linux/Documentation/driver-api/firmware
Hans de Goede e4c2c0ff00 firmware: Add new platform fallback mechanism and firmware_request_platform()
In some cases the platform's main firmware (e.g. the UEFI fw) may contain
an embedded copy of device firmware which needs to be (re)loaded into the
peripheral. Normally such firmware would be part of linux-firmware, but in
some cases this is not feasible, for 2 reasons:

1) The firmware is customized for a specific use-case of the chipset / use
with a specific hardware model, so we cannot have a single firmware file
for the chipset. E.g. touchscreen controller firmwares are compiled
specifically for the hardware model they are used with, as they are
calibrated for a specific model digitizer.

2) Despite repeated attempts we have failed to get permission to
redistribute the firmware. This is especially a problem with customized
firmwares, these get created by the chip vendor for a specific ODM and the
copyright may partially belong with the ODM, so the chip vendor cannot
give a blanket permission to distribute these.

This commit adds a new platform fallback mechanism to the firmware loader
which will try to lookup a device fw copy embedded in the platform's main
firmware if direct filesystem lookup fails.

Drivers which need such embedded fw copies can enable this fallback
mechanism by using the new firmware_request_platform() function.

Note that for now this is only supported on EFI platforms and even on
these platforms firmware_fallback_platform() only works if
CONFIG_EFI_EMBEDDED_FIRMWARE is enabled (this gets selected by drivers
which need this), in all other cases firmware_fallback_platform() simply
always returns -ENOENT.

Reported-by: Dave Olsthoorn <dave@bewaar.me>
Suggested-by: Peter Jones <pjones@redhat.com>
Acked-by: Luis Chamberlain <mcgrof@kernel.org>
Signed-off-by: Hans de Goede <hdegoede@redhat.com>
Link: https://lore.kernel.org/r/20200115163554.101315-5-hdegoede@redhat.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2020-03-20 14:54:04 +01:00
..
built-in-fw.rst firmware: Fix up docs referring to FIRMWARE_IN_KERNEL 2018-01-25 12:46:30 +01:00
core.rst firmware: revamp firmware documentation 2017-01-11 09:42:59 +01:00
direct-fs-lookup.rst firmware: revamp firmware documentation 2017-01-11 09:42:59 +01:00
fallback-mechanisms.rst firmware: Add new platform fallback mechanism and firmware_request_platform() 2020-03-20 14:54:04 +01:00
firmware_cache.rst Documentation: fix few typos and clarifications for the firmware loader 2018-05-14 16:44:41 +02:00
fw_search_path.rst firmware: revamp firmware documentation 2017-01-11 09:42:59 +01:00
index.rst docs-rst: core_api: move driver-specific stuff to drivers_api 2017-04-02 14:17:43 -06:00
introduction.rst firmware: revamp firmware documentation 2017-01-11 09:42:59 +01:00
lookup-order.rst firmware: Add new platform fallback mechanism and firmware_request_platform() 2020-03-20 14:54:04 +01:00
other_interfaces.rst docs: Fix a misdirected kerneldoc directive 2019-05-24 14:31:50 -06:00
request_firmware.rst firmware: Add new platform fallback mechanism and firmware_request_platform() 2020-03-20 14:54:04 +01:00