drivers/base/firmware_class.c

   1 /*
   2  * firmware_class.c - Multi purpose firmware loading support
   3  *
   4  * Copyright (c) 2003 Manuel Estrada Sainz <ranty@debian.org>
   5  *
   6  * Please see Documentation/firmware_class/ for more information.
   7  *
   8  */
   9
  10 #include <linux/device.h>
  11 #include <linux/module.h>
  12 #include <linux/init.h>
  13 #include <linux/timer.h>
  14 #include <linux/vmalloc.h>
  15 #include <asm/hardirq.h>
  16 #include <linux/bitops.h>
  17 #include <asm/semaphore.h>
  18
  19 #include <linux/firmware.h>
  20 #include "base.h"
  21
  22 MODULE_AUTHOR("Manuel Estrada Sainz <ranty@debian.org>");
  23 MODULE_DESCRIPTION("Multi purpose firmware loading support");
  24 MODULE_LICENSE("GPL");
  25
  26 enum {
  27         FW_STATUS_LOADING,
  28         FW_STATUS_DONE,
  29         FW_STATUS_ABORT,
  30         FW_STATUS_READY,
  31 };
  32
  33 static int loading_timeout = 10;        /* In seconds */
  34
  35 /* fw_lock could be moved to 'struct firmware_priv' but since it is just
  36  * guarding for corner cases a global lock should be OK */
  37 static DECLARE_MUTEX(fw_lock);
  38
  39 struct firmware_priv {
  40         char fw_id[FIRMWARE_NAME_MAX];
  41         struct completion completion;
  42         struct bin_attribute attr_data;
  43         struct firmware *fw;
  44         unsigned long status;
  45         int alloc_size;
  46         struct timer_list timeout;
  47 };
  48
  49 static inline void
  50 fw_load_abort(struct firmware_priv *fw_priv)
  51 {
  52         set_bit(FW_STATUS_ABORT, &fw_priv->status);
  53         wmb();
  54         complete(&fw_priv->completion);
  55 }
  56
  57 static ssize_t
  58 firmware_timeout_show(struct class *class, char *buf)
  59 {
  60         return sprintf(buf, "%d\n", loading_timeout);
  61 }
  62
  63 /**
  64  * firmware_timeout_store:
  65  * Description:
  66  *      Sets the number of seconds to wait for the firmware.  Once
  67  *      this expires an error will be return to the driver and no
  68  *      firmware will be provided.
  69  *
  70  *      Note: zero means 'wait for ever'
  71  *
  72  **/
  73 static ssize_t
  74 firmware_timeout_store(struct class *class, const char *buf, size_t count)
  75 {
  76         loading_timeout = simple_strtol(buf, NULL, 10);
  77         return count;
  78 }
  79
  80 static CLASS_ATTR(timeout, 0644, firmware_timeout_show, firmware_timeout_store);
  81
  82 static void  fw_class_dev_release(struct class_device *class_dev);
  83 int firmware_class_hotplug(struct class_device *dev, char **envp,
  84                            int num_envp, char *buffer, int buffer_size);
  85
  86 static struct class firmware_class = {
  87         .name           = "firmware",
  88         .hotplug        = firmware_class_hotplug,
  89         .release        = fw_class_dev_release,
  90 };
  91
  92 int
  93 firmware_class_hotplug(struct class_device *class_dev, char **envp,
  94                        int num_envp, char *buffer, int buffer_size)
  95 {
  96         struct firmware_priv *fw_priv = class_get_devdata(class_dev);
  97         int i = 0;
  98         char *scratch = buffer;
  99
 100         if (!test_bit(FW_STATUS_READY, &fw_priv->status))
 101                 return -ENODEV;
 102
 103         if (buffer_size < (FIRMWARE_NAME_MAX + 10))
 104                 return -ENOMEM;
 105         if (num_envp < 1)
 106                 return -ENOMEM;
 107
 108         envp[i++] = scratch;
 109         scratch += sprintf(scratch, "FIRMWARE=%s", fw_priv->fw_id) + 1;
 110         return 0;
 111 }
 112
 113 static ssize_t
 114 firmware_loading_show(struct class_device *class_dev, char *buf)
 115 {
 116         struct firmware_priv *fw_priv = class_get_devdata(class_dev);
 117         int loading = test_bit(FW_STATUS_LOADING, &fw_priv->status);
 118         return sprintf(buf, "%d\n", loading);
 119 }
 120
 121 /**
 122  * firmware_loading_store: - loading control file
 123  * Description:
 124  *      The relevant values are:
 125  *
 126  *       1: Start a load, discarding any previous partial load.
 127  *       0: Conclude the load and handle the data to the driver code.
 128  *      -1: Conclude the load with an error and discard any written data.
 129  **/
 130 static ssize_t
 131 firmware_loading_store(struct class_device *class_dev,
 132                        const char *buf, size_t count)
 133 {
 134         struct firmware_priv *fw_priv = class_get_devdata(class_dev);
 135         int loading = simple_strtol(buf, NULL, 10);
 136
 137         switch (loading) {
 138         case 1:
 139                 down(&fw_lock);
 140                 vfree(fw_priv->fw->data);
 141                 fw_priv->fw->data = NULL;
 142                 fw_priv->fw->size = 0;
 143                 fw_priv->alloc_size = 0;
 144                 set_bit(FW_STATUS_LOADING, &fw_priv->status);
 145                 up(&fw_lock);
 146                 break;
 147         case 0:
 148                 if (test_bit(FW_STATUS_LOADING, &fw_priv->status)) {
 149                         complete(&fw_priv->completion);
 150                         clear_bit(FW_STATUS_LOADING, &fw_priv->status);
 151                         break;
 152                 }
 153                 /* fallthrough */
 154         default:
 155                 printk(KERN_ERR "%s: unexpected value (%d)\n", __FUNCTION__,
 156                        loading);
 157                 /* fallthrough */
 158         case -1:
 159                 fw_load_abort(fw_priv);
 160                 break;
 161         }
 162
 163         return count;
 164 }
 165
 166 static CLASS_DEVICE_ATTR(loading, 0644,
 167                         firmware_loading_show, firmware_loading_store);
 168
 169 static ssize_t
 170 firmware_data_read(struct kobject *kobj,
 171                    char *buffer, loff_t offset, size_t count)
 172 {
 173         struct class_device *class_dev = to_class_dev(kobj);
 174         struct firmware_priv *fw_priv = class_get_devdata(class_dev);
 175         struct firmware *fw;
 176         ssize_t ret_count = count;
 177
 178         down(&fw_lock);
 179         fw = fw_priv->fw;
 180         if (test_bit(FW_STATUS_DONE, &fw_priv->status)) {
 181                 ret_count = -ENODEV;
 182                 goto out;
 183         }
 184         if (offset > fw->size) {
 185                 ret_count = 0;
 186                 goto out;
 187         }
 188         if (offset + ret_count > fw->size)
 189                 ret_count = fw->size - offset;
 190
 191         memcpy(buffer, fw->data + offset, ret_count);
 192 out:
 193         up(&fw_lock);
 194         return ret_count;
 195 }
 196 static int
 197 fw_realloc_buffer(struct firmware_priv *fw_priv, int min_size)
 198 {
 199         u8 *new_data;
 200
 201         if (min_size <= fw_priv->alloc_size)
 202                 return 0;
 203
 204         new_data = vmalloc(fw_priv->alloc_size + PAGE_SIZE);
 205         if (!new_data) {
 206                 printk(KERN_ERR "%s: unable to alloc buffer\n", __FUNCTION__);
 207                 /* Make sure that we don't keep incomplete data */
 208                 fw_load_abort(fw_priv);
 209                 return -ENOMEM;
 210         }
 211         fw_priv->alloc_size += PAGE_SIZE;
 212         if (fw_priv->fw->data) {
 213                 memcpy(new_data, fw_priv->fw->data, fw_priv->fw->size);
 214                 vfree(fw_priv->fw->data);
 215         }
 216         fw_priv->fw->data = new_data;
 217         BUG_ON(min_size > fw_priv->alloc_size);
 218         return 0;
 219 }
 220
 221 /**
 222  * firmware_data_write:
 223  *
 224  * Description:
 225  *
 226  *      Data written to the 'data' attribute will be later handled to
 227  *      the driver as a firmware image.
 228  **/
 229 static ssize_t
 230 firmware_data_write(struct kobject *kobj,
 231                     char *buffer, loff_t offset, size_t count)
 232 {
 233         struct class_device *class_dev = to_class_dev(kobj);
 234         struct firmware_priv *fw_priv = class_get_devdata(class_dev);
 235         struct firmware *fw;
 236         ssize_t retval;
 237
 238         down(&fw_lock);
 239         fw = fw_priv->fw;
 240         if (test_bit(FW_STATUS_DONE, &fw_priv->status)) {
 241                 retval = -ENODEV;
 242                 goto out;
 243         }
 244         retval = fw_realloc_buffer(fw_priv, offset + count);
 245         if (retval)
 246                 goto out;
 247
 248         memcpy(fw->data + offset, buffer, count);
 249
 250         fw->size = max_t(size_t, offset + count, fw->size);
 251         retval = count;
 252 out:
 253         up(&fw_lock);
 254         return retval;
 255 }
 256 static struct bin_attribute firmware_attr_data_tmpl = {
 257         .attr = {.name = "data", .mode = 0644, .owner = THIS_MODULE},
 258         .size = 0,
 259         .read = firmware_data_read,
 260         .write = firmware_data_write,
 261 };
 262
 263 static void
 264 fw_class_dev_release(struct class_device *class_dev)
 265 {
 266         struct firmware_priv *fw_priv = class_get_devdata(class_dev);
 267
 268         kfree(fw_priv);
 269         kfree(class_dev);
 270
 271         module_put(THIS_MODULE);
 272 }
 273
 274 static void
 275 firmware_class_timeout(u_long data)
 276 {
 277         struct firmware_priv *fw_priv = (struct firmware_priv *) data;
 278         fw_load_abort(fw_priv);
 279 }
 280
 281 static inline void
 282 fw_setup_class_device_id(struct class_device *class_dev, struct device *dev)
 283 {
 284         /* XXX warning we should watch out for name collisions */
 285         strlcpy(class_dev->class_id, dev->bus_id, BUS_ID_SIZE);
 286 }
 287
 288 static int
 289 fw_register_class_device(struct class_device **class_dev_p,
 290                          const char *fw_name, struct device *device)
 291 {
 292         int retval;
 293         struct firmware_priv *fw_priv = kmalloc(sizeof (struct firmware_priv),
 294                                                 GFP_KERNEL);
 295         struct class_device *class_dev = kmalloc(sizeof (struct class_device),
 296                                                  GFP_KERNEL);
 297
 298         *class_dev_p = NULL;
 299
 300         if (!fw_priv || !class_dev) {
 301                 printk(KERN_ERR "%s: kmalloc failed\n", __FUNCTION__);
 302                 retval = -ENOMEM;
 303                 goto error_kfree;
 304         }
 305         memset(fw_priv, 0, sizeof (*fw_priv));
 306         memset(class_dev, 0, sizeof (*class_dev));
 307
 308         init_completion(&fw_priv->completion);
 309         fw_priv->attr_data = firmware_attr_data_tmpl;
 310         strlcpy(fw_priv->fw_id, fw_name, FIRMWARE_NAME_MAX);
 311
 312         fw_priv->timeout.function = firmware_class_timeout;
 313         fw_priv->timeout.data = (u_long) fw_priv;
 314         init_timer(&fw_priv->timeout);
 315
 316         fw_setup_class_device_id(class_dev, device);
 317         class_dev->dev = device;
 318         class_dev->class = &firmware_class;
 319         class_set_devdata(class_dev, fw_priv);
 320         retval = class_device_register(class_dev);
 321         if (retval) {
 322                 printk(KERN_ERR "%s: class_device_register failed\n",
 323                        __FUNCTION__);
 324                 goto error_kfree;
 325         }
 326         *class_dev_p = class_dev;
 327         return 0;
 328
 329 error_kfree:
 330         kfree(fw_priv);
 331         kfree(class_dev);
 332         return retval;
 333 }
 334
 335 static int
 336 fw_setup_class_device(struct firmware *fw, struct class_device **class_dev_p,
 337                       const char *fw_name, struct device *device)
 338 {
 339         struct class_device *class_dev;
 340         struct firmware_priv *fw_priv;
 341         int retval;
 342
 343         *class_dev_p = NULL;
 344         retval = fw_register_class_device(&class_dev, fw_name, device);
 345         if (retval)
 346                 goto out;
 347
 348         /* Need to pin this module until class device is destroyed */
 349         __module_get(THIS_MODULE);
 350
 351         fw_priv = class_get_devdata(class_dev);
 352
 353         fw_priv->fw = fw;
 354         retval = sysfs_create_bin_file(&class_dev->kobj, &fw_priv->attr_data);
 355         if (retval) {
 356                 printk(KERN_ERR "%s: sysfs_create_bin_file failed\n",
 357                        __FUNCTION__);
 358                 goto error_unreg;
 359         }
 360
 361         retval = class_device_create_file(class_dev,
 362                                           &class_device_attr_loading);
 363         if (retval) {
 364                 printk(KERN_ERR "%s: class_device_create_file failed\n",
 365                        __FUNCTION__);
 366                 goto error_unreg;
 367         }
 368
 369         set_bit(FW_STATUS_READY, &fw_priv->status);
 370         *class_dev_p = class_dev;
 371         goto out;
 372
 373 error_unreg:
 374         class_device_unregister(class_dev);
 375 out:
 376         return retval;
 377 }
 378
 379 /**
 380  * request_firmware: - request firmware to hotplug and wait for it
 381  * Description:
 382  *      @firmware will be used to return a firmware image by the name
 383  *      of @name for device @device.
 384  *
 385  *      Should be called from user context where sleeping is allowed.
 386  *
 387  *      @name will be use as $FIRMWARE in the hotplug environment and
 388  *      should be distinctive enough not to be confused with any other
 389  *      firmware image for this or any other device.
 390  **/
 391 int
 392 request_firmware(const struct firmware **firmware_p, const char *name,
 393                  struct device *device)
 394 {
 395         struct class_device *class_dev;
 396         struct firmware_priv *fw_priv;
 397         struct firmware *firmware;
 398         int retval;
 399
 400         if (!firmware_p)
 401                 return -EINVAL;
 402
 403         *firmware_p = firmware = kmalloc(sizeof (struct firmware), GFP_KERNEL);
 404         if (!firmware) {
 405                 printk(KERN_ERR "%s: kmalloc(struct firmware) failed\n",
 406                        __FUNCTION__);
 407                 retval = -ENOMEM;
 408                 goto out;
 409         }
 410         memset(firmware, 0, sizeof (*firmware));
 411
 412         retval = fw_setup_class_device(firmware, &class_dev, name, device);
 413         if (retval)
 414                 goto error_kfree_fw;
 415
 416         fw_priv = class_get_devdata(class_dev);
 417
 418         if (loading_timeout) {
 419                 fw_priv->timeout.expires = jiffies + loading_timeout * HZ;
 420                 add_timer(&fw_priv->timeout);
 421         }
 422
 423         kobject_hotplug("add", &class_dev->kobj);
 424         wait_for_completion(&fw_priv->completion);
 425         set_bit(FW_STATUS_DONE, &fw_priv->status);
 426
 427         del_timer_sync(&fw_priv->timeout);
 428
 429         down(&fw_lock);
 430         if (!fw_priv->fw->size || test_bit(FW_STATUS_ABORT, &fw_priv->status)) {
 431                 retval = -ENOENT;
 432                 release_firmware(fw_priv->fw);
 433                 *firmware_p = NULL;
 434         }
 435         fw_priv->fw = NULL;
 436         up(&fw_lock);
 437         class_device_unregister(class_dev);
 438         goto out;
 439
 440 error_kfree_fw:
 441         kfree(firmware);
 442 out:
 443         return retval;
 444 }
 445
 446 /**
 447  * release_firmware: - release the resource associated with a firmware image
 448  **/
 449 void
 450 release_firmware(const struct firmware *fw)
 451 {
 452         if (fw) {
 453                 vfree(fw->data);
 454                 kfree(fw);
 455         }
 456 }
 457
 458 /**
 459  * register_firmware: - provide a firmware image for later usage
 460  *
 461  * Description:
 462  *      Make sure that @data will be available by requesting firmware @name.
 463  *
 464  *      Note: This will not be possible until some kind of persistence
 465  *      is available.
 466  **/
 467 void
 468 register_firmware(const char *name, const u8 *data, size_t size)
 469 {
 470         /* This is meaningless without firmware caching, so until we
 471          * decide if firmware caching is reasonable just leave it as a
 472          * noop */
 473 }
 474
 475 /* Async support */
 476 struct firmware_work {
 477         struct work_struct work;
 478         struct module *module;
 479         const char *name;
 480         struct device *device;
 481         void *context;
 482         void (*cont)(const struct firmware *fw, void *context);
 483 };
 484
 485 static int
 486 request_firmware_work_func(void *arg)
 487 {
 488         struct firmware_work *fw_work = arg;
 489         const struct firmware *fw;
 490         if (!arg) {
 491                 WARN_ON(1);
 492                 return 0;
 493         }
 494         daemonize("%s/%s", "firmware", fw_work->name);
 495         request_firmware(&fw, fw_work->name, fw_work->device);
 496         fw_work->cont(fw, fw_work->context);
 497         release_firmware(fw);
 498         module_put(fw_work->module);
 499         kfree(fw_work);
 500         return 0;
 501 }
 502
 503 /**
 504  * request_firmware_nowait:
 505  *
 506  * Description:
 507  *      Asynchronous variant of request_firmware() for contexts where
 508  *      it is not possible to sleep.
 509  *
 510  *      @cont will be called asynchronously when the firmware request is over.
 511  *
 512  *      @context will be passed over to @cont.
 513  *
 514  *      @fw may be %NULL if firmware request fails.
 515  *
 516  **/
 517 int
 518 request_firmware_nowait(
 519         struct module *module,
 520         const char *name, struct device *device, void *context,
 521         void (*cont)(const struct firmware *fw, void *context))
 522 {
 523         struct firmware_work *fw_work = kmalloc(sizeof (struct firmware_work),
 524                                                 GFP_ATOMIC);
 525         int ret;
 526
 527         if (!fw_work)
 528                 return -ENOMEM;
 529         if (!try_module_get(module)) {
 530                 kfree(fw_work);
 531                 return -EFAULT;
 532         }
 533
 534         *fw_work = (struct firmware_work) {
 535                 .module = module,
 536                 .name = name,
 537                 .device = device,
 538                 .context = context,
 539                 .cont = cont,
 540         };
 541
 542         ret = kernel_thread(request_firmware_work_func, fw_work,
 543                             CLONE_FS | CLONE_FILES);
 544
 545         if (ret < 0) {
 546                 fw_work->cont(NULL, fw_work->context);
 547                 return ret;
 548         }
 549         return 0;
 550 }
 551
 552 static int __init
 553 firmware_class_init(void)
 554 {
 555         int error;
 556         error = class_register(&firmware_class);
 557         if (error) {
 558                 printk(KERN_ERR "%s: class_register failed\n", __FUNCTION__);
 559                 return error;
 560         }
 561         error = class_create_file(&firmware_class, &class_attr_timeout);
 562         if (error) {
 563                 printk(KERN_ERR "%s: class_create_file failed\n",
 564                        __FUNCTION__);
 565                 class_unregister(&firmware_class);
 566         }
 567         return error;
 568
 569 }
 570 static void __exit
 571 firmware_class_exit(void)
 572 {
 573         class_unregister(&firmware_class);
 574 }
 575
 576 module_init(firmware_class_init);
 577 module_exit(firmware_class_exit);
 578
 579 EXPORT_SYMBOL(release_firmware);
 580 EXPORT_SYMBOL(request_firmware);
 581 EXPORT_SYMBOL(request_firmware_nowait);
 582 EXPORT_SYMBOL(register_firmware);
 583 EXPORT_SYMBOL(firmware_class);