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