driver-core: do not register a driver with bus_type not registered
[safe/jmp/linux-2.6] / drivers / base / firmware_class.c
index 3d384e3..44699d9 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * firmware_class.c - Multi purpose firmware loading support
  *
- * Copyright (c) 2003 Manuel Estrada Sainz <ranty@debian.org>
+ * Copyright (c) 2003 Manuel Estrada Sainz
  *
  * Please see Documentation/firmware_class/ for more information.
  *
 #include <linux/vmalloc.h>
 #include <linux/interrupt.h>
 #include <linux/bitops.h>
-#include <asm/semaphore.h>
+#include <linux/mutex.h>
+#include <linux/kthread.h>
 
 #include <linux/firmware.h>
 #include "base.h"
 
-MODULE_AUTHOR("Manuel Estrada Sainz <ranty@debian.org>");
+#define to_dev(obj) container_of(obj, struct device, kobj)
+
+MODULE_AUTHOR("Manuel Estrada Sainz");
 MODULE_DESCRIPTION("Multi purpose firmware loading support");
 MODULE_LICENSE("GPL");
 
@@ -28,15 +31,13 @@ enum {
        FW_STATUS_LOADING,
        FW_STATUS_DONE,
        FW_STATUS_ABORT,
-       FW_STATUS_READY,
-       FW_STATUS_READY_NOHOTPLUG,
 };
 
-static int loading_timeout = 10;       /* In seconds */
+static int loading_timeout = 60;       /* In seconds */
 
 /* 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 DECLARE_MUTEX(fw_lock);
+static DEFINE_MUTEX(fw_lock);
 
 struct firmware_priv {
        char fw_id[FIRMWARE_NAME_MAX];
@@ -48,7 +49,15 @@ struct firmware_priv {
        struct timer_list timeout;
 };
 
-static inline void
+#ifdef CONFIG_FW_LOADER
+extern struct builtin_fw __start_builtin_fw[];
+extern struct builtin_fw __end_builtin_fw[];
+#else /* Module case. Avoid ifdefs later; it'll all optimise out */
+static struct builtin_fw *__start_builtin_fw;
+static struct builtin_fw *__end_builtin_fw;
+#endif
+
+static void
 fw_load_abort(struct firmware_priv *fw_priv)
 {
        set_bit(FW_STATUS_ABORT, &fw_priv->status);
@@ -85,48 +94,38 @@ firmware_timeout_store(struct class *class, const char *buf, size_t count)
 
 static CLASS_ATTR(timeout, 0644, firmware_timeout_show, firmware_timeout_store);
 
-static void  fw_class_dev_release(struct class_device *class_dev);
-int firmware_class_uevent(struct class_device *dev, char **envp,
-                          int num_envp, char *buffer, int buffer_size);
-
-static struct class firmware_class = {
-       .name           = "firmware",
-       .uevent = firmware_class_uevent,
-       .release        = fw_class_dev_release,
-};
+static void fw_dev_release(struct device *dev);
 
-int
-firmware_class_uevent(struct class_device *class_dev, char **envp,
-                      int num_envp, char *buffer, int buffer_size)
+static int firmware_uevent(struct device *dev, struct kobj_uevent_env *env)
 {
-       struct firmware_priv *fw_priv = class_get_devdata(class_dev);
-       int i = 0, len = 0;
+       struct firmware_priv *fw_priv = dev_get_drvdata(dev);
 
-       if (!test_bit(FW_STATUS_READY, &fw_priv->status))
-               return -ENODEV;
-
-       if (add_uevent_var(envp, num_envp, &i, buffer, buffer_size, &len,
-                          "FIRMWARE=%s", fw_priv->fw_id))
+       if (add_uevent_var(env, "FIRMWARE=%s", fw_priv->fw_id))
                return -ENOMEM;
-       if (add_uevent_var(envp, num_envp, &i, buffer, buffer_size, &len,
-                          "TIMEOUT=%i", loading_timeout))
+       if (add_uevent_var(env, "TIMEOUT=%i", loading_timeout))
                return -ENOMEM;
-       envp[i] = NULL;
 
        return 0;
 }
 
-static ssize_t
-firmware_loading_show(struct class_device *class_dev, char *buf)
+static struct class firmware_class = {
+       .name           = "firmware",
+       .dev_uevent     = firmware_uevent,
+       .dev_release    = fw_dev_release,
+};
+
+static ssize_t firmware_loading_show(struct device *dev,
+                                    struct device_attribute *attr, char *buf)
 {
-       struct firmware_priv *fw_priv = class_get_devdata(class_dev);
+       struct firmware_priv *fw_priv = dev_get_drvdata(dev);
        int loading = test_bit(FW_STATUS_LOADING, &fw_priv->status);
        return sprintf(buf, "%d\n", loading);
 }
 
 /**
  * firmware_loading_store - set value in the 'loading' control file
- * @class_dev: class_device pointer
+ * @dev: device pointer
+ * @attr: device attribute pointer
  * @buf: buffer to scan for loading control value
  * @count: number of bytes in @buf
  *
@@ -136,18 +135,18 @@ firmware_loading_show(struct class_device *class_dev, char *buf)
  *      0: Conclude the load and hand the data to the driver code.
  *     -1: Conclude the load with an error and discard any written data.
  **/
-static ssize_t
-firmware_loading_store(struct class_device *class_dev,
-                      const char *buf, size_t count)
+static ssize_t firmware_loading_store(struct device *dev,
+                                     struct device_attribute *attr,
+                                     const char *buf, size_t count)
 {
-       struct firmware_priv *fw_priv = class_get_devdata(class_dev);
+       struct firmware_priv *fw_priv = dev_get_drvdata(dev);
        int loading = simple_strtol(buf, NULL, 10);
 
        switch (loading) {
        case 1:
-               down(&fw_lock);
+               mutex_lock(&fw_lock);
                if (!fw_priv->fw) {
-                       up(&fw_lock);
+                       mutex_unlock(&fw_lock);
                        break;
                }
                vfree(fw_priv->fw->data);
@@ -155,7 +154,7 @@ firmware_loading_store(struct class_device *class_dev,
                fw_priv->fw->size = 0;
                fw_priv->alloc_size = 0;
                set_bit(FW_STATUS_LOADING, &fw_priv->status);
-               up(&fw_lock);
+               mutex_unlock(&fw_lock);
                break;
        case 0:
                if (test_bit(FW_STATUS_LOADING, &fw_priv->status)) {
@@ -165,8 +164,7 @@ firmware_loading_store(struct class_device *class_dev,
                }
                /* fallthrough */
        default:
-               printk(KERN_ERR "%s: unexpected value (%d)\n", __FUNCTION__,
-                      loading);
+               dev_err(dev, "%s: unexpected value (%d)\n", __func__, loading);
                /* fallthrough */
        case -1:
                fw_load_abort(fw_priv);
@@ -176,34 +174,27 @@ firmware_loading_store(struct class_device *class_dev,
        return count;
 }
 
-static CLASS_DEVICE_ATTR(loading, 0644,
-                       firmware_loading_show, firmware_loading_store);
+static DEVICE_ATTR(loading, 0644, firmware_loading_show, firmware_loading_store);
 
 static ssize_t
-firmware_data_read(struct kobject *kobj,
+firmware_data_read(struct kobject *kobj, struct bin_attribute *bin_attr,
                   char *buffer, loff_t offset, size_t count)
 {
-       struct class_device *class_dev = to_class_dev(kobj);
-       struct firmware_priv *fw_priv = class_get_devdata(class_dev);
+       struct device *dev = to_dev(kobj);
+       struct firmware_priv *fw_priv = dev_get_drvdata(dev);
        struct firmware *fw;
-       ssize_t ret_count = count;
+       ssize_t ret_count;
 
-       down(&fw_lock);
+       mutex_lock(&fw_lock);
        fw = fw_priv->fw;
        if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
                ret_count = -ENODEV;
                goto out;
        }
-       if (offset > fw->size) {
-               ret_count = 0;
-               goto out;
-       }
-       if (offset + ret_count > fw->size)
-               ret_count = fw->size - offset;
-
-       memcpy(buffer, fw->data + offset, ret_count);
+       ret_count = memory_read_from_buffer(buffer, count, &offset,
+                                               fw->data, fw->size);
 out:
-       up(&fw_lock);
+       mutex_unlock(&fw_lock);
        return ret_count;
 }
 
@@ -211,18 +202,20 @@ static int
 fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
 {
        u8 *new_data;
+       int new_size = fw_priv->alloc_size;
 
        if (min_size <= fw_priv->alloc_size)
                return 0;
 
-       new_data = vmalloc(fw_priv->alloc_size + PAGE_SIZE);
+       new_size = ALIGN(min_size, PAGE_SIZE);
+       new_data = vmalloc(new_size);
        if (!new_data) {
-               printk(KERN_ERR "%s: unable to alloc buffer\n", __FUNCTION__);
+               printk(KERN_ERR "%s: unable to alloc buffer\n", __func__);
                /* Make sure that we don't keep incomplete data */
                fw_load_abort(fw_priv);
                return -ENOMEM;
        }
-       fw_priv->alloc_size += PAGE_SIZE;
+       fw_priv->alloc_size = new_size;
        if (fw_priv->fw->data) {
                memcpy(new_data, fw_priv->fw->data, fw_priv->fw->size);
                vfree(fw_priv->fw->data);
@@ -234,7 +227,8 @@ fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
 
 /**
  * firmware_data_write - write method for firmware
- * @kobj: kobject for the class_device
+ * @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
@@ -243,18 +237,18 @@ fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
  *     the driver as a firmware image.
  **/
 static ssize_t
-firmware_data_write(struct kobject *kobj,
+firmware_data_write(struct kobject *kobj, struct bin_attribute *bin_attr,
                    char *buffer, loff_t offset, size_t count)
 {
-       struct class_device *class_dev = to_class_dev(kobj);
-       struct firmware_priv *fw_priv = class_get_devdata(class_dev);
+       struct device *dev = to_dev(kobj);
+       struct firmware_priv *fw_priv = dev_get_drvdata(dev);
        struct firmware *fw;
        ssize_t retval;
 
        if (!capable(CAP_SYS_RAWIO))
                return -EPERM;
 
-       down(&fw_lock);
+       mutex_lock(&fw_lock);
        fw = fw_priv->fw;
        if (!fw || test_bit(FW_STATUS_DONE, &fw_priv->status)) {
                retval = -ENODEV;
@@ -264,29 +258,28 @@ firmware_data_write(struct kobject *kobj,
        if (retval)
                goto out;
 
-       memcpy(fw->data + offset, buffer, count);
+       memcpy((u8 *)fw->data + offset, buffer, count);
 
        fw->size = max_t(size_t, offset + count, fw->size);
        retval = count;
 out:
-       up(&fw_lock);
+       mutex_unlock(&fw_lock);
        return retval;
 }
 
 static struct bin_attribute firmware_attr_data_tmpl = {
-       .attr = {.name = "data", .mode = 0644, .owner = THIS_MODULE},
+       .attr = {.name = "data", .mode = 0644},
        .size = 0,
        .read = firmware_data_read,
        .write = firmware_data_write,
 };
 
-static void
-fw_class_dev_release(struct class_device *class_dev)
+static void fw_dev_release(struct device *dev)
 {
-       struct firmware_priv *fw_priv = class_get_devdata(class_dev);
+       struct firmware_priv *fw_priv = dev_get_drvdata(dev);
 
        kfree(fw_priv);
-       kfree(class_dev);
+       kfree(dev);
 
        module_put(THIS_MODULE);
 }
@@ -298,27 +291,18 @@ firmware_class_timeout(u_long data)
        fw_load_abort(fw_priv);
 }
 
-static inline void
-fw_setup_class_device_id(struct class_device *class_dev, struct device *dev)
-{
-       /* XXX warning we should watch out for name collisions */
-       strlcpy(class_dev->class_id, dev->bus_id, BUS_ID_SIZE);
-}
-
-static int
-fw_register_class_device(struct class_device **class_dev_p,
-                        const char *fw_name, struct device *device)
+static int fw_register_device(struct device **dev_p, const char *fw_name,
+                             struct device *device)
 {
        int retval;
        struct firmware_priv *fw_priv = kzalloc(sizeof(*fw_priv),
                                                GFP_KERNEL);
-       struct class_device *class_dev = kzalloc(sizeof(*class_dev),
-                                                GFP_KERNEL);
+       struct device *f_dev = kzalloc(sizeof(*f_dev), GFP_KERNEL);
 
-       *class_dev_p = NULL;
+       *dev_p = NULL;
 
-       if (!fw_priv || !class_dev) {
-               printk(KERN_ERR "%s: kmalloc failed\n", __FUNCTION__);
+       if (!fw_priv || !f_dev) {
+               dev_err(device, "%s: kmalloc failed\n", __func__);
                retval = -ENOMEM;
                goto error_kfree;
        }
@@ -331,68 +315,63 @@ fw_register_class_device(struct class_device **class_dev_p,
        fw_priv->timeout.data = (u_long) fw_priv;
        init_timer(&fw_priv->timeout);
 
-       fw_setup_class_device_id(class_dev, device);
-       class_dev->dev = device;
-       class_dev->class = &firmware_class;
-       class_set_devdata(class_dev, fw_priv);
-       retval = class_device_register(class_dev);
+       dev_set_name(f_dev, dev_name(device));
+       f_dev->parent = device;
+       f_dev->class = &firmware_class;
+       dev_set_drvdata(f_dev, fw_priv);
+       f_dev->uevent_suppress = 1;
+       retval = device_register(f_dev);
        if (retval) {
-               printk(KERN_ERR "%s: class_device_register failed\n",
-                      __FUNCTION__);
+               dev_err(device, "%s: device_register failed\n", __func__);
                goto error_kfree;
        }
-       *class_dev_p = class_dev;
+       *dev_p = f_dev;
        return 0;
 
 error_kfree:
        kfree(fw_priv);
-       kfree(class_dev);
+       kfree(f_dev);
        return retval;
 }
 
-static int
-fw_setup_class_device(struct firmware *fw, struct class_device **class_dev_p,
-                     const char *fw_name, struct device *device, int uevent)
+static int fw_setup_device(struct firmware *fw, struct device **dev_p,
+                          const char *fw_name, struct device *device,
+                          int uevent)
 {
-       struct class_device *class_dev;
+       struct device *f_dev;
        struct firmware_priv *fw_priv;
        int retval;
 
-       *class_dev_p = NULL;
-       retval = fw_register_class_device(&class_dev, fw_name, device);
+       *dev_p = NULL;
+       retval = fw_register_device(&f_dev, fw_name, device);
        if (retval)
                goto out;
 
        /* Need to pin this module until class device is destroyed */
        __module_get(THIS_MODULE);
 
-       fw_priv = class_get_devdata(class_dev);
+       fw_priv = dev_get_drvdata(f_dev);
 
        fw_priv->fw = fw;
-       retval = sysfs_create_bin_file(&class_dev->kobj, &fw_priv->attr_data);
+       retval = sysfs_create_bin_file(&f_dev->kobj, &fw_priv->attr_data);
        if (retval) {
-               printk(KERN_ERR "%s: sysfs_create_bin_file failed\n",
-                      __FUNCTION__);
+               dev_err(device, "%s: sysfs_create_bin_file failed\n", __func__);
                goto error_unreg;
        }
 
-       retval = class_device_create_file(class_dev,
-                                         &class_device_attr_loading);
+       retval = device_create_file(f_dev, &dev_attr_loading);
        if (retval) {
-               printk(KERN_ERR "%s: class_device_create_file failed\n",
-                      __FUNCTION__);
+               dev_err(device, "%s: device_create_file failed\n", __func__);
                goto error_unreg;
        }
 
        if (uevent)
-                set_bit(FW_STATUS_READY, &fw_priv->status);
-        else
-                set_bit(FW_STATUS_READY_NOHOTPLUG, &fw_priv->status);
-       *class_dev_p = class_dev;
+               f_dev->uevent_suppress = 0;
+       *dev_p = f_dev;
        goto out;
 
 error_unreg:
-       class_device_unregister(class_dev);
+       device_unregister(f_dev);
 out:
        return retval;
 }
@@ -401,9 +380,10 @@ static int
 _request_firmware(const struct firmware **firmware_p, const char *name,
                 struct device *device, int uevent)
 {
-       struct class_device *class_dev;
+       struct device *f_dev;
        struct firmware_priv *fw_priv;
        struct firmware *firmware;
+       struct builtin_fw *builtin;
        int retval;
 
        if (!firmware_p)
@@ -411,18 +391,31 @@ _request_firmware(const struct firmware **firmware_p, const char *name,
 
        *firmware_p = firmware = kzalloc(sizeof(*firmware), GFP_KERNEL);
        if (!firmware) {
-               printk(KERN_ERR "%s: kmalloc(struct firmware) failed\n",
-                      __FUNCTION__);
+               dev_err(device, "%s: kmalloc(struct firmware) failed\n",
+                       __func__);
                retval = -ENOMEM;
                goto out;
        }
 
-       retval = fw_setup_class_device(firmware, &class_dev, name, device,
-                                      uevent);
+       for (builtin = __start_builtin_fw; builtin != __end_builtin_fw;
+            builtin++) {
+               if (strcmp(name, builtin->name))
+                       continue;
+               dev_info(device, "firmware: using built-in firmware %s\n",
+                        name);
+               firmware->size = builtin->size;
+               firmware->data = builtin->data;
+               return 0;
+       }
+
+       if (uevent)
+               dev_info(device, "firmware: requesting %s\n", name);
+
+       retval = fw_setup_device(firmware, &f_dev, name, device, uevent);
        if (retval)
                goto error_kfree_fw;
 
-       fw_priv = class_get_devdata(class_dev);
+       fw_priv = dev_get_drvdata(f_dev);
 
        if (uevent) {
                if (loading_timeout > 0) {
@@ -430,22 +423,22 @@ _request_firmware(const struct firmware **firmware_p, const char *name,
                        add_timer(&fw_priv->timeout);
                }
 
-               kobject_uevent(&class_dev->kobj, KOBJ_ADD);
+               kobject_uevent(&f_dev->kobj, KOBJ_ADD);
                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);
 
-       down(&fw_lock);
+       mutex_lock(&fw_lock);
        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;
-       up(&fw_lock);
-       class_device_unregister(class_dev);
+       mutex_unlock(&fw_lock);
+       device_unregister(f_dev);
        goto out;
 
 error_kfree_fw:
@@ -485,31 +478,20 @@ request_firmware(const struct firmware **firmware_p, const char *name,
 void
 release_firmware(const struct firmware *fw)
 {
+       struct builtin_fw *builtin;
+
        if (fw) {
+               for (builtin = __start_builtin_fw; builtin != __end_builtin_fw;
+                    builtin++) {
+                       if (fw->data == builtin->data)
+                               goto free_fw;
+               }
                vfree(fw->data);
+       free_fw:
                kfree(fw);
        }
 }
 
-/**
- * register_firmware: - provide a firmware image for later usage
- * @name: name of firmware image file
- * @data: buffer pointer for the firmware image
- * @size: size of the data buffer area
- *
- *     Make sure that @data will be available by requesting firmware @name.
- *
- *     Note: This will not be possible until some kind of persistence
- *     is available.
- **/
-void
-register_firmware(const char *name, const u8 *data, size_t size)
-{
-       /* This is meaningless without firmware caching, so until we
-        * decide if firmware caching is reasonable just leave it as a
-        * noop */
-}
-
 /* Async support */
 struct firmware_work {
        struct work_struct work;
@@ -531,7 +513,6 @@ request_firmware_work_func(void *arg)
                WARN_ON(1);
                return 0;
        }
-       daemonize("%s/%s", "firmware", fw_work->name);
        ret = _request_firmware(&fw, fw_work->name, fw_work->device,
                fw_work->uevent);
        if (ret < 0)
@@ -566,9 +547,9 @@ request_firmware_nowait(
        const char *name, struct device *device, void *context,
        void (*cont)(const struct firmware *fw, void *context))
 {
+       struct task_struct *task;
        struct firmware_work *fw_work = kmalloc(sizeof (struct firmware_work),
                                                GFP_ATOMIC);
-       int ret;
 
        if (!fw_work)
                return -ENOMEM;
@@ -586,14 +567,14 @@ request_firmware_nowait(
                .uevent = uevent,
        };
 
-       ret = kernel_thread(request_firmware_work_func, fw_work,
-                           CLONE_FS | CLONE_FILES);
+       task = kthread_run(request_firmware_work_func, fw_work,
+                           "firmware/%s", name);
 
-       if (ret < 0) {
+       if (IS_ERR(task)) {
                fw_work->cont(NULL, fw_work->context);
                module_put(fw_work->module);
                kfree(fw_work);
-               return ret;
+               return PTR_ERR(task);
        }
        return 0;
 }
@@ -604,13 +585,13 @@ firmware_class_init(void)
        int error;
        error = class_register(&firmware_class);
        if (error) {
-               printk(KERN_ERR "%s: class_register failed\n", __FUNCTION__);
+               printk(KERN_ERR "%s: class_register failed\n", __func__);
                return error;
        }
        error = class_create_file(&firmware_class, &class_attr_timeout);
        if (error) {
                printk(KERN_ERR "%s: class_create_file failed\n",
-                      __FUNCTION__);
+                      __func__);
                class_unregister(&firmware_class);
        }
        return error;
@@ -622,10 +603,9 @@ firmware_class_exit(void)
        class_unregister(&firmware_class);
 }
 
-module_init(firmware_class_init);
+fs_initcall(firmware_class_init);
 module_exit(firmware_class_exit);
 
 EXPORT_SYMBOL(release_firmware);
 EXPORT_SYMBOL(request_firmware);
 EXPORT_SYMBOL(request_firmware_nowait);
-EXPORT_SYMBOL(register_firmware);