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 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
12 #include <linux/capability.h>
13 #include <linux/device.h>
14 #include <linux/module.h>
15 #include <linux/init.h>
16 #include <linux/timer.h>
17 #include <linux/vmalloc.h>
18 #include <linux/interrupt.h>
19 #include <linux/bitops.h>
20 #include <linux/mutex.h>
21 #include <linux/workqueue.h>
22 #include <linux/highmem.h>
23 #include <linux/firmware.h>
24 #include <linux/slab.h>
25 #include <linux/sched.h>
26 #include <linux/file.h>
27 #include <linux/list.h>
29 #include <linux/async.h>
31 #include <linux/suspend.h>
32 #include <linux/syscore_ops.h>
33 #include <linux/reboot.h>
34 #include <linux/security.h>
36 #include <generated/utsrelease.h>
40 MODULE_AUTHOR("Manuel Estrada Sainz");
41 MODULE_DESCRIPTION("Multi purpose firmware loading support");
42 MODULE_LICENSE("GPL");
44 /* Builtin firmware support */
46 #ifdef CONFIG_FW_LOADER
48 extern struct builtin_fw __start_builtin_fw[];
49 extern struct builtin_fw __end_builtin_fw[];
51 static bool fw_get_builtin_firmware(struct firmware *fw, const char *name,
52 void *buf, size_t size)
54 struct builtin_fw *b_fw;
56 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++) {
57 if (strcmp(name, b_fw->name) == 0) {
58 fw->size = b_fw->size;
59 fw->data = b_fw->data;
61 if (buf && fw->size <= size)
62 memcpy(buf, fw->data, fw->size);
70 static bool fw_is_builtin_firmware(const struct firmware *fw)
72 struct builtin_fw *b_fw;
74 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++)
75 if (fw->data == b_fw->data)
81 #else /* Module case - no builtin firmware support */
83 static inline bool fw_get_builtin_firmware(struct firmware *fw,
84 const char *name, void *buf,
90 static inline bool fw_is_builtin_firmware(const struct firmware *fw)
103 static int loading_timeout = 60; /* In seconds */
105 static inline long firmware_loading_timeout(void)
107 return loading_timeout > 0 ? loading_timeout * HZ : MAX_JIFFY_OFFSET;
111 * Concurrent request_firmware() for the same firmware need to be
112 * serialized. struct fw_state is simple state machine which hold the
113 * state of the firmware loading.
116 struct completion completion;
117 enum fw_status status;
120 static void fw_state_init(struct fw_state *fw_st)
122 init_completion(&fw_st->completion);
123 fw_st->status = FW_STATUS_UNKNOWN;
126 static inline bool __fw_state_is_done(enum fw_status status)
128 return status == FW_STATUS_DONE || status == FW_STATUS_ABORTED;
131 static int __fw_state_wait_common(struct fw_state *fw_st, long timeout)
135 ret = wait_for_completion_killable_timeout(&fw_st->completion, timeout);
136 if (ret != 0 && fw_st->status == FW_STATUS_ABORTED)
141 return ret < 0 ? ret : 0;
144 static void __fw_state_set(struct fw_state *fw_st,
145 enum fw_status status)
147 WRITE_ONCE(fw_st->status, status);
149 if (status == FW_STATUS_DONE || status == FW_STATUS_ABORTED)
150 complete_all(&fw_st->completion);
153 #define fw_state_start(fw_st) \
154 __fw_state_set(fw_st, FW_STATUS_LOADING)
155 #define fw_state_done(fw_st) \
156 __fw_state_set(fw_st, FW_STATUS_DONE)
157 #define fw_state_aborted(fw_st) \
158 __fw_state_set(fw_st, FW_STATUS_ABORTED)
159 #define fw_state_wait(fw_st) \
160 __fw_state_wait_common(fw_st, MAX_SCHEDULE_TIMEOUT)
162 static int __fw_state_check(struct fw_state *fw_st, enum fw_status status)
164 return fw_st->status == status;
167 #define fw_state_is_aborted(fw_st) \
168 __fw_state_check(fw_st, FW_STATUS_ABORTED)
170 #ifdef CONFIG_FW_LOADER_USER_HELPER
172 #define fw_state_aborted(fw_st) \
173 __fw_state_set(fw_st, FW_STATUS_ABORTED)
174 #define fw_state_is_done(fw_st) \
175 __fw_state_check(fw_st, FW_STATUS_DONE)
176 #define fw_state_is_loading(fw_st) \
177 __fw_state_check(fw_st, FW_STATUS_LOADING)
178 #define fw_state_wait_timeout(fw_st, timeout) \
179 __fw_state_wait_common(fw_st, timeout)
181 #endif /* CONFIG_FW_LOADER_USER_HELPER */
183 /* firmware behavior options */
184 #define FW_OPT_UEVENT (1U << 0)
185 #define FW_OPT_NOWAIT (1U << 1)
186 #ifdef CONFIG_FW_LOADER_USER_HELPER
187 #define FW_OPT_USERHELPER (1U << 2)
189 #define FW_OPT_USERHELPER 0
191 #ifdef CONFIG_FW_LOADER_USER_HELPER_FALLBACK
192 #define FW_OPT_FALLBACK FW_OPT_USERHELPER
194 #define FW_OPT_FALLBACK 0
196 #define FW_OPT_NO_WARN (1U << 3)
197 #define FW_OPT_NOCACHE (1U << 4)
199 struct firmware_cache {
200 /* firmware_buf instance will be added into the below list */
202 struct list_head head;
205 #ifdef CONFIG_PM_SLEEP
207 * Names of firmware images which have been cached successfully
208 * will be added into the below list so that device uncache
209 * helper can trace which firmware images have been cached
212 spinlock_t name_lock;
213 struct list_head fw_names;
215 struct delayed_work work;
217 struct notifier_block pm_notify;
221 struct firmware_buf {
223 struct list_head list;
224 struct firmware_cache *fwc;
225 struct fw_state fw_st;
228 size_t allocated_size;
229 #ifdef CONFIG_FW_LOADER_USER_HELPER
235 struct list_head pending_list;
240 struct fw_cache_entry {
241 struct list_head list;
245 struct fw_name_devm {
250 #define to_fwbuf(d) container_of(d, struct firmware_buf, ref)
252 #define FW_LOADER_NO_CACHE 0
253 #define FW_LOADER_START_CACHE 1
255 static int fw_cache_piggyback_on_request(const char *name);
257 /* fw_lock could be moved to 'struct firmware_priv' but since it is just
258 * guarding for corner cases a global lock should be OK */
259 static DEFINE_MUTEX(fw_lock);
261 static struct firmware_cache fw_cache;
263 static struct firmware_buf *__allocate_fw_buf(const char *fw_name,
264 struct firmware_cache *fwc,
265 void *dbuf, size_t size)
267 struct firmware_buf *buf;
269 buf = kzalloc(sizeof(*buf), GFP_ATOMIC);
273 buf->fw_id = kstrdup_const(fw_name, GFP_ATOMIC);
279 kref_init(&buf->ref);
282 buf->allocated_size = size;
283 fw_state_init(&buf->fw_st);
284 #ifdef CONFIG_FW_LOADER_USER_HELPER
285 INIT_LIST_HEAD(&buf->pending_list);
288 pr_debug("%s: fw-%s buf=%p\n", __func__, fw_name, buf);
293 static struct firmware_buf *__fw_lookup_buf(const char *fw_name)
295 struct firmware_buf *tmp;
296 struct firmware_cache *fwc = &fw_cache;
298 list_for_each_entry(tmp, &fwc->head, list)
299 if (!strcmp(tmp->fw_id, fw_name))
304 /* Returns 1 for batching firmware requests with the same name */
305 static int fw_lookup_and_allocate_buf(const char *fw_name,
306 struct firmware_cache *fwc,
307 struct firmware_buf **buf, void *dbuf,
310 struct firmware_buf *tmp;
312 spin_lock(&fwc->lock);
313 tmp = __fw_lookup_buf(fw_name);
316 spin_unlock(&fwc->lock);
318 pr_debug("batched request - sharing the same struct firmware_buf and lookup for multiple requests\n");
321 tmp = __allocate_fw_buf(fw_name, fwc, dbuf, size);
323 list_add(&tmp->list, &fwc->head);
324 spin_unlock(&fwc->lock);
328 return tmp ? 0 : -ENOMEM;
331 static void __fw_free_buf(struct kref *ref)
332 __releases(&fwc->lock)
334 struct firmware_buf *buf = to_fwbuf(ref);
335 struct firmware_cache *fwc = buf->fwc;
337 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
338 __func__, buf->fw_id, buf, buf->data,
339 (unsigned int)buf->size);
341 list_del(&buf->list);
342 spin_unlock(&fwc->lock);
344 #ifdef CONFIG_FW_LOADER_USER_HELPER
345 if (buf->is_paged_buf) {
348 for (i = 0; i < buf->nr_pages; i++)
349 __free_page(buf->pages[i]);
353 if (!buf->allocated_size)
355 kfree_const(buf->fw_id);
359 static void fw_free_buf(struct firmware_buf *buf)
361 struct firmware_cache *fwc = buf->fwc;
362 spin_lock(&fwc->lock);
363 if (!kref_put(&buf->ref, __fw_free_buf))
364 spin_unlock(&fwc->lock);
367 /* direct firmware loading support */
368 static char fw_path_para[256];
369 static const char * const fw_path[] = {
371 "/lib/firmware/updates/" UTS_RELEASE,
372 "/lib/firmware/updates",
373 "/lib/firmware/" UTS_RELEASE,
378 * Typical usage is that passing 'firmware_class.path=$CUSTOMIZED_PATH'
379 * from kernel command line because firmware_class is generally built in
380 * kernel instead of module.
382 module_param_string(path, fw_path_para, sizeof(fw_path_para), 0644);
383 MODULE_PARM_DESC(path, "customized firmware image search path with a higher priority than default path");
386 fw_get_filesystem_firmware(struct device *device, struct firmware_buf *buf)
392 enum kernel_read_file_id id = READING_FIRMWARE;
393 size_t msize = INT_MAX;
395 /* Already populated data member means we're loading into a buffer */
397 id = READING_FIRMWARE_PREALLOC_BUFFER;
398 msize = buf->allocated_size;
405 for (i = 0; i < ARRAY_SIZE(fw_path); i++) {
406 /* skip the unset customized path */
410 len = snprintf(path, PATH_MAX, "%s/%s",
411 fw_path[i], buf->fw_id);
412 if (len >= PATH_MAX) {
418 rc = kernel_read_file_from_path(path, &buf->data, &size, msize,
422 dev_dbg(device, "loading %s failed with error %d\n",
425 dev_warn(device, "loading %s failed with error %d\n",
429 dev_dbg(device, "direct-loading %s\n", buf->fw_id);
431 fw_state_done(&buf->fw_st);
439 /* firmware holds the ownership of pages */
440 static void firmware_free_data(const struct firmware *fw)
442 /* Loaded directly? */
447 fw_free_buf(fw->priv);
450 /* store the pages buffer info firmware from buf */
451 static void fw_set_page_data(struct firmware_buf *buf, struct firmware *fw)
454 #ifdef CONFIG_FW_LOADER_USER_HELPER
455 fw->pages = buf->pages;
457 fw->size = buf->size;
458 fw->data = buf->data;
460 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
461 __func__, buf->fw_id, buf, buf->data,
462 (unsigned int)buf->size);
465 #ifdef CONFIG_PM_SLEEP
466 static void fw_name_devm_release(struct device *dev, void *res)
468 struct fw_name_devm *fwn = res;
470 if (fwn->magic == (unsigned long)&fw_cache)
471 pr_debug("%s: fw_name-%s devm-%p released\n",
472 __func__, fwn->name, res);
473 kfree_const(fwn->name);
476 static int fw_devm_match(struct device *dev, void *res,
479 struct fw_name_devm *fwn = res;
481 return (fwn->magic == (unsigned long)&fw_cache) &&
482 !strcmp(fwn->name, match_data);
485 static struct fw_name_devm *fw_find_devm_name(struct device *dev,
488 struct fw_name_devm *fwn;
490 fwn = devres_find(dev, fw_name_devm_release,
491 fw_devm_match, (void *)name);
495 /* add firmware name into devres list */
496 static int fw_add_devm_name(struct device *dev, const char *name)
498 struct fw_name_devm *fwn;
500 fwn = fw_find_devm_name(dev, name);
504 fwn = devres_alloc(fw_name_devm_release, sizeof(struct fw_name_devm),
508 fwn->name = kstrdup_const(name, GFP_KERNEL);
514 fwn->magic = (unsigned long)&fw_cache;
515 devres_add(dev, fwn);
520 static int fw_add_devm_name(struct device *dev, const char *name)
526 static int assign_firmware_buf(struct firmware *fw, struct device *device,
527 unsigned int opt_flags)
529 struct firmware_buf *buf = fw->priv;
531 mutex_lock(&fw_lock);
532 if (!buf->size || fw_state_is_aborted(&buf->fw_st)) {
533 mutex_unlock(&fw_lock);
538 * add firmware name into devres list so that we can auto cache
539 * and uncache firmware for device.
541 * device may has been deleted already, but the problem
542 * should be fixed in devres or driver core.
544 /* don't cache firmware handled without uevent */
545 if (device && (opt_flags & FW_OPT_UEVENT) &&
546 !(opt_flags & FW_OPT_NOCACHE))
547 fw_add_devm_name(device, buf->fw_id);
550 * After caching firmware image is started, let it piggyback
551 * on request firmware.
553 if (!(opt_flags & FW_OPT_NOCACHE) &&
554 buf->fwc->state == FW_LOADER_START_CACHE) {
555 if (fw_cache_piggyback_on_request(buf->fw_id))
559 /* pass the pages buffer to driver at the last minute */
560 fw_set_page_data(buf, fw);
561 mutex_unlock(&fw_lock);
566 * user-mode helper code
568 #ifdef CONFIG_FW_LOADER_USER_HELPER
569 struct firmware_priv {
572 struct firmware_buf *buf;
576 static struct firmware_priv *to_firmware_priv(struct device *dev)
578 return container_of(dev, struct firmware_priv, dev);
581 static void __fw_load_abort(struct firmware_buf *buf)
584 * There is a small window in which user can write to 'loading'
585 * between loading done and disappearance of 'loading'
587 if (fw_state_is_done(&buf->fw_st))
590 list_del_init(&buf->pending_list);
591 fw_state_aborted(&buf->fw_st);
594 static void fw_load_abort(struct firmware_priv *fw_priv)
596 struct firmware_buf *buf = fw_priv->buf;
598 __fw_load_abort(buf);
601 static LIST_HEAD(pending_fw_head);
603 static void kill_pending_fw_fallback_reqs(bool only_kill_custom)
605 struct firmware_buf *buf;
606 struct firmware_buf *next;
608 mutex_lock(&fw_lock);
609 list_for_each_entry_safe(buf, next, &pending_fw_head, pending_list) {
610 if (!buf->need_uevent || !only_kill_custom)
611 __fw_load_abort(buf);
613 mutex_unlock(&fw_lock);
616 static ssize_t timeout_show(struct class *class, struct class_attribute *attr,
619 return sprintf(buf, "%d\n", loading_timeout);
623 * firmware_timeout_store - set number of seconds to wait for firmware
624 * @class: device class pointer
625 * @attr: device attribute pointer
626 * @buf: buffer to scan for timeout value
627 * @count: number of bytes in @buf
629 * Sets the number of seconds to wait for the firmware. Once
630 * this expires an error will be returned to the driver and no
631 * firmware will be provided.
633 * Note: zero means 'wait forever'.
635 static ssize_t timeout_store(struct class *class, struct class_attribute *attr,
636 const char *buf, size_t count)
638 loading_timeout = simple_strtol(buf, NULL, 10);
639 if (loading_timeout < 0)
644 static CLASS_ATTR_RW(timeout);
646 static struct attribute *firmware_class_attrs[] = {
647 &class_attr_timeout.attr,
650 ATTRIBUTE_GROUPS(firmware_class);
652 static void fw_dev_release(struct device *dev)
654 struct firmware_priv *fw_priv = to_firmware_priv(dev);
659 static int do_firmware_uevent(struct firmware_priv *fw_priv, struct kobj_uevent_env *env)
661 if (add_uevent_var(env, "FIRMWARE=%s", fw_priv->buf->fw_id))
663 if (add_uevent_var(env, "TIMEOUT=%i", loading_timeout))
665 if (add_uevent_var(env, "ASYNC=%d", fw_priv->nowait))
671 static int firmware_uevent(struct device *dev, struct kobj_uevent_env *env)
673 struct firmware_priv *fw_priv = to_firmware_priv(dev);
676 mutex_lock(&fw_lock);
678 err = do_firmware_uevent(fw_priv, env);
679 mutex_unlock(&fw_lock);
683 static struct class firmware_class = {
685 .class_groups = firmware_class_groups,
686 .dev_uevent = firmware_uevent,
687 .dev_release = fw_dev_release,
690 static ssize_t firmware_loading_show(struct device *dev,
691 struct device_attribute *attr, char *buf)
693 struct firmware_priv *fw_priv = to_firmware_priv(dev);
696 mutex_lock(&fw_lock);
698 loading = fw_state_is_loading(&fw_priv->buf->fw_st);
699 mutex_unlock(&fw_lock);
701 return sprintf(buf, "%d\n", loading);
704 /* Some architectures don't have PAGE_KERNEL_RO */
705 #ifndef PAGE_KERNEL_RO
706 #define PAGE_KERNEL_RO PAGE_KERNEL
709 /* one pages buffer should be mapped/unmapped only once */
710 static int fw_map_pages_buf(struct firmware_buf *buf)
712 if (!buf->is_paged_buf)
716 buf->data = vmap(buf->pages, buf->nr_pages, 0, PAGE_KERNEL_RO);
723 * firmware_loading_store - set value in the 'loading' control file
724 * @dev: device pointer
725 * @attr: device attribute pointer
726 * @buf: buffer to scan for loading control value
727 * @count: number of bytes in @buf
729 * The relevant values are:
731 * 1: Start a load, discarding any previous partial load.
732 * 0: Conclude the load and hand the data to the driver code.
733 * -1: Conclude the load with an error and discard any written data.
735 static ssize_t firmware_loading_store(struct device *dev,
736 struct device_attribute *attr,
737 const char *buf, size_t count)
739 struct firmware_priv *fw_priv = to_firmware_priv(dev);
740 struct firmware_buf *fw_buf;
741 ssize_t written = count;
742 int loading = simple_strtol(buf, NULL, 10);
745 mutex_lock(&fw_lock);
746 fw_buf = fw_priv->buf;
747 if (fw_state_is_aborted(&fw_buf->fw_st))
752 /* discarding any previous partial load */
753 if (!fw_state_is_done(&fw_buf->fw_st)) {
754 for (i = 0; i < fw_buf->nr_pages; i++)
755 __free_page(fw_buf->pages[i]);
756 vfree(fw_buf->pages);
757 fw_buf->pages = NULL;
758 fw_buf->page_array_size = 0;
759 fw_buf->nr_pages = 0;
760 fw_state_start(&fw_buf->fw_st);
764 if (fw_state_is_loading(&fw_buf->fw_st)) {
768 * Several loading requests may be pending on
769 * one same firmware buf, so let all requests
770 * see the mapped 'buf->data' once the loading
773 rc = fw_map_pages_buf(fw_buf);
775 dev_err(dev, "%s: map pages failed\n",
778 rc = security_kernel_post_read_file(NULL,
779 fw_buf->data, fw_buf->size,
783 * Same logic as fw_load_abort, only the DONE bit
784 * is ignored and we set ABORT only on failure.
786 list_del_init(&fw_buf->pending_list);
788 fw_state_aborted(&fw_buf->fw_st);
791 fw_state_done(&fw_buf->fw_st);
797 dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading);
800 fw_load_abort(fw_priv);
804 mutex_unlock(&fw_lock);
808 static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store);
810 static void firmware_rw_buf(struct firmware_buf *buf, char *buffer,
811 loff_t offset, size_t count, bool read)
814 memcpy(buffer, buf->data + offset, count);
816 memcpy(buf->data + offset, buffer, count);
819 static void firmware_rw(struct firmware_buf *buf, char *buffer,
820 loff_t offset, size_t count, bool read)
824 int page_nr = offset >> PAGE_SHIFT;
825 int page_ofs = offset & (PAGE_SIZE-1);
826 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
828 page_data = kmap(buf->pages[page_nr]);
831 memcpy(buffer, page_data + page_ofs, page_cnt);
833 memcpy(page_data + page_ofs, buffer, page_cnt);
835 kunmap(buf->pages[page_nr]);
842 static ssize_t firmware_data_read(struct file *filp, struct kobject *kobj,
843 struct bin_attribute *bin_attr,
844 char *buffer, loff_t offset, size_t count)
846 struct device *dev = kobj_to_dev(kobj);
847 struct firmware_priv *fw_priv = to_firmware_priv(dev);
848 struct firmware_buf *buf;
851 mutex_lock(&fw_lock);
853 if (!buf || fw_state_is_done(&buf->fw_st)) {
857 if (offset > buf->size) {
861 if (count > buf->size - offset)
862 count = buf->size - offset;
867 firmware_rw_buf(buf, buffer, offset, count, true);
869 firmware_rw(buf, buffer, offset, count, true);
872 mutex_unlock(&fw_lock);
876 static int fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
878 struct firmware_buf *buf = fw_priv->buf;
879 int pages_needed = PAGE_ALIGN(min_size) >> PAGE_SHIFT;
881 /* If the array of pages is too small, grow it... */
882 if (buf->page_array_size < pages_needed) {
883 int new_array_size = max(pages_needed,
884 buf->page_array_size * 2);
885 struct page **new_pages;
887 new_pages = vmalloc(new_array_size * sizeof(void *));
889 fw_load_abort(fw_priv);
892 memcpy(new_pages, buf->pages,
893 buf->page_array_size * sizeof(void *));
894 memset(&new_pages[buf->page_array_size], 0, sizeof(void *) *
895 (new_array_size - buf->page_array_size));
897 buf->pages = new_pages;
898 buf->page_array_size = new_array_size;
901 while (buf->nr_pages < pages_needed) {
902 buf->pages[buf->nr_pages] =
903 alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
905 if (!buf->pages[buf->nr_pages]) {
906 fw_load_abort(fw_priv);
915 * firmware_data_write - write method for firmware
916 * @filp: open sysfs file
917 * @kobj: kobject for the device
918 * @bin_attr: bin_attr structure
919 * @buffer: buffer being written
920 * @offset: buffer offset for write in total data store area
921 * @count: buffer size
923 * Data written to the 'data' attribute will be later handed to
924 * the driver as a firmware image.
926 static ssize_t firmware_data_write(struct file *filp, struct kobject *kobj,
927 struct bin_attribute *bin_attr,
928 char *buffer, loff_t offset, size_t count)
930 struct device *dev = kobj_to_dev(kobj);
931 struct firmware_priv *fw_priv = to_firmware_priv(dev);
932 struct firmware_buf *buf;
935 if (!capable(CAP_SYS_RAWIO))
938 mutex_lock(&fw_lock);
940 if (!buf || fw_state_is_done(&buf->fw_st)) {
946 if (offset + count > buf->allocated_size) {
950 firmware_rw_buf(buf, buffer, offset, count, false);
953 retval = fw_realloc_buffer(fw_priv, offset + count);
958 firmware_rw(buf, buffer, offset, count, false);
961 buf->size = max_t(size_t, offset + count, buf->size);
963 mutex_unlock(&fw_lock);
967 static struct bin_attribute firmware_attr_data = {
968 .attr = { .name = "data", .mode = 0644 },
970 .read = firmware_data_read,
971 .write = firmware_data_write,
974 static struct attribute *fw_dev_attrs[] = {
975 &dev_attr_loading.attr,
979 static struct bin_attribute *fw_dev_bin_attrs[] = {
984 static const struct attribute_group fw_dev_attr_group = {
985 .attrs = fw_dev_attrs,
986 .bin_attrs = fw_dev_bin_attrs,
989 static const struct attribute_group *fw_dev_attr_groups[] = {
994 static struct firmware_priv *
995 fw_create_instance(struct firmware *firmware, const char *fw_name,
996 struct device *device, unsigned int opt_flags)
998 struct firmware_priv *fw_priv;
999 struct device *f_dev;
1001 fw_priv = kzalloc(sizeof(*fw_priv), GFP_KERNEL);
1003 fw_priv = ERR_PTR(-ENOMEM);
1007 fw_priv->nowait = !!(opt_flags & FW_OPT_NOWAIT);
1008 fw_priv->fw = firmware;
1009 f_dev = &fw_priv->dev;
1011 device_initialize(f_dev);
1012 dev_set_name(f_dev, "%s", fw_name);
1013 f_dev->parent = device;
1014 f_dev->class = &firmware_class;
1015 f_dev->groups = fw_dev_attr_groups;
1020 /* load a firmware via user helper */
1021 static int _request_firmware_load(struct firmware_priv *fw_priv,
1022 unsigned int opt_flags, long timeout)
1025 struct device *f_dev = &fw_priv->dev;
1026 struct firmware_buf *buf = fw_priv->buf;
1028 /* fall back on userspace loading */
1030 buf->is_paged_buf = true;
1032 dev_set_uevent_suppress(f_dev, true);
1034 retval = device_add(f_dev);
1036 dev_err(f_dev, "%s: device_register failed\n", __func__);
1040 mutex_lock(&fw_lock);
1041 list_add(&buf->pending_list, &pending_fw_head);
1042 mutex_unlock(&fw_lock);
1044 if (opt_flags & FW_OPT_UEVENT) {
1045 buf->need_uevent = true;
1046 dev_set_uevent_suppress(f_dev, false);
1047 dev_dbg(f_dev, "firmware: requesting %s\n", buf->fw_id);
1048 kobject_uevent(&fw_priv->dev.kobj, KOBJ_ADD);
1050 timeout = MAX_JIFFY_OFFSET;
1053 retval = fw_state_wait_timeout(&buf->fw_st, timeout);
1055 mutex_lock(&fw_lock);
1056 fw_load_abort(fw_priv);
1057 mutex_unlock(&fw_lock);
1060 if (fw_state_is_aborted(&buf->fw_st)) {
1061 if (retval == -ERESTARTSYS)
1065 } else if (buf->is_paged_buf && !buf->data)
1074 static int fw_load_from_user_helper(struct firmware *firmware,
1075 const char *name, struct device *device,
1076 unsigned int opt_flags)
1078 struct firmware_priv *fw_priv;
1082 timeout = firmware_loading_timeout();
1083 if (opt_flags & FW_OPT_NOWAIT) {
1084 timeout = usermodehelper_read_lock_wait(timeout);
1086 dev_dbg(device, "firmware: %s loading timed out\n",
1091 ret = usermodehelper_read_trylock();
1093 dev_err(device, "firmware: %s will not be loaded\n",
1099 fw_priv = fw_create_instance(firmware, name, device, opt_flags);
1100 if (IS_ERR(fw_priv)) {
1101 ret = PTR_ERR(fw_priv);
1105 fw_priv->buf = firmware->priv;
1106 ret = _request_firmware_load(fw_priv, opt_flags, timeout);
1109 ret = assign_firmware_buf(firmware, device, opt_flags);
1112 usermodehelper_read_unlock();
1117 #else /* CONFIG_FW_LOADER_USER_HELPER */
1119 fw_load_from_user_helper(struct firmware *firmware, const char *name,
1120 struct device *device, unsigned int opt_flags)
1125 static inline void kill_pending_fw_fallback_reqs(bool only_kill_custom) { }
1127 #endif /* CONFIG_FW_LOADER_USER_HELPER */
1129 /* prepare firmware and firmware_buf structs;
1130 * return 0 if a firmware is already assigned, 1 if need to load one,
1131 * or a negative error code
1134 _request_firmware_prepare(struct firmware **firmware_p, const char *name,
1135 struct device *device, void *dbuf, size_t size)
1137 struct firmware *firmware;
1138 struct firmware_buf *buf;
1141 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
1143 dev_err(device, "%s: kmalloc(struct firmware) failed\n",
1148 if (fw_get_builtin_firmware(firmware, name, dbuf, size)) {
1149 dev_dbg(device, "using built-in %s\n", name);
1150 return 0; /* assigned */
1153 ret = fw_lookup_and_allocate_buf(name, &fw_cache, &buf, dbuf, size);
1156 * bind with 'buf' now to avoid warning in failure path
1157 * of requesting firmware.
1159 firmware->priv = buf;
1162 ret = fw_state_wait(&buf->fw_st);
1164 fw_set_page_data(buf, firmware);
1165 return 0; /* assigned */
1171 return 1; /* need to load */
1175 * Batched requests need only one wake, we need to do this step last due to the
1176 * fallback mechanism. The buf is protected with kref_get(), and it won't be
1177 * released until the last user calls release_firmware().
1179 * Failed batched requests are possible as well, in such cases we just share
1180 * the struct firmware_buf and won't release it until all requests are woken
1181 * and have gone through this same path.
1183 static void fw_abort_batch_reqs(struct firmware *fw)
1185 struct firmware_buf *buf;
1187 /* Loaded directly? */
1188 if (!fw || !fw->priv)
1192 if (!fw_state_is_aborted(&buf->fw_st))
1193 fw_state_aborted(&buf->fw_st);
1196 /* called from request_firmware() and request_firmware_work_func() */
1198 _request_firmware(const struct firmware **firmware_p, const char *name,
1199 struct device *device, void *buf, size_t size,
1200 unsigned int opt_flags)
1202 struct firmware *fw = NULL;
1208 if (!name || name[0] == '\0') {
1213 ret = _request_firmware_prepare(&fw, name, device, buf, size);
1214 if (ret <= 0) /* error or already assigned */
1217 ret = fw_get_filesystem_firmware(device, fw->priv);
1219 if (!(opt_flags & FW_OPT_NO_WARN))
1221 "Direct firmware load for %s failed with error %d\n",
1223 if (opt_flags & FW_OPT_USERHELPER) {
1224 dev_warn(device, "Falling back to user helper\n");
1225 ret = fw_load_from_user_helper(fw, name, device,
1229 ret = assign_firmware_buf(fw, device, opt_flags);
1233 fw_abort_batch_reqs(fw);
1234 release_firmware(fw);
1243 * request_firmware: - send firmware request and wait for it
1244 * @firmware_p: pointer to firmware image
1245 * @name: name of firmware file
1246 * @device: device for which firmware is being loaded
1248 * @firmware_p will be used to return a firmware image by the name
1249 * of @name for device @device.
1251 * Should be called from user context where sleeping is allowed.
1253 * @name will be used as $FIRMWARE in the uevent environment and
1254 * should be distinctive enough not to be confused with any other
1255 * firmware image for this or any other device.
1257 * Caller must hold the reference count of @device.
1259 * The function can be called safely inside device's suspend and
1263 request_firmware(const struct firmware **firmware_p, const char *name,
1264 struct device *device)
1268 /* Need to pin this module until return */
1269 __module_get(THIS_MODULE);
1270 ret = _request_firmware(firmware_p, name, device, NULL, 0,
1271 FW_OPT_UEVENT | FW_OPT_FALLBACK);
1272 module_put(THIS_MODULE);
1275 EXPORT_SYMBOL(request_firmware);
1278 * request_firmware_direct: - load firmware directly without usermode helper
1279 * @firmware_p: pointer to firmware image
1280 * @name: name of firmware file
1281 * @device: device for which firmware is being loaded
1283 * This function works pretty much like request_firmware(), but this doesn't
1284 * fall back to usermode helper even if the firmware couldn't be loaded
1285 * directly from fs. Hence it's useful for loading optional firmwares, which
1286 * aren't always present, without extra long timeouts of udev.
1288 int request_firmware_direct(const struct firmware **firmware_p,
1289 const char *name, struct device *device)
1293 __module_get(THIS_MODULE);
1294 ret = _request_firmware(firmware_p, name, device, NULL, 0,
1295 FW_OPT_UEVENT | FW_OPT_NO_WARN);
1296 module_put(THIS_MODULE);
1299 EXPORT_SYMBOL_GPL(request_firmware_direct);
1302 * request_firmware_into_buf - load firmware into a previously allocated buffer
1303 * @firmware_p: pointer to firmware image
1304 * @name: name of firmware file
1305 * @device: device for which firmware is being loaded and DMA region allocated
1306 * @buf: address of buffer to load firmware into
1307 * @size: size of buffer
1309 * This function works pretty much like request_firmware(), but it doesn't
1310 * allocate a buffer to hold the firmware data. Instead, the firmware
1311 * is loaded directly into the buffer pointed to by @buf and the @firmware_p
1312 * data member is pointed at @buf.
1314 * This function doesn't cache firmware either.
1317 request_firmware_into_buf(const struct firmware **firmware_p, const char *name,
1318 struct device *device, void *buf, size_t size)
1322 __module_get(THIS_MODULE);
1323 ret = _request_firmware(firmware_p, name, device, buf, size,
1324 FW_OPT_UEVENT | FW_OPT_FALLBACK |
1326 module_put(THIS_MODULE);
1329 EXPORT_SYMBOL(request_firmware_into_buf);
1332 * release_firmware: - release the resource associated with a firmware image
1333 * @fw: firmware resource to release
1335 void release_firmware(const struct firmware *fw)
1338 if (!fw_is_builtin_firmware(fw))
1339 firmware_free_data(fw);
1343 EXPORT_SYMBOL(release_firmware);
1346 struct firmware_work {
1347 struct work_struct work;
1348 struct module *module;
1350 struct device *device;
1352 void (*cont)(const struct firmware *fw, void *context);
1353 unsigned int opt_flags;
1356 static void request_firmware_work_func(struct work_struct *work)
1358 struct firmware_work *fw_work;
1359 const struct firmware *fw;
1361 fw_work = container_of(work, struct firmware_work, work);
1363 _request_firmware(&fw, fw_work->name, fw_work->device, NULL, 0,
1364 fw_work->opt_flags);
1365 fw_work->cont(fw, fw_work->context);
1366 put_device(fw_work->device); /* taken in request_firmware_nowait() */
1368 module_put(fw_work->module);
1369 kfree_const(fw_work->name);
1374 * request_firmware_nowait - asynchronous version of request_firmware
1375 * @module: module requesting the firmware
1376 * @uevent: sends uevent to copy the firmware image if this flag
1377 * is non-zero else the firmware copy must be done manually.
1378 * @name: name of firmware file
1379 * @device: device for which firmware is being loaded
1380 * @gfp: allocation flags
1381 * @context: will be passed over to @cont, and
1382 * @fw may be %NULL if firmware request fails.
1383 * @cont: function will be called asynchronously when the firmware
1386 * Caller must hold the reference count of @device.
1388 * Asynchronous variant of request_firmware() for user contexts:
1389 * - sleep for as small periods as possible since it may
1390 * increase kernel boot time of built-in device drivers
1391 * requesting firmware in their ->probe() methods, if
1392 * @gfp is GFP_KERNEL.
1394 * - can't sleep at all if @gfp is GFP_ATOMIC.
1397 request_firmware_nowait(
1398 struct module *module, bool uevent,
1399 const char *name, struct device *device, gfp_t gfp, void *context,
1400 void (*cont)(const struct firmware *fw, void *context))
1402 struct firmware_work *fw_work;
1404 fw_work = kzalloc(sizeof(struct firmware_work), gfp);
1408 fw_work->module = module;
1409 fw_work->name = kstrdup_const(name, gfp);
1410 if (!fw_work->name) {
1414 fw_work->device = device;
1415 fw_work->context = context;
1416 fw_work->cont = cont;
1417 fw_work->opt_flags = FW_OPT_NOWAIT | FW_OPT_FALLBACK |
1418 (uevent ? FW_OPT_UEVENT : FW_OPT_USERHELPER);
1420 if (!try_module_get(module)) {
1421 kfree_const(fw_work->name);
1426 get_device(fw_work->device);
1427 INIT_WORK(&fw_work->work, request_firmware_work_func);
1428 schedule_work(&fw_work->work);
1431 EXPORT_SYMBOL(request_firmware_nowait);
1433 #ifdef CONFIG_PM_SLEEP
1434 static ASYNC_DOMAIN_EXCLUSIVE(fw_cache_domain);
1437 * cache_firmware - cache one firmware image in kernel memory space
1438 * @fw_name: the firmware image name
1440 * Cache firmware in kernel memory so that drivers can use it when
1441 * system isn't ready for them to request firmware image from userspace.
1442 * Once it returns successfully, driver can use request_firmware or its
1443 * nowait version to get the cached firmware without any interacting
1446 * Return 0 if the firmware image has been cached successfully
1447 * Return !0 otherwise
1450 static int cache_firmware(const char *fw_name)
1453 const struct firmware *fw;
1455 pr_debug("%s: %s\n", __func__, fw_name);
1457 ret = request_firmware(&fw, fw_name, NULL);
1461 pr_debug("%s: %s ret=%d\n", __func__, fw_name, ret);
1466 static struct firmware_buf *fw_lookup_buf(const char *fw_name)
1468 struct firmware_buf *tmp;
1469 struct firmware_cache *fwc = &fw_cache;
1471 spin_lock(&fwc->lock);
1472 tmp = __fw_lookup_buf(fw_name);
1473 spin_unlock(&fwc->lock);
1479 * uncache_firmware - remove one cached firmware image
1480 * @fw_name: the firmware image name
1482 * Uncache one firmware image which has been cached successfully
1485 * Return 0 if the firmware cache has been removed successfully
1486 * Return !0 otherwise
1489 static int uncache_firmware(const char *fw_name)
1491 struct firmware_buf *buf;
1494 pr_debug("%s: %s\n", __func__, fw_name);
1496 if (fw_get_builtin_firmware(&fw, fw_name, NULL, 0))
1499 buf = fw_lookup_buf(fw_name);
1508 static struct fw_cache_entry *alloc_fw_cache_entry(const char *name)
1510 struct fw_cache_entry *fce;
1512 fce = kzalloc(sizeof(*fce), GFP_ATOMIC);
1516 fce->name = kstrdup_const(name, GFP_ATOMIC);
1526 static int __fw_entry_found(const char *name)
1528 struct firmware_cache *fwc = &fw_cache;
1529 struct fw_cache_entry *fce;
1531 list_for_each_entry(fce, &fwc->fw_names, list) {
1532 if (!strcmp(fce->name, name))
1538 static int fw_cache_piggyback_on_request(const char *name)
1540 struct firmware_cache *fwc = &fw_cache;
1541 struct fw_cache_entry *fce;
1544 spin_lock(&fwc->name_lock);
1545 if (__fw_entry_found(name))
1548 fce = alloc_fw_cache_entry(name);
1551 list_add(&fce->list, &fwc->fw_names);
1552 pr_debug("%s: fw: %s\n", __func__, name);
1555 spin_unlock(&fwc->name_lock);
1559 static void free_fw_cache_entry(struct fw_cache_entry *fce)
1561 kfree_const(fce->name);
1565 static void __async_dev_cache_fw_image(void *fw_entry,
1566 async_cookie_t cookie)
1568 struct fw_cache_entry *fce = fw_entry;
1569 struct firmware_cache *fwc = &fw_cache;
1572 ret = cache_firmware(fce->name);
1574 spin_lock(&fwc->name_lock);
1575 list_del(&fce->list);
1576 spin_unlock(&fwc->name_lock);
1578 free_fw_cache_entry(fce);
1582 /* called with dev->devres_lock held */
1583 static void dev_create_fw_entry(struct device *dev, void *res,
1586 struct fw_name_devm *fwn = res;
1587 const char *fw_name = fwn->name;
1588 struct list_head *head = data;
1589 struct fw_cache_entry *fce;
1591 fce = alloc_fw_cache_entry(fw_name);
1593 list_add(&fce->list, head);
1596 static int devm_name_match(struct device *dev, void *res,
1599 struct fw_name_devm *fwn = res;
1600 return (fwn->magic == (unsigned long)match_data);
1603 static void dev_cache_fw_image(struct device *dev, void *data)
1606 struct fw_cache_entry *fce;
1607 struct fw_cache_entry *fce_next;
1608 struct firmware_cache *fwc = &fw_cache;
1610 devres_for_each_res(dev, fw_name_devm_release,
1611 devm_name_match, &fw_cache,
1612 dev_create_fw_entry, &todo);
1614 list_for_each_entry_safe(fce, fce_next, &todo, list) {
1615 list_del(&fce->list);
1617 spin_lock(&fwc->name_lock);
1618 /* only one cache entry for one firmware */
1619 if (!__fw_entry_found(fce->name)) {
1620 list_add(&fce->list, &fwc->fw_names);
1622 free_fw_cache_entry(fce);
1625 spin_unlock(&fwc->name_lock);
1628 async_schedule_domain(__async_dev_cache_fw_image,
1634 static void __device_uncache_fw_images(void)
1636 struct firmware_cache *fwc = &fw_cache;
1637 struct fw_cache_entry *fce;
1639 spin_lock(&fwc->name_lock);
1640 while (!list_empty(&fwc->fw_names)) {
1641 fce = list_entry(fwc->fw_names.next,
1642 struct fw_cache_entry, list);
1643 list_del(&fce->list);
1644 spin_unlock(&fwc->name_lock);
1646 uncache_firmware(fce->name);
1647 free_fw_cache_entry(fce);
1649 spin_lock(&fwc->name_lock);
1651 spin_unlock(&fwc->name_lock);
1655 * device_cache_fw_images - cache devices' firmware
1657 * If one device called request_firmware or its nowait version
1658 * successfully before, the firmware names are recored into the
1659 * device's devres link list, so device_cache_fw_images can call
1660 * cache_firmware() to cache these firmwares for the device,
1661 * then the device driver can load its firmwares easily at
1662 * time when system is not ready to complete loading firmware.
1664 static void device_cache_fw_images(void)
1666 struct firmware_cache *fwc = &fw_cache;
1670 pr_debug("%s\n", __func__);
1672 /* cancel uncache work */
1673 cancel_delayed_work_sync(&fwc->work);
1676 * use small loading timeout for caching devices' firmware
1677 * because all these firmware images have been loaded
1678 * successfully at lease once, also system is ready for
1679 * completing firmware loading now. The maximum size of
1680 * firmware in current distributions is about 2M bytes,
1681 * so 10 secs should be enough.
1683 old_timeout = loading_timeout;
1684 loading_timeout = 10;
1686 mutex_lock(&fw_lock);
1687 fwc->state = FW_LOADER_START_CACHE;
1688 dpm_for_each_dev(NULL, dev_cache_fw_image);
1689 mutex_unlock(&fw_lock);
1691 /* wait for completion of caching firmware for all devices */
1692 async_synchronize_full_domain(&fw_cache_domain);
1694 loading_timeout = old_timeout;
1698 * device_uncache_fw_images - uncache devices' firmware
1700 * uncache all firmwares which have been cached successfully
1701 * by device_uncache_fw_images earlier
1703 static void device_uncache_fw_images(void)
1705 pr_debug("%s\n", __func__);
1706 __device_uncache_fw_images();
1709 static void device_uncache_fw_images_work(struct work_struct *work)
1711 device_uncache_fw_images();
1715 * device_uncache_fw_images_delay - uncache devices firmwares
1716 * @delay: number of milliseconds to delay uncache device firmwares
1718 * uncache all devices's firmwares which has been cached successfully
1719 * by device_cache_fw_images after @delay milliseconds.
1721 static void device_uncache_fw_images_delay(unsigned long delay)
1723 queue_delayed_work(system_power_efficient_wq, &fw_cache.work,
1724 msecs_to_jiffies(delay));
1727 static int fw_pm_notify(struct notifier_block *notify_block,
1728 unsigned long mode, void *unused)
1731 case PM_HIBERNATION_PREPARE:
1732 case PM_SUSPEND_PREPARE:
1733 case PM_RESTORE_PREPARE:
1735 * kill pending fallback requests with a custom fallback
1736 * to avoid stalling suspend.
1738 kill_pending_fw_fallback_reqs(true);
1739 device_cache_fw_images();
1742 case PM_POST_SUSPEND:
1743 case PM_POST_HIBERNATION:
1744 case PM_POST_RESTORE:
1746 * In case that system sleep failed and syscore_suspend is
1749 mutex_lock(&fw_lock);
1750 fw_cache.state = FW_LOADER_NO_CACHE;
1751 mutex_unlock(&fw_lock);
1753 device_uncache_fw_images_delay(10 * MSEC_PER_SEC);
1760 /* stop caching firmware once syscore_suspend is reached */
1761 static int fw_suspend(void)
1763 fw_cache.state = FW_LOADER_NO_CACHE;
1767 static struct syscore_ops fw_syscore_ops = {
1768 .suspend = fw_suspend,
1771 static int fw_cache_piggyback_on_request(const char *name)
1777 static void __init fw_cache_init(void)
1779 spin_lock_init(&fw_cache.lock);
1780 INIT_LIST_HEAD(&fw_cache.head);
1781 fw_cache.state = FW_LOADER_NO_CACHE;
1783 #ifdef CONFIG_PM_SLEEP
1784 spin_lock_init(&fw_cache.name_lock);
1785 INIT_LIST_HEAD(&fw_cache.fw_names);
1787 INIT_DELAYED_WORK(&fw_cache.work,
1788 device_uncache_fw_images_work);
1790 fw_cache.pm_notify.notifier_call = fw_pm_notify;
1791 register_pm_notifier(&fw_cache.pm_notify);
1793 register_syscore_ops(&fw_syscore_ops);
1797 static int fw_shutdown_notify(struct notifier_block *unused1,
1798 unsigned long unused2, void *unused3)
1801 * Kill all pending fallback requests to avoid both stalling shutdown,
1802 * and avoid a deadlock with the usermode_lock.
1804 kill_pending_fw_fallback_reqs(false);
1809 static struct notifier_block fw_shutdown_nb = {
1810 .notifier_call = fw_shutdown_notify,
1813 static int __init firmware_class_init(void)
1816 register_reboot_notifier(&fw_shutdown_nb);
1817 #ifdef CONFIG_FW_LOADER_USER_HELPER
1818 return class_register(&firmware_class);
1824 static void __exit firmware_class_exit(void)
1826 #ifdef CONFIG_PM_SLEEP
1827 unregister_syscore_ops(&fw_syscore_ops);
1828 unregister_pm_notifier(&fw_cache.pm_notify);
1830 unregister_reboot_notifier(&fw_shutdown_nb);
1831 #ifdef CONFIG_FW_LOADER_USER_HELPER
1832 class_unregister(&firmware_class);
1836 fs_initcall(firmware_class_init);
1837 module_exit(firmware_class_exit);