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 8-, 15-, 16-, 24- and 30-bit pixel depths;
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. If this option is set, the default value of the property is 'on' or 'off'
81accordingly. If this option isn't set, the default value of the property is
82.B auto,
83which means that TearFree is on for rotated outputs, outputs with RandR
84transforms applied and for RandR 1.4 secondary outputs, otherwise off.
85.TP
86.BI "Option \*qVariableRefresh\*q \*q" boolean \*q
87Enables support for enabling variable refresh on the Screen's CRTCs
88when an suitable application is flipping via the Present extension.
89.br
90The default is
91.B off.
92.TP
93.BI "Option \*qAsyncFlipSecondaries\*q \*q" boolean \*q
94Use async flips for secondary video outputs on multi-display setups. If a screen
95has multiple displays attached and DRI3 page flipping is used, then only one of
96the displays will have its page flip synchronized to vblank for tear-free
97presentation. This is the display that is used for presentation timing and
98timestamping, usually the one covering the biggest pixel area of the screen.
99All other displays ("Secondaries") will not synchronize their flips. This may
100cause some tearing on these displays, but it prevents a permanent or periodic
101slowdown or irritating judder of animations if not all video outputs are running
102synchronized with each other and with the same refresh rate. There is no perfect
103solution apart from perfectly synchronized outputs, but this option may give
104preferrable results if the displays in a multi-display setup mirror or clone
105each other.  The default is
106.B off.
107.TP
108.BI "Option \*qAccelMethod\*q \*q" string \*q
109Setting this option to
110.B none
111disables use of the glamor acceleration architecture. In that case, all 2D
112rendering is done by the CPU, but 3D and video hardware acceleration can still
113work. This is mainly useful for OpenGL driver bring-up.
114.br
115The default is to use glamor.
116
117.PP
118The following driver
119.B Option
120is supported for
121.B glamor
122:
123.TP
124.BI "Option \*qShadowPrimary\*q \*q" boolean \*q
125This option enables a so-called "shadow primary" buffer for fast CPU access to
126pixel data, and separate scanout buffers for each display controller (CRTC).
127This may improve performance for some 2D workloads, potentially at the expense
128of other (e.g. 3D, video) workloads.
129Note in particular that enabling this option currently disables page flipping.
130The default is
131.B off.
132
133.SH SEE ALSO
134__xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), Xserver(__appmansuffix__), X(__miscmansuffix__)
135.IP " 1." 4
136Wiki page:
137.RS 4
138https://www.x.org/wiki/radeon
139.RE
140.IP " 2." 4
141Overview about amdgpu development code:
142.RS 4
143https://gitlab.freedesktop.org/xorg/driver/xf86-video-amdgpu
144.RE
145.IP " 3." 4
146Mailing list:
147.RS 4
148https://lists.freedesktop.org/mailman/listinfo/amd-gfx
149.RE
150.IP " 4." 4
151IRC channel:
152.RS 4
153#radeon on irc.freenode.net
154.RE
155.IP " 5." 4
156The bugtracker for amdgpu bugs:
157.RS 4
158https://gitlab.freedesktop.org/xorg/driver/xf86-video-amdgpu/-/issues
159.RE
160.IP " 6." 4
161Submit merge requests:
162.RS 4
163https://gitlab.freedesktop.org/xorg/driver/xf86-video-amdgpu/-/merge_requests
164.RE
165
166.SH AUTHORS
167.nf
168Authors include:
169Michel D\(:anzer            \fImichel@daenzer.net\fP
170Alex Deucher             \fIalexdeucher@gmail.com\fP
171