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> |
abb139e7 | 24 | #include <linux/file.h> |
1f2b7959 | 25 | #include <linux/list.h> |
37276a51 ML |
26 | #include <linux/async.h> |
27 | #include <linux/pm.h> | |
07646d9c | 28 | #include <linux/suspend.h> |
ac39b3ea | 29 | #include <linux/syscore_ops.h> |
37276a51 | 30 | |
abb139e7 LT |
31 | #include <generated/utsrelease.h> |
32 | ||
37276a51 | 33 | #include "base.h" |
1da177e4 | 34 | |
87d37a4f | 35 | MODULE_AUTHOR("Manuel Estrada Sainz"); |
1da177e4 LT |
36 | MODULE_DESCRIPTION("Multi purpose firmware loading support"); |
37 | MODULE_LICENSE("GPL"); | |
38 | ||
bcb9bd18 DT |
39 | /* Builtin firmware support */ |
40 | ||
41 | #ifdef CONFIG_FW_LOADER | |
42 | ||
43 | extern struct builtin_fw __start_builtin_fw[]; | |
44 | extern struct builtin_fw __end_builtin_fw[]; | |
45 | ||
46 | static bool fw_get_builtin_firmware(struct firmware *fw, const char *name) | |
47 | { | |
48 | struct builtin_fw *b_fw; | |
49 | ||
50 | for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++) { | |
51 | if (strcmp(name, b_fw->name) == 0) { | |
52 | fw->size = b_fw->size; | |
53 | fw->data = b_fw->data; | |
54 | return true; | |
55 | } | |
56 | } | |
57 | ||
58 | return false; | |
59 | } | |
60 | ||
61 | static bool fw_is_builtin_firmware(const struct firmware *fw) | |
62 | { | |
63 | struct builtin_fw *b_fw; | |
64 | ||
65 | for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++) | |
66 | if (fw->data == b_fw->data) | |
67 | return true; | |
68 | ||
69 | return false; | |
70 | } | |
71 | ||
72 | #else /* Module case - no builtin firmware support */ | |
73 | ||
74 | static inline bool fw_get_builtin_firmware(struct firmware *fw, const char *name) | |
75 | { | |
76 | return false; | |
77 | } | |
78 | ||
79 | static inline bool fw_is_builtin_firmware(const struct firmware *fw) | |
80 | { | |
81 | return false; | |
82 | } | |
83 | #endif | |
84 | ||
1da177e4 LT |
85 | enum { |
86 | FW_STATUS_LOADING, | |
87 | FW_STATUS_DONE, | |
88 | FW_STATUS_ABORT, | |
1da177e4 LT |
89 | }; |
90 | ||
746058f4 ML |
91 | enum fw_buf_fmt { |
92 | VMALLOC_BUF, /* used in direct loading */ | |
93 | PAGE_BUF, /* used in loading via userspace */ | |
94 | }; | |
95 | ||
2f65168d | 96 | static int loading_timeout = 60; /* In seconds */ |
1da177e4 | 97 | |
9b78c1da RW |
98 | static inline long firmware_loading_timeout(void) |
99 | { | |
100 | return loading_timeout > 0 ? loading_timeout * HZ : MAX_SCHEDULE_TIMEOUT; | |
101 | } | |
102 | ||
1f2b7959 ML |
103 | struct firmware_cache { |
104 | /* firmware_buf instance will be added into the below list */ | |
105 | spinlock_t lock; | |
106 | struct list_head head; | |
cfe016b1 | 107 | int state; |
37276a51 | 108 | |
cfe016b1 | 109 | #ifdef CONFIG_PM_SLEEP |
37276a51 ML |
110 | /* |
111 | * Names of firmware images which have been cached successfully | |
112 | * will be added into the below list so that device uncache | |
113 | * helper can trace which firmware images have been cached | |
114 | * before. | |
115 | */ | |
116 | spinlock_t name_lock; | |
117 | struct list_head fw_names; | |
118 | ||
119 | wait_queue_head_t wait_queue; | |
120 | int cnt; | |
121 | struct delayed_work work; | |
07646d9c ML |
122 | |
123 | struct notifier_block pm_notify; | |
cfe016b1 | 124 | #endif |
1f2b7959 | 125 | }; |
1da177e4 | 126 | |
1244691c | 127 | struct firmware_buf { |
1f2b7959 ML |
128 | struct kref ref; |
129 | struct list_head list; | |
1da177e4 | 130 | struct completion completion; |
1f2b7959 | 131 | struct firmware_cache *fwc; |
1da177e4 | 132 | unsigned long status; |
746058f4 | 133 | enum fw_buf_fmt fmt; |
65710cb6 ML |
134 | void *data; |
135 | size_t size; | |
6e03a201 DW |
136 | struct page **pages; |
137 | int nr_pages; | |
138 | int page_array_size; | |
1244691c ML |
139 | char fw_id[]; |
140 | }; | |
141 | ||
37276a51 ML |
142 | struct fw_cache_entry { |
143 | struct list_head list; | |
144 | char name[]; | |
145 | }; | |
146 | ||
1244691c | 147 | struct firmware_priv { |
1da177e4 | 148 | struct timer_list timeout; |
e9045f91 | 149 | bool nowait; |
1244691c ML |
150 | struct device dev; |
151 | struct firmware_buf *buf; | |
1f2b7959 | 152 | struct firmware *fw; |
1da177e4 LT |
153 | }; |
154 | ||
f531f05a ML |
155 | struct fw_name_devm { |
156 | unsigned long magic; | |
157 | char name[]; | |
158 | }; | |
159 | ||
1f2b7959 ML |
160 | #define to_fwbuf(d) container_of(d, struct firmware_buf, ref) |
161 | ||
ac39b3ea ML |
162 | #define FW_LOADER_NO_CACHE 0 |
163 | #define FW_LOADER_START_CACHE 1 | |
164 | ||
165 | static int fw_cache_piggyback_on_request(const char *name); | |
166 | ||
1f2b7959 ML |
167 | /* fw_lock could be moved to 'struct firmware_priv' but since it is just |
168 | * guarding for corner cases a global lock should be OK */ | |
169 | static DEFINE_MUTEX(fw_lock); | |
170 | ||
171 | static struct firmware_cache fw_cache; | |
172 | ||
173 | static struct firmware_buf *__allocate_fw_buf(const char *fw_name, | |
174 | struct firmware_cache *fwc) | |
175 | { | |
176 | struct firmware_buf *buf; | |
177 | ||
178 | buf = kzalloc(sizeof(*buf) + strlen(fw_name) + 1 , GFP_ATOMIC); | |
179 | ||
180 | if (!buf) | |
181 | return buf; | |
182 | ||
183 | kref_init(&buf->ref); | |
184 | strcpy(buf->fw_id, fw_name); | |
185 | buf->fwc = fwc; | |
186 | init_completion(&buf->completion); | |
746058f4 | 187 | buf->fmt = VMALLOC_BUF; |
1f2b7959 ML |
188 | |
189 | pr_debug("%s: fw-%s buf=%p\n", __func__, fw_name, buf); | |
190 | ||
191 | return buf; | |
192 | } | |
193 | ||
2887b395 ML |
194 | static struct firmware_buf *__fw_lookup_buf(const char *fw_name) |
195 | { | |
196 | struct firmware_buf *tmp; | |
197 | struct firmware_cache *fwc = &fw_cache; | |
198 | ||
199 | list_for_each_entry(tmp, &fwc->head, list) | |
200 | if (!strcmp(tmp->fw_id, fw_name)) | |
201 | return tmp; | |
202 | return NULL; | |
203 | } | |
204 | ||
1f2b7959 ML |
205 | static int fw_lookup_and_allocate_buf(const char *fw_name, |
206 | struct firmware_cache *fwc, | |
207 | struct firmware_buf **buf) | |
208 | { | |
209 | struct firmware_buf *tmp; | |
210 | ||
211 | spin_lock(&fwc->lock); | |
2887b395 ML |
212 | tmp = __fw_lookup_buf(fw_name); |
213 | if (tmp) { | |
214 | kref_get(&tmp->ref); | |
215 | spin_unlock(&fwc->lock); | |
216 | *buf = tmp; | |
217 | return 1; | |
218 | } | |
1f2b7959 ML |
219 | tmp = __allocate_fw_buf(fw_name, fwc); |
220 | if (tmp) | |
221 | list_add(&tmp->list, &fwc->head); | |
222 | spin_unlock(&fwc->lock); | |
223 | ||
224 | *buf = tmp; | |
225 | ||
226 | return tmp ? 0 : -ENOMEM; | |
227 | } | |
228 | ||
2887b395 ML |
229 | static struct firmware_buf *fw_lookup_buf(const char *fw_name) |
230 | { | |
231 | struct firmware_buf *tmp; | |
232 | struct firmware_cache *fwc = &fw_cache; | |
233 | ||
234 | spin_lock(&fwc->lock); | |
235 | tmp = __fw_lookup_buf(fw_name); | |
236 | spin_unlock(&fwc->lock); | |
237 | ||
238 | return tmp; | |
239 | } | |
240 | ||
1f2b7959 ML |
241 | static void __fw_free_buf(struct kref *ref) |
242 | { | |
243 | struct firmware_buf *buf = to_fwbuf(ref); | |
244 | struct firmware_cache *fwc = buf->fwc; | |
245 | int i; | |
246 | ||
247 | pr_debug("%s: fw-%s buf=%p data=%p size=%u\n", | |
248 | __func__, buf->fw_id, buf, buf->data, | |
249 | (unsigned int)buf->size); | |
250 | ||
251 | spin_lock(&fwc->lock); | |
252 | list_del(&buf->list); | |
253 | spin_unlock(&fwc->lock); | |
254 | ||
746058f4 ML |
255 | |
256 | if (buf->fmt == PAGE_BUF) { | |
257 | vunmap(buf->data); | |
258 | for (i = 0; i < buf->nr_pages; i++) | |
259 | __free_page(buf->pages[i]); | |
260 | kfree(buf->pages); | |
261 | } else | |
262 | vfree(buf->data); | |
1f2b7959 ML |
263 | kfree(buf); |
264 | } | |
265 | ||
266 | static void fw_free_buf(struct firmware_buf *buf) | |
267 | { | |
268 | kref_put(&buf->ref, __fw_free_buf); | |
269 | } | |
270 | ||
746058f4 ML |
271 | /* direct firmware loading support */ |
272 | static const char *fw_path[] = { | |
273 | "/lib/firmware/updates/" UTS_RELEASE, | |
274 | "/lib/firmware/updates", | |
275 | "/lib/firmware/" UTS_RELEASE, | |
276 | "/lib/firmware" | |
277 | }; | |
278 | ||
279 | /* Don't inline this: 'struct kstat' is biggish */ | |
280 | static noinline long fw_file_size(struct file *file) | |
281 | { | |
282 | struct kstat st; | |
283 | if (vfs_getattr(file->f_path.mnt, file->f_path.dentry, &st)) | |
284 | return -1; | |
285 | if (!S_ISREG(st.mode)) | |
286 | return -1; | |
287 | if (st.size != (long)st.size) | |
288 | return -1; | |
289 | return st.size; | |
290 | } | |
291 | ||
292 | static bool fw_read_file_contents(struct file *file, struct firmware_buf *fw_buf) | |
293 | { | |
294 | long size; | |
295 | char *buf; | |
296 | ||
297 | size = fw_file_size(file); | |
298 | if (size < 0) | |
299 | return false; | |
300 | buf = vmalloc(size); | |
301 | if (!buf) | |
302 | return false; | |
303 | if (kernel_read(file, 0, buf, size) != size) { | |
304 | vfree(buf); | |
305 | return false; | |
306 | } | |
307 | fw_buf->data = buf; | |
308 | fw_buf->size = size; | |
309 | return true; | |
310 | } | |
311 | ||
312 | static bool fw_get_filesystem_firmware(struct firmware_buf *buf) | |
313 | { | |
314 | int i; | |
315 | bool success = false; | |
316 | char *path = __getname(); | |
317 | ||
318 | for (i = 0; i < ARRAY_SIZE(fw_path); i++) { | |
319 | struct file *file; | |
320 | snprintf(path, PATH_MAX, "%s/%s", fw_path[i], buf->fw_id); | |
321 | ||
322 | file = filp_open(path, O_RDONLY, 0); | |
323 | if (IS_ERR(file)) | |
324 | continue; | |
325 | success = fw_read_file_contents(file, buf); | |
326 | fput(file); | |
327 | if (success) | |
328 | break; | |
329 | } | |
330 | __putname(path); | |
331 | return success; | |
332 | } | |
333 | ||
f8a4bd34 DT |
334 | static struct firmware_priv *to_firmware_priv(struct device *dev) |
335 | { | |
336 | return container_of(dev, struct firmware_priv, dev); | |
337 | } | |
338 | ||
339 | static void fw_load_abort(struct firmware_priv *fw_priv) | |
1da177e4 | 340 | { |
1244691c ML |
341 | struct firmware_buf *buf = fw_priv->buf; |
342 | ||
343 | set_bit(FW_STATUS_ABORT, &buf->status); | |
1f2b7959 | 344 | complete_all(&buf->completion); |
1da177e4 LT |
345 | } |
346 | ||
f8a4bd34 DT |
347 | static ssize_t firmware_timeout_show(struct class *class, |
348 | struct class_attribute *attr, | |
349 | char *buf) | |
1da177e4 LT |
350 | { |
351 | return sprintf(buf, "%d\n", loading_timeout); | |
352 | } | |
353 | ||
354 | /** | |
eb8e3179 RD |
355 | * firmware_timeout_store - set number of seconds to wait for firmware |
356 | * @class: device class pointer | |
e59817bf | 357 | * @attr: device attribute pointer |
eb8e3179 RD |
358 | * @buf: buffer to scan for timeout value |
359 | * @count: number of bytes in @buf | |
360 | * | |
1da177e4 | 361 | * Sets the number of seconds to wait for the firmware. Once |
eb8e3179 | 362 | * this expires an error will be returned to the driver and no |
1da177e4 LT |
363 | * firmware will be provided. |
364 | * | |
eb8e3179 | 365 | * Note: zero means 'wait forever'. |
1da177e4 | 366 | **/ |
f8a4bd34 DT |
367 | static ssize_t firmware_timeout_store(struct class *class, |
368 | struct class_attribute *attr, | |
369 | const char *buf, size_t count) | |
1da177e4 LT |
370 | { |
371 | loading_timeout = simple_strtol(buf, NULL, 10); | |
b92eac01 SG |
372 | if (loading_timeout < 0) |
373 | loading_timeout = 0; | |
f8a4bd34 | 374 | |
1da177e4 LT |
375 | return count; |
376 | } | |
377 | ||
673fae90 DT |
378 | static struct class_attribute firmware_class_attrs[] = { |
379 | __ATTR(timeout, S_IWUSR | S_IRUGO, | |
380 | firmware_timeout_show, firmware_timeout_store), | |
381 | __ATTR_NULL | |
382 | }; | |
1da177e4 | 383 | |
1244691c ML |
384 | static void fw_dev_release(struct device *dev) |
385 | { | |
386 | struct firmware_priv *fw_priv = to_firmware_priv(dev); | |
65710cb6 | 387 | |
673fae90 | 388 | kfree(fw_priv); |
673fae90 DT |
389 | |
390 | module_put(THIS_MODULE); | |
391 | } | |
1da177e4 | 392 | |
7eff2e7a | 393 | static int firmware_uevent(struct device *dev, struct kobj_uevent_env *env) |
1da177e4 | 394 | { |
f8a4bd34 | 395 | struct firmware_priv *fw_priv = to_firmware_priv(dev); |
1da177e4 | 396 | |
1244691c | 397 | if (add_uevent_var(env, "FIRMWARE=%s", fw_priv->buf->fw_id)) |
1da177e4 | 398 | return -ENOMEM; |
7eff2e7a | 399 | if (add_uevent_var(env, "TIMEOUT=%i", loading_timeout)) |
6897089c | 400 | return -ENOMEM; |
e9045f91 JB |
401 | if (add_uevent_var(env, "ASYNC=%d", fw_priv->nowait)) |
402 | return -ENOMEM; | |
1da177e4 LT |
403 | |
404 | return 0; | |
405 | } | |
406 | ||
1b81d663 AB |
407 | static struct class firmware_class = { |
408 | .name = "firmware", | |
673fae90 | 409 | .class_attrs = firmware_class_attrs, |
e55c8790 GKH |
410 | .dev_uevent = firmware_uevent, |
411 | .dev_release = fw_dev_release, | |
1b81d663 AB |
412 | }; |
413 | ||
e55c8790 GKH |
414 | static ssize_t firmware_loading_show(struct device *dev, |
415 | struct device_attribute *attr, char *buf) | |
1da177e4 | 416 | { |
f8a4bd34 | 417 | struct firmware_priv *fw_priv = to_firmware_priv(dev); |
1244691c | 418 | int loading = test_bit(FW_STATUS_LOADING, &fw_priv->buf->status); |
f8a4bd34 | 419 | |
1da177e4 LT |
420 | return sprintf(buf, "%d\n", loading); |
421 | } | |
422 | ||
65710cb6 | 423 | /* firmware holds the ownership of pages */ |
dd336c55 DW |
424 | static void firmware_free_data(const struct firmware *fw) |
425 | { | |
abb139e7 LT |
426 | /* Loaded directly? */ |
427 | if (!fw->priv) { | |
428 | vfree(fw->data); | |
429 | return; | |
430 | } | |
1f2b7959 | 431 | fw_free_buf(fw->priv); |
dd336c55 DW |
432 | } |
433 | ||
6e03a201 DW |
434 | /* Some architectures don't have PAGE_KERNEL_RO */ |
435 | #ifndef PAGE_KERNEL_RO | |
436 | #define PAGE_KERNEL_RO PAGE_KERNEL | |
437 | #endif | |
253c9240 ML |
438 | |
439 | /* one pages buffer should be mapped/unmapped only once */ | |
440 | static int fw_map_pages_buf(struct firmware_buf *buf) | |
441 | { | |
746058f4 ML |
442 | if (buf->fmt != PAGE_BUF) |
443 | return 0; | |
444 | ||
253c9240 ML |
445 | if (buf->data) |
446 | vunmap(buf->data); | |
447 | buf->data = vmap(buf->pages, buf->nr_pages, 0, PAGE_KERNEL_RO); | |
448 | if (!buf->data) | |
449 | return -ENOMEM; | |
450 | return 0; | |
451 | } | |
452 | ||
1da177e4 | 453 | /** |
eb8e3179 | 454 | * firmware_loading_store - set value in the 'loading' control file |
e55c8790 | 455 | * @dev: device pointer |
af9997e4 | 456 | * @attr: device attribute pointer |
eb8e3179 RD |
457 | * @buf: buffer to scan for loading control value |
458 | * @count: number of bytes in @buf | |
459 | * | |
1da177e4 LT |
460 | * The relevant values are: |
461 | * | |
462 | * 1: Start a load, discarding any previous partial load. | |
eb8e3179 | 463 | * 0: Conclude the load and hand the data to the driver code. |
1da177e4 LT |
464 | * -1: Conclude the load with an error and discard any written data. |
465 | **/ | |
e55c8790 GKH |
466 | static ssize_t firmware_loading_store(struct device *dev, |
467 | struct device_attribute *attr, | |
468 | const char *buf, size_t count) | |
1da177e4 | 469 | { |
f8a4bd34 | 470 | struct firmware_priv *fw_priv = to_firmware_priv(dev); |
1244691c | 471 | struct firmware_buf *fw_buf = fw_priv->buf; |
1da177e4 | 472 | int loading = simple_strtol(buf, NULL, 10); |
6e03a201 | 473 | int i; |
1da177e4 | 474 | |
eea915bb NH |
475 | mutex_lock(&fw_lock); |
476 | ||
1244691c | 477 | if (!fw_buf) |
eea915bb NH |
478 | goto out; |
479 | ||
1da177e4 LT |
480 | switch (loading) { |
481 | case 1: | |
65710cb6 | 482 | /* discarding any previous partial load */ |
1244691c ML |
483 | if (!test_bit(FW_STATUS_DONE, &fw_buf->status)) { |
484 | for (i = 0; i < fw_buf->nr_pages; i++) | |
485 | __free_page(fw_buf->pages[i]); | |
486 | kfree(fw_buf->pages); | |
487 | fw_buf->pages = NULL; | |
488 | fw_buf->page_array_size = 0; | |
489 | fw_buf->nr_pages = 0; | |
490 | set_bit(FW_STATUS_LOADING, &fw_buf->status); | |
28eefa75 | 491 | } |
1da177e4 LT |
492 | break; |
493 | case 0: | |
1244691c ML |
494 | if (test_bit(FW_STATUS_LOADING, &fw_buf->status)) { |
495 | set_bit(FW_STATUS_DONE, &fw_buf->status); | |
496 | clear_bit(FW_STATUS_LOADING, &fw_buf->status); | |
253c9240 ML |
497 | |
498 | /* | |
499 | * Several loading requests may be pending on | |
500 | * one same firmware buf, so let all requests | |
501 | * see the mapped 'buf->data' once the loading | |
502 | * is completed. | |
503 | * */ | |
504 | fw_map_pages_buf(fw_buf); | |
1f2b7959 | 505 | complete_all(&fw_buf->completion); |
1da177e4 LT |
506 | break; |
507 | } | |
508 | /* fallthrough */ | |
509 | default: | |
266a813c | 510 | dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading); |
1da177e4 LT |
511 | /* fallthrough */ |
512 | case -1: | |
513 | fw_load_abort(fw_priv); | |
514 | break; | |
515 | } | |
eea915bb NH |
516 | out: |
517 | mutex_unlock(&fw_lock); | |
1da177e4 LT |
518 | return count; |
519 | } | |
520 | ||
e55c8790 | 521 | static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store); |
1da177e4 | 522 | |
f8a4bd34 DT |
523 | static ssize_t firmware_data_read(struct file *filp, struct kobject *kobj, |
524 | struct bin_attribute *bin_attr, | |
525 | char *buffer, loff_t offset, size_t count) | |
1da177e4 | 526 | { |
b0d1f807 | 527 | struct device *dev = kobj_to_dev(kobj); |
f8a4bd34 | 528 | struct firmware_priv *fw_priv = to_firmware_priv(dev); |
1244691c | 529 | struct firmware_buf *buf; |
f37e6617 | 530 | ssize_t ret_count; |
1da177e4 | 531 | |
cad1e55d | 532 | mutex_lock(&fw_lock); |
1244691c ML |
533 | buf = fw_priv->buf; |
534 | if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) { | |
1da177e4 LT |
535 | ret_count = -ENODEV; |
536 | goto out; | |
537 | } | |
1244691c | 538 | if (offset > buf->size) { |
308975fa JS |
539 | ret_count = 0; |
540 | goto out; | |
541 | } | |
1244691c ML |
542 | if (count > buf->size - offset) |
543 | count = buf->size - offset; | |
6e03a201 DW |
544 | |
545 | ret_count = count; | |
546 | ||
547 | while (count) { | |
548 | void *page_data; | |
549 | int page_nr = offset >> PAGE_SHIFT; | |
550 | int page_ofs = offset & (PAGE_SIZE-1); | |
551 | int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count); | |
552 | ||
1244691c | 553 | page_data = kmap(buf->pages[page_nr]); |
6e03a201 DW |
554 | |
555 | memcpy(buffer, page_data + page_ofs, page_cnt); | |
556 | ||
1244691c | 557 | kunmap(buf->pages[page_nr]); |
6e03a201 DW |
558 | buffer += page_cnt; |
559 | offset += page_cnt; | |
560 | count -= page_cnt; | |
561 | } | |
1da177e4 | 562 | out: |
cad1e55d | 563 | mutex_unlock(&fw_lock); |
1da177e4 LT |
564 | return ret_count; |
565 | } | |
eb8e3179 | 566 | |
f8a4bd34 | 567 | static int fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size) |
1da177e4 | 568 | { |
1244691c | 569 | struct firmware_buf *buf = fw_priv->buf; |
6e03a201 DW |
570 | int pages_needed = ALIGN(min_size, PAGE_SIZE) >> PAGE_SHIFT; |
571 | ||
572 | /* If the array of pages is too small, grow it... */ | |
1244691c | 573 | if (buf->page_array_size < pages_needed) { |
6e03a201 | 574 | int new_array_size = max(pages_needed, |
1244691c | 575 | buf->page_array_size * 2); |
6e03a201 DW |
576 | struct page **new_pages; |
577 | ||
578 | new_pages = kmalloc(new_array_size * sizeof(void *), | |
579 | GFP_KERNEL); | |
580 | if (!new_pages) { | |
581 | fw_load_abort(fw_priv); | |
582 | return -ENOMEM; | |
583 | } | |
1244691c ML |
584 | memcpy(new_pages, buf->pages, |
585 | buf->page_array_size * sizeof(void *)); | |
586 | memset(&new_pages[buf->page_array_size], 0, sizeof(void *) * | |
587 | (new_array_size - buf->page_array_size)); | |
588 | kfree(buf->pages); | |
589 | buf->pages = new_pages; | |
590 | buf->page_array_size = new_array_size; | |
6e03a201 | 591 | } |
1da177e4 | 592 | |
1244691c ML |
593 | while (buf->nr_pages < pages_needed) { |
594 | buf->pages[buf->nr_pages] = | |
6e03a201 | 595 | alloc_page(GFP_KERNEL | __GFP_HIGHMEM); |
1da177e4 | 596 | |
1244691c | 597 | if (!buf->pages[buf->nr_pages]) { |
6e03a201 DW |
598 | fw_load_abort(fw_priv); |
599 | return -ENOMEM; | |
600 | } | |
1244691c | 601 | buf->nr_pages++; |
1da177e4 | 602 | } |
1da177e4 LT |
603 | return 0; |
604 | } | |
605 | ||
606 | /** | |
eb8e3179 | 607 | * firmware_data_write - write method for firmware |
2c3c8bea | 608 | * @filp: open sysfs file |
e55c8790 | 609 | * @kobj: kobject for the device |
42e61f4a | 610 | * @bin_attr: bin_attr structure |
eb8e3179 RD |
611 | * @buffer: buffer being written |
612 | * @offset: buffer offset for write in total data store area | |
613 | * @count: buffer size | |
1da177e4 | 614 | * |
eb8e3179 | 615 | * Data written to the 'data' attribute will be later handed to |
1da177e4 LT |
616 | * the driver as a firmware image. |
617 | **/ | |
f8a4bd34 DT |
618 | static ssize_t firmware_data_write(struct file *filp, struct kobject *kobj, |
619 | struct bin_attribute *bin_attr, | |
620 | char *buffer, loff_t offset, size_t count) | |
1da177e4 | 621 | { |
b0d1f807 | 622 | struct device *dev = kobj_to_dev(kobj); |
f8a4bd34 | 623 | struct firmware_priv *fw_priv = to_firmware_priv(dev); |
1244691c | 624 | struct firmware_buf *buf; |
1da177e4 LT |
625 | ssize_t retval; |
626 | ||
627 | if (!capable(CAP_SYS_RAWIO)) | |
628 | return -EPERM; | |
b92eac01 | 629 | |
cad1e55d | 630 | mutex_lock(&fw_lock); |
1244691c ML |
631 | buf = fw_priv->buf; |
632 | if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) { | |
1da177e4 LT |
633 | retval = -ENODEV; |
634 | goto out; | |
635 | } | |
65710cb6 | 636 | |
1da177e4 LT |
637 | retval = fw_realloc_buffer(fw_priv, offset + count); |
638 | if (retval) | |
639 | goto out; | |
640 | ||
1da177e4 | 641 | retval = count; |
6e03a201 DW |
642 | |
643 | while (count) { | |
644 | void *page_data; | |
645 | int page_nr = offset >> PAGE_SHIFT; | |
646 | int page_ofs = offset & (PAGE_SIZE - 1); | |
647 | int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count); | |
648 | ||
1244691c | 649 | page_data = kmap(buf->pages[page_nr]); |
6e03a201 DW |
650 | |
651 | memcpy(page_data + page_ofs, buffer, page_cnt); | |
652 | ||
1244691c | 653 | kunmap(buf->pages[page_nr]); |
6e03a201 DW |
654 | buffer += page_cnt; |
655 | offset += page_cnt; | |
656 | count -= page_cnt; | |
657 | } | |
658 | ||
1244691c | 659 | buf->size = max_t(size_t, offset, buf->size); |
1da177e4 | 660 | out: |
cad1e55d | 661 | mutex_unlock(&fw_lock); |
1da177e4 LT |
662 | return retval; |
663 | } | |
eb8e3179 | 664 | |
0983ca2d DT |
665 | static struct bin_attribute firmware_attr_data = { |
666 | .attr = { .name = "data", .mode = 0644 }, | |
1da177e4 LT |
667 | .size = 0, |
668 | .read = firmware_data_read, | |
669 | .write = firmware_data_write, | |
670 | }; | |
671 | ||
f8a4bd34 | 672 | static void firmware_class_timeout(u_long data) |
1da177e4 LT |
673 | { |
674 | struct firmware_priv *fw_priv = (struct firmware_priv *) data; | |
f8a4bd34 | 675 | |
1da177e4 LT |
676 | fw_load_abort(fw_priv); |
677 | } | |
678 | ||
f8a4bd34 | 679 | static struct firmware_priv * |
dddb5549 | 680 | fw_create_instance(struct firmware *firmware, const char *fw_name, |
f8a4bd34 | 681 | struct device *device, bool uevent, bool nowait) |
1da177e4 | 682 | { |
f8a4bd34 DT |
683 | struct firmware_priv *fw_priv; |
684 | struct device *f_dev; | |
1da177e4 | 685 | |
1244691c | 686 | fw_priv = kzalloc(sizeof(*fw_priv), GFP_KERNEL); |
f8a4bd34 | 687 | if (!fw_priv) { |
266a813c | 688 | dev_err(device, "%s: kmalloc failed\n", __func__); |
1244691c ML |
689 | fw_priv = ERR_PTR(-ENOMEM); |
690 | goto exit; | |
691 | } | |
692 | ||
f8a4bd34 | 693 | fw_priv->nowait = nowait; |
1f2b7959 | 694 | fw_priv->fw = firmware; |
f8a4bd34 DT |
695 | setup_timer(&fw_priv->timeout, |
696 | firmware_class_timeout, (u_long) fw_priv); | |
1da177e4 | 697 | |
f8a4bd34 DT |
698 | f_dev = &fw_priv->dev; |
699 | ||
700 | device_initialize(f_dev); | |
99c2aa72 | 701 | dev_set_name(f_dev, "%s", fw_name); |
e55c8790 GKH |
702 | f_dev->parent = device; |
703 | f_dev->class = &firmware_class; | |
1244691c | 704 | exit: |
f8a4bd34 | 705 | return fw_priv; |
1da177e4 LT |
706 | } |
707 | ||
1f2b7959 ML |
708 | /* store the pages buffer info firmware from buf */ |
709 | static void fw_set_page_data(struct firmware_buf *buf, struct firmware *fw) | |
710 | { | |
711 | fw->priv = buf; | |
712 | fw->pages = buf->pages; | |
713 | fw->size = buf->size; | |
714 | fw->data = buf->data; | |
715 | ||
716 | pr_debug("%s: fw-%s buf=%p data=%p size=%u\n", | |
717 | __func__, buf->fw_id, buf, buf->data, | |
718 | (unsigned int)buf->size); | |
719 | } | |
720 | ||
cfe016b1 | 721 | #ifdef CONFIG_PM_SLEEP |
f531f05a ML |
722 | static void fw_name_devm_release(struct device *dev, void *res) |
723 | { | |
724 | struct fw_name_devm *fwn = res; | |
725 | ||
726 | if (fwn->magic == (unsigned long)&fw_cache) | |
727 | pr_debug("%s: fw_name-%s devm-%p released\n", | |
728 | __func__, fwn->name, res); | |
729 | } | |
730 | ||
731 | static int fw_devm_match(struct device *dev, void *res, | |
732 | void *match_data) | |
733 | { | |
734 | struct fw_name_devm *fwn = res; | |
735 | ||
736 | return (fwn->magic == (unsigned long)&fw_cache) && | |
737 | !strcmp(fwn->name, match_data); | |
738 | } | |
739 | ||
740 | static struct fw_name_devm *fw_find_devm_name(struct device *dev, | |
741 | const char *name) | |
742 | { | |
743 | struct fw_name_devm *fwn; | |
744 | ||
745 | fwn = devres_find(dev, fw_name_devm_release, | |
746 | fw_devm_match, (void *)name); | |
747 | return fwn; | |
748 | } | |
749 | ||
750 | /* add firmware name into devres list */ | |
751 | static int fw_add_devm_name(struct device *dev, const char *name) | |
752 | { | |
753 | struct fw_name_devm *fwn; | |
754 | ||
755 | fwn = fw_find_devm_name(dev, name); | |
756 | if (fwn) | |
757 | return 1; | |
758 | ||
759 | fwn = devres_alloc(fw_name_devm_release, sizeof(struct fw_name_devm) + | |
760 | strlen(name) + 1, GFP_KERNEL); | |
761 | if (!fwn) | |
762 | return -ENOMEM; | |
763 | ||
764 | fwn->magic = (unsigned long)&fw_cache; | |
765 | strcpy(fwn->name, name); | |
766 | devres_add(dev, fwn); | |
767 | ||
768 | return 0; | |
769 | } | |
cfe016b1 ML |
770 | #else |
771 | static int fw_add_devm_name(struct device *dev, const char *name) | |
772 | { | |
773 | return 0; | |
774 | } | |
775 | #endif | |
f531f05a | 776 | |
1f2b7959 ML |
777 | static void _request_firmware_cleanup(const struct firmware **firmware_p) |
778 | { | |
779 | release_firmware(*firmware_p); | |
780 | *firmware_p = NULL; | |
781 | } | |
782 | ||
dddb5549 SB |
783 | static struct firmware_priv * |
784 | _request_firmware_prepare(const struct firmware **firmware_p, const char *name, | |
785 | struct device *device, bool uevent, bool nowait) | |
1da177e4 | 786 | { |
1da177e4 | 787 | struct firmware *firmware; |
1f2b7959 ML |
788 | struct firmware_priv *fw_priv = NULL; |
789 | struct firmware_buf *buf; | |
790 | int ret; | |
1da177e4 LT |
791 | |
792 | if (!firmware_p) | |
dddb5549 | 793 | return ERR_PTR(-EINVAL); |
1da177e4 | 794 | |
4aed0644 | 795 | *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL); |
1da177e4 | 796 | if (!firmware) { |
266a813c BH |
797 | dev_err(device, "%s: kmalloc(struct firmware) failed\n", |
798 | __func__); | |
dddb5549 | 799 | return ERR_PTR(-ENOMEM); |
1da177e4 | 800 | } |
1da177e4 | 801 | |
bcb9bd18 | 802 | if (fw_get_builtin_firmware(firmware, name)) { |
6f18ff91 | 803 | dev_dbg(device, "firmware: using built-in firmware %s\n", name); |
dddb5549 | 804 | return NULL; |
5658c769 DW |
805 | } |
806 | ||
1f2b7959 ML |
807 | ret = fw_lookup_and_allocate_buf(name, &fw_cache, &buf); |
808 | if (!ret) | |
809 | fw_priv = fw_create_instance(firmware, name, device, | |
810 | uevent, nowait); | |
811 | ||
812 | if (IS_ERR(fw_priv) || ret < 0) { | |
813 | kfree(firmware); | |
dddb5549 | 814 | *firmware_p = NULL; |
1f2b7959 ML |
815 | return ERR_PTR(-ENOMEM); |
816 | } else if (fw_priv) { | |
817 | fw_priv->buf = buf; | |
818 | ||
819 | /* | |
820 | * bind with 'buf' now to avoid warning in failure path | |
821 | * of requesting firmware. | |
822 | */ | |
823 | firmware->priv = buf; | |
824 | return fw_priv; | |
dddb5549 | 825 | } |
811fa400 | 826 | |
1f2b7959 ML |
827 | /* share the cached buf, which is inprogessing or completed */ |
828 | check_status: | |
829 | mutex_lock(&fw_lock); | |
830 | if (test_bit(FW_STATUS_ABORT, &buf->status)) { | |
831 | fw_priv = ERR_PTR(-ENOENT); | |
ef40bb1b | 832 | firmware->priv = buf; |
1f2b7959 ML |
833 | _request_firmware_cleanup(firmware_p); |
834 | goto exit; | |
835 | } else if (test_bit(FW_STATUS_DONE, &buf->status)) { | |
836 | fw_priv = NULL; | |
837 | fw_set_page_data(buf, firmware); | |
838 | goto exit; | |
839 | } | |
840 | mutex_unlock(&fw_lock); | |
841 | wait_for_completion(&buf->completion); | |
842 | goto check_status; | |
65710cb6 | 843 | |
1f2b7959 ML |
844 | exit: |
845 | mutex_unlock(&fw_lock); | |
846 | return fw_priv; | |
65710cb6 ML |
847 | } |
848 | ||
dddb5549 SB |
849 | static int _request_firmware_load(struct firmware_priv *fw_priv, bool uevent, |
850 | long timeout) | |
811fa400 | 851 | { |
9b78c1da | 852 | int retval = 0; |
dddb5549 | 853 | struct device *f_dev = &fw_priv->dev; |
1244691c | 854 | struct firmware_buf *buf = fw_priv->buf; |
ac39b3ea | 855 | struct firmware_cache *fwc = &fw_cache; |
746058f4 ML |
856 | int direct_load = 0; |
857 | ||
858 | /* try direct loading from fs first */ | |
859 | if (fw_get_filesystem_firmware(buf)) { | |
860 | dev_dbg(f_dev->parent, "firmware: direct-loading" | |
861 | " firmware %s\n", buf->fw_id); | |
862 | ||
863 | set_bit(FW_STATUS_DONE, &buf->status); | |
864 | complete_all(&buf->completion); | |
865 | direct_load = 1; | |
866 | goto handle_fw; | |
867 | } | |
868 | ||
869 | /* fall back on userspace loading */ | |
870 | buf->fmt = PAGE_BUF; | |
dddb5549 SB |
871 | |
872 | dev_set_uevent_suppress(f_dev, true); | |
caca9510 | 873 | |
dddb5549 SB |
874 | /* Need to pin this module until class device is destroyed */ |
875 | __module_get(THIS_MODULE); | |
5658c769 | 876 | |
dddb5549 SB |
877 | retval = device_add(f_dev); |
878 | if (retval) { | |
879 | dev_err(f_dev, "%s: device_register failed\n", __func__); | |
880 | goto err_put_dev; | |
881 | } | |
882 | ||
883 | retval = device_create_bin_file(f_dev, &firmware_attr_data); | |
884 | if (retval) { | |
885 | dev_err(f_dev, "%s: sysfs_create_bin_file failed\n", __func__); | |
886 | goto err_del_dev; | |
887 | } | |
888 | ||
889 | retval = device_create_file(f_dev, &dev_attr_loading); | |
890 | if (retval) { | |
891 | dev_err(f_dev, "%s: device_create_file failed\n", __func__); | |
892 | goto err_del_bin_attr; | |
893 | } | |
1da177e4 | 894 | |
312c004d | 895 | if (uevent) { |
dddb5549 | 896 | dev_set_uevent_suppress(f_dev, false); |
1244691c | 897 | dev_dbg(f_dev, "firmware: requesting %s\n", buf->fw_id); |
9b78c1da | 898 | if (timeout != MAX_SCHEDULE_TIMEOUT) |
f8a4bd34 | 899 | mod_timer(&fw_priv->timeout, |
9b78c1da | 900 | round_jiffies_up(jiffies + timeout)); |
f8a4bd34 DT |
901 | |
902 | kobject_uevent(&fw_priv->dev.kobj, KOBJ_ADD); | |
903 | } | |
904 | ||
1244691c | 905 | wait_for_completion(&buf->completion); |
1da177e4 | 906 | |
f8a4bd34 | 907 | del_timer_sync(&fw_priv->timeout); |
1da177e4 | 908 | |
746058f4 | 909 | handle_fw: |
cad1e55d | 910 | mutex_lock(&fw_lock); |
1244691c | 911 | if (!buf->size || test_bit(FW_STATUS_ABORT, &buf->status)) |
1da177e4 | 912 | retval = -ENOENT; |
65710cb6 | 913 | |
f531f05a ML |
914 | /* |
915 | * add firmware name into devres list so that we can auto cache | |
916 | * and uncache firmware for device. | |
917 | * | |
918 | * f_dev->parent may has been deleted already, but the problem | |
919 | * should be fixed in devres or driver core. | |
920 | */ | |
921 | if (!retval && f_dev->parent) | |
922 | fw_add_devm_name(f_dev->parent, buf->fw_id); | |
923 | ||
ac39b3ea ML |
924 | /* |
925 | * After caching firmware image is started, let it piggyback | |
926 | * on request firmware. | |
927 | */ | |
928 | if (!retval && fwc->state == FW_LOADER_START_CACHE) { | |
929 | if (fw_cache_piggyback_on_request(buf->fw_id)) | |
930 | kref_get(&buf->ref); | |
931 | } | |
932 | ||
1f2b7959 ML |
933 | /* pass the pages buffer to driver at the last minute */ |
934 | fw_set_page_data(buf, fw_priv->fw); | |
1244691c | 935 | |
1244691c | 936 | fw_priv->buf = NULL; |
cad1e55d | 937 | mutex_unlock(&fw_lock); |
1da177e4 | 938 | |
746058f4 ML |
939 | if (direct_load) |
940 | goto err_put_dev; | |
941 | ||
dddb5549 SB |
942 | device_remove_file(f_dev, &dev_attr_loading); |
943 | err_del_bin_attr: | |
944 | device_remove_bin_file(f_dev, &firmware_attr_data); | |
945 | err_del_dev: | |
946 | device_del(f_dev); | |
947 | err_put_dev: | |
948 | put_device(f_dev); | |
1da177e4 LT |
949 | return retval; |
950 | } | |
951 | ||
6e3eaab0 | 952 | /** |
312c004d | 953 | * request_firmware: - send firmware request and wait for it |
eb8e3179 RD |
954 | * @firmware_p: pointer to firmware image |
955 | * @name: name of firmware file | |
956 | * @device: device for which firmware is being loaded | |
957 | * | |
958 | * @firmware_p will be used to return a firmware image by the name | |
6e3eaab0 AS |
959 | * of @name for device @device. |
960 | * | |
961 | * Should be called from user context where sleeping is allowed. | |
962 | * | |
312c004d | 963 | * @name will be used as $FIRMWARE in the uevent environment and |
6e3eaab0 AS |
964 | * should be distinctive enough not to be confused with any other |
965 | * firmware image for this or any other device. | |
0cfc1e1e ML |
966 | * |
967 | * Caller must hold the reference count of @device. | |
6e3eaab0 AS |
968 | **/ |
969 | int | |
970 | request_firmware(const struct firmware **firmware_p, const char *name, | |
971 | struct device *device) | |
972 | { | |
dddb5549 | 973 | struct firmware_priv *fw_priv; |
811fa400 RW |
974 | int ret; |
975 | ||
dddb5549 SB |
976 | fw_priv = _request_firmware_prepare(firmware_p, name, device, true, |
977 | false); | |
978 | if (IS_ERR_OR_NULL(fw_priv)) | |
979 | return PTR_RET(fw_priv); | |
811fa400 | 980 | |
9b78c1da RW |
981 | ret = usermodehelper_read_trylock(); |
982 | if (WARN_ON(ret)) { | |
983 | dev_err(device, "firmware: %s will not be loaded\n", name); | |
984 | } else { | |
dddb5549 | 985 | ret = _request_firmware_load(fw_priv, true, |
9b78c1da RW |
986 | firmware_loading_timeout()); |
987 | usermodehelper_read_unlock(); | |
988 | } | |
811fa400 RW |
989 | if (ret) |
990 | _request_firmware_cleanup(firmware_p); | |
991 | ||
992 | return ret; | |
6e3eaab0 AS |
993 | } |
994 | ||
1da177e4 LT |
995 | /** |
996 | * release_firmware: - release the resource associated with a firmware image | |
eb8e3179 | 997 | * @fw: firmware resource to release |
1da177e4 | 998 | **/ |
bcb9bd18 | 999 | void release_firmware(const struct firmware *fw) |
1da177e4 LT |
1000 | { |
1001 | if (fw) { | |
bcb9bd18 DT |
1002 | if (!fw_is_builtin_firmware(fw)) |
1003 | firmware_free_data(fw); | |
1da177e4 LT |
1004 | kfree(fw); |
1005 | } | |
1006 | } | |
1007 | ||
1da177e4 LT |
1008 | /* Async support */ |
1009 | struct firmware_work { | |
1010 | struct work_struct work; | |
1011 | struct module *module; | |
1012 | const char *name; | |
1013 | struct device *device; | |
1014 | void *context; | |
1015 | void (*cont)(const struct firmware *fw, void *context); | |
072fc8f0 | 1016 | bool uevent; |
1da177e4 LT |
1017 | }; |
1018 | ||
a36cf844 | 1019 | static void request_firmware_work_func(struct work_struct *work) |
1da177e4 | 1020 | { |
a36cf844 | 1021 | struct firmware_work *fw_work; |
1da177e4 | 1022 | const struct firmware *fw; |
dddb5549 | 1023 | struct firmware_priv *fw_priv; |
9b78c1da | 1024 | long timeout; |
113fab13 | 1025 | int ret; |
f8a4bd34 | 1026 | |
a36cf844 | 1027 | fw_work = container_of(work, struct firmware_work, work); |
dddb5549 SB |
1028 | fw_priv = _request_firmware_prepare(&fw, fw_work->name, fw_work->device, |
1029 | fw_work->uevent, true); | |
1030 | if (IS_ERR_OR_NULL(fw_priv)) { | |
1031 | ret = PTR_RET(fw_priv); | |
811fa400 | 1032 | goto out; |
dddb5549 | 1033 | } |
811fa400 | 1034 | |
9b78c1da RW |
1035 | timeout = usermodehelper_read_lock_wait(firmware_loading_timeout()); |
1036 | if (timeout) { | |
dddb5549 | 1037 | ret = _request_firmware_load(fw_priv, fw_work->uevent, timeout); |
9b78c1da RW |
1038 | usermodehelper_read_unlock(); |
1039 | } else { | |
1040 | dev_dbg(fw_work->device, "firmware: %s loading timed out\n", | |
1041 | fw_work->name); | |
1042 | ret = -EAGAIN; | |
1043 | } | |
811fa400 RW |
1044 | if (ret) |
1045 | _request_firmware_cleanup(&fw); | |
1046 | ||
1047 | out: | |
9ebfbd45 | 1048 | fw_work->cont(fw, fw_work->context); |
0cfc1e1e | 1049 | put_device(fw_work->device); |
9ebfbd45 | 1050 | |
1da177e4 LT |
1051 | module_put(fw_work->module); |
1052 | kfree(fw_work); | |
1da177e4 LT |
1053 | } |
1054 | ||
1055 | /** | |
3c31f07a | 1056 | * request_firmware_nowait - asynchronous version of request_firmware |
eb8e3179 | 1057 | * @module: module requesting the firmware |
312c004d | 1058 | * @uevent: sends uevent to copy the firmware image if this flag |
eb8e3179 RD |
1059 | * is non-zero else the firmware copy must be done manually. |
1060 | * @name: name of firmware file | |
1061 | * @device: device for which firmware is being loaded | |
9ebfbd45 | 1062 | * @gfp: allocation flags |
eb8e3179 RD |
1063 | * @context: will be passed over to @cont, and |
1064 | * @fw may be %NULL if firmware request fails. | |
1065 | * @cont: function will be called asynchronously when the firmware | |
1066 | * request is over. | |
1da177e4 | 1067 | * |
0cfc1e1e ML |
1068 | * Caller must hold the reference count of @device. |
1069 | * | |
6f21a62a ML |
1070 | * Asynchronous variant of request_firmware() for user contexts: |
1071 | * - sleep for as small periods as possible since it may | |
1072 | * increase kernel boot time of built-in device drivers | |
1073 | * requesting firmware in their ->probe() methods, if | |
1074 | * @gfp is GFP_KERNEL. | |
1075 | * | |
1076 | * - can't sleep at all if @gfp is GFP_ATOMIC. | |
1da177e4 LT |
1077 | **/ |
1078 | int | |
1079 | request_firmware_nowait( | |
072fc8f0 | 1080 | struct module *module, bool uevent, |
9ebfbd45 | 1081 | const char *name, struct device *device, gfp_t gfp, void *context, |
1da177e4 LT |
1082 | void (*cont)(const struct firmware *fw, void *context)) |
1083 | { | |
f8a4bd34 | 1084 | struct firmware_work *fw_work; |
1da177e4 | 1085 | |
f8a4bd34 | 1086 | fw_work = kzalloc(sizeof (struct firmware_work), gfp); |
1da177e4 LT |
1087 | if (!fw_work) |
1088 | return -ENOMEM; | |
f8a4bd34 DT |
1089 | |
1090 | fw_work->module = module; | |
1091 | fw_work->name = name; | |
1092 | fw_work->device = device; | |
1093 | fw_work->context = context; | |
1094 | fw_work->cont = cont; | |
1095 | fw_work->uevent = uevent; | |
1096 | ||
1da177e4 LT |
1097 | if (!try_module_get(module)) { |
1098 | kfree(fw_work); | |
1099 | return -EFAULT; | |
1100 | } | |
1101 | ||
0cfc1e1e | 1102 | get_device(fw_work->device); |
a36cf844 SB |
1103 | INIT_WORK(&fw_work->work, request_firmware_work_func); |
1104 | schedule_work(&fw_work->work); | |
1da177e4 LT |
1105 | return 0; |
1106 | } | |
1107 | ||
2887b395 ML |
1108 | /** |
1109 | * cache_firmware - cache one firmware image in kernel memory space | |
1110 | * @fw_name: the firmware image name | |
1111 | * | |
1112 | * Cache firmware in kernel memory so that drivers can use it when | |
1113 | * system isn't ready for them to request firmware image from userspace. | |
1114 | * Once it returns successfully, driver can use request_firmware or its | |
1115 | * nowait version to get the cached firmware without any interacting | |
1116 | * with userspace | |
1117 | * | |
1118 | * Return 0 if the firmware image has been cached successfully | |
1119 | * Return !0 otherwise | |
1120 | * | |
1121 | */ | |
1122 | int cache_firmware(const char *fw_name) | |
1123 | { | |
1124 | int ret; | |
1125 | const struct firmware *fw; | |
1126 | ||
1127 | pr_debug("%s: %s\n", __func__, fw_name); | |
1128 | ||
1129 | ret = request_firmware(&fw, fw_name, NULL); | |
1130 | if (!ret) | |
1131 | kfree(fw); | |
1132 | ||
1133 | pr_debug("%s: %s ret=%d\n", __func__, fw_name, ret); | |
1134 | ||
1135 | return ret; | |
1136 | } | |
1137 | ||
1138 | /** | |
1139 | * uncache_firmware - remove one cached firmware image | |
1140 | * @fw_name: the firmware image name | |
1141 | * | |
1142 | * Uncache one firmware image which has been cached successfully | |
1143 | * before. | |
1144 | * | |
1145 | * Return 0 if the firmware cache has been removed successfully | |
1146 | * Return !0 otherwise | |
1147 | * | |
1148 | */ | |
1149 | int uncache_firmware(const char *fw_name) | |
1150 | { | |
1151 | struct firmware_buf *buf; | |
1152 | struct firmware fw; | |
1153 | ||
1154 | pr_debug("%s: %s\n", __func__, fw_name); | |
1155 | ||
1156 | if (fw_get_builtin_firmware(&fw, fw_name)) | |
1157 | return 0; | |
1158 | ||
1159 | buf = fw_lookup_buf(fw_name); | |
1160 | if (buf) { | |
1161 | fw_free_buf(buf); | |
1162 | return 0; | |
1163 | } | |
1164 | ||
1165 | return -EINVAL; | |
1166 | } | |
1167 | ||
cfe016b1 | 1168 | #ifdef CONFIG_PM_SLEEP |
37276a51 ML |
1169 | static struct fw_cache_entry *alloc_fw_cache_entry(const char *name) |
1170 | { | |
1171 | struct fw_cache_entry *fce; | |
1172 | ||
1173 | fce = kzalloc(sizeof(*fce) + strlen(name) + 1, GFP_ATOMIC); | |
1174 | if (!fce) | |
1175 | goto exit; | |
1176 | ||
1177 | strcpy(fce->name, name); | |
1178 | exit: | |
1179 | return fce; | |
1180 | } | |
1181 | ||
373304fe | 1182 | static int __fw_entry_found(const char *name) |
ac39b3ea ML |
1183 | { |
1184 | struct firmware_cache *fwc = &fw_cache; | |
1185 | struct fw_cache_entry *fce; | |
ac39b3ea | 1186 | |
ac39b3ea ML |
1187 | list_for_each_entry(fce, &fwc->fw_names, list) { |
1188 | if (!strcmp(fce->name, name)) | |
373304fe | 1189 | return 1; |
ac39b3ea | 1190 | } |
373304fe ML |
1191 | return 0; |
1192 | } | |
1193 | ||
1194 | static int fw_cache_piggyback_on_request(const char *name) | |
1195 | { | |
1196 | struct firmware_cache *fwc = &fw_cache; | |
1197 | struct fw_cache_entry *fce; | |
1198 | int ret = 0; | |
1199 | ||
1200 | spin_lock(&fwc->name_lock); | |
1201 | if (__fw_entry_found(name)) | |
1202 | goto found; | |
ac39b3ea ML |
1203 | |
1204 | fce = alloc_fw_cache_entry(name); | |
1205 | if (fce) { | |
1206 | ret = 1; | |
1207 | list_add(&fce->list, &fwc->fw_names); | |
1208 | pr_debug("%s: fw: %s\n", __func__, name); | |
1209 | } | |
1210 | found: | |
1211 | spin_unlock(&fwc->name_lock); | |
1212 | return ret; | |
1213 | } | |
1214 | ||
37276a51 ML |
1215 | static void free_fw_cache_entry(struct fw_cache_entry *fce) |
1216 | { | |
1217 | kfree(fce); | |
1218 | } | |
1219 | ||
1220 | static void __async_dev_cache_fw_image(void *fw_entry, | |
1221 | async_cookie_t cookie) | |
1222 | { | |
1223 | struct fw_cache_entry *fce = fw_entry; | |
1224 | struct firmware_cache *fwc = &fw_cache; | |
1225 | int ret; | |
1226 | ||
1227 | ret = cache_firmware(fce->name); | |
ac39b3ea ML |
1228 | if (ret) { |
1229 | spin_lock(&fwc->name_lock); | |
1230 | list_del(&fce->list); | |
1231 | spin_unlock(&fwc->name_lock); | |
37276a51 | 1232 | |
ac39b3ea ML |
1233 | free_fw_cache_entry(fce); |
1234 | } | |
37276a51 | 1235 | |
37276a51 ML |
1236 | spin_lock(&fwc->name_lock); |
1237 | fwc->cnt--; | |
1238 | spin_unlock(&fwc->name_lock); | |
1239 | ||
1240 | wake_up(&fwc->wait_queue); | |
1241 | } | |
1242 | ||
1243 | /* called with dev->devres_lock held */ | |
1244 | static void dev_create_fw_entry(struct device *dev, void *res, | |
1245 | void *data) | |
1246 | { | |
1247 | struct fw_name_devm *fwn = res; | |
1248 | const char *fw_name = fwn->name; | |
1249 | struct list_head *head = data; | |
1250 | struct fw_cache_entry *fce; | |
1251 | ||
1252 | fce = alloc_fw_cache_entry(fw_name); | |
1253 | if (fce) | |
1254 | list_add(&fce->list, head); | |
1255 | } | |
1256 | ||
1257 | static int devm_name_match(struct device *dev, void *res, | |
1258 | void *match_data) | |
1259 | { | |
1260 | struct fw_name_devm *fwn = res; | |
1261 | return (fwn->magic == (unsigned long)match_data); | |
1262 | } | |
1263 | ||
ab6dd8e5 | 1264 | static void dev_cache_fw_image(struct device *dev, void *data) |
37276a51 ML |
1265 | { |
1266 | LIST_HEAD(todo); | |
1267 | struct fw_cache_entry *fce; | |
1268 | struct fw_cache_entry *fce_next; | |
1269 | struct firmware_cache *fwc = &fw_cache; | |
1270 | ||
1271 | devres_for_each_res(dev, fw_name_devm_release, | |
1272 | devm_name_match, &fw_cache, | |
1273 | dev_create_fw_entry, &todo); | |
1274 | ||
1275 | list_for_each_entry_safe(fce, fce_next, &todo, list) { | |
1276 | list_del(&fce->list); | |
1277 | ||
1278 | spin_lock(&fwc->name_lock); | |
373304fe ML |
1279 | /* only one cache entry for one firmware */ |
1280 | if (!__fw_entry_found(fce->name)) { | |
1281 | fwc->cnt++; | |
1282 | list_add(&fce->list, &fwc->fw_names); | |
1283 | } else { | |
1284 | free_fw_cache_entry(fce); | |
1285 | fce = NULL; | |
1286 | } | |
37276a51 ML |
1287 | spin_unlock(&fwc->name_lock); |
1288 | ||
373304fe ML |
1289 | if (fce) |
1290 | async_schedule(__async_dev_cache_fw_image, | |
1291 | (void *)fce); | |
37276a51 ML |
1292 | } |
1293 | } | |
1294 | ||
1295 | static void __device_uncache_fw_images(void) | |
1296 | { | |
1297 | struct firmware_cache *fwc = &fw_cache; | |
1298 | struct fw_cache_entry *fce; | |
1299 | ||
1300 | spin_lock(&fwc->name_lock); | |
1301 | while (!list_empty(&fwc->fw_names)) { | |
1302 | fce = list_entry(fwc->fw_names.next, | |
1303 | struct fw_cache_entry, list); | |
1304 | list_del(&fce->list); | |
1305 | spin_unlock(&fwc->name_lock); | |
1306 | ||
1307 | uncache_firmware(fce->name); | |
1308 | free_fw_cache_entry(fce); | |
1309 | ||
1310 | spin_lock(&fwc->name_lock); | |
1311 | } | |
1312 | spin_unlock(&fwc->name_lock); | |
1313 | } | |
1314 | ||
1315 | /** | |
1316 | * device_cache_fw_images - cache devices' firmware | |
1317 | * | |
1318 | * If one device called request_firmware or its nowait version | |
1319 | * successfully before, the firmware names are recored into the | |
1320 | * device's devres link list, so device_cache_fw_images can call | |
1321 | * cache_firmware() to cache these firmwares for the device, | |
1322 | * then the device driver can load its firmwares easily at | |
1323 | * time when system is not ready to complete loading firmware. | |
1324 | */ | |
1325 | static void device_cache_fw_images(void) | |
1326 | { | |
1327 | struct firmware_cache *fwc = &fw_cache; | |
ffe53f6f | 1328 | int old_timeout; |
37276a51 ML |
1329 | DEFINE_WAIT(wait); |
1330 | ||
1331 | pr_debug("%s\n", __func__); | |
1332 | ||
373304fe ML |
1333 | /* cancel uncache work */ |
1334 | cancel_delayed_work_sync(&fwc->work); | |
1335 | ||
ffe53f6f ML |
1336 | /* |
1337 | * use small loading timeout for caching devices' firmware | |
1338 | * because all these firmware images have been loaded | |
1339 | * successfully at lease once, also system is ready for | |
1340 | * completing firmware loading now. The maximum size of | |
1341 | * firmware in current distributions is about 2M bytes, | |
1342 | * so 10 secs should be enough. | |
1343 | */ | |
1344 | old_timeout = loading_timeout; | |
1345 | loading_timeout = 10; | |
1346 | ||
ac39b3ea ML |
1347 | mutex_lock(&fw_lock); |
1348 | fwc->state = FW_LOADER_START_CACHE; | |
ab6dd8e5 | 1349 | dpm_for_each_dev(NULL, dev_cache_fw_image); |
ac39b3ea | 1350 | mutex_unlock(&fw_lock); |
37276a51 ML |
1351 | |
1352 | /* wait for completion of caching firmware for all devices */ | |
1353 | spin_lock(&fwc->name_lock); | |
1354 | for (;;) { | |
1355 | prepare_to_wait(&fwc->wait_queue, &wait, | |
1356 | TASK_UNINTERRUPTIBLE); | |
1357 | if (!fwc->cnt) | |
1358 | break; | |
1359 | ||
1360 | spin_unlock(&fwc->name_lock); | |
1361 | ||
1362 | schedule(); | |
1363 | ||
1364 | spin_lock(&fwc->name_lock); | |
1365 | } | |
1366 | spin_unlock(&fwc->name_lock); | |
1367 | finish_wait(&fwc->wait_queue, &wait); | |
ffe53f6f ML |
1368 | |
1369 | loading_timeout = old_timeout; | |
37276a51 ML |
1370 | } |
1371 | ||
1372 | /** | |
1373 | * device_uncache_fw_images - uncache devices' firmware | |
1374 | * | |
1375 | * uncache all firmwares which have been cached successfully | |
1376 | * by device_uncache_fw_images earlier | |
1377 | */ | |
1378 | static void device_uncache_fw_images(void) | |
1379 | { | |
1380 | pr_debug("%s\n", __func__); | |
1381 | __device_uncache_fw_images(); | |
1382 | } | |
1383 | ||
1384 | static void device_uncache_fw_images_work(struct work_struct *work) | |
1385 | { | |
1386 | device_uncache_fw_images(); | |
1387 | } | |
1388 | ||
1389 | /** | |
1390 | * device_uncache_fw_images_delay - uncache devices firmwares | |
1391 | * @delay: number of milliseconds to delay uncache device firmwares | |
1392 | * | |
1393 | * uncache all devices's firmwares which has been cached successfully | |
1394 | * by device_cache_fw_images after @delay milliseconds. | |
1395 | */ | |
1396 | static void device_uncache_fw_images_delay(unsigned long delay) | |
1397 | { | |
1398 | schedule_delayed_work(&fw_cache.work, | |
1399 | msecs_to_jiffies(delay)); | |
1400 | } | |
1401 | ||
07646d9c ML |
1402 | static int fw_pm_notify(struct notifier_block *notify_block, |
1403 | unsigned long mode, void *unused) | |
1404 | { | |
1405 | switch (mode) { | |
1406 | case PM_HIBERNATION_PREPARE: | |
1407 | case PM_SUSPEND_PREPARE: | |
1408 | device_cache_fw_images(); | |
1409 | break; | |
1410 | ||
1411 | case PM_POST_SUSPEND: | |
1412 | case PM_POST_HIBERNATION: | |
1413 | case PM_POST_RESTORE: | |
ac39b3ea ML |
1414 | /* |
1415 | * In case that system sleep failed and syscore_suspend is | |
1416 | * not called. | |
1417 | */ | |
1418 | mutex_lock(&fw_lock); | |
1419 | fw_cache.state = FW_LOADER_NO_CACHE; | |
1420 | mutex_unlock(&fw_lock); | |
1421 | ||
07646d9c ML |
1422 | device_uncache_fw_images_delay(10 * MSEC_PER_SEC); |
1423 | break; | |
1424 | } | |
1425 | ||
1426 | return 0; | |
1427 | } | |
07646d9c | 1428 | |
ac39b3ea ML |
1429 | /* stop caching firmware once syscore_suspend is reached */ |
1430 | static int fw_suspend(void) | |
1431 | { | |
1432 | fw_cache.state = FW_LOADER_NO_CACHE; | |
1433 | return 0; | |
1434 | } | |
1435 | ||
1436 | static struct syscore_ops fw_syscore_ops = { | |
1437 | .suspend = fw_suspend, | |
1438 | }; | |
cfe016b1 ML |
1439 | #else |
1440 | static int fw_cache_piggyback_on_request(const char *name) | |
1441 | { | |
1442 | return 0; | |
1443 | } | |
1444 | #endif | |
ac39b3ea | 1445 | |
37276a51 ML |
1446 | static void __init fw_cache_init(void) |
1447 | { | |
1448 | spin_lock_init(&fw_cache.lock); | |
1449 | INIT_LIST_HEAD(&fw_cache.head); | |
cfe016b1 | 1450 | fw_cache.state = FW_LOADER_NO_CACHE; |
37276a51 | 1451 | |
cfe016b1 | 1452 | #ifdef CONFIG_PM_SLEEP |
37276a51 ML |
1453 | spin_lock_init(&fw_cache.name_lock); |
1454 | INIT_LIST_HEAD(&fw_cache.fw_names); | |
1455 | fw_cache.cnt = 0; | |
1456 | ||
1457 | init_waitqueue_head(&fw_cache.wait_queue); | |
1458 | INIT_DELAYED_WORK(&fw_cache.work, | |
1459 | device_uncache_fw_images_work); | |
07646d9c ML |
1460 | |
1461 | fw_cache.pm_notify.notifier_call = fw_pm_notify; | |
1462 | register_pm_notifier(&fw_cache.pm_notify); | |
ac39b3ea ML |
1463 | |
1464 | register_syscore_ops(&fw_syscore_ops); | |
cfe016b1 | 1465 | #endif |
37276a51 ML |
1466 | } |
1467 | ||
673fae90 | 1468 | static int __init firmware_class_init(void) |
1da177e4 | 1469 | { |
1f2b7959 | 1470 | fw_cache_init(); |
673fae90 | 1471 | return class_register(&firmware_class); |
1da177e4 | 1472 | } |
673fae90 DT |
1473 | |
1474 | static void __exit firmware_class_exit(void) | |
1da177e4 | 1475 | { |
cfe016b1 | 1476 | #ifdef CONFIG_PM_SLEEP |
ac39b3ea | 1477 | unregister_syscore_ops(&fw_syscore_ops); |
07646d9c | 1478 | unregister_pm_notifier(&fw_cache.pm_notify); |
cfe016b1 | 1479 | #endif |
1da177e4 LT |
1480 | class_unregister(&firmware_class); |
1481 | } | |
1482 | ||
a30a6a2c | 1483 | fs_initcall(firmware_class_init); |
1da177e4 LT |
1484 | module_exit(firmware_class_exit); |
1485 | ||
1486 | EXPORT_SYMBOL(release_firmware); | |
1487 | EXPORT_SYMBOL(request_firmware); | |
1488 | EXPORT_SYMBOL(request_firmware_nowait); | |
2887b395 ML |
1489 | EXPORT_SYMBOL_GPL(cache_firmware); |
1490 | EXPORT_SYMBOL_GPL(uncache_firmware); |