2 * firmware_class.c - Multi purpose firmware loading support
4 * Copyright (c) 2003 Manuel Estrada Sainz
6 * Please see Documentation/firmware_class/ for more information.
10 #include <linux/capability.h>
11 #include <linux/device.h>
12 #include <linux/module.h>
13 #include <linux/init.h>
14 #include <linux/timer.h>
15 #include <linux/vmalloc.h>
16 #include <linux/interrupt.h>
17 #include <linux/bitops.h>
18 #include <linux/mutex.h>
19 #include <linux/workqueue.h>
20 #include <linux/highmem.h>
21 #include <linux/firmware.h>
22 #include <linux/slab.h>
23 #include <linux/sched.h>
24 #include <linux/file.h>
25 #include <linux/list.h>
26 #include <linux/async.h>
28 #include <linux/suspend.h>
29 #include <linux/syscore_ops.h>
30 #include <linux/reboot.h>
31 #include <linux/security.h>
33 #include <generated/utsrelease.h>
37 MODULE_AUTHOR("Manuel Estrada Sainz");
38 MODULE_DESCRIPTION("Multi purpose firmware loading support");
39 MODULE_LICENSE("GPL");
41 /* Builtin firmware support */
43 #ifdef CONFIG_FW_LOADER
45 extern struct builtin_fw __start_builtin_fw[];
46 extern struct builtin_fw __end_builtin_fw[];
48 static bool fw_get_builtin_firmware(struct firmware *fw, const char *name)
50 struct builtin_fw *b_fw;
52 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++) {
53 if (strcmp(name, b_fw->name) == 0) {
54 fw->size = b_fw->size;
55 fw->data = b_fw->data;
63 static bool fw_is_builtin_firmware(const struct firmware *fw)
65 struct builtin_fw *b_fw;
67 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++)
68 if (fw->data == b_fw->data)
74 #else /* Module case - no builtin firmware support */
76 static inline bool fw_get_builtin_firmware(struct firmware *fw, const char *name)
81 static inline bool fw_is_builtin_firmware(const struct firmware *fw)
93 static int loading_timeout = 60; /* In seconds */
95 static inline long firmware_loading_timeout(void)
97 return loading_timeout > 0 ? loading_timeout * HZ : MAX_JIFFY_OFFSET;
100 /* firmware behavior options */
101 #define FW_OPT_UEVENT (1U << 0)
102 #define FW_OPT_NOWAIT (1U << 1)
103 #ifdef CONFIG_FW_LOADER_USER_HELPER
104 #define FW_OPT_USERHELPER (1U << 2)
106 #define FW_OPT_USERHELPER 0
108 #ifdef CONFIG_FW_LOADER_USER_HELPER_FALLBACK
109 #define FW_OPT_FALLBACK FW_OPT_USERHELPER
111 #define FW_OPT_FALLBACK 0
113 #define FW_OPT_NO_WARN (1U << 3)
115 struct firmware_cache {
116 /* firmware_buf instance will be added into the below list */
118 struct list_head head;
121 #ifdef CONFIG_PM_SLEEP
123 * Names of firmware images which have been cached successfully
124 * will be added into the below list so that device uncache
125 * helper can trace which firmware images have been cached
128 spinlock_t name_lock;
129 struct list_head fw_names;
131 struct delayed_work work;
133 struct notifier_block pm_notify;
137 struct firmware_buf {
139 struct list_head list;
140 struct completion completion;
141 struct firmware_cache *fwc;
142 unsigned long status;
145 #ifdef CONFIG_FW_LOADER_USER_HELPER
151 struct list_head pending_list;
156 struct fw_cache_entry {
157 struct list_head list;
161 struct fw_name_devm {
166 #define to_fwbuf(d) container_of(d, struct firmware_buf, ref)
168 #define FW_LOADER_NO_CACHE 0
169 #define FW_LOADER_START_CACHE 1
171 static int fw_cache_piggyback_on_request(const char *name);
173 /* fw_lock could be moved to 'struct firmware_priv' but since it is just
174 * guarding for corner cases a global lock should be OK */
175 static DEFINE_MUTEX(fw_lock);
177 static struct firmware_cache fw_cache;
179 static struct firmware_buf *__allocate_fw_buf(const char *fw_name,
180 struct firmware_cache *fwc)
182 struct firmware_buf *buf;
184 buf = kzalloc(sizeof(*buf), GFP_ATOMIC);
188 buf->fw_id = kstrdup_const(fw_name, GFP_ATOMIC);
194 kref_init(&buf->ref);
196 init_completion(&buf->completion);
197 #ifdef CONFIG_FW_LOADER_USER_HELPER
198 INIT_LIST_HEAD(&buf->pending_list);
201 pr_debug("%s: fw-%s buf=%p\n", __func__, fw_name, buf);
206 static struct firmware_buf *__fw_lookup_buf(const char *fw_name)
208 struct firmware_buf *tmp;
209 struct firmware_cache *fwc = &fw_cache;
211 list_for_each_entry(tmp, &fwc->head, list)
212 if (!strcmp(tmp->fw_id, fw_name))
217 static int fw_lookup_and_allocate_buf(const char *fw_name,
218 struct firmware_cache *fwc,
219 struct firmware_buf **buf)
221 struct firmware_buf *tmp;
223 spin_lock(&fwc->lock);
224 tmp = __fw_lookup_buf(fw_name);
227 spin_unlock(&fwc->lock);
231 tmp = __allocate_fw_buf(fw_name, fwc);
233 list_add(&tmp->list, &fwc->head);
234 spin_unlock(&fwc->lock);
238 return tmp ? 0 : -ENOMEM;
241 static void __fw_free_buf(struct kref *ref)
242 __releases(&fwc->lock)
244 struct firmware_buf *buf = to_fwbuf(ref);
245 struct firmware_cache *fwc = buf->fwc;
247 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
248 __func__, buf->fw_id, buf, buf->data,
249 (unsigned int)buf->size);
251 list_del(&buf->list);
252 spin_unlock(&fwc->lock);
254 #ifdef CONFIG_FW_LOADER_USER_HELPER
255 if (buf->is_paged_buf) {
258 for (i = 0; i < buf->nr_pages; i++)
259 __free_page(buf->pages[i]);
264 kfree_const(buf->fw_id);
268 static void fw_free_buf(struct firmware_buf *buf)
270 struct firmware_cache *fwc = buf->fwc;
271 spin_lock(&fwc->lock);
272 if (!kref_put(&buf->ref, __fw_free_buf))
273 spin_unlock(&fwc->lock);
276 /* direct firmware loading support */
277 static char fw_path_para[256];
278 static const char * const fw_path[] = {
280 "/lib/firmware/updates/" UTS_RELEASE,
281 "/lib/firmware/updates",
282 "/lib/firmware/" UTS_RELEASE,
287 * Typical usage is that passing 'firmware_class.path=$CUSTOMIZED_PATH'
288 * from kernel command line because firmware_class is generally built in
289 * kernel instead of module.
291 module_param_string(path, fw_path_para, sizeof(fw_path_para), 0644);
292 MODULE_PARM_DESC(path, "customized firmware image search path with a higher priority than default path");
294 static int fw_read_file_contents(struct file *file, struct firmware_buf *fw_buf)
300 if (!S_ISREG(file_inode(file)->i_mode))
302 size = i_size_read(file_inode(file));
308 rc = kernel_read(file, 0, buf, size);
314 rc = security_kernel_fw_from_file(file, buf, size);
325 static int fw_get_filesystem_firmware(struct device *device,
326 struct firmware_buf *buf)
336 for (i = 0; i < ARRAY_SIZE(fw_path); i++) {
339 /* skip the unset customized path */
343 len = snprintf(path, PATH_MAX, "%s/%s",
344 fw_path[i], buf->fw_id);
345 if (len >= PATH_MAX) {
350 file = filp_open(path, O_RDONLY, 0);
353 rc = fw_read_file_contents(file, buf);
356 dev_warn(device, "firmware, attempted to load %s, but failed with error %d\n",
364 dev_dbg(device, "firmware: direct-loading firmware %s\n",
366 mutex_lock(&fw_lock);
367 set_bit(FW_STATUS_DONE, &buf->status);
368 complete_all(&buf->completion);
369 mutex_unlock(&fw_lock);
375 /* firmware holds the ownership of pages */
376 static void firmware_free_data(const struct firmware *fw)
378 /* Loaded directly? */
383 fw_free_buf(fw->priv);
386 /* store the pages buffer info firmware from buf */
387 static void fw_set_page_data(struct firmware_buf *buf, struct firmware *fw)
390 #ifdef CONFIG_FW_LOADER_USER_HELPER
391 fw->pages = buf->pages;
393 fw->size = buf->size;
394 fw->data = buf->data;
396 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
397 __func__, buf->fw_id, buf, buf->data,
398 (unsigned int)buf->size);
401 #ifdef CONFIG_PM_SLEEP
402 static void fw_name_devm_release(struct device *dev, void *res)
404 struct fw_name_devm *fwn = res;
406 if (fwn->magic == (unsigned long)&fw_cache)
407 pr_debug("%s: fw_name-%s devm-%p released\n",
408 __func__, fwn->name, res);
409 kfree_const(fwn->name);
412 static int fw_devm_match(struct device *dev, void *res,
415 struct fw_name_devm *fwn = res;
417 return (fwn->magic == (unsigned long)&fw_cache) &&
418 !strcmp(fwn->name, match_data);
421 static struct fw_name_devm *fw_find_devm_name(struct device *dev,
424 struct fw_name_devm *fwn;
426 fwn = devres_find(dev, fw_name_devm_release,
427 fw_devm_match, (void *)name);
431 /* add firmware name into devres list */
432 static int fw_add_devm_name(struct device *dev, const char *name)
434 struct fw_name_devm *fwn;
436 fwn = fw_find_devm_name(dev, name);
440 fwn = devres_alloc(fw_name_devm_release, sizeof(struct fw_name_devm),
444 fwn->name = kstrdup_const(name, GFP_KERNEL);
450 fwn->magic = (unsigned long)&fw_cache;
451 devres_add(dev, fwn);
456 static int fw_add_devm_name(struct device *dev, const char *name)
464 * user-mode helper code
466 #ifdef CONFIG_FW_LOADER_USER_HELPER
467 struct firmware_priv {
470 struct firmware_buf *buf;
474 static struct firmware_priv *to_firmware_priv(struct device *dev)
476 return container_of(dev, struct firmware_priv, dev);
479 static void __fw_load_abort(struct firmware_buf *buf)
482 * There is a small window in which user can write to 'loading'
483 * between loading done and disappearance of 'loading'
485 if (test_bit(FW_STATUS_DONE, &buf->status))
488 list_del_init(&buf->pending_list);
489 set_bit(FW_STATUS_ABORT, &buf->status);
490 complete_all(&buf->completion);
493 static void fw_load_abort(struct firmware_priv *fw_priv)
495 struct firmware_buf *buf = fw_priv->buf;
497 __fw_load_abort(buf);
499 /* avoid user action after loading abort */
503 #define is_fw_load_aborted(buf) \
504 test_bit(FW_STATUS_ABORT, &(buf)->status)
506 static LIST_HEAD(pending_fw_head);
508 /* reboot notifier for avoid deadlock with usermode_lock */
509 static int fw_shutdown_notify(struct notifier_block *unused1,
510 unsigned long unused2, void *unused3)
512 mutex_lock(&fw_lock);
513 while (!list_empty(&pending_fw_head))
514 __fw_load_abort(list_first_entry(&pending_fw_head,
517 mutex_unlock(&fw_lock);
521 static struct notifier_block fw_shutdown_nb = {
522 .notifier_call = fw_shutdown_notify,
525 static ssize_t timeout_show(struct class *class, struct class_attribute *attr,
528 return sprintf(buf, "%d\n", loading_timeout);
532 * firmware_timeout_store - set number of seconds to wait for firmware
533 * @class: device class pointer
534 * @attr: device attribute pointer
535 * @buf: buffer to scan for timeout value
536 * @count: number of bytes in @buf
538 * Sets the number of seconds to wait for the firmware. Once
539 * this expires an error will be returned to the driver and no
540 * firmware will be provided.
542 * Note: zero means 'wait forever'.
544 static ssize_t timeout_store(struct class *class, struct class_attribute *attr,
545 const char *buf, size_t count)
547 loading_timeout = simple_strtol(buf, NULL, 10);
548 if (loading_timeout < 0)
554 static struct class_attribute firmware_class_attrs[] = {
559 static void fw_dev_release(struct device *dev)
561 struct firmware_priv *fw_priv = to_firmware_priv(dev);
566 static int firmware_uevent(struct device *dev, struct kobj_uevent_env *env)
568 struct firmware_priv *fw_priv = to_firmware_priv(dev);
570 if (add_uevent_var(env, "FIRMWARE=%s", fw_priv->buf->fw_id))
572 if (add_uevent_var(env, "TIMEOUT=%i", loading_timeout))
574 if (add_uevent_var(env, "ASYNC=%d", fw_priv->nowait))
580 static struct class firmware_class = {
582 .class_attrs = firmware_class_attrs,
583 .dev_uevent = firmware_uevent,
584 .dev_release = fw_dev_release,
587 static ssize_t firmware_loading_show(struct device *dev,
588 struct device_attribute *attr, char *buf)
590 struct firmware_priv *fw_priv = to_firmware_priv(dev);
593 mutex_lock(&fw_lock);
595 loading = test_bit(FW_STATUS_LOADING, &fw_priv->buf->status);
596 mutex_unlock(&fw_lock);
598 return sprintf(buf, "%d\n", loading);
601 /* Some architectures don't have PAGE_KERNEL_RO */
602 #ifndef PAGE_KERNEL_RO
603 #define PAGE_KERNEL_RO PAGE_KERNEL
606 /* one pages buffer should be mapped/unmapped only once */
607 static int fw_map_pages_buf(struct firmware_buf *buf)
609 if (!buf->is_paged_buf)
613 buf->data = vmap(buf->pages, buf->nr_pages, 0, PAGE_KERNEL_RO);
620 * firmware_loading_store - set value in the 'loading' control file
621 * @dev: device pointer
622 * @attr: device attribute pointer
623 * @buf: buffer to scan for loading control value
624 * @count: number of bytes in @buf
626 * The relevant values are:
628 * 1: Start a load, discarding any previous partial load.
629 * 0: Conclude the load and hand the data to the driver code.
630 * -1: Conclude the load with an error and discard any written data.
632 static ssize_t firmware_loading_store(struct device *dev,
633 struct device_attribute *attr,
634 const char *buf, size_t count)
636 struct firmware_priv *fw_priv = to_firmware_priv(dev);
637 struct firmware_buf *fw_buf;
638 ssize_t written = count;
639 int loading = simple_strtol(buf, NULL, 10);
642 mutex_lock(&fw_lock);
643 fw_buf = fw_priv->buf;
649 /* discarding any previous partial load */
650 if (!test_bit(FW_STATUS_DONE, &fw_buf->status)) {
651 for (i = 0; i < fw_buf->nr_pages; i++)
652 __free_page(fw_buf->pages[i]);
653 kfree(fw_buf->pages);
654 fw_buf->pages = NULL;
655 fw_buf->page_array_size = 0;
656 fw_buf->nr_pages = 0;
657 set_bit(FW_STATUS_LOADING, &fw_buf->status);
661 if (test_bit(FW_STATUS_LOADING, &fw_buf->status)) {
664 set_bit(FW_STATUS_DONE, &fw_buf->status);
665 clear_bit(FW_STATUS_LOADING, &fw_buf->status);
668 * Several loading requests may be pending on
669 * one same firmware buf, so let all requests
670 * see the mapped 'buf->data' once the loading
673 rc = fw_map_pages_buf(fw_buf);
675 dev_err(dev, "%s: map pages failed\n",
678 rc = security_kernel_fw_from_file(NULL,
679 fw_buf->data, fw_buf->size);
682 * Same logic as fw_load_abort, only the DONE bit
683 * is ignored and we set ABORT only on failure.
685 list_del_init(&fw_buf->pending_list);
687 set_bit(FW_STATUS_ABORT, &fw_buf->status);
690 complete_all(&fw_buf->completion);
695 dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading);
698 fw_load_abort(fw_priv);
702 mutex_unlock(&fw_lock);
706 static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store);
708 static ssize_t firmware_data_read(struct file *filp, struct kobject *kobj,
709 struct bin_attribute *bin_attr,
710 char *buffer, loff_t offset, size_t count)
712 struct device *dev = kobj_to_dev(kobj);
713 struct firmware_priv *fw_priv = to_firmware_priv(dev);
714 struct firmware_buf *buf;
717 mutex_lock(&fw_lock);
719 if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) {
723 if (offset > buf->size) {
727 if (count > buf->size - offset)
728 count = buf->size - offset;
734 int page_nr = offset >> PAGE_SHIFT;
735 int page_ofs = offset & (PAGE_SIZE-1);
736 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
738 page_data = kmap(buf->pages[page_nr]);
740 memcpy(buffer, page_data + page_ofs, page_cnt);
742 kunmap(buf->pages[page_nr]);
748 mutex_unlock(&fw_lock);
752 static int fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
754 struct firmware_buf *buf = fw_priv->buf;
755 int pages_needed = PAGE_ALIGN(min_size) >> PAGE_SHIFT;
757 /* If the array of pages is too small, grow it... */
758 if (buf->page_array_size < pages_needed) {
759 int new_array_size = max(pages_needed,
760 buf->page_array_size * 2);
761 struct page **new_pages;
763 new_pages = kmalloc(new_array_size * sizeof(void *),
766 fw_load_abort(fw_priv);
769 memcpy(new_pages, buf->pages,
770 buf->page_array_size * sizeof(void *));
771 memset(&new_pages[buf->page_array_size], 0, sizeof(void *) *
772 (new_array_size - buf->page_array_size));
774 buf->pages = new_pages;
775 buf->page_array_size = new_array_size;
778 while (buf->nr_pages < pages_needed) {
779 buf->pages[buf->nr_pages] =
780 alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
782 if (!buf->pages[buf->nr_pages]) {
783 fw_load_abort(fw_priv);
792 * firmware_data_write - write method for firmware
793 * @filp: open sysfs file
794 * @kobj: kobject for the device
795 * @bin_attr: bin_attr structure
796 * @buffer: buffer being written
797 * @offset: buffer offset for write in total data store area
798 * @count: buffer size
800 * Data written to the 'data' attribute will be later handed to
801 * the driver as a firmware image.
803 static ssize_t firmware_data_write(struct file *filp, struct kobject *kobj,
804 struct bin_attribute *bin_attr,
805 char *buffer, loff_t offset, size_t count)
807 struct device *dev = kobj_to_dev(kobj);
808 struct firmware_priv *fw_priv = to_firmware_priv(dev);
809 struct firmware_buf *buf;
812 if (!capable(CAP_SYS_RAWIO))
815 mutex_lock(&fw_lock);
817 if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) {
822 retval = fw_realloc_buffer(fw_priv, offset + count);
830 int page_nr = offset >> PAGE_SHIFT;
831 int page_ofs = offset & (PAGE_SIZE - 1);
832 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
834 page_data = kmap(buf->pages[page_nr]);
836 memcpy(page_data + page_ofs, buffer, page_cnt);
838 kunmap(buf->pages[page_nr]);
844 buf->size = max_t(size_t, offset, buf->size);
846 mutex_unlock(&fw_lock);
850 static struct bin_attribute firmware_attr_data = {
851 .attr = { .name = "data", .mode = 0644 },
853 .read = firmware_data_read,
854 .write = firmware_data_write,
857 static struct attribute *fw_dev_attrs[] = {
858 &dev_attr_loading.attr,
862 static struct bin_attribute *fw_dev_bin_attrs[] = {
867 static const struct attribute_group fw_dev_attr_group = {
868 .attrs = fw_dev_attrs,
869 .bin_attrs = fw_dev_bin_attrs,
872 static const struct attribute_group *fw_dev_attr_groups[] = {
877 static struct firmware_priv *
878 fw_create_instance(struct firmware *firmware, const char *fw_name,
879 struct device *device, unsigned int opt_flags)
881 struct firmware_priv *fw_priv;
882 struct device *f_dev;
884 fw_priv = kzalloc(sizeof(*fw_priv), GFP_KERNEL);
886 fw_priv = ERR_PTR(-ENOMEM);
890 fw_priv->nowait = !!(opt_flags & FW_OPT_NOWAIT);
891 fw_priv->fw = firmware;
892 f_dev = &fw_priv->dev;
894 device_initialize(f_dev);
895 dev_set_name(f_dev, "%s", fw_name);
896 f_dev->parent = device;
897 f_dev->class = &firmware_class;
898 f_dev->groups = fw_dev_attr_groups;
903 /* load a firmware via user helper */
904 static int _request_firmware_load(struct firmware_priv *fw_priv,
905 unsigned int opt_flags, long timeout)
908 struct device *f_dev = &fw_priv->dev;
909 struct firmware_buf *buf = fw_priv->buf;
911 /* fall back on userspace loading */
912 buf->is_paged_buf = true;
914 dev_set_uevent_suppress(f_dev, true);
916 retval = device_add(f_dev);
918 dev_err(f_dev, "%s: device_register failed\n", __func__);
922 mutex_lock(&fw_lock);
923 list_add(&buf->pending_list, &pending_fw_head);
924 mutex_unlock(&fw_lock);
926 if (opt_flags & FW_OPT_UEVENT) {
927 buf->need_uevent = true;
928 dev_set_uevent_suppress(f_dev, false);
929 dev_dbg(f_dev, "firmware: requesting %s\n", buf->fw_id);
930 kobject_uevent(&fw_priv->dev.kobj, KOBJ_ADD);
932 timeout = MAX_JIFFY_OFFSET;
935 retval = wait_for_completion_interruptible_timeout(&buf->completion,
937 if (retval == -ERESTARTSYS || !retval) {
938 mutex_lock(&fw_lock);
939 fw_load_abort(fw_priv);
940 mutex_unlock(&fw_lock);
941 } else if (retval > 0) {
945 if (is_fw_load_aborted(buf))
956 static int fw_load_from_user_helper(struct firmware *firmware,
957 const char *name, struct device *device,
958 unsigned int opt_flags, long timeout)
960 struct firmware_priv *fw_priv;
962 fw_priv = fw_create_instance(firmware, name, device, opt_flags);
964 return PTR_ERR(fw_priv);
966 fw_priv->buf = firmware->priv;
967 return _request_firmware_load(fw_priv, opt_flags, timeout);
970 #ifdef CONFIG_PM_SLEEP
971 /* kill pending requests without uevent to avoid blocking suspend */
972 static void kill_requests_without_uevent(void)
974 struct firmware_buf *buf;
975 struct firmware_buf *next;
977 mutex_lock(&fw_lock);
978 list_for_each_entry_safe(buf, next, &pending_fw_head, pending_list) {
979 if (!buf->need_uevent)
980 __fw_load_abort(buf);
982 mutex_unlock(&fw_lock);
986 #else /* CONFIG_FW_LOADER_USER_HELPER */
988 fw_load_from_user_helper(struct firmware *firmware, const char *name,
989 struct device *device, unsigned int opt_flags,
995 /* No abort during direct loading */
996 #define is_fw_load_aborted(buf) false
998 #ifdef CONFIG_PM_SLEEP
999 static inline void kill_requests_without_uevent(void) { }
1002 #endif /* CONFIG_FW_LOADER_USER_HELPER */
1005 /* wait until the shared firmware_buf becomes ready (or error) */
1006 static int sync_cached_firmware_buf(struct firmware_buf *buf)
1010 mutex_lock(&fw_lock);
1011 while (!test_bit(FW_STATUS_DONE, &buf->status)) {
1012 if (is_fw_load_aborted(buf)) {
1016 mutex_unlock(&fw_lock);
1017 ret = wait_for_completion_interruptible(&buf->completion);
1018 mutex_lock(&fw_lock);
1020 mutex_unlock(&fw_lock);
1024 /* prepare firmware and firmware_buf structs;
1025 * return 0 if a firmware is already assigned, 1 if need to load one,
1026 * or a negative error code
1029 _request_firmware_prepare(struct firmware **firmware_p, const char *name,
1030 struct device *device)
1032 struct firmware *firmware;
1033 struct firmware_buf *buf;
1036 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
1038 dev_err(device, "%s: kmalloc(struct firmware) failed\n",
1043 if (fw_get_builtin_firmware(firmware, name)) {
1044 dev_dbg(device, "firmware: using built-in firmware %s\n", name);
1045 return 0; /* assigned */
1048 ret = fw_lookup_and_allocate_buf(name, &fw_cache, &buf);
1051 * bind with 'buf' now to avoid warning in failure path
1052 * of requesting firmware.
1054 firmware->priv = buf;
1057 ret = sync_cached_firmware_buf(buf);
1059 fw_set_page_data(buf, firmware);
1060 return 0; /* assigned */
1066 return 1; /* need to load */
1069 static int assign_firmware_buf(struct firmware *fw, struct device *device,
1070 unsigned int opt_flags)
1072 struct firmware_buf *buf = fw->priv;
1074 mutex_lock(&fw_lock);
1075 if (!buf->size || is_fw_load_aborted(buf)) {
1076 mutex_unlock(&fw_lock);
1081 * add firmware name into devres list so that we can auto cache
1082 * and uncache firmware for device.
1084 * device may has been deleted already, but the problem
1085 * should be fixed in devres or driver core.
1087 /* don't cache firmware handled without uevent */
1088 if (device && (opt_flags & FW_OPT_UEVENT))
1089 fw_add_devm_name(device, buf->fw_id);
1092 * After caching firmware image is started, let it piggyback
1093 * on request firmware.
1095 if (buf->fwc->state == FW_LOADER_START_CACHE) {
1096 if (fw_cache_piggyback_on_request(buf->fw_id))
1097 kref_get(&buf->ref);
1100 /* pass the pages buffer to driver at the last minute */
1101 fw_set_page_data(buf, fw);
1102 mutex_unlock(&fw_lock);
1106 /* called from request_firmware() and request_firmware_work_func() */
1108 _request_firmware(const struct firmware **firmware_p, const char *name,
1109 struct device *device, unsigned int opt_flags)
1111 struct firmware *fw;
1118 if (!name || name[0] == '\0')
1121 ret = _request_firmware_prepare(&fw, name, device);
1122 if (ret <= 0) /* error or already assigned */
1126 timeout = firmware_loading_timeout();
1127 if (opt_flags & FW_OPT_NOWAIT) {
1128 timeout = usermodehelper_read_lock_wait(timeout);
1130 dev_dbg(device, "firmware: %s loading timed out\n",
1136 ret = usermodehelper_read_trylock();
1138 dev_err(device, "firmware: %s will not be loaded\n",
1144 ret = fw_get_filesystem_firmware(device, fw->priv);
1146 if (!(opt_flags & FW_OPT_NO_WARN))
1148 "Direct firmware load for %s failed with error %d\n",
1150 if (opt_flags & FW_OPT_USERHELPER) {
1151 dev_warn(device, "Falling back to user helper\n");
1152 ret = fw_load_from_user_helper(fw, name, device,
1153 opt_flags, timeout);
1158 ret = assign_firmware_buf(fw, device, opt_flags);
1160 usermodehelper_read_unlock();
1164 release_firmware(fw);
1173 * request_firmware: - send firmware request and wait for it
1174 * @firmware_p: pointer to firmware image
1175 * @name: name of firmware file
1176 * @device: device for which firmware is being loaded
1178 * @firmware_p will be used to return a firmware image by the name
1179 * of @name for device @device.
1181 * Should be called from user context where sleeping is allowed.
1183 * @name will be used as $FIRMWARE in the uevent environment and
1184 * should be distinctive enough not to be confused with any other
1185 * firmware image for this or any other device.
1187 * Caller must hold the reference count of @device.
1189 * The function can be called safely inside device's suspend and
1193 request_firmware(const struct firmware **firmware_p, const char *name,
1194 struct device *device)
1198 /* Need to pin this module until return */
1199 __module_get(THIS_MODULE);
1200 ret = _request_firmware(firmware_p, name, device,
1201 FW_OPT_UEVENT | FW_OPT_FALLBACK);
1202 module_put(THIS_MODULE);
1205 EXPORT_SYMBOL(request_firmware);
1208 * request_firmware_direct: - load firmware directly without usermode helper
1209 * @firmware_p: pointer to firmware image
1210 * @name: name of firmware file
1211 * @device: device for which firmware is being loaded
1213 * This function works pretty much like request_firmware(), but this doesn't
1214 * fall back to usermode helper even if the firmware couldn't be loaded
1215 * directly from fs. Hence it's useful for loading optional firmwares, which
1216 * aren't always present, without extra long timeouts of udev.
1218 int request_firmware_direct(const struct firmware **firmware_p,
1219 const char *name, struct device *device)
1223 __module_get(THIS_MODULE);
1224 ret = _request_firmware(firmware_p, name, device,
1225 FW_OPT_UEVENT | FW_OPT_NO_WARN);
1226 module_put(THIS_MODULE);
1229 EXPORT_SYMBOL_GPL(request_firmware_direct);
1232 * release_firmware: - release the resource associated with a firmware image
1233 * @fw: firmware resource to release
1235 void release_firmware(const struct firmware *fw)
1238 if (!fw_is_builtin_firmware(fw))
1239 firmware_free_data(fw);
1243 EXPORT_SYMBOL(release_firmware);
1246 struct firmware_work {
1247 struct work_struct work;
1248 struct module *module;
1250 struct device *device;
1252 void (*cont)(const struct firmware *fw, void *context);
1253 unsigned int opt_flags;
1256 static void request_firmware_work_func(struct work_struct *work)
1258 struct firmware_work *fw_work;
1259 const struct firmware *fw;
1261 fw_work = container_of(work, struct firmware_work, work);
1263 _request_firmware(&fw, fw_work->name, fw_work->device,
1264 fw_work->opt_flags);
1265 fw_work->cont(fw, fw_work->context);
1266 put_device(fw_work->device); /* taken in request_firmware_nowait() */
1268 module_put(fw_work->module);
1269 kfree_const(fw_work->name);
1274 * request_firmware_nowait - asynchronous version of request_firmware
1275 * @module: module requesting the firmware
1276 * @uevent: sends uevent to copy the firmware image if this flag
1277 * is non-zero else the firmware copy must be done manually.
1278 * @name: name of firmware file
1279 * @device: device for which firmware is being loaded
1280 * @gfp: allocation flags
1281 * @context: will be passed over to @cont, and
1282 * @fw may be %NULL if firmware request fails.
1283 * @cont: function will be called asynchronously when the firmware
1286 * Caller must hold the reference count of @device.
1288 * Asynchronous variant of request_firmware() for user contexts:
1289 * - sleep for as small periods as possible since it may
1290 * increase kernel boot time of built-in device drivers
1291 * requesting firmware in their ->probe() methods, if
1292 * @gfp is GFP_KERNEL.
1294 * - can't sleep at all if @gfp is GFP_ATOMIC.
1297 request_firmware_nowait(
1298 struct module *module, bool uevent,
1299 const char *name, struct device *device, gfp_t gfp, void *context,
1300 void (*cont)(const struct firmware *fw, void *context))
1302 struct firmware_work *fw_work;
1304 fw_work = kzalloc(sizeof(struct firmware_work), gfp);
1308 fw_work->module = module;
1309 fw_work->name = kstrdup_const(name, gfp);
1310 if (!fw_work->name) {
1314 fw_work->device = device;
1315 fw_work->context = context;
1316 fw_work->cont = cont;
1317 fw_work->opt_flags = FW_OPT_NOWAIT | FW_OPT_FALLBACK |
1318 (uevent ? FW_OPT_UEVENT : FW_OPT_USERHELPER);
1320 if (!try_module_get(module)) {
1321 kfree_const(fw_work->name);
1326 get_device(fw_work->device);
1327 INIT_WORK(&fw_work->work, request_firmware_work_func);
1328 schedule_work(&fw_work->work);
1331 EXPORT_SYMBOL(request_firmware_nowait);
1333 #ifdef CONFIG_PM_SLEEP
1334 static ASYNC_DOMAIN_EXCLUSIVE(fw_cache_domain);
1337 * cache_firmware - cache one firmware image in kernel memory space
1338 * @fw_name: the firmware image name
1340 * Cache firmware in kernel memory so that drivers can use it when
1341 * system isn't ready for them to request firmware image from userspace.
1342 * Once it returns successfully, driver can use request_firmware or its
1343 * nowait version to get the cached firmware without any interacting
1346 * Return 0 if the firmware image has been cached successfully
1347 * Return !0 otherwise
1350 static int cache_firmware(const char *fw_name)
1353 const struct firmware *fw;
1355 pr_debug("%s: %s\n", __func__, fw_name);
1357 ret = request_firmware(&fw, fw_name, NULL);
1361 pr_debug("%s: %s ret=%d\n", __func__, fw_name, ret);
1366 static struct firmware_buf *fw_lookup_buf(const char *fw_name)
1368 struct firmware_buf *tmp;
1369 struct firmware_cache *fwc = &fw_cache;
1371 spin_lock(&fwc->lock);
1372 tmp = __fw_lookup_buf(fw_name);
1373 spin_unlock(&fwc->lock);
1379 * uncache_firmware - remove one cached firmware image
1380 * @fw_name: the firmware image name
1382 * Uncache one firmware image which has been cached successfully
1385 * Return 0 if the firmware cache has been removed successfully
1386 * Return !0 otherwise
1389 static int uncache_firmware(const char *fw_name)
1391 struct firmware_buf *buf;
1394 pr_debug("%s: %s\n", __func__, fw_name);
1396 if (fw_get_builtin_firmware(&fw, fw_name))
1399 buf = fw_lookup_buf(fw_name);
1408 static struct fw_cache_entry *alloc_fw_cache_entry(const char *name)
1410 struct fw_cache_entry *fce;
1412 fce = kzalloc(sizeof(*fce), GFP_ATOMIC);
1416 fce->name = kstrdup_const(name, GFP_ATOMIC);
1426 static int __fw_entry_found(const char *name)
1428 struct firmware_cache *fwc = &fw_cache;
1429 struct fw_cache_entry *fce;
1431 list_for_each_entry(fce, &fwc->fw_names, list) {
1432 if (!strcmp(fce->name, name))
1438 static int fw_cache_piggyback_on_request(const char *name)
1440 struct firmware_cache *fwc = &fw_cache;
1441 struct fw_cache_entry *fce;
1444 spin_lock(&fwc->name_lock);
1445 if (__fw_entry_found(name))
1448 fce = alloc_fw_cache_entry(name);
1451 list_add(&fce->list, &fwc->fw_names);
1452 pr_debug("%s: fw: %s\n", __func__, name);
1455 spin_unlock(&fwc->name_lock);
1459 static void free_fw_cache_entry(struct fw_cache_entry *fce)
1461 kfree_const(fce->name);
1465 static void __async_dev_cache_fw_image(void *fw_entry,
1466 async_cookie_t cookie)
1468 struct fw_cache_entry *fce = fw_entry;
1469 struct firmware_cache *fwc = &fw_cache;
1472 ret = cache_firmware(fce->name);
1474 spin_lock(&fwc->name_lock);
1475 list_del(&fce->list);
1476 spin_unlock(&fwc->name_lock);
1478 free_fw_cache_entry(fce);
1482 /* called with dev->devres_lock held */
1483 static void dev_create_fw_entry(struct device *dev, void *res,
1486 struct fw_name_devm *fwn = res;
1487 const char *fw_name = fwn->name;
1488 struct list_head *head = data;
1489 struct fw_cache_entry *fce;
1491 fce = alloc_fw_cache_entry(fw_name);
1493 list_add(&fce->list, head);
1496 static int devm_name_match(struct device *dev, void *res,
1499 struct fw_name_devm *fwn = res;
1500 return (fwn->magic == (unsigned long)match_data);
1503 static void dev_cache_fw_image(struct device *dev, void *data)
1506 struct fw_cache_entry *fce;
1507 struct fw_cache_entry *fce_next;
1508 struct firmware_cache *fwc = &fw_cache;
1510 devres_for_each_res(dev, fw_name_devm_release,
1511 devm_name_match, &fw_cache,
1512 dev_create_fw_entry, &todo);
1514 list_for_each_entry_safe(fce, fce_next, &todo, list) {
1515 list_del(&fce->list);
1517 spin_lock(&fwc->name_lock);
1518 /* only one cache entry for one firmware */
1519 if (!__fw_entry_found(fce->name)) {
1520 list_add(&fce->list, &fwc->fw_names);
1522 free_fw_cache_entry(fce);
1525 spin_unlock(&fwc->name_lock);
1528 async_schedule_domain(__async_dev_cache_fw_image,
1534 static void __device_uncache_fw_images(void)
1536 struct firmware_cache *fwc = &fw_cache;
1537 struct fw_cache_entry *fce;
1539 spin_lock(&fwc->name_lock);
1540 while (!list_empty(&fwc->fw_names)) {
1541 fce = list_entry(fwc->fw_names.next,
1542 struct fw_cache_entry, list);
1543 list_del(&fce->list);
1544 spin_unlock(&fwc->name_lock);
1546 uncache_firmware(fce->name);
1547 free_fw_cache_entry(fce);
1549 spin_lock(&fwc->name_lock);
1551 spin_unlock(&fwc->name_lock);
1555 * device_cache_fw_images - cache devices' firmware
1557 * If one device called request_firmware or its nowait version
1558 * successfully before, the firmware names are recored into the
1559 * device's devres link list, so device_cache_fw_images can call
1560 * cache_firmware() to cache these firmwares for the device,
1561 * then the device driver can load its firmwares easily at
1562 * time when system is not ready to complete loading firmware.
1564 static void device_cache_fw_images(void)
1566 struct firmware_cache *fwc = &fw_cache;
1570 pr_debug("%s\n", __func__);
1572 /* cancel uncache work */
1573 cancel_delayed_work_sync(&fwc->work);
1576 * use small loading timeout for caching devices' firmware
1577 * because all these firmware images have been loaded
1578 * successfully at lease once, also system is ready for
1579 * completing firmware loading now. The maximum size of
1580 * firmware in current distributions is about 2M bytes,
1581 * so 10 secs should be enough.
1583 old_timeout = loading_timeout;
1584 loading_timeout = 10;
1586 mutex_lock(&fw_lock);
1587 fwc->state = FW_LOADER_START_CACHE;
1588 dpm_for_each_dev(NULL, dev_cache_fw_image);
1589 mutex_unlock(&fw_lock);
1591 /* wait for completion of caching firmware for all devices */
1592 async_synchronize_full_domain(&fw_cache_domain);
1594 loading_timeout = old_timeout;
1598 * device_uncache_fw_images - uncache devices' firmware
1600 * uncache all firmwares which have been cached successfully
1601 * by device_uncache_fw_images earlier
1603 static void device_uncache_fw_images(void)
1605 pr_debug("%s\n", __func__);
1606 __device_uncache_fw_images();
1609 static void device_uncache_fw_images_work(struct work_struct *work)
1611 device_uncache_fw_images();
1615 * device_uncache_fw_images_delay - uncache devices firmwares
1616 * @delay: number of milliseconds to delay uncache device firmwares
1618 * uncache all devices's firmwares which has been cached successfully
1619 * by device_cache_fw_images after @delay milliseconds.
1621 static void device_uncache_fw_images_delay(unsigned long delay)
1623 queue_delayed_work(system_power_efficient_wq, &fw_cache.work,
1624 msecs_to_jiffies(delay));
1627 static int fw_pm_notify(struct notifier_block *notify_block,
1628 unsigned long mode, void *unused)
1631 case PM_HIBERNATION_PREPARE:
1632 case PM_SUSPEND_PREPARE:
1633 case PM_RESTORE_PREPARE:
1634 kill_requests_without_uevent();
1635 device_cache_fw_images();
1638 case PM_POST_SUSPEND:
1639 case PM_POST_HIBERNATION:
1640 case PM_POST_RESTORE:
1642 * In case that system sleep failed and syscore_suspend is
1645 mutex_lock(&fw_lock);
1646 fw_cache.state = FW_LOADER_NO_CACHE;
1647 mutex_unlock(&fw_lock);
1649 device_uncache_fw_images_delay(10 * MSEC_PER_SEC);
1656 /* stop caching firmware once syscore_suspend is reached */
1657 static int fw_suspend(void)
1659 fw_cache.state = FW_LOADER_NO_CACHE;
1663 static struct syscore_ops fw_syscore_ops = {
1664 .suspend = fw_suspend,
1667 static int fw_cache_piggyback_on_request(const char *name)
1673 static void __init fw_cache_init(void)
1675 spin_lock_init(&fw_cache.lock);
1676 INIT_LIST_HEAD(&fw_cache.head);
1677 fw_cache.state = FW_LOADER_NO_CACHE;
1679 #ifdef CONFIG_PM_SLEEP
1680 spin_lock_init(&fw_cache.name_lock);
1681 INIT_LIST_HEAD(&fw_cache.fw_names);
1683 INIT_DELAYED_WORK(&fw_cache.work,
1684 device_uncache_fw_images_work);
1686 fw_cache.pm_notify.notifier_call = fw_pm_notify;
1687 register_pm_notifier(&fw_cache.pm_notify);
1689 register_syscore_ops(&fw_syscore_ops);
1693 static int __init firmware_class_init(void)
1696 #ifdef CONFIG_FW_LOADER_USER_HELPER
1697 register_reboot_notifier(&fw_shutdown_nb);
1698 return class_register(&firmware_class);
1704 static void __exit firmware_class_exit(void)
1706 #ifdef CONFIG_PM_SLEEP
1707 unregister_syscore_ops(&fw_syscore_ops);
1708 unregister_pm_notifier(&fw_cache.pm_notify);
1710 #ifdef CONFIG_FW_LOADER_USER_HELPER
1711 unregister_reboot_notifier(&fw_shutdown_nb);
1712 class_unregister(&firmware_class);
1716 fs_initcall(firmware_class_init);
1717 module_exit(firmware_class_exit);