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