1SAVAGE(4)                  Kernel Interfaces Manual                  SAVAGE(4)
2
3
4

NAME

6       savage - S3 Savage video driver
7

SYNOPSIS

9       Section "Device"
10         Identifier "devname"
11         Driver "savage"
12         ...
13       EndSection
14

DESCRIPTION

16       savage  is  an  Xorg  driver for the S3 Savage family video accelerator
17       chips.  2D, 3D, and Xv acceleration is supported on  all  chips  except
18       the  Savage2000  (2D only).  Dualhead operation is supported on MX, IX,
19       and SuperSavage chips.  The savage driver supports PCI and  AGP  boards
20       with the following chips:
21
22       Savage3D        (8a20 and 8a21) (2D, 3D)
23
24       Savage4         (8a22) (2D, 3D)
25
26       Savage2000      (9102) (2D only)
27
28       Savage/MX       (8c10 and 8c11) (2D, 3D, Dualhead)
29
30       Savage/IX       (8c12 and 8c13) (2D, 3D, Dualhead)
31
32       SuperSavage/MX  (8c22, 8c24, and 8c26) (2D, 3D, Dualhead)
33
34       SuperSavage/IX  (8c2a, 8c2b, 8c2c, 8c2d, 8c2e, and 8c2f) (2D, 3D, Dual‐
35                       head)
36
37       ProSavage PM133 (8a25) (2D, 3D)
38
39       ProSavage KM133 (8a26) (2D, 3D)
40
41       Twister (ProSavage PN133)
42                       (8d01) (2D, 3D)
43
44       TwisterK (ProSavage KN133)
45                       (8d02) (2D, 3D)
46
47       ProSavage DDR   (8d03) (2D, 3D)
48
49       ProSavage DDR-K (8d04) (2D, 3D)
50

CONFIGURATION DETAILS

52       Please refer to xorg.conf(5) for general configuration  details.   This
53       section only covers configuration details specific to this driver.
54
55       The following driver Options are supported:
56
57       Option "HWCursor" "boolean"
58
59       Option "SWCursor" "boolean"
60              These  two options interact to specify hardware or software cur‐
61              sor.  If the SWCursor option is specified, any HWCursor  setting
62              is  ignored.   Thus, either "HWCursor off" or "SWCursor on" will
63              force the use of the software cursor.   On  Savage/MX  and  Sav‐
64              age/IX chips which are connected to LCDs, a software cursor will
65              be forced, because the Savage hardware cursor does not correctly
66              track  the automatic panel expansion feature.  Default: hardware
67              cursor.
68
69       Option "NoAccel" "boolean"
70              Disable  or  enable  acceleration.   Default:  acceleration   is
71              enabled.
72
73       Option "AccelMethod" "string"
74              Chooses  between  available  acceleration  architectures.  Valid
75              options are XAA and EXA.  XAA is  the  traditional  acceleration
76              architecture  and support for it is very stable.  EXA is a newer
77              acceleration architecture with better performance for the Render
78              and Composite extensions, but the rendering code for it is newer
79              and possibly unstable.  The default is XAA.
80
81       Option "Rotate" "CW"
82
83       Option "Rotate" "CCW"
84              Rotate the desktop 90  degrees  clockwise  or  counterclockwise.
85              This option forces the ShadowFB option on, and disables acceler‐
86              ation and the RandR extension.  Default: no rotation.
87
88       Option "ShadowFB" "boolean"
89              Enable or disable use of the  shadow  framebuffer  layer.   This
90              option disables acceleration.  Default: off.
91
92       Option "LCDClock" "frequency"
93              Override  the maximum dot clock.  Some LCD panels produce incor‐
94              rect results if they are driven at too fast of a frequency.   If
95              UseBIOS  is  on, the BIOS will usually restrict the clock to the
96              correct range.  If not, it might be  necessary  to  override  it
97              here.  The frequency parameter may be specified as an integer in
98              Hz (135750000), or with standard suffixes like "k", "kHz",  "M",
99              or "MHz" (as in 135.75MHz).
100
101       Option "CrtOnly" "boolean"
102              This option disables output to the LCD and enables output to the
103              CRT port only.  It is useful on laptops if you only want to  use
104              the  CRT  port  or to force the CRT output only on desktop cards
105              that use mobile chips. Default: auto-detect active outputs
106
107       Option "UseBIOS" "boolean"
108              Enable or disable use of the video BIOS to change modes.   Ordi‐
109              narily, the savage driver tries to use the video BIOS to do mode
110              switches.  This generally produces the  best  results  with  the
111              mobile  chips  (/MX and /IX), since the BIOS knows how to handle
112              the critical but unusual timing requirements of the various  LCD
113              panels  supported  by the chip.  To do this, the driver searches
114              through the BIOS mode list, looking  for  the  mode  which  most
115              closely matches the xorg.conf mode line.  Some purists find this
116              scheme objectionable.  If  you  would  rather  have  the  savage
117              driver  use  your mode line timing exactly, turn off the UseBios
118              option.  Note: Use of the BIOS is required for  dualhead  opera‐
119              tion.  Default: on (use the BIOS).
120
121       Option "IgnoreEDID" "boolean"
122              Do  not use EDID data for mode validation, but DDC is still used
123              for monitor detection. This is different from NoDDC option.
124              The default value is off.
125
126       Option "ShadowStatus" "boolean"
127              Enables the use of a shadow status register.  There  is  a  chip
128              bug in the Savage graphics engine that can cause a bus lock when
129              reading the engine status register under  heavy  load,  such  as
130              when  scrolling text or dragging windows.  The bug affects about
131              4% of all Savage users without DRI and a large fraction of users
132              with  DRI.   If your system hangs regularly while scrolling text
133              or dragging windows, try turning this option on.  This  uses  an
134              alternate  method of reading the engine status which is slightly
135              more expensive, but avoids the problem.   When  DRI  is  enabled
136              then  the  default  is  "on"  (use shadow status), otherwise the
137              default is "off" (use normal status register).
138
139       Option "DisableCOB" "boolean"
140              Disables the COB (Command Overflow Buffer) on savage4 and  newer
141              chips.  There is supposedly a HW cache coherency problem on cer‐
142              tain savage4 and newer chips that renders the  COB  useless.  If
143              you are having problems with 2D acceleration you can disable the
144              COB, however you will lose some  performance.   3D  acceleration
145              requires  the  COB to work.  This option only applies to Savage4
146              and newer chips.  Default: "off" (use COB).
147
148       Option "BCIforXv" "boolean"
149              Use the BCI to copy and reformat Xv pixel data.  Using  the  BCI
150              for  Xv  causes  graphics  artifacts on some chips.  This option
151              only applies to Savage4 and  prosavage/twister  chips.  On  some
152              combinations of chipsets and video players, BCI formatting might
153              actually be slower than software  formatting  ("AGPforXv"  might
154              help  in  this  case).  BCI formatting can only be used on video
155              data with a width that is a multiple of 16 pixels (which is  the
156              vast  majority  of  videos).   Other  widths are handled through
157              software formatting. Default: on for prosavage and twister  (use
158              BCI for Xv); off for savage4 (do not use the BCI for Xv).
159
160       Option "AGPforXv" "boolean"
161              Instructs  the  BCI  Xv  pixel  formatter to use AGP memory as a
162              scratch buffer.  Ordinarily the BCI formatter uses a an area  in
163              framebuffer  memory to hold YV12 planar data to be converted for
164              display. This requires a somewhat expensive upload of YV12  data
165              to framebuffer memory. The "AGPforXv" option causes the BCI for‐
166              matter to place the YV12 data in AGP memory instead,  which  can
167              be uploaded faster than the framebuffer. Use of this option cuts
168              upload overhead by 25% according to benchmarks. This option also
169              smooths  out  most  of  the  shearing present when using BCI for
170              pixel conversion. Currently this option is experimental  and  is
171              disabled  by  default.  Video  width  restrictions that apply to
172              "BCIforXv" also apply here. Only valid when "DRI" and "BCIforXv"
173              are both active, and only on AGP chipsets. Default: "off".
174              If "AccelMethod" is set to "EXA" and "AGPforXv" is enabled, then
175              the driver will also attempt to reuse the AGP scratch buffer for
176              UploadToScreen acceleration.
177
178       Option "AGPMode" "integer"
179              Set AGP data transfer rate.  (used only when DRI is enabled)
180              1      -- x1 (default)
181              2      -- x2
182              4      -- x4
183              others -- invalid
184
185       Option "AGPSize" "integer"
186              The  amount  of  AGP memory that will allocated for DMA and tex‐
187              tures in MB. Valid sizes are 4, 8, 16, 32, 64, 128 and 256.  The
188              default is 16MB.
189
190       Option "DmaMode" "string"
191              This  option  influences in which way DMA (direct memory access)
192              is used by the kernel and 3D drivers.
193              Any      -- Try command DMA first, then vertex DMA (default)
194              Command  -- Only use command DMA or don't use DMA at all
195              Vertex   -- Only use vertex DMA or don't use DMA at all
196              None     -- Disable DMA
197              Command and vertex DMA cannot be enabled at the same time. Which
198              DMA  mode  is  actually  used in the end also depends on the DRM
199              version (only >= 2.4.0 supports command DMA)  and  the  hardware
200              (Savage3D/MX/IX doesn't support command DMA).
201
202       Option "DmaType" "string"
203              The  type  of  memory that will be used by the 3D driver for DMA
204              (direct memory access).
205              PCI    -- PCI memory (default on PCI cards)
206              AGP    -- AGP memory (default on AGP cards)
207              "AGP" only works if you have an AGP card.
208
209       Option "BusType" "string"
210              The bus type that will be used to access the graphics card.
211              PCI    -- PCI bus (default on PCI cards)
212              AGP    -- AGP bus (default on AGP cards)
213              "AGP" only works if you have an AGP card. If you choose "PCI" on
214              an  AGP card the AGP bus speed is not set and no AGP aperture is
215              allocated. This implies DmaType "PCI".
216
217       Option "DRI" "boolean"
218              Enable DRI support.  This option allows you to enable or disable
219              the DRI.  Default: "on" (enable DRI).
220

FILES

222       savage_drv.o
223

SEE ALSO

225       Xorg(1), xorg.conf(5), Xserver(1), X(7)
226

AUTHORS

228       Authors   include   Tim   Roberts   (timr@probo.com)   and   Ani  Joshi
229       (ajoshi@unixbox.com) for this version, and Tim Roberts and S.  Marineau
230       for the original driver from which this was derived.
231
232
233
234X Version 11                xf86-video-savage 2.3.2                  SAVAGE(4)
Impressum