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/kthread.h>
20 #include <linux/highmem.h>
21 #include <linux/firmware.h>
22 #include <linux/slab.h>
24 #define to_dev(obj) container_of(obj, struct device, kobj)
26 MODULE_AUTHOR("Manuel Estrada Sainz");
27 MODULE_DESCRIPTION("Multi purpose firmware loading support");
28 MODULE_LICENSE("GPL");
36 static int loading_timeout
= 60; /* In seconds */
38 /* fw_lock could be moved to 'struct firmware_priv' but since it is just
39 * guarding for corner cases a global lock should be OK */
40 static DEFINE_MUTEX(fw_lock
);
42 struct firmware_priv
{
44 struct completion completion
;
45 struct bin_attribute attr_data
;
52 struct timer_list timeout
;
55 #ifdef CONFIG_FW_LOADER
56 extern struct builtin_fw __start_builtin_fw
[];
57 extern struct builtin_fw __end_builtin_fw
[];
58 #else /* Module case. Avoid ifdefs later; it'll all optimise out */
59 static struct builtin_fw
*__start_builtin_fw
;
60 static struct builtin_fw
*__end_builtin_fw
;
64 fw_load_abort(struct firmware_priv
*fw_priv
)
66 set_bit(FW_STATUS_ABORT
, &fw_priv
->status
);
68 complete(&fw_priv
->completion
);
72 firmware_timeout_show(struct class *class,
73 struct class_attribute
*attr
,
76 return sprintf(buf
, "%d\n", loading_timeout
);
80 * firmware_timeout_store - set number of seconds to wait for firmware
81 * @class: device class pointer
82 * @attr: device attribute pointer
83 * @buf: buffer to scan for timeout value
84 * @count: number of bytes in @buf
86 * Sets the number of seconds to wait for the firmware. Once
87 * this expires an error will be returned to the driver and no
88 * firmware will be provided.
90 * Note: zero means 'wait forever'.
93 firmware_timeout_store(struct class *class,
94 struct class_attribute
*attr
,
95 const char *buf
, size_t count
)
97 loading_timeout
= simple_strtol(buf
, NULL
, 10);
98 if (loading_timeout
< 0)
103 static CLASS_ATTR(timeout
, 0644, firmware_timeout_show
, firmware_timeout_store
);
105 static void fw_dev_release(struct device
*dev
);
107 static int firmware_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
109 struct firmware_priv
*fw_priv
= dev_get_drvdata(dev
);
111 if (add_uevent_var(env
, "FIRMWARE=%s", fw_priv
->fw_id
))
113 if (add_uevent_var(env
, "TIMEOUT=%i", loading_timeout
))
119 static struct class firmware_class
= {
121 .dev_uevent
= firmware_uevent
,
122 .dev_release
= fw_dev_release
,
125 static ssize_t
firmware_loading_show(struct device
*dev
,
126 struct device_attribute
*attr
, char *buf
)
128 struct firmware_priv
*fw_priv
= dev_get_drvdata(dev
);
129 int loading
= test_bit(FW_STATUS_LOADING
, &fw_priv
->status
);
130 return sprintf(buf
, "%d\n", loading
);
133 /* Some architectures don't have PAGE_KERNEL_RO */
134 #ifndef PAGE_KERNEL_RO
135 #define PAGE_KERNEL_RO PAGE_KERNEL
138 * firmware_loading_store - set value in the 'loading' control file
139 * @dev: device pointer
140 * @attr: device attribute pointer
141 * @buf: buffer to scan for loading control value
142 * @count: number of bytes in @buf
144 * The relevant values are:
146 * 1: Start a load, discarding any previous partial load.
147 * 0: Conclude the load and hand the data to the driver code.
148 * -1: Conclude the load with an error and discard any written data.
150 static ssize_t
firmware_loading_store(struct device
*dev
,
151 struct device_attribute
*attr
,
152 const char *buf
, size_t count
)
154 struct firmware_priv
*fw_priv
= dev_get_drvdata(dev
);
155 int loading
= simple_strtol(buf
, NULL
, 10);
160 mutex_lock(&fw_lock
);
162 mutex_unlock(&fw_lock
);
165 vfree(fw_priv
->fw
->data
);
166 fw_priv
->fw
->data
= NULL
;
167 for (i
= 0; i
< fw_priv
->nr_pages
; i
++)
168 __free_page(fw_priv
->pages
[i
]);
169 kfree(fw_priv
->pages
);
170 fw_priv
->pages
= NULL
;
171 fw_priv
->page_array_size
= 0;
172 fw_priv
->nr_pages
= 0;
173 fw_priv
->fw
->size
= 0;
174 set_bit(FW_STATUS_LOADING
, &fw_priv
->status
);
175 mutex_unlock(&fw_lock
);
178 if (test_bit(FW_STATUS_LOADING
, &fw_priv
->status
)) {
179 vfree(fw_priv
->fw
->data
);
180 fw_priv
->fw
->data
= vmap(fw_priv
->pages
,
183 if (!fw_priv
->fw
->data
) {
184 dev_err(dev
, "%s: vmap() failed\n", __func__
);
187 /* Pages will be freed by vfree() */
188 fw_priv
->page_array_size
= 0;
189 fw_priv
->nr_pages
= 0;
190 complete(&fw_priv
->completion
);
191 clear_bit(FW_STATUS_LOADING
, &fw_priv
->status
);
196 dev_err(dev
, "%s: unexpected value (%d)\n", __func__
, loading
);
200 fw_load_abort(fw_priv
);
207 static DEVICE_ATTR(loading
, 0644, firmware_loading_show
, firmware_loading_store
);
210 firmware_data_read(struct kobject
*kobj
, struct bin_attribute
*bin_attr
,
211 char *buffer
, loff_t offset
, size_t count
)
213 struct device
*dev
= to_dev(kobj
);
214 struct firmware_priv
*fw_priv
= dev_get_drvdata(dev
);
218 mutex_lock(&fw_lock
);
220 if (!fw
|| test_bit(FW_STATUS_DONE
, &fw_priv
->status
)) {
224 if (offset
> fw
->size
) {
228 if (count
> fw
->size
- offset
)
229 count
= fw
->size
- offset
;
235 int page_nr
= offset
>> PAGE_SHIFT
;
236 int page_ofs
= offset
& (PAGE_SIZE
-1);
237 int page_cnt
= min_t(size_t, PAGE_SIZE
- page_ofs
, count
);
239 page_data
= kmap(fw_priv
->pages
[page_nr
]);
241 memcpy(buffer
, page_data
+ page_ofs
, page_cnt
);
243 kunmap(fw_priv
->pages
[page_nr
]);
249 mutex_unlock(&fw_lock
);
254 fw_realloc_buffer(struct firmware_priv
*fw_priv
, int min_size
)
256 int pages_needed
= ALIGN(min_size
, PAGE_SIZE
) >> PAGE_SHIFT
;
258 /* If the array of pages is too small, grow it... */
259 if (fw_priv
->page_array_size
< pages_needed
) {
260 int new_array_size
= max(pages_needed
,
261 fw_priv
->page_array_size
* 2);
262 struct page
**new_pages
;
264 new_pages
= kmalloc(new_array_size
* sizeof(void *),
267 fw_load_abort(fw_priv
);
270 memcpy(new_pages
, fw_priv
->pages
,
271 fw_priv
->page_array_size
* sizeof(void *));
272 memset(&new_pages
[fw_priv
->page_array_size
], 0, sizeof(void *) *
273 (new_array_size
- fw_priv
->page_array_size
));
274 kfree(fw_priv
->pages
);
275 fw_priv
->pages
= new_pages
;
276 fw_priv
->page_array_size
= new_array_size
;
279 while (fw_priv
->nr_pages
< pages_needed
) {
280 fw_priv
->pages
[fw_priv
->nr_pages
] =
281 alloc_page(GFP_KERNEL
| __GFP_HIGHMEM
);
283 if (!fw_priv
->pages
[fw_priv
->nr_pages
]) {
284 fw_load_abort(fw_priv
);
293 * firmware_data_write - write method for firmware
294 * @kobj: kobject for the device
295 * @bin_attr: bin_attr structure
296 * @buffer: buffer being written
297 * @offset: buffer offset for write in total data store area
298 * @count: buffer size
300 * Data written to the 'data' attribute will be later handed to
301 * the driver as a firmware image.
304 firmware_data_write(struct kobject
*kobj
, struct bin_attribute
*bin_attr
,
305 char *buffer
, loff_t offset
, size_t count
)
307 struct device
*dev
= to_dev(kobj
);
308 struct firmware_priv
*fw_priv
= dev_get_drvdata(dev
);
312 if (!capable(CAP_SYS_RAWIO
))
315 mutex_lock(&fw_lock
);
317 if (!fw
|| test_bit(FW_STATUS_DONE
, &fw_priv
->status
)) {
321 retval
= fw_realloc_buffer(fw_priv
, offset
+ count
);
329 int page_nr
= offset
>> PAGE_SHIFT
;
330 int page_ofs
= offset
& (PAGE_SIZE
- 1);
331 int page_cnt
= min_t(size_t, PAGE_SIZE
- page_ofs
, count
);
333 page_data
= kmap(fw_priv
->pages
[page_nr
]);
335 memcpy(page_data
+ page_ofs
, buffer
, page_cnt
);
337 kunmap(fw_priv
->pages
[page_nr
]);
343 fw
->size
= max_t(size_t, offset
, fw
->size
);
345 mutex_unlock(&fw_lock
);
349 static struct bin_attribute firmware_attr_data_tmpl
= {
350 .attr
= {.name
= "data", .mode
= 0644},
352 .read
= firmware_data_read
,
353 .write
= firmware_data_write
,
356 static void fw_dev_release(struct device
*dev
)
358 struct firmware_priv
*fw_priv
= dev_get_drvdata(dev
);
361 for (i
= 0; i
< fw_priv
->nr_pages
; i
++)
362 __free_page(fw_priv
->pages
[i
]);
363 kfree(fw_priv
->pages
);
364 kfree(fw_priv
->fw_id
);
368 module_put(THIS_MODULE
);
372 firmware_class_timeout(u_long data
)
374 struct firmware_priv
*fw_priv
= (struct firmware_priv
*) data
;
375 fw_load_abort(fw_priv
);
378 static int fw_register_device(struct device
**dev_p
, const char *fw_name
,
379 struct device
*device
)
382 struct firmware_priv
*fw_priv
= kzalloc(sizeof(*fw_priv
),
384 struct device
*f_dev
= kzalloc(sizeof(*f_dev
), GFP_KERNEL
);
388 if (!fw_priv
|| !f_dev
) {
389 dev_err(device
, "%s: kmalloc failed\n", __func__
);
394 init_completion(&fw_priv
->completion
);
395 fw_priv
->attr_data
= firmware_attr_data_tmpl
;
396 fw_priv
->fw_id
= kstrdup(fw_name
, GFP_KERNEL
);
397 if (!fw_priv
->fw_id
) {
398 dev_err(device
, "%s: Firmware name allocation failed\n",
404 fw_priv
->timeout
.function
= firmware_class_timeout
;
405 fw_priv
->timeout
.data
= (u_long
) fw_priv
;
406 init_timer(&fw_priv
->timeout
);
408 dev_set_name(f_dev
, "%s", dev_name(device
));
409 f_dev
->parent
= device
;
410 f_dev
->class = &firmware_class
;
411 dev_set_drvdata(f_dev
, fw_priv
);
412 dev_set_uevent_suppress(f_dev
, 1);
413 retval
= device_register(f_dev
);
415 dev_err(device
, "%s: device_register failed\n", __func__
);
428 static int fw_setup_device(struct firmware
*fw
, struct device
**dev_p
,
429 const char *fw_name
, struct device
*device
,
432 struct device
*f_dev
;
433 struct firmware_priv
*fw_priv
;
437 retval
= fw_register_device(&f_dev
, fw_name
, device
);
441 /* Need to pin this module until class device is destroyed */
442 __module_get(THIS_MODULE
);
444 fw_priv
= dev_get_drvdata(f_dev
);
447 sysfs_bin_attr_init(&fw_priv
->attr_data
);
448 retval
= sysfs_create_bin_file(&f_dev
->kobj
, &fw_priv
->attr_data
);
450 dev_err(device
, "%s: sysfs_create_bin_file failed\n", __func__
);
454 retval
= device_create_file(f_dev
, &dev_attr_loading
);
456 dev_err(device
, "%s: device_create_file failed\n", __func__
);
461 dev_set_uevent_suppress(f_dev
, 0);
466 device_unregister(f_dev
);
472 _request_firmware(const struct firmware
**firmware_p
, const char *name
,
473 struct device
*device
, int uevent
)
475 struct device
*f_dev
;
476 struct firmware_priv
*fw_priv
;
477 struct firmware
*firmware
;
478 struct builtin_fw
*builtin
;
484 *firmware_p
= firmware
= kzalloc(sizeof(*firmware
), GFP_KERNEL
);
486 dev_err(device
, "%s: kmalloc(struct firmware) failed\n",
492 for (builtin
= __start_builtin_fw
; builtin
!= __end_builtin_fw
;
494 if (strcmp(name
, builtin
->name
))
496 dev_info(device
, "firmware: using built-in firmware %s\n",
498 firmware
->size
= builtin
->size
;
499 firmware
->data
= builtin
->data
;
504 dev_info(device
, "firmware: requesting %s\n", name
);
506 retval
= fw_setup_device(firmware
, &f_dev
, name
, device
, uevent
);
510 fw_priv
= dev_get_drvdata(f_dev
);
513 if (loading_timeout
> 0) {
514 fw_priv
->timeout
.expires
= jiffies
+ loading_timeout
* HZ
;
515 add_timer(&fw_priv
->timeout
);
518 kobject_uevent(&f_dev
->kobj
, KOBJ_ADD
);
519 wait_for_completion(&fw_priv
->completion
);
520 set_bit(FW_STATUS_DONE
, &fw_priv
->status
);
521 del_timer_sync(&fw_priv
->timeout
);
523 wait_for_completion(&fw_priv
->completion
);
525 mutex_lock(&fw_lock
);
526 if (!fw_priv
->fw
->size
|| test_bit(FW_STATUS_ABORT
, &fw_priv
->status
)) {
528 release_firmware(fw_priv
->fw
);
532 mutex_unlock(&fw_lock
);
533 device_unregister(f_dev
);
544 * request_firmware: - send firmware request and wait for it
545 * @firmware_p: pointer to firmware image
546 * @name: name of firmware file
547 * @device: device for which firmware is being loaded
549 * @firmware_p will be used to return a firmware image by the name
550 * of @name for device @device.
552 * Should be called from user context where sleeping is allowed.
554 * @name will be used as $FIRMWARE in the uevent environment and
555 * should be distinctive enough not to be confused with any other
556 * firmware image for this or any other device.
559 request_firmware(const struct firmware
**firmware_p
, const char *name
,
560 struct device
*device
)
563 return _request_firmware(firmware_p
, name
, device
, uevent
);
567 * release_firmware: - release the resource associated with a firmware image
568 * @fw: firmware resource to release
571 release_firmware(const struct firmware
*fw
)
573 struct builtin_fw
*builtin
;
576 for (builtin
= __start_builtin_fw
; builtin
!= __end_builtin_fw
;
578 if (fw
->data
== builtin
->data
)
588 struct firmware_work
{
589 struct work_struct work
;
590 struct module
*module
;
592 struct device
*device
;
594 void (*cont
)(const struct firmware
*fw
, void *context
);
599 request_firmware_work_func(void *arg
)
601 struct firmware_work
*fw_work
= arg
;
602 const struct firmware
*fw
;
608 ret
= _request_firmware(&fw
, fw_work
->name
, fw_work
->device
,
611 fw_work
->cont(fw
, fw_work
->context
);
613 module_put(fw_work
->module
);
619 * request_firmware_nowait - asynchronous version of request_firmware
620 * @module: module requesting the firmware
621 * @uevent: sends uevent to copy the firmware image if this flag
622 * is non-zero else the firmware copy must be done manually.
623 * @name: name of firmware file
624 * @device: device for which firmware is being loaded
625 * @gfp: allocation flags
626 * @context: will be passed over to @cont, and
627 * @fw may be %NULL if firmware request fails.
628 * @cont: function will be called asynchronously when the firmware
631 * Asynchronous variant of request_firmware() for user contexts where
632 * it is not possible to sleep for long time. It can't be called
633 * in atomic contexts.
636 request_firmware_nowait(
637 struct module
*module
, int uevent
,
638 const char *name
, struct device
*device
, gfp_t gfp
, void *context
,
639 void (*cont
)(const struct firmware
*fw
, void *context
))
641 struct task_struct
*task
;
642 struct firmware_work
*fw_work
= kmalloc(sizeof (struct firmware_work
),
647 if (!try_module_get(module
)) {
652 *fw_work
= (struct firmware_work
) {
661 task
= kthread_run(request_firmware_work_func
, fw_work
,
662 "firmware/%s", name
);
665 fw_work
->cont(NULL
, fw_work
->context
);
666 module_put(fw_work
->module
);
668 return PTR_ERR(task
);
674 firmware_class_init(void)
677 error
= class_register(&firmware_class
);
679 printk(KERN_ERR
"%s: class_register failed\n", __func__
);
682 error
= class_create_file(&firmware_class
, &class_attr_timeout
);
684 printk(KERN_ERR
"%s: class_create_file failed\n",
686 class_unregister(&firmware_class
);
692 firmware_class_exit(void)
694 class_unregister(&firmware_class
);
697 fs_initcall(firmware_class_init
);
698 module_exit(firmware_class_exit
);
700 EXPORT_SYMBOL(release_firmware
);
701 EXPORT_SYMBOL(request_firmware
);
702 EXPORT_SYMBOL(request_firmware_nowait
);