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
)
457 list_del_init(&buf
->pending_list
);
458 set_bit(FW_STATUS_ABORT
, &buf
->status
);
459 complete_all(&buf
->completion
);
462 #define is_fw_load_aborted(buf) \
463 test_bit(FW_STATUS_ABORT, &(buf)->status)
465 static LIST_HEAD(pending_fw_head
);
467 /* reboot notifier for avoid deadlock with usermode_lock */
468 static int fw_shutdown_notify(struct notifier_block
*unused1
,
469 unsigned long unused2
, void *unused3
)
471 mutex_lock(&fw_lock
);
472 while (!list_empty(&pending_fw_head
))
473 fw_load_abort(list_first_entry(&pending_fw_head
,
476 mutex_unlock(&fw_lock
);
480 static struct notifier_block fw_shutdown_nb
= {
481 .notifier_call
= fw_shutdown_notify
,
484 static ssize_t
firmware_timeout_show(struct class *class,
485 struct class_attribute
*attr
,
488 return sprintf(buf
, "%d\n", loading_timeout
);
492 * firmware_timeout_store - set number of seconds to wait for firmware
493 * @class: device class pointer
494 * @attr: device attribute pointer
495 * @buf: buffer to scan for timeout value
496 * @count: number of bytes in @buf
498 * Sets the number of seconds to wait for the firmware. Once
499 * this expires an error will be returned to the driver and no
500 * firmware will be provided.
502 * Note: zero means 'wait forever'.
504 static ssize_t
firmware_timeout_store(struct class *class,
505 struct class_attribute
*attr
,
506 const char *buf
, size_t count
)
508 loading_timeout
= simple_strtol(buf
, NULL
, 10);
509 if (loading_timeout
< 0)
515 static struct class_attribute firmware_class_attrs
[] = {
516 __ATTR(timeout
, S_IWUSR
| S_IRUGO
,
517 firmware_timeout_show
, firmware_timeout_store
),
521 static void fw_dev_release(struct device
*dev
)
523 struct firmware_priv
*fw_priv
= to_firmware_priv(dev
);
528 static int firmware_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
530 struct firmware_priv
*fw_priv
= to_firmware_priv(dev
);
532 if (add_uevent_var(env
, "FIRMWARE=%s", fw_priv
->buf
->fw_id
))
534 if (add_uevent_var(env
, "TIMEOUT=%i", loading_timeout
))
536 if (add_uevent_var(env
, "ASYNC=%d", fw_priv
->nowait
))
542 static struct class firmware_class
= {
544 .class_attrs
= firmware_class_attrs
,
545 .dev_uevent
= firmware_uevent
,
546 .dev_release
= fw_dev_release
,
549 static ssize_t
firmware_loading_show(struct device
*dev
,
550 struct device_attribute
*attr
, char *buf
)
552 struct firmware_priv
*fw_priv
= to_firmware_priv(dev
);
553 int loading
= test_bit(FW_STATUS_LOADING
, &fw_priv
->buf
->status
);
555 return sprintf(buf
, "%d\n", loading
);
558 /* Some architectures don't have PAGE_KERNEL_RO */
559 #ifndef PAGE_KERNEL_RO
560 #define PAGE_KERNEL_RO PAGE_KERNEL
563 /* one pages buffer should be mapped/unmapped only once */
564 static int fw_map_pages_buf(struct firmware_buf
*buf
)
566 if (!buf
->is_paged_buf
)
571 buf
->data
= vmap(buf
->pages
, buf
->nr_pages
, 0, PAGE_KERNEL_RO
);
578 * firmware_loading_store - set value in the 'loading' control file
579 * @dev: device pointer
580 * @attr: device attribute pointer
581 * @buf: buffer to scan for loading control value
582 * @count: number of bytes in @buf
584 * The relevant values are:
586 * 1: Start a load, discarding any previous partial load.
587 * 0: Conclude the load and hand the data to the driver code.
588 * -1: Conclude the load with an error and discard any written data.
590 static ssize_t
firmware_loading_store(struct device
*dev
,
591 struct device_attribute
*attr
,
592 const char *buf
, size_t count
)
594 struct firmware_priv
*fw_priv
= to_firmware_priv(dev
);
595 struct firmware_buf
*fw_buf
= fw_priv
->buf
;
596 int loading
= simple_strtol(buf
, NULL
, 10);
599 mutex_lock(&fw_lock
);
606 /* discarding any previous partial load */
607 if (!test_bit(FW_STATUS_DONE
, &fw_buf
->status
)) {
608 for (i
= 0; i
< fw_buf
->nr_pages
; i
++)
609 __free_page(fw_buf
->pages
[i
]);
610 kfree(fw_buf
->pages
);
611 fw_buf
->pages
= NULL
;
612 fw_buf
->page_array_size
= 0;
613 fw_buf
->nr_pages
= 0;
614 set_bit(FW_STATUS_LOADING
, &fw_buf
->status
);
618 if (test_bit(FW_STATUS_LOADING
, &fw_buf
->status
)) {
619 set_bit(FW_STATUS_DONE
, &fw_buf
->status
);
620 clear_bit(FW_STATUS_LOADING
, &fw_buf
->status
);
623 * Several loading requests may be pending on
624 * one same firmware buf, so let all requests
625 * see the mapped 'buf->data' once the loading
628 fw_map_pages_buf(fw_buf
);
629 list_del_init(&fw_buf
->pending_list
);
630 complete_all(&fw_buf
->completion
);
635 dev_err(dev
, "%s: unexpected value (%d)\n", __func__
, loading
);
638 fw_load_abort(fw_buf
);
642 mutex_unlock(&fw_lock
);
646 static DEVICE_ATTR(loading
, 0644, firmware_loading_show
, firmware_loading_store
);
648 static ssize_t
firmware_data_read(struct file
*filp
, struct kobject
*kobj
,
649 struct bin_attribute
*bin_attr
,
650 char *buffer
, loff_t offset
, size_t count
)
652 struct device
*dev
= kobj_to_dev(kobj
);
653 struct firmware_priv
*fw_priv
= to_firmware_priv(dev
);
654 struct firmware_buf
*buf
;
657 mutex_lock(&fw_lock
);
659 if (!buf
|| test_bit(FW_STATUS_DONE
, &buf
->status
)) {
663 if (offset
> buf
->size
) {
667 if (count
> buf
->size
- offset
)
668 count
= buf
->size
- offset
;
674 int page_nr
= offset
>> PAGE_SHIFT
;
675 int page_ofs
= offset
& (PAGE_SIZE
-1);
676 int page_cnt
= min_t(size_t, PAGE_SIZE
- page_ofs
, count
);
678 page_data
= kmap(buf
->pages
[page_nr
]);
680 memcpy(buffer
, page_data
+ page_ofs
, page_cnt
);
682 kunmap(buf
->pages
[page_nr
]);
688 mutex_unlock(&fw_lock
);
692 static int fw_realloc_buffer(struct firmware_priv
*fw_priv
, int min_size
)
694 struct firmware_buf
*buf
= fw_priv
->buf
;
695 int pages_needed
= ALIGN(min_size
, PAGE_SIZE
) >> PAGE_SHIFT
;
697 /* If the array of pages is too small, grow it... */
698 if (buf
->page_array_size
< pages_needed
) {
699 int new_array_size
= max(pages_needed
,
700 buf
->page_array_size
* 2);
701 struct page
**new_pages
;
703 new_pages
= kmalloc(new_array_size
* sizeof(void *),
709 memcpy(new_pages
, buf
->pages
,
710 buf
->page_array_size
* sizeof(void *));
711 memset(&new_pages
[buf
->page_array_size
], 0, sizeof(void *) *
712 (new_array_size
- buf
->page_array_size
));
714 buf
->pages
= new_pages
;
715 buf
->page_array_size
= new_array_size
;
718 while (buf
->nr_pages
< pages_needed
) {
719 buf
->pages
[buf
->nr_pages
] =
720 alloc_page(GFP_KERNEL
| __GFP_HIGHMEM
);
722 if (!buf
->pages
[buf
->nr_pages
]) {
732 * firmware_data_write - write method for firmware
733 * @filp: open sysfs file
734 * @kobj: kobject for the device
735 * @bin_attr: bin_attr structure
736 * @buffer: buffer being written
737 * @offset: buffer offset for write in total data store area
738 * @count: buffer size
740 * Data written to the 'data' attribute will be later handed to
741 * the driver as a firmware image.
743 static ssize_t
firmware_data_write(struct file
*filp
, struct kobject
*kobj
,
744 struct bin_attribute
*bin_attr
,
745 char *buffer
, loff_t offset
, size_t count
)
747 struct device
*dev
= kobj_to_dev(kobj
);
748 struct firmware_priv
*fw_priv
= to_firmware_priv(dev
);
749 struct firmware_buf
*buf
;
752 if (!capable(CAP_SYS_RAWIO
))
755 mutex_lock(&fw_lock
);
757 if (!buf
|| test_bit(FW_STATUS_DONE
, &buf
->status
)) {
762 retval
= fw_realloc_buffer(fw_priv
, offset
+ count
);
770 int page_nr
= offset
>> PAGE_SHIFT
;
771 int page_ofs
= offset
& (PAGE_SIZE
- 1);
772 int page_cnt
= min_t(size_t, PAGE_SIZE
- page_ofs
, count
);
774 page_data
= kmap(buf
->pages
[page_nr
]);
776 memcpy(page_data
+ page_ofs
, buffer
, page_cnt
);
778 kunmap(buf
->pages
[page_nr
]);
784 buf
->size
= max_t(size_t, offset
, buf
->size
);
786 mutex_unlock(&fw_lock
);
790 static struct bin_attribute firmware_attr_data
= {
791 .attr
= { .name
= "data", .mode
= 0644 },
793 .read
= firmware_data_read
,
794 .write
= firmware_data_write
,
797 static void firmware_class_timeout_work(struct work_struct
*work
)
799 struct firmware_priv
*fw_priv
= container_of(work
,
800 struct firmware_priv
, timeout_work
.work
);
802 mutex_lock(&fw_lock
);
803 if (test_bit(FW_STATUS_DONE
, &(fw_priv
->buf
->status
))) {
804 mutex_unlock(&fw_lock
);
807 fw_load_abort(fw_priv
->buf
);
808 mutex_unlock(&fw_lock
);
811 static struct firmware_priv
*
812 fw_create_instance(struct firmware
*firmware
, const char *fw_name
,
813 struct device
*device
, bool uevent
, bool nowait
)
815 struct firmware_priv
*fw_priv
;
816 struct device
*f_dev
;
818 fw_priv
= kzalloc(sizeof(*fw_priv
), GFP_KERNEL
);
820 dev_err(device
, "%s: kmalloc failed\n", __func__
);
821 fw_priv
= ERR_PTR(-ENOMEM
);
825 fw_priv
->nowait
= nowait
;
826 fw_priv
->fw
= firmware
;
827 INIT_DELAYED_WORK(&fw_priv
->timeout_work
,
828 firmware_class_timeout_work
);
830 f_dev
= &fw_priv
->dev
;
832 device_initialize(f_dev
);
833 dev_set_name(f_dev
, "%s", fw_name
);
834 f_dev
->parent
= device
;
835 f_dev
->class = &firmware_class
;
840 /* load a firmware via user helper */
841 static int _request_firmware_load(struct firmware_priv
*fw_priv
, bool uevent
,
845 struct device
*f_dev
= &fw_priv
->dev
;
846 struct firmware_buf
*buf
= fw_priv
->buf
;
848 /* fall back on userspace loading */
849 buf
->is_paged_buf
= true;
851 dev_set_uevent_suppress(f_dev
, true);
853 retval
= device_add(f_dev
);
855 dev_err(f_dev
, "%s: device_register failed\n", __func__
);
859 retval
= device_create_bin_file(f_dev
, &firmware_attr_data
);
861 dev_err(f_dev
, "%s: sysfs_create_bin_file failed\n", __func__
);
865 retval
= device_create_file(f_dev
, &dev_attr_loading
);
867 dev_err(f_dev
, "%s: device_create_file failed\n", __func__
);
868 goto err_del_bin_attr
;
872 buf
->need_uevent
= true;
873 dev_set_uevent_suppress(f_dev
, false);
874 dev_dbg(f_dev
, "firmware: requesting %s\n", buf
->fw_id
);
875 if (timeout
!= MAX_SCHEDULE_TIMEOUT
)
876 schedule_delayed_work(&fw_priv
->timeout_work
, timeout
);
878 kobject_uevent(&fw_priv
->dev
.kobj
, KOBJ_ADD
);
881 mutex_lock(&fw_lock
);
882 list_add(&buf
->pending_list
, &pending_fw_head
);
883 mutex_unlock(&fw_lock
);
885 wait_for_completion(&buf
->completion
);
887 cancel_delayed_work_sync(&fw_priv
->timeout_work
);
891 device_remove_file(f_dev
, &dev_attr_loading
);
893 device_remove_bin_file(f_dev
, &firmware_attr_data
);
901 static int fw_load_from_user_helper(struct firmware
*firmware
,
902 const char *name
, struct device
*device
,
903 bool uevent
, bool nowait
, long timeout
)
905 struct firmware_priv
*fw_priv
;
907 fw_priv
= fw_create_instance(firmware
, name
, device
, uevent
, nowait
);
909 return PTR_ERR(fw_priv
);
911 fw_priv
->buf
= firmware
->priv
;
912 return _request_firmware_load(fw_priv
, uevent
, timeout
);
915 #ifdef CONFIG_PM_SLEEP
916 /* kill pending requests without uevent to avoid blocking suspend */
917 static void kill_requests_without_uevent(void)
919 struct firmware_buf
*buf
;
920 struct firmware_buf
*next
;
922 mutex_lock(&fw_lock
);
923 list_for_each_entry_safe(buf
, next
, &pending_fw_head
, pending_list
) {
924 if (!buf
->need_uevent
)
927 mutex_unlock(&fw_lock
);
931 #else /* CONFIG_FW_LOADER_USER_HELPER */
933 fw_load_from_user_helper(struct firmware
*firmware
, const char *name
,
934 struct device
*device
, bool uevent
, bool nowait
,
940 /* No abort during direct loading */
941 #define is_fw_load_aborted(buf) false
943 #ifdef CONFIG_PM_SLEEP
944 static inline void kill_requests_without_uevent(void) { }
947 #endif /* CONFIG_FW_LOADER_USER_HELPER */
950 /* wait until the shared firmware_buf becomes ready (or error) */
951 static int sync_cached_firmware_buf(struct firmware_buf
*buf
)
955 mutex_lock(&fw_lock
);
956 while (!test_bit(FW_STATUS_DONE
, &buf
->status
)) {
957 if (is_fw_load_aborted(buf
)) {
961 mutex_unlock(&fw_lock
);
962 wait_for_completion(&buf
->completion
);
963 mutex_lock(&fw_lock
);
965 mutex_unlock(&fw_lock
);
969 /* prepare firmware and firmware_buf structs;
970 * return 0 if a firmware is already assigned, 1 if need to load one,
971 * or a negative error code
974 _request_firmware_prepare(struct firmware
**firmware_p
, const char *name
,
975 struct device
*device
)
977 struct firmware
*firmware
;
978 struct firmware_buf
*buf
;
981 *firmware_p
= firmware
= kzalloc(sizeof(*firmware
), GFP_KERNEL
);
983 dev_err(device
, "%s: kmalloc(struct firmware) failed\n",
988 if (fw_get_builtin_firmware(firmware
, name
)) {
989 dev_dbg(device
, "firmware: using built-in firmware %s\n", name
);
990 return 0; /* assigned */
993 ret
= fw_lookup_and_allocate_buf(name
, &fw_cache
, &buf
);
996 * bind with 'buf' now to avoid warning in failure path
997 * of requesting firmware.
999 firmware
->priv
= buf
;
1002 ret
= sync_cached_firmware_buf(buf
);
1004 fw_set_page_data(buf
, firmware
);
1005 return 0; /* assigned */
1011 return 1; /* need to load */
1014 static int assign_firmware_buf(struct firmware
*fw
, struct device
*device
,
1017 struct firmware_buf
*buf
= fw
->priv
;
1019 mutex_lock(&fw_lock
);
1020 if (!buf
->size
|| is_fw_load_aborted(buf
)) {
1021 mutex_unlock(&fw_lock
);
1026 * add firmware name into devres list so that we can auto cache
1027 * and uncache firmware for device.
1029 * device may has been deleted already, but the problem
1030 * should be fixed in devres or driver core.
1032 if (device
&& !skip_cache
)
1033 fw_add_devm_name(device
, buf
->fw_id
);
1036 * After caching firmware image is started, let it piggyback
1037 * on request firmware.
1039 if (buf
->fwc
->state
== FW_LOADER_START_CACHE
) {
1040 if (fw_cache_piggyback_on_request(buf
->fw_id
))
1041 kref_get(&buf
->ref
);
1044 /* pass the pages buffer to driver at the last minute */
1045 fw_set_page_data(buf
, fw
);
1046 mutex_unlock(&fw_lock
);
1050 /* called from request_firmware() and request_firmware_work_func() */
1052 _request_firmware(const struct firmware
**firmware_p
, const char *name
,
1053 struct device
*device
, bool uevent
, bool nowait
)
1055 struct firmware
*fw
;
1062 ret
= _request_firmware_prepare(&fw
, name
, device
);
1063 if (ret
<= 0) /* error or already assigned */
1067 timeout
= firmware_loading_timeout();
1069 timeout
= usermodehelper_read_lock_wait(timeout
);
1071 dev_dbg(device
, "firmware: %s loading timed out\n",
1077 ret
= usermodehelper_read_trylock();
1079 dev_err(device
, "firmware: %s will not be loaded\n",
1085 if (!fw_get_filesystem_firmware(device
, fw
->priv
))
1086 ret
= fw_load_from_user_helper(fw
, name
, device
,
1087 uevent
, nowait
, timeout
);
1089 /* don't cache firmware handled without uevent */
1091 ret
= assign_firmware_buf(fw
, device
, !uevent
);
1093 usermodehelper_read_unlock();
1097 release_firmware(fw
);
1106 * request_firmware: - send firmware request and wait for it
1107 * @firmware_p: pointer to firmware image
1108 * @name: name of firmware file
1109 * @device: device for which firmware is being loaded
1111 * @firmware_p will be used to return a firmware image by the name
1112 * of @name for device @device.
1114 * Should be called from user context where sleeping is allowed.
1116 * @name will be used as $FIRMWARE in the uevent environment and
1117 * should be distinctive enough not to be confused with any other
1118 * firmware image for this or any other device.
1120 * Caller must hold the reference count of @device.
1122 * The function can be called safely inside device's suspend and
1126 request_firmware(const struct firmware
**firmware_p
, const char *name
,
1127 struct device
*device
)
1131 /* Need to pin this module until return */
1132 __module_get(THIS_MODULE
);
1133 ret
= _request_firmware(firmware_p
, name
, device
, true, false);
1134 module_put(THIS_MODULE
);
1137 EXPORT_SYMBOL(request_firmware
);
1140 * release_firmware: - release the resource associated with a firmware image
1141 * @fw: firmware resource to release
1143 void release_firmware(const struct firmware
*fw
)
1146 if (!fw_is_builtin_firmware(fw
))
1147 firmware_free_data(fw
);
1151 EXPORT_SYMBOL(release_firmware
);
1154 struct firmware_work
{
1155 struct work_struct work
;
1156 struct module
*module
;
1158 struct device
*device
;
1160 void (*cont
)(const struct firmware
*fw
, void *context
);
1164 static void request_firmware_work_func(struct work_struct
*work
)
1166 struct firmware_work
*fw_work
;
1167 const struct firmware
*fw
;
1169 fw_work
= container_of(work
, struct firmware_work
, work
);
1171 _request_firmware(&fw
, fw_work
->name
, fw_work
->device
,
1172 fw_work
->uevent
, true);
1173 fw_work
->cont(fw
, fw_work
->context
);
1174 put_device(fw_work
->device
); /* taken in request_firmware_nowait() */
1176 module_put(fw_work
->module
);
1181 * request_firmware_nowait - asynchronous version of request_firmware
1182 * @module: module requesting the firmware
1183 * @uevent: sends uevent to copy the firmware image if this flag
1184 * is non-zero else the firmware copy must be done manually.
1185 * @name: name of firmware file
1186 * @device: device for which firmware is being loaded
1187 * @gfp: allocation flags
1188 * @context: will be passed over to @cont, and
1189 * @fw may be %NULL if firmware request fails.
1190 * @cont: function will be called asynchronously when the firmware
1193 * Caller must hold the reference count of @device.
1195 * Asynchronous variant of request_firmware() for user contexts:
1196 * - sleep for as small periods as possible since it may
1197 * increase kernel boot time of built-in device drivers
1198 * requesting firmware in their ->probe() methods, if
1199 * @gfp is GFP_KERNEL.
1201 * - can't sleep at all if @gfp is GFP_ATOMIC.
1204 request_firmware_nowait(
1205 struct module
*module
, bool uevent
,
1206 const char *name
, struct device
*device
, gfp_t gfp
, void *context
,
1207 void (*cont
)(const struct firmware
*fw
, void *context
))
1209 struct firmware_work
*fw_work
;
1211 fw_work
= kzalloc(sizeof (struct firmware_work
), gfp
);
1215 fw_work
->module
= module
;
1216 fw_work
->name
= name
;
1217 fw_work
->device
= device
;
1218 fw_work
->context
= context
;
1219 fw_work
->cont
= cont
;
1220 fw_work
->uevent
= uevent
;
1222 if (!try_module_get(module
)) {
1227 get_device(fw_work
->device
);
1228 INIT_WORK(&fw_work
->work
, request_firmware_work_func
);
1229 schedule_work(&fw_work
->work
);
1232 EXPORT_SYMBOL(request_firmware_nowait
);
1235 * cache_firmware - cache one firmware image in kernel memory space
1236 * @fw_name: the firmware image name
1238 * Cache firmware in kernel memory so that drivers can use it when
1239 * system isn't ready for them to request firmware image from userspace.
1240 * Once it returns successfully, driver can use request_firmware or its
1241 * nowait version to get the cached firmware without any interacting
1244 * Return 0 if the firmware image has been cached successfully
1245 * Return !0 otherwise
1248 static int cache_firmware(const char *fw_name
)
1251 const struct firmware
*fw
;
1253 pr_debug("%s: %s\n", __func__
, fw_name
);
1255 ret
= request_firmware(&fw
, fw_name
, NULL
);
1259 pr_debug("%s: %s ret=%d\n", __func__
, fw_name
, ret
);
1265 * uncache_firmware - remove one cached firmware image
1266 * @fw_name: the firmware image name
1268 * Uncache one firmware image which has been cached successfully
1271 * Return 0 if the firmware cache has been removed successfully
1272 * Return !0 otherwise
1275 static int uncache_firmware(const char *fw_name
)
1277 struct firmware_buf
*buf
;
1280 pr_debug("%s: %s\n", __func__
, fw_name
);
1282 if (fw_get_builtin_firmware(&fw
, fw_name
))
1285 buf
= fw_lookup_buf(fw_name
);
1294 #ifdef CONFIG_PM_SLEEP
1295 static ASYNC_DOMAIN_EXCLUSIVE(fw_cache_domain
);
1297 static struct fw_cache_entry
*alloc_fw_cache_entry(const char *name
)
1299 struct fw_cache_entry
*fce
;
1301 fce
= kzalloc(sizeof(*fce
) + strlen(name
) + 1, GFP_ATOMIC
);
1305 strcpy(fce
->name
, name
);
1310 static int __fw_entry_found(const char *name
)
1312 struct firmware_cache
*fwc
= &fw_cache
;
1313 struct fw_cache_entry
*fce
;
1315 list_for_each_entry(fce
, &fwc
->fw_names
, list
) {
1316 if (!strcmp(fce
->name
, name
))
1322 static int fw_cache_piggyback_on_request(const char *name
)
1324 struct firmware_cache
*fwc
= &fw_cache
;
1325 struct fw_cache_entry
*fce
;
1328 spin_lock(&fwc
->name_lock
);
1329 if (__fw_entry_found(name
))
1332 fce
= alloc_fw_cache_entry(name
);
1335 list_add(&fce
->list
, &fwc
->fw_names
);
1336 pr_debug("%s: fw: %s\n", __func__
, name
);
1339 spin_unlock(&fwc
->name_lock
);
1343 static void free_fw_cache_entry(struct fw_cache_entry
*fce
)
1348 static void __async_dev_cache_fw_image(void *fw_entry
,
1349 async_cookie_t cookie
)
1351 struct fw_cache_entry
*fce
= fw_entry
;
1352 struct firmware_cache
*fwc
= &fw_cache
;
1355 ret
= cache_firmware(fce
->name
);
1357 spin_lock(&fwc
->name_lock
);
1358 list_del(&fce
->list
);
1359 spin_unlock(&fwc
->name_lock
);
1361 free_fw_cache_entry(fce
);
1365 /* called with dev->devres_lock held */
1366 static void dev_create_fw_entry(struct device
*dev
, void *res
,
1369 struct fw_name_devm
*fwn
= res
;
1370 const char *fw_name
= fwn
->name
;
1371 struct list_head
*head
= data
;
1372 struct fw_cache_entry
*fce
;
1374 fce
= alloc_fw_cache_entry(fw_name
);
1376 list_add(&fce
->list
, head
);
1379 static int devm_name_match(struct device
*dev
, void *res
,
1382 struct fw_name_devm
*fwn
= res
;
1383 return (fwn
->magic
== (unsigned long)match_data
);
1386 static void dev_cache_fw_image(struct device
*dev
, void *data
)
1389 struct fw_cache_entry
*fce
;
1390 struct fw_cache_entry
*fce_next
;
1391 struct firmware_cache
*fwc
= &fw_cache
;
1393 devres_for_each_res(dev
, fw_name_devm_release
,
1394 devm_name_match
, &fw_cache
,
1395 dev_create_fw_entry
, &todo
);
1397 list_for_each_entry_safe(fce
, fce_next
, &todo
, list
) {
1398 list_del(&fce
->list
);
1400 spin_lock(&fwc
->name_lock
);
1401 /* only one cache entry for one firmware */
1402 if (!__fw_entry_found(fce
->name
)) {
1403 list_add(&fce
->list
, &fwc
->fw_names
);
1405 free_fw_cache_entry(fce
);
1408 spin_unlock(&fwc
->name_lock
);
1411 async_schedule_domain(__async_dev_cache_fw_image
,
1417 static void __device_uncache_fw_images(void)
1419 struct firmware_cache
*fwc
= &fw_cache
;
1420 struct fw_cache_entry
*fce
;
1422 spin_lock(&fwc
->name_lock
);
1423 while (!list_empty(&fwc
->fw_names
)) {
1424 fce
= list_entry(fwc
->fw_names
.next
,
1425 struct fw_cache_entry
, list
);
1426 list_del(&fce
->list
);
1427 spin_unlock(&fwc
->name_lock
);
1429 uncache_firmware(fce
->name
);
1430 free_fw_cache_entry(fce
);
1432 spin_lock(&fwc
->name_lock
);
1434 spin_unlock(&fwc
->name_lock
);
1438 * device_cache_fw_images - cache devices' firmware
1440 * If one device called request_firmware or its nowait version
1441 * successfully before, the firmware names are recored into the
1442 * device's devres link list, so device_cache_fw_images can call
1443 * cache_firmware() to cache these firmwares for the device,
1444 * then the device driver can load its firmwares easily at
1445 * time when system is not ready to complete loading firmware.
1447 static void device_cache_fw_images(void)
1449 struct firmware_cache
*fwc
= &fw_cache
;
1453 pr_debug("%s\n", __func__
);
1455 /* cancel uncache work */
1456 cancel_delayed_work_sync(&fwc
->work
);
1459 * use small loading timeout for caching devices' firmware
1460 * because all these firmware images have been loaded
1461 * successfully at lease once, also system is ready for
1462 * completing firmware loading now. The maximum size of
1463 * firmware in current distributions is about 2M bytes,
1464 * so 10 secs should be enough.
1466 old_timeout
= loading_timeout
;
1467 loading_timeout
= 10;
1469 mutex_lock(&fw_lock
);
1470 fwc
->state
= FW_LOADER_START_CACHE
;
1471 dpm_for_each_dev(NULL
, dev_cache_fw_image
);
1472 mutex_unlock(&fw_lock
);
1474 /* wait for completion of caching firmware for all devices */
1475 async_synchronize_full_domain(&fw_cache_domain
);
1477 loading_timeout
= old_timeout
;
1481 * device_uncache_fw_images - uncache devices' firmware
1483 * uncache all firmwares which have been cached successfully
1484 * by device_uncache_fw_images earlier
1486 static void device_uncache_fw_images(void)
1488 pr_debug("%s\n", __func__
);
1489 __device_uncache_fw_images();
1492 static void device_uncache_fw_images_work(struct work_struct
*work
)
1494 device_uncache_fw_images();
1498 * device_uncache_fw_images_delay - uncache devices firmwares
1499 * @delay: number of milliseconds to delay uncache device firmwares
1501 * uncache all devices's firmwares which has been cached successfully
1502 * by device_cache_fw_images after @delay milliseconds.
1504 static void device_uncache_fw_images_delay(unsigned long delay
)
1506 schedule_delayed_work(&fw_cache
.work
,
1507 msecs_to_jiffies(delay
));
1510 static int fw_pm_notify(struct notifier_block
*notify_block
,
1511 unsigned long mode
, void *unused
)
1514 case PM_HIBERNATION_PREPARE
:
1515 case PM_SUSPEND_PREPARE
:
1516 kill_requests_without_uevent();
1517 device_cache_fw_images();
1520 case PM_POST_SUSPEND
:
1521 case PM_POST_HIBERNATION
:
1522 case PM_POST_RESTORE
:
1524 * In case that system sleep failed and syscore_suspend is
1527 mutex_lock(&fw_lock
);
1528 fw_cache
.state
= FW_LOADER_NO_CACHE
;
1529 mutex_unlock(&fw_lock
);
1531 device_uncache_fw_images_delay(10 * MSEC_PER_SEC
);
1538 /* stop caching firmware once syscore_suspend is reached */
1539 static int fw_suspend(void)
1541 fw_cache
.state
= FW_LOADER_NO_CACHE
;
1545 static struct syscore_ops fw_syscore_ops
= {
1546 .suspend
= fw_suspend
,
1549 static int fw_cache_piggyback_on_request(const char *name
)
1555 static void __init
fw_cache_init(void)
1557 spin_lock_init(&fw_cache
.lock
);
1558 INIT_LIST_HEAD(&fw_cache
.head
);
1559 fw_cache
.state
= FW_LOADER_NO_CACHE
;
1561 #ifdef CONFIG_PM_SLEEP
1562 spin_lock_init(&fw_cache
.name_lock
);
1563 INIT_LIST_HEAD(&fw_cache
.fw_names
);
1565 INIT_DELAYED_WORK(&fw_cache
.work
,
1566 device_uncache_fw_images_work
);
1568 fw_cache
.pm_notify
.notifier_call
= fw_pm_notify
;
1569 register_pm_notifier(&fw_cache
.pm_notify
);
1571 register_syscore_ops(&fw_syscore_ops
);
1575 static int __init
firmware_class_init(void)
1578 #ifdef CONFIG_FW_LOADER_USER_HELPER
1579 register_reboot_notifier(&fw_shutdown_nb
);
1580 return class_register(&firmware_class
);
1586 static void __exit
firmware_class_exit(void)
1588 #ifdef CONFIG_PM_SLEEP
1589 unregister_syscore_ops(&fw_syscore_ops
);
1590 unregister_pm_notifier(&fw_cache
.pm_notify
);
1592 #ifdef CONFIG_FW_LOADER_USER_HELPER
1593 unregister_reboot_notifier(&fw_shutdown_nb
);
1594 class_unregister(&firmware_class
);
1598 fs_initcall(firmware_class_init
);
1599 module_exit(firmware_class_exit
);