Changes in request_firmware.rst

726b5bd3 - Documentation/driver-api: firmware/request_firmware: drop doubled word

Sat, 04 Jul 2020 03:44:50 +0000

Documentation/driver-api: firmware/request_firmware: drop doubled wordDrop the doubled word "call".Signed-off-by: Randy Dunlap Cc: Jonathan Corbet Cc: linux-doc@vger.kernel.orgAcked-by: Luis Chamberlain Link: https://lore.kernel.org/r/20200704034502.17199-6-rdunlap@infradead.orgSigned-off-by: Greg Kroah-Hartman List of files: /linux-6.15/Documentation/driver-api/firmware/request_firmware.rst

e4c2c0ff - firmware: Add new platform fallback mechanism and firmware_request_platform()

Wed, 15 Jan 2020 16:35:48 +0000

firmware: Add new platform fallback mechanism and firmware_request_platform()In some cases the platform's main firmware (e.g. the UEFI fw) may containan embedded copy of device firmware which needs to be (re)loaded into theperipheral. Normally such firmware would be part of linux-firmware, but insome cases this is not feasible, for 2 reasons:1) The firmware is customized for a specific use-case of the chipset / usewith a specific hardware model, so we cannot have a single firmware filefor the chipset. E.g. touchscreen controller firmwares are compiledspecifically for the hardware model they are used with, as they arecalibrated for a specific model digitizer.2) Despite repeated attempts we have failed to get permission toredistribute the firmware. This is especially a problem with customizedfirmwares, these get created by the chip vendor for a specific ODM and thecopyright may partially belong with the ODM, so the chip vendor cannotgive a blanket permission to distribute these.This commit adds a new platform fallback mechanism to the firmware loaderwhich will try to lookup a device fw copy embedded in the platform's mainfirmware if direct filesystem lookup fails.Drivers which need such embedded fw copies can enable this fallbackmechanism by using the new firmware_request_platform() function.Note that for now this is only supported on EFI platforms and even onthese platforms firmware_fallback_platform() only works ifCONFIG_EFI_EMBEDDED_FIRMWARE is enabled (this gets selected by driverswhich need this), in all other cases firmware_fallback_platform() simplyalways returns -ENOENT.Reported-by: Dave Olsthoorn Suggested-by: Peter Jones Acked-by: Luis Chamberlain Signed-off-by: Hans de Goede Link: https://lore.kernel.org/r/20200115163554.101315-5-hdegoede@redhat.comSigned-off-by: Greg Kroah-Hartman List of files: /linux-6.15/Documentation/driver-api/firmware/request_firmware.rst

7dcc0134 - firmware: add firmware_request_nowarn() - load firmware without warnings

Thu, 10 May 2018 20:08:45 +0000

firmware: add firmware_request_nowarn() - load firmware without warningsCurrently the firmware loader only exposes one silent path for queryingoptional firmware, and that is firmware_request_direct(). This functionalso disables the sysfs fallback mechanism, which might not always be thedesired behaviour [0].This patch introduces a variations of request_firmware() that enable thecaller to disable the undesired warning messages but enables the sysfsfallback mechanism. This is equivalent to adding FW_OPT_NO_WARN to theold behaviour.[0]: https://git.kernel.org/linus/c0cc00f250e1Signed-off-by: Andres Rodriguez Reviewed-by: Kees Cook Acked-by: Luis R. Rodriguez [mcgrof: used the old API calls as the full rename is not done yet, and add the caller for when FW_LOADER is disabled, enhance documentation ]Signed-off-by: Luis R. Rodriguez Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/Documentation/driver-api/firmware/request_firmware.rst

b93815d0 - firmware: some documentation fixes

Wed, 25 Apr 2018 16:25:39 +0000

firmware: some documentation fixesIncluding: - Fixup outdated kernel-doc paths - Slightly too short title underline - Some typosSigned-off-by: Andres Rodriguez Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/Documentation/driver-api/firmware/request_firmware.rst

df9267f1 - firmware: Fix firmware documentation for recent file renames

Sun, 08 Apr 2018 16:06:21 +0000

firmware: Fix firmware documentation for recent file renamesfirmware_class.c was split into several files underdrivers/base/firmware_loader. The new main.c has the functions which/request_firmware.rst references.Acked-by: Luis R. Rodriguez Signed-off-by: Hans de Goede Tested-by: Randy Dunlap Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/Documentation/driver-api/firmware/request_firmware.rst

5d42c96e - firmware: add firmware_request_cache() to help with cache on reboot

Wed, 21 Mar 2018 22:34:29 +0000

firmware: add firmware_request_cache() to help with cache on rebootSome devices have an optimization in place to enable the firmware tobe retaineed during a system reboot, so after reboot the device can skiprequesting and loading the firmware. This can save up to 1s in loadtime. The mt7601u 802.11 device happens to be such a device.When these devices retain the firmware on a reboot and then suspendthey can miss looking for the firmware on resume. To help with this weneed a way to cache the firmware when such an optimization has takenplace.Signed-off-by: Luis R. Rodriguez Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/Documentation/driver-api/firmware/request_firmware.rst

f007cad1 - Revert "firmware: add sanity check on shutdown/suspend"

Mon, 11 Sep 2017 04:19:06 +0000

Revert "firmware: add sanity check on shutdown/suspend"This reverts commit 81f95076281fdd3bc382e004ba1bce8e82fccbce.It causes random failures of firmware loading at resume time (well,random for me, it seems to be more reliable for others) because thefirmware disabling is not actually synchronous with any particularresume event, and at least the btusb driver that uses a workqueue toload the firmware at resume seems to occasionally hit the "firmwareloading is disabled" logic because the firmware loader hasn't gotten theresume event yet.Some kind of sanity check for not trying to load firmware when it's notpossible might be a good thing, but this commit was not it.Greg seems to have silently suffered the same issue, and pointed to thelikely culprit, and Gabriel C verified the revert fixed it for him too.Reported-by: Linus Torvalds Pointed-at-by: Greg Kroah-Hartman Tested-by: Gabriel C Cc: Luis R. Rodriguez Signed-off-by: Linus Torvalds List of files: /linux-6.15/Documentation/driver-api/firmware/request_firmware.rst

81f95076 - firmware: add sanity check on shutdown/suspend

Tue, 02 May 2017 08:31:05 +0000

firmware: add sanity check on shutdown/suspendThe firmware API should not be used after we go to suspendand after we reboot/halt. The suspend/resume case is a bitcomplex, so this documents that so things are clearer.We want to know about users of the API in incorrect places sothat their callers are corrected, so this also adds a warnfor those cases.Signed-off-by: Luis R. Rodriguez Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/Documentation/driver-api/firmware/request_firmware.rst

113ccc38 - firmware: revamp firmware documentation

Fri, 16 Dec 2016 11:10:36 +0000

firmware: revamp firmware documentationUnderstanding this code is getting out of control without anynotes. 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 fixesSigned-off-by: Luis R. Rodriguez Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/Documentation/driver-api/firmware/request_firmware.rst