blob: 97ab5bd1c4d62ebb72ef9babc07f2c35571c484b [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * firmware_class.c - Multi purpose firmware loading support
3 *
4 * Copyright (c) 2003 Manuel Estrada Sainz <ranty@debian.org>
5 *
6 * Please see Documentation/firmware_class/ for more information.
7 *
8 */
9
Randy.Dunlapc59ede72006-01-11 12:17:46 -080010#include <linux/capability.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#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>
Laura Garciacad1e552006-05-23 23:22:38 +020018#include <linux/mutex.h>
Sukadev Bhattiprolu563d0752006-09-29 01:59:31 -070019#include <linux/kthread.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21#include <linux/firmware.h>
22#include "base.h"
23
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -070024#define to_dev(obj) container_of(obj, struct device, kobj)
25
Linus Torvalds1da177e2005-04-16 15:20:36 -070026MODULE_AUTHOR("Manuel Estrada Sainz <ranty@debian.org>");
27MODULE_DESCRIPTION("Multi purpose firmware loading support");
28MODULE_LICENSE("GPL");
29
30enum {
31 FW_STATUS_LOADING,
32 FW_STATUS_DONE,
33 FW_STATUS_ABORT,
Linus Torvalds1da177e2005-04-16 15:20:36 -070034};
35
Dave Jones2f651682007-01-25 15:56:15 -050036static int loading_timeout = 60; /* In seconds */
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
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 */
Laura Garciacad1e552006-05-23 23:22:38 +020040static DEFINE_MUTEX(fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
42struct firmware_priv {
43 char fw_id[FIRMWARE_NAME_MAX];
44 struct completion completion;
45 struct bin_attribute attr_data;
46 struct firmware *fw;
47 unsigned long status;
48 int alloc_size;
49 struct timer_list timeout;
50};
51
Arjan van de Ven858119e2006-01-14 13:20:43 -080052static void
Linus Torvalds1da177e2005-04-16 15:20:36 -070053fw_load_abort(struct firmware_priv *fw_priv)
54{
55 set_bit(FW_STATUS_ABORT, &fw_priv->status);
56 wmb();
57 complete(&fw_priv->completion);
58}
59
60static ssize_t
61firmware_timeout_show(struct class *class, char *buf)
62{
63 return sprintf(buf, "%d\n", loading_timeout);
64}
65
66/**
Randy Dunlapeb8e3172005-10-30 15:03:01 -080067 * firmware_timeout_store - set number of seconds to wait for firmware
68 * @class: device class pointer
69 * @buf: buffer to scan for timeout value
70 * @count: number of bytes in @buf
71 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 * Sets the number of seconds to wait for the firmware. Once
Randy Dunlapeb8e3172005-10-30 15:03:01 -080073 * this expires an error will be returned to the driver and no
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 * firmware will be provided.
75 *
Randy Dunlapeb8e3172005-10-30 15:03:01 -080076 * Note: zero means 'wait forever'.
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 **/
78static ssize_t
79firmware_timeout_store(struct class *class, const char *buf, size_t count)
80{
81 loading_timeout = simple_strtol(buf, NULL, 10);
Stanislaw W. Gruszkab92eac02005-06-28 20:44:51 -070082 if (loading_timeout < 0)
83 loading_timeout = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 return count;
85}
86
87static CLASS_ATTR(timeout, 0644, firmware_timeout_show, firmware_timeout_store);
88
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -070089static void fw_dev_release(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -070091static int firmware_uevent(struct device *dev, char **envp, int num_envp,
92 char *buffer, int buffer_size)
Linus Torvalds1da177e2005-04-16 15:20:36 -070093{
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -070094 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 int i = 0, len = 0;
96
Kay Sievers312c0042005-11-16 09:00:00 +010097 if (add_uevent_var(envp, num_envp, &i, buffer, buffer_size, &len,
98 "FIRMWARE=%s", fw_priv->fw_id))
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 return -ENOMEM;
Kay Sievers312c0042005-11-16 09:00:00 +0100100 if (add_uevent_var(envp, num_envp, &i, buffer, buffer_size, &len,
101 "TIMEOUT=%i", loading_timeout))
kay.sievers@vrfy.org68970892005-04-18 21:57:31 -0700102 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 envp[i] = NULL;
104
105 return 0;
106}
107
Adrian Bunk1b81d662006-05-20 15:00:16 -0700108static struct class firmware_class = {
109 .name = "firmware",
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700110 .dev_uevent = firmware_uevent,
111 .dev_release = fw_dev_release,
Adrian Bunk1b81d662006-05-20 15:00:16 -0700112};
113
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700114static ssize_t firmware_loading_show(struct device *dev,
115 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116{
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700117 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 int loading = test_bit(FW_STATUS_LOADING, &fw_priv->status);
119 return sprintf(buf, "%d\n", loading);
120}
121
122/**
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800123 * firmware_loading_store - set value in the 'loading' control file
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700124 * @dev: device pointer
Randy Dunlapaf9997e2006-12-22 01:06:52 -0800125 * @attr: device attribute pointer
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800126 * @buf: buffer to scan for loading control value
127 * @count: number of bytes in @buf
128 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 * The relevant values are:
130 *
131 * 1: Start a load, discarding any previous partial load.
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800132 * 0: Conclude the load and hand the data to the driver code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 * -1: Conclude the load with an error and discard any written data.
134 **/
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700135static ssize_t firmware_loading_store(struct device *dev,
136 struct device_attribute *attr,
137 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138{
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700139 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 int loading = simple_strtol(buf, NULL, 10);
141
142 switch (loading) {
143 case 1:
Laura Garciacad1e552006-05-23 23:22:38 +0200144 mutex_lock(&fw_lock);
Stanislaw W. Gruszkab92eac02005-06-28 20:44:51 -0700145 if (!fw_priv->fw) {
Laura Garciacad1e552006-05-23 23:22:38 +0200146 mutex_unlock(&fw_lock);
Stanislaw W. Gruszkab92eac02005-06-28 20:44:51 -0700147 break;
148 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 vfree(fw_priv->fw->data);
150 fw_priv->fw->data = NULL;
151 fw_priv->fw->size = 0;
152 fw_priv->alloc_size = 0;
153 set_bit(FW_STATUS_LOADING, &fw_priv->status);
Laura Garciacad1e552006-05-23 23:22:38 +0200154 mutex_unlock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 break;
156 case 0:
157 if (test_bit(FW_STATUS_LOADING, &fw_priv->status)) {
158 complete(&fw_priv->completion);
159 clear_bit(FW_STATUS_LOADING, &fw_priv->status);
160 break;
161 }
162 /* fallthrough */
163 default:
164 printk(KERN_ERR "%s: unexpected value (%d)\n", __FUNCTION__,
165 loading);
166 /* fallthrough */
167 case -1:
168 fw_load_abort(fw_priv);
169 break;
170 }
171
172 return count;
173}
174
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700175static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177static ssize_t
178firmware_data_read(struct kobject *kobj,
179 char *buffer, loff_t offset, size_t count)
180{
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700181 struct device *dev = to_dev(kobj);
182 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 struct firmware *fw;
184 ssize_t ret_count = count;
185
Laura Garciacad1e552006-05-23 23:22:38 +0200186 mutex_lock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 fw = fw_priv->fw;
Stanislaw W. Gruszkab92eac02005-06-28 20:44:51 -0700188 if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 ret_count = -ENODEV;
190 goto out;
191 }
192 if (offset > fw->size) {
193 ret_count = 0;
194 goto out;
195 }
196 if (offset + ret_count > fw->size)
197 ret_count = fw->size - offset;
198
199 memcpy(buffer, fw->data + offset, ret_count);
200out:
Laura Garciacad1e552006-05-23 23:22:38 +0200201 mutex_unlock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 return ret_count;
203}
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800204
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205static int
206fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
207{
208 u8 *new_data;
Jeff Moyer30560ba2006-02-13 14:52:38 -0800209 int new_size = fw_priv->alloc_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210
211 if (min_size <= fw_priv->alloc_size)
212 return 0;
213
Jeff Moyer30560ba2006-02-13 14:52:38 -0800214 new_size = ALIGN(min_size, PAGE_SIZE);
215 new_data = vmalloc(new_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 if (!new_data) {
217 printk(KERN_ERR "%s: unable to alloc buffer\n", __FUNCTION__);
218 /* Make sure that we don't keep incomplete data */
219 fw_load_abort(fw_priv);
220 return -ENOMEM;
221 }
Jeff Moyer30560ba2006-02-13 14:52:38 -0800222 fw_priv->alloc_size = new_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 if (fw_priv->fw->data) {
224 memcpy(new_data, fw_priv->fw->data, fw_priv->fw->size);
225 vfree(fw_priv->fw->data);
226 }
227 fw_priv->fw->data = new_data;
228 BUG_ON(min_size > fw_priv->alloc_size);
229 return 0;
230}
231
232/**
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800233 * firmware_data_write - write method for firmware
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700234 * @kobj: kobject for the device
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800235 * @buffer: buffer being written
236 * @offset: buffer offset for write in total data store area
237 * @count: buffer size
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 *
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800239 * Data written to the 'data' attribute will be later handed to
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 * the driver as a firmware image.
241 **/
242static ssize_t
243firmware_data_write(struct kobject *kobj,
244 char *buffer, loff_t offset, size_t count)
245{
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700246 struct device *dev = to_dev(kobj);
247 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 struct firmware *fw;
249 ssize_t retval;
250
251 if (!capable(CAP_SYS_RAWIO))
252 return -EPERM;
Stanislaw W. Gruszkab92eac02005-06-28 20:44:51 -0700253
Laura Garciacad1e552006-05-23 23:22:38 +0200254 mutex_lock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 fw = fw_priv->fw;
Stanislaw W. Gruszkab92eac02005-06-28 20:44:51 -0700256 if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 retval = -ENODEV;
258 goto out;
259 }
260 retval = fw_realloc_buffer(fw_priv, offset + count);
261 if (retval)
262 goto out;
263
264 memcpy(fw->data + offset, buffer, count);
265
266 fw->size = max_t(size_t, offset + count, fw->size);
267 retval = count;
268out:
Laura Garciacad1e552006-05-23 23:22:38 +0200269 mutex_unlock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 return retval;
271}
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800272
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273static struct bin_attribute firmware_attr_data_tmpl = {
274 .attr = {.name = "data", .mode = 0644, .owner = THIS_MODULE},
275 .size = 0,
276 .read = firmware_data_read,
277 .write = firmware_data_write,
278};
279
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700280static void fw_dev_release(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281{
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700282 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283
284 kfree(fw_priv);
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700285 kfree(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286
287 module_put(THIS_MODULE);
288}
289
290static void
291firmware_class_timeout(u_long data)
292{
293 struct firmware_priv *fw_priv = (struct firmware_priv *) data;
294 fw_load_abort(fw_priv);
295}
296
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700297static inline void fw_setup_device_id(struct device *f_dev, struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298{
299 /* XXX warning we should watch out for name collisions */
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700300 strlcpy(f_dev->bus_id, dev->bus_id, BUS_ID_SIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301}
302
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700303static int fw_register_device(struct device **dev_p, const char *fw_name,
304 struct device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305{
306 int retval;
Jiri Slaby4aed0642005-09-13 01:25:01 -0700307 struct firmware_priv *fw_priv = kzalloc(sizeof(*fw_priv),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 GFP_KERNEL);
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700309 struct device *f_dev = kzalloc(sizeof(*f_dev), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700311 *dev_p = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700313 if (!fw_priv || !f_dev) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 printk(KERN_ERR "%s: kmalloc failed\n", __FUNCTION__);
315 retval = -ENOMEM;
316 goto error_kfree;
317 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318
319 init_completion(&fw_priv->completion);
320 fw_priv->attr_data = firmware_attr_data_tmpl;
321 strlcpy(fw_priv->fw_id, fw_name, FIRMWARE_NAME_MAX);
322
323 fw_priv->timeout.function = firmware_class_timeout;
324 fw_priv->timeout.data = (u_long) fw_priv;
325 init_timer(&fw_priv->timeout);
326
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700327 fw_setup_device_id(f_dev, device);
328 f_dev->parent = device;
329 f_dev->class = &firmware_class;
330 dev_set_drvdata(f_dev, fw_priv);
Cornelia Huckbdc49602007-03-29 11:12:14 +0200331 f_dev->uevent_suppress = 1;
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700332 retval = device_register(f_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 if (retval) {
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700334 printk(KERN_ERR "%s: device_register failed\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 __FUNCTION__);
336 goto error_kfree;
337 }
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700338 *dev_p = f_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 return 0;
340
341error_kfree:
342 kfree(fw_priv);
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700343 kfree(f_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 return retval;
345}
346
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700347static int fw_setup_device(struct firmware *fw, struct device **dev_p,
348 const char *fw_name, struct device *device,
349 int uevent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350{
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700351 struct device *f_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 struct firmware_priv *fw_priv;
353 int retval;
354
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700355 *dev_p = NULL;
356 retval = fw_register_device(&f_dev, fw_name, device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 if (retval)
358 goto out;
359
360 /* Need to pin this module until class device is destroyed */
361 __module_get(THIS_MODULE);
362
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700363 fw_priv = dev_get_drvdata(f_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
365 fw_priv->fw = fw;
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700366 retval = sysfs_create_bin_file(&f_dev->kobj, &fw_priv->attr_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 if (retval) {
368 printk(KERN_ERR "%s: sysfs_create_bin_file failed\n",
369 __FUNCTION__);
370 goto error_unreg;
371 }
372
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700373 retval = device_create_file(f_dev, &dev_attr_loading);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 if (retval) {
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700375 printk(KERN_ERR "%s: device_create_file failed\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 __FUNCTION__);
377 goto error_unreg;
378 }
379
Kay Sievers312c0042005-11-16 09:00:00 +0100380 if (uevent)
Cornelia Huckbdc49602007-03-29 11:12:14 +0200381 f_dev->uevent_suppress = 0;
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700382 *dev_p = f_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 goto out;
384
385error_unreg:
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700386 device_unregister(f_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387out:
388 return retval;
389}
390
Abhay Salunke6e3eaab2005-09-06 15:17:13 -0700391static int
392_request_firmware(const struct firmware **firmware_p, const char *name,
Kay Sievers312c0042005-11-16 09:00:00 +0100393 struct device *device, int uevent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394{
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700395 struct device *f_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 struct firmware_priv *fw_priv;
397 struct firmware *firmware;
398 int retval;
399
400 if (!firmware_p)
401 return -EINVAL;
402
Jiri Slaby4aed0642005-09-13 01:25:01 -0700403 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 if (!firmware) {
405 printk(KERN_ERR "%s: kmalloc(struct firmware) failed\n",
406 __FUNCTION__);
407 retval = -ENOMEM;
408 goto out;
409 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700411 retval = fw_setup_device(firmware, &f_dev, name, device, uevent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 if (retval)
413 goto error_kfree_fw;
414
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700415 fw_priv = dev_get_drvdata(f_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416
Kay Sievers312c0042005-11-16 09:00:00 +0100417 if (uevent) {
Abhay Salunke6e3eaab2005-09-06 15:17:13 -0700418 if (loading_timeout > 0) {
419 fw_priv->timeout.expires = jiffies + loading_timeout * HZ;
420 add_timer(&fw_priv->timeout);
421 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700423 kobject_uevent(&f_dev->kobj, KOBJ_ADD);
Abhay Salunke6e3eaab2005-09-06 15:17:13 -0700424 wait_for_completion(&fw_priv->completion);
425 set_bit(FW_STATUS_DONE, &fw_priv->status);
426 del_timer_sync(&fw_priv->timeout);
427 } else
428 wait_for_completion(&fw_priv->completion);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429
Laura Garciacad1e552006-05-23 23:22:38 +0200430 mutex_lock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 if (!fw_priv->fw->size || test_bit(FW_STATUS_ABORT, &fw_priv->status)) {
432 retval = -ENOENT;
433 release_firmware(fw_priv->fw);
434 *firmware_p = NULL;
435 }
436 fw_priv->fw = NULL;
Laura Garciacad1e552006-05-23 23:22:38 +0200437 mutex_unlock(&fw_lock);
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700438 device_unregister(f_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 goto out;
440
441error_kfree_fw:
442 kfree(firmware);
443 *firmware_p = NULL;
444out:
445 return retval;
446}
447
448/**
Kay Sievers312c0042005-11-16 09:00:00 +0100449 * request_firmware: - send firmware request and wait for it
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800450 * @firmware_p: pointer to firmware image
451 * @name: name of firmware file
452 * @device: device for which firmware is being loaded
453 *
454 * @firmware_p will be used to return a firmware image by the name
Abhay Salunke6e3eaab2005-09-06 15:17:13 -0700455 * of @name for device @device.
456 *
457 * Should be called from user context where sleeping is allowed.
458 *
Kay Sievers312c0042005-11-16 09:00:00 +0100459 * @name will be used as $FIRMWARE in the uevent environment and
Abhay Salunke6e3eaab2005-09-06 15:17:13 -0700460 * should be distinctive enough not to be confused with any other
461 * firmware image for this or any other device.
462 **/
463int
464request_firmware(const struct firmware **firmware_p, const char *name,
465 struct device *device)
466{
Kay Sievers312c0042005-11-16 09:00:00 +0100467 int uevent = 1;
468 return _request_firmware(firmware_p, name, device, uevent);
Abhay Salunke6e3eaab2005-09-06 15:17:13 -0700469}
470
471/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 * release_firmware: - release the resource associated with a firmware image
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800473 * @fw: firmware resource to release
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 **/
475void
476release_firmware(const struct firmware *fw)
477{
478 if (fw) {
479 vfree(fw->data);
480 kfree(fw);
481 }
482}
483
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484/* Async support */
485struct firmware_work {
486 struct work_struct work;
487 struct module *module;
488 const char *name;
489 struct device *device;
490 void *context;
491 void (*cont)(const struct firmware *fw, void *context);
Kay Sievers312c0042005-11-16 09:00:00 +0100492 int uevent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493};
494
495static int
496request_firmware_work_func(void *arg)
497{
498 struct firmware_work *fw_work = arg;
499 const struct firmware *fw;
matthieu castet113fab12005-11-13 16:07:39 -0800500 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 if (!arg) {
502 WARN_ON(1);
503 return 0;
504 }
matthieu castet113fab12005-11-13 16:07:39 -0800505 ret = _request_firmware(&fw, fw_work->name, fw_work->device,
Kay Sievers312c0042005-11-16 09:00:00 +0100506 fw_work->uevent);
matthieu castet113fab12005-11-13 16:07:39 -0800507 if (ret < 0)
508 fw_work->cont(NULL, fw_work->context);
509 else {
510 fw_work->cont(fw, fw_work->context);
511 release_firmware(fw);
512 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 module_put(fw_work->module);
514 kfree(fw_work);
matthieu castet113fab12005-11-13 16:07:39 -0800515 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516}
517
518/**
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800519 * request_firmware_nowait: asynchronous version of request_firmware
520 * @module: module requesting the firmware
Kay Sievers312c0042005-11-16 09:00:00 +0100521 * @uevent: sends uevent to copy the firmware image if this flag
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800522 * is non-zero else the firmware copy must be done manually.
523 * @name: name of firmware file
524 * @device: device for which firmware is being loaded
525 * @context: will be passed over to @cont, and
526 * @fw may be %NULL if firmware request fails.
527 * @cont: function will be called asynchronously when the firmware
528 * request is over.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 * Asynchronous variant of request_firmware() for contexts where
531 * it is not possible to sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 **/
533int
534request_firmware_nowait(
Kay Sievers312c0042005-11-16 09:00:00 +0100535 struct module *module, int uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 const char *name, struct device *device, void *context,
537 void (*cont)(const struct firmware *fw, void *context))
538{
Sukadev Bhattiprolu563d0752006-09-29 01:59:31 -0700539 struct task_struct *task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 struct firmware_work *fw_work = kmalloc(sizeof (struct firmware_work),
541 GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542
543 if (!fw_work)
544 return -ENOMEM;
545 if (!try_module_get(module)) {
546 kfree(fw_work);
547 return -EFAULT;
548 }
549
550 *fw_work = (struct firmware_work) {
551 .module = module,
552 .name = name,
553 .device = device,
554 .context = context,
555 .cont = cont,
Kay Sievers312c0042005-11-16 09:00:00 +0100556 .uevent = uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 };
558
Sukadev Bhattiprolu563d0752006-09-29 01:59:31 -0700559 task = kthread_run(request_firmware_work_func, fw_work,
560 "firmware/%s", name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561
Sukadev Bhattiprolu563d0752006-09-29 01:59:31 -0700562 if (IS_ERR(task)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 fw_work->cont(NULL, fw_work->context);
matthieu castet113fab12005-11-13 16:07:39 -0800564 module_put(fw_work->module);
565 kfree(fw_work);
Sukadev Bhattiprolu563d0752006-09-29 01:59:31 -0700566 return PTR_ERR(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 }
568 return 0;
569}
570
571static int __init
572firmware_class_init(void)
573{
574 int error;
575 error = class_register(&firmware_class);
576 if (error) {
577 printk(KERN_ERR "%s: class_register failed\n", __FUNCTION__);
578 return error;
579 }
580 error = class_create_file(&firmware_class, &class_attr_timeout);
581 if (error) {
582 printk(KERN_ERR "%s: class_create_file failed\n",
583 __FUNCTION__);
584 class_unregister(&firmware_class);
585 }
586 return error;
587
588}
589static void __exit
590firmware_class_exit(void)
591{
592 class_unregister(&firmware_class);
593}
594
Shaohua Lia30a6a22006-09-27 01:50:52 -0700595fs_initcall(firmware_class_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596module_exit(firmware_class_exit);
597
598EXPORT_SYMBOL(release_firmware);
599EXPORT_SYMBOL(request_firmware);
600EXPORT_SYMBOL(request_firmware_nowait);