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 struct firmware_cache {
100 /* firmware_buf instance will be added into the below list */
102 struct list_head head;
105 #ifdef CONFIG_PM_SLEEP
107 * Names of firmware images which have been cached successfully
108 * will be added into the below list so that device uncache
109 * helper can trace which firmware images have been cached
112 spinlock_t name_lock;
113 struct list_head fw_names;
115 struct delayed_work work;
117 struct notifier_block pm_notify;
121 struct firmware_buf {
123 struct list_head list;
124 struct completion completion;
125 struct firmware_cache *fwc;
126 unsigned long status;
129 #ifdef CONFIG_FW_LOADER_USER_HELPER
135 struct list_head pending_list;
140 struct fw_cache_entry {
141 struct list_head list;
145 struct fw_name_devm {
150 #define to_fwbuf(d) container_of(d, struct firmware_buf, ref)
152 #define FW_LOADER_NO_CACHE 0
153 #define FW_LOADER_START_CACHE 1
155 static int fw_cache_piggyback_on_request(const char *name);
157 /* fw_lock could be moved to 'struct firmware_priv' but since it is just
158 * guarding for corner cases a global lock should be OK */
159 static DEFINE_MUTEX(fw_lock);
161 static struct firmware_cache fw_cache;
163 static struct firmware_buf *__allocate_fw_buf(const char *fw_name,
164 struct firmware_cache *fwc)
166 struct firmware_buf *buf;
168 buf = kzalloc(sizeof(*buf) + strlen(fw_name) + 1 , GFP_ATOMIC);
173 kref_init(&buf->ref);
174 strcpy(buf->fw_id, fw_name);
176 init_completion(&buf->completion);
177 #ifdef CONFIG_FW_LOADER_USER_HELPER
178 INIT_LIST_HEAD(&buf->pending_list);
181 pr_debug("%s: fw-%s buf=%p\n", __func__, fw_name, buf);
186 static struct firmware_buf *__fw_lookup_buf(const char *fw_name)
188 struct firmware_buf *tmp;
189 struct firmware_cache *fwc = &fw_cache;
191 list_for_each_entry(tmp, &fwc->head, list)
192 if (!strcmp(tmp->fw_id, fw_name))
197 static int fw_lookup_and_allocate_buf(const char *fw_name,
198 struct firmware_cache *fwc,
199 struct firmware_buf **buf)
201 struct firmware_buf *tmp;
203 spin_lock(&fwc->lock);
204 tmp = __fw_lookup_buf(fw_name);
207 spin_unlock(&fwc->lock);
211 tmp = __allocate_fw_buf(fw_name, fwc);
213 list_add(&tmp->list, &fwc->head);
214 spin_unlock(&fwc->lock);
218 return tmp ? 0 : -ENOMEM;
221 static struct firmware_buf *fw_lookup_buf(const char *fw_name)
223 struct firmware_buf *tmp;
224 struct firmware_cache *fwc = &fw_cache;
226 spin_lock(&fwc->lock);
227 tmp = __fw_lookup_buf(fw_name);
228 spin_unlock(&fwc->lock);
233 static void __fw_free_buf(struct kref *ref)
235 struct firmware_buf *buf = to_fwbuf(ref);
236 struct firmware_cache *fwc = buf->fwc;
238 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
239 __func__, buf->fw_id, buf, buf->data,
240 (unsigned int)buf->size);
242 list_del(&buf->list);
243 spin_unlock(&fwc->lock);
245 #ifdef CONFIG_FW_LOADER_USER_HELPER
246 if (buf->is_paged_buf) {
249 for (i = 0; i < buf->nr_pages; i++)
250 __free_page(buf->pages[i]);
258 static void fw_free_buf(struct firmware_buf *buf)
260 struct firmware_cache *fwc = buf->fwc;
261 spin_lock(&fwc->lock);
262 if (!kref_put(&buf->ref, __fw_free_buf))
263 spin_unlock(&fwc->lock);
266 /* direct firmware loading support */
267 static char fw_path_para[256];
268 static const char * const fw_path[] = {
270 "/lib/firmware/updates/" UTS_RELEASE,
271 "/lib/firmware/updates",
272 "/lib/firmware/" UTS_RELEASE,
277 * Typical usage is that passing 'firmware_class.path=$CUSTOMIZED_PATH'
278 * from kernel command line because firmware_class is generally built in
279 * kernel instead of module.
281 module_param_string(path, fw_path_para, sizeof(fw_path_para), 0644);
282 MODULE_PARM_DESC(path, "customized firmware image search path with a higher priority than default path");
284 /* Don't inline this: 'struct kstat' is biggish */
285 static noinline_for_stack long fw_file_size(struct file *file)
288 if (vfs_getattr(&file->f_path, &st))
290 if (!S_ISREG(st.mode))
292 if (st.size != (long)st.size)
297 static bool fw_read_file_contents(struct file *file, struct firmware_buf *fw_buf)
302 size = fw_file_size(file);
308 if (kernel_read(file, 0, buf, size) != size) {
317 static bool fw_get_filesystem_firmware(struct device *device,
318 struct firmware_buf *buf)
321 bool success = false;
322 char *path = __getname();
324 for (i = 0; i < ARRAY_SIZE(fw_path); i++) {
327 /* skip the unset customized path */
331 snprintf(path, PATH_MAX, "%s/%s", fw_path[i], buf->fw_id);
333 file = filp_open(path, O_RDONLY, 0);
336 success = fw_read_file_contents(file, buf);
344 dev_dbg(device, "firmware: direct-loading firmware %s\n",
346 mutex_lock(&fw_lock);
347 set_bit(FW_STATUS_DONE, &buf->status);
348 complete_all(&buf->completion);
349 mutex_unlock(&fw_lock);
355 /* firmware holds the ownership of pages */
356 static void firmware_free_data(const struct firmware *fw)
358 /* Loaded directly? */
363 fw_free_buf(fw->priv);
366 /* store the pages buffer info firmware from buf */
367 static void fw_set_page_data(struct firmware_buf *buf, struct firmware *fw)
370 #ifdef CONFIG_FW_LOADER_USER_HELPER
371 fw->pages = buf->pages;
373 fw->size = buf->size;
374 fw->data = buf->data;
376 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
377 __func__, buf->fw_id, buf, buf->data,
378 (unsigned int)buf->size);
381 #ifdef CONFIG_PM_SLEEP
382 static void fw_name_devm_release(struct device *dev, void *res)
384 struct fw_name_devm *fwn = res;
386 if (fwn->magic == (unsigned long)&fw_cache)
387 pr_debug("%s: fw_name-%s devm-%p released\n",
388 __func__, fwn->name, res);
391 static int fw_devm_match(struct device *dev, void *res,
394 struct fw_name_devm *fwn = res;
396 return (fwn->magic == (unsigned long)&fw_cache) &&
397 !strcmp(fwn->name, match_data);
400 static struct fw_name_devm *fw_find_devm_name(struct device *dev,
403 struct fw_name_devm *fwn;
405 fwn = devres_find(dev, fw_name_devm_release,
406 fw_devm_match, (void *)name);
410 /* add firmware name into devres list */
411 static int fw_add_devm_name(struct device *dev, const char *name)
413 struct fw_name_devm *fwn;
415 fwn = fw_find_devm_name(dev, name);
419 fwn = devres_alloc(fw_name_devm_release, sizeof(struct fw_name_devm) +
420 strlen(name) + 1, GFP_KERNEL);
424 fwn->magic = (unsigned long)&fw_cache;
425 strcpy(fwn->name, name);
426 devres_add(dev, fwn);
431 static int fw_add_devm_name(struct device *dev, const char *name)
439 * user-mode helper code
441 #ifdef CONFIG_FW_LOADER_USER_HELPER
442 struct firmware_priv {
443 struct delayed_work timeout_work;
446 struct firmware_buf *buf;
450 static struct firmware_priv *to_firmware_priv(struct device *dev)
452 return container_of(dev, struct firmware_priv, dev);
455 static void __fw_load_abort(struct firmware_buf *buf)
458 * There is a small window in which user can write to 'loading'
459 * between loading done and disappearance of 'loading'
461 if (test_bit(FW_STATUS_DONE, &buf->status))
464 list_del_init(&buf->pending_list);
465 set_bit(FW_STATUS_ABORT, &buf->status);
466 complete_all(&buf->completion);
469 static void fw_load_abort(struct firmware_priv *fw_priv)
471 struct firmware_buf *buf = fw_priv->buf;
473 __fw_load_abort(buf);
475 /* avoid user action after loading abort */
479 #define is_fw_load_aborted(buf) \
480 test_bit(FW_STATUS_ABORT, &(buf)->status)
482 static LIST_HEAD(pending_fw_head);
484 /* reboot notifier for avoid deadlock with usermode_lock */
485 static int fw_shutdown_notify(struct notifier_block *unused1,
486 unsigned long unused2, void *unused3)
488 mutex_lock(&fw_lock);
489 while (!list_empty(&pending_fw_head))
490 __fw_load_abort(list_first_entry(&pending_fw_head,
493 mutex_unlock(&fw_lock);
497 static struct notifier_block fw_shutdown_nb = {
498 .notifier_call = fw_shutdown_notify,
501 static ssize_t firmware_timeout_show(struct class *class,
502 struct class_attribute *attr,
505 return sprintf(buf, "%d\n", loading_timeout);
509 * firmware_timeout_store - set number of seconds to wait for firmware
510 * @class: device class pointer
511 * @attr: device attribute pointer
512 * @buf: buffer to scan for timeout value
513 * @count: number of bytes in @buf
515 * Sets the number of seconds to wait for the firmware. Once
516 * this expires an error will be returned to the driver and no
517 * firmware will be provided.
519 * Note: zero means 'wait forever'.
521 static ssize_t firmware_timeout_store(struct class *class,
522 struct class_attribute *attr,
523 const char *buf, size_t count)
525 loading_timeout = simple_strtol(buf, NULL, 10);
526 if (loading_timeout < 0)
532 static struct class_attribute firmware_class_attrs[] = {
533 __ATTR(timeout, S_IWUSR | S_IRUGO,
534 firmware_timeout_show, firmware_timeout_store),
538 static void fw_dev_release(struct device *dev)
540 struct firmware_priv *fw_priv = to_firmware_priv(dev);
545 static int firmware_uevent(struct device *dev, struct kobj_uevent_env *env)
547 struct firmware_priv *fw_priv = to_firmware_priv(dev);
549 if (add_uevent_var(env, "FIRMWARE=%s", fw_priv->buf->fw_id))
551 if (add_uevent_var(env, "TIMEOUT=%i", loading_timeout))
553 if (add_uevent_var(env, "ASYNC=%d", fw_priv->nowait))
559 static struct class firmware_class = {
561 .class_attrs = firmware_class_attrs,
562 .dev_uevent = firmware_uevent,
563 .dev_release = fw_dev_release,
566 static ssize_t firmware_loading_show(struct device *dev,
567 struct device_attribute *attr, char *buf)
569 struct firmware_priv *fw_priv = to_firmware_priv(dev);
572 mutex_lock(&fw_lock);
574 loading = test_bit(FW_STATUS_LOADING, &fw_priv->buf->status);
575 mutex_unlock(&fw_lock);
577 return sprintf(buf, "%d\n", loading);
580 /* Some architectures don't have PAGE_KERNEL_RO */
581 #ifndef PAGE_KERNEL_RO
582 #define PAGE_KERNEL_RO PAGE_KERNEL
585 /* one pages buffer should be mapped/unmapped only once */
586 static int fw_map_pages_buf(struct firmware_buf *buf)
588 if (!buf->is_paged_buf)
593 buf->data = vmap(buf->pages, buf->nr_pages, 0, PAGE_KERNEL_RO);
600 * firmware_loading_store - set value in the 'loading' control file
601 * @dev: device pointer
602 * @attr: device attribute pointer
603 * @buf: buffer to scan for loading control value
604 * @count: number of bytes in @buf
606 * The relevant values are:
608 * 1: Start a load, discarding any previous partial load.
609 * 0: Conclude the load and hand the data to the driver code.
610 * -1: Conclude the load with an error and discard any written data.
612 static ssize_t firmware_loading_store(struct device *dev,
613 struct device_attribute *attr,
614 const char *buf, size_t count)
616 struct firmware_priv *fw_priv = to_firmware_priv(dev);
617 struct firmware_buf *fw_buf;
618 int loading = simple_strtol(buf, NULL, 10);
621 mutex_lock(&fw_lock);
622 fw_buf = fw_priv->buf;
628 /* discarding any previous partial load */
629 if (!test_bit(FW_STATUS_DONE, &fw_buf->status)) {
630 for (i = 0; i < fw_buf->nr_pages; i++)
631 __free_page(fw_buf->pages[i]);
632 kfree(fw_buf->pages);
633 fw_buf->pages = NULL;
634 fw_buf->page_array_size = 0;
635 fw_buf->nr_pages = 0;
636 set_bit(FW_STATUS_LOADING, &fw_buf->status);
640 if (test_bit(FW_STATUS_LOADING, &fw_buf->status)) {
641 set_bit(FW_STATUS_DONE, &fw_buf->status);
642 clear_bit(FW_STATUS_LOADING, &fw_buf->status);
645 * Several loading requests may be pending on
646 * one same firmware buf, so let all requests
647 * see the mapped 'buf->data' once the loading
650 fw_map_pages_buf(fw_buf);
651 list_del_init(&fw_buf->pending_list);
652 complete_all(&fw_buf->completion);
657 dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading);
660 fw_load_abort(fw_priv);
664 mutex_unlock(&fw_lock);
668 static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store);
670 static ssize_t firmware_data_read(struct file *filp, struct kobject *kobj,
671 struct bin_attribute *bin_attr,
672 char *buffer, loff_t offset, size_t count)
674 struct device *dev = kobj_to_dev(kobj);
675 struct firmware_priv *fw_priv = to_firmware_priv(dev);
676 struct firmware_buf *buf;
679 mutex_lock(&fw_lock);
681 if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) {
685 if (offset > buf->size) {
689 if (count > buf->size - offset)
690 count = buf->size - offset;
696 int page_nr = offset >> PAGE_SHIFT;
697 int page_ofs = offset & (PAGE_SIZE-1);
698 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
700 page_data = kmap(buf->pages[page_nr]);
702 memcpy(buffer, page_data + page_ofs, page_cnt);
704 kunmap(buf->pages[page_nr]);
710 mutex_unlock(&fw_lock);
714 static int fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
716 struct firmware_buf *buf = fw_priv->buf;
717 int pages_needed = ALIGN(min_size, PAGE_SIZE) >> PAGE_SHIFT;
719 /* If the array of pages is too small, grow it... */
720 if (buf->page_array_size < pages_needed) {
721 int new_array_size = max(pages_needed,
722 buf->page_array_size * 2);
723 struct page **new_pages;
725 new_pages = kmalloc(new_array_size * sizeof(void *),
728 fw_load_abort(fw_priv);
731 memcpy(new_pages, buf->pages,
732 buf->page_array_size * sizeof(void *));
733 memset(&new_pages[buf->page_array_size], 0, sizeof(void *) *
734 (new_array_size - buf->page_array_size));
736 buf->pages = new_pages;
737 buf->page_array_size = new_array_size;
740 while (buf->nr_pages < pages_needed) {
741 buf->pages[buf->nr_pages] =
742 alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
744 if (!buf->pages[buf->nr_pages]) {
745 fw_load_abort(fw_priv);
754 * firmware_data_write - write method for firmware
755 * @filp: open sysfs file
756 * @kobj: kobject for the device
757 * @bin_attr: bin_attr structure
758 * @buffer: buffer being written
759 * @offset: buffer offset for write in total data store area
760 * @count: buffer size
762 * Data written to the 'data' attribute will be later handed to
763 * the driver as a firmware image.
765 static ssize_t firmware_data_write(struct file *filp, struct kobject *kobj,
766 struct bin_attribute *bin_attr,
767 char *buffer, loff_t offset, size_t count)
769 struct device *dev = kobj_to_dev(kobj);
770 struct firmware_priv *fw_priv = to_firmware_priv(dev);
771 struct firmware_buf *buf;
774 if (!capable(CAP_SYS_RAWIO))
777 mutex_lock(&fw_lock);
779 if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) {
784 retval = fw_realloc_buffer(fw_priv, offset + count);
792 int page_nr = offset >> PAGE_SHIFT;
793 int page_ofs = offset & (PAGE_SIZE - 1);
794 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
796 page_data = kmap(buf->pages[page_nr]);
798 memcpy(page_data + page_ofs, buffer, page_cnt);
800 kunmap(buf->pages[page_nr]);
806 buf->size = max_t(size_t, offset, buf->size);
808 mutex_unlock(&fw_lock);
812 static struct bin_attribute firmware_attr_data = {
813 .attr = { .name = "data", .mode = 0644 },
815 .read = firmware_data_read,
816 .write = firmware_data_write,
819 static void firmware_class_timeout_work(struct work_struct *work)
821 struct firmware_priv *fw_priv = container_of(work,
822 struct firmware_priv, timeout_work.work);
824 mutex_lock(&fw_lock);
825 fw_load_abort(fw_priv);
826 mutex_unlock(&fw_lock);
829 static struct firmware_priv *
830 fw_create_instance(struct firmware *firmware, const char *fw_name,
831 struct device *device, bool uevent, bool nowait)
833 struct firmware_priv *fw_priv;
834 struct device *f_dev;
836 fw_priv = kzalloc(sizeof(*fw_priv), GFP_KERNEL);
838 dev_err(device, "%s: kmalloc failed\n", __func__);
839 fw_priv = ERR_PTR(-ENOMEM);
843 fw_priv->nowait = nowait;
844 fw_priv->fw = firmware;
845 INIT_DELAYED_WORK(&fw_priv->timeout_work,
846 firmware_class_timeout_work);
848 f_dev = &fw_priv->dev;
850 device_initialize(f_dev);
851 dev_set_name(f_dev, "%s", fw_name);
852 f_dev->parent = device;
853 f_dev->class = &firmware_class;
858 /* load a firmware via user helper */
859 static int _request_firmware_load(struct firmware_priv *fw_priv, bool uevent,
863 struct device *f_dev = &fw_priv->dev;
864 struct firmware_buf *buf = fw_priv->buf;
866 /* fall back on userspace loading */
867 buf->is_paged_buf = true;
869 dev_set_uevent_suppress(f_dev, true);
871 retval = device_add(f_dev);
873 dev_err(f_dev, "%s: device_register failed\n", __func__);
877 retval = device_create_bin_file(f_dev, &firmware_attr_data);
879 dev_err(f_dev, "%s: sysfs_create_bin_file failed\n", __func__);
883 retval = device_create_file(f_dev, &dev_attr_loading);
885 dev_err(f_dev, "%s: device_create_file failed\n", __func__);
886 goto err_del_bin_attr;
890 buf->need_uevent = true;
891 dev_set_uevent_suppress(f_dev, false);
892 dev_dbg(f_dev, "firmware: requesting %s\n", buf->fw_id);
893 if (timeout != MAX_SCHEDULE_TIMEOUT)
894 schedule_delayed_work(&fw_priv->timeout_work, timeout);
896 kobject_uevent(&fw_priv->dev.kobj, KOBJ_ADD);
899 mutex_lock(&fw_lock);
900 list_add(&buf->pending_list, &pending_fw_head);
901 mutex_unlock(&fw_lock);
903 wait_for_completion(&buf->completion);
905 cancel_delayed_work_sync(&fw_priv->timeout_work);
907 device_remove_file(f_dev, &dev_attr_loading);
909 device_remove_bin_file(f_dev, &firmware_attr_data);
917 static int fw_load_from_user_helper(struct firmware *firmware,
918 const char *name, struct device *device,
919 bool uevent, bool nowait, long timeout)
921 struct firmware_priv *fw_priv;
923 fw_priv = fw_create_instance(firmware, name, device, uevent, nowait);
925 return PTR_ERR(fw_priv);
927 fw_priv->buf = firmware->priv;
928 return _request_firmware_load(fw_priv, uevent, timeout);
931 #ifdef CONFIG_PM_SLEEP
932 /* kill pending requests without uevent to avoid blocking suspend */
933 static void kill_requests_without_uevent(void)
935 struct firmware_buf *buf;
936 struct firmware_buf *next;
938 mutex_lock(&fw_lock);
939 list_for_each_entry_safe(buf, next, &pending_fw_head, pending_list) {
940 if (!buf->need_uevent)
941 __fw_load_abort(buf);
943 mutex_unlock(&fw_lock);
947 #else /* CONFIG_FW_LOADER_USER_HELPER */
949 fw_load_from_user_helper(struct firmware *firmware, const char *name,
950 struct device *device, bool uevent, bool nowait,
956 /* No abort during direct loading */
957 #define is_fw_load_aborted(buf) false
959 #ifdef CONFIG_PM_SLEEP
960 static inline void kill_requests_without_uevent(void) { }
963 #endif /* CONFIG_FW_LOADER_USER_HELPER */
966 /* wait until the shared firmware_buf becomes ready (or error) */
967 static int sync_cached_firmware_buf(struct firmware_buf *buf)
971 mutex_lock(&fw_lock);
972 while (!test_bit(FW_STATUS_DONE, &buf->status)) {
973 if (is_fw_load_aborted(buf)) {
977 mutex_unlock(&fw_lock);
978 wait_for_completion(&buf->completion);
979 mutex_lock(&fw_lock);
981 mutex_unlock(&fw_lock);
985 /* prepare firmware and firmware_buf structs;
986 * return 0 if a firmware is already assigned, 1 if need to load one,
987 * or a negative error code
990 _request_firmware_prepare(struct firmware **firmware_p, const char *name,
991 struct device *device)
993 struct firmware *firmware;
994 struct firmware_buf *buf;
997 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
999 dev_err(device, "%s: kmalloc(struct firmware) failed\n",
1004 if (fw_get_builtin_firmware(firmware, name)) {
1005 dev_dbg(device, "firmware: using built-in firmware %s\n", name);
1006 return 0; /* assigned */
1009 ret = fw_lookup_and_allocate_buf(name, &fw_cache, &buf);
1012 * bind with 'buf' now to avoid warning in failure path
1013 * of requesting firmware.
1015 firmware->priv = buf;
1018 ret = sync_cached_firmware_buf(buf);
1020 fw_set_page_data(buf, firmware);
1021 return 0; /* assigned */
1027 return 1; /* need to load */
1030 static int assign_firmware_buf(struct firmware *fw, struct device *device,
1033 struct firmware_buf *buf = fw->priv;
1035 mutex_lock(&fw_lock);
1036 if (!buf->size || is_fw_load_aborted(buf)) {
1037 mutex_unlock(&fw_lock);
1042 * add firmware name into devres list so that we can auto cache
1043 * and uncache firmware for device.
1045 * device may has been deleted already, but the problem
1046 * should be fixed in devres or driver core.
1048 if (device && !skip_cache)
1049 fw_add_devm_name(device, buf->fw_id);
1052 * After caching firmware image is started, let it piggyback
1053 * on request firmware.
1055 if (buf->fwc->state == FW_LOADER_START_CACHE) {
1056 if (fw_cache_piggyback_on_request(buf->fw_id))
1057 kref_get(&buf->ref);
1060 /* pass the pages buffer to driver at the last minute */
1061 fw_set_page_data(buf, fw);
1062 mutex_unlock(&fw_lock);
1066 /* called from request_firmware() and request_firmware_work_func() */
1068 _request_firmware(const struct firmware **firmware_p, const char *name,
1069 struct device *device, bool uevent, bool nowait)
1071 struct firmware *fw;
1078 ret = _request_firmware_prepare(&fw, name, device);
1079 if (ret <= 0) /* error or already assigned */
1083 timeout = firmware_loading_timeout();
1085 timeout = usermodehelper_read_lock_wait(timeout);
1087 dev_dbg(device, "firmware: %s loading timed out\n",
1093 ret = usermodehelper_read_trylock();
1095 dev_err(device, "firmware: %s will not be loaded\n",
1101 if (!fw_get_filesystem_firmware(device, fw->priv))
1102 ret = fw_load_from_user_helper(fw, name, device,
1103 uevent, nowait, timeout);
1105 /* don't cache firmware handled without uevent */
1107 ret = assign_firmware_buf(fw, device, !uevent);
1109 usermodehelper_read_unlock();
1113 release_firmware(fw);
1122 * request_firmware: - send firmware request and wait for it
1123 * @firmware_p: pointer to firmware image
1124 * @name: name of firmware file
1125 * @device: device for which firmware is being loaded
1127 * @firmware_p will be used to return a firmware image by the name
1128 * of @name for device @device.
1130 * Should be called from user context where sleeping is allowed.
1132 * @name will be used as $FIRMWARE in the uevent environment and
1133 * should be distinctive enough not to be confused with any other
1134 * firmware image for this or any other device.
1136 * Caller must hold the reference count of @device.
1138 * The function can be called safely inside device's suspend and
1142 request_firmware(const struct firmware **firmware_p, const char *name,
1143 struct device *device)
1147 /* Need to pin this module until return */
1148 __module_get(THIS_MODULE);
1149 ret = _request_firmware(firmware_p, name, device, true, false);
1150 module_put(THIS_MODULE);
1153 EXPORT_SYMBOL(request_firmware);
1156 * release_firmware: - release the resource associated with a firmware image
1157 * @fw: firmware resource to release
1159 void release_firmware(const struct firmware *fw)
1162 if (!fw_is_builtin_firmware(fw))
1163 firmware_free_data(fw);
1167 EXPORT_SYMBOL(release_firmware);
1170 struct firmware_work {
1171 struct work_struct work;
1172 struct module *module;
1174 struct device *device;
1176 void (*cont)(const struct firmware *fw, void *context);
1180 static void request_firmware_work_func(struct work_struct *work)
1182 struct firmware_work *fw_work;
1183 const struct firmware *fw;
1185 fw_work = container_of(work, struct firmware_work, work);
1187 _request_firmware(&fw, fw_work->name, fw_work->device,
1188 fw_work->uevent, true);
1189 fw_work->cont(fw, fw_work->context);
1190 put_device(fw_work->device); /* taken in request_firmware_nowait() */
1192 module_put(fw_work->module);
1197 * request_firmware_nowait - asynchronous version of request_firmware
1198 * @module: module requesting the firmware
1199 * @uevent: sends uevent to copy the firmware image if this flag
1200 * is non-zero else the firmware copy must be done manually.
1201 * @name: name of firmware file
1202 * @device: device for which firmware is being loaded
1203 * @gfp: allocation flags
1204 * @context: will be passed over to @cont, and
1205 * @fw may be %NULL if firmware request fails.
1206 * @cont: function will be called asynchronously when the firmware
1209 * Caller must hold the reference count of @device.
1211 * Asynchronous variant of request_firmware() for user contexts:
1212 * - sleep for as small periods as possible since it may
1213 * increase kernel boot time of built-in device drivers
1214 * requesting firmware in their ->probe() methods, if
1215 * @gfp is GFP_KERNEL.
1217 * - can't sleep at all if @gfp is GFP_ATOMIC.
1220 request_firmware_nowait(
1221 struct module *module, bool uevent,
1222 const char *name, struct device *device, gfp_t gfp, void *context,
1223 void (*cont)(const struct firmware *fw, void *context))
1225 struct firmware_work *fw_work;
1227 fw_work = kzalloc(sizeof (struct firmware_work), gfp);
1231 fw_work->module = module;
1232 fw_work->name = name;
1233 fw_work->device = device;
1234 fw_work->context = context;
1235 fw_work->cont = cont;
1236 fw_work->uevent = uevent;
1238 if (!try_module_get(module)) {
1243 get_device(fw_work->device);
1244 INIT_WORK(&fw_work->work, request_firmware_work_func);
1245 schedule_work(&fw_work->work);
1248 EXPORT_SYMBOL(request_firmware_nowait);
1250 #ifdef CONFIG_PM_SLEEP
1251 static ASYNC_DOMAIN_EXCLUSIVE(fw_cache_domain);
1254 * cache_firmware - cache one firmware image in kernel memory space
1255 * @fw_name: the firmware image name
1257 * Cache firmware in kernel memory so that drivers can use it when
1258 * system isn't ready for them to request firmware image from userspace.
1259 * Once it returns successfully, driver can use request_firmware or its
1260 * nowait version to get the cached firmware without any interacting
1263 * Return 0 if the firmware image has been cached successfully
1264 * Return !0 otherwise
1267 static int cache_firmware(const char *fw_name)
1270 const struct firmware *fw;
1272 pr_debug("%s: %s\n", __func__, fw_name);
1274 ret = request_firmware(&fw, fw_name, NULL);
1278 pr_debug("%s: %s ret=%d\n", __func__, fw_name, ret);
1284 * uncache_firmware - remove one cached firmware image
1285 * @fw_name: the firmware image name
1287 * Uncache one firmware image which has been cached successfully
1290 * Return 0 if the firmware cache has been removed successfully
1291 * Return !0 otherwise
1294 static int uncache_firmware(const char *fw_name)
1296 struct firmware_buf *buf;
1299 pr_debug("%s: %s\n", __func__, fw_name);
1301 if (fw_get_builtin_firmware(&fw, fw_name))
1304 buf = fw_lookup_buf(fw_name);
1313 static struct fw_cache_entry *alloc_fw_cache_entry(const char *name)
1315 struct fw_cache_entry *fce;
1317 fce = kzalloc(sizeof(*fce) + strlen(name) + 1, GFP_ATOMIC);
1321 strcpy(fce->name, name);
1326 static int __fw_entry_found(const char *name)
1328 struct firmware_cache *fwc = &fw_cache;
1329 struct fw_cache_entry *fce;
1331 list_for_each_entry(fce, &fwc->fw_names, list) {
1332 if (!strcmp(fce->name, name))
1338 static int fw_cache_piggyback_on_request(const char *name)
1340 struct firmware_cache *fwc = &fw_cache;
1341 struct fw_cache_entry *fce;
1344 spin_lock(&fwc->name_lock);
1345 if (__fw_entry_found(name))
1348 fce = alloc_fw_cache_entry(name);
1351 list_add(&fce->list, &fwc->fw_names);
1352 pr_debug("%s: fw: %s\n", __func__, name);
1355 spin_unlock(&fwc->name_lock);
1359 static void free_fw_cache_entry(struct fw_cache_entry *fce)
1364 static void __async_dev_cache_fw_image(void *fw_entry,
1365 async_cookie_t cookie)
1367 struct fw_cache_entry *fce = fw_entry;
1368 struct firmware_cache *fwc = &fw_cache;
1371 ret = cache_firmware(fce->name);
1373 spin_lock(&fwc->name_lock);
1374 list_del(&fce->list);
1375 spin_unlock(&fwc->name_lock);
1377 free_fw_cache_entry(fce);
1381 /* called with dev->devres_lock held */
1382 static void dev_create_fw_entry(struct device *dev, void *res,
1385 struct fw_name_devm *fwn = res;
1386 const char *fw_name = fwn->name;
1387 struct list_head *head = data;
1388 struct fw_cache_entry *fce;
1390 fce = alloc_fw_cache_entry(fw_name);
1392 list_add(&fce->list, head);
1395 static int devm_name_match(struct device *dev, void *res,
1398 struct fw_name_devm *fwn = res;
1399 return (fwn->magic == (unsigned long)match_data);
1402 static void dev_cache_fw_image(struct device *dev, void *data)
1405 struct fw_cache_entry *fce;
1406 struct fw_cache_entry *fce_next;
1407 struct firmware_cache *fwc = &fw_cache;
1409 devres_for_each_res(dev, fw_name_devm_release,
1410 devm_name_match, &fw_cache,
1411 dev_create_fw_entry, &todo);
1413 list_for_each_entry_safe(fce, fce_next, &todo, list) {
1414 list_del(&fce->list);
1416 spin_lock(&fwc->name_lock);
1417 /* only one cache entry for one firmware */
1418 if (!__fw_entry_found(fce->name)) {
1419 list_add(&fce->list, &fwc->fw_names);
1421 free_fw_cache_entry(fce);
1424 spin_unlock(&fwc->name_lock);
1427 async_schedule_domain(__async_dev_cache_fw_image,
1433 static void __device_uncache_fw_images(void)
1435 struct firmware_cache *fwc = &fw_cache;
1436 struct fw_cache_entry *fce;
1438 spin_lock(&fwc->name_lock);
1439 while (!list_empty(&fwc->fw_names)) {
1440 fce = list_entry(fwc->fw_names.next,
1441 struct fw_cache_entry, list);
1442 list_del(&fce->list);
1443 spin_unlock(&fwc->name_lock);
1445 uncache_firmware(fce->name);
1446 free_fw_cache_entry(fce);
1448 spin_lock(&fwc->name_lock);
1450 spin_unlock(&fwc->name_lock);
1454 * device_cache_fw_images - cache devices' firmware
1456 * If one device called request_firmware or its nowait version
1457 * successfully before, the firmware names are recored into the
1458 * device's devres link list, so device_cache_fw_images can call
1459 * cache_firmware() to cache these firmwares for the device,
1460 * then the device driver can load its firmwares easily at
1461 * time when system is not ready to complete loading firmware.
1463 static void device_cache_fw_images(void)
1465 struct firmware_cache *fwc = &fw_cache;
1469 pr_debug("%s\n", __func__);
1471 /* cancel uncache work */
1472 cancel_delayed_work_sync(&fwc->work);
1475 * use small loading timeout for caching devices' firmware
1476 * because all these firmware images have been loaded
1477 * successfully at lease once, also system is ready for
1478 * completing firmware loading now. The maximum size of
1479 * firmware in current distributions is about 2M bytes,
1480 * so 10 secs should be enough.
1482 old_timeout = loading_timeout;
1483 loading_timeout = 10;
1485 mutex_lock(&fw_lock);
1486 fwc->state = FW_LOADER_START_CACHE;
1487 dpm_for_each_dev(NULL, dev_cache_fw_image);
1488 mutex_unlock(&fw_lock);
1490 /* wait for completion of caching firmware for all devices */
1491 async_synchronize_full_domain(&fw_cache_domain);
1493 loading_timeout = old_timeout;
1497 * device_uncache_fw_images - uncache devices' firmware
1499 * uncache all firmwares which have been cached successfully
1500 * by device_uncache_fw_images earlier
1502 static void device_uncache_fw_images(void)
1504 pr_debug("%s\n", __func__);
1505 __device_uncache_fw_images();
1508 static void device_uncache_fw_images_work(struct work_struct *work)
1510 device_uncache_fw_images();
1514 * device_uncache_fw_images_delay - uncache devices firmwares
1515 * @delay: number of milliseconds to delay uncache device firmwares
1517 * uncache all devices's firmwares which has been cached successfully
1518 * by device_cache_fw_images after @delay milliseconds.
1520 static void device_uncache_fw_images_delay(unsigned long delay)
1522 schedule_delayed_work(&fw_cache.work,
1523 msecs_to_jiffies(delay));
1526 static int fw_pm_notify(struct notifier_block *notify_block,
1527 unsigned long mode, void *unused)
1530 case PM_HIBERNATION_PREPARE:
1531 case PM_SUSPEND_PREPARE:
1532 kill_requests_without_uevent();
1533 device_cache_fw_images();
1536 case PM_POST_SUSPEND:
1537 case PM_POST_HIBERNATION:
1538 case PM_POST_RESTORE:
1540 * In case that system sleep failed and syscore_suspend is
1543 mutex_lock(&fw_lock);
1544 fw_cache.state = FW_LOADER_NO_CACHE;
1545 mutex_unlock(&fw_lock);
1547 device_uncache_fw_images_delay(10 * MSEC_PER_SEC);
1554 /* stop caching firmware once syscore_suspend is reached */
1555 static int fw_suspend(void)
1557 fw_cache.state = FW_LOADER_NO_CACHE;
1561 static struct syscore_ops fw_syscore_ops = {
1562 .suspend = fw_suspend,
1565 static int fw_cache_piggyback_on_request(const char *name)
1571 static void __init fw_cache_init(void)
1573 spin_lock_init(&fw_cache.lock);
1574 INIT_LIST_HEAD(&fw_cache.head);
1575 fw_cache.state = FW_LOADER_NO_CACHE;
1577 #ifdef CONFIG_PM_SLEEP
1578 spin_lock_init(&fw_cache.name_lock);
1579 INIT_LIST_HEAD(&fw_cache.fw_names);
1581 INIT_DELAYED_WORK(&fw_cache.work,
1582 device_uncache_fw_images_work);
1584 fw_cache.pm_notify.notifier_call = fw_pm_notify;
1585 register_pm_notifier(&fw_cache.pm_notify);
1587 register_syscore_ops(&fw_syscore_ops);
1591 static int __init firmware_class_init(void)
1594 #ifdef CONFIG_FW_LOADER_USER_HELPER
1595 register_reboot_notifier(&fw_shutdown_nb);
1596 return class_register(&firmware_class);
1602 static void __exit firmware_class_exit(void)
1604 #ifdef CONFIG_PM_SLEEP
1605 unregister_syscore_ops(&fw_syscore_ops);
1606 unregister_pm_notifier(&fw_cache.pm_notify);
1608 #ifdef CONFIG_FW_LOADER_USER_HELPER
1609 unregister_reboot_notifier(&fw_shutdown_nb);
1610 class_unregister(&firmware_class);
1614 fs_initcall(firmware_class_init);
1615 module_exit(firmware_class_exit);