drivers/base/firmware_loader/main.c

   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
  44 MODULE_AUTHOR("Manuel Estrada Sainz");
  45 MODULE_DESCRIPTION("Multi purpose firmware loading support");
  46 MODULE_LICENSE("GPL");
  47
  48 struct 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
  70 struct fw_cache_entry {
  71         struct list_head list;
  72         const char *name;
  73 };
  74
  75 struct fw_name_devm {
  76         unsigned long magic;
  77         const char *name;
  78 };
  79
  80 static 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 */
  90 DEFINE_MUTEX(fw_lock);
  91
  92 static struct firmware_cache fw_cache;
  93
  94 /* Builtin firmware support */
  95
  96 #ifdef CONFIG_FW_LOADER
  97
  98 extern struct builtin_fw __start_builtin_fw[];
  99 extern struct builtin_fw __end_builtin_fw[];
 100
 101 static 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
 109 static 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
 127 static 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
 140 static 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
 147 static inline bool fw_is_builtin_firmware(const struct firmware *fw)
 148 {
 149         return false;
 150 }
 151 #endif
 152
 153 static 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
 161 static inline int fw_state_wait(struct fw_priv *fw_priv)
 162 {
 163         return __fw_state_wait_common(fw_priv, MAX_SCHEDULE_TIMEOUT);
 164 }
 165
 166 static int fw_cache_piggyback_on_request(const char *name);
 167
 168 static 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
 198 static 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 */
 210 static 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
 242 static 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
 264 static 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
 273 bool fw_is_paged_buf(struct fw_priv *fw_priv)
 274 {
 275         return fw_priv->is_paged_buf;
 276 }
 277
 278 void 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
 295 int 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
 328 int 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 */
 349 static 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 */
 359 static 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 */
 385 static 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
 432 static 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 */
 444 static char fw_path_para[256];
 445 static 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  */
 458 module_param_string(path, fw_path_para, sizeof(fw_path_para), 0644);
 459 MODULE_PARM_DESC(path, "customized firmware image search path with a higher priority than default path");
 460
 461 static int
 462 fw_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 */
 542 static 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 */
 553 static 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
 565 static 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
 575 static 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
 584 static 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
 594 static 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 */
 606 static 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
 629 static bool fw_cache_is_setup(struct device *dev, const char *name)
 630 {
 631         return false;
 632 }
 633
 634 static int fw_add_devm_name(struct device *dev, const char *name)
 635 {
 636         return 0;
 637 }
 638 #endif
 639
 640 int 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  */
 688 static 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  */
 740 static 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() */
 754 static 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  **/
 825 int
 826 request_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 }
 838 EXPORT_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  **/
 853 int 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 }
 865 EXPORT_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  **/
 878 int 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 }
 890 EXPORT_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  **/
 902 int 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 }
 914 EXPORT_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  **/
 928 int 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 }
 938 EXPORT_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  */
 955 int
 956 request_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 }
 970 EXPORT_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  **/
 976 void 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 }
 984 EXPORT_SYMBOL(release_firmware);
 985
 986 /* Async support */
 987 struct 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
 997 static 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  **/
1037 int
1038 request_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 }
1078 EXPORT_SYMBOL(request_firmware_nowait);
1079
1080 #ifdef CONFIG_FW_CACHE
1081 static 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  */
1097 static 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
1113 static 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  */
1136 static 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
1155 static 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         }
1169 exit:
1170         return fce;
1171 }
1172
1173 static 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
1185 static 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         }
1201 found:
1202         spin_unlock(&fwc->name_lock);
1203         return ret;
1204 }
1205
1206 static void free_fw_cache_entry(struct fw_cache_entry *fce)
1207 {
1208         kfree_const(fce->name);
1209         kfree(fce);
1210 }
1211
1212 static 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 */
1230 static 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
1243 static 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
1250 static 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
1281 static 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  */
1311 static 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  */
1340 static void device_uncache_fw_images(void)
1341 {
1342         pr_debug("%s\n", __func__);
1343         __device_uncache_fw_images();
1344 }
1345
1346 static 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  */
1358 static 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
1364 static 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 */
1398 static int fw_suspend(void)
1399 {
1400         fw_cache.state = FW_LOADER_NO_CACHE;
1401         return 0;
1402 }
1403
1404 static struct syscore_ops fw_syscore_ops = {
1405         .suspend = fw_suspend,
1406 };
1407
1408 static 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
1428 static 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
1434 static int fw_cache_piggyback_on_request(const char *name)
1435 {
1436         return 0;
1437 }
1438 static inline int register_fw_pm_ops(void)
1439 {
1440         return 0;
1441 }
1442 static inline void unregister_fw_pm_ops(void)
1443 {
1444 }
1445 #endif
1446
1447 static 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
1454 static 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
1466 static struct notifier_block fw_shutdown_nb = {
1467         .notifier_call = fw_shutdown_notify,
1468 };
1469
1470 static 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
1487 out:
1488         unregister_fw_pm_ops();
1489         return ret;
1490 }
1491
1492 static 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
1499 fs_initcall(firmware_class_init);
1500 module_exit(firmware_class_exit);