blob: 6c5c9edf5ff661cf2e7cd3f4c85665419403cd1a [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>
Kees Cook6593d922014-02-25 13:06:00 -080031#include <linux/security.h>
Ming Lei37276a52012-08-04 12:01:27 +080032
Linus Torvaldsabb139e2012-10-03 15:58:32 -070033#include <generated/utsrelease.h>
34
Ming Lei37276a52012-08-04 12:01:27 +080035#include "base.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
Markus Rechberger87d37a42007-06-04 18:45:44 +020037MODULE_AUTHOR("Manuel Estrada Sainz");
Linus Torvalds1da177e2005-04-16 15:20:36 -070038MODULE_DESCRIPTION("Multi purpose firmware loading support");
39MODULE_LICENSE("GPL");
40
Dmitry Torokhovbcb9bd12010-03-13 23:49:18 -080041/* Builtin firmware support */
42
43#ifdef CONFIG_FW_LOADER
44
45extern struct builtin_fw __start_builtin_fw[];
46extern struct builtin_fw __end_builtin_fw[];
47
48static bool fw_get_builtin_firmware(struct firmware *fw, const char *name)
49{
50 struct builtin_fw *b_fw;
51
52 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++) {
53 if (strcmp(name, b_fw->name) == 0) {
54 fw->size = b_fw->size;
55 fw->data = b_fw->data;
56 return true;
57 }
58 }
59
60 return false;
61}
62
63static bool fw_is_builtin_firmware(const struct firmware *fw)
64{
65 struct builtin_fw *b_fw;
66
67 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++)
68 if (fw->data == b_fw->data)
69 return true;
70
71 return false;
72}
73
74#else /* Module case - no builtin firmware support */
75
76static inline bool fw_get_builtin_firmware(struct firmware *fw, const char *name)
77{
78 return false;
79}
80
81static inline bool fw_is_builtin_firmware(const struct firmware *fw)
82{
83 return false;
84}
85#endif
86
Linus Torvalds1da177e2005-04-16 15:20:36 -070087enum {
88 FW_STATUS_LOADING,
89 FW_STATUS_DONE,
90 FW_STATUS_ABORT,
Linus Torvalds1da177e2005-04-16 15:20:36 -070091};
92
Dave Jones2f651682007-01-25 15:56:15 -050093static int loading_timeout = 60; /* In seconds */
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
Rafael J. Wysocki9b78c1d2012-03-28 23:30:02 +020095static inline long firmware_loading_timeout(void)
96{
Ming Lei68ff2a02015-01-13 00:02:01 +080097 return loading_timeout > 0 ? loading_timeout * HZ : MAX_JIFFY_OFFSET;
Rafael J. Wysocki9b78c1d2012-03-28 23:30:02 +020098}
99
Takashi Iwai14c4bae2013-12-02 15:38:18 +0100100/* firmware behavior options */
101#define FW_OPT_UEVENT (1U << 0)
102#define FW_OPT_NOWAIT (1U << 1)
Takashi Iwai68aeeaa2013-12-02 15:38:19 +0100103#ifdef CONFIG_FW_LOADER_USER_HELPER
Takashi Iwai5a1379e2014-06-04 17:48:15 +0200104#define FW_OPT_USERHELPER (1U << 2)
Takashi Iwai68aeeaa2013-12-02 15:38:19 +0100105#else
Takashi Iwai5a1379e2014-06-04 17:48:15 +0200106#define FW_OPT_USERHELPER 0
107#endif
108#ifdef CONFIG_FW_LOADER_USER_HELPER_FALLBACK
109#define FW_OPT_FALLBACK FW_OPT_USERHELPER
110#else
111#define FW_OPT_FALLBACK 0
Takashi Iwai68aeeaa2013-12-02 15:38:19 +0100112#endif
Luis R. Rodriguezc868edf2014-07-02 09:55:05 -0700113#define FW_OPT_NO_WARN (1U << 3)
Takashi Iwai14c4bae2013-12-02 15:38:18 +0100114
Ming Lei1f2b7952012-08-04 12:01:21 +0800115struct firmware_cache {
116 /* firmware_buf instance will be added into the below list */
117 spinlock_t lock;
118 struct list_head head;
Ming Leicfe016b2012-09-08 17:32:30 +0800119 int state;
Ming Lei37276a52012-08-04 12:01:27 +0800120
Ming Leicfe016b2012-09-08 17:32:30 +0800121#ifdef CONFIG_PM_SLEEP
Ming Lei37276a52012-08-04 12:01:27 +0800122 /*
123 * Names of firmware images which have been cached successfully
124 * will be added into the below list so that device uncache
125 * helper can trace which firmware images have been cached
126 * before.
127 */
128 spinlock_t name_lock;
129 struct list_head fw_names;
130
Ming Lei37276a52012-08-04 12:01:27 +0800131 struct delayed_work work;
Ming Lei07646d92012-08-04 12:01:29 +0800132
133 struct notifier_block pm_notify;
Ming Leicfe016b2012-09-08 17:32:30 +0800134#endif
Ming Lei1f2b7952012-08-04 12:01:21 +0800135};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
Ming Lei12446912012-08-04 12:01:20 +0800137struct firmware_buf {
Ming Lei1f2b7952012-08-04 12:01:21 +0800138 struct kref ref;
139 struct list_head list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 struct completion completion;
Ming Lei1f2b7952012-08-04 12:01:21 +0800141 struct firmware_cache *fwc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 unsigned long status;
Ming Lei65710cb2012-08-04 12:01:16 +0800143 void *data;
144 size_t size;
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100145#ifdef CONFIG_FW_LOADER_USER_HELPER
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100146 bool is_paged_buf;
Ming Leiaf5bc112013-05-27 18:30:04 +0800147 bool need_uevent;
David Woodhouse6e03a202009-04-09 22:04:07 -0700148 struct page **pages;
149 int nr_pages;
150 int page_array_size;
Takashi Iwaife304142013-05-22 18:28:38 +0200151 struct list_head pending_list;
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100152#endif
Dmitry Torokhove1771232010-03-13 23:49:23 -0800153 char fw_id[];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154};
155
Ming Lei37276a52012-08-04 12:01:27 +0800156struct fw_cache_entry {
157 struct list_head list;
158 char name[];
159};
160
Ming Leif531f05a2012-08-04 12:01:25 +0800161struct fw_name_devm {
162 unsigned long magic;
163 char name[];
164};
165
Ming Lei1f2b7952012-08-04 12:01:21 +0800166#define to_fwbuf(d) container_of(d, struct firmware_buf, ref)
167
Ming Leiac39b3e2012-08-20 19:04:16 +0800168#define FW_LOADER_NO_CACHE 0
169#define FW_LOADER_START_CACHE 1
170
171static int fw_cache_piggyback_on_request(const char *name);
172
Ming Lei1f2b7952012-08-04 12:01:21 +0800173/* fw_lock could be moved to 'struct firmware_priv' but since it is just
174 * guarding for corner cases a global lock should be OK */
175static DEFINE_MUTEX(fw_lock);
176
177static struct firmware_cache fw_cache;
178
179static struct firmware_buf *__allocate_fw_buf(const char *fw_name,
180 struct firmware_cache *fwc)
181{
182 struct firmware_buf *buf;
183
184 buf = kzalloc(sizeof(*buf) + strlen(fw_name) + 1 , GFP_ATOMIC);
185
186 if (!buf)
187 return buf;
188
189 kref_init(&buf->ref);
190 strcpy(buf->fw_id, fw_name);
191 buf->fwc = fwc;
192 init_completion(&buf->completion);
Takashi Iwaife304142013-05-22 18:28:38 +0200193#ifdef CONFIG_FW_LOADER_USER_HELPER
194 INIT_LIST_HEAD(&buf->pending_list);
195#endif
Ming Lei1f2b7952012-08-04 12:01:21 +0800196
197 pr_debug("%s: fw-%s buf=%p\n", __func__, fw_name, buf);
198
199 return buf;
200}
201
Ming Lei2887b392012-08-04 12:01:22 +0800202static struct firmware_buf *__fw_lookup_buf(const char *fw_name)
203{
204 struct firmware_buf *tmp;
205 struct firmware_cache *fwc = &fw_cache;
206
207 list_for_each_entry(tmp, &fwc->head, list)
208 if (!strcmp(tmp->fw_id, fw_name))
209 return tmp;
210 return NULL;
211}
212
Ming Lei1f2b7952012-08-04 12:01:21 +0800213static int fw_lookup_and_allocate_buf(const char *fw_name,
214 struct firmware_cache *fwc,
215 struct firmware_buf **buf)
216{
217 struct firmware_buf *tmp;
218
219 spin_lock(&fwc->lock);
Ming Lei2887b392012-08-04 12:01:22 +0800220 tmp = __fw_lookup_buf(fw_name);
221 if (tmp) {
222 kref_get(&tmp->ref);
223 spin_unlock(&fwc->lock);
224 *buf = tmp;
225 return 1;
226 }
Ming Lei1f2b7952012-08-04 12:01:21 +0800227 tmp = __allocate_fw_buf(fw_name, fwc);
228 if (tmp)
229 list_add(&tmp->list, &fwc->head);
230 spin_unlock(&fwc->lock);
231
232 *buf = tmp;
233
234 return tmp ? 0 : -ENOMEM;
235}
236
237static void __fw_free_buf(struct kref *ref)
Bart Van Assche98233b22014-01-04 14:20:36 +0100238 __releases(&fwc->lock)
Ming Lei1f2b7952012-08-04 12:01:21 +0800239{
240 struct firmware_buf *buf = to_fwbuf(ref);
241 struct firmware_cache *fwc = buf->fwc;
Ming Lei1f2b7952012-08-04 12:01:21 +0800242
243 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
244 __func__, buf->fw_id, buf, buf->data,
245 (unsigned int)buf->size);
246
Ming Lei1f2b7952012-08-04 12:01:21 +0800247 list_del(&buf->list);
248 spin_unlock(&fwc->lock);
249
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100250#ifdef CONFIG_FW_LOADER_USER_HELPER
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100251 if (buf->is_paged_buf) {
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100252 int i;
Ming Lei746058f2012-10-09 12:01:03 +0800253 vunmap(buf->data);
254 for (i = 0; i < buf->nr_pages; i++)
255 __free_page(buf->pages[i]);
256 kfree(buf->pages);
257 } else
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100258#endif
Ming Lei746058f2012-10-09 12:01:03 +0800259 vfree(buf->data);
Ming Lei1f2b7952012-08-04 12:01:21 +0800260 kfree(buf);
261}
262
263static void fw_free_buf(struct firmware_buf *buf)
264{
Chuansheng Liubd9eb7f2012-11-10 01:27:22 +0800265 struct firmware_cache *fwc = buf->fwc;
266 spin_lock(&fwc->lock);
267 if (!kref_put(&buf->ref, __fw_free_buf))
268 spin_unlock(&fwc->lock);
Ming Lei1f2b7952012-08-04 12:01:21 +0800269}
270
Ming Lei746058f2012-10-09 12:01:03 +0800271/* direct firmware loading support */
Ming Lei27602842012-11-03 17:47:58 +0800272static char fw_path_para[256];
273static const char * const fw_path[] = {
274 fw_path_para,
Ming Lei746058f2012-10-09 12:01:03 +0800275 "/lib/firmware/updates/" UTS_RELEASE,
276 "/lib/firmware/updates",
277 "/lib/firmware/" UTS_RELEASE,
278 "/lib/firmware"
279};
280
Ming Lei27602842012-11-03 17:47:58 +0800281/*
282 * Typical usage is that passing 'firmware_class.path=$CUSTOMIZED_PATH'
283 * from kernel command line because firmware_class is generally built in
284 * kernel instead of module.
285 */
286module_param_string(path, fw_path_para, sizeof(fw_path_para), 0644);
287MODULE_PARM_DESC(path, "customized firmware image search path with a higher priority than default path");
288
Neil Horman3e358ac2013-09-06 15:36:08 -0400289static int fw_read_file_contents(struct file *file, struct firmware_buf *fw_buf)
Ming Lei746058f2012-10-09 12:01:03 +0800290{
Ben Hutchings08da2012013-12-28 16:53:59 +0100291 int size;
Ming Lei746058f2012-10-09 12:01:03 +0800292 char *buf;
Neil Horman3e358ac2013-09-06 15:36:08 -0400293 int rc;
Ming Lei746058f2012-10-09 12:01:03 +0800294
Dmitry Kasatkin6af6b162014-06-13 18:09:54 +0300295 if (!S_ISREG(file_inode(file)->i_mode))
296 return -EINVAL;
297 size = i_size_read(file_inode(file));
Luciano Coelho4adf07f2013-01-15 10:43:43 +0200298 if (size <= 0)
Neil Horman3e358ac2013-09-06 15:36:08 -0400299 return -EINVAL;
Ming Lei746058f2012-10-09 12:01:03 +0800300 buf = vmalloc(size);
301 if (!buf)
Neil Horman3e358ac2013-09-06 15:36:08 -0400302 return -ENOMEM;
303 rc = kernel_read(file, 0, buf, size);
304 if (rc != size) {
305 if (rc > 0)
306 rc = -EIO;
Kees Cook6593d922014-02-25 13:06:00 -0800307 goto fail;
Ming Lei746058f2012-10-09 12:01:03 +0800308 }
Kees Cook6593d922014-02-25 13:06:00 -0800309 rc = security_kernel_fw_from_file(file, buf, size);
310 if (rc)
311 goto fail;
Ming Lei746058f2012-10-09 12:01:03 +0800312 fw_buf->data = buf;
313 fw_buf->size = size;
Neil Horman3e358ac2013-09-06 15:36:08 -0400314 return 0;
Kees Cook6593d922014-02-25 13:06:00 -0800315fail:
316 vfree(buf);
317 return rc;
Ming Lei746058f2012-10-09 12:01:03 +0800318}
319
Neil Horman3e358ac2013-09-06 15:36:08 -0400320static int fw_get_filesystem_firmware(struct device *device,
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100321 struct firmware_buf *buf)
Ming Lei746058f2012-10-09 12:01:03 +0800322{
323 int i;
Neil Horman3e358ac2013-09-06 15:36:08 -0400324 int rc = -ENOENT;
Ming Lei746058f2012-10-09 12:01:03 +0800325 char *path = __getname();
326
327 for (i = 0; i < ARRAY_SIZE(fw_path); i++) {
328 struct file *file;
Ming Lei27602842012-11-03 17:47:58 +0800329
330 /* skip the unset customized path */
331 if (!fw_path[i][0])
332 continue;
333
Ming Lei746058f2012-10-09 12:01:03 +0800334 snprintf(path, PATH_MAX, "%s/%s", fw_path[i], buf->fw_id);
335
336 file = filp_open(path, O_RDONLY, 0);
337 if (IS_ERR(file))
338 continue;
Neil Horman3e358ac2013-09-06 15:36:08 -0400339 rc = fw_read_file_contents(file, buf);
Ming Lei746058f2012-10-09 12:01:03 +0800340 fput(file);
Neil Horman3e358ac2013-09-06 15:36:08 -0400341 if (rc)
342 dev_warn(device, "firmware, attempted to load %s, but failed with error %d\n",
343 path, rc);
344 else
Ming Lei746058f2012-10-09 12:01:03 +0800345 break;
346 }
347 __putname(path);
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100348
Neil Horman3e358ac2013-09-06 15:36:08 -0400349 if (!rc) {
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100350 dev_dbg(device, "firmware: direct-loading firmware %s\n",
351 buf->fw_id);
352 mutex_lock(&fw_lock);
353 set_bit(FW_STATUS_DONE, &buf->status);
354 complete_all(&buf->completion);
355 mutex_unlock(&fw_lock);
356 }
357
Neil Horman3e358ac2013-09-06 15:36:08 -0400358 return rc;
Ming Lei746058f2012-10-09 12:01:03 +0800359}
360
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100361/* firmware holds the ownership of pages */
362static void firmware_free_data(const struct firmware *fw)
363{
364 /* Loaded directly? */
365 if (!fw->priv) {
366 vfree(fw->data);
367 return;
368 }
369 fw_free_buf(fw->priv);
370}
371
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100372/* store the pages buffer info firmware from buf */
373static void fw_set_page_data(struct firmware_buf *buf, struct firmware *fw)
374{
375 fw->priv = buf;
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100376#ifdef CONFIG_FW_LOADER_USER_HELPER
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100377 fw->pages = buf->pages;
378#endif
379 fw->size = buf->size;
380 fw->data = buf->data;
381
382 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
383 __func__, buf->fw_id, buf, buf->data,
384 (unsigned int)buf->size);
385}
386
387#ifdef CONFIG_PM_SLEEP
388static void fw_name_devm_release(struct device *dev, void *res)
389{
390 struct fw_name_devm *fwn = res;
391
392 if (fwn->magic == (unsigned long)&fw_cache)
393 pr_debug("%s: fw_name-%s devm-%p released\n",
394 __func__, fwn->name, res);
395}
396
397static int fw_devm_match(struct device *dev, void *res,
398 void *match_data)
399{
400 struct fw_name_devm *fwn = res;
401
402 return (fwn->magic == (unsigned long)&fw_cache) &&
403 !strcmp(fwn->name, match_data);
404}
405
406static struct fw_name_devm *fw_find_devm_name(struct device *dev,
407 const char *name)
408{
409 struct fw_name_devm *fwn;
410
411 fwn = devres_find(dev, fw_name_devm_release,
412 fw_devm_match, (void *)name);
413 return fwn;
414}
415
416/* add firmware name into devres list */
417static int fw_add_devm_name(struct device *dev, const char *name)
418{
419 struct fw_name_devm *fwn;
420
421 fwn = fw_find_devm_name(dev, name);
422 if (fwn)
423 return 1;
424
425 fwn = devres_alloc(fw_name_devm_release, sizeof(struct fw_name_devm) +
426 strlen(name) + 1, GFP_KERNEL);
427 if (!fwn)
428 return -ENOMEM;
429
430 fwn->magic = (unsigned long)&fw_cache;
431 strcpy(fwn->name, name);
432 devres_add(dev, fwn);
433
434 return 0;
435}
436#else
437static int fw_add_devm_name(struct device *dev, const char *name)
438{
439 return 0;
440}
441#endif
442
443
444/*
445 * user-mode helper code
446 */
447#ifdef CONFIG_FW_LOADER_USER_HELPER
448struct firmware_priv {
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100449 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
Markus Elfringdaa3d672014-11-19 11:38:38 +0100593 vunmap(buf->data);
Ming Lei253c9242012-10-09 12:01:02 +0800594 buf->data = vmap(buf->pages, buf->nr_pages, 0, PAGE_KERNEL_RO);
595 if (!buf->data)
596 return -ENOMEM;
597 return 0;
598}
599
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600/**
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800601 * firmware_loading_store - set value in the 'loading' control file
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700602 * @dev: device pointer
Randy Dunlapaf9997e2006-12-22 01:06:52 -0800603 * @attr: device attribute pointer
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800604 * @buf: buffer to scan for loading control value
605 * @count: number of bytes in @buf
606 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 * The relevant values are:
608 *
609 * 1: Start a load, discarding any previous partial load.
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800610 * 0: Conclude the load and hand the data to the driver code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 * -1: Conclude the load with an error and discard any written data.
612 **/
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700613static ssize_t firmware_loading_store(struct device *dev,
614 struct device_attribute *attr,
615 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616{
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700617 struct firmware_priv *fw_priv = to_firmware_priv(dev);
Ming Lei87597932013-06-15 16:36:38 +0800618 struct firmware_buf *fw_buf;
Kees Cook6593d922014-02-25 13:06:00 -0800619 ssize_t written = count;
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)) {
Kees Cook6593d922014-02-25 13:06:00 -0800643 int rc;
644
Ming Lei12446912012-08-04 12:01:20 +0800645 set_bit(FW_STATUS_DONE, &fw_buf->status);
646 clear_bit(FW_STATUS_LOADING, &fw_buf->status);
Ming Lei253c9242012-10-09 12:01:02 +0800647
648 /*
649 * Several loading requests may be pending on
650 * one same firmware buf, so let all requests
651 * see the mapped 'buf->data' once the loading
652 * is completed.
653 * */
Kees Cook6593d922014-02-25 13:06:00 -0800654 rc = fw_map_pages_buf(fw_buf);
655 if (rc)
zhang jun2b1278c2014-02-13 15:18:47 +0800656 dev_err(dev, "%s: map pages failed\n",
657 __func__);
Kees Cook6593d922014-02-25 13:06:00 -0800658 else
659 rc = security_kernel_fw_from_file(NULL,
660 fw_buf->data, fw_buf->size);
661
662 /*
663 * Same logic as fw_load_abort, only the DONE bit
664 * is ignored and we set ABORT only on failure.
665 */
Takashi Iwaife304142013-05-22 18:28:38 +0200666 list_del_init(&fw_buf->pending_list);
Kees Cook6593d922014-02-25 13:06:00 -0800667 if (rc) {
668 set_bit(FW_STATUS_ABORT, &fw_buf->status);
669 written = rc;
670 }
Ming Lei1f2b7952012-08-04 12:01:21 +0800671 complete_all(&fw_buf->completion);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 break;
673 }
674 /* fallthrough */
675 default:
Bjorn Helgaas266a8132008-10-15 22:04:20 -0700676 dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 /* fallthrough */
678 case -1:
679 fw_load_abort(fw_priv);
680 break;
681 }
Neil Hormaneea915b2012-01-02 15:31:23 -0500682out:
683 mutex_unlock(&fw_lock);
Kees Cook6593d922014-02-25 13:06:00 -0800684 return written;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685}
686
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700687static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700689static ssize_t firmware_data_read(struct file *filp, struct kobject *kobj,
690 struct bin_attribute *bin_attr,
691 char *buffer, loff_t offset, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200693 struct device *dev = kobj_to_dev(kobj);
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700694 struct firmware_priv *fw_priv = to_firmware_priv(dev);
Ming Lei12446912012-08-04 12:01:20 +0800695 struct firmware_buf *buf;
Akinobu Mitaf37e6612008-07-25 01:48:23 -0700696 ssize_t ret_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697
Laura Garciacad1e552006-05-23 23:22:38 +0200698 mutex_lock(&fw_lock);
Ming Lei12446912012-08-04 12:01:20 +0800699 buf = fw_priv->buf;
700 if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 ret_count = -ENODEV;
702 goto out;
703 }
Ming Lei12446912012-08-04 12:01:20 +0800704 if (offset > buf->size) {
Jiri Slaby308975f2009-06-21 23:57:31 +0200705 ret_count = 0;
706 goto out;
707 }
Ming Lei12446912012-08-04 12:01:20 +0800708 if (count > buf->size - offset)
709 count = buf->size - offset;
David Woodhouse6e03a202009-04-09 22:04:07 -0700710
711 ret_count = count;
712
713 while (count) {
714 void *page_data;
715 int page_nr = offset >> PAGE_SHIFT;
716 int page_ofs = offset & (PAGE_SIZE-1);
717 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
718
Ming Lei12446912012-08-04 12:01:20 +0800719 page_data = kmap(buf->pages[page_nr]);
David Woodhouse6e03a202009-04-09 22:04:07 -0700720
721 memcpy(buffer, page_data + page_ofs, page_cnt);
722
Ming Lei12446912012-08-04 12:01:20 +0800723 kunmap(buf->pages[page_nr]);
David Woodhouse6e03a202009-04-09 22:04:07 -0700724 buffer += page_cnt;
725 offset += page_cnt;
726 count -= page_cnt;
727 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728out:
Laura Garciacad1e552006-05-23 23:22:38 +0200729 mutex_unlock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 return ret_count;
731}
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800732
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700733static int fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734{
Ming Lei12446912012-08-04 12:01:20 +0800735 struct firmware_buf *buf = fw_priv->buf;
Fabian Fredericka76040d2014-07-01 21:13:30 +0200736 int pages_needed = PAGE_ALIGN(min_size) >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737
David Woodhouse6e03a202009-04-09 22:04:07 -0700738 /* If the array of pages is too small, grow it... */
Ming Lei12446912012-08-04 12:01:20 +0800739 if (buf->page_array_size < pages_needed) {
David Woodhouse6e03a202009-04-09 22:04:07 -0700740 int new_array_size = max(pages_needed,
Ming Lei12446912012-08-04 12:01:20 +0800741 buf->page_array_size * 2);
David Woodhouse6e03a202009-04-09 22:04:07 -0700742 struct page **new_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743
David Woodhouse6e03a202009-04-09 22:04:07 -0700744 new_pages = kmalloc(new_array_size * sizeof(void *),
745 GFP_KERNEL);
746 if (!new_pages) {
747 fw_load_abort(fw_priv);
748 return -ENOMEM;
749 }
Ming Lei12446912012-08-04 12:01:20 +0800750 memcpy(new_pages, buf->pages,
751 buf->page_array_size * sizeof(void *));
752 memset(&new_pages[buf->page_array_size], 0, sizeof(void *) *
753 (new_array_size - buf->page_array_size));
754 kfree(buf->pages);
755 buf->pages = new_pages;
756 buf->page_array_size = new_array_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 }
David Woodhouse6e03a202009-04-09 22:04:07 -0700758
Ming Lei12446912012-08-04 12:01:20 +0800759 while (buf->nr_pages < pages_needed) {
760 buf->pages[buf->nr_pages] =
David Woodhouse6e03a202009-04-09 22:04:07 -0700761 alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
762
Ming Lei12446912012-08-04 12:01:20 +0800763 if (!buf->pages[buf->nr_pages]) {
David Woodhouse6e03a202009-04-09 22:04:07 -0700764 fw_load_abort(fw_priv);
765 return -ENOMEM;
766 }
Ming Lei12446912012-08-04 12:01:20 +0800767 buf->nr_pages++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 return 0;
770}
771
772/**
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800773 * firmware_data_write - write method for firmware
Chris Wright2c3c8be2010-05-12 18:28:57 -0700774 * @filp: open sysfs file
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700775 * @kobj: kobject for the device
Randy Dunlap42e61f42007-07-23 21:42:11 -0700776 * @bin_attr: bin_attr structure
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800777 * @buffer: buffer being written
778 * @offset: buffer offset for write in total data store area
779 * @count: buffer size
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 *
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800781 * Data written to the 'data' attribute will be later handed to
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 * the driver as a firmware image.
783 **/
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700784static ssize_t firmware_data_write(struct file *filp, struct kobject *kobj,
785 struct bin_attribute *bin_attr,
786 char *buffer, loff_t offset, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200788 struct device *dev = kobj_to_dev(kobj);
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700789 struct firmware_priv *fw_priv = to_firmware_priv(dev);
Ming Lei12446912012-08-04 12:01:20 +0800790 struct firmware_buf *buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 ssize_t retval;
792
793 if (!capable(CAP_SYS_RAWIO))
794 return -EPERM;
Stanislaw W. Gruszkab92eac02005-06-28 20:44:51 -0700795
Laura Garciacad1e552006-05-23 23:22:38 +0200796 mutex_lock(&fw_lock);
Ming Lei12446912012-08-04 12:01:20 +0800797 buf = fw_priv->buf;
798 if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 retval = -ENODEV;
800 goto out;
801 }
Ming Lei65710cb2012-08-04 12:01:16 +0800802
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 retval = fw_realloc_buffer(fw_priv, offset + count);
804 if (retval)
805 goto out;
806
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 retval = count;
David Woodhouse6e03a202009-04-09 22:04:07 -0700808
809 while (count) {
810 void *page_data;
811 int page_nr = offset >> PAGE_SHIFT;
812 int page_ofs = offset & (PAGE_SIZE - 1);
813 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
814
Ming Lei12446912012-08-04 12:01:20 +0800815 page_data = kmap(buf->pages[page_nr]);
David Woodhouse6e03a202009-04-09 22:04:07 -0700816
817 memcpy(page_data + page_ofs, buffer, page_cnt);
818
Ming Lei12446912012-08-04 12:01:20 +0800819 kunmap(buf->pages[page_nr]);
David Woodhouse6e03a202009-04-09 22:04:07 -0700820 buffer += page_cnt;
821 offset += page_cnt;
822 count -= page_cnt;
823 }
824
Ming Lei12446912012-08-04 12:01:20 +0800825 buf->size = max_t(size_t, offset, buf->size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826out:
Laura Garciacad1e552006-05-23 23:22:38 +0200827 mutex_unlock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 return retval;
829}
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800830
Dmitry Torokhov0983ca22010-06-04 00:54:37 -0700831static struct bin_attribute firmware_attr_data = {
832 .attr = { .name = "data", .mode = 0644 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 .size = 0,
834 .read = firmware_data_read,
835 .write = firmware_data_write,
836};
837
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700838static struct firmware_priv *
Stephen Boyddddb5542012-03-28 23:30:43 +0200839fw_create_instance(struct firmware *firmware, const char *fw_name,
Takashi Iwai14c4bae2013-12-02 15:38:18 +0100840 struct device *device, unsigned int opt_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841{
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700842 struct firmware_priv *fw_priv;
843 struct device *f_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844
Ming Lei12446912012-08-04 12:01:20 +0800845 fw_priv = kzalloc(sizeof(*fw_priv), GFP_KERNEL);
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700846 if (!fw_priv) {
Ming Lei12446912012-08-04 12:01:20 +0800847 fw_priv = ERR_PTR(-ENOMEM);
848 goto exit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850
Takashi Iwai14c4bae2013-12-02 15:38:18 +0100851 fw_priv->nowait = !!(opt_flags & FW_OPT_NOWAIT);
Ming Lei1f2b7952012-08-04 12:01:21 +0800852 fw_priv->fw = firmware;
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700853 f_dev = &fw_priv->dev;
854
855 device_initialize(f_dev);
Ming Lei99c2aa72012-08-04 12:01:19 +0800856 dev_set_name(f_dev, "%s", fw_name);
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700857 f_dev->parent = device;
858 f_dev->class = &firmware_class;
Ming Lei12446912012-08-04 12:01:20 +0800859exit:
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700860 return fw_priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861}
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100862
863/* load a firmware via user helper */
Takashi Iwai14c4bae2013-12-02 15:38:18 +0100864static int _request_firmware_load(struct firmware_priv *fw_priv,
865 unsigned int opt_flags, long timeout)
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100866{
867 int retval = 0;
868 struct device *f_dev = &fw_priv->dev;
869 struct firmware_buf *buf = fw_priv->buf;
870
871 /* fall back on userspace loading */
872 buf->is_paged_buf = true;
873
874 dev_set_uevent_suppress(f_dev, true);
875
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100876 retval = device_add(f_dev);
877 if (retval) {
878 dev_err(f_dev, "%s: device_register failed\n", __func__);
879 goto err_put_dev;
880 }
881
882 retval = device_create_bin_file(f_dev, &firmware_attr_data);
883 if (retval) {
884 dev_err(f_dev, "%s: sysfs_create_bin_file failed\n", __func__);
885 goto err_del_dev;
886 }
887
Maxime Bizon1eeeef12013-08-29 20:28:13 +0200888 mutex_lock(&fw_lock);
889 list_add(&buf->pending_list, &pending_fw_head);
890 mutex_unlock(&fw_lock);
891
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100892 retval = device_create_file(f_dev, &dev_attr_loading);
893 if (retval) {
Maxime Bizon1eeeef12013-08-29 20:28:13 +0200894 mutex_lock(&fw_lock);
895 list_del_init(&buf->pending_list);
896 mutex_unlock(&fw_lock);
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100897 dev_err(f_dev, "%s: device_create_file failed\n", __func__);
898 goto err_del_bin_attr;
899 }
900
Takashi Iwai14c4bae2013-12-02 15:38:18 +0100901 if (opt_flags & FW_OPT_UEVENT) {
Ming Leiaf5bc112013-05-27 18:30:04 +0800902 buf->need_uevent = true;
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100903 dev_set_uevent_suppress(f_dev, false);
904 dev_dbg(f_dev, "firmware: requesting %s\n", buf->fw_id);
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100905 kobject_uevent(&fw_priv->dev.kobj, KOBJ_ADD);
Ming Lei68ff2a02015-01-13 00:02:01 +0800906 } else {
907 timeout = MAX_JIFFY_OFFSET;
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100908 }
909
Ming Lei68ff2a02015-01-13 00:02:01 +0800910 retval = wait_for_completion_interruptible_timeout(&buf->completion,
911 timeout);
912 if (retval == -ERESTARTSYS || !retval) {
Ming Lei0cb64242015-01-13 00:01:35 +0800913 mutex_lock(&fw_lock);
914 fw_load_abort(fw_priv);
915 mutex_unlock(&fw_lock);
916 }
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100917
Shuah Khan0542ad82014-07-22 18:10:38 -0600918 if (is_fw_load_aborted(buf))
919 retval = -EAGAIN;
920 else if (!buf->data)
zhang jun2b1278c2014-02-13 15:18:47 +0800921 retval = -ENOMEM;
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100922
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100923 device_remove_file(f_dev, &dev_attr_loading);
924err_del_bin_attr:
925 device_remove_bin_file(f_dev, &firmware_attr_data);
926err_del_dev:
927 device_del(f_dev);
928err_put_dev:
929 put_device(f_dev);
930 return retval;
931}
932
933static int fw_load_from_user_helper(struct firmware *firmware,
934 const char *name, struct device *device,
Takashi Iwai14c4bae2013-12-02 15:38:18 +0100935 unsigned int opt_flags, long timeout)
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100936{
937 struct firmware_priv *fw_priv;
938
Takashi Iwai14c4bae2013-12-02 15:38:18 +0100939 fw_priv = fw_create_instance(firmware, name, device, opt_flags);
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100940 if (IS_ERR(fw_priv))
941 return PTR_ERR(fw_priv);
942
943 fw_priv->buf = firmware->priv;
Takashi Iwai14c4bae2013-12-02 15:38:18 +0100944 return _request_firmware_load(fw_priv, opt_flags, timeout);
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100945}
Ming Leiddf1f062013-06-04 10:01:13 +0800946
Ming Lei5b7cb7a2013-06-06 19:52:54 +0800947#ifdef CONFIG_PM_SLEEP
Ming Leiddf1f062013-06-04 10:01:13 +0800948/* kill pending requests without uevent to avoid blocking suspend */
949static void kill_requests_without_uevent(void)
950{
951 struct firmware_buf *buf;
952 struct firmware_buf *next;
953
954 mutex_lock(&fw_lock);
955 list_for_each_entry_safe(buf, next, &pending_fw_head, pending_list) {
956 if (!buf->need_uevent)
Greg Kroah-Hartman7068cb02013-06-19 20:26:43 -0700957 __fw_load_abort(buf);
Ming Leiddf1f062013-06-04 10:01:13 +0800958 }
959 mutex_unlock(&fw_lock);
960}
Ming Lei5b7cb7a2013-06-06 19:52:54 +0800961#endif
Ming Leiddf1f062013-06-04 10:01:13 +0800962
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100963#else /* CONFIG_FW_LOADER_USER_HELPER */
964static inline int
965fw_load_from_user_helper(struct firmware *firmware, const char *name,
Takashi Iwai14c4bae2013-12-02 15:38:18 +0100966 struct device *device, unsigned int opt_flags,
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100967 long timeout)
968{
969 return -ENOENT;
970}
Takashi Iwai807be032013-01-31 11:13:57 +0100971
972/* No abort during direct loading */
973#define is_fw_load_aborted(buf) false
974
Ming Lei5b7cb7a2013-06-06 19:52:54 +0800975#ifdef CONFIG_PM_SLEEP
Ming Leiddf1f062013-06-04 10:01:13 +0800976static inline void kill_requests_without_uevent(void) { }
Ming Lei5b7cb7a2013-06-06 19:52:54 +0800977#endif
Ming Leiddf1f062013-06-04 10:01:13 +0800978
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100979#endif /* CONFIG_FW_LOADER_USER_HELPER */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980
Ming Leif531f05a2012-08-04 12:01:25 +0800981
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100982/* wait until the shared firmware_buf becomes ready (or error) */
983static int sync_cached_firmware_buf(struct firmware_buf *buf)
Ming Lei1f2b7952012-08-04 12:01:21 +0800984{
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100985 int ret = 0;
986
987 mutex_lock(&fw_lock);
988 while (!test_bit(FW_STATUS_DONE, &buf->status)) {
Takashi Iwai807be032013-01-31 11:13:57 +0100989 if (is_fw_load_aborted(buf)) {
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100990 ret = -ENOENT;
991 break;
992 }
993 mutex_unlock(&fw_lock);
Kweh, Hock Leong000deba2014-11-18 10:56:59 +0800994 ret = wait_for_completion_interruptible(&buf->completion);
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100995 mutex_lock(&fw_lock);
996 }
997 mutex_unlock(&fw_lock);
998 return ret;
Ming Lei1f2b7952012-08-04 12:01:21 +0800999}
1000
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001001/* prepare firmware and firmware_buf structs;
1002 * return 0 if a firmware is already assigned, 1 if need to load one,
1003 * or a negative error code
1004 */
1005static int
1006_request_firmware_prepare(struct firmware **firmware_p, const char *name,
1007 struct device *device)
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -07001008{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 struct firmware *firmware;
Ming Lei1f2b7952012-08-04 12:01:21 +08001010 struct firmware_buf *buf;
1011 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012
Jiri Slaby4aed0642005-09-13 01:25:01 -07001013 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 if (!firmware) {
Bjorn Helgaas266a8132008-10-15 22:04:20 -07001015 dev_err(device, "%s: kmalloc(struct firmware) failed\n",
1016 __func__);
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001017 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019
Dmitry Torokhovbcb9bd12010-03-13 23:49:18 -08001020 if (fw_get_builtin_firmware(firmware, name)) {
Rafael J. Wysocki6f18ff92010-02-27 21:43:22 +01001021 dev_dbg(device, "firmware: using built-in firmware %s\n", name);
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001022 return 0; /* assigned */
David Woodhouse5658c762008-05-23 13:52:42 +01001023 }
1024
Ming Lei1f2b7952012-08-04 12:01:21 +08001025 ret = fw_lookup_and_allocate_buf(name, &fw_cache, &buf);
Ming Lei1f2b7952012-08-04 12:01:21 +08001026
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001027 /*
1028 * bind with 'buf' now to avoid warning in failure path
1029 * of requesting firmware.
1030 */
1031 firmware->priv = buf;
Ming Lei1f2b7952012-08-04 12:01:21 +08001032
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001033 if (ret > 0) {
1034 ret = sync_cached_firmware_buf(buf);
1035 if (!ret) {
1036 fw_set_page_data(buf, firmware);
1037 return 0; /* assigned */
1038 }
Stephen Boyddddb5542012-03-28 23:30:43 +02001039 }
Ming Lei1f2b7952012-08-04 12:01:21 +08001040
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001041 if (ret < 0)
1042 return ret;
1043 return 1; /* need to load */
Rafael J. Wysocki811fa402012-03-28 23:29:55 +02001044}
1045
Ming Leie771d1a2013-05-27 18:30:03 +08001046static int assign_firmware_buf(struct firmware *fw, struct device *device,
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001047 unsigned int opt_flags)
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001048{
1049 struct firmware_buf *buf = fw->priv;
1050
1051 mutex_lock(&fw_lock);
Takashi Iwai807be032013-01-31 11:13:57 +01001052 if (!buf->size || is_fw_load_aborted(buf)) {
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001053 mutex_unlock(&fw_lock);
1054 return -ENOENT;
1055 }
1056
1057 /*
1058 * add firmware name into devres list so that we can auto cache
1059 * and uncache firmware for device.
1060 *
1061 * device may has been deleted already, but the problem
1062 * should be fixed in devres or driver core.
1063 */
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001064 /* don't cache firmware handled without uevent */
1065 if (device && (opt_flags & FW_OPT_UEVENT))
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001066 fw_add_devm_name(device, buf->fw_id);
1067
1068 /*
1069 * After caching firmware image is started, let it piggyback
1070 * on request firmware.
1071 */
1072 if (buf->fwc->state == FW_LOADER_START_CACHE) {
1073 if (fw_cache_piggyback_on_request(buf->fw_id))
1074 kref_get(&buf->ref);
1075 }
1076
1077 /* pass the pages buffer to driver at the last minute */
1078 fw_set_page_data(buf, fw);
1079 mutex_unlock(&fw_lock);
1080 return 0;
1081}
1082
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001083/* called from request_firmware() and request_firmware_work_func() */
1084static int
1085_request_firmware(const struct firmware **firmware_p, const char *name,
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001086 struct device *device, unsigned int opt_flags)
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001087{
1088 struct firmware *fw;
1089 long timeout;
1090 int ret;
1091
1092 if (!firmware_p)
1093 return -EINVAL;
1094
Kees Cook471b0952014-09-18 11:25:37 -07001095 if (!name || name[0] == '\0')
1096 return -EINVAL;
1097
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001098 ret = _request_firmware_prepare(&fw, name, device);
1099 if (ret <= 0) /* error or already assigned */
1100 goto out;
1101
1102 ret = 0;
1103 timeout = firmware_loading_timeout();
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001104 if (opt_flags & FW_OPT_NOWAIT) {
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001105 timeout = usermodehelper_read_lock_wait(timeout);
1106 if (!timeout) {
1107 dev_dbg(device, "firmware: %s loading timed out\n",
1108 name);
1109 ret = -EBUSY;
1110 goto out;
1111 }
1112 } else {
1113 ret = usermodehelper_read_trylock();
1114 if (WARN_ON(ret)) {
1115 dev_err(device, "firmware: %s will not be loaded\n",
1116 name);
1117 goto out;
1118 }
1119 }
1120
Neil Horman3e358ac2013-09-06 15:36:08 -04001121 ret = fw_get_filesystem_firmware(device, fw->priv);
1122 if (ret) {
Luis R. Rodriguezc868edf2014-07-02 09:55:05 -07001123 if (!(opt_flags & FW_OPT_NO_WARN))
Takashi Iwaibba3a872013-12-02 15:38:16 +01001124 dev_warn(device,
Luis R. Rodriguezc868edf2014-07-02 09:55:05 -07001125 "Direct firmware load for %s failed with error %d\n",
1126 name, ret);
1127 if (opt_flags & FW_OPT_USERHELPER) {
Takashi Iwaibba3a872013-12-02 15:38:16 +01001128 dev_warn(device, "Falling back to user helper\n");
1129 ret = fw_load_from_user_helper(fw, name, device,
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001130 opt_flags, timeout);
Takashi Iwaibba3a872013-12-02 15:38:16 +01001131 }
Neil Horman3e358ac2013-09-06 15:36:08 -04001132 }
Ming Leie771d1a2013-05-27 18:30:03 +08001133
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001134 if (!ret)
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001135 ret = assign_firmware_buf(fw, device, opt_flags);
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001136
1137 usermodehelper_read_unlock();
1138
1139 out:
1140 if (ret < 0) {
1141 release_firmware(fw);
1142 fw = NULL;
1143 }
1144
1145 *firmware_p = fw;
1146 return ret;
1147}
1148
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149/**
Kay Sievers312c0042005-11-16 09:00:00 +01001150 * request_firmware: - send firmware request and wait for it
Randy Dunlapeb8e3172005-10-30 15:03:01 -08001151 * @firmware_p: pointer to firmware image
1152 * @name: name of firmware file
1153 * @device: device for which firmware is being loaded
1154 *
1155 * @firmware_p will be used to return a firmware image by the name
Abhay Salunke6e3eaab2005-09-06 15:17:13 -07001156 * of @name for device @device.
1157 *
1158 * Should be called from user context where sleeping is allowed.
1159 *
Kay Sievers312c0042005-11-16 09:00:00 +01001160 * @name will be used as $FIRMWARE in the uevent environment and
Abhay Salunke6e3eaab2005-09-06 15:17:13 -07001161 * should be distinctive enough not to be confused with any other
1162 * firmware image for this or any other device.
Ming Lei0cfc1e12012-08-04 12:01:23 +08001163 *
1164 * Caller must hold the reference count of @device.
Ming Lei6a927852012-11-03 17:48:16 +08001165 *
1166 * The function can be called safely inside device's suspend and
1167 * resume callback.
Abhay Salunke6e3eaab2005-09-06 15:17:13 -07001168 **/
1169int
1170request_firmware(const struct firmware **firmware_p, const char *name,
1171 struct device *device)
1172{
Ming Leid6c8aa32013-06-06 20:01:48 +08001173 int ret;
1174
1175 /* Need to pin this module until return */
1176 __module_get(THIS_MODULE);
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001177 ret = _request_firmware(firmware_p, name, device,
1178 FW_OPT_UEVENT | FW_OPT_FALLBACK);
Ming Leid6c8aa32013-06-06 20:01:48 +08001179 module_put(THIS_MODULE);
1180 return ret;
Abhay Salunke6e3eaab2005-09-06 15:17:13 -07001181}
Daniel Mackf4945132013-05-23 22:17:18 +02001182EXPORT_SYMBOL(request_firmware);
Abhay Salunke6e3eaab2005-09-06 15:17:13 -07001183
Takashi Iwaibba3a872013-12-02 15:38:16 +01001184/**
Borislav Petkov3c1556b2014-12-03 22:46:37 +01001185 * request_firmware_direct: - load firmware directly without usermode helper
Takashi Iwaibba3a872013-12-02 15:38:16 +01001186 * @firmware_p: pointer to firmware image
1187 * @name: name of firmware file
1188 * @device: device for which firmware is being loaded
1189 *
1190 * This function works pretty much like request_firmware(), but this doesn't
1191 * fall back to usermode helper even if the firmware couldn't be loaded
1192 * directly from fs. Hence it's useful for loading optional firmwares, which
1193 * aren't always present, without extra long timeouts of udev.
1194 **/
1195int request_firmware_direct(const struct firmware **firmware_p,
1196 const char *name, struct device *device)
1197{
1198 int ret;
1199 __module_get(THIS_MODULE);
Luis R. Rodriguezc868edf2014-07-02 09:55:05 -07001200 ret = _request_firmware(firmware_p, name, device,
1201 FW_OPT_UEVENT | FW_OPT_NO_WARN);
Takashi Iwaibba3a872013-12-02 15:38:16 +01001202 module_put(THIS_MODULE);
1203 return ret;
1204}
1205EXPORT_SYMBOL_GPL(request_firmware_direct);
Takashi Iwaibba3a872013-12-02 15:38:16 +01001206
Abhay Salunke6e3eaab2005-09-06 15:17:13 -07001207/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208 * release_firmware: - release the resource associated with a firmware image
Randy Dunlapeb8e3172005-10-30 15:03:01 -08001209 * @fw: firmware resource to release
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210 **/
Dmitry Torokhovbcb9bd12010-03-13 23:49:18 -08001211void release_firmware(const struct firmware *fw)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212{
1213 if (fw) {
Dmitry Torokhovbcb9bd12010-03-13 23:49:18 -08001214 if (!fw_is_builtin_firmware(fw))
1215 firmware_free_data(fw);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 kfree(fw);
1217 }
1218}
Daniel Mackf4945132013-05-23 22:17:18 +02001219EXPORT_SYMBOL(release_firmware);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221/* Async support */
1222struct firmware_work {
1223 struct work_struct work;
1224 struct module *module;
1225 const char *name;
1226 struct device *device;
1227 void *context;
1228 void (*cont)(const struct firmware *fw, void *context);
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001229 unsigned int opt_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230};
1231
Stephen Boyda36cf842012-03-28 23:31:00 +02001232static void request_firmware_work_func(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233{
Stephen Boyda36cf842012-03-28 23:31:00 +02001234 struct firmware_work *fw_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 const struct firmware *fw;
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -07001236
Stephen Boyda36cf842012-03-28 23:31:00 +02001237 fw_work = container_of(work, struct firmware_work, work);
Rafael J. Wysocki811fa402012-03-28 23:29:55 +02001238
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001239 _request_firmware(&fw, fw_work->name, fw_work->device,
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001240 fw_work->opt_flags);
Johannes Berg9ebfbd42009-10-29 12:36:02 +01001241 fw_work->cont(fw, fw_work->context);
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001242 put_device(fw_work->device); /* taken in request_firmware_nowait() */
Johannes Berg9ebfbd42009-10-29 12:36:02 +01001243
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 module_put(fw_work->module);
1245 kfree(fw_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246}
1247
1248/**
Ben Hutchings3c31f072010-02-14 14:18:53 +00001249 * request_firmware_nowait - asynchronous version of request_firmware
Randy Dunlapeb8e3172005-10-30 15:03:01 -08001250 * @module: module requesting the firmware
Kay Sievers312c0042005-11-16 09:00:00 +01001251 * @uevent: sends uevent to copy the firmware image if this flag
Randy Dunlapeb8e3172005-10-30 15:03:01 -08001252 * is non-zero else the firmware copy must be done manually.
1253 * @name: name of firmware file
1254 * @device: device for which firmware is being loaded
Johannes Berg9ebfbd42009-10-29 12:36:02 +01001255 * @gfp: allocation flags
Randy Dunlapeb8e3172005-10-30 15:03:01 -08001256 * @context: will be passed over to @cont, and
1257 * @fw may be %NULL if firmware request fails.
1258 * @cont: function will be called asynchronously when the firmware
1259 * request is over.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260 *
Ming Lei0cfc1e12012-08-04 12:01:23 +08001261 * Caller must hold the reference count of @device.
1262 *
Ming Lei6f21a622012-08-04 12:01:24 +08001263 * Asynchronous variant of request_firmware() for user contexts:
1264 * - sleep for as small periods as possible since it may
1265 * increase kernel boot time of built-in device drivers
1266 * requesting firmware in their ->probe() methods, if
1267 * @gfp is GFP_KERNEL.
1268 *
1269 * - can't sleep at all if @gfp is GFP_ATOMIC.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 **/
1271int
1272request_firmware_nowait(
Bob Liu072fc8f2011-01-26 18:33:32 +08001273 struct module *module, bool uevent,
Johannes Berg9ebfbd42009-10-29 12:36:02 +01001274 const char *name, struct device *device, gfp_t gfp, void *context,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275 void (*cont)(const struct firmware *fw, void *context))
1276{
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -07001277 struct firmware_work *fw_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -07001279 fw_work = kzalloc(sizeof (struct firmware_work), gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 if (!fw_work)
1281 return -ENOMEM;
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -07001282
1283 fw_work->module = module;
1284 fw_work->name = name;
1285 fw_work->device = device;
1286 fw_work->context = context;
1287 fw_work->cont = cont;
Takashi Iwai14c4bae2013-12-02 15:38:18 +01001288 fw_work->opt_flags = FW_OPT_NOWAIT | FW_OPT_FALLBACK |
Takashi Iwai5a1379e2014-06-04 17:48:15 +02001289 (uevent ? FW_OPT_UEVENT : FW_OPT_USERHELPER);
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -07001290
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 if (!try_module_get(module)) {
1292 kfree(fw_work);
1293 return -EFAULT;
1294 }
1295
Ming Lei0cfc1e12012-08-04 12:01:23 +08001296 get_device(fw_work->device);
Stephen Boyda36cf842012-03-28 23:31:00 +02001297 INIT_WORK(&fw_work->work, request_firmware_work_func);
1298 schedule_work(&fw_work->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 return 0;
1300}
Daniel Mackf4945132013-05-23 22:17:18 +02001301EXPORT_SYMBOL(request_firmware_nowait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302
Ming Lei90f890812013-06-20 12:30:16 +08001303#ifdef CONFIG_PM_SLEEP
1304static ASYNC_DOMAIN_EXCLUSIVE(fw_cache_domain);
1305
Ming Lei2887b392012-08-04 12:01:22 +08001306/**
1307 * cache_firmware - cache one firmware image in kernel memory space
1308 * @fw_name: the firmware image name
1309 *
1310 * Cache firmware in kernel memory so that drivers can use it when
1311 * system isn't ready for them to request firmware image from userspace.
1312 * Once it returns successfully, driver can use request_firmware or its
1313 * nowait version to get the cached firmware without any interacting
1314 * with userspace
1315 *
1316 * Return 0 if the firmware image has been cached successfully
1317 * Return !0 otherwise
1318 *
1319 */
Ming Lei93232e42013-06-06 20:01:47 +08001320static int cache_firmware(const char *fw_name)
Ming Lei2887b392012-08-04 12:01:22 +08001321{
1322 int ret;
1323 const struct firmware *fw;
1324
1325 pr_debug("%s: %s\n", __func__, fw_name);
1326
1327 ret = request_firmware(&fw, fw_name, NULL);
1328 if (!ret)
1329 kfree(fw);
1330
1331 pr_debug("%s: %s ret=%d\n", __func__, fw_name, ret);
1332
1333 return ret;
1334}
1335
Ming Lei6a2c1232013-06-26 09:28:17 +08001336static struct firmware_buf *fw_lookup_buf(const char *fw_name)
1337{
1338 struct firmware_buf *tmp;
1339 struct firmware_cache *fwc = &fw_cache;
1340
1341 spin_lock(&fwc->lock);
1342 tmp = __fw_lookup_buf(fw_name);
1343 spin_unlock(&fwc->lock);
1344
1345 return tmp;
1346}
1347
Ming Lei2887b392012-08-04 12:01:22 +08001348/**
1349 * uncache_firmware - remove one cached firmware image
1350 * @fw_name: the firmware image name
1351 *
1352 * Uncache one firmware image which has been cached successfully
1353 * before.
1354 *
1355 * Return 0 if the firmware cache has been removed successfully
1356 * Return !0 otherwise
1357 *
1358 */
Ming Lei93232e42013-06-06 20:01:47 +08001359static int uncache_firmware(const char *fw_name)
Ming Lei2887b392012-08-04 12:01:22 +08001360{
1361 struct firmware_buf *buf;
1362 struct firmware fw;
1363
1364 pr_debug("%s: %s\n", __func__, fw_name);
1365
1366 if (fw_get_builtin_firmware(&fw, fw_name))
1367 return 0;
1368
1369 buf = fw_lookup_buf(fw_name);
1370 if (buf) {
1371 fw_free_buf(buf);
1372 return 0;
1373 }
1374
1375 return -EINVAL;
1376}
1377
Ming Lei37276a52012-08-04 12:01:27 +08001378static struct fw_cache_entry *alloc_fw_cache_entry(const char *name)
1379{
1380 struct fw_cache_entry *fce;
1381
1382 fce = kzalloc(sizeof(*fce) + strlen(name) + 1, GFP_ATOMIC);
1383 if (!fce)
1384 goto exit;
1385
1386 strcpy(fce->name, name);
1387exit:
1388 return fce;
1389}
1390
Ming Lei373304f2012-10-09 12:01:01 +08001391static int __fw_entry_found(const char *name)
1392{
1393 struct firmware_cache *fwc = &fw_cache;
1394 struct fw_cache_entry *fce;
1395
1396 list_for_each_entry(fce, &fwc->fw_names, list) {
1397 if (!strcmp(fce->name, name))
1398 return 1;
1399 }
1400 return 0;
1401}
1402
Ming Leiac39b3e2012-08-20 19:04:16 +08001403static int fw_cache_piggyback_on_request(const char *name)
1404{
1405 struct firmware_cache *fwc = &fw_cache;
1406 struct fw_cache_entry *fce;
1407 int ret = 0;
1408
1409 spin_lock(&fwc->name_lock);
Ming Lei373304f2012-10-09 12:01:01 +08001410 if (__fw_entry_found(name))
1411 goto found;
Ming Leiac39b3e2012-08-20 19:04:16 +08001412
1413 fce = alloc_fw_cache_entry(name);
1414 if (fce) {
1415 ret = 1;
1416 list_add(&fce->list, &fwc->fw_names);
1417 pr_debug("%s: fw: %s\n", __func__, name);
1418 }
1419found:
1420 spin_unlock(&fwc->name_lock);
1421 return ret;
1422}
1423
Ming Lei37276a52012-08-04 12:01:27 +08001424static void free_fw_cache_entry(struct fw_cache_entry *fce)
1425{
1426 kfree(fce);
1427}
1428
1429static void __async_dev_cache_fw_image(void *fw_entry,
1430 async_cookie_t cookie)
1431{
1432 struct fw_cache_entry *fce = fw_entry;
1433 struct firmware_cache *fwc = &fw_cache;
1434 int ret;
1435
1436 ret = cache_firmware(fce->name);
Ming Leiac39b3e2012-08-20 19:04:16 +08001437 if (ret) {
1438 spin_lock(&fwc->name_lock);
1439 list_del(&fce->list);
1440 spin_unlock(&fwc->name_lock);
Ming Lei37276a52012-08-04 12:01:27 +08001441
Ming Leiac39b3e2012-08-20 19:04:16 +08001442 free_fw_cache_entry(fce);
1443 }
Ming Lei37276a52012-08-04 12:01:27 +08001444}
1445
1446/* called with dev->devres_lock held */
1447static void dev_create_fw_entry(struct device *dev, void *res,
1448 void *data)
1449{
1450 struct fw_name_devm *fwn = res;
1451 const char *fw_name = fwn->name;
1452 struct list_head *head = data;
1453 struct fw_cache_entry *fce;
1454
1455 fce = alloc_fw_cache_entry(fw_name);
1456 if (fce)
1457 list_add(&fce->list, head);
1458}
1459
1460static int devm_name_match(struct device *dev, void *res,
1461 void *match_data)
1462{
1463 struct fw_name_devm *fwn = res;
1464 return (fwn->magic == (unsigned long)match_data);
1465}
1466
Ming Leiab6dd8e2012-08-17 22:07:00 +08001467static void dev_cache_fw_image(struct device *dev, void *data)
Ming Lei37276a52012-08-04 12:01:27 +08001468{
1469 LIST_HEAD(todo);
1470 struct fw_cache_entry *fce;
1471 struct fw_cache_entry *fce_next;
1472 struct firmware_cache *fwc = &fw_cache;
1473
1474 devres_for_each_res(dev, fw_name_devm_release,
1475 devm_name_match, &fw_cache,
1476 dev_create_fw_entry, &todo);
1477
1478 list_for_each_entry_safe(fce, fce_next, &todo, list) {
1479 list_del(&fce->list);
1480
1481 spin_lock(&fwc->name_lock);
Ming Lei373304f2012-10-09 12:01:01 +08001482 /* only one cache entry for one firmware */
1483 if (!__fw_entry_found(fce->name)) {
Ming Lei373304f2012-10-09 12:01:01 +08001484 list_add(&fce->list, &fwc->fw_names);
1485 } else {
1486 free_fw_cache_entry(fce);
1487 fce = NULL;
1488 }
Ming Lei37276a52012-08-04 12:01:27 +08001489 spin_unlock(&fwc->name_lock);
1490
Ming Lei373304f2012-10-09 12:01:01 +08001491 if (fce)
Ming Leid28d3882012-10-09 12:01:04 +08001492 async_schedule_domain(__async_dev_cache_fw_image,
1493 (void *)fce,
1494 &fw_cache_domain);
Ming Lei37276a52012-08-04 12:01:27 +08001495 }
1496}
1497
1498static void __device_uncache_fw_images(void)
1499{
1500 struct firmware_cache *fwc = &fw_cache;
1501 struct fw_cache_entry *fce;
1502
1503 spin_lock(&fwc->name_lock);
1504 while (!list_empty(&fwc->fw_names)) {
1505 fce = list_entry(fwc->fw_names.next,
1506 struct fw_cache_entry, list);
1507 list_del(&fce->list);
1508 spin_unlock(&fwc->name_lock);
1509
1510 uncache_firmware(fce->name);
1511 free_fw_cache_entry(fce);
1512
1513 spin_lock(&fwc->name_lock);
1514 }
1515 spin_unlock(&fwc->name_lock);
1516}
1517
1518/**
1519 * device_cache_fw_images - cache devices' firmware
1520 *
1521 * If one device called request_firmware or its nowait version
1522 * successfully before, the firmware names are recored into the
1523 * device's devres link list, so device_cache_fw_images can call
1524 * cache_firmware() to cache these firmwares for the device,
1525 * then the device driver can load its firmwares easily at
1526 * time when system is not ready to complete loading firmware.
1527 */
1528static void device_cache_fw_images(void)
1529{
1530 struct firmware_cache *fwc = &fw_cache;
Ming Leiffe53f62012-08-04 12:01:28 +08001531 int old_timeout;
Ming Lei37276a52012-08-04 12:01:27 +08001532 DEFINE_WAIT(wait);
1533
1534 pr_debug("%s\n", __func__);
1535
Ming Lei373304f2012-10-09 12:01:01 +08001536 /* cancel uncache work */
1537 cancel_delayed_work_sync(&fwc->work);
1538
Ming Leiffe53f62012-08-04 12:01:28 +08001539 /*
1540 * use small loading timeout for caching devices' firmware
1541 * because all these firmware images have been loaded
1542 * successfully at lease once, also system is ready for
1543 * completing firmware loading now. The maximum size of
1544 * firmware in current distributions is about 2M bytes,
1545 * so 10 secs should be enough.
1546 */
1547 old_timeout = loading_timeout;
1548 loading_timeout = 10;
1549
Ming Leiac39b3e2012-08-20 19:04:16 +08001550 mutex_lock(&fw_lock);
1551 fwc->state = FW_LOADER_START_CACHE;
Ming Leiab6dd8e2012-08-17 22:07:00 +08001552 dpm_for_each_dev(NULL, dev_cache_fw_image);
Ming Leiac39b3e2012-08-20 19:04:16 +08001553 mutex_unlock(&fw_lock);
Ming Lei37276a52012-08-04 12:01:27 +08001554
1555 /* wait for completion of caching firmware for all devices */
Ming Leid28d3882012-10-09 12:01:04 +08001556 async_synchronize_full_domain(&fw_cache_domain);
Ming Leiffe53f62012-08-04 12:01:28 +08001557
1558 loading_timeout = old_timeout;
Ming Lei37276a52012-08-04 12:01:27 +08001559}
1560
1561/**
1562 * device_uncache_fw_images - uncache devices' firmware
1563 *
1564 * uncache all firmwares which have been cached successfully
1565 * by device_uncache_fw_images earlier
1566 */
1567static void device_uncache_fw_images(void)
1568{
1569 pr_debug("%s\n", __func__);
1570 __device_uncache_fw_images();
1571}
1572
1573static void device_uncache_fw_images_work(struct work_struct *work)
1574{
1575 device_uncache_fw_images();
1576}
1577
1578/**
1579 * device_uncache_fw_images_delay - uncache devices firmwares
1580 * @delay: number of milliseconds to delay uncache device firmwares
1581 *
1582 * uncache all devices's firmwares which has been cached successfully
1583 * by device_cache_fw_images after @delay milliseconds.
1584 */
1585static void device_uncache_fw_images_delay(unsigned long delay)
1586{
Shaibal Duttabce66182014-01-31 15:44:58 -08001587 queue_delayed_work(system_power_efficient_wq, &fw_cache.work,
1588 msecs_to_jiffies(delay));
Ming Lei37276a52012-08-04 12:01:27 +08001589}
1590
Ming Lei07646d92012-08-04 12:01:29 +08001591static int fw_pm_notify(struct notifier_block *notify_block,
1592 unsigned long mode, void *unused)
1593{
1594 switch (mode) {
1595 case PM_HIBERNATION_PREPARE:
1596 case PM_SUSPEND_PREPARE:
Sebastian Capellaf8d5b9e2014-02-18 17:52:08 -08001597 case PM_RESTORE_PREPARE:
Ming Leiaf5bc112013-05-27 18:30:04 +08001598 kill_requests_without_uevent();
Ming Lei07646d92012-08-04 12:01:29 +08001599 device_cache_fw_images();
1600 break;
1601
1602 case PM_POST_SUSPEND:
1603 case PM_POST_HIBERNATION:
1604 case PM_POST_RESTORE:
Ming Leiac39b3e2012-08-20 19:04:16 +08001605 /*
1606 * In case that system sleep failed and syscore_suspend is
1607 * not called.
1608 */
1609 mutex_lock(&fw_lock);
1610 fw_cache.state = FW_LOADER_NO_CACHE;
1611 mutex_unlock(&fw_lock);
1612
Ming Lei07646d92012-08-04 12:01:29 +08001613 device_uncache_fw_images_delay(10 * MSEC_PER_SEC);
1614 break;
1615 }
1616
1617 return 0;
1618}
Ming Lei07646d92012-08-04 12:01:29 +08001619
Ming Leiac39b3e2012-08-20 19:04:16 +08001620/* stop caching firmware once syscore_suspend is reached */
1621static int fw_suspend(void)
1622{
1623 fw_cache.state = FW_LOADER_NO_CACHE;
1624 return 0;
1625}
1626
1627static struct syscore_ops fw_syscore_ops = {
1628 .suspend = fw_suspend,
1629};
Ming Leicfe016b2012-09-08 17:32:30 +08001630#else
1631static int fw_cache_piggyback_on_request(const char *name)
1632{
1633 return 0;
1634}
1635#endif
Ming Leiac39b3e2012-08-20 19:04:16 +08001636
Ming Lei37276a52012-08-04 12:01:27 +08001637static void __init fw_cache_init(void)
1638{
1639 spin_lock_init(&fw_cache.lock);
1640 INIT_LIST_HEAD(&fw_cache.head);
Ming Leicfe016b2012-09-08 17:32:30 +08001641 fw_cache.state = FW_LOADER_NO_CACHE;
Ming Lei37276a52012-08-04 12:01:27 +08001642
Ming Leicfe016b2012-09-08 17:32:30 +08001643#ifdef CONFIG_PM_SLEEP
Ming Lei37276a52012-08-04 12:01:27 +08001644 spin_lock_init(&fw_cache.name_lock);
1645 INIT_LIST_HEAD(&fw_cache.fw_names);
Ming Lei37276a52012-08-04 12:01:27 +08001646
Ming Lei37276a52012-08-04 12:01:27 +08001647 INIT_DELAYED_WORK(&fw_cache.work,
1648 device_uncache_fw_images_work);
Ming Lei07646d92012-08-04 12:01:29 +08001649
1650 fw_cache.pm_notify.notifier_call = fw_pm_notify;
1651 register_pm_notifier(&fw_cache.pm_notify);
Ming Leiac39b3e2012-08-20 19:04:16 +08001652
1653 register_syscore_ops(&fw_syscore_ops);
Ming Leicfe016b2012-09-08 17:32:30 +08001654#endif
Ming Lei37276a52012-08-04 12:01:27 +08001655}
1656
Dmitry Torokhov673fae92010-03-13 23:49:13 -08001657static int __init firmware_class_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658{
Ming Lei1f2b7952012-08-04 12:01:21 +08001659 fw_cache_init();
Takashi Iwai7b1269f2013-01-31 11:13:55 +01001660#ifdef CONFIG_FW_LOADER_USER_HELPER
Takashi Iwaife304142013-05-22 18:28:38 +02001661 register_reboot_notifier(&fw_shutdown_nb);
Dmitry Torokhov673fae92010-03-13 23:49:13 -08001662 return class_register(&firmware_class);
Takashi Iwai7b1269f2013-01-31 11:13:55 +01001663#else
1664 return 0;
1665#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666}
Dmitry Torokhov673fae92010-03-13 23:49:13 -08001667
1668static void __exit firmware_class_exit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669{
Ming Leicfe016b2012-09-08 17:32:30 +08001670#ifdef CONFIG_PM_SLEEP
Ming Leiac39b3e2012-08-20 19:04:16 +08001671 unregister_syscore_ops(&fw_syscore_ops);
Ming Lei07646d92012-08-04 12:01:29 +08001672 unregister_pm_notifier(&fw_cache.pm_notify);
Ming Leicfe016b2012-09-08 17:32:30 +08001673#endif
Takashi Iwai7b1269f2013-01-31 11:13:55 +01001674#ifdef CONFIG_FW_LOADER_USER_HELPER
Takashi Iwaife304142013-05-22 18:28:38 +02001675 unregister_reboot_notifier(&fw_shutdown_nb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676 class_unregister(&firmware_class);
Takashi Iwai7b1269f2013-01-31 11:13:55 +01001677#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678}
1679
Shaohua Lia30a6a22006-09-27 01:50:52 -07001680fs_initcall(firmware_class_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681module_exit(firmware_class_exit);