Commit 15a30609 authored by Harm Hanemaaijer's avatar Harm Hanemaaijer
Browse files

Update man page and README to reflect diverse platform support



Update the man page and bring it up-to-date, reflecting the fact
that the driver also supports non-sunxi platforms. Add description
of the "XVHWOverlay" option.

Also a small update to the README for similar reasons.
Signed-off-by: default avatarHarm Hanemaaijer <fgenfb@yahoo.com>
parent d39ccbfe
xf86-video-sunxifb - video driver for the devices based on Allwinner A10/A13 SoC xf86-video-sunxifb - video driver for devices based on the Allwinner A10/A13 SoC,
and other ARM-based devices.
Please submit bugs & patches to: Please submit bugs & patches to:
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
.ds q \N'34' .ds q \N'34'
.TH SUNXIFB __drivermansuffix__ __vendorversion__ .TH SUNXIFB __drivermansuffix__ __vendorversion__
.SH NAME .SH NAME
sunxifb \- video driver for the devices based on Allwinner A10/A13 SoC sunxifb \- video driver for Allwinner and other ARM-based devices
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B "Section \*qDevice\*q" .B "Section \*qDevice\*q"
...@@ -13,14 +13,15 @@ sunxifb \- video driver for the devices based on Allwinner A10/A13 SoC ...@@ -13,14 +13,15 @@ sunxifb \- video driver for the devices based on Allwinner A10/A13 SoC
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
.B sunxifb .B sunxifb
is an __xservername__ driver for the devices based on Allwinner A10/A13 SoC, is an __xservername__ driver for Allwinner and other ARM-based devices,
derived from derived from
.B fbdev .B fbdev
driver. driver.
With the regards to 2D graphics, currently it only supports sofware rendering. With regard to 2D graphics, it provides a number of software optimizations
However at least it tries to let the SIMD (ARM NEON) accelerated code from the on all platforms, while letting the SIMD (ARM NEON) accelerated code from the
.B pixman .B pixman
library run at full speed without any unnecessary overhead. The recommended library run at full speed without any unnecessary overhead. 2D hardware
acceleration using G2D is supported on sunxi platforms. The recommended
framebuffer color depths are 16 (RGB565) and 24 (XRGB8888), the other color framebuffer color depths are 16 (RGB565) and 24 (XRGB8888), the other color
depths may be supported too. Multi-head configurations are supported. depths may be supported too. Multi-head configurations are supported.
.SH SUPPORTED HARDWARE .SH SUPPORTED HARDWARE
...@@ -56,7 +57,9 @@ are supported: ...@@ -56,7 +57,9 @@ are supported:
The framebuffer device to use. Default: /dev/fb0. The framebuffer device to use. Default: /dev/fb0.
.TP .TP
.BI "Option \*qShadowFB\*q \*q" boolean \*q .BI "Option \*qShadowFB\*q \*q" boolean \*q
Enable or disable use of the shadow framebuffer layer. Default: on. Enable or disable use of the shadow framebuffer layer. Default: off on
most platforms (any hardware that supports NEON, VFP, or 2D hardware
acceleration).
.TP .TP
.BI "Option \*qRotate\*q \*q" string \*q .BI "Option \*qRotate\*q \*q" string \*q
Enable rotation of the display. The supported values are "CW" (clockwise, Enable rotation of the display. The supported values are "CW" (clockwise,
...@@ -77,7 +80,8 @@ Same as "UseBackingStore" option, but don't apply any heuristics and just ...@@ -77,7 +80,8 @@ Same as "UseBackingStore" option, but don't apply any heuristics and just
allocate backing store for all windows. allocate backing store for all windows.
.TP .TP
.BI "Option \*qHWCursor\*q \*q" boolean \*q .BI "Option \*qHWCursor\*q \*q" boolean \*q
Enable or disable the HW cursor. Default: on. Enable or disable the HW cursor. Supported on sunxi platforms. Default: on
if supported, off otherwise.
.TP .TP
.BI "Option \*qDRI2\*q \*q" boolean \*q .BI "Option \*qDRI2\*q \*q" boolean \*q
Enable or disable DRI2 integration for Mali GPU. Provides hardware Enable or disable DRI2 integration for Mali GPU. Provides hardware
...@@ -105,8 +109,16 @@ Chooses between available acceleration architectures. Valid values are ...@@ -105,8 +109,16 @@ Chooses between available acceleration architectures. Valid values are
.B G2D .B G2D
and and
.B CPU. .B CPU.
G2D is only available on sunxi hardware with G2D support (such as A10).
The default is The default is
.B G2D. .B G2D
on supported platforms, CPU on others.
.TP
.BI "Option \*qXVHWOverlay\*q \*q" boolean \*q
Enable or disable the use of display controller hardware overlays for
XVideo acceleration. Only available on sunxi hardware.
Default: on if supported, off otherwise.
.SH "SEE ALSO" .SH "SEE ALSO"
__xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), Xserver(__appmansuffix__), __xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), Xserver(__appmansuffix__),
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment