README revision 786a6f21 
1xf86-video-s3virge - S3 ViRGE video driver for the Xorg X server
2
3Please submit bugs & patches to the Xorg bugzilla:
4
5        https://bugs.freedesktop.org/enter_bug.cgi?product=xorg
6
7All questions regarding this software should be directed at the
8Xorg mailing list:
9
10        http://lists.freedesktop.org/mailman/listinfo/xorg
11
12The master development code repository can be found at:
13
14        git://anongit.freedesktop.org/git/xorg/driver/xf86-video-s3virge
15
16        http://cgit.freedesktop.org/xorg/driver/xf86-video-s3virge
17
18For more information on the git code manager, see:
19
20        http://wiki.x.org/wiki/GitPage
21
22------------------------------------------------------------------------
23What works: 
24- Supports 8bpp, 15/16bpp, 24bpp and 32bpp. Heavy testing on ViRGE DX.
25- There is some known instability in ViRGE GX2, please report problems.
26- Silken Mouse is enabled by default, use the generic server option of
27  -nosilk to disable it.
28
29XCONFIG options:
30
31The driver supports quite a few different XConfig options, which can
32be used to tune the driver and improve performance. Without any options, 
33the driver will use conservative settings which should work on most
34hardware. Large improvements in performance are possible by selecting
35the proper options, which will probably work on most systems.
36
37Cursor:
38
39- "hwcursor" "off" behaves exactly like "swcursor".  Default: "on"
40- "swcursor" will disable the HW Cursor.  HW Cursor is used by default and
41	no option is needed to enable it.
42
43Display:
44- "ShadowFB"  Use shadow framebuffer.  Disables HW acceleration.  Default: off.
45- "Rotate" " cw "|" ccw "  Rotate the screen CW - clockwise or CCW - counter
46    clockwise.  Disables HW Acceleration and HW Cursor, uses ShadowFB.
47    Default: no rotation.
48- "XVideo"  Disable XVideo support by using the off option.  This changes FIFO
49    settings which prevent screen noise for high-res modes.  Default: on
50
51Video memory:
52
53- "slow_edodram" will switch the standard ViRGE to 2-cycle edo mode. Try this
54	if you encounter pixel corruption on the ViRGE. Using this option will
55	cause a large decrease in performance. 
56- "fpm_vram" will switch the ViRGE/VX to fast page mode vram mode
57- "slow_dram " | " fast_dram"  Change Trio 3D and 3D/2X memory options.
58    Default: Use BIOS defaults.
59- "early_ras_precharge", "late_ras_precharge" adjust memory parameters.  One
60	of these will us the same settings as your video card defaults, and
61	using neither in the config file does the same.
62- "set_mclk" sets the memory clock, format is:
63	Option "set_mclk" "50000" 
64	in the XF86Config file.  Valid values are any 
65	integer <= 100000, where 100000 == 100 MHz.
66- "set_refclk" sets the ref clock for ViRGE MX, format is:
67	Option "set_refclk" "50000" 
68
69Acceleration and graphic engine:
70 
71- "NoAccel" turns off all acceleration
72- "fifo_aggressive", "fifo_moderate" and "fifo_conservative" alter the settings
73	for the threshold at which the pixel FIFO takes over the internal 
74	memory bus to refill itself. The smaller this threshold, the better
75	the acceleration performance of the card. You may try the fastest 
76	setting ("aggressive") and move down if you encounter pixel corruption.
77	The optimal setting will probably depend on dot-clock and on color 
78	depth. Note that specifying any of these options will also alter other
79	memory settings which should increase performance, so you should at
80        least use "fifo_conservative" (this uses the chip defaults).
81- Common XAA acceleration options to disable primitives for test purposes:
82	"XaaNoScreenToScreenCopy"
83	"XaaNoSolidFillRect"
84	"XaaNoColor8x8PatternFillRect"
85	"XaaNoImageWriteRect"
86	"XaaNoPixmapCache"
87
88PCI bus:
89- "pci_burst" will enable PCI burst mode. This should work on all but a
90	few "broken" PCI chipsets, and will increase performance.  Option may
91	take a parameter "on", "off", "yes", etc...
92- "pci_retry" will allow the driver to rely on PCI Retry to program the 
93	ViRGE registers. "pci_burst" must be enabled for this to work. 
94	This will increase performance, especially for small fills/blits, 
95        because the driver does not have to poll the ViRGE before sending it 
96        commands to make sure it is ready. It should work on most 
97        recent PCI chipsets. 
98
99ViRGE MX LCD options:
100- "lcd_center"
101- "set_lcdclk" allows setting the clock for a ViRGE MX LCD display. Format is:
102	Option "set_lcdclk" "30000"
103	in the config file.  Valid values are ?
104
105Debug:
106- "ShowCache"  Enable or disable viewing offscreen cache memory.  A
107    development debug option.  Default: off.
108- "mx_cr3a_fix"  Enable or disable a cr3a fix added for ViRGE MX.
109    Default: on.
110
111
112$XFree86: xc/programs/Xserver/hw/xfree86/drivers/s3virge/README,v 1.9 2000/06/14 21:57:54 dawes Exp $
113