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