Ticket #7697: x7driver-amdgpu.xml

File x7driver-amdgpu.xml, 8.6 KB (added by Armin K, 7 years ago)
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY radeon-wiki "http://wiki.x.org/wiki/RadeonFeature">
8 <!ENTITY radeon-marketing-names "&radeon-wiki;#Decoder_ring_for_engineering_vs_marketing_names">
9
10 <!ENTITY xorg-amdgpu-driver-version "7.8.0">
11
12 <!ENTITY xorg-amdgpu-driver-download-http "&xorg-download-http;/driver/xf86-video-amdgpu-&xorg-amdgpu-driver-version;.tar.bz2">
13 <!ENTITY xorg-amdgpu-driver-download-ftp "&xorg-download-ftp;/driver/xf86-video-amdgpu-&xorg-amdgpu-driver-version;.tar.bz2">
14 <!ENTITY xorg-amdgpu-driver-md5sum "f34d04a755e761e03b459155fa3ddcbb">
15 <!ENTITY xorg-amdgpu-driver-size "826 KB">
16 <!ENTITY xorg-amdgpu-driver-buildsize "19 MB">
17 <!ENTITY xorg-amdgpu-driver-time "0.2 SBU">
18]>
19
20 <!-- Begin Xorg AMDGPU Driver -->
21 <sect2 id="xorg-amdgpu-driver" xreflabel="Xorg AMDGPU Driver-&xorg-amdgpu-driver-version;">
22
23 <sect2info>
24 <othername>$LastChangedBy: ken $</othername>
25 <date>$Date: 2016-11-21 02:40:26 +0100 (Pon, 21 Nov 2016) $</date>
26 </sect2info>
27
28 <title>Xorg AMDGPU Driver-&xorg-amdgpu-driver-version;</title>
29
30 <indexterm zone="xorg-amdgpu-driver">
31 <primary sortas="a-xorg-amdgpu-driver">xorg-amdgpu-driver</primary>
32 </indexterm>
33
34 <sect3 role="package">
35 <title>Introduction to Xorg AMDGPU Driver</title>
36
37 <para>
38 The <application>Xorg AMDGPU Driver</application> package contains the X.Org
39 Video Driver for newer AMD Radeon video cards starting from Volcanic Islands.
40 It can also be used for Southern and Sea Islands if the experimental support
41 was enabled in the kernel.
42 </para>
43
44 &lfs7a_built;
45
46 <note>
47 <para>
48 For Direct Rendering to work, you need to enable the radeonsi Gallium
49 driver at <xref linkend="mesa"/> build time. Also, all cards
50 require Firmware to be available when the kernel driver is loaded.
51 Firmware can be obtained from <ulink
52 url="&sources-anduin-http;/linux-firmware/"/>.
53 See <xref linkend="xorg-amdgpu-firmware-kernel"/> below for additional
54 firmware.
55 </para>
56 </note>
57
58 <bridgehead renderas="sect4">Package Information</bridgehead>
59 <itemizedlist spacing="compact">
60 <listitem>
61 <para>
62 Download (HTTP): <ulink url="&xorg-amdgpu-driver-download-http;"/>
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Download (FTP): <ulink url="&xorg-amdgpu-driver-download-ftp;"/>
68 </para>
69 </listitem>
70 <listitem>
71 <para>
72 Download MD5 sum: &xorg-amdgpu-driver-md5sum;
73 </para>
74 </listitem>
75 <listitem>
76 <para>
77 Download size: &xorg-amdgpu-driver-size;
78 </para>
79 </listitem>
80 <listitem>
81 <para>
82 Estimated disk space required: &xorg-amdgpu-driver-buildsize;
83 </para>
84 </listitem>
85 <listitem>
86 <para>
87 Estimated build time: &xorg-amdgpu-driver-time;
88 </para>
89 </listitem>
90 </itemizedlist>
91
92 <bridgehead renderas="sect4">Xorg AMDGPU Driver Dependencies</bridgehead>
93
94 <bridgehead renderas="sect5">Required</bridgehead>
95 <para role="required">
96 <xref linkend="xorg-server"/> (must be built with glamor enabled)
97 </para>
98
99 <para condition="html" role="usernotes">
100 User Notes: <ulink url="&blfs-wiki;/xorg-amdgpu-driver"/>
101 </para>
102 </sect3>
103
104 <sect3 role="kernel" id="xorg-amdgpu-driver-kernel">
105 <title>Kernel Configuration</title>
106
107 <para>
108 Enable the following options in the kernel configuration and recompile
109 the kernel if necessary:
110 </para>
111
112<!-- Editor note: CONFIG_DRM_AMDGPU_SI available in 4.9+ -->
113<screen><literal>Device Drivers ---&gt;
114 Graphics support ---&gt;
115 &lt;*&gt; Direct Rendering Manager (XFree86 ... support) ---&gt; [CONFIG_DRM]
116 &lt;*/M&gt; AMD GPU [CONFIG_DRM_AMDGPU]
117 [ /*] Enable amdgpu support for SI parts [CONFIG_DRM_AMDGPU_SI]
118 [ /*] Enable amdgpu support for CIK parts [CONFIG_DRM_AMDGPU_CIK]</literal></screen>
119
120 <para>
121 The last two options enable experimental support for Southern and
122 Sea Islands AMD GPUs so they can be used with this driver. Note that
123 the support is marked experimental and disabled by default.
124 <xref linkend="xorg-ati-driver"/> should be used for those GPUs.
125 </para>
126
127 <indexterm zone="xorg-amdgpu-driver xorg-amdgpu-driver-kernel">
128 <primary sortas="d-xorg-amdgpu-driver">xorg-amdgpu-driver</primary>
129 </indexterm>
130 </sect3>
131
132 <sect3 role="kernel" id="xorg-amdgpu-firmware-kernel">
133 <title>Kernel Configuration for additional firmware</title>
134
135 <para>
136 If you need to add firmware, install the file(s) and then point to them in the
137 kernel configuration and recompile the kernel if necessary. To find out which
138 firmware you need, consult the <ulink url="&radeon-marketing-names;">
139 Decoder ring for engineering vs marketing names</ulink>. Download any firmware
140 for your card which is named like:
141 <filename><replaceable>&lt;ENGINEERING_NAME&gt;</replaceable>_rlc.bin</filename>,
142 etc. Below is an example for Radeon R7 M340 GPU, which is codenamed
143 Iceland/Topaz, along with a network card that also requires the firmware:
144 </para>
145
146<screen><literal>CONFIG_EXTRA_FIRMWARE="amdgpu/topaz_ce.bin amdgpu/topaz_k_smc.bin amdgpu/topaz_mc.bin
147 amdgpu/topaz_me.bin amdgpu/topaz_mec2.bin amdgpu/topaz_mec.bin
148 amdgpu/topaz_pfp.bin amdgpu/topaz_rlc.bin amdgpu/topaz_sdma1.bin
149 amdgpu/topaz_sdma.bin amdgpu/topaz_smc.bin rtl_nic/rtl8168e-3.fw"
150CONFIG_EXTRA_FIRMWARE_DIR="/lib/firmware"</literal></screen>
151
152 <note>
153 <para>
154 CONFIG_EXTRA_FIRMWARE should all be on one line. It is shown above as
155 multiple lines for presentation only.
156 </para>
157 </note>
158
159 <tip>
160 <para>
161 You can check <command>dmesg</command> output after boot to see which firmware
162 is missing.
163 </para>
164 </tip>
165
166 <para>
167 Alternatively, if you change CONFIG_DRM_AMDGPU to '=m' in your .config
168 the firmware can be loaded automatically from /lib/firmware/radeon when
169 it installs the module. This offers a tiny space saving, but also means
170 that the screen will be blank for a longer time before the framebuffer
171 appears. Distros take this approach because it is not practical to
172 specify every possible firmware and the kernel would be excessively big.
173 </para>
174
175 <indexterm zone="xorg-amdgpu-driver xorg-amdgpu-firmware-kernel">
176 <primary sortas="d-xorg-amdgpu-firmware">xorg-amdgpu-firmware</primary>
177 </indexterm>
178 </sect3>
179
180 <sect3 role="installation">
181 <title>Installation of Xorg AMDGPU Driver</title>
182
183 <para>
184 Install <application>Xorg AMDGPU Driver</application> by running the following
185 commands:
186 </para>
187
188<screen><userinput>./configure $XORG_CONFIG &amp;&amp;
189make</userinput></screen>
190
191 <para>
192 This package does not come with a test suite.
193 </para>
194
195 <para>
196 Now, as the <systemitem class="username">root</systemitem> user:
197 </para>
198
199<screen role="root"><userinput>make install</userinput></screen>
200 </sect3>
201
202 <sect3 role="content">
203 <title>Contents</title>
204
205 <segmentedlist>
206 <segtitle>Installed Xorg Driver</segtitle>
207
208 <seglistitem>
209 <seg>
210 amdgpu_drv.so
211 </seg>
212 </seglistitem>
213 </segmentedlist>
214
215 <variablelist>
216 <bridgehead renderas="sect4">Short Descriptions</bridgehead>
217 <?dbfo list-presentation="list"?>
218 <?dbhtml list-presentation="table"?>
219
220 <varlistentry id="amdgpu_drv">
221 <term><filename class="libraryfile">amdgpu_drv.so</filename></term>
222 <listitem>
223 <para>
224 is an Xorg video driver for latest AMD Radeon video cards.
225 </para>
226 <indexterm zone="xorg-amdgpu-driver amdgpu_drv">
227 <primary sortas="c-amdgpu_drv">amdgpu_drv.so</primary>
228 </indexterm>
229 </listitem>
230 </varlistentry>
231
232 </variablelist>
233
234 </sect3>
235
236 </sect2>
237 <!-- End Xorg AMDGPU Driver -->