3  * main.c - Multi purpose firmware loading support
7  * Please see Documentation/driver-api/firmware/ for more information.
25 #include <linux/firmware.h>
42 #include "firmware.h"
46 MODULE_DESCRIPTION("Multi purpose firmware loading support");
57 	 * Names of firmware images which have been cached successfully
59 	 * helper can trace which firmware images have been cached
95 /* Builtin firmware support */
102 static void fw_copy_to_prealloc_buf(struct firmware *fw,  in fw_copy_to_prealloc_buf()
110 static bool fw_get_builtin_firmware(struct firmware *fw, const char *name,  in fw_get_builtin_firmware()
128 static bool fw_is_builtin_firmware(const struct firmware *fw)  in fw_is_builtin_firmware()
139 #else /* Module case - no builtin firmware support */
141 static inline bool fw_get_builtin_firmware(struct firmware *fw,  in fw_get_builtin_firmware()
148 static inline bool fw_is_builtin_firmware(const struct firmware *fw)  in fw_is_builtin_firmware()
223 /* Returns 1 for batching firmware requests with the same name */
366  * XZ-compressed firmware support
464 /* direct firmware loading support */
468 	"/lib/firmware/updates/" UTS_RELEASE,
469 	"/lib/firmware/updates",
470 	"/lib/firmware/" UTS_RELEASE,
471 	"/lib/firmware"
480 MODULE_PARM_DESC(path, "customized firmware image search path with a higher priority than default p…
527 		 * firmware was not completely loaded.  in fw_get_filesystem_firmware()
532 		/* load firmware files from the mount namespace of init */  in fw_get_filesystem_firmware()
549 		dev_dbg(device, "Loading firmware from %s\n", path);  in fw_get_filesystem_firmware()
576 /* firmware holds the ownership of pages */
577 static void firmware_free_data(const struct firmware *fw)  in firmware_free_data()
587 /* store the pages buffer info firmware from buf */
588 static void fw_set_page_data(struct fw_priv *fw_priv, struct firmware *fw)  in fw_set_page_data()
640 /* add firmware name into devres list */
675 int assign_fw(struct firmware *fw, struct device *device)  in assign_fw()
687 	 * add firmware name into devres list so that we can auto cache  in assign_fw()
688 	 * and uncache firmware for device.  in assign_fw()
693 	/* don't cache firmware handled without uevent */  in assign_fw()
704 	 * After caching firmware image is started, let it piggyback  in assign_fw()
705 	 * on request firmware.  in assign_fw()
719 /* prepare firmware and firmware_buf structs;
720  * return 0 if a firmware is already assigned, 1 if need to load one,
724 _request_firmware_prepare(struct firmware **firmware_p, const char *name,  in _request_firmware_prepare()
728 	struct firmware *firmware;  in _request_firmware_prepare()  local
732 	*firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);  in _request_firmware_prepare()
733 	if (!firmware) {  in _request_firmware_prepare()
734 		dev_err(device, "%s: kmalloc(struct firmware) failed\n",  in _request_firmware_prepare()
739 	if (fw_get_builtin_firmware(firmware, name, dbuf, size)) {  in _request_firmware_prepare()
749 	 * of requesting firmware.  in _request_firmware_prepare()
751 	firmware->priv = fw_priv;  in _request_firmware_prepare()
756 			fw_set_page_data(fw_priv, firmware);  in _request_firmware_prepare()
775 static void fw_abort_batch_reqs(struct firmware *fw)  in fw_abort_batch_reqs()
790 _request_firmware(const struct firmware **firmware_p, const char *name,  in _request_firmware()
794 	struct firmware *fw = NULL;  in _request_firmware()
828 				 "Direct firmware load for %s failed with error %d\n",  in _request_firmware()
848  * request_firmware() - send firmware request and wait for it
849  * @firmware_p: pointer to firmware image
850  * @name: name of firmware file
851  * @device: device for which firmware is being loaded
853  *      @firmware_p will be used to return a firmware image by the name
858  *      @name will be used as $FIRMWARE in the uevent environment and
860  *      firmware image for this or any other device.
868 request_firmware(const struct firmware **firmware_p, const char *name,  in request_firmware()
884  * @firmware: pointer to firmware image
885  * @name: name of firmware file
886  * @device: device for which firmware is being loaded
891  * failures to find the firmware file with it are still suppressed. It is
895 int firmware_request_nowarn(const struct firmware **firmware, const char *name,  in firmware_request_nowarn()  argument
902 	ret = _request_firmware(firmware, name, device, NULL, 0, 0,  in firmware_request_nowarn()
910  * request_firmware_direct() - load firmware directly without usermode helper
911  * @firmware_p: pointer to firmware image
912  * @name: name of firmware file
913  * @device: device for which firmware is being loaded
916  * fall back to usermode helper even if the firmware couldn't be loaded
920 int request_firmware_direct(const struct firmware **firmware_p,  in request_firmware_direct()
935  * firmware_request_platform() - request firmware with platform-fw fallback
936  * @firmware: pointer to firmware image
937  * @name: name of firmware file
938  * @device: device for which firmware is being loaded
942  * requested firmware embedded in the platform's main (e.g. UEFI) firmware.
944 int firmware_request_platform(const struct firmware **firmware,  in firmware_request_platform()  argument
951 	ret = _request_firmware(firmware, name, device, NULL, 0, 0,  in firmware_request_platform()
959  * firmware_request_cache() - cache firmware for suspend so resume can use it
960  * @name: name of firmware file
961  * @device: device for which firmware should be cached for
964  * require loading firmware on system reboot. This optimization may still
965  * require the firmware present on resume from suspend. This routine can be
966  * used to ensure the firmware is present on resume from suspend in these
983  * request_firmware_into_buf() - load firmware into a previously allocated buffer
984  * @firmware_p: pointer to firmware image
985  * @name: name of firmware file
986  * @device: device for which firmware is being loaded and DMA region allocated
987  * @buf: address of buffer to load firmware into
991  * allocate a buffer to hold the firmware data. Instead, the firmware
995  * This function doesn't cache firmware either.
998 request_firmware_into_buf(const struct firmware **firmware_p, const char *name,  in request_firmware_into_buf()
1015  * request_partial_firmware_into_buf() - load partial firmware into a previously allocated buffer
1016  * @firmware_p: pointer to firmware image
1017  * @name: name of firmware file
1018  * @device: device for which firmware is being loaded and DMA region allocated
1019  * @buf: address of buffer to load firmware into
1027 request_partial_firmware_into_buf(const struct firmware **firmware_p,  in request_partial_firmware_into_buf()
1046  * release_firmware() - release the resource associated with a firmware image
1047  * @fw: firmware resource to release
1049 void release_firmware(const struct firmware *fw)  in release_firmware()
1066 	void (*cont)(const struct firmware *fw, void *context);
1073 	const struct firmware *fw;  in request_firmware_work_func()
1089  * @module: module requesting the firmware
1090  * @uevent: sends uevent to copy the firmware image if this flag
1091  *	is non-zero else the firmware copy must be done manually.
1092  * @name: name of firmware file
1093  * @device: device for which firmware is being loaded
1096  *	@fw may be %NULL if firmware request fails.
1097  * @cont: function will be called asynchronously when the firmware
1105  *		  requesting firmware in their ->probe() methods, if
1114 	void (*cont)(const struct firmware *fw, void *context))  in request_firmware_nowait()
1157  * cache_firmware() - cache one firmware image in kernel memory space
1158  * @fw_name: the firmware image name
1160  * Cache firmware in kernel memory so that drivers can use it when
1161  * system isn't ready for them to request firmware image from userspace.
1163  * nowait version to get the cached firmware without any interacting
1166  * Return 0 if the firmware image has been cached successfully
1173 	const struct firmware *fw;  in cache_firmware()
1199  * uncache_firmware() - remove one cached firmware image
1200  * @fw_name: the firmware image name
1202  * Uncache one firmware image which has been cached successfully
1205  * Return 0 if the firmware cache has been removed successfully
1212 	struct firmware fw;  in uncache_firmware()
1338 		/* only one cache entry for one firmware */  in dev_cache_fw_image()
1375  * device_cache_fw_images() - cache devices' firmware
1378  * successfully before, the firmware names are recored into the
1382  * time when system is not ready to complete loading firmware.
1401 	/* wait for completion of caching firmware for all devices */  in device_cache_fw_images()
1408  * device_uncache_fw_images() - uncache devices' firmware
1470 /* stop caching firmware once syscore_suspend is reached */