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>
23 #define to_dev(obj) container_of(obj, struct device, kobj)
25 MODULE_AUTHOR("Manuel Estrada Sainz");
26 MODULE_DESCRIPTION("Multi purpose firmware loading support");
27 MODULE_LICENSE("GPL");
35 static int loading_timeout = 60; /* In seconds */
37 /* fw_lock could be moved to 'struct firmware_priv' but since it is just
38 * guarding for corner cases a global lock should be OK */
39 static DEFINE_MUTEX(fw_lock);
41 struct firmware_priv {
43 struct completion completion;
44 struct bin_attribute attr_data;
51 struct timer_list timeout;
54 //#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 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24))
103 static int firmware_uevent(struct device *dev, struct kobj_uevent_env *env)
105 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
107 if (add_uevent_var(env, "FIRMWARE=%s", fw_priv->fw_id))
109 if (add_uevent_var(env, "TIMEOUT=%i", loading_timeout))
115 static int firmware_uevent(struct device *dev, char **envp,
116 int num_envp, char *buf, int size)
118 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
119 int error, len = 0, i = 0;
121 error = add_uevent_var(envp, num_envp, &i,
123 "FIRMWARE=%s", fw_priv->fw_id);
127 error = add_uevent_var(envp, num_envp, &i,
129 "TIMEOUT=%i", loading_timeout);
140 static struct class firmware_class = {
141 .name = "compat_firmware",
142 .dev_uevent = firmware_uevent,
143 .dev_release = fw_dev_release,
146 static ssize_t firmware_loading_show(struct device *dev,
147 struct device_attribute *attr, char *buf)
149 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
150 int loading = test_bit(FW_STATUS_LOADING, &fw_priv->status);
151 return sprintf(buf, "%d\n", loading);
154 /* Some architectures don't have PAGE_KERNEL_RO */
155 #ifndef PAGE_KERNEL_RO
156 #define PAGE_KERNEL_RO PAGE_KERNEL
159 * firmware_loading_store - set value in the 'loading' control file
160 * @dev: device pointer
161 * @attr: device attribute pointer
162 * @buf: buffer to scan for loading control value
163 * @count: number of bytes in @buf
165 * The relevant values are:
167 * 1: Start a load, discarding any previous partial load.
168 * 0: Conclude the load and hand the data to the driver code.
169 * -1: Conclude the load with an error and discard any written data.
171 static ssize_t firmware_loading_store(struct device *dev,
172 struct device_attribute *attr,
173 const char *buf, size_t count)
175 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
176 int loading = simple_strtol(buf, NULL, 10);
181 mutex_lock(&fw_lock);
183 mutex_unlock(&fw_lock);
186 vfree(fw_priv->fw->data);
187 fw_priv->fw->data = NULL;
188 for (i = 0; i < fw_priv->nr_pages; i++)
189 __free_page(fw_priv->pages[i]);
190 kfree(fw_priv->pages);
191 fw_priv->pages = NULL;
192 fw_priv->page_array_size = 0;
193 fw_priv->nr_pages = 0;
194 fw_priv->fw->size = 0;
195 set_bit(FW_STATUS_LOADING, &fw_priv->status);
196 mutex_unlock(&fw_lock);
199 if (test_bit(FW_STATUS_LOADING, &fw_priv->status)) {
200 vfree(fw_priv->fw->data);
201 fw_priv->fw->data = vmap(fw_priv->pages,
204 if (!fw_priv->fw->data) {
205 dev_err(dev, "%s: vmap() failed\n", __func__);
208 /* Pages will be freed by vfree() */
209 fw_priv->page_array_size = 0;
210 fw_priv->nr_pages = 0;
211 complete(&fw_priv->completion);
212 clear_bit(FW_STATUS_LOADING, &fw_priv->status);
217 dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading);
221 fw_load_abort(fw_priv);
228 static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store);
231 firmware_data_read(struct kobject *kobj, struct bin_attribute *bin_attr,
232 char *buffer, loff_t offset, size_t count)
234 struct device *dev = to_dev(kobj);
235 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
239 mutex_lock(&fw_lock);
241 if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
245 if (offset > fw->size) {
249 if (count > fw->size - offset)
250 count = fw->size - offset;
256 int page_nr = offset >> PAGE_SHIFT;
257 int page_ofs = offset & (PAGE_SIZE-1);
258 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
260 page_data = kmap(fw_priv->pages[page_nr]);
262 memcpy(buffer, page_data + page_ofs, page_cnt);
264 kunmap(fw_priv->pages[page_nr]);
270 mutex_unlock(&fw_lock);
275 fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
277 int pages_needed = ALIGN(min_size, PAGE_SIZE) >> PAGE_SHIFT;
279 /* If the array of pages is too small, grow it... */
280 if (fw_priv->page_array_size < pages_needed) {
281 int new_array_size = max(pages_needed,
282 fw_priv->page_array_size * 2);
283 struct page **new_pages;
285 new_pages = kmalloc(new_array_size * sizeof(void *),
288 fw_load_abort(fw_priv);
291 memcpy(new_pages, fw_priv->pages,
292 fw_priv->page_array_size * sizeof(void *));
293 memset(&new_pages[fw_priv->page_array_size], 0, sizeof(void *) *
294 (new_array_size - fw_priv->page_array_size));
295 kfree(fw_priv->pages);
296 fw_priv->pages = new_pages;
297 fw_priv->page_array_size = new_array_size;
300 while (fw_priv->nr_pages < pages_needed) {
301 fw_priv->pages[fw_priv->nr_pages] =
302 alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
304 if (!fw_priv->pages[fw_priv->nr_pages]) {
305 fw_load_abort(fw_priv);
314 * firmware_data_write - write method for firmware
315 * @kobj: kobject for the device
316 * @bin_attr: bin_attr structure
317 * @buffer: buffer being written
318 * @offset: buffer offset for write in total data store area
319 * @count: buffer size
321 * Data written to the 'data' attribute will be later handed to
322 * the driver as a firmware image.
325 firmware_data_write(struct kobject *kobj, struct bin_attribute *bin_attr,
326 char *buffer, loff_t offset, size_t count)
328 struct device *dev = to_dev(kobj);
329 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
333 if (!capable(CAP_SYS_RAWIO))
336 mutex_lock(&fw_lock);
338 if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
342 retval = fw_realloc_buffer(fw_priv, offset + count);
350 int page_nr = offset >> PAGE_SHIFT;
351 int page_ofs = offset & (PAGE_SIZE - 1);
352 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
354 page_data = kmap(fw_priv->pages[page_nr]);
356 memcpy(page_data + page_ofs, buffer, page_cnt);
358 kunmap(fw_priv->pages[page_nr]);
364 fw->size = max_t(size_t, offset, fw->size);
366 mutex_unlock(&fw_lock);
370 static struct bin_attribute firmware_attr_data_tmpl = {
371 .attr = {.name = "data", .mode = 0644},
373 .read = firmware_data_read,
374 .write = firmware_data_write,
377 static void fw_dev_release(struct device *dev)
379 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
382 for (i = 0; i < fw_priv->nr_pages; i++)
383 __free_page(fw_priv->pages[i]);
384 kfree(fw_priv->pages);
385 kfree(fw_priv->fw_id);
389 module_put(THIS_MODULE);
393 firmware_class_timeout(u_long data)
395 struct firmware_priv *fw_priv = (struct firmware_priv *) data;
396 fw_load_abort(fw_priv);
399 static int fw_register_device(struct device **dev_p, const char *fw_name,
400 struct device *device)
403 struct firmware_priv *fw_priv = kzalloc(sizeof(*fw_priv),
405 struct device *f_dev = kzalloc(sizeof(*f_dev), GFP_KERNEL);
409 if (!fw_priv || !f_dev) {
410 dev_err(device, "%s: kmalloc failed\n", __func__);
415 init_completion(&fw_priv->completion);
416 fw_priv->attr_data = firmware_attr_data_tmpl;
417 fw_priv->fw_id = kstrdup(fw_name, GFP_KERNEL);
418 if (!fw_priv->fw_id) {
419 dev_err(device, "%s: Firmware name allocation failed\n",
425 fw_priv->timeout.function = firmware_class_timeout;
426 fw_priv->timeout.data = (u_long) fw_priv;
427 init_timer(&fw_priv->timeout);
429 dev_set_name(f_dev, "%s", dev_name(device));
430 f_dev->parent = device;
431 f_dev->class = &firmware_class;
432 dev_set_drvdata(f_dev, fw_priv);
433 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,30))
434 dev_set_uevent_suppress(f_dev, 1);
436 f_dev->uevent_suppress = 1;
438 retval = device_register(f_dev);
440 dev_err(device, "%s: device_register failed\n", __func__);
453 static int fw_setup_device(struct firmware *fw, struct device **dev_p,
454 const char *fw_name, struct device *device,
457 struct device *f_dev;
458 struct firmware_priv *fw_priv;
462 retval = fw_register_device(&f_dev, fw_name, device);
466 /* Need to pin this module until class device is destroyed */
467 __module_get(THIS_MODULE);
469 fw_priv = dev_get_drvdata(f_dev);
472 retval = sysfs_create_bin_file(&f_dev->kobj, &fw_priv->attr_data);
474 dev_err(device, "%s: sysfs_create_bin_file failed\n", __func__);
478 retval = device_create_file(f_dev, &dev_attr_loading);
480 dev_err(device, "%s: device_create_file failed\n", __func__);
485 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,30))
486 dev_set_uevent_suppress(f_dev, 0);
488 f_dev->uevent_suppress = 0;
494 device_unregister(f_dev);
500 _request_firmware(const struct firmware **firmware_p, const char *name,
501 struct device *device, int uevent)
503 struct device *f_dev;
504 struct firmware_priv *fw_priv;
505 struct firmware *firmware;
506 struct builtin_fw *builtin;
512 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
514 dev_err(device, "%s: kmalloc(struct firmware) failed\n",
520 for (builtin = __start_builtin_fw; builtin != __end_builtin_fw;
522 if (strcmp(name, builtin->name))
524 dev_info(device, "firmware: using built-in firmware %s\n",
526 firmware->size = builtin->size;
527 firmware->data = builtin->data;
532 dev_info(device, "firmware: requesting %s\n", name);
534 retval = fw_setup_device(firmware, &f_dev, name, device, uevent);
538 fw_priv = dev_get_drvdata(f_dev);
541 if (loading_timeout > 0) {
542 fw_priv->timeout.expires = jiffies + loading_timeout * HZ;
543 add_timer(&fw_priv->timeout);
546 kobject_uevent(&f_dev->kobj, KOBJ_ADD);
547 wait_for_completion(&fw_priv->completion);
548 set_bit(FW_STATUS_DONE, &fw_priv->status);
549 del_timer_sync(&fw_priv->timeout);
551 wait_for_completion(&fw_priv->completion);
553 mutex_lock(&fw_lock);
554 if (!fw_priv->fw->size || test_bit(FW_STATUS_ABORT, &fw_priv->status)) {
556 release_firmware(fw_priv->fw);
560 mutex_unlock(&fw_lock);
561 device_unregister(f_dev);
572 * request_firmware: - send firmware request and wait for it
573 * @firmware_p: pointer to firmware image
574 * @name: name of firmware file
575 * @device: device for which firmware is being loaded
577 * @firmware_p will be used to return a firmware image by the name
578 * of @name for device @device.
580 * Should be called from user context where sleeping is allowed.
582 * @name will be used as $FIRMWARE in the uevent environment and
583 * should be distinctive enough not to be confused with any other
584 * firmware image for this or any other device.
587 request_firmware(const struct firmware **firmware_p, const char *name,
588 struct device *device)
591 return _request_firmware(firmware_p, name, device, uevent);
595 * release_firmware: - release the resource associated with a firmware image
596 * @fw: firmware resource to release
599 release_firmware(const struct firmware *fw)
601 struct builtin_fw *builtin;
604 for (builtin = __start_builtin_fw; builtin != __end_builtin_fw;
606 if (fw->data == builtin->data)
616 struct firmware_work {
617 struct work_struct work;
618 struct module *module;
620 struct device *device;
622 void (*cont)(const struct firmware *fw, void *context);
627 request_firmware_work_func(void *arg)
629 struct firmware_work *fw_work = arg;
630 const struct firmware *fw;
636 ret = _request_firmware(&fw, fw_work->name, fw_work->device,
639 fw_work->cont(fw, fw_work->context);
641 module_put(fw_work->module);
647 * request_firmware_nowait: asynchronous version of request_firmware
648 * @module: module requesting the firmware
649 * @uevent: sends uevent to copy the firmware image if this flag
650 * is non-zero else the firmware copy must be done manually.
651 * @name: name of firmware file
652 * @device: device for which firmware is being loaded
653 * @gfp: allocation flags
654 * @context: will be passed over to @cont, and
655 * @fw may be %NULL if firmware request fails.
656 * @cont: function will be called asynchronously when the firmware
659 * Asynchronous variant of request_firmware() for user contexts where
660 * it is not possible to sleep for long time. It can't be called
661 * in atomic contexts.
664 request_firmware_nowait(
665 struct module *module, int uevent,
666 const char *name, struct device *device, gfp_t gfp, void *context,
667 void (*cont)(const struct firmware *fw, void *context))
669 struct task_struct *task;
670 struct firmware_work *fw_work = kmalloc(sizeof (struct firmware_work),
675 if (!try_module_get(module)) {
680 *fw_work = (struct firmware_work) {
689 task = kthread_run(request_firmware_work_func, fw_work,
690 "firmware/%s", name);
693 fw_work->cont(NULL, fw_work->context);
694 module_put(fw_work->module);
696 return PTR_ERR(task);
702 firmware_class_init(void)
705 error = class_register(&firmware_class);
707 printk(KERN_ERR "%s: class_register failed\n", __func__);
710 error = class_create_file(&firmware_class, &class_attr_timeout);
712 printk(KERN_ERR "%s: class_create_file failed\n",
714 class_unregister(&firmware_class);
720 firmware_class_exit(void)
722 class_unregister(&firmware_class);
725 fs_initcall(firmware_class_init);
726 module_exit(firmware_class_exit);
728 EXPORT_SYMBOL(release_firmware);
729 EXPORT_SYMBOL(request_firmware);
730 EXPORT_SYMBOL(request_firmware_nowait);