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:
67 * Sets the number of seconds to wait for the firmware. Once
68 * this expires an error will be return to the driver and no
69 * firmware will be provided.
71 * Note: zero means 'wait for ever'
75 firmware_timeout_store(struct class *class, const char *buf
, size_t count
)
77 loading_timeout
= simple_strtol(buf
, NULL
, 10);
78 if (loading_timeout
< 0)
83 static CLASS_ATTR(timeout
, 0644, firmware_timeout_show
, firmware_timeout_store
);
85 static void fw_class_dev_release(struct class_device
*class_dev
);
86 int firmware_class_hotplug(struct class_device
*dev
, char **envp
,
87 int num_envp
, char *buffer
, int buffer_size
);
89 static struct class firmware_class
= {
91 .hotplug
= firmware_class_hotplug
,
92 .release
= fw_class_dev_release
,
96 firmware_class_hotplug(struct class_device
*class_dev
, char **envp
,
97 int num_envp
, char *buffer
, int buffer_size
)
99 struct firmware_priv
*fw_priv
= class_get_devdata(class_dev
);
102 if (!test_bit(FW_STATUS_READY
, &fw_priv
->status
))
105 if (add_hotplug_env_var(envp
, num_envp
, &i
, buffer
, buffer_size
, &len
,
106 "FIRMWARE=%s", fw_priv
->fw_id
))
108 if (add_hotplug_env_var(envp
, num_envp
, &i
, buffer
, buffer_size
, &len
,
109 "TIMEOUT=%i", loading_timeout
))
118 firmware_loading_show(struct class_device
*class_dev
, char *buf
)
120 struct firmware_priv
*fw_priv
= class_get_devdata(class_dev
);
121 int loading
= test_bit(FW_STATUS_LOADING
, &fw_priv
->status
);
122 return sprintf(buf
, "%d\n", loading
);
126 * firmware_loading_store: - loading control file
128 * The relevant values are:
130 * 1: Start a load, discarding any previous partial load.
131 * 0: Conclude the load and handle the data to the driver code.
132 * -1: Conclude the load with an error and discard any written data.
135 firmware_loading_store(struct class_device
*class_dev
,
136 const char *buf
, size_t count
)
138 struct firmware_priv
*fw_priv
= class_get_devdata(class_dev
);
139 int loading
= simple_strtol(buf
, NULL
, 10);
148 vfree(fw_priv
->fw
->data
);
149 fw_priv
->fw
->data
= NULL
;
150 fw_priv
->fw
->size
= 0;
151 fw_priv
->alloc_size
= 0;
152 set_bit(FW_STATUS_LOADING
, &fw_priv
->status
);
156 if (test_bit(FW_STATUS_LOADING
, &fw_priv
->status
)) {
157 complete(&fw_priv
->completion
);
158 clear_bit(FW_STATUS_LOADING
, &fw_priv
->status
);
163 printk(KERN_ERR
"%s: unexpected value (%d)\n", __FUNCTION__
,
167 fw_load_abort(fw_priv
);
174 static CLASS_DEVICE_ATTR(loading
, 0644,
175 firmware_loading_show
, firmware_loading_store
);
178 firmware_data_read(struct kobject
*kobj
,
179 char *buffer
, loff_t offset
, size_t count
)
181 struct class_device
*class_dev
= to_class_dev(kobj
);
182 struct firmware_priv
*fw_priv
= class_get_devdata(class_dev
);
184 ssize_t ret_count
= count
;
188 if (!fw
|| test_bit(FW_STATUS_DONE
, &fw_priv
->status
)) {
192 if (offset
> fw
->size
) {
196 if (offset
+ ret_count
> fw
->size
)
197 ret_count
= fw
->size
- offset
;
199 memcpy(buffer
, fw
->data
+ offset
, ret_count
);
205 fw_realloc_buffer(struct firmware_priv
*fw_priv
, int min_size
)
209 if (min_size
<= fw_priv
->alloc_size
)
212 new_data
= vmalloc(fw_priv
->alloc_size
+ PAGE_SIZE
);
214 printk(KERN_ERR
"%s: unable to alloc buffer\n", __FUNCTION__
);
215 /* Make sure that we don't keep incomplete data */
216 fw_load_abort(fw_priv
);
219 fw_priv
->alloc_size
+= PAGE_SIZE
;
220 if (fw_priv
->fw
->data
) {
221 memcpy(new_data
, fw_priv
->fw
->data
, fw_priv
->fw
->size
);
222 vfree(fw_priv
->fw
->data
);
224 fw_priv
->fw
->data
= new_data
;
225 BUG_ON(min_size
> fw_priv
->alloc_size
);
230 * firmware_data_write:
234 * Data written to the 'data' attribute will be later handled to
235 * the driver as a firmware image.
238 firmware_data_write(struct kobject
*kobj
,
239 char *buffer
, loff_t offset
, size_t count
)
241 struct class_device
*class_dev
= to_class_dev(kobj
);
242 struct firmware_priv
*fw_priv
= class_get_devdata(class_dev
);
246 if (!capable(CAP_SYS_RAWIO
))
251 if (!fw
|| test_bit(FW_STATUS_DONE
, &fw_priv
->status
)) {
255 retval
= fw_realloc_buffer(fw_priv
, offset
+ count
);
259 memcpy(fw
->data
+ offset
, buffer
, count
);
261 fw
->size
= max_t(size_t, offset
+ count
, fw
->size
);
267 static struct bin_attribute firmware_attr_data_tmpl
= {
268 .attr
= {.name
= "data", .mode
= 0644, .owner
= THIS_MODULE
},
270 .read
= firmware_data_read
,
271 .write
= firmware_data_write
,
275 fw_class_dev_release(struct class_device
*class_dev
)
277 struct firmware_priv
*fw_priv
= class_get_devdata(class_dev
);
282 module_put(THIS_MODULE
);
286 firmware_class_timeout(u_long data
)
288 struct firmware_priv
*fw_priv
= (struct firmware_priv
*) data
;
289 fw_load_abort(fw_priv
);
293 fw_setup_class_device_id(struct class_device
*class_dev
, struct device
*dev
)
295 /* XXX warning we should watch out for name collisions */
296 strlcpy(class_dev
->class_id
, dev
->bus_id
, BUS_ID_SIZE
);
300 fw_register_class_device(struct class_device
**class_dev_p
,
301 const char *fw_name
, struct device
*device
)
304 struct firmware_priv
*fw_priv
= kzalloc(sizeof(*fw_priv
),
306 struct class_device
*class_dev
= kzalloc(sizeof(*class_dev
),
311 if (!fw_priv
|| !class_dev
) {
312 printk(KERN_ERR
"%s: kmalloc failed\n", __FUNCTION__
);
317 init_completion(&fw_priv
->completion
);
318 fw_priv
->attr_data
= firmware_attr_data_tmpl
;
319 strlcpy(fw_priv
->fw_id
, fw_name
, FIRMWARE_NAME_MAX
);
321 fw_priv
->timeout
.function
= firmware_class_timeout
;
322 fw_priv
->timeout
.data
= (u_long
) fw_priv
;
323 init_timer(&fw_priv
->timeout
);
325 fw_setup_class_device_id(class_dev
, device
);
326 class_dev
->dev
= device
;
327 class_dev
->class = &firmware_class
;
328 class_set_devdata(class_dev
, fw_priv
);
329 retval
= class_device_register(class_dev
);
331 printk(KERN_ERR
"%s: class_device_register failed\n",
335 *class_dev_p
= class_dev
;
345 fw_setup_class_device(struct firmware
*fw
, struct class_device
**class_dev_p
,
346 const char *fw_name
, struct device
*device
, int hotplug
)
348 struct class_device
*class_dev
;
349 struct firmware_priv
*fw_priv
;
353 retval
= fw_register_class_device(&class_dev
, fw_name
, device
);
357 /* Need to pin this module until class device is destroyed */
358 __module_get(THIS_MODULE
);
360 fw_priv
= class_get_devdata(class_dev
);
363 retval
= sysfs_create_bin_file(&class_dev
->kobj
, &fw_priv
->attr_data
);
365 printk(KERN_ERR
"%s: sysfs_create_bin_file failed\n",
370 retval
= class_device_create_file(class_dev
,
371 &class_device_attr_loading
);
373 printk(KERN_ERR
"%s: class_device_create_file failed\n",
379 set_bit(FW_STATUS_READY
, &fw_priv
->status
);
381 set_bit(FW_STATUS_READY_NOHOTPLUG
, &fw_priv
->status
);
382 *class_dev_p
= class_dev
;
386 class_device_unregister(class_dev
);
392 _request_firmware(const struct firmware
**firmware_p
, const char *name
,
393 struct device
*device
, int hotplug
)
395 struct class_device
*class_dev
;
396 struct firmware_priv
*fw_priv
;
397 struct firmware
*firmware
;
403 *firmware_p
= firmware
= kzalloc(sizeof(*firmware
), GFP_KERNEL
);
405 printk(KERN_ERR
"%s: kmalloc(struct firmware) failed\n",
411 retval
= fw_setup_class_device(firmware
, &class_dev
, name
, device
,
416 fw_priv
= class_get_devdata(class_dev
);
419 if (loading_timeout
> 0) {
420 fw_priv
->timeout
.expires
= jiffies
+ loading_timeout
* HZ
;
421 add_timer(&fw_priv
->timeout
);
424 kobject_hotplug(&class_dev
->kobj
, KOBJ_ADD
);
425 wait_for_completion(&fw_priv
->completion
);
426 set_bit(FW_STATUS_DONE
, &fw_priv
->status
);
427 del_timer_sync(&fw_priv
->timeout
);
429 wait_for_completion(&fw_priv
->completion
);
432 if (!fw_priv
->fw
->size
|| test_bit(FW_STATUS_ABORT
, &fw_priv
->status
)) {
434 release_firmware(fw_priv
->fw
);
439 class_device_unregister(class_dev
);
450 * request_firmware: - request firmware to hotplug and wait for it
452 * @firmware will be used to return a firmware image by the name
453 * of @name for device @device.
455 * Should be called from user context where sleeping is allowed.
457 * @name will be use as $FIRMWARE in the hotplug environment and
458 * should be distinctive enough not to be confused with any other
459 * firmware image for this or any other device.
462 request_firmware(const struct firmware
**firmware_p
, const char *name
,
463 struct device
*device
)
466 return _request_firmware(firmware_p
, name
, device
, hotplug
);
470 * release_firmware: - release the resource associated with a firmware image
473 release_firmware(const struct firmware
*fw
)
482 * register_firmware: - provide a firmware image for later usage
485 * Make sure that @data will be available by requesting firmware @name.
487 * Note: This will not be possible until some kind of persistence
491 register_firmware(const char *name
, const u8
*data
, size_t size
)
493 /* This is meaningless without firmware caching, so until we
494 * decide if firmware caching is reasonable just leave it as a
499 struct firmware_work
{
500 struct work_struct work
;
501 struct module
*module
;
503 struct device
*device
;
505 void (*cont
)(const struct firmware
*fw
, void *context
);
510 request_firmware_work_func(void *arg
)
512 struct firmware_work
*fw_work
= arg
;
513 const struct firmware
*fw
;
518 daemonize("%s/%s", "firmware", fw_work
->name
);
519 _request_firmware(&fw
, fw_work
->name
, fw_work
->device
,
521 fw_work
->cont(fw
, fw_work
->context
);
522 release_firmware(fw
);
523 module_put(fw_work
->module
);
529 * request_firmware_nowait:
532 * Asynchronous variant of request_firmware() for contexts where
533 * it is not possible to sleep.
535 * @hotplug invokes hotplug event to copy the firmware image if this flag
536 * is non-zero else the firmware copy must be done manually.
538 * @cont will be called asynchronously when the firmware request is over.
540 * @context will be passed over to @cont.
542 * @fw may be %NULL if firmware request fails.
546 request_firmware_nowait(
547 struct module
*module
, int hotplug
,
548 const char *name
, struct device
*device
, void *context
,
549 void (*cont
)(const struct firmware
*fw
, void *context
))
551 struct firmware_work
*fw_work
= kmalloc(sizeof (struct firmware_work
),
557 if (!try_module_get(module
)) {
562 *fw_work
= (struct firmware_work
) {
571 ret
= kernel_thread(request_firmware_work_func
, fw_work
,
572 CLONE_FS
| CLONE_FILES
);
575 fw_work
->cont(NULL
, fw_work
->context
);
582 firmware_class_init(void)
585 error
= class_register(&firmware_class
);
587 printk(KERN_ERR
"%s: class_register failed\n", __FUNCTION__
);
590 error
= class_create_file(&firmware_class
, &class_attr_timeout
);
592 printk(KERN_ERR
"%s: class_create_file failed\n",
594 class_unregister(&firmware_class
);
600 firmware_class_exit(void)
602 class_unregister(&firmware_class
);
605 module_init(firmware_class_init
);
606 module_exit(firmware_class_exit
);
608 EXPORT_SYMBOL(release_firmware
);
609 EXPORT_SYMBOL(request_firmware
);
610 EXPORT_SYMBOL(request_firmware_nowait
);
611 EXPORT_SYMBOL(register_firmware
);