cregit-Linux how code gets into the kernel

Release 4.17 drivers/base/firmware_loader/main.c

// SPDX-License-Identifier: GPL-2.0
/*
 * main.c - Multi purpose firmware loading support
 *
 * Copyright (c) 2003 Manuel Estrada Sainz
 *
 * Please see Documentation/firmware_class/ for more information.
 *
 */


#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/capability.h>
#include <linux/device.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/timer.h>
#include <linux/vmalloc.h>
#include <linux/interrupt.h>
#include <linux/bitops.h>
#include <linux/mutex.h>
#include <linux/workqueue.h>
#include <linux/highmem.h>
#include <linux/firmware.h>
#include <linux/slab.h>
#include <linux/sched.h>
#include <linux/file.h>
#include <linux/list.h>
#include <linux/fs.h>
#include <linux/async.h>
#include <linux/pm.h>
#include <linux/suspend.h>
#include <linux/syscore_ops.h>
#include <linux/reboot.h>
#include <linux/security.h>

#include <generated/utsrelease.h>

#include "../base.h"
#include "firmware.h"
#include "fallback.h"

MODULE_AUTHOR("Manuel Estrada Sainz");
MODULE_DESCRIPTION("Multi purpose firmware loading support");
MODULE_LICENSE("GPL");


struct firmware_cache {
	/* firmware_buf instance will be added into the below list */
	
spinlock_t lock;
	
struct list_head head;
	
int state;

#ifdef CONFIG_PM_SLEEP
	/*
         * Names of firmware images which have been cached successfully
         * will be added into the below list so that device uncache
         * helper can trace which firmware images have been cached
         * before.
         */
	
spinlock_t name_lock;
	
struct list_head fw_names;

	
struct delayed_work work;

	
struct notifier_block   pm_notify;
#endif
};


struct fw_cache_entry {
	
struct list_head list;
	
const char *name;
};


struct fw_name_devm {
	
unsigned long magic;
	
const char *name;
};


static inline struct fw_priv *to_fw_priv(struct kref *ref) { return container_of(ref, struct fw_priv, ref); }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez25100.00%2100.00%
Total25100.00%2100.00%

#define FW_LOADER_NO_CACHE 0 #define FW_LOADER_START_CACHE 1 /* fw_lock could be moved to 'struct fw_sysfs' but since it is just * guarding for corner cases a global lock should be OK */ DEFINE_MUTEX(fw_lock); static struct firmware_cache fw_cache; /* Builtin firmware support */ #ifdef CONFIG_FW_LOADER extern struct builtin_fw __start_builtin_fw[]; extern struct builtin_fw __end_builtin_fw[];
static void fw_copy_to_prealloc_buf(struct firmware *fw, void *buf, size_t size) { if (!buf || size < fw->size) return; memcpy(buf, fw->data, fw->size); }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez43100.00%1100.00%
Total43100.00%1100.00%


static bool fw_get_builtin_firmware(struct firmware *fw, const char *name, void *buf, size_t size) { struct builtin_fw *b_fw; for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++) { if (strcmp(name, b_fw->name) == 0) { fw->size = b_fw->size; fw->data = b_fw->data; fw_copy_to_prealloc_buf(fw, buf, size); return true; } } return false; }

Contributors

PersonTokensPropCommitsCommitProp
Ming Lei4247.19%125.00%
Linus Torvalds3134.83%125.00%
Stephen Boyd1314.61%125.00%
Luis R. Rodriguez33.37%125.00%
Total89100.00%4100.00%


static bool fw_is_builtin_firmware(const struct firmware *fw) { struct builtin_fw *b_fw; for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++) if (fw->data == b_fw->data) return true; return false; }

Contributors

PersonTokensPropCommitsCommitProp
Dmitry Torokhov2554.35%133.33%
Linus Torvalds1430.43%133.33%
Ming Lei715.22%133.33%
Total46100.00%3100.00%

#else /* Module case - no builtin firmware support */
static inline bool fw_get_builtin_firmware(struct firmware *fw, const char *name, void *buf, size_t size) { return false; }

Contributors

PersonTokensPropCommitsCommitProp
Dmitry Torokhov2074.07%150.00%
Stephen Boyd725.93%150.00%
Total27100.00%2100.00%


static inline bool fw_is_builtin_firmware(const struct firmware *fw) { return false; }

Contributors

PersonTokensPropCommitsCommitProp
Dmitry Torokhov16100.00%1100.00%
Total16100.00%1100.00%

#endif
static void fw_state_init(struct fw_priv *fw_priv) { struct fw_state *fw_st = &fw_priv->fw_st; init_completion(&fw_st->completion); fw_st->status = FW_STATUS_UNKNOWN; }

Contributors

PersonTokensPropCommitsCommitProp
Daniel Wagner2160.00%133.33%
Luis R. Rodriguez1440.00%266.67%
Total35100.00%3100.00%


static inline int fw_state_wait(struct fw_priv *fw_priv) { return __fw_state_wait_common(fw_priv, MAX_SCHEDULE_TIMEOUT); }

Contributors

PersonTokensPropCommitsCommitProp
Daniel Wagner1155.00%125.00%
Luis R. Rodriguez840.00%250.00%
Björn Andersson15.00%125.00%
Total20100.00%4100.00%

static int fw_cache_piggyback_on_request(const char *name);
static struct fw_priv *__allocate_fw_priv(const char *fw_name, struct firmware_cache *fwc, void *dbuf, size_t size) { struct fw_priv *fw_priv; fw_priv = kzalloc(sizeof(*fw_priv), GFP_ATOMIC); if (!fw_priv) return NULL; fw_priv->fw_name = kstrdup_const(fw_name, GFP_ATOMIC); if (!fw_priv->fw_name) { kfree(fw_priv); return NULL; } kref_init(&fw_priv->ref); fw_priv->fwc = fwc; fw_priv->data = dbuf; fw_priv->allocated_size = size; fw_state_init(fw_priv); #ifdef CONFIG_FW_LOADER_USER_HELPER INIT_LIST_HEAD(&fw_priv->pending_list); #endif pr_debug("%s: fw-%s fw_priv=%p\n", __func__, fw_name, fw_priv); return fw_priv; }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez12289.05%250.00%
Daniel Wagner1510.95%250.00%
Total137100.00%4100.00%


static struct fw_priv *__lookup_fw_priv(const char *fw_name) { struct fw_priv *tmp; struct firmware_cache *fwc = &fw_cache; list_for_each_entry(tmp, &fwc->head, list) if (!strcmp(tmp->fw_name, fw_name)) return tmp; return NULL; }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez4688.46%375.00%
Daniel Wagner611.54%125.00%
Total52100.00%4100.00%

/* Returns 1 for batching firmware requests with the same name */
static int alloc_lookup_fw_priv(const char *fw_name, struct firmware_cache *fwc, struct fw_priv **fw_priv, void *dbuf, size_t size) { struct fw_priv *tmp; spin_lock(&fwc->lock); tmp = __lookup_fw_priv(fw_name); if (tmp) { kref_get(&tmp->ref); spin_unlock(&fwc->lock); *fw_priv = tmp; pr_debug("batched request - sharing the same struct fw_priv and lookup for multiple requests\n"); return 1; } tmp = __allocate_fw_priv(fw_name, fwc, dbuf, size); if (tmp) list_add(&tmp->list, &fwc->head); spin_unlock(&fwc->lock); *fw_priv = tmp; return tmp ? 0 : -ENOMEM; }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez9167.41%545.45%
Stephen Boyd2216.30%218.18%
Andrew Morton139.63%19.09%
Takashi Iwai53.70%19.09%
David Woodhouse21.48%19.09%
Manuel Estrada Sainz21.48%19.09%
Total135100.00%11100.00%


static void __free_fw_priv(struct kref *ref) __releases(&fwc->lock

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez758.33%133.33%
Manuel Estrada Sainz325.00%133.33%
Chuansheng Liu216.67%133.33%
Total12100.00%3100.00%

) { struct fw_priv *fw_priv = to_fw_priv(ref); struct firmware_cache *fwc = fw_priv->fwc; pr_debug("%s: fw-%s fw_priv=%p data=%p size=%u\n", __func__, fw_priv->fw_name, fw_priv, fw_priv->data, (unsigned int)fw_priv->size); list_del(&fw_priv->list); spin_unlock(&fwc->lock); #ifdef CONFIG_FW_LOADER_USER_HELPER if (fw_priv->is_paged_buf) { int i; vunmap(fw_priv->data); for (i = 0; i < fw_priv->nr_pages; i++) __free_page(fw_priv->pages[i]); vfree(fw_priv->pages); } else #endif if (!fw_priv->allocated_size) vfree(fw_priv->data); kfree_const(fw_priv->fw_name); kfree(fw_priv); }
static void free_fw_priv(struct fw_priv *fw_priv) { struct firmware_cache *fwc = fw_priv->fwc; spin_lock(&fwc->lock); if (!kref_put(&fw_priv->ref, __free_fw_priv)) spin_unlock(&fwc->lock); }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez3673.47%250.00%
Takashi Iwai714.29%125.00%
Ming Lei612.24%125.00%
Total49100.00%4100.00%

/* direct firmware loading support */ static char fw_path_para[256]; static const char * const fw_path[] = { fw_path_para, "/lib/firmware/updates/" UTS_RELEASE, "/lib/firmware/updates", "/lib/firmware/" UTS_RELEASE, "/lib/firmware" }; /* * Typical usage is that passing 'firmware_class.path=$CUSTOMIZED_PATH' * from kernel command line because firmware_class is generally built in * kernel instead of module. */ module_param_string(path, fw_path_para, sizeof(fw_path_para), 0644); MODULE_PARM_DESC(path, "customized firmware image search path with a higher priority than default path");
static int fw_get_filesystem_firmware(struct device *device, struct fw_priv *fw_priv) { loff_t size; int i, len; int rc = -ENOENT; char *path; enum kernel_read_file_id id = READING_FIRMWARE; size_t msize = INT_MAX; /* Already populated data member means we're loading into a buffer */ if (fw_priv->data) { id = READING_FIRMWARE_PREALLOC_BUFFER; msize = fw_priv->allocated_size; } path = __getname(); if (!path) return -ENOMEM; for (i = 0; i < ARRAY_SIZE(fw_path); i++) { /* skip the unset customized path */ if (!fw_path[i][0]) continue; len = snprintf(path, PATH_MAX, "%s/%s", fw_path[i], fw_priv->fw_name); if (len >= PATH_MAX) { rc = -ENAMETOOLONG; break; } fw_priv->size = 0; rc = kernel_read_file_from_path(path, &fw_priv->data, &size, msize, id); if (rc) { if (rc == -ENOENT) dev_dbg(device, "loading %s failed with error %d\n", path, rc); else dev_warn(device, "loading %s failed with error %d\n", path, rc); continue; } dev_dbg(device, "direct-loading %s\n", fw_priv->fw_name); fw_priv->size = size; fw_state_done(fw_priv); break; } __putname(path); return rc; }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez16871.19%233.33%
Takashi Iwai4016.95%116.67%
Stephen Boyd177.20%233.33%
Ming Lei114.66%116.67%
Total236100.00%6100.00%

/* firmware holds the ownership of pages */
static void firmware_free_data(const struct firmware *fw) { /* Loaded directly? */ if (!fw->priv) { vfree(fw->data); return; } free_fw_priv(fw->priv); }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez3081.08%150.00%
Takashi Iwai718.92%150.00%
Total37100.00%2100.00%

/* store the pages buffer info firmware from buf */
static void fw_set_page_data(struct fw_priv *fw_priv, struct firmware *fw) { fw->priv = fw_priv; #ifdef CONFIG_FW_LOADER_USER_HELPER fw->pages = fw_priv->pages; #endif fw->size = fw_priv->size; fw->data = fw_priv->data; pr_debug("%s: fw-%s fw_priv=%p data=%p size=%u\n", __func__, fw_priv->fw_name, fw_priv, fw_priv->data, (unsigned int)fw_priv->size); }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez4863.16%120.00%
Takashi Iwai1823.68%240.00%
Ming Lei1013.16%240.00%
Total76100.00%5100.00%

#ifdef CONFIG_PM_SLEEP
static void fw_name_devm_release(struct device *dev, void *res) { struct fw_name_devm *fwn = res; if (fwn->magic == (unsigned long)&fw_cache) pr_debug("%s: fw_name-%s devm-%p released\n", __func__, fwn->name, res); kfree_const(fwn->name); }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez2749.09%112.50%
Takashi Iwai1527.27%225.00%
Ming Lei1018.18%337.50%
Stephen Boyd23.64%112.50%
Maxime Bizon11.82%112.50%
Total55100.00%8100.00%


static int fw_devm_match(struct device *dev, void *res, void *match_data) { struct fw_name_devm *fwn = res; return (fwn->magic == (unsigned long)&fw_cache) && !strcmp(fwn->name, match_data); }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez4386.00%233.33%
Takashi Iwai48.00%233.33%
Stephen Boyd24.00%116.67%
zhang jun12.00%116.67%
Total50100.00%6100.00%


static struct fw_name_devm *fw_find_devm_name(struct device *dev, const char *name) { struct fw_name_devm *fwn; fwn = devres_find(dev, fw_name_devm_release, fw_devm_match, (void *)name); return fwn; }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez3069.77%240.00%
Manuel Estrada Sainz1125.58%120.00%
Ming Lei12.33%120.00%
Andrew Morton12.33%120.00%
Total43100.00%5100.00%


static bool fw_cache_is_setup(struct device *dev, const char *name) { struct fw_name_devm *fwn; fwn = fw_find_devm_name(dev, name); if (fwn) return true; return false; }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez40100.00%3100.00%
Total40100.00%3100.00%

/* add firmware name into devres list */
static int fw_add_devm_name(struct device *dev, const char *name) { struct fw_name_devm *fwn; if (fw_cache_is_setup(dev, name)) return 0; fwn = devres_alloc(fw_name_devm_release, sizeof(struct fw_name_devm), GFP_KERNEL); if (!fwn) return -ENOMEM; fwn->name = kstrdup_const(name, GFP_KERNEL); if (!fwn->name) { devres_free(fwn); return -ENOMEM; } fwn->magic = (unsigned long)&fw_cache; devres_add(dev, fwn); return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez9285.98%538.46%
Andrew Morton32.80%17.69%
David Woodhouse32.80%17.69%
Takashi Iwai32.80%215.38%
Stephen Boyd21.87%17.69%
Ming Lei21.87%17.69%
Manuel Estrada Sainz10.93%17.69%
Björn Helgaas10.93%17.69%
Total107100.00%13100.00%

#else
static bool fw_cache_is_setup(struct device *dev, const char *name) { return false; }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez19100.00%1100.00%
Total19100.00%1100.00%


static int fw_add_devm_name(struct device *dev, const char *name) { return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez19100.00%2100.00%
Total19100.00%2100.00%

#endif
int assign_fw(struct firmware *fw, struct device *device, unsigned int opt_flags) { struct fw_priv *fw_priv = fw->priv; int ret; mutex_lock(&fw_lock); if (!fw_priv->size || fw_state_is_aborted(fw_priv)) { mutex_unlock(&fw_lock); return -ENOENT; } /* * add firmware name into devres list so that we can auto cache * and uncache firmware for device. * * device may has been deleted already, but the problem * should be fixed in devres or driver core. */ /* don't cache firmware handled without uevent */ if (device && (opt_flags & FW_OPT_UEVENT) && !(opt_flags & FW_OPT_NOCACHE)) { ret = fw_add_devm_name(device, fw_priv->fw_name); if (ret) { mutex_unlock(&fw_lock); return ret; } } /* * After caching firmware image is started, let it piggyback * on request firmware. */ if (!(opt_flags & FW_OPT_NOCACHE) && fw_priv->fwc->state == FW_LOADER_START_CACHE) { if (fw_cache_piggyback_on_request(fw_priv->fw_name)) kref_get(&fw_priv->ref); } /* pass the pages buffer to driver at the last minute */ fw_set_page_data(fw_priv, fw); mutex_unlock(&fw_lock); return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez14388.27%457.14%
Takashi Iwai1911.73%342.86%
Total162100.00%7100.00%

/* prepare firmware and firmware_buf structs; * return 0 if a firmware is already assigned, 1 if need to load one, * or a negative error code */
static int _request_firmware_prepare(struct firmware **firmware_p, const char *name, struct device *device, void *dbuf, size_t size) { struct firmware *firmware; struct fw_priv *fw_priv; int ret; *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL); if (!firmware) { dev_err(device, "%s: kmalloc(struct firmware) failed\n", __func__); return -ENOMEM; } if (fw_get_builtin_firmware(firmware, name, dbuf, size)) { dev_dbg(device, "using built-in %s\n", name); return 0; /* assigned */ } ret = alloc_lookup_fw_priv(name, &fw_cache, &fw_priv, dbuf, size); /* * bind with 'priv' now to avoid warning in failure path * of requesting firmware. */ firmware->priv = fw_priv; if (ret > 0) { ret = fw_state_wait(fw_priv); if (!ret) { fw_set_page_data(fw_priv, firmware); return 0; /* assigned */ } } if (ret < 0) return ret; return 1; /* need to load */ }

Contributors

PersonTokensPropCommitsCommitProp
Takashi Iwai9352.84%210.53%
Stephen Boyd3519.89%210.53%
Rafael J. Wysocki95.11%15.26%
Luis R. Rodriguez95.11%210.53%
Andrew Morton84.55%315.79%
Ming Lei73.98%315.79%
Manuel Estrada Sainz63.41%15.26%
Abhay Salunke31.70%15.26%
David Woodhouse21.14%15.26%
Dmitry Torokhov21.14%15.26%
Greg Kroah-Hartman10.57%15.26%
Daniel Wagner10.57%15.26%
Total176100.00%19100.00%

/* * Batched requests need only one wake, we need to do this step last due to the * fallback mechanism. The buf is protected with kref_get(), and it won't be * released until the last user calls release_firmware(). * * Failed batched requests are possible as well, in such cases we just share * the struct fw_priv and won't release it until all requests are woken * and have gone through this same path. */
static void fw_abort_batch_reqs(struct firmware *fw) { struct fw_priv *fw_priv; /* Loaded directly? */ if (!fw || !fw->priv) return; fw_priv = fw->priv; if (!fw_state_is_aborted(fw_priv)) fw_state_aborted(fw_priv); }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez47100.00%2100.00%
Total47100.00%2100.00%

/* called from request_firmware() and request_firmware_work_func() */
static int _request_firmware(const struct firmware **firmware_p, const char *name, struct device *device, void *buf, size_t size, unsigned int opt_flags) { struct firmware *fw = NULL; int ret; if (!firmware_p) return -EINVAL; if (!name || name[0] == '\0') { ret = -EINVAL; goto out; } ret = _request_firmware_prepare(&fw, name, device, buf, size); if (ret <= 0) /* error or already assigned */ goto out; ret = fw_get_filesystem_firmware(device, fw->priv); if (ret) { if (!(opt_flags & FW_OPT_NO_WARN)) dev_warn(device, "Direct firmware load for %s failed with error %d\n", name, ret); ret = fw_sysfs_fallback(fw, name, device, opt_flags, ret); } else ret = assign_fw(fw, device, opt_flags); out: if (ret < 0) { fw_abort_batch_reqs(fw); release_firmware(fw); fw = NULL; } *firmware_p = fw; return ret; }

Contributors

PersonTokensPropCommitsCommitProp
Takashi Iwai7437.56%316.67%
Rafael J. Wysocki2613.20%211.11%
Abhay Salunke2512.69%15.56%
Luis R. Rodriguez178.63%527.78%
Kees Cook168.12%15.56%
Neil Horman147.11%15.56%
Stephen Boyd136.60%211.11%
Brian Norris105.08%15.56%
Ming Lei10.51%15.56%
Johannes Berg10.51%15.56%
Total197100.00%18100.00%

/** * request_firmware: - send firmware request and wait for it * @firmware_p: pointer to firmware image * @name: name of firmware file * @device: device for which firmware is being loaded * * @firmware_p will be used to return a firmware image by the name * of @name for device @device. * * Should be called from user context where sleeping is allowed. * * @name will be used as $FIRMWARE in the uevent environment and * should be distinctive enough not to be confused with any other * firmware image for this or any other device. * * Caller must hold the reference count of @device. * * The function can be called safely inside device's suspend and * resume callback. **/
int request_firmware(const struct firmware **firmware_p, const char *name, struct device *device) { int ret; /* Need to pin this module until return */ __module_get(THIS_MODULE); ret = _request_firmware(firmware_p, name, device, NULL, 0, FW_OPT_UEVENT); module_put(THIS_MODULE); return ret; }

Contributors

PersonTokensPropCommitsCommitProp
Takashi Iwai3358.93%250.00%
Ming Lei1933.93%125.00%
Stephen Boyd47.14%125.00%
Total56100.00%4100.00%

EXPORT_SYMBOL(request_firmware); /** * request_firmware_direct: - load firmware directly without usermode helper * @firmware_p: pointer to firmware image * @name: name of firmware file * @device: device for which firmware is being loaded * * This function works pretty much like request_firmware(), but this doesn't * fall back to usermode helper even if the firmware couldn't be loaded * directly from fs. Hence it's useful for loading optional firmwares, which * aren't always present, without extra long timeouts of udev. **/
int request_firmware_direct(const struct firmware **firmware_p, const char *name, struct device *device) { int ret; __module_get(THIS_MODULE); ret = _request_firmware(firmware_p, name, device, NULL, 0, FW_OPT_UEVENT | FW_OPT_NO_WARN | FW_OPT_NOFALLBACK); module_put(THIS_MODULE); return ret; }

Contributors

PersonTokensPropCommitsCommitProp
Takashi Iwai5186.44%240.00%
Stephen Boyd46.78%120.00%
Luis R. Rodriguez46.78%240.00%
Total59100.00%5100.00%

EXPORT_SYMBOL_GPL(request_firmware_direct); /** * firmware_request_cache: - cache firmware for suspend so resume can use it * @name: name of firmware file * @device: device for which firmware should be cached for * * There are some devices with an optimization that enables the device to not * require loading firmware on system reboot. This optimization may still * require the firmware present on resume from suspend. This routine can be * used to ensure the firmware is present on resume from suspend in these * situations. This helper is not compatible with drivers which use * request_firmware_into_buf() or request_firmware_nowait() with no uevent set. **/
int firmware_request_cache(struct device *device, const char *name) { int ret; mutex_lock(&fw_lock); ret = fw_add_devm_name(device, name); mutex_unlock(&fw_lock); return ret; }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez42100.00%1100.00%
Total42100.00%1100.00%

EXPORT_SYMBOL_GPL(firmware_request_cache); /** * request_firmware_into_buf - load firmware into a previously allocated buffer * @firmware_p: pointer to firmware image * @name: name of firmware file * @device: device for which firmware is being loaded and DMA region allocated * @buf: address of buffer to load firmware into * @size: size of buffer * * This function works pretty much like request_firmware(), but it doesn't * allocate a buffer to hold the firmware data. Instead, the firmware * is loaded directly into the buffer pointed to by @buf and the @firmware_p * data member is pointed at @buf. * * This function doesn't cache firmware either. */
int request_firmware_into_buf(const struct firmware **firmware_p, const char *name, struct device *device, void *buf, size_t size) { int ret; if (fw_cache_is_setup(device, name)) return -EOPNOTSUPP; __module_get(THIS_MODULE); ret = _request_firmware(firmware_p, name, device, buf, size, FW_OPT_UEVENT | FW_OPT_NOCACHE); module_put(THIS_MODULE); return ret; }

Contributors

PersonTokensPropCommitsCommitProp
Stephen Boyd6483.12%150.00%
Luis R. Rodriguez1316.88%150.00%
Total77100.00%2100.00%

EXPORT_SYMBOL(request_firmware_into_buf); /** * release_firmware: - release the resource associated with a firmware image * @fw: firmware resource to release **/
void release_firmware(const struct firmware *fw) { if (fw) { if (!fw_is_builtin_firmware(fw)) firmware_free_data(fw); kfree(fw); } }

Contributors

PersonTokensPropCommitsCommitProp
Manuel Estrada Sainz2571.43%125.00%
Dmitry Torokhov514.29%125.00%
David Woodhouse514.29%250.00%
Total35100.00%4100.00%

EXPORT_SYMBOL(release_firmware); /* Async support */ struct firmware_work { struct work_struct work; struct module *module; const char *name; struct device *device; void *context; void (*cont)(const struct firmware *fw, void *context); unsigned int opt_flags; };
static void request_firmware_work_func(struct work_struct *work) { struct firmware_work *fw_work; const struct firmware *fw; fw_work = container_of(work, struct firmware_work, work); _request_firmware(&fw, fw_work->name, fw_work->device, NULL, 0, fw_work->opt_flags); fw_work->cont(fw, fw_work->context); put_device(fw_work->device); /* taken in request_firmware_nowait() */ module_put(fw_work->module); kfree_const(fw_work->name); kfree(fw_work); }

Contributors

PersonTokensPropCommitsCommitProp
Manuel Estrada Sainz5255.32%110.00%
Stephen Boyd2021.28%330.00%
Luis R. Rodriguez77.45%110.00%
Ming Lei77.45%110.00%
Takashi Iwai33.19%220.00%
Andrew Morton33.19%110.00%
Rafael J. Wysocki22.13%110.00%
Total94100.00%10100.00%

/** * request_firmware_nowait - asynchronous version of request_firmware * @module: module requesting the firmware * @uevent: sends uevent to copy the firmware image if this flag * is non-zero else the firmware copy must be done manually. * @name: name of firmware file * @device: device for which firmware is being loaded * @gfp: allocation flags * @context: will be passed over to @cont, and * @fw may be %NULL if firmware request fails. * @cont: function will be called asynchronously when the firmware * request is over. * * Caller must hold the reference count of @device. * * Asynchronous variant of request_firmware() for user contexts: * - sleep for as small periods as possible since it may * increase kernel boot time of built-in device drivers * requesting firmware in their ->probe() methods, if * @gfp is GFP_KERNEL. * * - can't sleep at all if @gfp is GFP_ATOMIC. **/
int request_firmware_nowait( struct module *module, bool uevent, const char *name, struct device *device, gfp_t gfp, void *context, void (*cont)(const struct firmware *fw, void *context)) { struct firmware_work *fw_work; fw_work = kzalloc(sizeof(struct firmware_work), gfp); if (!fw_work) return -ENOMEM; fw_work->module = module; fw_work->name = kstrdup_const(name, gfp); if (!fw_work->name) { kfree(fw_work); return -ENOMEM; } fw_work->device = device; fw_work->context = context; fw_work->cont = cont; fw_work->opt_flags = FW_OPT_NOWAIT | (uevent ? FW_OPT_UEVENT : FW_OPT_USERHELPER); if (!uevent && fw_cache_is_setup(device, name)) { kfree_const(fw_work->name); kfree(fw_work); return -EOPNOTSUPP; } if (!try_module_get(module)) { kfree_const(fw_work->name); kfree(fw_work); return -EFAULT; } get_device(fw_work->device); INIT_WORK(&fw_work->work, request_firmware_work_func); schedule_work(&fw_work->work); return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Manuel Estrada Sainz8537.78%16.67%
Luis R. Rodriguez6026.67%320.00%
Dmitry Torokhov4017.78%16.67%
Takashi Iwai94.00%213.33%
Ming Lei73.11%16.67%
Stephen Boyd73.11%16.67%
Matthieu Castet52.22%16.67%
Johannes Berg41.78%16.67%
Andrew Morton31.33%16.67%
Abhay Salunke20.89%16.67%
Kay Sievers20.89%16.67%
Bob Liu10.44%16.67%
Total225100.00%15100.00%

EXPORT_SYMBOL(request_firmware_nowait); #ifdef CONFIG_PM_SLEEP static ASYNC_DOMAIN_EXCLUSIVE(fw_cache_domain); /** * cache_firmware - cache one firmware image in kernel memory space * @fw_name: the firmware image name * * Cache firmware in kernel memory so that drivers can use it when * system isn't ready for them to request firmware image from userspace. * Once it returns successfully, driver can use request_firmware or its * nowait version to get the cached firmware without any interacting * with userspace * * Return 0 if the firmware image has been cached successfully * Return !0 otherwise * */
static int cache_firmware(const char *fw_name) { int ret; const struct firmware *fw; pr_debug("%s: %s\n", __func__, fw_name); ret = request_firmware(&fw, fw_name, NULL); if (!ret) kfree(fw); pr_debug("%s: %s ret=%d\n", __func__, fw_name, ret); return ret; }

Contributors

PersonTokensPropCommitsCommitProp
Ming Lei65100.00%2100.00%
Total65100.00%2100.00%


static struct fw_priv *lookup_fw_priv(const char *fw_name) { struct fw_priv *tmp; struct firmware_cache *fwc = &fw_cache; spin_lock(&fwc->lock); tmp = __lookup_fw_priv(fw_name); spin_unlock(&fwc->lock); return tmp; }

Contributors

PersonTokensPropCommitsCommitProp
Ming Lei4892.31%150.00%
Luis R. Rodriguez47.69%150.00%
Total52100.00%2100.00%

/** * uncache_firmware - remove one cached firmware image * @fw_name: the firmware image name * * Uncache one firmware image which has been cached successfully * before. * * Return 0 if the firmware cache has been removed successfully * Return !0 otherwise * */
static int uncache_firmware(const char *fw_name) { struct fw_priv *fw_priv; struct firmware fw; pr_debug("%s: %s\n", __func__, fw_name); if (fw_get_builtin_firmware(&fw, fw_name, NULL, 0)) return 0; fw_priv = lookup_fw_priv(fw_name); if (fw_priv) { free_fw_priv(fw_priv); return 0; } return -EINVAL; }

Contributors

PersonTokensPropCommitsCommitProp
Ming Lei6084.51%250.00%
Luis R. Rodriguez79.86%125.00%
Stephen Boyd45.63%125.00%
Total71100.00%4100.00%


static struct fw_cache_entry *alloc_fw_cache_entry(const char *name) { struct fw_cache_entry *fce; fce = kzalloc(sizeof(*fce), GFP_ATOMIC); if (!fce) goto exit; fce->name = kstrdup_const(name, GFP_ATOMIC); if (!fce->name) { kfree(fce); fce = NULL; goto exit; } exit: return fce; }

Contributors

PersonTokensPropCommitsCommitProp
Ming Lei5167.11%150.00%
Luis R. Rodriguez2532.89%150.00%
Total76100.00%2100.00%


static int __fw_entry_found(const char *name) { struct firmware_cache *fwc = &fw_cache; struct fw_cache_entry *fce; list_for_each_entry(fce, &fwc->fw_names, list) { if (!strcmp(fce->name, name)) return 1; } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Ming Lei52100.00%2100.00%
Total52100.00%2100.00%


static int fw_cache_piggyback_on_request(const char *name) { struct firmware_cache *fwc = &fw_cache; struct fw_cache_entry *fce; int ret = 0; spin_lock(&fwc->name_lock); if (__fw_entry_found(name)) goto found; fce = alloc_fw_cache_entry(name); if (fce) { ret = 1; list_add(&fce->list, &fwc->fw_names); pr_debug("%s: fw: %s\n", __func__, name); } found: spin_unlock(&fwc->name_lock); return ret; }

Contributors

PersonTokensPropCommitsCommitProp
Ming Lei99100.00%2100.00%
Total99100.00%2100.00%


static void free_fw_cache_entry(struct fw_cache_entry *fce) { kfree_const(fce->name); kfree(fce); }

Contributors

PersonTokensPropCommitsCommitProp
Ming Lei1669.57%150.00%
Luis R. Rodriguez730.43%150.00%
Total23100.00%2100.00%


static void __async_dev_cache_fw_image(void *fw_entry, async_cookie_t cookie) { struct fw_cache_entry *fce = fw_entry; struct firmware_cache *fwc = &fw_cache; int ret; ret = cache_firmware(fce->name); if (ret) { spin_lock(&fwc->name_lock); list_del(&fce->list); spin_unlock(&fwc->name_lock); free_fw_cache_entry(fce); } }

Contributors

PersonTokensPropCommitsCommitProp
Ming Lei75100.00%2100.00%
Total75100.00%2100.00%

/* called with dev->devres_lock held */
static void dev_create_fw_entry(struct device *dev, void *res, void *data) { struct fw_name_devm *fwn = res; const char *fw_name = fwn->name; struct list_head *head = data; struct fw_cache_entry *fce; fce = alloc_fw_cache_entry(fw_name); if (fce) list_add(&fce->list, head); }

Contributors

PersonTokensPropCommitsCommitProp
Ming Lei68100.00%1100.00%
Total68100.00%1100.00%


static int devm_name_match(struct device *dev, void *res, void *match_data) { struct fw_name_devm *fwn = res; return (fwn->magic == (unsigned long)match_data); }

Contributors

PersonTokensPropCommitsCommitProp
Ming Lei39100.00%1100.00%
Total39100.00%1100.00%


static void dev_cache_fw_image(struct device *dev, void *data) { LIST_HEAD(todo); struct fw_cache_entry *fce; struct fw_cache_entry *fce_next; struct firmware_cache *fwc = &fw_cache; devres_for_each_res(dev, fw_name_devm_release, devm_name_match, &fw_cache, dev_create_fw_entry, &todo); list_for_each_entry_safe(fce, fce_next, &todo, list) { list_del(&fce->list); spin_lock(&fwc->name_lock); /* only one cache entry for one firmware */ if (!__fw_entry_found(fce->name)) { list_add(&fce->list, &fwc->fw_names); } else { free_fw_cache_entry(fce); fce = NULL; } spin_unlock(&fwc->name_lock); if (fce) async_schedule_domain(__async_dev_cache_fw_image, (void *)fce, &fw_cache_domain); } }

Contributors

PersonTokensPropCommitsCommitProp
Ming Lei147100.00%5100.00%
Total147100.00%5100.00%


static void __device_uncache_fw_images(void) { struct firmware_cache *fwc = &fw_cache; struct fw_cache_entry *fce; spin_lock(&fwc->name_lock); while (!list_empty(&fwc->fw_names)) { fce = list_entry(fwc->fw_names.next, struct fw_cache_entry, list); list_del(&fce->list); spin_unlock(&fwc->name_lock); uncache_firmware(fce->name); free_fw_cache_entry(fce); spin_lock(&fwc->name_lock); } spin_unlock(&fwc->name_lock); }

Contributors

PersonTokensPropCommitsCommitProp
Ming Lei102100.00%1100.00%
Total102100.00%1100.00%

/** * device_cache_fw_images - cache devices' firmware * * If one device called request_firmware or its nowait version * successfully before, the firmware names are recored into the * device's devres link list, so device_cache_fw_images can call * cache_firmware() to cache these firmwares for the device, * then the device driver can load its firmwares easily at * time when system is not ready to complete loading firmware. */
static void device_cache_fw_images(void) { struct firmware_cache *fwc = &fw_cache; DEFINE_WAIT(wait); pr_debug("%s\n", __func__); /* cancel uncache work */ cancel_delayed_work_sync(&fwc->work); fw_fallback_set_cache_timeout(); mutex_lock(&fw_lock); fwc->state = FW_LOADER_START_CACHE; dpm_for_each_dev(NULL, dev_cache_fw_image); mutex_unlock(&fw_lock); /* wait for completion of caching firmware for all devices */ async_synchronize_full_domain(&fw_cache_domain); fw_fallback_set_default_timeout(); }

Contributors

PersonTokensPropCommitsCommitProp
Ming Lei7194.67%685.71%
Luis R. Rodriguez45.33%114.29%
Total75100.00%7100.00%

/** * device_uncache_fw_images - uncache devices' firmware * * uncache all firmwares which have been cached successfully * by device_uncache_fw_images earlier */
static void device_uncache_fw_images(void) { pr_debug("%s\n", __func__); __device_uncache_fw_images(); }

Contributors

PersonTokensPropCommitsCommitProp
Ming Lei18100.00%1100.00%
Total18100.00%1100.00%


static void device_uncache_fw_images_work(struct work_struct *work) { device_uncache_fw_images(); }

Contributors

PersonTokensPropCommitsCommitProp
Ming Lei14100.00%1100.00%
Total14100.00%1100.00%

/** * device_uncache_fw_images_delay - uncache devices firmwares * @delay: number of milliseconds to delay uncache device firmwares * * uncache all devices's firmwares which has been cached successfully * by device_cache_fw_images after @delay milliseconds. */
static void device_uncache_fw_images_delay(unsigned long delay) { queue_delayed_work(system_power_efficient_wq, &fw_cache.work, msecs_to_jiffies(delay)); }

Contributors

PersonTokensPropCommitsCommitProp
Ming Lei2288.00%150.00%
Shaibal Dutta312.00%150.00%
Total25100.00%2100.00%


static int fw_pm_notify(struct notifier_block *notify_block, unsigned long mode, void *unused) { switch (mode) { case PM_HIBERNATION_PREPARE: case PM_SUSPEND_PREPARE: case PM_RESTORE_PREPARE: /* * kill pending fallback requests with a custom fallback * to avoid stalling suspend. */ kill_pending_fw_fallback_reqs(true); device_cache_fw_images(); break; case PM_POST_SUSPEND: case PM_POST_HIBERNATION: case PM_POST_RESTORE: /* * In case that system sleep failed and syscore_suspend is * not called. */ mutex_lock(&fw_lock); fw_cache.state = FW_LOADER_NO_CACHE; mutex_unlock(&fw_lock); device_uncache_fw_images_delay(10 * MSEC_PER_SEC); break; } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Ming Lei7590.36%360.00%
Luis R. Rodriguez56.02%120.00%
Sebastian Capella33.61%120.00%
Total83100.00%5100.00%

/* stop caching firmware once syscore_suspend is reached */
static int fw_suspend(void) { fw_cache.state = FW_LOADER_NO_CACHE; return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Ming Lei17100.00%1100.00%
Total17100.00%1100.00%

static struct syscore_ops fw_syscore_ops = { .suspend = fw_suspend, };
static int __init register_fw_pm_ops(void) { int ret; spin_lock_init(&fw_cache.name_lock); INIT_LIST_HEAD(&fw_cache.fw_names); INIT_DELAYED_WORK(&fw_cache.work, device_uncache_fw_images_work); fw_cache.pm_notify.notifier_call = fw_pm_notify; ret = register_pm_notifier(&fw_cache.pm_notify); if (ret) return ret; register_syscore_ops(&fw_syscore_ops); return ret; }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez72100.00%1100.00%
Total72100.00%1100.00%


static inline void unregister_fw_pm_ops(void) { unregister_syscore_ops(&fw_syscore_ops); unregister_pm_notifier(&fw_cache.pm_notify); }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez23100.00%1100.00%
Total23100.00%1100.00%

#else
static int fw_cache_piggyback_on_request(const char *name) { return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Ming Lei14100.00%1100.00%
Total14100.00%1100.00%


static inline int register_fw_pm_ops(void) { return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez12100.00%1100.00%
Total12100.00%1100.00%


static inline void unregister_fw_pm_ops(void) { }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez8100.00%1100.00%
Total8100.00%1100.00%

#endif
static void __init fw_cache_init(void) { spin_lock_init(&fw_cache.lock); INIT_LIST_HEAD(&fw_cache.head); fw_cache.state = FW_LOADER_NO_CACHE; }

Contributors

PersonTokensPropCommitsCommitProp
Ming Lei31100.00%2100.00%
Total31100.00%2100.00%


static int fw_shutdown_notify(struct notifier_block *unused1, unsigned long unused2, void *unused3) { /* * Kill all pending fallback requests to avoid both stalling shutdown, * and avoid a deadlock with the usermode_lock. */ kill_pending_fw_fallback_reqs(false); return NOTIFY_DONE; }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez28100.00%1100.00%
Total28100.00%1100.00%

static struct notifier_block fw_shutdown_nb = { .notifier_call = fw_shutdown_notify, };
static int __init firmware_class_init(void) { int ret; /* No need to unfold these on exit */ fw_cache_init(); ret = register_fw_pm_ops(); if (ret) return ret; ret = register_reboot_notifier(&fw_shutdown_nb); if (ret) goto out; return register_sysfs_loader(); out: unregister_fw_pm_ops(); return ret; }

Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez3563.64%337.50%
Manuel Estrada Sainz916.36%112.50%
Takashi Iwai712.73%225.00%
Ming Lei35.45%112.50%
Andrew Morton11.82%112.50%
Total55100.00%8100.00%


static void __exit firmware_class_exit(void) { unregister_fw_pm_ops(); unregister_reboot_notifier(&fw_shutdown_nb); unregister_sysfs_loader(); }

Contributors

PersonTokensPropCommitsCommitProp
Manuel Estrada Sainz1047.62%120.00%
Takashi Iwai628.57%120.00%
Luis R. Rodriguez419.05%240.00%
Ming Lei14.76%120.00%
Total21100.00%5100.00%

fs_initcall(firmware_class_init); module_exit(firmware_class_exit);

Overall Contributors

PersonTokensPropCommitsCommitProp
Luis R. Rodriguez178139.81%3126.50%
Ming Lei129228.88%2117.95%
Takashi Iwai4149.25%86.84%
Manuel Estrada Sainz3036.77%21.71%
Stephen Boyd2265.05%43.42%
Dmitry Torokhov1152.57%21.71%
Daniel Wagner561.25%43.42%
Linus Torvalds551.23%10.85%
Andrew Morton390.87%65.13%
Rafael J. Wysocki370.83%21.71%
Abhay Salunke310.69%10.85%
Kees Cook190.42%21.71%
Daniel Mack150.34%10.85%
David Woodhouse150.34%32.56%
Neil Horman140.31%10.85%
Brian Norris100.22%10.85%
Chuansheng Liu70.16%10.85%
Johannes Berg50.11%21.71%
Matthieu Castet50.11%10.85%
Randy Dunlap40.09%21.71%
Sebastian Capella30.07%10.85%
Shaibal Dutta30.07%10.85%
Tejun Heo30.07%10.85%
Mimi Zohar30.07%10.85%
Kay Sievers30.07%21.71%
Sukadev Bhattiprolu20.04%10.85%
Greg Kroah-Hartman20.04%21.71%
Björn Andersson10.02%10.85%
Maxime Bizon10.02%10.85%
Chen Feng10.02%10.85%
Laura Garcia Liebana10.02%10.85%
Björn Helgaas10.02%10.85%
Markus Rechberger10.02%10.85%
Christoph Hellwig10.02%10.85%
zhang jun10.02%10.85%
David Shaohua Li10.02%10.85%
Bob Liu10.02%10.85%
Silvio Fricke10.02%10.85%
Borislav Petkov10.02%10.85%
Total4474100.00%117100.00%
Information contained on this website is for historical information purposes only and does not indicate or represent copyright ownership.
Created with cregit.