Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * main.c - Multi purpose firmware loading support
4 *
5 * Copyright (c) 2003 Manuel Estrada Sainz
6 *
7 * Please see Documentation/driver-api/firmware/ for more information.
8 *
9 */
10
11#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
12
13#include <linux/capability.h>
14#include <linux/device.h>
15#include <linux/module.h>
16#include <linux/init.h>
17#include <linux/timer.h>
18#include <linux/vmalloc.h>
19#include <linux/interrupt.h>
20#include <linux/bitops.h>
21#include <linux/mutex.h>
22#include <linux/workqueue.h>
23#include <linux/highmem.h>
24#include <linux/firmware.h>
25#include <linux/slab.h>
26#include <linux/sched.h>
27#include <linux/file.h>
28#include <linux/list.h>
29#include <linux/fs.h>
30#include <linux/async.h>
31#include <linux/pm.h>
32#include <linux/suspend.h>
33#include <linux/syscore_ops.h>
34#include <linux/reboot.h>
35#include <linux/security.h>
36#include <linux/xz.h>
37
38#include <generated/utsrelease.h>
39
40#include "../base.h"
41#include "firmware.h"
42#include "fallback.h"
43
44MODULE_AUTHOR("Manuel Estrada Sainz");
45MODULE_DESCRIPTION("Multi purpose firmware loading support");
46MODULE_LICENSE("GPL");
47
48struct firmware_cache {
49 /* firmware_buf instance will be added into the below list */
50 spinlock_t lock;
51 struct list_head head;
52 int state;
53
54#ifdef CONFIG_FW_CACHE
55 /*
56 * Names of firmware images which have been cached successfully
57 * will be added into the below list so that device uncache
58 * helper can trace which firmware images have been cached
59 * before.
60 */
61 spinlock_t name_lock;
62 struct list_head fw_names;
63
64 struct delayed_work work;
65
66 struct notifier_block pm_notify;
67#endif
68};
69
70struct fw_cache_entry {
71 struct list_head list;
72 const char *name;
73};
74
75struct fw_name_devm {
76 unsigned long magic;
77 const char *name;
78};
79
80static inline struct fw_priv *to_fw_priv(struct kref *ref)
81{
82 return container_of(ref, struct fw_priv, ref);
83}
84
85#define FW_LOADER_NO_CACHE 0
86#define FW_LOADER_START_CACHE 1
87
88/* fw_lock could be moved to 'struct fw_sysfs' but since it is just
89 * guarding for corner cases a global lock should be OK */
90DEFINE_MUTEX(fw_lock);
91
92static struct firmware_cache fw_cache;
93
94/* Builtin firmware support */
95
96#ifdef CONFIG_FW_LOADER
97
98extern struct builtin_fw __start_builtin_fw[];
99extern struct builtin_fw __end_builtin_fw[];
100
101static void fw_copy_to_prealloc_buf(struct firmware *fw,
102 void *buf, size_t size)
103{
104 if (!buf || size < fw->size)
105 return;
106 memcpy(buf, fw->data, fw->size);
107}
108
109static bool fw_get_builtin_firmware(struct firmware *fw, const char *name,
110 void *buf, size_t size)
111{
112 struct builtin_fw *b_fw;
113
114 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++) {
115 if (strcmp(name, b_fw->name) == 0) {
116 fw->size = b_fw->size;
117 fw->data = b_fw->data;
118 fw_copy_to_prealloc_buf(fw, buf, size);
119
120 return true;
121 }
122 }
123
124 return false;
125}
126
127static bool fw_is_builtin_firmware(const struct firmware *fw)
128{
129 struct builtin_fw *b_fw;
130
131 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++)
132 if (fw->data == b_fw->data)
133 return true;
134
135 return false;
136}
137
138#else /* Module case - no builtin firmware support */
139
140static inline bool fw_get_builtin_firmware(struct firmware *fw,
141 const char *name, void *buf,
142 size_t size)
143{
144 return false;
145}
146
147static inline bool fw_is_builtin_firmware(const struct firmware *fw)
148{
149 return false;
150}
151#endif
152
153static void fw_state_init(struct fw_priv *fw_priv)
154{
155 struct fw_state *fw_st = &fw_priv->fw_st;
156
157 init_completion(&fw_st->completion);
158 fw_st->status = FW_STATUS_UNKNOWN;
159}
160
161static inline int fw_state_wait(struct fw_priv *fw_priv)
162{
163 return __fw_state_wait_common(fw_priv, MAX_SCHEDULE_TIMEOUT);
164}
165
166static int fw_cache_piggyback_on_request(const char *name);
167
168static struct fw_priv *__allocate_fw_priv(const char *fw_name,
169 struct firmware_cache *fwc,
170 void *dbuf, size_t size)
171{
172 struct fw_priv *fw_priv;
173
174 fw_priv = kzalloc(sizeof(*fw_priv), GFP_ATOMIC);
175 if (!fw_priv)
176 return NULL;
177
178 fw_priv->fw_name = kstrdup_const(fw_name, GFP_ATOMIC);
179 if (!fw_priv->fw_name) {
180 kfree(fw_priv);
181 return NULL;
182 }
183
184 kref_init(&fw_priv->ref);
185 fw_priv->fwc = fwc;
186 fw_priv->data = dbuf;
187 fw_priv->allocated_size = size;
188 fw_state_init(fw_priv);
189#ifdef CONFIG_FW_LOADER_USER_HELPER
190 INIT_LIST_HEAD(&fw_priv->pending_list);
191#endif
192
193 pr_debug("%s: fw-%s fw_priv=%p\n", __func__, fw_name, fw_priv);
194
195 return fw_priv;
196}
197
198static struct fw_priv *__lookup_fw_priv(const char *fw_name)
199{
200 struct fw_priv *tmp;
201 struct firmware_cache *fwc = &fw_cache;
202
203 list_for_each_entry(tmp, &fwc->head, list)
204 if (!strcmp(tmp->fw_name, fw_name))
205 return tmp;
206 return NULL;
207}
208
209/* Returns 1 for batching firmware requests with the same name */
210static int alloc_lookup_fw_priv(const char *fw_name,
211 struct firmware_cache *fwc,
212 struct fw_priv **fw_priv, void *dbuf,
213 size_t size, u32 opt_flags)
214{
215 struct fw_priv *tmp;
216
217 spin_lock(&fwc->lock);
218 if (!(opt_flags & FW_OPT_NOCACHE)) {
219 tmp = __lookup_fw_priv(fw_name);
220 if (tmp) {
221 kref_get(&tmp->ref);
222 spin_unlock(&fwc->lock);
223 *fw_priv = tmp;
224 pr_debug("batched request - sharing the same struct fw_priv and lookup for multiple requests\n");
225 return 1;
226 }
227 }
228
229 tmp = __allocate_fw_priv(fw_name, fwc, dbuf, size);
230 if (tmp) {
231 INIT_LIST_HEAD(&tmp->list);
232 if (!(opt_flags & FW_OPT_NOCACHE))
233 list_add(&tmp->list, &fwc->head);
234 }
235 spin_unlock(&fwc->lock);
236
237 *fw_priv = tmp;
238
239 return tmp ? 0 : -ENOMEM;
240}
241
242static void __free_fw_priv(struct kref *ref)
243 __releases(&fwc->lock)
244{
245 struct fw_priv *fw_priv = to_fw_priv(ref);
246 struct firmware_cache *fwc = fw_priv->fwc;
247
248 pr_debug("%s: fw-%s fw_priv=%p data=%p size=%u\n",
249 __func__, fw_priv->fw_name, fw_priv, fw_priv->data,
250 (unsigned int)fw_priv->size);
251
252 list_del(&fw_priv->list);
253 spin_unlock(&fwc->lock);
254
255 if (fw_is_paged_buf(fw_priv))
256 fw_free_paged_buf(fw_priv);
257 else if (!fw_priv->allocated_size)
258 vfree(fw_priv->data);
259
260 kfree_const(fw_priv->fw_name);
261 kfree(fw_priv);
262}
263
264static void free_fw_priv(struct fw_priv *fw_priv)
265{
266 struct firmware_cache *fwc = fw_priv->fwc;
267 spin_lock(&fwc->lock);
268 if (!kref_put(&fw_priv->ref, __free_fw_priv))
269 spin_unlock(&fwc->lock);
270}
271
272#ifdef CONFIG_FW_LOADER_PAGED_BUF
273bool fw_is_paged_buf(struct fw_priv *fw_priv)
274{
275 return fw_priv->is_paged_buf;
276}
277
278void fw_free_paged_buf(struct fw_priv *fw_priv)
279{
280 int i;
281
282 if (!fw_priv->pages)
283 return;
284
285 vunmap(fw_priv->data);
286
287 for (i = 0; i < fw_priv->nr_pages; i++)
288 __free_page(fw_priv->pages[i]);
289 kvfree(fw_priv->pages);
290 fw_priv->pages = NULL;
291 fw_priv->page_array_size = 0;
292 fw_priv->nr_pages = 0;
293}
294
295int fw_grow_paged_buf(struct fw_priv *fw_priv, int pages_needed)
296{
297 /* If the array of pages is too small, grow it */
298 if (fw_priv->page_array_size < pages_needed) {
299 int new_array_size = max(pages_needed,
300 fw_priv->page_array_size * 2);
301 struct page **new_pages;
302
303 new_pages = kvmalloc_array(new_array_size, sizeof(void *),
304 GFP_KERNEL);
305 if (!new_pages)
306 return -ENOMEM;
307 memcpy(new_pages, fw_priv->pages,
308 fw_priv->page_array_size * sizeof(void *));
309 memset(&new_pages[fw_priv->page_array_size], 0, sizeof(void *) *
310 (new_array_size - fw_priv->page_array_size));
311 kvfree(fw_priv->pages);
312 fw_priv->pages = new_pages;
313 fw_priv->page_array_size = new_array_size;
314 }
315
316 while (fw_priv->nr_pages < pages_needed) {
317 fw_priv->pages[fw_priv->nr_pages] =
318 alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
319
320 if (!fw_priv->pages[fw_priv->nr_pages])
321 return -ENOMEM;
322 fw_priv->nr_pages++;
323 }
324
325 return 0;
326}
327
328int fw_map_paged_buf(struct fw_priv *fw_priv)
329{
330 /* one pages buffer should be mapped/unmapped only once */
331 if (!fw_priv->pages)
332 return 0;
333
334 vunmap(fw_priv->data);
335 fw_priv->data = vmap(fw_priv->pages, fw_priv->nr_pages, 0,
336 PAGE_KERNEL_RO);
337 if (!fw_priv->data)
338 return -ENOMEM;
339
340 return 0;
341}
342#endif
343
344/*
345 * XZ-compressed firmware support
346 */
347#ifdef CONFIG_FW_LOADER_COMPRESS
348/* show an error and return the standard error code */
349static int fw_decompress_xz_error(struct device *dev, enum xz_ret xz_ret)
350{
351 if (xz_ret != XZ_STREAM_END) {
352 dev_warn(dev, "xz decompression failed (xz_ret=%d)\n", xz_ret);
353 return xz_ret == XZ_MEM_ERROR ? -ENOMEM : -EINVAL;
354 }
355 return 0;
356}
357
358/* single-shot decompression onto the pre-allocated buffer */
359static int fw_decompress_xz_single(struct device *dev, struct fw_priv *fw_priv,
360 size_t in_size, const void *in_buffer)
361{
362 struct xz_dec *xz_dec;
363 struct xz_buf xz_buf;
364 enum xz_ret xz_ret;
365
366 xz_dec = xz_dec_init(XZ_SINGLE, (u32)-1);
367 if (!xz_dec)
368 return -ENOMEM;
369
370 xz_buf.in_size = in_size;
371 xz_buf.in = in_buffer;
372 xz_buf.in_pos = 0;
373 xz_buf.out_size = fw_priv->allocated_size;
374 xz_buf.out = fw_priv->data;
375 xz_buf.out_pos = 0;
376
377 xz_ret = xz_dec_run(xz_dec, &xz_buf);
378 xz_dec_end(xz_dec);
379
380 fw_priv->size = xz_buf.out_pos;
381 return fw_decompress_xz_error(dev, xz_ret);
382}
383
384/* decompression on paged buffer and map it */
385static int fw_decompress_xz_pages(struct device *dev, struct fw_priv *fw_priv,
386 size_t in_size, const void *in_buffer)
387{
388 struct xz_dec *xz_dec;
389 struct xz_buf xz_buf;
390 enum xz_ret xz_ret;
391 struct page *page;
392 int err = 0;
393
394 xz_dec = xz_dec_init(XZ_DYNALLOC, (u32)-1);
395 if (!xz_dec)
396 return -ENOMEM;
397
398 xz_buf.in_size = in_size;
399 xz_buf.in = in_buffer;
400 xz_buf.in_pos = 0;
401
402 fw_priv->is_paged_buf = true;
403 fw_priv->size = 0;
404 do {
405 if (fw_grow_paged_buf(fw_priv, fw_priv->nr_pages + 1)) {
406 err = -ENOMEM;
407 goto out;
408 }
409
410 /* decompress onto the new allocated page */
411 page = fw_priv->pages[fw_priv->nr_pages - 1];
412 xz_buf.out = kmap(page);
413 xz_buf.out_pos = 0;
414 xz_buf.out_size = PAGE_SIZE;
415 xz_ret = xz_dec_run(xz_dec, &xz_buf);
416 kunmap(page);
417 fw_priv->size += xz_buf.out_pos;
418 /* partial decompression means either end or error */
419 if (xz_buf.out_pos != PAGE_SIZE)
420 break;
421 } while (xz_ret == XZ_OK);
422
423 err = fw_decompress_xz_error(dev, xz_ret);
424 if (!err)
425 err = fw_map_paged_buf(fw_priv);
426
427 out:
428 xz_dec_end(xz_dec);
429 return err;
430}
431
432static int fw_decompress_xz(struct device *dev, struct fw_priv *fw_priv,
433 size_t in_size, const void *in_buffer)
434{
435 /* if the buffer is pre-allocated, we can perform in single-shot mode */
436 if (fw_priv->data)
437 return fw_decompress_xz_single(dev, fw_priv, in_size, in_buffer);
438 else
439 return fw_decompress_xz_pages(dev, fw_priv, in_size, in_buffer);
440}
441#endif /* CONFIG_FW_LOADER_COMPRESS */
442
443/* direct firmware loading support */
444static char fw_path_para[256];
445static const char * const fw_path[] = {
446 fw_path_para,
447 "/lib/firmware/updates/" UTS_RELEASE,
448 "/lib/firmware/updates",
449 "/lib/firmware/" UTS_RELEASE,
450 "/lib/firmware"
451};
452
453/*
454 * Typical usage is that passing 'firmware_class.path=$CUSTOMIZED_PATH'
455 * from kernel command line because firmware_class is generally built in
456 * kernel instead of module.
457 */
458module_param_string(path, fw_path_para, sizeof(fw_path_para), 0644);
459MODULE_PARM_DESC(path, "customized firmware image search path with a higher priority than default path");
460
461static int
462fw_get_filesystem_firmware(struct device *device, struct fw_priv *fw_priv,
463 const char *suffix,
464 int (*decompress)(struct device *dev,
465 struct fw_priv *fw_priv,
466 size_t in_size,
467 const void *in_buffer))
468{
469 loff_t size;
470 int i, len;
471 int rc = -ENOENT;
472 char *path;
473 enum kernel_read_file_id id = READING_FIRMWARE;
474 size_t msize = INT_MAX;
475 void *buffer = NULL;
476
477 /* Already populated data member means we're loading into a buffer */
478 if (!decompress && fw_priv->data) {
479 buffer = fw_priv->data;
480 id = READING_FIRMWARE_PREALLOC_BUFFER;
481 msize = fw_priv->allocated_size;
482 }
483
484 path = __getname();
485 if (!path)
486 return -ENOMEM;
487
488 for (i = 0; i < ARRAY_SIZE(fw_path); i++) {
489 /* skip the unset customized path */
490 if (!fw_path[i][0])
491 continue;
492
493 len = snprintf(path, PATH_MAX, "%s/%s%s",
494 fw_path[i], fw_priv->fw_name, suffix);
495 if (len >= PATH_MAX) {
496 rc = -ENAMETOOLONG;
497 break;
498 }
499
500 fw_priv->size = 0;
501
502 /* load firmware files from the mount namespace of init */
503 rc = kernel_read_file_from_path_initns(path, &buffer,
504 &size, msize, id);
505 if (rc) {
506 if (rc != -ENOENT)
507 dev_warn(device, "loading %s failed with error %d\n",
508 path, rc);
509 else
510 dev_dbg(device, "loading %s failed for no such file or directory.\n",
511 path);
512 continue;
513 }
514 dev_dbg(device, "Loading firmware from %s\n", path);
515 if (decompress) {
516 dev_dbg(device, "f/w decompressing %s\n",
517 fw_priv->fw_name);
518 rc = decompress(device, fw_priv, size, buffer);
519 /* discard the superfluous original content */
520 vfree(buffer);
521 buffer = NULL;
522 if (rc) {
523 fw_free_paged_buf(fw_priv);
524 continue;
525 }
526 } else {
527 dev_dbg(device, "direct-loading %s\n",
528 fw_priv->fw_name);
529 if (!fw_priv->data)
530 fw_priv->data = buffer;
531 fw_priv->size = size;
532 }
533 fw_state_done(fw_priv);
534 break;
535 }
536 __putname(path);
537
538 return rc;
539}
540
541/* firmware holds the ownership of pages */
542static void firmware_free_data(const struct firmware *fw)
543{
544 /* Loaded directly? */
545 if (!fw->priv) {
546 vfree(fw->data);
547 return;
548 }
549 free_fw_priv(fw->priv);
550}
551
552/* store the pages buffer info firmware from buf */
553static void fw_set_page_data(struct fw_priv *fw_priv, struct firmware *fw)
554{
555 fw->priv = fw_priv;
556 fw->size = fw_priv->size;
557 fw->data = fw_priv->data;
558
559 pr_debug("%s: fw-%s fw_priv=%p data=%p size=%u\n",
560 __func__, fw_priv->fw_name, fw_priv, fw_priv->data,
561 (unsigned int)fw_priv->size);
562}
563
564#ifdef CONFIG_FW_CACHE
565static void fw_name_devm_release(struct device *dev, void *res)
566{
567 struct fw_name_devm *fwn = res;
568
569 if (fwn->magic == (unsigned long)&fw_cache)
570 pr_debug("%s: fw_name-%s devm-%p released\n",
571 __func__, fwn->name, res);
572 kfree_const(fwn->name);
573}
574
575static int fw_devm_match(struct device *dev, void *res,
576 void *match_data)
577{
578 struct fw_name_devm *fwn = res;
579
580 return (fwn->magic == (unsigned long)&fw_cache) &&
581 !strcmp(fwn->name, match_data);
582}
583
584static struct fw_name_devm *fw_find_devm_name(struct device *dev,
585 const char *name)
586{
587 struct fw_name_devm *fwn;
588
589 fwn = devres_find(dev, fw_name_devm_release,
590 fw_devm_match, (void *)name);
591 return fwn;
592}
593
594static bool fw_cache_is_setup(struct device *dev, const char *name)
595{
596 struct fw_name_devm *fwn;
597
598 fwn = fw_find_devm_name(dev, name);
599 if (fwn)
600 return true;
601
602 return false;
603}
604
605/* add firmware name into devres list */
606static int fw_add_devm_name(struct device *dev, const char *name)
607{
608 struct fw_name_devm *fwn;
609
610 if (fw_cache_is_setup(dev, name))
611 return 0;
612
613 fwn = devres_alloc(fw_name_devm_release, sizeof(struct fw_name_devm),
614 GFP_KERNEL);
615 if (!fwn)
616 return -ENOMEM;
617 fwn->name = kstrdup_const(name, GFP_KERNEL);
618 if (!fwn->name) {
619 devres_free(fwn);
620 return -ENOMEM;
621 }
622
623 fwn->magic = (unsigned long)&fw_cache;
624 devres_add(dev, fwn);
625
626 return 0;
627}
628#else
629static bool fw_cache_is_setup(struct device *dev, const char *name)
630{
631 return false;
632}
633
634static int fw_add_devm_name(struct device *dev, const char *name)
635{
636 return 0;
637}
638#endif
639
640int assign_fw(struct firmware *fw, struct device *device, u32 opt_flags)
641{
642 struct fw_priv *fw_priv = fw->priv;
643 int ret;
644
645 mutex_lock(&fw_lock);
646 if (!fw_priv->size || fw_state_is_aborted(fw_priv)) {
647 mutex_unlock(&fw_lock);
648 return -ENOENT;
649 }
650
651 /*
652 * add firmware name into devres list so that we can auto cache
653 * and uncache firmware for device.
654 *
655 * device may has been deleted already, but the problem
656 * should be fixed in devres or driver core.
657 */
658 /* don't cache firmware handled without uevent */
659 if (device && (opt_flags & FW_OPT_UEVENT) &&
660 !(opt_flags & FW_OPT_NOCACHE)) {
661 ret = fw_add_devm_name(device, fw_priv->fw_name);
662 if (ret) {
663 mutex_unlock(&fw_lock);
664 return ret;
665 }
666 }
667
668 /*
669 * After caching firmware image is started, let it piggyback
670 * on request firmware.
671 */
672 if (!(opt_flags & FW_OPT_NOCACHE) &&
673 fw_priv->fwc->state == FW_LOADER_START_CACHE) {
674 if (fw_cache_piggyback_on_request(fw_priv->fw_name))
675 kref_get(&fw_priv->ref);
676 }
677
678 /* pass the pages buffer to driver at the last minute */
679 fw_set_page_data(fw_priv, fw);
680 mutex_unlock(&fw_lock);
681 return 0;
682}
683
684/* prepare firmware and firmware_buf structs;
685 * return 0 if a firmware is already assigned, 1 if need to load one,
686 * or a negative error code
687 */
688static int
689_request_firmware_prepare(struct firmware **firmware_p, const char *name,
690 struct device *device, void *dbuf, size_t size,
691 u32 opt_flags)
692{
693 struct firmware *firmware;
694 struct fw_priv *fw_priv;
695 int ret;
696
697 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
698 if (!firmware) {
699 dev_err(device, "%s: kmalloc(struct firmware) failed\n",
700 __func__);
701 return -ENOMEM;
702 }
703
704 if (fw_get_builtin_firmware(firmware, name, dbuf, size)) {
705 dev_dbg(device, "using built-in %s\n", name);
706 return 0; /* assigned */
707 }
708
709 ret = alloc_lookup_fw_priv(name, &fw_cache, &fw_priv, dbuf, size,
710 opt_flags);
711
712 /*
713 * bind with 'priv' now to avoid warning in failure path
714 * of requesting firmware.
715 */
716 firmware->priv = fw_priv;
717
718 if (ret > 0) {
719 ret = fw_state_wait(fw_priv);
720 if (!ret) {
721 fw_set_page_data(fw_priv, firmware);
722 return 0; /* assigned */
723 }
724 }
725
726 if (ret < 0)
727 return ret;
728 return 1; /* need to load */
729}
730
731/*
732 * Batched requests need only one wake, we need to do this step last due to the
733 * fallback mechanism. The buf is protected with kref_get(), and it won't be
734 * released until the last user calls release_firmware().
735 *
736 * Failed batched requests are possible as well, in such cases we just share
737 * the struct fw_priv and won't release it until all requests are woken
738 * and have gone through this same path.
739 */
740static void fw_abort_batch_reqs(struct firmware *fw)
741{
742 struct fw_priv *fw_priv;
743
744 /* Loaded directly? */
745 if (!fw || !fw->priv)
746 return;
747
748 fw_priv = fw->priv;
749 if (!fw_state_is_aborted(fw_priv))
750 fw_state_aborted(fw_priv);
751}
752
753/* called from request_firmware() and request_firmware_work_func() */
754static int
755_request_firmware(const struct firmware **firmware_p, const char *name,
756 struct device *device, void *buf, size_t size,
757 u32 opt_flags)
758{
759 struct firmware *fw = NULL;
760 int ret;
761
762 if (!firmware_p)
763 return -EINVAL;
764
765 if (!name || name[0] == '\0') {
766 ret = -EINVAL;
767 goto out;
768 }
769
770 ret = _request_firmware_prepare(&fw, name, device, buf, size,
771 opt_flags);
772 if (ret <= 0) /* error or already assigned */
773 goto out;
774
775 ret = fw_get_filesystem_firmware(device, fw->priv, "", NULL);
776#ifdef CONFIG_FW_LOADER_COMPRESS
777 if (ret == -ENOENT)
778 ret = fw_get_filesystem_firmware(device, fw->priv, ".xz",
779 fw_decompress_xz);
780#endif
781
782 if (ret == -ENOENT)
783 ret = firmware_fallback_platform(fw->priv, opt_flags);
784
785 if (ret) {
786 if (!(opt_flags & FW_OPT_NO_WARN))
787 dev_warn(device,
788 "Direct firmware load for %s failed with error %d\n",
789 name, ret);
790 ret = firmware_fallback_sysfs(fw, name, device, opt_flags, ret);
791 } else
792 ret = assign_fw(fw, device, opt_flags);
793
794 out:
795 if (ret < 0) {
796 fw_abort_batch_reqs(fw);
797 release_firmware(fw);
798 fw = NULL;
799 }
800
801 *firmware_p = fw;
802 return ret;
803}
804
805/**
806 * request_firmware() - send firmware request and wait for it
807 * @firmware_p: pointer to firmware image
808 * @name: name of firmware file
809 * @device: device for which firmware is being loaded
810 *
811 * @firmware_p will be used to return a firmware image by the name
812 * of @name for device @device.
813 *
814 * Should be called from user context where sleeping is allowed.
815 *
816 * @name will be used as $FIRMWARE in the uevent environment and
817 * should be distinctive enough not to be confused with any other
818 * firmware image for this or any other device.
819 *
820 * Caller must hold the reference count of @device.
821 *
822 * The function can be called safely inside device's suspend and
823 * resume callback.
824 **/
825int
826request_firmware(const struct firmware **firmware_p, const char *name,
827 struct device *device)
828{
829 int ret;
830
831 /* Need to pin this module until return */
832 __module_get(THIS_MODULE);
833 ret = _request_firmware(firmware_p, name, device, NULL, 0,
834 FW_OPT_UEVENT);
835 module_put(THIS_MODULE);
836 return ret;
837}
838EXPORT_SYMBOL(request_firmware);
839
840/**
841 * firmware_request_nowarn() - request for an optional fw module
842 * @firmware: pointer to firmware image
843 * @name: name of firmware file
844 * @device: device for which firmware is being loaded
845 *
846 * This function is similar in behaviour to request_firmware(), except it
847 * doesn't produce warning messages when the file is not found. The sysfs
848 * fallback mechanism is enabled if direct filesystem lookup fails. However,
849 * failures to find the firmware file with it are still suppressed. It is
850 * therefore up to the driver to check for the return value of this call and to
851 * decide when to inform the users of errors.
852 **/
853int firmware_request_nowarn(const struct firmware **firmware, const char *name,
854 struct device *device)
855{
856 int ret;
857
858 /* Need to pin this module until return */
859 __module_get(THIS_MODULE);
860 ret = _request_firmware(firmware, name, device, NULL, 0,
861 FW_OPT_UEVENT | FW_OPT_NO_WARN);
862 module_put(THIS_MODULE);
863 return ret;
864}
865EXPORT_SYMBOL_GPL(firmware_request_nowarn);
866
867/**
868 * request_firmware_direct() - load firmware directly without usermode helper
869 * @firmware_p: pointer to firmware image
870 * @name: name of firmware file
871 * @device: device for which firmware is being loaded
872 *
873 * This function works pretty much like request_firmware(), but this doesn't
874 * fall back to usermode helper even if the firmware couldn't be loaded
875 * directly from fs. Hence it's useful for loading optional firmwares, which
876 * aren't always present, without extra long timeouts of udev.
877 **/
878int request_firmware_direct(const struct firmware **firmware_p,
879 const char *name, struct device *device)
880{
881 int ret;
882
883 __module_get(THIS_MODULE);
884 ret = _request_firmware(firmware_p, name, device, NULL, 0,
885 FW_OPT_UEVENT | FW_OPT_NO_WARN |
886 FW_OPT_NOFALLBACK_SYSFS);
887 module_put(THIS_MODULE);
888 return ret;
889}
890EXPORT_SYMBOL_GPL(request_firmware_direct);
891
892/**
893 * firmware_request_platform() - request firmware with platform-fw fallback
894 * @firmware: pointer to firmware image
895 * @name: name of firmware file
896 * @device: device for which firmware is being loaded
897 *
898 * This function is similar in behaviour to request_firmware, except that if
899 * direct filesystem lookup fails, it will fallback to looking for a copy of the
900 * requested firmware embedded in the platform's main (e.g. UEFI) firmware.
901 **/
902int firmware_request_platform(const struct firmware **firmware,
903 const char *name, struct device *device)
904{
905 int ret;
906
907 /* Need to pin this module until return */
908 __module_get(THIS_MODULE);
909 ret = _request_firmware(firmware, name, device, NULL, 0,
910 FW_OPT_UEVENT | FW_OPT_FALLBACK_PLATFORM);
911 module_put(THIS_MODULE);
912 return ret;
913}
914EXPORT_SYMBOL_GPL(firmware_request_platform);
915
916/**
917 * firmware_request_cache() - cache firmware for suspend so resume can use it
918 * @name: name of firmware file
919 * @device: device for which firmware should be cached for
920 *
921 * There are some devices with an optimization that enables the device to not
922 * require loading firmware on system reboot. This optimization may still
923 * require the firmware present on resume from suspend. This routine can be
924 * used to ensure the firmware is present on resume from suspend in these
925 * situations. This helper is not compatible with drivers which use
926 * request_firmware_into_buf() or request_firmware_nowait() with no uevent set.
927 **/
928int firmware_request_cache(struct device *device, const char *name)
929{
930 int ret;
931
932 mutex_lock(&fw_lock);
933 ret = fw_add_devm_name(device, name);
934 mutex_unlock(&fw_lock);
935
936 return ret;
937}
938EXPORT_SYMBOL_GPL(firmware_request_cache);
939
940/**
941 * request_firmware_into_buf() - load firmware into a previously allocated buffer
942 * @firmware_p: pointer to firmware image
943 * @name: name of firmware file
944 * @device: device for which firmware is being loaded and DMA region allocated
945 * @buf: address of buffer to load firmware into
946 * @size: size of buffer
947 *
948 * This function works pretty much like request_firmware(), but it doesn't
949 * allocate a buffer to hold the firmware data. Instead, the firmware
950 * is loaded directly into the buffer pointed to by @buf and the @firmware_p
951 * data member is pointed at @buf.
952 *
953 * This function doesn't cache firmware either.
954 */
955int
956request_firmware_into_buf(const struct firmware **firmware_p, const char *name,
957 struct device *device, void *buf, size_t size)
958{
959 int ret;
960
961 if (fw_cache_is_setup(device, name))
962 return -EOPNOTSUPP;
963
964 __module_get(THIS_MODULE);
965 ret = _request_firmware(firmware_p, name, device, buf, size,
966 FW_OPT_UEVENT | FW_OPT_NOCACHE);
967 module_put(THIS_MODULE);
968 return ret;
969}
970EXPORT_SYMBOL(request_firmware_into_buf);
971
972/**
973 * release_firmware() - release the resource associated with a firmware image
974 * @fw: firmware resource to release
975 **/
976void release_firmware(const struct firmware *fw)
977{
978 if (fw) {
979 if (!fw_is_builtin_firmware(fw))
980 firmware_free_data(fw);
981 kfree(fw);
982 }
983}
984EXPORT_SYMBOL(release_firmware);
985
986/* Async support */
987struct firmware_work {
988 struct work_struct work;
989 struct module *module;
990 const char *name;
991 struct device *device;
992 void *context;
993 void (*cont)(const struct firmware *fw, void *context);
994 u32 opt_flags;
995};
996
997static void request_firmware_work_func(struct work_struct *work)
998{
999 struct firmware_work *fw_work;
1000 const struct firmware *fw;
1001
1002 fw_work = container_of(work, struct firmware_work, work);
1003
1004 _request_firmware(&fw, fw_work->name, fw_work->device, NULL, 0,
1005 fw_work->opt_flags);
1006 fw_work->cont(fw, fw_work->context);
1007 put_device(fw_work->device); /* taken in request_firmware_nowait() */
1008
1009 module_put(fw_work->module);
1010 kfree_const(fw_work->name);
1011 kfree(fw_work);
1012}
1013
1014/**
1015 * request_firmware_nowait() - asynchronous version of request_firmware
1016 * @module: module requesting the firmware
1017 * @uevent: sends uevent to copy the firmware image if this flag
1018 * is non-zero else the firmware copy must be done manually.
1019 * @name: name of firmware file
1020 * @device: device for which firmware is being loaded
1021 * @gfp: allocation flags
1022 * @context: will be passed over to @cont, and
1023 * @fw may be %NULL if firmware request fails.
1024 * @cont: function will be called asynchronously when the firmware
1025 * request is over.
1026 *
1027 * Caller must hold the reference count of @device.
1028 *
1029 * Asynchronous variant of request_firmware() for user contexts:
1030 * - sleep for as small periods as possible since it may
1031 * increase kernel boot time of built-in device drivers
1032 * requesting firmware in their ->probe() methods, if
1033 * @gfp is GFP_KERNEL.
1034 *
1035 * - can't sleep at all if @gfp is GFP_ATOMIC.
1036 **/
1037int
1038request_firmware_nowait(
1039 struct module *module, bool uevent,
1040 const char *name, struct device *device, gfp_t gfp, void *context,
1041 void (*cont)(const struct firmware *fw, void *context))
1042{
1043 struct firmware_work *fw_work;
1044
1045 fw_work = kzalloc(sizeof(struct firmware_work), gfp);
1046 if (!fw_work)
1047 return -ENOMEM;
1048
1049 fw_work->module = module;
1050 fw_work->name = kstrdup_const(name, gfp);
1051 if (!fw_work->name) {
1052 kfree(fw_work);
1053 return -ENOMEM;
1054 }
1055 fw_work->device = device;
1056 fw_work->context = context;
1057 fw_work->cont = cont;
1058 fw_work->opt_flags = FW_OPT_NOWAIT |
1059 (uevent ? FW_OPT_UEVENT : FW_OPT_USERHELPER);
1060
1061 if (!uevent && fw_cache_is_setup(device, name)) {
1062 kfree_const(fw_work->name);
1063 kfree(fw_work);
1064 return -EOPNOTSUPP;
1065 }
1066
1067 if (!try_module_get(module)) {
1068 kfree_const(fw_work->name);
1069 kfree(fw_work);
1070 return -EFAULT;
1071 }
1072
1073 get_device(fw_work->device);
1074 INIT_WORK(&fw_work->work, request_firmware_work_func);
1075 schedule_work(&fw_work->work);
1076 return 0;
1077}
1078EXPORT_SYMBOL(request_firmware_nowait);
1079
1080#ifdef CONFIG_FW_CACHE
1081static ASYNC_DOMAIN_EXCLUSIVE(fw_cache_domain);
1082
1083/**
1084 * cache_firmware() - cache one firmware image in kernel memory space
1085 * @fw_name: the firmware image name
1086 *
1087 * Cache firmware in kernel memory so that drivers can use it when
1088 * system isn't ready for them to request firmware image from userspace.
1089 * Once it returns successfully, driver can use request_firmware or its
1090 * nowait version to get the cached firmware without any interacting
1091 * with userspace
1092 *
1093 * Return 0 if the firmware image has been cached successfully
1094 * Return !0 otherwise
1095 *
1096 */
1097static int cache_firmware(const char *fw_name)
1098{
1099 int ret;
1100 const struct firmware *fw;
1101
1102 pr_debug("%s: %s\n", __func__, fw_name);
1103
1104 ret = request_firmware(&fw, fw_name, NULL);
1105 if (!ret)
1106 kfree(fw);
1107
1108 pr_debug("%s: %s ret=%d\n", __func__, fw_name, ret);
1109
1110 return ret;
1111}
1112
1113static struct fw_priv *lookup_fw_priv(const char *fw_name)
1114{
1115 struct fw_priv *tmp;
1116 struct firmware_cache *fwc = &fw_cache;
1117
1118 spin_lock(&fwc->lock);
1119 tmp = __lookup_fw_priv(fw_name);
1120 spin_unlock(&fwc->lock);
1121
1122 return tmp;
1123}
1124
1125/**
1126 * uncache_firmware() - remove one cached firmware image
1127 * @fw_name: the firmware image name
1128 *
1129 * Uncache one firmware image which has been cached successfully
1130 * before.
1131 *
1132 * Return 0 if the firmware cache has been removed successfully
1133 * Return !0 otherwise
1134 *
1135 */
1136static int uncache_firmware(const char *fw_name)
1137{
1138 struct fw_priv *fw_priv;
1139 struct firmware fw;
1140
1141 pr_debug("%s: %s\n", __func__, fw_name);
1142
1143 if (fw_get_builtin_firmware(&fw, fw_name, NULL, 0))
1144 return 0;
1145
1146 fw_priv = lookup_fw_priv(fw_name);
1147 if (fw_priv) {
1148 free_fw_priv(fw_priv);
1149 return 0;
1150 }
1151
1152 return -EINVAL;
1153}
1154
1155static struct fw_cache_entry *alloc_fw_cache_entry(const char *name)
1156{
1157 struct fw_cache_entry *fce;
1158
1159 fce = kzalloc(sizeof(*fce), GFP_ATOMIC);
1160 if (!fce)
1161 goto exit;
1162
1163 fce->name = kstrdup_const(name, GFP_ATOMIC);
1164 if (!fce->name) {
1165 kfree(fce);
1166 fce = NULL;
1167 goto exit;
1168 }
1169exit:
1170 return fce;
1171}
1172
1173static int __fw_entry_found(const char *name)
1174{
1175 struct firmware_cache *fwc = &fw_cache;
1176 struct fw_cache_entry *fce;
1177
1178 list_for_each_entry(fce, &fwc->fw_names, list) {
1179 if (!strcmp(fce->name, name))
1180 return 1;
1181 }
1182 return 0;
1183}
1184
1185static int fw_cache_piggyback_on_request(const char *name)
1186{
1187 struct firmware_cache *fwc = &fw_cache;
1188 struct fw_cache_entry *fce;
1189 int ret = 0;
1190
1191 spin_lock(&fwc->name_lock);
1192 if (__fw_entry_found(name))
1193 goto found;
1194
1195 fce = alloc_fw_cache_entry(name);
1196 if (fce) {
1197 ret = 1;
1198 list_add(&fce->list, &fwc->fw_names);
1199 pr_debug("%s: fw: %s\n", __func__, name);
1200 }
1201found:
1202 spin_unlock(&fwc->name_lock);
1203 return ret;
1204}
1205
1206static void free_fw_cache_entry(struct fw_cache_entry *fce)
1207{
1208 kfree_const(fce->name);
1209 kfree(fce);
1210}
1211
1212static void __async_dev_cache_fw_image(void *fw_entry,
1213 async_cookie_t cookie)
1214{
1215 struct fw_cache_entry *fce = fw_entry;
1216 struct firmware_cache *fwc = &fw_cache;
1217 int ret;
1218
1219 ret = cache_firmware(fce->name);
1220 if (ret) {
1221 spin_lock(&fwc->name_lock);
1222 list_del(&fce->list);
1223 spin_unlock(&fwc->name_lock);
1224
1225 free_fw_cache_entry(fce);
1226 }
1227}
1228
1229/* called with dev->devres_lock held */
1230static void dev_create_fw_entry(struct device *dev, void *res,
1231 void *data)
1232{
1233 struct fw_name_devm *fwn = res;
1234 const char *fw_name = fwn->name;
1235 struct list_head *head = data;
1236 struct fw_cache_entry *fce;
1237
1238 fce = alloc_fw_cache_entry(fw_name);
1239 if (fce)
1240 list_add(&fce->list, head);
1241}
1242
1243static int devm_name_match(struct device *dev, void *res,
1244 void *match_data)
1245{
1246 struct fw_name_devm *fwn = res;
1247 return (fwn->magic == (unsigned long)match_data);
1248}
1249
1250static void dev_cache_fw_image(struct device *dev, void *data)
1251{
1252 LIST_HEAD(todo);
1253 struct fw_cache_entry *fce;
1254 struct fw_cache_entry *fce_next;
1255 struct firmware_cache *fwc = &fw_cache;
1256
1257 devres_for_each_res(dev, fw_name_devm_release,
1258 devm_name_match, &fw_cache,
1259 dev_create_fw_entry, &todo);
1260
1261 list_for_each_entry_safe(fce, fce_next, &todo, list) {
1262 list_del(&fce->list);
1263
1264 spin_lock(&fwc->name_lock);
1265 /* only one cache entry for one firmware */
1266 if (!__fw_entry_found(fce->name)) {
1267 list_add(&fce->list, &fwc->fw_names);
1268 } else {
1269 free_fw_cache_entry(fce);
1270 fce = NULL;
1271 }
1272 spin_unlock(&fwc->name_lock);
1273
1274 if (fce)
1275 async_schedule_domain(__async_dev_cache_fw_image,
1276 (void *)fce,
1277 &fw_cache_domain);
1278 }
1279}
1280
1281static void __device_uncache_fw_images(void)
1282{
1283 struct firmware_cache *fwc = &fw_cache;
1284 struct fw_cache_entry *fce;
1285
1286 spin_lock(&fwc->name_lock);
1287 while (!list_empty(&fwc->fw_names)) {
1288 fce = list_entry(fwc->fw_names.next,
1289 struct fw_cache_entry, list);
1290 list_del(&fce->list);
1291 spin_unlock(&fwc->name_lock);
1292
1293 uncache_firmware(fce->name);
1294 free_fw_cache_entry(fce);
1295
1296 spin_lock(&fwc->name_lock);
1297 }
1298 spin_unlock(&fwc->name_lock);
1299}
1300
1301/**
1302 * device_cache_fw_images() - cache devices' firmware
1303 *
1304 * If one device called request_firmware or its nowait version
1305 * successfully before, the firmware names are recored into the
1306 * device's devres link list, so device_cache_fw_images can call
1307 * cache_firmware() to cache these firmwares for the device,
1308 * then the device driver can load its firmwares easily at
1309 * time when system is not ready to complete loading firmware.
1310 */
1311static void device_cache_fw_images(void)
1312{
1313 struct firmware_cache *fwc = &fw_cache;
1314 DEFINE_WAIT(wait);
1315
1316 pr_debug("%s\n", __func__);
1317
1318 /* cancel uncache work */
1319 cancel_delayed_work_sync(&fwc->work);
1320
1321 fw_fallback_set_cache_timeout();
1322
1323 mutex_lock(&fw_lock);
1324 fwc->state = FW_LOADER_START_CACHE;
1325 dpm_for_each_dev(NULL, dev_cache_fw_image);
1326 mutex_unlock(&fw_lock);
1327
1328 /* wait for completion of caching firmware for all devices */
1329 async_synchronize_full_domain(&fw_cache_domain);
1330
1331 fw_fallback_set_default_timeout();
1332}
1333
1334/**
1335 * device_uncache_fw_images() - uncache devices' firmware
1336 *
1337 * uncache all firmwares which have been cached successfully
1338 * by device_uncache_fw_images earlier
1339 */
1340static void device_uncache_fw_images(void)
1341{
1342 pr_debug("%s\n", __func__);
1343 __device_uncache_fw_images();
1344}
1345
1346static void device_uncache_fw_images_work(struct work_struct *work)
1347{
1348 device_uncache_fw_images();
1349}
1350
1351/**
1352 * device_uncache_fw_images_delay() - uncache devices firmwares
1353 * @delay: number of milliseconds to delay uncache device firmwares
1354 *
1355 * uncache all devices's firmwares which has been cached successfully
1356 * by device_cache_fw_images after @delay milliseconds.
1357 */
1358static void device_uncache_fw_images_delay(unsigned long delay)
1359{
1360 queue_delayed_work(system_power_efficient_wq, &fw_cache.work,
1361 msecs_to_jiffies(delay));
1362}
1363
1364static int fw_pm_notify(struct notifier_block *notify_block,
1365 unsigned long mode, void *unused)
1366{
1367 switch (mode) {
1368 case PM_HIBERNATION_PREPARE:
1369 case PM_SUSPEND_PREPARE:
1370 case PM_RESTORE_PREPARE:
1371 /*
1372 * kill pending fallback requests with a custom fallback
1373 * to avoid stalling suspend.
1374 */
1375 kill_pending_fw_fallback_reqs(true);
1376 device_cache_fw_images();
1377 break;
1378
1379 case PM_POST_SUSPEND:
1380 case PM_POST_HIBERNATION:
1381 case PM_POST_RESTORE:
1382 /*
1383 * In case that system sleep failed and syscore_suspend is
1384 * not called.
1385 */
1386 mutex_lock(&fw_lock);
1387 fw_cache.state = FW_LOADER_NO_CACHE;
1388 mutex_unlock(&fw_lock);
1389
1390 device_uncache_fw_images_delay(10 * MSEC_PER_SEC);
1391 break;
1392 }
1393
1394 return 0;
1395}
1396
1397/* stop caching firmware once syscore_suspend is reached */
1398static int fw_suspend(void)
1399{
1400 fw_cache.state = FW_LOADER_NO_CACHE;
1401 return 0;
1402}
1403
1404static struct syscore_ops fw_syscore_ops = {
1405 .suspend = fw_suspend,
1406};
1407
1408static int __init register_fw_pm_ops(void)
1409{
1410 int ret;
1411
1412 spin_lock_init(&fw_cache.name_lock);
1413 INIT_LIST_HEAD(&fw_cache.fw_names);
1414
1415 INIT_DELAYED_WORK(&fw_cache.work,
1416 device_uncache_fw_images_work);
1417
1418 fw_cache.pm_notify.notifier_call = fw_pm_notify;
1419 ret = register_pm_notifier(&fw_cache.pm_notify);
1420 if (ret)
1421 return ret;
1422
1423 register_syscore_ops(&fw_syscore_ops);
1424
1425 return ret;
1426}
1427
1428static inline void unregister_fw_pm_ops(void)
1429{
1430 unregister_syscore_ops(&fw_syscore_ops);
1431 unregister_pm_notifier(&fw_cache.pm_notify);
1432}
1433#else
1434static int fw_cache_piggyback_on_request(const char *name)
1435{
1436 return 0;
1437}
1438static inline int register_fw_pm_ops(void)
1439{
1440 return 0;
1441}
1442static inline void unregister_fw_pm_ops(void)
1443{
1444}
1445#endif
1446
1447static void __init fw_cache_init(void)
1448{
1449 spin_lock_init(&fw_cache.lock);
1450 INIT_LIST_HEAD(&fw_cache.head);
1451 fw_cache.state = FW_LOADER_NO_CACHE;
1452}
1453
1454static int fw_shutdown_notify(struct notifier_block *unused1,
1455 unsigned long unused2, void *unused3)
1456{
1457 /*
1458 * Kill all pending fallback requests to avoid both stalling shutdown,
1459 * and avoid a deadlock with the usermode_lock.
1460 */
1461 kill_pending_fw_fallback_reqs(false);
1462
1463 return NOTIFY_DONE;
1464}
1465
1466static struct notifier_block fw_shutdown_nb = {
1467 .notifier_call = fw_shutdown_notify,
1468};
1469
1470static int __init firmware_class_init(void)
1471{
1472 int ret;
1473
1474 /* No need to unfold these on exit */
1475 fw_cache_init();
1476
1477 ret = register_fw_pm_ops();
1478 if (ret)
1479 return ret;
1480
1481 ret = register_reboot_notifier(&fw_shutdown_nb);
1482 if (ret)
1483 goto out;
1484
1485 return register_sysfs_loader();
1486
1487out:
1488 unregister_fw_pm_ops();
1489 return ret;
1490}
1491
1492static void __exit firmware_class_exit(void)
1493{
1494 unregister_fw_pm_ops();
1495 unregister_reboot_notifier(&fw_shutdown_nb);
1496 unregister_sysfs_loader();
1497}
1498
1499fs_initcall(firmware_class_init);
1500module_exit(firmware_class_exit);
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * main.c - Multi purpose firmware loading support
4 *
5 * Copyright (c) 2003 Manuel Estrada Sainz
6 *
7 * Please see Documentation/driver-api/firmware/ for more information.
8 *
9 */
10
11#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
12
13#include <linux/capability.h>
14#include <linux/device.h>
15#include <linux/kernel_read_file.h>
16#include <linux/module.h>
17#include <linux/init.h>
18#include <linux/initrd.h>
19#include <linux/timer.h>
20#include <linux/vmalloc.h>
21#include <linux/interrupt.h>
22#include <linux/bitops.h>
23#include <linux/mutex.h>
24#include <linux/workqueue.h>
25#include <linux/highmem.h>
26#include <linux/firmware.h>
27#include <linux/slab.h>
28#include <linux/sched.h>
29#include <linux/file.h>
30#include <linux/list.h>
31#include <linux/fs.h>
32#include <linux/async.h>
33#include <linux/pm.h>
34#include <linux/suspend.h>
35#include <linux/syscore_ops.h>
36#include <linux/reboot.h>
37#include <linux/security.h>
38#include <linux/xz.h>
39
40#include <generated/utsrelease.h>
41
42#include "../base.h"
43#include "firmware.h"
44#include "fallback.h"
45
46MODULE_AUTHOR("Manuel Estrada Sainz");
47MODULE_DESCRIPTION("Multi purpose firmware loading support");
48MODULE_LICENSE("GPL");
49
50struct firmware_cache {
51 /* firmware_buf instance will be added into the below list */
52 spinlock_t lock;
53 struct list_head head;
54 int state;
55
56#ifdef CONFIG_FW_CACHE
57 /*
58 * Names of firmware images which have been cached successfully
59 * will be added into the below list so that device uncache
60 * helper can trace which firmware images have been cached
61 * before.
62 */
63 spinlock_t name_lock;
64 struct list_head fw_names;
65
66 struct delayed_work work;
67
68 struct notifier_block pm_notify;
69#endif
70};
71
72struct fw_cache_entry {
73 struct list_head list;
74 const char *name;
75};
76
77struct fw_name_devm {
78 unsigned long magic;
79 const char *name;
80};
81
82static inline struct fw_priv *to_fw_priv(struct kref *ref)
83{
84 return container_of(ref, struct fw_priv, ref);
85}
86
87#define FW_LOADER_NO_CACHE 0
88#define FW_LOADER_START_CACHE 1
89
90/* fw_lock could be moved to 'struct fw_sysfs' but since it is just
91 * guarding for corner cases a global lock should be OK */
92DEFINE_MUTEX(fw_lock);
93
94static struct firmware_cache fw_cache;
95
96/* Builtin firmware support */
97
98#ifdef CONFIG_FW_LOADER
99
100extern struct builtin_fw __start_builtin_fw[];
101extern struct builtin_fw __end_builtin_fw[];
102
103static void fw_copy_to_prealloc_buf(struct firmware *fw,
104 void *buf, size_t size)
105{
106 if (!buf || size < fw->size)
107 return;
108 memcpy(buf, fw->data, fw->size);
109}
110
111static bool fw_get_builtin_firmware(struct firmware *fw, const char *name,
112 void *buf, size_t size)
113{
114 struct builtin_fw *b_fw;
115
116 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++) {
117 if (strcmp(name, b_fw->name) == 0) {
118 fw->size = b_fw->size;
119 fw->data = b_fw->data;
120 fw_copy_to_prealloc_buf(fw, buf, size);
121
122 return true;
123 }
124 }
125
126 return false;
127}
128
129static bool fw_is_builtin_firmware(const struct firmware *fw)
130{
131 struct builtin_fw *b_fw;
132
133 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++)
134 if (fw->data == b_fw->data)
135 return true;
136
137 return false;
138}
139
140#else /* Module case - no builtin firmware support */
141
142static inline bool fw_get_builtin_firmware(struct firmware *fw,
143 const char *name, void *buf,
144 size_t size)
145{
146 return false;
147}
148
149static inline bool fw_is_builtin_firmware(const struct firmware *fw)
150{
151 return false;
152}
153#endif
154
155static void fw_state_init(struct fw_priv *fw_priv)
156{
157 struct fw_state *fw_st = &fw_priv->fw_st;
158
159 init_completion(&fw_st->completion);
160 fw_st->status = FW_STATUS_UNKNOWN;
161}
162
163static inline int fw_state_wait(struct fw_priv *fw_priv)
164{
165 return __fw_state_wait_common(fw_priv, MAX_SCHEDULE_TIMEOUT);
166}
167
168static void fw_cache_piggyback_on_request(struct fw_priv *fw_priv);
169
170static struct fw_priv *__allocate_fw_priv(const char *fw_name,
171 struct firmware_cache *fwc,
172 void *dbuf,
173 size_t size,
174 size_t offset,
175 u32 opt_flags)
176{
177 struct fw_priv *fw_priv;
178
179 /* For a partial read, the buffer must be preallocated. */
180 if ((opt_flags & FW_OPT_PARTIAL) && !dbuf)
181 return NULL;
182
183 /* Only partial reads are allowed to use an offset. */
184 if (offset != 0 && !(opt_flags & FW_OPT_PARTIAL))
185 return NULL;
186
187 fw_priv = kzalloc(sizeof(*fw_priv), GFP_ATOMIC);
188 if (!fw_priv)
189 return NULL;
190
191 fw_priv->fw_name = kstrdup_const(fw_name, GFP_ATOMIC);
192 if (!fw_priv->fw_name) {
193 kfree(fw_priv);
194 return NULL;
195 }
196
197 kref_init(&fw_priv->ref);
198 fw_priv->fwc = fwc;
199 fw_priv->data = dbuf;
200 fw_priv->allocated_size = size;
201 fw_priv->offset = offset;
202 fw_priv->opt_flags = opt_flags;
203 fw_state_init(fw_priv);
204#ifdef CONFIG_FW_LOADER_USER_HELPER
205 INIT_LIST_HEAD(&fw_priv->pending_list);
206#endif
207
208 pr_debug("%s: fw-%s fw_priv=%p\n", __func__, fw_name, fw_priv);
209
210 return fw_priv;
211}
212
213static struct fw_priv *__lookup_fw_priv(const char *fw_name)
214{
215 struct fw_priv *tmp;
216 struct firmware_cache *fwc = &fw_cache;
217
218 list_for_each_entry(tmp, &fwc->head, list)
219 if (!strcmp(tmp->fw_name, fw_name))
220 return tmp;
221 return NULL;
222}
223
224/* Returns 1 for batching firmware requests with the same name */
225static int alloc_lookup_fw_priv(const char *fw_name,
226 struct firmware_cache *fwc,
227 struct fw_priv **fw_priv,
228 void *dbuf,
229 size_t size,
230 size_t offset,
231 u32 opt_flags)
232{
233 struct fw_priv *tmp;
234
235 spin_lock(&fwc->lock);
236 /*
237 * Do not merge requests that are marked to be non-cached or
238 * are performing partial reads.
239 */
240 if (!(opt_flags & (FW_OPT_NOCACHE | FW_OPT_PARTIAL))) {
241 tmp = __lookup_fw_priv(fw_name);
242 if (tmp) {
243 kref_get(&tmp->ref);
244 spin_unlock(&fwc->lock);
245 *fw_priv = tmp;
246 pr_debug("batched request - sharing the same struct fw_priv and lookup for multiple requests\n");
247 return 1;
248 }
249 }
250
251 tmp = __allocate_fw_priv(fw_name, fwc, dbuf, size, offset, opt_flags);
252 if (tmp) {
253 INIT_LIST_HEAD(&tmp->list);
254 if (!(opt_flags & FW_OPT_NOCACHE))
255 list_add(&tmp->list, &fwc->head);
256 }
257 spin_unlock(&fwc->lock);
258
259 *fw_priv = tmp;
260
261 return tmp ? 0 : -ENOMEM;
262}
263
264static void __free_fw_priv(struct kref *ref)
265 __releases(&fwc->lock)
266{
267 struct fw_priv *fw_priv = to_fw_priv(ref);
268 struct firmware_cache *fwc = fw_priv->fwc;
269
270 pr_debug("%s: fw-%s fw_priv=%p data=%p size=%u\n",
271 __func__, fw_priv->fw_name, fw_priv, fw_priv->data,
272 (unsigned int)fw_priv->size);
273
274 list_del(&fw_priv->list);
275 spin_unlock(&fwc->lock);
276
277 if (fw_is_paged_buf(fw_priv))
278 fw_free_paged_buf(fw_priv);
279 else if (!fw_priv->allocated_size)
280 vfree(fw_priv->data);
281
282 kfree_const(fw_priv->fw_name);
283 kfree(fw_priv);
284}
285
286static void free_fw_priv(struct fw_priv *fw_priv)
287{
288 struct firmware_cache *fwc = fw_priv->fwc;
289 spin_lock(&fwc->lock);
290 if (!kref_put(&fw_priv->ref, __free_fw_priv))
291 spin_unlock(&fwc->lock);
292}
293
294#ifdef CONFIG_FW_LOADER_PAGED_BUF
295bool fw_is_paged_buf(struct fw_priv *fw_priv)
296{
297 return fw_priv->is_paged_buf;
298}
299
300void fw_free_paged_buf(struct fw_priv *fw_priv)
301{
302 int i;
303
304 if (!fw_priv->pages)
305 return;
306
307 vunmap(fw_priv->data);
308
309 for (i = 0; i < fw_priv->nr_pages; i++)
310 __free_page(fw_priv->pages[i]);
311 kvfree(fw_priv->pages);
312 fw_priv->pages = NULL;
313 fw_priv->page_array_size = 0;
314 fw_priv->nr_pages = 0;
315}
316
317int fw_grow_paged_buf(struct fw_priv *fw_priv, int pages_needed)
318{
319 /* If the array of pages is too small, grow it */
320 if (fw_priv->page_array_size < pages_needed) {
321 int new_array_size = max(pages_needed,
322 fw_priv->page_array_size * 2);
323 struct page **new_pages;
324
325 new_pages = kvmalloc_array(new_array_size, sizeof(void *),
326 GFP_KERNEL);
327 if (!new_pages)
328 return -ENOMEM;
329 memcpy(new_pages, fw_priv->pages,
330 fw_priv->page_array_size * sizeof(void *));
331 memset(&new_pages[fw_priv->page_array_size], 0, sizeof(void *) *
332 (new_array_size - fw_priv->page_array_size));
333 kvfree(fw_priv->pages);
334 fw_priv->pages = new_pages;
335 fw_priv->page_array_size = new_array_size;
336 }
337
338 while (fw_priv->nr_pages < pages_needed) {
339 fw_priv->pages[fw_priv->nr_pages] =
340 alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
341
342 if (!fw_priv->pages[fw_priv->nr_pages])
343 return -ENOMEM;
344 fw_priv->nr_pages++;
345 }
346
347 return 0;
348}
349
350int fw_map_paged_buf(struct fw_priv *fw_priv)
351{
352 /* one pages buffer should be mapped/unmapped only once */
353 if (!fw_priv->pages)
354 return 0;
355
356 vunmap(fw_priv->data);
357 fw_priv->data = vmap(fw_priv->pages, fw_priv->nr_pages, 0,
358 PAGE_KERNEL_RO);
359 if (!fw_priv->data)
360 return -ENOMEM;
361
362 return 0;
363}
364#endif
365
366/*
367 * XZ-compressed firmware support
368 */
369#ifdef CONFIG_FW_LOADER_COMPRESS
370/* show an error and return the standard error code */
371static int fw_decompress_xz_error(struct device *dev, enum xz_ret xz_ret)
372{
373 if (xz_ret != XZ_STREAM_END) {
374 dev_warn(dev, "xz decompression failed (xz_ret=%d)\n", xz_ret);
375 return xz_ret == XZ_MEM_ERROR ? -ENOMEM : -EINVAL;
376 }
377 return 0;
378}
379
380/* single-shot decompression onto the pre-allocated buffer */
381static int fw_decompress_xz_single(struct device *dev, struct fw_priv *fw_priv,
382 size_t in_size, const void *in_buffer)
383{
384 struct xz_dec *xz_dec;
385 struct xz_buf xz_buf;
386 enum xz_ret xz_ret;
387
388 xz_dec = xz_dec_init(XZ_SINGLE, (u32)-1);
389 if (!xz_dec)
390 return -ENOMEM;
391
392 xz_buf.in_size = in_size;
393 xz_buf.in = in_buffer;
394 xz_buf.in_pos = 0;
395 xz_buf.out_size = fw_priv->allocated_size;
396 xz_buf.out = fw_priv->data;
397 xz_buf.out_pos = 0;
398
399 xz_ret = xz_dec_run(xz_dec, &xz_buf);
400 xz_dec_end(xz_dec);
401
402 fw_priv->size = xz_buf.out_pos;
403 return fw_decompress_xz_error(dev, xz_ret);
404}
405
406/* decompression on paged buffer and map it */
407static int fw_decompress_xz_pages(struct device *dev, struct fw_priv *fw_priv,
408 size_t in_size, const void *in_buffer)
409{
410 struct xz_dec *xz_dec;
411 struct xz_buf xz_buf;
412 enum xz_ret xz_ret;
413 struct page *page;
414 int err = 0;
415
416 xz_dec = xz_dec_init(XZ_DYNALLOC, (u32)-1);
417 if (!xz_dec)
418 return -ENOMEM;
419
420 xz_buf.in_size = in_size;
421 xz_buf.in = in_buffer;
422 xz_buf.in_pos = 0;
423
424 fw_priv->is_paged_buf = true;
425 fw_priv->size = 0;
426 do {
427 if (fw_grow_paged_buf(fw_priv, fw_priv->nr_pages + 1)) {
428 err = -ENOMEM;
429 goto out;
430 }
431
432 /* decompress onto the new allocated page */
433 page = fw_priv->pages[fw_priv->nr_pages - 1];
434 xz_buf.out = kmap(page);
435 xz_buf.out_pos = 0;
436 xz_buf.out_size = PAGE_SIZE;
437 xz_ret = xz_dec_run(xz_dec, &xz_buf);
438 kunmap(page);
439 fw_priv->size += xz_buf.out_pos;
440 /* partial decompression means either end or error */
441 if (xz_buf.out_pos != PAGE_SIZE)
442 break;
443 } while (xz_ret == XZ_OK);
444
445 err = fw_decompress_xz_error(dev, xz_ret);
446 if (!err)
447 err = fw_map_paged_buf(fw_priv);
448
449 out:
450 xz_dec_end(xz_dec);
451 return err;
452}
453
454static int fw_decompress_xz(struct device *dev, struct fw_priv *fw_priv,
455 size_t in_size, const void *in_buffer)
456{
457 /* if the buffer is pre-allocated, we can perform in single-shot mode */
458 if (fw_priv->data)
459 return fw_decompress_xz_single(dev, fw_priv, in_size, in_buffer);
460 else
461 return fw_decompress_xz_pages(dev, fw_priv, in_size, in_buffer);
462}
463#endif /* CONFIG_FW_LOADER_COMPRESS */
464
465/* direct firmware loading support */
466static char fw_path_para[256];
467static const char * const fw_path[] = {
468 fw_path_para,
469 "/lib/firmware/updates/" UTS_RELEASE,
470 "/lib/firmware/updates",
471 "/lib/firmware/" UTS_RELEASE,
472 "/lib/firmware"
473};
474
475/*
476 * Typical usage is that passing 'firmware_class.path=$CUSTOMIZED_PATH'
477 * from kernel command line because firmware_class is generally built in
478 * kernel instead of module.
479 */
480module_param_string(path, fw_path_para, sizeof(fw_path_para), 0644);
481MODULE_PARM_DESC(path, "customized firmware image search path with a higher priority than default path");
482
483static int
484fw_get_filesystem_firmware(struct device *device, struct fw_priv *fw_priv,
485 const char *suffix,
486 int (*decompress)(struct device *dev,
487 struct fw_priv *fw_priv,
488 size_t in_size,
489 const void *in_buffer))
490{
491 size_t size;
492 int i, len;
493 int rc = -ENOENT;
494 char *path;
495 size_t msize = INT_MAX;
496 void *buffer = NULL;
497
498 /* Already populated data member means we're loading into a buffer */
499 if (!decompress && fw_priv->data) {
500 buffer = fw_priv->data;
501 msize = fw_priv->allocated_size;
502 }
503
504 path = __getname();
505 if (!path)
506 return -ENOMEM;
507
508 wait_for_initramfs();
509 for (i = 0; i < ARRAY_SIZE(fw_path); i++) {
510 size_t file_size = 0;
511 size_t *file_size_ptr = NULL;
512
513 /* skip the unset customized path */
514 if (!fw_path[i][0])
515 continue;
516
517 len = snprintf(path, PATH_MAX, "%s/%s%s",
518 fw_path[i], fw_priv->fw_name, suffix);
519 if (len >= PATH_MAX) {
520 rc = -ENAMETOOLONG;
521 break;
522 }
523
524 fw_priv->size = 0;
525
526 /*
527 * The total file size is only examined when doing a partial
528 * read; the "full read" case needs to fail if the whole
529 * firmware was not completely loaded.
530 */
531 if ((fw_priv->opt_flags & FW_OPT_PARTIAL) && buffer)
532 file_size_ptr = &file_size;
533
534 /* load firmware files from the mount namespace of init */
535 rc = kernel_read_file_from_path_initns(path, fw_priv->offset,
536 &buffer, msize,
537 file_size_ptr,
538 READING_FIRMWARE);
539 if (rc < 0) {
540 if (rc != -ENOENT)
541 dev_warn(device, "loading %s failed with error %d\n",
542 path, rc);
543 else
544 dev_dbg(device, "loading %s failed for no such file or directory.\n",
545 path);
546 continue;
547 }
548 size = rc;
549 rc = 0;
550
551 dev_dbg(device, "Loading firmware from %s\n", path);
552 if (decompress) {
553 dev_dbg(device, "f/w decompressing %s\n",
554 fw_priv->fw_name);
555 rc = decompress(device, fw_priv, size, buffer);
556 /* discard the superfluous original content */
557 vfree(buffer);
558 buffer = NULL;
559 if (rc) {
560 fw_free_paged_buf(fw_priv);
561 continue;
562 }
563 } else {
564 dev_dbg(device, "direct-loading %s\n",
565 fw_priv->fw_name);
566 if (!fw_priv->data)
567 fw_priv->data = buffer;
568 fw_priv->size = size;
569 }
570 fw_state_done(fw_priv);
571 break;
572 }
573 __putname(path);
574
575 return rc;
576}
577
578/* firmware holds the ownership of pages */
579static void firmware_free_data(const struct firmware *fw)
580{
581 /* Loaded directly? */
582 if (!fw->priv) {
583 vfree(fw->data);
584 return;
585 }
586 free_fw_priv(fw->priv);
587}
588
589/* store the pages buffer info firmware from buf */
590static void fw_set_page_data(struct fw_priv *fw_priv, struct firmware *fw)
591{
592 fw->priv = fw_priv;
593 fw->size = fw_priv->size;
594 fw->data = fw_priv->data;
595
596 pr_debug("%s: fw-%s fw_priv=%p data=%p size=%u\n",
597 __func__, fw_priv->fw_name, fw_priv, fw_priv->data,
598 (unsigned int)fw_priv->size);
599}
600
601#ifdef CONFIG_FW_CACHE
602static void fw_name_devm_release(struct device *dev, void *res)
603{
604 struct fw_name_devm *fwn = res;
605
606 if (fwn->magic == (unsigned long)&fw_cache)
607 pr_debug("%s: fw_name-%s devm-%p released\n",
608 __func__, fwn->name, res);
609 kfree_const(fwn->name);
610}
611
612static int fw_devm_match(struct device *dev, void *res,
613 void *match_data)
614{
615 struct fw_name_devm *fwn = res;
616
617 return (fwn->magic == (unsigned long)&fw_cache) &&
618 !strcmp(fwn->name, match_data);
619}
620
621static struct fw_name_devm *fw_find_devm_name(struct device *dev,
622 const char *name)
623{
624 struct fw_name_devm *fwn;
625
626 fwn = devres_find(dev, fw_name_devm_release,
627 fw_devm_match, (void *)name);
628 return fwn;
629}
630
631static bool fw_cache_is_setup(struct device *dev, const char *name)
632{
633 struct fw_name_devm *fwn;
634
635 fwn = fw_find_devm_name(dev, name);
636 if (fwn)
637 return true;
638
639 return false;
640}
641
642/* add firmware name into devres list */
643static int fw_add_devm_name(struct device *dev, const char *name)
644{
645 struct fw_name_devm *fwn;
646
647 if (fw_cache_is_setup(dev, name))
648 return 0;
649
650 fwn = devres_alloc(fw_name_devm_release, sizeof(struct fw_name_devm),
651 GFP_KERNEL);
652 if (!fwn)
653 return -ENOMEM;
654 fwn->name = kstrdup_const(name, GFP_KERNEL);
655 if (!fwn->name) {
656 devres_free(fwn);
657 return -ENOMEM;
658 }
659
660 fwn->magic = (unsigned long)&fw_cache;
661 devres_add(dev, fwn);
662
663 return 0;
664}
665#else
666static bool fw_cache_is_setup(struct device *dev, const char *name)
667{
668 return false;
669}
670
671static int fw_add_devm_name(struct device *dev, const char *name)
672{
673 return 0;
674}
675#endif
676
677int assign_fw(struct firmware *fw, struct device *device)
678{
679 struct fw_priv *fw_priv = fw->priv;
680 int ret;
681
682 mutex_lock(&fw_lock);
683 if (!fw_priv->size || fw_state_is_aborted(fw_priv)) {
684 mutex_unlock(&fw_lock);
685 return -ENOENT;
686 }
687
688 /*
689 * add firmware name into devres list so that we can auto cache
690 * and uncache firmware for device.
691 *
692 * device may has been deleted already, but the problem
693 * should be fixed in devres or driver core.
694 */
695 /* don't cache firmware handled without uevent */
696 if (device && (fw_priv->opt_flags & FW_OPT_UEVENT) &&
697 !(fw_priv->opt_flags & FW_OPT_NOCACHE)) {
698 ret = fw_add_devm_name(device, fw_priv->fw_name);
699 if (ret) {
700 mutex_unlock(&fw_lock);
701 return ret;
702 }
703 }
704
705 /*
706 * After caching firmware image is started, let it piggyback
707 * on request firmware.
708 */
709 if (!(fw_priv->opt_flags & FW_OPT_NOCACHE) &&
710 fw_priv->fwc->state == FW_LOADER_START_CACHE)
711 fw_cache_piggyback_on_request(fw_priv);
712
713 /* pass the pages buffer to driver at the last minute */
714 fw_set_page_data(fw_priv, fw);
715 mutex_unlock(&fw_lock);
716 return 0;
717}
718
719/* prepare firmware and firmware_buf structs;
720 * return 0 if a firmware is already assigned, 1 if need to load one,
721 * or a negative error code
722 */
723static int
724_request_firmware_prepare(struct firmware **firmware_p, const char *name,
725 struct device *device, void *dbuf, size_t size,
726 size_t offset, u32 opt_flags)
727{
728 struct firmware *firmware;
729 struct fw_priv *fw_priv;
730 int ret;
731
732 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
733 if (!firmware) {
734 dev_err(device, "%s: kmalloc(struct firmware) failed\n",
735 __func__);
736 return -ENOMEM;
737 }
738
739 if (fw_get_builtin_firmware(firmware, name, dbuf, size)) {
740 dev_dbg(device, "using built-in %s\n", name);
741 return 0; /* assigned */
742 }
743
744 ret = alloc_lookup_fw_priv(name, &fw_cache, &fw_priv, dbuf, size,
745 offset, opt_flags);
746
747 /*
748 * bind with 'priv' now to avoid warning in failure path
749 * of requesting firmware.
750 */
751 firmware->priv = fw_priv;
752
753 if (ret > 0) {
754 ret = fw_state_wait(fw_priv);
755 if (!ret) {
756 fw_set_page_data(fw_priv, firmware);
757 return 0; /* assigned */
758 }
759 }
760
761 if (ret < 0)
762 return ret;
763 return 1; /* need to load */
764}
765
766/*
767 * Batched requests need only one wake, we need to do this step last due to the
768 * fallback mechanism. The buf is protected with kref_get(), and it won't be
769 * released until the last user calls release_firmware().
770 *
771 * Failed batched requests are possible as well, in such cases we just share
772 * the struct fw_priv and won't release it until all requests are woken
773 * and have gone through this same path.
774 */
775static void fw_abort_batch_reqs(struct firmware *fw)
776{
777 struct fw_priv *fw_priv;
778
779 /* Loaded directly? */
780 if (!fw || !fw->priv)
781 return;
782
783 fw_priv = fw->priv;
784 mutex_lock(&fw_lock);
785 if (!fw_state_is_aborted(fw_priv))
786 fw_state_aborted(fw_priv);
787 mutex_unlock(&fw_lock);
788}
789
790/* called from request_firmware() and request_firmware_work_func() */
791static int
792_request_firmware(const struct firmware **firmware_p, const char *name,
793 struct device *device, void *buf, size_t size,
794 size_t offset, u32 opt_flags)
795{
796 struct firmware *fw = NULL;
797 bool nondirect = false;
798 int ret;
799
800 if (!firmware_p)
801 return -EINVAL;
802
803 if (!name || name[0] == '\0') {
804 ret = -EINVAL;
805 goto out;
806 }
807
808 ret = _request_firmware_prepare(&fw, name, device, buf, size,
809 offset, opt_flags);
810 if (ret <= 0) /* error or already assigned */
811 goto out;
812
813 ret = fw_get_filesystem_firmware(device, fw->priv, "", NULL);
814
815 /* Only full reads can support decompression, platform, and sysfs. */
816 if (!(opt_flags & FW_OPT_PARTIAL))
817 nondirect = true;
818
819#ifdef CONFIG_FW_LOADER_COMPRESS
820 if (ret == -ENOENT && nondirect)
821 ret = fw_get_filesystem_firmware(device, fw->priv, ".xz",
822 fw_decompress_xz);
823#endif
824 if (ret == -ENOENT && nondirect)
825 ret = firmware_fallback_platform(fw->priv);
826
827 if (ret) {
828 if (!(opt_flags & FW_OPT_NO_WARN))
829 dev_warn(device,
830 "Direct firmware load for %s failed with error %d\n",
831 name, ret);
832 if (nondirect)
833 ret = firmware_fallback_sysfs(fw, name, device,
834 opt_flags, ret);
835 } else
836 ret = assign_fw(fw, device);
837
838 out:
839 if (ret < 0) {
840 fw_abort_batch_reqs(fw);
841 release_firmware(fw);
842 fw = NULL;
843 }
844
845 *firmware_p = fw;
846 return ret;
847}
848
849/**
850 * request_firmware() - send firmware request and wait for it
851 * @firmware_p: pointer to firmware image
852 * @name: name of firmware file
853 * @device: device for which firmware is being loaded
854 *
855 * @firmware_p will be used to return a firmware image by the name
856 * of @name for device @device.
857 *
858 * Should be called from user context where sleeping is allowed.
859 *
860 * @name will be used as $FIRMWARE in the uevent environment and
861 * should be distinctive enough not to be confused with any other
862 * firmware image for this or any other device.
863 *
864 * Caller must hold the reference count of @device.
865 *
866 * The function can be called safely inside device's suspend and
867 * resume callback.
868 **/
869int
870request_firmware(const struct firmware **firmware_p, const char *name,
871 struct device *device)
872{
873 int ret;
874
875 /* Need to pin this module until return */
876 __module_get(THIS_MODULE);
877 ret = _request_firmware(firmware_p, name, device, NULL, 0, 0,
878 FW_OPT_UEVENT);
879 module_put(THIS_MODULE);
880 return ret;
881}
882EXPORT_SYMBOL(request_firmware);
883
884/**
885 * firmware_request_nowarn() - request for an optional fw module
886 * @firmware: pointer to firmware image
887 * @name: name of firmware file
888 * @device: device for which firmware is being loaded
889 *
890 * This function is similar in behaviour to request_firmware(), except it
891 * doesn't produce warning messages when the file is not found. The sysfs
892 * fallback mechanism is enabled if direct filesystem lookup fails. However,
893 * failures to find the firmware file with it are still suppressed. It is
894 * therefore up to the driver to check for the return value of this call and to
895 * decide when to inform the users of errors.
896 **/
897int firmware_request_nowarn(const struct firmware **firmware, const char *name,
898 struct device *device)
899{
900 int ret;
901
902 /* Need to pin this module until return */
903 __module_get(THIS_MODULE);
904 ret = _request_firmware(firmware, name, device, NULL, 0, 0,
905 FW_OPT_UEVENT | FW_OPT_NO_WARN);
906 module_put(THIS_MODULE);
907 return ret;
908}
909EXPORT_SYMBOL_GPL(firmware_request_nowarn);
910
911/**
912 * request_firmware_direct() - load firmware directly without usermode helper
913 * @firmware_p: pointer to firmware image
914 * @name: name of firmware file
915 * @device: device for which firmware is being loaded
916 *
917 * This function works pretty much like request_firmware(), but this doesn't
918 * fall back to usermode helper even if the firmware couldn't be loaded
919 * directly from fs. Hence it's useful for loading optional firmwares, which
920 * aren't always present, without extra long timeouts of udev.
921 **/
922int request_firmware_direct(const struct firmware **firmware_p,
923 const char *name, struct device *device)
924{
925 int ret;
926
927 __module_get(THIS_MODULE);
928 ret = _request_firmware(firmware_p, name, device, NULL, 0, 0,
929 FW_OPT_UEVENT | FW_OPT_NO_WARN |
930 FW_OPT_NOFALLBACK_SYSFS);
931 module_put(THIS_MODULE);
932 return ret;
933}
934EXPORT_SYMBOL_GPL(request_firmware_direct);
935
936/**
937 * firmware_request_platform() - request firmware with platform-fw fallback
938 * @firmware: pointer to firmware image
939 * @name: name of firmware file
940 * @device: device for which firmware is being loaded
941 *
942 * This function is similar in behaviour to request_firmware, except that if
943 * direct filesystem lookup fails, it will fallback to looking for a copy of the
944 * requested firmware embedded in the platform's main (e.g. UEFI) firmware.
945 **/
946int firmware_request_platform(const struct firmware **firmware,
947 const char *name, struct device *device)
948{
949 int ret;
950
951 /* Need to pin this module until return */
952 __module_get(THIS_MODULE);
953 ret = _request_firmware(firmware, name, device, NULL, 0, 0,
954 FW_OPT_UEVENT | FW_OPT_FALLBACK_PLATFORM);
955 module_put(THIS_MODULE);
956 return ret;
957}
958EXPORT_SYMBOL_GPL(firmware_request_platform);
959
960/**
961 * firmware_request_cache() - cache firmware for suspend so resume can use it
962 * @name: name of firmware file
963 * @device: device for which firmware should be cached for
964 *
965 * There are some devices with an optimization that enables the device to not
966 * require loading firmware on system reboot. This optimization may still
967 * require the firmware present on resume from suspend. This routine can be
968 * used to ensure the firmware is present on resume from suspend in these
969 * situations. This helper is not compatible with drivers which use
970 * request_firmware_into_buf() or request_firmware_nowait() with no uevent set.
971 **/
972int firmware_request_cache(struct device *device, const char *name)
973{
974 int ret;
975
976 mutex_lock(&fw_lock);
977 ret = fw_add_devm_name(device, name);
978 mutex_unlock(&fw_lock);
979
980 return ret;
981}
982EXPORT_SYMBOL_GPL(firmware_request_cache);
983
984/**
985 * request_firmware_into_buf() - load firmware into a previously allocated buffer
986 * @firmware_p: pointer to firmware image
987 * @name: name of firmware file
988 * @device: device for which firmware is being loaded and DMA region allocated
989 * @buf: address of buffer to load firmware into
990 * @size: size of buffer
991 *
992 * This function works pretty much like request_firmware(), but it doesn't
993 * allocate a buffer to hold the firmware data. Instead, the firmware
994 * is loaded directly into the buffer pointed to by @buf and the @firmware_p
995 * data member is pointed at @buf.
996 *
997 * This function doesn't cache firmware either.
998 */
999int
1000request_firmware_into_buf(const struct firmware **firmware_p, const char *name,
1001 struct device *device, void *buf, size_t size)
1002{
1003 int ret;
1004
1005 if (fw_cache_is_setup(device, name))
1006 return -EOPNOTSUPP;
1007
1008 __module_get(THIS_MODULE);
1009 ret = _request_firmware(firmware_p, name, device, buf, size, 0,
1010 FW_OPT_UEVENT | FW_OPT_NOCACHE);
1011 module_put(THIS_MODULE);
1012 return ret;
1013}
1014EXPORT_SYMBOL(request_firmware_into_buf);
1015
1016/**
1017 * request_partial_firmware_into_buf() - load partial firmware into a previously allocated buffer
1018 * @firmware_p: pointer to firmware image
1019 * @name: name of firmware file
1020 * @device: device for which firmware is being loaded and DMA region allocated
1021 * @buf: address of buffer to load firmware into
1022 * @size: size of buffer
1023 * @offset: offset into file to read
1024 *
1025 * This function works pretty much like request_firmware_into_buf except
1026 * it allows a partial read of the file.
1027 */
1028int
1029request_partial_firmware_into_buf(const struct firmware **firmware_p,
1030 const char *name, struct device *device,
1031 void *buf, size_t size, size_t offset)
1032{
1033 int ret;
1034
1035 if (fw_cache_is_setup(device, name))
1036 return -EOPNOTSUPP;
1037
1038 __module_get(THIS_MODULE);
1039 ret = _request_firmware(firmware_p, name, device, buf, size, offset,
1040 FW_OPT_UEVENT | FW_OPT_NOCACHE |
1041 FW_OPT_PARTIAL);
1042 module_put(THIS_MODULE);
1043 return ret;
1044}
1045EXPORT_SYMBOL(request_partial_firmware_into_buf);
1046
1047/**
1048 * release_firmware() - release the resource associated with a firmware image
1049 * @fw: firmware resource to release
1050 **/
1051void release_firmware(const struct firmware *fw)
1052{
1053 if (fw) {
1054 if (!fw_is_builtin_firmware(fw))
1055 firmware_free_data(fw);
1056 kfree(fw);
1057 }
1058}
1059EXPORT_SYMBOL(release_firmware);
1060
1061/* Async support */
1062struct firmware_work {
1063 struct work_struct work;
1064 struct module *module;
1065 const char *name;
1066 struct device *device;
1067 void *context;
1068 void (*cont)(const struct firmware *fw, void *context);
1069 u32 opt_flags;
1070};
1071
1072static void request_firmware_work_func(struct work_struct *work)
1073{
1074 struct firmware_work *fw_work;
1075 const struct firmware *fw;
1076
1077 fw_work = container_of(work, struct firmware_work, work);
1078
1079 _request_firmware(&fw, fw_work->name, fw_work->device, NULL, 0, 0,
1080 fw_work->opt_flags);
1081 fw_work->cont(fw, fw_work->context);
1082 put_device(fw_work->device); /* taken in request_firmware_nowait() */
1083
1084 module_put(fw_work->module);
1085 kfree_const(fw_work->name);
1086 kfree(fw_work);
1087}
1088
1089/**
1090 * request_firmware_nowait() - asynchronous version of request_firmware
1091 * @module: module requesting the firmware
1092 * @uevent: sends uevent to copy the firmware image if this flag
1093 * is non-zero else the firmware copy must be done manually.
1094 * @name: name of firmware file
1095 * @device: device for which firmware is being loaded
1096 * @gfp: allocation flags
1097 * @context: will be passed over to @cont, and
1098 * @fw may be %NULL if firmware request fails.
1099 * @cont: function will be called asynchronously when the firmware
1100 * request is over.
1101 *
1102 * Caller must hold the reference count of @device.
1103 *
1104 * Asynchronous variant of request_firmware() for user contexts:
1105 * - sleep for as small periods as possible since it may
1106 * increase kernel boot time of built-in device drivers
1107 * requesting firmware in their ->probe() methods, if
1108 * @gfp is GFP_KERNEL.
1109 *
1110 * - can't sleep at all if @gfp is GFP_ATOMIC.
1111 **/
1112int
1113request_firmware_nowait(
1114 struct module *module, bool uevent,
1115 const char *name, struct device *device, gfp_t gfp, void *context,
1116 void (*cont)(const struct firmware *fw, void *context))
1117{
1118 struct firmware_work *fw_work;
1119
1120 fw_work = kzalloc(sizeof(struct firmware_work), gfp);
1121 if (!fw_work)
1122 return -ENOMEM;
1123
1124 fw_work->module = module;
1125 fw_work->name = kstrdup_const(name, gfp);
1126 if (!fw_work->name) {
1127 kfree(fw_work);
1128 return -ENOMEM;
1129 }
1130 fw_work->device = device;
1131 fw_work->context = context;
1132 fw_work->cont = cont;
1133 fw_work->opt_flags = FW_OPT_NOWAIT |
1134 (uevent ? FW_OPT_UEVENT : FW_OPT_USERHELPER);
1135
1136 if (!uevent && fw_cache_is_setup(device, name)) {
1137 kfree_const(fw_work->name);
1138 kfree(fw_work);
1139 return -EOPNOTSUPP;
1140 }
1141
1142 if (!try_module_get(module)) {
1143 kfree_const(fw_work->name);
1144 kfree(fw_work);
1145 return -EFAULT;
1146 }
1147
1148 get_device(fw_work->device);
1149 INIT_WORK(&fw_work->work, request_firmware_work_func);
1150 schedule_work(&fw_work->work);
1151 return 0;
1152}
1153EXPORT_SYMBOL(request_firmware_nowait);
1154
1155#ifdef CONFIG_FW_CACHE
1156static ASYNC_DOMAIN_EXCLUSIVE(fw_cache_domain);
1157
1158/**
1159 * cache_firmware() - cache one firmware image in kernel memory space
1160 * @fw_name: the firmware image name
1161 *
1162 * Cache firmware in kernel memory so that drivers can use it when
1163 * system isn't ready for them to request firmware image from userspace.
1164 * Once it returns successfully, driver can use request_firmware or its
1165 * nowait version to get the cached firmware without any interacting
1166 * with userspace
1167 *
1168 * Return 0 if the firmware image has been cached successfully
1169 * Return !0 otherwise
1170 *
1171 */
1172static int cache_firmware(const char *fw_name)
1173{
1174 int ret;
1175 const struct firmware *fw;
1176
1177 pr_debug("%s: %s\n", __func__, fw_name);
1178
1179 ret = request_firmware(&fw, fw_name, NULL);
1180 if (!ret)
1181 kfree(fw);
1182
1183 pr_debug("%s: %s ret=%d\n", __func__, fw_name, ret);
1184
1185 return ret;
1186}
1187
1188static struct fw_priv *lookup_fw_priv(const char *fw_name)
1189{
1190 struct fw_priv *tmp;
1191 struct firmware_cache *fwc = &fw_cache;
1192
1193 spin_lock(&fwc->lock);
1194 tmp = __lookup_fw_priv(fw_name);
1195 spin_unlock(&fwc->lock);
1196
1197 return tmp;
1198}
1199
1200/**
1201 * uncache_firmware() - remove one cached firmware image
1202 * @fw_name: the firmware image name
1203 *
1204 * Uncache one firmware image which has been cached successfully
1205 * before.
1206 *
1207 * Return 0 if the firmware cache has been removed successfully
1208 * Return !0 otherwise
1209 *
1210 */
1211static int uncache_firmware(const char *fw_name)
1212{
1213 struct fw_priv *fw_priv;
1214 struct firmware fw;
1215
1216 pr_debug("%s: %s\n", __func__, fw_name);
1217
1218 if (fw_get_builtin_firmware(&fw, fw_name, NULL, 0))
1219 return 0;
1220
1221 fw_priv = lookup_fw_priv(fw_name);
1222 if (fw_priv) {
1223 free_fw_priv(fw_priv);
1224 return 0;
1225 }
1226
1227 return -EINVAL;
1228}
1229
1230static struct fw_cache_entry *alloc_fw_cache_entry(const char *name)
1231{
1232 struct fw_cache_entry *fce;
1233
1234 fce = kzalloc(sizeof(*fce), GFP_ATOMIC);
1235 if (!fce)
1236 goto exit;
1237
1238 fce->name = kstrdup_const(name, GFP_ATOMIC);
1239 if (!fce->name) {
1240 kfree(fce);
1241 fce = NULL;
1242 goto exit;
1243 }
1244exit:
1245 return fce;
1246}
1247
1248static int __fw_entry_found(const char *name)
1249{
1250 struct firmware_cache *fwc = &fw_cache;
1251 struct fw_cache_entry *fce;
1252
1253 list_for_each_entry(fce, &fwc->fw_names, list) {
1254 if (!strcmp(fce->name, name))
1255 return 1;
1256 }
1257 return 0;
1258}
1259
1260static void fw_cache_piggyback_on_request(struct fw_priv *fw_priv)
1261{
1262 const char *name = fw_priv->fw_name;
1263 struct firmware_cache *fwc = fw_priv->fwc;
1264 struct fw_cache_entry *fce;
1265
1266 spin_lock(&fwc->name_lock);
1267 if (__fw_entry_found(name))
1268 goto found;
1269
1270 fce = alloc_fw_cache_entry(name);
1271 if (fce) {
1272 list_add(&fce->list, &fwc->fw_names);
1273 kref_get(&fw_priv->ref);
1274 pr_debug("%s: fw: %s\n", __func__, name);
1275 }
1276found:
1277 spin_unlock(&fwc->name_lock);
1278}
1279
1280static void free_fw_cache_entry(struct fw_cache_entry *fce)
1281{
1282 kfree_const(fce->name);
1283 kfree(fce);
1284}
1285
1286static void __async_dev_cache_fw_image(void *fw_entry,
1287 async_cookie_t cookie)
1288{
1289 struct fw_cache_entry *fce = fw_entry;
1290 struct firmware_cache *fwc = &fw_cache;
1291 int ret;
1292
1293 ret = cache_firmware(fce->name);
1294 if (ret) {
1295 spin_lock(&fwc->name_lock);
1296 list_del(&fce->list);
1297 spin_unlock(&fwc->name_lock);
1298
1299 free_fw_cache_entry(fce);
1300 }
1301}
1302
1303/* called with dev->devres_lock held */
1304static void dev_create_fw_entry(struct device *dev, void *res,
1305 void *data)
1306{
1307 struct fw_name_devm *fwn = res;
1308 const char *fw_name = fwn->name;
1309 struct list_head *head = data;
1310 struct fw_cache_entry *fce;
1311
1312 fce = alloc_fw_cache_entry(fw_name);
1313 if (fce)
1314 list_add(&fce->list, head);
1315}
1316
1317static int devm_name_match(struct device *dev, void *res,
1318 void *match_data)
1319{
1320 struct fw_name_devm *fwn = res;
1321 return (fwn->magic == (unsigned long)match_data);
1322}
1323
1324static void dev_cache_fw_image(struct device *dev, void *data)
1325{
1326 LIST_HEAD(todo);
1327 struct fw_cache_entry *fce;
1328 struct fw_cache_entry *fce_next;
1329 struct firmware_cache *fwc = &fw_cache;
1330
1331 devres_for_each_res(dev, fw_name_devm_release,
1332 devm_name_match, &fw_cache,
1333 dev_create_fw_entry, &todo);
1334
1335 list_for_each_entry_safe(fce, fce_next, &todo, list) {
1336 list_del(&fce->list);
1337
1338 spin_lock(&fwc->name_lock);
1339 /* only one cache entry for one firmware */
1340 if (!__fw_entry_found(fce->name)) {
1341 list_add(&fce->list, &fwc->fw_names);
1342 } else {
1343 free_fw_cache_entry(fce);
1344 fce = NULL;
1345 }
1346 spin_unlock(&fwc->name_lock);
1347
1348 if (fce)
1349 async_schedule_domain(__async_dev_cache_fw_image,
1350 (void *)fce,
1351 &fw_cache_domain);
1352 }
1353}
1354
1355static void __device_uncache_fw_images(void)
1356{
1357 struct firmware_cache *fwc = &fw_cache;
1358 struct fw_cache_entry *fce;
1359
1360 spin_lock(&fwc->name_lock);
1361 while (!list_empty(&fwc->fw_names)) {
1362 fce = list_entry(fwc->fw_names.next,
1363 struct fw_cache_entry, list);
1364 list_del(&fce->list);
1365 spin_unlock(&fwc->name_lock);
1366
1367 uncache_firmware(fce->name);
1368 free_fw_cache_entry(fce);
1369
1370 spin_lock(&fwc->name_lock);
1371 }
1372 spin_unlock(&fwc->name_lock);
1373}
1374
1375/**
1376 * device_cache_fw_images() - cache devices' firmware
1377 *
1378 * If one device called request_firmware or its nowait version
1379 * successfully before, the firmware names are recored into the
1380 * device's devres link list, so device_cache_fw_images can call
1381 * cache_firmware() to cache these firmwares for the device,
1382 * then the device driver can load its firmwares easily at
1383 * time when system is not ready to complete loading firmware.
1384 */
1385static void device_cache_fw_images(void)
1386{
1387 struct firmware_cache *fwc = &fw_cache;
1388 DEFINE_WAIT(wait);
1389
1390 pr_debug("%s\n", __func__);
1391
1392 /* cancel uncache work */
1393 cancel_delayed_work_sync(&fwc->work);
1394
1395 fw_fallback_set_cache_timeout();
1396
1397 mutex_lock(&fw_lock);
1398 fwc->state = FW_LOADER_START_CACHE;
1399 dpm_for_each_dev(NULL, dev_cache_fw_image);
1400 mutex_unlock(&fw_lock);
1401
1402 /* wait for completion of caching firmware for all devices */
1403 async_synchronize_full_domain(&fw_cache_domain);
1404
1405 fw_fallback_set_default_timeout();
1406}
1407
1408/**
1409 * device_uncache_fw_images() - uncache devices' firmware
1410 *
1411 * uncache all firmwares which have been cached successfully
1412 * by device_uncache_fw_images earlier
1413 */
1414static void device_uncache_fw_images(void)
1415{
1416 pr_debug("%s\n", __func__);
1417 __device_uncache_fw_images();
1418}
1419
1420static void device_uncache_fw_images_work(struct work_struct *work)
1421{
1422 device_uncache_fw_images();
1423}
1424
1425/**
1426 * device_uncache_fw_images_delay() - uncache devices firmwares
1427 * @delay: number of milliseconds to delay uncache device firmwares
1428 *
1429 * uncache all devices's firmwares which has been cached successfully
1430 * by device_cache_fw_images after @delay milliseconds.
1431 */
1432static void device_uncache_fw_images_delay(unsigned long delay)
1433{
1434 queue_delayed_work(system_power_efficient_wq, &fw_cache.work,
1435 msecs_to_jiffies(delay));
1436}
1437
1438static int fw_pm_notify(struct notifier_block *notify_block,
1439 unsigned long mode, void *unused)
1440{
1441 switch (mode) {
1442 case PM_HIBERNATION_PREPARE:
1443 case PM_SUSPEND_PREPARE:
1444 case PM_RESTORE_PREPARE:
1445 /*
1446 * kill pending fallback requests with a custom fallback
1447 * to avoid stalling suspend.
1448 */
1449 kill_pending_fw_fallback_reqs(true);
1450 device_cache_fw_images();
1451 break;
1452
1453 case PM_POST_SUSPEND:
1454 case PM_POST_HIBERNATION:
1455 case PM_POST_RESTORE:
1456 /*
1457 * In case that system sleep failed and syscore_suspend is
1458 * not called.
1459 */
1460 mutex_lock(&fw_lock);
1461 fw_cache.state = FW_LOADER_NO_CACHE;
1462 mutex_unlock(&fw_lock);
1463
1464 device_uncache_fw_images_delay(10 * MSEC_PER_SEC);
1465 break;
1466 }
1467
1468 return 0;
1469}
1470
1471/* stop caching firmware once syscore_suspend is reached */
1472static int fw_suspend(void)
1473{
1474 fw_cache.state = FW_LOADER_NO_CACHE;
1475 return 0;
1476}
1477
1478static struct syscore_ops fw_syscore_ops = {
1479 .suspend = fw_suspend,
1480};
1481
1482static int __init register_fw_pm_ops(void)
1483{
1484 int ret;
1485
1486 spin_lock_init(&fw_cache.name_lock);
1487 INIT_LIST_HEAD(&fw_cache.fw_names);
1488
1489 INIT_DELAYED_WORK(&fw_cache.work,
1490 device_uncache_fw_images_work);
1491
1492 fw_cache.pm_notify.notifier_call = fw_pm_notify;
1493 ret = register_pm_notifier(&fw_cache.pm_notify);
1494 if (ret)
1495 return ret;
1496
1497 register_syscore_ops(&fw_syscore_ops);
1498
1499 return ret;
1500}
1501
1502static inline void unregister_fw_pm_ops(void)
1503{
1504 unregister_syscore_ops(&fw_syscore_ops);
1505 unregister_pm_notifier(&fw_cache.pm_notify);
1506}
1507#else
1508static void fw_cache_piggyback_on_request(struct fw_priv *fw_priv)
1509{
1510}
1511static inline int register_fw_pm_ops(void)
1512{
1513 return 0;
1514}
1515static inline void unregister_fw_pm_ops(void)
1516{
1517}
1518#endif
1519
1520static void __init fw_cache_init(void)
1521{
1522 spin_lock_init(&fw_cache.lock);
1523 INIT_LIST_HEAD(&fw_cache.head);
1524 fw_cache.state = FW_LOADER_NO_CACHE;
1525}
1526
1527static int fw_shutdown_notify(struct notifier_block *unused1,
1528 unsigned long unused2, void *unused3)
1529{
1530 /*
1531 * Kill all pending fallback requests to avoid both stalling shutdown,
1532 * and avoid a deadlock with the usermode_lock.
1533 */
1534 kill_pending_fw_fallback_reqs(false);
1535
1536 return NOTIFY_DONE;
1537}
1538
1539static struct notifier_block fw_shutdown_nb = {
1540 .notifier_call = fw_shutdown_notify,
1541};
1542
1543static int __init firmware_class_init(void)
1544{
1545 int ret;
1546
1547 /* No need to unfold these on exit */
1548 fw_cache_init();
1549
1550 ret = register_fw_pm_ops();
1551 if (ret)
1552 return ret;
1553
1554 ret = register_reboot_notifier(&fw_shutdown_nb);
1555 if (ret)
1556 goto out;
1557
1558 return register_sysfs_loader();
1559
1560out:
1561 unregister_fw_pm_ops();
1562 return ret;
1563}
1564
1565static void __exit firmware_class_exit(void)
1566{
1567 unregister_fw_pm_ops();
1568 unregister_reboot_notifier(&fw_shutdown_nb);
1569 unregister_sysfs_loader();
1570}
1571
1572fs_initcall(firmware_class_init);
1573module_exit(firmware_class_exit);