1 // SPDX-License-Identifier: GPL-2.0
3 * main.c - Multi purpose firmware loading support
5 * Copyright (c) 2003 Manuel Estrada Sainz
7 * Please see Documentation/firmware_class/ for more information.
11 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
13 #include <linux/capability.h>
14 #include <linux/device.h>
15 #include <linux/module.h>
16 #include <linux/init.h>
17 #include <linux/timer.h>
18 #include <linux/vmalloc.h>
19 #include <linux/interrupt.h>
20 #include <linux/bitops.h>
21 #include <linux/mutex.h>
22 #include <linux/workqueue.h>
23 #include <linux/highmem.h>
24 #include <linux/firmware.h>
25 #include <linux/slab.h>
26 #include <linux/sched.h>
27 #include <linux/file.h>
28 #include <linux/list.h>
30 #include <linux/async.h>
32 #include <linux/suspend.h>
33 #include <linux/syscore_ops.h>
34 #include <linux/reboot.h>
35 #include <linux/security.h>
37 #include <generated/utsrelease.h>
43 MODULE_AUTHOR("Manuel Estrada Sainz");
44 MODULE_DESCRIPTION("Multi purpose firmware loading support");
45 MODULE_LICENSE("GPL");
47 struct firmware_cache {
48 /* firmware_buf instance will be added into the below list */
50 struct list_head head;
53 #ifdef CONFIG_PM_SLEEP
55 * Names of firmware images which have been cached successfully
56 * will be added into the below list so that device uncache
57 * helper can trace which firmware images have been cached
61 struct list_head fw_names;
63 struct delayed_work work;
65 struct notifier_block pm_notify;
69 struct fw_cache_entry {
70 struct list_head list;
79 static inline struct fw_priv *to_fw_priv(struct kref *ref)
81 return container_of(ref, struct fw_priv, ref);
84 #define FW_LOADER_NO_CACHE 0
85 #define FW_LOADER_START_CACHE 1
87 /* fw_lock could be moved to 'struct fw_sysfs' but since it is just
88 * guarding for corner cases a global lock should be OK */
89 DEFINE_MUTEX(fw_lock);
91 static struct firmware_cache fw_cache;
93 /* Builtin firmware support */
95 #ifdef CONFIG_FW_LOADER
97 extern struct builtin_fw __start_builtin_fw[];
98 extern struct builtin_fw __end_builtin_fw[];
100 static void fw_copy_to_prealloc_buf(struct firmware *fw,
101 void *buf, size_t size)
103 if (!buf || size < fw->size)
105 memcpy(buf, fw->data, fw->size);
108 static bool fw_get_builtin_firmware(struct firmware *fw, const char *name,
109 void *buf, size_t size)
111 struct builtin_fw *b_fw;
113 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++) {
114 if (strcmp(name, b_fw->name) == 0) {
115 fw->size = b_fw->size;
116 fw->data = b_fw->data;
117 fw_copy_to_prealloc_buf(fw, buf, size);
126 static bool fw_is_builtin_firmware(const struct firmware *fw)
128 struct builtin_fw *b_fw;
130 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++)
131 if (fw->data == b_fw->data)
137 #else /* Module case - no builtin firmware support */
139 static inline bool fw_get_builtin_firmware(struct firmware *fw,
140 const char *name, void *buf,
146 static inline bool fw_is_builtin_firmware(const struct firmware *fw)
152 static void fw_state_init(struct fw_priv *fw_priv)
154 struct fw_state *fw_st = &fw_priv->fw_st;
156 init_completion(&fw_st->completion);
157 fw_st->status = FW_STATUS_UNKNOWN;
160 static inline int fw_state_wait(struct fw_priv *fw_priv)
162 return __fw_state_wait_common(fw_priv, MAX_SCHEDULE_TIMEOUT);
165 static int fw_cache_piggyback_on_request(const char *name);
167 static struct fw_priv *__allocate_fw_priv(const char *fw_name,
168 struct firmware_cache *fwc,
169 void *dbuf, size_t size)
171 struct fw_priv *fw_priv;
173 fw_priv = kzalloc(sizeof(*fw_priv), GFP_ATOMIC);
177 fw_priv->fw_name = kstrdup_const(fw_name, GFP_ATOMIC);
178 if (!fw_priv->fw_name) {
183 kref_init(&fw_priv->ref);
185 fw_priv->data = dbuf;
186 fw_priv->allocated_size = size;
187 fw_state_init(fw_priv);
188 #ifdef CONFIG_FW_LOADER_USER_HELPER
189 INIT_LIST_HEAD(&fw_priv->pending_list);
192 pr_debug("%s: fw-%s fw_priv=%p\n", __func__, fw_name, fw_priv);
197 static struct fw_priv *__lookup_fw_priv(const char *fw_name)
200 struct firmware_cache *fwc = &fw_cache;
202 list_for_each_entry(tmp, &fwc->head, list)
203 if (!strcmp(tmp->fw_name, fw_name))
208 /* Returns 1 for batching firmware requests with the same name */
209 static int alloc_lookup_fw_priv(const char *fw_name,
210 struct firmware_cache *fwc,
211 struct fw_priv **fw_priv, void *dbuf,
212 size_t size, enum fw_opt opt_flags)
216 spin_lock(&fwc->lock);
217 if (!(opt_flags & FW_OPT_NOCACHE)) {
218 tmp = __lookup_fw_priv(fw_name);
221 spin_unlock(&fwc->lock);
223 pr_debug("batched request - sharing the same struct fw_priv and lookup for multiple requests\n");
228 tmp = __allocate_fw_priv(fw_name, fwc, dbuf, size);
229 if (tmp && !(opt_flags & FW_OPT_NOCACHE))
230 list_add(&tmp->list, &fwc->head);
231 spin_unlock(&fwc->lock);
235 return tmp ? 0 : -ENOMEM;
238 static void __free_fw_priv(struct kref *ref)
239 __releases(&fwc->lock)
241 struct fw_priv *fw_priv = to_fw_priv(ref);
242 struct firmware_cache *fwc = fw_priv->fwc;
244 pr_debug("%s: fw-%s fw_priv=%p data=%p size=%u\n",
245 __func__, fw_priv->fw_name, fw_priv, fw_priv->data,
246 (unsigned int)fw_priv->size);
248 list_del(&fw_priv->list);
249 spin_unlock(&fwc->lock);
251 #ifdef CONFIG_FW_LOADER_USER_HELPER
252 if (fw_priv->is_paged_buf) {
254 vunmap(fw_priv->data);
255 for (i = 0; i < fw_priv->nr_pages; i++)
256 __free_page(fw_priv->pages[i]);
257 vfree(fw_priv->pages);
260 if (!fw_priv->allocated_size)
261 vfree(fw_priv->data);
262 kfree_const(fw_priv->fw_name);
266 static void free_fw_priv(struct fw_priv *fw_priv)
268 struct firmware_cache *fwc = fw_priv->fwc;
269 spin_lock(&fwc->lock);
270 if (!kref_put(&fw_priv->ref, __free_fw_priv))
271 spin_unlock(&fwc->lock);
274 /* direct firmware loading support */
275 static char fw_path_para[256];
276 static const char * const fw_path[] = {
278 "/lib/firmware/updates/" UTS_RELEASE,
279 "/lib/firmware/updates",
280 "/lib/firmware/" UTS_RELEASE,
285 * Typical usage is that passing 'firmware_class.path=$CUSTOMIZED_PATH'
286 * from kernel command line because firmware_class is generally built in
287 * kernel instead of module.
289 module_param_string(path, fw_path_para, sizeof(fw_path_para), 0644);
290 MODULE_PARM_DESC(path, "customized firmware image search path with a higher priority than default path");
293 fw_get_filesystem_firmware(struct device *device, struct fw_priv *fw_priv)
299 enum kernel_read_file_id id = READING_FIRMWARE;
300 size_t msize = INT_MAX;
302 /* Already populated data member means we're loading into a buffer */
304 id = READING_FIRMWARE_PREALLOC_BUFFER;
305 msize = fw_priv->allocated_size;
312 for (i = 0; i < ARRAY_SIZE(fw_path); i++) {
313 /* skip the unset customized path */
317 len = snprintf(path, PATH_MAX, "%s/%s",
318 fw_path[i], fw_priv->fw_name);
319 if (len >= PATH_MAX) {
325 rc = kernel_read_file_from_path(path, &fw_priv->data, &size,
329 dev_dbg(device, "loading %s failed with error %d\n",
332 dev_warn(device, "loading %s failed with error %d\n",
336 dev_dbg(device, "direct-loading %s\n", fw_priv->fw_name);
337 fw_priv->size = size;
338 fw_state_done(fw_priv);
346 /* firmware holds the ownership of pages */
347 static void firmware_free_data(const struct firmware *fw)
349 /* Loaded directly? */
354 free_fw_priv(fw->priv);
357 /* store the pages buffer info firmware from buf */
358 static void fw_set_page_data(struct fw_priv *fw_priv, struct firmware *fw)
361 #ifdef CONFIG_FW_LOADER_USER_HELPER
362 fw->pages = fw_priv->pages;
364 fw->size = fw_priv->size;
365 fw->data = fw_priv->data;
367 pr_debug("%s: fw-%s fw_priv=%p data=%p size=%u\n",
368 __func__, fw_priv->fw_name, fw_priv, fw_priv->data,
369 (unsigned int)fw_priv->size);
372 #ifdef CONFIG_PM_SLEEP
373 static void fw_name_devm_release(struct device *dev, void *res)
375 struct fw_name_devm *fwn = res;
377 if (fwn->magic == (unsigned long)&fw_cache)
378 pr_debug("%s: fw_name-%s devm-%p released\n",
379 __func__, fwn->name, res);
380 kfree_const(fwn->name);
383 static int fw_devm_match(struct device *dev, void *res,
386 struct fw_name_devm *fwn = res;
388 return (fwn->magic == (unsigned long)&fw_cache) &&
389 !strcmp(fwn->name, match_data);
392 static struct fw_name_devm *fw_find_devm_name(struct device *dev,
395 struct fw_name_devm *fwn;
397 fwn = devres_find(dev, fw_name_devm_release,
398 fw_devm_match, (void *)name);
402 static bool fw_cache_is_setup(struct device *dev, const char *name)
404 struct fw_name_devm *fwn;
406 fwn = fw_find_devm_name(dev, name);
413 /* add firmware name into devres list */
414 static int fw_add_devm_name(struct device *dev, const char *name)
416 struct fw_name_devm *fwn;
418 if (fw_cache_is_setup(dev, name))
421 fwn = devres_alloc(fw_name_devm_release, sizeof(struct fw_name_devm),
425 fwn->name = kstrdup_const(name, GFP_KERNEL);
431 fwn->magic = (unsigned long)&fw_cache;
432 devres_add(dev, fwn);
437 static bool fw_cache_is_setup(struct device *dev, const char *name)
442 static int fw_add_devm_name(struct device *dev, const char *name)
448 int assign_fw(struct firmware *fw, struct device *device,
449 enum fw_opt opt_flags)
451 struct fw_priv *fw_priv = fw->priv;
454 mutex_lock(&fw_lock);
455 if (!fw_priv->size || fw_state_is_aborted(fw_priv)) {
456 mutex_unlock(&fw_lock);
461 * add firmware name into devres list so that we can auto cache
462 * and uncache firmware for device.
464 * device may has been deleted already, but the problem
465 * should be fixed in devres or driver core.
467 /* don't cache firmware handled without uevent */
468 if (device && (opt_flags & FW_OPT_UEVENT) &&
469 !(opt_flags & FW_OPT_NOCACHE)) {
470 ret = fw_add_devm_name(device, fw_priv->fw_name);
472 mutex_unlock(&fw_lock);
478 * After caching firmware image is started, let it piggyback
479 * on request firmware.
481 if (!(opt_flags & FW_OPT_NOCACHE) &&
482 fw_priv->fwc->state == FW_LOADER_START_CACHE) {
483 if (fw_cache_piggyback_on_request(fw_priv->fw_name))
484 kref_get(&fw_priv->ref);
487 /* pass the pages buffer to driver at the last minute */
488 fw_set_page_data(fw_priv, fw);
489 mutex_unlock(&fw_lock);
493 /* prepare firmware and firmware_buf structs;
494 * return 0 if a firmware is already assigned, 1 if need to load one,
495 * or a negative error code
498 _request_firmware_prepare(struct firmware **firmware_p, const char *name,
499 struct device *device, void *dbuf, size_t size,
500 enum fw_opt opt_flags)
502 struct firmware *firmware;
503 struct fw_priv *fw_priv;
506 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
508 dev_err(device, "%s: kmalloc(struct firmware) failed\n",
513 if (fw_get_builtin_firmware(firmware, name, dbuf, size)) {
514 dev_dbg(device, "using built-in %s\n", name);
515 return 0; /* assigned */
518 ret = alloc_lookup_fw_priv(name, &fw_cache, &fw_priv, dbuf, size,
522 * bind with 'priv' now to avoid warning in failure path
523 * of requesting firmware.
525 firmware->priv = fw_priv;
528 ret = fw_state_wait(fw_priv);
530 fw_set_page_data(fw_priv, firmware);
531 return 0; /* assigned */
537 return 1; /* need to load */
541 * Batched requests need only one wake, we need to do this step last due to the
542 * fallback mechanism. The buf is protected with kref_get(), and it won't be
543 * released until the last user calls release_firmware().
545 * Failed batched requests are possible as well, in such cases we just share
546 * the struct fw_priv and won't release it until all requests are woken
547 * and have gone through this same path.
549 static void fw_abort_batch_reqs(struct firmware *fw)
551 struct fw_priv *fw_priv;
553 /* Loaded directly? */
554 if (!fw || !fw->priv)
558 if (!fw_state_is_aborted(fw_priv))
559 fw_state_aborted(fw_priv);
562 /* called from request_firmware() and request_firmware_work_func() */
564 _request_firmware(const struct firmware **firmware_p, const char *name,
565 struct device *device, void *buf, size_t size,
566 enum fw_opt opt_flags)
568 struct firmware *fw = NULL;
574 if (!name || name[0] == '\0') {
579 ret = _request_firmware_prepare(&fw, name, device, buf, size,
581 if (ret <= 0) /* error or already assigned */
584 ret = fw_get_filesystem_firmware(device, fw->priv);
586 if (!(opt_flags & FW_OPT_NO_WARN))
588 "Direct firmware load for %s failed with error %d\n",
590 ret = firmware_fallback_sysfs(fw, name, device, opt_flags, ret);
592 ret = assign_fw(fw, device, opt_flags);
596 fw_abort_batch_reqs(fw);
597 release_firmware(fw);
606 * request_firmware() - send firmware request and wait for it
607 * @firmware_p: pointer to firmware image
608 * @name: name of firmware file
609 * @device: device for which firmware is being loaded
611 * @firmware_p will be used to return a firmware image by the name
612 * of @name for device @device.
614 * Should be called from user context where sleeping is allowed.
616 * @name will be used as $FIRMWARE in the uevent environment and
617 * should be distinctive enough not to be confused with any other
618 * firmware image for this or any other device.
620 * Caller must hold the reference count of @device.
622 * The function can be called safely inside device's suspend and
626 request_firmware(const struct firmware **firmware_p, const char *name,
627 struct device *device)
631 /* Need to pin this module until return */
632 __module_get(THIS_MODULE);
633 ret = _request_firmware(firmware_p, name, device, NULL, 0,
635 module_put(THIS_MODULE);
638 EXPORT_SYMBOL(request_firmware);
641 * firmware_request_nowarn() - request for an optional fw module
642 * @firmware: pointer to firmware image
643 * @name: name of firmware file
644 * @device: device for which firmware is being loaded
646 * This function is similar in behaviour to request_firmware(), except
647 * it doesn't produce warning messages when the file is not found.
648 * The sysfs fallback mechanism is enabled if direct filesystem lookup fails,
649 * however, however failures to find the firmware file with it are still
650 * suppressed. It is therefore up to the driver to check for the return value
651 * of this call and to decide when to inform the users of errors.
653 int firmware_request_nowarn(const struct firmware **firmware, const char *name,
654 struct device *device)
658 /* Need to pin this module until return */
659 __module_get(THIS_MODULE);
660 ret = _request_firmware(firmware, name, device, NULL, 0,
661 FW_OPT_UEVENT | FW_OPT_NO_WARN);
662 module_put(THIS_MODULE);
665 EXPORT_SYMBOL_GPL(firmware_request_nowarn);
668 * request_firmware_direct() - load firmware directly without usermode helper
669 * @firmware_p: pointer to firmware image
670 * @name: name of firmware file
671 * @device: device for which firmware is being loaded
673 * This function works pretty much like request_firmware(), but this doesn't
674 * fall back to usermode helper even if the firmware couldn't be loaded
675 * directly from fs. Hence it's useful for loading optional firmwares, which
676 * aren't always present, without extra long timeouts of udev.
678 int request_firmware_direct(const struct firmware **firmware_p,
679 const char *name, struct device *device)
683 __module_get(THIS_MODULE);
684 ret = _request_firmware(firmware_p, name, device, NULL, 0,
685 FW_OPT_UEVENT | FW_OPT_NO_WARN |
687 module_put(THIS_MODULE);
690 EXPORT_SYMBOL_GPL(request_firmware_direct);
693 * firmware_request_cache() - cache firmware for suspend so resume can use it
694 * @name: name of firmware file
695 * @device: device for which firmware should be cached for
697 * There are some devices with an optimization that enables the device to not
698 * require loading firmware on system reboot. This optimization may still
699 * require the firmware present on resume from suspend. This routine can be
700 * used to ensure the firmware is present on resume from suspend in these
701 * situations. This helper is not compatible with drivers which use
702 * request_firmware_into_buf() or request_firmware_nowait() with no uevent set.
704 int firmware_request_cache(struct device *device, const char *name)
708 mutex_lock(&fw_lock);
709 ret = fw_add_devm_name(device, name);
710 mutex_unlock(&fw_lock);
714 EXPORT_SYMBOL_GPL(firmware_request_cache);
717 * request_firmware_into_buf() - load firmware into a previously allocated buffer
718 * @firmware_p: pointer to firmware image
719 * @name: name of firmware file
720 * @device: device for which firmware is being loaded and DMA region allocated
721 * @buf: address of buffer to load firmware into
722 * @size: size of buffer
724 * This function works pretty much like request_firmware(), but it doesn't
725 * allocate a buffer to hold the firmware data. Instead, the firmware
726 * is loaded directly into the buffer pointed to by @buf and the @firmware_p
727 * data member is pointed at @buf.
729 * This function doesn't cache firmware either.
732 request_firmware_into_buf(const struct firmware **firmware_p, const char *name,
733 struct device *device, void *buf, size_t size)
737 if (fw_cache_is_setup(device, name))
740 __module_get(THIS_MODULE);
741 ret = _request_firmware(firmware_p, name, device, buf, size,
742 FW_OPT_UEVENT | FW_OPT_NOCACHE);
743 module_put(THIS_MODULE);
746 EXPORT_SYMBOL(request_firmware_into_buf);
749 * release_firmware() - release the resource associated with a firmware image
750 * @fw: firmware resource to release
752 void release_firmware(const struct firmware *fw)
755 if (!fw_is_builtin_firmware(fw))
756 firmware_free_data(fw);
760 EXPORT_SYMBOL(release_firmware);
763 struct firmware_work {
764 struct work_struct work;
765 struct module *module;
767 struct device *device;
769 void (*cont)(const struct firmware *fw, void *context);
770 enum fw_opt opt_flags;
773 static void request_firmware_work_func(struct work_struct *work)
775 struct firmware_work *fw_work;
776 const struct firmware *fw;
778 fw_work = container_of(work, struct firmware_work, work);
780 _request_firmware(&fw, fw_work->name, fw_work->device, NULL, 0,
782 fw_work->cont(fw, fw_work->context);
783 put_device(fw_work->device); /* taken in request_firmware_nowait() */
785 module_put(fw_work->module);
786 kfree_const(fw_work->name);
791 * request_firmware_nowait() - asynchronous version of request_firmware
792 * @module: module requesting the firmware
793 * @uevent: sends uevent to copy the firmware image if this flag
794 * is non-zero else the firmware copy must be done manually.
795 * @name: name of firmware file
796 * @device: device for which firmware is being loaded
797 * @gfp: allocation flags
798 * @context: will be passed over to @cont, and
799 * @fw may be %NULL if firmware request fails.
800 * @cont: function will be called asynchronously when the firmware
803 * Caller must hold the reference count of @device.
805 * Asynchronous variant of request_firmware() for user contexts:
806 * - sleep for as small periods as possible since it may
807 * increase kernel boot time of built-in device drivers
808 * requesting firmware in their ->probe() methods, if
809 * @gfp is GFP_KERNEL.
811 * - can't sleep at all if @gfp is GFP_ATOMIC.
814 request_firmware_nowait(
815 struct module *module, bool uevent,
816 const char *name, struct device *device, gfp_t gfp, void *context,
817 void (*cont)(const struct firmware *fw, void *context))
819 struct firmware_work *fw_work;
821 fw_work = kzalloc(sizeof(struct firmware_work), gfp);
825 fw_work->module = module;
826 fw_work->name = kstrdup_const(name, gfp);
827 if (!fw_work->name) {
831 fw_work->device = device;
832 fw_work->context = context;
833 fw_work->cont = cont;
834 fw_work->opt_flags = FW_OPT_NOWAIT |
835 (uevent ? FW_OPT_UEVENT : FW_OPT_USERHELPER);
837 if (!uevent && fw_cache_is_setup(device, name)) {
838 kfree_const(fw_work->name);
843 if (!try_module_get(module)) {
844 kfree_const(fw_work->name);
849 get_device(fw_work->device);
850 INIT_WORK(&fw_work->work, request_firmware_work_func);
851 schedule_work(&fw_work->work);
854 EXPORT_SYMBOL(request_firmware_nowait);
856 #ifdef CONFIG_PM_SLEEP
857 static ASYNC_DOMAIN_EXCLUSIVE(fw_cache_domain);
860 * cache_firmware() - cache one firmware image in kernel memory space
861 * @fw_name: the firmware image name
863 * Cache firmware in kernel memory so that drivers can use it when
864 * system isn't ready for them to request firmware image from userspace.
865 * Once it returns successfully, driver can use request_firmware or its
866 * nowait version to get the cached firmware without any interacting
869 * Return 0 if the firmware image has been cached successfully
870 * Return !0 otherwise
873 static int cache_firmware(const char *fw_name)
876 const struct firmware *fw;
878 pr_debug("%s: %s\n", __func__, fw_name);
880 ret = request_firmware(&fw, fw_name, NULL);
884 pr_debug("%s: %s ret=%d\n", __func__, fw_name, ret);
889 static struct fw_priv *lookup_fw_priv(const char *fw_name)
892 struct firmware_cache *fwc = &fw_cache;
894 spin_lock(&fwc->lock);
895 tmp = __lookup_fw_priv(fw_name);
896 spin_unlock(&fwc->lock);
902 * uncache_firmware() - remove one cached firmware image
903 * @fw_name: the firmware image name
905 * Uncache one firmware image which has been cached successfully
908 * Return 0 if the firmware cache has been removed successfully
909 * Return !0 otherwise
912 static int uncache_firmware(const char *fw_name)
914 struct fw_priv *fw_priv;
917 pr_debug("%s: %s\n", __func__, fw_name);
919 if (fw_get_builtin_firmware(&fw, fw_name, NULL, 0))
922 fw_priv = lookup_fw_priv(fw_name);
924 free_fw_priv(fw_priv);
931 static struct fw_cache_entry *alloc_fw_cache_entry(const char *name)
933 struct fw_cache_entry *fce;
935 fce = kzalloc(sizeof(*fce), GFP_ATOMIC);
939 fce->name = kstrdup_const(name, GFP_ATOMIC);
949 static int __fw_entry_found(const char *name)
951 struct firmware_cache *fwc = &fw_cache;
952 struct fw_cache_entry *fce;
954 list_for_each_entry(fce, &fwc->fw_names, list) {
955 if (!strcmp(fce->name, name))
961 static int fw_cache_piggyback_on_request(const char *name)
963 struct firmware_cache *fwc = &fw_cache;
964 struct fw_cache_entry *fce;
967 spin_lock(&fwc->name_lock);
968 if (__fw_entry_found(name))
971 fce = alloc_fw_cache_entry(name);
974 list_add(&fce->list, &fwc->fw_names);
975 pr_debug("%s: fw: %s\n", __func__, name);
978 spin_unlock(&fwc->name_lock);
982 static void free_fw_cache_entry(struct fw_cache_entry *fce)
984 kfree_const(fce->name);
988 static void __async_dev_cache_fw_image(void *fw_entry,
989 async_cookie_t cookie)
991 struct fw_cache_entry *fce = fw_entry;
992 struct firmware_cache *fwc = &fw_cache;
995 ret = cache_firmware(fce->name);
997 spin_lock(&fwc->name_lock);
998 list_del(&fce->list);
999 spin_unlock(&fwc->name_lock);
1001 free_fw_cache_entry(fce);
1005 /* called with dev->devres_lock held */
1006 static void dev_create_fw_entry(struct device *dev, void *res,
1009 struct fw_name_devm *fwn = res;
1010 const char *fw_name = fwn->name;
1011 struct list_head *head = data;
1012 struct fw_cache_entry *fce;
1014 fce = alloc_fw_cache_entry(fw_name);
1016 list_add(&fce->list, head);
1019 static int devm_name_match(struct device *dev, void *res,
1022 struct fw_name_devm *fwn = res;
1023 return (fwn->magic == (unsigned long)match_data);
1026 static void dev_cache_fw_image(struct device *dev, void *data)
1029 struct fw_cache_entry *fce;
1030 struct fw_cache_entry *fce_next;
1031 struct firmware_cache *fwc = &fw_cache;
1033 devres_for_each_res(dev, fw_name_devm_release,
1034 devm_name_match, &fw_cache,
1035 dev_create_fw_entry, &todo);
1037 list_for_each_entry_safe(fce, fce_next, &todo, list) {
1038 list_del(&fce->list);
1040 spin_lock(&fwc->name_lock);
1041 /* only one cache entry for one firmware */
1042 if (!__fw_entry_found(fce->name)) {
1043 list_add(&fce->list, &fwc->fw_names);
1045 free_fw_cache_entry(fce);
1048 spin_unlock(&fwc->name_lock);
1051 async_schedule_domain(__async_dev_cache_fw_image,
1057 static void __device_uncache_fw_images(void)
1059 struct firmware_cache *fwc = &fw_cache;
1060 struct fw_cache_entry *fce;
1062 spin_lock(&fwc->name_lock);
1063 while (!list_empty(&fwc->fw_names)) {
1064 fce = list_entry(fwc->fw_names.next,
1065 struct fw_cache_entry, list);
1066 list_del(&fce->list);
1067 spin_unlock(&fwc->name_lock);
1069 uncache_firmware(fce->name);
1070 free_fw_cache_entry(fce);
1072 spin_lock(&fwc->name_lock);
1074 spin_unlock(&fwc->name_lock);
1078 * device_cache_fw_images() - cache devices' firmware
1080 * If one device called request_firmware or its nowait version
1081 * successfully before, the firmware names are recored into the
1082 * device's devres link list, so device_cache_fw_images can call
1083 * cache_firmware() to cache these firmwares for the device,
1084 * then the device driver can load its firmwares easily at
1085 * time when system is not ready to complete loading firmware.
1087 static void device_cache_fw_images(void)
1089 struct firmware_cache *fwc = &fw_cache;
1092 pr_debug("%s\n", __func__);
1094 /* cancel uncache work */
1095 cancel_delayed_work_sync(&fwc->work);
1097 fw_fallback_set_cache_timeout();
1099 mutex_lock(&fw_lock);
1100 fwc->state = FW_LOADER_START_CACHE;
1101 dpm_for_each_dev(NULL, dev_cache_fw_image);
1102 mutex_unlock(&fw_lock);
1104 /* wait for completion of caching firmware for all devices */
1105 async_synchronize_full_domain(&fw_cache_domain);
1107 fw_fallback_set_default_timeout();
1111 * device_uncache_fw_images() - uncache devices' firmware
1113 * uncache all firmwares which have been cached successfully
1114 * by device_uncache_fw_images earlier
1116 static void device_uncache_fw_images(void)
1118 pr_debug("%s\n", __func__);
1119 __device_uncache_fw_images();
1122 static void device_uncache_fw_images_work(struct work_struct *work)
1124 device_uncache_fw_images();
1128 * device_uncache_fw_images_delay() - uncache devices firmwares
1129 * @delay: number of milliseconds to delay uncache device firmwares
1131 * uncache all devices's firmwares which has been cached successfully
1132 * by device_cache_fw_images after @delay milliseconds.
1134 static void device_uncache_fw_images_delay(unsigned long delay)
1136 queue_delayed_work(system_power_efficient_wq, &fw_cache.work,
1137 msecs_to_jiffies(delay));
1140 static int fw_pm_notify(struct notifier_block *notify_block,
1141 unsigned long mode, void *unused)
1144 case PM_HIBERNATION_PREPARE:
1145 case PM_SUSPEND_PREPARE:
1146 case PM_RESTORE_PREPARE:
1148 * kill pending fallback requests with a custom fallback
1149 * to avoid stalling suspend.
1151 kill_pending_fw_fallback_reqs(true);
1152 device_cache_fw_images();
1155 case PM_POST_SUSPEND:
1156 case PM_POST_HIBERNATION:
1157 case PM_POST_RESTORE:
1159 * In case that system sleep failed and syscore_suspend is
1162 mutex_lock(&fw_lock);
1163 fw_cache.state = FW_LOADER_NO_CACHE;
1164 mutex_unlock(&fw_lock);
1166 device_uncache_fw_images_delay(10 * MSEC_PER_SEC);
1173 /* stop caching firmware once syscore_suspend is reached */
1174 static int fw_suspend(void)
1176 fw_cache.state = FW_LOADER_NO_CACHE;
1180 static struct syscore_ops fw_syscore_ops = {
1181 .suspend = fw_suspend,
1184 static int __init register_fw_pm_ops(void)
1188 spin_lock_init(&fw_cache.name_lock);
1189 INIT_LIST_HEAD(&fw_cache.fw_names);
1191 INIT_DELAYED_WORK(&fw_cache.work,
1192 device_uncache_fw_images_work);
1194 fw_cache.pm_notify.notifier_call = fw_pm_notify;
1195 ret = register_pm_notifier(&fw_cache.pm_notify);
1199 register_syscore_ops(&fw_syscore_ops);
1204 static inline void unregister_fw_pm_ops(void)
1206 unregister_syscore_ops(&fw_syscore_ops);
1207 unregister_pm_notifier(&fw_cache.pm_notify);
1210 static int fw_cache_piggyback_on_request(const char *name)
1214 static inline int register_fw_pm_ops(void)
1218 static inline void unregister_fw_pm_ops(void)
1223 static void __init fw_cache_init(void)
1225 spin_lock_init(&fw_cache.lock);
1226 INIT_LIST_HEAD(&fw_cache.head);
1227 fw_cache.state = FW_LOADER_NO_CACHE;
1230 static int fw_shutdown_notify(struct notifier_block *unused1,
1231 unsigned long unused2, void *unused3)
1234 * Kill all pending fallback requests to avoid both stalling shutdown,
1235 * and avoid a deadlock with the usermode_lock.
1237 kill_pending_fw_fallback_reqs(false);
1242 static struct notifier_block fw_shutdown_nb = {
1243 .notifier_call = fw_shutdown_notify,
1246 static int __init firmware_class_init(void)
1250 /* No need to unfold these on exit */
1253 ret = register_fw_pm_ops();
1257 ret = register_reboot_notifier(&fw_shutdown_nb);
1261 return register_sysfs_loader();
1264 unregister_fw_pm_ops();
1268 static void __exit firmware_class_exit(void)
1270 unregister_fw_pm_ops();
1271 unregister_reboot_notifier(&fw_shutdown_nb);
1272 unregister_sysfs_loader();
1275 fs_initcall(firmware_class_init);
1276 module_exit(firmware_class_exit);