2 * firmware_class.c - Multi purpose firmware loading support
4 * Copyright (c) 2003 Manuel Estrada Sainz
6 * Please see Documentation/firmware_class/ for more information.
10 #include <linux/capability.h>
11 #include <linux/device.h>
12 #include <linux/module.h>
13 #include <linux/init.h>
14 #include <linux/timer.h>
15 #include <linux/vmalloc.h>
16 #include <linux/interrupt.h>
17 #include <linux/bitops.h>
18 #include <linux/mutex.h>
19 #include <linux/workqueue.h>
20 #include <linux/highmem.h>
21 #include <linux/firmware.h>
22 #include <linux/slab.h>
23 #include <linux/sched.h>
24 #include <linux/file.h>
25 #include <linux/list.h>
26 #include <linux/async.h>
28 #include <linux/suspend.h>
29 #include <linux/syscore_ops.h>
30 #include <linux/reboot.h>
31 #include <linux/security.h>
33 #include <generated/utsrelease.h>
37 MODULE_AUTHOR("Manuel Estrada Sainz");
38 MODULE_DESCRIPTION("Multi purpose firmware loading support");
39 MODULE_LICENSE("GPL");
41 /* Builtin firmware support */
43 #ifdef CONFIG_FW_LOADER
45 extern struct builtin_fw __start_builtin_fw
[];
46 extern struct builtin_fw __end_builtin_fw
[];
48 static bool fw_get_builtin_firmware(struct firmware
*fw
, const char *name
)
50 struct builtin_fw
*b_fw
;
52 for (b_fw
= __start_builtin_fw
; b_fw
!= __end_builtin_fw
; b_fw
++) {
53 if (strcmp(name
, b_fw
->name
) == 0) {
54 fw
->size
= b_fw
->size
;
55 fw
->data
= b_fw
->data
;
63 static bool fw_is_builtin_firmware(const struct firmware
*fw
)
65 struct builtin_fw
*b_fw
;
67 for (b_fw
= __start_builtin_fw
; b_fw
!= __end_builtin_fw
; b_fw
++)
68 if (fw
->data
== b_fw
->data
)
74 #else /* Module case - no builtin firmware support */
76 static inline bool fw_get_builtin_firmware(struct firmware
*fw
, const char *name
)
81 static inline bool fw_is_builtin_firmware(const struct firmware
*fw
)
93 static int loading_timeout
= 60; /* In seconds */
95 static inline long firmware_loading_timeout(void)
97 return loading_timeout
> 0 ? loading_timeout
* HZ
: MAX_JIFFY_OFFSET
;
100 /* firmware behavior options */
101 #define FW_OPT_UEVENT (1U << 0)
102 #define FW_OPT_NOWAIT (1U << 1)
103 #ifdef CONFIG_FW_LOADER_USER_HELPER
104 #define FW_OPT_USERHELPER (1U << 2)
106 #define FW_OPT_USERHELPER 0
108 #ifdef CONFIG_FW_LOADER_USER_HELPER_FALLBACK
109 #define FW_OPT_FALLBACK FW_OPT_USERHELPER
111 #define FW_OPT_FALLBACK 0
113 #define FW_OPT_NO_WARN (1U << 3)
115 struct firmware_cache
{
116 /* firmware_buf instance will be added into the below list */
118 struct list_head head
;
121 #ifdef CONFIG_PM_SLEEP
123 * Names of firmware images which have been cached successfully
124 * will be added into the below list so that device uncache
125 * helper can trace which firmware images have been cached
128 spinlock_t name_lock
;
129 struct list_head fw_names
;
131 struct delayed_work work
;
133 struct notifier_block pm_notify
;
137 struct firmware_buf
{
139 struct list_head list
;
140 struct completion completion
;
141 struct firmware_cache
*fwc
;
142 unsigned long status
;
145 #ifdef CONFIG_FW_LOADER_USER_HELPER
151 struct list_head pending_list
;
156 struct fw_cache_entry
{
157 struct list_head list
;
161 struct fw_name_devm
{
166 #define to_fwbuf(d) container_of(d, struct firmware_buf, ref)
168 #define FW_LOADER_NO_CACHE 0
169 #define FW_LOADER_START_CACHE 1
171 static int fw_cache_piggyback_on_request(const char *name
);
173 /* fw_lock could be moved to 'struct firmware_priv' but since it is just
174 * guarding for corner cases a global lock should be OK */
175 static DEFINE_MUTEX(fw_lock
);
177 static struct firmware_cache fw_cache
;
179 static struct firmware_buf
*__allocate_fw_buf(const char *fw_name
,
180 struct firmware_cache
*fwc
)
182 struct firmware_buf
*buf
;
184 buf
= kzalloc(sizeof(*buf
) + strlen(fw_name
) + 1, GFP_ATOMIC
);
189 kref_init(&buf
->ref
);
190 strcpy(buf
->fw_id
, fw_name
);
192 init_completion(&buf
->completion
);
193 #ifdef CONFIG_FW_LOADER_USER_HELPER
194 INIT_LIST_HEAD(&buf
->pending_list
);
197 pr_debug("%s: fw-%s buf=%p\n", __func__
, fw_name
, buf
);
202 static struct firmware_buf
*__fw_lookup_buf(const char *fw_name
)
204 struct firmware_buf
*tmp
;
205 struct firmware_cache
*fwc
= &fw_cache
;
207 list_for_each_entry(tmp
, &fwc
->head
, list
)
208 if (!strcmp(tmp
->fw_id
, fw_name
))
213 static int fw_lookup_and_allocate_buf(const char *fw_name
,
214 struct firmware_cache
*fwc
,
215 struct firmware_buf
**buf
)
217 struct firmware_buf
*tmp
;
219 spin_lock(&fwc
->lock
);
220 tmp
= __fw_lookup_buf(fw_name
);
223 spin_unlock(&fwc
->lock
);
227 tmp
= __allocate_fw_buf(fw_name
, fwc
);
229 list_add(&tmp
->list
, &fwc
->head
);
230 spin_unlock(&fwc
->lock
);
234 return tmp
? 0 : -ENOMEM
;
237 static void __fw_free_buf(struct kref
*ref
)
238 __releases(&fwc
->lock
)
240 struct firmware_buf
*buf
= to_fwbuf(ref
);
241 struct firmware_cache
*fwc
= buf
->fwc
;
243 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
244 __func__
, buf
->fw_id
, buf
, buf
->data
,
245 (unsigned int)buf
->size
);
247 list_del(&buf
->list
);
248 spin_unlock(&fwc
->lock
);
250 #ifdef CONFIG_FW_LOADER_USER_HELPER
251 if (buf
->is_paged_buf
) {
254 for (i
= 0; i
< buf
->nr_pages
; i
++)
255 __free_page(buf
->pages
[i
]);
263 static void fw_free_buf(struct firmware_buf
*buf
)
265 struct firmware_cache
*fwc
= buf
->fwc
;
266 spin_lock(&fwc
->lock
);
267 if (!kref_put(&buf
->ref
, __fw_free_buf
))
268 spin_unlock(&fwc
->lock
);
271 /* direct firmware loading support */
272 static char fw_path_para
[256];
273 static const char * const fw_path
[] = {
275 "/lib/firmware/updates/" UTS_RELEASE
,
276 "/lib/firmware/updates",
277 "/lib/firmware/" UTS_RELEASE
,
282 * Typical usage is that passing 'firmware_class.path=$CUSTOMIZED_PATH'
283 * from kernel command line because firmware_class is generally built in
284 * kernel instead of module.
286 module_param_string(path
, fw_path_para
, sizeof(fw_path_para
), 0644);
287 MODULE_PARM_DESC(path
, "customized firmware image search path with a higher priority than default path");
289 static int fw_read_file_contents(struct file
*file
, struct firmware_buf
*fw_buf
)
295 if (!S_ISREG(file_inode(file
)->i_mode
))
297 size
= i_size_read(file_inode(file
));
303 rc
= kernel_read(file
, 0, buf
, size
);
309 rc
= security_kernel_fw_from_file(file
, buf
, size
);
320 static int fw_get_filesystem_firmware(struct device
*device
,
321 struct firmware_buf
*buf
)
331 for (i
= 0; i
< ARRAY_SIZE(fw_path
); i
++) {
334 /* skip the unset customized path */
338 len
= snprintf(path
, PATH_MAX
, "%s/%s",
339 fw_path
[i
], buf
->fw_id
);
340 if (len
>= PATH_MAX
) {
345 file
= filp_open(path
, O_RDONLY
, 0);
348 rc
= fw_read_file_contents(file
, buf
);
351 dev_warn(device
, "firmware, attempted to load %s, but failed with error %d\n",
359 dev_dbg(device
, "firmware: direct-loading firmware %s\n",
361 mutex_lock(&fw_lock
);
362 set_bit(FW_STATUS_DONE
, &buf
->status
);
363 complete_all(&buf
->completion
);
364 mutex_unlock(&fw_lock
);
370 /* firmware holds the ownership of pages */
371 static void firmware_free_data(const struct firmware
*fw
)
373 /* Loaded directly? */
378 fw_free_buf(fw
->priv
);
381 /* store the pages buffer info firmware from buf */
382 static void fw_set_page_data(struct firmware_buf
*buf
, struct firmware
*fw
)
385 #ifdef CONFIG_FW_LOADER_USER_HELPER
386 fw
->pages
= buf
->pages
;
388 fw
->size
= buf
->size
;
389 fw
->data
= buf
->data
;
391 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
392 __func__
, buf
->fw_id
, buf
, buf
->data
,
393 (unsigned int)buf
->size
);
396 #ifdef CONFIG_PM_SLEEP
397 static void fw_name_devm_release(struct device
*dev
, void *res
)
399 struct fw_name_devm
*fwn
= res
;
401 if (fwn
->magic
== (unsigned long)&fw_cache
)
402 pr_debug("%s: fw_name-%s devm-%p released\n",
403 __func__
, fwn
->name
, res
);
406 static int fw_devm_match(struct device
*dev
, void *res
,
409 struct fw_name_devm
*fwn
= res
;
411 return (fwn
->magic
== (unsigned long)&fw_cache
) &&
412 !strcmp(fwn
->name
, match_data
);
415 static struct fw_name_devm
*fw_find_devm_name(struct device
*dev
,
418 struct fw_name_devm
*fwn
;
420 fwn
= devres_find(dev
, fw_name_devm_release
,
421 fw_devm_match
, (void *)name
);
425 /* add firmware name into devres list */
426 static int fw_add_devm_name(struct device
*dev
, const char *name
)
428 struct fw_name_devm
*fwn
;
430 fwn
= fw_find_devm_name(dev
, name
);
434 fwn
= devres_alloc(fw_name_devm_release
, sizeof(struct fw_name_devm
) +
435 strlen(name
) + 1, GFP_KERNEL
);
439 fwn
->magic
= (unsigned long)&fw_cache
;
440 strcpy(fwn
->name
, name
);
441 devres_add(dev
, fwn
);
446 static int fw_add_devm_name(struct device
*dev
, const char *name
)
454 * user-mode helper code
456 #ifdef CONFIG_FW_LOADER_USER_HELPER
457 struct firmware_priv
{
460 struct firmware_buf
*buf
;
464 static struct firmware_priv
*to_firmware_priv(struct device
*dev
)
466 return container_of(dev
, struct firmware_priv
, dev
);
469 static void __fw_load_abort(struct firmware_buf
*buf
)
472 * There is a small window in which user can write to 'loading'
473 * between loading done and disappearance of 'loading'
475 if (test_bit(FW_STATUS_DONE
, &buf
->status
))
478 list_del_init(&buf
->pending_list
);
479 set_bit(FW_STATUS_ABORT
, &buf
->status
);
480 complete_all(&buf
->completion
);
483 static void fw_load_abort(struct firmware_priv
*fw_priv
)
485 struct firmware_buf
*buf
= fw_priv
->buf
;
487 __fw_load_abort(buf
);
489 /* avoid user action after loading abort */
493 #define is_fw_load_aborted(buf) \
494 test_bit(FW_STATUS_ABORT, &(buf)->status)
496 static LIST_HEAD(pending_fw_head
);
498 /* reboot notifier for avoid deadlock with usermode_lock */
499 static int fw_shutdown_notify(struct notifier_block
*unused1
,
500 unsigned long unused2
, void *unused3
)
502 mutex_lock(&fw_lock
);
503 while (!list_empty(&pending_fw_head
))
504 __fw_load_abort(list_first_entry(&pending_fw_head
,
507 mutex_unlock(&fw_lock
);
511 static struct notifier_block fw_shutdown_nb
= {
512 .notifier_call
= fw_shutdown_notify
,
515 static ssize_t
timeout_show(struct class *class, struct class_attribute
*attr
,
518 return sprintf(buf
, "%d\n", loading_timeout
);
522 * firmware_timeout_store - set number of seconds to wait for firmware
523 * @class: device class pointer
524 * @attr: device attribute pointer
525 * @buf: buffer to scan for timeout value
526 * @count: number of bytes in @buf
528 * Sets the number of seconds to wait for the firmware. Once
529 * this expires an error will be returned to the driver and no
530 * firmware will be provided.
532 * Note: zero means 'wait forever'.
534 static ssize_t
timeout_store(struct class *class, struct class_attribute
*attr
,
535 const char *buf
, size_t count
)
537 loading_timeout
= simple_strtol(buf
, NULL
, 10);
538 if (loading_timeout
< 0)
544 static struct class_attribute firmware_class_attrs
[] = {
549 static void fw_dev_release(struct device
*dev
)
551 struct firmware_priv
*fw_priv
= to_firmware_priv(dev
);
556 static int firmware_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
558 struct firmware_priv
*fw_priv
= to_firmware_priv(dev
);
560 if (add_uevent_var(env
, "FIRMWARE=%s", fw_priv
->buf
->fw_id
))
562 if (add_uevent_var(env
, "TIMEOUT=%i", loading_timeout
))
564 if (add_uevent_var(env
, "ASYNC=%d", fw_priv
->nowait
))
570 static struct class firmware_class
= {
572 .class_attrs
= firmware_class_attrs
,
573 .dev_uevent
= firmware_uevent
,
574 .dev_release
= fw_dev_release
,
577 static ssize_t
firmware_loading_show(struct device
*dev
,
578 struct device_attribute
*attr
, char *buf
)
580 struct firmware_priv
*fw_priv
= to_firmware_priv(dev
);
583 mutex_lock(&fw_lock
);
585 loading
= test_bit(FW_STATUS_LOADING
, &fw_priv
->buf
->status
);
586 mutex_unlock(&fw_lock
);
588 return sprintf(buf
, "%d\n", loading
);
591 /* Some architectures don't have PAGE_KERNEL_RO */
592 #ifndef PAGE_KERNEL_RO
593 #define PAGE_KERNEL_RO PAGE_KERNEL
596 /* one pages buffer should be mapped/unmapped only once */
597 static int fw_map_pages_buf(struct firmware_buf
*buf
)
599 if (!buf
->is_paged_buf
)
603 buf
->data
= vmap(buf
->pages
, buf
->nr_pages
, 0, PAGE_KERNEL_RO
);
610 * firmware_loading_store - set value in the 'loading' control file
611 * @dev: device pointer
612 * @attr: device attribute pointer
613 * @buf: buffer to scan for loading control value
614 * @count: number of bytes in @buf
616 * The relevant values are:
618 * 1: Start a load, discarding any previous partial load.
619 * 0: Conclude the load and hand the data to the driver code.
620 * -1: Conclude the load with an error and discard any written data.
622 static ssize_t
firmware_loading_store(struct device
*dev
,
623 struct device_attribute
*attr
,
624 const char *buf
, size_t count
)
626 struct firmware_priv
*fw_priv
= to_firmware_priv(dev
);
627 struct firmware_buf
*fw_buf
;
628 ssize_t written
= count
;
629 int loading
= simple_strtol(buf
, NULL
, 10);
632 mutex_lock(&fw_lock
);
633 fw_buf
= fw_priv
->buf
;
639 /* discarding any previous partial load */
640 if (!test_bit(FW_STATUS_DONE
, &fw_buf
->status
)) {
641 for (i
= 0; i
< fw_buf
->nr_pages
; i
++)
642 __free_page(fw_buf
->pages
[i
]);
643 kfree(fw_buf
->pages
);
644 fw_buf
->pages
= NULL
;
645 fw_buf
->page_array_size
= 0;
646 fw_buf
->nr_pages
= 0;
647 set_bit(FW_STATUS_LOADING
, &fw_buf
->status
);
651 if (test_bit(FW_STATUS_LOADING
, &fw_buf
->status
)) {
654 set_bit(FW_STATUS_DONE
, &fw_buf
->status
);
655 clear_bit(FW_STATUS_LOADING
, &fw_buf
->status
);
658 * Several loading requests may be pending on
659 * one same firmware buf, so let all requests
660 * see the mapped 'buf->data' once the loading
663 rc
= fw_map_pages_buf(fw_buf
);
665 dev_err(dev
, "%s: map pages failed\n",
668 rc
= security_kernel_fw_from_file(NULL
,
669 fw_buf
->data
, fw_buf
->size
);
672 * Same logic as fw_load_abort, only the DONE bit
673 * is ignored and we set ABORT only on failure.
675 list_del_init(&fw_buf
->pending_list
);
677 set_bit(FW_STATUS_ABORT
, &fw_buf
->status
);
680 complete_all(&fw_buf
->completion
);
685 dev_err(dev
, "%s: unexpected value (%d)\n", __func__
, loading
);
688 fw_load_abort(fw_priv
);
692 mutex_unlock(&fw_lock
);
696 static DEVICE_ATTR(loading
, 0644, firmware_loading_show
, firmware_loading_store
);
698 static ssize_t
firmware_data_read(struct file
*filp
, struct kobject
*kobj
,
699 struct bin_attribute
*bin_attr
,
700 char *buffer
, loff_t offset
, size_t count
)
702 struct device
*dev
= kobj_to_dev(kobj
);
703 struct firmware_priv
*fw_priv
= to_firmware_priv(dev
);
704 struct firmware_buf
*buf
;
707 mutex_lock(&fw_lock
);
709 if (!buf
|| test_bit(FW_STATUS_DONE
, &buf
->status
)) {
713 if (offset
> buf
->size
) {
717 if (count
> buf
->size
- offset
)
718 count
= buf
->size
- offset
;
724 int page_nr
= offset
>> PAGE_SHIFT
;
725 int page_ofs
= offset
& (PAGE_SIZE
-1);
726 int page_cnt
= min_t(size_t, PAGE_SIZE
- page_ofs
, count
);
728 page_data
= kmap(buf
->pages
[page_nr
]);
730 memcpy(buffer
, page_data
+ page_ofs
, page_cnt
);
732 kunmap(buf
->pages
[page_nr
]);
738 mutex_unlock(&fw_lock
);
742 static int fw_realloc_buffer(struct firmware_priv
*fw_priv
, int min_size
)
744 struct firmware_buf
*buf
= fw_priv
->buf
;
745 int pages_needed
= PAGE_ALIGN(min_size
) >> PAGE_SHIFT
;
747 /* If the array of pages is too small, grow it... */
748 if (buf
->page_array_size
< pages_needed
) {
749 int new_array_size
= max(pages_needed
,
750 buf
->page_array_size
* 2);
751 struct page
**new_pages
;
753 new_pages
= kmalloc(new_array_size
* sizeof(void *),
756 fw_load_abort(fw_priv
);
759 memcpy(new_pages
, buf
->pages
,
760 buf
->page_array_size
* sizeof(void *));
761 memset(&new_pages
[buf
->page_array_size
], 0, sizeof(void *) *
762 (new_array_size
- buf
->page_array_size
));
764 buf
->pages
= new_pages
;
765 buf
->page_array_size
= new_array_size
;
768 while (buf
->nr_pages
< pages_needed
) {
769 buf
->pages
[buf
->nr_pages
] =
770 alloc_page(GFP_KERNEL
| __GFP_HIGHMEM
);
772 if (!buf
->pages
[buf
->nr_pages
]) {
773 fw_load_abort(fw_priv
);
782 * firmware_data_write - write method for firmware
783 * @filp: open sysfs file
784 * @kobj: kobject for the device
785 * @bin_attr: bin_attr structure
786 * @buffer: buffer being written
787 * @offset: buffer offset for write in total data store area
788 * @count: buffer size
790 * Data written to the 'data' attribute will be later handed to
791 * the driver as a firmware image.
793 static ssize_t
firmware_data_write(struct file
*filp
, struct kobject
*kobj
,
794 struct bin_attribute
*bin_attr
,
795 char *buffer
, loff_t offset
, size_t count
)
797 struct device
*dev
= kobj_to_dev(kobj
);
798 struct firmware_priv
*fw_priv
= to_firmware_priv(dev
);
799 struct firmware_buf
*buf
;
802 if (!capable(CAP_SYS_RAWIO
))
805 mutex_lock(&fw_lock
);
807 if (!buf
|| test_bit(FW_STATUS_DONE
, &buf
->status
)) {
812 retval
= fw_realloc_buffer(fw_priv
, offset
+ count
);
820 int page_nr
= offset
>> PAGE_SHIFT
;
821 int page_ofs
= offset
& (PAGE_SIZE
- 1);
822 int page_cnt
= min_t(size_t, PAGE_SIZE
- page_ofs
, count
);
824 page_data
= kmap(buf
->pages
[page_nr
]);
826 memcpy(page_data
+ page_ofs
, buffer
, page_cnt
);
828 kunmap(buf
->pages
[page_nr
]);
834 buf
->size
= max_t(size_t, offset
, buf
->size
);
836 mutex_unlock(&fw_lock
);
840 static struct bin_attribute firmware_attr_data
= {
841 .attr
= { .name
= "data", .mode
= 0644 },
843 .read
= firmware_data_read
,
844 .write
= firmware_data_write
,
847 static struct attribute
*fw_dev_attrs
[] = {
848 &dev_attr_loading
.attr
,
852 static struct bin_attribute
*fw_dev_bin_attrs
[] = {
857 static const struct attribute_group fw_dev_attr_group
= {
858 .attrs
= fw_dev_attrs
,
859 .bin_attrs
= fw_dev_bin_attrs
,
862 static const struct attribute_group
*fw_dev_attr_groups
[] = {
867 static struct firmware_priv
*
868 fw_create_instance(struct firmware
*firmware
, const char *fw_name
,
869 struct device
*device
, unsigned int opt_flags
)
871 struct firmware_priv
*fw_priv
;
872 struct device
*f_dev
;
874 fw_priv
= kzalloc(sizeof(*fw_priv
), GFP_KERNEL
);
876 fw_priv
= ERR_PTR(-ENOMEM
);
880 fw_priv
->nowait
= !!(opt_flags
& FW_OPT_NOWAIT
);
881 fw_priv
->fw
= firmware
;
882 f_dev
= &fw_priv
->dev
;
884 device_initialize(f_dev
);
885 dev_set_name(f_dev
, "%s", fw_name
);
886 f_dev
->parent
= device
;
887 f_dev
->class = &firmware_class
;
888 f_dev
->groups
= fw_dev_attr_groups
;
893 /* load a firmware via user helper */
894 static int _request_firmware_load(struct firmware_priv
*fw_priv
,
895 unsigned int opt_flags
, long timeout
)
898 struct device
*f_dev
= &fw_priv
->dev
;
899 struct firmware_buf
*buf
= fw_priv
->buf
;
901 /* fall back on userspace loading */
902 buf
->is_paged_buf
= true;
904 dev_set_uevent_suppress(f_dev
, true);
906 retval
= device_add(f_dev
);
908 dev_err(f_dev
, "%s: device_register failed\n", __func__
);
912 mutex_lock(&fw_lock
);
913 list_add(&buf
->pending_list
, &pending_fw_head
);
914 mutex_unlock(&fw_lock
);
916 if (opt_flags
& FW_OPT_UEVENT
) {
917 buf
->need_uevent
= true;
918 dev_set_uevent_suppress(f_dev
, false);
919 dev_dbg(f_dev
, "firmware: requesting %s\n", buf
->fw_id
);
920 kobject_uevent(&fw_priv
->dev
.kobj
, KOBJ_ADD
);
922 timeout
= MAX_JIFFY_OFFSET
;
925 retval
= wait_for_completion_interruptible_timeout(&buf
->completion
,
927 if (retval
== -ERESTARTSYS
|| !retval
) {
928 mutex_lock(&fw_lock
);
929 fw_load_abort(fw_priv
);
930 mutex_unlock(&fw_lock
);
931 } else if (retval
> 0) {
935 if (is_fw_load_aborted(buf
))
946 static int fw_load_from_user_helper(struct firmware
*firmware
,
947 const char *name
, struct device
*device
,
948 unsigned int opt_flags
, long timeout
)
950 struct firmware_priv
*fw_priv
;
952 fw_priv
= fw_create_instance(firmware
, name
, device
, opt_flags
);
954 return PTR_ERR(fw_priv
);
956 fw_priv
->buf
= firmware
->priv
;
957 return _request_firmware_load(fw_priv
, opt_flags
, timeout
);
960 #ifdef CONFIG_PM_SLEEP
961 /* kill pending requests without uevent to avoid blocking suspend */
962 static void kill_requests_without_uevent(void)
964 struct firmware_buf
*buf
;
965 struct firmware_buf
*next
;
967 mutex_lock(&fw_lock
);
968 list_for_each_entry_safe(buf
, next
, &pending_fw_head
, pending_list
) {
969 if (!buf
->need_uevent
)
970 __fw_load_abort(buf
);
972 mutex_unlock(&fw_lock
);
976 #else /* CONFIG_FW_LOADER_USER_HELPER */
978 fw_load_from_user_helper(struct firmware
*firmware
, const char *name
,
979 struct device
*device
, unsigned int opt_flags
,
985 /* No abort during direct loading */
986 #define is_fw_load_aborted(buf) false
988 #ifdef CONFIG_PM_SLEEP
989 static inline void kill_requests_without_uevent(void) { }
992 #endif /* CONFIG_FW_LOADER_USER_HELPER */
995 /* wait until the shared firmware_buf becomes ready (or error) */
996 static int sync_cached_firmware_buf(struct firmware_buf
*buf
)
1000 mutex_lock(&fw_lock
);
1001 while (!test_bit(FW_STATUS_DONE
, &buf
->status
)) {
1002 if (is_fw_load_aborted(buf
)) {
1006 mutex_unlock(&fw_lock
);
1007 ret
= wait_for_completion_interruptible(&buf
->completion
);
1008 mutex_lock(&fw_lock
);
1010 mutex_unlock(&fw_lock
);
1014 /* prepare firmware and firmware_buf structs;
1015 * return 0 if a firmware is already assigned, 1 if need to load one,
1016 * or a negative error code
1019 _request_firmware_prepare(struct firmware
**firmware_p
, const char *name
,
1020 struct device
*device
)
1022 struct firmware
*firmware
;
1023 struct firmware_buf
*buf
;
1026 *firmware_p
= firmware
= kzalloc(sizeof(*firmware
), GFP_KERNEL
);
1028 dev_err(device
, "%s: kmalloc(struct firmware) failed\n",
1033 if (fw_get_builtin_firmware(firmware
, name
)) {
1034 dev_dbg(device
, "firmware: using built-in firmware %s\n", name
);
1035 return 0; /* assigned */
1038 ret
= fw_lookup_and_allocate_buf(name
, &fw_cache
, &buf
);
1041 * bind with 'buf' now to avoid warning in failure path
1042 * of requesting firmware.
1044 firmware
->priv
= buf
;
1047 ret
= sync_cached_firmware_buf(buf
);
1049 fw_set_page_data(buf
, firmware
);
1050 return 0; /* assigned */
1056 return 1; /* need to load */
1059 static int assign_firmware_buf(struct firmware
*fw
, struct device
*device
,
1060 unsigned int opt_flags
)
1062 struct firmware_buf
*buf
= fw
->priv
;
1064 mutex_lock(&fw_lock
);
1065 if (!buf
->size
|| is_fw_load_aborted(buf
)) {
1066 mutex_unlock(&fw_lock
);
1071 * add firmware name into devres list so that we can auto cache
1072 * and uncache firmware for device.
1074 * device may has been deleted already, but the problem
1075 * should be fixed in devres or driver core.
1077 /* don't cache firmware handled without uevent */
1078 if (device
&& (opt_flags
& FW_OPT_UEVENT
))
1079 fw_add_devm_name(device
, buf
->fw_id
);
1082 * After caching firmware image is started, let it piggyback
1083 * on request firmware.
1085 if (buf
->fwc
->state
== FW_LOADER_START_CACHE
) {
1086 if (fw_cache_piggyback_on_request(buf
->fw_id
))
1087 kref_get(&buf
->ref
);
1090 /* pass the pages buffer to driver at the last minute */
1091 fw_set_page_data(buf
, fw
);
1092 mutex_unlock(&fw_lock
);
1096 /* called from request_firmware() and request_firmware_work_func() */
1098 _request_firmware(const struct firmware
**firmware_p
, const char *name
,
1099 struct device
*device
, unsigned int opt_flags
)
1101 struct firmware
*fw
;
1108 if (!name
|| name
[0] == '\0')
1111 ret
= _request_firmware_prepare(&fw
, name
, device
);
1112 if (ret
<= 0) /* error or already assigned */
1116 timeout
= firmware_loading_timeout();
1117 if (opt_flags
& FW_OPT_NOWAIT
) {
1118 timeout
= usermodehelper_read_lock_wait(timeout
);
1120 dev_dbg(device
, "firmware: %s loading timed out\n",
1126 ret
= usermodehelper_read_trylock();
1128 dev_err(device
, "firmware: %s will not be loaded\n",
1134 ret
= fw_get_filesystem_firmware(device
, fw
->priv
);
1136 if (!(opt_flags
& FW_OPT_NO_WARN
))
1138 "Direct firmware load for %s failed with error %d\n",
1140 if (opt_flags
& FW_OPT_USERHELPER
) {
1141 dev_warn(device
, "Falling back to user helper\n");
1142 ret
= fw_load_from_user_helper(fw
, name
, device
,
1143 opt_flags
, timeout
);
1148 ret
= assign_firmware_buf(fw
, device
, opt_flags
);
1150 usermodehelper_read_unlock();
1154 release_firmware(fw
);
1163 * request_firmware: - send firmware request and wait for it
1164 * @firmware_p: pointer to firmware image
1165 * @name: name of firmware file
1166 * @device: device for which firmware is being loaded
1168 * @firmware_p will be used to return a firmware image by the name
1169 * of @name for device @device.
1171 * Should be called from user context where sleeping is allowed.
1173 * @name will be used as $FIRMWARE in the uevent environment and
1174 * should be distinctive enough not to be confused with any other
1175 * firmware image for this or any other device.
1177 * Caller must hold the reference count of @device.
1179 * The function can be called safely inside device's suspend and
1183 request_firmware(const struct firmware
**firmware_p
, const char *name
,
1184 struct device
*device
)
1188 /* Need to pin this module until return */
1189 __module_get(THIS_MODULE
);
1190 ret
= _request_firmware(firmware_p
, name
, device
,
1191 FW_OPT_UEVENT
| FW_OPT_FALLBACK
);
1192 module_put(THIS_MODULE
);
1195 EXPORT_SYMBOL(request_firmware
);
1198 * request_firmware_direct: - load firmware directly without usermode helper
1199 * @firmware_p: pointer to firmware image
1200 * @name: name of firmware file
1201 * @device: device for which firmware is being loaded
1203 * This function works pretty much like request_firmware(), but this doesn't
1204 * fall back to usermode helper even if the firmware couldn't be loaded
1205 * directly from fs. Hence it's useful for loading optional firmwares, which
1206 * aren't always present, without extra long timeouts of udev.
1208 int request_firmware_direct(const struct firmware
**firmware_p
,
1209 const char *name
, struct device
*device
)
1213 __module_get(THIS_MODULE
);
1214 ret
= _request_firmware(firmware_p
, name
, device
,
1215 FW_OPT_UEVENT
| FW_OPT_NO_WARN
);
1216 module_put(THIS_MODULE
);
1219 EXPORT_SYMBOL_GPL(request_firmware_direct
);
1222 * release_firmware: - release the resource associated with a firmware image
1223 * @fw: firmware resource to release
1225 void release_firmware(const struct firmware
*fw
)
1228 if (!fw_is_builtin_firmware(fw
))
1229 firmware_free_data(fw
);
1233 EXPORT_SYMBOL(release_firmware
);
1236 struct firmware_work
{
1237 struct work_struct work
;
1238 struct module
*module
;
1240 struct device
*device
;
1242 void (*cont
)(const struct firmware
*fw
, void *context
);
1243 unsigned int opt_flags
;
1246 static void request_firmware_work_func(struct work_struct
*work
)
1248 struct firmware_work
*fw_work
;
1249 const struct firmware
*fw
;
1251 fw_work
= container_of(work
, struct firmware_work
, work
);
1253 _request_firmware(&fw
, fw_work
->name
, fw_work
->device
,
1254 fw_work
->opt_flags
);
1255 fw_work
->cont(fw
, fw_work
->context
);
1256 put_device(fw_work
->device
); /* taken in request_firmware_nowait() */
1258 module_put(fw_work
->module
);
1263 * request_firmware_nowait - asynchronous version of request_firmware
1264 * @module: module requesting the firmware
1265 * @uevent: sends uevent to copy the firmware image if this flag
1266 * is non-zero else the firmware copy must be done manually.
1267 * @name: name of firmware file
1268 * @device: device for which firmware is being loaded
1269 * @gfp: allocation flags
1270 * @context: will be passed over to @cont, and
1271 * @fw may be %NULL if firmware request fails.
1272 * @cont: function will be called asynchronously when the firmware
1275 * Caller must hold the reference count of @device.
1277 * Asynchronous variant of request_firmware() for user contexts:
1278 * - sleep for as small periods as possible since it may
1279 * increase kernel boot time of built-in device drivers
1280 * requesting firmware in their ->probe() methods, if
1281 * @gfp is GFP_KERNEL.
1283 * - can't sleep at all if @gfp is GFP_ATOMIC.
1286 request_firmware_nowait(
1287 struct module
*module
, bool uevent
,
1288 const char *name
, struct device
*device
, gfp_t gfp
, void *context
,
1289 void (*cont
)(const struct firmware
*fw
, void *context
))
1291 struct firmware_work
*fw_work
;
1293 fw_work
= kzalloc(sizeof(struct firmware_work
), gfp
);
1297 fw_work
->module
= module
;
1298 fw_work
->name
= name
;
1299 fw_work
->device
= device
;
1300 fw_work
->context
= context
;
1301 fw_work
->cont
= cont
;
1302 fw_work
->opt_flags
= FW_OPT_NOWAIT
| FW_OPT_FALLBACK
|
1303 (uevent
? FW_OPT_UEVENT
: FW_OPT_USERHELPER
);
1305 if (!try_module_get(module
)) {
1310 get_device(fw_work
->device
);
1311 INIT_WORK(&fw_work
->work
, request_firmware_work_func
);
1312 schedule_work(&fw_work
->work
);
1315 EXPORT_SYMBOL(request_firmware_nowait
);
1317 #ifdef CONFIG_PM_SLEEP
1318 static ASYNC_DOMAIN_EXCLUSIVE(fw_cache_domain
);
1321 * cache_firmware - cache one firmware image in kernel memory space
1322 * @fw_name: the firmware image name
1324 * Cache firmware in kernel memory so that drivers can use it when
1325 * system isn't ready for them to request firmware image from userspace.
1326 * Once it returns successfully, driver can use request_firmware or its
1327 * nowait version to get the cached firmware without any interacting
1330 * Return 0 if the firmware image has been cached successfully
1331 * Return !0 otherwise
1334 static int cache_firmware(const char *fw_name
)
1337 const struct firmware
*fw
;
1339 pr_debug("%s: %s\n", __func__
, fw_name
);
1341 ret
= request_firmware(&fw
, fw_name
, NULL
);
1345 pr_debug("%s: %s ret=%d\n", __func__
, fw_name
, ret
);
1350 static struct firmware_buf
*fw_lookup_buf(const char *fw_name
)
1352 struct firmware_buf
*tmp
;
1353 struct firmware_cache
*fwc
= &fw_cache
;
1355 spin_lock(&fwc
->lock
);
1356 tmp
= __fw_lookup_buf(fw_name
);
1357 spin_unlock(&fwc
->lock
);
1363 * uncache_firmware - remove one cached firmware image
1364 * @fw_name: the firmware image name
1366 * Uncache one firmware image which has been cached successfully
1369 * Return 0 if the firmware cache has been removed successfully
1370 * Return !0 otherwise
1373 static int uncache_firmware(const char *fw_name
)
1375 struct firmware_buf
*buf
;
1378 pr_debug("%s: %s\n", __func__
, fw_name
);
1380 if (fw_get_builtin_firmware(&fw
, fw_name
))
1383 buf
= fw_lookup_buf(fw_name
);
1392 static struct fw_cache_entry
*alloc_fw_cache_entry(const char *name
)
1394 struct fw_cache_entry
*fce
;
1396 fce
= kzalloc(sizeof(*fce
) + strlen(name
) + 1, GFP_ATOMIC
);
1400 strcpy(fce
->name
, name
);
1405 static int __fw_entry_found(const char *name
)
1407 struct firmware_cache
*fwc
= &fw_cache
;
1408 struct fw_cache_entry
*fce
;
1410 list_for_each_entry(fce
, &fwc
->fw_names
, list
) {
1411 if (!strcmp(fce
->name
, name
))
1417 static int fw_cache_piggyback_on_request(const char *name
)
1419 struct firmware_cache
*fwc
= &fw_cache
;
1420 struct fw_cache_entry
*fce
;
1423 spin_lock(&fwc
->name_lock
);
1424 if (__fw_entry_found(name
))
1427 fce
= alloc_fw_cache_entry(name
);
1430 list_add(&fce
->list
, &fwc
->fw_names
);
1431 pr_debug("%s: fw: %s\n", __func__
, name
);
1434 spin_unlock(&fwc
->name_lock
);
1438 static void free_fw_cache_entry(struct fw_cache_entry
*fce
)
1443 static void __async_dev_cache_fw_image(void *fw_entry
,
1444 async_cookie_t cookie
)
1446 struct fw_cache_entry
*fce
= fw_entry
;
1447 struct firmware_cache
*fwc
= &fw_cache
;
1450 ret
= cache_firmware(fce
->name
);
1452 spin_lock(&fwc
->name_lock
);
1453 list_del(&fce
->list
);
1454 spin_unlock(&fwc
->name_lock
);
1456 free_fw_cache_entry(fce
);
1460 /* called with dev->devres_lock held */
1461 static void dev_create_fw_entry(struct device
*dev
, void *res
,
1464 struct fw_name_devm
*fwn
= res
;
1465 const char *fw_name
= fwn
->name
;
1466 struct list_head
*head
= data
;
1467 struct fw_cache_entry
*fce
;
1469 fce
= alloc_fw_cache_entry(fw_name
);
1471 list_add(&fce
->list
, head
);
1474 static int devm_name_match(struct device
*dev
, void *res
,
1477 struct fw_name_devm
*fwn
= res
;
1478 return (fwn
->magic
== (unsigned long)match_data
);
1481 static void dev_cache_fw_image(struct device
*dev
, void *data
)
1484 struct fw_cache_entry
*fce
;
1485 struct fw_cache_entry
*fce_next
;
1486 struct firmware_cache
*fwc
= &fw_cache
;
1488 devres_for_each_res(dev
, fw_name_devm_release
,
1489 devm_name_match
, &fw_cache
,
1490 dev_create_fw_entry
, &todo
);
1492 list_for_each_entry_safe(fce
, fce_next
, &todo
, list
) {
1493 list_del(&fce
->list
);
1495 spin_lock(&fwc
->name_lock
);
1496 /* only one cache entry for one firmware */
1497 if (!__fw_entry_found(fce
->name
)) {
1498 list_add(&fce
->list
, &fwc
->fw_names
);
1500 free_fw_cache_entry(fce
);
1503 spin_unlock(&fwc
->name_lock
);
1506 async_schedule_domain(__async_dev_cache_fw_image
,
1512 static void __device_uncache_fw_images(void)
1514 struct firmware_cache
*fwc
= &fw_cache
;
1515 struct fw_cache_entry
*fce
;
1517 spin_lock(&fwc
->name_lock
);
1518 while (!list_empty(&fwc
->fw_names
)) {
1519 fce
= list_entry(fwc
->fw_names
.next
,
1520 struct fw_cache_entry
, list
);
1521 list_del(&fce
->list
);
1522 spin_unlock(&fwc
->name_lock
);
1524 uncache_firmware(fce
->name
);
1525 free_fw_cache_entry(fce
);
1527 spin_lock(&fwc
->name_lock
);
1529 spin_unlock(&fwc
->name_lock
);
1533 * device_cache_fw_images - cache devices' firmware
1535 * If one device called request_firmware or its nowait version
1536 * successfully before, the firmware names are recored into the
1537 * device's devres link list, so device_cache_fw_images can call
1538 * cache_firmware() to cache these firmwares for the device,
1539 * then the device driver can load its firmwares easily at
1540 * time when system is not ready to complete loading firmware.
1542 static void device_cache_fw_images(void)
1544 struct firmware_cache
*fwc
= &fw_cache
;
1548 pr_debug("%s\n", __func__
);
1550 /* cancel uncache work */
1551 cancel_delayed_work_sync(&fwc
->work
);
1554 * use small loading timeout for caching devices' firmware
1555 * because all these firmware images have been loaded
1556 * successfully at lease once, also system is ready for
1557 * completing firmware loading now. The maximum size of
1558 * firmware in current distributions is about 2M bytes,
1559 * so 10 secs should be enough.
1561 old_timeout
= loading_timeout
;
1562 loading_timeout
= 10;
1564 mutex_lock(&fw_lock
);
1565 fwc
->state
= FW_LOADER_START_CACHE
;
1566 dpm_for_each_dev(NULL
, dev_cache_fw_image
);
1567 mutex_unlock(&fw_lock
);
1569 /* wait for completion of caching firmware for all devices */
1570 async_synchronize_full_domain(&fw_cache_domain
);
1572 loading_timeout
= old_timeout
;
1576 * device_uncache_fw_images - uncache devices' firmware
1578 * uncache all firmwares which have been cached successfully
1579 * by device_uncache_fw_images earlier
1581 static void device_uncache_fw_images(void)
1583 pr_debug("%s\n", __func__
);
1584 __device_uncache_fw_images();
1587 static void device_uncache_fw_images_work(struct work_struct
*work
)
1589 device_uncache_fw_images();
1593 * device_uncache_fw_images_delay - uncache devices firmwares
1594 * @delay: number of milliseconds to delay uncache device firmwares
1596 * uncache all devices's firmwares which has been cached successfully
1597 * by device_cache_fw_images after @delay milliseconds.
1599 static void device_uncache_fw_images_delay(unsigned long delay
)
1601 queue_delayed_work(system_power_efficient_wq
, &fw_cache
.work
,
1602 msecs_to_jiffies(delay
));
1605 static int fw_pm_notify(struct notifier_block
*notify_block
,
1606 unsigned long mode
, void *unused
)
1609 case PM_HIBERNATION_PREPARE
:
1610 case PM_SUSPEND_PREPARE
:
1611 case PM_RESTORE_PREPARE
:
1612 kill_requests_without_uevent();
1613 device_cache_fw_images();
1616 case PM_POST_SUSPEND
:
1617 case PM_POST_HIBERNATION
:
1618 case PM_POST_RESTORE
:
1620 * In case that system sleep failed and syscore_suspend is
1623 mutex_lock(&fw_lock
);
1624 fw_cache
.state
= FW_LOADER_NO_CACHE
;
1625 mutex_unlock(&fw_lock
);
1627 device_uncache_fw_images_delay(10 * MSEC_PER_SEC
);
1634 /* stop caching firmware once syscore_suspend is reached */
1635 static int fw_suspend(void)
1637 fw_cache
.state
= FW_LOADER_NO_CACHE
;
1641 static struct syscore_ops fw_syscore_ops
= {
1642 .suspend
= fw_suspend
,
1645 static int fw_cache_piggyback_on_request(const char *name
)
1651 static void __init
fw_cache_init(void)
1653 spin_lock_init(&fw_cache
.lock
);
1654 INIT_LIST_HEAD(&fw_cache
.head
);
1655 fw_cache
.state
= FW_LOADER_NO_CACHE
;
1657 #ifdef CONFIG_PM_SLEEP
1658 spin_lock_init(&fw_cache
.name_lock
);
1659 INIT_LIST_HEAD(&fw_cache
.fw_names
);
1661 INIT_DELAYED_WORK(&fw_cache
.work
,
1662 device_uncache_fw_images_work
);
1664 fw_cache
.pm_notify
.notifier_call
= fw_pm_notify
;
1665 register_pm_notifier(&fw_cache
.pm_notify
);
1667 register_syscore_ops(&fw_syscore_ops
);
1671 static int __init
firmware_class_init(void)
1674 #ifdef CONFIG_FW_LOADER_USER_HELPER
1675 register_reboot_notifier(&fw_shutdown_nb
);
1676 return class_register(&firmware_class
);
1682 static void __exit
firmware_class_exit(void)
1684 #ifdef CONFIG_PM_SLEEP
1685 unregister_syscore_ops(&fw_syscore_ops
);
1686 unregister_pm_notifier(&fw_cache
.pm_notify
);
1688 #ifdef CONFIG_FW_LOADER_USER_HELPER
1689 unregister_reboot_notifier(&fw_shutdown_nb
);
1690 class_unregister(&firmware_class
);
1694 fs_initcall(firmware_class_init
);
1695 module_exit(firmware_class_exit
);