3  * main.c - Multi purpose firmware loading support
7  * Please see Documentation/driver-api/firmware/ for more information.
26 #include <linux/firmware.h>
44 #include "firmware.h"
48 MODULE_DESCRIPTION("Multi purpose firmware loading support");
59 	 * Names of firmware images which have been cached successfully
61 	 * helper can trace which firmware images have been cached
166 /* Returns 1 for batching firmware requests with the same name */
307  * ZSTD-compressed firmware support
371  * XZ-compressed firmware support
469 /* direct firmware loading support */
473 	"/lib/firmware/updates/" UTS_RELEASE,
474 	"/lib/firmware/updates",
475 	"/lib/firmware/" UTS_RELEASE,
476 	"/lib/firmware"
485 MODULE_PARM_DESC(path, "customized firmware image search path with a higher priority than default p…
542 		 * firmware was not completely loaded.  in fw_get_filesystem_firmware()
547 		/* load firmware files from the mount namespace of init */  in fw_get_filesystem_firmware()
564 		dev_dbg(device, "Loading firmware from %s\n", path);  in fw_get_filesystem_firmware()
591 /* firmware holds the ownership of pages */
592 static void firmware_free_data(const struct firmware *fw)  in firmware_free_data()
602 /* store the pages buffer info firmware from buf */
603 static void fw_set_page_data(struct fw_priv *fw_priv, struct firmware *fw)  in fw_set_page_data()
655 /* add firmware name into devres list */
690 int assign_fw(struct firmware *fw, struct device *device)  in assign_fw()
702 	 * add firmware name into devres list so that we can auto cache  in assign_fw()
703 	 * and uncache firmware for device.  in assign_fw()
708 	/* don't cache firmware handled without uevent */  in assign_fw()
719 	 * After caching firmware image is started, let it piggyback  in assign_fw()
720 	 * on request firmware.  in assign_fw()
732 /* prepare firmware and firmware_buf structs;
733  * return 0 if a firmware is already assigned, 1 if need to load one,
737 _request_firmware_prepare(struct firmware **firmware_p, const char *name,  in _request_firmware_prepare()
741 	struct firmware *firmware;  in _request_firmware_prepare()  local
745 	*firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);  in _request_firmware_prepare()
746 	if (!firmware) {  in _request_firmware_prepare()
747 		dev_err(device, "%s: kmalloc(struct firmware) failed\n",  in _request_firmware_prepare()
752 	if (firmware_request_builtin_buf(firmware, name, dbuf, size)) {  in _request_firmware_prepare()
762 	 * of requesting firmware.  in _request_firmware_prepare()
764 	firmware->priv = fw_priv;  in _request_firmware_prepare()
769 			fw_set_page_data(fw_priv, firmware);  in _request_firmware_prepare()
788 static void fw_abort_batch_reqs(struct firmware *fw)  in fw_abort_batch_reqs()
807 static void fw_log_firmware_info(const struct firmware *fw, const char *name, struct device *device)  in fw_log_firmware_info()
841 static void fw_log_firmware_info(const struct firmware *fw, const char *name,  in fw_log_firmware_info()
847  * Reject firmware file names with ".." path components.
848  * There are drivers that construct firmware file names from device-supplied
850  * be sent my firmware from ../../../etc/shadow, please".
854  * This intentionally only looks at the firmware name, not at the firmware base
868 _request_firmware(const struct firmware **firmware_p, const char *name,  in _request_firmware()
872 	struct firmware *fw = NULL;  in _request_firmware()
888 			 "Firmware load for '%s' refused, path contains '..' component\n",  in _request_firmware()
900 	 * We are about to try to access the firmware file. Because we may have been  in _request_firmware()
933 				 "Direct firmware load for %s failed with error %d\n",  in _request_firmware()
958  * request_firmware() - send firmware request and wait for it
959  * @firmware_p: pointer to firmware image
960  * @name: name of firmware file
961  * @device: device for which firmware is being loaded
963  *      @firmware_p will be used to return a firmware image by the name
968  *      @name will be used as $FIRMWARE in the uevent environment and
970  *      firmware image for this or any other device.
980 request_firmware(const struct firmware **firmware_p, const char *name,  in request_firmware()
996  * @firmware: pointer to firmware image
997  * @name: name of firmware file
998  * @device: device for which firmware is being loaded
1003  * failures to find the firmware file with it are still suppressed. It is
1007 int firmware_request_nowarn(const struct firmware **firmware, const char *name,  in firmware_request_nowarn()  argument
1014 	ret = _request_firmware(firmware, name, device, NULL, 0, 0,  in firmware_request_nowarn()
1022  * request_firmware_direct() - load firmware directly without usermode helper
1023  * @firmware_p: pointer to firmware image
1024  * @name: name of firmware file
1025  * @device: device for which firmware is being loaded
1028  * fall back to usermode helper even if the firmware couldn't be loaded
1032 int request_firmware_direct(const struct firmware **firmware_p,  in request_firmware_direct()
1047  * firmware_request_platform() - request firmware with platform-fw fallback
1048  * @firmware: pointer to firmware image
1049  * @name: name of firmware file
1050  * @device: device for which firmware is being loaded
1054  * requested firmware embedded in the platform's main (e.g. UEFI) firmware.
1056 int firmware_request_platform(const struct firmware **firmware,  in firmware_request_platform()  argument
1063 	ret = _request_firmware(firmware, name, device, NULL, 0, 0,  in firmware_request_platform()
1071  * firmware_request_cache() - cache firmware for suspend so resume can use it
1072  * @name: name of firmware file
1073  * @device: device for which firmware should be cached for
1076  * require loading firmware on system reboot. This optimization may still
1077  * require the firmware present on resume from suspend. This routine can be
1078  * used to ensure the firmware is present on resume from suspend in these
1095  * request_firmware_into_buf() - load firmware into a previously allocated buffer
1096  * @firmware_p: pointer to firmware image
1097  * @name: name of firmware file
1098  * @device: device for which firmware is being loaded and DMA region allocated
1099  * @buf: address of buffer to load firmware into
1103  * allocate a buffer to hold the firmware data. Instead, the firmware
1107  * This function doesn't cache firmware either.
1110 request_firmware_into_buf(const struct firmware **firmware_p, const char *name,  in request_firmware_into_buf()
1127  * request_partial_firmware_into_buf() - load partial firmware into a previously allocated buffer
1128  * @firmware_p: pointer to firmware image
1129  * @name: name of firmware file
1130  * @device: device for which firmware is being loaded and DMA region allocated
1131  * @buf: address of buffer to load firmware into
1139 request_partial_firmware_into_buf(const struct firmware **firmware_p,  in request_partial_firmware_into_buf()
1158  * release_firmware() - release the resource associated with a firmware image
1159  * @fw: firmware resource to release
1161 void release_firmware(const struct firmware *fw)  in release_firmware()
1178 	void (*cont)(const struct firmware *fw, void *context);
1185 	const struct firmware *fw;  in request_firmware_work_func()
1201  * @module: module requesting the firmware
1202  * @uevent: sends uevent to copy the firmware image if this flag
1203  *	is non-zero else the firmware copy must be done manually.
1204  * @name: name of firmware file
1205  * @device: device for which firmware is being loaded
1208  *	@fw may be %NULL if firmware request fails.
1209  * @cont: function will be called asynchronously when the firmware
1217  *		  requesting firmware in their ->probe() methods, if
1226 	void (*cont)(const struct firmware *fw, void *context))  in request_firmware_nowait()
1269  * cache_firmware() - cache one firmware image in kernel memory space
1270  * @fw_name: the firmware image name
1272  * Cache firmware in kernel memory so that drivers can use it when
1273  * system isn't ready for them to request firmware image from userspace.
1275  * nowait version to get the cached firmware without any interacting
1278  * Return 0 if the firmware image has been cached successfully
1285 	const struct firmware *fw;  in cache_firmware()
1311  * uncache_firmware() - remove one cached firmware image
1312  * @fw_name: the firmware image name
1314  * Uncache one firmware image which has been cached successfully
1317  * Return 0 if the firmware cache has been removed successfully
1324 	struct firmware fw;  in uncache_firmware()
1449 		/* only one cache entry for one firmware */  in dev_cache_fw_image()
1486  * device_cache_fw_images() - cache devices' firmware
1489  * successfully before, the firmware names are recored into the
1493  * time when system is not ready to complete loading firmware.
1512 	/* wait for completion of caching firmware for all devices */  in device_cache_fw_images()
1519  * device_uncache_fw_images() - uncache devices' firmware
1581 /* stop caching firmware once syscore_suspend is reached */