blob: c30df50e4440c3af5639af58dd567c37e8bf40e6 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * firmware_class.c - Multi purpose firmware loading support
3 *
Markus Rechberger87d37a42007-06-04 18:45:44 +02004 * Copyright (c) 2003 Manuel Estrada Sainz
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
6 * Please see Documentation/firmware_class/ for more information.
7 *
8 */
9
Randy.Dunlapc59ede72006-01-11 12:17:46 -080010#include <linux/capability.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/device.h>
12#include <linux/module.h>
13#include <linux/init.h>
14#include <linux/timer.h>
15#include <linux/vmalloc.h>
16#include <linux/interrupt.h>
17#include <linux/bitops.h>
Laura Garciacad1e552006-05-23 23:22:38 +020018#include <linux/mutex.h>
Stephen Boyda36cf842012-03-28 23:31:00 +020019#include <linux/workqueue.h>
David Woodhouse6e03a202009-04-09 22:04:07 -070020#include <linux/highmem.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#include <linux/firmware.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090022#include <linux/slab.h>
Stephen Boyda36cf842012-03-28 23:31:00 +020023#include <linux/sched.h>
Linus Torvaldsabb139e2012-10-03 15:58:32 -070024#include <linux/file.h>
Ming Lei1f2b7952012-08-04 12:01:21 +080025#include <linux/list.h>
Ming Lei37276a52012-08-04 12:01:27 +080026#include <linux/async.h>
27#include <linux/pm.h>
Ming Lei07646d92012-08-04 12:01:29 +080028#include <linux/suspend.h>
Ming Leiac39b3e2012-08-20 19:04:16 +080029#include <linux/syscore_ops.h>
Takashi Iwaife304142013-05-22 18:28:38 +020030#include <linux/reboot.h>
Ming Lei37276a52012-08-04 12:01:27 +080031
Linus Torvaldsabb139e2012-10-03 15:58:32 -070032#include <generated/utsrelease.h>
33
Ming Lei37276a52012-08-04 12:01:27 +080034#include "base.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Markus Rechberger87d37a42007-06-04 18:45:44 +020036MODULE_AUTHOR("Manuel Estrada Sainz");
Linus Torvalds1da177e2005-04-16 15:20:36 -070037MODULE_DESCRIPTION("Multi purpose firmware loading support");
38MODULE_LICENSE("GPL");
39
Dmitry Torokhovbcb9bd12010-03-13 23:49:18 -080040/* Builtin firmware support */
41
42#ifdef CONFIG_FW_LOADER
43
44extern struct builtin_fw __start_builtin_fw[];
45extern struct builtin_fw __end_builtin_fw[];
46
47static bool fw_get_builtin_firmware(struct firmware *fw, const char *name)
48{
49 struct builtin_fw *b_fw;
50
51 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++) {
52 if (strcmp(name, b_fw->name) == 0) {
53 fw->size = b_fw->size;
54 fw->data = b_fw->data;
55 return true;
56 }
57 }
58
59 return false;
60}
61
62static bool fw_is_builtin_firmware(const struct firmware *fw)
63{
64 struct builtin_fw *b_fw;
65
66 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++)
67 if (fw->data == b_fw->data)
68 return true;
69
70 return false;
71}
72
73#else /* Module case - no builtin firmware support */
74
75static inline bool fw_get_builtin_firmware(struct firmware *fw, const char *name)
76{
77 return false;
78}
79
80static inline bool fw_is_builtin_firmware(const struct firmware *fw)
81{
82 return false;
83}
84#endif
85
Linus Torvalds1da177e2005-04-16 15:20:36 -070086enum {
87 FW_STATUS_LOADING,
88 FW_STATUS_DONE,
89 FW_STATUS_ABORT,
Linus Torvalds1da177e2005-04-16 15:20:36 -070090};
91
Dave Jones2f651682007-01-25 15:56:15 -050092static int loading_timeout = 60; /* In seconds */
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
Rafael J. Wysocki9b78c1d2012-03-28 23:30:02 +020094static inline long firmware_loading_timeout(void)
95{
96 return loading_timeout > 0 ? loading_timeout * HZ : MAX_SCHEDULE_TIMEOUT;
97}
98
Takashi Iwai14c4bae2013-12-02 15:38:18 +010099/* firmware behavior options */
100#define FW_OPT_UEVENT (1U << 0)
101#define FW_OPT_NOWAIT (1U << 1)
Takashi Iwai68aeeaa2013-12-02 15:38:19 +0100102#ifdef CONFIG_FW_LOADER_USER_HELPER
Takashi Iwai14c4bae2013-12-02 15:38:18 +0100103#define FW_OPT_FALLBACK (1U << 2)
Takashi Iwai68aeeaa2013-12-02 15:38:19 +0100104#else
105#define FW_OPT_FALLBACK 0
106#endif
Takashi Iwai14c4bae2013-12-02 15:38:18 +0100107
Ming Lei1f2b7952012-08-04 12:01:21 +0800108struct firmware_cache {
109 /* firmware_buf instance will be added into the below list */
110 spinlock_t lock;
111 struct list_head head;
Ming Leicfe016b2012-09-08 17:32:30 +0800112 int state;
Ming Lei37276a52012-08-04 12:01:27 +0800113
Ming Leicfe016b2012-09-08 17:32:30 +0800114#ifdef CONFIG_PM_SLEEP
Ming Lei37276a52012-08-04 12:01:27 +0800115 /*
116 * Names of firmware images which have been cached successfully
117 * will be added into the below list so that device uncache
118 * helper can trace which firmware images have been cached
119 * before.
120 */
121 spinlock_t name_lock;
122 struct list_head fw_names;
123
Ming Lei37276a52012-08-04 12:01:27 +0800124 struct delayed_work work;
Ming Lei07646d92012-08-04 12:01:29 +0800125
126 struct notifier_block pm_notify;
Ming Leicfe016b2012-09-08 17:32:30 +0800127#endif
Ming Lei1f2b7952012-08-04 12:01:21 +0800128};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
Ming Lei12446912012-08-04 12:01:20 +0800130struct firmware_buf {
Ming Lei1f2b7952012-08-04 12:01:21 +0800131 struct kref ref;
132 struct list_head list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 struct completion completion;
Ming Lei1f2b7952012-08-04 12:01:21 +0800134 struct firmware_cache *fwc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 unsigned long status;
Ming Lei65710cb2012-08-04 12:01:16 +0800136 void *data;
137 size_t size;
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100138#ifdef CONFIG_FW_LOADER_USER_HELPER
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100139 bool is_paged_buf;
Ming Leiaf5bc112013-05-27 18:30:04 +0800140 bool need_uevent;
David Woodhouse6e03a202009-04-09 22:04:07 -0700141 struct page **pages;
142 int nr_pages;
143 int page_array_size;
Takashi Iwaife304142013-05-22 18:28:38 +0200144 struct list_head pending_list;
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100145#endif
Dmitry Torokhove1771232010-03-13 23:49:23 -0800146 char fw_id[];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147};
148
Ming Lei37276a52012-08-04 12:01:27 +0800149struct fw_cache_entry {
150 struct list_head list;
151 char name[];
152};
153
Ming Leif531f05a2012-08-04 12:01:25 +0800154struct fw_name_devm {
155 unsigned long magic;
156 char name[];
157};
158
Ming Lei1f2b7952012-08-04 12:01:21 +0800159#define to_fwbuf(d) container_of(d, struct firmware_buf, ref)
160
Ming Leiac39b3e2012-08-20 19:04:16 +0800161#define FW_LOADER_NO_CACHE 0
162#define FW_LOADER_START_CACHE 1
163
164static int fw_cache_piggyback_on_request(const char *name);
165
Ming Lei1f2b7952012-08-04 12:01:21 +0800166/* fw_lock could be moved to 'struct firmware_priv' but since it is just
167 * guarding for corner cases a global lock should be OK */
168static DEFINE_MUTEX(fw_lock);
169
170static struct firmware_cache fw_cache;
171
172static struct firmware_buf *__allocate_fw_buf(const char *fw_name,
173 struct firmware_cache *fwc)
174{
175 struct firmware_buf *buf;
176
177 buf = kzalloc(sizeof(*buf) + strlen(fw_name) + 1 , GFP_ATOMIC);
178
179 if (!buf)
180 return buf;
181
182 kref_init(&buf->ref);
183 strcpy(buf->fw_id, fw_name);
184 buf->fwc = fwc;
185 init_completion(&buf->completion);
Takashi Iwaife304142013-05-22 18:28:38 +0200186#ifdef CONFIG_FW_LOADER_USER_HELPER
187 INIT_LIST_HEAD(&buf->pending_list);
188#endif
Ming Lei1f2b7952012-08-04 12:01:21 +0800189
190 pr_debug("%s: fw-%s buf=%p\n", __func__, fw_name, buf);
191
192 return buf;
193}
194
Ming Lei2887b392012-08-04 12:01:22 +0800195static struct firmware_buf *__fw_lookup_buf(const char *fw_name)
196{
197 struct firmware_buf *tmp;
198 struct firmware_cache *fwc = &fw_cache;
199
200 list_for_each_entry(tmp, &fwc->head, list)
201 if (!strcmp(tmp->fw_id, fw_name))
202 return tmp;
203 return NULL;
204}
205
Ming Lei1f2b7952012-08-04 12:01:21 +0800206static int fw_lookup_and_allocate_buf(const char *fw_name,
207 struct firmware_cache *fwc,
208 struct firmware_buf **buf)
209{
210 struct firmware_buf *tmp;
211
212 spin_lock(&fwc->lock);
Ming Lei2887b392012-08-04 12:01:22 +0800213 tmp = __fw_lookup_buf(fw_name);
214 if (tmp) {
215 kref_get(&tmp->ref);
216 spin_unlock(&fwc->lock);
217 *buf = tmp;
218 return 1;
219 }
Ming Lei1f2b7952012-08-04 12:01:21 +0800220 tmp = __allocate_fw_buf(fw_name, fwc);
221 if (tmp)
222 list_add(&tmp->list, &fwc->head);
223 spin_unlock(&fwc->lock);
224
225 *buf = tmp;
226
227 return tmp ? 0 : -ENOMEM;
228}
229
230static void __fw_free_buf(struct kref *ref)
Bart Van Assche98233b22014-01-04 14:20:36 +0100231 __releases(&fwc->lock)
Ming Lei1f2b7952012-08-04 12:01:21 +0800232{
233 struct firmware_buf *buf = to_fwbuf(ref);
234 struct firmware_cache *fwc = buf->fwc;
Ming Lei1f2b7952012-08-04 12:01:21 +0800235
236 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
237 __func__, buf->fw_id, buf, buf->data,
238 (unsigned int)buf->size);
239
Ming Lei1f2b7952012-08-04 12:01:21 +0800240 list_del(&buf->list);
241 spin_unlock(&fwc->lock);
242
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100243#ifdef CONFIG_FW_LOADER_USER_HELPER
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100244 if (buf->is_paged_buf) {
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100245 int i;
Ming Lei746058f2012-10-09 12:01:03 +0800246 vunmap(buf->data);
247 for (i = 0; i < buf->nr_pages; i++)
248 __free_page(buf->pages[i]);
249 kfree(buf->pages);
250 } else
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100251#endif
Ming Lei746058f2012-10-09 12:01:03 +0800252 vfree(buf->data);
Ming Lei1f2b7952012-08-04 12:01:21 +0800253 kfree(buf);
254}
255
256static void fw_free_buf(struct firmware_buf *buf)
257{
Chuansheng Liubd9eb7f2012-11-10 01:27:22 +0800258 struct firmware_cache *fwc = buf->fwc;
259 spin_lock(&fwc->lock);
260 if (!kref_put(&buf->ref, __fw_free_buf))
261 spin_unlock(&fwc->lock);
Ming Lei1f2b7952012-08-04 12:01:21 +0800262}
263
Ming Lei746058f2012-10-09 12:01:03 +0800264/* direct firmware loading support */
Ming Lei27602842012-11-03 17:47:58 +0800265static char fw_path_para[256];
266static const char * const fw_path[] = {
267 fw_path_para,
Ming Lei746058f2012-10-09 12:01:03 +0800268 "/lib/firmware/updates/" UTS_RELEASE,
269 "/lib/firmware/updates",
270 "/lib/firmware/" UTS_RELEASE,
271 "/lib/firmware"
272};
273
Ming Lei27602842012-11-03 17:47:58 +0800274/*
275 * Typical usage is that passing 'firmware_class.path=$CUSTOMIZED_PATH'
276 * from kernel command line because firmware_class is generally built in
277 * kernel instead of module.
278 */
279module_param_string(path, fw_path_para, sizeof(fw_path_para), 0644);
280MODULE_PARM_DESC(path, "customized firmware image search path with a higher priority than default path");
281
Ming Lei746058f2012-10-09 12:01:03 +0800282/* Don't inline this: 'struct kstat' is biggish */
Ben Hutchings08da2012013-12-28 16:53:59 +0100283static noinline_for_stack int fw_file_size(struct file *file)
Ming Lei746058f2012-10-09 12:01:03 +0800284{
285 struct kstat st;
Al Viro3dadecc2013-01-24 02:18:08 -0500286 if (vfs_getattr(&file->f_path, &st))
Ming Lei746058f2012-10-09 12:01:03 +0800287 return -1;
288 if (!S_ISREG(st.mode))
289 return -1;
Ben Hutchings08da2012013-12-28 16:53:59 +0100290 if (st.size != (int)st.size)
Ming Lei746058f2012-10-09 12:01:03 +0800291 return -1;
292 return st.size;
293}
294
Neil Horman3e358ac2013-09-06 15:36:08 -0400295static int fw_read_file_contents(struct file *file, struct firmware_buf *fw_buf)
Ming Lei746058f2012-10-09 12:01:03 +0800296{
Ben Hutchings08da2012013-12-28 16:53:59 +0100297 int size;
Ming Lei746058f2012-10-09 12:01:03 +0800298 char *buf;
Neil Horman3e358ac2013-09-06 15:36:08 -0400299 int rc;
Ming Lei746058f2012-10-09 12:01:03 +0800300
301 size = fw_file_size(file);
Luciano Coelho4adf07f2013-01-15 10:43:43 +0200302 if (size <= 0)
Neil Horman3e358ac2013-09-06 15:36:08 -0400303 return -EINVAL;
Ming Lei746058f2012-10-09 12:01:03 +0800304 buf = vmalloc(size);
305 if (!buf)
Neil Horman3e358ac2013-09-06 15:36:08 -0400306 return -ENOMEM;
307 rc = kernel_read(file, 0, buf, size);
308 if (rc != size) {
309 if (rc > 0)
310 rc = -EIO;
Ming Lei746058f2012-10-09 12:01:03 +0800311 vfree(buf);
Neil Horman3e358ac2013-09-06 15:36:08 -0400312 return rc;
Ming Lei746058f2012-10-09 12:01:03 +0800313 }
314 fw_buf->data = buf;
315 fw_buf->size = size;
Neil Horman3e358ac2013-09-06 15:36:08 -0400316 return 0;
Ming Lei746058f2012-10-09 12:01:03 +0800317}
318
Neil Horman3e358ac2013-09-06 15:36:08 -0400319static int fw_get_filesystem_firmware(struct device *device,
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100320 struct firmware_buf *buf)
Ming Lei746058f2012-10-09 12:01:03 +0800321{
322 int i;
Neil Horman3e358ac2013-09-06 15:36:08 -0400323 int rc = -ENOENT;
Ming Lei746058f2012-10-09 12:01:03 +0800324 char *path = __getname();
325
326 for (i = 0; i < ARRAY_SIZE(fw_path); i++) {
327 struct file *file;
Ming Lei27602842012-11-03 17:47:58 +0800328
329 /* skip the unset customized path */
330 if (!fw_path[i][0])
331 continue;
332
Ming Lei746058f2012-10-09 12:01:03 +0800333 snprintf(path, PATH_MAX, "%s/%s", fw_path[i], buf->fw_id);
334
335 file = filp_open(path, O_RDONLY, 0);
336 if (IS_ERR(file))
337 continue;
Neil Horman3e358ac2013-09-06 15:36:08 -0400338 rc = fw_read_file_contents(file, buf);
Ming Lei746058f2012-10-09 12:01:03 +0800339 fput(file);
Neil Horman3e358ac2013-09-06 15:36:08 -0400340 if (rc)
341 dev_warn(device, "firmware, attempted to load %s, but failed with error %d\n",
342 path, rc);
343 else
Ming Lei746058f2012-10-09 12:01:03 +0800344 break;
345 }
346 __putname(path);
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100347
Neil Horman3e358ac2013-09-06 15:36:08 -0400348 if (!rc) {
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100349 dev_dbg(device, "firmware: direct-loading firmware %s\n",
350 buf->fw_id);
351 mutex_lock(&fw_lock);
352 set_bit(FW_STATUS_DONE, &buf->status);
353 complete_all(&buf->completion);
354 mutex_unlock(&fw_lock);
355 }
356
Neil Horman3e358ac2013-09-06 15:36:08 -0400357 return rc;
Ming Lei746058f2012-10-09 12:01:03 +0800358}
359
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100360/* firmware holds the ownership of pages */
361static void firmware_free_data(const struct firmware *fw)
362{
363 /* Loaded directly? */
364 if (!fw->priv) {
365 vfree(fw->data);
366 return;
367 }
368 fw_free_buf(fw->priv);
369}
370
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100371/* store the pages buffer info firmware from buf */
372static void fw_set_page_data(struct firmware_buf *buf, struct firmware *fw)
373{
374 fw->priv = buf;
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100375#ifdef CONFIG_FW_LOADER_USER_HELPER
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100376 fw->pages = buf->pages;
377#endif
378 fw->size = buf->size;
379 fw->data = buf->data;
380
381 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
382 __func__, buf->fw_id, buf, buf->data,
383 (unsigned int)buf->size);
384}
385
386#ifdef CONFIG_PM_SLEEP
387static void fw_name_devm_release(struct device *dev, void *res)
388{
389 struct fw_name_devm *fwn = res;
390
391 if (fwn->magic == (unsigned long)&fw_cache)
392 pr_debug("%s: fw_name-%s devm-%p released\n",
393 __func__, fwn->name, res);
394}
395
396static int fw_devm_match(struct device *dev, void *res,
397 void *match_data)
398{
399 struct fw_name_devm *fwn = res;
400
401 return (fwn->magic == (unsigned long)&fw_cache) &&
402 !strcmp(fwn->name, match_data);
403}
404
405static struct fw_name_devm *fw_find_devm_name(struct device *dev,
406 const char *name)
407{
408 struct fw_name_devm *fwn;
409
410 fwn = devres_find(dev, fw_name_devm_release,
411 fw_devm_match, (void *)name);
412 return fwn;
413}
414
415/* add firmware name into devres list */
416static int fw_add_devm_name(struct device *dev, const char *name)
417{
418 struct fw_name_devm *fwn;
419
420 fwn = fw_find_devm_name(dev, name);
421 if (fwn)
422 return 1;
423
424 fwn = devres_alloc(fw_name_devm_release, sizeof(struct fw_name_devm) +
425 strlen(name) + 1, GFP_KERNEL);
426 if (!fwn)
427 return -ENOMEM;
428
429 fwn->magic = (unsigned long)&fw_cache;
430 strcpy(fwn->name, name);
431 devres_add(dev, fwn);
432
433 return 0;
434}
435#else
436static int fw_add_devm_name(struct device *dev, const char *name)
437{
438 return 0;
439}
440#endif
441
442
443/*
444 * user-mode helper code
445 */
446#ifdef CONFIG_FW_LOADER_USER_HELPER
447struct firmware_priv {
448 struct delayed_work timeout_work;
449 bool nowait;
450 struct device dev;
451 struct firmware_buf *buf;
452 struct firmware *fw;
453};
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100454
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700455static struct firmware_priv *to_firmware_priv(struct device *dev)
456{
457 return container_of(dev, struct firmware_priv, dev);
458}
459
Greg Kroah-Hartman7068cb02013-06-19 20:26:43 -0700460static void __fw_load_abort(struct firmware_buf *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461{
Ming Lei87597932013-06-15 16:36:38 +0800462 /*
463 * There is a small window in which user can write to 'loading'
464 * between loading done and disappearance of 'loading'
465 */
466 if (test_bit(FW_STATUS_DONE, &buf->status))
467 return;
468
Takashi Iwaife304142013-05-22 18:28:38 +0200469 list_del_init(&buf->pending_list);
Ming Lei12446912012-08-04 12:01:20 +0800470 set_bit(FW_STATUS_ABORT, &buf->status);
Ming Lei1f2b7952012-08-04 12:01:21 +0800471 complete_all(&buf->completion);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472}
473
Greg Kroah-Hartman7068cb02013-06-19 20:26:43 -0700474static void fw_load_abort(struct firmware_priv *fw_priv)
475{
476 struct firmware_buf *buf = fw_priv->buf;
477
478 __fw_load_abort(buf);
Ming Lei87597932013-06-15 16:36:38 +0800479
480 /* avoid user action after loading abort */
481 fw_priv->buf = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482}
483
Takashi Iwai807be032013-01-31 11:13:57 +0100484#define is_fw_load_aborted(buf) \
485 test_bit(FW_STATUS_ABORT, &(buf)->status)
486
Takashi Iwaife304142013-05-22 18:28:38 +0200487static LIST_HEAD(pending_fw_head);
488
489/* reboot notifier for avoid deadlock with usermode_lock */
490static int fw_shutdown_notify(struct notifier_block *unused1,
491 unsigned long unused2, void *unused3)
492{
493 mutex_lock(&fw_lock);
494 while (!list_empty(&pending_fw_head))
Greg Kroah-Hartman7068cb02013-06-19 20:26:43 -0700495 __fw_load_abort(list_first_entry(&pending_fw_head,
Takashi Iwaife304142013-05-22 18:28:38 +0200496 struct firmware_buf,
497 pending_list));
498 mutex_unlock(&fw_lock);
499 return NOTIFY_DONE;
500}
501
502static struct notifier_block fw_shutdown_nb = {
503 .notifier_call = fw_shutdown_notify,
504};
505
Greg Kroah-Hartman14adbe52013-08-23 17:08:48 -0700506static ssize_t timeout_show(struct class *class, struct class_attribute *attr,
507 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508{
509 return sprintf(buf, "%d\n", loading_timeout);
510}
511
512/**
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800513 * firmware_timeout_store - set number of seconds to wait for firmware
514 * @class: device class pointer
Randy Dunlape59817b2010-03-10 11:47:58 -0800515 * @attr: device attribute pointer
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800516 * @buf: buffer to scan for timeout value
517 * @count: number of bytes in @buf
518 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 * Sets the number of seconds to wait for the firmware. Once
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800520 * this expires an error will be returned to the driver and no
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 * firmware will be provided.
522 *
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800523 * Note: zero means 'wait forever'.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 **/
Greg Kroah-Hartman14adbe52013-08-23 17:08:48 -0700525static ssize_t timeout_store(struct class *class, struct class_attribute *attr,
526 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527{
528 loading_timeout = simple_strtol(buf, NULL, 10);
Stanislaw W. Gruszkab92eac02005-06-28 20:44:51 -0700529 if (loading_timeout < 0)
530 loading_timeout = 0;
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700531
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 return count;
533}
534
Dmitry Torokhov673fae92010-03-13 23:49:13 -0800535static struct class_attribute firmware_class_attrs[] = {
Greg Kroah-Hartman14adbe52013-08-23 17:08:48 -0700536 __ATTR_RW(timeout),
Dmitry Torokhov673fae92010-03-13 23:49:13 -0800537 __ATTR_NULL
538};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539
Dmitry Torokhov673fae92010-03-13 23:49:13 -0800540static void fw_dev_release(struct device *dev)
541{
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700542 struct firmware_priv *fw_priv = to_firmware_priv(dev);
Ming Lei65710cb2012-08-04 12:01:16 +0800543
Dmitry Torokhov673fae92010-03-13 23:49:13 -0800544 kfree(fw_priv);
Dmitry Torokhov673fae92010-03-13 23:49:13 -0800545}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546
Kay Sievers7eff2e72007-08-14 15:15:12 +0200547static int firmware_uevent(struct device *dev, struct kobj_uevent_env *env)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548{
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700549 struct firmware_priv *fw_priv = to_firmware_priv(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550
Ming Lei12446912012-08-04 12:01:20 +0800551 if (add_uevent_var(env, "FIRMWARE=%s", fw_priv->buf->fw_id))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 return -ENOMEM;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200553 if (add_uevent_var(env, "TIMEOUT=%i", loading_timeout))
kay.sievers@vrfy.org68970892005-04-18 21:57:31 -0700554 return -ENOMEM;
Johannes Berge9045f92010-03-29 17:57:20 +0200555 if (add_uevent_var(env, "ASYNC=%d", fw_priv->nowait))
556 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557
558 return 0;
559}
560
Adrian Bunk1b81d662006-05-20 15:00:16 -0700561static struct class firmware_class = {
562 .name = "firmware",
Dmitry Torokhov673fae92010-03-13 23:49:13 -0800563 .class_attrs = firmware_class_attrs,
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700564 .dev_uevent = firmware_uevent,
565 .dev_release = fw_dev_release,
Adrian Bunk1b81d662006-05-20 15:00:16 -0700566};
567
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700568static ssize_t firmware_loading_show(struct device *dev,
569 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570{
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700571 struct firmware_priv *fw_priv = to_firmware_priv(dev);
Ming Lei87597932013-06-15 16:36:38 +0800572 int loading = 0;
573
574 mutex_lock(&fw_lock);
575 if (fw_priv->buf)
576 loading = test_bit(FW_STATUS_LOADING, &fw_priv->buf->status);
577 mutex_unlock(&fw_lock);
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700578
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 return sprintf(buf, "%d\n", loading);
580}
581
David Woodhouse6e03a202009-04-09 22:04:07 -0700582/* Some architectures don't have PAGE_KERNEL_RO */
583#ifndef PAGE_KERNEL_RO
584#define PAGE_KERNEL_RO PAGE_KERNEL
585#endif
Ming Lei253c9242012-10-09 12:01:02 +0800586
587/* one pages buffer should be mapped/unmapped only once */
588static int fw_map_pages_buf(struct firmware_buf *buf)
589{
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100590 if (!buf->is_paged_buf)
Ming Lei746058f2012-10-09 12:01:03 +0800591 return 0;
592
Ming Lei253c9242012-10-09 12:01:02 +0800593 if (buf->data)
594 vunmap(buf->data);
595 buf->data = vmap(buf->pages, buf->nr_pages, 0, PAGE_KERNEL_RO);
596 if (!buf->data)
597 return -ENOMEM;
598 return 0;
599}
600
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601/**
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800602 * firmware_loading_store - set value in the 'loading' control file
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700603 * @dev: device pointer
Randy Dunlapaf9997e2006-12-22 01:06:52 -0800604 * @attr: device attribute pointer
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800605 * @buf: buffer to scan for loading control value
606 * @count: number of bytes in @buf
607 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 * The relevant values are:
609 *
610 * 1: Start a load, discarding any previous partial load.
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800611 * 0: Conclude the load and hand the data to the driver code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 * -1: Conclude the load with an error and discard any written data.
613 **/
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700614static ssize_t firmware_loading_store(struct device *dev,
615 struct device_attribute *attr,
616 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617{
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700618 struct firmware_priv *fw_priv = to_firmware_priv(dev);
Ming Lei87597932013-06-15 16:36:38 +0800619 struct firmware_buf *fw_buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 int loading = simple_strtol(buf, NULL, 10);
David Woodhouse6e03a202009-04-09 22:04:07 -0700621 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622
Neil Hormaneea915b2012-01-02 15:31:23 -0500623 mutex_lock(&fw_lock);
Ming Lei87597932013-06-15 16:36:38 +0800624 fw_buf = fw_priv->buf;
Ming Lei12446912012-08-04 12:01:20 +0800625 if (!fw_buf)
Neil Hormaneea915b2012-01-02 15:31:23 -0500626 goto out;
627
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 switch (loading) {
629 case 1:
Ming Lei65710cb2012-08-04 12:01:16 +0800630 /* discarding any previous partial load */
Ming Lei12446912012-08-04 12:01:20 +0800631 if (!test_bit(FW_STATUS_DONE, &fw_buf->status)) {
632 for (i = 0; i < fw_buf->nr_pages; i++)
633 __free_page(fw_buf->pages[i]);
634 kfree(fw_buf->pages);
635 fw_buf->pages = NULL;
636 fw_buf->page_array_size = 0;
637 fw_buf->nr_pages = 0;
638 set_bit(FW_STATUS_LOADING, &fw_buf->status);
Ming Lei28eefa72012-08-04 12:01:17 +0800639 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 break;
641 case 0:
Ming Lei12446912012-08-04 12:01:20 +0800642 if (test_bit(FW_STATUS_LOADING, &fw_buf->status)) {
643 set_bit(FW_STATUS_DONE, &fw_buf->status);
644 clear_bit(FW_STATUS_LOADING, &fw_buf->status);
Ming Lei253c9242012-10-09 12:01:02 +0800645
646 /*
647 * Several loading requests may be pending on
648 * one same firmware buf, so let all requests
649 * see the mapped 'buf->data' once the loading
650 * is completed.
651 * */
652 fw_map_pages_buf(fw_buf);
Takashi Iwaife304142013-05-22 18:28:38 +0200653 list_del_init(&fw_buf->pending_list);
Ming Lei1f2b7952012-08-04 12:01:21 +0800654 complete_all(&fw_buf->completion);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 break;
656 }
657 /* fallthrough */
658 default:
Bjorn Helgaas266a8132008-10-15 22:04:20 -0700659 dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 /* fallthrough */
661 case -1:
662 fw_load_abort(fw_priv);
663 break;
664 }
Neil Hormaneea915b2012-01-02 15:31:23 -0500665out:
666 mutex_unlock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 return count;
668}
669
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700670static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700672static ssize_t firmware_data_read(struct file *filp, struct kobject *kobj,
673 struct bin_attribute *bin_attr,
674 char *buffer, loff_t offset, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200676 struct device *dev = kobj_to_dev(kobj);
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700677 struct firmware_priv *fw_priv = to_firmware_priv(dev);
Ming Lei12446912012-08-04 12:01:20 +0800678 struct firmware_buf *buf;
Akinobu Mitaf37e6612008-07-25 01:48:23 -0700679 ssize_t ret_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680
Laura Garciacad1e552006-05-23 23:22:38 +0200681 mutex_lock(&fw_lock);
Ming Lei12446912012-08-04 12:01:20 +0800682 buf = fw_priv->buf;
683 if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 ret_count = -ENODEV;
685 goto out;
686 }
Ming Lei12446912012-08-04 12:01:20 +0800687 if (offset > buf->size) {
Jiri Slaby308975f2009-06-21 23:57:31 +0200688 ret_count = 0;
689 goto out;
690 }
Ming Lei12446912012-08-04 12:01:20 +0800691 if (count > buf->size - offset)
692 count = buf->size - offset;
David Woodhouse6e03a202009-04-09 22:04:07 -0700693
694 ret_count = count;
695
696 while (count) {
697 void *page_data;
698 int page_nr = offset >> PAGE_SHIFT;
699 int page_ofs = offset & (PAGE_SIZE-1);
700 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
701
Ming Lei12446912012-08-04 12:01:20 +0800702 page_data = kmap(buf->pages[page_nr]);
David Woodhouse6e03a202009-04-09 22:04:07 -0700703
704 memcpy(buffer, page_data + page_ofs, page_cnt);
705
Ming Lei12446912012-08-04 12:01:20 +0800706 kunmap(buf->pages[page_nr]);
David Woodhouse6e03a202009-04-09 22:04:07 -0700707 buffer += page_cnt;
708 offset += page_cnt;
709 count -= page_cnt;
710 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711out:
Laura Garciacad1e552006-05-23 23:22:38 +0200712 mutex_unlock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 return ret_count;
714}
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800715
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700716static int fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717{
Ming Lei12446912012-08-04 12:01:20 +0800718 struct firmware_buf *buf = fw_priv->buf;
David Woodhouse6e03a202009-04-09 22:04:07 -0700719 int pages_needed = ALIGN(min_size, PAGE_SIZE) >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720
David Woodhouse6e03a202009-04-09 22:04:07 -0700721 /* If the array of pages is too small, grow it... */
Ming Lei12446912012-08-04 12:01:20 +0800722 if (buf->page_array_size < pages_needed) {
David Woodhouse6e03a202009-04-09 22:04:07 -0700723 int new_array_size = max(pages_needed,
Ming Lei12446912012-08-04 12:01:20 +0800724 buf->page_array_size * 2);
David Woodhouse6e03a202009-04-09 22:04:07 -0700725 struct page **new_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
David Woodhouse6e03a202009-04-09 22:04:07 -0700727 new_pages = kmalloc(new_array_size * sizeof(void *),
728 GFP_KERNEL);
729 if (!new_pages) {
730 fw_load_abort(fw_priv);
731 return -ENOMEM;
732 }
Ming Lei12446912012-08-04 12:01:20 +0800733 memcpy(new_pages, buf->pages,
734 buf->page_array_size * sizeof(void *));
735 memset(&new_pages[buf->page_array_size], 0, sizeof(void *) *
736 (new_array_size - buf->page_array_size));
737 kfree(buf->pages);
738 buf->pages = new_pages;
739 buf->page_array_size = new_array_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 }
David Woodhouse6e03a202009-04-09 22:04:07 -0700741
Ming Lei12446912012-08-04 12:01:20 +0800742 while (buf->nr_pages < pages_needed) {
743 buf->pages[buf->nr_pages] =
David Woodhouse6e03a202009-04-09 22:04:07 -0700744 alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
745
Ming Lei12446912012-08-04 12:01:20 +0800746 if (!buf->pages[buf->nr_pages]) {
David Woodhouse6e03a202009-04-09 22:04:07 -0700747 fw_load_abort(fw_priv);
748 return -ENOMEM;
749 }
Ming Lei12446912012-08-04 12:01:20 +0800750 buf->nr_pages++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 return 0;
753}
754
755/**
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800756 * firmware_data_write - write method for firmware
Chris Wright2c3c8be2010-05-12 18:28:57 -0700757 * @filp: open sysfs file
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700758 * @kobj: kobject for the device
Randy Dunlap42e61f42007-07-23 21:42:11 -0700759 * @bin_attr: bin_attr structure
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800760 * @buffer: buffer being written
761 * @offset: buffer offset for write in total data store area
762 * @count: buffer size
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 *
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800764 * Data written to the 'data' attribute will be later handed to
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 * the driver as a firmware image.
766 **/
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700767static ssize_t firmware_data_write(struct file *filp, struct kobject *kobj,
768 struct bin_attribute *bin_attr,
769 char *buffer, loff_t offset, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200771 struct device *dev = kobj_to_dev(kobj);
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700772 struct firmware_priv *fw_priv = to_firmware_priv(dev);
Ming Lei12446912012-08-04 12:01:20 +0800773 struct firmware_buf *buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 ssize_t retval;
775
776 if (!capable(CAP_SYS_RAWIO))
777 return -EPERM;
Stanislaw W. Gruszkab92eac02005-06-28 20:44:51 -0700778
Laura Garciacad1e552006-05-23 23:22:38 +0200779 mutex_lock(&fw_lock);
Ming Lei12446912012-08-04 12:01:20 +0800780 buf = fw_priv->buf;
781 if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 retval = -ENODEV;
783 goto out;
784 }
Ming Lei65710cb2012-08-04 12:01:16 +0800785
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 retval = fw_realloc_buffer(fw_priv, offset + count);
787 if (retval)
788 goto out;
789
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 retval = count;
David Woodhouse6e03a202009-04-09 22:04:07 -0700791
792 while (count) {
793 void *page_data;
794 int page_nr = offset >> PAGE_SHIFT;
795 int page_ofs = offset & (PAGE_SIZE - 1);
796 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
797
Ming Lei12446912012-08-04 12:01:20 +0800798 page_data = kmap(buf->pages[page_nr]);
David Woodhouse6e03a202009-04-09 22:04:07 -0700799
800 memcpy(page_data + page_ofs, buffer, page_cnt);
801
Ming Lei12446912012-08-04 12:01:20 +0800802 kunmap(buf->pages[page_nr]);
David Woodhouse6e03a202009-04-09 22:04:07 -0700803 buffer += page_cnt;
804 offset += page_cnt;
805 count -= page_cnt;
806 }
807
Ming Lei12446912012-08-04 12:01:20 +0800808 buf->size = max_t(size_t, offset, buf->size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809out:
Laura Garciacad1e552006-05-23 23:22:38 +0200810 mutex_unlock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 return retval;
812}
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800813
Dmitry Torokhov0983ca22010-06-04 00:54:37 -0700814static struct bin_attribute firmware_attr_data = {
815 .attr = { .name = "data", .mode = 0644 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 .size = 0,
817 .read = firmware_data_read,
818 .write = firmware_data_write,
819};
820
Chuansheng Liuce2fcbd2012-11-08 19:14:40 +0800821static void firmware_class_timeout_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822{
Chuansheng Liuce2fcbd2012-11-08 19:14:40 +0800823 struct firmware_priv *fw_priv = container_of(work,
824 struct firmware_priv, timeout_work.work);
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700825
Chuansheng Liuce2fcbd2012-11-08 19:14:40 +0800826 mutex_lock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 fw_load_abort(fw_priv);
Chuansheng Liuce2fcbd2012-11-08 19:14:40 +0800828 mutex_unlock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829}
830
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700831static struct firmware_priv *
Stephen Boyddddb5542012-03-28 23:30:43 +0200832fw_create_instance(struct firmware *firmware, const char *fw_name,
Takashi Iwai14c4bae2013-12-02 15:38:18 +0100833 struct device *device, unsigned int opt_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834{
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700835 struct firmware_priv *fw_priv;
836 struct device *f_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837
Ming Lei12446912012-08-04 12:01:20 +0800838 fw_priv = kzalloc(sizeof(*fw_priv), GFP_KERNEL);
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700839 if (!fw_priv) {
Bjorn Helgaas266a8132008-10-15 22:04:20 -0700840 dev_err(device, "%s: kmalloc failed\n", __func__);
Ming Lei12446912012-08-04 12:01:20 +0800841 fw_priv = ERR_PTR(-ENOMEM);
842 goto exit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844
Takashi Iwai14c4bae2013-12-02 15:38:18 +0100845 fw_priv->nowait = !!(opt_flags & FW_OPT_NOWAIT);
Ming Lei1f2b7952012-08-04 12:01:21 +0800846 fw_priv->fw = firmware;
Chuansheng Liuce2fcbd2012-11-08 19:14:40 +0800847 INIT_DELAYED_WORK(&fw_priv->timeout_work,
848 firmware_class_timeout_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700850 f_dev = &fw_priv->dev;
851
852 device_initialize(f_dev);
Ming Lei99c2aa72012-08-04 12:01:19 +0800853 dev_set_name(f_dev, "%s", fw_name);
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700854 f_dev->parent = device;
855 f_dev->class = &firmware_class;
Ming Lei12446912012-08-04 12:01:20 +0800856exit:
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700857 return fw_priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858}
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100859
860/* load a firmware via user helper */
Takashi Iwai14c4bae2013-12-02 15:38:18 +0100861static int _request_firmware_load(struct firmware_priv *fw_priv,
862 unsigned int opt_flags, long timeout)
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100863{
864 int retval = 0;
865 struct device *f_dev = &fw_priv->dev;
866 struct firmware_buf *buf = fw_priv->buf;
867
868 /* fall back on userspace loading */
869 buf->is_paged_buf = true;
870
871 dev_set_uevent_suppress(f_dev, true);
872
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100873 retval = device_add(f_dev);
874 if (retval) {
875 dev_err(f_dev, "%s: device_register failed\n", __func__);
876 goto err_put_dev;
877 }
878
879 retval = device_create_bin_file(f_dev, &firmware_attr_data);
880 if (retval) {
881 dev_err(f_dev, "%s: sysfs_create_bin_file failed\n", __func__);
882 goto err_del_dev;
883 }
884
Maxime Bizon1eeeef12013-08-29 20:28:13 +0200885 mutex_lock(&fw_lock);
886 list_add(&buf->pending_list, &pending_fw_head);
887 mutex_unlock(&fw_lock);
888
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100889 retval = device_create_file(f_dev, &dev_attr_loading);
890 if (retval) {
Maxime Bizon1eeeef12013-08-29 20:28:13 +0200891 mutex_lock(&fw_lock);
892 list_del_init(&buf->pending_list);
893 mutex_unlock(&fw_lock);
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100894 dev_err(f_dev, "%s: device_create_file failed\n", __func__);
895 goto err_del_bin_attr;
896 }
897
Takashi Iwai14c4bae2013-12-02 15:38:18 +0100898 if (opt_flags & FW_OPT_UEVENT) {
Ming Leiaf5bc112013-05-27 18:30:04 +0800899 buf->need_uevent = true;
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100900 dev_set_uevent_suppress(f_dev, false);
901 dev_dbg(f_dev, "firmware: requesting %s\n", buf->fw_id);
902 if (timeout != MAX_SCHEDULE_TIMEOUT)
903 schedule_delayed_work(&fw_priv->timeout_work, timeout);
904
905 kobject_uevent(&fw_priv->dev.kobj, KOBJ_ADD);
906 }
907
908 wait_for_completion(&buf->completion);
909
910 cancel_delayed_work_sync(&fw_priv->timeout_work);
911
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100912 device_remove_file(f_dev, &dev_attr_loading);
913err_del_bin_attr:
914 device_remove_bin_file(f_dev, &firmware_attr_data);
915err_del_dev:
916 device_del(f_dev);
917err_put_dev:
918 put_device(f_dev);
919 return retval;
920}
921
922static int fw_load_from_user_helper(struct firmware *firmware,
923 const char *name, struct device *device,
Takashi Iwai14c4bae2013-12-02 15:38:18 +0100924 unsigned int opt_flags, long timeout)
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100925{
926 struct firmware_priv *fw_priv;
927
Takashi Iwai14c4bae2013-12-02 15:38:18 +0100928 fw_priv = fw_create_instance(firmware, name, device, opt_flags);
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100929 if (IS_ERR(fw_priv))
930 return PTR_ERR(fw_priv);
931
932 fw_priv->buf = firmware->priv;
Takashi Iwai14c4bae2013-12-02 15:38:18 +0100933 return _request_firmware_load(fw_priv, opt_flags, timeout);
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100934}
Ming Leiddf1f062013-06-04 10:01:13 +0800935
Ming Lei5b7cb7a2013-06-06 19:52:54 +0800936#ifdef CONFIG_PM_SLEEP
Ming Leiddf1f062013-06-04 10:01:13 +0800937/* kill pending requests without uevent to avoid blocking suspend */
938static void kill_requests_without_uevent(void)
939{
940 struct firmware_buf *buf;
941 struct firmware_buf *next;
942
943 mutex_lock(&fw_lock);
944 list_for_each_entry_safe(buf, next, &pending_fw_head, pending_list) {
945 if (!buf->need_uevent)
Greg Kroah-Hartman7068cb02013-06-19 20:26:43 -0700946 __fw_load_abort(buf);
Ming Leiddf1f062013-06-04 10:01:13 +0800947 }
948 mutex_unlock(&fw_lock);
949}
Ming Lei5b7cb7a2013-06-06 19:52:54 +0800950#endif
Ming Leiddf1f062013-06-04 10:01:13 +0800951
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100952#else /* CONFIG_FW_LOADER_USER_HELPER */
953static inline int
954fw_load_from_user_helper(struct firmware *firmware, const char *name,
Takashi Iwai14c4bae2013-12-02 15:38:18 +0100955 struct device *device, unsigned int opt_flags,
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100956 long timeout)
957{
958 return -ENOENT;
959}
Takashi Iwai807be032013-01-31 11:13:57 +0100960
961/* No abort during direct loading */
962#define is_fw_load_aborted(buf) false
963
Ming Lei5b7cb7a2013-06-06 19:52:54 +0800964#ifdef CONFIG_PM_SLEEP
Ming Leiddf1f062013-06-04 10:01:13 +0800965static inline void kill_requests_without_uevent(void) { }
Ming Lei5b7cb7a2013-06-06 19:52:54 +0800966#endif
Ming Leiddf1f062013-06-04 10:01:13 +0800967
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100968#endif /* CONFIG_FW_LOADER_USER_HELPER */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969
Ming Leif531f05a2012-08-04 12:01:25 +0800970
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100971/* wait until the shared firmware_buf becomes ready (or error) */
972static int sync_cached_firmware_buf(struct firmware_buf *buf)
Ming Lei1f2b7952012-08-04 12:01:21 +0800973{
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100974 int ret = 0;
975
976 mutex_lock(&fw_lock);
977 while (!test_bit(FW_STATUS_DONE, &buf->status)) {
Takashi Iwai807be032013-01-31 11:13:57 +0100978 if (is_fw_load_aborted(buf)) {
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100979 ret = -ENOENT;
980 break;
981 }
982 mutex_unlock(&fw_lock);
983 wait_for_completion(&buf->completion);
984 mutex_lock(&fw_lock);
985 }
986 mutex_unlock(&fw_lock);
987 return ret;
Ming Lei1f2b7952012-08-04 12:01:21 +0800988}
989
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100990/* prepare firmware and firmware_buf structs;
991 * return 0 if a firmware is already assigned, 1 if need to load one,
992 * or a negative error code
993 */
994static int
995_request_firmware_prepare(struct firmware **firmware_p, const char *name,
996 struct device *device)
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700997{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998 struct firmware *firmware;
Ming Lei1f2b7952012-08-04 12:01:21 +0800999 struct firmware_buf *buf;
1000 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001
Jiri Slaby4aed0642005-09-13 01:25:01 -07001002 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 if (!firmware) {
Bjorn Helgaas266a8132008-10-15 22:04:20 -07001004 dev_err(device, "%s: kmalloc(struct firmware) failed\n",
1005 __func__);
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001006 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008
Dmitry Torokhovbcb9bd12010-03-13 23:49:18 -08001009 if (fw_get_builtin_firmware(firmware, name)) {
Rafael J. Wysocki6f18ff92010-02-27 21:43:22 +01001010 dev_dbg(device, "firmware: using built-in firmware %s\n", name);
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001011 return 0; /* assigned */
David Woodhouse5658c762008-05-23 13:52:42 +01001012 }
1013
Ming Lei1f2b7952012-08-04 12:01:21 +08001014 ret = fw_lookup_and_allocate_buf(name, &fw_cache, &buf);
Ming Lei1f2b7952012-08-04 12:01:21 +08001015
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001016 /*
1017 * bind with 'buf' now to avoid warning in failure path
1018 * of requesting firmware.
1019 */
1020 firmware->priv = buf;
Ming Lei1f2b7952012-08-04 12:01:21 +08001021
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001022 if (ret > 0) {
1023 ret = sync_cached_firmware_buf(buf);
1024 if (!ret) {
1025 fw_set_page_data(buf, firmware);
1026 return 0; /* assigned */
1027 }
Stephen Boyddddb5542012-03-28 23:30:43 +02001028 }
Ming Lei1f2b7952012-08-04 12:01:21 +08001029
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001030 if (ret < 0)
1031 return ret;
1032 return 1; /* need to load */
Rafael J. Wysocki811fa402012-03-28 23:29:55 +02001033}
1034
Ming Leie771d1a2013-05-27 18:30:03 +08001035static int assign_firmware_buf(struct firmware *fw, struct device *device,
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001036 unsigned int opt_flags)
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001037{
1038 struct firmware_buf *buf = fw->priv;
1039
1040 mutex_lock(&fw_lock);
Takashi Iwai807be032013-01-31 11:13:57 +01001041 if (!buf->size || is_fw_load_aborted(buf)) {
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001042 mutex_unlock(&fw_lock);
1043 return -ENOENT;
1044 }
1045
1046 /*
1047 * add firmware name into devres list so that we can auto cache
1048 * and uncache firmware for device.
1049 *
1050 * device may has been deleted already, but the problem
1051 * should be fixed in devres or driver core.
1052 */
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001053 /* don't cache firmware handled without uevent */
1054 if (device && (opt_flags & FW_OPT_UEVENT))
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001055 fw_add_devm_name(device, buf->fw_id);
1056
1057 /*
1058 * After caching firmware image is started, let it piggyback
1059 * on request firmware.
1060 */
1061 if (buf->fwc->state == FW_LOADER_START_CACHE) {
1062 if (fw_cache_piggyback_on_request(buf->fw_id))
1063 kref_get(&buf->ref);
1064 }
1065
1066 /* pass the pages buffer to driver at the last minute */
1067 fw_set_page_data(buf, fw);
1068 mutex_unlock(&fw_lock);
1069 return 0;
1070}
1071
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001072/* called from request_firmware() and request_firmware_work_func() */
1073static int
1074_request_firmware(const struct firmware **firmware_p, const char *name,
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001075 struct device *device, unsigned int opt_flags)
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001076{
1077 struct firmware *fw;
1078 long timeout;
1079 int ret;
1080
1081 if (!firmware_p)
1082 return -EINVAL;
1083
1084 ret = _request_firmware_prepare(&fw, name, device);
1085 if (ret <= 0) /* error or already assigned */
1086 goto out;
1087
1088 ret = 0;
1089 timeout = firmware_loading_timeout();
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001090 if (opt_flags & FW_OPT_NOWAIT) {
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001091 timeout = usermodehelper_read_lock_wait(timeout);
1092 if (!timeout) {
1093 dev_dbg(device, "firmware: %s loading timed out\n",
1094 name);
1095 ret = -EBUSY;
1096 goto out;
1097 }
1098 } else {
1099 ret = usermodehelper_read_trylock();
1100 if (WARN_ON(ret)) {
1101 dev_err(device, "firmware: %s will not be loaded\n",
1102 name);
1103 goto out;
1104 }
1105 }
1106
Neil Horman3e358ac2013-09-06 15:36:08 -04001107 ret = fw_get_filesystem_firmware(device, fw->priv);
1108 if (ret) {
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001109 if (opt_flags & FW_OPT_FALLBACK) {
Takashi Iwaibba3a872013-12-02 15:38:16 +01001110 dev_warn(device,
1111 "Direct firmware load failed with error %d\n",
1112 ret);
1113 dev_warn(device, "Falling back to user helper\n");
1114 ret = fw_load_from_user_helper(fw, name, device,
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001115 opt_flags, timeout);
Takashi Iwaibba3a872013-12-02 15:38:16 +01001116 }
Neil Horman3e358ac2013-09-06 15:36:08 -04001117 }
Ming Leie771d1a2013-05-27 18:30:03 +08001118
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001119 if (!ret)
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001120 ret = assign_firmware_buf(fw, device, opt_flags);
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001121
1122 usermodehelper_read_unlock();
1123
1124 out:
1125 if (ret < 0) {
1126 release_firmware(fw);
1127 fw = NULL;
1128 }
1129
1130 *firmware_p = fw;
1131 return ret;
1132}
1133
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134/**
Kay Sievers312c0042005-11-16 09:00:00 +01001135 * request_firmware: - send firmware request and wait for it
Randy Dunlapeb8e3172005-10-30 15:03:01 -08001136 * @firmware_p: pointer to firmware image
1137 * @name: name of firmware file
1138 * @device: device for which firmware is being loaded
1139 *
1140 * @firmware_p will be used to return a firmware image by the name
Abhay Salunke6e3eaab2005-09-06 15:17:13 -07001141 * of @name for device @device.
1142 *
1143 * Should be called from user context where sleeping is allowed.
1144 *
Kay Sievers312c0042005-11-16 09:00:00 +01001145 * @name will be used as $FIRMWARE in the uevent environment and
Abhay Salunke6e3eaab2005-09-06 15:17:13 -07001146 * should be distinctive enough not to be confused with any other
1147 * firmware image for this or any other device.
Ming Lei0cfc1e12012-08-04 12:01:23 +08001148 *
1149 * Caller must hold the reference count of @device.
Ming Lei6a927852012-11-03 17:48:16 +08001150 *
1151 * The function can be called safely inside device's suspend and
1152 * resume callback.
Abhay Salunke6e3eaab2005-09-06 15:17:13 -07001153 **/
1154int
1155request_firmware(const struct firmware **firmware_p, const char *name,
1156 struct device *device)
1157{
Ming Leid6c8aa32013-06-06 20:01:48 +08001158 int ret;
1159
1160 /* Need to pin this module until return */
1161 __module_get(THIS_MODULE);
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001162 ret = _request_firmware(firmware_p, name, device,
1163 FW_OPT_UEVENT | FW_OPT_FALLBACK);
Ming Leid6c8aa32013-06-06 20:01:48 +08001164 module_put(THIS_MODULE);
1165 return ret;
Abhay Salunke6e3eaab2005-09-06 15:17:13 -07001166}
Daniel Mackf4945132013-05-23 22:17:18 +02001167EXPORT_SYMBOL(request_firmware);
Abhay Salunke6e3eaab2005-09-06 15:17:13 -07001168
Takashi Iwaibba3a872013-12-02 15:38:16 +01001169#ifdef CONFIG_FW_LOADER_USER_HELPER
1170/**
1171 * request_firmware: - load firmware directly without usermode helper
1172 * @firmware_p: pointer to firmware image
1173 * @name: name of firmware file
1174 * @device: device for which firmware is being loaded
1175 *
1176 * This function works pretty much like request_firmware(), but this doesn't
1177 * fall back to usermode helper even if the firmware couldn't be loaded
1178 * directly from fs. Hence it's useful for loading optional firmwares, which
1179 * aren't always present, without extra long timeouts of udev.
1180 **/
1181int request_firmware_direct(const struct firmware **firmware_p,
1182 const char *name, struct device *device)
1183{
1184 int ret;
1185 __module_get(THIS_MODULE);
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001186 ret = _request_firmware(firmware_p, name, device, FW_OPT_UEVENT);
Takashi Iwaibba3a872013-12-02 15:38:16 +01001187 module_put(THIS_MODULE);
1188 return ret;
1189}
1190EXPORT_SYMBOL_GPL(request_firmware_direct);
1191#endif
1192
Abhay Salunke6e3eaab2005-09-06 15:17:13 -07001193/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194 * release_firmware: - release the resource associated with a firmware image
Randy Dunlapeb8e3172005-10-30 15:03:01 -08001195 * @fw: firmware resource to release
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196 **/
Dmitry Torokhovbcb9bd12010-03-13 23:49:18 -08001197void release_firmware(const struct firmware *fw)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198{
1199 if (fw) {
Dmitry Torokhovbcb9bd12010-03-13 23:49:18 -08001200 if (!fw_is_builtin_firmware(fw))
1201 firmware_free_data(fw);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 kfree(fw);
1203 }
1204}
Daniel Mackf4945132013-05-23 22:17:18 +02001205EXPORT_SYMBOL(release_firmware);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207/* Async support */
1208struct firmware_work {
1209 struct work_struct work;
1210 struct module *module;
1211 const char *name;
1212 struct device *device;
1213 void *context;
1214 void (*cont)(const struct firmware *fw, void *context);
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001215 unsigned int opt_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216};
1217
Stephen Boyda36cf842012-03-28 23:31:00 +02001218static void request_firmware_work_func(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219{
Stephen Boyda36cf842012-03-28 23:31:00 +02001220 struct firmware_work *fw_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221 const struct firmware *fw;
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -07001222
Stephen Boyda36cf842012-03-28 23:31:00 +02001223 fw_work = container_of(work, struct firmware_work, work);
Rafael J. Wysocki811fa402012-03-28 23:29:55 +02001224
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001225 _request_firmware(&fw, fw_work->name, fw_work->device,
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001226 fw_work->opt_flags);
Johannes Berg9ebfbd42009-10-29 12:36:02 +01001227 fw_work->cont(fw, fw_work->context);
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001228 put_device(fw_work->device); /* taken in request_firmware_nowait() */
Johannes Berg9ebfbd42009-10-29 12:36:02 +01001229
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 module_put(fw_work->module);
1231 kfree(fw_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232}
1233
1234/**
Ben Hutchings3c31f072010-02-14 14:18:53 +00001235 * request_firmware_nowait - asynchronous version of request_firmware
Randy Dunlapeb8e3172005-10-30 15:03:01 -08001236 * @module: module requesting the firmware
Kay Sievers312c0042005-11-16 09:00:00 +01001237 * @uevent: sends uevent to copy the firmware image if this flag
Randy Dunlapeb8e3172005-10-30 15:03:01 -08001238 * is non-zero else the firmware copy must be done manually.
1239 * @name: name of firmware file
1240 * @device: device for which firmware is being loaded
Johannes Berg9ebfbd42009-10-29 12:36:02 +01001241 * @gfp: allocation flags
Randy Dunlapeb8e3172005-10-30 15:03:01 -08001242 * @context: will be passed over to @cont, and
1243 * @fw may be %NULL if firmware request fails.
1244 * @cont: function will be called asynchronously when the firmware
1245 * request is over.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 *
Ming Lei0cfc1e12012-08-04 12:01:23 +08001247 * Caller must hold the reference count of @device.
1248 *
Ming Lei6f21a622012-08-04 12:01:24 +08001249 * Asynchronous variant of request_firmware() for user contexts:
1250 * - sleep for as small periods as possible since it may
1251 * increase kernel boot time of built-in device drivers
1252 * requesting firmware in their ->probe() methods, if
1253 * @gfp is GFP_KERNEL.
1254 *
1255 * - can't sleep at all if @gfp is GFP_ATOMIC.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256 **/
1257int
1258request_firmware_nowait(
Bob Liu072fc8f2011-01-26 18:33:32 +08001259 struct module *module, bool uevent,
Johannes Berg9ebfbd42009-10-29 12:36:02 +01001260 const char *name, struct device *device, gfp_t gfp, void *context,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 void (*cont)(const struct firmware *fw, void *context))
1262{
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -07001263 struct firmware_work *fw_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -07001265 fw_work = kzalloc(sizeof (struct firmware_work), gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266 if (!fw_work)
1267 return -ENOMEM;
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -07001268
1269 fw_work->module = module;
1270 fw_work->name = name;
1271 fw_work->device = device;
1272 fw_work->context = context;
1273 fw_work->cont = cont;
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001274 fw_work->opt_flags = FW_OPT_NOWAIT | FW_OPT_FALLBACK |
1275 (uevent ? FW_OPT_UEVENT : 0);
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -07001276
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277 if (!try_module_get(module)) {
1278 kfree(fw_work);
1279 return -EFAULT;
1280 }
1281
Ming Lei0cfc1e12012-08-04 12:01:23 +08001282 get_device(fw_work->device);
Stephen Boyda36cf842012-03-28 23:31:00 +02001283 INIT_WORK(&fw_work->work, request_firmware_work_func);
1284 schedule_work(&fw_work->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 return 0;
1286}
Daniel Mackf4945132013-05-23 22:17:18 +02001287EXPORT_SYMBOL(request_firmware_nowait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288
Ming Lei90f890812013-06-20 12:30:16 +08001289#ifdef CONFIG_PM_SLEEP
1290static ASYNC_DOMAIN_EXCLUSIVE(fw_cache_domain);
1291
Ming Lei2887b392012-08-04 12:01:22 +08001292/**
1293 * cache_firmware - cache one firmware image in kernel memory space
1294 * @fw_name: the firmware image name
1295 *
1296 * Cache firmware in kernel memory so that drivers can use it when
1297 * system isn't ready for them to request firmware image from userspace.
1298 * Once it returns successfully, driver can use request_firmware or its
1299 * nowait version to get the cached firmware without any interacting
1300 * with userspace
1301 *
1302 * Return 0 if the firmware image has been cached successfully
1303 * Return !0 otherwise
1304 *
1305 */
Ming Lei93232e42013-06-06 20:01:47 +08001306static int cache_firmware(const char *fw_name)
Ming Lei2887b392012-08-04 12:01:22 +08001307{
1308 int ret;
1309 const struct firmware *fw;
1310
1311 pr_debug("%s: %s\n", __func__, fw_name);
1312
1313 ret = request_firmware(&fw, fw_name, NULL);
1314 if (!ret)
1315 kfree(fw);
1316
1317 pr_debug("%s: %s ret=%d\n", __func__, fw_name, ret);
1318
1319 return ret;
1320}
1321
Ming Lei6a2c1232013-06-26 09:28:17 +08001322static struct firmware_buf *fw_lookup_buf(const char *fw_name)
1323{
1324 struct firmware_buf *tmp;
1325 struct firmware_cache *fwc = &fw_cache;
1326
1327 spin_lock(&fwc->lock);
1328 tmp = __fw_lookup_buf(fw_name);
1329 spin_unlock(&fwc->lock);
1330
1331 return tmp;
1332}
1333
Ming Lei2887b392012-08-04 12:01:22 +08001334/**
1335 * uncache_firmware - remove one cached firmware image
1336 * @fw_name: the firmware image name
1337 *
1338 * Uncache one firmware image which has been cached successfully
1339 * before.
1340 *
1341 * Return 0 if the firmware cache has been removed successfully
1342 * Return !0 otherwise
1343 *
1344 */
Ming Lei93232e42013-06-06 20:01:47 +08001345static int uncache_firmware(const char *fw_name)
Ming Lei2887b392012-08-04 12:01:22 +08001346{
1347 struct firmware_buf *buf;
1348 struct firmware fw;
1349
1350 pr_debug("%s: %s\n", __func__, fw_name);
1351
1352 if (fw_get_builtin_firmware(&fw, fw_name))
1353 return 0;
1354
1355 buf = fw_lookup_buf(fw_name);
1356 if (buf) {
1357 fw_free_buf(buf);
1358 return 0;
1359 }
1360
1361 return -EINVAL;
1362}
1363
Ming Lei37276a52012-08-04 12:01:27 +08001364static struct fw_cache_entry *alloc_fw_cache_entry(const char *name)
1365{
1366 struct fw_cache_entry *fce;
1367
1368 fce = kzalloc(sizeof(*fce) + strlen(name) + 1, GFP_ATOMIC);
1369 if (!fce)
1370 goto exit;
1371
1372 strcpy(fce->name, name);
1373exit:
1374 return fce;
1375}
1376
Ming Lei373304f2012-10-09 12:01:01 +08001377static int __fw_entry_found(const char *name)
1378{
1379 struct firmware_cache *fwc = &fw_cache;
1380 struct fw_cache_entry *fce;
1381
1382 list_for_each_entry(fce, &fwc->fw_names, list) {
1383 if (!strcmp(fce->name, name))
1384 return 1;
1385 }
1386 return 0;
1387}
1388
Ming Leiac39b3e2012-08-20 19:04:16 +08001389static int fw_cache_piggyback_on_request(const char *name)
1390{
1391 struct firmware_cache *fwc = &fw_cache;
1392 struct fw_cache_entry *fce;
1393 int ret = 0;
1394
1395 spin_lock(&fwc->name_lock);
Ming Lei373304f2012-10-09 12:01:01 +08001396 if (__fw_entry_found(name))
1397 goto found;
Ming Leiac39b3e2012-08-20 19:04:16 +08001398
1399 fce = alloc_fw_cache_entry(name);
1400 if (fce) {
1401 ret = 1;
1402 list_add(&fce->list, &fwc->fw_names);
1403 pr_debug("%s: fw: %s\n", __func__, name);
1404 }
1405found:
1406 spin_unlock(&fwc->name_lock);
1407 return ret;
1408}
1409
Ming Lei37276a52012-08-04 12:01:27 +08001410static void free_fw_cache_entry(struct fw_cache_entry *fce)
1411{
1412 kfree(fce);
1413}
1414
1415static void __async_dev_cache_fw_image(void *fw_entry,
1416 async_cookie_t cookie)
1417{
1418 struct fw_cache_entry *fce = fw_entry;
1419 struct firmware_cache *fwc = &fw_cache;
1420 int ret;
1421
1422 ret = cache_firmware(fce->name);
Ming Leiac39b3e2012-08-20 19:04:16 +08001423 if (ret) {
1424 spin_lock(&fwc->name_lock);
1425 list_del(&fce->list);
1426 spin_unlock(&fwc->name_lock);
Ming Lei37276a52012-08-04 12:01:27 +08001427
Ming Leiac39b3e2012-08-20 19:04:16 +08001428 free_fw_cache_entry(fce);
1429 }
Ming Lei37276a52012-08-04 12:01:27 +08001430}
1431
1432/* called with dev->devres_lock held */
1433static void dev_create_fw_entry(struct device *dev, void *res,
1434 void *data)
1435{
1436 struct fw_name_devm *fwn = res;
1437 const char *fw_name = fwn->name;
1438 struct list_head *head = data;
1439 struct fw_cache_entry *fce;
1440
1441 fce = alloc_fw_cache_entry(fw_name);
1442 if (fce)
1443 list_add(&fce->list, head);
1444}
1445
1446static int devm_name_match(struct device *dev, void *res,
1447 void *match_data)
1448{
1449 struct fw_name_devm *fwn = res;
1450 return (fwn->magic == (unsigned long)match_data);
1451}
1452
Ming Leiab6dd8e2012-08-17 22:07:00 +08001453static void dev_cache_fw_image(struct device *dev, void *data)
Ming Lei37276a52012-08-04 12:01:27 +08001454{
1455 LIST_HEAD(todo);
1456 struct fw_cache_entry *fce;
1457 struct fw_cache_entry *fce_next;
1458 struct firmware_cache *fwc = &fw_cache;
1459
1460 devres_for_each_res(dev, fw_name_devm_release,
1461 devm_name_match, &fw_cache,
1462 dev_create_fw_entry, &todo);
1463
1464 list_for_each_entry_safe(fce, fce_next, &todo, list) {
1465 list_del(&fce->list);
1466
1467 spin_lock(&fwc->name_lock);
Ming Lei373304f2012-10-09 12:01:01 +08001468 /* only one cache entry for one firmware */
1469 if (!__fw_entry_found(fce->name)) {
Ming Lei373304f2012-10-09 12:01:01 +08001470 list_add(&fce->list, &fwc->fw_names);
1471 } else {
1472 free_fw_cache_entry(fce);
1473 fce = NULL;
1474 }
Ming Lei37276a52012-08-04 12:01:27 +08001475 spin_unlock(&fwc->name_lock);
1476
Ming Lei373304f2012-10-09 12:01:01 +08001477 if (fce)
Ming Leid28d3882012-10-09 12:01:04 +08001478 async_schedule_domain(__async_dev_cache_fw_image,
1479 (void *)fce,
1480 &fw_cache_domain);
Ming Lei37276a52012-08-04 12:01:27 +08001481 }
1482}
1483
1484static void __device_uncache_fw_images(void)
1485{
1486 struct firmware_cache *fwc = &fw_cache;
1487 struct fw_cache_entry *fce;
1488
1489 spin_lock(&fwc->name_lock);
1490 while (!list_empty(&fwc->fw_names)) {
1491 fce = list_entry(fwc->fw_names.next,
1492 struct fw_cache_entry, list);
1493 list_del(&fce->list);
1494 spin_unlock(&fwc->name_lock);
1495
1496 uncache_firmware(fce->name);
1497 free_fw_cache_entry(fce);
1498
1499 spin_lock(&fwc->name_lock);
1500 }
1501 spin_unlock(&fwc->name_lock);
1502}
1503
1504/**
1505 * device_cache_fw_images - cache devices' firmware
1506 *
1507 * If one device called request_firmware or its nowait version
1508 * successfully before, the firmware names are recored into the
1509 * device's devres link list, so device_cache_fw_images can call
1510 * cache_firmware() to cache these firmwares for the device,
1511 * then the device driver can load its firmwares easily at
1512 * time when system is not ready to complete loading firmware.
1513 */
1514static void device_cache_fw_images(void)
1515{
1516 struct firmware_cache *fwc = &fw_cache;
Ming Leiffe53f62012-08-04 12:01:28 +08001517 int old_timeout;
Ming Lei37276a52012-08-04 12:01:27 +08001518 DEFINE_WAIT(wait);
1519
1520 pr_debug("%s\n", __func__);
1521
Ming Lei373304f2012-10-09 12:01:01 +08001522 /* cancel uncache work */
1523 cancel_delayed_work_sync(&fwc->work);
1524
Ming Leiffe53f62012-08-04 12:01:28 +08001525 /*
1526 * use small loading timeout for caching devices' firmware
1527 * because all these firmware images have been loaded
1528 * successfully at lease once, also system is ready for
1529 * completing firmware loading now. The maximum size of
1530 * firmware in current distributions is about 2M bytes,
1531 * so 10 secs should be enough.
1532 */
1533 old_timeout = loading_timeout;
1534 loading_timeout = 10;
1535
Ming Leiac39b3e2012-08-20 19:04:16 +08001536 mutex_lock(&fw_lock);
1537 fwc->state = FW_LOADER_START_CACHE;
Ming Leiab6dd8e2012-08-17 22:07:00 +08001538 dpm_for_each_dev(NULL, dev_cache_fw_image);
Ming Leiac39b3e2012-08-20 19:04:16 +08001539 mutex_unlock(&fw_lock);
Ming Lei37276a52012-08-04 12:01:27 +08001540
1541 /* wait for completion of caching firmware for all devices */
Ming Leid28d3882012-10-09 12:01:04 +08001542 async_synchronize_full_domain(&fw_cache_domain);
Ming Leiffe53f62012-08-04 12:01:28 +08001543
1544 loading_timeout = old_timeout;
Ming Lei37276a52012-08-04 12:01:27 +08001545}
1546
1547/**
1548 * device_uncache_fw_images - uncache devices' firmware
1549 *
1550 * uncache all firmwares which have been cached successfully
1551 * by device_uncache_fw_images earlier
1552 */
1553static void device_uncache_fw_images(void)
1554{
1555 pr_debug("%s\n", __func__);
1556 __device_uncache_fw_images();
1557}
1558
1559static void device_uncache_fw_images_work(struct work_struct *work)
1560{
1561 device_uncache_fw_images();
1562}
1563
1564/**
1565 * device_uncache_fw_images_delay - uncache devices firmwares
1566 * @delay: number of milliseconds to delay uncache device firmwares
1567 *
1568 * uncache all devices's firmwares which has been cached successfully
1569 * by device_cache_fw_images after @delay milliseconds.
1570 */
1571static void device_uncache_fw_images_delay(unsigned long delay)
1572{
1573 schedule_delayed_work(&fw_cache.work,
1574 msecs_to_jiffies(delay));
1575}
1576
Ming Lei07646d92012-08-04 12:01:29 +08001577static int fw_pm_notify(struct notifier_block *notify_block,
1578 unsigned long mode, void *unused)
1579{
1580 switch (mode) {
1581 case PM_HIBERNATION_PREPARE:
1582 case PM_SUSPEND_PREPARE:
Sebastian Capellaf8d5b9e2014-02-18 17:52:08 -08001583 case PM_RESTORE_PREPARE:
Ming Leiaf5bc112013-05-27 18:30:04 +08001584 kill_requests_without_uevent();
Ming Lei07646d92012-08-04 12:01:29 +08001585 device_cache_fw_images();
1586 break;
1587
1588 case PM_POST_SUSPEND:
1589 case PM_POST_HIBERNATION:
1590 case PM_POST_RESTORE:
Ming Leiac39b3e2012-08-20 19:04:16 +08001591 /*
1592 * In case that system sleep failed and syscore_suspend is
1593 * not called.
1594 */
1595 mutex_lock(&fw_lock);
1596 fw_cache.state = FW_LOADER_NO_CACHE;
1597 mutex_unlock(&fw_lock);
1598
Ming Lei07646d92012-08-04 12:01:29 +08001599 device_uncache_fw_images_delay(10 * MSEC_PER_SEC);
1600 break;
1601 }
1602
1603 return 0;
1604}
Ming Lei07646d92012-08-04 12:01:29 +08001605
Ming Leiac39b3e2012-08-20 19:04:16 +08001606/* stop caching firmware once syscore_suspend is reached */
1607static int fw_suspend(void)
1608{
1609 fw_cache.state = FW_LOADER_NO_CACHE;
1610 return 0;
1611}
1612
1613static struct syscore_ops fw_syscore_ops = {
1614 .suspend = fw_suspend,
1615};
Ming Leicfe016b2012-09-08 17:32:30 +08001616#else
1617static int fw_cache_piggyback_on_request(const char *name)
1618{
1619 return 0;
1620}
1621#endif
Ming Leiac39b3e2012-08-20 19:04:16 +08001622
Ming Lei37276a52012-08-04 12:01:27 +08001623static void __init fw_cache_init(void)
1624{
1625 spin_lock_init(&fw_cache.lock);
1626 INIT_LIST_HEAD(&fw_cache.head);
Ming Leicfe016b2012-09-08 17:32:30 +08001627 fw_cache.state = FW_LOADER_NO_CACHE;
Ming Lei37276a52012-08-04 12:01:27 +08001628
Ming Leicfe016b2012-09-08 17:32:30 +08001629#ifdef CONFIG_PM_SLEEP
Ming Lei37276a52012-08-04 12:01:27 +08001630 spin_lock_init(&fw_cache.name_lock);
1631 INIT_LIST_HEAD(&fw_cache.fw_names);
Ming Lei37276a52012-08-04 12:01:27 +08001632
Ming Lei37276a52012-08-04 12:01:27 +08001633 INIT_DELAYED_WORK(&fw_cache.work,
1634 device_uncache_fw_images_work);
Ming Lei07646d92012-08-04 12:01:29 +08001635
1636 fw_cache.pm_notify.notifier_call = fw_pm_notify;
1637 register_pm_notifier(&fw_cache.pm_notify);
Ming Leiac39b3e2012-08-20 19:04:16 +08001638
1639 register_syscore_ops(&fw_syscore_ops);
Ming Leicfe016b2012-09-08 17:32:30 +08001640#endif
Ming Lei37276a52012-08-04 12:01:27 +08001641}
1642
Dmitry Torokhov673fae92010-03-13 23:49:13 -08001643static int __init firmware_class_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644{
Ming Lei1f2b7952012-08-04 12:01:21 +08001645 fw_cache_init();
Takashi Iwai7b1269f2013-01-31 11:13:55 +01001646#ifdef CONFIG_FW_LOADER_USER_HELPER
Takashi Iwaife304142013-05-22 18:28:38 +02001647 register_reboot_notifier(&fw_shutdown_nb);
Dmitry Torokhov673fae92010-03-13 23:49:13 -08001648 return class_register(&firmware_class);
Takashi Iwai7b1269f2013-01-31 11:13:55 +01001649#else
1650 return 0;
1651#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652}
Dmitry Torokhov673fae92010-03-13 23:49:13 -08001653
1654static void __exit firmware_class_exit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655{
Ming Leicfe016b2012-09-08 17:32:30 +08001656#ifdef CONFIG_PM_SLEEP
Ming Leiac39b3e2012-08-20 19:04:16 +08001657 unregister_syscore_ops(&fw_syscore_ops);
Ming Lei07646d92012-08-04 12:01:29 +08001658 unregister_pm_notifier(&fw_cache.pm_notify);
Ming Leicfe016b2012-09-08 17:32:30 +08001659#endif
Takashi Iwai7b1269f2013-01-31 11:13:55 +01001660#ifdef CONFIG_FW_LOADER_USER_HELPER
Takashi Iwaife304142013-05-22 18:28:38 +02001661 unregister_reboot_notifier(&fw_shutdown_nb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662 class_unregister(&firmware_class);
Takashi Iwai7b1269f2013-01-31 11:13:55 +01001663#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664}
1665
Shaohua Lia30a6a22006-09-27 01:50:52 -07001666fs_initcall(firmware_class_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667module_exit(firmware_class_exit);