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>
32 #include <generated/utsrelease.h>
36 MODULE_AUTHOR("Manuel Estrada Sainz");
37 MODULE_DESCRIPTION("Multi purpose firmware loading support");
38 MODULE_LICENSE("GPL");
40 /* Builtin firmware support */
42 #ifdef CONFIG_FW_LOADER
44 extern struct builtin_fw __start_builtin_fw[];
45 extern struct builtin_fw __end_builtin_fw[];
47 static bool fw_get_builtin_firmware(struct firmware *fw, const char *name)
49 struct builtin_fw *b_fw;
51 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++) {
52 if (strcmp(name, b_fw->name) == 0) {
53 fw->size = b_fw->size;
54 fw->data = b_fw->data;
62 static bool fw_is_builtin_firmware(const struct firmware *fw)
64 struct builtin_fw *b_fw;
66 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++)
67 if (fw->data == b_fw->data)
73 #else /* Module case - no builtin firmware support */
75 static inline bool fw_get_builtin_firmware(struct firmware *fw, const char *name)
80 static inline bool fw_is_builtin_firmware(const struct firmware *fw)
92 static int loading_timeout = 60; /* In seconds */
94 static inline long firmware_loading_timeout(void)
96 return loading_timeout > 0 ? loading_timeout * HZ : MAX_SCHEDULE_TIMEOUT;
99 /* firmware behavior options */
100 #define FW_OPT_UEVENT (1U << 0)
101 #define FW_OPT_NOWAIT (1U << 1)
102 #ifdef CONFIG_FW_LOADER_USER_HELPER
103 #define FW_OPT_FALLBACK (1U << 2)
105 #define FW_OPT_FALLBACK 0
108 struct firmware_cache {
109 /* firmware_buf instance will be added into the below list */
111 struct list_head head;
114 #ifdef CONFIG_PM_SLEEP
116 * Names of firmware images which have been cached successfully
117 * will be added into the below list so that device uncache
118 * helper can trace which firmware images have been cached
121 spinlock_t name_lock;
122 struct list_head fw_names;
124 struct delayed_work work;
126 struct notifier_block pm_notify;
130 struct firmware_buf {
132 struct list_head list;
133 struct completion completion;
134 struct firmware_cache *fwc;
135 unsigned long status;
138 #ifdef CONFIG_FW_LOADER_USER_HELPER
144 struct list_head pending_list;
149 struct fw_cache_entry {
150 struct list_head list;
154 struct fw_name_devm {
159 #define to_fwbuf(d) container_of(d, struct firmware_buf, ref)
161 #define FW_LOADER_NO_CACHE 0
162 #define FW_LOADER_START_CACHE 1
164 static int fw_cache_piggyback_on_request(const char *name);
166 /* fw_lock could be moved to 'struct firmware_priv' but since it is just
167 * guarding for corner cases a global lock should be OK */
168 static DEFINE_MUTEX(fw_lock);
170 static struct firmware_cache fw_cache;
172 static struct firmware_buf *__allocate_fw_buf(const char *fw_name,
173 struct firmware_cache *fwc)
175 struct firmware_buf *buf;
177 buf = kzalloc(sizeof(*buf) + strlen(fw_name) + 1 , GFP_ATOMIC);
182 kref_init(&buf->ref);
183 strcpy(buf->fw_id, fw_name);
185 init_completion(&buf->completion);
186 #ifdef CONFIG_FW_LOADER_USER_HELPER
187 INIT_LIST_HEAD(&buf->pending_list);
190 pr_debug("%s: fw-%s buf=%p\n", __func__, fw_name, buf);
195 static struct firmware_buf *__fw_lookup_buf(const char *fw_name)
197 struct firmware_buf *tmp;
198 struct firmware_cache *fwc = &fw_cache;
200 list_for_each_entry(tmp, &fwc->head, list)
201 if (!strcmp(tmp->fw_id, fw_name))
206 static int fw_lookup_and_allocate_buf(const char *fw_name,
207 struct firmware_cache *fwc,
208 struct firmware_buf **buf)
210 struct firmware_buf *tmp;
212 spin_lock(&fwc->lock);
213 tmp = __fw_lookup_buf(fw_name);
216 spin_unlock(&fwc->lock);
220 tmp = __allocate_fw_buf(fw_name, fwc);
222 list_add(&tmp->list, &fwc->head);
223 spin_unlock(&fwc->lock);
227 return tmp ? 0 : -ENOMEM;
230 static void __fw_free_buf(struct kref *ref)
231 __releases(&fwc->lock)
233 struct firmware_buf *buf = to_fwbuf(ref);
234 struct firmware_cache *fwc = buf->fwc;
236 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
237 __func__, buf->fw_id, buf, buf->data,
238 (unsigned int)buf->size);
240 list_del(&buf->list);
241 spin_unlock(&fwc->lock);
243 #ifdef CONFIG_FW_LOADER_USER_HELPER
244 if (buf->is_paged_buf) {
247 for (i = 0; i < buf->nr_pages; i++)
248 __free_page(buf->pages[i]);
256 static void fw_free_buf(struct firmware_buf *buf)
258 struct firmware_cache *fwc = buf->fwc;
259 spin_lock(&fwc->lock);
260 if (!kref_put(&buf->ref, __fw_free_buf))
261 spin_unlock(&fwc->lock);
264 /* direct firmware loading support */
265 static char fw_path_para[256];
266 static const char * const fw_path[] = {
268 "/lib/firmware/updates/" UTS_RELEASE,
269 "/lib/firmware/updates",
270 "/lib/firmware/" UTS_RELEASE,
275 * Typical usage is that passing 'firmware_class.path=$CUSTOMIZED_PATH'
276 * from kernel command line because firmware_class is generally built in
277 * kernel instead of module.
279 module_param_string(path, fw_path_para, sizeof(fw_path_para), 0644);
280 MODULE_PARM_DESC(path, "customized firmware image search path with a higher priority than default path");
282 /* Don't inline this: 'struct kstat' is biggish */
283 static noinline_for_stack int fw_file_size(struct file *file)
286 if (vfs_getattr(&file->f_path, &st))
288 if (!S_ISREG(st.mode))
290 if (st.size != (int)st.size)
295 static int fw_read_file_contents(struct file *file, struct firmware_buf *fw_buf)
301 size = fw_file_size(file);
307 rc = kernel_read(file, 0, buf, size);
319 static int fw_get_filesystem_firmware(struct device *device,
320 struct firmware_buf *buf)
324 char *path = __getname();
326 for (i = 0; i < ARRAY_SIZE(fw_path); i++) {
329 /* skip the unset customized path */
333 snprintf(path, PATH_MAX, "%s/%s", fw_path[i], buf->fw_id);
335 file = filp_open(path, O_RDONLY, 0);
338 rc = fw_read_file_contents(file, buf);
341 dev_warn(device, "firmware, attempted to load %s, but failed with error %d\n",
349 dev_dbg(device, "firmware: direct-loading firmware %s\n",
351 mutex_lock(&fw_lock);
352 set_bit(FW_STATUS_DONE, &buf->status);
353 complete_all(&buf->completion);
354 mutex_unlock(&fw_lock);
360 /* firmware holds the ownership of pages */
361 static void firmware_free_data(const struct firmware *fw)
363 /* Loaded directly? */
368 fw_free_buf(fw->priv);
371 /* store the pages buffer info firmware from buf */
372 static void fw_set_page_data(struct firmware_buf *buf, struct firmware *fw)
375 #ifdef CONFIG_FW_LOADER_USER_HELPER
376 fw->pages = buf->pages;
378 fw->size = buf->size;
379 fw->data = buf->data;
381 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
382 __func__, buf->fw_id, buf, buf->data,
383 (unsigned int)buf->size);
386 #ifdef CONFIG_PM_SLEEP
387 static void fw_name_devm_release(struct device *dev, void *res)
389 struct fw_name_devm *fwn = res;
391 if (fwn->magic == (unsigned long)&fw_cache)
392 pr_debug("%s: fw_name-%s devm-%p released\n",
393 __func__, fwn->name, res);
396 static int fw_devm_match(struct device *dev, void *res,
399 struct fw_name_devm *fwn = res;
401 return (fwn->magic == (unsigned long)&fw_cache) &&
402 !strcmp(fwn->name, match_data);
405 static struct fw_name_devm *fw_find_devm_name(struct device *dev,
408 struct fw_name_devm *fwn;
410 fwn = devres_find(dev, fw_name_devm_release,
411 fw_devm_match, (void *)name);
415 /* add firmware name into devres list */
416 static int fw_add_devm_name(struct device *dev, const char *name)
418 struct fw_name_devm *fwn;
420 fwn = fw_find_devm_name(dev, name);
424 fwn = devres_alloc(fw_name_devm_release, sizeof(struct fw_name_devm) +
425 strlen(name) + 1, GFP_KERNEL);
429 fwn->magic = (unsigned long)&fw_cache;
430 strcpy(fwn->name, name);
431 devres_add(dev, fwn);
436 static int fw_add_devm_name(struct device *dev, const char *name)
444 * user-mode helper code
446 #ifdef CONFIG_FW_LOADER_USER_HELPER
447 struct firmware_priv {
448 struct delayed_work timeout_work;
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)
595 buf->data = vmap(buf->pages, buf->nr_pages, 0, PAGE_KERNEL_RO);
602 * firmware_loading_store - set value in the 'loading' control file
603 * @dev: device pointer
604 * @attr: device attribute pointer
605 * @buf: buffer to scan for loading control value
606 * @count: number of bytes in @buf
608 * The relevant values are:
610 * 1: Start a load, discarding any previous partial load.
611 * 0: Conclude the load and hand the data to the driver code.
612 * -1: Conclude the load with an error and discard any written data.
614 static ssize_t firmware_loading_store(struct device *dev,
615 struct device_attribute *attr,
616 const char *buf, size_t count)
618 struct firmware_priv *fw_priv = to_firmware_priv(dev);
619 struct firmware_buf *fw_buf;
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)) {
643 set_bit(FW_STATUS_DONE, &fw_buf->status);
644 clear_bit(FW_STATUS_LOADING, &fw_buf->status);
647 * Several loading requests may be pending on
648 * one same firmware buf, so let all requests
649 * see the mapped 'buf->data' once the loading
652 fw_map_pages_buf(fw_buf);
653 list_del_init(&fw_buf->pending_list);
654 complete_all(&fw_buf->completion);
659 dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading);
662 fw_load_abort(fw_priv);
666 mutex_unlock(&fw_lock);
670 static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store);
672 static ssize_t firmware_data_read(struct file *filp, struct kobject *kobj,
673 struct bin_attribute *bin_attr,
674 char *buffer, loff_t offset, size_t count)
676 struct device *dev = kobj_to_dev(kobj);
677 struct firmware_priv *fw_priv = to_firmware_priv(dev);
678 struct firmware_buf *buf;
681 mutex_lock(&fw_lock);
683 if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) {
687 if (offset > buf->size) {
691 if (count > buf->size - offset)
692 count = buf->size - offset;
698 int page_nr = offset >> PAGE_SHIFT;
699 int page_ofs = offset & (PAGE_SIZE-1);
700 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
702 page_data = kmap(buf->pages[page_nr]);
704 memcpy(buffer, page_data + page_ofs, page_cnt);
706 kunmap(buf->pages[page_nr]);
712 mutex_unlock(&fw_lock);
716 static int fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
718 struct firmware_buf *buf = fw_priv->buf;
719 int pages_needed = ALIGN(min_size, PAGE_SIZE) >> PAGE_SHIFT;
721 /* If the array of pages is too small, grow it... */
722 if (buf->page_array_size < pages_needed) {
723 int new_array_size = max(pages_needed,
724 buf->page_array_size * 2);
725 struct page **new_pages;
727 new_pages = kmalloc(new_array_size * sizeof(void *),
730 fw_load_abort(fw_priv);
733 memcpy(new_pages, buf->pages,
734 buf->page_array_size * sizeof(void *));
735 memset(&new_pages[buf->page_array_size], 0, sizeof(void *) *
736 (new_array_size - buf->page_array_size));
738 buf->pages = new_pages;
739 buf->page_array_size = new_array_size;
742 while (buf->nr_pages < pages_needed) {
743 buf->pages[buf->nr_pages] =
744 alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
746 if (!buf->pages[buf->nr_pages]) {
747 fw_load_abort(fw_priv);
756 * firmware_data_write - write method for firmware
757 * @filp: open sysfs file
758 * @kobj: kobject for the device
759 * @bin_attr: bin_attr structure
760 * @buffer: buffer being written
761 * @offset: buffer offset for write in total data store area
762 * @count: buffer size
764 * Data written to the 'data' attribute will be later handed to
765 * the driver as a firmware image.
767 static ssize_t firmware_data_write(struct file *filp, struct kobject *kobj,
768 struct bin_attribute *bin_attr,
769 char *buffer, loff_t offset, size_t count)
771 struct device *dev = kobj_to_dev(kobj);
772 struct firmware_priv *fw_priv = to_firmware_priv(dev);
773 struct firmware_buf *buf;
776 if (!capable(CAP_SYS_RAWIO))
779 mutex_lock(&fw_lock);
781 if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) {
786 retval = fw_realloc_buffer(fw_priv, offset + count);
794 int page_nr = offset >> PAGE_SHIFT;
795 int page_ofs = offset & (PAGE_SIZE - 1);
796 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
798 page_data = kmap(buf->pages[page_nr]);
800 memcpy(page_data + page_ofs, buffer, page_cnt);
802 kunmap(buf->pages[page_nr]);
808 buf->size = max_t(size_t, offset, buf->size);
810 mutex_unlock(&fw_lock);
814 static struct bin_attribute firmware_attr_data = {
815 .attr = { .name = "data", .mode = 0644 },
817 .read = firmware_data_read,
818 .write = firmware_data_write,
821 static void firmware_class_timeout_work(struct work_struct *work)
823 struct firmware_priv *fw_priv = container_of(work,
824 struct firmware_priv, timeout_work.work);
826 mutex_lock(&fw_lock);
827 fw_load_abort(fw_priv);
828 mutex_unlock(&fw_lock);
831 static struct firmware_priv *
832 fw_create_instance(struct firmware *firmware, const char *fw_name,
833 struct device *device, unsigned int opt_flags)
835 struct firmware_priv *fw_priv;
836 struct device *f_dev;
838 fw_priv = kzalloc(sizeof(*fw_priv), GFP_KERNEL);
840 dev_err(device, "%s: kmalloc failed\n", __func__);
841 fw_priv = ERR_PTR(-ENOMEM);
845 fw_priv->nowait = !!(opt_flags & FW_OPT_NOWAIT);
846 fw_priv->fw = firmware;
847 INIT_DELAYED_WORK(&fw_priv->timeout_work,
848 firmware_class_timeout_work);
850 f_dev = &fw_priv->dev;
852 device_initialize(f_dev);
853 dev_set_name(f_dev, "%s", fw_name);
854 f_dev->parent = device;
855 f_dev->class = &firmware_class;
860 /* load a firmware via user helper */
861 static int _request_firmware_load(struct firmware_priv *fw_priv,
862 unsigned int opt_flags, long timeout)
865 struct device *f_dev = &fw_priv->dev;
866 struct firmware_buf *buf = fw_priv->buf;
868 /* fall back on userspace loading */
869 buf->is_paged_buf = true;
871 dev_set_uevent_suppress(f_dev, true);
873 retval = device_add(f_dev);
875 dev_err(f_dev, "%s: device_register failed\n", __func__);
879 retval = device_create_bin_file(f_dev, &firmware_attr_data);
881 dev_err(f_dev, "%s: sysfs_create_bin_file failed\n", __func__);
885 mutex_lock(&fw_lock);
886 list_add(&buf->pending_list, &pending_fw_head);
887 mutex_unlock(&fw_lock);
889 retval = device_create_file(f_dev, &dev_attr_loading);
891 mutex_lock(&fw_lock);
892 list_del_init(&buf->pending_list);
893 mutex_unlock(&fw_lock);
894 dev_err(f_dev, "%s: device_create_file failed\n", __func__);
895 goto err_del_bin_attr;
898 if (opt_flags & FW_OPT_UEVENT) {
899 buf->need_uevent = true;
900 dev_set_uevent_suppress(f_dev, false);
901 dev_dbg(f_dev, "firmware: requesting %s\n", buf->fw_id);
902 if (timeout != MAX_SCHEDULE_TIMEOUT)
903 schedule_delayed_work(&fw_priv->timeout_work, timeout);
905 kobject_uevent(&fw_priv->dev.kobj, KOBJ_ADD);
908 wait_for_completion(&buf->completion);
910 cancel_delayed_work_sync(&fw_priv->timeout_work);
912 device_remove_file(f_dev, &dev_attr_loading);
914 device_remove_bin_file(f_dev, &firmware_attr_data);
922 static int fw_load_from_user_helper(struct firmware *firmware,
923 const char *name, struct device *device,
924 unsigned int opt_flags, long timeout)
926 struct firmware_priv *fw_priv;
928 fw_priv = fw_create_instance(firmware, name, device, opt_flags);
930 return PTR_ERR(fw_priv);
932 fw_priv->buf = firmware->priv;
933 return _request_firmware_load(fw_priv, opt_flags, timeout);
936 #ifdef CONFIG_PM_SLEEP
937 /* kill pending requests without uevent to avoid blocking suspend */
938 static void kill_requests_without_uevent(void)
940 struct firmware_buf *buf;
941 struct firmware_buf *next;
943 mutex_lock(&fw_lock);
944 list_for_each_entry_safe(buf, next, &pending_fw_head, pending_list) {
945 if (!buf->need_uevent)
946 __fw_load_abort(buf);
948 mutex_unlock(&fw_lock);
952 #else /* CONFIG_FW_LOADER_USER_HELPER */
954 fw_load_from_user_helper(struct firmware *firmware, const char *name,
955 struct device *device, unsigned int opt_flags,
961 /* No abort during direct loading */
962 #define is_fw_load_aborted(buf) false
964 #ifdef CONFIG_PM_SLEEP
965 static inline void kill_requests_without_uevent(void) { }
968 #endif /* CONFIG_FW_LOADER_USER_HELPER */
971 /* wait until the shared firmware_buf becomes ready (or error) */
972 static int sync_cached_firmware_buf(struct firmware_buf *buf)
976 mutex_lock(&fw_lock);
977 while (!test_bit(FW_STATUS_DONE, &buf->status)) {
978 if (is_fw_load_aborted(buf)) {
982 mutex_unlock(&fw_lock);
983 wait_for_completion(&buf->completion);
984 mutex_lock(&fw_lock);
986 mutex_unlock(&fw_lock);
990 /* prepare firmware and firmware_buf structs;
991 * return 0 if a firmware is already assigned, 1 if need to load one,
992 * or a negative error code
995 _request_firmware_prepare(struct firmware **firmware_p, const char *name,
996 struct device *device)
998 struct firmware *firmware;
999 struct firmware_buf *buf;
1002 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
1004 dev_err(device, "%s: kmalloc(struct firmware) failed\n",
1009 if (fw_get_builtin_firmware(firmware, name)) {
1010 dev_dbg(device, "firmware: using built-in firmware %s\n", name);
1011 return 0; /* assigned */
1014 ret = fw_lookup_and_allocate_buf(name, &fw_cache, &buf);
1017 * bind with 'buf' now to avoid warning in failure path
1018 * of requesting firmware.
1020 firmware->priv = buf;
1023 ret = sync_cached_firmware_buf(buf);
1025 fw_set_page_data(buf, firmware);
1026 return 0; /* assigned */
1032 return 1; /* need to load */
1035 static int assign_firmware_buf(struct firmware *fw, struct device *device,
1036 unsigned int opt_flags)
1038 struct firmware_buf *buf = fw->priv;
1040 mutex_lock(&fw_lock);
1041 if (!buf->size || is_fw_load_aborted(buf)) {
1042 mutex_unlock(&fw_lock);
1047 * add firmware name into devres list so that we can auto cache
1048 * and uncache firmware for device.
1050 * device may has been deleted already, but the problem
1051 * should be fixed in devres or driver core.
1053 /* don't cache firmware handled without uevent */
1054 if (device && (opt_flags & FW_OPT_UEVENT))
1055 fw_add_devm_name(device, buf->fw_id);
1058 * After caching firmware image is started, let it piggyback
1059 * on request firmware.
1061 if (buf->fwc->state == FW_LOADER_START_CACHE) {
1062 if (fw_cache_piggyback_on_request(buf->fw_id))
1063 kref_get(&buf->ref);
1066 /* pass the pages buffer to driver at the last minute */
1067 fw_set_page_data(buf, fw);
1068 mutex_unlock(&fw_lock);
1072 /* called from request_firmware() and request_firmware_work_func() */
1074 _request_firmware(const struct firmware **firmware_p, const char *name,
1075 struct device *device, unsigned int opt_flags)
1077 struct firmware *fw;
1084 ret = _request_firmware_prepare(&fw, name, device);
1085 if (ret <= 0) /* error or already assigned */
1089 timeout = firmware_loading_timeout();
1090 if (opt_flags & FW_OPT_NOWAIT) {
1091 timeout = usermodehelper_read_lock_wait(timeout);
1093 dev_dbg(device, "firmware: %s loading timed out\n",
1099 ret = usermodehelper_read_trylock();
1101 dev_err(device, "firmware: %s will not be loaded\n",
1107 ret = fw_get_filesystem_firmware(device, fw->priv);
1109 if (opt_flags & FW_OPT_FALLBACK) {
1111 "Direct firmware load failed with error %d\n",
1113 dev_warn(device, "Falling back to user helper\n");
1114 ret = fw_load_from_user_helper(fw, name, device,
1115 opt_flags, timeout);
1120 ret = assign_firmware_buf(fw, device, opt_flags);
1122 usermodehelper_read_unlock();
1126 release_firmware(fw);
1135 * request_firmware: - send firmware request and wait for it
1136 * @firmware_p: pointer to firmware image
1137 * @name: name of firmware file
1138 * @device: device for which firmware is being loaded
1140 * @firmware_p will be used to return a firmware image by the name
1141 * of @name for device @device.
1143 * Should be called from user context where sleeping is allowed.
1145 * @name will be used as $FIRMWARE in the uevent environment and
1146 * should be distinctive enough not to be confused with any other
1147 * firmware image for this or any other device.
1149 * Caller must hold the reference count of @device.
1151 * The function can be called safely inside device's suspend and
1155 request_firmware(const struct firmware **firmware_p, const char *name,
1156 struct device *device)
1160 /* Need to pin this module until return */
1161 __module_get(THIS_MODULE);
1162 ret = _request_firmware(firmware_p, name, device,
1163 FW_OPT_UEVENT | FW_OPT_FALLBACK);
1164 module_put(THIS_MODULE);
1167 EXPORT_SYMBOL(request_firmware);
1169 #ifdef CONFIG_FW_LOADER_USER_HELPER
1171 * request_firmware: - load firmware directly without usermode helper
1172 * @firmware_p: pointer to firmware image
1173 * @name: name of firmware file
1174 * @device: device for which firmware is being loaded
1176 * This function works pretty much like request_firmware(), but this doesn't
1177 * fall back to usermode helper even if the firmware couldn't be loaded
1178 * directly from fs. Hence it's useful for loading optional firmwares, which
1179 * aren't always present, without extra long timeouts of udev.
1181 int request_firmware_direct(const struct firmware **firmware_p,
1182 const char *name, struct device *device)
1185 __module_get(THIS_MODULE);
1186 ret = _request_firmware(firmware_p, name, device, FW_OPT_UEVENT);
1187 module_put(THIS_MODULE);
1190 EXPORT_SYMBOL_GPL(request_firmware_direct);
1194 * release_firmware: - release the resource associated with a firmware image
1195 * @fw: firmware resource to release
1197 void release_firmware(const struct firmware *fw)
1200 if (!fw_is_builtin_firmware(fw))
1201 firmware_free_data(fw);
1205 EXPORT_SYMBOL(release_firmware);
1208 struct firmware_work {
1209 struct work_struct work;
1210 struct module *module;
1212 struct device *device;
1214 void (*cont)(const struct firmware *fw, void *context);
1215 unsigned int opt_flags;
1218 static void request_firmware_work_func(struct work_struct *work)
1220 struct firmware_work *fw_work;
1221 const struct firmware *fw;
1223 fw_work = container_of(work, struct firmware_work, work);
1225 _request_firmware(&fw, fw_work->name, fw_work->device,
1226 fw_work->opt_flags);
1227 fw_work->cont(fw, fw_work->context);
1228 put_device(fw_work->device); /* taken in request_firmware_nowait() */
1230 module_put(fw_work->module);
1235 * request_firmware_nowait - asynchronous version of request_firmware
1236 * @module: module requesting the firmware
1237 * @uevent: sends uevent to copy the firmware image if this flag
1238 * is non-zero else the firmware copy must be done manually.
1239 * @name: name of firmware file
1240 * @device: device for which firmware is being loaded
1241 * @gfp: allocation flags
1242 * @context: will be passed over to @cont, and
1243 * @fw may be %NULL if firmware request fails.
1244 * @cont: function will be called asynchronously when the firmware
1247 * Caller must hold the reference count of @device.
1249 * Asynchronous variant of request_firmware() for user contexts:
1250 * - sleep for as small periods as possible since it may
1251 * increase kernel boot time of built-in device drivers
1252 * requesting firmware in their ->probe() methods, if
1253 * @gfp is GFP_KERNEL.
1255 * - can't sleep at all if @gfp is GFP_ATOMIC.
1258 request_firmware_nowait(
1259 struct module *module, bool uevent,
1260 const char *name, struct device *device, gfp_t gfp, void *context,
1261 void (*cont)(const struct firmware *fw, void *context))
1263 struct firmware_work *fw_work;
1265 fw_work = kzalloc(sizeof (struct firmware_work), gfp);
1269 fw_work->module = module;
1270 fw_work->name = name;
1271 fw_work->device = device;
1272 fw_work->context = context;
1273 fw_work->cont = cont;
1274 fw_work->opt_flags = FW_OPT_NOWAIT | FW_OPT_FALLBACK |
1275 (uevent ? FW_OPT_UEVENT : 0);
1277 if (!try_module_get(module)) {
1282 get_device(fw_work->device);
1283 INIT_WORK(&fw_work->work, request_firmware_work_func);
1284 schedule_work(&fw_work->work);
1287 EXPORT_SYMBOL(request_firmware_nowait);
1289 #ifdef CONFIG_PM_SLEEP
1290 static ASYNC_DOMAIN_EXCLUSIVE(fw_cache_domain);
1293 * cache_firmware - cache one firmware image in kernel memory space
1294 * @fw_name: the firmware image name
1296 * Cache firmware in kernel memory so that drivers can use it when
1297 * system isn't ready for them to request firmware image from userspace.
1298 * Once it returns successfully, driver can use request_firmware or its
1299 * nowait version to get the cached firmware without any interacting
1302 * Return 0 if the firmware image has been cached successfully
1303 * Return !0 otherwise
1306 static int cache_firmware(const char *fw_name)
1309 const struct firmware *fw;
1311 pr_debug("%s: %s\n", __func__, fw_name);
1313 ret = request_firmware(&fw, fw_name, NULL);
1317 pr_debug("%s: %s ret=%d\n", __func__, fw_name, ret);
1322 static struct firmware_buf *fw_lookup_buf(const char *fw_name)
1324 struct firmware_buf *tmp;
1325 struct firmware_cache *fwc = &fw_cache;
1327 spin_lock(&fwc->lock);
1328 tmp = __fw_lookup_buf(fw_name);
1329 spin_unlock(&fwc->lock);
1335 * uncache_firmware - remove one cached firmware image
1336 * @fw_name: the firmware image name
1338 * Uncache one firmware image which has been cached successfully
1341 * Return 0 if the firmware cache has been removed successfully
1342 * Return !0 otherwise
1345 static int uncache_firmware(const char *fw_name)
1347 struct firmware_buf *buf;
1350 pr_debug("%s: %s\n", __func__, fw_name);
1352 if (fw_get_builtin_firmware(&fw, fw_name))
1355 buf = fw_lookup_buf(fw_name);
1364 static struct fw_cache_entry *alloc_fw_cache_entry(const char *name)
1366 struct fw_cache_entry *fce;
1368 fce = kzalloc(sizeof(*fce) + strlen(name) + 1, GFP_ATOMIC);
1372 strcpy(fce->name, name);
1377 static int __fw_entry_found(const char *name)
1379 struct firmware_cache *fwc = &fw_cache;
1380 struct fw_cache_entry *fce;
1382 list_for_each_entry(fce, &fwc->fw_names, list) {
1383 if (!strcmp(fce->name, name))
1389 static int fw_cache_piggyback_on_request(const char *name)
1391 struct firmware_cache *fwc = &fw_cache;
1392 struct fw_cache_entry *fce;
1395 spin_lock(&fwc->name_lock);
1396 if (__fw_entry_found(name))
1399 fce = alloc_fw_cache_entry(name);
1402 list_add(&fce->list, &fwc->fw_names);
1403 pr_debug("%s: fw: %s\n", __func__, name);
1406 spin_unlock(&fwc->name_lock);
1410 static void free_fw_cache_entry(struct fw_cache_entry *fce)
1415 static void __async_dev_cache_fw_image(void *fw_entry,
1416 async_cookie_t cookie)
1418 struct fw_cache_entry *fce = fw_entry;
1419 struct firmware_cache *fwc = &fw_cache;
1422 ret = cache_firmware(fce->name);
1424 spin_lock(&fwc->name_lock);
1425 list_del(&fce->list);
1426 spin_unlock(&fwc->name_lock);
1428 free_fw_cache_entry(fce);
1432 /* called with dev->devres_lock held */
1433 static void dev_create_fw_entry(struct device *dev, void *res,
1436 struct fw_name_devm *fwn = res;
1437 const char *fw_name = fwn->name;
1438 struct list_head *head = data;
1439 struct fw_cache_entry *fce;
1441 fce = alloc_fw_cache_entry(fw_name);
1443 list_add(&fce->list, head);
1446 static int devm_name_match(struct device *dev, void *res,
1449 struct fw_name_devm *fwn = res;
1450 return (fwn->magic == (unsigned long)match_data);
1453 static void dev_cache_fw_image(struct device *dev, void *data)
1456 struct fw_cache_entry *fce;
1457 struct fw_cache_entry *fce_next;
1458 struct firmware_cache *fwc = &fw_cache;
1460 devres_for_each_res(dev, fw_name_devm_release,
1461 devm_name_match, &fw_cache,
1462 dev_create_fw_entry, &todo);
1464 list_for_each_entry_safe(fce, fce_next, &todo, list) {
1465 list_del(&fce->list);
1467 spin_lock(&fwc->name_lock);
1468 /* only one cache entry for one firmware */
1469 if (!__fw_entry_found(fce->name)) {
1470 list_add(&fce->list, &fwc->fw_names);
1472 free_fw_cache_entry(fce);
1475 spin_unlock(&fwc->name_lock);
1478 async_schedule_domain(__async_dev_cache_fw_image,
1484 static void __device_uncache_fw_images(void)
1486 struct firmware_cache *fwc = &fw_cache;
1487 struct fw_cache_entry *fce;
1489 spin_lock(&fwc->name_lock);
1490 while (!list_empty(&fwc->fw_names)) {
1491 fce = list_entry(fwc->fw_names.next,
1492 struct fw_cache_entry, list);
1493 list_del(&fce->list);
1494 spin_unlock(&fwc->name_lock);
1496 uncache_firmware(fce->name);
1497 free_fw_cache_entry(fce);
1499 spin_lock(&fwc->name_lock);
1501 spin_unlock(&fwc->name_lock);
1505 * device_cache_fw_images - cache devices' firmware
1507 * If one device called request_firmware or its nowait version
1508 * successfully before, the firmware names are recored into the
1509 * device's devres link list, so device_cache_fw_images can call
1510 * cache_firmware() to cache these firmwares for the device,
1511 * then the device driver can load its firmwares easily at
1512 * time when system is not ready to complete loading firmware.
1514 static void device_cache_fw_images(void)
1516 struct firmware_cache *fwc = &fw_cache;
1520 pr_debug("%s\n", __func__);
1522 /* cancel uncache work */
1523 cancel_delayed_work_sync(&fwc->work);
1526 * use small loading timeout for caching devices' firmware
1527 * because all these firmware images have been loaded
1528 * successfully at lease once, also system is ready for
1529 * completing firmware loading now. The maximum size of
1530 * firmware in current distributions is about 2M bytes,
1531 * so 10 secs should be enough.
1533 old_timeout = loading_timeout;
1534 loading_timeout = 10;
1536 mutex_lock(&fw_lock);
1537 fwc->state = FW_LOADER_START_CACHE;
1538 dpm_for_each_dev(NULL, dev_cache_fw_image);
1539 mutex_unlock(&fw_lock);
1541 /* wait for completion of caching firmware for all devices */
1542 async_synchronize_full_domain(&fw_cache_domain);
1544 loading_timeout = old_timeout;
1548 * device_uncache_fw_images - uncache devices' firmware
1550 * uncache all firmwares which have been cached successfully
1551 * by device_uncache_fw_images earlier
1553 static void device_uncache_fw_images(void)
1555 pr_debug("%s\n", __func__);
1556 __device_uncache_fw_images();
1559 static void device_uncache_fw_images_work(struct work_struct *work)
1561 device_uncache_fw_images();
1565 * device_uncache_fw_images_delay - uncache devices firmwares
1566 * @delay: number of milliseconds to delay uncache device firmwares
1568 * uncache all devices's firmwares which has been cached successfully
1569 * by device_cache_fw_images after @delay milliseconds.
1571 static void device_uncache_fw_images_delay(unsigned long delay)
1573 schedule_delayed_work(&fw_cache.work,
1574 msecs_to_jiffies(delay));
1577 static int fw_pm_notify(struct notifier_block *notify_block,
1578 unsigned long mode, void *unused)
1581 case PM_HIBERNATION_PREPARE:
1582 case PM_SUSPEND_PREPARE:
1583 case PM_RESTORE_PREPARE:
1584 kill_requests_without_uevent();
1585 device_cache_fw_images();
1588 case PM_POST_SUSPEND:
1589 case PM_POST_HIBERNATION:
1590 case PM_POST_RESTORE:
1592 * In case that system sleep failed and syscore_suspend is
1595 mutex_lock(&fw_lock);
1596 fw_cache.state = FW_LOADER_NO_CACHE;
1597 mutex_unlock(&fw_lock);
1599 device_uncache_fw_images_delay(10 * MSEC_PER_SEC);
1606 /* stop caching firmware once syscore_suspend is reached */
1607 static int fw_suspend(void)
1609 fw_cache.state = FW_LOADER_NO_CACHE;
1613 static struct syscore_ops fw_syscore_ops = {
1614 .suspend = fw_suspend,
1617 static int fw_cache_piggyback_on_request(const char *name)
1623 static void __init fw_cache_init(void)
1625 spin_lock_init(&fw_cache.lock);
1626 INIT_LIST_HEAD(&fw_cache.head);
1627 fw_cache.state = FW_LOADER_NO_CACHE;
1629 #ifdef CONFIG_PM_SLEEP
1630 spin_lock_init(&fw_cache.name_lock);
1631 INIT_LIST_HEAD(&fw_cache.fw_names);
1633 INIT_DELAYED_WORK(&fw_cache.work,
1634 device_uncache_fw_images_work);
1636 fw_cache.pm_notify.notifier_call = fw_pm_notify;
1637 register_pm_notifier(&fw_cache.pm_notify);
1639 register_syscore_ops(&fw_syscore_ops);
1643 static int __init firmware_class_init(void)
1646 #ifdef CONFIG_FW_LOADER_USER_HELPER
1647 register_reboot_notifier(&fw_shutdown_nb);
1648 return class_register(&firmware_class);
1654 static void __exit firmware_class_exit(void)
1656 #ifdef CONFIG_PM_SLEEP
1657 unregister_syscore_ops(&fw_syscore_ops);
1658 unregister_pm_notifier(&fw_cache.pm_notify);
1660 #ifdef CONFIG_FW_LOADER_USER_HELPER
1661 unregister_reboot_notifier(&fw_shutdown_nb);
1662 class_unregister(&firmware_class);
1666 fs_initcall(firmware_class_init);
1667 module_exit(firmware_class_exit);