firmware_class.c 17.2 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3
/*
 * firmware_class.c - Multi purpose firmware loading support
 *
4
 * Copyright (c) 2003 Manuel Estrada Sainz
Linus Torvalds's avatar
Linus Torvalds committed
5 6 7 8 9
 *
 * Please see Documentation/firmware_class/ for more information.
 *
 */

10
#include <linux/capability.h>
Linus Torvalds's avatar
Linus Torvalds committed
11 12 13 14 15 16 17
#include <linux/device.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/timer.h>
#include <linux/vmalloc.h>
#include <linux/interrupt.h>
#include <linux/bitops.h>
18
#include <linux/mutex.h>
19
#include <linux/kthread.h>
20
#include <linux/highmem.h>
Linus Torvalds's avatar
Linus Torvalds committed
21
#include <linux/firmware.h>
22
#include <linux/slab.h>
Linus Torvalds's avatar
Linus Torvalds committed
23

24 25
#define to_dev(obj) container_of(obj, struct device, kobj)

26
MODULE_AUTHOR("Manuel Estrada Sainz");
Linus Torvalds's avatar
Linus Torvalds committed
27 28 29
MODULE_DESCRIPTION("Multi purpose firmware loading support");
MODULE_LICENSE("GPL");

30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
/* Builtin firmware support */

#ifdef CONFIG_FW_LOADER

extern struct builtin_fw __start_builtin_fw[];
extern struct builtin_fw __end_builtin_fw[];

static bool fw_get_builtin_firmware(struct firmware *fw, const char *name)
{
	struct builtin_fw *b_fw;

	for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++) {
		if (strcmp(name, b_fw->name) == 0) {
			fw->size = b_fw->size;
			fw->data = b_fw->data;
			return true;
		}
	}

	return false;
}

static bool fw_is_builtin_firmware(const struct firmware *fw)
{
	struct builtin_fw *b_fw;

	for (b_fw = __start_builtin_fw; b_fw != __end_builtin_fw; b_fw++)
		if (fw->data == b_fw->data)
			return true;

	return false;
}

#else /* Module case - no builtin firmware support */

static inline bool fw_get_builtin_firmware(struct firmware *fw, const char *name)
{
	return false;
}

static inline bool fw_is_builtin_firmware(const struct firmware *fw)
{
	return false;
}
#endif

Linus Torvalds's avatar
Linus Torvalds committed
76 77 78 79 80 81
enum {
	FW_STATUS_LOADING,
	FW_STATUS_DONE,
	FW_STATUS_ABORT,
};

82
static int loading_timeout = 60;	/* In seconds */
Linus Torvalds's avatar
Linus Torvalds committed
83 84 85

/* fw_lock could be moved to 'struct firmware_priv' but since it is just
 * guarding for corner cases a global lock should be OK */
86
static DEFINE_MUTEX(fw_lock);
Linus Torvalds's avatar
Linus Torvalds committed
87 88 89 90 91 92

struct firmware_priv {
	struct completion completion;
	struct bin_attribute attr_data;
	struct firmware *fw;
	unsigned long status;
93 94 95
	struct page **pages;
	int nr_pages;
	int page_array_size;
Linus Torvalds's avatar
Linus Torvalds committed
96
	struct timer_list timeout;
97
	bool nowait;
98
	char fw_id[];
Linus Torvalds's avatar
Linus Torvalds committed
99 100
};

101
static void
Linus Torvalds's avatar
Linus Torvalds committed
102 103 104 105 106 107 108 109
fw_load_abort(struct firmware_priv *fw_priv)
{
	set_bit(FW_STATUS_ABORT, &fw_priv->status);
	wmb();
	complete(&fw_priv->completion);
}

static ssize_t
110 111 112
firmware_timeout_show(struct class *class,
		      struct class_attribute *attr,
		      char *buf)
Linus Torvalds's avatar
Linus Torvalds committed
113 114 115 116 117
{
	return sprintf(buf, "%d\n", loading_timeout);
}

/**
118 119
 * firmware_timeout_store - set number of seconds to wait for firmware
 * @class: device class pointer
120
 * @attr: device attribute pointer
121 122 123
 * @buf: buffer to scan for timeout value
 * @count: number of bytes in @buf
 *
Linus Torvalds's avatar
Linus Torvalds committed
124
 *	Sets the number of seconds to wait for the firmware.  Once
125
 *	this expires an error will be returned to the driver and no
Linus Torvalds's avatar
Linus Torvalds committed
126 127
 *	firmware will be provided.
 *
128
 *	Note: zero means 'wait forever'.
Linus Torvalds's avatar
Linus Torvalds committed
129 130
 **/
static ssize_t
131 132 133
firmware_timeout_store(struct class *class,
			struct class_attribute *attr,
			const char *buf, size_t count)
Linus Torvalds's avatar
Linus Torvalds committed
134 135
{
	loading_timeout = simple_strtol(buf, NULL, 10);
136 137
	if (loading_timeout < 0)
		loading_timeout = 0;
Linus Torvalds's avatar
Linus Torvalds committed
138 139 140
	return count;
}

141 142 143 144 145
static struct class_attribute firmware_class_attrs[] = {
	__ATTR(timeout, S_IWUSR | S_IRUGO,
		firmware_timeout_show, firmware_timeout_store),
	__ATTR_NULL
};
Linus Torvalds's avatar
Linus Torvalds committed
146

147 148 149 150 151 152 153 154 155 156 157 158 159
static void fw_dev_release(struct device *dev)
{
	struct firmware_priv *fw_priv = dev_get_drvdata(dev);
	int i;

	for (i = 0; i < fw_priv->nr_pages; i++)
		__free_page(fw_priv->pages[i]);
	kfree(fw_priv->pages);
	kfree(fw_priv);
	kfree(dev);

	module_put(THIS_MODULE);
}
Linus Torvalds's avatar
Linus Torvalds committed
160

161
static int firmware_uevent(struct device *dev, struct kobj_uevent_env *env)
Linus Torvalds's avatar
Linus Torvalds committed
162
{
163
	struct firmware_priv *fw_priv = dev_get_drvdata(dev);
Linus Torvalds's avatar
Linus Torvalds committed
164

165
	if (add_uevent_var(env, "FIRMWARE=%s", fw_priv->fw_id))
Linus Torvalds's avatar
Linus Torvalds committed
166
		return -ENOMEM;
167
	if (add_uevent_var(env, "TIMEOUT=%i", loading_timeout))
168
		return -ENOMEM;
169 170
	if (add_uevent_var(env, "ASYNC=%d", fw_priv->nowait))
		return -ENOMEM;
Linus Torvalds's avatar
Linus Torvalds committed
171 172 173 174

	return 0;
}

175 176
static struct class firmware_class = {
	.name		= "firmware",
177
	.class_attrs	= firmware_class_attrs,
178 179
	.dev_uevent	= firmware_uevent,
	.dev_release	= fw_dev_release,
180 181
};

182 183
static ssize_t firmware_loading_show(struct device *dev,
				     struct device_attribute *attr, char *buf)
Linus Torvalds's avatar
Linus Torvalds committed
184
{
185
	struct firmware_priv *fw_priv = dev_get_drvdata(dev);
Linus Torvalds's avatar
Linus Torvalds committed
186 187 188 189
	int loading = test_bit(FW_STATUS_LOADING, &fw_priv->status);
	return sprintf(buf, "%d\n", loading);
}

190 191 192 193 194 195 196 197 198 199 200
static void firmware_free_data(const struct firmware *fw)
{
	int i;
	vunmap(fw->data);
	if (fw->pages) {
		for (i = 0; i < PFN_UP(fw->size); i++)
			__free_page(fw->pages[i]);
		kfree(fw->pages);
	}
}

201 202 203 204
/* Some architectures don't have PAGE_KERNEL_RO */
#ifndef PAGE_KERNEL_RO
#define PAGE_KERNEL_RO PAGE_KERNEL
#endif
Linus Torvalds's avatar
Linus Torvalds committed
205
/**
206
 * firmware_loading_store - set value in the 'loading' control file
207
 * @dev: device pointer
208
 * @attr: device attribute pointer
209 210 211
 * @buf: buffer to scan for loading control value
 * @count: number of bytes in @buf
 *
Linus Torvalds's avatar
Linus Torvalds committed
212 213 214
 *	The relevant values are:
 *
 *	 1: Start a load, discarding any previous partial load.
215
 *	 0: Conclude the load and hand the data to the driver code.
Linus Torvalds's avatar
Linus Torvalds committed
216 217
 *	-1: Conclude the load with an error and discard any written data.
 **/
218 219 220
static ssize_t firmware_loading_store(struct device *dev,
				      struct device_attribute *attr,
				      const char *buf, size_t count)
Linus Torvalds's avatar
Linus Torvalds committed
221
{
222
	struct firmware_priv *fw_priv = dev_get_drvdata(dev);
Linus Torvalds's avatar
Linus Torvalds committed
223
	int loading = simple_strtol(buf, NULL, 10);
224
	int i;
Linus Torvalds's avatar
Linus Torvalds committed
225 226 227

	switch (loading) {
	case 1:
228
		mutex_lock(&fw_lock);
229
		if (!fw_priv->fw) {
230
			mutex_unlock(&fw_lock);
231 232
			break;
		}
233 234 235
		firmware_free_data(fw_priv->fw);
		memset(fw_priv->fw, 0, sizeof(struct firmware));
		/* If the pages are not owned by 'struct firmware' */
236 237 238 239 240 241
		for (i = 0; i < fw_priv->nr_pages; i++)
			__free_page(fw_priv->pages[i]);
		kfree(fw_priv->pages);
		fw_priv->pages = NULL;
		fw_priv->page_array_size = 0;
		fw_priv->nr_pages = 0;
Linus Torvalds's avatar
Linus Torvalds committed
242
		set_bit(FW_STATUS_LOADING, &fw_priv->status);
243
		mutex_unlock(&fw_lock);
Linus Torvalds's avatar
Linus Torvalds committed
244 245 246
		break;
	case 0:
		if (test_bit(FW_STATUS_LOADING, &fw_priv->status)) {
247
			vunmap(fw_priv->fw->data);
248 249 250 251 252 253 254
			fw_priv->fw->data = vmap(fw_priv->pages,
						 fw_priv->nr_pages,
						 0, PAGE_KERNEL_RO);
			if (!fw_priv->fw->data) {
				dev_err(dev, "%s: vmap() failed\n", __func__);
				goto err;
			}
255 256 257 258
			/* Pages are now owned by 'struct firmware' */
			fw_priv->fw->pages = fw_priv->pages;
			fw_priv->pages = NULL;

259 260
			fw_priv->page_array_size = 0;
			fw_priv->nr_pages = 0;
Linus Torvalds's avatar
Linus Torvalds committed
261 262 263 264 265 266
			complete(&fw_priv->completion);
			clear_bit(FW_STATUS_LOADING, &fw_priv->status);
			break;
		}
		/* fallthrough */
	default:
267
		dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading);
Linus Torvalds's avatar
Linus Torvalds committed
268 269
		/* fallthrough */
	case -1:
270
	err:
Linus Torvalds's avatar
Linus Torvalds committed
271 272 273 274 275 276 277
		fw_load_abort(fw_priv);
		break;
	}

	return count;
}

278
static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store);
Linus Torvalds's avatar
Linus Torvalds committed
279 280

static ssize_t
281
firmware_data_read(struct kobject *kobj, struct bin_attribute *bin_attr,
Linus Torvalds's avatar
Linus Torvalds committed
282 283
		   char *buffer, loff_t offset, size_t count)
{
284 285
	struct device *dev = to_dev(kobj);
	struct firmware_priv *fw_priv = dev_get_drvdata(dev);
Linus Torvalds's avatar
Linus Torvalds committed
286
	struct firmware *fw;
287
	ssize_t ret_count;
Linus Torvalds's avatar
Linus Torvalds committed
288

289
	mutex_lock(&fw_lock);
Linus Torvalds's avatar
Linus Torvalds committed
290
	fw = fw_priv->fw;
291
	if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
Linus Torvalds's avatar
Linus Torvalds committed
292 293 294
		ret_count = -ENODEV;
		goto out;
	}
295 296 297 298
	if (offset > fw->size) {
		ret_count = 0;
		goto out;
	}
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
	if (count > fw->size - offset)
		count = fw->size - offset;

	ret_count = count;

	while (count) {
		void *page_data;
		int page_nr = offset >> PAGE_SHIFT;
		int page_ofs = offset & (PAGE_SIZE-1);
		int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);

		page_data = kmap(fw_priv->pages[page_nr]);

		memcpy(buffer, page_data + page_ofs, page_cnt);

		kunmap(fw_priv->pages[page_nr]);
		buffer += page_cnt;
		offset += page_cnt;
		count -= page_cnt;
	}
Linus Torvalds's avatar
Linus Torvalds committed
319
out:
320
	mutex_unlock(&fw_lock);
Linus Torvalds's avatar
Linus Torvalds committed
321 322
	return ret_count;
}
323

Linus Torvalds's avatar
Linus Torvalds committed
324 325 326
static int
fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
{
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
	int pages_needed = ALIGN(min_size, PAGE_SIZE) >> PAGE_SHIFT;

	/* If the array of pages is too small, grow it... */
	if (fw_priv->page_array_size < pages_needed) {
		int new_array_size = max(pages_needed,
					 fw_priv->page_array_size * 2);
		struct page **new_pages;

		new_pages = kmalloc(new_array_size * sizeof(void *),
				    GFP_KERNEL);
		if (!new_pages) {
			fw_load_abort(fw_priv);
			return -ENOMEM;
		}
		memcpy(new_pages, fw_priv->pages,
		       fw_priv->page_array_size * sizeof(void *));
		memset(&new_pages[fw_priv->page_array_size], 0, sizeof(void *) *
		       (new_array_size - fw_priv->page_array_size));
		kfree(fw_priv->pages);
		fw_priv->pages = new_pages;
		fw_priv->page_array_size = new_array_size;
	}
Linus Torvalds's avatar
Linus Torvalds committed
349

350 351 352
	while (fw_priv->nr_pages < pages_needed) {
		fw_priv->pages[fw_priv->nr_pages] =
			alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
Linus Torvalds's avatar
Linus Torvalds committed
353

354 355 356 357 358
		if (!fw_priv->pages[fw_priv->nr_pages]) {
			fw_load_abort(fw_priv);
			return -ENOMEM;
		}
		fw_priv->nr_pages++;
Linus Torvalds's avatar
Linus Torvalds committed
359 360 361 362 363
	}
	return 0;
}

/**
364
 * firmware_data_write - write method for firmware
365
 * @kobj: kobject for the device
366
 * @bin_attr: bin_attr structure
367 368 369
 * @buffer: buffer being written
 * @offset: buffer offset for write in total data store area
 * @count: buffer size
Linus Torvalds's avatar
Linus Torvalds committed
370
 *
371
 *	Data written to the 'data' attribute will be later handed to
Linus Torvalds's avatar
Linus Torvalds committed
372 373 374
 *	the driver as a firmware image.
 **/
static ssize_t
375
firmware_data_write(struct kobject *kobj, struct bin_attribute *bin_attr,
Linus Torvalds's avatar
Linus Torvalds committed
376 377
		    char *buffer, loff_t offset, size_t count)
{
378 379
	struct device *dev = to_dev(kobj);
	struct firmware_priv *fw_priv = dev_get_drvdata(dev);
Linus Torvalds's avatar
Linus Torvalds committed
380 381 382 383 384
	struct firmware *fw;
	ssize_t retval;

	if (!capable(CAP_SYS_RAWIO))
		return -EPERM;
385

386
	mutex_lock(&fw_lock);
Linus Torvalds's avatar
Linus Torvalds committed
387
	fw = fw_priv->fw;
388
	if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
Linus Torvalds's avatar
Linus Torvalds committed
389 390 391 392 393 394 395 396
		retval = -ENODEV;
		goto out;
	}
	retval = fw_realloc_buffer(fw_priv, offset + count);
	if (retval)
		goto out;

	retval = count;
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414

	while (count) {
		void *page_data;
		int page_nr = offset >> PAGE_SHIFT;
		int page_ofs = offset & (PAGE_SIZE - 1);
		int page_cnt = min_t(size_t, PAGE_SIZE - page_ofs, count);

		page_data = kmap(fw_priv->pages[page_nr]);

		memcpy(page_data + page_ofs, buffer, page_cnt);

		kunmap(fw_priv->pages[page_nr]);
		buffer += page_cnt;
		offset += page_cnt;
		count -= page_cnt;
	}

	fw->size = max_t(size_t, offset, fw->size);
Linus Torvalds's avatar
Linus Torvalds committed
415
out:
416
	mutex_unlock(&fw_lock);
Linus Torvalds's avatar
Linus Torvalds committed
417 418
	return retval;
}
419

Linus Torvalds's avatar
Linus Torvalds committed
420
static struct bin_attribute firmware_attr_data_tmpl = {
421
	.attr = {.name = "data", .mode = 0644},
Linus Torvalds's avatar
Linus Torvalds committed
422 423 424 425 426 427 428 429 430 431 432 433
	.size = 0,
	.read = firmware_data_read,
	.write = firmware_data_write,
};

static void
firmware_class_timeout(u_long data)
{
	struct firmware_priv *fw_priv = (struct firmware_priv *) data;
	fw_load_abort(fw_priv);
}

434 435
static int fw_register_device(struct device **dev_p, const char *fw_name,
			      struct device *device)
Linus Torvalds's avatar
Linus Torvalds committed
436 437
{
	int retval;
438 439
	struct firmware_priv *fw_priv =
		kzalloc(sizeof(*fw_priv) + strlen(fw_name) + 1 , GFP_KERNEL);
440
	struct device *f_dev = kzalloc(sizeof(*f_dev), GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
441

442
	*dev_p = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
443

444
	if (!fw_priv || !f_dev) {
445
		dev_err(device, "%s: kmalloc failed\n", __func__);
Linus Torvalds's avatar
Linus Torvalds committed
446 447 448 449
		retval = -ENOMEM;
		goto error_kfree;
	}

450
	strcpy(fw_priv->fw_id, fw_name);
Linus Torvalds's avatar
Linus Torvalds committed
451 452 453 454 455 456
	init_completion(&fw_priv->completion);
	fw_priv->attr_data = firmware_attr_data_tmpl;
	fw_priv->timeout.function = firmware_class_timeout;
	fw_priv->timeout.data = (u_long) fw_priv;
	init_timer(&fw_priv->timeout);

457
	dev_set_name(f_dev, "%s", dev_name(device));
458 459 460
	f_dev->parent = device;
	f_dev->class = &firmware_class;
	dev_set_drvdata(f_dev, fw_priv);
461
	dev_set_uevent_suppress(f_dev, 1);
462
	retval = device_register(f_dev);
Linus Torvalds's avatar
Linus Torvalds committed
463
	if (retval) {
464
		dev_err(device, "%s: device_register failed\n", __func__);
465
		put_device(f_dev);
466
		return retval;
Linus Torvalds's avatar
Linus Torvalds committed
467
	}
468
	*dev_p = f_dev;
Linus Torvalds's avatar
Linus Torvalds committed
469 470 471
	return 0;

error_kfree:
472
	kfree(f_dev);
473
	kfree(fw_priv);
Linus Torvalds's avatar
Linus Torvalds committed
474 475 476
	return retval;
}

477 478
static int fw_setup_device(struct firmware *fw, struct device **dev_p,
			   const char *fw_name, struct device *device,
479
			   int uevent, bool nowait)
Linus Torvalds's avatar
Linus Torvalds committed
480
{
481
	struct device *f_dev;
Linus Torvalds's avatar
Linus Torvalds committed
482 483 484
	struct firmware_priv *fw_priv;
	int retval;

485 486
	*dev_p = NULL;
	retval = fw_register_device(&f_dev, fw_name, device);
Linus Torvalds's avatar
Linus Torvalds committed
487 488 489 490 491 492
	if (retval)
		goto out;

	/* Need to pin this module until class device is destroyed */
	__module_get(THIS_MODULE);

493
	fw_priv = dev_get_drvdata(f_dev);
Linus Torvalds's avatar
Linus Torvalds committed
494

495 496
	fw_priv->nowait = nowait;

Linus Torvalds's avatar
Linus Torvalds committed
497
	fw_priv->fw = fw;
498
	sysfs_bin_attr_init(&fw_priv->attr_data);
499
	retval = sysfs_create_bin_file(&f_dev->kobj, &fw_priv->attr_data);
Linus Torvalds's avatar
Linus Torvalds committed
500
	if (retval) {
501
		dev_err(device, "%s: sysfs_create_bin_file failed\n", __func__);
Linus Torvalds's avatar
Linus Torvalds committed
502 503 504
		goto error_unreg;
	}

505
	retval = device_create_file(f_dev, &dev_attr_loading);
Linus Torvalds's avatar
Linus Torvalds committed
506
	if (retval) {
507
		dev_err(device, "%s: device_create_file failed\n", __func__);
Linus Torvalds's avatar
Linus Torvalds committed
508 509 510
		goto error_unreg;
	}

511
	if (uevent)
512
		dev_set_uevent_suppress(f_dev, 0);
513
	*dev_p = f_dev;
Linus Torvalds's avatar
Linus Torvalds committed
514 515 516
	goto out;

error_unreg:
517
	device_unregister(f_dev);
Linus Torvalds's avatar
Linus Torvalds committed
518 519 520 521
out:
	return retval;
}

522 523
static int
_request_firmware(const struct firmware **firmware_p, const char *name,
524
		 struct device *device, int uevent, bool nowait)
Linus Torvalds's avatar
Linus Torvalds committed
525
{
526
	struct device *f_dev;
Linus Torvalds's avatar
Linus Torvalds committed
527 528 529 530 531 532 533
	struct firmware_priv *fw_priv;
	struct firmware *firmware;
	int retval;

	if (!firmware_p)
		return -EINVAL;

534
	*firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
535
	if (!firmware) {
536 537
		dev_err(device, "%s: kmalloc(struct firmware) failed\n",
			__func__);
Linus Torvalds's avatar
Linus Torvalds committed
538 539 540 541
		retval = -ENOMEM;
		goto out;
	}

542
	if (fw_get_builtin_firmware(firmware, name)) {
543
		dev_dbg(device, "firmware: using built-in firmware %s\n", name);
544 545 546 547
		return 0;
	}

	if (uevent)
548
		dev_dbg(device, "firmware: requesting %s\n", name);
549

550 551
	retval = fw_setup_device(firmware, &f_dev, name, device,
				 uevent, nowait);
Linus Torvalds's avatar
Linus Torvalds committed
552 553 554
	if (retval)
		goto error_kfree_fw;

555
	fw_priv = dev_get_drvdata(f_dev);
Linus Torvalds's avatar
Linus Torvalds committed
556

557
	if (uevent) {
558 559 560 561
		if (loading_timeout > 0) {
			fw_priv->timeout.expires = jiffies + loading_timeout * HZ;
			add_timer(&fw_priv->timeout);
		}
Linus Torvalds's avatar
Linus Torvalds committed
562

563
		kobject_uevent(&f_dev->kobj, KOBJ_ADD);
564 565 566 567 568
		wait_for_completion(&fw_priv->completion);
		set_bit(FW_STATUS_DONE, &fw_priv->status);
		del_timer_sync(&fw_priv->timeout);
	} else
		wait_for_completion(&fw_priv->completion);
Linus Torvalds's avatar
Linus Torvalds committed
569

570
	mutex_lock(&fw_lock);
Linus Torvalds's avatar
Linus Torvalds committed
571 572 573 574 575 576
	if (!fw_priv->fw->size || test_bit(FW_STATUS_ABORT, &fw_priv->status)) {
		retval = -ENOENT;
		release_firmware(fw_priv->fw);
		*firmware_p = NULL;
	}
	fw_priv->fw = NULL;
577
	mutex_unlock(&fw_lock);
578
	device_unregister(f_dev);
Linus Torvalds's avatar
Linus Torvalds committed
579 580 581 582 583 584 585 586 587
	goto out;

error_kfree_fw:
	kfree(firmware);
	*firmware_p = NULL;
out:
	return retval;
}

588
/**
589
 * request_firmware: - send firmware request and wait for it
590 591 592 593 594
 * @firmware_p: pointer to firmware image
 * @name: name of firmware file
 * @device: device for which firmware is being loaded
 *
 *      @firmware_p will be used to return a firmware image by the name
595 596 597 598
 *      of @name for device @device.
 *
 *      Should be called from user context where sleeping is allowed.
 *
599
 *      @name will be used as $FIRMWARE in the uevent environment and
600 601 602 603 604 605 606
 *      should be distinctive enough not to be confused with any other
 *      firmware image for this or any other device.
 **/
int
request_firmware(const struct firmware **firmware_p, const char *name,
                 struct device *device)
{
607
        int uevent = 1;
608
        return _request_firmware(firmware_p, name, device, uevent, false);
609 610
}

Linus Torvalds's avatar
Linus Torvalds committed
611 612
/**
 * release_firmware: - release the resource associated with a firmware image
613
 * @fw: firmware resource to release
Linus Torvalds's avatar
Linus Torvalds committed
614
 **/
615
void release_firmware(const struct firmware *fw)
Linus Torvalds's avatar
Linus Torvalds committed
616 617
{
	if (fw) {
618 619
		if (!fw_is_builtin_firmware(fw))
			firmware_free_data(fw);
Linus Torvalds's avatar
Linus Torvalds committed
620 621 622 623 624 625 626 627 628 629 630 631
		kfree(fw);
	}
}

/* Async support */
struct firmware_work {
	struct work_struct work;
	struct module *module;
	const char *name;
	struct device *device;
	void *context;
	void (*cont)(const struct firmware *fw, void *context);
632
	int uevent;
Linus Torvalds's avatar
Linus Torvalds committed
633 634 635 636 637 638 639
};

static int
request_firmware_work_func(void *arg)
{
	struct firmware_work *fw_work = arg;
	const struct firmware *fw;
640
	int ret;
Linus Torvalds's avatar
Linus Torvalds committed
641 642 643 644
	if (!arg) {
		WARN_ON(1);
		return 0;
	}
645
	ret = _request_firmware(&fw, fw_work->name, fw_work->device,
646
		fw_work->uevent, true);
647 648 649

	fw_work->cont(fw, fw_work->context);

Linus Torvalds's avatar
Linus Torvalds committed
650 651
	module_put(fw_work->module);
	kfree(fw_work);
652
	return ret;
Linus Torvalds's avatar
Linus Torvalds committed
653 654 655
}

/**
656
 * request_firmware_nowait - asynchronous version of request_firmware
657
 * @module: module requesting the firmware
658
 * @uevent: sends uevent to copy the firmware image if this flag
659 660 661
 *	is non-zero else the firmware copy must be done manually.
 * @name: name of firmware file
 * @device: device for which firmware is being loaded
662
 * @gfp: allocation flags
663 664 665 666
 * @context: will be passed over to @cont, and
 *	@fw may be %NULL if firmware request fails.
 * @cont: function will be called asynchronously when the firmware
 *	request is over.
Linus Torvalds's avatar
Linus Torvalds committed
667
 *
668 669 670
 *	Asynchronous variant of request_firmware() for user contexts where
 *	it is not possible to sleep for long time. It can't be called
 *	in atomic contexts.
Linus Torvalds's avatar
Linus Torvalds committed
671 672 673
 **/
int
request_firmware_nowait(
674
	struct module *module, int uevent,
675
	const char *name, struct device *device, gfp_t gfp, void *context,
Linus Torvalds's avatar
Linus Torvalds committed
676 677
	void (*cont)(const struct firmware *fw, void *context))
{
678
	struct task_struct *task;
Linus Torvalds's avatar
Linus Torvalds committed
679
	struct firmware_work *fw_work = kmalloc(sizeof (struct firmware_work),
680
						gfp);
Linus Torvalds's avatar
Linus Torvalds committed
681 682 683 684 685 686 687 688 689 690 691 692 693 694

	if (!fw_work)
		return -ENOMEM;
	if (!try_module_get(module)) {
		kfree(fw_work);
		return -EFAULT;
	}

	*fw_work = (struct firmware_work) {
		.module = module,
		.name = name,
		.device = device,
		.context = context,
		.cont = cont,
695
		.uevent = uevent,
Linus Torvalds's avatar
Linus Torvalds committed
696 697
	};

698 699
	task = kthread_run(request_firmware_work_func, fw_work,
			    "firmware/%s", name);
Linus Torvalds's avatar
Linus Torvalds committed
700

701
	if (IS_ERR(task)) {
Linus Torvalds's avatar
Linus Torvalds committed
702
		fw_work->cont(NULL, fw_work->context);
703 704
		module_put(fw_work->module);
		kfree(fw_work);
705
		return PTR_ERR(task);
Linus Torvalds's avatar
Linus Torvalds committed
706 707 708 709
	}
	return 0;
}

710
static int __init firmware_class_init(void)
Linus Torvalds's avatar
Linus Torvalds committed
711
{
712
	return class_register(&firmware_class);
Linus Torvalds's avatar
Linus Torvalds committed
713
}
714 715

static void __exit firmware_class_exit(void)
Linus Torvalds's avatar
Linus Torvalds committed
716 717 718 719
{
	class_unregister(&firmware_class);
}

720
fs_initcall(firmware_class_init);
Linus Torvalds's avatar
Linus Torvalds committed
721 722 723 724 725
module_exit(firmware_class_exit);

EXPORT_SYMBOL(release_firmware);
EXPORT_SYMBOL(request_firmware);
EXPORT_SYMBOL(request_firmware_nowait);