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