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>
23 #define to_dev(obj) container_of(obj, struct device, kobj)
25 MODULE_AUTHOR("Manuel Estrada Sainz");
26 MODULE_DESCRIPTION("Multi purpose firmware loading support");
27 MODULE_LICENSE("GPL");
35 static int loading_timeout
= 60; /* In seconds */
37 /* fw_lock could be moved to 'struct firmware_priv' but since it is just
38 * guarding for corner cases a global lock should be OK */
39 static DEFINE_MUTEX(fw_lock
);
41 struct firmware_priv
{
43 struct completion completion
;
44 struct bin_attribute attr_data
;
51 struct timer_list timeout
;
54 #ifdef CONFIG_FW_LOADER
55 extern struct builtin_fw __start_builtin_fw
[];
56 extern struct builtin_fw __end_builtin_fw
[];
57 #else /* Module case. Avoid ifdefs later; it'll all optimise out */
58 static struct builtin_fw
*__start_builtin_fw
;
59 static struct builtin_fw
*__end_builtin_fw
;
63 fw_load_abort(struct firmware_priv
*fw_priv
)
65 set_bit(FW_STATUS_ABORT
, &fw_priv
->status
);
67 complete(&fw_priv
->completion
);
71 firmware_timeout_show(struct class *class,
72 struct class_attribute
*attr
,
75 return sprintf(buf
, "%d\n", loading_timeout
);
79 * firmware_timeout_store - set number of seconds to wait for firmware
80 * @class: device class pointer
81 * @attr: device attribute pointer
82 * @buf: buffer to scan for timeout value
83 * @count: number of bytes in @buf
85 * Sets the number of seconds to wait for the firmware. Once
86 * this expires an error will be returned to the driver and no
87 * firmware will be provided.
89 * Note: zero means 'wait forever'.
92 firmware_timeout_store(struct class *class,
93 struct class_attribute
*attr
,
94 const char *buf
, size_t count
)
96 loading_timeout
= simple_strtol(buf
, NULL
, 10);
97 if (loading_timeout
< 0)
102 static CLASS_ATTR(timeout
, 0644, firmware_timeout_show
, firmware_timeout_store
);
104 static void fw_dev_release(struct device
*dev
);
106 static int firmware_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
108 struct firmware_priv
*fw_priv
= dev_get_drvdata(dev
);
110 if (add_uevent_var(env
, "FIRMWARE=%s", fw_priv
->fw_id
))
112 if (add_uevent_var(env
, "TIMEOUT=%i", loading_timeout
))
118 static struct class firmware_class
= {
120 .dev_uevent
= firmware_uevent
,
121 .dev_release
= fw_dev_release
,
124 static ssize_t
firmware_loading_show(struct device
*dev
,
125 struct device_attribute
*attr
, char *buf
)
127 struct firmware_priv
*fw_priv
= dev_get_drvdata(dev
);
128 int loading
= test_bit(FW_STATUS_LOADING
, &fw_priv
->status
);
129 return sprintf(buf
, "%d\n", loading
);
132 /* Some architectures don't have PAGE_KERNEL_RO */
133 #ifndef PAGE_KERNEL_RO
134 #define PAGE_KERNEL_RO PAGE_KERNEL
137 * firmware_loading_store - set value in the 'loading' control file
138 * @dev: device pointer
139 * @attr: device attribute pointer
140 * @buf: buffer to scan for loading control value
141 * @count: number of bytes in @buf
143 * The relevant values are:
145 * 1: Start a load, discarding any previous partial load.
146 * 0: Conclude the load and hand the data to the driver code.
147 * -1: Conclude the load with an error and discard any written data.
149 static ssize_t
firmware_loading_store(struct device
*dev
,
150 struct device_attribute
*attr
,
151 const char *buf
, size_t count
)
153 struct firmware_priv
*fw_priv
= dev_get_drvdata(dev
);
154 int loading
= simple_strtol(buf
, NULL
, 10);
159 mutex_lock(&fw_lock
);
161 mutex_unlock(&fw_lock
);
164 vfree(fw_priv
->fw
->data
);
165 fw_priv
->fw
->data
= NULL
;
166 for (i
= 0; i
< fw_priv
->nr_pages
; i
++)
167 __free_page(fw_priv
->pages
[i
]);
168 kfree(fw_priv
->pages
);
169 fw_priv
->pages
= NULL
;
170 fw_priv
->page_array_size
= 0;
171 fw_priv
->nr_pages
= 0;
172 fw_priv
->fw
->size
= 0;
173 set_bit(FW_STATUS_LOADING
, &fw_priv
->status
);
174 mutex_unlock(&fw_lock
);
177 if (test_bit(FW_STATUS_LOADING
, &fw_priv
->status
)) {
178 vfree(fw_priv
->fw
->data
);
179 fw_priv
->fw
->data
= vmap(fw_priv
->pages
,
182 if (!fw_priv
->fw
->data
) {
183 dev_err(dev
, "%s: vmap() failed\n", __func__
);
186 /* Pages will be freed by vfree() */
187 fw_priv
->page_array_size
= 0;
188 fw_priv
->nr_pages
= 0;
189 complete(&fw_priv
->completion
);
190 clear_bit(FW_STATUS_LOADING
, &fw_priv
->status
);
195 dev_err(dev
, "%s: unexpected value (%d)\n", __func__
, loading
);
199 fw_load_abort(fw_priv
);
206 static DEVICE_ATTR(loading
, 0644, firmware_loading_show
, firmware_loading_store
);
209 firmware_data_read(struct kobject
*kobj
, struct bin_attribute
*bin_attr
,
210 char *buffer
, loff_t offset
, size_t count
)
212 struct device
*dev
= to_dev(kobj
);
213 struct firmware_priv
*fw_priv
= dev_get_drvdata(dev
);
217 mutex_lock(&fw_lock
);
219 if (!fw
|| test_bit(FW_STATUS_DONE
, &fw_priv
->status
)) {
223 if (offset
> fw
->size
) {
227 if (count
> fw
->size
- offset
)
228 count
= fw
->size
- offset
;
234 int page_nr
= offset
>> PAGE_SHIFT
;
235 int page_ofs
= offset
& (PAGE_SIZE
-1);
236 int page_cnt
= min_t(size_t, PAGE_SIZE
- page_ofs
, count
);
238 page_data
= kmap(fw_priv
->pages
[page_nr
]);
240 memcpy(buffer
, page_data
+ page_ofs
, page_cnt
);
242 kunmap(fw_priv
->pages
[page_nr
]);
248 mutex_unlock(&fw_lock
);
253 fw_realloc_buffer(struct firmware_priv
*fw_priv
, int min_size
)
255 int pages_needed
= ALIGN(min_size
, PAGE_SIZE
) >> PAGE_SHIFT
;
257 /* If the array of pages is too small, grow it... */
258 if (fw_priv
->page_array_size
< pages_needed
) {
259 int new_array_size
= max(pages_needed
,
260 fw_priv
->page_array_size
* 2);
261 struct page
**new_pages
;
263 new_pages
= kmalloc(new_array_size
* sizeof(void *),
266 fw_load_abort(fw_priv
);
269 memcpy(new_pages
, fw_priv
->pages
,
270 fw_priv
->page_array_size
* sizeof(void *));
271 memset(&new_pages
[fw_priv
->page_array_size
], 0, sizeof(void *) *
272 (new_array_size
- fw_priv
->page_array_size
));
273 kfree(fw_priv
->pages
);
274 fw_priv
->pages
= new_pages
;
275 fw_priv
->page_array_size
= new_array_size
;
278 while (fw_priv
->nr_pages
< pages_needed
) {
279 fw_priv
->pages
[fw_priv
->nr_pages
] =
280 alloc_page(GFP_KERNEL
| __GFP_HIGHMEM
);
282 if (!fw_priv
->pages
[fw_priv
->nr_pages
]) {
283 fw_load_abort(fw_priv
);
292 * firmware_data_write - write method for firmware
293 * @kobj: kobject for the device
294 * @bin_attr: bin_attr structure
295 * @buffer: buffer being written
296 * @offset: buffer offset for write in total data store area
297 * @count: buffer size
299 * Data written to the 'data' attribute will be later handed to
300 * the driver as a firmware image.
303 firmware_data_write(struct kobject
*kobj
, struct bin_attribute
*bin_attr
,
304 char *buffer
, loff_t offset
, size_t count
)
306 struct device
*dev
= to_dev(kobj
);
307 struct firmware_priv
*fw_priv
= dev_get_drvdata(dev
);
311 if (!capable(CAP_SYS_RAWIO
))
314 mutex_lock(&fw_lock
);
316 if (!fw
|| test_bit(FW_STATUS_DONE
, &fw_priv
->status
)) {
320 retval
= fw_realloc_buffer(fw_priv
, offset
+ count
);
328 int page_nr
= offset
>> PAGE_SHIFT
;
329 int page_ofs
= offset
& (PAGE_SIZE
- 1);
330 int page_cnt
= min_t(size_t, PAGE_SIZE
- page_ofs
, count
);
332 page_data
= kmap(fw_priv
->pages
[page_nr
]);
334 memcpy(page_data
+ page_ofs
, buffer
, page_cnt
);
336 kunmap(fw_priv
->pages
[page_nr
]);
342 fw
->size
= max_t(size_t, offset
, fw
->size
);
344 mutex_unlock(&fw_lock
);
348 static struct bin_attribute firmware_attr_data_tmpl
= {
349 .attr
= {.name
= "data", .mode
= 0644},
351 .read
= firmware_data_read
,
352 .write
= firmware_data_write
,
355 static void fw_dev_release(struct device
*dev
)
357 struct firmware_priv
*fw_priv
= dev_get_drvdata(dev
);
360 for (i
= 0; i
< fw_priv
->nr_pages
; i
++)
361 __free_page(fw_priv
->pages
[i
]);
362 kfree(fw_priv
->pages
);
363 kfree(fw_priv
->fw_id
);
367 module_put(THIS_MODULE
);
371 firmware_class_timeout(u_long data
)
373 struct firmware_priv
*fw_priv
= (struct firmware_priv
*) data
;
374 fw_load_abort(fw_priv
);
377 static int fw_register_device(struct device
**dev_p
, const char *fw_name
,
378 struct device
*device
)
381 struct firmware_priv
*fw_priv
= kzalloc(sizeof(*fw_priv
),
383 struct device
*f_dev
= kzalloc(sizeof(*f_dev
), GFP_KERNEL
);
387 if (!fw_priv
|| !f_dev
) {
388 dev_err(device
, "%s: kmalloc failed\n", __func__
);
393 init_completion(&fw_priv
->completion
);
394 fw_priv
->attr_data
= firmware_attr_data_tmpl
;
395 fw_priv
->fw_id
= kstrdup(fw_name
, GFP_KERNEL
);
396 if (!fw_priv
->fw_id
) {
397 dev_err(device
, "%s: Firmware name allocation failed\n",
403 fw_priv
->timeout
.function
= firmware_class_timeout
;
404 fw_priv
->timeout
.data
= (u_long
) fw_priv
;
405 init_timer(&fw_priv
->timeout
);
407 dev_set_name(f_dev
, "%s", dev_name(device
));
408 f_dev
->parent
= device
;
409 f_dev
->class = &firmware_class
;
410 dev_set_drvdata(f_dev
, fw_priv
);
411 dev_set_uevent_suppress(f_dev
, 1);
412 retval
= device_register(f_dev
);
414 dev_err(device
, "%s: device_register failed\n", __func__
);
427 static int fw_setup_device(struct firmware
*fw
, struct device
**dev_p
,
428 const char *fw_name
, struct device
*device
,
431 struct device
*f_dev
;
432 struct firmware_priv
*fw_priv
;
436 retval
= fw_register_device(&f_dev
, fw_name
, device
);
440 /* Need to pin this module until class device is destroyed */
441 __module_get(THIS_MODULE
);
443 fw_priv
= dev_get_drvdata(f_dev
);
446 sysfs_bin_attr_init(&fw_priv
->attr_data
);
447 retval
= sysfs_create_bin_file(&f_dev
->kobj
, &fw_priv
->attr_data
);
449 dev_err(device
, "%s: sysfs_create_bin_file failed\n", __func__
);
453 retval
= device_create_file(f_dev
, &dev_attr_loading
);
455 dev_err(device
, "%s: device_create_file failed\n", __func__
);
460 dev_set_uevent_suppress(f_dev
, 0);
465 device_unregister(f_dev
);
471 _request_firmware(const struct firmware
**firmware_p
, const char *name
,
472 struct device
*device
, int uevent
)
474 struct device
*f_dev
;
475 struct firmware_priv
*fw_priv
;
476 struct firmware
*firmware
;
477 struct builtin_fw
*builtin
;
483 *firmware_p
= firmware
= kzalloc(sizeof(*firmware
), GFP_KERNEL
);
485 dev_err(device
, "%s: kmalloc(struct firmware) failed\n",
491 for (builtin
= __start_builtin_fw
; builtin
!= __end_builtin_fw
;
493 if (strcmp(name
, builtin
->name
))
495 dev_info(device
, "firmware: using built-in firmware %s\n",
497 firmware
->size
= builtin
->size
;
498 firmware
->data
= builtin
->data
;
503 dev_info(device
, "firmware: requesting %s\n", name
);
505 retval
= fw_setup_device(firmware
, &f_dev
, name
, device
, uevent
);
509 fw_priv
= dev_get_drvdata(f_dev
);
512 if (loading_timeout
> 0) {
513 fw_priv
->timeout
.expires
= jiffies
+ loading_timeout
* HZ
;
514 add_timer(&fw_priv
->timeout
);
517 kobject_uevent(&f_dev
->kobj
, KOBJ_ADD
);
518 wait_for_completion(&fw_priv
->completion
);
519 set_bit(FW_STATUS_DONE
, &fw_priv
->status
);
520 del_timer_sync(&fw_priv
->timeout
);
522 wait_for_completion(&fw_priv
->completion
);
524 mutex_lock(&fw_lock
);
525 if (!fw_priv
->fw
->size
|| test_bit(FW_STATUS_ABORT
, &fw_priv
->status
)) {
527 release_firmware(fw_priv
->fw
);
531 mutex_unlock(&fw_lock
);
532 device_unregister(f_dev
);
543 * request_firmware: - send firmware request and wait for it
544 * @firmware_p: pointer to firmware image
545 * @name: name of firmware file
546 * @device: device for which firmware is being loaded
548 * @firmware_p will be used to return a firmware image by the name
549 * of @name for device @device.
551 * Should be called from user context where sleeping is allowed.
553 * @name will be used as $FIRMWARE in the uevent environment and
554 * should be distinctive enough not to be confused with any other
555 * firmware image for this or any other device.
558 request_firmware(const struct firmware
**firmware_p
, const char *name
,
559 struct device
*device
)
562 return _request_firmware(firmware_p
, name
, device
, uevent
);
566 * release_firmware: - release the resource associated with a firmware image
567 * @fw: firmware resource to release
570 release_firmware(const struct firmware
*fw
)
572 struct builtin_fw
*builtin
;
575 for (builtin
= __start_builtin_fw
; builtin
!= __end_builtin_fw
;
577 if (fw
->data
== builtin
->data
)
587 struct firmware_work
{
588 struct work_struct work
;
589 struct module
*module
;
591 struct device
*device
;
593 void (*cont
)(const struct firmware
*fw
, void *context
);
598 request_firmware_work_func(void *arg
)
600 struct firmware_work
*fw_work
= arg
;
601 const struct firmware
*fw
;
607 ret
= _request_firmware(&fw
, fw_work
->name
, fw_work
->device
,
610 fw_work
->cont(fw
, fw_work
->context
);
612 module_put(fw_work
->module
);
618 * request_firmware_nowait - asynchronous version of request_firmware
619 * @module: module requesting the firmware
620 * @uevent: sends uevent to copy the firmware image if this flag
621 * is non-zero else the firmware copy must be done manually.
622 * @name: name of firmware file
623 * @device: device for which firmware is being loaded
624 * @gfp: allocation flags
625 * @context: will be passed over to @cont, and
626 * @fw may be %NULL if firmware request fails.
627 * @cont: function will be called asynchronously when the firmware
630 * Asynchronous variant of request_firmware() for user contexts where
631 * it is not possible to sleep for long time. It can't be called
632 * in atomic contexts.
635 request_firmware_nowait(
636 struct module
*module
, int uevent
,
637 const char *name
, struct device
*device
, gfp_t gfp
, void *context
,
638 void (*cont
)(const struct firmware
*fw
, void *context
))
640 struct task_struct
*task
;
641 struct firmware_work
*fw_work
= kmalloc(sizeof (struct firmware_work
),
646 if (!try_module_get(module
)) {
651 *fw_work
= (struct firmware_work
) {
660 task
= kthread_run(request_firmware_work_func
, fw_work
,
661 "firmware/%s", name
);
664 fw_work
->cont(NULL
, fw_work
->context
);
665 module_put(fw_work
->module
);
667 return PTR_ERR(task
);
673 firmware_class_init(void)
676 error
= class_register(&firmware_class
);
678 printk(KERN_ERR
"%s: class_register failed\n", __func__
);
681 error
= class_create_file(&firmware_class
, &class_attr_timeout
);
683 printk(KERN_ERR
"%s: class_create_file failed\n",
685 class_unregister(&firmware_class
);
691 firmware_class_exit(void)
693 class_unregister(&firmware_class
);
696 fs_initcall(firmware_class_init
);
697 module_exit(firmware_class_exit
);
699 EXPORT_SYMBOL(release_firmware
);
700 EXPORT_SYMBOL(request_firmware
);
701 EXPORT_SYMBOL(request_firmware_nowait
);