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/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>
21 #include <linux/firmware.h>
24 #define to_dev(obj) container_of(obj, struct device, kobj)
26 MODULE_AUTHOR("Manuel Estrada Sainz <ranty@debian.org>");
27 MODULE_DESCRIPTION("Multi purpose firmware loading support");
28 MODULE_LICENSE("GPL");
35 FW_STATUS_READY_NOHOTPLUG,
38 static int loading_timeout = 60; /* In seconds */
40 /* fw_lock could be moved to 'struct firmware_priv' but since it is just
41 * guarding for corner cases a global lock should be OK */
42 static DEFINE_MUTEX(fw_lock);
44 struct firmware_priv {
45 char fw_id[FIRMWARE_NAME_MAX];
46 struct completion completion;
47 struct bin_attribute attr_data;
51 struct timer_list timeout;
55 fw_load_abort(struct firmware_priv *fw_priv)
57 set_bit(FW_STATUS_ABORT, &fw_priv->status);
59 complete(&fw_priv->completion);
63 firmware_timeout_show(struct class *class, char *buf)
65 return sprintf(buf, "%d\n", loading_timeout);
69 * firmware_timeout_store - set number of seconds to wait for firmware
70 * @class: device class pointer
71 * @buf: buffer to scan for timeout value
72 * @count: number of bytes in @buf
74 * Sets the number of seconds to wait for the firmware. Once
75 * this expires an error will be returned to the driver and no
76 * firmware will be provided.
78 * Note: zero means 'wait forever'.
81 firmware_timeout_store(struct class *class, const char *buf, size_t count)
83 loading_timeout = simple_strtol(buf, NULL, 10);
84 if (loading_timeout <= 0)
86 else if (loading_timeout < 60) {
87 if (printk_ratelimit())
89 "firmware_class: attempt to set timeout to %d\n",
96 static CLASS_ATTR(timeout, 0644, firmware_timeout_show, firmware_timeout_store);
98 static void fw_dev_release(struct device *dev);
100 static int firmware_uevent(struct device *dev, char **envp, int num_envp,
101 char *buffer, int buffer_size)
103 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
106 if (!test_bit(FW_STATUS_READY, &fw_priv->status))
109 if (add_uevent_var(envp, num_envp, &i, buffer, buffer_size, &len,
110 "FIRMWARE=%s", fw_priv->fw_id))
112 if (add_uevent_var(envp, num_envp, &i, buffer, buffer_size, &len,
113 "TIMEOUT=%i", loading_timeout))
120 static struct class firmware_class = {
122 .dev_uevent = firmware_uevent,
123 .dev_release = fw_dev_release,
126 static ssize_t firmware_loading_show(struct device *dev,
127 struct device_attribute *attr, char *buf)
129 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
130 int loading = test_bit(FW_STATUS_LOADING, &fw_priv->status);
131 return sprintf(buf, "%d\n", loading);
135 * firmware_loading_store - set value in the 'loading' control file
136 * @dev: device pointer
137 * @attr: device attribute pointer
138 * @buf: buffer to scan for loading control value
139 * @count: number of bytes in @buf
141 * The relevant values are:
143 * 1: Start a load, discarding any previous partial load.
144 * 0: Conclude the load and hand the data to the driver code.
145 * -1: Conclude the load with an error and discard any written data.
147 static ssize_t firmware_loading_store(struct device *dev,
148 struct device_attribute *attr,
149 const char *buf, size_t count)
151 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
152 int loading = simple_strtol(buf, NULL, 10);
156 mutex_lock(&fw_lock);
158 mutex_unlock(&fw_lock);
161 vfree(fw_priv->fw->data);
162 fw_priv->fw->data = NULL;
163 fw_priv->fw->size = 0;
164 fw_priv->alloc_size = 0;
165 set_bit(FW_STATUS_LOADING, &fw_priv->status);
166 mutex_unlock(&fw_lock);
169 if (test_bit(FW_STATUS_LOADING, &fw_priv->status)) {
170 complete(&fw_priv->completion);
171 clear_bit(FW_STATUS_LOADING, &fw_priv->status);
176 printk(KERN_ERR "%s: unexpected value (%d)\n", __FUNCTION__,
180 fw_load_abort(fw_priv);
187 static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store);
190 firmware_data_read(struct kobject *kobj,
191 char *buffer, loff_t offset, size_t count)
193 struct device *dev = to_dev(kobj);
194 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
196 ssize_t ret_count = count;
198 mutex_lock(&fw_lock);
200 if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
204 if (offset > fw->size) {
208 if (offset + ret_count > fw->size)
209 ret_count = fw->size - offset;
211 memcpy(buffer, fw->data + offset, ret_count);
213 mutex_unlock(&fw_lock);
218 fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
221 int new_size = fw_priv->alloc_size;
223 if (min_size <= fw_priv->alloc_size)
226 new_size = ALIGN(min_size, PAGE_SIZE);
227 new_data = vmalloc(new_size);
229 printk(KERN_ERR "%s: unable to alloc buffer\n", __FUNCTION__);
230 /* Make sure that we don't keep incomplete data */
231 fw_load_abort(fw_priv);
234 fw_priv->alloc_size = new_size;
235 if (fw_priv->fw->data) {
236 memcpy(new_data, fw_priv->fw->data, fw_priv->fw->size);
237 vfree(fw_priv->fw->data);
239 fw_priv->fw->data = new_data;
240 BUG_ON(min_size > fw_priv->alloc_size);
245 * firmware_data_write - write method for firmware
246 * @kobj: kobject for the device
247 * @buffer: buffer being written
248 * @offset: buffer offset for write in total data store area
249 * @count: buffer size
251 * Data written to the 'data' attribute will be later handed to
252 * the driver as a firmware image.
255 firmware_data_write(struct kobject *kobj,
256 char *buffer, loff_t offset, size_t count)
258 struct device *dev = to_dev(kobj);
259 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
263 if (!capable(CAP_SYS_RAWIO))
266 mutex_lock(&fw_lock);
268 if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
272 retval = fw_realloc_buffer(fw_priv, offset + count);
276 memcpy(fw->data + offset, buffer, count);
278 fw->size = max_t(size_t, offset + count, fw->size);
281 mutex_unlock(&fw_lock);
285 static struct bin_attribute firmware_attr_data_tmpl = {
286 .attr = {.name = "data", .mode = 0644, .owner = THIS_MODULE},
288 .read = firmware_data_read,
289 .write = firmware_data_write,
292 static void fw_dev_release(struct device *dev)
294 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
299 module_put(THIS_MODULE);
303 firmware_class_timeout(u_long data)
305 struct firmware_priv *fw_priv = (struct firmware_priv *) data;
306 fw_load_abort(fw_priv);
309 static inline void fw_setup_device_id(struct device *f_dev, struct device *dev)
311 /* XXX warning we should watch out for name collisions */
312 strlcpy(f_dev->bus_id, dev->bus_id, BUS_ID_SIZE);
315 static int fw_register_device(struct device **dev_p, const char *fw_name,
316 struct device *device)
319 struct firmware_priv *fw_priv = kzalloc(sizeof(*fw_priv),
321 struct device *f_dev = kzalloc(sizeof(*f_dev), GFP_KERNEL);
325 if (!fw_priv || !f_dev) {
326 printk(KERN_ERR "%s: kmalloc failed\n", __FUNCTION__);
331 init_completion(&fw_priv->completion);
332 fw_priv->attr_data = firmware_attr_data_tmpl;
333 strlcpy(fw_priv->fw_id, fw_name, FIRMWARE_NAME_MAX);
335 fw_priv->timeout.function = firmware_class_timeout;
336 fw_priv->timeout.data = (u_long) fw_priv;
337 init_timer(&fw_priv->timeout);
339 fw_setup_device_id(f_dev, device);
340 f_dev->parent = device;
341 f_dev->class = &firmware_class;
342 dev_set_drvdata(f_dev, fw_priv);
343 retval = device_register(f_dev);
345 printk(KERN_ERR "%s: device_register failed\n",
358 static int fw_setup_device(struct firmware *fw, struct device **dev_p,
359 const char *fw_name, struct device *device,
362 struct device *f_dev;
363 struct firmware_priv *fw_priv;
367 retval = fw_register_device(&f_dev, fw_name, device);
371 /* Need to pin this module until class device is destroyed */
372 __module_get(THIS_MODULE);
374 fw_priv = dev_get_drvdata(f_dev);
377 retval = sysfs_create_bin_file(&f_dev->kobj, &fw_priv->attr_data);
379 printk(KERN_ERR "%s: sysfs_create_bin_file failed\n",
384 retval = device_create_file(f_dev, &dev_attr_loading);
386 printk(KERN_ERR "%s: device_create_file failed\n",
392 set_bit(FW_STATUS_READY, &fw_priv->status);
394 set_bit(FW_STATUS_READY_NOHOTPLUG, &fw_priv->status);
399 device_unregister(f_dev);
405 _request_firmware(const struct firmware **firmware_p, const char *name,
406 struct device *device, int uevent)
408 struct device *f_dev;
409 struct firmware_priv *fw_priv;
410 struct firmware *firmware;
416 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
418 printk(KERN_ERR "%s: kmalloc(struct firmware) failed\n",
424 retval = fw_setup_device(firmware, &f_dev, name, device, uevent);
428 fw_priv = dev_get_drvdata(f_dev);
431 if (loading_timeout > 0) {
432 fw_priv->timeout.expires = jiffies + loading_timeout * HZ;
433 add_timer(&fw_priv->timeout);
436 kobject_uevent(&f_dev->kobj, KOBJ_ADD);
437 wait_for_completion(&fw_priv->completion);
438 set_bit(FW_STATUS_DONE, &fw_priv->status);
439 del_timer_sync(&fw_priv->timeout);
441 wait_for_completion(&fw_priv->completion);
443 mutex_lock(&fw_lock);
444 if (!fw_priv->fw->size || test_bit(FW_STATUS_ABORT, &fw_priv->status)) {
446 release_firmware(fw_priv->fw);
450 mutex_unlock(&fw_lock);
451 device_unregister(f_dev);
462 * request_firmware: - send firmware request and wait for it
463 * @firmware_p: pointer to firmware image
464 * @name: name of firmware file
465 * @device: device for which firmware is being loaded
467 * @firmware_p will be used to return a firmware image by the name
468 * of @name for device @device.
470 * Should be called from user context where sleeping is allowed.
472 * @name will be used as $FIRMWARE in the uevent environment and
473 * should be distinctive enough not to be confused with any other
474 * firmware image for this or any other device.
477 request_firmware(const struct firmware **firmware_p, const char *name,
478 struct device *device)
481 return _request_firmware(firmware_p, name, device, uevent);
485 * release_firmware: - release the resource associated with a firmware image
486 * @fw: firmware resource to release
489 release_firmware(const struct firmware *fw)
498 struct firmware_work {
499 struct work_struct work;
500 struct module *module;
502 struct device *device;
504 void (*cont)(const struct firmware *fw, void *context);
509 request_firmware_work_func(void *arg)
511 struct firmware_work *fw_work = arg;
512 const struct firmware *fw;
518 ret = _request_firmware(&fw, fw_work->name, fw_work->device,
521 fw_work->cont(NULL, fw_work->context);
523 fw_work->cont(fw, fw_work->context);
524 release_firmware(fw);
526 module_put(fw_work->module);
532 * request_firmware_nowait: asynchronous version of request_firmware
533 * @module: module requesting the firmware
534 * @uevent: sends uevent to copy the firmware image if this flag
535 * is non-zero else the firmware copy must be done manually.
536 * @name: name of firmware file
537 * @device: device for which firmware is being loaded
538 * @context: will be passed over to @cont, and
539 * @fw may be %NULL if firmware request fails.
540 * @cont: function will be called asynchronously when the firmware
543 * Asynchronous variant of request_firmware() for contexts where
544 * it is not possible to sleep.
547 request_firmware_nowait(
548 struct module *module, int uevent,
549 const char *name, struct device *device, void *context,
550 void (*cont)(const struct firmware *fw, void *context))
552 struct task_struct *task;
553 struct firmware_work *fw_work = kmalloc(sizeof (struct firmware_work),
558 if (!try_module_get(module)) {
563 *fw_work = (struct firmware_work) {
572 task = kthread_run(request_firmware_work_func, fw_work,
573 "firmware/%s", name);
576 fw_work->cont(NULL, fw_work->context);
577 module_put(fw_work->module);
579 return PTR_ERR(task);
585 firmware_class_init(void)
588 error = class_register(&firmware_class);
590 printk(KERN_ERR "%s: class_register failed\n", __FUNCTION__);
593 error = class_create_file(&firmware_class, &class_attr_timeout);
595 printk(KERN_ERR "%s: class_create_file failed\n",
597 class_unregister(&firmware_class);
603 firmware_class_exit(void)
605 class_unregister(&firmware_class);
608 fs_initcall(firmware_class_init);
609 module_exit(firmware_class_exit);
611 EXPORT_SYMBOL(release_firmware);
612 EXPORT_SYMBOL(request_firmware);
613 EXPORT_SYMBOL(request_firmware_nowait);