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_uevent(struct class_device *dev, char **envp,
89 int num_envp, char *buffer, int buffer_size);
91 static struct class firmware_class = {
93 .uevent = firmware_class_uevent,
94 .release = fw_class_dev_release,
98 firmware_class_uevent(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_uevent_var(envp, num_envp, &i, buffer, buffer_size, &len,
108 "FIRMWARE=%s", fw_priv->fw_id))
110 if (add_uevent_var(envp, num_envp, &i, buffer, buffer_size, &len,
111 "TIMEOUT=%i", loading_timeout))
119 firmware_loading_show(struct class_device *class_dev, char *buf)
121 struct firmware_priv *fw_priv = class_get_devdata(class_dev);
122 int loading = test_bit(FW_STATUS_LOADING, &fw_priv->status);
123 return sprintf(buf, "%d\n", loading);
127 * firmware_loading_store - set value in the 'loading' control file
128 * @class_dev: class_device pointer
129 * @buf: buffer to scan for loading control value
130 * @count: number of bytes in @buf
132 * The relevant values are:
134 * 1: Start a load, discarding any previous partial load.
135 * 0: Conclude the load and hand the data to the driver code.
136 * -1: Conclude the load with an error and discard any written data.
139 firmware_loading_store(struct class_device *class_dev,
140 const char *buf, size_t count)
142 struct firmware_priv *fw_priv = class_get_devdata(class_dev);
143 int loading = simple_strtol(buf, NULL, 10);
152 vfree(fw_priv->fw->data);
153 fw_priv->fw->data = NULL;
154 fw_priv->fw->size = 0;
155 fw_priv->alloc_size = 0;
156 set_bit(FW_STATUS_LOADING, &fw_priv->status);
160 if (test_bit(FW_STATUS_LOADING, &fw_priv->status)) {
161 complete(&fw_priv->completion);
162 clear_bit(FW_STATUS_LOADING, &fw_priv->status);
167 printk(KERN_ERR "%s: unexpected value (%d)\n", __FUNCTION__,
171 fw_load_abort(fw_priv);
178 static CLASS_DEVICE_ATTR(loading, 0644,
179 firmware_loading_show, firmware_loading_store);
182 firmware_data_read(struct kobject *kobj,
183 char *buffer, loff_t offset, size_t count)
185 struct class_device *class_dev = to_class_dev(kobj);
186 struct firmware_priv *fw_priv = class_get_devdata(class_dev);
188 ssize_t ret_count = count;
192 if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
196 if (offset > fw->size) {
200 if (offset + ret_count > fw->size)
201 ret_count = fw->size - offset;
203 memcpy(buffer, fw->data + offset, ret_count);
210 fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
214 if (min_size <= fw_priv->alloc_size)
217 new_data = vmalloc(fw_priv->alloc_size + PAGE_SIZE);
219 printk(KERN_ERR "%s: unable to alloc buffer\n", __FUNCTION__);
220 /* Make sure that we don't keep incomplete data */
221 fw_load_abort(fw_priv);
224 fw_priv->alloc_size += PAGE_SIZE;
225 if (fw_priv->fw->data) {
226 memcpy(new_data, fw_priv->fw->data, fw_priv->fw->size);
227 vfree(fw_priv->fw->data);
229 fw_priv->fw->data = new_data;
230 BUG_ON(min_size > fw_priv->alloc_size);
235 * firmware_data_write - write method for firmware
236 * @kobj: kobject for the class_device
237 * @buffer: buffer being written
238 * @offset: buffer offset for write in total data store area
239 * @count: buffer size
241 * Data written to the 'data' attribute will be later handed to
242 * the driver as a firmware image.
245 firmware_data_write(struct kobject *kobj,
246 char *buffer, loff_t offset, size_t count)
248 struct class_device *class_dev = to_class_dev(kobj);
249 struct firmware_priv *fw_priv = class_get_devdata(class_dev);
253 if (!capable(CAP_SYS_RAWIO))
258 if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
262 retval = fw_realloc_buffer(fw_priv, offset + count);
266 memcpy(fw->data + offset, buffer, count);
268 fw->size = max_t(size_t, offset + count, fw->size);
275 static struct bin_attribute firmware_attr_data_tmpl = {
276 .attr = {.name = "data", .mode = 0644, .owner = THIS_MODULE},
278 .read = firmware_data_read,
279 .write = firmware_data_write,
283 fw_class_dev_release(struct class_device *class_dev)
285 struct firmware_priv *fw_priv = class_get_devdata(class_dev);
290 module_put(THIS_MODULE);
294 firmware_class_timeout(u_long data)
296 struct firmware_priv *fw_priv = (struct firmware_priv *) data;
297 fw_load_abort(fw_priv);
301 fw_setup_class_device_id(struct class_device *class_dev, struct device *dev)
303 /* XXX warning we should watch out for name collisions */
304 strlcpy(class_dev->class_id, dev->bus_id, BUS_ID_SIZE);
308 fw_register_class_device(struct class_device **class_dev_p,
309 const char *fw_name, struct device *device)
312 struct firmware_priv *fw_priv = kzalloc(sizeof(*fw_priv),
314 struct class_device *class_dev = kzalloc(sizeof(*class_dev),
319 if (!fw_priv || !class_dev) {
320 printk(KERN_ERR "%s: kmalloc failed\n", __FUNCTION__);
325 init_completion(&fw_priv->completion);
326 fw_priv->attr_data = firmware_attr_data_tmpl;
327 strlcpy(fw_priv->fw_id, fw_name, FIRMWARE_NAME_MAX);
329 fw_priv->timeout.function = firmware_class_timeout;
330 fw_priv->timeout.data = (u_long) fw_priv;
331 init_timer(&fw_priv->timeout);
333 fw_setup_class_device_id(class_dev, device);
334 class_dev->dev = device;
335 class_dev->class = &firmware_class;
336 class_set_devdata(class_dev, fw_priv);
337 retval = class_device_register(class_dev);
339 printk(KERN_ERR "%s: class_device_register failed\n",
343 *class_dev_p = class_dev;
353 fw_setup_class_device(struct firmware *fw, struct class_device **class_dev_p,
354 const char *fw_name, struct device *device, int uevent)
356 struct class_device *class_dev;
357 struct firmware_priv *fw_priv;
361 retval = fw_register_class_device(&class_dev, fw_name, device);
365 /* Need to pin this module until class device is destroyed */
366 __module_get(THIS_MODULE);
368 fw_priv = class_get_devdata(class_dev);
371 retval = sysfs_create_bin_file(&class_dev->kobj, &fw_priv->attr_data);
373 printk(KERN_ERR "%s: sysfs_create_bin_file failed\n",
378 retval = class_device_create_file(class_dev,
379 &class_device_attr_loading);
381 printk(KERN_ERR "%s: class_device_create_file failed\n",
387 set_bit(FW_STATUS_READY, &fw_priv->status);
389 set_bit(FW_STATUS_READY_NOHOTPLUG, &fw_priv->status);
390 *class_dev_p = class_dev;
394 class_device_unregister(class_dev);
400 _request_firmware(const struct firmware **firmware_p, const char *name,
401 struct device *device, int uevent)
403 struct class_device *class_dev;
404 struct firmware_priv *fw_priv;
405 struct firmware *firmware;
411 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
413 printk(KERN_ERR "%s: kmalloc(struct firmware) failed\n",
419 retval = fw_setup_class_device(firmware, &class_dev, name, device,
424 fw_priv = class_get_devdata(class_dev);
427 if (loading_timeout > 0) {
428 fw_priv->timeout.expires = jiffies + loading_timeout * HZ;
429 add_timer(&fw_priv->timeout);
432 kobject_uevent(&class_dev->kobj, KOBJ_ADD);
433 wait_for_completion(&fw_priv->completion);
434 set_bit(FW_STATUS_DONE, &fw_priv->status);
435 del_timer_sync(&fw_priv->timeout);
437 wait_for_completion(&fw_priv->completion);
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 * request_firmware: - send firmware request and wait for it
459 * @firmware_p: pointer to firmware image
460 * @name: name of firmware file
461 * @device: device for which firmware is being loaded
463 * @firmware_p will be used to return a firmware image by the name
464 * of @name for device @device.
466 * Should be called from user context where sleeping is allowed.
468 * @name will be used as $FIRMWARE in the uevent environment and
469 * should be distinctive enough not to be confused with any other
470 * firmware image for this or any other device.
473 request_firmware(const struct firmware **firmware_p, const char *name,
474 struct device *device)
477 return _request_firmware(firmware_p, name, device, uevent);
481 * release_firmware: - release the resource associated with a firmware image
482 * @fw: firmware resource to release
485 release_firmware(const struct firmware *fw)
494 * register_firmware: - provide a firmware image for later usage
495 * @name: name of firmware image file
496 * @data: buffer pointer for the firmware image
497 * @size: size of the data buffer area
499 * Make sure that @data will be available by requesting firmware @name.
501 * Note: This will not be possible until some kind of persistence
505 register_firmware(const char *name, const u8 *data, size_t size)
507 /* This is meaningless without firmware caching, so until we
508 * decide if firmware caching is reasonable just leave it as a
513 struct firmware_work {
514 struct work_struct work;
515 struct module *module;
517 struct device *device;
519 void (*cont)(const struct firmware *fw, void *context);
524 request_firmware_work_func(void *arg)
526 struct firmware_work *fw_work = arg;
527 const struct firmware *fw;
533 daemonize("%s/%s", "firmware", fw_work->name);
534 ret = _request_firmware(&fw, fw_work->name, fw_work->device,
537 fw_work->cont(NULL, fw_work->context);
539 fw_work->cont(fw, fw_work->context);
540 release_firmware(fw);
542 module_put(fw_work->module);
548 * request_firmware_nowait: asynchronous version of request_firmware
549 * @module: module requesting the firmware
550 * @uevent: sends uevent to copy the firmware image if this flag
551 * is non-zero else the firmware copy must be done manually.
552 * @name: name of firmware file
553 * @device: device for which firmware is being loaded
554 * @context: will be passed over to @cont, and
555 * @fw may be %NULL if firmware request fails.
556 * @cont: function will be called asynchronously when the firmware
559 * Asynchronous variant of request_firmware() for contexts where
560 * it is not possible to sleep.
563 request_firmware_nowait(
564 struct module *module, int uevent,
565 const char *name, struct device *device, void *context,
566 void (*cont)(const struct firmware *fw, void *context))
568 struct firmware_work *fw_work = kmalloc(sizeof (struct firmware_work),
574 if (!try_module_get(module)) {
579 *fw_work = (struct firmware_work) {
588 ret = kernel_thread(request_firmware_work_func, fw_work,
589 CLONE_FS | CLONE_FILES);
592 fw_work->cont(NULL, fw_work->context);
593 module_put(fw_work->module);
601 firmware_class_init(void)
604 error = class_register(&firmware_class);
606 printk(KERN_ERR "%s: class_register failed\n", __FUNCTION__);
609 error = class_create_file(&firmware_class, &class_attr_timeout);
611 printk(KERN_ERR "%s: class_create_file failed\n",
613 class_unregister(&firmware_class);
619 firmware_class_exit(void)
621 class_unregister(&firmware_class);
624 module_init(firmware_class_init);
625 module_exit(firmware_class_exit);
627 EXPORT_SYMBOL(release_firmware);
628 EXPORT_SYMBOL(request_firmware);
629 EXPORT_SYMBOL(request_firmware_nowait);
630 EXPORT_SYMBOL(register_firmware);