Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * firmware_class.c - Multi purpose firmware loading support | |
3 | * | |
87d37a4f | 4 | * Copyright (c) 2003 Manuel Estrada Sainz |
1da177e4 LT |
5 | * |
6 | * Please see Documentation/firmware_class/ for more information. | |
7 | * | |
8 | */ | |
9 | ||
c59ede7b | 10 | #include <linux/capability.h> |
1da177e4 LT |
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> | |
cad1e55d | 18 | #include <linux/mutex.h> |
563d0757 | 19 | #include <linux/kthread.h> |
6e03a201 | 20 | #include <linux/highmem.h> |
1da177e4 | 21 | #include <linux/firmware.h> |
1da177e4 | 22 | |
e55c8790 GKH |
23 | #define to_dev(obj) container_of(obj, struct device, kobj) |
24 | ||
87d37a4f | 25 | MODULE_AUTHOR("Manuel Estrada Sainz"); |
1da177e4 LT |
26 | MODULE_DESCRIPTION("Multi purpose firmware loading support"); |
27 | MODULE_LICENSE("GPL"); | |
28 | ||
29 | enum { | |
30 | FW_STATUS_LOADING, | |
31 | FW_STATUS_DONE, | |
32 | FW_STATUS_ABORT, | |
1da177e4 LT |
33 | }; |
34 | ||
2f65168d | 35 | static int loading_timeout = 60; /* In seconds */ |
1da177e4 LT |
36 | |
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 */ | |
cad1e55d | 39 | static DEFINE_MUTEX(fw_lock); |
1da177e4 LT |
40 | |
41 | struct firmware_priv { | |
976821d7 | 42 | char *fw_id; |
1da177e4 LT |
43 | struct completion completion; |
44 | struct bin_attribute attr_data; | |
45 | struct firmware *fw; | |
46 | unsigned long status; | |
6e03a201 DW |
47 | struct page **pages; |
48 | int nr_pages; | |
49 | int page_array_size; | |
50 | const char *vdata; | |
1da177e4 LT |
51 | struct timer_list timeout; |
52 | }; | |
53 | ||
5658c769 DW |
54 | #ifdef CONFIG_FW_LOADER |
55 | extern struct builtin_fw __start_builtin_fw[]; | |
56 | extern struct builtin_fw __end_builtin_fw[]; | |
57 | #else /* Module case. Avoid ifdefs later; it'll all optimise out */ | |
58 | static struct builtin_fw *__start_builtin_fw; | |
59 | static struct builtin_fw *__end_builtin_fw; | |
60 | #endif | |
61 | ||
858119e1 | 62 | static void |
1da177e4 LT |
63 | fw_load_abort(struct firmware_priv *fw_priv) |
64 | { | |
65 | set_bit(FW_STATUS_ABORT, &fw_priv->status); | |
66 | wmb(); | |
67 | complete(&fw_priv->completion); | |
68 | } | |
69 | ||
70 | static ssize_t | |
28812fe1 AK |
71 | firmware_timeout_show(struct class *class, |
72 | struct class_attribute *attr, | |
73 | char *buf) | |
1da177e4 LT |
74 | { |
75 | return sprintf(buf, "%d\n", loading_timeout); | |
76 | } | |
77 | ||
78 | /** | |
eb8e3179 RD |
79 | * firmware_timeout_store - set number of seconds to wait for firmware |
80 | * @class: device class pointer | |
81 | * @buf: buffer to scan for timeout value | |
82 | * @count: number of bytes in @buf | |
83 | * | |
1da177e4 | 84 | * Sets the number of seconds to wait for the firmware. Once |
eb8e3179 | 85 | * this expires an error will be returned to the driver and no |
1da177e4 LT |
86 | * firmware will be provided. |
87 | * | |
eb8e3179 | 88 | * Note: zero means 'wait forever'. |
1da177e4 LT |
89 | **/ |
90 | static ssize_t | |
28812fe1 AK |
91 | firmware_timeout_store(struct class *class, |
92 | struct class_attribute *attr, | |
93 | const char *buf, size_t count) | |
1da177e4 LT |
94 | { |
95 | loading_timeout = simple_strtol(buf, NULL, 10); | |
b92eac01 SG |
96 | if (loading_timeout < 0) |
97 | loading_timeout = 0; | |
1da177e4 LT |
98 | return count; |
99 | } | |
100 | ||
101 | static CLASS_ATTR(timeout, 0644, firmware_timeout_show, firmware_timeout_store); | |
102 | ||
e55c8790 | 103 | static void fw_dev_release(struct device *dev); |
1da177e4 | 104 | |
7eff2e7a | 105 | static int firmware_uevent(struct device *dev, struct kobj_uevent_env *env) |
1da177e4 | 106 | { |
e55c8790 | 107 | struct firmware_priv *fw_priv = dev_get_drvdata(dev); |
1da177e4 | 108 | |
7eff2e7a | 109 | if (add_uevent_var(env, "FIRMWARE=%s", fw_priv->fw_id)) |
1da177e4 | 110 | return -ENOMEM; |
7eff2e7a | 111 | if (add_uevent_var(env, "TIMEOUT=%i", loading_timeout)) |
6897089c | 112 | return -ENOMEM; |
1da177e4 LT |
113 | |
114 | return 0; | |
115 | } | |
116 | ||
1b81d663 AB |
117 | static struct class firmware_class = { |
118 | .name = "firmware", | |
e55c8790 GKH |
119 | .dev_uevent = firmware_uevent, |
120 | .dev_release = fw_dev_release, | |
1b81d663 AB |
121 | }; |
122 | ||
e55c8790 GKH |
123 | static ssize_t firmware_loading_show(struct device *dev, |
124 | struct device_attribute *attr, char *buf) | |
1da177e4 | 125 | { |
e55c8790 | 126 | struct firmware_priv *fw_priv = dev_get_drvdata(dev); |
1da177e4 LT |
127 | int loading = test_bit(FW_STATUS_LOADING, &fw_priv->status); |
128 | return sprintf(buf, "%d\n", loading); | |
129 | } | |
130 | ||
6e03a201 DW |
131 | /* Some architectures don't have PAGE_KERNEL_RO */ |
132 | #ifndef PAGE_KERNEL_RO | |
133 | #define PAGE_KERNEL_RO PAGE_KERNEL | |
134 | #endif | |
1da177e4 | 135 | /** |
eb8e3179 | 136 | * firmware_loading_store - set value in the 'loading' control file |
e55c8790 | 137 | * @dev: device pointer |
af9997e4 | 138 | * @attr: device attribute pointer |
eb8e3179 RD |
139 | * @buf: buffer to scan for loading control value |
140 | * @count: number of bytes in @buf | |
141 | * | |
1da177e4 LT |
142 | * The relevant values are: |
143 | * | |
144 | * 1: Start a load, discarding any previous partial load. | |
eb8e3179 | 145 | * 0: Conclude the load and hand the data to the driver code. |
1da177e4 LT |
146 | * -1: Conclude the load with an error and discard any written data. |
147 | **/ | |
e55c8790 GKH |
148 | static ssize_t firmware_loading_store(struct device *dev, |
149 | struct device_attribute *attr, | |
150 | const char *buf, size_t count) | |
1da177e4 | 151 | { |
e55c8790 | 152 | struct firmware_priv *fw_priv = dev_get_drvdata(dev); |
1da177e4 | 153 | int loading = simple_strtol(buf, NULL, 10); |
6e03a201 | 154 | int i; |
1da177e4 LT |
155 | |
156 | switch (loading) { | |
157 | case 1: | |
cad1e55d | 158 | mutex_lock(&fw_lock); |
b92eac01 | 159 | if (!fw_priv->fw) { |
cad1e55d | 160 | mutex_unlock(&fw_lock); |
b92eac01 SG |
161 | break; |
162 | } | |
1da177e4 LT |
163 | vfree(fw_priv->fw->data); |
164 | fw_priv->fw->data = NULL; | |
6e03a201 DW |
165 | for (i = 0; i < fw_priv->nr_pages; i++) |
166 | __free_page(fw_priv->pages[i]); | |
167 | kfree(fw_priv->pages); | |
168 | fw_priv->pages = NULL; | |
169 | fw_priv->page_array_size = 0; | |
170 | fw_priv->nr_pages = 0; | |
1da177e4 | 171 | fw_priv->fw->size = 0; |
1da177e4 | 172 | set_bit(FW_STATUS_LOADING, &fw_priv->status); |
cad1e55d | 173 | mutex_unlock(&fw_lock); |
1da177e4 LT |
174 | break; |
175 | case 0: | |
176 | if (test_bit(FW_STATUS_LOADING, &fw_priv->status)) { | |
6e03a201 DW |
177 | vfree(fw_priv->fw->data); |
178 | fw_priv->fw->data = vmap(fw_priv->pages, | |
179 | fw_priv->nr_pages, | |
180 | 0, PAGE_KERNEL_RO); | |
181 | if (!fw_priv->fw->data) { | |
182 | dev_err(dev, "%s: vmap() failed\n", __func__); | |
183 | goto err; | |
184 | } | |
185 | /* Pages will be freed by vfree() */ | |
6e03a201 DW |
186 | fw_priv->page_array_size = 0; |
187 | fw_priv->nr_pages = 0; | |
1da177e4 LT |
188 | complete(&fw_priv->completion); |
189 | clear_bit(FW_STATUS_LOADING, &fw_priv->status); | |
190 | break; | |
191 | } | |
192 | /* fallthrough */ | |
193 | default: | |
266a813c | 194 | dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading); |
1da177e4 LT |
195 | /* fallthrough */ |
196 | case -1: | |
6e03a201 | 197 | err: |
1da177e4 LT |
198 | fw_load_abort(fw_priv); |
199 | break; | |
200 | } | |
201 | ||
202 | return count; | |
203 | } | |
204 | ||
e55c8790 | 205 | static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store); |
1da177e4 LT |
206 | |
207 | static ssize_t | |
91a69029 | 208 | firmware_data_read(struct kobject *kobj, struct bin_attribute *bin_attr, |
1da177e4 LT |
209 | char *buffer, loff_t offset, size_t count) |
210 | { | |
e55c8790 GKH |
211 | struct device *dev = to_dev(kobj); |
212 | struct firmware_priv *fw_priv = dev_get_drvdata(dev); | |
1da177e4 | 213 | struct firmware *fw; |
f37e6617 | 214 | ssize_t ret_count; |
1da177e4 | 215 | |
cad1e55d | 216 | mutex_lock(&fw_lock); |
1da177e4 | 217 | fw = fw_priv->fw; |
b92eac01 | 218 | if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) { |
1da177e4 LT |
219 | ret_count = -ENODEV; |
220 | goto out; | |
221 | } | |
308975fa JS |
222 | if (offset > fw->size) { |
223 | ret_count = 0; | |
224 | goto out; | |
225 | } | |
6e03a201 DW |
226 | if (count > fw->size - offset) |
227 | count = fw->size - offset; | |
228 | ||
229 | ret_count = count; | |
230 | ||
231 | while (count) { | |
232 | void *page_data; | |
233 | int page_nr = offset >> PAGE_SHIFT; | |
234 | int page_ofs = offset & (PAGE_SIZE-1); | |
235 | int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count); | |
236 | ||
237 | page_data = kmap(fw_priv->pages[page_nr]); | |
238 | ||
239 | memcpy(buffer, page_data + page_ofs, page_cnt); | |
240 | ||
241 | kunmap(fw_priv->pages[page_nr]); | |
242 | buffer += page_cnt; | |
243 | offset += page_cnt; | |
244 | count -= page_cnt; | |
245 | } | |
1da177e4 | 246 | out: |
cad1e55d | 247 | mutex_unlock(&fw_lock); |
1da177e4 LT |
248 | return ret_count; |
249 | } | |
eb8e3179 | 250 | |
1da177e4 LT |
251 | static int |
252 | fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size) | |
253 | { | |
6e03a201 DW |
254 | int pages_needed = ALIGN(min_size, PAGE_SIZE) >> PAGE_SHIFT; |
255 | ||
256 | /* If the array of pages is too small, grow it... */ | |
257 | if (fw_priv->page_array_size < pages_needed) { | |
258 | int new_array_size = max(pages_needed, | |
259 | fw_priv->page_array_size * 2); | |
260 | struct page **new_pages; | |
261 | ||
262 | new_pages = kmalloc(new_array_size * sizeof(void *), | |
263 | GFP_KERNEL); | |
264 | if (!new_pages) { | |
265 | fw_load_abort(fw_priv); | |
266 | return -ENOMEM; | |
267 | } | |
268 | memcpy(new_pages, fw_priv->pages, | |
269 | fw_priv->page_array_size * sizeof(void *)); | |
270 | memset(&new_pages[fw_priv->page_array_size], 0, sizeof(void *) * | |
271 | (new_array_size - fw_priv->page_array_size)); | |
272 | kfree(fw_priv->pages); | |
273 | fw_priv->pages = new_pages; | |
274 | fw_priv->page_array_size = new_array_size; | |
275 | } | |
1da177e4 | 276 | |
6e03a201 DW |
277 | while (fw_priv->nr_pages < pages_needed) { |
278 | fw_priv->pages[fw_priv->nr_pages] = | |
279 | alloc_page(GFP_KERNEL | __GFP_HIGHMEM); | |
1da177e4 | 280 | |
6e03a201 DW |
281 | if (!fw_priv->pages[fw_priv->nr_pages]) { |
282 | fw_load_abort(fw_priv); | |
283 | return -ENOMEM; | |
284 | } | |
285 | fw_priv->nr_pages++; | |
1da177e4 | 286 | } |
1da177e4 LT |
287 | return 0; |
288 | } | |
289 | ||
290 | /** | |
eb8e3179 | 291 | * firmware_data_write - write method for firmware |
e55c8790 | 292 | * @kobj: kobject for the device |
42e61f4a | 293 | * @bin_attr: bin_attr structure |
eb8e3179 RD |
294 | * @buffer: buffer being written |
295 | * @offset: buffer offset for write in total data store area | |
296 | * @count: buffer size | |
1da177e4 | 297 | * |
eb8e3179 | 298 | * Data written to the 'data' attribute will be later handed to |
1da177e4 LT |
299 | * the driver as a firmware image. |
300 | **/ | |
301 | static ssize_t | |
91a69029 | 302 | firmware_data_write(struct kobject *kobj, struct bin_attribute *bin_attr, |
1da177e4 LT |
303 | char *buffer, loff_t offset, size_t count) |
304 | { | |
e55c8790 GKH |
305 | struct device *dev = to_dev(kobj); |
306 | struct firmware_priv *fw_priv = dev_get_drvdata(dev); | |
1da177e4 LT |
307 | struct firmware *fw; |
308 | ssize_t retval; | |
309 | ||
310 | if (!capable(CAP_SYS_RAWIO)) | |
311 | return -EPERM; | |
b92eac01 | 312 | |
cad1e55d | 313 | mutex_lock(&fw_lock); |
1da177e4 | 314 | fw = fw_priv->fw; |
b92eac01 | 315 | if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) { |
1da177e4 LT |
316 | retval = -ENODEV; |
317 | goto out; | |
318 | } | |
319 | retval = fw_realloc_buffer(fw_priv, offset + count); | |
320 | if (retval) | |
321 | goto out; | |
322 | ||
1da177e4 | 323 | retval = count; |
6e03a201 DW |
324 | |
325 | while (count) { | |
326 | void *page_data; | |
327 | int page_nr = offset >> PAGE_SHIFT; | |
328 | int page_ofs = offset & (PAGE_SIZE - 1); | |
329 | int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count); | |
330 | ||
331 | page_data = kmap(fw_priv->pages[page_nr]); | |
332 | ||
333 | memcpy(page_data + page_ofs, buffer, page_cnt); | |
334 | ||
335 | kunmap(fw_priv->pages[page_nr]); | |
336 | buffer += page_cnt; | |
337 | offset += page_cnt; | |
338 | count -= page_cnt; | |
339 | } | |
340 | ||
341 | fw->size = max_t(size_t, offset, fw->size); | |
1da177e4 | 342 | out: |
cad1e55d | 343 | mutex_unlock(&fw_lock); |
1da177e4 LT |
344 | return retval; |
345 | } | |
eb8e3179 | 346 | |
1da177e4 | 347 | static struct bin_attribute firmware_attr_data_tmpl = { |
7b595756 | 348 | .attr = {.name = "data", .mode = 0644}, |
1da177e4 LT |
349 | .size = 0, |
350 | .read = firmware_data_read, | |
351 | .write = firmware_data_write, | |
352 | }; | |
353 | ||
e55c8790 | 354 | static void fw_dev_release(struct device *dev) |
1da177e4 | 355 | { |
e55c8790 | 356 | struct firmware_priv *fw_priv = dev_get_drvdata(dev); |
6e03a201 | 357 | int i; |
1da177e4 | 358 | |
6e03a201 DW |
359 | for (i = 0; i < fw_priv->nr_pages; i++) |
360 | __free_page(fw_priv->pages[i]); | |
361 | kfree(fw_priv->pages); | |
976821d7 | 362 | kfree(fw_priv->fw_id); |
1da177e4 | 363 | kfree(fw_priv); |
0f2f2221 | 364 | kfree(dev); |
1da177e4 LT |
365 | |
366 | module_put(THIS_MODULE); | |
367 | } | |
368 | ||
369 | static void | |
370 | firmware_class_timeout(u_long data) | |
371 | { | |
372 | struct firmware_priv *fw_priv = (struct firmware_priv *) data; | |
373 | fw_load_abort(fw_priv); | |
374 | } | |
375 | ||
e55c8790 GKH |
376 | static int fw_register_device(struct device **dev_p, const char *fw_name, |
377 | struct device *device) | |
1da177e4 LT |
378 | { |
379 | int retval; | |
4aed0644 | 380 | struct firmware_priv *fw_priv = kzalloc(sizeof(*fw_priv), |
1da177e4 | 381 | GFP_KERNEL); |
e55c8790 | 382 | struct device *f_dev = kzalloc(sizeof(*f_dev), GFP_KERNEL); |
1da177e4 | 383 | |
e55c8790 | 384 | *dev_p = NULL; |
1da177e4 | 385 | |
e55c8790 | 386 | if (!fw_priv || !f_dev) { |
266a813c | 387 | dev_err(device, "%s: kmalloc failed\n", __func__); |
1da177e4 LT |
388 | retval = -ENOMEM; |
389 | goto error_kfree; | |
390 | } | |
1da177e4 LT |
391 | |
392 | init_completion(&fw_priv->completion); | |
393 | fw_priv->attr_data = firmware_attr_data_tmpl; | |
976821d7 SO |
394 | fw_priv->fw_id = kstrdup(fw_name, GFP_KERNEL); |
395 | if (!fw_priv->fw_id) { | |
396 | dev_err(device, "%s: Firmware name allocation failed\n", | |
397 | __func__); | |
398 | retval = -ENOMEM; | |
399 | goto error_kfree; | |
400 | } | |
1da177e4 LT |
401 | |
402 | fw_priv->timeout.function = firmware_class_timeout; | |
403 | fw_priv->timeout.data = (u_long) fw_priv; | |
404 | init_timer(&fw_priv->timeout); | |
405 | ||
acc0e90f | 406 | dev_set_name(f_dev, "%s", dev_name(device)); |
e55c8790 GKH |
407 | f_dev->parent = device; |
408 | f_dev->class = &firmware_class; | |
409 | dev_set_drvdata(f_dev, fw_priv); | |
f67f129e | 410 | dev_set_uevent_suppress(f_dev, 1); |
e55c8790 | 411 | retval = device_register(f_dev); |
1da177e4 | 412 | if (retval) { |
266a813c | 413 | dev_err(device, "%s: device_register failed\n", __func__); |
6acf70f0 | 414 | put_device(f_dev); |
0f2f2221 | 415 | return retval; |
1da177e4 | 416 | } |
e55c8790 | 417 | *dev_p = f_dev; |
1da177e4 LT |
418 | return 0; |
419 | ||
420 | error_kfree: | |
e55c8790 | 421 | kfree(f_dev); |
6acf70f0 | 422 | kfree(fw_priv); |
1da177e4 LT |
423 | return retval; |
424 | } | |
425 | ||
e55c8790 GKH |
426 | static int fw_setup_device(struct firmware *fw, struct device **dev_p, |
427 | const char *fw_name, struct device *device, | |
428 | int uevent) | |
1da177e4 | 429 | { |
e55c8790 | 430 | struct device *f_dev; |
1da177e4 LT |
431 | struct firmware_priv *fw_priv; |
432 | int retval; | |
433 | ||
e55c8790 GKH |
434 | *dev_p = NULL; |
435 | retval = fw_register_device(&f_dev, fw_name, device); | |
1da177e4 LT |
436 | if (retval) |
437 | goto out; | |
438 | ||
439 | /* Need to pin this module until class device is destroyed */ | |
440 | __module_get(THIS_MODULE); | |
441 | ||
e55c8790 | 442 | fw_priv = dev_get_drvdata(f_dev); |
1da177e4 LT |
443 | |
444 | fw_priv->fw = fw; | |
e55c8790 | 445 | retval = sysfs_create_bin_file(&f_dev->kobj, &fw_priv->attr_data); |
1da177e4 | 446 | if (retval) { |
266a813c | 447 | dev_err(device, "%s: sysfs_create_bin_file failed\n", __func__); |
1da177e4 LT |
448 | goto error_unreg; |
449 | } | |
450 | ||
e55c8790 | 451 | retval = device_create_file(f_dev, &dev_attr_loading); |
1da177e4 | 452 | if (retval) { |
266a813c | 453 | dev_err(device, "%s: device_create_file failed\n", __func__); |
1da177e4 LT |
454 | goto error_unreg; |
455 | } | |
456 | ||
312c004d | 457 | if (uevent) |
f67f129e | 458 | dev_set_uevent_suppress(f_dev, 0); |
e55c8790 | 459 | *dev_p = f_dev; |
1da177e4 LT |
460 | goto out; |
461 | ||
462 | error_unreg: | |
e55c8790 | 463 | device_unregister(f_dev); |
1da177e4 LT |
464 | out: |
465 | return retval; | |
466 | } | |
467 | ||
6e3eaab0 AS |
468 | static int |
469 | _request_firmware(const struct firmware **firmware_p, const char *name, | |
312c004d | 470 | struct device *device, int uevent) |
1da177e4 | 471 | { |
e55c8790 | 472 | struct device *f_dev; |
1da177e4 LT |
473 | struct firmware_priv *fw_priv; |
474 | struct firmware *firmware; | |
5658c769 | 475 | struct builtin_fw *builtin; |
1da177e4 LT |
476 | int retval; |
477 | ||
478 | if (!firmware_p) | |
479 | return -EINVAL; | |
480 | ||
4aed0644 | 481 | *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL); |
1da177e4 | 482 | if (!firmware) { |
266a813c BH |
483 | dev_err(device, "%s: kmalloc(struct firmware) failed\n", |
484 | __func__); | |
1da177e4 LT |
485 | retval = -ENOMEM; |
486 | goto out; | |
487 | } | |
1da177e4 | 488 | |
5658c769 DW |
489 | for (builtin = __start_builtin_fw; builtin != __end_builtin_fw; |
490 | builtin++) { | |
491 | if (strcmp(name, builtin->name)) | |
492 | continue; | |
266a813c BH |
493 | dev_info(device, "firmware: using built-in firmware %s\n", |
494 | name); | |
5658c769 DW |
495 | firmware->size = builtin->size; |
496 | firmware->data = builtin->data; | |
497 | return 0; | |
498 | } | |
499 | ||
500 | if (uevent) | |
266a813c | 501 | dev_info(device, "firmware: requesting %s\n", name); |
5658c769 | 502 | |
e55c8790 | 503 | retval = fw_setup_device(firmware, &f_dev, name, device, uevent); |
1da177e4 LT |
504 | if (retval) |
505 | goto error_kfree_fw; | |
506 | ||
e55c8790 | 507 | fw_priv = dev_get_drvdata(f_dev); |
1da177e4 | 508 | |
312c004d | 509 | if (uevent) { |
6e3eaab0 AS |
510 | if (loading_timeout > 0) { |
511 | fw_priv->timeout.expires = jiffies + loading_timeout * HZ; | |
512 | add_timer(&fw_priv->timeout); | |
513 | } | |
1da177e4 | 514 | |
e55c8790 | 515 | kobject_uevent(&f_dev->kobj, KOBJ_ADD); |
6e3eaab0 AS |
516 | wait_for_completion(&fw_priv->completion); |
517 | set_bit(FW_STATUS_DONE, &fw_priv->status); | |
518 | del_timer_sync(&fw_priv->timeout); | |
519 | } else | |
520 | wait_for_completion(&fw_priv->completion); | |
1da177e4 | 521 | |
cad1e55d | 522 | mutex_lock(&fw_lock); |
1da177e4 LT |
523 | if (!fw_priv->fw->size || test_bit(FW_STATUS_ABORT, &fw_priv->status)) { |
524 | retval = -ENOENT; | |
525 | release_firmware(fw_priv->fw); | |
526 | *firmware_p = NULL; | |
527 | } | |
528 | fw_priv->fw = NULL; | |
cad1e55d | 529 | mutex_unlock(&fw_lock); |
e55c8790 | 530 | device_unregister(f_dev); |
1da177e4 LT |
531 | goto out; |
532 | ||
533 | error_kfree_fw: | |
534 | kfree(firmware); | |
535 | *firmware_p = NULL; | |
536 | out: | |
537 | return retval; | |
538 | } | |
539 | ||
6e3eaab0 | 540 | /** |
312c004d | 541 | * request_firmware: - send firmware request and wait for it |
eb8e3179 RD |
542 | * @firmware_p: pointer to firmware image |
543 | * @name: name of firmware file | |
544 | * @device: device for which firmware is being loaded | |
545 | * | |
546 | * @firmware_p will be used to return a firmware image by the name | |
6e3eaab0 AS |
547 | * of @name for device @device. |
548 | * | |
549 | * Should be called from user context where sleeping is allowed. | |
550 | * | |
312c004d | 551 | * @name will be used as $FIRMWARE in the uevent environment and |
6e3eaab0 AS |
552 | * should be distinctive enough not to be confused with any other |
553 | * firmware image for this or any other device. | |
554 | **/ | |
555 | int | |
556 | request_firmware(const struct firmware **firmware_p, const char *name, | |
557 | struct device *device) | |
558 | { | |
312c004d KS |
559 | int uevent = 1; |
560 | return _request_firmware(firmware_p, name, device, uevent); | |
6e3eaab0 AS |
561 | } |
562 | ||
1da177e4 LT |
563 | /** |
564 | * release_firmware: - release the resource associated with a firmware image | |
eb8e3179 | 565 | * @fw: firmware resource to release |
1da177e4 LT |
566 | **/ |
567 | void | |
568 | release_firmware(const struct firmware *fw) | |
569 | { | |
5658c769 DW |
570 | struct builtin_fw *builtin; |
571 | ||
1da177e4 | 572 | if (fw) { |
5658c769 DW |
573 | for (builtin = __start_builtin_fw; builtin != __end_builtin_fw; |
574 | builtin++) { | |
575 | if (fw->data == builtin->data) | |
576 | goto free_fw; | |
577 | } | |
1da177e4 | 578 | vfree(fw->data); |
5658c769 | 579 | free_fw: |
1da177e4 LT |
580 | kfree(fw); |
581 | } | |
582 | } | |
583 | ||
1da177e4 LT |
584 | /* Async support */ |
585 | struct firmware_work { | |
586 | struct work_struct work; | |
587 | struct module *module; | |
588 | const char *name; | |
589 | struct device *device; | |
590 | void *context; | |
591 | void (*cont)(const struct firmware *fw, void *context); | |
312c004d | 592 | int uevent; |
1da177e4 LT |
593 | }; |
594 | ||
595 | static int | |
596 | request_firmware_work_func(void *arg) | |
597 | { | |
598 | struct firmware_work *fw_work = arg; | |
599 | const struct firmware *fw; | |
113fab13 | 600 | int ret; |
1da177e4 LT |
601 | if (!arg) { |
602 | WARN_ON(1); | |
603 | return 0; | |
604 | } | |
113fab13 | 605 | ret = _request_firmware(&fw, fw_work->name, fw_work->device, |
312c004d | 606 | fw_work->uevent); |
9ebfbd45 JB |
607 | |
608 | fw_work->cont(fw, fw_work->context); | |
609 | ||
1da177e4 LT |
610 | module_put(fw_work->module); |
611 | kfree(fw_work); | |
113fab13 | 612 | return ret; |
1da177e4 LT |
613 | } |
614 | ||
615 | /** | |
eb8e3179 RD |
616 | * request_firmware_nowait: asynchronous version of request_firmware |
617 | * @module: module requesting the firmware | |
312c004d | 618 | * @uevent: sends uevent to copy the firmware image if this flag |
eb8e3179 RD |
619 | * is non-zero else the firmware copy must be done manually. |
620 | * @name: name of firmware file | |
621 | * @device: device for which firmware is being loaded | |
9ebfbd45 | 622 | * @gfp: allocation flags |
eb8e3179 RD |
623 | * @context: will be passed over to @cont, and |
624 | * @fw may be %NULL if firmware request fails. | |
625 | * @cont: function will be called asynchronously when the firmware | |
626 | * request is over. | |
1da177e4 | 627 | * |
7fcab099 ML |
628 | * Asynchronous variant of request_firmware() for user contexts where |
629 | * it is not possible to sleep for long time. It can't be called | |
630 | * in atomic contexts. | |
1da177e4 LT |
631 | **/ |
632 | int | |
633 | request_firmware_nowait( | |
312c004d | 634 | struct module *module, int uevent, |
9ebfbd45 | 635 | const char *name, struct device *device, gfp_t gfp, void *context, |
1da177e4 LT |
636 | void (*cont)(const struct firmware *fw, void *context)) |
637 | { | |
563d0757 | 638 | struct task_struct *task; |
1da177e4 | 639 | struct firmware_work *fw_work = kmalloc(sizeof (struct firmware_work), |
9ebfbd45 | 640 | gfp); |
1da177e4 LT |
641 | |
642 | if (!fw_work) | |
643 | return -ENOMEM; | |
644 | if (!try_module_get(module)) { | |
645 | kfree(fw_work); | |
646 | return -EFAULT; | |
647 | } | |
648 | ||
649 | *fw_work = (struct firmware_work) { | |
650 | .module = module, | |
651 | .name = name, | |
652 | .device = device, | |
653 | .context = context, | |
654 | .cont = cont, | |
312c004d | 655 | .uevent = uevent, |
1da177e4 LT |
656 | }; |
657 | ||
563d0757 SB |
658 | task = kthread_run(request_firmware_work_func, fw_work, |
659 | "firmware/%s", name); | |
1da177e4 | 660 | |
563d0757 | 661 | if (IS_ERR(task)) { |
1da177e4 | 662 | fw_work->cont(NULL, fw_work->context); |
113fab13 | 663 | module_put(fw_work->module); |
664 | kfree(fw_work); | |
563d0757 | 665 | return PTR_ERR(task); |
1da177e4 LT |
666 | } |
667 | return 0; | |
668 | } | |
669 | ||
670 | static int __init | |
671 | firmware_class_init(void) | |
672 | { | |
673 | int error; | |
674 | error = class_register(&firmware_class); | |
675 | if (error) { | |
2b3a302a | 676 | printk(KERN_ERR "%s: class_register failed\n", __func__); |
1da177e4 LT |
677 | return error; |
678 | } | |
679 | error = class_create_file(&firmware_class, &class_attr_timeout); | |
680 | if (error) { | |
681 | printk(KERN_ERR "%s: class_create_file failed\n", | |
2b3a302a | 682 | __func__); |
1da177e4 LT |
683 | class_unregister(&firmware_class); |
684 | } | |
685 | return error; | |
686 | ||
687 | } | |
688 | static void __exit | |
689 | firmware_class_exit(void) | |
690 | { | |
691 | class_unregister(&firmware_class); | |
692 | } | |
693 | ||
a30a6a2c | 694 | fs_initcall(firmware_class_init); |
1da177e4 LT |
695 | module_exit(firmware_class_exit); |
696 | ||
697 | EXPORT_SYMBOL(release_firmware); | |
698 | EXPORT_SYMBOL(request_firmware); | |
699 | EXPORT_SYMBOL(request_firmware_nowait); |