firmware loader: always let firmware_buf own the pages buffer
[linux-2.6-block.git] / drivers / base / firmware_class.c
CommitLineData
1da177e4
LT
1/*
2 * firmware_class.c - Multi purpose firmware loading support
3 *
87d37a4f 4 * Copyright (c) 2003 Manuel Estrada Sainz
1da177e4
LT
5 *
6 * Please see Documentation/firmware_class/ for more information.
7 *
8 */
9
c59ede7b 10#include <linux/capability.h>
1da177e4
LT
11#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>
cad1e55d 18#include <linux/mutex.h>
a36cf844 19#include <linux/workqueue.h>
6e03a201 20#include <linux/highmem.h>
1da177e4 21#include <linux/firmware.h>
5a0e3ad6 22#include <linux/slab.h>
a36cf844 23#include <linux/sched.h>
1f2b7959 24#include <linux/list.h>
1da177e4 25
87d37a4f 26MODULE_AUTHOR("Manuel Estrada Sainz");
1da177e4
LT
27MODULE_DESCRIPTION("Multi purpose firmware loading support");
28MODULE_LICENSE("GPL");
29
bcb9bd18
DT
30/* Builtin firmware support */
31
32#ifdef CONFIG_FW_LOADER
33
34extern struct builtin_fw __start_builtin_fw[];
35extern struct builtin_fw __end_builtin_fw[];
36
37static bool fw_get_builtin_firmware(struct firmware *fw, const char *name)
38{
39 struct builtin_fw *b_fw;
40
41 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++) {
42 if (strcmp(name, b_fw->name) == 0) {
43 fw->size = b_fw->size;
44 fw->data = b_fw->data;
45 return true;
46 }
47 }
48
49 return false;
50}
51
52static bool fw_is_builtin_firmware(const struct firmware *fw)
53{
54 struct builtin_fw *b_fw;
55
56 for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++)
57 if (fw->data == b_fw->data)
58 return true;
59
60 return false;
61}
62
63#else /* Module case - no builtin firmware support */
64
65static inline bool fw_get_builtin_firmware(struct firmware *fw, const char *name)
66{
67 return false;
68}
69
70static inline bool fw_is_builtin_firmware(const struct firmware *fw)
71{
72 return false;
73}
74#endif
75
1da177e4
LT
76enum {
77 FW_STATUS_LOADING,
78 FW_STATUS_DONE,
79 FW_STATUS_ABORT,
1da177e4
LT
80};
81
2f65168d 82static int loading_timeout = 60; /* In seconds */
1da177e4 83
9b78c1da
RW
84static inline long firmware_loading_timeout(void)
85{
86 return loading_timeout > 0 ? loading_timeout * HZ : MAX_SCHEDULE_TIMEOUT;
87}
88
1f2b7959
ML
89struct firmware_cache {
90 /* firmware_buf instance will be added into the below list */
91 spinlock_t lock;
92 struct list_head head;
93};
1da177e4 94
1244691c 95struct firmware_buf {
1f2b7959
ML
96 struct kref ref;
97 struct list_head list;
1da177e4 98 struct completion completion;
1f2b7959 99 struct firmware_cache *fwc;
1da177e4 100 unsigned long status;
65710cb6
ML
101 void *data;
102 size_t size;
6e03a201
DW
103 struct page **pages;
104 int nr_pages;
105 int page_array_size;
1244691c
ML
106 char fw_id[];
107};
108
109struct firmware_priv {
1da177e4 110 struct timer_list timeout;
e9045f91 111 bool nowait;
1244691c
ML
112 struct device dev;
113 struct firmware_buf *buf;
1f2b7959 114 struct firmware *fw;
1da177e4
LT
115};
116
1f2b7959
ML
117#define to_fwbuf(d) container_of(d, struct firmware_buf, ref)
118
119/* fw_lock could be moved to 'struct firmware_priv' but since it is just
120 * guarding for corner cases a global lock should be OK */
121static DEFINE_MUTEX(fw_lock);
122
123static struct firmware_cache fw_cache;
124
125static struct firmware_buf *__allocate_fw_buf(const char *fw_name,
126 struct firmware_cache *fwc)
127{
128 struct firmware_buf *buf;
129
130 buf = kzalloc(sizeof(*buf) + strlen(fw_name) + 1 , GFP_ATOMIC);
131
132 if (!buf)
133 return buf;
134
135 kref_init(&buf->ref);
136 strcpy(buf->fw_id, fw_name);
137 buf->fwc = fwc;
138 init_completion(&buf->completion);
139
140 pr_debug("%s: fw-%s buf=%p\n", __func__, fw_name, buf);
141
142 return buf;
143}
144
145static int fw_lookup_and_allocate_buf(const char *fw_name,
146 struct firmware_cache *fwc,
147 struct firmware_buf **buf)
148{
149 struct firmware_buf *tmp;
150
151 spin_lock(&fwc->lock);
152 list_for_each_entry(tmp, &fwc->head, list)
153 if (!strcmp(tmp->fw_id, fw_name)) {
154 kref_get(&tmp->ref);
155 spin_unlock(&fwc->lock);
156 *buf = tmp;
157 return 1;
158 }
159
160 tmp = __allocate_fw_buf(fw_name, fwc);
161 if (tmp)
162 list_add(&tmp->list, &fwc->head);
163 spin_unlock(&fwc->lock);
164
165 *buf = tmp;
166
167 return tmp ? 0 : -ENOMEM;
168}
169
170static void __fw_free_buf(struct kref *ref)
171{
172 struct firmware_buf *buf = to_fwbuf(ref);
173 struct firmware_cache *fwc = buf->fwc;
174 int i;
175
176 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
177 __func__, buf->fw_id, buf, buf->data,
178 (unsigned int)buf->size);
179
180 spin_lock(&fwc->lock);
181 list_del(&buf->list);
182 spin_unlock(&fwc->lock);
183
184 vunmap(buf->data);
185 for (i = 0; i < buf->nr_pages; i++)
186 __free_page(buf->pages[i]);
187 kfree(buf->pages);
188 kfree(buf);
189}
190
191static void fw_free_buf(struct firmware_buf *buf)
192{
193 kref_put(&buf->ref, __fw_free_buf);
194}
195
196static void __init fw_cache_init(void)
197{
198 spin_lock_init(&fw_cache.lock);
199 INIT_LIST_HEAD(&fw_cache.head);
200}
201
f8a4bd34
DT
202static struct firmware_priv *to_firmware_priv(struct device *dev)
203{
204 return container_of(dev, struct firmware_priv, dev);
205}
206
207static void fw_load_abort(struct firmware_priv *fw_priv)
1da177e4 208{
1244691c
ML
209 struct firmware_buf *buf = fw_priv->buf;
210
211 set_bit(FW_STATUS_ABORT, &buf->status);
1f2b7959 212 complete_all(&buf->completion);
1da177e4
LT
213}
214
f8a4bd34
DT
215static ssize_t firmware_timeout_show(struct class *class,
216 struct class_attribute *attr,
217 char *buf)
1da177e4
LT
218{
219 return sprintf(buf, "%d\n", loading_timeout);
220}
221
222/**
eb8e3179
RD
223 * firmware_timeout_store - set number of seconds to wait for firmware
224 * @class: device class pointer
e59817bf 225 * @attr: device attribute pointer
eb8e3179
RD
226 * @buf: buffer to scan for timeout value
227 * @count: number of bytes in @buf
228 *
1da177e4 229 * Sets the number of seconds to wait for the firmware. Once
eb8e3179 230 * this expires an error will be returned to the driver and no
1da177e4
LT
231 * firmware will be provided.
232 *
eb8e3179 233 * Note: zero means 'wait forever'.
1da177e4 234 **/
f8a4bd34
DT
235static ssize_t firmware_timeout_store(struct class *class,
236 struct class_attribute *attr,
237 const char *buf, size_t count)
1da177e4
LT
238{
239 loading_timeout = simple_strtol(buf, NULL, 10);
b92eac01
SG
240 if (loading_timeout < 0)
241 loading_timeout = 0;
f8a4bd34 242
1da177e4
LT
243 return count;
244}
245
673fae90
DT
246static struct class_attribute firmware_class_attrs[] = {
247 __ATTR(timeout, S_IWUSR | S_IRUGO,
248 firmware_timeout_show, firmware_timeout_store),
249 __ATTR_NULL
250};
1da177e4 251
1244691c
ML
252static void fw_dev_release(struct device *dev)
253{
254 struct firmware_priv *fw_priv = to_firmware_priv(dev);
65710cb6 255
673fae90 256 kfree(fw_priv);
673fae90
DT
257
258 module_put(THIS_MODULE);
259}
1da177e4 260
7eff2e7a 261static int firmware_uevent(struct device *dev, struct kobj_uevent_env *env)
1da177e4 262{
f8a4bd34 263 struct firmware_priv *fw_priv = to_firmware_priv(dev);
1da177e4 264
1244691c 265 if (add_uevent_var(env, "FIRMWARE=%s", fw_priv->buf->fw_id))
1da177e4 266 return -ENOMEM;
7eff2e7a 267 if (add_uevent_var(env, "TIMEOUT=%i", loading_timeout))
6897089c 268 return -ENOMEM;
e9045f91
JB
269 if (add_uevent_var(env, "ASYNC=%d", fw_priv->nowait))
270 return -ENOMEM;
1da177e4
LT
271
272 return 0;
273}
274
1b81d663
AB
275static struct class firmware_class = {
276 .name = "firmware",
673fae90 277 .class_attrs = firmware_class_attrs,
e55c8790
GKH
278 .dev_uevent = firmware_uevent,
279 .dev_release = fw_dev_release,
1b81d663
AB
280};
281
e55c8790
GKH
282static ssize_t firmware_loading_show(struct device *dev,
283 struct device_attribute *attr, char *buf)
1da177e4 284{
f8a4bd34 285 struct firmware_priv *fw_priv = to_firmware_priv(dev);
1244691c 286 int loading = test_bit(FW_STATUS_LOADING, &fw_priv->buf->status);
f8a4bd34 287
1da177e4
LT
288 return sprintf(buf, "%d\n", loading);
289}
290
65710cb6 291/* firmware holds the ownership of pages */
dd336c55
DW
292static void firmware_free_data(const struct firmware *fw)
293{
1f2b7959
ML
294 WARN_ON(!fw->priv);
295 fw_free_buf(fw->priv);
dd336c55
DW
296}
297
6e03a201
DW
298/* Some architectures don't have PAGE_KERNEL_RO */
299#ifndef PAGE_KERNEL_RO
300#define PAGE_KERNEL_RO PAGE_KERNEL
301#endif
1da177e4 302/**
eb8e3179 303 * firmware_loading_store - set value in the 'loading' control file
e55c8790 304 * @dev: device pointer
af9997e4 305 * @attr: device attribute pointer
eb8e3179
RD
306 * @buf: buffer to scan for loading control value
307 * @count: number of bytes in @buf
308 *
1da177e4
LT
309 * The relevant values are:
310 *
311 * 1: Start a load, discarding any previous partial load.
eb8e3179 312 * 0: Conclude the load and hand the data to the driver code.
1da177e4
LT
313 * -1: Conclude the load with an error and discard any written data.
314 **/
e55c8790
GKH
315static ssize_t firmware_loading_store(struct device *dev,
316 struct device_attribute *attr,
317 const char *buf, size_t count)
1da177e4 318{
f8a4bd34 319 struct firmware_priv *fw_priv = to_firmware_priv(dev);
1244691c 320 struct firmware_buf *fw_buf = fw_priv->buf;
1da177e4 321 int loading = simple_strtol(buf, NULL, 10);
6e03a201 322 int i;
1da177e4 323
eea915bb
NH
324 mutex_lock(&fw_lock);
325
1244691c 326 if (!fw_buf)
eea915bb
NH
327 goto out;
328
1da177e4
LT
329 switch (loading) {
330 case 1:
65710cb6 331 /* discarding any previous partial load */
1244691c
ML
332 if (!test_bit(FW_STATUS_DONE, &fw_buf->status)) {
333 for (i = 0; i < fw_buf->nr_pages; i++)
334 __free_page(fw_buf->pages[i]);
335 kfree(fw_buf->pages);
336 fw_buf->pages = NULL;
337 fw_buf->page_array_size = 0;
338 fw_buf->nr_pages = 0;
339 set_bit(FW_STATUS_LOADING, &fw_buf->status);
28eefa75 340 }
1da177e4
LT
341 break;
342 case 0:
1244691c
ML
343 if (test_bit(FW_STATUS_LOADING, &fw_buf->status)) {
344 set_bit(FW_STATUS_DONE, &fw_buf->status);
345 clear_bit(FW_STATUS_LOADING, &fw_buf->status);
1f2b7959 346 complete_all(&fw_buf->completion);
1da177e4
LT
347 break;
348 }
349 /* fallthrough */
350 default:
266a813c 351 dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading);
1da177e4
LT
352 /* fallthrough */
353 case -1:
354 fw_load_abort(fw_priv);
355 break;
356 }
eea915bb
NH
357out:
358 mutex_unlock(&fw_lock);
1da177e4
LT
359 return count;
360}
361
e55c8790 362static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store);
1da177e4 363
f8a4bd34
DT
364static ssize_t firmware_data_read(struct file *filp, struct kobject *kobj,
365 struct bin_attribute *bin_attr,
366 char *buffer, loff_t offset, size_t count)
1da177e4 367{
b0d1f807 368 struct device *dev = kobj_to_dev(kobj);
f8a4bd34 369 struct firmware_priv *fw_priv = to_firmware_priv(dev);
1244691c 370 struct firmware_buf *buf;
f37e6617 371 ssize_t ret_count;
1da177e4 372
cad1e55d 373 mutex_lock(&fw_lock);
1244691c
ML
374 buf = fw_priv->buf;
375 if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) {
1da177e4
LT
376 ret_count = -ENODEV;
377 goto out;
378 }
1244691c 379 if (offset > buf->size) {
308975fa
JS
380 ret_count = 0;
381 goto out;
382 }
1244691c
ML
383 if (count > buf->size - offset)
384 count = buf->size - offset;
6e03a201
DW
385
386 ret_count = count;
387
388 while (count) {
389 void *page_data;
390 int page_nr = offset >> PAGE_SHIFT;
391 int page_ofs = offset & (PAGE_SIZE-1);
392 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
393
1244691c 394 page_data = kmap(buf->pages[page_nr]);
6e03a201
DW
395
396 memcpy(buffer, page_data + page_ofs, page_cnt);
397
1244691c 398 kunmap(buf->pages[page_nr]);
6e03a201
DW
399 buffer += page_cnt;
400 offset += page_cnt;
401 count -= page_cnt;
402 }
1da177e4 403out:
cad1e55d 404 mutex_unlock(&fw_lock);
1da177e4
LT
405 return ret_count;
406}
eb8e3179 407
f8a4bd34 408static int fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
1da177e4 409{
1244691c 410 struct firmware_buf *buf = fw_priv->buf;
6e03a201
DW
411 int pages_needed = ALIGN(min_size, PAGE_SIZE) >> PAGE_SHIFT;
412
413 /* If the array of pages is too small, grow it... */
1244691c 414 if (buf->page_array_size < pages_needed) {
6e03a201 415 int new_array_size = max(pages_needed,
1244691c 416 buf->page_array_size * 2);
6e03a201
DW
417 struct page **new_pages;
418
419 new_pages = kmalloc(new_array_size * sizeof(void *),
420 GFP_KERNEL);
421 if (!new_pages) {
422 fw_load_abort(fw_priv);
423 return -ENOMEM;
424 }
1244691c
ML
425 memcpy(new_pages, buf->pages,
426 buf->page_array_size * sizeof(void *));
427 memset(&new_pages[buf->page_array_size], 0, sizeof(void *) *
428 (new_array_size - buf->page_array_size));
429 kfree(buf->pages);
430 buf->pages = new_pages;
431 buf->page_array_size = new_array_size;
6e03a201 432 }
1da177e4 433
1244691c
ML
434 while (buf->nr_pages < pages_needed) {
435 buf->pages[buf->nr_pages] =
6e03a201 436 alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
1da177e4 437
1244691c 438 if (!buf->pages[buf->nr_pages]) {
6e03a201
DW
439 fw_load_abort(fw_priv);
440 return -ENOMEM;
441 }
1244691c 442 buf->nr_pages++;
1da177e4 443 }
1da177e4
LT
444 return 0;
445}
446
447/**
eb8e3179 448 * firmware_data_write - write method for firmware
2c3c8bea 449 * @filp: open sysfs file
e55c8790 450 * @kobj: kobject for the device
42e61f4a 451 * @bin_attr: bin_attr structure
eb8e3179
RD
452 * @buffer: buffer being written
453 * @offset: buffer offset for write in total data store area
454 * @count: buffer size
1da177e4 455 *
eb8e3179 456 * Data written to the 'data' attribute will be later handed to
1da177e4
LT
457 * the driver as a firmware image.
458 **/
f8a4bd34
DT
459static ssize_t firmware_data_write(struct file *filp, struct kobject *kobj,
460 struct bin_attribute *bin_attr,
461 char *buffer, loff_t offset, size_t count)
1da177e4 462{
b0d1f807 463 struct device *dev = kobj_to_dev(kobj);
f8a4bd34 464 struct firmware_priv *fw_priv = to_firmware_priv(dev);
1244691c 465 struct firmware_buf *buf;
1da177e4
LT
466 ssize_t retval;
467
468 if (!capable(CAP_SYS_RAWIO))
469 return -EPERM;
b92eac01 470
cad1e55d 471 mutex_lock(&fw_lock);
1244691c
ML
472 buf = fw_priv->buf;
473 if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) {
1da177e4
LT
474 retval = -ENODEV;
475 goto out;
476 }
65710cb6 477
1da177e4
LT
478 retval = fw_realloc_buffer(fw_priv, offset + count);
479 if (retval)
480 goto out;
481
1da177e4 482 retval = count;
6e03a201
DW
483
484 while (count) {
485 void *page_data;
486 int page_nr = offset >> PAGE_SHIFT;
487 int page_ofs = offset & (PAGE_SIZE - 1);
488 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
489
1244691c 490 page_data = kmap(buf->pages[page_nr]);
6e03a201
DW
491
492 memcpy(page_data + page_ofs, buffer, page_cnt);
493
1244691c 494 kunmap(buf->pages[page_nr]);
6e03a201
DW
495 buffer += page_cnt;
496 offset += page_cnt;
497 count -= page_cnt;
498 }
499
1244691c 500 buf->size = max_t(size_t, offset, buf->size);
1da177e4 501out:
cad1e55d 502 mutex_unlock(&fw_lock);
1da177e4
LT
503 return retval;
504}
eb8e3179 505
0983ca2d
DT
506static struct bin_attribute firmware_attr_data = {
507 .attr = { .name = "data", .mode = 0644 },
1da177e4
LT
508 .size = 0,
509 .read = firmware_data_read,
510 .write = firmware_data_write,
511};
512
f8a4bd34 513static void firmware_class_timeout(u_long data)
1da177e4
LT
514{
515 struct firmware_priv *fw_priv = (struct firmware_priv *) data;
f8a4bd34 516
1da177e4
LT
517 fw_load_abort(fw_priv);
518}
519
f8a4bd34 520static struct firmware_priv *
dddb5549 521fw_create_instance(struct firmware *firmware, const char *fw_name,
f8a4bd34 522 struct device *device, bool uevent, bool nowait)
1da177e4 523{
f8a4bd34
DT
524 struct firmware_priv *fw_priv;
525 struct device *f_dev;
1da177e4 526
1244691c 527 fw_priv = kzalloc(sizeof(*fw_priv), GFP_KERNEL);
f8a4bd34 528 if (!fw_priv) {
266a813c 529 dev_err(device, "%s: kmalloc failed\n", __func__);
1244691c
ML
530 fw_priv = ERR_PTR(-ENOMEM);
531 goto exit;
532 }
533
f8a4bd34 534 fw_priv->nowait = nowait;
1f2b7959 535 fw_priv->fw = firmware;
f8a4bd34
DT
536 setup_timer(&fw_priv->timeout,
537 firmware_class_timeout, (u_long) fw_priv);
1da177e4 538
f8a4bd34
DT
539 f_dev = &fw_priv->dev;
540
541 device_initialize(f_dev);
99c2aa72 542 dev_set_name(f_dev, "%s", fw_name);
e55c8790
GKH
543 f_dev->parent = device;
544 f_dev->class = &firmware_class;
1244691c 545exit:
f8a4bd34 546 return fw_priv;
1da177e4
LT
547}
548
1f2b7959
ML
549/* one pages buffer is mapped/unmapped only once */
550static int fw_map_pages_buf(struct firmware_buf *buf)
551{
552 buf->data = vmap(buf->pages, buf->nr_pages, 0, PAGE_KERNEL_RO);
553 if (!buf->data)
554 return -ENOMEM;
555 return 0;
556}
557
558/* store the pages buffer info firmware from buf */
559static void fw_set_page_data(struct firmware_buf *buf, struct firmware *fw)
560{
561 fw->priv = buf;
562 fw->pages = buf->pages;
563 fw->size = buf->size;
564 fw->data = buf->data;
565
566 pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
567 __func__, buf->fw_id, buf, buf->data,
568 (unsigned int)buf->size);
569}
570
571static void _request_firmware_cleanup(const struct firmware **firmware_p)
572{
573 release_firmware(*firmware_p);
574 *firmware_p = NULL;
575}
576
dddb5549
SB
577static struct firmware_priv *
578_request_firmware_prepare(const struct firmware **firmware_p, const char *name,
579 struct device *device, bool uevent, bool nowait)
1da177e4 580{
1da177e4 581 struct firmware *firmware;
1f2b7959
ML
582 struct firmware_priv *fw_priv = NULL;
583 struct firmware_buf *buf;
584 int ret;
1da177e4
LT
585
586 if (!firmware_p)
dddb5549 587 return ERR_PTR(-EINVAL);
1da177e4 588
4aed0644 589 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
1da177e4 590 if (!firmware) {
266a813c
BH
591 dev_err(device, "%s: kmalloc(struct firmware) failed\n",
592 __func__);
dddb5549 593 return ERR_PTR(-ENOMEM);
1da177e4 594 }
1da177e4 595
bcb9bd18 596 if (fw_get_builtin_firmware(firmware, name)) {
6f18ff91 597 dev_dbg(device, "firmware: using built-in firmware %s\n", name);
dddb5549 598 return NULL;
5658c769
DW
599 }
600
1f2b7959
ML
601 ret = fw_lookup_and_allocate_buf(name, &fw_cache, &buf);
602 if (!ret)
603 fw_priv = fw_create_instance(firmware, name, device,
604 uevent, nowait);
605
606 if (IS_ERR(fw_priv) || ret < 0) {
607 kfree(firmware);
dddb5549 608 *firmware_p = NULL;
1f2b7959
ML
609 return ERR_PTR(-ENOMEM);
610 } else if (fw_priv) {
611 fw_priv->buf = buf;
612
613 /*
614 * bind with 'buf' now to avoid warning in failure path
615 * of requesting firmware.
616 */
617 firmware->priv = buf;
618 return fw_priv;
dddb5549 619 }
811fa400 620
1f2b7959
ML
621 /* share the cached buf, which is inprogessing or completed */
622 check_status:
623 mutex_lock(&fw_lock);
624 if (test_bit(FW_STATUS_ABORT, &buf->status)) {
625 fw_priv = ERR_PTR(-ENOENT);
626 _request_firmware_cleanup(firmware_p);
627 goto exit;
628 } else if (test_bit(FW_STATUS_DONE, &buf->status)) {
629 fw_priv = NULL;
630 fw_set_page_data(buf, firmware);
631 goto exit;
632 }
633 mutex_unlock(&fw_lock);
634 wait_for_completion(&buf->completion);
635 goto check_status;
65710cb6 636
1f2b7959
ML
637exit:
638 mutex_unlock(&fw_lock);
639 return fw_priv;
65710cb6
ML
640}
641
dddb5549
SB
642static int _request_firmware_load(struct firmware_priv *fw_priv, bool uevent,
643 long timeout)
811fa400 644{
9b78c1da 645 int retval = 0;
dddb5549 646 struct device *f_dev = &fw_priv->dev;
1244691c 647 struct firmware_buf *buf = fw_priv->buf;
dddb5549
SB
648
649 dev_set_uevent_suppress(f_dev, true);
caca9510 650
dddb5549
SB
651 /* Need to pin this module until class device is destroyed */
652 __module_get(THIS_MODULE);
5658c769 653
dddb5549
SB
654 retval = device_add(f_dev);
655 if (retval) {
656 dev_err(f_dev, "%s: device_register failed\n", __func__);
657 goto err_put_dev;
658 }
659
660 retval = device_create_bin_file(f_dev, &firmware_attr_data);
661 if (retval) {
662 dev_err(f_dev, "%s: sysfs_create_bin_file failed\n", __func__);
663 goto err_del_dev;
664 }
665
666 retval = device_create_file(f_dev, &dev_attr_loading);
667 if (retval) {
668 dev_err(f_dev, "%s: device_create_file failed\n", __func__);
669 goto err_del_bin_attr;
670 }
1da177e4 671
312c004d 672 if (uevent) {
dddb5549 673 dev_set_uevent_suppress(f_dev, false);
1244691c 674 dev_dbg(f_dev, "firmware: requesting %s\n", buf->fw_id);
9b78c1da 675 if (timeout != MAX_SCHEDULE_TIMEOUT)
f8a4bd34 676 mod_timer(&fw_priv->timeout,
9b78c1da 677 round_jiffies_up(jiffies + timeout));
f8a4bd34
DT
678
679 kobject_uevent(&fw_priv->dev.kobj, KOBJ_ADD);
680 }
681
1244691c 682 wait_for_completion(&buf->completion);
1da177e4 683
f8a4bd34 684 del_timer_sync(&fw_priv->timeout);
1da177e4 685
cad1e55d 686 mutex_lock(&fw_lock);
1244691c 687 if (!buf->size || test_bit(FW_STATUS_ABORT, &buf->status))
1da177e4 688 retval = -ENOENT;
65710cb6 689
65710cb6 690 if (!retval)
1f2b7959
ML
691 retval = fw_map_pages_buf(buf);
692
693 /* pass the pages buffer to driver at the last minute */
694 fw_set_page_data(buf, fw_priv->fw);
1244691c 695
1244691c 696 fw_priv->buf = NULL;
cad1e55d 697 mutex_unlock(&fw_lock);
1da177e4 698
dddb5549
SB
699 device_remove_file(f_dev, &dev_attr_loading);
700err_del_bin_attr:
701 device_remove_bin_file(f_dev, &firmware_attr_data);
702err_del_dev:
703 device_del(f_dev);
704err_put_dev:
705 put_device(f_dev);
1da177e4
LT
706 return retval;
707}
708
6e3eaab0 709/**
312c004d 710 * request_firmware: - send firmware request and wait for it
eb8e3179
RD
711 * @firmware_p: pointer to firmware image
712 * @name: name of firmware file
713 * @device: device for which firmware is being loaded
714 *
715 * @firmware_p will be used to return a firmware image by the name
6e3eaab0
AS
716 * of @name for device @device.
717 *
718 * Should be called from user context where sleeping is allowed.
719 *
312c004d 720 * @name will be used as $FIRMWARE in the uevent environment and
6e3eaab0
AS
721 * should be distinctive enough not to be confused with any other
722 * firmware image for this or any other device.
723 **/
724int
725request_firmware(const struct firmware **firmware_p, const char *name,
726 struct device *device)
727{
dddb5549 728 struct firmware_priv *fw_priv;
811fa400
RW
729 int ret;
730
dddb5549
SB
731 fw_priv = _request_firmware_prepare(firmware_p, name, device, true,
732 false);
733 if (IS_ERR_OR_NULL(fw_priv))
734 return PTR_RET(fw_priv);
811fa400 735
9b78c1da
RW
736 ret = usermodehelper_read_trylock();
737 if (WARN_ON(ret)) {
738 dev_err(device, "firmware: %s will not be loaded\n", name);
739 } else {
dddb5549 740 ret = _request_firmware_load(fw_priv, true,
9b78c1da
RW
741 firmware_loading_timeout());
742 usermodehelper_read_unlock();
743 }
811fa400
RW
744 if (ret)
745 _request_firmware_cleanup(firmware_p);
746
747 return ret;
6e3eaab0
AS
748}
749
1da177e4
LT
750/**
751 * release_firmware: - release the resource associated with a firmware image
eb8e3179 752 * @fw: firmware resource to release
1da177e4 753 **/
bcb9bd18 754void release_firmware(const struct firmware *fw)
1da177e4
LT
755{
756 if (fw) {
bcb9bd18
DT
757 if (!fw_is_builtin_firmware(fw))
758 firmware_free_data(fw);
1da177e4
LT
759 kfree(fw);
760 }
761}
762
1da177e4
LT
763/* Async support */
764struct firmware_work {
765 struct work_struct work;
766 struct module *module;
767 const char *name;
768 struct device *device;
769 void *context;
770 void (*cont)(const struct firmware *fw, void *context);
072fc8f0 771 bool uevent;
1da177e4
LT
772};
773
a36cf844 774static void request_firmware_work_func(struct work_struct *work)
1da177e4 775{
a36cf844 776 struct firmware_work *fw_work;
1da177e4 777 const struct firmware *fw;
dddb5549 778 struct firmware_priv *fw_priv;
9b78c1da 779 long timeout;
113fab13 780 int ret;
f8a4bd34 781
a36cf844 782 fw_work = container_of(work, struct firmware_work, work);
dddb5549
SB
783 fw_priv = _request_firmware_prepare(&fw, fw_work->name, fw_work->device,
784 fw_work->uevent, true);
785 if (IS_ERR_OR_NULL(fw_priv)) {
786 ret = PTR_RET(fw_priv);
811fa400 787 goto out;
dddb5549 788 }
811fa400 789
9b78c1da
RW
790 timeout = usermodehelper_read_lock_wait(firmware_loading_timeout());
791 if (timeout) {
dddb5549 792 ret = _request_firmware_load(fw_priv, fw_work->uevent, timeout);
9b78c1da
RW
793 usermodehelper_read_unlock();
794 } else {
795 dev_dbg(fw_work->device, "firmware: %s loading timed out\n",
796 fw_work->name);
797 ret = -EAGAIN;
798 }
811fa400
RW
799 if (ret)
800 _request_firmware_cleanup(&fw);
801
802 out:
9ebfbd45
JB
803 fw_work->cont(fw, fw_work->context);
804
1da177e4
LT
805 module_put(fw_work->module);
806 kfree(fw_work);
1da177e4
LT
807}
808
809/**
3c31f07a 810 * request_firmware_nowait - asynchronous version of request_firmware
eb8e3179 811 * @module: module requesting the firmware
312c004d 812 * @uevent: sends uevent to copy the firmware image if this flag
eb8e3179
RD
813 * is non-zero else the firmware copy must be done manually.
814 * @name: name of firmware file
815 * @device: device for which firmware is being loaded
9ebfbd45 816 * @gfp: allocation flags
eb8e3179
RD
817 * @context: will be passed over to @cont, and
818 * @fw may be %NULL if firmware request fails.
819 * @cont: function will be called asynchronously when the firmware
820 * request is over.
1da177e4 821 *
7fcab099
ML
822 * Asynchronous variant of request_firmware() for user contexts where
823 * it is not possible to sleep for long time. It can't be called
824 * in atomic contexts.
1da177e4
LT
825 **/
826int
827request_firmware_nowait(
072fc8f0 828 struct module *module, bool uevent,
9ebfbd45 829 const char *name, struct device *device, gfp_t gfp, void *context,
1da177e4
LT
830 void (*cont)(const struct firmware *fw, void *context))
831{
f8a4bd34 832 struct firmware_work *fw_work;
1da177e4 833
f8a4bd34 834 fw_work = kzalloc(sizeof (struct firmware_work), gfp);
1da177e4
LT
835 if (!fw_work)
836 return -ENOMEM;
f8a4bd34
DT
837
838 fw_work->module = module;
839 fw_work->name = name;
840 fw_work->device = device;
841 fw_work->context = context;
842 fw_work->cont = cont;
843 fw_work->uevent = uevent;
844
1da177e4
LT
845 if (!try_module_get(module)) {
846 kfree(fw_work);
847 return -EFAULT;
848 }
849
a36cf844
SB
850 INIT_WORK(&fw_work->work, request_firmware_work_func);
851 schedule_work(&fw_work->work);
1da177e4
LT
852 return 0;
853}
854
673fae90 855static int __init firmware_class_init(void)
1da177e4 856{
1f2b7959 857 fw_cache_init();
673fae90 858 return class_register(&firmware_class);
1da177e4 859}
673fae90
DT
860
861static void __exit firmware_class_exit(void)
1da177e4
LT
862{
863 class_unregister(&firmware_class);
864}
865
a30a6a2c 866fs_initcall(firmware_class_init);
1da177e4
LT
867module_exit(firmware_class_exit);
868
869EXPORT_SYMBOL(release_firmware);
870EXPORT_SYMBOL(request_firmware);
871EXPORT_SYMBOL(request_firmware_nowait);