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
134 struct list_head pending_list
;
139 struct fw_cache_entry
{
140 struct list_head list
;
144 struct fw_name_devm
{
149 #define to_fwbuf(d) container_of(d, struct firmware_buf, ref)
151 #define FW_LOADER_NO_CACHE 0
152 #define FW_LOADER_START_CACHE 1
154 static int fw_cache_piggyback_on_request(const char *name
);
156 /* fw_lock could be moved to 'struct firmware_priv' but since it is just
157 * guarding for corner cases a global lock should be OK */
158 static DEFINE_MUTEX(fw_lock
);
160 static struct firmware_cache fw_cache
;
162 static struct firmware_buf
*__allocate_fw_buf(const char *fw_name
,
163 struct firmware_cache
*fwc
)
165 struct firmware_buf
*buf
;
167 buf
= kzalloc(sizeof(*buf
) + strlen(fw_name
) + 1 , GFP_ATOMIC
);
172 kref_init(&buf
->ref
);
173 strcpy(buf
->fw_id
, fw_name
);
175 init_completion(&buf
->completion
);
176 #ifdef CONFIG_FW_LOADER_USER_HELPER
177 INIT_LIST_HEAD(&buf
->pending_list
);
180 pr_debug("%s: fw-%s buf=%p\n", __func__
, fw_name
, buf
);
185 static struct firmware_buf
*__fw_lookup_buf(const char *fw_name
)
187 struct firmware_buf
*tmp
;
188 struct firmware_cache
*fwc
= &fw_cache
;
190 list_for_each_entry(tmp
, &fwc
->head
, list
)
191 if (!strcmp(tmp
->fw_id
, fw_name
))
196 static int fw_lookup_and_allocate_buf(const char *fw_name
,
197 struct firmware_cache
*fwc
,
198 struct firmware_buf
**buf
)
200 struct firmware_buf
*tmp
;
202 spin_lock(&fwc
->lock
);
203 tmp
= __fw_lookup_buf(fw_name
);
206 spin_unlock(&fwc
->lock
);
210 tmp
= __allocate_fw_buf(fw_name
, fwc
);
212 list_add(&tmp
->list
, &fwc
->head
);
213 spin_unlock(&fwc
->lock
);
217 return tmp
? 0 : -ENOMEM
;
220 static struct firmware_buf
*fw_lookup_buf(const char *fw_name
)
222 struct firmware_buf
*tmp
;
223 struct firmware_cache
*fwc
= &fw_cache
;
225 spin_lock(&fwc
->lock
);
226 tmp
= __fw_lookup_buf(fw_name
);
227 spin_unlock(&fwc
->lock
);
232 static void __fw_free_buf(struct kref
*ref
)
234 struct firmware_buf
*buf
= to_fwbuf(ref
);
235 struct firmware_cache
*fwc
= buf
->fwc
;
237 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
238 __func__
, buf
->fw_id
, buf
, buf
->data
,
239 (unsigned int)buf
->size
);
241 list_del(&buf
->list
);
242 spin_unlock(&fwc
->lock
);
244 #ifdef CONFIG_FW_LOADER_USER_HELPER
245 if (buf
->is_paged_buf
) {
248 for (i
= 0; i
< buf
->nr_pages
; i
++)
249 __free_page(buf
->pages
[i
]);
257 static void fw_free_buf(struct firmware_buf
*buf
)
259 struct firmware_cache
*fwc
= buf
->fwc
;
260 spin_lock(&fwc
->lock
);
261 if (!kref_put(&buf
->ref
, __fw_free_buf
))
262 spin_unlock(&fwc
->lock
);
265 /* direct firmware loading support */
266 static char fw_path_para
[256];
267 static const char * const fw_path
[] = {
269 "/lib/firmware/updates/" UTS_RELEASE
,
270 "/lib/firmware/updates",
271 "/lib/firmware/" UTS_RELEASE
,
276 * Typical usage is that passing 'firmware_class.path=$CUSTOMIZED_PATH'
277 * from kernel command line because firmware_class is generally built in
278 * kernel instead of module.
280 module_param_string(path
, fw_path_para
, sizeof(fw_path_para
), 0644);
281 MODULE_PARM_DESC(path
, "customized firmware image search path with a higher priority than default path");
283 /* Don't inline this: 'struct kstat' is biggish */
284 static noinline_for_stack
long fw_file_size(struct file
*file
)
287 if (vfs_getattr(&file
->f_path
, &st
))
289 if (!S_ISREG(st
.mode
))
291 if (st
.size
!= (long)st
.size
)
296 static bool fw_read_file_contents(struct file
*file
, struct firmware_buf
*fw_buf
)
301 size
= fw_file_size(file
);
307 if (kernel_read(file
, 0, buf
, size
) != size
) {
316 static bool fw_get_filesystem_firmware(struct device
*device
,
317 struct firmware_buf
*buf
)
320 bool success
= false;
321 char *path
= __getname();
323 for (i
= 0; i
< ARRAY_SIZE(fw_path
); i
++) {
326 /* skip the unset customized path */
330 snprintf(path
, PATH_MAX
, "%s/%s", fw_path
[i
], buf
->fw_id
);
332 file
= filp_open(path
, O_RDONLY
, 0);
335 success
= fw_read_file_contents(file
, buf
);
343 dev_dbg(device
, "firmware: direct-loading firmware %s\n",
345 mutex_lock(&fw_lock
);
346 set_bit(FW_STATUS_DONE
, &buf
->status
);
347 complete_all(&buf
->completion
);
348 mutex_unlock(&fw_lock
);
354 /* firmware holds the ownership of pages */
355 static void firmware_free_data(const struct firmware
*fw
)
357 /* Loaded directly? */
362 fw_free_buf(fw
->priv
);
365 /* store the pages buffer info firmware from buf */
366 static void fw_set_page_data(struct firmware_buf
*buf
, struct firmware
*fw
)
369 #ifdef CONFIG_FW_LOADER_USER_HELPER
370 fw
->pages
= buf
->pages
;
372 fw
->size
= buf
->size
;
373 fw
->data
= buf
->data
;
375 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
376 __func__
, buf
->fw_id
, buf
, buf
->data
,
377 (unsigned int)buf
->size
);
380 #ifdef CONFIG_PM_SLEEP
381 static void fw_name_devm_release(struct device
*dev
, void *res
)
383 struct fw_name_devm
*fwn
= res
;
385 if (fwn
->magic
== (unsigned long)&fw_cache
)
386 pr_debug("%s: fw_name-%s devm-%p released\n",
387 __func__
, fwn
->name
, res
);
390 static int fw_devm_match(struct device
*dev
, void *res
,
393 struct fw_name_devm
*fwn
= res
;
395 return (fwn
->magic
== (unsigned long)&fw_cache
) &&
396 !strcmp(fwn
->name
, match_data
);
399 static struct fw_name_devm
*fw_find_devm_name(struct device
*dev
,
402 struct fw_name_devm
*fwn
;
404 fwn
= devres_find(dev
, fw_name_devm_release
,
405 fw_devm_match
, (void *)name
);
409 /* add firmware name into devres list */
410 static int fw_add_devm_name(struct device
*dev
, const char *name
)
412 struct fw_name_devm
*fwn
;
414 fwn
= fw_find_devm_name(dev
, name
);
418 fwn
= devres_alloc(fw_name_devm_release
, sizeof(struct fw_name_devm
) +
419 strlen(name
) + 1, GFP_KERNEL
);
423 fwn
->magic
= (unsigned long)&fw_cache
;
424 strcpy(fwn
->name
, name
);
425 devres_add(dev
, fwn
);
430 static int fw_add_devm_name(struct device
*dev
, const char *name
)
438 * user-mode helper code
440 #ifdef CONFIG_FW_LOADER_USER_HELPER
441 struct firmware_priv
{
442 struct delayed_work timeout_work
;
445 struct firmware_buf
*buf
;
449 static struct firmware_priv
*to_firmware_priv(struct device
*dev
)
451 return container_of(dev
, struct firmware_priv
, dev
);
454 static void __fw_load_abort(struct firmware_buf
*buf
)
457 * There is a small window in which user can write to 'loading'
458 * between loading done and disappearance of 'loading'
460 if (test_bit(FW_STATUS_DONE
, &buf
->status
))
463 list_del_init(&buf
->pending_list
);
464 set_bit(FW_STATUS_ABORT
, &buf
->status
);
465 complete_all(&buf
->completion
);
468 static void fw_load_abort(struct firmware_priv
*fw_priv
)
470 struct firmware_buf
*buf
= fw_priv
->buf
;
472 __fw_load_abort(buf
);
474 /* avoid user action after loading abort */
478 #define is_fw_load_aborted(buf) \
479 test_bit(FW_STATUS_ABORT, &(buf)->status)
481 static LIST_HEAD(pending_fw_head
);
483 /* reboot notifier for avoid deadlock with usermode_lock */
484 static int fw_shutdown_notify(struct notifier_block
*unused1
,
485 unsigned long unused2
, void *unused3
)
487 mutex_lock(&fw_lock
);
488 while (!list_empty(&pending_fw_head
))
489 __fw_load_abort(list_first_entry(&pending_fw_head
,
492 mutex_unlock(&fw_lock
);
496 static struct notifier_block fw_shutdown_nb
= {
497 .notifier_call
= fw_shutdown_notify
,
500 static ssize_t
firmware_timeout_show(struct class *class,
501 struct class_attribute
*attr
,
504 return sprintf(buf
, "%d\n", loading_timeout
);
508 * firmware_timeout_store - set number of seconds to wait for firmware
509 * @class: device class pointer
510 * @attr: device attribute pointer
511 * @buf: buffer to scan for timeout value
512 * @count: number of bytes in @buf
514 * Sets the number of seconds to wait for the firmware. Once
515 * this expires an error will be returned to the driver and no
516 * firmware will be provided.
518 * Note: zero means 'wait forever'.
520 static ssize_t
firmware_timeout_store(struct class *class,
521 struct class_attribute
*attr
,
522 const char *buf
, size_t count
)
524 loading_timeout
= simple_strtol(buf
, NULL
, 10);
525 if (loading_timeout
< 0)
531 static struct class_attribute firmware_class_attrs
[] = {
532 __ATTR(timeout
, S_IWUSR
| S_IRUGO
,
533 firmware_timeout_show
, firmware_timeout_store
),
537 static void fw_dev_release(struct device
*dev
)
539 struct firmware_priv
*fw_priv
= to_firmware_priv(dev
);
543 module_put(THIS_MODULE
);
546 static int do_firmware_uevent(struct firmware_priv
*fw_priv
, struct kobj_uevent_env
*env
)
548 if (add_uevent_var(env
, "FIRMWARE=%s", fw_priv
->buf
->fw_id
))
550 if (add_uevent_var(env
, "TIMEOUT=%i", loading_timeout
))
552 if (add_uevent_var(env
, "ASYNC=%d", fw_priv
->nowait
))
558 static int firmware_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
560 struct firmware_priv
*fw_priv
= to_firmware_priv(dev
);
563 mutex_lock(&fw_lock
);
565 err
= do_firmware_uevent(fw_priv
, env
);
566 mutex_unlock(&fw_lock
);
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
)
604 buf
->data
= vmap(buf
->pages
, buf
->nr_pages
, 0, PAGE_KERNEL_RO
);
611 * firmware_loading_store - set value in the 'loading' control file
612 * @dev: device pointer
613 * @attr: device attribute pointer
614 * @buf: buffer to scan for loading control value
615 * @count: number of bytes in @buf
617 * The relevant values are:
619 * 1: Start a load, discarding any previous partial load.
620 * 0: Conclude the load and hand the data to the driver code.
621 * -1: Conclude the load with an error and discard any written data.
623 static ssize_t
firmware_loading_store(struct device
*dev
,
624 struct device_attribute
*attr
,
625 const char *buf
, size_t count
)
627 struct firmware_priv
*fw_priv
= to_firmware_priv(dev
);
628 struct firmware_buf
*fw_buf
;
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
)) {
652 set_bit(FW_STATUS_DONE
, &fw_buf
->status
);
653 clear_bit(FW_STATUS_LOADING
, &fw_buf
->status
);
656 * Several loading requests may be pending on
657 * one same firmware buf, so let all requests
658 * see the mapped 'buf->data' once the loading
661 fw_map_pages_buf(fw_buf
);
662 list_del_init(&fw_buf
->pending_list
);
663 complete_all(&fw_buf
->completion
);
668 dev_err(dev
, "%s: unexpected value (%d)\n", __func__
, loading
);
671 fw_load_abort(fw_priv
);
675 mutex_unlock(&fw_lock
);
679 static DEVICE_ATTR(loading
, 0644, firmware_loading_show
, firmware_loading_store
);
681 static ssize_t
firmware_data_read(struct file
*filp
, struct kobject
*kobj
,
682 struct bin_attribute
*bin_attr
,
683 char *buffer
, loff_t offset
, size_t count
)
685 struct device
*dev
= kobj_to_dev(kobj
);
686 struct firmware_priv
*fw_priv
= to_firmware_priv(dev
);
687 struct firmware_buf
*buf
;
690 mutex_lock(&fw_lock
);
692 if (!buf
|| test_bit(FW_STATUS_DONE
, &buf
->status
)) {
696 if (offset
> buf
->size
) {
700 if (count
> buf
->size
- offset
)
701 count
= buf
->size
- offset
;
707 int page_nr
= offset
>> PAGE_SHIFT
;
708 int page_ofs
= offset
& (PAGE_SIZE
-1);
709 int page_cnt
= min_t(size_t, PAGE_SIZE
- page_ofs
, count
);
711 page_data
= kmap(buf
->pages
[page_nr
]);
713 memcpy(buffer
, page_data
+ page_ofs
, page_cnt
);
715 kunmap(buf
->pages
[page_nr
]);
721 mutex_unlock(&fw_lock
);
725 static int fw_realloc_buffer(struct firmware_priv
*fw_priv
, int min_size
)
727 struct firmware_buf
*buf
= fw_priv
->buf
;
728 int pages_needed
= ALIGN(min_size
, PAGE_SIZE
) >> PAGE_SHIFT
;
730 /* If the array of pages is too small, grow it... */
731 if (buf
->page_array_size
< pages_needed
) {
732 int new_array_size
= max(pages_needed
,
733 buf
->page_array_size
* 2);
734 struct page
**new_pages
;
736 new_pages
= kmalloc(new_array_size
* sizeof(void *),
739 fw_load_abort(fw_priv
);
742 memcpy(new_pages
, buf
->pages
,
743 buf
->page_array_size
* sizeof(void *));
744 memset(&new_pages
[buf
->page_array_size
], 0, sizeof(void *) *
745 (new_array_size
- buf
->page_array_size
));
747 buf
->pages
= new_pages
;
748 buf
->page_array_size
= new_array_size
;
751 while (buf
->nr_pages
< pages_needed
) {
752 buf
->pages
[buf
->nr_pages
] =
753 alloc_page(GFP_KERNEL
| __GFP_HIGHMEM
);
755 if (!buf
->pages
[buf
->nr_pages
]) {
756 fw_load_abort(fw_priv
);
765 * firmware_data_write - write method for firmware
766 * @filp: open sysfs file
767 * @kobj: kobject for the device
768 * @bin_attr: bin_attr structure
769 * @buffer: buffer being written
770 * @offset: buffer offset for write in total data store area
771 * @count: buffer size
773 * Data written to the 'data' attribute will be later handed to
774 * the driver as a firmware image.
776 static ssize_t
firmware_data_write(struct file
*filp
, struct kobject
*kobj
,
777 struct bin_attribute
*bin_attr
,
778 char *buffer
, loff_t offset
, size_t count
)
780 struct device
*dev
= kobj_to_dev(kobj
);
781 struct firmware_priv
*fw_priv
= to_firmware_priv(dev
);
782 struct firmware_buf
*buf
;
785 if (!capable(CAP_SYS_RAWIO
))
788 mutex_lock(&fw_lock
);
790 if (!buf
|| test_bit(FW_STATUS_DONE
, &buf
->status
)) {
795 retval
= fw_realloc_buffer(fw_priv
, offset
+ count
);
803 int page_nr
= offset
>> PAGE_SHIFT
;
804 int page_ofs
= offset
& (PAGE_SIZE
- 1);
805 int page_cnt
= min_t(size_t, PAGE_SIZE
- page_ofs
, count
);
807 page_data
= kmap(buf
->pages
[page_nr
]);
809 memcpy(page_data
+ page_ofs
, buffer
, page_cnt
);
811 kunmap(buf
->pages
[page_nr
]);
817 buf
->size
= max_t(size_t, offset
, buf
->size
);
819 mutex_unlock(&fw_lock
);
823 static struct bin_attribute firmware_attr_data
= {
824 .attr
= { .name
= "data", .mode
= 0644 },
826 .read
= firmware_data_read
,
827 .write
= firmware_data_write
,
830 static void firmware_class_timeout_work(struct work_struct
*work
)
832 struct firmware_priv
*fw_priv
= container_of(work
,
833 struct firmware_priv
, timeout_work
.work
);
835 mutex_lock(&fw_lock
);
836 fw_load_abort(fw_priv
);
837 mutex_unlock(&fw_lock
);
840 static struct firmware_priv
*
841 fw_create_instance(struct firmware
*firmware
, const char *fw_name
,
842 struct device
*device
, bool uevent
, bool nowait
)
844 struct firmware_priv
*fw_priv
;
845 struct device
*f_dev
;
847 fw_priv
= kzalloc(sizeof(*fw_priv
), GFP_KERNEL
);
849 dev_err(device
, "%s: kmalloc failed\n", __func__
);
850 fw_priv
= ERR_PTR(-ENOMEM
);
854 fw_priv
->nowait
= nowait
;
855 fw_priv
->fw
= firmware
;
856 INIT_DELAYED_WORK(&fw_priv
->timeout_work
,
857 firmware_class_timeout_work
);
859 f_dev
= &fw_priv
->dev
;
861 device_initialize(f_dev
);
862 dev_set_name(f_dev
, "%s", fw_name
);
863 f_dev
->parent
= device
;
864 f_dev
->class = &firmware_class
;
869 /* load a firmware via user helper */
870 static int _request_firmware_load(struct firmware_priv
*fw_priv
, bool uevent
,
874 struct device
*f_dev
= &fw_priv
->dev
;
875 struct firmware_buf
*buf
= fw_priv
->buf
;
877 /* fall back on userspace loading */
878 buf
->is_paged_buf
= true;
880 dev_set_uevent_suppress(f_dev
, true);
882 /* Need to pin this module until class device is destroyed */
883 __module_get(THIS_MODULE
);
885 retval
= device_add(f_dev
);
887 dev_err(f_dev
, "%s: device_register failed\n", __func__
);
891 retval
= device_create_bin_file(f_dev
, &firmware_attr_data
);
893 dev_err(f_dev
, "%s: sysfs_create_bin_file failed\n", __func__
);
897 mutex_lock(&fw_lock
);
898 list_add(&buf
->pending_list
, &pending_fw_head
);
899 mutex_unlock(&fw_lock
);
901 retval
= device_create_file(f_dev
, &dev_attr_loading
);
903 mutex_lock(&fw_lock
);
904 list_del_init(&buf
->pending_list
);
905 mutex_unlock(&fw_lock
);
906 dev_err(f_dev
, "%s: device_create_file failed\n", __func__
);
907 goto err_del_bin_attr
;
911 dev_set_uevent_suppress(f_dev
, false);
912 dev_dbg(f_dev
, "firmware: requesting %s\n", buf
->fw_id
);
913 if (timeout
!= MAX_SCHEDULE_TIMEOUT
)
914 schedule_delayed_work(&fw_priv
->timeout_work
, timeout
);
916 kobject_uevent(&fw_priv
->dev
.kobj
, KOBJ_ADD
);
919 wait_for_completion(&buf
->completion
);
921 cancel_delayed_work_sync(&fw_priv
->timeout_work
);
923 device_remove_file(f_dev
, &dev_attr_loading
);
925 device_remove_bin_file(f_dev
, &firmware_attr_data
);
933 static int fw_load_from_user_helper(struct firmware
*firmware
,
934 const char *name
, struct device
*device
,
935 bool uevent
, bool nowait
, long timeout
)
937 struct firmware_priv
*fw_priv
;
939 fw_priv
= fw_create_instance(firmware
, name
, device
, uevent
, nowait
);
941 return PTR_ERR(fw_priv
);
943 fw_priv
->buf
= firmware
->priv
;
944 return _request_firmware_load(fw_priv
, uevent
, timeout
);
946 #else /* CONFIG_FW_LOADER_USER_HELPER */
948 fw_load_from_user_helper(struct firmware
*firmware
, const char *name
,
949 struct device
*device
, bool uevent
, bool nowait
,
955 /* No abort during direct loading */
956 #define is_fw_load_aborted(buf) false
958 #endif /* CONFIG_FW_LOADER_USER_HELPER */
961 /* wait until the shared firmware_buf becomes ready (or error) */
962 static int sync_cached_firmware_buf(struct firmware_buf
*buf
)
966 mutex_lock(&fw_lock
);
967 while (!test_bit(FW_STATUS_DONE
, &buf
->status
)) {
968 if (is_fw_load_aborted(buf
)) {
972 mutex_unlock(&fw_lock
);
973 wait_for_completion(&buf
->completion
);
974 mutex_lock(&fw_lock
);
976 mutex_unlock(&fw_lock
);
980 /* prepare firmware and firmware_buf structs;
981 * return 0 if a firmware is already assigned, 1 if need to load one,
982 * or a negative error code
985 _request_firmware_prepare(struct firmware
**firmware_p
, const char *name
,
986 struct device
*device
)
988 struct firmware
*firmware
;
989 struct firmware_buf
*buf
;
992 *firmware_p
= firmware
= kzalloc(sizeof(*firmware
), GFP_KERNEL
);
994 dev_err(device
, "%s: kmalloc(struct firmware) failed\n",
999 if (fw_get_builtin_firmware(firmware
, name
)) {
1000 dev_dbg(device
, "firmware: using built-in firmware %s\n", name
);
1001 return 0; /* assigned */
1004 ret
= fw_lookup_and_allocate_buf(name
, &fw_cache
, &buf
);
1007 * bind with 'buf' now to avoid warning in failure path
1008 * of requesting firmware.
1010 firmware
->priv
= buf
;
1013 ret
= sync_cached_firmware_buf(buf
);
1015 fw_set_page_data(buf
, firmware
);
1016 return 0; /* assigned */
1022 return 1; /* need to load */
1025 static int assign_firmware_buf(struct firmware
*fw
, struct device
*device
)
1027 struct firmware_buf
*buf
= fw
->priv
;
1029 mutex_lock(&fw_lock
);
1030 if (!buf
->size
|| is_fw_load_aborted(buf
)) {
1031 mutex_unlock(&fw_lock
);
1036 * add firmware name into devres list so that we can auto cache
1037 * and uncache firmware for device.
1039 * device may has been deleted already, but the problem
1040 * should be fixed in devres or driver core.
1043 fw_add_devm_name(device
, buf
->fw_id
);
1046 * After caching firmware image is started, let it piggyback
1047 * on request firmware.
1049 if (buf
->fwc
->state
== FW_LOADER_START_CACHE
) {
1050 if (fw_cache_piggyback_on_request(buf
->fw_id
))
1051 kref_get(&buf
->ref
);
1054 /* pass the pages buffer to driver at the last minute */
1055 fw_set_page_data(buf
, fw
);
1056 mutex_unlock(&fw_lock
);
1060 /* called from request_firmware() and request_firmware_work_func() */
1062 _request_firmware(const struct firmware
**firmware_p
, const char *name
,
1063 struct device
*device
, bool uevent
, bool nowait
)
1065 struct firmware
*fw
;
1072 if (!name
|| name
[0] == '\0')
1075 ret
= _request_firmware_prepare(&fw
, name
, device
);
1076 if (ret
<= 0) /* error or already assigned */
1080 timeout
= firmware_loading_timeout();
1082 timeout
= usermodehelper_read_lock_wait(timeout
);
1084 dev_dbg(device
, "firmware: %s loading timed out\n",
1090 ret
= usermodehelper_read_trylock();
1092 dev_err(device
, "firmware: %s will not be loaded\n",
1098 if (!fw_get_filesystem_firmware(device
, fw
->priv
))
1099 ret
= fw_load_from_user_helper(fw
, name
, device
,
1100 uevent
, nowait
, timeout
);
1102 ret
= assign_firmware_buf(fw
, device
);
1104 usermodehelper_read_unlock();
1108 release_firmware(fw
);
1117 * request_firmware: - send firmware request and wait for it
1118 * @firmware_p: pointer to firmware image
1119 * @name: name of firmware file
1120 * @device: device for which firmware is being loaded
1122 * @firmware_p will be used to return a firmware image by the name
1123 * of @name for device @device.
1125 * Should be called from user context where sleeping is allowed.
1127 * @name will be used as $FIRMWARE in the uevent environment and
1128 * should be distinctive enough not to be confused with any other
1129 * firmware image for this or any other device.
1131 * Caller must hold the reference count of @device.
1133 * The function can be called safely inside device's suspend and
1137 request_firmware(const struct firmware
**firmware_p
, const char *name
,
1138 struct device
*device
)
1140 return _request_firmware(firmware_p
, name
, device
, true, false);
1144 * release_firmware: - release the resource associated with a firmware image
1145 * @fw: firmware resource to release
1147 void release_firmware(const struct firmware
*fw
)
1150 if (!fw_is_builtin_firmware(fw
))
1151 firmware_free_data(fw
);
1157 struct firmware_work
{
1158 struct work_struct work
;
1159 struct module
*module
;
1161 struct device
*device
;
1163 void (*cont
)(const struct firmware
*fw
, void *context
);
1167 static void request_firmware_work_func(struct work_struct
*work
)
1169 struct firmware_work
*fw_work
;
1170 const struct firmware
*fw
;
1172 fw_work
= container_of(work
, struct firmware_work
, work
);
1174 _request_firmware(&fw
, fw_work
->name
, fw_work
->device
,
1175 fw_work
->uevent
, true);
1176 fw_work
->cont(fw
, fw_work
->context
);
1177 put_device(fw_work
->device
); /* taken in request_firmware_nowait() */
1179 module_put(fw_work
->module
);
1184 * request_firmware_nowait - asynchronous version of request_firmware
1185 * @module: module requesting the firmware
1186 * @uevent: sends uevent to copy the firmware image if this flag
1187 * is non-zero else the firmware copy must be done manually.
1188 * @name: name of firmware file
1189 * @device: device for which firmware is being loaded
1190 * @gfp: allocation flags
1191 * @context: will be passed over to @cont, and
1192 * @fw may be %NULL if firmware request fails.
1193 * @cont: function will be called asynchronously when the firmware
1196 * Caller must hold the reference count of @device.
1198 * Asynchronous variant of request_firmware() for user contexts:
1199 * - sleep for as small periods as possible since it may
1200 * increase kernel boot time of built-in device drivers
1201 * requesting firmware in their ->probe() methods, if
1202 * @gfp is GFP_KERNEL.
1204 * - can't sleep at all if @gfp is GFP_ATOMIC.
1207 request_firmware_nowait(
1208 struct module
*module
, bool uevent
,
1209 const char *name
, struct device
*device
, gfp_t gfp
, void *context
,
1210 void (*cont
)(const struct firmware
*fw
, void *context
))
1212 struct firmware_work
*fw_work
;
1214 fw_work
= kzalloc(sizeof (struct firmware_work
), gfp
);
1218 fw_work
->module
= module
;
1219 fw_work
->name
= name
;
1220 fw_work
->device
= device
;
1221 fw_work
->context
= context
;
1222 fw_work
->cont
= cont
;
1223 fw_work
->uevent
= uevent
;
1225 if (!try_module_get(module
)) {
1230 get_device(fw_work
->device
);
1231 INIT_WORK(&fw_work
->work
, request_firmware_work_func
);
1232 schedule_work(&fw_work
->work
);
1237 * cache_firmware - cache one firmware image in kernel memory space
1238 * @fw_name: the firmware image name
1240 * Cache firmware in kernel memory so that drivers can use it when
1241 * system isn't ready for them to request firmware image from userspace.
1242 * Once it returns successfully, driver can use request_firmware or its
1243 * nowait version to get the cached firmware without any interacting
1246 * Return 0 if the firmware image has been cached successfully
1247 * Return !0 otherwise
1250 int cache_firmware(const char *fw_name
)
1253 const struct firmware
*fw
;
1255 pr_debug("%s: %s\n", __func__
, fw_name
);
1257 ret
= request_firmware(&fw
, fw_name
, NULL
);
1261 pr_debug("%s: %s ret=%d\n", __func__
, fw_name
, ret
);
1267 * uncache_firmware - remove one cached firmware image
1268 * @fw_name: the firmware image name
1270 * Uncache one firmware image which has been cached successfully
1273 * Return 0 if the firmware cache has been removed successfully
1274 * Return !0 otherwise
1277 int uncache_firmware(const char *fw_name
)
1279 struct firmware_buf
*buf
;
1282 pr_debug("%s: %s\n", __func__
, fw_name
);
1284 if (fw_get_builtin_firmware(&fw
, fw_name
))
1287 buf
= fw_lookup_buf(fw_name
);
1296 #ifdef CONFIG_PM_SLEEP
1297 static ASYNC_DOMAIN_EXCLUSIVE(fw_cache_domain
);
1299 static struct fw_cache_entry
*alloc_fw_cache_entry(const char *name
)
1301 struct fw_cache_entry
*fce
;
1303 fce
= kzalloc(sizeof(*fce
) + strlen(name
) + 1, GFP_ATOMIC
);
1307 strcpy(fce
->name
, name
);
1312 static int __fw_entry_found(const char *name
)
1314 struct firmware_cache
*fwc
= &fw_cache
;
1315 struct fw_cache_entry
*fce
;
1317 list_for_each_entry(fce
, &fwc
->fw_names
, list
) {
1318 if (!strcmp(fce
->name
, name
))
1324 static int fw_cache_piggyback_on_request(const char *name
)
1326 struct firmware_cache
*fwc
= &fw_cache
;
1327 struct fw_cache_entry
*fce
;
1330 spin_lock(&fwc
->name_lock
);
1331 if (__fw_entry_found(name
))
1334 fce
= alloc_fw_cache_entry(name
);
1337 list_add(&fce
->list
, &fwc
->fw_names
);
1338 pr_debug("%s: fw: %s\n", __func__
, name
);
1341 spin_unlock(&fwc
->name_lock
);
1345 static void free_fw_cache_entry(struct fw_cache_entry
*fce
)
1350 static void __async_dev_cache_fw_image(void *fw_entry
,
1351 async_cookie_t cookie
)
1353 struct fw_cache_entry
*fce
= fw_entry
;
1354 struct firmware_cache
*fwc
= &fw_cache
;
1357 ret
= cache_firmware(fce
->name
);
1359 spin_lock(&fwc
->name_lock
);
1360 list_del(&fce
->list
);
1361 spin_unlock(&fwc
->name_lock
);
1363 free_fw_cache_entry(fce
);
1367 /* called with dev->devres_lock held */
1368 static void dev_create_fw_entry(struct device
*dev
, void *res
,
1371 struct fw_name_devm
*fwn
= res
;
1372 const char *fw_name
= fwn
->name
;
1373 struct list_head
*head
= data
;
1374 struct fw_cache_entry
*fce
;
1376 fce
= alloc_fw_cache_entry(fw_name
);
1378 list_add(&fce
->list
, head
);
1381 static int devm_name_match(struct device
*dev
, void *res
,
1384 struct fw_name_devm
*fwn
= res
;
1385 return (fwn
->magic
== (unsigned long)match_data
);
1388 static void dev_cache_fw_image(struct device
*dev
, void *data
)
1391 struct fw_cache_entry
*fce
;
1392 struct fw_cache_entry
*fce_next
;
1393 struct firmware_cache
*fwc
= &fw_cache
;
1395 devres_for_each_res(dev
, fw_name_devm_release
,
1396 devm_name_match
, &fw_cache
,
1397 dev_create_fw_entry
, &todo
);
1399 list_for_each_entry_safe(fce
, fce_next
, &todo
, list
) {
1400 list_del(&fce
->list
);
1402 spin_lock(&fwc
->name_lock
);
1403 /* only one cache entry for one firmware */
1404 if (!__fw_entry_found(fce
->name
)) {
1405 list_add(&fce
->list
, &fwc
->fw_names
);
1407 free_fw_cache_entry(fce
);
1410 spin_unlock(&fwc
->name_lock
);
1413 async_schedule_domain(__async_dev_cache_fw_image
,
1419 static void __device_uncache_fw_images(void)
1421 struct firmware_cache
*fwc
= &fw_cache
;
1422 struct fw_cache_entry
*fce
;
1424 spin_lock(&fwc
->name_lock
);
1425 while (!list_empty(&fwc
->fw_names
)) {
1426 fce
= list_entry(fwc
->fw_names
.next
,
1427 struct fw_cache_entry
, list
);
1428 list_del(&fce
->list
);
1429 spin_unlock(&fwc
->name_lock
);
1431 uncache_firmware(fce
->name
);
1432 free_fw_cache_entry(fce
);
1434 spin_lock(&fwc
->name_lock
);
1436 spin_unlock(&fwc
->name_lock
);
1440 * device_cache_fw_images - cache devices' firmware
1442 * If one device called request_firmware or its nowait version
1443 * successfully before, the firmware names are recored into the
1444 * device's devres link list, so device_cache_fw_images can call
1445 * cache_firmware() to cache these firmwares for the device,
1446 * then the device driver can load its firmwares easily at
1447 * time when system is not ready to complete loading firmware.
1449 static void device_cache_fw_images(void)
1451 struct firmware_cache
*fwc
= &fw_cache
;
1455 pr_debug("%s\n", __func__
);
1457 /* cancel uncache work */
1458 cancel_delayed_work_sync(&fwc
->work
);
1461 * use small loading timeout for caching devices' firmware
1462 * because all these firmware images have been loaded
1463 * successfully at lease once, also system is ready for
1464 * completing firmware loading now. The maximum size of
1465 * firmware in current distributions is about 2M bytes,
1466 * so 10 secs should be enough.
1468 old_timeout
= loading_timeout
;
1469 loading_timeout
= 10;
1471 mutex_lock(&fw_lock
);
1472 fwc
->state
= FW_LOADER_START_CACHE
;
1473 dpm_for_each_dev(NULL
, dev_cache_fw_image
);
1474 mutex_unlock(&fw_lock
);
1476 /* wait for completion of caching firmware for all devices */
1477 async_synchronize_full_domain(&fw_cache_domain
);
1479 loading_timeout
= old_timeout
;
1483 * device_uncache_fw_images - uncache devices' firmware
1485 * uncache all firmwares which have been cached successfully
1486 * by device_uncache_fw_images earlier
1488 static void device_uncache_fw_images(void)
1490 pr_debug("%s\n", __func__
);
1491 __device_uncache_fw_images();
1494 static void device_uncache_fw_images_work(struct work_struct
*work
)
1496 device_uncache_fw_images();
1500 * device_uncache_fw_images_delay - uncache devices firmwares
1501 * @delay: number of milliseconds to delay uncache device firmwares
1503 * uncache all devices's firmwares which has been cached successfully
1504 * by device_cache_fw_images after @delay milliseconds.
1506 static void device_uncache_fw_images_delay(unsigned long delay
)
1508 schedule_delayed_work(&fw_cache
.work
,
1509 msecs_to_jiffies(delay
));
1512 static int fw_pm_notify(struct notifier_block
*notify_block
,
1513 unsigned long mode
, void *unused
)
1516 case PM_HIBERNATION_PREPARE
:
1517 case PM_SUSPEND_PREPARE
:
1518 device_cache_fw_images();
1521 case PM_POST_SUSPEND
:
1522 case PM_POST_HIBERNATION
:
1523 case PM_POST_RESTORE
:
1525 * In case that system sleep failed and syscore_suspend is
1528 mutex_lock(&fw_lock
);
1529 fw_cache
.state
= FW_LOADER_NO_CACHE
;
1530 mutex_unlock(&fw_lock
);
1532 device_uncache_fw_images_delay(10 * MSEC_PER_SEC
);
1539 /* stop caching firmware once syscore_suspend is reached */
1540 static int fw_suspend(void)
1542 fw_cache
.state
= FW_LOADER_NO_CACHE
;
1546 static struct syscore_ops fw_syscore_ops
= {
1547 .suspend
= fw_suspend
,
1550 static int fw_cache_piggyback_on_request(const char *name
)
1556 static void __init
fw_cache_init(void)
1558 spin_lock_init(&fw_cache
.lock
);
1559 INIT_LIST_HEAD(&fw_cache
.head
);
1560 fw_cache
.state
= FW_LOADER_NO_CACHE
;
1562 #ifdef CONFIG_PM_SLEEP
1563 spin_lock_init(&fw_cache
.name_lock
);
1564 INIT_LIST_HEAD(&fw_cache
.fw_names
);
1566 INIT_DELAYED_WORK(&fw_cache
.work
,
1567 device_uncache_fw_images_work
);
1569 fw_cache
.pm_notify
.notifier_call
= fw_pm_notify
;
1570 register_pm_notifier(&fw_cache
.pm_notify
);
1572 register_syscore_ops(&fw_syscore_ops
);
1576 static int __init
firmware_class_init(void)
1579 #ifdef CONFIG_FW_LOADER_USER_HELPER
1580 register_reboot_notifier(&fw_shutdown_nb
);
1581 return class_register(&firmware_class
);
1587 static void __exit
firmware_class_exit(void)
1589 #ifdef CONFIG_PM_SLEEP
1590 unregister_syscore_ops(&fw_syscore_ops
);
1591 unregister_pm_notifier(&fw_cache
.pm_notify
);
1593 #ifdef CONFIG_FW_LOADER_USER_HELPER
1594 unregister_reboot_notifier(&fw_shutdown_nb
);
1595 class_unregister(&firmware_class
);
1599 fs_initcall(firmware_class_init
);
1600 module_exit(firmware_class_exit
);
1602 EXPORT_SYMBOL(release_firmware
);
1603 EXPORT_SYMBOL(request_firmware
);
1604 EXPORT_SYMBOL(request_firmware_nowait
);
1605 EXPORT_SYMBOL_GPL(cache_firmware
);
1606 EXPORT_SYMBOL_GPL(uncache_firmware
);