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;
55 #ifdef CONFIG_FW_LOADER
56 extern struct builtin_fw __start_builtin_fw[];
57 extern struct builtin_fw __end_builtin_fw[];
58 #else /* Module case. Avoid ifdefs later; it'll all optimise out */
59 static struct builtin_fw *__start_builtin_fw;
60 static struct builtin_fw *__end_builtin_fw;
64 fw_load_abort(struct firmware_priv *fw_priv)
66 set_bit(FW_STATUS_ABORT, &fw_priv->status);
68 complete(&fw_priv->completion);
72 firmware_timeout_show(struct class *class,
73 struct class_attribute *attr,
76 return sprintf(buf, "%d\n", loading_timeout);
80 * firmware_timeout_store - set number of seconds to wait for firmware
81 * @class: device class pointer
82 * @attr: device attribute pointer
83 * @buf: buffer to scan for timeout value
84 * @count: number of bytes in @buf
86 * Sets the number of seconds to wait for the firmware. Once
87 * this expires an error will be returned to the driver and no
88 * firmware will be provided.
90 * Note: zero means 'wait forever'.
93 firmware_timeout_store(struct class *class,
94 struct class_attribute *attr,
95 const char *buf, size_t count)
97 loading_timeout = simple_strtol(buf, NULL, 10);
98 if (loading_timeout < 0)
103 static CLASS_ATTR(timeout, 0644, firmware_timeout_show, firmware_timeout_store);
105 static void fw_dev_release(struct device *dev);
107 static int firmware_uevent(struct device *dev, struct kobj_uevent_env *env)
109 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
111 if (add_uevent_var(env, "FIRMWARE=%s", fw_priv->fw_id))
113 if (add_uevent_var(env, "TIMEOUT=%i", loading_timeout))
119 static struct class firmware_class = {
121 .dev_uevent = firmware_uevent,
122 .dev_release = fw_dev_release,
125 static ssize_t firmware_loading_show(struct device *dev,
126 struct device_attribute *attr, char *buf)
128 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
129 int loading = test_bit(FW_STATUS_LOADING, &fw_priv->status);
130 return sprintf(buf, "%d\n", loading);
133 static void firmware_free_data(const struct firmware *fw)
138 for (i = 0; i < PFN_UP(fw->size); i++)
139 __free_page(fw->pages[i]);
144 /* Some architectures don't have PAGE_KERNEL_RO */
145 #ifndef PAGE_KERNEL_RO
146 #define PAGE_KERNEL_RO PAGE_KERNEL
149 * firmware_loading_store - set value in the 'loading' control file
150 * @dev: device pointer
151 * @attr: device attribute pointer
152 * @buf: buffer to scan for loading control value
153 * @count: number of bytes in @buf
155 * The relevant values are:
157 * 1: Start a load, discarding any previous partial load.
158 * 0: Conclude the load and hand the data to the driver code.
159 * -1: Conclude the load with an error and discard any written data.
161 static ssize_t firmware_loading_store(struct device *dev,
162 struct device_attribute *attr,
163 const char *buf, size_t count)
165 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
166 int loading = simple_strtol(buf, NULL, 10);
171 mutex_lock(&fw_lock);
173 mutex_unlock(&fw_lock);
176 firmware_free_data(fw_priv->fw);
177 memset(fw_priv->fw, 0, sizeof(struct firmware));
178 /* If the pages are not owned by 'struct firmware' */
179 for (i = 0; i < fw_priv->nr_pages; i++)
180 __free_page(fw_priv->pages[i]);
181 kfree(fw_priv->pages);
182 fw_priv->pages = NULL;
183 fw_priv->page_array_size = 0;
184 fw_priv->nr_pages = 0;
185 set_bit(FW_STATUS_LOADING, &fw_priv->status);
186 mutex_unlock(&fw_lock);
189 if (test_bit(FW_STATUS_LOADING, &fw_priv->status)) {
190 vunmap(fw_priv->fw->data);
191 fw_priv->fw->data = vmap(fw_priv->pages,
194 if (!fw_priv->fw->data) {
195 dev_err(dev, "%s: vmap() failed\n", __func__);
198 /* Pages are now owned by 'struct firmware' */
199 fw_priv->fw->pages = fw_priv->pages;
200 fw_priv->pages = NULL;
202 fw_priv->page_array_size = 0;
203 fw_priv->nr_pages = 0;
204 complete(&fw_priv->completion);
205 clear_bit(FW_STATUS_LOADING, &fw_priv->status);
210 dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading);
214 fw_load_abort(fw_priv);
221 static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store);
224 firmware_data_read(struct kobject *kobj, struct bin_attribute *bin_attr,
225 char *buffer, loff_t offset, size_t count)
227 struct device *dev = to_dev(kobj);
228 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
232 mutex_lock(&fw_lock);
234 if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
238 if (offset > fw->size) {
242 if (count > fw->size - offset)
243 count = fw->size - offset;
249 int page_nr = offset >> PAGE_SHIFT;
250 int page_ofs = offset & (PAGE_SIZE-1);
251 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
253 page_data = kmap(fw_priv->pages[page_nr]);
255 memcpy(buffer, page_data + page_ofs, page_cnt);
257 kunmap(fw_priv->pages[page_nr]);
263 mutex_unlock(&fw_lock);
268 fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
270 int pages_needed = ALIGN(min_size, PAGE_SIZE) >> PAGE_SHIFT;
272 /* If the array of pages is too small, grow it... */
273 if (fw_priv->page_array_size < pages_needed) {
274 int new_array_size = max(pages_needed,
275 fw_priv->page_array_size * 2);
276 struct page **new_pages;
278 new_pages = kmalloc(new_array_size * sizeof(void *),
281 fw_load_abort(fw_priv);
284 memcpy(new_pages, fw_priv->pages,
285 fw_priv->page_array_size * sizeof(void *));
286 memset(&new_pages[fw_priv->page_array_size], 0, sizeof(void *) *
287 (new_array_size - fw_priv->page_array_size));
288 kfree(fw_priv->pages);
289 fw_priv->pages = new_pages;
290 fw_priv->page_array_size = new_array_size;
293 while (fw_priv->nr_pages < pages_needed) {
294 fw_priv->pages[fw_priv->nr_pages] =
295 alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
297 if (!fw_priv->pages[fw_priv->nr_pages]) {
298 fw_load_abort(fw_priv);
307 * firmware_data_write - write method for firmware
308 * @kobj: kobject for the device
309 * @bin_attr: bin_attr structure
310 * @buffer: buffer being written
311 * @offset: buffer offset for write in total data store area
312 * @count: buffer size
314 * Data written to the 'data' attribute will be later handed to
315 * the driver as a firmware image.
318 firmware_data_write(struct kobject *kobj, struct bin_attribute *bin_attr,
319 char *buffer, loff_t offset, size_t count)
321 struct device *dev = to_dev(kobj);
322 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
326 if (!capable(CAP_SYS_RAWIO))
329 mutex_lock(&fw_lock);
331 if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
335 retval = fw_realloc_buffer(fw_priv, offset + count);
343 int page_nr = offset >> PAGE_SHIFT;
344 int page_ofs = offset & (PAGE_SIZE - 1);
345 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
347 page_data = kmap(fw_priv->pages[page_nr]);
349 memcpy(page_data + page_ofs, buffer, page_cnt);
351 kunmap(fw_priv->pages[page_nr]);
357 fw->size = max_t(size_t, offset, fw->size);
359 mutex_unlock(&fw_lock);
363 static struct bin_attribute firmware_attr_data_tmpl = {
364 .attr = {.name = "data", .mode = 0644},
366 .read = firmware_data_read,
367 .write = firmware_data_write,
370 static void fw_dev_release(struct device *dev)
372 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
375 for (i = 0; i < fw_priv->nr_pages; i++)
376 __free_page(fw_priv->pages[i]);
377 kfree(fw_priv->pages);
378 kfree(fw_priv->fw_id);
382 module_put(THIS_MODULE);
386 firmware_class_timeout(u_long data)
388 struct firmware_priv *fw_priv = (struct firmware_priv *) data;
389 fw_load_abort(fw_priv);
392 static int fw_register_device(struct device **dev_p, const char *fw_name,
393 struct device *device)
396 struct firmware_priv *fw_priv = kzalloc(sizeof(*fw_priv),
398 struct device *f_dev = kzalloc(sizeof(*f_dev), GFP_KERNEL);
402 if (!fw_priv || !f_dev) {
403 dev_err(device, "%s: kmalloc failed\n", __func__);
408 init_completion(&fw_priv->completion);
409 fw_priv->attr_data = firmware_attr_data_tmpl;
410 fw_priv->fw_id = kstrdup(fw_name, GFP_KERNEL);
411 if (!fw_priv->fw_id) {
412 dev_err(device, "%s: Firmware name allocation failed\n",
418 fw_priv->timeout.function = firmware_class_timeout;
419 fw_priv->timeout.data = (u_long) fw_priv;
420 init_timer(&fw_priv->timeout);
422 dev_set_name(f_dev, "%s", dev_name(device));
423 f_dev->parent = device;
424 f_dev->class = &firmware_class;
425 dev_set_drvdata(f_dev, fw_priv);
426 dev_set_uevent_suppress(f_dev, 1);
427 retval = device_register(f_dev);
429 dev_err(device, "%s: device_register failed\n", __func__);
442 static int fw_setup_device(struct firmware *fw, struct device **dev_p,
443 const char *fw_name, struct device *device,
446 struct device *f_dev;
447 struct firmware_priv *fw_priv;
451 retval = fw_register_device(&f_dev, fw_name, device);
455 /* Need to pin this module until class device is destroyed */
456 __module_get(THIS_MODULE);
458 fw_priv = dev_get_drvdata(f_dev);
461 sysfs_bin_attr_init(&fw_priv->attr_data);
462 retval = sysfs_create_bin_file(&f_dev->kobj, &fw_priv->attr_data);
464 dev_err(device, "%s: sysfs_create_bin_file failed\n", __func__);
468 retval = device_create_file(f_dev, &dev_attr_loading);
470 dev_err(device, "%s: device_create_file failed\n", __func__);
475 dev_set_uevent_suppress(f_dev, 0);
480 device_unregister(f_dev);
486 _request_firmware(const struct firmware **firmware_p, const char *name,
487 struct device *device, int uevent)
489 struct device *f_dev;
490 struct firmware_priv *fw_priv;
491 struct firmware *firmware;
492 struct builtin_fw *builtin;
498 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
500 dev_err(device, "%s: kmalloc(struct firmware) failed\n",
506 for (builtin = __start_builtin_fw; builtin != __end_builtin_fw;
508 if (strcmp(name, builtin->name))
510 dev_info(device, "firmware: using built-in firmware %s\n",
512 firmware->size = builtin->size;
513 firmware->data = builtin->data;
518 dev_info(device, "firmware: requesting %s\n", name);
520 retval = fw_setup_device(firmware, &f_dev, name, device, uevent);
524 fw_priv = dev_get_drvdata(f_dev);
527 if (loading_timeout > 0) {
528 fw_priv->timeout.expires = jiffies + loading_timeout * HZ;
529 add_timer(&fw_priv->timeout);
532 kobject_uevent(&f_dev->kobj, KOBJ_ADD);
533 wait_for_completion(&fw_priv->completion);
534 set_bit(FW_STATUS_DONE, &fw_priv->status);
535 del_timer_sync(&fw_priv->timeout);
537 wait_for_completion(&fw_priv->completion);
539 mutex_lock(&fw_lock);
540 if (!fw_priv->fw->size || test_bit(FW_STATUS_ABORT, &fw_priv->status)) {
542 release_firmware(fw_priv->fw);
546 mutex_unlock(&fw_lock);
547 device_unregister(f_dev);
558 * request_firmware: - send firmware request and wait for it
559 * @firmware_p: pointer to firmware image
560 * @name: name of firmware file
561 * @device: device for which firmware is being loaded
563 * @firmware_p will be used to return a firmware image by the name
564 * of @name for device @device.
566 * Should be called from user context where sleeping is allowed.
568 * @name will be used as $FIRMWARE in the uevent environment and
569 * should be distinctive enough not to be confused with any other
570 * firmware image for this or any other device.
573 request_firmware(const struct firmware **firmware_p, const char *name,
574 struct device *device)
577 return _request_firmware(firmware_p, name, device, uevent);
581 * release_firmware: - release the resource associated with a firmware image
582 * @fw: firmware resource to release
585 release_firmware(const struct firmware *fw)
587 struct builtin_fw *builtin;
590 for (builtin = __start_builtin_fw; builtin != __end_builtin_fw;
592 if (fw->data == builtin->data)
595 firmware_free_data(fw);
602 struct firmware_work {
603 struct work_struct work;
604 struct module *module;
606 struct device *device;
608 void (*cont)(const struct firmware *fw, void *context);
613 request_firmware_work_func(void *arg)
615 struct firmware_work *fw_work = arg;
616 const struct firmware *fw;
622 ret = _request_firmware(&fw, fw_work->name, fw_work->device,
625 fw_work->cont(fw, fw_work->context);
627 module_put(fw_work->module);
633 * request_firmware_nowait - asynchronous version of request_firmware
634 * @module: module requesting the firmware
635 * @uevent: sends uevent to copy the firmware image if this flag
636 * is non-zero else the firmware copy must be done manually.
637 * @name: name of firmware file
638 * @device: device for which firmware is being loaded
639 * @gfp: allocation flags
640 * @context: will be passed over to @cont, and
641 * @fw may be %NULL if firmware request fails.
642 * @cont: function will be called asynchronously when the firmware
645 * Asynchronous variant of request_firmware() for user contexts where
646 * it is not possible to sleep for long time. It can't be called
647 * in atomic contexts.
650 request_firmware_nowait(
651 struct module *module, int uevent,
652 const char *name, struct device *device, gfp_t gfp, void *context,
653 void (*cont)(const struct firmware *fw, void *context))
655 struct task_struct *task;
656 struct firmware_work *fw_work = kmalloc(sizeof (struct firmware_work),
661 if (!try_module_get(module)) {
666 *fw_work = (struct firmware_work) {
675 task = kthread_run(request_firmware_work_func, fw_work,
676 "firmware/%s", name);
679 fw_work->cont(NULL, fw_work->context);
680 module_put(fw_work->module);
682 return PTR_ERR(task);
688 firmware_class_init(void)
691 error = class_register(&firmware_class);
693 printk(KERN_ERR "%s: class_register failed\n", __func__);
696 error = class_create_file(&firmware_class, &class_attr_timeout);
698 printk(KERN_ERR "%s: class_create_file failed\n",
700 class_unregister(&firmware_class);
706 firmware_class_exit(void)
708 class_unregister(&firmware_class);
711 fs_initcall(firmware_class_init);
712 module_exit(firmware_class_exit);
714 EXPORT_SYMBOL(release_firmware);
715 EXPORT_SYMBOL(request_firmware);
716 EXPORT_SYMBOL(request_firmware_nowait);