2 * firmware_class.c - Multi purpose firmware loading support
4 * Copyright (c) 2003 Manuel Estrada Sainz <ranty@debian.org>
6 * Please see Documentation/firmware_class/ for more information.
10 #include <linux/device.h>
11 #include <linux/module.h>
12 #include <linux/init.h>
13 #include <linux/timer.h>
14 #include <linux/vmalloc.h>
15 #include <linux/interrupt.h>
16 #include <linux/bitops.h>
17 #include <asm/semaphore.h>
19 #include <linux/firmware.h>
22 MODULE_AUTHOR("Manuel Estrada Sainz <ranty@debian.org>");
23 MODULE_DESCRIPTION("Multi purpose firmware loading support");
24 MODULE_LICENSE("GPL");
31 FW_STATUS_READY_NOHOTPLUG
,
34 static int loading_timeout
= 10; /* In seconds */
36 /* fw_lock could be moved to 'struct firmware_priv' but since it is just
37 * guarding for corner cases a global lock should be OK */
38 static DECLARE_MUTEX(fw_lock
);
40 struct firmware_priv
{
41 char fw_id
[FIRMWARE_NAME_MAX
];
42 struct completion completion
;
43 struct bin_attribute attr_data
;
47 struct timer_list timeout
;
51 fw_load_abort(struct firmware_priv
*fw_priv
)
53 set_bit(FW_STATUS_ABORT
, &fw_priv
->status
);
55 complete(&fw_priv
->completion
);
59 firmware_timeout_show(struct class *class, char *buf
)
61 return sprintf(buf
, "%d\n", loading_timeout
);
65 * firmware_timeout_store - set number of seconds to wait for firmware
66 * @class: device class pointer
67 * @buf: buffer to scan for timeout value
68 * @count: number of bytes in @buf
70 * Sets the number of seconds to wait for the firmware. Once
71 * this expires an error will be returned to the driver and no
72 * firmware will be provided.
74 * Note: zero means 'wait forever'.
77 firmware_timeout_store(struct class *class, const char *buf
, size_t count
)
79 loading_timeout
= simple_strtol(buf
, NULL
, 10);
80 if (loading_timeout
< 0)
85 static CLASS_ATTR(timeout
, 0644, firmware_timeout_show
, firmware_timeout_store
);
87 static void fw_class_dev_release(struct class_device
*class_dev
);
88 int firmware_class_hotplug(struct class_device
*dev
, char **envp
,
89 int num_envp
, char *buffer
, int buffer_size
);
91 static struct class firmware_class
= {
93 .hotplug
= firmware_class_hotplug
,
94 .release
= fw_class_dev_release
,
98 firmware_class_hotplug(struct class_device
*class_dev
, char **envp
,
99 int num_envp
, char *buffer
, int buffer_size
)
101 struct firmware_priv
*fw_priv
= class_get_devdata(class_dev
);
104 if (!test_bit(FW_STATUS_READY
, &fw_priv
->status
))
107 if (add_hotplug_env_var(envp
, num_envp
, &i
, buffer
, buffer_size
, &len
,
108 "FIRMWARE=%s", fw_priv
->fw_id
))
110 if (add_hotplug_env_var(envp
, num_envp
, &i
, buffer
, buffer_size
, &len
,
111 "TIMEOUT=%i", loading_timeout
))
120 firmware_loading_show(struct class_device
*class_dev
, char *buf
)
122 struct firmware_priv
*fw_priv
= class_get_devdata(class_dev
);
123 int loading
= test_bit(FW_STATUS_LOADING
, &fw_priv
->status
);
124 return sprintf(buf
, "%d\n", loading
);
128 * firmware_loading_store - set value in the 'loading' control file
129 * @class_dev: class_device pointer
130 * @buf: buffer to scan for loading control value
131 * @count: number of bytes in @buf
133 * The relevant values are:
135 * 1: Start a load, discarding any previous partial load.
136 * 0: Conclude the load and hand the data to the driver code.
137 * -1: Conclude the load with an error and discard any written data.
140 firmware_loading_store(struct class_device
*class_dev
,
141 const char *buf
, size_t count
)
143 struct firmware_priv
*fw_priv
= class_get_devdata(class_dev
);
144 int loading
= simple_strtol(buf
, NULL
, 10);
153 vfree(fw_priv
->fw
->data
);
154 fw_priv
->fw
->data
= NULL
;
155 fw_priv
->fw
->size
= 0;
156 fw_priv
->alloc_size
= 0;
157 set_bit(FW_STATUS_LOADING
, &fw_priv
->status
);
161 if (test_bit(FW_STATUS_LOADING
, &fw_priv
->status
)) {
162 complete(&fw_priv
->completion
);
163 clear_bit(FW_STATUS_LOADING
, &fw_priv
->status
);
168 printk(KERN_ERR
"%s: unexpected value (%d)\n", __FUNCTION__
,
172 fw_load_abort(fw_priv
);
179 static CLASS_DEVICE_ATTR(loading
, 0644,
180 firmware_loading_show
, firmware_loading_store
);
183 firmware_data_read(struct kobject
*kobj
,
184 char *buffer
, loff_t offset
, size_t count
)
186 struct class_device
*class_dev
= to_class_dev(kobj
);
187 struct firmware_priv
*fw_priv
= class_get_devdata(class_dev
);
189 ssize_t ret_count
= count
;
193 if (!fw
|| test_bit(FW_STATUS_DONE
, &fw_priv
->status
)) {
197 if (offset
> fw
->size
) {
201 if (offset
+ ret_count
> fw
->size
)
202 ret_count
= fw
->size
- offset
;
204 memcpy(buffer
, fw
->data
+ offset
, ret_count
);
211 fw_realloc_buffer(struct firmware_priv
*fw_priv
, int min_size
)
215 if (min_size
<= fw_priv
->alloc_size
)
218 new_data
= vmalloc(fw_priv
->alloc_size
+ PAGE_SIZE
);
220 printk(KERN_ERR
"%s: unable to alloc buffer\n", __FUNCTION__
);
221 /* Make sure that we don't keep incomplete data */
222 fw_load_abort(fw_priv
);
225 fw_priv
->alloc_size
+= PAGE_SIZE
;
226 if (fw_priv
->fw
->data
) {
227 memcpy(new_data
, fw_priv
->fw
->data
, fw_priv
->fw
->size
);
228 vfree(fw_priv
->fw
->data
);
230 fw_priv
->fw
->data
= new_data
;
231 BUG_ON(min_size
> fw_priv
->alloc_size
);
236 * firmware_data_write - write method for firmware
237 * @kobj: kobject for the class_device
238 * @buffer: buffer being written
239 * @offset: buffer offset for write in total data store area
240 * @count: buffer size
242 * Data written to the 'data' attribute will be later handed to
243 * the driver as a firmware image.
246 firmware_data_write(struct kobject
*kobj
,
247 char *buffer
, loff_t offset
, size_t count
)
249 struct class_device
*class_dev
= to_class_dev(kobj
);
250 struct firmware_priv
*fw_priv
= class_get_devdata(class_dev
);
254 if (!capable(CAP_SYS_RAWIO
))
259 if (!fw
|| test_bit(FW_STATUS_DONE
, &fw_priv
->status
)) {
263 retval
= fw_realloc_buffer(fw_priv
, offset
+ count
);
267 memcpy(fw
->data
+ offset
, buffer
, count
);
269 fw
->size
= max_t(size_t, offset
+ count
, fw
->size
);
276 static struct bin_attribute firmware_attr_data_tmpl
= {
277 .attr
= {.name
= "data", .mode
= 0644, .owner
= THIS_MODULE
},
279 .read
= firmware_data_read
,
280 .write
= firmware_data_write
,
284 fw_class_dev_release(struct class_device
*class_dev
)
286 struct firmware_priv
*fw_priv
= class_get_devdata(class_dev
);
291 module_put(THIS_MODULE
);
295 firmware_class_timeout(u_long data
)
297 struct firmware_priv
*fw_priv
= (struct firmware_priv
*) data
;
298 fw_load_abort(fw_priv
);
302 fw_setup_class_device_id(struct class_device
*class_dev
, struct device
*dev
)
304 /* XXX warning we should watch out for name collisions */
305 strlcpy(class_dev
->class_id
, dev
->bus_id
, BUS_ID_SIZE
);
309 fw_register_class_device(struct class_device
**class_dev_p
,
310 const char *fw_name
, struct device
*device
)
313 struct firmware_priv
*fw_priv
= kzalloc(sizeof(*fw_priv
),
315 struct class_device
*class_dev
= kzalloc(sizeof(*class_dev
),
320 if (!fw_priv
|| !class_dev
) {
321 printk(KERN_ERR
"%s: kmalloc failed\n", __FUNCTION__
);
326 init_completion(&fw_priv
->completion
);
327 fw_priv
->attr_data
= firmware_attr_data_tmpl
;
328 strlcpy(fw_priv
->fw_id
, fw_name
, FIRMWARE_NAME_MAX
);
330 fw_priv
->timeout
.function
= firmware_class_timeout
;
331 fw_priv
->timeout
.data
= (u_long
) fw_priv
;
332 init_timer(&fw_priv
->timeout
);
334 fw_setup_class_device_id(class_dev
, device
);
335 class_dev
->dev
= device
;
336 class_dev
->class = &firmware_class
;
337 class_set_devdata(class_dev
, fw_priv
);
338 retval
= class_device_register(class_dev
);
340 printk(KERN_ERR
"%s: class_device_register failed\n",
344 *class_dev_p
= class_dev
;
354 fw_setup_class_device(struct firmware
*fw
, struct class_device
**class_dev_p
,
355 const char *fw_name
, struct device
*device
, int hotplug
)
357 struct class_device
*class_dev
;
358 struct firmware_priv
*fw_priv
;
362 retval
= fw_register_class_device(&class_dev
, fw_name
, device
);
366 /* Need to pin this module until class device is destroyed */
367 __module_get(THIS_MODULE
);
369 fw_priv
= class_get_devdata(class_dev
);
372 retval
= sysfs_create_bin_file(&class_dev
->kobj
, &fw_priv
->attr_data
);
374 printk(KERN_ERR
"%s: sysfs_create_bin_file failed\n",
379 retval
= class_device_create_file(class_dev
,
380 &class_device_attr_loading
);
382 printk(KERN_ERR
"%s: class_device_create_file failed\n",
388 set_bit(FW_STATUS_READY
, &fw_priv
->status
);
390 set_bit(FW_STATUS_READY_NOHOTPLUG
, &fw_priv
->status
);
391 *class_dev_p
= class_dev
;
395 class_device_unregister(class_dev
);
401 _request_firmware(const struct firmware
**firmware_p
, const char *name
,
402 struct device
*device
, int hotplug
)
404 struct class_device
*class_dev
;
405 struct firmware_priv
*fw_priv
;
406 struct firmware
*firmware
;
412 *firmware_p
= firmware
= kzalloc(sizeof(*firmware
), GFP_KERNEL
);
414 printk(KERN_ERR
"%s: kmalloc(struct firmware) failed\n",
420 retval
= fw_setup_class_device(firmware
, &class_dev
, name
, device
,
425 fw_priv
= class_get_devdata(class_dev
);
428 if (loading_timeout
> 0) {
429 fw_priv
->timeout
.expires
= jiffies
+ loading_timeout
* HZ
;
430 add_timer(&fw_priv
->timeout
);
433 kobject_hotplug(&class_dev
->kobj
, KOBJ_ADD
);
434 wait_for_completion(&fw_priv
->completion
);
435 set_bit(FW_STATUS_DONE
, &fw_priv
->status
);
436 del_timer_sync(&fw_priv
->timeout
);
438 wait_for_completion(&fw_priv
->completion
);
441 if (!fw_priv
->fw
->size
|| test_bit(FW_STATUS_ABORT
, &fw_priv
->status
)) {
443 release_firmware(fw_priv
->fw
);
448 class_device_unregister(class_dev
);
459 * request_firmware: - request firmware to hotplug and wait for it
460 * @firmware_p: pointer to firmware image
461 * @name: name of firmware file
462 * @device: device for which firmware is being loaded
464 * @firmware_p will be used to return a firmware image by the name
465 * of @name for device @device.
467 * Should be called from user context where sleeping is allowed.
469 * @name will be used as $FIRMWARE in the hotplug environment and
470 * should be distinctive enough not to be confused with any other
471 * firmware image for this or any other device.
474 request_firmware(const struct firmware
**firmware_p
, const char *name
,
475 struct device
*device
)
478 return _request_firmware(firmware_p
, name
, device
, hotplug
);
482 * release_firmware: - release the resource associated with a firmware image
483 * @fw: firmware resource to release
486 release_firmware(const struct firmware
*fw
)
495 * register_firmware: - provide a firmware image for later usage
496 * @name: name of firmware image file
497 * @data: buffer pointer for the firmware image
498 * @size: size of the data buffer area
500 * Make sure that @data will be available by requesting firmware @name.
502 * Note: This will not be possible until some kind of persistence
506 register_firmware(const char *name
, const u8
*data
, size_t size
)
508 /* This is meaningless without firmware caching, so until we
509 * decide if firmware caching is reasonable just leave it as a
514 struct firmware_work
{
515 struct work_struct work
;
516 struct module
*module
;
518 struct device
*device
;
520 void (*cont
)(const struct firmware
*fw
, void *context
);
525 request_firmware_work_func(void *arg
)
527 struct firmware_work
*fw_work
= arg
;
528 const struct firmware
*fw
;
534 daemonize("%s/%s", "firmware", fw_work
->name
);
535 ret
= _request_firmware(&fw
, fw_work
->name
, fw_work
->device
,
538 fw_work
->cont(NULL
, fw_work
->context
);
540 fw_work
->cont(fw
, fw_work
->context
);
541 release_firmware(fw
);
543 module_put(fw_work
->module
);
549 * request_firmware_nowait: asynchronous version of request_firmware
550 * @module: module requesting the firmware
551 * @hotplug: invokes hotplug event to copy the firmware image if this flag
552 * is non-zero else the firmware copy must be done manually.
553 * @name: name of firmware file
554 * @device: device for which firmware is being loaded
555 * @context: will be passed over to @cont, and
556 * @fw may be %NULL if firmware request fails.
557 * @cont: function will be called asynchronously when the firmware
560 * Asynchronous variant of request_firmware() for contexts where
561 * it is not possible to sleep.
564 request_firmware_nowait(
565 struct module
*module
, int hotplug
,
566 const char *name
, struct device
*device
, void *context
,
567 void (*cont
)(const struct firmware
*fw
, void *context
))
569 struct firmware_work
*fw_work
= kmalloc(sizeof (struct firmware_work
),
575 if (!try_module_get(module
)) {
580 *fw_work
= (struct firmware_work
) {
589 ret
= kernel_thread(request_firmware_work_func
, fw_work
,
590 CLONE_FS
| CLONE_FILES
);
593 fw_work
->cont(NULL
, fw_work
->context
);
594 module_put(fw_work
->module
);
602 firmware_class_init(void)
605 error
= class_register(&firmware_class
);
607 printk(KERN_ERR
"%s: class_register failed\n", __FUNCTION__
);
610 error
= class_create_file(&firmware_class
, &class_attr_timeout
);
612 printk(KERN_ERR
"%s: class_create_file failed\n",
614 class_unregister(&firmware_class
);
620 firmware_class_exit(void)
622 class_unregister(&firmware_class
);
625 module_init(firmware_class_init
);
626 module_exit(firmware_class_exit
);
628 EXPORT_SYMBOL(release_firmware
);
629 EXPORT_SYMBOL(request_firmware
);
630 EXPORT_SYMBOL(request_firmware_nowait
);
631 EXPORT_SYMBOL(register_firmware
);