blob: a439602ea9194f409286147d4e33b39cc1114cda [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
Ming Lei1f2b7952012-08-04 12:01:21 +080099struct firmware_cache {
100 /* firmware_buf instance will be added into the below list */
101 spinlock_t lock;
102 struct list_head head;
Ming Leicfe016b2012-09-08 17:32:30 +0800103 int state;
Ming Lei37276a52012-08-04 12:01:27 +0800104
Ming Leicfe016b2012-09-08 17:32:30 +0800105#ifdef CONFIG_PM_SLEEP
Ming Lei37276a52012-08-04 12:01:27 +0800106 /*
107 * Names of firmware images which have been cached successfully
108 * will be added into the below list so that device uncache
109 * helper can trace which firmware images have been cached
110 * before.
111 */
112 spinlock_t name_lock;
113 struct list_head fw_names;
114
Ming Lei37276a52012-08-04 12:01:27 +0800115 struct delayed_work work;
Ming Lei07646d92012-08-04 12:01:29 +0800116
117 struct notifier_block pm_notify;
Ming Leicfe016b2012-09-08 17:32:30 +0800118#endif
Ming Lei1f2b7952012-08-04 12:01:21 +0800119};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
Ming Lei12446912012-08-04 12:01:20 +0800121struct firmware_buf {
Ming Lei1f2b7952012-08-04 12:01:21 +0800122 struct kref ref;
123 struct list_head list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 struct completion completion;
Ming Lei1f2b7952012-08-04 12:01:21 +0800125 struct firmware_cache *fwc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 unsigned long status;
Ming Lei65710cb2012-08-04 12:01:16 +0800127 void *data;
128 size_t size;
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100129#ifdef CONFIG_FW_LOADER_USER_HELPER
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100130 bool is_paged_buf;
Ming Leiaf5bc112013-05-27 18:30:04 +0800131 bool need_uevent;
David Woodhouse6e03a202009-04-09 22:04:07 -0700132 struct page **pages;
133 int nr_pages;
134 int page_array_size;
Takashi Iwaife304142013-05-22 18:28:38 +0200135 struct list_head pending_list;
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100136#endif
Dmitry Torokhove1771232010-03-13 23:49:23 -0800137 char fw_id[];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138};
139
Ming Lei37276a52012-08-04 12:01:27 +0800140struct fw_cache_entry {
141 struct list_head list;
142 char name[];
143};
144
Ming Leif531f05a2012-08-04 12:01:25 +0800145struct fw_name_devm {
146 unsigned long magic;
147 char name[];
148};
149
Ming Lei1f2b7952012-08-04 12:01:21 +0800150#define to_fwbuf(d) container_of(d, struct firmware_buf, ref)
151
Ming Leiac39b3e2012-08-20 19:04:16 +0800152#define FW_LOADER_NO_CACHE 0
153#define FW_LOADER_START_CACHE 1
154
155static int fw_cache_piggyback_on_request(const char *name);
156
Ming Lei1f2b7952012-08-04 12:01:21 +0800157/* fw_lock could be moved to 'struct firmware_priv' but since it is just
158 * guarding for corner cases a global lock should be OK */
159static DEFINE_MUTEX(fw_lock);
160
161static struct firmware_cache fw_cache;
162
163static struct firmware_buf *__allocate_fw_buf(const char *fw_name,
164 struct firmware_cache *fwc)
165{
166 struct firmware_buf *buf;
167
168 buf = kzalloc(sizeof(*buf) + strlen(fw_name) + 1 , GFP_ATOMIC);
169
170 if (!buf)
171 return buf;
172
173 kref_init(&buf->ref);
174 strcpy(buf->fw_id, fw_name);
175 buf->fwc = fwc;
176 init_completion(&buf->completion);
Takashi Iwaife304142013-05-22 18:28:38 +0200177#ifdef CONFIG_FW_LOADER_USER_HELPER
178 INIT_LIST_HEAD(&buf->pending_list);
179#endif
Ming Lei1f2b7952012-08-04 12:01:21 +0800180
181 pr_debug("%s: fw-%s buf=%p\n", __func__, fw_name, buf);
182
183 return buf;
184}
185
Ming Lei2887b392012-08-04 12:01:22 +0800186static struct firmware_buf *__fw_lookup_buf(const char *fw_name)
187{
188 struct firmware_buf *tmp;
189 struct firmware_cache *fwc = &fw_cache;
190
191 list_for_each_entry(tmp, &fwc->head, list)
192 if (!strcmp(tmp->fw_id, fw_name))
193 return tmp;
194 return NULL;
195}
196
Ming Lei1f2b7952012-08-04 12:01:21 +0800197static int fw_lookup_and_allocate_buf(const char *fw_name,
198 struct firmware_cache *fwc,
199 struct firmware_buf **buf)
200{
201 struct firmware_buf *tmp;
202
203 spin_lock(&fwc->lock);
Ming Lei2887b392012-08-04 12:01:22 +0800204 tmp = __fw_lookup_buf(fw_name);
205 if (tmp) {
206 kref_get(&tmp->ref);
207 spin_unlock(&fwc->lock);
208 *buf = tmp;
209 return 1;
210 }
Ming Lei1f2b7952012-08-04 12:01:21 +0800211 tmp = __allocate_fw_buf(fw_name, fwc);
212 if (tmp)
213 list_add(&tmp->list, &fwc->head);
214 spin_unlock(&fwc->lock);
215
216 *buf = tmp;
217
218 return tmp ? 0 : -ENOMEM;
219}
220
221static void __fw_free_buf(struct kref *ref)
222{
223 struct firmware_buf *buf = to_fwbuf(ref);
224 struct firmware_cache *fwc = buf->fwc;
Ming Lei1f2b7952012-08-04 12:01:21 +0800225
226 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
227 __func__, buf->fw_id, buf, buf->data,
228 (unsigned int)buf->size);
229
Ming Lei1f2b7952012-08-04 12:01:21 +0800230 list_del(&buf->list);
231 spin_unlock(&fwc->lock);
232
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100233#ifdef CONFIG_FW_LOADER_USER_HELPER
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100234 if (buf->is_paged_buf) {
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100235 int i;
Ming Lei746058f2012-10-09 12:01:03 +0800236 vunmap(buf->data);
237 for (i = 0; i < buf->nr_pages; i++)
238 __free_page(buf->pages[i]);
239 kfree(buf->pages);
240 } else
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100241#endif
Ming Lei746058f2012-10-09 12:01:03 +0800242 vfree(buf->data);
Ming Lei1f2b7952012-08-04 12:01:21 +0800243 kfree(buf);
244}
245
246static void fw_free_buf(struct firmware_buf *buf)
247{
Chuansheng Liubd9eb7f2012-11-10 01:27:22 +0800248 struct firmware_cache *fwc = buf->fwc;
249 spin_lock(&fwc->lock);
250 if (!kref_put(&buf->ref, __fw_free_buf))
251 spin_unlock(&fwc->lock);
Ming Lei1f2b7952012-08-04 12:01:21 +0800252}
253
Ming Lei746058f2012-10-09 12:01:03 +0800254/* direct firmware loading support */
Ming Lei27602842012-11-03 17:47:58 +0800255static char fw_path_para[256];
256static const char * const fw_path[] = {
257 fw_path_para,
Ming Lei746058f2012-10-09 12:01:03 +0800258 "/lib/firmware/updates/" UTS_RELEASE,
259 "/lib/firmware/updates",
260 "/lib/firmware/" UTS_RELEASE,
261 "/lib/firmware"
262};
263
Ming Lei27602842012-11-03 17:47:58 +0800264/*
265 * Typical usage is that passing 'firmware_class.path=$CUSTOMIZED_PATH'
266 * from kernel command line because firmware_class is generally built in
267 * kernel instead of module.
268 */
269module_param_string(path, fw_path_para, sizeof(fw_path_para), 0644);
270MODULE_PARM_DESC(path, "customized firmware image search path with a higher priority than default path");
271
Ming Lei746058f2012-10-09 12:01:03 +0800272/* Don't inline this: 'struct kstat' is biggish */
Cesar Eduardo Barros60dac5e2012-10-27 20:37:10 -0200273static noinline_for_stack long fw_file_size(struct file *file)
Ming Lei746058f2012-10-09 12:01:03 +0800274{
275 struct kstat st;
Al Viro3dadecc2013-01-24 02:18:08 -0500276 if (vfs_getattr(&file->f_path, &st))
Ming Lei746058f2012-10-09 12:01:03 +0800277 return -1;
278 if (!S_ISREG(st.mode))
279 return -1;
280 if (st.size != (long)st.size)
281 return -1;
282 return st.size;
283}
284
285static bool fw_read_file_contents(struct file *file, struct firmware_buf *fw_buf)
286{
287 long size;
288 char *buf;
289
290 size = fw_file_size(file);
Luciano Coelho4adf07f2013-01-15 10:43:43 +0200291 if (size <= 0)
Ming Lei746058f2012-10-09 12:01:03 +0800292 return false;
293 buf = vmalloc(size);
294 if (!buf)
295 return false;
296 if (kernel_read(file, 0, buf, size) != size) {
297 vfree(buf);
298 return false;
299 }
300 fw_buf->data = buf;
301 fw_buf->size = size;
302 return true;
303}
304
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100305static bool fw_get_filesystem_firmware(struct device *device,
306 struct firmware_buf *buf)
Ming Lei746058f2012-10-09 12:01:03 +0800307{
308 int i;
309 bool success = false;
310 char *path = __getname();
311
312 for (i = 0; i < ARRAY_SIZE(fw_path); i++) {
313 struct file *file;
Ming Lei27602842012-11-03 17:47:58 +0800314
315 /* skip the unset customized path */
316 if (!fw_path[i][0])
317 continue;
318
Ming Lei746058f2012-10-09 12:01:03 +0800319 snprintf(path, PATH_MAX, "%s/%s", fw_path[i], buf->fw_id);
320
321 file = filp_open(path, O_RDONLY, 0);
322 if (IS_ERR(file))
323 continue;
324 success = fw_read_file_contents(file, buf);
325 fput(file);
326 if (success)
327 break;
328 }
329 __putname(path);
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100330
331 if (success) {
332 dev_dbg(device, "firmware: direct-loading firmware %s\n",
333 buf->fw_id);
334 mutex_lock(&fw_lock);
335 set_bit(FW_STATUS_DONE, &buf->status);
336 complete_all(&buf->completion);
337 mutex_unlock(&fw_lock);
338 }
339
Ming Lei746058f2012-10-09 12:01:03 +0800340 return success;
341}
342
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100343/* firmware holds the ownership of pages */
344static void firmware_free_data(const struct firmware *fw)
345{
346 /* Loaded directly? */
347 if (!fw->priv) {
348 vfree(fw->data);
349 return;
350 }
351 fw_free_buf(fw->priv);
352}
353
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100354/* store the pages buffer info firmware from buf */
355static void fw_set_page_data(struct firmware_buf *buf, struct firmware *fw)
356{
357 fw->priv = buf;
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100358#ifdef CONFIG_FW_LOADER_USER_HELPER
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100359 fw->pages = buf->pages;
360#endif
361 fw->size = buf->size;
362 fw->data = buf->data;
363
364 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
365 __func__, buf->fw_id, buf, buf->data,
366 (unsigned int)buf->size);
367}
368
369#ifdef CONFIG_PM_SLEEP
370static void fw_name_devm_release(struct device *dev, void *res)
371{
372 struct fw_name_devm *fwn = res;
373
374 if (fwn->magic == (unsigned long)&fw_cache)
375 pr_debug("%s: fw_name-%s devm-%p released\n",
376 __func__, fwn->name, res);
377}
378
379static int fw_devm_match(struct device *dev, void *res,
380 void *match_data)
381{
382 struct fw_name_devm *fwn = res;
383
384 return (fwn->magic == (unsigned long)&fw_cache) &&
385 !strcmp(fwn->name, match_data);
386}
387
388static struct fw_name_devm *fw_find_devm_name(struct device *dev,
389 const char *name)
390{
391 struct fw_name_devm *fwn;
392
393 fwn = devres_find(dev, fw_name_devm_release,
394 fw_devm_match, (void *)name);
395 return fwn;
396}
397
398/* add firmware name into devres list */
399static int fw_add_devm_name(struct device *dev, const char *name)
400{
401 struct fw_name_devm *fwn;
402
403 fwn = fw_find_devm_name(dev, name);
404 if (fwn)
405 return 1;
406
407 fwn = devres_alloc(fw_name_devm_release, sizeof(struct fw_name_devm) +
408 strlen(name) + 1, GFP_KERNEL);
409 if (!fwn)
410 return -ENOMEM;
411
412 fwn->magic = (unsigned long)&fw_cache;
413 strcpy(fwn->name, name);
414 devres_add(dev, fwn);
415
416 return 0;
417}
418#else
419static int fw_add_devm_name(struct device *dev, const char *name)
420{
421 return 0;
422}
423#endif
424
425
426/*
427 * user-mode helper code
428 */
429#ifdef CONFIG_FW_LOADER_USER_HELPER
430struct firmware_priv {
431 struct delayed_work timeout_work;
432 bool nowait;
433 struct device dev;
434 struct firmware_buf *buf;
435 struct firmware *fw;
436};
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100437
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700438static struct firmware_priv *to_firmware_priv(struct device *dev)
439{
440 return container_of(dev, struct firmware_priv, dev);
441}
442
Greg Kroah-Hartman7068cb02013-06-19 20:26:43 -0700443static void __fw_load_abort(struct firmware_buf *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444{
Ming Lei87597932013-06-15 16:36:38 +0800445 /*
446 * There is a small window in which user can write to 'loading'
447 * between loading done and disappearance of 'loading'
448 */
449 if (test_bit(FW_STATUS_DONE, &buf->status))
450 return;
451
Takashi Iwaife304142013-05-22 18:28:38 +0200452 list_del_init(&buf->pending_list);
Ming Lei12446912012-08-04 12:01:20 +0800453 set_bit(FW_STATUS_ABORT, &buf->status);
Ming Lei1f2b7952012-08-04 12:01:21 +0800454 complete_all(&buf->completion);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455}
456
Greg Kroah-Hartman7068cb02013-06-19 20:26:43 -0700457static void fw_load_abort(struct firmware_priv *fw_priv)
458{
459 struct firmware_buf *buf = fw_priv->buf;
460
461 __fw_load_abort(buf);
Ming Lei87597932013-06-15 16:36:38 +0800462
463 /* avoid user action after loading abort */
464 fw_priv->buf = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465}
466
Takashi Iwai807be032013-01-31 11:13:57 +0100467#define is_fw_load_aborted(buf) \
468 test_bit(FW_STATUS_ABORT, &(buf)->status)
469
Takashi Iwaife304142013-05-22 18:28:38 +0200470static LIST_HEAD(pending_fw_head);
471
472/* reboot notifier for avoid deadlock with usermode_lock */
473static int fw_shutdown_notify(struct notifier_block *unused1,
474 unsigned long unused2, void *unused3)
475{
476 mutex_lock(&fw_lock);
477 while (!list_empty(&pending_fw_head))
Greg Kroah-Hartman7068cb02013-06-19 20:26:43 -0700478 __fw_load_abort(list_first_entry(&pending_fw_head,
Takashi Iwaife304142013-05-22 18:28:38 +0200479 struct firmware_buf,
480 pending_list));
481 mutex_unlock(&fw_lock);
482 return NOTIFY_DONE;
483}
484
485static struct notifier_block fw_shutdown_nb = {
486 .notifier_call = fw_shutdown_notify,
487};
488
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700489static ssize_t firmware_timeout_show(struct class *class,
490 struct class_attribute *attr,
491 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492{
493 return sprintf(buf, "%d\n", loading_timeout);
494}
495
496/**
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800497 * firmware_timeout_store - set number of seconds to wait for firmware
498 * @class: device class pointer
Randy Dunlape59817b2010-03-10 11:47:58 -0800499 * @attr: device attribute pointer
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800500 * @buf: buffer to scan for timeout value
501 * @count: number of bytes in @buf
502 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 * Sets the number of seconds to wait for the firmware. Once
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800504 * this expires an error will be returned to the driver and no
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 * firmware will be provided.
506 *
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800507 * Note: zero means 'wait forever'.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 **/
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700509static ssize_t firmware_timeout_store(struct class *class,
510 struct class_attribute *attr,
511 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512{
513 loading_timeout = simple_strtol(buf, NULL, 10);
Stanislaw W. Gruszkab92eac02005-06-28 20:44:51 -0700514 if (loading_timeout < 0)
515 loading_timeout = 0;
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700516
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517 return count;
518}
519
Dmitry Torokhov673fae92010-03-13 23:49:13 -0800520static struct class_attribute firmware_class_attrs[] = {
521 __ATTR(timeout, S_IWUSR | S_IRUGO,
522 firmware_timeout_show, firmware_timeout_store),
523 __ATTR_NULL
524};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
Dmitry Torokhov673fae92010-03-13 23:49:13 -0800526static void fw_dev_release(struct device *dev)
527{
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700528 struct firmware_priv *fw_priv = to_firmware_priv(dev);
Ming Lei65710cb2012-08-04 12:01:16 +0800529
Dmitry Torokhov673fae92010-03-13 23:49:13 -0800530 kfree(fw_priv);
Dmitry Torokhov673fae92010-03-13 23:49:13 -0800531}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532
Kay Sievers7eff2e72007-08-14 15:15:12 +0200533static int firmware_uevent(struct device *dev, struct kobj_uevent_env *env)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534{
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700535 struct firmware_priv *fw_priv = to_firmware_priv(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536
Ming Lei12446912012-08-04 12:01:20 +0800537 if (add_uevent_var(env, "FIRMWARE=%s", fw_priv->buf->fw_id))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 return -ENOMEM;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200539 if (add_uevent_var(env, "TIMEOUT=%i", loading_timeout))
kay.sievers@vrfy.org68970892005-04-18 21:57:31 -0700540 return -ENOMEM;
Johannes Berge9045f92010-03-29 17:57:20 +0200541 if (add_uevent_var(env, "ASYNC=%d", fw_priv->nowait))
542 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
544 return 0;
545}
546
Adrian Bunk1b81d662006-05-20 15:00:16 -0700547static struct class firmware_class = {
548 .name = "firmware",
Dmitry Torokhov673fae92010-03-13 23:49:13 -0800549 .class_attrs = firmware_class_attrs,
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700550 .dev_uevent = firmware_uevent,
551 .dev_release = fw_dev_release,
Adrian Bunk1b81d662006-05-20 15:00:16 -0700552};
553
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700554static ssize_t firmware_loading_show(struct device *dev,
555 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556{
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700557 struct firmware_priv *fw_priv = to_firmware_priv(dev);
Ming Lei87597932013-06-15 16:36:38 +0800558 int loading = 0;
559
560 mutex_lock(&fw_lock);
561 if (fw_priv->buf)
562 loading = test_bit(FW_STATUS_LOADING, &fw_priv->buf->status);
563 mutex_unlock(&fw_lock);
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700564
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 return sprintf(buf, "%d\n", loading);
566}
567
David Woodhouse6e03a202009-04-09 22:04:07 -0700568/* Some architectures don't have PAGE_KERNEL_RO */
569#ifndef PAGE_KERNEL_RO
570#define PAGE_KERNEL_RO PAGE_KERNEL
571#endif
Ming Lei253c9242012-10-09 12:01:02 +0800572
573/* one pages buffer should be mapped/unmapped only once */
574static int fw_map_pages_buf(struct firmware_buf *buf)
575{
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100576 if (!buf->is_paged_buf)
Ming Lei746058f2012-10-09 12:01:03 +0800577 return 0;
578
Ming Lei253c9242012-10-09 12:01:02 +0800579 if (buf->data)
580 vunmap(buf->data);
581 buf->data = vmap(buf->pages, buf->nr_pages, 0, PAGE_KERNEL_RO);
582 if (!buf->data)
583 return -ENOMEM;
584 return 0;
585}
586
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587/**
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800588 * firmware_loading_store - set value in the 'loading' control file
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700589 * @dev: device pointer
Randy Dunlapaf9997e2006-12-22 01:06:52 -0800590 * @attr: device attribute pointer
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800591 * @buf: buffer to scan for loading control value
592 * @count: number of bytes in @buf
593 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 * The relevant values are:
595 *
596 * 1: Start a load, discarding any previous partial load.
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800597 * 0: Conclude the load and hand the data to the driver code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 * -1: Conclude the load with an error and discard any written data.
599 **/
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700600static ssize_t firmware_loading_store(struct device *dev,
601 struct device_attribute *attr,
602 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603{
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700604 struct firmware_priv *fw_priv = to_firmware_priv(dev);
Ming Lei87597932013-06-15 16:36:38 +0800605 struct firmware_buf *fw_buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 int loading = simple_strtol(buf, NULL, 10);
David Woodhouse6e03a202009-04-09 22:04:07 -0700607 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
Neil Hormaneea915b2012-01-02 15:31:23 -0500609 mutex_lock(&fw_lock);
Ming Lei87597932013-06-15 16:36:38 +0800610 fw_buf = fw_priv->buf;
Ming Lei12446912012-08-04 12:01:20 +0800611 if (!fw_buf)
Neil Hormaneea915b2012-01-02 15:31:23 -0500612 goto out;
613
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 switch (loading) {
615 case 1:
Ming Lei65710cb2012-08-04 12:01:16 +0800616 /* discarding any previous partial load */
Ming Lei12446912012-08-04 12:01:20 +0800617 if (!test_bit(FW_STATUS_DONE, &fw_buf->status)) {
618 for (i = 0; i < fw_buf->nr_pages; i++)
619 __free_page(fw_buf->pages[i]);
620 kfree(fw_buf->pages);
621 fw_buf->pages = NULL;
622 fw_buf->page_array_size = 0;
623 fw_buf->nr_pages = 0;
624 set_bit(FW_STATUS_LOADING, &fw_buf->status);
Ming Lei28eefa72012-08-04 12:01:17 +0800625 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 break;
627 case 0:
Ming Lei12446912012-08-04 12:01:20 +0800628 if (test_bit(FW_STATUS_LOADING, &fw_buf->status)) {
629 set_bit(FW_STATUS_DONE, &fw_buf->status);
630 clear_bit(FW_STATUS_LOADING, &fw_buf->status);
Ming Lei253c9242012-10-09 12:01:02 +0800631
632 /*
633 * Several loading requests may be pending on
634 * one same firmware buf, so let all requests
635 * see the mapped 'buf->data' once the loading
636 * is completed.
637 * */
638 fw_map_pages_buf(fw_buf);
Takashi Iwaife304142013-05-22 18:28:38 +0200639 list_del_init(&fw_buf->pending_list);
Ming Lei1f2b7952012-08-04 12:01:21 +0800640 complete_all(&fw_buf->completion);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 break;
642 }
643 /* fallthrough */
644 default:
Bjorn Helgaas266a8132008-10-15 22:04:20 -0700645 dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 /* fallthrough */
647 case -1:
648 fw_load_abort(fw_priv);
649 break;
650 }
Neil Hormaneea915b2012-01-02 15:31:23 -0500651out:
652 mutex_unlock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 return count;
654}
655
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700656static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700658static ssize_t firmware_data_read(struct file *filp, struct kobject *kobj,
659 struct bin_attribute *bin_attr,
660 char *buffer, loff_t offset, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200662 struct device *dev = kobj_to_dev(kobj);
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700663 struct firmware_priv *fw_priv = to_firmware_priv(dev);
Ming Lei12446912012-08-04 12:01:20 +0800664 struct firmware_buf *buf;
Akinobu Mitaf37e6612008-07-25 01:48:23 -0700665 ssize_t ret_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666
Laura Garciacad1e552006-05-23 23:22:38 +0200667 mutex_lock(&fw_lock);
Ming Lei12446912012-08-04 12:01:20 +0800668 buf = fw_priv->buf;
669 if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 ret_count = -ENODEV;
671 goto out;
672 }
Ming Lei12446912012-08-04 12:01:20 +0800673 if (offset > buf->size) {
Jiri Slaby308975f2009-06-21 23:57:31 +0200674 ret_count = 0;
675 goto out;
676 }
Ming Lei12446912012-08-04 12:01:20 +0800677 if (count > buf->size - offset)
678 count = buf->size - offset;
David Woodhouse6e03a202009-04-09 22:04:07 -0700679
680 ret_count = count;
681
682 while (count) {
683 void *page_data;
684 int page_nr = offset >> PAGE_SHIFT;
685 int page_ofs = offset & (PAGE_SIZE-1);
686 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
687
Ming Lei12446912012-08-04 12:01:20 +0800688 page_data = kmap(buf->pages[page_nr]);
David Woodhouse6e03a202009-04-09 22:04:07 -0700689
690 memcpy(buffer, page_data + page_ofs, page_cnt);
691
Ming Lei12446912012-08-04 12:01:20 +0800692 kunmap(buf->pages[page_nr]);
David Woodhouse6e03a202009-04-09 22:04:07 -0700693 buffer += page_cnt;
694 offset += page_cnt;
695 count -= page_cnt;
696 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697out:
Laura Garciacad1e552006-05-23 23:22:38 +0200698 mutex_unlock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 return ret_count;
700}
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800701
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700702static int fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703{
Ming Lei12446912012-08-04 12:01:20 +0800704 struct firmware_buf *buf = fw_priv->buf;
David Woodhouse6e03a202009-04-09 22:04:07 -0700705 int pages_needed = ALIGN(min_size, PAGE_SIZE) >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706
David Woodhouse6e03a202009-04-09 22:04:07 -0700707 /* If the array of pages is too small, grow it... */
Ming Lei12446912012-08-04 12:01:20 +0800708 if (buf->page_array_size < pages_needed) {
David Woodhouse6e03a202009-04-09 22:04:07 -0700709 int new_array_size = max(pages_needed,
Ming Lei12446912012-08-04 12:01:20 +0800710 buf->page_array_size * 2);
David Woodhouse6e03a202009-04-09 22:04:07 -0700711 struct page **new_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712
David Woodhouse6e03a202009-04-09 22:04:07 -0700713 new_pages = kmalloc(new_array_size * sizeof(void *),
714 GFP_KERNEL);
715 if (!new_pages) {
716 fw_load_abort(fw_priv);
717 return -ENOMEM;
718 }
Ming Lei12446912012-08-04 12:01:20 +0800719 memcpy(new_pages, buf->pages,
720 buf->page_array_size * sizeof(void *));
721 memset(&new_pages[buf->page_array_size], 0, sizeof(void *) *
722 (new_array_size - buf->page_array_size));
723 kfree(buf->pages);
724 buf->pages = new_pages;
725 buf->page_array_size = new_array_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 }
David Woodhouse6e03a202009-04-09 22:04:07 -0700727
Ming Lei12446912012-08-04 12:01:20 +0800728 while (buf->nr_pages < pages_needed) {
729 buf->pages[buf->nr_pages] =
David Woodhouse6e03a202009-04-09 22:04:07 -0700730 alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
731
Ming Lei12446912012-08-04 12:01:20 +0800732 if (!buf->pages[buf->nr_pages]) {
David Woodhouse6e03a202009-04-09 22:04:07 -0700733 fw_load_abort(fw_priv);
734 return -ENOMEM;
735 }
Ming Lei12446912012-08-04 12:01:20 +0800736 buf->nr_pages++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 return 0;
739}
740
741/**
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800742 * firmware_data_write - write method for firmware
Chris Wright2c3c8be2010-05-12 18:28:57 -0700743 * @filp: open sysfs file
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700744 * @kobj: kobject for the device
Randy Dunlap42e61f42007-07-23 21:42:11 -0700745 * @bin_attr: bin_attr structure
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800746 * @buffer: buffer being written
747 * @offset: buffer offset for write in total data store area
748 * @count: buffer size
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 *
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800750 * Data written to the 'data' attribute will be later handed to
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 * the driver as a firmware image.
752 **/
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700753static ssize_t firmware_data_write(struct file *filp, struct kobject *kobj,
754 struct bin_attribute *bin_attr,
755 char *buffer, loff_t offset, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200757 struct device *dev = kobj_to_dev(kobj);
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700758 struct firmware_priv *fw_priv = to_firmware_priv(dev);
Ming Lei12446912012-08-04 12:01:20 +0800759 struct firmware_buf *buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 ssize_t retval;
761
762 if (!capable(CAP_SYS_RAWIO))
763 return -EPERM;
Stanislaw W. Gruszkab92eac02005-06-28 20:44:51 -0700764
Laura Garciacad1e552006-05-23 23:22:38 +0200765 mutex_lock(&fw_lock);
Ming Lei12446912012-08-04 12:01:20 +0800766 buf = fw_priv->buf;
767 if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 retval = -ENODEV;
769 goto out;
770 }
Ming Lei65710cb2012-08-04 12:01:16 +0800771
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 retval = fw_realloc_buffer(fw_priv, offset + count);
773 if (retval)
774 goto out;
775
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 retval = count;
David Woodhouse6e03a202009-04-09 22:04:07 -0700777
778 while (count) {
779 void *page_data;
780 int page_nr = offset >> PAGE_SHIFT;
781 int page_ofs = offset & (PAGE_SIZE - 1);
782 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
783
Ming Lei12446912012-08-04 12:01:20 +0800784 page_data = kmap(buf->pages[page_nr]);
David Woodhouse6e03a202009-04-09 22:04:07 -0700785
786 memcpy(page_data + page_ofs, buffer, page_cnt);
787
Ming Lei12446912012-08-04 12:01:20 +0800788 kunmap(buf->pages[page_nr]);
David Woodhouse6e03a202009-04-09 22:04:07 -0700789 buffer += page_cnt;
790 offset += page_cnt;
791 count -= page_cnt;
792 }
793
Ming Lei12446912012-08-04 12:01:20 +0800794 buf->size = max_t(size_t, offset, buf->size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795out:
Laura Garciacad1e552006-05-23 23:22:38 +0200796 mutex_unlock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 return retval;
798}
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800799
Dmitry Torokhov0983ca22010-06-04 00:54:37 -0700800static struct bin_attribute firmware_attr_data = {
801 .attr = { .name = "data", .mode = 0644 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 .size = 0,
803 .read = firmware_data_read,
804 .write = firmware_data_write,
805};
806
Chuansheng Liuce2fcbd2012-11-08 19:14:40 +0800807static void firmware_class_timeout_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808{
Chuansheng Liuce2fcbd2012-11-08 19:14:40 +0800809 struct firmware_priv *fw_priv = container_of(work,
810 struct firmware_priv, timeout_work.work);
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700811
Chuansheng Liuce2fcbd2012-11-08 19:14:40 +0800812 mutex_lock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 fw_load_abort(fw_priv);
Chuansheng Liuce2fcbd2012-11-08 19:14:40 +0800814 mutex_unlock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815}
816
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700817static struct firmware_priv *
Stephen Boyddddb5542012-03-28 23:30:43 +0200818fw_create_instance(struct firmware *firmware, const char *fw_name,
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700819 struct device *device, bool uevent, bool nowait)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820{
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700821 struct firmware_priv *fw_priv;
822 struct device *f_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823
Ming Lei12446912012-08-04 12:01:20 +0800824 fw_priv = kzalloc(sizeof(*fw_priv), GFP_KERNEL);
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700825 if (!fw_priv) {
Bjorn Helgaas266a8132008-10-15 22:04:20 -0700826 dev_err(device, "%s: kmalloc failed\n", __func__);
Ming Lei12446912012-08-04 12:01:20 +0800827 fw_priv = ERR_PTR(-ENOMEM);
828 goto exit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700831 fw_priv->nowait = nowait;
Ming Lei1f2b7952012-08-04 12:01:21 +0800832 fw_priv->fw = firmware;
Chuansheng Liuce2fcbd2012-11-08 19:14:40 +0800833 INIT_DELAYED_WORK(&fw_priv->timeout_work,
834 firmware_class_timeout_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700836 f_dev = &fw_priv->dev;
837
838 device_initialize(f_dev);
Ming Lei99c2aa72012-08-04 12:01:19 +0800839 dev_set_name(f_dev, "%s", fw_name);
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700840 f_dev->parent = device;
841 f_dev->class = &firmware_class;
Ming Lei12446912012-08-04 12:01:20 +0800842exit:
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700843 return fw_priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844}
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100845
846/* load a firmware via user helper */
847static int _request_firmware_load(struct firmware_priv *fw_priv, bool uevent,
848 long timeout)
849{
850 int retval = 0;
851 struct device *f_dev = &fw_priv->dev;
852 struct firmware_buf *buf = fw_priv->buf;
853
854 /* fall back on userspace loading */
855 buf->is_paged_buf = true;
856
857 dev_set_uevent_suppress(f_dev, true);
858
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100859 retval = device_add(f_dev);
860 if (retval) {
861 dev_err(f_dev, "%s: device_register failed\n", __func__);
862 goto err_put_dev;
863 }
864
865 retval = device_create_bin_file(f_dev, &firmware_attr_data);
866 if (retval) {
867 dev_err(f_dev, "%s: sysfs_create_bin_file failed\n", __func__);
868 goto err_del_dev;
869 }
870
871 retval = device_create_file(f_dev, &dev_attr_loading);
872 if (retval) {
873 dev_err(f_dev, "%s: device_create_file failed\n", __func__);
874 goto err_del_bin_attr;
875 }
876
877 if (uevent) {
Ming Leiaf5bc112013-05-27 18:30:04 +0800878 buf->need_uevent = true;
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100879 dev_set_uevent_suppress(f_dev, false);
880 dev_dbg(f_dev, "firmware: requesting %s\n", buf->fw_id);
881 if (timeout != MAX_SCHEDULE_TIMEOUT)
882 schedule_delayed_work(&fw_priv->timeout_work, timeout);
883
884 kobject_uevent(&fw_priv->dev.kobj, KOBJ_ADD);
885 }
886
Takashi Iwaife304142013-05-22 18:28:38 +0200887 mutex_lock(&fw_lock);
888 list_add(&buf->pending_list, &pending_fw_head);
889 mutex_unlock(&fw_lock);
890
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100891 wait_for_completion(&buf->completion);
892
893 cancel_delayed_work_sync(&fw_priv->timeout_work);
894
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100895 device_remove_file(f_dev, &dev_attr_loading);
896err_del_bin_attr:
897 device_remove_bin_file(f_dev, &firmware_attr_data);
898err_del_dev:
899 device_del(f_dev);
900err_put_dev:
901 put_device(f_dev);
902 return retval;
903}
904
905static int fw_load_from_user_helper(struct firmware *firmware,
906 const char *name, struct device *device,
907 bool uevent, bool nowait, long timeout)
908{
909 struct firmware_priv *fw_priv;
910
911 fw_priv = fw_create_instance(firmware, name, device, uevent, nowait);
912 if (IS_ERR(fw_priv))
913 return PTR_ERR(fw_priv);
914
915 fw_priv->buf = firmware->priv;
916 return _request_firmware_load(fw_priv, uevent, timeout);
917}
Ming Leiddf1f062013-06-04 10:01:13 +0800918
Ming Lei5b7cb7a2013-06-06 19:52:54 +0800919#ifdef CONFIG_PM_SLEEP
Ming Leiddf1f062013-06-04 10:01:13 +0800920/* kill pending requests without uevent to avoid blocking suspend */
921static void kill_requests_without_uevent(void)
922{
923 struct firmware_buf *buf;
924 struct firmware_buf *next;
925
926 mutex_lock(&fw_lock);
927 list_for_each_entry_safe(buf, next, &pending_fw_head, pending_list) {
928 if (!buf->need_uevent)
Greg Kroah-Hartman7068cb02013-06-19 20:26:43 -0700929 __fw_load_abort(buf);
Ming Leiddf1f062013-06-04 10:01:13 +0800930 }
931 mutex_unlock(&fw_lock);
932}
Ming Lei5b7cb7a2013-06-06 19:52:54 +0800933#endif
Ming Leiddf1f062013-06-04 10:01:13 +0800934
Takashi Iwaicd7239f2013-01-31 11:13:56 +0100935#else /* CONFIG_FW_LOADER_USER_HELPER */
936static inline int
937fw_load_from_user_helper(struct firmware *firmware, const char *name,
938 struct device *device, bool uevent, bool nowait,
939 long timeout)
940{
941 return -ENOENT;
942}
Takashi Iwai807be032013-01-31 11:13:57 +0100943
944/* No abort during direct loading */
945#define is_fw_load_aborted(buf) false
946
Ming Lei5b7cb7a2013-06-06 19:52:54 +0800947#ifdef CONFIG_PM_SLEEP
Ming Leiddf1f062013-06-04 10:01:13 +0800948static inline void kill_requests_without_uevent(void) { }
Ming Lei5b7cb7a2013-06-06 19:52:54 +0800949#endif
Ming Leiddf1f062013-06-04 10:01:13 +0800950
Takashi Iwai7b1269f2013-01-31 11:13:55 +0100951#endif /* CONFIG_FW_LOADER_USER_HELPER */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952
Ming Leif531f05a2012-08-04 12:01:25 +0800953
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100954/* wait until the shared firmware_buf becomes ready (or error) */
955static int sync_cached_firmware_buf(struct firmware_buf *buf)
Ming Lei1f2b7952012-08-04 12:01:21 +0800956{
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100957 int ret = 0;
958
959 mutex_lock(&fw_lock);
960 while (!test_bit(FW_STATUS_DONE, &buf->status)) {
Takashi Iwai807be032013-01-31 11:13:57 +0100961 if (is_fw_load_aborted(buf)) {
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100962 ret = -ENOENT;
963 break;
964 }
965 mutex_unlock(&fw_lock);
966 wait_for_completion(&buf->completion);
967 mutex_lock(&fw_lock);
968 }
969 mutex_unlock(&fw_lock);
970 return ret;
Ming Lei1f2b7952012-08-04 12:01:21 +0800971}
972
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100973/* prepare firmware and firmware_buf structs;
974 * return 0 if a firmware is already assigned, 1 if need to load one,
975 * or a negative error code
976 */
977static int
978_request_firmware_prepare(struct firmware **firmware_p, const char *name,
979 struct device *device)
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -0700980{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 struct firmware *firmware;
Ming Lei1f2b7952012-08-04 12:01:21 +0800982 struct firmware_buf *buf;
983 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984
Jiri Slaby4aed0642005-09-13 01:25:01 -0700985 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 if (!firmware) {
Bjorn Helgaas266a8132008-10-15 22:04:20 -0700987 dev_err(device, "%s: kmalloc(struct firmware) failed\n",
988 __func__);
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100989 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991
Dmitry Torokhovbcb9bd12010-03-13 23:49:18 -0800992 if (fw_get_builtin_firmware(firmware, name)) {
Rafael J. Wysocki6f18ff92010-02-27 21:43:22 +0100993 dev_dbg(device, "firmware: using built-in firmware %s\n", name);
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100994 return 0; /* assigned */
David Woodhouse5658c762008-05-23 13:52:42 +0100995 }
996
Ming Lei1f2b7952012-08-04 12:01:21 +0800997 ret = fw_lookup_and_allocate_buf(name, &fw_cache, &buf);
Ming Lei1f2b7952012-08-04 12:01:21 +0800998
Takashi Iwai4e0c92d2013-01-31 11:13:54 +0100999 /*
1000 * bind with 'buf' now to avoid warning in failure path
1001 * of requesting firmware.
1002 */
1003 firmware->priv = buf;
Ming Lei1f2b7952012-08-04 12:01:21 +08001004
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001005 if (ret > 0) {
1006 ret = sync_cached_firmware_buf(buf);
1007 if (!ret) {
1008 fw_set_page_data(buf, firmware);
1009 return 0; /* assigned */
1010 }
Stephen Boyddddb5542012-03-28 23:30:43 +02001011 }
Ming Lei1f2b7952012-08-04 12:01:21 +08001012
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001013 if (ret < 0)
1014 return ret;
1015 return 1; /* need to load */
Rafael J. Wysocki811fa402012-03-28 23:29:55 +02001016}
1017
Ming Leie771d1a2013-05-27 18:30:03 +08001018static int assign_firmware_buf(struct firmware *fw, struct device *device,
1019 bool skip_cache)
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001020{
1021 struct firmware_buf *buf = fw->priv;
1022
1023 mutex_lock(&fw_lock);
Takashi Iwai807be032013-01-31 11:13:57 +01001024 if (!buf->size || is_fw_load_aborted(buf)) {
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001025 mutex_unlock(&fw_lock);
1026 return -ENOENT;
1027 }
1028
1029 /*
1030 * add firmware name into devres list so that we can auto cache
1031 * and uncache firmware for device.
1032 *
1033 * device may has been deleted already, but the problem
1034 * should be fixed in devres or driver core.
1035 */
Ming Leie771d1a2013-05-27 18:30:03 +08001036 if (device && !skip_cache)
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001037 fw_add_devm_name(device, buf->fw_id);
1038
1039 /*
1040 * After caching firmware image is started, let it piggyback
1041 * on request firmware.
1042 */
1043 if (buf->fwc->state == FW_LOADER_START_CACHE) {
1044 if (fw_cache_piggyback_on_request(buf->fw_id))
1045 kref_get(&buf->ref);
1046 }
1047
1048 /* pass the pages buffer to driver at the last minute */
1049 fw_set_page_data(buf, fw);
1050 mutex_unlock(&fw_lock);
1051 return 0;
1052}
1053
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001054/* called from request_firmware() and request_firmware_work_func() */
1055static int
1056_request_firmware(const struct firmware **firmware_p, const char *name,
1057 struct device *device, bool uevent, bool nowait)
1058{
1059 struct firmware *fw;
1060 long timeout;
1061 int ret;
1062
1063 if (!firmware_p)
1064 return -EINVAL;
1065
1066 ret = _request_firmware_prepare(&fw, name, device);
1067 if (ret <= 0) /* error or already assigned */
1068 goto out;
1069
1070 ret = 0;
1071 timeout = firmware_loading_timeout();
1072 if (nowait) {
1073 timeout = usermodehelper_read_lock_wait(timeout);
1074 if (!timeout) {
1075 dev_dbg(device, "firmware: %s loading timed out\n",
1076 name);
1077 ret = -EBUSY;
1078 goto out;
1079 }
1080 } else {
1081 ret = usermodehelper_read_trylock();
1082 if (WARN_ON(ret)) {
1083 dev_err(device, "firmware: %s will not be loaded\n",
1084 name);
1085 goto out;
1086 }
1087 }
1088
1089 if (!fw_get_filesystem_firmware(device, fw->priv))
1090 ret = fw_load_from_user_helper(fw, name, device,
1091 uevent, nowait, timeout);
Ming Leie771d1a2013-05-27 18:30:03 +08001092
1093 /* don't cache firmware handled without uevent */
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001094 if (!ret)
Ming Leie771d1a2013-05-27 18:30:03 +08001095 ret = assign_firmware_buf(fw, device, !uevent);
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001096
1097 usermodehelper_read_unlock();
1098
1099 out:
1100 if (ret < 0) {
1101 release_firmware(fw);
1102 fw = NULL;
1103 }
1104
1105 *firmware_p = fw;
1106 return ret;
1107}
1108
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109/**
Kay Sievers312c0042005-11-16 09:00:00 +01001110 * request_firmware: - send firmware request and wait for it
Randy Dunlapeb8e3172005-10-30 15:03:01 -08001111 * @firmware_p: pointer to firmware image
1112 * @name: name of firmware file
1113 * @device: device for which firmware is being loaded
1114 *
1115 * @firmware_p will be used to return a firmware image by the name
Abhay Salunke6e3eaab2005-09-06 15:17:13 -07001116 * of @name for device @device.
1117 *
1118 * Should be called from user context where sleeping is allowed.
1119 *
Kay Sievers312c0042005-11-16 09:00:00 +01001120 * @name will be used as $FIRMWARE in the uevent environment and
Abhay Salunke6e3eaab2005-09-06 15:17:13 -07001121 * should be distinctive enough not to be confused with any other
1122 * firmware image for this or any other device.
Ming Lei0cfc1e12012-08-04 12:01:23 +08001123 *
1124 * Caller must hold the reference count of @device.
Ming Lei6a927852012-11-03 17:48:16 +08001125 *
1126 * The function can be called safely inside device's suspend and
1127 * resume callback.
Abhay Salunke6e3eaab2005-09-06 15:17:13 -07001128 **/
1129int
1130request_firmware(const struct firmware **firmware_p, const char *name,
1131 struct device *device)
1132{
Ming Leid6c8aa32013-06-06 20:01:48 +08001133 int ret;
1134
1135 /* Need to pin this module until return */
1136 __module_get(THIS_MODULE);
1137 ret = _request_firmware(firmware_p, name, device, true, false);
1138 module_put(THIS_MODULE);
1139 return ret;
Abhay Salunke6e3eaab2005-09-06 15:17:13 -07001140}
Daniel Mackf4945132013-05-23 22:17:18 +02001141EXPORT_SYMBOL(request_firmware);
Abhay Salunke6e3eaab2005-09-06 15:17:13 -07001142
1143/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 * release_firmware: - release the resource associated with a firmware image
Randy Dunlapeb8e3172005-10-30 15:03:01 -08001145 * @fw: firmware resource to release
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 **/
Dmitry Torokhovbcb9bd12010-03-13 23:49:18 -08001147void release_firmware(const struct firmware *fw)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148{
1149 if (fw) {
Dmitry Torokhovbcb9bd12010-03-13 23:49:18 -08001150 if (!fw_is_builtin_firmware(fw))
1151 firmware_free_data(fw);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 kfree(fw);
1153 }
1154}
Daniel Mackf4945132013-05-23 22:17:18 +02001155EXPORT_SYMBOL(release_firmware);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157/* Async support */
1158struct firmware_work {
1159 struct work_struct work;
1160 struct module *module;
1161 const char *name;
1162 struct device *device;
1163 void *context;
1164 void (*cont)(const struct firmware *fw, void *context);
Bob Liu072fc8f2011-01-26 18:33:32 +08001165 bool uevent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166};
1167
Stephen Boyda36cf842012-03-28 23:31:00 +02001168static void request_firmware_work_func(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169{
Stephen Boyda36cf842012-03-28 23:31:00 +02001170 struct firmware_work *fw_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 const struct firmware *fw;
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -07001172
Stephen Boyda36cf842012-03-28 23:31:00 +02001173 fw_work = container_of(work, struct firmware_work, work);
Rafael J. Wysocki811fa402012-03-28 23:29:55 +02001174
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001175 _request_firmware(&fw, fw_work->name, fw_work->device,
1176 fw_work->uevent, true);
Johannes Berg9ebfbd42009-10-29 12:36:02 +01001177 fw_work->cont(fw, fw_work->context);
Takashi Iwai4e0c92d2013-01-31 11:13:54 +01001178 put_device(fw_work->device); /* taken in request_firmware_nowait() */
Johannes Berg9ebfbd42009-10-29 12:36:02 +01001179
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 module_put(fw_work->module);
1181 kfree(fw_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182}
1183
1184/**
Ben Hutchings3c31f072010-02-14 14:18:53 +00001185 * request_firmware_nowait - asynchronous version of request_firmware
Randy Dunlapeb8e3172005-10-30 15:03:01 -08001186 * @module: module requesting the firmware
Kay Sievers312c0042005-11-16 09:00:00 +01001187 * @uevent: sends uevent to copy the firmware image if this flag
Randy Dunlapeb8e3172005-10-30 15:03:01 -08001188 * is non-zero else the firmware copy must be done manually.
1189 * @name: name of firmware file
1190 * @device: device for which firmware is being loaded
Johannes Berg9ebfbd42009-10-29 12:36:02 +01001191 * @gfp: allocation flags
Randy Dunlapeb8e3172005-10-30 15:03:01 -08001192 * @context: will be passed over to @cont, and
1193 * @fw may be %NULL if firmware request fails.
1194 * @cont: function will be called asynchronously when the firmware
1195 * request is over.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196 *
Ming Lei0cfc1e12012-08-04 12:01:23 +08001197 * Caller must hold the reference count of @device.
1198 *
Ming Lei6f21a622012-08-04 12:01:24 +08001199 * Asynchronous variant of request_firmware() for user contexts:
1200 * - sleep for as small periods as possible since it may
1201 * increase kernel boot time of built-in device drivers
1202 * requesting firmware in their ->probe() methods, if
1203 * @gfp is GFP_KERNEL.
1204 *
1205 * - can't sleep at all if @gfp is GFP_ATOMIC.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 **/
1207int
1208request_firmware_nowait(
Bob Liu072fc8f2011-01-26 18:33:32 +08001209 struct module *module, bool uevent,
Johannes Berg9ebfbd42009-10-29 12:36:02 +01001210 const char *name, struct device *device, gfp_t gfp, void *context,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 void (*cont)(const struct firmware *fw, void *context))
1212{
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -07001213 struct firmware_work *fw_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -07001215 fw_work = kzalloc(sizeof (struct firmware_work), gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 if (!fw_work)
1217 return -ENOMEM;
Dmitry Torokhovf8a4bd32010-06-04 00:54:43 -07001218
1219 fw_work->module = module;
1220 fw_work->name = name;
1221 fw_work->device = device;
1222 fw_work->context = context;
1223 fw_work->cont = cont;
1224 fw_work->uevent = uevent;
1225
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 if (!try_module_get(module)) {
1227 kfree(fw_work);
1228 return -EFAULT;
1229 }
1230
Ming Lei0cfc1e12012-08-04 12:01:23 +08001231 get_device(fw_work->device);
Stephen Boyda36cf842012-03-28 23:31:00 +02001232 INIT_WORK(&fw_work->work, request_firmware_work_func);
1233 schedule_work(&fw_work->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234 return 0;
1235}
Daniel Mackf4945132013-05-23 22:17:18 +02001236EXPORT_SYMBOL(request_firmware_nowait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237
Ming Lei90f890812013-06-20 12:30:16 +08001238#ifdef CONFIG_PM_SLEEP
1239static ASYNC_DOMAIN_EXCLUSIVE(fw_cache_domain);
1240
Ming Lei2887b392012-08-04 12:01:22 +08001241/**
1242 * cache_firmware - cache one firmware image in kernel memory space
1243 * @fw_name: the firmware image name
1244 *
1245 * Cache firmware in kernel memory so that drivers can use it when
1246 * system isn't ready for them to request firmware image from userspace.
1247 * Once it returns successfully, driver can use request_firmware or its
1248 * nowait version to get the cached firmware without any interacting
1249 * with userspace
1250 *
1251 * Return 0 if the firmware image has been cached successfully
1252 * Return !0 otherwise
1253 *
1254 */
Ming Lei93232e42013-06-06 20:01:47 +08001255static int cache_firmware(const char *fw_name)
Ming Lei2887b392012-08-04 12:01:22 +08001256{
1257 int ret;
1258 const struct firmware *fw;
1259
1260 pr_debug("%s: %s\n", __func__, fw_name);
1261
1262 ret = request_firmware(&fw, fw_name, NULL);
1263 if (!ret)
1264 kfree(fw);
1265
1266 pr_debug("%s: %s ret=%d\n", __func__, fw_name, ret);
1267
1268 return ret;
1269}
1270
Ming Lei6a2c1232013-06-26 09:28:17 +08001271static struct firmware_buf *fw_lookup_buf(const char *fw_name)
1272{
1273 struct firmware_buf *tmp;
1274 struct firmware_cache *fwc = &fw_cache;
1275
1276 spin_lock(&fwc->lock);
1277 tmp = __fw_lookup_buf(fw_name);
1278 spin_unlock(&fwc->lock);
1279
1280 return tmp;
1281}
1282
Ming Lei2887b392012-08-04 12:01:22 +08001283/**
1284 * uncache_firmware - remove one cached firmware image
1285 * @fw_name: the firmware image name
1286 *
1287 * Uncache one firmware image which has been cached successfully
1288 * before.
1289 *
1290 * Return 0 if the firmware cache has been removed successfully
1291 * Return !0 otherwise
1292 *
1293 */
Ming Lei93232e42013-06-06 20:01:47 +08001294static int uncache_firmware(const char *fw_name)
Ming Lei2887b392012-08-04 12:01:22 +08001295{
1296 struct firmware_buf *buf;
1297 struct firmware fw;
1298
1299 pr_debug("%s: %s\n", __func__, fw_name);
1300
1301 if (fw_get_builtin_firmware(&fw, fw_name))
1302 return 0;
1303
1304 buf = fw_lookup_buf(fw_name);
1305 if (buf) {
1306 fw_free_buf(buf);
1307 return 0;
1308 }
1309
1310 return -EINVAL;
1311}
1312
Ming Lei37276a52012-08-04 12:01:27 +08001313static struct fw_cache_entry *alloc_fw_cache_entry(const char *name)
1314{
1315 struct fw_cache_entry *fce;
1316
1317 fce = kzalloc(sizeof(*fce) + strlen(name) + 1, GFP_ATOMIC);
1318 if (!fce)
1319 goto exit;
1320
1321 strcpy(fce->name, name);
1322exit:
1323 return fce;
1324}
1325
Ming Lei373304f2012-10-09 12:01:01 +08001326static int __fw_entry_found(const char *name)
1327{
1328 struct firmware_cache *fwc = &fw_cache;
1329 struct fw_cache_entry *fce;
1330
1331 list_for_each_entry(fce, &fwc->fw_names, list) {
1332 if (!strcmp(fce->name, name))
1333 return 1;
1334 }
1335 return 0;
1336}
1337
Ming Leiac39b3e2012-08-20 19:04:16 +08001338static int fw_cache_piggyback_on_request(const char *name)
1339{
1340 struct firmware_cache *fwc = &fw_cache;
1341 struct fw_cache_entry *fce;
1342 int ret = 0;
1343
1344 spin_lock(&fwc->name_lock);
Ming Lei373304f2012-10-09 12:01:01 +08001345 if (__fw_entry_found(name))
1346 goto found;
Ming Leiac39b3e2012-08-20 19:04:16 +08001347
1348 fce = alloc_fw_cache_entry(name);
1349 if (fce) {
1350 ret = 1;
1351 list_add(&fce->list, &fwc->fw_names);
1352 pr_debug("%s: fw: %s\n", __func__, name);
1353 }
1354found:
1355 spin_unlock(&fwc->name_lock);
1356 return ret;
1357}
1358
Ming Lei37276a52012-08-04 12:01:27 +08001359static void free_fw_cache_entry(struct fw_cache_entry *fce)
1360{
1361 kfree(fce);
1362}
1363
1364static void __async_dev_cache_fw_image(void *fw_entry,
1365 async_cookie_t cookie)
1366{
1367 struct fw_cache_entry *fce = fw_entry;
1368 struct firmware_cache *fwc = &fw_cache;
1369 int ret;
1370
1371 ret = cache_firmware(fce->name);
Ming Leiac39b3e2012-08-20 19:04:16 +08001372 if (ret) {
1373 spin_lock(&fwc->name_lock);
1374 list_del(&fce->list);
1375 spin_unlock(&fwc->name_lock);
Ming Lei37276a52012-08-04 12:01:27 +08001376
Ming Leiac39b3e2012-08-20 19:04:16 +08001377 free_fw_cache_entry(fce);
1378 }
Ming Lei37276a52012-08-04 12:01:27 +08001379}
1380
1381/* called with dev->devres_lock held */
1382static void dev_create_fw_entry(struct device *dev, void *res,
1383 void *data)
1384{
1385 struct fw_name_devm *fwn = res;
1386 const char *fw_name = fwn->name;
1387 struct list_head *head = data;
1388 struct fw_cache_entry *fce;
1389
1390 fce = alloc_fw_cache_entry(fw_name);
1391 if (fce)
1392 list_add(&fce->list, head);
1393}
1394
1395static int devm_name_match(struct device *dev, void *res,
1396 void *match_data)
1397{
1398 struct fw_name_devm *fwn = res;
1399 return (fwn->magic == (unsigned long)match_data);
1400}
1401
Ming Leiab6dd8e2012-08-17 22:07:00 +08001402static void dev_cache_fw_image(struct device *dev, void *data)
Ming Lei37276a52012-08-04 12:01:27 +08001403{
1404 LIST_HEAD(todo);
1405 struct fw_cache_entry *fce;
1406 struct fw_cache_entry *fce_next;
1407 struct firmware_cache *fwc = &fw_cache;
1408
1409 devres_for_each_res(dev, fw_name_devm_release,
1410 devm_name_match, &fw_cache,
1411 dev_create_fw_entry, &todo);
1412
1413 list_for_each_entry_safe(fce, fce_next, &todo, list) {
1414 list_del(&fce->list);
1415
1416 spin_lock(&fwc->name_lock);
Ming Lei373304f2012-10-09 12:01:01 +08001417 /* only one cache entry for one firmware */
1418 if (!__fw_entry_found(fce->name)) {
Ming Lei373304f2012-10-09 12:01:01 +08001419 list_add(&fce->list, &fwc->fw_names);
1420 } else {
1421 free_fw_cache_entry(fce);
1422 fce = NULL;
1423 }
Ming Lei37276a52012-08-04 12:01:27 +08001424 spin_unlock(&fwc->name_lock);
1425
Ming Lei373304f2012-10-09 12:01:01 +08001426 if (fce)
Ming Leid28d3882012-10-09 12:01:04 +08001427 async_schedule_domain(__async_dev_cache_fw_image,
1428 (void *)fce,
1429 &fw_cache_domain);
Ming Lei37276a52012-08-04 12:01:27 +08001430 }
1431}
1432
1433static void __device_uncache_fw_images(void)
1434{
1435 struct firmware_cache *fwc = &fw_cache;
1436 struct fw_cache_entry *fce;
1437
1438 spin_lock(&fwc->name_lock);
1439 while (!list_empty(&fwc->fw_names)) {
1440 fce = list_entry(fwc->fw_names.next,
1441 struct fw_cache_entry, list);
1442 list_del(&fce->list);
1443 spin_unlock(&fwc->name_lock);
1444
1445 uncache_firmware(fce->name);
1446 free_fw_cache_entry(fce);
1447
1448 spin_lock(&fwc->name_lock);
1449 }
1450 spin_unlock(&fwc->name_lock);
1451}
1452
1453/**
1454 * device_cache_fw_images - cache devices' firmware
1455 *
1456 * If one device called request_firmware or its nowait version
1457 * successfully before, the firmware names are recored into the
1458 * device's devres link list, so device_cache_fw_images can call
1459 * cache_firmware() to cache these firmwares for the device,
1460 * then the device driver can load its firmwares easily at
1461 * time when system is not ready to complete loading firmware.
1462 */
1463static void device_cache_fw_images(void)
1464{
1465 struct firmware_cache *fwc = &fw_cache;
Ming Leiffe53f62012-08-04 12:01:28 +08001466 int old_timeout;
Ming Lei37276a52012-08-04 12:01:27 +08001467 DEFINE_WAIT(wait);
1468
1469 pr_debug("%s\n", __func__);
1470
Ming Lei373304f2012-10-09 12:01:01 +08001471 /* cancel uncache work */
1472 cancel_delayed_work_sync(&fwc->work);
1473
Ming Leiffe53f62012-08-04 12:01:28 +08001474 /*
1475 * use small loading timeout for caching devices' firmware
1476 * because all these firmware images have been loaded
1477 * successfully at lease once, also system is ready for
1478 * completing firmware loading now. The maximum size of
1479 * firmware in current distributions is about 2M bytes,
1480 * so 10 secs should be enough.
1481 */
1482 old_timeout = loading_timeout;
1483 loading_timeout = 10;
1484
Ming Leiac39b3e2012-08-20 19:04:16 +08001485 mutex_lock(&fw_lock);
1486 fwc->state = FW_LOADER_START_CACHE;
Ming Leiab6dd8e2012-08-17 22:07:00 +08001487 dpm_for_each_dev(NULL, dev_cache_fw_image);
Ming Leiac39b3e2012-08-20 19:04:16 +08001488 mutex_unlock(&fw_lock);
Ming Lei37276a52012-08-04 12:01:27 +08001489
1490 /* wait for completion of caching firmware for all devices */
Ming Leid28d3882012-10-09 12:01:04 +08001491 async_synchronize_full_domain(&fw_cache_domain);
Ming Leiffe53f62012-08-04 12:01:28 +08001492
1493 loading_timeout = old_timeout;
Ming Lei37276a52012-08-04 12:01:27 +08001494}
1495
1496/**
1497 * device_uncache_fw_images - uncache devices' firmware
1498 *
1499 * uncache all firmwares which have been cached successfully
1500 * by device_uncache_fw_images earlier
1501 */
1502static void device_uncache_fw_images(void)
1503{
1504 pr_debug("%s\n", __func__);
1505 __device_uncache_fw_images();
1506}
1507
1508static void device_uncache_fw_images_work(struct work_struct *work)
1509{
1510 device_uncache_fw_images();
1511}
1512
1513/**
1514 * device_uncache_fw_images_delay - uncache devices firmwares
1515 * @delay: number of milliseconds to delay uncache device firmwares
1516 *
1517 * uncache all devices's firmwares which has been cached successfully
1518 * by device_cache_fw_images after @delay milliseconds.
1519 */
1520static void device_uncache_fw_images_delay(unsigned long delay)
1521{
1522 schedule_delayed_work(&fw_cache.work,
1523 msecs_to_jiffies(delay));
1524}
1525
Ming Lei07646d92012-08-04 12:01:29 +08001526static int fw_pm_notify(struct notifier_block *notify_block,
1527 unsigned long mode, void *unused)
1528{
1529 switch (mode) {
1530 case PM_HIBERNATION_PREPARE:
1531 case PM_SUSPEND_PREPARE:
Ming Leiaf5bc112013-05-27 18:30:04 +08001532 kill_requests_without_uevent();
Ming Lei07646d92012-08-04 12:01:29 +08001533 device_cache_fw_images();
1534 break;
1535
1536 case PM_POST_SUSPEND:
1537 case PM_POST_HIBERNATION:
1538 case PM_POST_RESTORE:
Ming Leiac39b3e2012-08-20 19:04:16 +08001539 /*
1540 * In case that system sleep failed and syscore_suspend is
1541 * not called.
1542 */
1543 mutex_lock(&fw_lock);
1544 fw_cache.state = FW_LOADER_NO_CACHE;
1545 mutex_unlock(&fw_lock);
1546
Ming Lei07646d92012-08-04 12:01:29 +08001547 device_uncache_fw_images_delay(10 * MSEC_PER_SEC);
1548 break;
1549 }
1550
1551 return 0;
1552}
Ming Lei07646d92012-08-04 12:01:29 +08001553
Ming Leiac39b3e2012-08-20 19:04:16 +08001554/* stop caching firmware once syscore_suspend is reached */
1555static int fw_suspend(void)
1556{
1557 fw_cache.state = FW_LOADER_NO_CACHE;
1558 return 0;
1559}
1560
1561static struct syscore_ops fw_syscore_ops = {
1562 .suspend = fw_suspend,
1563};
Ming Leicfe016b2012-09-08 17:32:30 +08001564#else
1565static int fw_cache_piggyback_on_request(const char *name)
1566{
1567 return 0;
1568}
1569#endif
Ming Leiac39b3e2012-08-20 19:04:16 +08001570
Ming Lei37276a52012-08-04 12:01:27 +08001571static void __init fw_cache_init(void)
1572{
1573 spin_lock_init(&fw_cache.lock);
1574 INIT_LIST_HEAD(&fw_cache.head);
Ming Leicfe016b2012-09-08 17:32:30 +08001575 fw_cache.state = FW_LOADER_NO_CACHE;
Ming Lei37276a52012-08-04 12:01:27 +08001576
Ming Leicfe016b2012-09-08 17:32:30 +08001577#ifdef CONFIG_PM_SLEEP
Ming Lei37276a52012-08-04 12:01:27 +08001578 spin_lock_init(&fw_cache.name_lock);
1579 INIT_LIST_HEAD(&fw_cache.fw_names);
Ming Lei37276a52012-08-04 12:01:27 +08001580
Ming Lei37276a52012-08-04 12:01:27 +08001581 INIT_DELAYED_WORK(&fw_cache.work,
1582 device_uncache_fw_images_work);
Ming Lei07646d92012-08-04 12:01:29 +08001583
1584 fw_cache.pm_notify.notifier_call = fw_pm_notify;
1585 register_pm_notifier(&fw_cache.pm_notify);
Ming Leiac39b3e2012-08-20 19:04:16 +08001586
1587 register_syscore_ops(&fw_syscore_ops);
Ming Leicfe016b2012-09-08 17:32:30 +08001588#endif
Ming Lei37276a52012-08-04 12:01:27 +08001589}
1590
Dmitry Torokhov673fae92010-03-13 23:49:13 -08001591static int __init firmware_class_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592{
Ming Lei1f2b7952012-08-04 12:01:21 +08001593 fw_cache_init();
Takashi Iwai7b1269f2013-01-31 11:13:55 +01001594#ifdef CONFIG_FW_LOADER_USER_HELPER
Takashi Iwaife304142013-05-22 18:28:38 +02001595 register_reboot_notifier(&fw_shutdown_nb);
Dmitry Torokhov673fae92010-03-13 23:49:13 -08001596 return class_register(&firmware_class);
Takashi Iwai7b1269f2013-01-31 11:13:55 +01001597#else
1598 return 0;
1599#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600}
Dmitry Torokhov673fae92010-03-13 23:49:13 -08001601
1602static void __exit firmware_class_exit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603{
Ming Leicfe016b2012-09-08 17:32:30 +08001604#ifdef CONFIG_PM_SLEEP
Ming Leiac39b3e2012-08-20 19:04:16 +08001605 unregister_syscore_ops(&fw_syscore_ops);
Ming Lei07646d92012-08-04 12:01:29 +08001606 unregister_pm_notifier(&fw_cache.pm_notify);
Ming Leicfe016b2012-09-08 17:32:30 +08001607#endif
Takashi Iwai7b1269f2013-01-31 11:13:55 +01001608#ifdef CONFIG_FW_LOADER_USER_HELPER
Takashi Iwaife304142013-05-22 18:28:38 +02001609 unregister_reboot_notifier(&fw_shutdown_nb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610 class_unregister(&firmware_class);
Takashi Iwai7b1269f2013-01-31 11:13:55 +01001611#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612}
1613
Shaohua Lia30a6a22006-09-27 01:50:52 -07001614fs_initcall(firmware_class_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615module_exit(firmware_class_exit);