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