]>
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> |
563d0757 | 19 | #include <linux/kthread.h> |
6e03a201 | 20 | #include <linux/highmem.h> |
1da177e4 | 21 | #include <linux/firmware.h> |
5a0e3ad6 | 22 | #include <linux/slab.h> |
1da177e4 | 23 | |
e55c8790 GKH |
24 | #define to_dev(obj) container_of(obj, struct device, kobj) |
25 | ||
87d37a4f | 26 | MODULE_AUTHOR("Manuel Estrada Sainz"); |
1da177e4 LT |
27 | MODULE_DESCRIPTION("Multi purpose firmware loading support"); |
28 | MODULE_LICENSE("GPL"); | |
29 | ||
30 | enum { | |
31 | FW_STATUS_LOADING, | |
32 | FW_STATUS_DONE, | |
33 | FW_STATUS_ABORT, | |
1da177e4 LT |
34 | }; |
35 | ||
2f65168d | 36 | static int loading_timeout = 60; /* In seconds */ |
1da177e4 LT |
37 | |
38 | /* fw_lock could be moved to 'struct firmware_priv' but since it is just | |
39 | * guarding for corner cases a global lock should be OK */ | |
cad1e55d | 40 | static DEFINE_MUTEX(fw_lock); |
1da177e4 LT |
41 | |
42 | struct firmware_priv { | |
976821d7 | 43 | char *fw_id; |
1da177e4 LT |
44 | struct completion completion; |
45 | struct bin_attribute attr_data; | |
46 | struct firmware *fw; | |
47 | unsigned long status; | |
6e03a201 DW |
48 | struct page **pages; |
49 | int nr_pages; | |
50 | int page_array_size; | |
51 | const char *vdata; | |
1da177e4 | 52 | struct timer_list timeout; |
e9045f91 | 53 | bool nowait; |
1da177e4 LT |
54 | }; |
55 | ||
5658c769 DW |
56 | #ifdef CONFIG_FW_LOADER |
57 | extern struct builtin_fw __start_builtin_fw[]; | |
58 | extern struct builtin_fw __end_builtin_fw[]; | |
59 | #else /* Module case. Avoid ifdefs later; it'll all optimise out */ | |
60 | static struct builtin_fw *__start_builtin_fw; | |
61 | static struct builtin_fw *__end_builtin_fw; | |
62 | #endif | |
63 | ||
858119e1 | 64 | static void |
1da177e4 LT |
65 | fw_load_abort(struct firmware_priv *fw_priv) |
66 | { | |
67 | set_bit(FW_STATUS_ABORT, &fw_priv->status); | |
68 | wmb(); | |
69 | complete(&fw_priv->completion); | |
70 | } | |
71 | ||
72 | static ssize_t | |
28812fe1 AK |
73 | firmware_timeout_show(struct class *class, |
74 | struct class_attribute *attr, | |
75 | char *buf) | |
1da177e4 LT |
76 | { |
77 | return sprintf(buf, "%d\n", loading_timeout); | |
78 | } | |
79 | ||
80 | /** | |
eb8e3179 RD |
81 | * firmware_timeout_store - set number of seconds to wait for firmware |
82 | * @class: device class pointer | |
e59817bf | 83 | * @attr: device attribute pointer |
eb8e3179 RD |
84 | * @buf: buffer to scan for timeout value |
85 | * @count: number of bytes in @buf | |
86 | * | |
1da177e4 | 87 | * Sets the number of seconds to wait for the firmware. Once |
eb8e3179 | 88 | * this expires an error will be returned to the driver and no |
1da177e4 LT |
89 | * firmware will be provided. |
90 | * | |
eb8e3179 | 91 | * Note: zero means 'wait forever'. |
1da177e4 LT |
92 | **/ |
93 | static ssize_t | |
28812fe1 AK |
94 | firmware_timeout_store(struct class *class, |
95 | struct class_attribute *attr, | |
96 | const char *buf, size_t count) | |
1da177e4 LT |
97 | { |
98 | loading_timeout = simple_strtol(buf, NULL, 10); | |
b92eac01 SG |
99 | if (loading_timeout < 0) |
100 | loading_timeout = 0; | |
1da177e4 LT |
101 | return count; |
102 | } | |
103 | ||
104 | static CLASS_ATTR(timeout, 0644, firmware_timeout_show, firmware_timeout_store); | |
105 | ||
e55c8790 | 106 | static void fw_dev_release(struct device *dev); |
1da177e4 | 107 | |
7eff2e7a | 108 | static int firmware_uevent(struct device *dev, struct kobj_uevent_env *env) |
1da177e4 | 109 | { |
e55c8790 | 110 | struct firmware_priv *fw_priv = dev_get_drvdata(dev); |
1da177e4 | 111 | |
7eff2e7a | 112 | if (add_uevent_var(env, "FIRMWARE=%s", fw_priv->fw_id)) |
1da177e4 | 113 | return -ENOMEM; |
7eff2e7a | 114 | if (add_uevent_var(env, "TIMEOUT=%i", loading_timeout)) |
6897089c | 115 | return -ENOMEM; |
e9045f91 JB |
116 | if (add_uevent_var(env, "ASYNC=%d", fw_priv->nowait)) |
117 | return -ENOMEM; | |
1da177e4 LT |
118 | |
119 | return 0; | |
120 | } | |
121 | ||
1b81d663 AB |
122 | static struct class firmware_class = { |
123 | .name = "firmware", | |
e55c8790 GKH |
124 | .dev_uevent = firmware_uevent, |
125 | .dev_release = fw_dev_release, | |
1b81d663 AB |
126 | }; |
127 | ||
e55c8790 GKH |
128 | static ssize_t firmware_loading_show(struct device *dev, |
129 | struct device_attribute *attr, char *buf) | |
1da177e4 | 130 | { |
e55c8790 | 131 | struct firmware_priv *fw_priv = dev_get_drvdata(dev); |
1da177e4 LT |
132 | int loading = test_bit(FW_STATUS_LOADING, &fw_priv->status); |
133 | return sprintf(buf, "%d\n", loading); | |
134 | } | |
135 | ||
dd336c55 DW |
136 | static void firmware_free_data(const struct firmware *fw) |
137 | { | |
138 | int i; | |
139 | vunmap(fw->data); | |
140 | if (fw->pages) { | |
141 | for (i = 0; i < PFN_UP(fw->size); i++) | |
142 | __free_page(fw->pages[i]); | |
143 | kfree(fw->pages); | |
144 | } | |
145 | } | |
146 | ||
6e03a201 DW |
147 | /* Some architectures don't have PAGE_KERNEL_RO */ |
148 | #ifndef PAGE_KERNEL_RO | |
149 | #define PAGE_KERNEL_RO PAGE_KERNEL | |
150 | #endif | |
1da177e4 | 151 | /** |
eb8e3179 | 152 | * firmware_loading_store - set value in the 'loading' control file |
e55c8790 | 153 | * @dev: device pointer |
af9997e4 | 154 | * @attr: device attribute pointer |
eb8e3179 RD |
155 | * @buf: buffer to scan for loading control value |
156 | * @count: number of bytes in @buf | |
157 | * | |
1da177e4 LT |
158 | * The relevant values are: |
159 | * | |
160 | * 1: Start a load, discarding any previous partial load. | |
eb8e3179 | 161 | * 0: Conclude the load and hand the data to the driver code. |
1da177e4 LT |
162 | * -1: Conclude the load with an error and discard any written data. |
163 | **/ | |
e55c8790 GKH |
164 | static ssize_t firmware_loading_store(struct device *dev, |
165 | struct device_attribute *attr, | |
166 | const char *buf, size_t count) | |
1da177e4 | 167 | { |
e55c8790 | 168 | struct firmware_priv *fw_priv = dev_get_drvdata(dev); |
1da177e4 | 169 | int loading = simple_strtol(buf, NULL, 10); |
6e03a201 | 170 | int i; |
1da177e4 LT |
171 | |
172 | switch (loading) { | |
173 | case 1: | |
cad1e55d | 174 | mutex_lock(&fw_lock); |
b92eac01 | 175 | if (!fw_priv->fw) { |
cad1e55d | 176 | mutex_unlock(&fw_lock); |
b92eac01 SG |
177 | break; |
178 | } | |
dd336c55 DW |
179 | firmware_free_data(fw_priv->fw); |
180 | memset(fw_priv->fw, 0, sizeof(struct firmware)); | |
181 | /* If the pages are not owned by 'struct firmware' */ | |
6e03a201 DW |
182 | for (i = 0; i < fw_priv->nr_pages; i++) |
183 | __free_page(fw_priv->pages[i]); | |
184 | kfree(fw_priv->pages); | |
185 | fw_priv->pages = NULL; | |
186 | fw_priv->page_array_size = 0; | |
187 | fw_priv->nr_pages = 0; | |
1da177e4 | 188 | set_bit(FW_STATUS_LOADING, &fw_priv->status); |
cad1e55d | 189 | mutex_unlock(&fw_lock); |
1da177e4 LT |
190 | break; |
191 | case 0: | |
192 | if (test_bit(FW_STATUS_LOADING, &fw_priv->status)) { | |
dd336c55 | 193 | vunmap(fw_priv->fw->data); |
6e03a201 DW |
194 | fw_priv->fw->data = vmap(fw_priv->pages, |
195 | fw_priv->nr_pages, | |
196 | 0, PAGE_KERNEL_RO); | |
197 | if (!fw_priv->fw->data) { | |
198 | dev_err(dev, "%s: vmap() failed\n", __func__); | |
199 | goto err; | |
200 | } | |
dd336c55 DW |
201 | /* Pages are now owned by 'struct firmware' */ |
202 | fw_priv->fw->pages = fw_priv->pages; | |
203 | fw_priv->pages = NULL; | |
204 | ||
6e03a201 DW |
205 | fw_priv->page_array_size = 0; |
206 | fw_priv->nr_pages = 0; | |
1da177e4 LT |
207 | complete(&fw_priv->completion); |
208 | clear_bit(FW_STATUS_LOADING, &fw_priv->status); | |
209 | break; | |
210 | } | |
211 | /* fallthrough */ | |
212 | default: | |
266a813c | 213 | dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading); |
1da177e4 LT |
214 | /* fallthrough */ |
215 | case -1: | |
6e03a201 | 216 | err: |
1da177e4 LT |
217 | fw_load_abort(fw_priv); |
218 | break; | |
219 | } | |
220 | ||
221 | return count; | |
222 | } | |
223 | ||
e55c8790 | 224 | static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store); |
1da177e4 LT |
225 | |
226 | static ssize_t | |
91a69029 | 227 | firmware_data_read(struct kobject *kobj, struct bin_attribute *bin_attr, |
1da177e4 LT |
228 | char *buffer, loff_t offset, size_t count) |
229 | { | |
e55c8790 GKH |
230 | struct device *dev = to_dev(kobj); |
231 | struct firmware_priv *fw_priv = dev_get_drvdata(dev); | |
1da177e4 | 232 | struct firmware *fw; |
f37e6617 | 233 | ssize_t ret_count; |
1da177e4 | 234 | |
cad1e55d | 235 | mutex_lock(&fw_lock); |
1da177e4 | 236 | fw = fw_priv->fw; |
b92eac01 | 237 | if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) { |
1da177e4 LT |
238 | ret_count = -ENODEV; |
239 | goto out; | |
240 | } | |
308975fa JS |
241 | if (offset > fw->size) { |
242 | ret_count = 0; | |
243 | goto out; | |
244 | } | |
6e03a201 DW |
245 | if (count > fw->size - offset) |
246 | count = fw->size - offset; | |
247 | ||
248 | ret_count = count; | |
249 | ||
250 | while (count) { | |
251 | void *page_data; | |
252 | int page_nr = offset >> PAGE_SHIFT; | |
253 | int page_ofs = offset & (PAGE_SIZE-1); | |
254 | int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count); | |
255 | ||
256 | page_data = kmap(fw_priv->pages[page_nr]); | |
257 | ||
258 | memcpy(buffer, page_data + page_ofs, page_cnt); | |
259 | ||
260 | kunmap(fw_priv->pages[page_nr]); | |
261 | buffer += page_cnt; | |
262 | offset += page_cnt; | |
263 | count -= page_cnt; | |
264 | } | |
1da177e4 | 265 | out: |
cad1e55d | 266 | mutex_unlock(&fw_lock); |
1da177e4 LT |
267 | return ret_count; |
268 | } | |
eb8e3179 | 269 | |
1da177e4 LT |
270 | static int |
271 | fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size) | |
272 | { | |
6e03a201 DW |
273 | int pages_needed = ALIGN(min_size, PAGE_SIZE) >> PAGE_SHIFT; |
274 | ||
275 | /* If the array of pages is too small, grow it... */ | |
276 | if (fw_priv->page_array_size < pages_needed) { | |
277 | int new_array_size = max(pages_needed, | |
278 | fw_priv->page_array_size * 2); | |
279 | struct page **new_pages; | |
280 | ||
281 | new_pages = kmalloc(new_array_size * sizeof(void *), | |
282 | GFP_KERNEL); | |
283 | if (!new_pages) { | |
284 | fw_load_abort(fw_priv); | |
285 | return -ENOMEM; | |
286 | } | |
287 | memcpy(new_pages, fw_priv->pages, | |
288 | fw_priv->page_array_size * sizeof(void *)); | |
289 | memset(&new_pages[fw_priv->page_array_size], 0, sizeof(void *) * | |
290 | (new_array_size - fw_priv->page_array_size)); | |
291 | kfree(fw_priv->pages); | |
292 | fw_priv->pages = new_pages; | |
293 | fw_priv->page_array_size = new_array_size; | |
294 | } | |
1da177e4 | 295 | |
6e03a201 DW |
296 | while (fw_priv->nr_pages < pages_needed) { |
297 | fw_priv->pages[fw_priv->nr_pages] = | |
298 | alloc_page(GFP_KERNEL | __GFP_HIGHMEM); | |
1da177e4 | 299 | |
6e03a201 DW |
300 | if (!fw_priv->pages[fw_priv->nr_pages]) { |
301 | fw_load_abort(fw_priv); | |
302 | return -ENOMEM; | |
303 | } | |
304 | fw_priv->nr_pages++; | |
1da177e4 | 305 | } |
1da177e4 LT |
306 | return 0; |
307 | } | |
308 | ||
309 | /** | |
eb8e3179 | 310 | * firmware_data_write - write method for firmware |
e55c8790 | 311 | * @kobj: kobject for the device |
42e61f4a | 312 | * @bin_attr: bin_attr structure |
eb8e3179 RD |
313 | * @buffer: buffer being written |
314 | * @offset: buffer offset for write in total data store area | |
315 | * @count: buffer size | |
1da177e4 | 316 | * |
eb8e3179 | 317 | * Data written to the 'data' attribute will be later handed to |
1da177e4 LT |
318 | * the driver as a firmware image. |
319 | **/ | |
320 | static ssize_t | |
91a69029 | 321 | firmware_data_write(struct kobject *kobj, struct bin_attribute *bin_attr, |
1da177e4 LT |
322 | char *buffer, loff_t offset, size_t count) |
323 | { | |
e55c8790 GKH |
324 | struct device *dev = to_dev(kobj); |
325 | struct firmware_priv *fw_priv = dev_get_drvdata(dev); | |
1da177e4 LT |
326 | struct firmware *fw; |
327 | ssize_t retval; | |
328 | ||
329 | if (!capable(CAP_SYS_RAWIO)) | |
330 | return -EPERM; | |
b92eac01 | 331 | |
cad1e55d | 332 | mutex_lock(&fw_lock); |
1da177e4 | 333 | fw = fw_priv->fw; |
b92eac01 | 334 | if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) { |
1da177e4 LT |
335 | retval = -ENODEV; |
336 | goto out; | |
337 | } | |
338 | retval = fw_realloc_buffer(fw_priv, offset + count); | |
339 | if (retval) | |
340 | goto out; | |
341 | ||
1da177e4 | 342 | retval = count; |
6e03a201 DW |
343 | |
344 | while (count) { | |
345 | void *page_data; | |
346 | int page_nr = offset >> PAGE_SHIFT; | |
347 | int page_ofs = offset & (PAGE_SIZE - 1); | |
348 | int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count); | |
349 | ||
350 | page_data = kmap(fw_priv->pages[page_nr]); | |
351 | ||
352 | memcpy(page_data + page_ofs, buffer, page_cnt); | |
353 | ||
354 | kunmap(fw_priv->pages[page_nr]); | |
355 | buffer += page_cnt; | |
356 | offset += page_cnt; | |
357 | count -= page_cnt; | |
358 | } | |
359 | ||
360 | fw->size = max_t(size_t, offset, fw->size); | |
1da177e4 | 361 | out: |
cad1e55d | 362 | mutex_unlock(&fw_lock); |
1da177e4 LT |
363 | return retval; |
364 | } | |
eb8e3179 | 365 | |
1da177e4 | 366 | static struct bin_attribute firmware_attr_data_tmpl = { |
7b595756 | 367 | .attr = {.name = "data", .mode = 0644}, |
1da177e4 LT |
368 | .size = 0, |
369 | .read = firmware_data_read, | |
370 | .write = firmware_data_write, | |
371 | }; | |
372 | ||
e55c8790 | 373 | static void fw_dev_release(struct device *dev) |
1da177e4 | 374 | { |
e55c8790 | 375 | struct firmware_priv *fw_priv = dev_get_drvdata(dev); |
6e03a201 | 376 | int i; |
1da177e4 | 377 | |
6e03a201 DW |
378 | for (i = 0; i < fw_priv->nr_pages; i++) |
379 | __free_page(fw_priv->pages[i]); | |
380 | kfree(fw_priv->pages); | |
976821d7 | 381 | kfree(fw_priv->fw_id); |
1da177e4 | 382 | kfree(fw_priv); |
0f2f2221 | 383 | kfree(dev); |
1da177e4 LT |
384 | |
385 | module_put(THIS_MODULE); | |
386 | } | |
387 | ||
388 | static void | |
389 | firmware_class_timeout(u_long data) | |
390 | { | |
391 | struct firmware_priv *fw_priv = (struct firmware_priv *) data; | |
392 | fw_load_abort(fw_priv); | |
393 | } | |
394 | ||
e55c8790 GKH |
395 | static int fw_register_device(struct device **dev_p, const char *fw_name, |
396 | struct device *device) | |
1da177e4 LT |
397 | { |
398 | int retval; | |
4aed0644 | 399 | struct firmware_priv *fw_priv = kzalloc(sizeof(*fw_priv), |
1da177e4 | 400 | GFP_KERNEL); |
e55c8790 | 401 | struct device *f_dev = kzalloc(sizeof(*f_dev), GFP_KERNEL); |
1da177e4 | 402 | |
e55c8790 | 403 | *dev_p = NULL; |
1da177e4 | 404 | |
e55c8790 | 405 | if (!fw_priv || !f_dev) { |
266a813c | 406 | dev_err(device, "%s: kmalloc failed\n", __func__); |
1da177e4 LT |
407 | retval = -ENOMEM; |
408 | goto error_kfree; | |
409 | } | |
1da177e4 LT |
410 | |
411 | init_completion(&fw_priv->completion); | |
412 | fw_priv->attr_data = firmware_attr_data_tmpl; | |
976821d7 SO |
413 | fw_priv->fw_id = kstrdup(fw_name, GFP_KERNEL); |
414 | if (!fw_priv->fw_id) { | |
415 | dev_err(device, "%s: Firmware name allocation failed\n", | |
416 | __func__); | |
417 | retval = -ENOMEM; | |
418 | goto error_kfree; | |
419 | } | |
1da177e4 LT |
420 | |
421 | fw_priv->timeout.function = firmware_class_timeout; | |
422 | fw_priv->timeout.data = (u_long) fw_priv; | |
423 | init_timer(&fw_priv->timeout); | |
424 | ||
acc0e90f | 425 | dev_set_name(f_dev, "%s", dev_name(device)); |
e55c8790 GKH |
426 | f_dev->parent = device; |
427 | f_dev->class = &firmware_class; | |
428 | dev_set_drvdata(f_dev, fw_priv); | |
f67f129e | 429 | dev_set_uevent_suppress(f_dev, 1); |
e55c8790 | 430 | retval = device_register(f_dev); |
1da177e4 | 431 | if (retval) { |
266a813c | 432 | dev_err(device, "%s: device_register failed\n", __func__); |
6acf70f0 | 433 | put_device(f_dev); |
0f2f2221 | 434 | return retval; |
1da177e4 | 435 | } |
e55c8790 | 436 | *dev_p = f_dev; |
1da177e4 LT |
437 | return 0; |
438 | ||
439 | error_kfree: | |
e55c8790 | 440 | kfree(f_dev); |
6acf70f0 | 441 | kfree(fw_priv); |
1da177e4 LT |
442 | return retval; |
443 | } | |
444 | ||
e55c8790 GKH |
445 | static int fw_setup_device(struct firmware *fw, struct device **dev_p, |
446 | const char *fw_name, struct device *device, | |
e9045f91 | 447 | int uevent, bool nowait) |
1da177e4 | 448 | { |
e55c8790 | 449 | struct device *f_dev; |
1da177e4 LT |
450 | struct firmware_priv *fw_priv; |
451 | int retval; | |
452 | ||
e55c8790 GKH |
453 | *dev_p = NULL; |
454 | retval = fw_register_device(&f_dev, fw_name, device); | |
1da177e4 LT |
455 | if (retval) |
456 | goto out; | |
457 | ||
458 | /* Need to pin this module until class device is destroyed */ | |
459 | __module_get(THIS_MODULE); | |
460 | ||
e55c8790 | 461 | fw_priv = dev_get_drvdata(f_dev); |
1da177e4 | 462 | |
e9045f91 JB |
463 | fw_priv->nowait = nowait; |
464 | ||
1da177e4 | 465 | fw_priv->fw = fw; |
e1955ca0 | 466 | sysfs_bin_attr_init(&fw_priv->attr_data); |
e55c8790 | 467 | retval = sysfs_create_bin_file(&f_dev->kobj, &fw_priv->attr_data); |
1da177e4 | 468 | if (retval) { |
266a813c | 469 | dev_err(device, "%s: sysfs_create_bin_file failed\n", __func__); |
1da177e4 LT |
470 | goto error_unreg; |
471 | } | |
472 | ||
e55c8790 | 473 | retval = device_create_file(f_dev, &dev_attr_loading); |
1da177e4 | 474 | if (retval) { |
266a813c | 475 | dev_err(device, "%s: device_create_file failed\n", __func__); |
1da177e4 LT |
476 | goto error_unreg; |
477 | } | |
478 | ||
312c004d | 479 | if (uevent) |
f67f129e | 480 | dev_set_uevent_suppress(f_dev, 0); |
e55c8790 | 481 | *dev_p = f_dev; |
1da177e4 LT |
482 | goto out; |
483 | ||
484 | error_unreg: | |
e55c8790 | 485 | device_unregister(f_dev); |
1da177e4 LT |
486 | out: |
487 | return retval; | |
488 | } | |
489 | ||
6e3eaab0 AS |
490 | static int |
491 | _request_firmware(const struct firmware **firmware_p, const char *name, | |
e9045f91 | 492 | struct device *device, int uevent, bool nowait) |
1da177e4 | 493 | { |
e55c8790 | 494 | struct device *f_dev; |
1da177e4 LT |
495 | struct firmware_priv *fw_priv; |
496 | struct firmware *firmware; | |
5658c769 | 497 | struct builtin_fw *builtin; |
1da177e4 LT |
498 | int retval; |
499 | ||
500 | if (!firmware_p) | |
501 | return -EINVAL; | |
502 | ||
4aed0644 | 503 | *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL); |
1da177e4 | 504 | if (!firmware) { |
266a813c BH |
505 | dev_err(device, "%s: kmalloc(struct firmware) failed\n", |
506 | __func__); | |
1da177e4 LT |
507 | retval = -ENOMEM; |
508 | goto out; | |
509 | } | |
1da177e4 | 510 | |
5658c769 DW |
511 | for (builtin = __start_builtin_fw; builtin != __end_builtin_fw; |
512 | builtin++) { | |
513 | if (strcmp(name, builtin->name)) | |
514 | continue; | |
6f18ff91 | 515 | dev_dbg(device, "firmware: using built-in firmware %s\n", name); |
5658c769 DW |
516 | firmware->size = builtin->size; |
517 | firmware->data = builtin->data; | |
518 | return 0; | |
519 | } | |
520 | ||
521 | if (uevent) | |
6f18ff91 | 522 | dev_dbg(device, "firmware: requesting %s\n", name); |
5658c769 | 523 | |
e9045f91 JB |
524 | retval = fw_setup_device(firmware, &f_dev, name, device, |
525 | uevent, nowait); | |
1da177e4 LT |
526 | if (retval) |
527 | goto error_kfree_fw; | |
528 | ||
e55c8790 | 529 | fw_priv = dev_get_drvdata(f_dev); |
1da177e4 | 530 | |
312c004d | 531 | if (uevent) { |
6e3eaab0 AS |
532 | if (loading_timeout > 0) { |
533 | fw_priv->timeout.expires = jiffies + loading_timeout * HZ; | |
534 | add_timer(&fw_priv->timeout); | |
535 | } | |
1da177e4 | 536 | |
e55c8790 | 537 | kobject_uevent(&f_dev->kobj, KOBJ_ADD); |
6e3eaab0 AS |
538 | wait_for_completion(&fw_priv->completion); |
539 | set_bit(FW_STATUS_DONE, &fw_priv->status); | |
540 | del_timer_sync(&fw_priv->timeout); | |
541 | } else | |
542 | wait_for_completion(&fw_priv->completion); | |
1da177e4 | 543 | |
cad1e55d | 544 | mutex_lock(&fw_lock); |
1da177e4 LT |
545 | if (!fw_priv->fw->size || test_bit(FW_STATUS_ABORT, &fw_priv->status)) { |
546 | retval = -ENOENT; | |
547 | release_firmware(fw_priv->fw); | |
548 | *firmware_p = NULL; | |
549 | } | |
550 | fw_priv->fw = NULL; | |
cad1e55d | 551 | mutex_unlock(&fw_lock); |
e55c8790 | 552 | device_unregister(f_dev); |
1da177e4 LT |
553 | goto out; |
554 | ||
555 | error_kfree_fw: | |
556 | kfree(firmware); | |
557 | *firmware_p = NULL; | |
558 | out: | |
559 | return retval; | |
560 | } | |
561 | ||
6e3eaab0 | 562 | /** |
312c004d | 563 | * request_firmware: - send firmware request and wait for it |
eb8e3179 RD |
564 | * @firmware_p: pointer to firmware image |
565 | * @name: name of firmware file | |
566 | * @device: device for which firmware is being loaded | |
567 | * | |
568 | * @firmware_p will be used to return a firmware image by the name | |
6e3eaab0 AS |
569 | * of @name for device @device. |
570 | * | |
571 | * Should be called from user context where sleeping is allowed. | |
572 | * | |
312c004d | 573 | * @name will be used as $FIRMWARE in the uevent environment and |
6e3eaab0 AS |
574 | * should be distinctive enough not to be confused with any other |
575 | * firmware image for this or any other device. | |
576 | **/ | |
577 | int | |
578 | request_firmware(const struct firmware **firmware_p, const char *name, | |
579 | struct device *device) | |
580 | { | |
312c004d | 581 | int uevent = 1; |
e9045f91 | 582 | return _request_firmware(firmware_p, name, device, uevent, false); |
6e3eaab0 AS |
583 | } |
584 | ||
1da177e4 LT |
585 | /** |
586 | * release_firmware: - release the resource associated with a firmware image | |
eb8e3179 | 587 | * @fw: firmware resource to release |
1da177e4 LT |
588 | **/ |
589 | void | |
590 | release_firmware(const struct firmware *fw) | |
591 | { | |
5658c769 DW |
592 | struct builtin_fw *builtin; |
593 | ||
1da177e4 | 594 | if (fw) { |
5658c769 DW |
595 | for (builtin = __start_builtin_fw; builtin != __end_builtin_fw; |
596 | builtin++) { | |
597 | if (fw->data == builtin->data) | |
598 | goto free_fw; | |
599 | } | |
dd336c55 | 600 | firmware_free_data(fw); |
5658c769 | 601 | free_fw: |
1da177e4 LT |
602 | kfree(fw); |
603 | } | |
604 | } | |
605 | ||
1da177e4 LT |
606 | /* Async support */ |
607 | struct firmware_work { | |
608 | struct work_struct work; | |
609 | struct module *module; | |
610 | const char *name; | |
611 | struct device *device; | |
612 | void *context; | |
613 | void (*cont)(const struct firmware *fw, void *context); | |
312c004d | 614 | int uevent; |
1da177e4 LT |
615 | }; |
616 | ||
617 | static int | |
618 | request_firmware_work_func(void *arg) | |
619 | { | |
620 | struct firmware_work *fw_work = arg; | |
621 | const struct firmware *fw; | |
113fab13 | 622 | int ret; |
1da177e4 LT |
623 | if (!arg) { |
624 | WARN_ON(1); | |
625 | return 0; | |
626 | } | |
113fab13 | 627 | ret = _request_firmware(&fw, fw_work->name, fw_work->device, |
e9045f91 | 628 | fw_work->uevent, true); |
9ebfbd45 JB |
629 | |
630 | fw_work->cont(fw, fw_work->context); | |
631 | ||
1da177e4 LT |
632 | module_put(fw_work->module); |
633 | kfree(fw_work); | |
113fab13 | 634 | return ret; |
1da177e4 LT |
635 | } |
636 | ||
637 | /** | |
3c31f07a | 638 | * request_firmware_nowait - asynchronous version of request_firmware |
eb8e3179 | 639 | * @module: module requesting the firmware |
312c004d | 640 | * @uevent: sends uevent to copy the firmware image if this flag |
eb8e3179 RD |
641 | * is non-zero else the firmware copy must be done manually. |
642 | * @name: name of firmware file | |
643 | * @device: device for which firmware is being loaded | |
9ebfbd45 | 644 | * @gfp: allocation flags |
eb8e3179 RD |
645 | * @context: will be passed over to @cont, and |
646 | * @fw may be %NULL if firmware request fails. | |
647 | * @cont: function will be called asynchronously when the firmware | |
648 | * request is over. | |
1da177e4 | 649 | * |
7fcab099 ML |
650 | * Asynchronous variant of request_firmware() for user contexts where |
651 | * it is not possible to sleep for long time. It can't be called | |
652 | * in atomic contexts. | |
1da177e4 LT |
653 | **/ |
654 | int | |
655 | request_firmware_nowait( | |
312c004d | 656 | struct module *module, int uevent, |
9ebfbd45 | 657 | const char *name, struct device *device, gfp_t gfp, void *context, |
1da177e4 LT |
658 | void (*cont)(const struct firmware *fw, void *context)) |
659 | { | |
563d0757 | 660 | struct task_struct *task; |
1da177e4 | 661 | struct firmware_work *fw_work = kmalloc(sizeof (struct firmware_work), |
9ebfbd45 | 662 | gfp); |
1da177e4 LT |
663 | |
664 | if (!fw_work) | |
665 | return -ENOMEM; | |
666 | if (!try_module_get(module)) { | |
667 | kfree(fw_work); | |
668 | return -EFAULT; | |
669 | } | |
670 | ||
671 | *fw_work = (struct firmware_work) { | |
672 | .module = module, | |
673 | .name = name, | |
674 | .device = device, | |
675 | .context = context, | |
676 | .cont = cont, | |
312c004d | 677 | .uevent = uevent, |
1da177e4 LT |
678 | }; |
679 | ||
563d0757 SB |
680 | task = kthread_run(request_firmware_work_func, fw_work, |
681 | "firmware/%s", name); | |
1da177e4 | 682 | |
563d0757 | 683 | if (IS_ERR(task)) { |
1da177e4 | 684 | fw_work->cont(NULL, fw_work->context); |
113fab13 MC |
685 | module_put(fw_work->module); |
686 | kfree(fw_work); | |
563d0757 | 687 | return PTR_ERR(task); |
1da177e4 LT |
688 | } |
689 | return 0; | |
690 | } | |
691 | ||
692 | static int __init | |
693 | firmware_class_init(void) | |
694 | { | |
695 | int error; | |
696 | error = class_register(&firmware_class); | |
697 | if (error) { | |
2b3a302a | 698 | printk(KERN_ERR "%s: class_register failed\n", __func__); |
1da177e4 LT |
699 | return error; |
700 | } | |
701 | error = class_create_file(&firmware_class, &class_attr_timeout); | |
702 | if (error) { | |
703 | printk(KERN_ERR "%s: class_create_file failed\n", | |
2b3a302a | 704 | __func__); |
1da177e4 LT |
705 | class_unregister(&firmware_class); |
706 | } | |
707 | return error; | |
708 | ||
709 | } | |
710 | static void __exit | |
711 | firmware_class_exit(void) | |
712 | { | |
713 | class_unregister(&firmware_class); | |
714 | } | |
715 | ||
a30a6a2c | 716 | fs_initcall(firmware_class_init); |
1da177e4 LT |
717 | module_exit(firmware_class_exit); |
718 | ||
719 | EXPORT_SYMBOL(release_firmware); | |
720 | EXPORT_SYMBOL(request_firmware); | |
721 | EXPORT_SYMBOL(request_firmware_nowait); |