amdgpu.man revision 11bf0794 
1.ds q \N'34'
2.TH AMDGPU __drivermansuffix__ __vendorversion__
3.SH NAME
4amdgpu \- AMD RADEON GPU video driver
5.SH SYNOPSIS
6.nf
7.B "Section \*qDevice\*q"
8.BI "  Identifier \*q"  devname \*q
9.B  "  Driver \*qamdgpu\*q"
10\ \ ...
11.B EndSection
12.fi
13.SH DESCRIPTION
14.B amdgpu
15is an __xservername__ driver for AMD RADEON-based video cards with the
16following features:
17.PP
18.PD 0
19.TP 2
20\(bu
21Support for 24-bit pixel depth;
22.TP
23\(bu
24RandR support up to version 1.4;
25.TP
26\(bu
273D acceleration;
28.PD
29.SH SUPPORTED HARDWARE
30The
31.B amdgpu
32driver supports SI and newer families' video cards.
33.PD
34.SH CONFIGURATION DETAILS
35Please refer to __xconfigfile__(__filemansuffix__) for general configuration
36details.  This section only covers configuration details specific to this
37driver.
38.PP
39The following driver
40.B Options
41are supported:
42.TP
43.BI "Option \*qSWcursor\*q \*q" boolean \*q
44Selects software cursor.  The default is
45.B off.
46.TP
47.BI "Option \*qAccel\*q \*q" boolean \*q
48Enables or disables all hardware acceleration.
49.br
50The default is
51.B on.
52
53.TP
54.BI "Option \*qZaphodHeads\*q \*q" string \*q
55Specify the RandR output(s) to use with zaphod mode for a particular driver
56instance.  If you use this option you must use this option for all instances
57of the driver.
58.br
59For example:
60.B
61Option \*qZaphodHeads\*q \*qLVDS,VGA-0\*q
62will assign xrandr outputs LVDS and VGA-0 to this instance of the driver.
63.TP
64.BI "Option \*qDRI\*q \*q" integer \*q
65Define the maximum level of DRI to enable. Valid values are 2 for DRI2 or 3 for DRI3.
66The default is
67.B 3 for DRI3
68if the Xorg version is >= 1.18.3, otherwise
69.B 2 for DRI2.
70.TP
71.BI "Option \*qEnablePageFlip\*q \*q" boolean \*q
72Enable DRI2 page flipping.  The default is
73.B on.
74.TP
75.BI "Option \*qTearFree\*q \*q" boolean \*q
76Set the default value of the per-output 'TearFree' property, which controls
77tearing prevention using the hardware page flipping mechanism. TearFree is
78on for any CRTC associated with one or more outputs with TearFree on. Two
79separate scanout buffers need to be allocated for each CRTC with TearFree
80on. While TearFree is on for any CRTC, it currently prevents clients from using
81DRI page flipping. If this option is set, the default value of the property is
82'on' or 'off' accordingly. If this option isn't set, the default value of the
83property is
84.B auto,
85which means that TearFree is on for outputs with rotation or other RandR
86transforms, and for RandR 1.4 slave outputs, otherwise off.
87.TP
88.BI "Option \*qAccelMethod\*q \*q" string \*q
89Setting this option to
90.B none
91disables use of the glamor acceleration architecture. In that case, all 2D
92rendering is done by the CPU, but 3D and video hardware acceleration can still
93work. This is mainly useful for OpenGL driver bring-up.
94.br
95The default is to use glamor.
96
97.PP
98The following driver
99.B Option
100is supported for
101.B glamor
102:
103.TP
104.BI "Option \*qShadowPrimary\*q \*q" boolean \*q
105This option enables a so-called "shadow primary" buffer for fast CPU access to
106pixel data, and separate scanout buffers for each display controller (CRTC).
107This may improve performance for some 2D workloads, potentially at the expense
108of other (e.g. 3D, video) workloads.
109Note in particular that enabling this option currently disables page flipping.
110The default is
111.B off.
112
113.SH SEE ALSO
114__xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), Xserver(__appmansuffix__), X(__miscmansuffix__)
115.IP " 1." 4
116Wiki page:
117.RS 4
118http://www.x.org/wiki/radeon
119.RE
120.IP " 2." 4
121Overview about amdgpu development code:
122.RS 4
123http://cgit.freedesktop.org/xorg/driver/xf86-video-amdgpu/
124.RE
125.IP " 3." 4
126Mailing list:
127.RS 4
128http://lists.freedesktop.org/mailman/listinfo/amd-gfx
129.RE
130.IP " 4." 4
131IRC channel:
132.RS 4
133#radeon on irc.freenode.net
134.RE
135.IP " 5." 4
136Query the bugtracker for amdgpu bugs:
137.RS 4
138https://bugs.freedesktop.org/query.cgi?product=xorg&component=Driver/AMDgpu
139.RE
140.IP " 6." 4
141Submit bugs & patches:
142.RS 4
143https://bugs.freedesktop.org/enter_bug.cgi?product=xorg&component=Driver/AMDgpu
144.RE
145
146.SH AUTHORS
147.nf
148Authors include:
149Michel D\(:anzer            \fImichel@daenzer.net\fP
150Alex Deucher             \fIalexdeucher@gmail.com\fP
151