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