1 ===================
2 Firmware Guidelines
3 ===================
4
5 Users switching to a newer kernel should *not*
6 firmware files to keep their hardware working.
7 firmware files must not cause any regressions
8 releases.
9
10 Drivers that use firmware from linux-firmware
11 this guide. (Where there is limited control of
12 i.e. company doesn't support Linux, firmwares
13 then of course these rules will not apply stri
14
15 * Firmware files shall be designed in a way th
16 firmware ABI version changes. It is recommen
17 versioned with at least a major/minor versio
18 the firmware files in linux-firmware be name
19 specific name, and just the major version. T
20 be stored in the firmware header, or as an e
21 firmware file name, in order to let the driv
22 fixes/changes. The firmware files in linux-f
23 overwritten with the newest compatible major
24 version firmware shall remain compatible wit
25 that major number.
26
27 * If the kernel support for the hardware is no
28 hardware isn't available for public consumpt
29 be ignored, until the first kernel release t
30 This means no major version bumps without th
31 backwards compatibility for the older major
32 bumps should not introduce new features that
33 non-optionally.
34
35 * If a security fix needs lockstep firmware an
36 be successful, then all supported major vers
37 repo that are required by currently supporte
38 should be updated with the security fix. The
39 detect if the firmware is new enough to decl
40 is fixed. All communications around securit
41 both the firmware and kernel fixes. If a sec
42 deprecating old major versions, then this sh
43 last option, and be stated clearly in all co
44
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.