Initial commit of the vermilion driver

2 files changed, 133 insertions, 0 deletions

diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..bf7ec17
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,59 @@
+# $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
+
+MAN_SUBSTS = \
+	-e 's|__vendorversion__|"$(XORGRELSTRING)" "$(XORGMANNAME)"|' \
+	-e 's|__xorgversion__|"$(XORGRELSTRING)" "$(XORGMANNAME)"|' \
+	-e 's|__xservername__|Xorg|g' \
+	-e 's|__xconfigfile__|xorg.conf|g' \
+	-e 's|__projectroot__|$(prefix)|g' \
+	-e 's|__appmansuffix__|$(APP_MAN_SUFFIX)|g' \
+	-e 's|__drivermansuffix__|$(DRIVER_MAN_SUFFIX)|g' \
+	-e 's|__adminmansuffix__|$(ADMIN_MAN_SUFFIX)|g' \
+	-e 's|__miscmansuffix__|$(MISC_MAN_SUFFIX)|g' \
+	-e 's|__filemansuffix__|$(FILE_MAN_SUFFIX)|g'
+
+SUFFIXES = .$(DRIVER_MAN_SUFFIX) .man
+
+.man.$(DRIVER_MAN_SUFFIX):
+	sed $(MAN_SUBSTS) < $< > $@
diff --git a/man/vermilion.man b/man/vermilion.man
new file mode 100644
index 0000000..bb99a11
--- /dev/null
+++ b/man/vermilion.man
@@ -0,0 +1,74 @@
+.\" shorthand for double quote that works everywhere.
+.ds q \N'34'
+.TH VERMILION __drivermansuffix__ __vendorversion__
+.SH NAME
+vermilion \- Generic VERMILION video driver
+.SH SYNOPSIS
+.nf
+.B "Section \*qDevice\*q"
+.BI "  Identifier \*q"  devname \*q
+.B  "  Driver \*qvermilion\*q"
+\ \ ...
+.B EndSection
+.fi
+.SH DESCRIPTION
+.B vermilion
+is an __xservername__ driver for generic VERMILION video cards.  It can drive most
+VERMILION-compatible video cards, but only makes use of the basic standard
+VERMILION core that is common to these cards.  The driver supports depths 15
+and 24.
+.SH SUPPORTED HARDWARE
+The
+.B vermilion
+driver supports most VERMILION-compatible video cards.  There are some known
+exceptions, and those should be listed here.
+.SH CONFIGURATION DETAILS
+Please refer to __xconfigfile__(__filemansuffix__) for general configuration
+details.  This section only covers configuration details specific to this
+driver.
+.PP
+The driver auto-detects the presence of VERMILION-compatible hardware.  The
+.B ChipSet
+name may optionally be specified in the config file
+.B \*qDevice\*q
+section, and will override the auto-detection:
+.PP
+.RS 4
+"vermilion"
+.RE
+.PP
+The following driver
+.B Options
+are supported:
+.TP
+.BI "Option \*qShadowFB\*q \*q" boolean \*q
+Enable or disable use of the shadow framebuffer layer. This is currently
+enabled for depth 15 because of hardware restrictions, but disabled for
+depth 24 where the accelerator is used to give higher performance. 
+.TP
+.BI "Option \*qPanelType\*q \*q" integer \*q
+Sets the panel timing constraints to the timing of one of the
+pre-programmed panel types, and makes sure that the panel and panel
+backlight are switched on an off as appropriate. If this value is set
+to \*q-1\*q the driver ignores any panel timings and avoids trying to
+manipulate panel and backlight power. The currently supported values are:
+\*q-1\*q; don't assmume any panel timing constraints and
+\*q0\*q, assume that the connected panel is a SHARP LQ150X1LGN2A. Default: \*q0\*q.
+.TP
+.BI "Option \*qFusedClock\*q \*q" integer \*q
+The driver by default supports a set of 9 discrete dotclocks. These
+clocks are: (given as MHz (index)): 6.75(0), 13.5(1), 27.0(2), 29.7(3),
+37.125(4), 54.0(5), 59.4(6), 74.25(7) and 120.0(8). The driver can be
+forced to support only one of these clocks by giving the corresponding
+index as argument to this option. If an index of \*q-1\*q is given,
+the driver will support all of the above clocks. Default: \*q-1\* (All
+clocks supported).
+.TP
+.BI "Option \*qDebug\*q \*q" boolean \*q
+Enable a debug printout of the modesetting registers. Default: false.
+
+.SH "SEE ALSO"
+__xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), xorgcfg(__appmansuffix__), xorgconfig(__appmansuffix__), Xserver(__appmansuffix__), X(__miscmansuffix__)
+.SH AUTHORS
+Authors include: Michel Danzer <michel-at-tungstengraphics-dot-com>, Thomas Hellstrom <thomas-at-tungstengraphics-dot-com> and Alan Hourihane <alanh-at-tungstengraphics-dot-com>
+.TP