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 * @buf: buffer to scan for timeout value
82 * @count: number of bytes in @buf
84 * Sets the number of seconds to wait for the firmware. Once
85 * this expires an error will be returned to the driver and no
86 * firmware will be provided.
88 * Note: zero means 'wait forever'.
91 firmware_timeout_store(struct class *class,
92 struct class_attribute
*attr
,
93 const char *buf
, size_t count
)
95 loading_timeout
= simple_strtol(buf
, NULL
, 10);
96 if (loading_timeout
< 0)
101 static CLASS_ATTR(timeout
, 0644, firmware_timeout_show
, firmware_timeout_store
);
103 static void fw_dev_release(struct device
*dev
);
105 static int firmware_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
107 struct firmware_priv
*fw_priv
= dev_get_drvdata(dev
);
109 if (add_uevent_var(env
, "FIRMWARE=%s", fw_priv
->fw_id
))
111 if (add_uevent_var(env
, "TIMEOUT=%i", loading_timeout
))
117 static struct class firmware_class
= {
119 .dev_uevent
= firmware_uevent
,
120 .dev_release
= fw_dev_release
,
123 static ssize_t
firmware_loading_show(struct device
*dev
,
124 struct device_attribute
*attr
, char *buf
)
126 struct firmware_priv
*fw_priv
= dev_get_drvdata(dev
);
127 int loading
= test_bit(FW_STATUS_LOADING
, &fw_priv
->status
);
128 return sprintf(buf
, "%d\n", loading
);
131 /* Some architectures don't have PAGE_KERNEL_RO */
132 #ifndef PAGE_KERNEL_RO
133 #define PAGE_KERNEL_RO PAGE_KERNEL
136 * firmware_loading_store - set value in the 'loading' control file
137 * @dev: device pointer
138 * @attr: device attribute pointer
139 * @buf: buffer to scan for loading control value
140 * @count: number of bytes in @buf
142 * The relevant values are:
144 * 1: Start a load, discarding any previous partial load.
145 * 0: Conclude the load and hand the data to the driver code.
146 * -1: Conclude the load with an error and discard any written data.
148 static ssize_t
firmware_loading_store(struct device
*dev
,
149 struct device_attribute
*attr
,
150 const char *buf
, size_t count
)
152 struct firmware_priv
*fw_priv
= dev_get_drvdata(dev
);
153 int loading
= simple_strtol(buf
, NULL
, 10);
158 mutex_lock(&fw_lock
);
160 mutex_unlock(&fw_lock
);
163 vfree(fw_priv
->fw
->data
);
164 fw_priv
->fw
->data
= NULL
;
165 for (i
= 0; i
< fw_priv
->nr_pages
; i
++)
166 __free_page(fw_priv
->pages
[i
]);
167 kfree(fw_priv
->pages
);
168 fw_priv
->pages
= NULL
;
169 fw_priv
->page_array_size
= 0;
170 fw_priv
->nr_pages
= 0;
171 fw_priv
->fw
->size
= 0;
172 set_bit(FW_STATUS_LOADING
, &fw_priv
->status
);
173 mutex_unlock(&fw_lock
);
176 if (test_bit(FW_STATUS_LOADING
, &fw_priv
->status
)) {
177 vfree(fw_priv
->fw
->data
);
178 fw_priv
->fw
->data
= vmap(fw_priv
->pages
,
181 if (!fw_priv
->fw
->data
) {
182 dev_err(dev
, "%s: vmap() failed\n", __func__
);
185 /* Pages will be freed by vfree() */
186 fw_priv
->page_array_size
= 0;
187 fw_priv
->nr_pages
= 0;
188 complete(&fw_priv
->completion
);
189 clear_bit(FW_STATUS_LOADING
, &fw_priv
->status
);
194 dev_err(dev
, "%s: unexpected value (%d)\n", __func__
, loading
);
198 fw_load_abort(fw_priv
);
205 static DEVICE_ATTR(loading
, 0644, firmware_loading_show
, firmware_loading_store
);
208 firmware_data_read(struct kobject
*kobj
, struct bin_attribute
*bin_attr
,
209 char *buffer
, loff_t offset
, size_t count
)
211 struct device
*dev
= to_dev(kobj
);
212 struct firmware_priv
*fw_priv
= dev_get_drvdata(dev
);
216 mutex_lock(&fw_lock
);
218 if (!fw
|| test_bit(FW_STATUS_DONE
, &fw_priv
->status
)) {
222 if (offset
> fw
->size
) {
226 if (count
> fw
->size
- offset
)
227 count
= fw
->size
- offset
;
233 int page_nr
= offset
>> PAGE_SHIFT
;
234 int page_ofs
= offset
& (PAGE_SIZE
-1);
235 int page_cnt
= min_t(size_t, PAGE_SIZE
- page_ofs
, count
);
237 page_data
= kmap(fw_priv
->pages
[page_nr
]);
239 memcpy(buffer
, page_data
+ page_ofs
, page_cnt
);
241 kunmap(fw_priv
->pages
[page_nr
]);
247 mutex_unlock(&fw_lock
);
252 fw_realloc_buffer(struct firmware_priv
*fw_priv
, int min_size
)
254 int pages_needed
= ALIGN(min_size
, PAGE_SIZE
) >> PAGE_SHIFT
;
256 /* If the array of pages is too small, grow it... */
257 if (fw_priv
->page_array_size
< pages_needed
) {
258 int new_array_size
= max(pages_needed
,
259 fw_priv
->page_array_size
* 2);
260 struct page
**new_pages
;
262 new_pages
= kmalloc(new_array_size
* sizeof(void *),
265 fw_load_abort(fw_priv
);
268 memcpy(new_pages
, fw_priv
->pages
,
269 fw_priv
->page_array_size
* sizeof(void *));
270 memset(&new_pages
[fw_priv
->page_array_size
], 0, sizeof(void *) *
271 (new_array_size
- fw_priv
->page_array_size
));
272 kfree(fw_priv
->pages
);
273 fw_priv
->pages
= new_pages
;
274 fw_priv
->page_array_size
= new_array_size
;
277 while (fw_priv
->nr_pages
< pages_needed
) {
278 fw_priv
->pages
[fw_priv
->nr_pages
] =
279 alloc_page(GFP_KERNEL
| __GFP_HIGHMEM
);
281 if (!fw_priv
->pages
[fw_priv
->nr_pages
]) {
282 fw_load_abort(fw_priv
);
291 * firmware_data_write - write method for firmware
292 * @kobj: kobject for the device
293 * @bin_attr: bin_attr structure
294 * @buffer: buffer being written
295 * @offset: buffer offset for write in total data store area
296 * @count: buffer size
298 * Data written to the 'data' attribute will be later handed to
299 * the driver as a firmware image.
302 firmware_data_write(struct kobject
*kobj
, struct bin_attribute
*bin_attr
,
303 char *buffer
, loff_t offset
, size_t count
)
305 struct device
*dev
= to_dev(kobj
);
306 struct firmware_priv
*fw_priv
= dev_get_drvdata(dev
);
310 if (!capable(CAP_SYS_RAWIO
))
313 mutex_lock(&fw_lock
);
315 if (!fw
|| test_bit(FW_STATUS_DONE
, &fw_priv
->status
)) {
319 retval
= fw_realloc_buffer(fw_priv
, offset
+ count
);
327 int page_nr
= offset
>> PAGE_SHIFT
;
328 int page_ofs
= offset
& (PAGE_SIZE
- 1);
329 int page_cnt
= min_t(size_t, PAGE_SIZE
- page_ofs
, count
);
331 page_data
= kmap(fw_priv
->pages
[page_nr
]);
333 memcpy(page_data
+ page_ofs
, buffer
, page_cnt
);
335 kunmap(fw_priv
->pages
[page_nr
]);
341 fw
->size
= max_t(size_t, offset
, fw
->size
);
343 mutex_unlock(&fw_lock
);
347 static struct bin_attribute firmware_attr_data_tmpl
= {
348 .attr
= {.name
= "data", .mode
= 0644},
350 .read
= firmware_data_read
,
351 .write
= firmware_data_write
,
354 static void fw_dev_release(struct device
*dev
)
356 struct firmware_priv
*fw_priv
= dev_get_drvdata(dev
);
359 for (i
= 0; i
< fw_priv
->nr_pages
; i
++)
360 __free_page(fw_priv
->pages
[i
]);
361 kfree(fw_priv
->pages
);
362 kfree(fw_priv
->fw_id
);
366 module_put(THIS_MODULE
);
370 firmware_class_timeout(u_long data
)
372 struct firmware_priv
*fw_priv
= (struct firmware_priv
*) data
;
373 fw_load_abort(fw_priv
);
376 static int fw_register_device(struct device
**dev_p
, const char *fw_name
,
377 struct device
*device
)
380 struct firmware_priv
*fw_priv
= kzalloc(sizeof(*fw_priv
),
382 struct device
*f_dev
= kzalloc(sizeof(*f_dev
), GFP_KERNEL
);
386 if (!fw_priv
|| !f_dev
) {
387 dev_err(device
, "%s: kmalloc failed\n", __func__
);
392 init_completion(&fw_priv
->completion
);
393 fw_priv
->attr_data
= firmware_attr_data_tmpl
;
394 fw_priv
->fw_id
= kstrdup(fw_name
, GFP_KERNEL
);
395 if (!fw_priv
->fw_id
) {
396 dev_err(device
, "%s: Firmware name allocation failed\n",
402 fw_priv
->timeout
.function
= firmware_class_timeout
;
403 fw_priv
->timeout
.data
= (u_long
) fw_priv
;
404 init_timer(&fw_priv
->timeout
);
406 dev_set_name(f_dev
, "%s", dev_name(device
));
407 f_dev
->parent
= device
;
408 f_dev
->class = &firmware_class
;
409 dev_set_drvdata(f_dev
, fw_priv
);
410 dev_set_uevent_suppress(f_dev
, 1);
411 retval
= device_register(f_dev
);
413 dev_err(device
, "%s: device_register failed\n", __func__
);
426 static int fw_setup_device(struct firmware
*fw
, struct device
**dev_p
,
427 const char *fw_name
, struct device
*device
,
430 struct device
*f_dev
;
431 struct firmware_priv
*fw_priv
;
435 retval
= fw_register_device(&f_dev
, fw_name
, device
);
439 /* Need to pin this module until class device is destroyed */
440 __module_get(THIS_MODULE
);
442 fw_priv
= dev_get_drvdata(f_dev
);
445 retval
= sysfs_create_bin_file(&f_dev
->kobj
, &fw_priv
->attr_data
);
447 dev_err(device
, "%s: sysfs_create_bin_file failed\n", __func__
);
451 retval
= device_create_file(f_dev
, &dev_attr_loading
);
453 dev_err(device
, "%s: device_create_file failed\n", __func__
);
458 dev_set_uevent_suppress(f_dev
, 0);
463 device_unregister(f_dev
);
469 _request_firmware(const struct firmware
**firmware_p
, const char *name
,
470 struct device
*device
, int uevent
)
472 struct device
*f_dev
;
473 struct firmware_priv
*fw_priv
;
474 struct firmware
*firmware
;
475 struct builtin_fw
*builtin
;
481 *firmware_p
= firmware
= kzalloc(sizeof(*firmware
), GFP_KERNEL
);
483 dev_err(device
, "%s: kmalloc(struct firmware) failed\n",
489 for (builtin
= __start_builtin_fw
; builtin
!= __end_builtin_fw
;
491 if (strcmp(name
, builtin
->name
))
493 dev_info(device
, "firmware: using built-in firmware %s\n",
495 firmware
->size
= builtin
->size
;
496 firmware
->data
= builtin
->data
;
501 dev_info(device
, "firmware: requesting %s\n", name
);
503 retval
= fw_setup_device(firmware
, &f_dev
, name
, device
, uevent
);
507 fw_priv
= dev_get_drvdata(f_dev
);
510 if (loading_timeout
> 0) {
511 fw_priv
->timeout
.expires
= jiffies
+ loading_timeout
* HZ
;
512 add_timer(&fw_priv
->timeout
);
515 kobject_uevent(&f_dev
->kobj
, KOBJ_ADD
);
516 wait_for_completion(&fw_priv
->completion
);
517 set_bit(FW_STATUS_DONE
, &fw_priv
->status
);
518 del_timer_sync(&fw_priv
->timeout
);
520 wait_for_completion(&fw_priv
->completion
);
522 mutex_lock(&fw_lock
);
523 if (!fw_priv
->fw
->size
|| test_bit(FW_STATUS_ABORT
, &fw_priv
->status
)) {
525 release_firmware(fw_priv
->fw
);
529 mutex_unlock(&fw_lock
);
530 device_unregister(f_dev
);
541 * request_firmware: - send firmware request and wait for it
542 * @firmware_p: pointer to firmware image
543 * @name: name of firmware file
544 * @device: device for which firmware is being loaded
546 * @firmware_p will be used to return a firmware image by the name
547 * of @name for device @device.
549 * Should be called from user context where sleeping is allowed.
551 * @name will be used as $FIRMWARE in the uevent environment and
552 * should be distinctive enough not to be confused with any other
553 * firmware image for this or any other device.
556 request_firmware(const struct firmware
**firmware_p
, const char *name
,
557 struct device
*device
)
560 return _request_firmware(firmware_p
, name
, device
, uevent
);
564 * release_firmware: - release the resource associated with a firmware image
565 * @fw: firmware resource to release
568 release_firmware(const struct firmware
*fw
)
570 struct builtin_fw
*builtin
;
573 for (builtin
= __start_builtin_fw
; builtin
!= __end_builtin_fw
;
575 if (fw
->data
== builtin
->data
)
585 struct firmware_work
{
586 struct work_struct work
;
587 struct module
*module
;
589 struct device
*device
;
591 void (*cont
)(const struct firmware
*fw
, void *context
);
596 request_firmware_work_func(void *arg
)
598 struct firmware_work
*fw_work
= arg
;
599 const struct firmware
*fw
;
605 ret
= _request_firmware(&fw
, fw_work
->name
, fw_work
->device
,
608 fw_work
->cont(fw
, fw_work
->context
);
610 module_put(fw_work
->module
);
616 * request_firmware_nowait - asynchronous version of request_firmware
617 * @module: module requesting the firmware
618 * @uevent: sends uevent to copy the firmware image if this flag
619 * is non-zero else the firmware copy must be done manually.
620 * @name: name of firmware file
621 * @device: device for which firmware is being loaded
622 * @gfp: allocation flags
623 * @context: will be passed over to @cont, and
624 * @fw may be %NULL if firmware request fails.
625 * @cont: function will be called asynchronously when the firmware
628 * Asynchronous variant of request_firmware() for user contexts where
629 * it is not possible to sleep for long time. It can't be called
630 * in atomic contexts.
633 request_firmware_nowait(
634 struct module
*module
, int uevent
,
635 const char *name
, struct device
*device
, gfp_t gfp
, void *context
,
636 void (*cont
)(const struct firmware
*fw
, void *context
))
638 struct task_struct
*task
;
639 struct firmware_work
*fw_work
= kmalloc(sizeof (struct firmware_work
),
644 if (!try_module_get(module
)) {
649 *fw_work
= (struct firmware_work
) {
658 task
= kthread_run(request_firmware_work_func
, fw_work
,
659 "firmware/%s", name
);
662 fw_work
->cont(NULL
, fw_work
->context
);
663 module_put(fw_work
->module
);
665 return PTR_ERR(task
);
671 firmware_class_init(void)
674 error
= class_register(&firmware_class
);
676 printk(KERN_ERR
"%s: class_register failed\n", __func__
);
679 error
= class_create_file(&firmware_class
, &class_attr_timeout
);
681 printk(KERN_ERR
"%s: class_create_file failed\n",
683 class_unregister(&firmware_class
);
689 firmware_class_exit(void)
691 class_unregister(&firmware_class
);
694 fs_initcall(firmware_class_init
);
695 module_exit(firmware_class_exit
);
697 EXPORT_SYMBOL(release_firmware
);
698 EXPORT_SYMBOL(request_firmware
);
699 EXPORT_SYMBOL(request_firmware_nowait
);