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