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>
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, char *buf)
74 return sprintf(buf, "%d\n", loading_timeout);
78 * firmware_timeout_store - set number of seconds to wait for firmware
79 * @class: device class pointer
80 * @buf: buffer to scan for timeout value
81 * @count: number of bytes in @buf
83 * Sets the number of seconds to wait for the firmware. Once
84 * this expires an error will be returned to the driver and no
85 * firmware will be provided.
87 * Note: zero means 'wait forever'.
90 firmware_timeout_store(struct class *class, const char *buf, size_t count)
92 loading_timeout = simple_strtol(buf, NULL, 10);
93 if (loading_timeout < 0)
98 static CLASS_ATTR(timeout, 0644, firmware_timeout_show, firmware_timeout_store);
100 static void fw_dev_release(struct device *dev);
102 static int firmware_uevent(struct device *dev, struct kobj_uevent_env *env)
104 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
106 if (add_uevent_var(env, "FIRMWARE=%s", fw_priv->fw_id))
108 if (add_uevent_var(env, "TIMEOUT=%i", loading_timeout))
114 static struct class firmware_class = {
116 .dev_uevent = firmware_uevent,
117 .dev_release = fw_dev_release,
120 static ssize_t firmware_loading_show(struct device *dev,
121 struct device_attribute *attr, char *buf)
123 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
124 int loading = test_bit(FW_STATUS_LOADING, &fw_priv->status);
125 return sprintf(buf, "%d\n", loading);
128 static void firmware_free_data(const struct firmware *fw)
133 for (i = 0; i < PFN_UP(fw->size); i++)
134 __free_page(fw->pages[i]);
139 /* Some architectures don't have PAGE_KERNEL_RO */
140 #ifndef PAGE_KERNEL_RO
141 #define PAGE_KERNEL_RO PAGE_KERNEL
144 * firmware_loading_store - set value in the 'loading' control file
145 * @dev: device pointer
146 * @attr: device attribute pointer
147 * @buf: buffer to scan for loading control value
148 * @count: number of bytes in @buf
150 * The relevant values are:
152 * 1: Start a load, discarding any previous partial load.
153 * 0: Conclude the load and hand the data to the driver code.
154 * -1: Conclude the load with an error and discard any written data.
156 static ssize_t firmware_loading_store(struct device *dev,
157 struct device_attribute *attr,
158 const char *buf, size_t count)
160 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
161 int loading = simple_strtol(buf, NULL, 10);
164 mutex_lock(&fw_lock);
171 firmware_free_data(fw_priv->fw);
172 memset(fw_priv->fw, 0, sizeof(struct firmware));
173 /* If the pages are not owned by 'struct firmware' */
174 for (i = 0; i < fw_priv->nr_pages; i++)
175 __free_page(fw_priv->pages[i]);
176 kfree(fw_priv->pages);
177 fw_priv->pages = NULL;
178 fw_priv->page_array_size = 0;
179 fw_priv->nr_pages = 0;
180 set_bit(FW_STATUS_LOADING, &fw_priv->status);
183 if (test_bit(FW_STATUS_LOADING, &fw_priv->status)) {
184 vunmap(fw_priv->fw->data);
185 fw_priv->fw->data = vmap(fw_priv->pages,
188 if (!fw_priv->fw->data) {
189 dev_err(dev, "%s: vmap() failed\n", __func__);
192 /* Pages are now owned by 'struct firmware' */
193 fw_priv->fw->pages = fw_priv->pages;
194 fw_priv->pages = NULL;
196 fw_priv->page_array_size = 0;
197 fw_priv->nr_pages = 0;
198 complete(&fw_priv->completion);
199 clear_bit(FW_STATUS_LOADING, &fw_priv->status);
204 dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading);
208 fw_load_abort(fw_priv);
212 mutex_unlock(&fw_lock);
216 static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store);
219 firmware_data_read(struct kobject *kobj, struct bin_attribute *bin_attr,
220 char *buffer, loff_t offset, size_t count)
222 struct device *dev = to_dev(kobj);
223 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
227 mutex_lock(&fw_lock);
229 if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
233 if (offset > fw->size) {
237 if (count > fw->size - offset)
238 count = fw->size - offset;
244 int page_nr = offset >> PAGE_SHIFT;
245 int page_ofs = offset & (PAGE_SIZE-1);
246 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
248 page_data = kmap(fw_priv->pages[page_nr]);
250 memcpy(buffer, page_data + page_ofs, page_cnt);
252 kunmap(fw_priv->pages[page_nr]);
258 mutex_unlock(&fw_lock);
263 fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
265 int pages_needed = ALIGN(min_size, PAGE_SIZE) >> PAGE_SHIFT;
267 /* If the array of pages is too small, grow it... */
268 if (fw_priv->page_array_size < pages_needed) {
269 int new_array_size = max(pages_needed,
270 fw_priv->page_array_size * 2);
271 struct page **new_pages;
273 new_pages = kmalloc(new_array_size * sizeof(void *),
276 fw_load_abort(fw_priv);
279 memcpy(new_pages, fw_priv->pages,
280 fw_priv->page_array_size * sizeof(void *));
281 memset(&new_pages[fw_priv->page_array_size], 0, sizeof(void *) *
282 (new_array_size - fw_priv->page_array_size));
283 kfree(fw_priv->pages);
284 fw_priv->pages = new_pages;
285 fw_priv->page_array_size = new_array_size;
288 while (fw_priv->nr_pages < pages_needed) {
289 fw_priv->pages[fw_priv->nr_pages] =
290 alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
292 if (!fw_priv->pages[fw_priv->nr_pages]) {
293 fw_load_abort(fw_priv);
302 * firmware_data_write - write method for firmware
303 * @kobj: kobject for the device
304 * @bin_attr: bin_attr structure
305 * @buffer: buffer being written
306 * @offset: buffer offset for write in total data store area
307 * @count: buffer size
309 * Data written to the 'data' attribute will be later handed to
310 * the driver as a firmware image.
313 firmware_data_write(struct kobject *kobj, struct bin_attribute *bin_attr,
314 char *buffer, loff_t offset, size_t count)
316 struct device *dev = to_dev(kobj);
317 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
321 if (!capable(CAP_SYS_RAWIO))
324 mutex_lock(&fw_lock);
326 if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
330 retval = fw_realloc_buffer(fw_priv, offset + count);
338 int page_nr = offset >> PAGE_SHIFT;
339 int page_ofs = offset & (PAGE_SIZE - 1);
340 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
342 page_data = kmap(fw_priv->pages[page_nr]);
344 memcpy(page_data + page_ofs, buffer, page_cnt);
346 kunmap(fw_priv->pages[page_nr]);
352 fw->size = max_t(size_t, offset, fw->size);
354 mutex_unlock(&fw_lock);
358 static struct bin_attribute firmware_attr_data_tmpl = {
359 .attr = {.name = "data", .mode = 0644},
361 .read = firmware_data_read,
362 .write = firmware_data_write,
365 static void fw_dev_release(struct device *dev)
367 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
370 for (i = 0; i < fw_priv->nr_pages; i++)
371 __free_page(fw_priv->pages[i]);
372 kfree(fw_priv->pages);
373 kfree(fw_priv->fw_id);
377 module_put(THIS_MODULE);
381 firmware_class_timeout(u_long data)
383 struct firmware_priv *fw_priv = (struct firmware_priv *) data;
384 fw_load_abort(fw_priv);
387 static int fw_register_device(struct device **dev_p, const char *fw_name,
388 struct device *device)
391 struct firmware_priv *fw_priv = kzalloc(sizeof(*fw_priv),
393 struct device *f_dev = kzalloc(sizeof(*f_dev), GFP_KERNEL);
397 if (!fw_priv || !f_dev) {
398 dev_err(device, "%s: kmalloc failed\n", __func__);
403 init_completion(&fw_priv->completion);
404 fw_priv->attr_data = firmware_attr_data_tmpl;
405 fw_priv->fw_id = kstrdup(fw_name, GFP_KERNEL);
406 if (!fw_priv->fw_id) {
407 dev_err(device, "%s: Firmware name allocation failed\n",
413 fw_priv->timeout.function = firmware_class_timeout;
414 fw_priv->timeout.data = (u_long) fw_priv;
415 init_timer(&fw_priv->timeout);
417 dev_set_name(f_dev, "%s", dev_name(device));
418 f_dev->parent = device;
419 f_dev->class = &firmware_class;
420 dev_set_drvdata(f_dev, fw_priv);
421 dev_set_uevent_suppress(f_dev, 1);
422 retval = device_register(f_dev);
424 dev_err(device, "%s: device_register failed\n", __func__);
437 static int fw_setup_device(struct firmware *fw, struct device **dev_p,
438 const char *fw_name, struct device *device,
441 struct device *f_dev;
442 struct firmware_priv *fw_priv;
446 retval = fw_register_device(&f_dev, fw_name, device);
450 /* Need to pin this module until class device is destroyed */
451 __module_get(THIS_MODULE);
453 fw_priv = dev_get_drvdata(f_dev);
456 retval = sysfs_create_bin_file(&f_dev->kobj, &fw_priv->attr_data);
458 dev_err(device, "%s: sysfs_create_bin_file failed\n", __func__);
462 retval = device_create_file(f_dev, &dev_attr_loading);
464 dev_err(device, "%s: device_create_file failed\n", __func__);
469 dev_set_uevent_suppress(f_dev, 0);
474 device_unregister(f_dev);
480 _request_firmware(const struct firmware **firmware_p, const char *name,
481 struct device *device, int uevent)
483 struct device *f_dev;
484 struct firmware_priv *fw_priv;
485 struct firmware *firmware;
486 struct builtin_fw *builtin;
492 if (WARN_ON(usermodehelper_is_disabled())) {
493 dev_err(device, "firmware: %s will not be loaded\n", name);
497 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
499 dev_err(device, "%s: kmalloc(struct firmware) failed\n",
505 for (builtin = __start_builtin_fw; builtin != __end_builtin_fw;
507 if (strcmp(name, builtin->name))
509 dev_info(device, "firmware: using built-in firmware %s\n",
511 firmware->size = builtin->size;
512 firmware->data = builtin->data;
517 dev_info(device, "firmware: requesting %s\n", name);
519 retval = fw_setup_device(firmware, &f_dev, name, device, uevent);
523 fw_priv = dev_get_drvdata(f_dev);
526 if (loading_timeout > 0) {
527 fw_priv->timeout.expires = jiffies + loading_timeout * HZ;
528 add_timer(&fw_priv->timeout);
531 kobject_uevent(&f_dev->kobj, KOBJ_ADD);
532 wait_for_completion(&fw_priv->completion);
533 set_bit(FW_STATUS_DONE, &fw_priv->status);
534 del_timer_sync(&fw_priv->timeout);
536 wait_for_completion(&fw_priv->completion);
538 mutex_lock(&fw_lock);
539 if (!fw_priv->fw->size || test_bit(FW_STATUS_ABORT, &fw_priv->status)) {
541 release_firmware(fw_priv->fw);
545 mutex_unlock(&fw_lock);
546 device_unregister(f_dev);
557 * request_firmware: - send firmware request and wait for it
558 * @firmware_p: pointer to firmware image
559 * @name: name of firmware file
560 * @device: device for which firmware is being loaded
562 * @firmware_p will be used to return a firmware image by the name
563 * of @name for device @device.
565 * Should be called from user context where sleeping is allowed.
567 * @name will be used as $FIRMWARE in the uevent environment and
568 * should be distinctive enough not to be confused with any other
569 * firmware image for this or any other device.
572 request_firmware(const struct firmware **firmware_p, const char *name,
573 struct device *device)
576 return _request_firmware(firmware_p, name, device, uevent);
580 * release_firmware: - release the resource associated with a firmware image
581 * @fw: firmware resource to release
584 release_firmware(const struct firmware *fw)
586 struct builtin_fw *builtin;
589 for (builtin = __start_builtin_fw; builtin != __end_builtin_fw;
591 if (fw->data == builtin->data)
594 firmware_free_data(fw);
601 struct firmware_work {
602 struct work_struct work;
603 struct module *module;
605 struct device *device;
607 void (*cont)(const struct firmware *fw, void *context);
612 request_firmware_work_func(void *arg)
614 struct firmware_work *fw_work = arg;
615 const struct firmware *fw;
621 ret = _request_firmware(&fw, fw_work->name, fw_work->device,
624 fw_work->cont(NULL, fw_work->context);
626 fw_work->cont(fw, fw_work->context);
627 release_firmware(fw);
629 module_put(fw_work->module);
635 * request_firmware_nowait: asynchronous version of request_firmware
636 * @module: module requesting the firmware
637 * @uevent: sends uevent to copy the firmware image if this flag
638 * is non-zero else the firmware copy must be done manually.
639 * @name: name of firmware file
640 * @device: device for which firmware is being loaded
641 * @context: will be passed over to @cont, and
642 * @fw may be %NULL if firmware request fails.
643 * @cont: function will be called asynchronously when the firmware
646 * Asynchronous variant of request_firmware() for user contexts where
647 * it is not possible to sleep for long time. It can't be called
648 * in atomic contexts.
651 request_firmware_nowait(
652 struct module *module, int uevent,
653 const char *name, struct device *device, void *context,
654 void (*cont)(const struct firmware *fw, void *context))
656 struct task_struct *task;
657 struct firmware_work *fw_work = kmalloc(sizeof (struct firmware_work),
662 if (!try_module_get(module)) {
667 *fw_work = (struct firmware_work) {
676 task = kthread_run(request_firmware_work_func, fw_work,
677 "firmware/%s", name);
680 fw_work->cont(NULL, fw_work->context);
681 module_put(fw_work->module);
683 return PTR_ERR(task);
689 firmware_class_init(void)
692 error = class_register(&firmware_class);
694 printk(KERN_ERR "%s: class_register failed\n", __func__);
697 error = class_create_file(&firmware_class, &class_attr_timeout);
699 printk(KERN_ERR "%s: class_create_file failed\n",
701 class_unregister(&firmware_class);
707 firmware_class_exit(void)
709 class_unregister(&firmware_class);
712 fs_initcall(firmware_class_init);
713 module_exit(firmware_class_exit);
715 EXPORT_SYMBOL(release_firmware);
716 EXPORT_SYMBOL(request_firmware);
717 EXPORT_SYMBOL(request_firmware_nowait);