sis.man 14 KB
Newer Older
1
.\" $XFree86: xc/programs/Xserver/hw/xfree86/drivers/sis/sis.man,v 1.5 2001/12/17 20:52:34 dawes Exp $
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
.\" shorthand for double quote that works everywhere.
.ds q \N'34'
.TH SIS __drivermansuffix__ __vendorversion__
.SH NAME
sis \- SiS video driver
.SH SYNOPSIS
.nf
.B "Section \*qDevice\*q"
.BI "  Identifier \*q"  devname \*q
.B  "  Driver \*qsis\*q"
\ \ ...
.B EndSection
.fi
.SH DESCRIPTION
.B sis
17 18 19
is an XFree86 driver for SiS (Silicon Integrated Systems) video chips. The
driver is accelerated, and provides support for colordepths of 8, 16 and 24 bpp.
XVideo, Render and other extensions are supported as well.
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
20 21 22 23 24 25 26 27 28 29 30 31
.SH SUPPORTED HARDWARE
The
.B sis
driver supports PCI and AGP video cards based on the following chipsets:
.PP
.B SiS5597/5598
.B SiS530/620
.B SiS6326/AGP/DVD
.B SiS300/305
.B SiS540
.B SiS630/730
.B SiS315/H/PRO
32 33
.B SiS550/551/552
.B SiS650/651/M650/661FX/M661FX/M661MX/740/741
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
34
.B SiS330 (Xabre)
35
.B SiS760
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
36 37 38 39 40 41 42 43 44
.PP
In the following text, the following terms are used:
.PP
.B old series
for SiS5597/5598, 530/620 and 6326/AGP/DVD
.PP
.B 300 series
for SiS300/305, 540 and 630/730
.PP
45 46 47 48
.B 315/330 series
for SiS315/H/PRO, 55x and (M)65x/(M)661xX/74x, 330, 760
.PP
Note: Support for 661FX, M661FX, M661MX, 741 and 760 is untested.
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
49 50 51
.SH CONFIGURATION DETAILS
Please refer to XF86Config(__filemansuffix__) for general configuration
details.  This section only covers configuration details specific to this
52 53 54 55 56 57
driver.
.PP
Detailed information on all supported options can be obtained at
http://www.winischhofer.net/linuxsisvga.shtml
.PP
This manpage only covers a subset of the supported options.
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
58 59 60 61 62 63 64 65
.PP
.I "1. For all supported chipsets"
.PP
The following driver
.B Options
are supported on all chipsets:
.TP
.BI "Option \*qNoAccel\*q \*q" boolean \*q
66
Disable or enable 2D acceleration. Default: acceleration is enabled.
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
67 68 69 70 71 72 73 74 75
.TP
.BI "Option \*qHWCursor\*q \*q" boolean \*q
Enable or disable the HW cursor. Default: HWCursor is on.
.TP
.BI "Option \*qSWCursor\*q \*q" boolean \*q
The opposite of HWCursor. Default: SWCursor is off.
.TP
.BI "Option \*qRotate\*q \*qCW\*q"
Rotate the display clockwise. This mode is unaccelerated, and uses
76 77
the Shadow Frame Buffer layer. Using this option disables
the Resize and Rotate extension (RandR).
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
78 79 80 81
Default: no rotation.
.TP
.BI "Option \*qRotate\*q \*qCCW\*q"
Rotate the display counterclockwise. This mode is unaccelerated, and
82 83
uses the Shadow Frame Buffer layer. Using this option disables
the Resize and Rotate extension (RandR).
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
84 85 86 87 88
Default: no rotation.
.TP
.BI "Option \*qShadowFB\*q \*q" boolean \*q
Enable or disable use of the shadow framebuffer layer.
Default: Shadow framebuffer is off.
89 90 91 92
.TP
.BI "Option \*qCRT1Gamma\*q \*q" boolean \*q
Enable or disable gamma correction.
Default: Gamma correction is on.
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
93 94 95 96
.PP
.I "2. Old series specific information"
.PP
The driver will auto-detect the amount of video memory present for all
97 98 99 100
these chips, but in the case of the 6326, it will limit the memory size
to 4MB. This is because the 6326's 2D engine can only address 4MB. The
remaining memory seems to be intended for 3D texture data, since only
the 3D engine can address RAM above 4MB. However, you can override this
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
101 102
limitation using the
.B \*qVideoRAM\*q
103 104 105
option in the Device section if your board has more than 4MB and you
need to use it. However, 2D acceleration, Xvideo and the HWCursor will
be disabled in this case.
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
106 107 108 109 110
.PP
The driver will also auto-detect the maximum dotclock and DAC speed.
If you have problems getting high resolutions because of dot clock
limitations, try using the
.B \*qDacSpeed\*q
111 112
option, also in the Device section. However, this is not recommended
for the 6326. For this chip, the driver has two built-in modes for
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
113 114 115 116 117 118 119 120 121
high resolutions which you should use instead. These are named
.B \*qSIS1280x1024-75\*q
and
.B \*qSIS1600x1200-60\*q
and they will be added to the list of default modes. To use these modes,
just place them in your Screen section. Example:
.PP
.BI "Modes \*qSIS1600x1200-60\*q \*qSIS1280x1024x75\*q \*q1024x768\*q ...
.PP
122 123
Of these modes, 1280x1024 is only available at 8, 15 and 16bpp. 1600x1200
is available at 8bpp only.
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
124 125 126
.PP
TV support for the 6326
.PP
127 128
TV output is supported for the 6326. The driver will auto detect a
TV connected and in this case add the following modes to the list
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
129 130 131 132 133 134 135 136 137 138 139 140 141
of default modes: "PAL800x600", "PAL800x600U", "PAL720x540",
"PAL640x480", "NTSC640x480", "NTSC640x480U" and "NTSC640x400".
Use these modes like the hi-res modes described above.
.PP
The following driver
.B Options
are supported on the old series:
.TP
.BI "Option \*qTurboQueue\*q \*q" boolean \*q
Enable or disable TurboQueue mode.  Default: off for SIS530/620, on for
the others
.TP
.BI "Option \*qFastVram\*q \*q" boolean \*q
142 143 144 145
Enable or disable FastVram mode.  Enabling this sets the video RAM timing
to one cycle per read operation instead of two cycles. Disabling this will
set two cycles for read and write operations. Leaving this option out uses
the default, which varies depending on the chipset.
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
146 147 148 149 150 151 152 153
.TP
.BI "Option \*qNoHostBus\*q \*q" boolean \*q
(SiS5597/5598 only). Disable CPU-to-VGA host bus support. This
speeds up CPU to video RAM transfers. Default: Host bus is enabled.
.TP
.BI "Option \*qNoXVideo\*q \*q" boolean \*q
Disable XV (XVideo) extension support. Default: XVideo is on.
.TP
154 155 156 157 158 159
.BI "Option \*qNoYV12\*q \*q" boolean \*q
Disable YV12 Xv support. This might me required due to hardware bugs in some
chipsets. Disabling YV12 support forces Xv-aware applications to use YUV2 or
XShm for video output.
Default: YV12 support is on.
.TP
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
160
.BI "Option \*qTVStandard\*q \*q" string \*q
161
(6326 only) Valid parameters are
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
162 163 164 165 166 167
.B PAL
or
.B NTSC.
The default is set by a jumper on the card.
.TP
.BI "Option \*qTVXPosOffset\*q \*q" integer \*q
168 169
(6326 only) This option allows tuning the horizontal position of the image
for TV output. The range is from -16 to 16. Default: 0
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
170 171
.TP
.BI "Option \*qTVYPosOffset\*q \*q" integer \*q
172 173
(6326 only) This option allows tuning the vertical position of the image
for TV output. The range is from -16 to 16. Default: 0
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
174 175
.TP
.BI "Option \*qSIS6326TVEnableYFilter\*q \*q" boolean \*q
176
(6326 only) This option allows enabling/disabling the Y (chroma) filter for
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
177 178 179
TV output.
.TP
.BI "Option \*qSIS6326TVAntiFlicker\*q \*q" string \*q
180 181
(6326 only) This option allow enabling/disabling the anti flicker facility
for TV output. Possible parameters are
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
182 183 184 185 186
.B OFF, LOW, MED, HIGH
or
.B ADAPTIVE.
By experience,
.B ADAPTIVE
187
yields the best results, hence it is the default.
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
188
.PP
189
.I "2. 300 and 315/330 series specific information"
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
190
.PP
191 192 193
The 300 and 315/330 series feature two CRT controllers and very often come
with a video bridge for controlling LCD and TV output. Hereinafter, the
term
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
194 195 196 197 198 199 200 201 202 203 204
.B CRT1
refers to the VGA output of the chip, and
.B CRT2
refers to either LCD, TV or secondary VGA. Due to timing reasons,
only one CRT2 output can be active at the same time. But this
limitation does not apply to using CRT1 and CRT2 at the same time
which makes it possible to run the driver in dual head mode.
.PP
The driver supports the following video bridges:
.PP
.B SiS301
205 206 207
.B SiS301B(-DH)
.B SiS301C
.B SiS301LV(X)
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
208 209 210 211 212 213 214 215 216 217 218 219 220 221
.B SiS302LV
.PP
Instead of a video bridge, some machines have a
.B LVDS
transmitter to control LCD panels, and a
.B "Chrontel 7005"
or
.B "7019"
for TV output. All these are supported as well.
.PP
About TV output
.PP
On the SiS301 and the Chrontel 7005, only resolutions up to 800x600
are supported. On all others, resolutions up to 1024x768 are supported.
222 223
However, due to a hardware bug, Xvideo might be distorted on SiS video
bridges if running NTSC or PAL-M at 1024x768.
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
224 225 226 227 228
.PP
About XVideo support
.PP
XVideo is supported on all chipsets of both families. However, there
are some differences in hardware features which cause limitations.
229 230 231 232
The 300 series as well as the SiS55x, M650, 651, 661FX, M661FX, and
741 support two video overlays. The SiS315/H/PRO, 650/740 and 330 support
only one such overlay. On chips with two overlays, one overlay is used
for CRT1, the other for CRT2. On the other chipsets, the option
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
233 234 235
.B \*qXvOnCRT2\*q
can be used to select the desired output channel.
.PP
236 237 238 239 240 241
About Merged Framebuffer support
.PP
This mode is strongly recommended over Xinerama. Please see
http://www.winischhofer.net/linuxsisvga.shtml for detailed
information.
.PP
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
242 243 244 245
About dual-head support
.PP
Dual head mode has some limitations as regards color depth and
resolution. Due to memory bandwidth limits, CRT1 might have a
246
reduced maximum refresh rate if running on higher resolutions than
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
247 248 249 250 251 252
1280x1024.
.PP
Colordepth 8 is not supported when running in dual head mode.
.PP
The following driver
.B Options
253
are supported on the 300 and 315/330 series:
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
254 255 256 257 258 259 260 261 262 263 264 265 266 267
.TP
.BI "Option \*qNoXVideo\*q \*q" boolean \*q
Disable XV (XVideo) extension support.
Default: XVideo is on.
.TP
.BI "Option \*qXvOnCRT2\*q \*q" boolean \*q
On chipsets with only one video overlay, this option can
used to bind the overlay to CRT1 ( if a monitor is detected
and if this option is either unset or set to
.B false
) or CRT2 ( if a CRT2 device is detected or forced, and if this
option is set to
.B true
). If either only CRT1 or CRT2 is detected, the driver decides
268
automatically. In Merged Framebuffer mode, this option is ignored.
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
269 270 271
Default: overlay is used on CRT1
.TP
.BI "Option \*qForceCRT1\*q \*q" boolean \*q
272 273 274 275 276
Force CRT1 to be on of off. If a monitor is connected, it will be
detected during server start. However, some old monitors are not
detected correctly. In such cases, you may set this option to
.B on
in order to make the driver initialize CRT1 anyway.
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
277
If this option is set to
278 279 280
.B off
, the driver will switch off CRT1.
Default: auto-detect
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
281 282 283 284 285 286 287 288 289 290 291
.TP
.BI "Option \*qForceCRT2Type\*q \*q" string \*q
Force display type to one of:
.B NONE
,
.B TV
,
.B SVIDEO
,
.B COMPOSITE
,
292 293 294
.B SVIDEO+COMPOSITE
,
.B SCART
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
295 296 297 298 299 300
,
.B LCD
,
.B VGA
;
.B NONE
301 302 303
will disable CRT2. The SVIDEO, COMPOSITE, SVIDEO+COMPOSITE and SCART
parameters are for SiS video bridges only and can be used to force the
driver to use a specific TV output connector (if present).
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
304 305
Default: auto detect.
.TP
306 307 308
.BI "Option \*qCRT2Gamma\*q \*q" boolean \*q
Enable or disable gamma correction for CRT2. Only supported
for SiS video bridges. Default: Gamma correction for CRT2 is on.
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
309 310 311 312 313 314
.TP
.BI "Option \*qTVStandard\*q \*q" string \*q
Force the TV standard to either
.B PAL
or
.B NTSC.
315
On some machines with 630, 730 and the 315/330 series,
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
316
.B PALM
317
,
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
318
.B PALN
319 320
and
.B NTSCJ
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
321 322 323
are supported as well. Default: BIOS setting.
.TP
.BI "Option \*qTVXPosOffset\*q \*q" integer \*q
324 325 326
This option allows tuning the horizontal position of the image for
TV output. The range is from -32 to 32. Not supported on the Chrontel
7019. Default: 0
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
327 328
.TP
.BI "Option \*qTVYPosOffset\*q \*q" integer \*q
329 330 331 332 333 334 335 336 337 338 339 340 341
This option allows tuning the vertical position of the image for TV
output. The range is from -32 to 32. Not supported on the Chrontel
7019. Default: 0
.TP
.BI "Option \*qSISTVXScale\*q \*q" integer \*q
This option selects the horizontal zooming level for TV output. The range
is from -16 to 16. Only supported on SiS video bridges. Default: 0
.TP
.BI "Option \*qSISTVYScale\*q \*q" integer \*q
This option selects the vertical zooming level for TV output in the
following modes: 640x480, 800x600. On the 315/330 series, also 720x480,
720x576 and 768x576. The range is from -4 to 3. Only supported on
SiS video bridges. Default: 0
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
342 343
.TP
.BI "Option \*qCHTVOverscan\*q \*q" boolean \*q
344 345 346
On machines with a Chrontel TV encoder, this can be used to force the
TV mode to overscan or underscan.
.B on
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
347
means overscan,
348
.B off
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
349 350 351 352 353 354 355 356 357
means underscan.
Default: BIOS setting.
.TP
.BI "Option \*qCHTVSuperOverscan\*q \*q" boolean \*q
On machines with a Chrontel 7005 TV encoder, this option
enables a super-overscan mode. This is only supported if
the TV standard is PAL. Super overscan will produce an
image on the TV which is larger than the viewable area.
.PP
358 359 360 361
The driver supports many more options. Please see
http://www.winischhofer.net/linuxsisvga.shtml for
more information.
.PP
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
362 363
.I "3. 300 series specific information"
.PP
364 365
DRI is supported on the 300 series only. On Linux, DRI requires the
kernel's SiS framebuffer driver (
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
366
.B sisfb
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
) and some other modules which come with either the kernel or XFree86.
.PP
Sisfb takes care of memory management for texture data. In order to
prevent the X Server and sisfb from overwriting each other's data,
sisfb reserves an amount of video memory for the X driver. This amount
can either be selected using sisfb's mem parameter, or auto-selected
depending on the amount of total video RAM available.
.PP
Sisfb can be used for memory management only, or as a complete framebuffer
driver. If you start sisfb with a valid mode (ie you gain a graphical console),
the X driver can communicate with sisfb and doesn't require any
manual configuration for finding out about the video memory it is allowed
to use.
However, if you are running a 2.4 series Linux kernel and use sisfb for
video memory management only, ie you started sisfb with mode=none and still
have a text mode console, there is no communication between sisfb and the
X driver. For this purpose,
the
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
385 386 387
.TP
.BI "Option \*qMaxXFBMem\*q \*q" integer \*q
.PP
388 389 390 391
exists. This option must be set to the same value as given to sisfb through
its "mem" parameter, ie the amount of memory to use for X in kilobytes.
.PP
If you started sisfb without the mem argument, sisfb will reserve
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
392 393 394 395 396 397 398
.TP
12288KB if more than 16MB of total video RAM is available,
.TP
8192KB if between 12 and 16MB of video RAM is available,
.TP
4096KB in all other cases.
.PP
399 400 401 402 403 404 405 406 407 408
If you intend to use DRI, I recommend setting the total video memory in
the BIOS to 64MB in order to at least overcome the lack of memory swap
functions.
.TP
.BI "Option \*qDRI\*q \*q" boolean \*q
This option allows enabling or disabling DRI. By default, DRI is on.
.TP
.BI "Option \*qAGPSize\*q \*q" integer \*q
This option allows selecting the amount of AGP memory to be used for DRI.
The amount is to be specified in megabyte, the default is 8.
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
409
.SH "KNOWN BUGS"
410
none.
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
411 412 413
.SH "SEE ALSO"
XFree86(1), XF86Config(__filemansuffix__), xf86config(1), Xserver(1), X(__miscmansuffix__)
.PP
414
.B "http://www.winischhofer.net/linuxsisvga.shtml"
Kaleb Keithley Keithley's avatar
Kaleb Keithley Keithley committed
415 416 417 418
for more information and updates
.SH AUTHORS
Authors include: Alan Hourihane, Mike Chapman, Juanjo Santamarta, Mitani
Hiroshi, David Thomas, Sung-Ching Lin, Ademar Reis, Thomas Winischhofer