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");
30 /* Builtin firmware support */
32 #ifdef CONFIG_FW_LOADER
34 extern struct builtin_fw __start_builtin_fw[];
35 extern struct builtin_fw __end_builtin_fw[];
37 static bool fw_get_builtin_firmware(struct firmware *fw, const char *name)
39 struct builtin_fw *b_fw;
41 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++) {
42 if (strcmp(name, b_fw->name) == 0) {
43 fw->size = b_fw->size;
44 fw->data = b_fw->data;
52 static bool fw_is_builtin_firmware(const struct firmware *fw)
54 struct builtin_fw *b_fw;
56 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++)
57 if (fw->data == b_fw->data)
63 #else /* Module case - no builtin firmware support */
65 static inline bool fw_get_builtin_firmware(struct firmware *fw, const char *name)
70 static inline bool fw_is_builtin_firmware(const struct firmware *fw)
82 static int loading_timeout = 60; /* In seconds */
84 /* fw_lock could be moved to 'struct firmware_priv' but since it is just
85 * guarding for corner cases a global lock should be OK */
86 static DEFINE_MUTEX(fw_lock);
88 struct firmware_priv {
89 struct completion completion;
95 struct timer_list timeout;
101 fw_load_abort(struct firmware_priv *fw_priv)
103 set_bit(FW_STATUS_ABORT, &fw_priv->status);
105 complete(&fw_priv->completion);
109 firmware_timeout_show(struct class *class,
110 struct class_attribute *attr,
113 return sprintf(buf, "%d\n", loading_timeout);
117 * firmware_timeout_store - set number of seconds to wait for firmware
118 * @class: device class pointer
119 * @attr: device attribute pointer
120 * @buf: buffer to scan for timeout value
121 * @count: number of bytes in @buf
123 * Sets the number of seconds to wait for the firmware. Once
124 * this expires an error will be returned to the driver and no
125 * firmware will be provided.
127 * Note: zero means 'wait forever'.
130 firmware_timeout_store(struct class *class,
131 struct class_attribute *attr,
132 const char *buf, size_t count)
134 loading_timeout = simple_strtol(buf, NULL, 10);
135 if (loading_timeout < 0)
140 static struct class_attribute firmware_class_attrs[] = {
141 __ATTR(timeout, S_IWUSR | S_IRUGO,
142 firmware_timeout_show, firmware_timeout_store),
146 static void fw_dev_release(struct device *dev)
148 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
151 for (i = 0; i < fw_priv->nr_pages; i++)
152 __free_page(fw_priv->pages[i]);
153 kfree(fw_priv->pages);
157 module_put(THIS_MODULE);
160 static int firmware_uevent(struct device *dev, struct kobj_uevent_env *env)
162 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
164 if (add_uevent_var(env, "FIRMWARE=%s", fw_priv->fw_id))
166 if (add_uevent_var(env, "TIMEOUT=%i", loading_timeout))
168 if (add_uevent_var(env, "ASYNC=%d", fw_priv->nowait))
174 static struct class firmware_class = {
176 .class_attrs = firmware_class_attrs,
177 .dev_uevent = firmware_uevent,
178 .dev_release = fw_dev_release,
181 static ssize_t firmware_loading_show(struct device *dev,
182 struct device_attribute *attr, char *buf)
184 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
185 int loading = test_bit(FW_STATUS_LOADING, &fw_priv->status);
186 return sprintf(buf, "%d\n", loading);
189 static void firmware_free_data(const struct firmware *fw)
194 for (i = 0; i < PFN_UP(fw->size); i++)
195 __free_page(fw->pages[i]);
200 /* Some architectures don't have PAGE_KERNEL_RO */
201 #ifndef PAGE_KERNEL_RO
202 #define PAGE_KERNEL_RO PAGE_KERNEL
205 * firmware_loading_store - set value in the 'loading' control file
206 * @dev: device pointer
207 * @attr: device attribute pointer
208 * @buf: buffer to scan for loading control value
209 * @count: number of bytes in @buf
211 * The relevant values are:
213 * 1: Start a load, discarding any previous partial load.
214 * 0: Conclude the load and hand the data to the driver code.
215 * -1: Conclude the load with an error and discard any written data.
217 static ssize_t firmware_loading_store(struct device *dev,
218 struct device_attribute *attr,
219 const char *buf, size_t count)
221 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
222 int loading = simple_strtol(buf, NULL, 10);
227 mutex_lock(&fw_lock);
229 mutex_unlock(&fw_lock);
232 firmware_free_data(fw_priv->fw);
233 memset(fw_priv->fw, 0, sizeof(struct firmware));
234 /* If the pages are not owned by 'struct firmware' */
235 for (i = 0; i < fw_priv->nr_pages; i++)
236 __free_page(fw_priv->pages[i]);
237 kfree(fw_priv->pages);
238 fw_priv->pages = NULL;
239 fw_priv->page_array_size = 0;
240 fw_priv->nr_pages = 0;
241 set_bit(FW_STATUS_LOADING, &fw_priv->status);
242 mutex_unlock(&fw_lock);
245 if (test_bit(FW_STATUS_LOADING, &fw_priv->status)) {
246 vunmap(fw_priv->fw->data);
247 fw_priv->fw->data = vmap(fw_priv->pages,
250 if (!fw_priv->fw->data) {
251 dev_err(dev, "%s: vmap() failed\n", __func__);
254 /* Pages are now owned by 'struct firmware' */
255 fw_priv->fw->pages = fw_priv->pages;
256 fw_priv->pages = NULL;
258 fw_priv->page_array_size = 0;
259 fw_priv->nr_pages = 0;
260 complete(&fw_priv->completion);
261 clear_bit(FW_STATUS_LOADING, &fw_priv->status);
266 dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading);
270 fw_load_abort(fw_priv);
277 static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store);
280 firmware_data_read(struct file *filp, struct kobject *kobj,
281 struct bin_attribute *bin_attr, char *buffer, loff_t offset,
284 struct device *dev = to_dev(kobj);
285 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
289 mutex_lock(&fw_lock);
291 if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
295 if (offset > fw->size) {
299 if (count > fw->size - offset)
300 count = fw->size - offset;
306 int page_nr = offset >> PAGE_SHIFT;
307 int page_ofs = offset & (PAGE_SIZE-1);
308 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
310 page_data = kmap(fw_priv->pages[page_nr]);
312 memcpy(buffer, page_data + page_ofs, page_cnt);
314 kunmap(fw_priv->pages[page_nr]);
320 mutex_unlock(&fw_lock);
325 fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
327 int pages_needed = ALIGN(min_size, PAGE_SIZE) >> PAGE_SHIFT;
329 /* If the array of pages is too small, grow it... */
330 if (fw_priv->page_array_size < pages_needed) {
331 int new_array_size = max(pages_needed,
332 fw_priv->page_array_size * 2);
333 struct page **new_pages;
335 new_pages = kmalloc(new_array_size * sizeof(void *),
338 fw_load_abort(fw_priv);
341 memcpy(new_pages, fw_priv->pages,
342 fw_priv->page_array_size * sizeof(void *));
343 memset(&new_pages[fw_priv->page_array_size], 0, sizeof(void *) *
344 (new_array_size - fw_priv->page_array_size));
345 kfree(fw_priv->pages);
346 fw_priv->pages = new_pages;
347 fw_priv->page_array_size = new_array_size;
350 while (fw_priv->nr_pages < pages_needed) {
351 fw_priv->pages[fw_priv->nr_pages] =
352 alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
354 if (!fw_priv->pages[fw_priv->nr_pages]) {
355 fw_load_abort(fw_priv);
364 * firmware_data_write - write method for firmware
365 * @filp: open sysfs file
366 * @kobj: kobject for the device
367 * @bin_attr: bin_attr structure
368 * @buffer: buffer being written
369 * @offset: buffer offset for write in total data store area
370 * @count: buffer size
372 * Data written to the 'data' attribute will be later handed to
373 * the driver as a firmware image.
376 firmware_data_write(struct file* filp, struct kobject *kobj,
377 struct bin_attribute *bin_attr, char *buffer,
378 loff_t offset, size_t count)
380 struct device *dev = to_dev(kobj);
381 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
385 if (!capable(CAP_SYS_RAWIO))
388 mutex_lock(&fw_lock);
390 if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
394 retval = fw_realloc_buffer(fw_priv, offset + count);
402 int page_nr = offset >> PAGE_SHIFT;
403 int page_ofs = offset & (PAGE_SIZE - 1);
404 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
406 page_data = kmap(fw_priv->pages[page_nr]);
408 memcpy(page_data + page_ofs, buffer, page_cnt);
410 kunmap(fw_priv->pages[page_nr]);
416 fw->size = max_t(size_t, offset, fw->size);
418 mutex_unlock(&fw_lock);
422 static struct bin_attribute firmware_attr_data = {
423 .attr = { .name = "data", .mode = 0644 },
425 .read = firmware_data_read,
426 .write = firmware_data_write,
430 firmware_class_timeout(u_long data)
432 struct firmware_priv *fw_priv = (struct firmware_priv *) data;
433 fw_load_abort(fw_priv);
436 static int fw_register_device(struct device **dev_p, const char *fw_name,
437 struct device *device)
440 struct firmware_priv *fw_priv =
441 kzalloc(sizeof(*fw_priv) + strlen(fw_name) + 1 , GFP_KERNEL);
442 struct device *f_dev = kzalloc(sizeof(*f_dev), GFP_KERNEL);
446 if (!fw_priv || !f_dev) {
447 dev_err(device, "%s: kmalloc failed\n", __func__);
452 strcpy(fw_priv->fw_id, fw_name);
453 init_completion(&fw_priv->completion);
454 fw_priv->timeout.function = firmware_class_timeout;
455 fw_priv->timeout.data = (u_long) fw_priv;
456 init_timer(&fw_priv->timeout);
458 dev_set_name(f_dev, "%s", dev_name(device));
459 f_dev->parent = device;
460 f_dev->class = &firmware_class;
461 dev_set_drvdata(f_dev, fw_priv);
462 dev_set_uevent_suppress(f_dev, 1);
463 retval = device_register(f_dev);
465 dev_err(device, "%s: device_register failed\n", __func__);
478 static int fw_setup_device(struct firmware *fw, struct device **dev_p,
479 const char *fw_name, struct device *device,
480 int uevent, bool nowait)
482 struct device *f_dev;
483 struct firmware_priv *fw_priv;
487 retval = fw_register_device(&f_dev, fw_name, device);
491 /* Need to pin this module until class device is destroyed */
492 __module_get(THIS_MODULE);
494 fw_priv = dev_get_drvdata(f_dev);
496 fw_priv->nowait = nowait;
499 retval = sysfs_create_bin_file(&f_dev->kobj, &firmware_attr_data);
501 dev_err(device, "%s: sysfs_create_bin_file failed\n", __func__);
505 retval = device_create_file(f_dev, &dev_attr_loading);
507 dev_err(device, "%s: device_create_file failed\n", __func__);
512 dev_set_uevent_suppress(f_dev, 0);
517 device_unregister(f_dev);
523 _request_firmware(const struct firmware **firmware_p, const char *name,
524 struct device *device, int uevent, bool nowait)
526 struct device *f_dev;
527 struct firmware_priv *fw_priv;
528 struct firmware *firmware;
534 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
536 dev_err(device, "%s: kmalloc(struct firmware) failed\n",
542 if (fw_get_builtin_firmware(firmware, name)) {
543 dev_dbg(device, "firmware: using built-in firmware %s\n", name);
548 dev_dbg(device, "firmware: requesting %s\n", name);
550 retval = fw_setup_device(firmware, &f_dev, name, device,
555 fw_priv = dev_get_drvdata(f_dev);
558 if (loading_timeout > 0) {
559 fw_priv->timeout.expires = jiffies + loading_timeout * HZ;
560 add_timer(&fw_priv->timeout);
563 kobject_uevent(&f_dev->kobj, KOBJ_ADD);
564 wait_for_completion(&fw_priv->completion);
565 set_bit(FW_STATUS_DONE, &fw_priv->status);
566 del_timer_sync(&fw_priv->timeout);
568 wait_for_completion(&fw_priv->completion);
570 mutex_lock(&fw_lock);
571 if (!fw_priv->fw->size || test_bit(FW_STATUS_ABORT, &fw_priv->status)) {
573 release_firmware(fw_priv->fw);
577 mutex_unlock(&fw_lock);
578 device_unregister(f_dev);
589 * request_firmware: - send firmware request and wait for it
590 * @firmware_p: pointer to firmware image
591 * @name: name of firmware file
592 * @device: device for which firmware is being loaded
594 * @firmware_p will be used to return a firmware image by the name
595 * of @name for device @device.
597 * Should be called from user context where sleeping is allowed.
599 * @name will be used as $FIRMWARE in the uevent environment and
600 * should be distinctive enough not to be confused with any other
601 * firmware image for this or any other device.
604 request_firmware(const struct firmware **firmware_p, const char *name,
605 struct device *device)
608 return _request_firmware(firmware_p, name, device, uevent, false);
612 * release_firmware: - release the resource associated with a firmware image
613 * @fw: firmware resource to release
615 void release_firmware(const struct firmware *fw)
618 if (!fw_is_builtin_firmware(fw))
619 firmware_free_data(fw);
625 struct firmware_work {
626 struct work_struct work;
627 struct module *module;
629 struct device *device;
631 void (*cont)(const struct firmware *fw, void *context);
636 request_firmware_work_func(void *arg)
638 struct firmware_work *fw_work = arg;
639 const struct firmware *fw;
645 ret = _request_firmware(&fw, fw_work->name, fw_work->device,
646 fw_work->uevent, true);
648 fw_work->cont(fw, fw_work->context);
650 module_put(fw_work->module);
656 * request_firmware_nowait - asynchronous version of request_firmware
657 * @module: module requesting the firmware
658 * @uevent: sends uevent to copy the firmware image if this flag
659 * is non-zero else the firmware copy must be done manually.
660 * @name: name of firmware file
661 * @device: device for which firmware is being loaded
662 * @gfp: allocation flags
663 * @context: will be passed over to @cont, and
664 * @fw may be %NULL if firmware request fails.
665 * @cont: function will be called asynchronously when the firmware
668 * Asynchronous variant of request_firmware() for user contexts where
669 * it is not possible to sleep for long time. It can't be called
670 * in atomic contexts.
673 request_firmware_nowait(
674 struct module *module, int uevent,
675 const char *name, struct device *device, gfp_t gfp, void *context,
676 void (*cont)(const struct firmware *fw, void *context))
678 struct task_struct *task;
679 struct firmware_work *fw_work = kmalloc(sizeof (struct firmware_work),
684 if (!try_module_get(module)) {
689 *fw_work = (struct firmware_work) {
698 task = kthread_run(request_firmware_work_func, fw_work,
699 "firmware/%s", name);
702 fw_work->cont(NULL, fw_work->context);
703 module_put(fw_work->module);
705 return PTR_ERR(task);
710 static int __init firmware_class_init(void)
712 return class_register(&firmware_class);
715 static void __exit firmware_class_exit(void)
717 class_unregister(&firmware_class);
720 fs_initcall(firmware_class_init);
721 module_exit(firmware_class_exit);
723 EXPORT_SYMBOL(release_firmware);
724 EXPORT_SYMBOL(request_firmware);
725 EXPORT_SYMBOL(request_firmware_nowait);