Skip to content
Snippets Groups Projects
firmware_class.c 20.6 KiB
Newer Older
  • Learn to ignore specific revisions
  • Linus Torvalds's avatar
    Linus Torvalds committed
    /*
     * firmware_class.c - Multi purpose firmware loading support
     *
    
     * Copyright (c) 2003 Manuel Estrada Sainz
    
    Linus Torvalds's avatar
    Linus Torvalds committed
     *
     * Please see Documentation/firmware_class/ for more information.
     *
     */
    
    
    #include <linux/capability.h>
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    #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>
    
    #include <linux/mutex.h>
    
    #include <linux/workqueue.h>
    
    #include <linux/highmem.h>
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    #include <linux/firmware.h>
    
    #include <linux/list.h>
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    MODULE_AUTHOR("Manuel Estrada Sainz");
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    MODULE_DESCRIPTION("Multi purpose firmware loading support");
    MODULE_LICENSE("GPL");
    
    
    /* 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
    enum {
    	FW_STATUS_LOADING,
    	FW_STATUS_DONE,
    	FW_STATUS_ABORT,
    };
    
    
    static int loading_timeout = 60;	/* In seconds */
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    static inline long firmware_loading_timeout(void)
    {
    	return loading_timeout > 0 ? loading_timeout * HZ : MAX_SCHEDULE_TIMEOUT;
    }
    
    
    struct firmware_cache {
    	/* firmware_buf instance will be added into the below list */
    	spinlock_t lock;
    	struct list_head head;
    };
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    struct firmware_buf {
    
    	struct kref ref;
    	struct list_head list;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	struct completion completion;
    
    	struct firmware_cache *fwc;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	unsigned long status;
    
    	void *data;
    	size_t size;
    
    	struct page **pages;
    	int nr_pages;
    	int page_array_size;
    
    	char fw_id[];
    };
    
    struct firmware_priv {
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	struct timer_list timeout;
    
    	struct device dev;
    	struct firmware_buf *buf;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    };
    
    
    #define to_fwbuf(d) container_of(d, struct firmware_buf, ref)
    
    /* fw_lock could be moved to 'struct firmware_priv' but since it is just
     * guarding for corner cases a global lock should be OK */
    static DEFINE_MUTEX(fw_lock);
    
    static struct firmware_cache fw_cache;
    
    static struct firmware_buf *__allocate_fw_buf(const char *fw_name,
    					      struct firmware_cache *fwc)
    {
    	struct firmware_buf *buf;
    
    	buf = kzalloc(sizeof(*buf) + strlen(fw_name) + 1 , GFP_ATOMIC);
    
    	if (!buf)
    		return buf;
    
    	kref_init(&buf->ref);
    	strcpy(buf->fw_id, fw_name);
    	buf->fwc = fwc;
    	init_completion(&buf->completion);
    
    	pr_debug("%s: fw-%s buf=%p\n", __func__, fw_name, buf);
    
    	return buf;
    }
    
    static int fw_lookup_and_allocate_buf(const char *fw_name,
    				      struct firmware_cache *fwc,
    				      struct firmware_buf **buf)
    {
    	struct firmware_buf *tmp;
    
    	spin_lock(&fwc->lock);
    	list_for_each_entry(tmp, &fwc->head, list)
    		if (!strcmp(tmp->fw_id, fw_name)) {
    			kref_get(&tmp->ref);
    			spin_unlock(&fwc->lock);
    			*buf = tmp;
    			return 1;
    		}
    
    	tmp = __allocate_fw_buf(fw_name, fwc);
    	if (tmp)
    		list_add(&tmp->list, &fwc->head);
    	spin_unlock(&fwc->lock);
    
    	*buf = tmp;
    
    	return tmp ? 0 : -ENOMEM;
    }
    
    static void __fw_free_buf(struct kref *ref)
    {
    	struct firmware_buf *buf = to_fwbuf(ref);
    	struct firmware_cache *fwc = buf->fwc;
    	int i;
    
    	pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
    		 __func__, buf->fw_id, buf, buf->data,
    		 (unsigned int)buf->size);
    
    	spin_lock(&fwc->lock);
    	list_del(&buf->list);
    	spin_unlock(&fwc->lock);
    
    	vunmap(buf->data);
    	for (i = 0; i < buf->nr_pages; i++)
    		__free_page(buf->pages[i]);
    	kfree(buf->pages);
    	kfree(buf);
    }
    
    static void fw_free_buf(struct firmware_buf *buf)
    {
    	kref_put(&buf->ref, __fw_free_buf);
    }
    
    static void __init fw_cache_init(void)
    {
    	spin_lock_init(&fw_cache.lock);
    	INIT_LIST_HEAD(&fw_cache.head);
    }
    
    
    static struct firmware_priv *to_firmware_priv(struct device *dev)
    {
    	return container_of(dev, struct firmware_priv, dev);
    }
    
    static void fw_load_abort(struct firmware_priv *fw_priv)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    {
    
    	struct firmware_buf *buf = fw_priv->buf;
    
    	set_bit(FW_STATUS_ABORT, &buf->status);
    
    	complete_all(&buf->completion);
    
    static ssize_t firmware_timeout_show(struct class *class,
    				     struct class_attribute *attr,
    				     char *buf)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    {
    	return sprintf(buf, "%d\n", loading_timeout);
    }
    
    /**
    
     * firmware_timeout_store - set number of seconds to wait for firmware
     * @class: device class pointer
    
     * @attr: device attribute pointer
    
     * @buf: buffer to scan for timeout value
     * @count: number of bytes in @buf
     *
    
    Linus Torvalds's avatar
    Linus Torvalds committed
     *	Sets the number of seconds to wait for the firmware.  Once
    
     *	this expires an error will be returned to the driver and no
    
    Linus Torvalds's avatar
    Linus Torvalds committed
     *	firmware will be provided.
     *
    
     *	Note: zero means 'wait forever'.
    
    Linus Torvalds's avatar
    Linus Torvalds committed
     **/
    
    static ssize_t firmware_timeout_store(struct class *class,
    				      struct class_attribute *attr,
    				      const char *buf, size_t count)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    {
    	loading_timeout = simple_strtol(buf, NULL, 10);
    
    	if (loading_timeout < 0)
    		loading_timeout = 0;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	return count;
    }
    
    
    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
    
    
    static void fw_dev_release(struct device *dev)
    {
    	struct firmware_priv *fw_priv = to_firmware_priv(dev);
    
    	kfree(fw_priv);
    
    	module_put(THIS_MODULE);
    }
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    static int firmware_uevent(struct device *dev, struct kobj_uevent_env *env)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    {
    
    	struct firmware_priv *fw_priv = to_firmware_priv(dev);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	if (add_uevent_var(env, "FIRMWARE=%s", fw_priv->buf->fw_id))
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    		return -ENOMEM;
    
    	if (add_uevent_var(env, "TIMEOUT=%i", loading_timeout))
    
    	if (add_uevent_var(env, "ASYNC=%d", fw_priv->nowait))
    		return -ENOMEM;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    	return 0;
    }
    
    
    static struct class firmware_class = {
    	.name		= "firmware",
    
    	.class_attrs	= firmware_class_attrs,
    
    	.dev_uevent	= firmware_uevent,
    	.dev_release	= fw_dev_release,
    
    static ssize_t firmware_loading_show(struct device *dev,
    				     struct device_attribute *attr, char *buf)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    {
    
    	struct firmware_priv *fw_priv = to_firmware_priv(dev);
    
    	int loading = test_bit(FW_STATUS_LOADING, &fw_priv->buf->status);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	return sprintf(buf, "%d\n", loading);
    }
    
    
    /* firmware holds the ownership of pages */
    
    static void firmware_free_data(const struct firmware *fw)
    {
    
    	WARN_ON(!fw->priv);
    	fw_free_buf(fw->priv);
    
    /* 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
    /**
    
     * firmware_loading_store - set value in the 'loading' control file
    
     * @attr: device attribute pointer
    
     * @buf: buffer to scan for loading control value
     * @count: number of bytes in @buf
     *
    
    Linus Torvalds's avatar
    Linus Torvalds committed
     *	The relevant values are:
     *
     *	 1: Start a load, discarding any previous partial load.
    
     *	 0: Conclude the load and hand the data to the driver code.
    
    Linus Torvalds's avatar
    Linus Torvalds committed
     *	-1: Conclude the load with an error and discard any written data.
     **/
    
    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
    {
    
    	struct firmware_priv *fw_priv = to_firmware_priv(dev);
    
    	struct firmware_buf *fw_buf = fw_priv->buf;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	int loading = simple_strtol(buf, NULL, 10);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	if (!fw_buf)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	switch (loading) {
    	case 1:
    
    		/* discarding any previous partial load */
    
    		if (!test_bit(FW_STATUS_DONE, &fw_buf->status)) {
    			for (i = 0; i < fw_buf->nr_pages; i++)
    				__free_page(fw_buf->pages[i]);
    			kfree(fw_buf->pages);
    			fw_buf->pages = NULL;
    			fw_buf->page_array_size = 0;
    			fw_buf->nr_pages = 0;
    			set_bit(FW_STATUS_LOADING, &fw_buf->status);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    		break;
    	case 0:
    
    		if (test_bit(FW_STATUS_LOADING, &fw_buf->status)) {
    			set_bit(FW_STATUS_DONE, &fw_buf->status);
    			clear_bit(FW_STATUS_LOADING, &fw_buf->status);
    
    			complete_all(&fw_buf->completion);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    			break;
    		}
    		/* fallthrough */
    	default:
    
    		dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    		/* fallthrough */
    	case -1:
    		fw_load_abort(fw_priv);
    		break;
    	}
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	return count;
    }
    
    
    static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    static ssize_t firmware_data_read(struct file *filp, struct kobject *kobj,
    				  struct bin_attribute *bin_attr,
    				  char *buffer, loff_t offset, size_t count)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    {
    
    	struct device *dev = kobj_to_dev(kobj);
    
    	struct firmware_priv *fw_priv = to_firmware_priv(dev);
    
    	struct firmware_buf *buf;
    
    	ssize_t ret_count;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	mutex_lock(&fw_lock);
    
    	buf = fw_priv->buf;
    	if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) {
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    		ret_count = -ENODEV;
    		goto out;
    	}
    
    	if (offset > buf->size) {
    
    		ret_count = 0;
    		goto out;
    	}
    
    	if (count > buf->size - offset)
    		count = buf->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(buf->pages[page_nr]);
    
    
    		memcpy(buffer, page_data + page_ofs, page_cnt);
    
    
    		kunmap(buf->pages[page_nr]);
    
    		buffer += page_cnt;
    		offset += page_cnt;
    		count -= page_cnt;
    	}
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    out:
    
    	mutex_unlock(&fw_lock);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	return ret_count;
    }
    
    static int fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    {
    
    	struct firmware_buf *buf = fw_priv->buf;
    
    	int pages_needed = ALIGN(min_size, PAGE_SIZE) >> PAGE_SHIFT;
    
    	/* If the array of pages is too small, grow it... */
    
    	if (buf->page_array_size < pages_needed) {
    
    		int new_array_size = max(pages_needed,
    
    					 buf->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, buf->pages,
    		       buf->page_array_size * sizeof(void *));
    		memset(&new_pages[buf->page_array_size], 0, sizeof(void *) *
    		       (new_array_size - buf->page_array_size));
    		kfree(buf->pages);
    		buf->pages = new_pages;
    		buf->page_array_size = new_array_size;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	while (buf->nr_pages < pages_needed) {
    		buf->pages[buf->nr_pages] =
    
    			alloc_page(GFP_KERNEL | __GFP_HIGHMEM);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    		if (!buf->pages[buf->nr_pages]) {
    
    			fw_load_abort(fw_priv);
    			return -ENOMEM;
    		}
    
    		buf->nr_pages++;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	}
    	return 0;
    }
    
    /**
    
     * firmware_data_write - write method for firmware
    
     * @filp: open sysfs file
    
     * @kobj: kobject for the device
    
     * @bin_attr: bin_attr structure
    
     * @buffer: buffer being written
     * @offset: buffer offset for write in total data store area
     * @count: buffer size
    
    Linus Torvalds's avatar
    Linus Torvalds committed
     *
    
     *	Data written to the 'data' attribute will be later handed to
    
    Linus Torvalds's avatar
    Linus Torvalds committed
     *	the driver as a firmware image.
     **/
    
    static ssize_t firmware_data_write(struct file *filp, struct kobject *kobj,
    				   struct bin_attribute *bin_attr,
    				   char *buffer, loff_t offset, size_t count)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    {
    
    	struct device *dev = kobj_to_dev(kobj);
    
    	struct firmware_priv *fw_priv = to_firmware_priv(dev);
    
    	struct firmware_buf *buf;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	ssize_t retval;
    
    	if (!capable(CAP_SYS_RAWIO))
    		return -EPERM;
    
    	mutex_lock(&fw_lock);
    
    	buf = fw_priv->buf;
    	if (!buf || test_bit(FW_STATUS_DONE, &buf->status)) {
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    		retval = -ENODEV;
    		goto out;
    	}
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	retval = fw_realloc_buffer(fw_priv, offset + count);
    	if (retval)
    		goto out;
    
    	retval = 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(buf->pages[page_nr]);
    
    
    		memcpy(page_data + page_ofs, buffer, page_cnt);
    
    
    		kunmap(buf->pages[page_nr]);
    
    		buffer += page_cnt;
    		offset += page_cnt;
    		count -= page_cnt;
    	}
    
    
    	buf->size = max_t(size_t, offset, buf->size);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    out:
    
    	mutex_unlock(&fw_lock);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	return retval;
    }
    
    static struct bin_attribute firmware_attr_data = {
    	.attr = { .name = "data", .mode = 0644 },
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	.size = 0,
    	.read = firmware_data_read,
    	.write = firmware_data_write,
    };
    
    
    static void firmware_class_timeout(u_long data)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    {
    	struct firmware_priv *fw_priv = (struct firmware_priv *) data;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	fw_load_abort(fw_priv);
    }
    
    
    static struct firmware_priv *
    
    fw_create_instance(struct firmware *firmware, const char *fw_name,
    
    		   struct device *device, bool uevent, bool nowait)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    {
    
    	struct firmware_priv *fw_priv;
    	struct device *f_dev;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	fw_priv = kzalloc(sizeof(*fw_priv), GFP_KERNEL);
    
    		dev_err(device, "%s: kmalloc failed\n", __func__);
    
    		fw_priv = ERR_PTR(-ENOMEM);
    		goto exit;
    	}
    
    
    	setup_timer(&fw_priv->timeout,
    		    firmware_class_timeout, (u_long) fw_priv);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	f_dev = &fw_priv->dev;
    
    	device_initialize(f_dev);
    
    	dev_set_name(f_dev, "%s", fw_name);
    
    	f_dev->parent = device;
    	f_dev->class = &firmware_class;
    
    /* one pages buffer is mapped/unmapped only once */
    static int fw_map_pages_buf(struct firmware_buf *buf)
    {
    	buf->data = vmap(buf->pages, buf->nr_pages, 0, PAGE_KERNEL_RO);
    	if (!buf->data)
    		return -ENOMEM;
    	return 0;
    }
    
    /* store the pages buffer info firmware from buf */
    static void fw_set_page_data(struct firmware_buf *buf, struct firmware *fw)
    {
    	fw->priv = buf;
    	fw->pages = buf->pages;
    	fw->size = buf->size;
    	fw->data = buf->data;
    
    	pr_debug("%s: fw-%s buf=%p data=%p size=%u\n",
    		 __func__, buf->fw_id, buf, buf->data,
    		 (unsigned int)buf->size);
    }
    
    static void _request_firmware_cleanup(const struct firmware **firmware_p)
    {
    	release_firmware(*firmware_p);
    	*firmware_p = NULL;
    }
    
    
    static struct firmware_priv *
    _request_firmware_prepare(const struct firmware **firmware_p, const char *name,
    			  struct device *device, bool uevent, bool nowait)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    {
    	struct firmware *firmware;
    
    	struct firmware_priv *fw_priv = NULL;
    	struct firmware_buf *buf;
    	int ret;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    	if (!firmware_p)
    
    		return ERR_PTR(-EINVAL);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	*firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	if (!firmware) {
    
    		dev_err(device, "%s: kmalloc(struct firmware) failed\n",
    			__func__);
    
    		return ERR_PTR(-ENOMEM);
    
    	if (fw_get_builtin_firmware(firmware, name)) {
    
    		dev_dbg(device, "firmware: using built-in firmware %s\n", name);
    
    	ret = fw_lookup_and_allocate_buf(name, &fw_cache, &buf);
    	if (!ret)
    		fw_priv = fw_create_instance(firmware, name, device,
    				uevent, nowait);
    
    	if (IS_ERR(fw_priv) || ret < 0) {
    		kfree(firmware);
    
    		*firmware_p = NULL;
    
    		return ERR_PTR(-ENOMEM);
    	} else if (fw_priv) {
    		fw_priv->buf = buf;
    
    		/*
    		 * bind with 'buf' now to avoid warning in failure path
    		 * of requesting firmware.
    		 */
    		firmware->priv = buf;
    		return fw_priv;
    
    	/* share the cached buf, which is inprogessing or completed */
     check_status:
    	mutex_lock(&fw_lock);
    	if (test_bit(FW_STATUS_ABORT, &buf->status)) {
    		fw_priv = ERR_PTR(-ENOENT);
    		_request_firmware_cleanup(firmware_p);
    		goto exit;
    	} else if (test_bit(FW_STATUS_DONE, &buf->status)) {
    		fw_priv = NULL;
    		fw_set_page_data(buf, firmware);
    		goto exit;
    	}
    	mutex_unlock(&fw_lock);
    	wait_for_completion(&buf->completion);
    	goto check_status;
    
    exit:
    	mutex_unlock(&fw_lock);
    	return fw_priv;
    
    static int _request_firmware_load(struct firmware_priv *fw_priv, bool uevent,
    				  long timeout)
    
    	struct device *f_dev = &fw_priv->dev;
    
    	struct firmware_buf *buf = fw_priv->buf;
    
    
    	dev_set_uevent_suppress(f_dev, true);
    
    	/* Need to pin this module until class device is destroyed */
    	__module_get(THIS_MODULE);
    
    	retval = device_add(f_dev);
    	if (retval) {
    		dev_err(f_dev, "%s: device_register failed\n", __func__);
    		goto err_put_dev;
    	}
    
    	retval = device_create_bin_file(f_dev, &firmware_attr_data);
    	if (retval) {
    		dev_err(f_dev, "%s: sysfs_create_bin_file failed\n", __func__);
    		goto err_del_dev;
    	}
    
    	retval = device_create_file(f_dev, &dev_attr_loading);
    	if (retval) {
    		dev_err(f_dev, "%s: device_create_file failed\n", __func__);
    		goto err_del_bin_attr;
    	}
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    		dev_set_uevent_suppress(f_dev, false);
    
    		dev_dbg(f_dev, "firmware: requesting %s\n", buf->fw_id);
    
    		if (timeout != MAX_SCHEDULE_TIMEOUT)
    
    			mod_timer(&fw_priv->timeout,
    
    				  round_jiffies_up(jiffies + timeout));
    
    
    		kobject_uevent(&fw_priv->dev.kobj, KOBJ_ADD);
    	}
    
    
    	wait_for_completion(&buf->completion);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	del_timer_sync(&fw_priv->timeout);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	mutex_lock(&fw_lock);
    
    	if (!buf->size || test_bit(FW_STATUS_ABORT, &buf->status))
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    		retval = -ENOENT;
    
    		retval = fw_map_pages_buf(buf);
    
    	/* pass the pages buffer to driver at the last minute */
    	fw_set_page_data(buf, fw_priv->fw);
    
    
    	fw_priv->buf = NULL;
    
    	mutex_unlock(&fw_lock);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	device_remove_file(f_dev, &dev_attr_loading);
    err_del_bin_attr:
    	device_remove_bin_file(f_dev, &firmware_attr_data);
    err_del_dev:
    	device_del(f_dev);
    err_put_dev:
    	put_device(f_dev);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	return retval;
    }
    
    
     * request_firmware: - send firmware request and wait for it
    
     * @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
    
     *      of @name for device @device.
     *
     *      Should be called from user context where sleeping is allowed.
     *
    
     *      @name will be used as $FIRMWARE in the uevent environment and
    
     *      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)
    {
    
    	struct firmware_priv *fw_priv;
    
    	fw_priv = _request_firmware_prepare(firmware_p, name, device, true,
    					    false);
    	if (IS_ERR_OR_NULL(fw_priv))
    		return PTR_RET(fw_priv);
    
    	ret = usermodehelper_read_trylock();
    	if (WARN_ON(ret)) {
    		dev_err(device, "firmware: %s will not be loaded\n", name);
    	} else {
    
    		ret = _request_firmware_load(fw_priv, true,
    
    					firmware_loading_timeout());
    		usermodehelper_read_unlock();
    	}
    
    	if (ret)
    		_request_firmware_cleanup(firmware_p);
    
    	return ret;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    /**
     * release_firmware: - release the resource associated with a firmware image
    
     * @fw: firmware resource to release
    
    Linus Torvalds's avatar
    Linus Torvalds committed
     **/
    
    void release_firmware(const struct firmware *fw)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    {
    	if (fw) {
    
    		if (!fw_is_builtin_firmware(fw))
    			firmware_free_data(fw);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    		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);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    };
    
    
    static void request_firmware_work_func(struct work_struct *work)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    {
    
    	struct firmware_work *fw_work;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	const struct firmware *fw;
    
    	struct firmware_priv *fw_priv;
    
    	fw_work = container_of(work, struct firmware_work, work);
    
    	fw_priv = _request_firmware_prepare(&fw, fw_work->name, fw_work->device,
    			fw_work->uevent, true);
    	if (IS_ERR_OR_NULL(fw_priv)) {
    		ret = PTR_RET(fw_priv);
    
    	timeout = usermodehelper_read_lock_wait(firmware_loading_timeout());
    	if (timeout) {
    
    		ret = _request_firmware_load(fw_priv, fw_work->uevent, timeout);
    
    		usermodehelper_read_unlock();
    	} else {
    		dev_dbg(fw_work->device, "firmware: %s loading timed out\n",
    			fw_work->name);
    		ret = -EAGAIN;
    	}
    
    	fw_work->cont(fw, fw_work->context);
    
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	module_put(fw_work->module);
    	kfree(fw_work);
    }
    
    /**
    
     * request_firmware_nowait - asynchronous version of request_firmware
    
     * @module: module requesting the firmware
    
     * @uevent: sends uevent to copy the firmware image if this flag
    
     *	is non-zero else the firmware copy must be done manually.
     * @name: name of firmware file
     * @device: device for which firmware is being loaded
    
     * @gfp: allocation flags
    
     * @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
     *
    
     *	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
     **/
    int
    request_firmware_nowait(
    
    	struct module *module, bool uevent,
    
    	const char *name, struct device *device, gfp_t gfp, void *context,
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	void (*cont)(const struct firmware *fw, void *context))
    {
    
    	struct firmware_work *fw_work;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	fw_work = kzalloc(sizeof (struct firmware_work), gfp);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	if (!fw_work)
    		return -ENOMEM;
    
    
    	fw_work->module = module;
    	fw_work->name = name;
    	fw_work->device = device;
    	fw_work->context = context;
    	fw_work->cont = cont;
    	fw_work->uevent = uevent;
    
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	if (!try_module_get(module)) {
    		kfree(fw_work);
    		return -EFAULT;
    	}
    
    
    	INIT_WORK(&fw_work->work, request_firmware_work_func);
    	schedule_work(&fw_work->work);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	return 0;
    }
    
    
    static int __init firmware_class_init(void)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    {
    
    	return class_register(&firmware_class);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    }
    
    
    static void __exit firmware_class_exit(void)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    {
    	class_unregister(&firmware_class);
    }
    
    
    fs_initcall(firmware_class_init);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    module_exit(firmware_class_exit);
    
    EXPORT_SYMBOL(release_firmware);
    EXPORT_SYMBOL(request_firmware);
    EXPORT_SYMBOL(request_firmware_nowait);