linux/Documentation/driver-api/firmware/built-in-fw.rst

=================
Built-in firmware
=================

Firmware can be built-in to the kernel, this means building the firmware
into vmlinux directly, to enable avoiding having to look for firmware from
the filesystem. Instead, firmware can be looked for inside the kernel
directly. You can enable built-in firmware using the kernel configuration
options:

  * CONFIG_EXTRA_FIRMWARE
  * CONFIG_EXTRA_FIRMWARE_DIR

There are a few reasons why you might want to consider building your firmware
into the kernel with CONFIG_EXTRA_FIRMWARE:

* Speed
* Firmware is needed for accessing the boot device, and the user doesn't
  want to stuff the firmware into the boot initramfs.

Even if you have these needs there are a few reasons why you may not be
able to make use of built-in firmware:

* Legalese - firmware is non-GPL compatible
* Some firmware may be optional
* Firmware upgrades are possible, therefore a new firmware would implicate
  a complete kernel rebuild.
* Some firmware files may be really large in size. The remote-proc subsystem
  is an example subsystem which deals with these sorts of firmware
* The firmware may need to be scraped out from some device specific location
  dynamically, an example is calibration data for for some WiFi chipsets. This
  calibration data can be unique per sold device.
firmware: revamp firmware documentation Understanding this code is getting out of control without any notes. Give the firmware_class driver a much needed documentation love, and while at it convert it to the new sphinx documentation format. v2: typos and small fixes Signed-off-by: Luis R. Rodriguez <mcgrof@kernel.org> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> 2016-12-16 14:10:36 +03:00			`=================`
			`Built-in firmware`
			`=================`

			`Firmware can be built-in to the kernel, this means building the firmware`
			`into vmlinux directly, to enable avoiding having to look for firmware from`
			`the filesystem. Instead, firmware can be looked for inside the kernel`
			`directly. You can enable built-in firmware using the kernel configuration`
			`options:`

			`* CONFIG_EXTRA_FIRMWARE`
			`* CONFIG_EXTRA_FIRMWARE_DIR`

			`There are a few reasons why you might want to consider building your firmware`
firmware: Fix up docs referring to FIRMWARE_IN_KERNEL We've removed the option, so stop talking about it. Signed-off-by: Benjamin Gilbert <benjamin.gilbert@coreos.com> Acked-by: Ingo Molnar <mingo@kernel.org> Cc: Borislav Petkov <bp@suse.de> Cc: Thomas Gleixner <tglx@linutronix.de> Cc: H. Peter Anvin <hpa@zytor.com> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> 2018-01-24 05:06:32 +03:00			`into the kernel with CONFIG_EXTRA_FIRMWARE:`
firmware: revamp firmware documentation Understanding this code is getting out of control without any notes. Give the firmware_class driver a much needed documentation love, and while at it convert it to the new sphinx documentation format. v2: typos and small fixes Signed-off-by: Luis R. Rodriguez <mcgrof@kernel.org> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> 2016-12-16 14:10:36 +03:00
			`* Speed`
			`* Firmware is needed for accessing the boot device, and the user doesn't`
			`want to stuff the firmware into the boot initramfs.`

			`Even if you have these needs there are a few reasons why you may not be`
			`able to make use of built-in firmware:`

			`* Legalese - firmware is non-GPL compatible`
			`* Some firmware may be optional`
			`* Firmware upgrades are possible, therefore a new firmware would implicate`
			`a complete kernel rebuild.`
			`* Some firmware files may be really large in size. The remote-proc subsystem`
			`is an example subsystem which deals with these sorts of firmware`
			`* The firmware may need to be scraped out from some device specific location`
			`dynamically, an example is calibration data for for some WiFi chipsets. This`
			`calibration data can be unique per sold device.`