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");
33 static int loading_timeout
= 10; /* In seconds */
35 /* fw_lock could be moved to 'struct firmware_priv' but since it is just
36 * guarding for corner cases a global lock should be OK */
37 static DECLARE_MUTEX(fw_lock
);
39 struct firmware_priv
{
40 char fw_id
[FIRMWARE_NAME_MAX
];
41 struct completion completion
;
42 struct bin_attribute attr_data
;
46 struct timer_list timeout
;
50 fw_load_abort(struct firmware_priv
*fw_priv
)
52 set_bit(FW_STATUS_ABORT
, &fw_priv
->status
);
54 complete(&fw_priv
->completion
);
58 firmware_timeout_show(struct class *class, char *buf
)
60 return sprintf(buf
, "%d\n", loading_timeout
);
64 * firmware_timeout_store:
66 * Sets the number of seconds to wait for the firmware. Once
67 * this expires an error will be return to the driver and no
68 * firmware will be provided.
70 * Note: zero means 'wait for ever'
74 firmware_timeout_store(struct class *class, const char *buf
, size_t count
)
76 loading_timeout
= simple_strtol(buf
, NULL
, 10);
77 if (loading_timeout
< 0)
82 static CLASS_ATTR(timeout
, 0644, firmware_timeout_show
, firmware_timeout_store
);
84 static void fw_class_dev_release(struct class_device
*class_dev
);
85 int firmware_class_hotplug(struct class_device
*dev
, char **envp
,
86 int num_envp
, char *buffer
, int buffer_size
);
88 static struct class firmware_class
= {
90 .hotplug
= firmware_class_hotplug
,
91 .release
= fw_class_dev_release
,
95 firmware_class_hotplug(struct class_device
*class_dev
, char **envp
,
96 int num_envp
, char *buffer
, int buffer_size
)
98 struct firmware_priv
*fw_priv
= class_get_devdata(class_dev
);
101 if (!test_bit(FW_STATUS_READY
, &fw_priv
->status
))
104 if (add_hotplug_env_var(envp
, num_envp
, &i
, buffer
, buffer_size
, &len
,
105 "FIRMWARE=%s", fw_priv
->fw_id
))
107 if (add_hotplug_env_var(envp
, num_envp
, &i
, buffer
, buffer_size
, &len
,
108 "TIMEOUT=%i", loading_timeout
))
117 firmware_loading_show(struct class_device
*class_dev
, char *buf
)
119 struct firmware_priv
*fw_priv
= class_get_devdata(class_dev
);
120 int loading
= test_bit(FW_STATUS_LOADING
, &fw_priv
->status
);
121 return sprintf(buf
, "%d\n", loading
);
125 * firmware_loading_store: - loading control file
127 * The relevant values are:
129 * 1: Start a load, discarding any previous partial load.
130 * 0: Conclude the load and handle the data to the driver code.
131 * -1: Conclude the load with an error and discard any written data.
134 firmware_loading_store(struct class_device
*class_dev
,
135 const char *buf
, size_t count
)
137 struct firmware_priv
*fw_priv
= class_get_devdata(class_dev
);
138 int loading
= simple_strtol(buf
, NULL
, 10);
147 vfree(fw_priv
->fw
->data
);
148 fw_priv
->fw
->data
= NULL
;
149 fw_priv
->fw
->size
= 0;
150 fw_priv
->alloc_size
= 0;
151 set_bit(FW_STATUS_LOADING
, &fw_priv
->status
);
155 if (test_bit(FW_STATUS_LOADING
, &fw_priv
->status
)) {
156 complete(&fw_priv
->completion
);
157 clear_bit(FW_STATUS_LOADING
, &fw_priv
->status
);
162 printk(KERN_ERR
"%s: unexpected value (%d)\n", __FUNCTION__
,
166 fw_load_abort(fw_priv
);
173 static CLASS_DEVICE_ATTR(loading
, 0644,
174 firmware_loading_show
, firmware_loading_store
);
177 firmware_data_read(struct kobject
*kobj
,
178 char *buffer
, loff_t offset
, size_t count
)
180 struct class_device
*class_dev
= to_class_dev(kobj
);
181 struct firmware_priv
*fw_priv
= class_get_devdata(class_dev
);
183 ssize_t ret_count
= count
;
187 if (!fw
|| test_bit(FW_STATUS_DONE
, &fw_priv
->status
)) {
191 if (offset
> fw
->size
) {
195 if (offset
+ ret_count
> fw
->size
)
196 ret_count
= fw
->size
- offset
;
198 memcpy(buffer
, fw
->data
+ offset
, ret_count
);
204 fw_realloc_buffer(struct firmware_priv
*fw_priv
, int min_size
)
208 if (min_size
<= fw_priv
->alloc_size
)
211 new_data
= vmalloc(fw_priv
->alloc_size
+ PAGE_SIZE
);
213 printk(KERN_ERR
"%s: unable to alloc buffer\n", __FUNCTION__
);
214 /* Make sure that we don't keep incomplete data */
215 fw_load_abort(fw_priv
);
218 fw_priv
->alloc_size
+= PAGE_SIZE
;
219 if (fw_priv
->fw
->data
) {
220 memcpy(new_data
, fw_priv
->fw
->data
, fw_priv
->fw
->size
);
221 vfree(fw_priv
->fw
->data
);
223 fw_priv
->fw
->data
= new_data
;
224 BUG_ON(min_size
> fw_priv
->alloc_size
);
229 * firmware_data_write:
233 * Data written to the 'data' attribute will be later handled to
234 * the driver as a firmware image.
237 firmware_data_write(struct kobject
*kobj
,
238 char *buffer
, loff_t offset
, size_t count
)
240 struct class_device
*class_dev
= to_class_dev(kobj
);
241 struct firmware_priv
*fw_priv
= class_get_devdata(class_dev
);
245 if (!capable(CAP_SYS_RAWIO
))
250 if (!fw
|| test_bit(FW_STATUS_DONE
, &fw_priv
->status
)) {
254 retval
= fw_realloc_buffer(fw_priv
, offset
+ count
);
258 memcpy(fw
->data
+ offset
, buffer
, count
);
260 fw
->size
= max_t(size_t, offset
+ count
, fw
->size
);
266 static struct bin_attribute firmware_attr_data_tmpl
= {
267 .attr
= {.name
= "data", .mode
= 0644, .owner
= THIS_MODULE
},
269 .read
= firmware_data_read
,
270 .write
= firmware_data_write
,
274 fw_class_dev_release(struct class_device
*class_dev
)
276 struct firmware_priv
*fw_priv
= class_get_devdata(class_dev
);
281 module_put(THIS_MODULE
);
285 firmware_class_timeout(u_long data
)
287 struct firmware_priv
*fw_priv
= (struct firmware_priv
*) data
;
288 fw_load_abort(fw_priv
);
292 fw_setup_class_device_id(struct class_device
*class_dev
, struct device
*dev
)
294 /* XXX warning we should watch out for name collisions */
295 strlcpy(class_dev
->class_id
, dev
->bus_id
, BUS_ID_SIZE
);
299 fw_register_class_device(struct class_device
**class_dev_p
,
300 const char *fw_name
, struct device
*device
)
303 struct firmware_priv
*fw_priv
= kmalloc(sizeof (struct firmware_priv
),
305 struct class_device
*class_dev
= kmalloc(sizeof (struct class_device
),
310 if (!fw_priv
|| !class_dev
) {
311 printk(KERN_ERR
"%s: kmalloc failed\n", __FUNCTION__
);
315 memset(fw_priv
, 0, sizeof (*fw_priv
));
316 memset(class_dev
, 0, sizeof (*class_dev
));
318 init_completion(&fw_priv
->completion
);
319 fw_priv
->attr_data
= firmware_attr_data_tmpl
;
320 strlcpy(fw_priv
->fw_id
, fw_name
, FIRMWARE_NAME_MAX
);
322 fw_priv
->timeout
.function
= firmware_class_timeout
;
323 fw_priv
->timeout
.data
= (u_long
) fw_priv
;
324 init_timer(&fw_priv
->timeout
);
326 fw_setup_class_device_id(class_dev
, device
);
327 class_dev
->dev
= device
;
328 class_dev
->class = &firmware_class
;
329 class_set_devdata(class_dev
, fw_priv
);
330 retval
= class_device_register(class_dev
);
332 printk(KERN_ERR
"%s: class_device_register failed\n",
336 *class_dev_p
= class_dev
;
346 fw_setup_class_device(struct firmware
*fw
, struct class_device
**class_dev_p
,
347 const char *fw_name
, struct device
*device
)
349 struct class_device
*class_dev
;
350 struct firmware_priv
*fw_priv
;
354 retval
= fw_register_class_device(&class_dev
, fw_name
, device
);
358 /* Need to pin this module until class device is destroyed */
359 __module_get(THIS_MODULE
);
361 fw_priv
= class_get_devdata(class_dev
);
364 retval
= sysfs_create_bin_file(&class_dev
->kobj
, &fw_priv
->attr_data
);
366 printk(KERN_ERR
"%s: sysfs_create_bin_file failed\n",
371 retval
= class_device_create_file(class_dev
,
372 &class_device_attr_loading
);
374 printk(KERN_ERR
"%s: class_device_create_file failed\n",
379 set_bit(FW_STATUS_READY
, &fw_priv
->status
);
380 *class_dev_p
= class_dev
;
384 class_device_unregister(class_dev
);
390 * request_firmware: - request firmware to hotplug and wait for it
392 * @firmware will be used to return a firmware image by the name
393 * of @name for device @device.
395 * Should be called from user context where sleeping is allowed.
397 * @name will be use as $FIRMWARE in the hotplug environment and
398 * should be distinctive enough not to be confused with any other
399 * firmware image for this or any other device.
402 request_firmware(const struct firmware
**firmware_p
, const char *name
,
403 struct device
*device
)
405 struct class_device
*class_dev
;
406 struct firmware_priv
*fw_priv
;
407 struct firmware
*firmware
;
413 *firmware_p
= firmware
= kmalloc(sizeof (struct firmware
), GFP_KERNEL
);
415 printk(KERN_ERR
"%s: kmalloc(struct firmware) failed\n",
420 memset(firmware
, 0, sizeof (*firmware
));
422 retval
= fw_setup_class_device(firmware
, &class_dev
, name
, device
);
426 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
);
437 del_timer_sync(&fw_priv
->timeout
);
440 if (!fw_priv
->fw
->size
|| test_bit(FW_STATUS_ABORT
, &fw_priv
->status
)) {
442 release_firmware(fw_priv
->fw
);
447 class_device_unregister(class_dev
);
458 * release_firmware: - release the resource associated with a firmware image
461 release_firmware(const struct firmware
*fw
)
470 * register_firmware: - provide a firmware image for later usage
473 * Make sure that @data will be available by requesting firmware @name.
475 * Note: This will not be possible until some kind of persistence
479 register_firmware(const char *name
, const u8
*data
, size_t size
)
481 /* This is meaningless without firmware caching, so until we
482 * decide if firmware caching is reasonable just leave it as a
487 struct firmware_work
{
488 struct work_struct work
;
489 struct module
*module
;
491 struct device
*device
;
493 void (*cont
)(const struct firmware
*fw
, void *context
);
497 request_firmware_work_func(void *arg
)
499 struct firmware_work
*fw_work
= arg
;
500 const struct firmware
*fw
;
505 daemonize("%s/%s", "firmware", fw_work
->name
);
506 request_firmware(&fw
, fw_work
->name
, fw_work
->device
);
507 fw_work
->cont(fw
, fw_work
->context
);
508 release_firmware(fw
);
509 module_put(fw_work
->module
);
515 * request_firmware_nowait:
518 * Asynchronous variant of request_firmware() for contexts where
519 * it is not possible to sleep.
521 * @cont will be called asynchronously when the firmware request is over.
523 * @context will be passed over to @cont.
525 * @fw may be %NULL if firmware request fails.
529 request_firmware_nowait(
530 struct module
*module
,
531 const char *name
, struct device
*device
, void *context
,
532 void (*cont
)(const struct firmware
*fw
, void *context
))
534 struct firmware_work
*fw_work
= kmalloc(sizeof (struct firmware_work
),
540 if (!try_module_get(module
)) {
545 *fw_work
= (struct firmware_work
) {
553 ret
= kernel_thread(request_firmware_work_func
, fw_work
,
554 CLONE_FS
| CLONE_FILES
);
557 fw_work
->cont(NULL
, fw_work
->context
);
564 firmware_class_init(void)
567 error
= class_register(&firmware_class
);
569 printk(KERN_ERR
"%s: class_register failed\n", __FUNCTION__
);
572 error
= class_create_file(&firmware_class
, &class_attr_timeout
);
574 printk(KERN_ERR
"%s: class_create_file failed\n",
576 class_unregister(&firmware_class
);
582 firmware_class_exit(void)
584 class_unregister(&firmware_class
);
587 module_init(firmware_class_init
);
588 module_exit(firmware_class_exit
);
590 EXPORT_SYMBOL(release_firmware
);
591 EXPORT_SYMBOL(request_firmware
);
592 EXPORT_SYMBOL(request_firmware_nowait
);
593 EXPORT_SYMBOL(register_firmware
);