2 * firmware_class.c - Multi purpose firmware loading support
4 * Copyright (c) 2003 Manuel Estrada Sainz
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>
20 #include <linux/highmem.h>
21 #include <linux/firmware.h>
22 #include <linux/slab.h>
24 #define to_dev(obj) container_of(obj, struct device, kobj)
26 MODULE_AUTHOR("Manuel Estrada Sainz");
27 MODULE_DESCRIPTION("Multi purpose firmware loading support");
28 MODULE_LICENSE("GPL");
36 static int loading_timeout = 60; /* In seconds */
38 /* fw_lock could be moved to 'struct firmware_priv' but since it is just
39 * guarding for corner cases a global lock should be OK */
40 static DEFINE_MUTEX(fw_lock);
42 struct firmware_priv {
44 struct completion completion;
45 struct bin_attribute attr_data;
52 struct timer_list timeout;
56 #ifdef CONFIG_FW_LOADER
57 extern struct builtin_fw __start_builtin_fw[];
58 extern struct builtin_fw __end_builtin_fw[];
59 #else /* Module case. Avoid ifdefs later; it'll all optimise out */
60 static struct builtin_fw *__start_builtin_fw;
61 static struct builtin_fw *__end_builtin_fw;
65 fw_load_abort(struct firmware_priv *fw_priv)
67 set_bit(FW_STATUS_ABORT, &fw_priv->status);
69 complete(&fw_priv->completion);
73 firmware_timeout_show(struct class *class,
74 struct class_attribute *attr,
77 return sprintf(buf, "%d\n", loading_timeout);
81 * firmware_timeout_store - set number of seconds to wait for firmware
82 * @class: device class pointer
83 * @attr: device attribute pointer
84 * @buf: buffer to scan for timeout value
85 * @count: number of bytes in @buf
87 * Sets the number of seconds to wait for the firmware. Once
88 * this expires an error will be returned to the driver and no
89 * firmware will be provided.
91 * Note: zero means 'wait forever'.
94 firmware_timeout_store(struct class *class,
95 struct class_attribute *attr,
96 const char *buf, size_t count)
98 loading_timeout = simple_strtol(buf, NULL, 10);
99 if (loading_timeout < 0)
104 static CLASS_ATTR(timeout, 0644, firmware_timeout_show, firmware_timeout_store);
106 static void fw_dev_release(struct device *dev);
108 static int firmware_uevent(struct device *dev, struct kobj_uevent_env *env)
110 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
112 if (add_uevent_var(env, "FIRMWARE=%s", fw_priv->fw_id))
114 if (add_uevent_var(env, "TIMEOUT=%i", loading_timeout))
116 if (add_uevent_var(env, "ASYNC=%d", fw_priv->nowait))
122 static struct class firmware_class = {
124 .dev_uevent = firmware_uevent,
125 .dev_release = fw_dev_release,
128 static ssize_t firmware_loading_show(struct device *dev,
129 struct device_attribute *attr, char *buf)
131 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
132 int loading = test_bit(FW_STATUS_LOADING, &fw_priv->status);
133 return sprintf(buf, "%d\n", loading);
136 static void firmware_free_data(const struct firmware *fw)
141 for (i = 0; i < PFN_UP(fw->size); i++)
142 __free_page(fw->pages[i]);
147 /* Some architectures don't have PAGE_KERNEL_RO */
148 #ifndef PAGE_KERNEL_RO
149 #define PAGE_KERNEL_RO PAGE_KERNEL
152 * firmware_loading_store - set value in the 'loading' control file
153 * @dev: device pointer
154 * @attr: device attribute pointer
155 * @buf: buffer to scan for loading control value
156 * @count: number of bytes in @buf
158 * The relevant values are:
160 * 1: Start a load, discarding any previous partial load.
161 * 0: Conclude the load and hand the data to the driver code.
162 * -1: Conclude the load with an error and discard any written data.
164 static ssize_t firmware_loading_store(struct device *dev,
165 struct device_attribute *attr,
166 const char *buf, size_t count)
168 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
169 int loading = simple_strtol(buf, NULL, 10);
174 mutex_lock(&fw_lock);
176 mutex_unlock(&fw_lock);
179 firmware_free_data(fw_priv->fw);
180 memset(fw_priv->fw, 0, sizeof(struct firmware));
181 /* If the pages are not owned by 'struct firmware' */
182 for (i = 0; i < fw_priv->nr_pages; i++)
183 __free_page(fw_priv->pages[i]);
184 kfree(fw_priv->pages);
185 fw_priv->pages = NULL;
186 fw_priv->page_array_size = 0;
187 fw_priv->nr_pages = 0;
188 set_bit(FW_STATUS_LOADING, &fw_priv->status);
189 mutex_unlock(&fw_lock);
192 if (test_bit(FW_STATUS_LOADING, &fw_priv->status)) {
193 vunmap(fw_priv->fw->data);
194 fw_priv->fw->data = vmap(fw_priv->pages,
197 if (!fw_priv->fw->data) {
198 dev_err(dev, "%s: vmap() failed\n", __func__);
201 /* Pages are now owned by 'struct firmware' */
202 fw_priv->fw->pages = fw_priv->pages;
203 fw_priv->pages = NULL;
205 fw_priv->page_array_size = 0;
206 fw_priv->nr_pages = 0;
207 complete(&fw_priv->completion);
208 clear_bit(FW_STATUS_LOADING, &fw_priv->status);
213 dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading);
217 fw_load_abort(fw_priv);
224 static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store);
227 firmware_data_read(struct kobject *kobj, struct bin_attribute *bin_attr,
228 char *buffer, loff_t offset, size_t count)
230 struct device *dev = to_dev(kobj);
231 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
235 mutex_lock(&fw_lock);
237 if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
241 if (offset > fw->size) {
245 if (count > fw->size - offset)
246 count = fw->size - offset;
252 int page_nr = offset >> PAGE_SHIFT;
253 int page_ofs = offset & (PAGE_SIZE-1);
254 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
256 page_data = kmap(fw_priv->pages[page_nr]);
258 memcpy(buffer, page_data + page_ofs, page_cnt);
260 kunmap(fw_priv->pages[page_nr]);
266 mutex_unlock(&fw_lock);
271 fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
273 int pages_needed = ALIGN(min_size, PAGE_SIZE) >> PAGE_SHIFT;
275 /* If the array of pages is too small, grow it... */
276 if (fw_priv->page_array_size < pages_needed) {
277 int new_array_size = max(pages_needed,
278 fw_priv->page_array_size * 2);
279 struct page **new_pages;
281 new_pages = kmalloc(new_array_size * sizeof(void *),
284 fw_load_abort(fw_priv);
287 memcpy(new_pages, fw_priv->pages,
288 fw_priv->page_array_size * sizeof(void *));
289 memset(&new_pages[fw_priv->page_array_size], 0, sizeof(void *) *
290 (new_array_size - fw_priv->page_array_size));
291 kfree(fw_priv->pages);
292 fw_priv->pages = new_pages;
293 fw_priv->page_array_size = new_array_size;
296 while (fw_priv->nr_pages < pages_needed) {
297 fw_priv->pages[fw_priv->nr_pages] =
298 alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
300 if (!fw_priv->pages[fw_priv->nr_pages]) {
301 fw_load_abort(fw_priv);
310 * firmware_data_write - write method for firmware
311 * @kobj: kobject for the device
312 * @bin_attr: bin_attr structure
313 * @buffer: buffer being written
314 * @offset: buffer offset for write in total data store area
315 * @count: buffer size
317 * Data written to the 'data' attribute will be later handed to
318 * the driver as a firmware image.
321 firmware_data_write(struct kobject *kobj, struct bin_attribute *bin_attr,
322 char *buffer, loff_t offset, size_t count)
324 struct device *dev = to_dev(kobj);
325 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
329 if (!capable(CAP_SYS_RAWIO))
332 mutex_lock(&fw_lock);
334 if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
338 retval = fw_realloc_buffer(fw_priv, offset + count);
346 int page_nr = offset >> PAGE_SHIFT;
347 int page_ofs = offset & (PAGE_SIZE - 1);
348 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
350 page_data = kmap(fw_priv->pages[page_nr]);
352 memcpy(page_data + page_ofs, buffer, page_cnt);
354 kunmap(fw_priv->pages[page_nr]);
360 fw->size = max_t(size_t, offset, fw->size);
362 mutex_unlock(&fw_lock);
366 static struct bin_attribute firmware_attr_data_tmpl = {
367 .attr = {.name = "data", .mode = 0644},
369 .read = firmware_data_read,
370 .write = firmware_data_write,
373 static void fw_dev_release(struct device *dev)
375 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
378 for (i = 0; i < fw_priv->nr_pages; i++)
379 __free_page(fw_priv->pages[i]);
380 kfree(fw_priv->pages);
381 kfree(fw_priv->fw_id);
385 module_put(THIS_MODULE);
389 firmware_class_timeout(u_long data)
391 struct firmware_priv *fw_priv = (struct firmware_priv *) data;
392 fw_load_abort(fw_priv);
395 static int fw_register_device(struct device **dev_p, const char *fw_name,
396 struct device *device)
399 struct firmware_priv *fw_priv = kzalloc(sizeof(*fw_priv),
401 struct device *f_dev = kzalloc(sizeof(*f_dev), GFP_KERNEL);
405 if (!fw_priv || !f_dev) {
406 dev_err(device, "%s: kmalloc failed\n", __func__);
411 init_completion(&fw_priv->completion);
412 fw_priv->attr_data = firmware_attr_data_tmpl;
413 fw_priv->fw_id = kstrdup(fw_name, GFP_KERNEL);
414 if (!fw_priv->fw_id) {
415 dev_err(device, "%s: Firmware name allocation failed\n",
421 fw_priv->timeout.function = firmware_class_timeout;
422 fw_priv->timeout.data = (u_long) fw_priv;
423 init_timer(&fw_priv->timeout);
425 dev_set_name(f_dev, "%s", dev_name(device));
426 f_dev->parent = device;
427 f_dev->class = &firmware_class;
428 dev_set_drvdata(f_dev, fw_priv);
429 dev_set_uevent_suppress(f_dev, 1);
430 retval = device_register(f_dev);
432 dev_err(device, "%s: device_register failed\n", __func__);
445 static int fw_setup_device(struct firmware *fw, struct device **dev_p,
446 const char *fw_name, struct device *device,
447 int uevent, bool nowait)
449 struct device *f_dev;
450 struct firmware_priv *fw_priv;
454 retval = fw_register_device(&f_dev, fw_name, device);
458 /* Need to pin this module until class device is destroyed */
459 __module_get(THIS_MODULE);
461 fw_priv = dev_get_drvdata(f_dev);
463 fw_priv->nowait = nowait;
466 sysfs_bin_attr_init(&fw_priv->attr_data);
467 retval = sysfs_create_bin_file(&f_dev->kobj, &fw_priv->attr_data);
469 dev_err(device, "%s: sysfs_create_bin_file failed\n", __func__);
473 retval = device_create_file(f_dev, &dev_attr_loading);
475 dev_err(device, "%s: device_create_file failed\n", __func__);
480 dev_set_uevent_suppress(f_dev, 0);
485 device_unregister(f_dev);
491 _request_firmware(const struct firmware **firmware_p, const char *name,
492 struct device *device, int uevent, bool nowait)
494 struct device *f_dev;
495 struct firmware_priv *fw_priv;
496 struct firmware *firmware;
497 struct builtin_fw *builtin;
503 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
505 dev_err(device, "%s: kmalloc(struct firmware) failed\n",
511 for (builtin = __start_builtin_fw; builtin != __end_builtin_fw;
513 if (strcmp(name, builtin->name))
515 dev_dbg(device, "firmware: using built-in firmware %s\n", name);
516 firmware->size = builtin->size;
517 firmware->data = builtin->data;
522 dev_dbg(device, "firmware: requesting %s\n", name);
524 retval = fw_setup_device(firmware, &f_dev, name, device,
529 fw_priv = dev_get_drvdata(f_dev);
532 if (loading_timeout > 0) {
533 fw_priv->timeout.expires = jiffies + loading_timeout * HZ;
534 add_timer(&fw_priv->timeout);
537 kobject_uevent(&f_dev->kobj, KOBJ_ADD);
538 wait_for_completion(&fw_priv->completion);
539 set_bit(FW_STATUS_DONE, &fw_priv->status);
540 del_timer_sync(&fw_priv->timeout);
542 wait_for_completion(&fw_priv->completion);
544 mutex_lock(&fw_lock);
545 if (!fw_priv->fw->size || test_bit(FW_STATUS_ABORT, &fw_priv->status)) {
547 release_firmware(fw_priv->fw);
551 mutex_unlock(&fw_lock);
552 device_unregister(f_dev);
563 * request_firmware: - send firmware request and wait for it
564 * @firmware_p: pointer to firmware image
565 * @name: name of firmware file
566 * @device: device for which firmware is being loaded
568 * @firmware_p will be used to return a firmware image by the name
569 * of @name for device @device.
571 * Should be called from user context where sleeping is allowed.
573 * @name will be used as $FIRMWARE in the uevent environment and
574 * should be distinctive enough not to be confused with any other
575 * firmware image for this or any other device.
578 request_firmware(const struct firmware **firmware_p, const char *name,
579 struct device *device)
582 return _request_firmware(firmware_p, name, device, uevent, false);
586 * release_firmware: - release the resource associated with a firmware image
587 * @fw: firmware resource to release
590 release_firmware(const struct firmware *fw)
592 struct builtin_fw *builtin;
595 for (builtin = __start_builtin_fw; builtin != __end_builtin_fw;
597 if (fw->data == builtin->data)
600 firmware_free_data(fw);
607 struct firmware_work {
608 struct work_struct work;
609 struct module *module;
611 struct device *device;
613 void (*cont)(const struct firmware *fw, void *context);
618 request_firmware_work_func(void *arg)
620 struct firmware_work *fw_work = arg;
621 const struct firmware *fw;
627 ret = _request_firmware(&fw, fw_work->name, fw_work->device,
628 fw_work->uevent, true);
630 fw_work->cont(fw, fw_work->context);
632 module_put(fw_work->module);
638 * request_firmware_nowait - asynchronous version of request_firmware
639 * @module: module requesting the firmware
640 * @uevent: sends uevent to copy the firmware image if this flag
641 * is non-zero else the firmware copy must be done manually.
642 * @name: name of firmware file
643 * @device: device for which firmware is being loaded
644 * @gfp: allocation flags
645 * @context: will be passed over to @cont, and
646 * @fw may be %NULL if firmware request fails.
647 * @cont: function will be called asynchronously when the firmware
650 * Asynchronous variant of request_firmware() for user contexts where
651 * it is not possible to sleep for long time. It can't be called
652 * in atomic contexts.
655 request_firmware_nowait(
656 struct module *module, int uevent,
657 const char *name, struct device *device, gfp_t gfp, void *context,
658 void (*cont)(const struct firmware *fw, void *context))
660 struct task_struct *task;
661 struct firmware_work *fw_work = kmalloc(sizeof (struct firmware_work),
666 if (!try_module_get(module)) {
671 *fw_work = (struct firmware_work) {
680 task = kthread_run(request_firmware_work_func, fw_work,
681 "firmware/%s", name);
684 fw_work->cont(NULL, fw_work->context);
685 module_put(fw_work->module);
687 return PTR_ERR(task);
693 firmware_class_init(void)
696 error = class_register(&firmware_class);
698 printk(KERN_ERR "%s: class_register failed\n", __func__);
701 error = class_create_file(&firmware_class, &class_attr_timeout);
703 printk(KERN_ERR "%s: class_create_file failed\n",
705 class_unregister(&firmware_class);
711 firmware_class_exit(void)
713 class_unregister(&firmware_class);
716 fs_initcall(firmware_class_init);
717 module_exit(firmware_class_exit);
719 EXPORT_SYMBOL(release_firmware);
720 EXPORT_SYMBOL(request_firmware);
721 EXPORT_SYMBOL(request_firmware_nowait);