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);
230 INIT_LIST_HEAD(&tmp->list);
231 if (!(opt_flags & FW_OPT_NOCACHE))
232 list_add(&tmp->list, &fwc->head);
234 spin_unlock(&fwc->lock);
238 return tmp ? 0 : -ENOMEM;
241 static void __free_fw_priv(struct kref *ref)
242 __releases(&fwc->lock)
244 struct fw_priv *fw_priv = to_fw_priv(ref);
245 struct firmware_cache *fwc = fw_priv->fwc;
247 pr_debug("%s: fw-%s fw_priv=%p data=%p size=%u\n",
248 __func__, fw_priv->fw_name, fw_priv, fw_priv->data,
249 (unsigned int)fw_priv->size);
251 list_del(&fw_priv->list);
252 spin_unlock(&fwc->lock);
254 fw_free_paged_buf(fw_priv); /* free leftover pages */
255 if (!fw_priv->allocated_size)
256 vfree(fw_priv->data);
257 kfree_const(fw_priv->fw_name);
261 static void free_fw_priv(struct fw_priv *fw_priv)
263 struct firmware_cache *fwc = fw_priv->fwc;
264 spin_lock(&fwc->lock);
265 if (!kref_put(&fw_priv->ref, __free_fw_priv))
266 spin_unlock(&fwc->lock);
269 #ifdef CONFIG_FW_LOADER_USER_HELPER
270 void fw_free_paged_buf(struct fw_priv *fw_priv)
277 for (i = 0; i < fw_priv->nr_pages; i++)
278 __free_page(fw_priv->pages[i]);
279 kvfree(fw_priv->pages);
280 fw_priv->pages = NULL;
281 fw_priv->page_array_size = 0;
282 fw_priv->nr_pages = 0;
285 int fw_grow_paged_buf(struct fw_priv *fw_priv, int pages_needed)
287 /* If the array of pages is too small, grow it */
288 if (fw_priv->page_array_size < pages_needed) {
289 int new_array_size = max(pages_needed,
290 fw_priv->page_array_size * 2);
291 struct page **new_pages;
293 new_pages = kvmalloc_array(new_array_size, sizeof(void *),
297 memcpy(new_pages, fw_priv->pages,
298 fw_priv->page_array_size * sizeof(void *));
299 memset(&new_pages[fw_priv->page_array_size], 0, sizeof(void *) *
300 (new_array_size - fw_priv->page_array_size));
301 kvfree(fw_priv->pages);
302 fw_priv->pages = new_pages;
303 fw_priv->page_array_size = new_array_size;
306 while (fw_priv->nr_pages < pages_needed) {
307 fw_priv->pages[fw_priv->nr_pages] =
308 alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
310 if (!fw_priv->pages[fw_priv->nr_pages])
318 int fw_map_paged_buf(struct fw_priv *fw_priv)
320 /* one pages buffer should be mapped/unmapped only once */
324 vunmap(fw_priv->data);
325 fw_priv->data = vmap(fw_priv->pages, fw_priv->nr_pages, 0,
330 /* page table is no longer needed after mapping, let's free */
331 kvfree(fw_priv->pages);
332 fw_priv->pages = NULL;
338 /* direct firmware loading support */
339 static char fw_path_para[256];
340 static const char * const fw_path[] = {
342 "/lib/firmware/updates/" UTS_RELEASE,
343 "/lib/firmware/updates",
344 "/lib/firmware/" UTS_RELEASE,
349 * Typical usage is that passing 'firmware_class.path=$CUSTOMIZED_PATH'
350 * from kernel command line because firmware_class is generally built in
351 * kernel instead of module.
353 module_param_string(path, fw_path_para, sizeof(fw_path_para), 0644);
354 MODULE_PARM_DESC(path, "customized firmware image search path with a higher priority than default path");
357 fw_get_filesystem_firmware(struct device *device, struct fw_priv *fw_priv)
363 enum kernel_read_file_id id = READING_FIRMWARE;
364 size_t msize = INT_MAX;
366 /* Already populated data member means we're loading into a buffer */
368 id = READING_FIRMWARE_PREALLOC_BUFFER;
369 msize = fw_priv->allocated_size;
376 for (i = 0; i < ARRAY_SIZE(fw_path); i++) {
377 /* skip the unset customized path */
381 len = snprintf(path, PATH_MAX, "%s/%s",
382 fw_path[i], fw_priv->fw_name);
383 if (len >= PATH_MAX) {
389 rc = kernel_read_file_from_path(path, &fw_priv->data, &size,
393 dev_warn(device, "loading %s failed with error %d\n",
396 dev_dbg(device, "loading %s failed for no such file or directory.\n",
400 dev_dbg(device, "direct-loading %s\n", fw_priv->fw_name);
401 fw_priv->size = size;
402 fw_state_done(fw_priv);
410 /* firmware holds the ownership of pages */
411 static void firmware_free_data(const struct firmware *fw)
413 /* Loaded directly? */
418 free_fw_priv(fw->priv);
421 /* store the pages buffer info firmware from buf */
422 static void fw_set_page_data(struct fw_priv *fw_priv, struct firmware *fw)
425 #ifdef CONFIG_FW_LOADER_USER_HELPER
426 fw->pages = fw_priv->pages;
428 fw->size = fw_priv->size;
429 fw->data = fw_priv->data;
431 pr_debug("%s: fw-%s fw_priv=%p data=%p size=%u\n",
432 __func__, fw_priv->fw_name, fw_priv, fw_priv->data,
433 (unsigned int)fw_priv->size);
436 #ifdef CONFIG_PM_SLEEP
437 static void fw_name_devm_release(struct device *dev, void *res)
439 struct fw_name_devm *fwn = res;
441 if (fwn->magic == (unsigned long)&fw_cache)
442 pr_debug("%s: fw_name-%s devm-%p released\n",
443 __func__, fwn->name, res);
444 kfree_const(fwn->name);
447 static int fw_devm_match(struct device *dev, void *res,
450 struct fw_name_devm *fwn = res;
452 return (fwn->magic == (unsigned long)&fw_cache) &&
453 !strcmp(fwn->name, match_data);
456 static struct fw_name_devm *fw_find_devm_name(struct device *dev,
459 struct fw_name_devm *fwn;
461 fwn = devres_find(dev, fw_name_devm_release,
462 fw_devm_match, (void *)name);
466 static bool fw_cache_is_setup(struct device *dev, const char *name)
468 struct fw_name_devm *fwn;
470 fwn = fw_find_devm_name(dev, name);
477 /* add firmware name into devres list */
478 static int fw_add_devm_name(struct device *dev, const char *name)
480 struct fw_name_devm *fwn;
482 if (fw_cache_is_setup(dev, name))
485 fwn = devres_alloc(fw_name_devm_release, sizeof(struct fw_name_devm),
489 fwn->name = kstrdup_const(name, GFP_KERNEL);
495 fwn->magic = (unsigned long)&fw_cache;
496 devres_add(dev, fwn);
501 static bool fw_cache_is_setup(struct device *dev, const char *name)
506 static int fw_add_devm_name(struct device *dev, const char *name)
512 int assign_fw(struct firmware *fw, struct device *device,
513 enum fw_opt opt_flags)
515 struct fw_priv *fw_priv = fw->priv;
518 mutex_lock(&fw_lock);
519 if (!fw_priv->size || fw_state_is_aborted(fw_priv)) {
520 mutex_unlock(&fw_lock);
525 * add firmware name into devres list so that we can auto cache
526 * and uncache firmware for device.
528 * device may has been deleted already, but the problem
529 * should be fixed in devres or driver core.
531 /* don't cache firmware handled without uevent */
532 if (device && (opt_flags & FW_OPT_UEVENT) &&
533 !(opt_flags & FW_OPT_NOCACHE)) {
534 ret = fw_add_devm_name(device, fw_priv->fw_name);
536 mutex_unlock(&fw_lock);
542 * After caching firmware image is started, let it piggyback
543 * on request firmware.
545 if (!(opt_flags & FW_OPT_NOCACHE) &&
546 fw_priv->fwc->state == FW_LOADER_START_CACHE) {
547 if (fw_cache_piggyback_on_request(fw_priv->fw_name))
548 kref_get(&fw_priv->ref);
551 /* pass the pages buffer to driver at the last minute */
552 fw_set_page_data(fw_priv, fw);
553 mutex_unlock(&fw_lock);
557 /* prepare firmware and firmware_buf structs;
558 * return 0 if a firmware is already assigned, 1 if need to load one,
559 * or a negative error code
562 _request_firmware_prepare(struct firmware **firmware_p, const char *name,
563 struct device *device, void *dbuf, size_t size,
564 enum fw_opt opt_flags)
566 struct firmware *firmware;
567 struct fw_priv *fw_priv;
570 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
572 dev_err(device, "%s: kmalloc(struct firmware) failed\n",
577 if (fw_get_builtin_firmware(firmware, name, dbuf, size)) {
578 dev_dbg(device, "using built-in %s\n", name);
579 return 0; /* assigned */
582 ret = alloc_lookup_fw_priv(name, &fw_cache, &fw_priv, dbuf, size,
586 * bind with 'priv' now to avoid warning in failure path
587 * of requesting firmware.
589 firmware->priv = fw_priv;
592 ret = fw_state_wait(fw_priv);
594 fw_set_page_data(fw_priv, firmware);
595 return 0; /* assigned */
601 return 1; /* need to load */
605 * Batched requests need only one wake, we need to do this step last due to the
606 * fallback mechanism. The buf is protected with kref_get(), and it won't be
607 * released until the last user calls release_firmware().
609 * Failed batched requests are possible as well, in such cases we just share
610 * the struct fw_priv and won't release it until all requests are woken
611 * and have gone through this same path.
613 static void fw_abort_batch_reqs(struct firmware *fw)
615 struct fw_priv *fw_priv;
617 /* Loaded directly? */
618 if (!fw || !fw->priv)
622 if (!fw_state_is_aborted(fw_priv))
623 fw_state_aborted(fw_priv);
626 /* called from request_firmware() and request_firmware_work_func() */
628 _request_firmware(const struct firmware **firmware_p, const char *name,
629 struct device *device, void *buf, size_t size,
630 enum fw_opt opt_flags)
632 struct firmware *fw = NULL;
638 if (!name || name[0] == '\0') {
643 ret = _request_firmware_prepare(&fw, name, device, buf, size,
645 if (ret <= 0) /* error or already assigned */
648 ret = fw_get_filesystem_firmware(device, fw->priv);
650 if (!(opt_flags & FW_OPT_NO_WARN))
652 "Direct firmware load for %s failed with error %d\n",
654 ret = firmware_fallback_sysfs(fw, name, device, opt_flags, ret);
656 ret = assign_fw(fw, device, opt_flags);
660 fw_abort_batch_reqs(fw);
661 release_firmware(fw);
670 * request_firmware() - send firmware request and wait for it
671 * @firmware_p: pointer to firmware image
672 * @name: name of firmware file
673 * @device: device for which firmware is being loaded
675 * @firmware_p will be used to return a firmware image by the name
676 * of @name for device @device.
678 * Should be called from user context where sleeping is allowed.
680 * @name will be used as $FIRMWARE in the uevent environment and
681 * should be distinctive enough not to be confused with any other
682 * firmware image for this or any other device.
684 * Caller must hold the reference count of @device.
686 * The function can be called safely inside device's suspend and
690 request_firmware(const struct firmware **firmware_p, const char *name,
691 struct device *device)
695 /* Need to pin this module until return */
696 __module_get(THIS_MODULE);
697 ret = _request_firmware(firmware_p, name, device, NULL, 0,
699 module_put(THIS_MODULE);
702 EXPORT_SYMBOL(request_firmware);
705 * firmware_request_nowarn() - request for an optional fw module
706 * @firmware: pointer to firmware image
707 * @name: name of firmware file
708 * @device: device for which firmware is being loaded
710 * This function is similar in behaviour to request_firmware(), except
711 * it doesn't produce warning messages when the file is not found.
712 * The sysfs fallback mechanism is enabled if direct filesystem lookup fails,
713 * however, however failures to find the firmware file with it are still
714 * suppressed. It is therefore up to the driver to check for the return value
715 * of this call and to decide when to inform the users of errors.
717 int firmware_request_nowarn(const struct firmware **firmware, const char *name,
718 struct device *device)
722 /* Need to pin this module until return */
723 __module_get(THIS_MODULE);
724 ret = _request_firmware(firmware, name, device, NULL, 0,
725 FW_OPT_UEVENT | FW_OPT_NO_WARN);
726 module_put(THIS_MODULE);
729 EXPORT_SYMBOL_GPL(firmware_request_nowarn);
732 * request_firmware_direct() - load firmware directly without usermode helper
733 * @firmware_p: pointer to firmware image
734 * @name: name of firmware file
735 * @device: device for which firmware is being loaded
737 * This function works pretty much like request_firmware(), but this doesn't
738 * fall back to usermode helper even if the firmware couldn't be loaded
739 * directly from fs. Hence it's useful for loading optional firmwares, which
740 * aren't always present, without extra long timeouts of udev.
742 int request_firmware_direct(const struct firmware **firmware_p,
743 const char *name, struct device *device)
747 __module_get(THIS_MODULE);
748 ret = _request_firmware(firmware_p, name, device, NULL, 0,
749 FW_OPT_UEVENT | FW_OPT_NO_WARN |
751 module_put(THIS_MODULE);
754 EXPORT_SYMBOL_GPL(request_firmware_direct);
757 * firmware_request_cache() - cache firmware for suspend so resume can use it
758 * @name: name of firmware file
759 * @device: device for which firmware should be cached for
761 * There are some devices with an optimization that enables the device to not
762 * require loading firmware on system reboot. This optimization may still
763 * require the firmware present on resume from suspend. This routine can be
764 * used to ensure the firmware is present on resume from suspend in these
765 * situations. This helper is not compatible with drivers which use
766 * request_firmware_into_buf() or request_firmware_nowait() with no uevent set.
768 int firmware_request_cache(struct device *device, const char *name)
772 mutex_lock(&fw_lock);
773 ret = fw_add_devm_name(device, name);
774 mutex_unlock(&fw_lock);
778 EXPORT_SYMBOL_GPL(firmware_request_cache);
781 * request_firmware_into_buf() - load firmware into a previously allocated buffer
782 * @firmware_p: pointer to firmware image
783 * @name: name of firmware file
784 * @device: device for which firmware is being loaded and DMA region allocated
785 * @buf: address of buffer to load firmware into
786 * @size: size of buffer
788 * This function works pretty much like request_firmware(), but it doesn't
789 * allocate a buffer to hold the firmware data. Instead, the firmware
790 * is loaded directly into the buffer pointed to by @buf and the @firmware_p
791 * data member is pointed at @buf.
793 * This function doesn't cache firmware either.
796 request_firmware_into_buf(const struct firmware **firmware_p, const char *name,
797 struct device *device, void *buf, size_t size)
801 if (fw_cache_is_setup(device, name))
804 __module_get(THIS_MODULE);
805 ret = _request_firmware(firmware_p, name, device, buf, size,
806 FW_OPT_UEVENT | FW_OPT_NOCACHE);
807 module_put(THIS_MODULE);
810 EXPORT_SYMBOL(request_firmware_into_buf);
813 * release_firmware() - release the resource associated with a firmware image
814 * @fw: firmware resource to release
816 void release_firmware(const struct firmware *fw)
819 if (!fw_is_builtin_firmware(fw))
820 firmware_free_data(fw);
824 EXPORT_SYMBOL(release_firmware);
827 struct firmware_work {
828 struct work_struct work;
829 struct module *module;
831 struct device *device;
833 void (*cont)(const struct firmware *fw, void *context);
834 enum fw_opt opt_flags;
837 static void request_firmware_work_func(struct work_struct *work)
839 struct firmware_work *fw_work;
840 const struct firmware *fw;
842 fw_work = container_of(work, struct firmware_work, work);
844 _request_firmware(&fw, fw_work->name, fw_work->device, NULL, 0,
846 fw_work->cont(fw, fw_work->context);
847 put_device(fw_work->device); /* taken in request_firmware_nowait() */
849 module_put(fw_work->module);
850 kfree_const(fw_work->name);
855 * request_firmware_nowait() - asynchronous version of request_firmware
856 * @module: module requesting the firmware
857 * @uevent: sends uevent to copy the firmware image if this flag
858 * is non-zero else the firmware copy must be done manually.
859 * @name: name of firmware file
860 * @device: device for which firmware is being loaded
861 * @gfp: allocation flags
862 * @context: will be passed over to @cont, and
863 * @fw may be %NULL if firmware request fails.
864 * @cont: function will be called asynchronously when the firmware
867 * Caller must hold the reference count of @device.
869 * Asynchronous variant of request_firmware() for user contexts:
870 * - sleep for as small periods as possible since it may
871 * increase kernel boot time of built-in device drivers
872 * requesting firmware in their ->probe() methods, if
873 * @gfp is GFP_KERNEL.
875 * - can't sleep at all if @gfp is GFP_ATOMIC.
878 request_firmware_nowait(
879 struct module *module, bool uevent,
880 const char *name, struct device *device, gfp_t gfp, void *context,
881 void (*cont)(const struct firmware *fw, void *context))
883 struct firmware_work *fw_work;
885 fw_work = kzalloc(sizeof(struct firmware_work), gfp);
889 fw_work->module = module;
890 fw_work->name = kstrdup_const(name, gfp);
891 if (!fw_work->name) {
895 fw_work->device = device;
896 fw_work->context = context;
897 fw_work->cont = cont;
898 fw_work->opt_flags = FW_OPT_NOWAIT |
899 (uevent ? FW_OPT_UEVENT : FW_OPT_USERHELPER);
901 if (!uevent && fw_cache_is_setup(device, name)) {
902 kfree_const(fw_work->name);
907 if (!try_module_get(module)) {
908 kfree_const(fw_work->name);
913 get_device(fw_work->device);
914 INIT_WORK(&fw_work->work, request_firmware_work_func);
915 schedule_work(&fw_work->work);
918 EXPORT_SYMBOL(request_firmware_nowait);
920 #ifdef CONFIG_PM_SLEEP
921 static ASYNC_DOMAIN_EXCLUSIVE(fw_cache_domain);
924 * cache_firmware() - cache one firmware image in kernel memory space
925 * @fw_name: the firmware image name
927 * Cache firmware in kernel memory so that drivers can use it when
928 * system isn't ready for them to request firmware image from userspace.
929 * Once it returns successfully, driver can use request_firmware or its
930 * nowait version to get the cached firmware without any interacting
933 * Return 0 if the firmware image has been cached successfully
934 * Return !0 otherwise
937 static int cache_firmware(const char *fw_name)
940 const struct firmware *fw;
942 pr_debug("%s: %s\n", __func__, fw_name);
944 ret = request_firmware(&fw, fw_name, NULL);
948 pr_debug("%s: %s ret=%d\n", __func__, fw_name, ret);
953 static struct fw_priv *lookup_fw_priv(const char *fw_name)
956 struct firmware_cache *fwc = &fw_cache;
958 spin_lock(&fwc->lock);
959 tmp = __lookup_fw_priv(fw_name);
960 spin_unlock(&fwc->lock);
966 * uncache_firmware() - remove one cached firmware image
967 * @fw_name: the firmware image name
969 * Uncache one firmware image which has been cached successfully
972 * Return 0 if the firmware cache has been removed successfully
973 * Return !0 otherwise
976 static int uncache_firmware(const char *fw_name)
978 struct fw_priv *fw_priv;
981 pr_debug("%s: %s\n", __func__, fw_name);
983 if (fw_get_builtin_firmware(&fw, fw_name, NULL, 0))
986 fw_priv = lookup_fw_priv(fw_name);
988 free_fw_priv(fw_priv);
995 static struct fw_cache_entry *alloc_fw_cache_entry(const char *name)
997 struct fw_cache_entry *fce;
999 fce = kzalloc(sizeof(*fce), GFP_ATOMIC);
1003 fce->name = kstrdup_const(name, GFP_ATOMIC);
1013 static int __fw_entry_found(const char *name)
1015 struct firmware_cache *fwc = &fw_cache;
1016 struct fw_cache_entry *fce;
1018 list_for_each_entry(fce, &fwc->fw_names, list) {
1019 if (!strcmp(fce->name, name))
1025 static int fw_cache_piggyback_on_request(const char *name)
1027 struct firmware_cache *fwc = &fw_cache;
1028 struct fw_cache_entry *fce;
1031 spin_lock(&fwc->name_lock);
1032 if (__fw_entry_found(name))
1035 fce = alloc_fw_cache_entry(name);
1038 list_add(&fce->list, &fwc->fw_names);
1039 pr_debug("%s: fw: %s\n", __func__, name);
1042 spin_unlock(&fwc->name_lock);
1046 static void free_fw_cache_entry(struct fw_cache_entry *fce)
1048 kfree_const(fce->name);
1052 static void __async_dev_cache_fw_image(void *fw_entry,
1053 async_cookie_t cookie)
1055 struct fw_cache_entry *fce = fw_entry;
1056 struct firmware_cache *fwc = &fw_cache;
1059 ret = cache_firmware(fce->name);
1061 spin_lock(&fwc->name_lock);
1062 list_del(&fce->list);
1063 spin_unlock(&fwc->name_lock);
1065 free_fw_cache_entry(fce);
1069 /* called with dev->devres_lock held */
1070 static void dev_create_fw_entry(struct device *dev, void *res,
1073 struct fw_name_devm *fwn = res;
1074 const char *fw_name = fwn->name;
1075 struct list_head *head = data;
1076 struct fw_cache_entry *fce;
1078 fce = alloc_fw_cache_entry(fw_name);
1080 list_add(&fce->list, head);
1083 static int devm_name_match(struct device *dev, void *res,
1086 struct fw_name_devm *fwn = res;
1087 return (fwn->magic == (unsigned long)match_data);
1090 static void dev_cache_fw_image(struct device *dev, void *data)
1093 struct fw_cache_entry *fce;
1094 struct fw_cache_entry *fce_next;
1095 struct firmware_cache *fwc = &fw_cache;
1097 devres_for_each_res(dev, fw_name_devm_release,
1098 devm_name_match, &fw_cache,
1099 dev_create_fw_entry, &todo);
1101 list_for_each_entry_safe(fce, fce_next, &todo, list) {
1102 list_del(&fce->list);
1104 spin_lock(&fwc->name_lock);
1105 /* only one cache entry for one firmware */
1106 if (!__fw_entry_found(fce->name)) {
1107 list_add(&fce->list, &fwc->fw_names);
1109 free_fw_cache_entry(fce);
1112 spin_unlock(&fwc->name_lock);
1115 async_schedule_domain(__async_dev_cache_fw_image,
1121 static void __device_uncache_fw_images(void)
1123 struct firmware_cache *fwc = &fw_cache;
1124 struct fw_cache_entry *fce;
1126 spin_lock(&fwc->name_lock);
1127 while (!list_empty(&fwc->fw_names)) {
1128 fce = list_entry(fwc->fw_names.next,
1129 struct fw_cache_entry, list);
1130 list_del(&fce->list);
1131 spin_unlock(&fwc->name_lock);
1133 uncache_firmware(fce->name);
1134 free_fw_cache_entry(fce);
1136 spin_lock(&fwc->name_lock);
1138 spin_unlock(&fwc->name_lock);
1142 * device_cache_fw_images() - cache devices' firmware
1144 * If one device called request_firmware or its nowait version
1145 * successfully before, the firmware names are recored into the
1146 * device's devres link list, so device_cache_fw_images can call
1147 * cache_firmware() to cache these firmwares for the device,
1148 * then the device driver can load its firmwares easily at
1149 * time when system is not ready to complete loading firmware.
1151 static void device_cache_fw_images(void)
1153 struct firmware_cache *fwc = &fw_cache;
1156 pr_debug("%s\n", __func__);
1158 /* cancel uncache work */
1159 cancel_delayed_work_sync(&fwc->work);
1161 fw_fallback_set_cache_timeout();
1163 mutex_lock(&fw_lock);
1164 fwc->state = FW_LOADER_START_CACHE;
1165 dpm_for_each_dev(NULL, dev_cache_fw_image);
1166 mutex_unlock(&fw_lock);
1168 /* wait for completion of caching firmware for all devices */
1169 async_synchronize_full_domain(&fw_cache_domain);
1171 fw_fallback_set_default_timeout();
1175 * device_uncache_fw_images() - uncache devices' firmware
1177 * uncache all firmwares which have been cached successfully
1178 * by device_uncache_fw_images earlier
1180 static void device_uncache_fw_images(void)
1182 pr_debug("%s\n", __func__);
1183 __device_uncache_fw_images();
1186 static void device_uncache_fw_images_work(struct work_struct *work)
1188 device_uncache_fw_images();
1192 * device_uncache_fw_images_delay() - uncache devices firmwares
1193 * @delay: number of milliseconds to delay uncache device firmwares
1195 * uncache all devices's firmwares which has been cached successfully
1196 * by device_cache_fw_images after @delay milliseconds.
1198 static void device_uncache_fw_images_delay(unsigned long delay)
1200 queue_delayed_work(system_power_efficient_wq, &fw_cache.work,
1201 msecs_to_jiffies(delay));
1204 static int fw_pm_notify(struct notifier_block *notify_block,
1205 unsigned long mode, void *unused)
1208 case PM_HIBERNATION_PREPARE:
1209 case PM_SUSPEND_PREPARE:
1210 case PM_RESTORE_PREPARE:
1212 * kill pending fallback requests with a custom fallback
1213 * to avoid stalling suspend.
1215 kill_pending_fw_fallback_reqs(true);
1216 device_cache_fw_images();
1219 case PM_POST_SUSPEND:
1220 case PM_POST_HIBERNATION:
1221 case PM_POST_RESTORE:
1223 * In case that system sleep failed and syscore_suspend is
1226 mutex_lock(&fw_lock);
1227 fw_cache.state = FW_LOADER_NO_CACHE;
1228 mutex_unlock(&fw_lock);
1230 device_uncache_fw_images_delay(10 * MSEC_PER_SEC);
1237 /* stop caching firmware once syscore_suspend is reached */
1238 static int fw_suspend(void)
1240 fw_cache.state = FW_LOADER_NO_CACHE;
1244 static struct syscore_ops fw_syscore_ops = {
1245 .suspend = fw_suspend,
1248 static int __init register_fw_pm_ops(void)
1252 spin_lock_init(&fw_cache.name_lock);
1253 INIT_LIST_HEAD(&fw_cache.fw_names);
1255 INIT_DELAYED_WORK(&fw_cache.work,
1256 device_uncache_fw_images_work);
1258 fw_cache.pm_notify.notifier_call = fw_pm_notify;
1259 ret = register_pm_notifier(&fw_cache.pm_notify);
1263 register_syscore_ops(&fw_syscore_ops);
1268 static inline void unregister_fw_pm_ops(void)
1270 unregister_syscore_ops(&fw_syscore_ops);
1271 unregister_pm_notifier(&fw_cache.pm_notify);
1274 static int fw_cache_piggyback_on_request(const char *name)
1278 static inline int register_fw_pm_ops(void)
1282 static inline void unregister_fw_pm_ops(void)
1287 static void __init fw_cache_init(void)
1289 spin_lock_init(&fw_cache.lock);
1290 INIT_LIST_HEAD(&fw_cache.head);
1291 fw_cache.state = FW_LOADER_NO_CACHE;
1294 static int fw_shutdown_notify(struct notifier_block *unused1,
1295 unsigned long unused2, void *unused3)
1298 * Kill all pending fallback requests to avoid both stalling shutdown,
1299 * and avoid a deadlock with the usermode_lock.
1301 kill_pending_fw_fallback_reqs(false);
1306 static struct notifier_block fw_shutdown_nb = {
1307 .notifier_call = fw_shutdown_notify,
1310 static int __init firmware_class_init(void)
1314 /* No need to unfold these on exit */
1317 ret = register_fw_pm_ops();
1321 ret = register_reboot_notifier(&fw_shutdown_nb);
1325 return register_sysfs_loader();
1328 unregister_fw_pm_ops();
1332 static void __exit firmware_class_exit(void)
1334 unregister_fw_pm_ops();
1335 unregister_reboot_notifier(&fw_shutdown_nb);
1336 unregister_sysfs_loader();
1339 fs_initcall(firmware_class_init);
1340 module_exit(firmware_class_exit);