1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
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 | <!ENTITY linux-firmware-git "https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git">
|
---|
7 | ]>
|
---|
8 |
|
---|
9 | <sect1 id="postlfs-firmware" xreflabel="About Firmware">
|
---|
10 | <?dbhtml filename="firmware.html"?>
|
---|
11 |
|
---|
12 |
|
---|
13 | <title>About Firmware</title>
|
---|
14 |
|
---|
15 | <indexterm zone="postlfs-firmware">
|
---|
16 | <primary sortas="e-lib-firmware">/lib/firmware</primary>
|
---|
17 | </indexterm>
|
---|
18 |
|
---|
19 | <para>
|
---|
20 | On some recent PCs it can be necessary, or desirable, to load firmware
|
---|
21 | to make them work at their best. There is a directory, <filename
|
---|
22 | class="directory">/lib/firmware</filename>, where the kernel or kernel
|
---|
23 | drivers look for firmware images.
|
---|
24 | </para>
|
---|
25 |
|
---|
26 | <para>
|
---|
27 | Currently, most firmware can be found at a <userinput>git</userinput>
|
---|
28 | repository which can be viewed in the browser with the URL
|
---|
29 | <ulink url="&linux-firmware-git;/plain"/>.
|
---|
30 | For convenience, the LFS Project has created a mirror, updated daily, where
|
---|
31 | these firmware files can be accessed via <userinput>wget</userinput> or a
|
---|
32 | web browser at <ulink url="&sources-anduin-http;/linux-firmware/"/>.
|
---|
33 | </para>
|
---|
34 |
|
---|
35 | <para>
|
---|
36 | To get the firmware, point a browser to one of the above
|
---|
37 | repositories and then download the item(s) which you need. If you want
|
---|
38 | all these firmware files (for example you are distributing the system
|
---|
39 | onto multiple hardware systems), either install <xref linkend="git"/>
|
---|
40 | and clone <ulink url='&linux-firmware-git;'/>, or open this URL in a
|
---|
41 | browser and download the latest snapshot listed in the
|
---|
42 | <literal>Tag</literal> table.
|
---|
43 | </para>
|
---|
44 |
|
---|
45 | <para>
|
---|
46 | For some other firmware, particularly for Intel microcode and certain
|
---|
47 | wifi devices, the needed firmware is not available in the above repository.
|
---|
48 | Some of this will be addressed below, but a search of the Internet for
|
---|
49 | needed firmware is sometimes necessary.
|
---|
50 | </para>
|
---|
51 |
|
---|
52 | <para>
|
---|
53 | Firmware files are conventionally referred to as blobs because you cannot
|
---|
54 | determine what they will do. Note that firmware is distributed under
|
---|
55 | various different licenses which do not permit disassembly or
|
---|
56 | reverse-engineering.
|
---|
57 | </para>
|
---|
58 |
|
---|
59 | <para>
|
---|
60 | Firmware for PCs falls into four categories:
|
---|
61 | </para>
|
---|
62 |
|
---|
63 | <itemizedlist spacing="compact">
|
---|
64 | <listitem>
|
---|
65 | <para>
|
---|
66 | Updates to the CPU to work around errata, usually referred to as
|
---|
67 | microcode.
|
---|
68 | </para>
|
---|
69 | </listitem>
|
---|
70 | <listitem>
|
---|
71 | <para>
|
---|
72 | Firmware for video controllers. On x86 machines this is required for
|
---|
73 | ATI devices (Radeon and AMDGPU chips) and may be useful for Intel (Skylake
|
---|
74 | and later) and Nvidia (Kepler and later) GPUs.
|
---|
75 | </para>
|
---|
76 |
|
---|
77 | <para>
|
---|
78 | ATI Radeon and AMDGPU devices all require firmware to be able to use KMS
|
---|
79 | (kernel modesetting - the preferred option) as well as for Xorg. For
|
---|
80 | old radeon chips (before the R600), the firmware is still in the
|
---|
81 | kernel source.
|
---|
82 | </para>
|
---|
83 |
|
---|
84 | <para>
|
---|
85 | Intel integrated GPUs from Skylake onwards can use firmware for GuC
|
---|
86 | (the Graphics microcontroller), and also for the HuC (HEVC/H265
|
---|
87 | microcontroller which offloads to the GPU) and the DMC (Display
|
---|
88 | Microcontroller) to provide additional low-power states. The GuC and
|
---|
89 | HuC have had a chequered history in the kernel and updated firmware
|
---|
90 | may be disabled by default, depending on your kernel version. Further
|
---|
91 | details may be found at <ulink
|
---|
92 | url="https://01.org/linuxgraphics/downloads/firmware/">01.org</ulink>
|
---|
93 | and <ulink
|
---|
94 | url="https://wiki.archlinux.org/index.php/intel_graphics">Arch
|
---|
95 | linux</ulink>.
|
---|
96 | </para>
|
---|
97 |
|
---|
98 | <para>
|
---|
99 | Nvidia GPUs from Kepler onwards require signed firmware, otherwise the
|
---|
100 | nouveau driver is unable to provide hardware acceleration. Nvidia has
|
---|
101 | now released firmware up to Ampere (GeForce30 series) to linux-firmware.
|
---|
102 | Note that faster clocks than the default are not enabled
|
---|
103 | by the released firmware.
|
---|
104 | </para>
|
---|
105 | </listitem>
|
---|
106 | <listitem>
|
---|
107 | <para>
|
---|
108 | Firmware updates for wired network ports. Most of them work even
|
---|
109 | without the updates, but they will probably work better with
|
---|
110 | the updated firmware. For some modern laptops, firmware for both
|
---|
111 | wired ethernet (e.g. rtl_nic) and also for bluetooth devices (e.g. qca)
|
---|
112 | is <emphasis>required</emphasis> before the wired network can be used.
|
---|
113 | </para>
|
---|
114 | </listitem>
|
---|
115 | <listitem>
|
---|
116 | <para>
|
---|
117 | Firmware for other devices, such as wireless NICs. These devices are not
|
---|
118 | required for the PC to boot, but need the firmware before these devices
|
---|
119 | can be used.
|
---|
120 | </para>
|
---|
121 | </listitem>
|
---|
122 | </itemizedlist>
|
---|
123 |
|
---|
124 | <note>
|
---|
125 | <para>
|
---|
126 | Although not needed to load a firmware blob, the following
|
---|
127 | tools may be useful for determining, obtaining, or preparing the needed
|
---|
128 | firmware in order to load it into the system:
|
---|
129 | <xref linkend="cpio"/>,
|
---|
130 | <xref linkend="git"/>,
|
---|
131 | <xref linkend="pciutils"/>, and
|
---|
132 | <xref linkend="wget"/>
|
---|
133 | </para>
|
---|
134 | </note>
|
---|
135 |
|
---|
136 |
|
---|
137 | <sect2 id="cpu-microcode">
|
---|
138 | <title>Microcode updates for CPUs</title>
|
---|
139 |
|
---|
140 | <para>
|
---|
141 | In general, microcode can be loaded by the BIOS or UEFI, and it might be
|
---|
142 | updated by upgrading to a newer version of those. On linux, you can also
|
---|
143 | load the microcode from the kernel if you are using an AMD family 10h or
|
---|
144 | later processor (first introduced late 2007), or an Intel processor from
|
---|
145 | 1998 and later (Pentium4, Core, etc), if updated microcode has been
|
---|
146 | released. These updates only last until the machine is powered off, so
|
---|
147 | they need to be applied on every boot.
|
---|
148 | </para>
|
---|
149 |
|
---|
150 | <para>
|
---|
151 | Intel provide updates of their microcode for Skylake and later
|
---|
152 | processors as new vulnerabilities come to light, and have in the past
|
---|
153 | provided updates for processors from SandyBridge onwards, although those
|
---|
154 | are no-longer supported for new fixes. New versions of AMD
|
---|
155 | firmware are rare and usually only apply to a few models, although
|
---|
156 | motherboard manufacturers get AGESA (AMD Generic Encapsulated Software
|
---|
157 | Architecture) updates to change BIOS values, e.g. to support more memory
|
---|
158 | variants, new vulnerability fixes or newer CPUs.
|
---|
159 | </para>
|
---|
160 |
|
---|
161 | <para>
|
---|
162 | There were two ways of loading the microcode, described as 'early' and
|
---|
163 | 'late'. Early loading happens before userspace has been started, late
|
---|
164 | loading happens after userspace has started. However, late loading is
|
---|
165 | known to be problematic and not supported anymore (see the kernel commit
|
---|
166 | <ulink url="https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d23d33e">
|
---|
167 | x86/microcode: Taint and warn on late loading</ulink>). Indeed, early
|
---|
168 | loading is needed to work around one particular erratum in early Intel
|
---|
169 | Haswell processors which had TSX enabled. (See <ulink url=
|
---|
170 | "https://www.anandtech.com/show/8376/intel-disables-tsx-instructions-erratum-found-in-haswell-haswelleep-broadwelly/">
|
---|
171 | Intel Disables TSX Instructions: Erratum Found in Haswell,
|
---|
172 | Haswell-E/EP, Broadwell-Y</ulink>.)
|
---|
173 | Without this update glibc can do the wrong thing in uncommon
|
---|
174 | situations.
|
---|
175 | </para>
|
---|
176 |
|
---|
177 | <para>
|
---|
178 | In previous versions of this book, late loading of microcode to see if
|
---|
179 | it gets applied was recommended, followed by using an initrd to force
|
---|
180 | early loading. But now that the contents of the Intel microcode tarball
|
---|
181 | is documented, and AMD microcode can be read by a Python script to
|
---|
182 | determine which machines it covers, there is no real reason to use late
|
---|
183 | loading.
|
---|
184 | </para>
|
---|
185 |
|
---|
186 | <para>
|
---|
187 | It might be still possible to manually force late loading of microcode.
|
---|
188 | But it may cause kernel malfunction and you should take the risk yourself.
|
---|
189 | You will need to reconfigure your kernel for late loading, but
|
---|
190 | early loading is always supported by Linux kernel version 6.6
|
---|
191 | or later on a x86 (no matter 32-bit or 64-bit) system. The
|
---|
192 | instructions here will show you how to create an initrd for early
|
---|
193 | loading. It is also possible to build the same microcode bin file into
|
---|
194 | the kernel, which allows early loading but requires the kernel to be
|
---|
195 | recompiled to update the microcode.
|
---|
196 | </para>
|
---|
197 |
|
---|
198 | <para>
|
---|
199 | To confirm what processor(s) you have (if more than one, they will be
|
---|
200 | identical) look in /proc/cpuinfo. Determine the decimal values of the cpu
|
---|
201 | family, model and stepping by running the following command (it will also
|
---|
202 | report the current microcode version):
|
---|
203 | </para>
|
---|
204 |
|
---|
205 | <screen><userinput>head -n7 /proc/cpuinfo</userinput></screen>
|
---|
206 |
|
---|
207 | <para>
|
---|
208 | Convert the cpu family, model and stepping to pairs of hexadecimal
|
---|
209 | digits, and remember the value of the <quote>microcode</quote> field.
|
---|
210 | You can now check if there is any microcode available.
|
---|
211 | </para>
|
---|
212 |
|
---|
213 | <para>
|
---|
214 | If you are creating an initrd to update firmware for different machines,
|
---|
215 | as a distro would do, go down to 'Early loading of microcode' and cat all
|
---|
216 | the Intel blobs to GenuineIntel.bin or cat all the AMD blobs to
|
---|
217 | AuthenticAMD.bin. This creates a larger initrd - for all Intel machines in
|
---|
218 | the 20200609 update the size was 3.0 MB compared to typically 24 KB for one
|
---|
219 | machine.
|
---|
220 | </para>
|
---|
221 |
|
---|
222 | <sect3 id="intel-microcode">
|
---|
223 | <title>Intel Microcode for the CPU</title>
|
---|
224 |
|
---|
225 | <para>
|
---|
226 | The first step is to get the most recent version of the Intel
|
---|
227 | microcode. This must be done by navigating to <ulink url=
|
---|
228 | 'https://github.com/intel/Intel-Linux-Processor-Microcode-Data-Files/releases/'/>
|
---|
229 | and downloading the latest file there. As of this writing the most
|
---|
230 | secure version of the microcode is microcode-&intel-microcode-version;.
|
---|
231 | Extract this file in the normal way, the microcode is in the
|
---|
232 | <filename>intel-ucode </filename> directory, containing various blobs
|
---|
233 | with names in the form XX-YY-ZZ. There are also various other files,
|
---|
234 | and a release note.
|
---|
235 | </para>
|
---|
236 |
|
---|
237 | <para>
|
---|
238 | In the past, intel did not provide any details of which blobs had
|
---|
239 | changed versions, but now the release note details this. You can
|
---|
240 | compare the microcode version in <filename>/proc/cpuinfo</filename>
|
---|
241 | with the version for your CPU model in the releasenote to know if
|
---|
242 | there is an update.
|
---|
243 | </para>
|
---|
244 |
|
---|
245 | <para>
|
---|
246 | The recent firmware for older processors is provided to deal with
|
---|
247 | vulnerabilities which have now been made public, and for some of these
|
---|
248 | such as Microarchitectural Data Sampling (MDS) you might wish to
|
---|
249 | increase the protection by disabling hyperthreading, or alternatively
|
---|
250 | to disable the kernel's default mitigation because of its impact on
|
---|
251 | compile times. Please read the online documentation at <ulink url=
|
---|
252 | 'https://www.kernel.org/doc/html/latest/admin-guide/hw-vuln/index.html'/>.
|
---|
253 | </para>
|
---|
254 |
|
---|
255 | <para>
|
---|
256 | For an Tigerlake mobile (described as Intel(R) Core(TM) i5-11300H
|
---|
257 | CPU) the relevant values are cpu family 6, model 140, stepping 1 so
|
---|
258 | in this case the required identification is 06-8c-01. The
|
---|
259 | releasenote says the latest microcode for it is versioned 0xb8. If
|
---|
260 | the value of the <quote>microcode</quote> field in
|
---|
261 | <filename>/proc/cpuinfo</filename> is 0xb8 or greater, it indicates
|
---|
262 | the microcode update is already applied by the BIOS. Otherwise,
|
---|
263 | proceed to <xref linkend='early-microcode'/>.
|
---|
264 | </para>
|
---|
265 | </sect3>
|
---|
266 |
|
---|
267 | <sect3 id="amd-microcode">
|
---|
268 | <title>AMD Microcode for the CPU</title>
|
---|
269 |
|
---|
270 | <para>
|
---|
271 | Begin by downloading a container of firmware for your CPU family
|
---|
272 | from <ulink url=
|
---|
273 | '&sources-anduin-http;/linux-firmware/amd-ucode/'/>.
|
---|
274 | The family is always specified in hex. Families 10h to 14h (16 to 20)
|
---|
275 | are in microcode_amd.bin. Families 15h, 16h, 17h (Zen, Zen+, Zen2) and
|
---|
276 | 19h (Zen3) have their own containers, but very few machines are likely to
|
---|
277 | get updated microcode. Instead, AMD provide an updated AGESA to the
|
---|
278 | motherboard makers, who may provide an updated BIOS using this.
|
---|
279 | There is a Python3 script at <ulink url=
|
---|
280 | 'https://github.com/AMDESE/amd_ucode_info/blob/master/amd_ucode_info.py'/>.
|
---|
281 | Download that script and run it against the bin file to check which
|
---|
282 | processors have updates.
|
---|
283 | </para>
|
---|
284 |
|
---|
285 | <para>
|
---|
286 | For the very old Athlon(tm) II X2 in these examples the values were
|
---|
287 | cpu family 16, model 5, stepping 3 giving an identification of
|
---|
288 | Family=0x10 Model=0x05 Stepping=0x03. One line of the
|
---|
289 | <command>amd_ucode_info.py</command> script output describes the
|
---|
290 | microcode version for it:
|
---|
291 | </para>
|
---|
292 |
|
---|
293 | <screen><computeroutput>Family=0x10 Model=0x05 Stepping=0x03: Patch=0x010000c8 Length=960 bytes</computeroutput></screen>
|
---|
294 |
|
---|
295 | <para>
|
---|
296 | If the value of the <quote>microcode</quote> field in
|
---|
297 | <filename>/proc/cpuinfo</filename> is 0x10000c8 or greater, it
|
---|
298 | indicates the BIOS has already applied the microcode update.
|
---|
299 | Otherwise, proceed to <xref linkend='early-microcode'/>.
|
---|
300 | </para>
|
---|
301 | </sect3>
|
---|
302 |
|
---|
303 | <sect3 id="early-microcode">
|
---|
304 | <title>Early loading of microcode</title>
|
---|
305 |
|
---|
306 | <para>
|
---|
307 | If you have established that updated microcode is available for
|
---|
308 | your system, it is time to prepare it for early loading. This requires
|
---|
309 | an additional package, <xref linkend='cpio'/> and the creation of an
|
---|
310 | initrd which will need to be added to grub.cfg.
|
---|
311 | </para>
|
---|
312 |
|
---|
313 | <para>
|
---|
314 | It does not matter where you prepare the initrd, and once it is
|
---|
315 | working you can apply the same initrd to later LFS systems or newer
|
---|
316 | kernels on this same machine, at least until any newer microcode is
|
---|
317 | released. Use the following commands:
|
---|
318 | </para>
|
---|
319 |
|
---|
320 | <screen><userinput>mkdir -p initrd/kernel/x86/microcode
|
---|
321 | cd initrd</userinput></screen>
|
---|
322 |
|
---|
323 | <para>
|
---|
324 | For an AMD machine, use the following command (replace
|
---|
325 | <MYCONTAINER> with the name of the container for your CPU's
|
---|
326 | family):
|
---|
327 | </para>
|
---|
328 |
|
---|
329 | <screen><userinput>cp -v ../<MYCONTAINER> kernel/x86/microcode/AuthenticAMD.bin</userinput></screen>
|
---|
330 |
|
---|
331 | <para>
|
---|
332 | Or for an Intel machine copy the appropriate blob using this command:
|
---|
333 | </para>
|
---|
334 |
|
---|
335 | <screen><userinput>cp -v ../intel-ucode/<XX-YY-ZZ> kernel/x86/microcode/GenuineIntel.bin</userinput></screen>
|
---|
336 |
|
---|
337 | <!-- new version from 20201110 release onwards, assumed to work on all skylakes
|
---|
338 | But complaints about previous version took some days to appear, so keep as a comment for now.
|
---|
339 | <caution>
|
---|
340 | <para>
|
---|
341 | On some Skylake machines with hex Model Number '4e' (78 decimal) the
|
---|
342 | upgrade to microcode version '0xdc' is reported to cause the machine to
|
---|
343 | hang in early boot, and the fix is to revert to version 0xd6 which was
|
---|
344 | first shipped in the 20191115 microcode release.
|
---|
345 | </para>
|
---|
346 |
|
---|
347 | <para>
|
---|
348 | At least one model '5e' Skylake does boot successfully with version
|
---|
349 | 0xdc, but Intel has now shipped a 20200616 release which is intended for
|
---|
350 | distros which need an initrd that will boot on everyone's machine: it
|
---|
351 | reverts both Skylake variants ('4e' and '5e') to the old 0xd6.
|
---|
352 | </para>
|
---|
353 |
|
---|
354 | <para>
|
---|
355 | For a Skylake which does not boot with 0xdc, reverting to 0xd6 will make
|
---|
356 | the machine usable, but without the SRBDS mitigations.
|
---|
357 | </para>
|
---|
358 | </caution>-->
|
---|
359 |
|
---|
360 | <para>
|
---|
361 | Now prepare the initrd:
|
---|
362 | </para>
|
---|
363 |
|
---|
364 | <screen><userinput>find . | cpio -o -H newc > /boot/microcode.img</userinput></screen>
|
---|
365 |
|
---|
366 | <para>
|
---|
367 | You now need to add a new entry to /boot/grub/grub.cfg and
|
---|
368 | here you should add a new line after the linux line within the stanza.
|
---|
369 | If /boot is a separate mountpoint:
|
---|
370 | </para>
|
---|
371 |
|
---|
372 | <screen><userinput>initrd /microcode.img</userinput></screen>
|
---|
373 |
|
---|
374 | <para>
|
---|
375 | or this if it is not:
|
---|
376 | </para>
|
---|
377 |
|
---|
378 | <screen><userinput>initrd /boot/microcode.img</userinput></screen>
|
---|
379 |
|
---|
380 | <para>
|
---|
381 | If you are already booting with an initrd (see <xref
|
---|
382 | linkend="initramfs"/>), you should run <command>mkinitramfs</command>
|
---|
383 | again after putting the appropriate blob or container into <filename
|
---|
384 | class="directory">/lib/firmware</filename>. More precisely, put an
|
---|
385 | intel blob in a <filename
|
---|
386 | class="directory">/lib/firmware/intel-ucode</filename> directory
|
---|
387 | or an AMD container in a <filename
|
---|
388 | class="directory">/lib/firmware/amd-ucode</filename> directory before
|
---|
389 | running <command>mkinitramfs</command>.
|
---|
390 | Alternatively, you can have both initrd on the same line, such as
|
---|
391 | <userinput>initrd /microcode.img /other-initrd.img</userinput> (adapt
|
---|
392 | that as above if /boot is not a separate mountpoint).
|
---|
393 | </para>
|
---|
394 |
|
---|
395 | <para>
|
---|
396 | You can now reboot with the added initrd, and then use the following
|
---|
397 | command to check that the early load worked:
|
---|
398 | </para>
|
---|
399 |
|
---|
400 | <screen><userinput>dmesg | grep -e 'microcode' -e 'Linux version' -e 'Command line'</userinput></screen>
|
---|
401 |
|
---|
402 | <para>
|
---|
403 | If you updated to address vulnerabilities, you can look at the
|
---|
404 | output of the <command>lscpu</command> command to see what is now
|
---|
405 | reported.
|
---|
406 | </para>
|
---|
407 |
|
---|
408 | <para>
|
---|
409 | The places and times where early loading happens are very different
|
---|
410 | in AMD and Intel machines. First, an example of an Intel (Tigerlake
|
---|
411 | mobile) with early loading:
|
---|
412 | </para>
|
---|
413 |
|
---|
414 | <screen><literal>[ 0.000000] Linux version 6.10.4 (xry111@stargazer) (gcc (GCC) 14.2.0, GNU ld (GNU Binutils) 2.43) #4 SMP PREEMPT_DYNAMIC Tue Aug 15 18:04:11 CST 2024
|
---|
415 | [ 0.000000] Command line: BOOT_IMAGE=/boot/vmlinuz-6.10.0 root=PARTUUID=<replaceable><CLASSIFIED></replaceable> ro
|
---|
416 | [ 0.585605] microcode: Current revision: 0x000000b8
|
---|
417 | [ 0.585611] microcode: Updated early from: 0x00000086</literal></screen>
|
---|
418 |
|
---|
419 | <para>
|
---|
420 | A historic AMD example:
|
---|
421 | </para>
|
---|
422 |
|
---|
423 | <screen><literal>[ 0.000000] Linux version 4.15.3 (ken@testserver) (gcc version 7.3.0 (GCC))
|
---|
424 | #2 SMP Sun Feb 18 02:32:03 GMT 2018
|
---|
425 | [ 0.000000] Command line: BOOT_IMAGE=/vmlinuz-4.15.3-sda5 root=/dev/sda5 ro
|
---|
426 | [ 0.307619] microcode: microcode updated early to new patch_level=0x010000c8
|
---|
427 | [ 0.307678] microcode: CPU0: patch_level=0x010000c8
|
---|
428 | [ 0.307723] microcode: CPU1: patch_level=0x010000c8
|
---|
429 | [ 0.307795] microcode: Microcode Update Driver: v2.2.</literal></screen>
|
---|
430 |
|
---|
431 | </sect3>
|
---|
432 |
|
---|
433 | </sect2>
|
---|
434 |
|
---|
435 | <sect2 id="video-firmware">
|
---|
436 | <title>Firmware for Video Cards</title>
|
---|
437 |
|
---|
438 | <sect3 id="ati-video-firmware">
|
---|
439 | <title>Firmware for ATI video chips (R600 and later)</title>
|
---|
440 |
|
---|
441 | <para>
|
---|
442 | These instructions do NOT apply to old radeons before the R600
|
---|
443 | family. For those, the firmware is in the kernel's <filename
|
---|
444 | class='directory'>/lib/firmware/</filename> directory. Nor do they
|
---|
445 | apply if you intend to avoid a graphical setup such as Xorg and are
|
---|
446 | content to use the default 80x25 display rather than a framebuffer.
|
---|
447 | </para>
|
---|
448 |
|
---|
449 | <para>
|
---|
450 | Early radeon devices only needed a single 2K blob of firmware. Recent
|
---|
451 | devices need several different blobs, and some of them are much bigger.
|
---|
452 | The total size of the radeon firmware directory is over 500K —
|
---|
453 | on a large modern system you can probably spare the space, but it is
|
---|
454 | still redundant to install all the unused files each time you build
|
---|
455 | a system.
|
---|
456 | </para>
|
---|
457 |
|
---|
458 | <para>
|
---|
459 | A better approach is to install <xref linkend='pciutils'/> and then
|
---|
460 | use <userinput>lspci</userinput> to identify which VGA controller is
|
---|
461 | installed.
|
---|
462 | </para>
|
---|
463 |
|
---|
464 | <para>
|
---|
465 | With that information, check the RadeonFeature page of the Xorg wiki
|
---|
466 | for <ulink url="https://wiki.x.org/wiki/RadeonFeature/#index5h2">Decoder
|
---|
467 | ring for engineering vs marketing names</ulink> to identify the family
|
---|
468 | (you may need to know this for the Xorg driver in BLFS —
|
---|
469 | Southern Islands and Sea Islands use the radeonsi driver) and the
|
---|
470 | specific model.
|
---|
471 | </para>
|
---|
472 |
|
---|
473 | <para>
|
---|
474 | Now that you know which controller you are using, consult the
|
---|
475 | <ulink url="https://wiki.gentoo.org/wiki/Radeon#Firmware">
|
---|
476 | Radeon</ulink> page of the Gentoo wiki which has a table listing
|
---|
477 | the required firmware blobs for the various chipsets. Note that
|
---|
478 | Southern Islands and Sea Islands chips use different firmware for
|
---|
479 | kernel 3.17 and later compared to earlier kernels. Identify and
|
---|
480 | download the required blobs then install them:
|
---|
481 | </para>
|
---|
482 |
|
---|
483 | <screen><userinput>mkdir -pv /lib/firmware/radeon
|
---|
484 | cp -v <YOUR_BLOBS> /lib/firmware/radeon</userinput></screen>
|
---|
485 |
|
---|
486 | <para>
|
---|
487 | Building the kernel amdgpu driver as a module is recommended because
|
---|
488 | the firmware files need to be accessible at the time it is loaded.
|
---|
489 | If you are building it as a part of the kernel image for any reason,
|
---|
490 | you need to either include the firmware files in the initramfs (read
|
---|
491 | <xref linkend='initramfs'/> for details), or include them in the
|
---|
492 | kernel image itself (read <xref linkend='firmware-in-kernel-image'/>
|
---|
493 | for details).
|
---|
494 | </para>
|
---|
495 |
|
---|
496 | </sect3>
|
---|
497 |
|
---|
498 | <sect3 id="amdgpu-video-firmware">
|
---|
499 | <title>Firmware for AMD/ATI amdgpu video chips</title>
|
---|
500 |
|
---|
501 | <para>
|
---|
502 | All video controllers using the amdgpu kernel driver require firmware,
|
---|
503 | whether you will be using the xorg amdgpu driver, the xserver's modesetting
|
---|
504 | driver, or just kernel modesetting to get a console framebuffer larger than
|
---|
505 | 80x25.
|
---|
506 | </para>
|
---|
507 |
|
---|
508 | <para>
|
---|
509 | Install <xref linkend="pciutils"/> and use that to check the model name
|
---|
510 | (look for 'VGA compatible controller:'). If you have an APU (Accelerated
|
---|
511 | Processing Unit, i.e. CPU and video on the same chip) that will probably
|
---|
512 | tell you the name. If you have a separate amdgpu video card you will need
|
---|
513 | to search to determine which name it uses (e.g. a card described as
|
---|
514 | Advanced Micro Devices, Inc. [AMD/ATI] Baffin [Radeon RX 550 640SP / RX
|
---|
515 | 560/560X] needs Polaris11 firmware. There is a table of "Family, Chipset
|
---|
516 | name, Product name and Firmware" at the end of the Kernel sections in
|
---|
517 | <ulink url="https://wiki.gentoo.org/wiki/AMDGPU#Known_firmware_blobs">
|
---|
518 | AMDGPU</ulink> page of the Gentoo wiki.
|
---|
519 | </para>
|
---|
520 |
|
---|
521 | <para>
|
---|
522 | Once you have identified the firmware name, install all the relevant
|
---|
523 | files for it. For example, the Baffin card mentioned above has 21 different
|
---|
524 | polaris11* files, APUs such as renoir and picasso have at least 12 files and
|
---|
525 | might gain more in future updates (e.g. the raven APU now has a 13th file,
|
---|
526 | raven_ta.bin).
|
---|
527 | </para>
|
---|
528 |
|
---|
529 | <screen><userinput>mkdir -pv /lib/firmware/amdgpu
|
---|
530 | cp -v <YOUR_BLOBS> /lib/firmware/amdgpu</userinput></screen>
|
---|
531 |
|
---|
532 | <para>
|
---|
533 | If disk space is not a problem, you could install all the current amdgpu
|
---|
534 | firmware files and not worry about exactly which chipset is installed.
|
---|
535 | </para>
|
---|
536 |
|
---|
537 | <para>
|
---|
538 | Building the kernel amdgpu driver as a module is recommended because
|
---|
539 | the firmware files need to be accessible at the time it is loaded.
|
---|
540 | If you are building it as a part of the kernel image for any reason,
|
---|
541 | you need to either include the firmware files in the initramfs (read
|
---|
542 | <xref linkend='initramfs'/> for details), or include them in the
|
---|
543 | kernel image itself (read <xref linkend='firmware-in-kernel-image'/>
|
---|
544 | for details).
|
---|
545 | </para>
|
---|
546 |
|
---|
547 | </sect3>
|
---|
548 |
|
---|
549 | <sect3 id="nvidia-video-firmware">
|
---|
550 | <title>Firmware for Nvidia video chips</title>
|
---|
551 |
|
---|
552 | <para>
|
---|
553 | Nvidia has released basic signed firmware for recent graphics chips,
|
---|
554 | but significantly after the chips and its own binary drivers were first
|
---|
555 | available. For other chips it has been necessary to extract the firmware
|
---|
556 | from the binary driver.
|
---|
557 | </para>
|
---|
558 | <para>
|
---|
559 | For more exact information about which chips need extracted firmware, see
|
---|
560 | <ulink url=
|
---|
561 | "https://nouveau.freedesktop.org/VideoAcceleration.html"/>.
|
---|
562 | </para>
|
---|
563 |
|
---|
564 | <para>
|
---|
565 | If the necessary firmware is available in the
|
---|
566 | <filename class="directory">nvidia/</filename> directory of
|
---|
567 | linux-firmware, copy it to
|
---|
568 | <filename class="directory">/lib/firmware/nouveau</filename>.
|
---|
569 | </para>
|
---|
570 | <para>
|
---|
571 | If the firmware has not been made available in linux-firmware,
|
---|
572 | for the old chips mentioned in the nouveau wiki link above
|
---|
573 | run the following commands:
|
---|
574 | </para>
|
---|
575 |
|
---|
576 | <screen><userinput>wget https://anduin.linuxfromscratch.org/BLFS/nvidia-firmware/extract_firmware.py
|
---|
577 | wget https://us.download.nvidia.com/XFree86/Linux-x86/340.32/NVIDIA-Linux-x86-340.32.run
|
---|
578 | sh NVIDIA-Linux-x86-340.32.run --extract-only
|
---|
579 | python3 extract_firmware.py
|
---|
580 | mkdir -p /lib/firmware/nouveau
|
---|
581 | cp -d nv* vuc-* /lib/firmware/nouveau/</userinput></screen>
|
---|
582 |
|
---|
583 | </sect3>
|
---|
584 | </sect2>
|
---|
585 |
|
---|
586 | <sect2 id="nic-firmware">
|
---|
587 | <title>Firmware for Network Interfaces</title>
|
---|
588 |
|
---|
589 | <para>
|
---|
590 | The kernel likes to load firmware for some network drivers, particularly
|
---|
591 | those from Realtek (the /lib/linux-firmware/rtl_nic/) directory, but
|
---|
592 | they generally appear to work without it. Therefore, you can boot the
|
---|
593 | kernel, check dmesg for messages about this missing firmware, and if
|
---|
594 | necessary download the firmware and put it in the specified directory in
|
---|
595 | <filename class="directory">/lib/firmware</filename> so that it will
|
---|
596 | be found on subsequent boots. Note that with current kernels this
|
---|
597 | works whether or not the driver is compiled in or built as a module,
|
---|
598 | there is no need to build this firmware into the kernel.
|
---|
599 | Here is an example where the R8169 driver has been compiled in but the
|
---|
600 | firmware was not made available. Once the firmware had been provided,
|
---|
601 | there was no mention of it on later boots.
|
---|
602 | </para>
|
---|
603 |
|
---|
604 | <screen><literal>dmesg | grep firmware | grep r8169
|
---|
605 | [ 7.018028] r8169 0000:01:00.0: Direct firmware load for rtl_nic/rtl8168g-2.fw failed with error -2
|
---|
606 | [ 7.018036] r8169 0000:01:00.0 eth0: unable to load firmware patch rtl_nic/rtl8168g-2.fw (-2)</literal></screen>
|
---|
607 |
|
---|
608 | </sect2>
|
---|
609 |
|
---|
610 | <sect2 id="regulatory-db">
|
---|
611 | <title>Firmware for Regulatory Database of Wireless Devices</title>
|
---|
612 |
|
---|
613 | <para>
|
---|
614 | Different countries have different regulations on the radio spectrum
|
---|
615 | usage of wireless devices. You can install a firmware to make the
|
---|
616 | wireless devices obey local spectrum regulations, so you won't be
|
---|
617 | inquired by local authority or find your wireless NIC jamming the
|
---|
618 | frequencies of other devices (for example, remote controllers).
|
---|
619 | The regulatory database firmware can be downloaded from
|
---|
620 | <ulink url = 'https://kernel.org/pub/software/network/wireless-regdb/'/>.
|
---|
621 | To install it, simply extract <filename>regulatory.db</filename> and
|
---|
622 | <filename>regulatory.db.p7s</filename> from the tarball into
|
---|
623 | <filename class="directory">/lib/firmware</filename>. Note that either
|
---|
624 | the <option>cfg80211</option> driver needs to be selected as a module
|
---|
625 | for the <filename>regulatory.*</filename>
|
---|
626 | files to be loaded, or those files need to be included as firmware into
|
---|
627 | the kernel, as explained above in <xref linkend="video-firmware"/>.
|
---|
628 | </para>
|
---|
629 |
|
---|
630 | <para>
|
---|
631 | The access point (AP) would send a country code to your wireless NIC,
|
---|
632 | and <xref linkend='wpa_supplicant'/> would tell the kernel to load
|
---|
633 | the regulation of this country from
|
---|
634 | <filename>regulatory.db</filename>, and enforce it. Note that several AP
|
---|
635 | don't send this country code, so you may be locked to a rather
|
---|
636 | restricted usage (specially if you want to use your interface as an AP).
|
---|
637 | </para>
|
---|
638 | </sect2>
|
---|
639 |
|
---|
640 | <sect2 id="sound-open-firmware">
|
---|
641 | <title>Sound Open Firmware</title>
|
---|
642 |
|
---|
643 | <para>
|
---|
644 | Some systems (especially budget laptops) utilize a DSP shipped with
|
---|
645 | the CPU for connection with the audio codec. The Sound Open Firmware
|
---|
646 | must be loaded onto the DSP to make it functional. These firmware
|
---|
647 | files can be downloaded from
|
---|
648 | <ulink url='https://github.com/thesofproject/sof-bin/releases'/>.
|
---|
649 | Extract the tarball and changing into the extracted directory,
|
---|
650 | then as the &root; user install the firmware:
|
---|
651 | </para>
|
---|
652 |
|
---|
653 | <screen role="nodump"><userinput>install -vdm755 /usr/lib/firmware/intel &&
|
---|
654 | cp -av -T --no-preserve=ownership sof \
|
---|
655 | /usr/lib/firmware/intel/sof &&
|
---|
656 | cp -av -T --no-preserve=ownership sof-tplg \
|
---|
657 | /usr/lib/firmware/intel/sof-tplg</userinput></screen>
|
---|
658 |
|
---|
659 | <para>
|
---|
660 | <xref linkend="alsa-lib"/> needs Use Case Manager configuration files
|
---|
661 | for the systems using Sound Open Firmware as well. Read the
|
---|
662 | <xref linkend="alsa-lib"/> page for the instructions to install them.
|
---|
663 | Once the firmware is loaded (you may need a reboot so the kernel will
|
---|
664 | load them) and the UCM configuration files are installed, following
|
---|
665 | <xref linkend="alsa-utils-config-sect"/> to set up your sound card for
|
---|
666 | ALSA properly.
|
---|
667 | </para>
|
---|
668 | </sect2>
|
---|
669 |
|
---|
670 | <sect2 id="other-firmware">
|
---|
671 | <title>Firmware for Other Devices</title>
|
---|
672 |
|
---|
673 | <para>
|
---|
674 | Identifying the correct firmware will typically require you to install
|
---|
675 | <xref linkend='pciutils'/>, and then use <userinput>lspci</userinput>
|
---|
676 | to identify the device. You should then search online to check which
|
---|
677 | module it uses, which firmware, and where to obtain the firmware —
|
---|
678 | not all of it is in linux-firmware.
|
---|
679 | </para>
|
---|
680 |
|
---|
681 | <para>
|
---|
682 | If possible, you should begin by using a wired connection when you first
|
---|
683 | boot your LFS system. To use a wireless connection you will need to
|
---|
684 | use a network tools such as <xref linkend="iw"/>,
|
---|
685 | <xref linkend='wireless_tools'/>, or <xref linkend='wpa_supplicant'/>.
|
---|
686 | </para>
|
---|
687 |
|
---|
688 | <para>
|
---|
689 | Firmware may also be needed for other devices such as some SCSI
|
---|
690 | controllers, bluetooth adaptors, or TV recorders. The same principles
|
---|
691 | apply.
|
---|
692 | </para>
|
---|
693 |
|
---|
694 | </sect2>
|
---|
695 |
|
---|
696 | <sect2 id='firmware-in-kernel-image'>
|
---|
697 | <title>Include Firmware Blobs in the Kernel Image</title>
|
---|
698 |
|
---|
699 | <para>
|
---|
700 | Some drivers, notably the drivers for ATI or AMD GPU, requires the
|
---|
701 | firmware files accessible at the time it is loaded. The easiest
|
---|
702 | method to handle these drivers is building them as a kernel module.
|
---|
703 | An alternative method is creating an initramfs (read
|
---|
704 | <xref linkend='initramfs'/> for details) including the firmware files.
|
---|
705 | If you don't want to use either methods, you may include the firmware
|
---|
706 | files in the kernel image itself. Install the needed firmware files
|
---|
707 | into <filename class='directory'>/lib/firmware</filename> first, then
|
---|
708 | set the following kernel configuration and rebuild the kernel:
|
---|
709 | </para>
|
---|
710 |
|
---|
711 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
712 | href="builtin-fw-kernel.xml"/>
|
---|
713 |
|
---|
714 | <para>
|
---|
715 | Replace <replaceable>xx/aa.bin xx/bb.bin</replaceable>
|
---|
716 | with a whitespace-separated list of paths to the needed firmware
|
---|
717 | files, relative to
|
---|
718 | <filename class='directory'>/lib/firmware</filename>. A method
|
---|
719 | easier than manually typing the list (it may be long) is running the
|
---|
720 | following command:
|
---|
721 | </para>
|
---|
722 |
|
---|
723 | <screen><userinput>echo CONFIG_EXTRA_FIRMWARE='"'$({ cd /lib/firmware; echo <replaceable>amdgpu/*</replaceable> })'"' >> .config
|
---|
724 | make oldconfig</userinput></screen>
|
---|
725 |
|
---|
726 | <para>
|
---|
727 | Replace <replaceable>amdgpu/*</replaceable> with a shell pattern
|
---|
728 | matching the needed firmware files.
|
---|
729 | </para>
|
---|
730 |
|
---|
731 | <warning>
|
---|
732 | <para>
|
---|
733 | Do not distribute a kernel image containing the firmware to others
|
---|
734 | or you may violate the GPL.
|
---|
735 | </para>
|
---|
736 | </warning>
|
---|
737 |
|
---|
738 | </sect2>
|
---|
739 |
|
---|
740 | </sect1>
|
---|