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) + strlen(fw_name) + 1 , GFP_ATOMIC);
189 kref_init(&buf->ref);
190 strcpy(buf->fw_id, fw_name);
192 init_completion(&buf->completion);
193 #ifdef CONFIG_FW_LOADER_USER_HELPER
194 INIT_LIST_HEAD(&buf->pending_list);
197 pr_debug("%s: fw-%s buf=%p\n", __func__, fw_name, buf);
202 static struct firmware_buf *__fw_lookup_buf(const char *fw_name)
204 struct firmware_buf *tmp;
205 struct firmware_cache *fwc = &fw_cache;
207 list_for_each_entry(tmp, &fwc->head, list)
208 if (!strcmp(tmp->fw_id, fw_name))
213 static int fw_lookup_and_allocate_buf(const char *fw_name,
214 struct firmware_cache *fwc,
215 struct firmware_buf **buf)
217 struct firmware_buf *tmp;
219 spin_lock(&fwc->lock);
220 tmp = __fw_lookup_buf(fw_name);
223 spin_unlock(&fwc->lock);
227 tmp = __allocate_fw_buf(fw_name, fwc);
229 list_add(&tmp->list, &fwc->head);
230 spin_unlock(&fwc->lock);
234 return tmp ? 0 : -ENOMEM;
237 static void __fw_free_buf(struct kref *ref)
238 __releases(&fwc->lock)
240 struct firmware_buf *buf = to_fwbuf(ref);
241 struct firmware_cache *fwc = buf->fwc;
243 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
244 __func__, buf->fw_id, buf, buf->data,
245 (unsigned int)buf->size);
247 list_del(&buf->list);
248 spin_unlock(&fwc->lock);
250 #ifdef CONFIG_FW_LOADER_USER_HELPER
251 if (buf->is_paged_buf) {
254 for (i = 0; i < buf->nr_pages; i++)
255 __free_page(buf->pages[i]);
263 static void fw_free_buf(struct firmware_buf *buf)
265 struct firmware_cache *fwc = buf->fwc;
266 spin_lock(&fwc->lock);
267 if (!kref_put(&buf->ref, __fw_free_buf))
268 spin_unlock(&fwc->lock);
271 /* direct firmware loading support */
272 static char fw_path_para[256];
273 static const char * const fw_path[] = {
275 "/lib/firmware/updates/" UTS_RELEASE,
276 "/lib/firmware/updates",
277 "/lib/firmware/" UTS_RELEASE,
282 * Typical usage is that passing 'firmware_class.path=$CUSTOMIZED_PATH'
283 * from kernel command line because firmware_class is generally built in
284 * kernel instead of module.
286 module_param_string(path, fw_path_para, sizeof(fw_path_para), 0644);
287 MODULE_PARM_DESC(path, "customized firmware image search path with a higher priority than default path");
289 static int fw_read_file_contents(struct file *file, struct firmware_buf *fw_buf)
295 if (!S_ISREG(file_inode(file)->i_mode))
297 size = i_size_read(file_inode(file));
303 rc = kernel_read(file, 0, buf, size);
309 rc = security_kernel_fw_from_file(file, buf, size);
320 static int fw_get_filesystem_firmware(struct device *device,
321 struct firmware_buf *buf)
325 char *path = __getname();
327 for (i = 0; i < ARRAY_SIZE(fw_path); i++) {
330 /* skip the unset customized path */
334 snprintf(path, PATH_MAX, "%s/%s", fw_path[i], buf->fw_id);
336 file = filp_open(path, O_RDONLY, 0);
339 rc = fw_read_file_contents(file, buf);
342 dev_warn(device, "firmware, attempted to load %s, but failed with error %d\n",
350 dev_dbg(device, "firmware: direct-loading firmware %s\n",
352 mutex_lock(&fw_lock);
353 set_bit(FW_STATUS_DONE, &buf->status);
354 complete_all(&buf->completion);
355 mutex_unlock(&fw_lock);
361 /* firmware holds the ownership of pages */
362 static void firmware_free_data(const struct firmware *fw)
364 /* Loaded directly? */
369 fw_free_buf(fw->priv);
372 /* store the pages buffer info firmware from buf */
373 static void fw_set_page_data(struct firmware_buf *buf, struct firmware *fw)
376 #ifdef CONFIG_FW_LOADER_USER_HELPER
377 fw->pages = buf->pages;
379 fw->size = buf->size;
380 fw->data = buf->data;
382 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
383 __func__, buf->fw_id, buf, buf->data,
384 (unsigned int)buf->size);
387 #ifdef CONFIG_PM_SLEEP
388 static void fw_name_devm_release(struct device *dev, void *res)
390 struct fw_name_devm *fwn = res;
392 if (fwn->magic == (unsigned long)&fw_cache)
393 pr_debug("%s: fw_name-%s devm-%p released\n",
394 __func__, fwn->name, res);
397 static int fw_devm_match(struct device *dev, void *res,
400 struct fw_name_devm *fwn = res;
402 return (fwn->magic == (unsigned long)&fw_cache) &&
403 !strcmp(fwn->name, match_data);
406 static struct fw_name_devm *fw_find_devm_name(struct device *dev,
409 struct fw_name_devm *fwn;
411 fwn = devres_find(dev, fw_name_devm_release,
412 fw_devm_match, (void *)name);
416 /* add firmware name into devres list */
417 static int fw_add_devm_name(struct device *dev, const char *name)
419 struct fw_name_devm *fwn;
421 fwn = fw_find_devm_name(dev, name);
425 fwn = devres_alloc(fw_name_devm_release, sizeof(struct fw_name_devm) +
426 strlen(name) + 1, GFP_KERNEL);
430 fwn->magic = (unsigned long)&fw_cache;
431 strcpy(fwn->name, name);
432 devres_add(dev, fwn);
437 static int fw_add_devm_name(struct device *dev, const char *name)
445 * user-mode helper code
447 #ifdef CONFIG_FW_LOADER_USER_HELPER
448 struct firmware_priv {
451 struct firmware_buf *buf;
455 static struct firmware_priv *to_firmware_priv(struct device *dev)
457 return container_of(dev, struct firmware_priv, dev);
460 static void __fw_load_abort(struct firmware_buf *buf)
463 * There is a small window in which user can write to 'loading'
464 * between loading done and disappearance of 'loading'
466 if (test_bit(FW_STATUS_DONE, &buf->status))
469 list_del_init(&buf->pending_list);
470 set_bit(FW_STATUS_ABORT, &buf->status);
471 complete_all(&buf->completion);
474 static void fw_load_abort(struct firmware_priv *fw_priv)
476 struct firmware_buf *buf = fw_priv->buf;
478 __fw_load_abort(buf);
480 /* avoid user action after loading abort */
484 #define is_fw_load_aborted(buf) \
485 test_bit(FW_STATUS_ABORT, &(buf)->status)
487 static LIST_HEAD(pending_fw_head);
489 /* reboot notifier for avoid deadlock with usermode_lock */
490 static int fw_shutdown_notify(struct notifier_block *unused1,
491 unsigned long unused2, void *unused3)
493 mutex_lock(&fw_lock);
494 while (!list_empty(&pending_fw_head))
495 __fw_load_abort(list_first_entry(&pending_fw_head,
498 mutex_unlock(&fw_lock);
502 static struct notifier_block fw_shutdown_nb = {
503 .notifier_call = fw_shutdown_notify,
506 static ssize_t timeout_show(struct class *class, struct class_attribute *attr,
509 return sprintf(buf, "%d\n", loading_timeout);
513 * firmware_timeout_store - set number of seconds to wait for firmware
514 * @class: device class pointer
515 * @attr: device attribute pointer
516 * @buf: buffer to scan for timeout value
517 * @count: number of bytes in @buf
519 * Sets the number of seconds to wait for the firmware. Once
520 * this expires an error will be returned to the driver and no
521 * firmware will be provided.
523 * Note: zero means 'wait forever'.
525 static ssize_t timeout_store(struct class *class, struct class_attribute *attr,
526 const char *buf, size_t count)
528 loading_timeout = simple_strtol(buf, NULL, 10);
529 if (loading_timeout < 0)
535 static struct class_attribute firmware_class_attrs[] = {
540 static void fw_dev_release(struct device *dev)
542 struct firmware_priv *fw_priv = to_firmware_priv(dev);
547 static int firmware_uevent(struct device *dev, struct kobj_uevent_env *env)
549 struct firmware_priv *fw_priv = to_firmware_priv(dev);
551 if (add_uevent_var(env, "FIRMWARE=%s", fw_priv->buf->fw_id))
553 if (add_uevent_var(env, "TIMEOUT=%i", loading_timeout))
555 if (add_uevent_var(env, "ASYNC=%d", fw_priv->nowait))
561 static struct class firmware_class = {
563 .class_attrs = firmware_class_attrs,
564 .dev_uevent = firmware_uevent,
565 .dev_release = fw_dev_release,
568 static ssize_t firmware_loading_show(struct device *dev,
569 struct device_attribute *attr, char *buf)
571 struct firmware_priv *fw_priv = to_firmware_priv(dev);
574 mutex_lock(&fw_lock);
576 loading = test_bit(FW_STATUS_LOADING, &fw_priv->buf->status);
577 mutex_unlock(&fw_lock);
579 return sprintf(buf, "%d\n", loading);
582 /* Some architectures don't have PAGE_KERNEL_RO */
583 #ifndef PAGE_KERNEL_RO
584 #define PAGE_KERNEL_RO PAGE_KERNEL
587 /* one pages buffer should be mapped/unmapped only once */
588 static int fw_map_pages_buf(struct firmware_buf *buf)
590 if (!buf->is_paged_buf)
594 buf->data = vmap(buf->pages, buf->nr_pages, 0, PAGE_KERNEL_RO);
601 * firmware_loading_store - set value in the 'loading' control file
602 * @dev: device pointer
603 * @attr: device attribute pointer
604 * @buf: buffer to scan for loading control value
605 * @count: number of bytes in @buf
607 * The relevant values are:
609 * 1: Start a load, discarding any previous partial load.
610 * 0: Conclude the load and hand the data to the driver code.
611 * -1: Conclude the load with an error and discard any written data.
613 static ssize_t firmware_loading_store(struct device *dev,
614 struct device_attribute *attr,
615 const char *buf, size_t count)
617 struct firmware_priv *fw_priv = to_firmware_priv(dev);
618 struct firmware_buf *fw_buf;
619 ssize_t written = count;
620 int loading = simple_strtol(buf, NULL, 10);
623 mutex_lock(&fw_lock);
624 fw_buf = fw_priv->buf;
630 /* discarding any previous partial load */
631 if (!test_bit(FW_STATUS_DONE, &fw_buf->status)) {
632 for (i = 0; i < fw_buf->nr_pages; i++)
633 __free_page(fw_buf->pages[i]);
634 kfree(fw_buf->pages);
635 fw_buf->pages = NULL;
636 fw_buf->page_array_size = 0;
637 fw_buf->nr_pages = 0;
638 set_bit(FW_STATUS_LOADING, &fw_buf->status);
642 if (test_bit(FW_STATUS_LOADING, &fw_buf->status)) {
645 set_bit(FW_STATUS_DONE, &fw_buf->status);
646 clear_bit(FW_STATUS_LOADING, &fw_buf->status);
649 * Several loading requests may be pending on
650 * one same firmware buf, so let all requests
651 * see the mapped 'buf->data' once the loading
654 rc = fw_map_pages_buf(fw_buf);
656 dev_err(dev, "%s: map pages failed\n",
659 rc = security_kernel_fw_from_file(NULL,
660 fw_buf->data, fw_buf->size);
663 * Same logic as fw_load_abort, only the DONE bit
664 * is ignored and we set ABORT only on failure.
666 list_del_init(&fw_buf->pending_list);
668 set_bit(FW_STATUS_ABORT, &fw_buf->status);
671 complete_all(&fw_buf->completion);
676 dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading);
679 fw_load_abort(fw_priv);
683 mutex_unlock(&fw_lock);
687 static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store);
689 static ssize_t firmware_data_read(struct file *filp, struct kobject *kobj,
690 struct bin_attribute *bin_attr,
691 char *buffer, loff_t offset, size_t count)
693 struct device *dev = kobj_to_dev(kobj);
694 struct firmware_priv *fw_priv = to_firmware_priv(dev);
695 struct firmware_buf *buf;
698 mutex_lock(&fw_lock);
700 if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) {
704 if (offset > buf->size) {
708 if (count > buf->size - offset)
709 count = buf->size - offset;
715 int page_nr = offset >> PAGE_SHIFT;
716 int page_ofs = offset & (PAGE_SIZE-1);
717 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
719 page_data = kmap(buf->pages[page_nr]);
721 memcpy(buffer, page_data + page_ofs, page_cnt);
723 kunmap(buf->pages[page_nr]);
729 mutex_unlock(&fw_lock);
733 static int fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
735 struct firmware_buf *buf = fw_priv->buf;
736 int pages_needed = PAGE_ALIGN(min_size) >> PAGE_SHIFT;
738 /* If the array of pages is too small, grow it... */
739 if (buf->page_array_size < pages_needed) {
740 int new_array_size = max(pages_needed,
741 buf->page_array_size * 2);
742 struct page **new_pages;
744 new_pages = kmalloc(new_array_size * sizeof(void *),
747 fw_load_abort(fw_priv);
750 memcpy(new_pages, buf->pages,
751 buf->page_array_size * sizeof(void *));
752 memset(&new_pages[buf->page_array_size], 0, sizeof(void *) *
753 (new_array_size - buf->page_array_size));
755 buf->pages = new_pages;
756 buf->page_array_size = new_array_size;
759 while (buf->nr_pages < pages_needed) {
760 buf->pages[buf->nr_pages] =
761 alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
763 if (!buf->pages[buf->nr_pages]) {
764 fw_load_abort(fw_priv);
773 * firmware_data_write - write method for firmware
774 * @filp: open sysfs file
775 * @kobj: kobject for the device
776 * @bin_attr: bin_attr structure
777 * @buffer: buffer being written
778 * @offset: buffer offset for write in total data store area
779 * @count: buffer size
781 * Data written to the 'data' attribute will be later handed to
782 * the driver as a firmware image.
784 static ssize_t firmware_data_write(struct file *filp, struct kobject *kobj,
785 struct bin_attribute *bin_attr,
786 char *buffer, loff_t offset, size_t count)
788 struct device *dev = kobj_to_dev(kobj);
789 struct firmware_priv *fw_priv = to_firmware_priv(dev);
790 struct firmware_buf *buf;
793 if (!capable(CAP_SYS_RAWIO))
796 mutex_lock(&fw_lock);
798 if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) {
803 retval = fw_realloc_buffer(fw_priv, offset + count);
811 int page_nr = offset >> PAGE_SHIFT;
812 int page_ofs = offset & (PAGE_SIZE - 1);
813 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
815 page_data = kmap(buf->pages[page_nr]);
817 memcpy(page_data + page_ofs, buffer, page_cnt);
819 kunmap(buf->pages[page_nr]);
825 buf->size = max_t(size_t, offset, buf->size);
827 mutex_unlock(&fw_lock);
831 static struct bin_attribute firmware_attr_data = {
832 .attr = { .name = "data", .mode = 0644 },
834 .read = firmware_data_read,
835 .write = firmware_data_write,
838 static struct firmware_priv *
839 fw_create_instance(struct firmware *firmware, const char *fw_name,
840 struct device *device, unsigned int opt_flags)
842 struct firmware_priv *fw_priv;
843 struct device *f_dev;
845 fw_priv = kzalloc(sizeof(*fw_priv), GFP_KERNEL);
847 fw_priv = ERR_PTR(-ENOMEM);
851 fw_priv->nowait = !!(opt_flags & FW_OPT_NOWAIT);
852 fw_priv->fw = firmware;
853 f_dev = &fw_priv->dev;
855 device_initialize(f_dev);
856 dev_set_name(f_dev, "%s", fw_name);
857 f_dev->parent = device;
858 f_dev->class = &firmware_class;
863 /* load a firmware via user helper */
864 static int _request_firmware_load(struct firmware_priv *fw_priv,
865 unsigned int opt_flags, long timeout)
868 struct device *f_dev = &fw_priv->dev;
869 struct firmware_buf *buf = fw_priv->buf;
871 /* fall back on userspace loading */
872 buf->is_paged_buf = true;
874 dev_set_uevent_suppress(f_dev, true);
876 retval = device_add(f_dev);
878 dev_err(f_dev, "%s: device_register failed\n", __func__);
882 retval = device_create_bin_file(f_dev, &firmware_attr_data);
884 dev_err(f_dev, "%s: sysfs_create_bin_file failed\n", __func__);
888 mutex_lock(&fw_lock);
889 list_add(&buf->pending_list, &pending_fw_head);
890 mutex_unlock(&fw_lock);
892 retval = device_create_file(f_dev, &dev_attr_loading);
894 mutex_lock(&fw_lock);
895 list_del_init(&buf->pending_list);
896 mutex_unlock(&fw_lock);
897 dev_err(f_dev, "%s: device_create_file failed\n", __func__);
898 goto err_del_bin_attr;
901 if (opt_flags & FW_OPT_UEVENT) {
902 buf->need_uevent = true;
903 dev_set_uevent_suppress(f_dev, false);
904 dev_dbg(f_dev, "firmware: requesting %s\n", buf->fw_id);
905 kobject_uevent(&fw_priv->dev.kobj, KOBJ_ADD);
907 timeout = MAX_JIFFY_OFFSET;
910 retval = wait_for_completion_interruptible_timeout(&buf->completion,
912 if (retval == -ERESTARTSYS || !retval) {
913 mutex_lock(&fw_lock);
914 fw_load_abort(fw_priv);
915 mutex_unlock(&fw_lock);
918 if (is_fw_load_aborted(buf))
923 device_remove_file(f_dev, &dev_attr_loading);
925 device_remove_bin_file(f_dev, &firmware_attr_data);
933 static int fw_load_from_user_helper(struct firmware *firmware,
934 const char *name, struct device *device,
935 unsigned int opt_flags, long timeout)
937 struct firmware_priv *fw_priv;
939 fw_priv = fw_create_instance(firmware, name, device, opt_flags);
941 return PTR_ERR(fw_priv);
943 fw_priv->buf = firmware->priv;
944 return _request_firmware_load(fw_priv, opt_flags, timeout);
947 #ifdef CONFIG_PM_SLEEP
948 /* kill pending requests without uevent to avoid blocking suspend */
949 static void kill_requests_without_uevent(void)
951 struct firmware_buf *buf;
952 struct firmware_buf *next;
954 mutex_lock(&fw_lock);
955 list_for_each_entry_safe(buf, next, &pending_fw_head, pending_list) {
956 if (!buf->need_uevent)
957 __fw_load_abort(buf);
959 mutex_unlock(&fw_lock);
963 #else /* CONFIG_FW_LOADER_USER_HELPER */
965 fw_load_from_user_helper(struct firmware *firmware, const char *name,
966 struct device *device, unsigned int opt_flags,
972 /* No abort during direct loading */
973 #define is_fw_load_aborted(buf) false
975 #ifdef CONFIG_PM_SLEEP
976 static inline void kill_requests_without_uevent(void) { }
979 #endif /* CONFIG_FW_LOADER_USER_HELPER */
982 /* wait until the shared firmware_buf becomes ready (or error) */
983 static int sync_cached_firmware_buf(struct firmware_buf *buf)
987 mutex_lock(&fw_lock);
988 while (!test_bit(FW_STATUS_DONE, &buf->status)) {
989 if (is_fw_load_aborted(buf)) {
993 mutex_unlock(&fw_lock);
994 ret = wait_for_completion_interruptible(&buf->completion);
995 mutex_lock(&fw_lock);
997 mutex_unlock(&fw_lock);
1001 /* prepare firmware and firmware_buf structs;
1002 * return 0 if a firmware is already assigned, 1 if need to load one,
1003 * or a negative error code
1006 _request_firmware_prepare(struct firmware **firmware_p, const char *name,
1007 struct device *device)
1009 struct firmware *firmware;
1010 struct firmware_buf *buf;
1013 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
1015 dev_err(device, "%s: kmalloc(struct firmware) failed\n",
1020 if (fw_get_builtin_firmware(firmware, name)) {
1021 dev_dbg(device, "firmware: using built-in firmware %s\n", name);
1022 return 0; /* assigned */
1025 ret = fw_lookup_and_allocate_buf(name, &fw_cache, &buf);
1028 * bind with 'buf' now to avoid warning in failure path
1029 * of requesting firmware.
1031 firmware->priv = buf;
1034 ret = sync_cached_firmware_buf(buf);
1036 fw_set_page_data(buf, firmware);
1037 return 0; /* assigned */
1043 return 1; /* need to load */
1046 static int assign_firmware_buf(struct firmware *fw, struct device *device,
1047 unsigned int opt_flags)
1049 struct firmware_buf *buf = fw->priv;
1051 mutex_lock(&fw_lock);
1052 if (!buf->size || is_fw_load_aborted(buf)) {
1053 mutex_unlock(&fw_lock);
1058 * add firmware name into devres list so that we can auto cache
1059 * and uncache firmware for device.
1061 * device may has been deleted already, but the problem
1062 * should be fixed in devres or driver core.
1064 /* don't cache firmware handled without uevent */
1065 if (device && (opt_flags & FW_OPT_UEVENT))
1066 fw_add_devm_name(device, buf->fw_id);
1069 * After caching firmware image is started, let it piggyback
1070 * on request firmware.
1072 if (buf->fwc->state == FW_LOADER_START_CACHE) {
1073 if (fw_cache_piggyback_on_request(buf->fw_id))
1074 kref_get(&buf->ref);
1077 /* pass the pages buffer to driver at the last minute */
1078 fw_set_page_data(buf, fw);
1079 mutex_unlock(&fw_lock);
1083 /* called from request_firmware() and request_firmware_work_func() */
1085 _request_firmware(const struct firmware **firmware_p, const char *name,
1086 struct device *device, unsigned int opt_flags)
1088 struct firmware *fw;
1095 if (!name || name[0] == '\0')
1098 ret = _request_firmware_prepare(&fw, name, device);
1099 if (ret <= 0) /* error or already assigned */
1103 timeout = firmware_loading_timeout();
1104 if (opt_flags & FW_OPT_NOWAIT) {
1105 timeout = usermodehelper_read_lock_wait(timeout);
1107 dev_dbg(device, "firmware: %s loading timed out\n",
1113 ret = usermodehelper_read_trylock();
1115 dev_err(device, "firmware: %s will not be loaded\n",
1121 ret = fw_get_filesystem_firmware(device, fw->priv);
1123 if (!(opt_flags & FW_OPT_NO_WARN))
1125 "Direct firmware load for %s failed with error %d\n",
1127 if (opt_flags & FW_OPT_USERHELPER) {
1128 dev_warn(device, "Falling back to user helper\n");
1129 ret = fw_load_from_user_helper(fw, name, device,
1130 opt_flags, timeout);
1135 ret = assign_firmware_buf(fw, device, opt_flags);
1137 usermodehelper_read_unlock();
1141 release_firmware(fw);
1150 * request_firmware: - send firmware request and wait for it
1151 * @firmware_p: pointer to firmware image
1152 * @name: name of firmware file
1153 * @device: device for which firmware is being loaded
1155 * @firmware_p will be used to return a firmware image by the name
1156 * of @name for device @device.
1158 * Should be called from user context where sleeping is allowed.
1160 * @name will be used as $FIRMWARE in the uevent environment and
1161 * should be distinctive enough not to be confused with any other
1162 * firmware image for this or any other device.
1164 * Caller must hold the reference count of @device.
1166 * The function can be called safely inside device's suspend and
1170 request_firmware(const struct firmware **firmware_p, const char *name,
1171 struct device *device)
1175 /* Need to pin this module until return */
1176 __module_get(THIS_MODULE);
1177 ret = _request_firmware(firmware_p, name, device,
1178 FW_OPT_UEVENT | FW_OPT_FALLBACK);
1179 module_put(THIS_MODULE);
1182 EXPORT_SYMBOL(request_firmware);
1185 * request_firmware_direct: - load firmware directly without usermode helper
1186 * @firmware_p: pointer to firmware image
1187 * @name: name of firmware file
1188 * @device: device for which firmware is being loaded
1190 * This function works pretty much like request_firmware(), but this doesn't
1191 * fall back to usermode helper even if the firmware couldn't be loaded
1192 * directly from fs. Hence it's useful for loading optional firmwares, which
1193 * aren't always present, without extra long timeouts of udev.
1195 int request_firmware_direct(const struct firmware **firmware_p,
1196 const char *name, struct device *device)
1199 __module_get(THIS_MODULE);
1200 ret = _request_firmware(firmware_p, name, device,
1201 FW_OPT_UEVENT | FW_OPT_NO_WARN);
1202 module_put(THIS_MODULE);
1205 EXPORT_SYMBOL_GPL(request_firmware_direct);
1208 * release_firmware: - release the resource associated with a firmware image
1209 * @fw: firmware resource to release
1211 void release_firmware(const struct firmware *fw)
1214 if (!fw_is_builtin_firmware(fw))
1215 firmware_free_data(fw);
1219 EXPORT_SYMBOL(release_firmware);
1222 struct firmware_work {
1223 struct work_struct work;
1224 struct module *module;
1226 struct device *device;
1228 void (*cont)(const struct firmware *fw, void *context);
1229 unsigned int opt_flags;
1232 static void request_firmware_work_func(struct work_struct *work)
1234 struct firmware_work *fw_work;
1235 const struct firmware *fw;
1237 fw_work = container_of(work, struct firmware_work, work);
1239 _request_firmware(&fw, fw_work->name, fw_work->device,
1240 fw_work->opt_flags);
1241 fw_work->cont(fw, fw_work->context);
1242 put_device(fw_work->device); /* taken in request_firmware_nowait() */
1244 module_put(fw_work->module);
1249 * request_firmware_nowait - asynchronous version of request_firmware
1250 * @module: module requesting the firmware
1251 * @uevent: sends uevent to copy the firmware image if this flag
1252 * is non-zero else the firmware copy must be done manually.
1253 * @name: name of firmware file
1254 * @device: device for which firmware is being loaded
1255 * @gfp: allocation flags
1256 * @context: will be passed over to @cont, and
1257 * @fw may be %NULL if firmware request fails.
1258 * @cont: function will be called asynchronously when the firmware
1261 * Caller must hold the reference count of @device.
1263 * Asynchronous variant of request_firmware() for user contexts:
1264 * - sleep for as small periods as possible since it may
1265 * increase kernel boot time of built-in device drivers
1266 * requesting firmware in their ->probe() methods, if
1267 * @gfp is GFP_KERNEL.
1269 * - can't sleep at all if @gfp is GFP_ATOMIC.
1272 request_firmware_nowait(
1273 struct module *module, bool uevent,
1274 const char *name, struct device *device, gfp_t gfp, void *context,
1275 void (*cont)(const struct firmware *fw, void *context))
1277 struct firmware_work *fw_work;
1279 fw_work = kzalloc(sizeof (struct firmware_work), gfp);
1283 fw_work->module = module;
1284 fw_work->name = name;
1285 fw_work->device = device;
1286 fw_work->context = context;
1287 fw_work->cont = cont;
1288 fw_work->opt_flags = FW_OPT_NOWAIT | FW_OPT_FALLBACK |
1289 (uevent ? FW_OPT_UEVENT : FW_OPT_USERHELPER);
1291 if (!try_module_get(module)) {
1296 get_device(fw_work->device);
1297 INIT_WORK(&fw_work->work, request_firmware_work_func);
1298 schedule_work(&fw_work->work);
1301 EXPORT_SYMBOL(request_firmware_nowait);
1303 #ifdef CONFIG_PM_SLEEP
1304 static ASYNC_DOMAIN_EXCLUSIVE(fw_cache_domain);
1307 * cache_firmware - cache one firmware image in kernel memory space
1308 * @fw_name: the firmware image name
1310 * Cache firmware in kernel memory so that drivers can use it when
1311 * system isn't ready for them to request firmware image from userspace.
1312 * Once it returns successfully, driver can use request_firmware or its
1313 * nowait version to get the cached firmware without any interacting
1316 * Return 0 if the firmware image has been cached successfully
1317 * Return !0 otherwise
1320 static int cache_firmware(const char *fw_name)
1323 const struct firmware *fw;
1325 pr_debug("%s: %s\n", __func__, fw_name);
1327 ret = request_firmware(&fw, fw_name, NULL);
1331 pr_debug("%s: %s ret=%d\n", __func__, fw_name, ret);
1336 static struct firmware_buf *fw_lookup_buf(const char *fw_name)
1338 struct firmware_buf *tmp;
1339 struct firmware_cache *fwc = &fw_cache;
1341 spin_lock(&fwc->lock);
1342 tmp = __fw_lookup_buf(fw_name);
1343 spin_unlock(&fwc->lock);
1349 * uncache_firmware - remove one cached firmware image
1350 * @fw_name: the firmware image name
1352 * Uncache one firmware image which has been cached successfully
1355 * Return 0 if the firmware cache has been removed successfully
1356 * Return !0 otherwise
1359 static int uncache_firmware(const char *fw_name)
1361 struct firmware_buf *buf;
1364 pr_debug("%s: %s\n", __func__, fw_name);
1366 if (fw_get_builtin_firmware(&fw, fw_name))
1369 buf = fw_lookup_buf(fw_name);
1378 static struct fw_cache_entry *alloc_fw_cache_entry(const char *name)
1380 struct fw_cache_entry *fce;
1382 fce = kzalloc(sizeof(*fce) + strlen(name) + 1, GFP_ATOMIC);
1386 strcpy(fce->name, name);
1391 static int __fw_entry_found(const char *name)
1393 struct firmware_cache *fwc = &fw_cache;
1394 struct fw_cache_entry *fce;
1396 list_for_each_entry(fce, &fwc->fw_names, list) {
1397 if (!strcmp(fce->name, name))
1403 static int fw_cache_piggyback_on_request(const char *name)
1405 struct firmware_cache *fwc = &fw_cache;
1406 struct fw_cache_entry *fce;
1409 spin_lock(&fwc->name_lock);
1410 if (__fw_entry_found(name))
1413 fce = alloc_fw_cache_entry(name);
1416 list_add(&fce->list, &fwc->fw_names);
1417 pr_debug("%s: fw: %s\n", __func__, name);
1420 spin_unlock(&fwc->name_lock);
1424 static void free_fw_cache_entry(struct fw_cache_entry *fce)
1429 static void __async_dev_cache_fw_image(void *fw_entry,
1430 async_cookie_t cookie)
1432 struct fw_cache_entry *fce = fw_entry;
1433 struct firmware_cache *fwc = &fw_cache;
1436 ret = cache_firmware(fce->name);
1438 spin_lock(&fwc->name_lock);
1439 list_del(&fce->list);
1440 spin_unlock(&fwc->name_lock);
1442 free_fw_cache_entry(fce);
1446 /* called with dev->devres_lock held */
1447 static void dev_create_fw_entry(struct device *dev, void *res,
1450 struct fw_name_devm *fwn = res;
1451 const char *fw_name = fwn->name;
1452 struct list_head *head = data;
1453 struct fw_cache_entry *fce;
1455 fce = alloc_fw_cache_entry(fw_name);
1457 list_add(&fce->list, head);
1460 static int devm_name_match(struct device *dev, void *res,
1463 struct fw_name_devm *fwn = res;
1464 return (fwn->magic == (unsigned long)match_data);
1467 static void dev_cache_fw_image(struct device *dev, void *data)
1470 struct fw_cache_entry *fce;
1471 struct fw_cache_entry *fce_next;
1472 struct firmware_cache *fwc = &fw_cache;
1474 devres_for_each_res(dev, fw_name_devm_release,
1475 devm_name_match, &fw_cache,
1476 dev_create_fw_entry, &todo);
1478 list_for_each_entry_safe(fce, fce_next, &todo, list) {
1479 list_del(&fce->list);
1481 spin_lock(&fwc->name_lock);
1482 /* only one cache entry for one firmware */
1483 if (!__fw_entry_found(fce->name)) {
1484 list_add(&fce->list, &fwc->fw_names);
1486 free_fw_cache_entry(fce);
1489 spin_unlock(&fwc->name_lock);
1492 async_schedule_domain(__async_dev_cache_fw_image,
1498 static void __device_uncache_fw_images(void)
1500 struct firmware_cache *fwc = &fw_cache;
1501 struct fw_cache_entry *fce;
1503 spin_lock(&fwc->name_lock);
1504 while (!list_empty(&fwc->fw_names)) {
1505 fce = list_entry(fwc->fw_names.next,
1506 struct fw_cache_entry, list);
1507 list_del(&fce->list);
1508 spin_unlock(&fwc->name_lock);
1510 uncache_firmware(fce->name);
1511 free_fw_cache_entry(fce);
1513 spin_lock(&fwc->name_lock);
1515 spin_unlock(&fwc->name_lock);
1519 * device_cache_fw_images - cache devices' firmware
1521 * If one device called request_firmware or its nowait version
1522 * successfully before, the firmware names are recored into the
1523 * device's devres link list, so device_cache_fw_images can call
1524 * cache_firmware() to cache these firmwares for the device,
1525 * then the device driver can load its firmwares easily at
1526 * time when system is not ready to complete loading firmware.
1528 static void device_cache_fw_images(void)
1530 struct firmware_cache *fwc = &fw_cache;
1534 pr_debug("%s\n", __func__);
1536 /* cancel uncache work */
1537 cancel_delayed_work_sync(&fwc->work);
1540 * use small loading timeout for caching devices' firmware
1541 * because all these firmware images have been loaded
1542 * successfully at lease once, also system is ready for
1543 * completing firmware loading now. The maximum size of
1544 * firmware in current distributions is about 2M bytes,
1545 * so 10 secs should be enough.
1547 old_timeout = loading_timeout;
1548 loading_timeout = 10;
1550 mutex_lock(&fw_lock);
1551 fwc->state = FW_LOADER_START_CACHE;
1552 dpm_for_each_dev(NULL, dev_cache_fw_image);
1553 mutex_unlock(&fw_lock);
1555 /* wait for completion of caching firmware for all devices */
1556 async_synchronize_full_domain(&fw_cache_domain);
1558 loading_timeout = old_timeout;
1562 * device_uncache_fw_images - uncache devices' firmware
1564 * uncache all firmwares which have been cached successfully
1565 * by device_uncache_fw_images earlier
1567 static void device_uncache_fw_images(void)
1569 pr_debug("%s\n", __func__);
1570 __device_uncache_fw_images();
1573 static void device_uncache_fw_images_work(struct work_struct *work)
1575 device_uncache_fw_images();
1579 * device_uncache_fw_images_delay - uncache devices firmwares
1580 * @delay: number of milliseconds to delay uncache device firmwares
1582 * uncache all devices's firmwares which has been cached successfully
1583 * by device_cache_fw_images after @delay milliseconds.
1585 static void device_uncache_fw_images_delay(unsigned long delay)
1587 queue_delayed_work(system_power_efficient_wq, &fw_cache.work,
1588 msecs_to_jiffies(delay));
1591 static int fw_pm_notify(struct notifier_block *notify_block,
1592 unsigned long mode, void *unused)
1595 case PM_HIBERNATION_PREPARE:
1596 case PM_SUSPEND_PREPARE:
1597 case PM_RESTORE_PREPARE:
1598 kill_requests_without_uevent();
1599 device_cache_fw_images();
1602 case PM_POST_SUSPEND:
1603 case PM_POST_HIBERNATION:
1604 case PM_POST_RESTORE:
1606 * In case that system sleep failed and syscore_suspend is
1609 mutex_lock(&fw_lock);
1610 fw_cache.state = FW_LOADER_NO_CACHE;
1611 mutex_unlock(&fw_lock);
1613 device_uncache_fw_images_delay(10 * MSEC_PER_SEC);
1620 /* stop caching firmware once syscore_suspend is reached */
1621 static int fw_suspend(void)
1623 fw_cache.state = FW_LOADER_NO_CACHE;
1627 static struct syscore_ops fw_syscore_ops = {
1628 .suspend = fw_suspend,
1631 static int fw_cache_piggyback_on_request(const char *name)
1637 static void __init fw_cache_init(void)
1639 spin_lock_init(&fw_cache.lock);
1640 INIT_LIST_HEAD(&fw_cache.head);
1641 fw_cache.state = FW_LOADER_NO_CACHE;
1643 #ifdef CONFIG_PM_SLEEP
1644 spin_lock_init(&fw_cache.name_lock);
1645 INIT_LIST_HEAD(&fw_cache.fw_names);
1647 INIT_DELAYED_WORK(&fw_cache.work,
1648 device_uncache_fw_images_work);
1650 fw_cache.pm_notify.notifier_call = fw_pm_notify;
1651 register_pm_notifier(&fw_cache.pm_notify);
1653 register_syscore_ops(&fw_syscore_ops);
1657 static int __init firmware_class_init(void)
1660 #ifdef CONFIG_FW_LOADER_USER_HELPER
1661 register_reboot_notifier(&fw_shutdown_nb);
1662 return class_register(&firmware_class);
1668 static void __exit firmware_class_exit(void)
1670 #ifdef CONFIG_PM_SLEEP
1671 unregister_syscore_ops(&fw_syscore_ops);
1672 unregister_pm_notifier(&fw_cache.pm_notify);
1674 #ifdef CONFIG_FW_LOADER_USER_HELPER
1675 unregister_reboot_notifier(&fw_shutdown_nb);
1676 class_unregister(&firmware_class);
1680 fs_initcall(firmware_class_init);
1681 module_exit(firmware_class_exit);