summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorRussell King <rmk_cubox@arm.linux.org.uk>2013-05-23 00:40:18 +0100
committerRussell King <rmk@arm.linux.org.uk>2013-06-14 13:07:17 +0100
commit204ea08a1598909ae05c217e1e7ca709776efbde (patch)
tree326c2fd3d998707e83365ac5f156c98f0fff3956 /man
downloadxf86-video-armada-204ea08a1598909ae05c217e1e7ca709776efbde.tar.gz
xf86-video-armada-204ea08a1598909ae05c217e1e7ca709776efbde.tar.xz
Initial checkin of Marvell Armada xorg driver
Signed-off-by: Russell King <rmk_cubox@arm.linux.org.uk>
Diffstat (limited to 'man')
-rw-r--r--man/Makefile.am59
-rw-r--r--man/armada.man84
2 files changed, 143 insertions, 0 deletions
diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..203490e
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,59 @@
+# $Id: Makefile.am,v 1.1 2009/01/08 02:25:52 tarang Exp $
+#
+# 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/armada.man b/man/armada.man
new file mode 100644
index 0000000..8764ee8
--- /dev/null
+++ b/man/armada.man
@@ -0,0 +1,84 @@
+.\" $XFree86: xc/programs/Xserver/hw/xfree86/drivers/fbdev/fbdev.man,v 1.2 2001/01/27 18:20:47 dawes Exp $
+.\" shorthand for double quote that works everywhere.
+.ds q \N'34'
+.TH ARMADA __drivermansuffix__ __vendorversion__
+.SH NAME
+armada \- Marvell Armada 510 Xorg driver
+.SH SYNOPSIS
+.nf
+.B "Section \*qDevice\*q"
+.BI " Identifier \*q" devname \*q
+.B " Driver \*qarmada\*q"
+.BI " BusID \*qplatform:armada-drm:" id \*q
+\ \ ...
+.B EndSection
+.fi
+.SH DESCRIPTION
+.B armada
+is an __xservername__ driver for Marvell Armada SoCs. This is an accelerated
+driver, the following framebuffer depths are supported: 8, 15, 16, 24.
+All visual types are supported for depth 8, and TrueColor visual is
+supported for the other depths. The driver has preliminary support for
+the Direct Rendering Infrastructure (DRI). Multi-head configurations are
+supported.
+.PP
+Support for video overlay is provided, supporting I420, YV12, I422, YUY2,
+UYVY, VYUY and YV16 formats. The common I420 and YV12 formats are
+converted on the fly by this driver to I422 and YV16 for the hardware.
+Support is also provided for video overlay using an XVBO format, which
+can be used to pass a drm buffer handle to the video overlay backend, as
+well as Marvell's special
+.B libbmm
+based method.
+.SH SUPPORTED HARDWARE
+The
+.B armada
+driver currently supports the Marvell Armada 510 LCD controller(s).
+.PP
+.B armada
+communicates with the Linux Kernel Direct Rendering Manager (drm) layer
+to control and arbitrate access to the hardware. Kernel drm support is
+required.
+.SH CONFIGURATION DETAILS
+Please refer to __xconfigfile__(__filemansuffix__) for general configuration
+details. This section only covers configuration details specific to
+this driver.
+.PP
+For this driver it is not required to specify modes in the screen
+section of the config file. The
+.B armada
+driver will request video mode information from the Linux Kernel drm layer.
+.PP
+The VideoRAM option is ignored by this driver; video memory is managed
+by the Linux Kernel drm layer using system memory.
+.PP
+The following driver
+.B Options
+are supported:
+.TP
+.BI "Option \*qHotplug\*q \*q" boolean \*q
+This option controls whether the driver automatically notifies when
+monitors are connected or disconnected.
+.IP
+Default: enabled.
+.TP
+.BI "Option \*qHWcursor\*q \*q" boolean \*q
+Enable or disable use of the hardware cursor.
+.IP
+Default: disabled.
+.TP
+.BI "Option \*qUseGPU\*q \*q" boolean \*q
+Enable or disable use of the Vivante GPU for acceleration.
+.IP
+Default: enabled.
+.TP
+.BI "Option \*qXvAccel\*q \*q" boolean \*q
+Enable or disable the X Video backend.
+.IP
+Default: enabled.
+.TP
+.SH "SEE ALSO"
+__xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), xorgconfig(__appmansuffix__), Xserver(__appmansuffix__),
+X(__miscmansuffix__)
+.SH AUTHORS
+Authors include: Gerd Knorr, Michel Dänzer, Geert Uytterhoeven, Russell King.