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