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);
80 static CLASS_ATTR(timeout, 0644, firmware_timeout_show, firmware_timeout_store);
82 static void fw_class_dev_release(struct class_device *class_dev);
83 int firmware_class_hotplug(struct class_device *dev, char **envp,
84 int num_envp, char *buffer, int buffer_size);
86 static struct class firmware_class = {
88 .hotplug = firmware_class_hotplug,
89 .release = fw_class_dev_release,
93 firmware_class_hotplug(struct class_device *class_dev, char **envp,
94 int num_envp, char *buffer, int buffer_size)
96 struct firmware_priv *fw_priv = class_get_devdata(class_dev);
99 if (!test_bit(FW_STATUS_READY, &fw_priv->status))
102 if (add_hotplug_env_var(envp, num_envp, &i, buffer, buffer_size, &len,
103 "FIRMWARE=%s", fw_priv->fw_id))
105 if (add_hotplug_env_var(envp, num_envp, &i, buffer, buffer_size, &len,
106 "TIMEOUT=%i", loading_timeout))
115 firmware_loading_show(struct class_device *class_dev, char *buf)
117 struct firmware_priv *fw_priv = class_get_devdata(class_dev);
118 int loading = test_bit(FW_STATUS_LOADING, &fw_priv->status);
119 return sprintf(buf, "%d\n", loading);
123 * firmware_loading_store: - loading control file
125 * The relevant values are:
127 * 1: Start a load, discarding any previous partial load.
128 * 0: Conclude the load and handle the data to the driver code.
129 * -1: Conclude the load with an error and discard any written data.
132 firmware_loading_store(struct class_device *class_dev,
133 const char *buf, size_t count)
135 struct firmware_priv *fw_priv = class_get_devdata(class_dev);
136 int loading = simple_strtol(buf, NULL, 10);
141 vfree(fw_priv->fw->data);
142 fw_priv->fw->data = NULL;
143 fw_priv->fw->size = 0;
144 fw_priv->alloc_size = 0;
145 set_bit(FW_STATUS_LOADING, &fw_priv->status);
149 if (test_bit(FW_STATUS_LOADING, &fw_priv->status)) {
150 complete(&fw_priv->completion);
151 clear_bit(FW_STATUS_LOADING, &fw_priv->status);
156 printk(KERN_ERR "%s: unexpected value (%d)\n", __FUNCTION__,
160 fw_load_abort(fw_priv);
167 static CLASS_DEVICE_ATTR(loading, 0644,
168 firmware_loading_show, firmware_loading_store);
171 firmware_data_read(struct kobject *kobj,
172 char *buffer, loff_t offset, size_t count)
174 struct class_device *class_dev = to_class_dev(kobj);
175 struct firmware_priv *fw_priv = class_get_devdata(class_dev);
177 ssize_t ret_count = count;
181 if (test_bit(FW_STATUS_DONE, &fw_priv->status)) {
185 if (offset > fw->size) {
189 if (offset + ret_count > fw->size)
190 ret_count = fw->size - offset;
192 memcpy(buffer, fw->data + offset, ret_count);
198 fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
202 if (min_size <= fw_priv->alloc_size)
205 new_data = vmalloc(fw_priv->alloc_size + PAGE_SIZE);
207 printk(KERN_ERR "%s: unable to alloc buffer\n", __FUNCTION__);
208 /* Make sure that we don't keep incomplete data */
209 fw_load_abort(fw_priv);
212 fw_priv->alloc_size += PAGE_SIZE;
213 if (fw_priv->fw->data) {
214 memcpy(new_data, fw_priv->fw->data, fw_priv->fw->size);
215 vfree(fw_priv->fw->data);
217 fw_priv->fw->data = new_data;
218 BUG_ON(min_size > fw_priv->alloc_size);
223 * firmware_data_write:
227 * Data written to the 'data' attribute will be later handled to
228 * the driver as a firmware image.
231 firmware_data_write(struct kobject *kobj,
232 char *buffer, loff_t offset, size_t count)
234 struct class_device *class_dev = to_class_dev(kobj);
235 struct firmware_priv *fw_priv = class_get_devdata(class_dev);
239 if (!capable(CAP_SYS_RAWIO))
243 if (test_bit(FW_STATUS_DONE, &fw_priv->status)) {
247 retval = fw_realloc_buffer(fw_priv, offset + count);
251 memcpy(fw->data + offset, buffer, count);
253 fw->size = max_t(size_t, offset + count, fw->size);
259 static struct bin_attribute firmware_attr_data_tmpl = {
260 .attr = {.name = "data", .mode = 0644, .owner = THIS_MODULE},
262 .read = firmware_data_read,
263 .write = firmware_data_write,
267 fw_class_dev_release(struct class_device *class_dev)
269 struct firmware_priv *fw_priv = class_get_devdata(class_dev);
274 module_put(THIS_MODULE);
278 firmware_class_timeout(u_long data)
280 struct firmware_priv *fw_priv = (struct firmware_priv *) data;
281 fw_load_abort(fw_priv);
285 fw_setup_class_device_id(struct class_device *class_dev, struct device *dev)
287 /* XXX warning we should watch out for name collisions */
288 strlcpy(class_dev->class_id, dev->bus_id, BUS_ID_SIZE);
292 fw_register_class_device(struct class_device **class_dev_p,
293 const char *fw_name, struct device *device)
296 struct firmware_priv *fw_priv = kmalloc(sizeof (struct firmware_priv),
298 struct class_device *class_dev = kmalloc(sizeof (struct class_device),
303 if (!fw_priv || !class_dev) {
304 printk(KERN_ERR "%s: kmalloc failed\n", __FUNCTION__);
308 memset(fw_priv, 0, sizeof (*fw_priv));
309 memset(class_dev, 0, sizeof (*class_dev));
311 init_completion(&fw_priv->completion);
312 fw_priv->attr_data = firmware_attr_data_tmpl;
313 strlcpy(fw_priv->fw_id, fw_name, FIRMWARE_NAME_MAX);
315 fw_priv->timeout.function = firmware_class_timeout;
316 fw_priv->timeout.data = (u_long) fw_priv;
317 init_timer(&fw_priv->timeout);
319 fw_setup_class_device_id(class_dev, device);
320 class_dev->dev = device;
321 class_dev->class = &firmware_class;
322 class_set_devdata(class_dev, fw_priv);
323 retval = class_device_register(class_dev);
325 printk(KERN_ERR "%s: class_device_register failed\n",
329 *class_dev_p = class_dev;
339 fw_setup_class_device(struct firmware *fw, struct class_device **class_dev_p,
340 const char *fw_name, struct device *device)
342 struct class_device *class_dev;
343 struct firmware_priv *fw_priv;
347 retval = fw_register_class_device(&class_dev, fw_name, device);
351 /* Need to pin this module until class device is destroyed */
352 __module_get(THIS_MODULE);
354 fw_priv = class_get_devdata(class_dev);
357 retval = sysfs_create_bin_file(&class_dev->kobj, &fw_priv->attr_data);
359 printk(KERN_ERR "%s: sysfs_create_bin_file failed\n",
364 retval = class_device_create_file(class_dev,
365 &class_device_attr_loading);
367 printk(KERN_ERR "%s: class_device_create_file failed\n",
372 set_bit(FW_STATUS_READY, &fw_priv->status);
373 *class_dev_p = class_dev;
377 class_device_unregister(class_dev);
383 * request_firmware: - request firmware to hotplug and wait for it
385 * @firmware will be used to return a firmware image by the name
386 * of @name for device @device.
388 * Should be called from user context where sleeping is allowed.
390 * @name will be use as $FIRMWARE in the hotplug environment and
391 * should be distinctive enough not to be confused with any other
392 * firmware image for this or any other device.
395 request_firmware(const struct firmware **firmware_p, const char *name,
396 struct device *device)
398 struct class_device *class_dev;
399 struct firmware_priv *fw_priv;
400 struct firmware *firmware;
406 *firmware_p = firmware = kmalloc(sizeof (struct firmware), GFP_KERNEL);
408 printk(KERN_ERR "%s: kmalloc(struct firmware) failed\n",
413 memset(firmware, 0, sizeof (*firmware));
415 retval = fw_setup_class_device(firmware, &class_dev, name, device);
419 fw_priv = class_get_devdata(class_dev);
421 if (loading_timeout) {
422 fw_priv->timeout.expires = jiffies + loading_timeout * HZ;
423 add_timer(&fw_priv->timeout);
426 kobject_hotplug(&class_dev->kobj, KOBJ_ADD);
427 wait_for_completion(&fw_priv->completion);
428 set_bit(FW_STATUS_DONE, &fw_priv->status);
430 del_timer_sync(&fw_priv->timeout);
433 if (!fw_priv->fw->size || test_bit(FW_STATUS_ABORT, &fw_priv->status)) {
435 release_firmware(fw_priv->fw);
440 class_device_unregister(class_dev);
451 * release_firmware: - release the resource associated with a firmware image
454 release_firmware(const struct firmware *fw)
463 * register_firmware: - provide a firmware image for later usage
466 * Make sure that @data will be available by requesting firmware @name.
468 * Note: This will not be possible until some kind of persistence
472 register_firmware(const char *name, const u8 *data, size_t size)
474 /* This is meaningless without firmware caching, so until we
475 * decide if firmware caching is reasonable just leave it as a
480 struct firmware_work {
481 struct work_struct work;
482 struct module *module;
484 struct device *device;
486 void (*cont)(const struct firmware *fw, void *context);
490 request_firmware_work_func(void *arg)
492 struct firmware_work *fw_work = arg;
493 const struct firmware *fw;
498 daemonize("%s/%s", "firmware", fw_work->name);
499 request_firmware(&fw, fw_work->name, fw_work->device);
500 fw_work->cont(fw, fw_work->context);
501 release_firmware(fw);
502 module_put(fw_work->module);
508 * request_firmware_nowait:
511 * Asynchronous variant of request_firmware() for contexts where
512 * it is not possible to sleep.
514 * @cont will be called asynchronously when the firmware request is over.
516 * @context will be passed over to @cont.
518 * @fw may be %NULL if firmware request fails.
522 request_firmware_nowait(
523 struct module *module,
524 const char *name, struct device *device, void *context,
525 void (*cont)(const struct firmware *fw, void *context))
527 struct firmware_work *fw_work = kmalloc(sizeof (struct firmware_work),
533 if (!try_module_get(module)) {
538 *fw_work = (struct firmware_work) {
546 ret = kernel_thread(request_firmware_work_func, fw_work,
547 CLONE_FS | CLONE_FILES);
550 fw_work->cont(NULL, fw_work->context);
557 firmware_class_init(void)
560 error = class_register(&firmware_class);
562 printk(KERN_ERR "%s: class_register failed\n", __FUNCTION__);
565 error = class_create_file(&firmware_class, &class_attr_timeout);
567 printk(KERN_ERR "%s: class_create_file failed\n",
569 class_unregister(&firmware_class);
575 firmware_class_exit(void)
577 class_unregister(&firmware_class);
580 module_init(firmware_class_init);
581 module_exit(firmware_class_exit);
583 EXPORT_SYMBOL(release_firmware);
584 EXPORT_SYMBOL(request_firmware);
585 EXPORT_SYMBOL(request_firmware_nowait);
586 EXPORT_SYMBOL(register_firmware);