blob: 7376367bcb8053dec4951945f916d47c882fd59a [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>
Sukadev Bhattiprolu563d0752006-09-29 01:59:31 -070019#include <linux/kthread.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>
22#include "base.h"
23
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -070024#define to_dev(obj) container_of(obj, struct device, kobj)
25
Markus Rechberger87d37a42007-06-04 18:45:44 +020026MODULE_AUTHOR("Manuel Estrada Sainz");
Linus Torvalds1da177e2005-04-16 15:20:36 -070027MODULE_DESCRIPTION("Multi purpose firmware loading support");
28MODULE_LICENSE("GPL");
29
30enum {
31 FW_STATUS_LOADING,
32 FW_STATUS_DONE,
33 FW_STATUS_ABORT,
Linus Torvalds1da177e2005-04-16 15:20:36 -070034};
35
Dave Jones2f651682007-01-25 15:56:15 -050036static int loading_timeout = 60; /* In seconds */
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
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 */
Laura Garciacad1e552006-05-23 23:22:38 +020040static DEFINE_MUTEX(fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
42struct firmware_priv {
Samuel Ortiz976821d2009-05-27 00:49:31 +020043 char *fw_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 struct completion completion;
45 struct bin_attribute attr_data;
46 struct firmware *fw;
47 unsigned long status;
David Woodhouse6e03a202009-04-09 22:04:07 -070048 struct page **pages;
49 int nr_pages;
50 int page_array_size;
51 const char *vdata;
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 struct timer_list timeout;
53};
54
David Woodhouse5658c762008-05-23 13:52:42 +010055#ifdef CONFIG_FW_LOADER
56extern struct builtin_fw __start_builtin_fw[];
57extern struct builtin_fw __end_builtin_fw[];
58#else /* Module case. Avoid ifdefs later; it'll all optimise out */
59static struct builtin_fw *__start_builtin_fw;
60static struct builtin_fw *__end_builtin_fw;
61#endif
62
Arjan van de Ven858119e2006-01-14 13:20:43 -080063static void
Linus Torvalds1da177e2005-04-16 15:20:36 -070064fw_load_abort(struct firmware_priv *fw_priv)
65{
66 set_bit(FW_STATUS_ABORT, &fw_priv->status);
67 wmb();
68 complete(&fw_priv->completion);
69}
70
71static ssize_t
72firmware_timeout_show(struct class *class, char *buf)
73{
74 return sprintf(buf, "%d\n", loading_timeout);
75}
76
77/**
Randy Dunlapeb8e3172005-10-30 15:03:01 -080078 * firmware_timeout_store - set number of seconds to wait for firmware
79 * @class: device class pointer
80 * @buf: buffer to scan for timeout value
81 * @count: number of bytes in @buf
82 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 * Sets the number of seconds to wait for the firmware. Once
Randy Dunlapeb8e3172005-10-30 15:03:01 -080084 * this expires an error will be returned to the driver and no
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 * firmware will be provided.
86 *
Randy Dunlapeb8e3172005-10-30 15:03:01 -080087 * Note: zero means 'wait forever'.
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 **/
89static ssize_t
90firmware_timeout_store(struct class *class, const char *buf, size_t count)
91{
92 loading_timeout = simple_strtol(buf, NULL, 10);
Stanislaw W. Gruszkab92eac02005-06-28 20:44:51 -070093 if (loading_timeout < 0)
94 loading_timeout = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 return count;
96}
97
98static CLASS_ATTR(timeout, 0644, firmware_timeout_show, firmware_timeout_store);
99
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700100static void fw_dev_release(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
Kay Sievers7eff2e72007-08-14 15:15:12 +0200102static int firmware_uevent(struct device *dev, struct kobj_uevent_env *env)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103{
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700104 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
Kay Sievers7eff2e72007-08-14 15:15:12 +0200106 if (add_uevent_var(env, "FIRMWARE=%s", fw_priv->fw_id))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 return -ENOMEM;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200108 if (add_uevent_var(env, "TIMEOUT=%i", loading_timeout))
kay.sievers@vrfy.org68970892005-04-18 21:57:31 -0700109 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
111 return 0;
112}
113
Adrian Bunk1b81d662006-05-20 15:00:16 -0700114static struct class firmware_class = {
115 .name = "firmware",
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700116 .dev_uevent = firmware_uevent,
117 .dev_release = fw_dev_release,
Adrian Bunk1b81d662006-05-20 15:00:16 -0700118};
119
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700120static ssize_t firmware_loading_show(struct device *dev,
121 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122{
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700123 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 int loading = test_bit(FW_STATUS_LOADING, &fw_priv->status);
125 return sprintf(buf, "%d\n", loading);
126}
127
David Woodhouse6e03a202009-04-09 22:04:07 -0700128/* Some architectures don't have PAGE_KERNEL_RO */
129#ifndef PAGE_KERNEL_RO
130#define PAGE_KERNEL_RO PAGE_KERNEL
131#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132/**
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800133 * firmware_loading_store - set value in the 'loading' control file
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700134 * @dev: device pointer
Randy Dunlapaf9997e2006-12-22 01:06:52 -0800135 * @attr: device attribute pointer
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800136 * @buf: buffer to scan for loading control value
137 * @count: number of bytes in @buf
138 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 * The relevant values are:
140 *
141 * 1: Start a load, discarding any previous partial load.
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800142 * 0: Conclude the load and hand the data to the driver code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 * -1: Conclude the load with an error and discard any written data.
144 **/
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700145static ssize_t firmware_loading_store(struct device *dev,
146 struct device_attribute *attr,
147 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148{
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700149 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 int loading = simple_strtol(buf, NULL, 10);
David Woodhouse6e03a202009-04-09 22:04:07 -0700151 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152
153 switch (loading) {
154 case 1:
Laura Garciacad1e552006-05-23 23:22:38 +0200155 mutex_lock(&fw_lock);
Stanislaw W. Gruszkab92eac02005-06-28 20:44:51 -0700156 if (!fw_priv->fw) {
Laura Garciacad1e552006-05-23 23:22:38 +0200157 mutex_unlock(&fw_lock);
Stanislaw W. Gruszkab92eac02005-06-28 20:44:51 -0700158 break;
159 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 vfree(fw_priv->fw->data);
161 fw_priv->fw->data = NULL;
David Woodhouse6e03a202009-04-09 22:04:07 -0700162 for (i = 0; i < fw_priv->nr_pages; i++)
163 __free_page(fw_priv->pages[i]);
164 kfree(fw_priv->pages);
165 fw_priv->pages = NULL;
166 fw_priv->page_array_size = 0;
167 fw_priv->nr_pages = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 fw_priv->fw->size = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 set_bit(FW_STATUS_LOADING, &fw_priv->status);
Laura Garciacad1e552006-05-23 23:22:38 +0200170 mutex_unlock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 break;
172 case 0:
173 if (test_bit(FW_STATUS_LOADING, &fw_priv->status)) {
David Woodhouse6e03a202009-04-09 22:04:07 -0700174 vfree(fw_priv->fw->data);
175 fw_priv->fw->data = vmap(fw_priv->pages,
176 fw_priv->nr_pages,
177 0, PAGE_KERNEL_RO);
178 if (!fw_priv->fw->data) {
179 dev_err(dev, "%s: vmap() failed\n", __func__);
180 goto err;
181 }
182 /* Pages will be freed by vfree() */
David Woodhouse6e03a202009-04-09 22:04:07 -0700183 fw_priv->page_array_size = 0;
184 fw_priv->nr_pages = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 complete(&fw_priv->completion);
186 clear_bit(FW_STATUS_LOADING, &fw_priv->status);
187 break;
188 }
189 /* fallthrough */
190 default:
Bjorn Helgaas266a8132008-10-15 22:04:20 -0700191 dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 /* fallthrough */
193 case -1:
David Woodhouse6e03a202009-04-09 22:04:07 -0700194 err:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 fw_load_abort(fw_priv);
196 break;
197 }
198
199 return count;
200}
201
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700202static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
204static ssize_t
Zhang Rui91a69022007-06-09 13:57:22 +0800205firmware_data_read(struct kobject *kobj, struct bin_attribute *bin_attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 char *buffer, loff_t offset, size_t count)
207{
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700208 struct device *dev = to_dev(kobj);
209 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 struct firmware *fw;
Akinobu Mitaf37e6612008-07-25 01:48:23 -0700211 ssize_t ret_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
Laura Garciacad1e552006-05-23 23:22:38 +0200213 mutex_lock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 fw = fw_priv->fw;
Stanislaw W. Gruszkab92eac02005-06-28 20:44:51 -0700215 if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 ret_count = -ENODEV;
217 goto out;
218 }
Jiri Slaby308975f2009-06-21 23:57:31 +0200219 if (offset > fw->size) {
220 ret_count = 0;
221 goto out;
222 }
David Woodhouse6e03a202009-04-09 22:04:07 -0700223 if (count > fw->size - offset)
224 count = fw->size - offset;
225
226 ret_count = count;
227
228 while (count) {
229 void *page_data;
230 int page_nr = offset >> PAGE_SHIFT;
231 int page_ofs = offset & (PAGE_SIZE-1);
232 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
233
234 page_data = kmap(fw_priv->pages[page_nr]);
235
236 memcpy(buffer, page_data + page_ofs, page_cnt);
237
238 kunmap(fw_priv->pages[page_nr]);
239 buffer += page_cnt;
240 offset += page_cnt;
241 count -= page_cnt;
242 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243out:
Laura Garciacad1e552006-05-23 23:22:38 +0200244 mutex_unlock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 return ret_count;
246}
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800247
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248static int
249fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
250{
David Woodhouse6e03a202009-04-09 22:04:07 -0700251 int pages_needed = ALIGN(min_size, PAGE_SIZE) >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252
David Woodhouse6e03a202009-04-09 22:04:07 -0700253 /* If the array of pages is too small, grow it... */
254 if (fw_priv->page_array_size < pages_needed) {
255 int new_array_size = max(pages_needed,
256 fw_priv->page_array_size * 2);
257 struct page **new_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258
David Woodhouse6e03a202009-04-09 22:04:07 -0700259 new_pages = kmalloc(new_array_size * sizeof(void *),
260 GFP_KERNEL);
261 if (!new_pages) {
262 fw_load_abort(fw_priv);
263 return -ENOMEM;
264 }
265 memcpy(new_pages, fw_priv->pages,
266 fw_priv->page_array_size * sizeof(void *));
267 memset(&new_pages[fw_priv->page_array_size], 0, sizeof(void *) *
268 (new_array_size - fw_priv->page_array_size));
269 kfree(fw_priv->pages);
270 fw_priv->pages = new_pages;
271 fw_priv->page_array_size = new_array_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 }
David Woodhouse6e03a202009-04-09 22:04:07 -0700273
274 while (fw_priv->nr_pages < pages_needed) {
275 fw_priv->pages[fw_priv->nr_pages] =
276 alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
277
278 if (!fw_priv->pages[fw_priv->nr_pages]) {
279 fw_load_abort(fw_priv);
280 return -ENOMEM;
281 }
282 fw_priv->nr_pages++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 return 0;
285}
286
287/**
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800288 * firmware_data_write - write method for firmware
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700289 * @kobj: kobject for the device
Randy Dunlap42e61f42007-07-23 21:42:11 -0700290 * @bin_attr: bin_attr structure
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800291 * @buffer: buffer being written
292 * @offset: buffer offset for write in total data store area
293 * @count: buffer size
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 *
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800295 * Data written to the 'data' attribute will be later handed to
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 * the driver as a firmware image.
297 **/
298static ssize_t
Zhang Rui91a69022007-06-09 13:57:22 +0800299firmware_data_write(struct kobject *kobj, struct bin_attribute *bin_attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 char *buffer, loff_t offset, size_t count)
301{
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700302 struct device *dev = to_dev(kobj);
303 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 struct firmware *fw;
305 ssize_t retval;
306
307 if (!capable(CAP_SYS_RAWIO))
308 return -EPERM;
Stanislaw W. Gruszkab92eac02005-06-28 20:44:51 -0700309
Laura Garciacad1e552006-05-23 23:22:38 +0200310 mutex_lock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 fw = fw_priv->fw;
Stanislaw W. Gruszkab92eac02005-06-28 20:44:51 -0700312 if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 retval = -ENODEV;
314 goto out;
315 }
316 retval = fw_realloc_buffer(fw_priv, offset + count);
317 if (retval)
318 goto out;
319
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 retval = count;
David Woodhouse6e03a202009-04-09 22:04:07 -0700321
322 while (count) {
323 void *page_data;
324 int page_nr = offset >> PAGE_SHIFT;
325 int page_ofs = offset & (PAGE_SIZE - 1);
326 int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);
327
328 page_data = kmap(fw_priv->pages[page_nr]);
329
330 memcpy(page_data + page_ofs, buffer, page_cnt);
331
332 kunmap(fw_priv->pages[page_nr]);
333 buffer += page_cnt;
334 offset += page_cnt;
335 count -= page_cnt;
336 }
337
338 fw->size = max_t(size_t, offset, fw->size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339out:
Laura Garciacad1e552006-05-23 23:22:38 +0200340 mutex_unlock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 return retval;
342}
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800343
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344static struct bin_attribute firmware_attr_data_tmpl = {
Tejun Heo7b595752007-06-14 03:45:17 +0900345 .attr = {.name = "data", .mode = 0644},
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 .size = 0,
347 .read = firmware_data_read,
348 .write = firmware_data_write,
349};
350
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700351static void fw_dev_release(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352{
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700353 struct firmware_priv *fw_priv = dev_get_drvdata(dev);
David Woodhouse6e03a202009-04-09 22:04:07 -0700354 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355
David Woodhouse6e03a202009-04-09 22:04:07 -0700356 for (i = 0; i < fw_priv->nr_pages; i++)
357 __free_page(fw_priv->pages[i]);
358 kfree(fw_priv->pages);
Samuel Ortiz976821d2009-05-27 00:49:31 +0200359 kfree(fw_priv->fw_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 kfree(fw_priv);
Catalin Marinas0f2f2222009-07-08 11:17:40 +0100361 kfree(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362
363 module_put(THIS_MODULE);
364}
365
366static void
367firmware_class_timeout(u_long data)
368{
369 struct firmware_priv *fw_priv = (struct firmware_priv *) data;
370 fw_load_abort(fw_priv);
371}
372
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700373static int fw_register_device(struct device **dev_p, const char *fw_name,
374 struct device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375{
376 int retval;
Jiri Slaby4aed0642005-09-13 01:25:01 -0700377 struct firmware_priv *fw_priv = kzalloc(sizeof(*fw_priv),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 GFP_KERNEL);
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700379 struct device *f_dev = kzalloc(sizeof(*f_dev), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700381 *dev_p = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700383 if (!fw_priv || !f_dev) {
Bjorn Helgaas266a8132008-10-15 22:04:20 -0700384 dev_err(device, "%s: kmalloc failed\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 retval = -ENOMEM;
386 goto error_kfree;
387 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
389 init_completion(&fw_priv->completion);
390 fw_priv->attr_data = firmware_attr_data_tmpl;
Samuel Ortiz976821d2009-05-27 00:49:31 +0200391 fw_priv->fw_id = kstrdup(fw_name, GFP_KERNEL);
392 if (!fw_priv->fw_id) {
393 dev_err(device, "%s: Firmware name allocation failed\n",
394 __func__);
395 retval = -ENOMEM;
396 goto error_kfree;
397 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398
399 fw_priv->timeout.function = firmware_class_timeout;
400 fw_priv->timeout.data = (u_long) fw_priv;
401 init_timer(&fw_priv->timeout);
402
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -0700403 dev_set_name(f_dev, "%s", dev_name(device));
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700404 f_dev->parent = device;
405 f_dev->class = &firmware_class;
406 dev_set_drvdata(f_dev, fw_priv);
Ming Leif67f1292009-03-01 21:10:49 +0800407 dev_set_uevent_suppress(f_dev, 1);
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700408 retval = device_register(f_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 if (retval) {
Bjorn Helgaas266a8132008-10-15 22:04:20 -0700410 dev_err(device, "%s: device_register failed\n", __func__);
Ming Lei6acf70f2009-04-23 22:31:52 +0800411 put_device(f_dev);
Catalin Marinas0f2f2222009-07-08 11:17:40 +0100412 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 }
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700414 *dev_p = f_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 return 0;
416
417error_kfree:
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700418 kfree(f_dev);
Ming Lei6acf70f2009-04-23 22:31:52 +0800419 kfree(fw_priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 return retval;
421}
422
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700423static int fw_setup_device(struct firmware *fw, struct device **dev_p,
424 const char *fw_name, struct device *device,
425 int uevent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426{
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700427 struct device *f_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 struct firmware_priv *fw_priv;
429 int retval;
430
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700431 *dev_p = NULL;
432 retval = fw_register_device(&f_dev, fw_name, device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 if (retval)
434 goto out;
435
436 /* Need to pin this module until class device is destroyed */
437 __module_get(THIS_MODULE);
438
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700439 fw_priv = dev_get_drvdata(f_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440
441 fw_priv->fw = fw;
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700442 retval = sysfs_create_bin_file(&f_dev->kobj, &fw_priv->attr_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 if (retval) {
Bjorn Helgaas266a8132008-10-15 22:04:20 -0700444 dev_err(device, "%s: sysfs_create_bin_file failed\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 goto error_unreg;
446 }
447
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700448 retval = device_create_file(f_dev, &dev_attr_loading);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 if (retval) {
Bjorn Helgaas266a8132008-10-15 22:04:20 -0700450 dev_err(device, "%s: device_create_file failed\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 goto error_unreg;
452 }
453
Kay Sievers312c0042005-11-16 09:00:00 +0100454 if (uevent)
Ming Leif67f1292009-03-01 21:10:49 +0800455 dev_set_uevent_suppress(f_dev, 0);
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700456 *dev_p = f_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 goto out;
458
459error_unreg:
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700460 device_unregister(f_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461out:
462 return retval;
463}
464
Abhay Salunke6e3eaab2005-09-06 15:17:13 -0700465static int
466_request_firmware(const struct firmware **firmware_p, const char *name,
Kay Sievers312c0042005-11-16 09:00:00 +0100467 struct device *device, int uevent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468{
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700469 struct device *f_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 struct firmware_priv *fw_priv;
471 struct firmware *firmware;
David Woodhouse5658c762008-05-23 13:52:42 +0100472 struct builtin_fw *builtin;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 int retval;
474
475 if (!firmware_p)
476 return -EINVAL;
477
Jiri Slaby4aed0642005-09-13 01:25:01 -0700478 *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 if (!firmware) {
Bjorn Helgaas266a8132008-10-15 22:04:20 -0700480 dev_err(device, "%s: kmalloc(struct firmware) failed\n",
481 __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 retval = -ENOMEM;
483 goto out;
484 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485
David Woodhouse5658c762008-05-23 13:52:42 +0100486 for (builtin = __start_builtin_fw; builtin != __end_builtin_fw;
487 builtin++) {
488 if (strcmp(name, builtin->name))
489 continue;
Bjorn Helgaas266a8132008-10-15 22:04:20 -0700490 dev_info(device, "firmware: using built-in firmware %s\n",
491 name);
David Woodhouse5658c762008-05-23 13:52:42 +0100492 firmware->size = builtin->size;
493 firmware->data = builtin->data;
494 return 0;
495 }
496
497 if (uevent)
Bjorn Helgaas266a8132008-10-15 22:04:20 -0700498 dev_info(device, "firmware: requesting %s\n", name);
David Woodhouse5658c762008-05-23 13:52:42 +0100499
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700500 retval = fw_setup_device(firmware, &f_dev, name, device, uevent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 if (retval)
502 goto error_kfree_fw;
503
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700504 fw_priv = dev_get_drvdata(f_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505
Kay Sievers312c0042005-11-16 09:00:00 +0100506 if (uevent) {
Abhay Salunke6e3eaab2005-09-06 15:17:13 -0700507 if (loading_timeout > 0) {
508 fw_priv->timeout.expires = jiffies + loading_timeout * HZ;
509 add_timer(&fw_priv->timeout);
510 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700512 kobject_uevent(&f_dev->kobj, KOBJ_ADD);
Abhay Salunke6e3eaab2005-09-06 15:17:13 -0700513 wait_for_completion(&fw_priv->completion);
514 set_bit(FW_STATUS_DONE, &fw_priv->status);
515 del_timer_sync(&fw_priv->timeout);
516 } else
517 wait_for_completion(&fw_priv->completion);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
Laura Garciacad1e552006-05-23 23:22:38 +0200519 mutex_lock(&fw_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 if (!fw_priv->fw->size || test_bit(FW_STATUS_ABORT, &fw_priv->status)) {
521 retval = -ENOENT;
522 release_firmware(fw_priv->fw);
523 *firmware_p = NULL;
524 }
525 fw_priv->fw = NULL;
Laura Garciacad1e552006-05-23 23:22:38 +0200526 mutex_unlock(&fw_lock);
Greg Kroah-Hartmane55c8792006-09-14 07:30:59 -0700527 device_unregister(f_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 goto out;
529
530error_kfree_fw:
531 kfree(firmware);
532 *firmware_p = NULL;
533out:
534 return retval;
535}
536
537/**
Kay Sievers312c0042005-11-16 09:00:00 +0100538 * request_firmware: - send firmware request and wait for it
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800539 * @firmware_p: pointer to firmware image
540 * @name: name of firmware file
541 * @device: device for which firmware is being loaded
542 *
543 * @firmware_p will be used to return a firmware image by the name
Abhay Salunke6e3eaab2005-09-06 15:17:13 -0700544 * of @name for device @device.
545 *
546 * Should be called from user context where sleeping is allowed.
547 *
Kay Sievers312c0042005-11-16 09:00:00 +0100548 * @name will be used as $FIRMWARE in the uevent environment and
Abhay Salunke6e3eaab2005-09-06 15:17:13 -0700549 * should be distinctive enough not to be confused with any other
550 * firmware image for this or any other device.
551 **/
552int
553request_firmware(const struct firmware **firmware_p, const char *name,
554 struct device *device)
555{
Kay Sievers312c0042005-11-16 09:00:00 +0100556 int uevent = 1;
557 return _request_firmware(firmware_p, name, device, uevent);
Abhay Salunke6e3eaab2005-09-06 15:17:13 -0700558}
559
560/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 * release_firmware: - release the resource associated with a firmware image
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800562 * @fw: firmware resource to release
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 **/
564void
565release_firmware(const struct firmware *fw)
566{
David Woodhouse5658c762008-05-23 13:52:42 +0100567 struct builtin_fw *builtin;
568
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 if (fw) {
David Woodhouse5658c762008-05-23 13:52:42 +0100570 for (builtin = __start_builtin_fw; builtin != __end_builtin_fw;
571 builtin++) {
572 if (fw->data == builtin->data)
573 goto free_fw;
574 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 vfree(fw->data);
David Woodhouse5658c762008-05-23 13:52:42 +0100576 free_fw:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 kfree(fw);
578 }
579}
580
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581/* Async support */
582struct firmware_work {
583 struct work_struct work;
584 struct module *module;
585 const char *name;
586 struct device *device;
587 void *context;
588 void (*cont)(const struct firmware *fw, void *context);
Kay Sievers312c0042005-11-16 09:00:00 +0100589 int uevent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590};
591
592static int
593request_firmware_work_func(void *arg)
594{
595 struct firmware_work *fw_work = arg;
596 const struct firmware *fw;
matthieu castet113fab12005-11-13 16:07:39 -0800597 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 if (!arg) {
599 WARN_ON(1);
600 return 0;
601 }
matthieu castet113fab12005-11-13 16:07:39 -0800602 ret = _request_firmware(&fw, fw_work->name, fw_work->device,
Kay Sievers312c0042005-11-16 09:00:00 +0100603 fw_work->uevent);
matthieu castet113fab12005-11-13 16:07:39 -0800604 if (ret < 0)
605 fw_work->cont(NULL, fw_work->context);
606 else {
607 fw_work->cont(fw, fw_work->context);
608 release_firmware(fw);
609 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 module_put(fw_work->module);
611 kfree(fw_work);
matthieu castet113fab12005-11-13 16:07:39 -0800612 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613}
614
615/**
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800616 * request_firmware_nowait: asynchronous version of request_firmware
617 * @module: module requesting the firmware
Kay Sievers312c0042005-11-16 09:00:00 +0100618 * @uevent: sends uevent to copy the firmware image if this flag
Randy Dunlapeb8e3172005-10-30 15:03:01 -0800619 * is non-zero else the firmware copy must be done manually.
620 * @name: name of firmware file
621 * @device: device for which firmware is being loaded
622 * @context: will be passed over to @cont, and
623 * @fw may be %NULL if firmware request fails.
624 * @cont: function will be called asynchronously when the firmware
625 * request is over.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 *
Ming Lei7fcab092009-05-29 11:33:19 +0800627 * Asynchronous variant of request_firmware() for user contexts where
628 * it is not possible to sleep for long time. It can't be called
629 * in atomic contexts.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 **/
631int
632request_firmware_nowait(
Kay Sievers312c0042005-11-16 09:00:00 +0100633 struct module *module, int uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 const char *name, struct device *device, void *context,
635 void (*cont)(const struct firmware *fw, void *context))
636{
Sukadev Bhattiprolu563d0752006-09-29 01:59:31 -0700637 struct task_struct *task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 struct firmware_work *fw_work = kmalloc(sizeof (struct firmware_work),
639 GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640
641 if (!fw_work)
642 return -ENOMEM;
643 if (!try_module_get(module)) {
644 kfree(fw_work);
645 return -EFAULT;
646 }
647
648 *fw_work = (struct firmware_work) {
649 .module = module,
650 .name = name,
651 .device = device,
652 .context = context,
653 .cont = cont,
Kay Sievers312c0042005-11-16 09:00:00 +0100654 .uevent = uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 };
656
Sukadev Bhattiprolu563d0752006-09-29 01:59:31 -0700657 task = kthread_run(request_firmware_work_func, fw_work,
658 "firmware/%s", name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659
Sukadev Bhattiprolu563d0752006-09-29 01:59:31 -0700660 if (IS_ERR(task)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 fw_work->cont(NULL, fw_work->context);
matthieu castet113fab12005-11-13 16:07:39 -0800662 module_put(fw_work->module);
663 kfree(fw_work);
Sukadev Bhattiprolu563d0752006-09-29 01:59:31 -0700664 return PTR_ERR(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 }
666 return 0;
667}
668
669static int __init
670firmware_class_init(void)
671{
672 int error;
673 error = class_register(&firmware_class);
674 if (error) {
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800675 printk(KERN_ERR "%s: class_register failed\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 return error;
677 }
678 error = class_create_file(&firmware_class, &class_attr_timeout);
679 if (error) {
680 printk(KERN_ERR "%s: class_create_file failed\n",
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800681 __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 class_unregister(&firmware_class);
683 }
684 return error;
685
686}
687static void __exit
688firmware_class_exit(void)
689{
690 class_unregister(&firmware_class);
691}
692
Shaohua Lia30a6a22006-09-27 01:50:52 -0700693fs_initcall(firmware_class_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694module_exit(firmware_class_exit);
695
696EXPORT_SYMBOL(release_firmware);
697EXPORT_SYMBOL(request_firmware);
698EXPORT_SYMBOL(request_firmware_nowait);