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