2005-04-16 16:20:36 -06:00
|
|
|
/*
|
|
|
|
* firmware_class.c - Multi purpose firmware loading support
|
|
|
|
*
|
2007-06-04 10:45:44 -06:00
|
|
|
* Copyright (c) 2003 Manuel Estrada Sainz
|
2005-04-16 16:20:36 -06:00
|
|
|
*
|
|
|
|
* Please see Documentation/firmware_class/ for more information.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2006-01-11 13:17:46 -07:00
|
|
|
#include <linux/capability.h>
|
2005-04-16 16:20:36 -06:00
|
|
|
#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>
|
2006-05-23 15:22:38 -06:00
|
|
|
#include <linux/mutex.h>
|
2012-03-28 15:31:00 -06:00
|
|
|
#include <linux/workqueue.h>
|
2009-04-09 23:04:07 -06:00
|
|
|
#include <linux/highmem.h>
|
2005-04-16 16:20:36 -06:00
|
|
|
#include <linux/firmware.h>
|
include cleanup: Update gfp.h and slab.h includes to prepare for breaking implicit slab.h inclusion from percpu.h
percpu.h is included by sched.h and module.h and thus ends up being
included when building most .c files. percpu.h includes slab.h which
in turn includes gfp.h making everything defined by the two files
universally available and complicating inclusion dependencies.
percpu.h -> slab.h dependency is about to be removed. Prepare for
this change by updating users of gfp and slab facilities include those
headers directly instead of assuming availability. As this conversion
needs to touch large number of source files, the following script is
used as the basis of conversion.
http://userweb.kernel.org/~tj/misc/slabh-sweep.py
The script does the followings.
* Scan files for gfp and slab usages and update includes such that
only the necessary includes are there. ie. if only gfp is used,
gfp.h, if slab is used, slab.h.
* When the script inserts a new include, it looks at the include
blocks and try to put the new include such that its order conforms
to its surrounding. It's put in the include block which contains
core kernel includes, in the same order that the rest are ordered -
alphabetical, Christmas tree, rev-Xmas-tree or at the end if there
doesn't seem to be any matching order.
* If the script can't find a place to put a new include (mostly
because the file doesn't have fitting include block), it prints out
an error message indicating which .h file needs to be added to the
file.
The conversion was done in the following steps.
1. The initial automatic conversion of all .c files updated slightly
over 4000 files, deleting around 700 includes and adding ~480 gfp.h
and ~3000 slab.h inclusions. The script emitted errors for ~400
files.
2. Each error was manually checked. Some didn't need the inclusion,
some needed manual addition while adding it to implementation .h or
embedding .c file was more appropriate for others. This step added
inclusions to around 150 files.
3. The script was run again and the output was compared to the edits
from #2 to make sure no file was left behind.
4. Several build tests were done and a couple of problems were fixed.
e.g. lib/decompress_*.c used malloc/free() wrappers around slab
APIs requiring slab.h to be added manually.
5. The script was run on all .h files but without automatically
editing them as sprinkling gfp.h and slab.h inclusions around .h
files could easily lead to inclusion dependency hell. Most gfp.h
inclusion directives were ignored as stuff from gfp.h was usually
wildly available and often used in preprocessor macros. Each
slab.h inclusion directive was examined and added manually as
necessary.
6. percpu.h was updated not to include slab.h.
7. Build test were done on the following configurations and failures
were fixed. CONFIG_GCOV_KERNEL was turned off for all tests (as my
distributed build env didn't work with gcov compiles) and a few
more options had to be turned off depending on archs to make things
build (like ipr on powerpc/64 which failed due to missing writeq).
* x86 and x86_64 UP and SMP allmodconfig and a custom test config.
* powerpc and powerpc64 SMP allmodconfig
* sparc and sparc64 SMP allmodconfig
* ia64 SMP allmodconfig
* s390 SMP allmodconfig
* alpha SMP allmodconfig
* um on x86_64 SMP allmodconfig
8. percpu.h modifications were reverted so that it could be applied as
a separate patch and serve as bisection point.
Given the fact that I had only a couple of failures from tests on step
6, I'm fairly confident about the coverage of this conversion patch.
If there is a breakage, it's likely to be something in one of the arch
headers which should be easily discoverable easily on most builds of
the specific arch.
Signed-off-by: Tejun Heo <tj@kernel.org>
Guess-its-ok-by: Christoph Lameter <cl@linux-foundation.org>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Lee Schermerhorn <Lee.Schermerhorn@hp.com>
2010-03-24 02:04:11 -06:00
|
|
|
#include <linux/slab.h>
|
2012-03-28 15:31:00 -06:00
|
|
|
#include <linux/sched.h>
|
2012-10-03 16:58:32 -06:00
|
|
|
#include <linux/file.h>
|
2012-08-03 22:01:21 -06:00
|
|
|
#include <linux/list.h>
|
2012-08-03 22:01:27 -06:00
|
|
|
#include <linux/async.h>
|
|
|
|
#include <linux/pm.h>
|
2012-08-03 22:01:29 -06:00
|
|
|
#include <linux/suspend.h>
|
2012-08-20 05:04:16 -06:00
|
|
|
#include <linux/syscore_ops.h>
|
2012-08-03 22:01:27 -06:00
|
|
|
|
2012-10-03 16:58:32 -06:00
|
|
|
#include <generated/utsrelease.h>
|
|
|
|
|
2012-08-03 22:01:27 -06:00
|
|
|
#include "base.h"
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2007-06-04 10:45:44 -06:00
|
|
|
MODULE_AUTHOR("Manuel Estrada Sainz");
|
2005-04-16 16:20:36 -06:00
|
|
|
MODULE_DESCRIPTION("Multi purpose firmware loading support");
|
|
|
|
MODULE_LICENSE("GPL");
|
|
|
|
|
2010-03-14 00:49:18 -07:00
|
|
|
/* Builtin firmware support */
|
|
|
|
|
|
|
|
#ifdef CONFIG_FW_LOADER
|
|
|
|
|
|
|
|
extern struct builtin_fw __start_builtin_fw[];
|
|
|
|
extern struct builtin_fw __end_builtin_fw[];
|
|
|
|
|
|
|
|
static bool fw_get_builtin_firmware(struct firmware *fw, const char *name)
|
|
|
|
{
|
|
|
|
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;
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
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;
|
|
|
|
}
|
|
|
|
|
|
|
|
#else /* Module case - no builtin firmware support */
|
|
|
|
|
|
|
|
static inline bool fw_get_builtin_firmware(struct firmware *fw, const char *name)
|
|
|
|
{
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline bool fw_is_builtin_firmware(const struct firmware *fw)
|
|
|
|
{
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
enum {
|
|
|
|
FW_STATUS_LOADING,
|
|
|
|
FW_STATUS_DONE,
|
|
|
|
FW_STATUS_ABORT,
|
|
|
|
};
|
|
|
|
|
2012-10-08 22:01:03 -06:00
|
|
|
enum fw_buf_fmt {
|
|
|
|
VMALLOC_BUF, /* used in direct loading */
|
|
|
|
PAGE_BUF, /* used in loading via userspace */
|
|
|
|
};
|
|
|
|
|
2007-01-25 13:56:15 -07:00
|
|
|
static int loading_timeout = 60; /* In seconds */
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2012-03-28 15:30:02 -06:00
|
|
|
static inline long firmware_loading_timeout(void)
|
|
|
|
{
|
|
|
|
return loading_timeout > 0 ? loading_timeout * HZ : MAX_SCHEDULE_TIMEOUT;
|
|
|
|
}
|
|
|
|
|
2012-08-03 22:01:21 -06:00
|
|
|
struct firmware_cache {
|
|
|
|
/* firmware_buf instance will be added into the below list */
|
|
|
|
spinlock_t lock;
|
|
|
|
struct list_head head;
|
2012-09-08 03:32:30 -06:00
|
|
|
int state;
|
2012-08-03 22:01:27 -06:00
|
|
|
|
2012-09-08 03:32:30 -06:00
|
|
|
#ifdef CONFIG_PM_SLEEP
|
2012-08-03 22:01:27 -06:00
|
|
|
/*
|
|
|
|
* 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;
|
2012-08-03 22:01:29 -06:00
|
|
|
|
|
|
|
struct notifier_block pm_notify;
|
2012-09-08 03:32:30 -06:00
|
|
|
#endif
|
2012-08-03 22:01:21 -06:00
|
|
|
};
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2012-08-03 22:01:20 -06:00
|
|
|
struct firmware_buf {
|
2012-08-03 22:01:21 -06:00
|
|
|
struct kref ref;
|
|
|
|
struct list_head list;
|
2005-04-16 16:20:36 -06:00
|
|
|
struct completion completion;
|
2012-08-03 22:01:21 -06:00
|
|
|
struct firmware_cache *fwc;
|
2005-04-16 16:20:36 -06:00
|
|
|
unsigned long status;
|
2012-10-08 22:01:03 -06:00
|
|
|
enum fw_buf_fmt fmt;
|
2012-08-03 22:01:16 -06:00
|
|
|
void *data;
|
|
|
|
size_t size;
|
2009-04-09 23:04:07 -06:00
|
|
|
struct page **pages;
|
|
|
|
int nr_pages;
|
|
|
|
int page_array_size;
|
2012-08-03 22:01:20 -06:00
|
|
|
char fw_id[];
|
|
|
|
};
|
|
|
|
|
2012-08-03 22:01:27 -06:00
|
|
|
struct fw_cache_entry {
|
|
|
|
struct list_head list;
|
|
|
|
char name[];
|
|
|
|
};
|
|
|
|
|
2012-08-03 22:01:20 -06:00
|
|
|
struct firmware_priv {
|
2012-11-08 04:14:40 -07:00
|
|
|
struct delayed_work timeout_work;
|
2010-03-29 09:57:20 -06:00
|
|
|
bool nowait;
|
2012-08-03 22:01:20 -06:00
|
|
|
struct device dev;
|
|
|
|
struct firmware_buf *buf;
|
2012-08-03 22:01:21 -06:00
|
|
|
struct firmware *fw;
|
2005-04-16 16:20:36 -06:00
|
|
|
};
|
|
|
|
|
2012-08-03 22:01:25 -06:00
|
|
|
struct fw_name_devm {
|
|
|
|
unsigned long magic;
|
|
|
|
char name[];
|
|
|
|
};
|
|
|
|
|
2012-08-03 22:01:21 -06:00
|
|
|
#define to_fwbuf(d) container_of(d, struct firmware_buf, ref)
|
|
|
|
|
2012-08-20 05:04:16 -06:00
|
|
|
#define FW_LOADER_NO_CACHE 0
|
|
|
|
#define FW_LOADER_START_CACHE 1
|
|
|
|
|
|
|
|
static int fw_cache_piggyback_on_request(const char *name);
|
|
|
|
|
2012-08-03 22:01:21 -06:00
|
|
|
/* fw_lock could be moved to 'struct firmware_priv' but since it is just
|
|
|
|
* guarding for corner cases a global lock should be OK */
|
|
|
|
static DEFINE_MUTEX(fw_lock);
|
|
|
|
|
|
|
|
static struct firmware_cache fw_cache;
|
|
|
|
|
|
|
|
static struct firmware_buf *__allocate_fw_buf(const char *fw_name,
|
|
|
|
struct firmware_cache *fwc)
|
|
|
|
{
|
|
|
|
struct firmware_buf *buf;
|
|
|
|
|
|
|
|
buf = kzalloc(sizeof(*buf) + strlen(fw_name) + 1 , GFP_ATOMIC);
|
|
|
|
|
|
|
|
if (!buf)
|
|
|
|
return buf;
|
|
|
|
|
|
|
|
kref_init(&buf->ref);
|
|
|
|
strcpy(buf->fw_id, fw_name);
|
|
|
|
buf->fwc = fwc;
|
|
|
|
init_completion(&buf->completion);
|
2012-10-08 22:01:03 -06:00
|
|
|
buf->fmt = VMALLOC_BUF;
|
2012-08-03 22:01:21 -06:00
|
|
|
|
|
|
|
pr_debug("%s: fw-%s buf=%p\n", __func__, fw_name, buf);
|
|
|
|
|
|
|
|
return buf;
|
|
|
|
}
|
|
|
|
|
2012-08-03 22:01:22 -06:00
|
|
|
static struct firmware_buf *__fw_lookup_buf(const char *fw_name)
|
|
|
|
{
|
|
|
|
struct firmware_buf *tmp;
|
|
|
|
struct firmware_cache *fwc = &fw_cache;
|
|
|
|
|
|
|
|
list_for_each_entry(tmp, &fwc->head, list)
|
|
|
|
if (!strcmp(tmp->fw_id, fw_name))
|
|
|
|
return tmp;
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
2012-08-03 22:01:21 -06:00
|
|
|
static int fw_lookup_and_allocate_buf(const char *fw_name,
|
|
|
|
struct firmware_cache *fwc,
|
|
|
|
struct firmware_buf **buf)
|
|
|
|
{
|
|
|
|
struct firmware_buf *tmp;
|
|
|
|
|
|
|
|
spin_lock(&fwc->lock);
|
2012-08-03 22:01:22 -06:00
|
|
|
tmp = __fw_lookup_buf(fw_name);
|
|
|
|
if (tmp) {
|
|
|
|
kref_get(&tmp->ref);
|
|
|
|
spin_unlock(&fwc->lock);
|
|
|
|
*buf = tmp;
|
|
|
|
return 1;
|
|
|
|
}
|
2012-08-03 22:01:21 -06:00
|
|
|
tmp = __allocate_fw_buf(fw_name, fwc);
|
|
|
|
if (tmp)
|
|
|
|
list_add(&tmp->list, &fwc->head);
|
|
|
|
spin_unlock(&fwc->lock);
|
|
|
|
|
|
|
|
*buf = tmp;
|
|
|
|
|
|
|
|
return tmp ? 0 : -ENOMEM;
|
|
|
|
}
|
|
|
|
|
2012-08-03 22:01:22 -06:00
|
|
|
static struct firmware_buf *fw_lookup_buf(const char *fw_name)
|
|
|
|
{
|
|
|
|
struct firmware_buf *tmp;
|
|
|
|
struct firmware_cache *fwc = &fw_cache;
|
|
|
|
|
|
|
|
spin_lock(&fwc->lock);
|
|
|
|
tmp = __fw_lookup_buf(fw_name);
|
|
|
|
spin_unlock(&fwc->lock);
|
|
|
|
|
|
|
|
return tmp;
|
|
|
|
}
|
|
|
|
|
2012-08-03 22:01:21 -06:00
|
|
|
static void __fw_free_buf(struct kref *ref)
|
|
|
|
{
|
|
|
|
struct firmware_buf *buf = to_fwbuf(ref);
|
|
|
|
struct firmware_cache *fwc = buf->fwc;
|
|
|
|
int i;
|
|
|
|
|
|
|
|
pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
|
|
|
|
__func__, buf->fw_id, buf, buf->data,
|
|
|
|
(unsigned int)buf->size);
|
|
|
|
|
|
|
|
list_del(&buf->list);
|
|
|
|
spin_unlock(&fwc->lock);
|
|
|
|
|
2012-10-08 22:01:03 -06:00
|
|
|
|
|
|
|
if (buf->fmt == PAGE_BUF) {
|
|
|
|
vunmap(buf->data);
|
|
|
|
for (i = 0; i < buf->nr_pages; i++)
|
|
|
|
__free_page(buf->pages[i]);
|
|
|
|
kfree(buf->pages);
|
|
|
|
} else
|
|
|
|
vfree(buf->data);
|
2012-08-03 22:01:21 -06:00
|
|
|
kfree(buf);
|
|
|
|
}
|
|
|
|
|
|
|
|
static void fw_free_buf(struct firmware_buf *buf)
|
|
|
|
{
|
2012-11-09 10:27:22 -07:00
|
|
|
struct firmware_cache *fwc = buf->fwc;
|
|
|
|
spin_lock(&fwc->lock);
|
|
|
|
if (!kref_put(&buf->ref, __fw_free_buf))
|
|
|
|
spin_unlock(&fwc->lock);
|
2012-08-03 22:01:21 -06:00
|
|
|
}
|
|
|
|
|
2012-10-08 22:01:03 -06:00
|
|
|
/* direct firmware loading support */
|
2012-11-03 03:47:58 -06:00
|
|
|
static char fw_path_para[256];
|
|
|
|
static const char * const fw_path[] = {
|
|
|
|
fw_path_para,
|
2012-10-08 22:01:03 -06:00
|
|
|
"/lib/firmware/updates/" UTS_RELEASE,
|
|
|
|
"/lib/firmware/updates",
|
|
|
|
"/lib/firmware/" UTS_RELEASE,
|
|
|
|
"/lib/firmware"
|
|
|
|
};
|
|
|
|
|
2012-11-03 03:47:58 -06:00
|
|
|
/*
|
|
|
|
* 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");
|
|
|
|
|
2012-10-08 22:01:03 -06:00
|
|
|
/* Don't inline this: 'struct kstat' is biggish */
|
2012-10-27 16:37:10 -06:00
|
|
|
static noinline_for_stack long fw_file_size(struct file *file)
|
2012-10-08 22:01:03 -06:00
|
|
|
{
|
|
|
|
struct kstat st;
|
|
|
|
if (vfs_getattr(file->f_path.mnt, file->f_path.dentry, &st))
|
|
|
|
return -1;
|
|
|
|
if (!S_ISREG(st.mode))
|
|
|
|
return -1;
|
|
|
|
if (st.size != (long)st.size)
|
|
|
|
return -1;
|
|
|
|
return st.size;
|
|
|
|
}
|
|
|
|
|
|
|
|
static bool fw_read_file_contents(struct file *file, struct firmware_buf *fw_buf)
|
|
|
|
{
|
|
|
|
long size;
|
|
|
|
char *buf;
|
|
|
|
|
|
|
|
size = fw_file_size(file);
|
|
|
|
if (size < 0)
|
|
|
|
return false;
|
|
|
|
buf = vmalloc(size);
|
|
|
|
if (!buf)
|
|
|
|
return false;
|
|
|
|
if (kernel_read(file, 0, buf, size) != size) {
|
|
|
|
vfree(buf);
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
fw_buf->data = buf;
|
|
|
|
fw_buf->size = size;
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
static bool fw_get_filesystem_firmware(struct firmware_buf *buf)
|
|
|
|
{
|
|
|
|
int i;
|
|
|
|
bool success = false;
|
|
|
|
char *path = __getname();
|
|
|
|
|
|
|
|
for (i = 0; i < ARRAY_SIZE(fw_path); i++) {
|
|
|
|
struct file *file;
|
2012-11-03 03:47:58 -06:00
|
|
|
|
|
|
|
/* skip the unset customized path */
|
|
|
|
if (!fw_path[i][0])
|
|
|
|
continue;
|
|
|
|
|
2012-10-08 22:01:03 -06:00
|
|
|
snprintf(path, PATH_MAX, "%s/%s", fw_path[i], buf->fw_id);
|
|
|
|
|
|
|
|
file = filp_open(path, O_RDONLY, 0);
|
|
|
|
if (IS_ERR(file))
|
|
|
|
continue;
|
|
|
|
success = fw_read_file_contents(file, buf);
|
|
|
|
fput(file);
|
|
|
|
if (success)
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
__putname(path);
|
|
|
|
return success;
|
|
|
|
}
|
|
|
|
|
2010-06-04 01:54:43 -06:00
|
|
|
static struct firmware_priv *to_firmware_priv(struct device *dev)
|
|
|
|
{
|
|
|
|
return container_of(dev, struct firmware_priv, dev);
|
|
|
|
}
|
|
|
|
|
|
|
|
static void fw_load_abort(struct firmware_priv *fw_priv)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
2012-08-03 22:01:20 -06:00
|
|
|
struct firmware_buf *buf = fw_priv->buf;
|
|
|
|
|
|
|
|
set_bit(FW_STATUS_ABORT, &buf->status);
|
2012-08-03 22:01:21 -06:00
|
|
|
complete_all(&buf->completion);
|
2005-04-16 16:20:36 -06:00
|
|
|
}
|
|
|
|
|
2010-06-04 01:54:43 -06:00
|
|
|
static ssize_t firmware_timeout_show(struct class *class,
|
|
|
|
struct class_attribute *attr,
|
|
|
|
char *buf)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
|
|
|
return sprintf(buf, "%d\n", loading_timeout);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2005-10-30 16:03:01 -07:00
|
|
|
* firmware_timeout_store - set number of seconds to wait for firmware
|
|
|
|
* @class: device class pointer
|
2010-03-10 12:47:58 -07:00
|
|
|
* @attr: device attribute pointer
|
2005-10-30 16:03:01 -07:00
|
|
|
* @buf: buffer to scan for timeout value
|
|
|
|
* @count: number of bytes in @buf
|
|
|
|
*
|
2005-04-16 16:20:36 -06:00
|
|
|
* Sets the number of seconds to wait for the firmware. Once
|
2005-10-30 16:03:01 -07:00
|
|
|
* this expires an error will be returned to the driver and no
|
2005-04-16 16:20:36 -06:00
|
|
|
* firmware will be provided.
|
|
|
|
*
|
2005-10-30 16:03:01 -07:00
|
|
|
* Note: zero means 'wait forever'.
|
2005-04-16 16:20:36 -06:00
|
|
|
**/
|
2010-06-04 01:54:43 -06:00
|
|
|
static ssize_t firmware_timeout_store(struct class *class,
|
|
|
|
struct class_attribute *attr,
|
|
|
|
const char *buf, size_t count)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
|
|
|
loading_timeout = simple_strtol(buf, NULL, 10);
|
2005-06-28 21:44:51 -06:00
|
|
|
if (loading_timeout < 0)
|
|
|
|
loading_timeout = 0;
|
2010-06-04 01:54:43 -06:00
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
return count;
|
|
|
|
}
|
|
|
|
|
2010-03-14 00:49:13 -07:00
|
|
|
static struct class_attribute firmware_class_attrs[] = {
|
|
|
|
__ATTR(timeout, S_IWUSR | S_IRUGO,
|
|
|
|
firmware_timeout_show, firmware_timeout_store),
|
|
|
|
__ATTR_NULL
|
|
|
|
};
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2012-08-03 22:01:20 -06:00
|
|
|
static void fw_dev_release(struct device *dev)
|
|
|
|
{
|
|
|
|
struct firmware_priv *fw_priv = to_firmware_priv(dev);
|
2012-08-03 22:01:16 -06:00
|
|
|
|
2010-03-14 00:49:13 -07:00
|
|
|
kfree(fw_priv);
|
|
|
|
|
|
|
|
module_put(THIS_MODULE);
|
|
|
|
}
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2007-08-14 07:15:12 -06:00
|
|
|
static int firmware_uevent(struct device *dev, struct kobj_uevent_env *env)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
2010-06-04 01:54:43 -06:00
|
|
|
struct firmware_priv *fw_priv = to_firmware_priv(dev);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2012-08-03 22:01:20 -06:00
|
|
|
if (add_uevent_var(env, "FIRMWARE=%s", fw_priv->buf->fw_id))
|
2005-04-16 16:20:36 -06:00
|
|
|
return -ENOMEM;
|
2007-08-14 07:15:12 -06:00
|
|
|
if (add_uevent_var(env, "TIMEOUT=%i", loading_timeout))
|
2005-04-18 22:57:31 -06:00
|
|
|
return -ENOMEM;
|
2010-03-29 09:57:20 -06:00
|
|
|
if (add_uevent_var(env, "ASYNC=%d", fw_priv->nowait))
|
|
|
|
return -ENOMEM;
|
2005-04-16 16:20:36 -06:00
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2006-05-20 16:00:16 -06:00
|
|
|
static struct class firmware_class = {
|
|
|
|
.name = "firmware",
|
2010-03-14 00:49:13 -07:00
|
|
|
.class_attrs = firmware_class_attrs,
|
2006-09-14 08:30:59 -06:00
|
|
|
.dev_uevent = firmware_uevent,
|
|
|
|
.dev_release = fw_dev_release,
|
2006-05-20 16:00:16 -06:00
|
|
|
};
|
|
|
|
|
2006-09-14 08:30:59 -06:00
|
|
|
static ssize_t firmware_loading_show(struct device *dev,
|
|
|
|
struct device_attribute *attr, char *buf)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
2010-06-04 01:54:43 -06:00
|
|
|
struct firmware_priv *fw_priv = to_firmware_priv(dev);
|
2012-08-03 22:01:20 -06:00
|
|
|
int loading = test_bit(FW_STATUS_LOADING, &fw_priv->buf->status);
|
2010-06-04 01:54:43 -06:00
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
return sprintf(buf, "%d\n", loading);
|
|
|
|
}
|
|
|
|
|
2012-08-03 22:01:16 -06:00
|
|
|
/* firmware holds the ownership of pages */
|
2010-05-02 02:21:21 -06:00
|
|
|
static void firmware_free_data(const struct firmware *fw)
|
|
|
|
{
|
2012-10-03 16:58:32 -06:00
|
|
|
/* Loaded directly? */
|
|
|
|
if (!fw->priv) {
|
|
|
|
vfree(fw->data);
|
|
|
|
return;
|
|
|
|
}
|
2012-08-03 22:01:21 -06:00
|
|
|
fw_free_buf(fw->priv);
|
2010-05-02 02:21:21 -06:00
|
|
|
}
|
|
|
|
|
2009-04-09 23:04:07 -06:00
|
|
|
/* Some architectures don't have PAGE_KERNEL_RO */
|
|
|
|
#ifndef PAGE_KERNEL_RO
|
|
|
|
#define PAGE_KERNEL_RO PAGE_KERNEL
|
|
|
|
#endif
|
2012-10-08 22:01:02 -06:00
|
|
|
|
|
|
|
/* one pages buffer should be mapped/unmapped only once */
|
|
|
|
static int fw_map_pages_buf(struct firmware_buf *buf)
|
|
|
|
{
|
2012-10-08 22:01:03 -06:00
|
|
|
if (buf->fmt != PAGE_BUF)
|
|
|
|
return 0;
|
|
|
|
|
2012-10-08 22:01:02 -06:00
|
|
|
if (buf->data)
|
|
|
|
vunmap(buf->data);
|
|
|
|
buf->data = vmap(buf->pages, buf->nr_pages, 0, PAGE_KERNEL_RO);
|
|
|
|
if (!buf->data)
|
|
|
|
return -ENOMEM;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
/**
|
2005-10-30 16:03:01 -07:00
|
|
|
* firmware_loading_store - set value in the 'loading' control file
|
2006-09-14 08:30:59 -06:00
|
|
|
* @dev: device pointer
|
2006-12-22 02:06:52 -07:00
|
|
|
* @attr: device attribute pointer
|
2005-10-30 16:03:01 -07:00
|
|
|
* @buf: buffer to scan for loading control value
|
|
|
|
* @count: number of bytes in @buf
|
|
|
|
*
|
2005-04-16 16:20:36 -06:00
|
|
|
* The relevant values are:
|
|
|
|
*
|
|
|
|
* 1: Start a load, discarding any previous partial load.
|
2005-10-30 16:03:01 -07:00
|
|
|
* 0: Conclude the load and hand the data to the driver code.
|
2005-04-16 16:20:36 -06:00
|
|
|
* -1: Conclude the load with an error and discard any written data.
|
|
|
|
**/
|
2006-09-14 08:30:59 -06:00
|
|
|
static ssize_t firmware_loading_store(struct device *dev,
|
|
|
|
struct device_attribute *attr,
|
|
|
|
const char *buf, size_t count)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
2010-06-04 01:54:43 -06:00
|
|
|
struct firmware_priv *fw_priv = to_firmware_priv(dev);
|
2012-08-03 22:01:20 -06:00
|
|
|
struct firmware_buf *fw_buf = fw_priv->buf;
|
2005-04-16 16:20:36 -06:00
|
|
|
int loading = simple_strtol(buf, NULL, 10);
|
2009-04-09 23:04:07 -06:00
|
|
|
int i;
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2012-01-02 13:31:23 -07:00
|
|
|
mutex_lock(&fw_lock);
|
|
|
|
|
2012-08-03 22:01:20 -06:00
|
|
|
if (!fw_buf)
|
2012-01-02 13:31:23 -07:00
|
|
|
goto out;
|
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
switch (loading) {
|
|
|
|
case 1:
|
2012-08-03 22:01:16 -06:00
|
|
|
/* discarding any previous partial load */
|
2012-08-03 22:01:20 -06:00
|
|
|
if (!test_bit(FW_STATUS_DONE, &fw_buf->status)) {
|
|
|
|
for (i = 0; i < fw_buf->nr_pages; i++)
|
|
|
|
__free_page(fw_buf->pages[i]);
|
|
|
|
kfree(fw_buf->pages);
|
|
|
|
fw_buf->pages = NULL;
|
|
|
|
fw_buf->page_array_size = 0;
|
|
|
|
fw_buf->nr_pages = 0;
|
|
|
|
set_bit(FW_STATUS_LOADING, &fw_buf->status);
|
2012-08-03 22:01:17 -06:00
|
|
|
}
|
2005-04-16 16:20:36 -06:00
|
|
|
break;
|
|
|
|
case 0:
|
2012-08-03 22:01:20 -06:00
|
|
|
if (test_bit(FW_STATUS_LOADING, &fw_buf->status)) {
|
|
|
|
set_bit(FW_STATUS_DONE, &fw_buf->status);
|
|
|
|
clear_bit(FW_STATUS_LOADING, &fw_buf->status);
|
2012-10-08 22:01:02 -06:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Several loading requests may be pending on
|
|
|
|
* one same firmware buf, so let all requests
|
|
|
|
* see the mapped 'buf->data' once the loading
|
|
|
|
* is completed.
|
|
|
|
* */
|
|
|
|
fw_map_pages_buf(fw_buf);
|
2012-08-03 22:01:21 -06:00
|
|
|
complete_all(&fw_buf->completion);
|
2005-04-16 16:20:36 -06:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
/* fallthrough */
|
|
|
|
default:
|
2008-10-15 23:04:20 -06:00
|
|
|
dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading);
|
2005-04-16 16:20:36 -06:00
|
|
|
/* fallthrough */
|
|
|
|
case -1:
|
|
|
|
fw_load_abort(fw_priv);
|
|
|
|
break;
|
|
|
|
}
|
2012-01-02 13:31:23 -07:00
|
|
|
out:
|
|
|
|
mutex_unlock(&fw_lock);
|
2005-04-16 16:20:36 -06:00
|
|
|
return count;
|
|
|
|
}
|
|
|
|
|
2006-09-14 08:30:59 -06:00
|
|
|
static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2010-06-04 01:54:43 -06:00
|
|
|
static ssize_t firmware_data_read(struct file *filp, struct kobject *kobj,
|
|
|
|
struct bin_attribute *bin_attr,
|
|
|
|
char *buffer, loff_t offset, size_t count)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
2012-07-03 10:49:36 -06:00
|
|
|
struct device *dev = kobj_to_dev(kobj);
|
2010-06-04 01:54:43 -06:00
|
|
|
struct firmware_priv *fw_priv = to_firmware_priv(dev);
|
2012-08-03 22:01:20 -06:00
|
|
|
struct firmware_buf *buf;
|
2008-07-25 02:48:23 -06:00
|
|
|
ssize_t ret_count;
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2006-05-23 15:22:38 -06:00
|
|
|
mutex_lock(&fw_lock);
|
2012-08-03 22:01:20 -06:00
|
|
|
buf = fw_priv->buf;
|
|
|
|
if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) {
|
2005-04-16 16:20:36 -06:00
|
|
|
ret_count = -ENODEV;
|
|
|
|
goto out;
|
|
|
|
}
|
2012-08-03 22:01:20 -06:00
|
|
|
if (offset > buf->size) {
|
2009-06-21 15:57:31 -06:00
|
|
|
ret_count = 0;
|
|
|
|
goto out;
|
|
|
|
}
|
2012-08-03 22:01:20 -06:00
|
|
|
if (count > buf->size - offset)
|
|
|
|
count = buf->size - offset;
|
2009-04-09 23:04:07 -06:00
|
|
|
|
|
|
|
ret_count = count;
|
|
|
|
|
|
|
|
while (count) {
|
|
|
|
void *page_data;
|
|
|
|
int page_nr = offset >> PAGE_SHIFT;
|
|
|
|
int page_ofs = offset & (PAGE_SIZE-1);
|
|
|
|
int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
|
|
|
|
|
2012-08-03 22:01:20 -06:00
|
|
|
page_data = kmap(buf->pages[page_nr]);
|
2009-04-09 23:04:07 -06:00
|
|
|
|
|
|
|
memcpy(buffer, page_data + page_ofs, page_cnt);
|
|
|
|
|
2012-08-03 22:01:20 -06:00
|
|
|
kunmap(buf->pages[page_nr]);
|
2009-04-09 23:04:07 -06:00
|
|
|
buffer += page_cnt;
|
|
|
|
offset += page_cnt;
|
|
|
|
count -= page_cnt;
|
|
|
|
}
|
2005-04-16 16:20:36 -06:00
|
|
|
out:
|
2006-05-23 15:22:38 -06:00
|
|
|
mutex_unlock(&fw_lock);
|
2005-04-16 16:20:36 -06:00
|
|
|
return ret_count;
|
|
|
|
}
|
2005-10-30 16:03:01 -07:00
|
|
|
|
2010-06-04 01:54:43 -06:00
|
|
|
static int fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
2012-08-03 22:01:20 -06:00
|
|
|
struct firmware_buf *buf = fw_priv->buf;
|
2009-04-09 23:04:07 -06:00
|
|
|
int pages_needed = ALIGN(min_size, PAGE_SIZE) >> PAGE_SHIFT;
|
|
|
|
|
|
|
|
/* If the array of pages is too small, grow it... */
|
2012-08-03 22:01:20 -06:00
|
|
|
if (buf->page_array_size < pages_needed) {
|
2009-04-09 23:04:07 -06:00
|
|
|
int new_array_size = max(pages_needed,
|
2012-08-03 22:01:20 -06:00
|
|
|
buf->page_array_size * 2);
|
2009-04-09 23:04:07 -06:00
|
|
|
struct page **new_pages;
|
|
|
|
|
|
|
|
new_pages = kmalloc(new_array_size * sizeof(void *),
|
|
|
|
GFP_KERNEL);
|
|
|
|
if (!new_pages) {
|
|
|
|
fw_load_abort(fw_priv);
|
|
|
|
return -ENOMEM;
|
|
|
|
}
|
2012-08-03 22:01:20 -06:00
|
|
|
memcpy(new_pages, buf->pages,
|
|
|
|
buf->page_array_size * sizeof(void *));
|
|
|
|
memset(&new_pages[buf->page_array_size], 0, sizeof(void *) *
|
|
|
|
(new_array_size - buf->page_array_size));
|
|
|
|
kfree(buf->pages);
|
|
|
|
buf->pages = new_pages;
|
|
|
|
buf->page_array_size = new_array_size;
|
2009-04-09 23:04:07 -06:00
|
|
|
}
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2012-08-03 22:01:20 -06:00
|
|
|
while (buf->nr_pages < pages_needed) {
|
|
|
|
buf->pages[buf->nr_pages] =
|
2009-04-09 23:04:07 -06:00
|
|
|
alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2012-08-03 22:01:20 -06:00
|
|
|
if (!buf->pages[buf->nr_pages]) {
|
2009-04-09 23:04:07 -06:00
|
|
|
fw_load_abort(fw_priv);
|
|
|
|
return -ENOMEM;
|
|
|
|
}
|
2012-08-03 22:01:20 -06:00
|
|
|
buf->nr_pages++;
|
2005-04-16 16:20:36 -06:00
|
|
|
}
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2005-10-30 16:03:01 -07:00
|
|
|
* firmware_data_write - write method for firmware
|
2010-05-12 19:28:57 -06:00
|
|
|
* @filp: open sysfs file
|
2006-09-14 08:30:59 -06:00
|
|
|
* @kobj: kobject for the device
|
2007-07-23 22:42:11 -06:00
|
|
|
* @bin_attr: bin_attr structure
|
2005-10-30 16:03:01 -07:00
|
|
|
* @buffer: buffer being written
|
|
|
|
* @offset: buffer offset for write in total data store area
|
|
|
|
* @count: buffer size
|
2005-04-16 16:20:36 -06:00
|
|
|
*
|
2005-10-30 16:03:01 -07:00
|
|
|
* Data written to the 'data' attribute will be later handed to
|
2005-04-16 16:20:36 -06:00
|
|
|
* the driver as a firmware image.
|
|
|
|
**/
|
2010-06-04 01:54:43 -06:00
|
|
|
static ssize_t firmware_data_write(struct file *filp, struct kobject *kobj,
|
|
|
|
struct bin_attribute *bin_attr,
|
|
|
|
char *buffer, loff_t offset, size_t count)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
2012-07-03 10:49:36 -06:00
|
|
|
struct device *dev = kobj_to_dev(kobj);
|
2010-06-04 01:54:43 -06:00
|
|
|
struct firmware_priv *fw_priv = to_firmware_priv(dev);
|
2012-08-03 22:01:20 -06:00
|
|
|
struct firmware_buf *buf;
|
2005-04-16 16:20:36 -06:00
|
|
|
ssize_t retval;
|
|
|
|
|
|
|
|
if (!capable(CAP_SYS_RAWIO))
|
|
|
|
return -EPERM;
|
2005-06-28 21:44:51 -06:00
|
|
|
|
2006-05-23 15:22:38 -06:00
|
|
|
mutex_lock(&fw_lock);
|
2012-08-03 22:01:20 -06:00
|
|
|
buf = fw_priv->buf;
|
|
|
|
if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) {
|
2005-04-16 16:20:36 -06:00
|
|
|
retval = -ENODEV;
|
|
|
|
goto out;
|
|
|
|
}
|
2012-08-03 22:01:16 -06:00
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
retval = fw_realloc_buffer(fw_priv, offset + count);
|
|
|
|
if (retval)
|
|
|
|
goto out;
|
|
|
|
|
|
|
|
retval = count;
|
2009-04-09 23:04:07 -06:00
|
|
|
|
|
|
|
while (count) {
|
|
|
|
void *page_data;
|
|
|
|
int page_nr = offset >> PAGE_SHIFT;
|
|
|
|
int page_ofs = offset & (PAGE_SIZE - 1);
|
|
|
|
int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
|
|
|
|
|
2012-08-03 22:01:20 -06:00
|
|
|
page_data = kmap(buf->pages[page_nr]);
|
2009-04-09 23:04:07 -06:00
|
|
|
|
|
|
|
memcpy(page_data + page_ofs, buffer, page_cnt);
|
|
|
|
|
2012-08-03 22:01:20 -06:00
|
|
|
kunmap(buf->pages[page_nr]);
|
2009-04-09 23:04:07 -06:00
|
|
|
buffer += page_cnt;
|
|
|
|
offset += page_cnt;
|
|
|
|
count -= page_cnt;
|
|
|
|
}
|
|
|
|
|
2012-08-03 22:01:20 -06:00
|
|
|
buf->size = max_t(size_t, offset, buf->size);
|
2005-04-16 16:20:36 -06:00
|
|
|
out:
|
2006-05-23 15:22:38 -06:00
|
|
|
mutex_unlock(&fw_lock);
|
2005-04-16 16:20:36 -06:00
|
|
|
return retval;
|
|
|
|
}
|
2005-10-30 16:03:01 -07:00
|
|
|
|
2010-06-04 01:54:37 -06:00
|
|
|
static struct bin_attribute firmware_attr_data = {
|
|
|
|
.attr = { .name = "data", .mode = 0644 },
|
2005-04-16 16:20:36 -06:00
|
|
|
.size = 0,
|
|
|
|
.read = firmware_data_read,
|
|
|
|
.write = firmware_data_write,
|
|
|
|
};
|
|
|
|
|
2012-11-08 04:14:40 -07:00
|
|
|
static void firmware_class_timeout_work(struct work_struct *work)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
2012-11-08 04:14:40 -07:00
|
|
|
struct firmware_priv *fw_priv = container_of(work,
|
|
|
|
struct firmware_priv, timeout_work.work);
|
2010-06-04 01:54:43 -06:00
|
|
|
|
2012-11-08 04:14:40 -07:00
|
|
|
mutex_lock(&fw_lock);
|
|
|
|
if (test_bit(FW_STATUS_DONE, &(fw_priv->buf->status))) {
|
|
|
|
mutex_unlock(&fw_lock);
|
|
|
|
return;
|
|
|
|
}
|
2005-04-16 16:20:36 -06:00
|
|
|
fw_load_abort(fw_priv);
|
2012-11-08 04:14:40 -07:00
|
|
|
mutex_unlock(&fw_lock);
|
2005-04-16 16:20:36 -06:00
|
|
|
}
|
|
|
|
|
2010-06-04 01:54:43 -06:00
|
|
|
static struct firmware_priv *
|
2012-03-28 15:30:43 -06:00
|
|
|
fw_create_instance(struct firmware *firmware, const char *fw_name,
|
2010-06-04 01:54:43 -06:00
|
|
|
struct device *device, bool uevent, bool nowait)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
2010-06-04 01:54:43 -06:00
|
|
|
struct firmware_priv *fw_priv;
|
|
|
|
struct device *f_dev;
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2012-08-03 22:01:20 -06:00
|
|
|
fw_priv = kzalloc(sizeof(*fw_priv), GFP_KERNEL);
|
2010-06-04 01:54:43 -06:00
|
|
|
if (!fw_priv) {
|
2008-10-15 23:04:20 -06:00
|
|
|
dev_err(device, "%s: kmalloc failed\n", __func__);
|
2012-08-03 22:01:20 -06:00
|
|
|
fw_priv = ERR_PTR(-ENOMEM);
|
|
|
|
goto exit;
|
|
|
|
}
|
|
|
|
|
2010-06-04 01:54:43 -06:00
|
|
|
fw_priv->nowait = nowait;
|
2012-08-03 22:01:21 -06:00
|
|
|
fw_priv->fw = firmware;
|
2012-11-08 04:14:40 -07:00
|
|
|
INIT_DELAYED_WORK(&fw_priv->timeout_work,
|
|
|
|
firmware_class_timeout_work);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2010-06-04 01:54:43 -06:00
|
|
|
f_dev = &fw_priv->dev;
|
|
|
|
|
|
|
|
device_initialize(f_dev);
|
2012-08-03 22:01:19 -06:00
|
|
|
dev_set_name(f_dev, "%s", fw_name);
|
2006-09-14 08:30:59 -06:00
|
|
|
f_dev->parent = device;
|
|
|
|
f_dev->class = &firmware_class;
|
2012-08-03 22:01:20 -06:00
|
|
|
exit:
|
2010-06-04 01:54:43 -06:00
|
|
|
return fw_priv;
|
2005-04-16 16:20:36 -06:00
|
|
|
}
|
|
|
|
|
2012-08-03 22:01:21 -06:00
|
|
|
/* store the pages buffer info firmware from buf */
|
|
|
|
static void fw_set_page_data(struct firmware_buf *buf, struct firmware *fw)
|
|
|
|
{
|
|
|
|
fw->priv = buf;
|
|
|
|
fw->pages = buf->pages;
|
|
|
|
fw->size = buf->size;
|
|
|
|
fw->data = buf->data;
|
|
|
|
|
|
|
|
pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
|
|
|
|
__func__, buf->fw_id, buf, buf->data,
|
|
|
|
(unsigned int)buf->size);
|
|
|
|
}
|
|
|
|
|
2012-09-08 03:32:30 -06:00
|
|
|
#ifdef CONFIG_PM_SLEEP
|
2012-08-03 22:01:25 -06:00
|
|
|
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);
|
|
|
|
}
|
|
|
|
|
|
|
|
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);
|
|
|
|
}
|
|
|
|
|
|
|
|
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;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* add firmware name into devres list */
|
|
|
|
static int fw_add_devm_name(struct device *dev, const char *name)
|
|
|
|
{
|
|
|
|
struct fw_name_devm *fwn;
|
|
|
|
|
|
|
|
fwn = fw_find_devm_name(dev, name);
|
|
|
|
if (fwn)
|
|
|
|
return 1;
|
|
|
|
|
|
|
|
fwn = devres_alloc(fw_name_devm_release, sizeof(struct fw_name_devm) +
|
|
|
|
strlen(name) + 1, GFP_KERNEL);
|
|
|
|
if (!fwn)
|
|
|
|
return -ENOMEM;
|
|
|
|
|
|
|
|
fwn->magic = (unsigned long)&fw_cache;
|
|
|
|
strcpy(fwn->name, name);
|
|
|
|
devres_add(dev, fwn);
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
2012-09-08 03:32:30 -06:00
|
|
|
#else
|
|
|
|
static int fw_add_devm_name(struct device *dev, const char *name)
|
|
|
|
{
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
#endif
|
2012-08-03 22:01:25 -06:00
|
|
|
|
2012-08-03 22:01:21 -06:00
|
|
|
static void _request_firmware_cleanup(const struct firmware **firmware_p)
|
|
|
|
{
|
|
|
|
release_firmware(*firmware_p);
|
|
|
|
*firmware_p = NULL;
|
|
|
|
}
|
|
|
|
|
2012-03-28 15:30:43 -06:00
|
|
|
static struct firmware_priv *
|
|
|
|
_request_firmware_prepare(const struct firmware **firmware_p, const char *name,
|
|
|
|
struct device *device, bool uevent, bool nowait)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
|
|
|
struct firmware *firmware;
|
2012-08-03 22:01:21 -06:00
|
|
|
struct firmware_priv *fw_priv = NULL;
|
|
|
|
struct firmware_buf *buf;
|
|
|
|
int ret;
|
2005-04-16 16:20:36 -06:00
|
|
|
|
|
|
|
if (!firmware_p)
|
2012-03-28 15:30:43 -06:00
|
|
|
return ERR_PTR(-EINVAL);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2005-09-13 02:25:01 -06:00
|
|
|
*firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
|
2005-04-16 16:20:36 -06:00
|
|
|
if (!firmware) {
|
2008-10-15 23:04:20 -06:00
|
|
|
dev_err(device, "%s: kmalloc(struct firmware) failed\n",
|
|
|
|
__func__);
|
2012-03-28 15:30:43 -06:00
|
|
|
return ERR_PTR(-ENOMEM);
|
2005-04-16 16:20:36 -06:00
|
|
|
}
|
|
|
|
|
2010-03-14 00:49:18 -07:00
|
|
|
if (fw_get_builtin_firmware(firmware, name)) {
|
2010-02-27 13:43:22 -07:00
|
|
|
dev_dbg(device, "firmware: using built-in firmware %s\n", name);
|
2012-03-28 15:30:43 -06:00
|
|
|
return NULL;
|
2008-05-23 06:52:42 -06:00
|
|
|
}
|
|
|
|
|
2012-08-03 22:01:21 -06:00
|
|
|
ret = fw_lookup_and_allocate_buf(name, &fw_cache, &buf);
|
|
|
|
if (!ret)
|
|
|
|
fw_priv = fw_create_instance(firmware, name, device,
|
|
|
|
uevent, nowait);
|
|
|
|
|
|
|
|
if (IS_ERR(fw_priv) || ret < 0) {
|
|
|
|
kfree(firmware);
|
2012-03-28 15:30:43 -06:00
|
|
|
*firmware_p = NULL;
|
2012-08-03 22:01:21 -06:00
|
|
|
return ERR_PTR(-ENOMEM);
|
|
|
|
} else if (fw_priv) {
|
|
|
|
fw_priv->buf = buf;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* bind with 'buf' now to avoid warning in failure path
|
|
|
|
* of requesting firmware.
|
|
|
|
*/
|
|
|
|
firmware->priv = buf;
|
|
|
|
return fw_priv;
|
2012-03-28 15:30:43 -06:00
|
|
|
}
|
2012-03-28 15:29:55 -06:00
|
|
|
|
2012-08-03 22:01:21 -06:00
|
|
|
/* share the cached buf, which is inprogessing or completed */
|
|
|
|
check_status:
|
|
|
|
mutex_lock(&fw_lock);
|
|
|
|
if (test_bit(FW_STATUS_ABORT, &buf->status)) {
|
|
|
|
fw_priv = ERR_PTR(-ENOENT);
|
2012-08-20 05:04:15 -06:00
|
|
|
firmware->priv = buf;
|
2012-08-03 22:01:21 -06:00
|
|
|
_request_firmware_cleanup(firmware_p);
|
|
|
|
goto exit;
|
|
|
|
} else if (test_bit(FW_STATUS_DONE, &buf->status)) {
|
|
|
|
fw_priv = NULL;
|
|
|
|
fw_set_page_data(buf, firmware);
|
|
|
|
goto exit;
|
|
|
|
}
|
|
|
|
mutex_unlock(&fw_lock);
|
|
|
|
wait_for_completion(&buf->completion);
|
|
|
|
goto check_status;
|
2012-08-03 22:01:16 -06:00
|
|
|
|
2012-08-03 22:01:21 -06:00
|
|
|
exit:
|
|
|
|
mutex_unlock(&fw_lock);
|
|
|
|
return fw_priv;
|
2012-08-03 22:01:16 -06:00
|
|
|
}
|
|
|
|
|
2012-03-28 15:30:43 -06:00
|
|
|
static int _request_firmware_load(struct firmware_priv *fw_priv, bool uevent,
|
|
|
|
long timeout)
|
2012-03-28 15:29:55 -06:00
|
|
|
{
|
2012-03-28 15:30:02 -06:00
|
|
|
int retval = 0;
|
2012-03-28 15:30:43 -06:00
|
|
|
struct device *f_dev = &fw_priv->dev;
|
2012-08-03 22:01:20 -06:00
|
|
|
struct firmware_buf *buf = fw_priv->buf;
|
2012-08-20 05:04:16 -06:00
|
|
|
struct firmware_cache *fwc = &fw_cache;
|
2012-10-08 22:01:03 -06:00
|
|
|
int direct_load = 0;
|
|
|
|
|
|
|
|
/* try direct loading from fs first */
|
|
|
|
if (fw_get_filesystem_firmware(buf)) {
|
|
|
|
dev_dbg(f_dev->parent, "firmware: direct-loading"
|
|
|
|
" firmware %s\n", buf->fw_id);
|
|
|
|
|
2012-11-08 04:14:40 -07:00
|
|
|
mutex_lock(&fw_lock);
|
2012-10-08 22:01:03 -06:00
|
|
|
set_bit(FW_STATUS_DONE, &buf->status);
|
2012-11-08 04:14:40 -07:00
|
|
|
mutex_unlock(&fw_lock);
|
2012-10-08 22:01:03 -06:00
|
|
|
complete_all(&buf->completion);
|
|
|
|
direct_load = 1;
|
|
|
|
goto handle_fw;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* fall back on userspace loading */
|
|
|
|
buf->fmt = PAGE_BUF;
|
2012-03-28 15:30:43 -06:00
|
|
|
|
|
|
|
dev_set_uevent_suppress(f_dev, true);
|
2011-08-24 16:55:30 -06:00
|
|
|
|
2012-03-28 15:30:43 -06:00
|
|
|
/* Need to pin this module until class device is destroyed */
|
|
|
|
__module_get(THIS_MODULE);
|
2008-05-23 06:52:42 -06:00
|
|
|
|
2012-03-28 15:30:43 -06:00
|
|
|
retval = device_add(f_dev);
|
|
|
|
if (retval) {
|
|
|
|
dev_err(f_dev, "%s: device_register failed\n", __func__);
|
|
|
|
goto err_put_dev;
|
|
|
|
}
|
|
|
|
|
|
|
|
retval = device_create_bin_file(f_dev, &firmware_attr_data);
|
|
|
|
if (retval) {
|
|
|
|
dev_err(f_dev, "%s: sysfs_create_bin_file failed\n", __func__);
|
|
|
|
goto err_del_dev;
|
|
|
|
}
|
|
|
|
|
|
|
|
retval = device_create_file(f_dev, &dev_attr_loading);
|
|
|
|
if (retval) {
|
|
|
|
dev_err(f_dev, "%s: device_create_file failed\n", __func__);
|
|
|
|
goto err_del_bin_attr;
|
|
|
|
}
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2005-11-16 01:00:00 -07:00
|
|
|
if (uevent) {
|
2012-03-28 15:30:43 -06:00
|
|
|
dev_set_uevent_suppress(f_dev, false);
|
2012-08-03 22:01:20 -06:00
|
|
|
dev_dbg(f_dev, "firmware: requesting %s\n", buf->fw_id);
|
2012-03-28 15:30:02 -06:00
|
|
|
if (timeout != MAX_SCHEDULE_TIMEOUT)
|
2012-11-08 04:14:40 -07:00
|
|
|
schedule_delayed_work(&fw_priv->timeout_work, timeout);
|
2010-06-04 01:54:43 -06:00
|
|
|
|
|
|
|
kobject_uevent(&fw_priv->dev.kobj, KOBJ_ADD);
|
|
|
|
}
|
|
|
|
|
2012-08-03 22:01:20 -06:00
|
|
|
wait_for_completion(&buf->completion);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2012-11-08 04:14:40 -07:00
|
|
|
cancel_delayed_work_sync(&fw_priv->timeout_work);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2012-10-08 22:01:03 -06:00
|
|
|
handle_fw:
|
2006-05-23 15:22:38 -06:00
|
|
|
mutex_lock(&fw_lock);
|
2012-08-03 22:01:20 -06:00
|
|
|
if (!buf->size || test_bit(FW_STATUS_ABORT, &buf->status))
|
2005-04-16 16:20:36 -06:00
|
|
|
retval = -ENOENT;
|
2012-08-03 22:01:16 -06:00
|
|
|
|
2012-08-03 22:01:25 -06:00
|
|
|
/*
|
|
|
|
* add firmware name into devres list so that we can auto cache
|
|
|
|
* and uncache firmware for device.
|
|
|
|
*
|
|
|
|
* f_dev->parent may has been deleted already, but the problem
|
|
|
|
* should be fixed in devres or driver core.
|
|
|
|
*/
|
|
|
|
if (!retval && f_dev->parent)
|
|
|
|
fw_add_devm_name(f_dev->parent, buf->fw_id);
|
|
|
|
|
2012-08-20 05:04:16 -06:00
|
|
|
/*
|
|
|
|
* After caching firmware image is started, let it piggyback
|
|
|
|
* on request firmware.
|
|
|
|
*/
|
|
|
|
if (!retval && fwc->state == FW_LOADER_START_CACHE) {
|
|
|
|
if (fw_cache_piggyback_on_request(buf->fw_id))
|
|
|
|
kref_get(&buf->ref);
|
|
|
|
}
|
|
|
|
|
2012-08-03 22:01:21 -06:00
|
|
|
/* pass the pages buffer to driver at the last minute */
|
|
|
|
fw_set_page_data(buf, fw_priv->fw);
|
2012-08-03 22:01:20 -06:00
|
|
|
|
|
|
|
fw_priv->buf = NULL;
|
2006-05-23 15:22:38 -06:00
|
|
|
mutex_unlock(&fw_lock);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2012-10-08 22:01:03 -06:00
|
|
|
if (direct_load)
|
|
|
|
goto err_put_dev;
|
|
|
|
|
2012-03-28 15:30:43 -06:00
|
|
|
device_remove_file(f_dev, &dev_attr_loading);
|
|
|
|
err_del_bin_attr:
|
|
|
|
device_remove_bin_file(f_dev, &firmware_attr_data);
|
|
|
|
err_del_dev:
|
|
|
|
device_del(f_dev);
|
|
|
|
err_put_dev:
|
|
|
|
put_device(f_dev);
|
2005-04-16 16:20:36 -06:00
|
|
|
return retval;
|
|
|
|
}
|
|
|
|
|
2005-09-06 16:17:13 -06:00
|
|
|
/**
|
2005-11-16 01:00:00 -07:00
|
|
|
* request_firmware: - send firmware request and wait for it
|
2005-10-30 16:03:01 -07:00
|
|
|
* @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
|
2005-09-06 16:17:13 -06:00
|
|
|
* of @name for device @device.
|
|
|
|
*
|
|
|
|
* Should be called from user context where sleeping is allowed.
|
|
|
|
*
|
2005-11-16 01:00:00 -07:00
|
|
|
* @name will be used as $FIRMWARE in the uevent environment and
|
2005-09-06 16:17:13 -06:00
|
|
|
* should be distinctive enough not to be confused with any other
|
|
|
|
* firmware image for this or any other device.
|
2012-08-03 22:01:23 -06:00
|
|
|
*
|
|
|
|
* Caller must hold the reference count of @device.
|
2012-11-03 03:48:16 -06:00
|
|
|
*
|
|
|
|
* The function can be called safely inside device's suspend and
|
|
|
|
* resume callback.
|
2005-09-06 16:17:13 -06:00
|
|
|
**/
|
|
|
|
int
|
|
|
|
request_firmware(const struct firmware **firmware_p, const char *name,
|
|
|
|
struct device *device)
|
|
|
|
{
|
2012-03-28 15:30:43 -06:00
|
|
|
struct firmware_priv *fw_priv;
|
2012-03-28 15:29:55 -06:00
|
|
|
int ret;
|
|
|
|
|
2012-03-28 15:30:43 -06:00
|
|
|
fw_priv = _request_firmware_prepare(firmware_p, name, device, true,
|
|
|
|
false);
|
|
|
|
if (IS_ERR_OR_NULL(fw_priv))
|
|
|
|
return PTR_RET(fw_priv);
|
2012-03-28 15:29:55 -06:00
|
|
|
|
2012-03-28 15:30:02 -06:00
|
|
|
ret = usermodehelper_read_trylock();
|
|
|
|
if (WARN_ON(ret)) {
|
|
|
|
dev_err(device, "firmware: %s will not be loaded\n", name);
|
|
|
|
} else {
|
2012-03-28 15:30:43 -06:00
|
|
|
ret = _request_firmware_load(fw_priv, true,
|
2012-03-28 15:30:02 -06:00
|
|
|
firmware_loading_timeout());
|
|
|
|
usermodehelper_read_unlock();
|
|
|
|
}
|
2012-03-28 15:29:55 -06:00
|
|
|
if (ret)
|
|
|
|
_request_firmware_cleanup(firmware_p);
|
|
|
|
|
|
|
|
return ret;
|
2005-09-06 16:17:13 -06:00
|
|
|
}
|
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
/**
|
|
|
|
* release_firmware: - release the resource associated with a firmware image
|
2005-10-30 16:03:01 -07:00
|
|
|
* @fw: firmware resource to release
|
2005-04-16 16:20:36 -06:00
|
|
|
**/
|
2010-03-14 00:49:18 -07:00
|
|
|
void release_firmware(const struct firmware *fw)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
|
|
|
if (fw) {
|
2010-03-14 00:49:18 -07:00
|
|
|
if (!fw_is_builtin_firmware(fw))
|
|
|
|
firmware_free_data(fw);
|
2005-04-16 16:20:36 -06:00
|
|
|
kfree(fw);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/* 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);
|
2011-01-26 03:33:32 -07:00
|
|
|
bool uevent;
|
2005-04-16 16:20:36 -06:00
|
|
|
};
|
|
|
|
|
2012-03-28 15:31:00 -06:00
|
|
|
static void request_firmware_work_func(struct work_struct *work)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
2012-03-28 15:31:00 -06:00
|
|
|
struct firmware_work *fw_work;
|
2005-04-16 16:20:36 -06:00
|
|
|
const struct firmware *fw;
|
2012-03-28 15:30:43 -06:00
|
|
|
struct firmware_priv *fw_priv;
|
2012-03-28 15:30:02 -06:00
|
|
|
long timeout;
|
2005-11-13 17:07:39 -07:00
|
|
|
int ret;
|
2010-06-04 01:54:43 -06:00
|
|
|
|
2012-03-28 15:31:00 -06:00
|
|
|
fw_work = container_of(work, struct firmware_work, work);
|
2012-03-28 15:30:43 -06:00
|
|
|
fw_priv = _request_firmware_prepare(&fw, fw_work->name, fw_work->device,
|
|
|
|
fw_work->uevent, true);
|
|
|
|
if (IS_ERR_OR_NULL(fw_priv)) {
|
|
|
|
ret = PTR_RET(fw_priv);
|
2012-03-28 15:29:55 -06:00
|
|
|
goto out;
|
2012-03-28 15:30:43 -06:00
|
|
|
}
|
2012-03-28 15:29:55 -06:00
|
|
|
|
2012-03-28 15:30:02 -06:00
|
|
|
timeout = usermodehelper_read_lock_wait(firmware_loading_timeout());
|
|
|
|
if (timeout) {
|
2012-03-28 15:30:43 -06:00
|
|
|
ret = _request_firmware_load(fw_priv, fw_work->uevent, timeout);
|
2012-03-28 15:30:02 -06:00
|
|
|
usermodehelper_read_unlock();
|
|
|
|
} else {
|
|
|
|
dev_dbg(fw_work->device, "firmware: %s loading timed out\n",
|
|
|
|
fw_work->name);
|
|
|
|
ret = -EAGAIN;
|
|
|
|
}
|
2012-03-28 15:29:55 -06:00
|
|
|
if (ret)
|
|
|
|
_request_firmware_cleanup(&fw);
|
|
|
|
|
|
|
|
out:
|
2009-10-29 05:36:02 -06:00
|
|
|
fw_work->cont(fw, fw_work->context);
|
2012-08-03 22:01:23 -06:00
|
|
|
put_device(fw_work->device);
|
2009-10-29 05:36:02 -06:00
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
module_put(fw_work->module);
|
|
|
|
kfree(fw_work);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2010-02-14 07:18:53 -07:00
|
|
|
* request_firmware_nowait - asynchronous version of request_firmware
|
2005-10-30 16:03:01 -07:00
|
|
|
* @module: module requesting the firmware
|
2005-11-16 01:00:00 -07:00
|
|
|
* @uevent: sends uevent to copy the firmware image if this flag
|
2005-10-30 16:03:01 -07:00
|
|
|
* is non-zero else the firmware copy must be done manually.
|
|
|
|
* @name: name of firmware file
|
|
|
|
* @device: device for which firmware is being loaded
|
2009-10-29 05:36:02 -06:00
|
|
|
* @gfp: allocation flags
|
2005-10-30 16:03:01 -07:00
|
|
|
* @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.
|
2005-04-16 16:20:36 -06:00
|
|
|
*
|
2012-08-03 22:01:23 -06:00
|
|
|
* Caller must hold the reference count of @device.
|
|
|
|
*
|
2012-08-03 22:01:24 -06:00
|
|
|
* 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.
|
2005-04-16 16:20:36 -06:00
|
|
|
**/
|
|
|
|
int
|
|
|
|
request_firmware_nowait(
|
2011-01-26 03:33:32 -07:00
|
|
|
struct module *module, bool uevent,
|
2009-10-29 05:36:02 -06:00
|
|
|
const char *name, struct device *device, gfp_t gfp, void *context,
|
2005-04-16 16:20:36 -06:00
|
|
|
void (*cont)(const struct firmware *fw, void *context))
|
|
|
|
{
|
2010-06-04 01:54:43 -06:00
|
|
|
struct firmware_work *fw_work;
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2010-06-04 01:54:43 -06:00
|
|
|
fw_work = kzalloc(sizeof (struct firmware_work), gfp);
|
2005-04-16 16:20:36 -06:00
|
|
|
if (!fw_work)
|
|
|
|
return -ENOMEM;
|
2010-06-04 01:54:43 -06:00
|
|
|
|
|
|
|
fw_work->module = module;
|
|
|
|
fw_work->name = name;
|
|
|
|
fw_work->device = device;
|
|
|
|
fw_work->context = context;
|
|
|
|
fw_work->cont = cont;
|
|
|
|
fw_work->uevent = uevent;
|
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
if (!try_module_get(module)) {
|
|
|
|
kfree(fw_work);
|
|
|
|
return -EFAULT;
|
|
|
|
}
|
|
|
|
|
2012-08-03 22:01:23 -06:00
|
|
|
get_device(fw_work->device);
|
2012-03-28 15:31:00 -06:00
|
|
|
INIT_WORK(&fw_work->work, request_firmware_work_func);
|
|
|
|
schedule_work(&fw_work->work);
|
2005-04-16 16:20:36 -06:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2012-08-03 22:01:22 -06:00
|
|
|
/**
|
|
|
|
* 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
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
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;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
int uncache_firmware(const char *fw_name)
|
|
|
|
{
|
|
|
|
struct firmware_buf *buf;
|
|
|
|
struct firmware fw;
|
|
|
|
|
|
|
|
pr_debug("%s: %s\n", __func__, fw_name);
|
|
|
|
|
|
|
|
if (fw_get_builtin_firmware(&fw, fw_name))
|
|
|
|
return 0;
|
|
|
|
|
|
|
|
buf = fw_lookup_buf(fw_name);
|
|
|
|
if (buf) {
|
|
|
|
fw_free_buf(buf);
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
return -EINVAL;
|
|
|
|
}
|
|
|
|
|
2012-09-08 03:32:30 -06:00
|
|
|
#ifdef CONFIG_PM_SLEEP
|
2012-10-08 22:01:04 -06:00
|
|
|
static ASYNC_DOMAIN_EXCLUSIVE(fw_cache_domain);
|
|
|
|
|
2012-08-03 22:01:27 -06:00
|
|
|
static struct fw_cache_entry *alloc_fw_cache_entry(const char *name)
|
|
|
|
{
|
|
|
|
struct fw_cache_entry *fce;
|
|
|
|
|
|
|
|
fce = kzalloc(sizeof(*fce) + strlen(name) + 1, GFP_ATOMIC);
|
|
|
|
if (!fce)
|
|
|
|
goto exit;
|
|
|
|
|
|
|
|
strcpy(fce->name, name);
|
|
|
|
exit:
|
|
|
|
return fce;
|
|
|
|
}
|
|
|
|
|
2012-10-08 22:01:01 -06:00
|
|
|
static int __fw_entry_found(const char *name)
|
2012-08-20 05:04:16 -06:00
|
|
|
{
|
|
|
|
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))
|
2012-10-08 22:01:01 -06:00
|
|
|
return 1;
|
2012-08-20 05:04:16 -06:00
|
|
|
}
|
2012-10-08 22:01:01 -06:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
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;
|
2012-08-20 05:04:16 -06:00
|
|
|
|
|
|
|
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;
|
|
|
|
}
|
|
|
|
|
2012-08-03 22:01:27 -06:00
|
|
|
static void free_fw_cache_entry(struct fw_cache_entry *fce)
|
|
|
|
{
|
|
|
|
kfree(fce);
|
|
|
|
}
|
|
|
|
|
|
|
|
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);
|
2012-08-20 05:04:16 -06:00
|
|
|
if (ret) {
|
|
|
|
spin_lock(&fwc->name_lock);
|
|
|
|
list_del(&fce->list);
|
|
|
|
spin_unlock(&fwc->name_lock);
|
2012-08-03 22:01:27 -06:00
|
|
|
|
2012-08-20 05:04:16 -06:00
|
|
|
free_fw_cache_entry(fce);
|
|
|
|
}
|
2012-08-03 22:01:27 -06: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);
|
|
|
|
}
|
|
|
|
|
|
|
|
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);
|
|
|
|
}
|
|
|
|
|
2012-08-17 08:07:00 -06:00
|
|
|
static void dev_cache_fw_image(struct device *dev, void *data)
|
2012-08-03 22:01:27 -06:00
|
|
|
{
|
|
|
|
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);
|
2012-10-08 22:01:01 -06:00
|
|
|
/* 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;
|
|
|
|
}
|
2012-08-03 22:01:27 -06:00
|
|
|
spin_unlock(&fwc->name_lock);
|
|
|
|
|
2012-10-08 22:01:01 -06:00
|
|
|
if (fce)
|
2012-10-08 22:01:04 -06:00
|
|
|
async_schedule_domain(__async_dev_cache_fw_image,
|
|
|
|
(void *)fce,
|
|
|
|
&fw_cache_domain);
|
2012-08-03 22:01:27 -06: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);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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;
|
2012-08-03 22:01:28 -06:00
|
|
|
int old_timeout;
|
2012-08-03 22:01:27 -06:00
|
|
|
DEFINE_WAIT(wait);
|
|
|
|
|
|
|
|
pr_debug("%s\n", __func__);
|
|
|
|
|
2012-10-08 22:01:01 -06:00
|
|
|
/* cancel uncache work */
|
|
|
|
cancel_delayed_work_sync(&fwc->work);
|
|
|
|
|
2012-08-03 22:01:28 -06:00
|
|
|
/*
|
|
|
|
* use small loading timeout for caching devices' firmware
|
|
|
|
* because all these firmware images have been loaded
|
|
|
|
* successfully at lease once, also system is ready for
|
|
|
|
* completing firmware loading now. The maximum size of
|
|
|
|
* firmware in current distributions is about 2M bytes,
|
|
|
|
* so 10 secs should be enough.
|
|
|
|
*/
|
|
|
|
old_timeout = loading_timeout;
|
|
|
|
loading_timeout = 10;
|
|
|
|
|
2012-08-20 05:04:16 -06:00
|
|
|
mutex_lock(&fw_lock);
|
|
|
|
fwc->state = FW_LOADER_START_CACHE;
|
2012-08-17 08:07:00 -06:00
|
|
|
dpm_for_each_dev(NULL, dev_cache_fw_image);
|
2012-08-20 05:04:16 -06:00
|
|
|
mutex_unlock(&fw_lock);
|
2012-08-03 22:01:27 -06:00
|
|
|
|
|
|
|
/* wait for completion of caching firmware for all devices */
|
2012-10-08 22:01:04 -06:00
|
|
|
async_synchronize_full_domain(&fw_cache_domain);
|
2012-08-03 22:01:28 -06:00
|
|
|
|
|
|
|
loading_timeout = old_timeout;
|
2012-08-03 22:01:27 -06: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();
|
|
|
|
}
|
|
|
|
|
|
|
|
static void device_uncache_fw_images_work(struct work_struct *work)
|
|
|
|
{
|
|
|
|
device_uncache_fw_images();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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)
|
|
|
|
{
|
|
|
|
schedule_delayed_work(&fw_cache.work,
|
|
|
|
msecs_to_jiffies(delay));
|
|
|
|
}
|
|
|
|
|
2012-08-03 22:01:29 -06: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:
|
|
|
|
device_cache_fw_images();
|
|
|
|
break;
|
|
|
|
|
|
|
|
case PM_POST_SUSPEND:
|
|
|
|
case PM_POST_HIBERNATION:
|
|
|
|
case PM_POST_RESTORE:
|
2012-08-20 05:04:16 -06:00
|
|
|
/*
|
|
|
|
* 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);
|
|
|
|
|
2012-08-03 22:01:29 -06:00
|
|
|
device_uncache_fw_images_delay(10 * MSEC_PER_SEC);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2012-08-20 05:04:16 -06:00
|
|
|
/* stop caching firmware once syscore_suspend is reached */
|
|
|
|
static int fw_suspend(void)
|
|
|
|
{
|
|
|
|
fw_cache.state = FW_LOADER_NO_CACHE;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
static struct syscore_ops fw_syscore_ops = {
|
|
|
|
.suspend = fw_suspend,
|
|
|
|
};
|
2012-09-08 03:32:30 -06:00
|
|
|
#else
|
|
|
|
static int fw_cache_piggyback_on_request(const char *name)
|
|
|
|
{
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
#endif
|
2012-08-20 05:04:16 -06:00
|
|
|
|
2012-08-03 22:01:27 -06:00
|
|
|
static void __init fw_cache_init(void)
|
|
|
|
{
|
|
|
|
spin_lock_init(&fw_cache.lock);
|
|
|
|
INIT_LIST_HEAD(&fw_cache.head);
|
2012-09-08 03:32:30 -06:00
|
|
|
fw_cache.state = FW_LOADER_NO_CACHE;
|
2012-08-03 22:01:27 -06:00
|
|
|
|
2012-09-08 03:32:30 -06:00
|
|
|
#ifdef CONFIG_PM_SLEEP
|
2012-08-03 22:01:27 -06:00
|
|
|
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);
|
2012-08-03 22:01:29 -06:00
|
|
|
|
|
|
|
fw_cache.pm_notify.notifier_call = fw_pm_notify;
|
|
|
|
register_pm_notifier(&fw_cache.pm_notify);
|
2012-08-20 05:04:16 -06:00
|
|
|
|
|
|
|
register_syscore_ops(&fw_syscore_ops);
|
2012-09-08 03:32:30 -06:00
|
|
|
#endif
|
2012-08-03 22:01:27 -06:00
|
|
|
}
|
|
|
|
|
2010-03-14 00:49:13 -07:00
|
|
|
static int __init firmware_class_init(void)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
2012-08-03 22:01:21 -06:00
|
|
|
fw_cache_init();
|
2010-03-14 00:49:13 -07:00
|
|
|
return class_register(&firmware_class);
|
2005-04-16 16:20:36 -06:00
|
|
|
}
|
2010-03-14 00:49:13 -07:00
|
|
|
|
|
|
|
static void __exit firmware_class_exit(void)
|
2005-04-16 16:20:36 -06:00
|
|
|
{
|
2012-09-08 03:32:30 -06:00
|
|
|
#ifdef CONFIG_PM_SLEEP
|
2012-08-20 05:04:16 -06:00
|
|
|
unregister_syscore_ops(&fw_syscore_ops);
|
2012-08-03 22:01:29 -06:00
|
|
|
unregister_pm_notifier(&fw_cache.pm_notify);
|
2012-09-08 03:32:30 -06:00
|
|
|
#endif
|
2005-04-16 16:20:36 -06:00
|
|
|
class_unregister(&firmware_class);
|
|
|
|
}
|
|
|
|
|
2006-09-27 02:50:52 -06:00
|
|
|
fs_initcall(firmware_class_init);
|
2005-04-16 16:20:36 -06:00
|
|
|
module_exit(firmware_class_exit);
|
|
|
|
|
|
|
|
EXPORT_SYMBOL(release_firmware);
|
|
|
|
EXPORT_SYMBOL(request_firmware);
|
|
|
|
EXPORT_SYMBOL(request_firmware_nowait);
|
2012-08-03 22:01:22 -06:00
|
|
|
EXPORT_SYMBOL_GPL(cache_firmware);
|
|
|
|
EXPORT_SYMBOL_GPL(uncache_firmware);
|