Initial pass at getting driver building. Not done yet.

Shuffle files around into their correct places. Create Makefile.am, configure.ac, and autogen.sh based on similar files in other drivers. Delete pre-modular files (e.g., Imakefile) that are no longer necessary.
2026-03-24 01:24:35 +00:00 · 2006-11-16 12:41:02 -08:00
parent 0ace27ac3e
commit 1a3cd0a7f8
63 changed files with 298 additions and 1837 deletions
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -0,0 +1,73 @@
+# $Id$
+#
+# Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
+# 
+# Permission to use, copy, modify, distribute, and sell this software and its
+# documentation for any purpose is hereby granted without fee, provided that
+# the above copyright notice appear in all copies and that both that
+# copyright notice and this permission notice appear in supporting
+# documentation.
+# 
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR
+# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+# 
+# Except as contained in this notice, the name of the copyright holders shall
+# not be used in advertising or otherwise to promote the sale, use or
+# other dealings in this Software without prior written authorization
+# from the copyright holders.
+# 
+
+drivermandir = $(DRIVER_MAN_DIR)
+
+driverman_PRE = @DRIVER_NAME@.man
+
+driverman_DATA = $(driverman_PRE:man=@DRIVER_MAN_SUFFIX@)
+
+EXTRA_DIST = @DRIVER_NAME@.man
+
+CLEANFILES = $(driverman_DATA)
+
+SED = sed
+
+# Strings to replace in man pages
+XORGRELSTRING = @PACKAGE_STRING@
+  XORGMANNAME = X Version 11
+
+MANDEFS =  \
+	-D__vendorversion__="\"$(XORGRELSTRING)\" \"$(XORGMANNAME)\"" \
+	-D__appmansuffix__=$(APP_MAN_SUFFIX) \
+	-D__filemansuffix__=$(FILE_MAN_SUFFIX) \
+	-D__libmansuffix__=$(LIB_MAN_SUFFIX) \
+	-D__miscmansuffix__=$(MISC_MAN_SUFFIX) \
+	-D__drivermansuffix__=$(DRIVER_MAN_SUFFIX) \
+	-D__adminmansuffix__=$(ADMIN_MAN_SUFFIX) \
+	-D__xconfigfile__=xorg.conf \
+	-D__xservername__=Xorg
+
+# Translate XCOMM into pound sign with sed, rather than passing -DXCOMM=XCOMM
+# to cpp, because that trick does not work on all ANSI C preprocessors.
+# Delete line numbers from the cpp output (-P is not portable, I guess).
+# Allow XCOMM to be preceded by whitespace and provide a means of generating
+# output lines with trailing backslashes.
+# Allow XHASH to always be substituted, even in cases where XCOMM isn't.
+
+CPP_SED_MAGIC = $(SED) -e '/^\#  *[0-9][0-9]*  *.*$$/d' \
+                       -e '/^\#line  *[0-9][0-9]*  *.*$$/d' \
+                       -e '/^[         ]*XCOMM$$/s/XCOMM/\#/' \
+                       -e '/^[         ]*XCOMM[^a-zA-Z0-9_]/s/XCOMM/\#/' \
+                       -e '/^[         ]*XHASH/s/XHASH/\#/' \
+                       -e '/\@\@$$/s/\@\@$$/\\/'
+
+SUFFIXES = .$(DRIVER_MAN_SUFFIX) .man
+
+.man.$(DRIVER_MAN_SUFFIX):
+	$(RAWCPP) $(RAWCPPFLAGS) $(MANDEFS) $(EXTRAMANDEFS) < $< | $(CPP_SED_MAGIC) > $@
+
--- a/man/xgi.man
+++ b/man/xgi.man
@@ -0,0 +1,418 @@
+.\" $XFree86: xc/programs/Xserver/hw/xfree86/drivers/xgi/xgi.man,v 1.14 2003/11/12 16:50:36 twini Exp $
+.\" shorthand for double quote that works everywhere.
+.ds q \N'34'
+.TH XGI __drivermansuffix__ __vendorversion__
+.SH NAME
+xgi \- XGI video driver
+.SH SYNOPSIS
+.nf
+.B "Section \*qDevice\*q"
+.BI "  Identifier \*q"  devname \*q
+.B  "  Driver \*qxgi\*q"
+\ \ ...
+.B EndSection
+.fi
+.SH DESCRIPTION
+.B xgi
+is an XFree86 driver for XGI  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.
+.SH SUPPORTED HARDWARE
+The
+.B xgi
+driver supports PCI and AGP video cards based on the following chipsets:
+.PP
+.B XGI5597/5598
+.B XGI530/620
+.B XGI6326/AGP/DVD
+.B XGI300/305
+.B XGI540
+.B XGI630/730
+.B XGI315/H/PRO
+.B XGI550/551/552
+.B XGI650/651/M650/661FX/M661FX/M661MX/740/741
+.B XGI330 (Xabre)
+.B XGI760
+.PP
+In the following text, the following terms are used:
+.PP
+.B old series
+for XGI5597/5598, 530/620 and 6326/AGP/DVD
+.PP
+.B 300 series
+for XGI300/305, 540 and 630/730
+.PP
+.B 315/330 series
+for XGI315/H/PRO, 55x and (M)65x/(M)661xX/74x, 330, 760
+.PP
+Note: Support for 661FX, M661FX, M661MX, 741 and 760 is untested.
+.SH CONFIGURATION DETAILS
+Please refer to XF86Config(__filemansuffix__) for general configuration
+details.  This section only covers configuration details specific to this
+driver.
+.PP
+Detailed information on all supported options can be obtained at
+http://www.winischhofer.net/linuxxgivga.shtml
+.PP
+This manpage only covers a subset of the supported options.
+.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
+Disable or enable 2D acceleration. Default: acceleration is enabled.
+.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
+the Shadow Frame Buffer layer. Using this option disables
+the Resize and Rotate extension (RandR).
+Default: no rotation.
+.TP
+.BI "Option \*qRotate\*q \*qCCW\*q"
+Rotate the display counterclockwise. This mode is unaccelerated, and
+uses the Shadow Frame Buffer layer. Using this option disables
+the Resize and Rotate extension (RandR).
+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.
+.TP
+.BI "Option \*qCRT1Gamma\*q \*q" boolean \*q
+Enable or disable gamma correction.
+Default: Gamma correction is on.
+.PP
+.I "2. Old series specific information"
+.PP
+The driver will auto-detect the amount of video memory present for all
+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
+limitation using the
+.B \*qVideoRAM\*q
+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.
+.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
+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
+high resolutions which you should use instead. These are named
+.B \*qXGI1280x1024-75\*q
+and
+.B \*qXGI1600x1200-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 \*qXGI1600x1200-60\*q \*qXGI1280x1024x75\*q \*q1024x768\*q ...
+.PP
+Of these modes, 1280x1024 is only available at 8, 15 and 16bpp. 1600x1200
+is available at 8bpp only.
+.PP
+TV support for the 6326
+.PP
+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
+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 530/620, on for
+the others
+.TP
+.BI "Option \*qFastVram\*q \*q" boolean \*q
+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.
+.TP
+.BI "Option \*qNoHostBus\*q \*q" boolean \*q
+(XGI5597/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
+.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
+.BI "Option \*qTVStandard\*q \*q" string \*q
+(6326 only) Valid parameters are
+.B PAL
+or
+.B NTSC.
+The default is set by a jumper on the card.
+.TP
+.BI "Option \*qTVXPosOffset\*q \*q" integer \*q
+(6326 only) This option allows tuning the horizontal position of the image
+for TV output. The range is from -16 to 16. Default: 0
+.TP
+.BI "Option \*qTVYPosOffset\*q \*q" integer \*q
+(6326 only) This option allows tuning the vertical position of the image
+for TV output. The range is from -16 to 16. Default: 0
+.TP
+.BI "Option \*qXGI6326TVEnableYFilter\*q \*q" boolean \*q
+(6326 only) This option allows enabling/disabling the Y (chroma) filter for
+TV output.
+.TP
+.BI "Option \*qXGI6326TVAntiFlicker\*q \*q" string \*q
+(6326 only) This option allow enabling/disabling the anti flicker facility
+for TV output. Possible parameters are
+.B OFF, LOW, MED, HIGH
+or
+.B ADAPTIVE.
+By experience,
+.B ADAPTIVE
+yields the best results, hence it is the default.
+.PP
+.I "2. 300 and 315/330 series specific information"
+.PP
+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
+.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 XGI301
+.B XGI301B(-DH)
+.B XGI301C
+.B XGI301LV(X)
+.B XGI302LV
+.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 XGI301 and the Chrontel 7005, only resolutions up to 800x600
+are supported. On all others, resolutions up to 1024x768 are supported.
+However, due to a hardware bug, Xvideo might be distorted on XGI video
+bridges if running NTSC or PAL-M at 1024x768.
+.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.
+The 300 series as well as the XGI55x, M650, 651, 661FX, M661FX, and
+741 support two video overlays. The XGI315/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
+.B \*qXvOnCRT2\*q
+can be used to select the desired output channel.
+.PP
+About Merged Framebuffer support
+.PP
+This mode is strongly recommended over Xinerama. Please see
+http://www.winischhofer.net/linuxxgivga.shtml for detailed
+information.
+.PP
+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
+reduced maximum refresh rate if running on higher resolutions than
+1280x1024.
+.PP
+Colordepth 8 is not supported when running in dual head mode.
+.PP
+The following driver
+.B Options
+are supported on the 300 and 315/330 series:
+.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
+automatically. In Merged Framebuffer mode, this option is ignored.
+Default: overlay is used on CRT1
+.TP
+.BI "Option \*qForceCRT1\*q \*q" boolean \*q
+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.
+If this option is set to
+.B off
+, the driver will switch off CRT1.
+Default: auto-detect
+.TP
+.BI "Option \*qForceCRT2Type\*q \*q" string \*q
+Force display type to one of:
+.B NONE
+,
+.B TV
+,
+.B SVIDEO
+,
+.B COMPOSITE
+,
+.B SVIDEO+COMPOSITE
+,
+.B SCART
+,
+.B LCD
+,
+.B VGA
+;
+.B NONE
+will disable CRT2. The SVIDEO, COMPOSITE, SVIDEO+COMPOSITE and SCART
+parameters are for XGI video bridges only and can be used to force the
+driver to use a specific TV output connector (if present).
+Default: auto detect.
+.TP
+.BI "Option \*qCRT2Gamma\*q \*q" boolean \*q
+Enable or disable gamma correction for CRT2. Only supported
+for XGI video bridges. Default: Gamma correction for CRT2 is on.
+.TP
+.BI "Option \*qTVStandard\*q \*q" string \*q
+Force the TV standard to either
+.B PAL
+or
+.B NTSC.
+On some machines with 630, 730 and the 315/330 series,
+.B PALM
+,
+.B PALN
+and
+.B NTSCJ
+are supported as well. Default: BIOS setting.
+.TP
+.BI "Option \*qTVXPosOffset\*q \*q" integer \*q
+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
+.TP
+.BI "Option \*qTVYPosOffset\*q \*q" integer \*q
+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 \*qXGITVXScale\*q \*q" integer \*q
+This option selects the horizontal zooming level for TV output. The range
+is from -16 to 16. Only supported on XGI video bridges. Default: 0
+.TP
+.BI "Option \*qXGITVYScale\*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
+XGI video bridges. Default: 0
+.TP
+.BI "Option \*qCHTVOverscan\*q \*q" boolean \*q
+On machines with a Chrontel TV encoder, this can be used to force the
+TV mode to overscan or underscan.
+.B on
+means overscan,
+.B off
+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
+The driver supports many more options. Please see
+http://www.winischhofer.net/linuxxgivga.shtml for
+more information.
+.PP
+.I "3. 300 series specific information"
+.PP
+DRI is supported on the 300 series only. On Linux, DRI requires the
+kernel's XGI framebuffer driver (
+.B xgifb
+) and some other modules which come with either the kernel or XFree86.
+.PP
+Xgifb takes care of memory management for texture data. In order to
+prevent the X Server and xgifb from overwriting each other's data,
+xgifb reserves an amount of video memory for the X driver. This amount
+can either be selected using xgifb's mem parameter, or auto-selected
+depending on the amount of total video RAM available.
+.PP
+Xgifb can be used for memory management only, or as a complete framebuffer
+driver. If you start xgifb with a valid mode (ie you gain a graphical console),
+the X driver can communicate with xgifb 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 xgifb for
+video memory management only, ie you started xgifb with mode=none and still
+have a text mode console, there is no communication between xgifb and the
+X driver. For this purpose,
+the
+.TP
+.BI "Option \*qMaxXFBMem\*q \*q" integer \*q
+.PP
+exists. This option must be set to the same value as given to xgifb through
+its "mem" parameter, ie the amount of memory to use for X in kilobytes.
+.PP
+If you started xgifb without the mem argument, xgifb will reserve
+.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
+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.
+.SH "KNOWN BUGS"
+none.
+.SH "SEE ALSO"
+XFree86(1), XF86Config(__filemansuffix__), xf86config(1), Xserver(1), X(__miscmansuffix__)
+.PP
+.B "http://www.winischhofer.net/linuxxgivga.shtml"
+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