drivers/base/platform.c

   1 /*
   2  * platform.c - platform 'pseudo' bus for legacy devices
   3  *
   4  * Copyright (c) 2002-3 Patrick Mochel
   5  * Copyright (c) 2002-3 Open Source Development Labs
   6  *
   7  * This file is released under the GPLv2
   8  *
   9  * Please see Documentation/driver-model/platform.txt for more
  10  * information.
  11  */
  12
  13 #include <linux/string.h>
  14 #include <linux/platform_device.h>
  15 #include <linux/of_device.h>
  16 #include <linux/of_irq.h>
  17 #include <linux/module.h>
  18 #include <linux/init.h>
  19 #include <linux/dma-mapping.h>
  20 #include <linux/bootmem.h>
  21 #include <linux/err.h>
  22 #include <linux/slab.h>
  23 #include <linux/pm_runtime.h>
  24 #include <linux/pm_domain.h>
  25 #include <linux/idr.h>
  26 #include <linux/acpi.h>
  27 #include <linux/clk/clk-conf.h>
  28 #include <linux/limits.h>
  29
  30 #include "base.h"
  31 #include "power/power.h"
  32
  33 /* For automatically allocated device IDs */
  34 static DEFINE_IDA(platform_devid_ida);
  35
  36 struct device platform_bus = {
  37         .init_name      = "platform",
  38 };
  39 EXPORT_SYMBOL_GPL(platform_bus);
  40
  41 /**
  42  * arch_setup_pdev_archdata - Allow manipulation of archdata before its used
  43  * @pdev: platform device
  44  *
  45  * This is called before platform_device_add() such that any pdev_archdata may
  46  * be setup before the platform_notifier is called.  So if a user needs to
  47  * manipulate any relevant information in the pdev_archdata they can do:
  48  *
  49  *      platform_device_alloc()
  50  *      ... manipulate ...
  51  *      platform_device_add()
  52  *
  53  * And if they don't care they can just call platform_device_register() and
  54  * everything will just work out.
  55  */
  56 void __weak arch_setup_pdev_archdata(struct platform_device *pdev)
  57 {
  58 }
  59
  60 /**
  61  * platform_get_resource - get a resource for a device
  62  * @dev: platform device
  63  * @type: resource type
  64  * @num: resource index
  65  */
  66 struct resource *platform_get_resource(struct platform_device *dev,
  67                                        unsigned int type, unsigned int num)
  68 {
  69         int i;
  70
  71         for (i = 0; i < dev->num_resources; i++) {
  72                 struct resource *r = &dev->resource[i];
  73
  74                 if (type == resource_type(r) && num-- == 0)
  75                         return r;
  76         }
  77         return NULL;
  78 }
  79 EXPORT_SYMBOL_GPL(platform_get_resource);
  80
  81 /**
  82  * platform_get_irq - get an IRQ for a device
  83  * @dev: platform device
  84  * @num: IRQ number index
  85  */
  86 int platform_get_irq(struct platform_device *dev, unsigned int num)
  87 {
  88 #ifdef CONFIG_SPARC
  89         /* sparc does not have irqs represented as IORESOURCE_IRQ resources */
  90         if (!dev || num >= dev->archdata.num_irqs)
  91                 return -ENXIO;
  92         return dev->archdata.irqs[num];
  93 #else
  94         struct resource *r;
  95         if (IS_ENABLED(CONFIG_OF_IRQ) && dev->dev.of_node) {
  96                 int ret;
  97
  98                 ret = of_irq_get(dev->dev.of_node, num);
  99                 if (ret > 0 || ret == -EPROBE_DEFER)
 100                         return ret;
 101         }
 102
 103         r = platform_get_resource(dev, IORESOURCE_IRQ, num);
 104         /*
 105          * The resources may pass trigger flags to the irqs that need
 106          * to be set up. It so happens that the trigger flags for
 107          * IORESOURCE_BITS correspond 1-to-1 to the IRQF_TRIGGER*
 108          * settings.
 109          */
 110         if (r && r->flags & IORESOURCE_BITS)
 111                 irqd_set_trigger_type(irq_get_irq_data(r->start),
 112                                       r->flags & IORESOURCE_BITS);
 113
 114         return r ? r->start : -ENXIO;
 115 #endif
 116 }
 117 EXPORT_SYMBOL_GPL(platform_get_irq);
 118
 119 /**
 120  * platform_get_resource_byname - get a resource for a device by name
 121  * @dev: platform device
 122  * @type: resource type
 123  * @name: resource name
 124  */
 125 struct resource *platform_get_resource_byname(struct platform_device *dev,
 126                                               unsigned int type,
 127                                               const char *name)
 128 {
 129         int i;
 130
 131         for (i = 0; i < dev->num_resources; i++) {
 132                 struct resource *r = &dev->resource[i];
 133
 134                 if (unlikely(!r->name))
 135                         continue;
 136
 137                 if (type == resource_type(r) && !strcmp(r->name, name))
 138                         return r;
 139         }
 140         return NULL;
 141 }
 142 EXPORT_SYMBOL_GPL(platform_get_resource_byname);
 143
 144 /**
 145  * platform_get_irq_byname - get an IRQ for a device by name
 146  * @dev: platform device
 147  * @name: IRQ name
 148  */
 149 int platform_get_irq_byname(struct platform_device *dev, const char *name)
 150 {
 151         struct resource *r;
 152
 153         if (IS_ENABLED(CONFIG_OF_IRQ) && dev->dev.of_node) {
 154                 int ret;
 155
 156                 ret = of_irq_get_byname(dev->dev.of_node, name);
 157                 if (ret > 0 || ret == -EPROBE_DEFER)
 158                         return ret;
 159         }
 160
 161         r = platform_get_resource_byname(dev, IORESOURCE_IRQ, name);
 162         return r ? r->start : -ENXIO;
 163 }
 164 EXPORT_SYMBOL_GPL(platform_get_irq_byname);
 165
 166 /**
 167  * platform_add_devices - add a numbers of platform devices
 168  * @devs: array of platform devices to add
 169  * @num: number of platform devices in array
 170  */
 171 int platform_add_devices(struct platform_device **devs, int num)
 172 {
 173         int i, ret = 0;
 174
 175         for (i = 0; i < num; i++) {
 176                 ret = platform_device_register(devs[i]);
 177                 if (ret) {
 178                         while (--i >= 0)
 179                                 platform_device_unregister(devs[i]);
 180                         break;
 181                 }
 182         }
 183
 184         return ret;
 185 }
 186 EXPORT_SYMBOL_GPL(platform_add_devices);
 187
 188 struct platform_object {
 189         struct platform_device pdev;
 190         char name[];
 191 };
 192
 193 /**
 194  * platform_device_put - destroy a platform device
 195  * @pdev: platform device to free
 196  *
 197  * Free all memory associated with a platform device.  This function must
 198  * _only_ be externally called in error cases.  All other usage is a bug.
 199  */
 200 void platform_device_put(struct platform_device *pdev)
 201 {
 202         if (pdev)
 203                 put_device(&pdev->dev);
 204 }
 205 EXPORT_SYMBOL_GPL(platform_device_put);
 206
 207 static void platform_device_release(struct device *dev)
 208 {
 209         struct platform_object *pa = container_of(dev, struct platform_object,
 210                                                   pdev.dev);
 211
 212         of_device_node_put(&pa->pdev.dev);
 213         kfree(pa->pdev.dev.platform_data);
 214         kfree(pa->pdev.mfd_cell);
 215         kfree(pa->pdev.resource);
 216         kfree(pa->pdev.driver_override);
 217         kfree(pa);
 218 }
 219
 220 /**
 221  * platform_device_alloc - create a platform device
 222  * @name: base name of the device we're adding
 223  * @id: instance id
 224  *
 225  * Create a platform device object which can have other objects attached
 226  * to it, and which will have attached objects freed when it is released.
 227  */
 228 struct platform_device *platform_device_alloc(const char *name, int id)
 229 {
 230         struct platform_object *pa;
 231
 232         pa = kzalloc(sizeof(*pa) + strlen(name) + 1, GFP_KERNEL);
 233         if (pa) {
 234                 strcpy(pa->name, name);
 235                 pa->pdev.name = pa->name;
 236                 pa->pdev.id = id;
 237                 device_initialize(&pa->pdev.dev);
 238                 pa->pdev.dev.release = platform_device_release;
 239                 arch_setup_pdev_archdata(&pa->pdev);
 240         }
 241
 242         return pa ? &pa->pdev : NULL;
 243 }
 244 EXPORT_SYMBOL_GPL(platform_device_alloc);
 245
 246 /**
 247  * platform_device_add_resources - add resources to a platform device
 248  * @pdev: platform device allocated by platform_device_alloc to add resources to
 249  * @res: set of resources that needs to be allocated for the device
 250  * @num: number of resources
 251  *
 252  * Add a copy of the resources to the platform device.  The memory
 253  * associated with the resources will be freed when the platform device is
 254  * released.
 255  */
 256 int platform_device_add_resources(struct platform_device *pdev,
 257                                   const struct resource *res, unsigned int num)
 258 {
 259         struct resource *r = NULL;
 260
 261         if (res) {
 262                 r = kmemdup(res, sizeof(struct resource) * num, GFP_KERNEL);
 263                 if (!r)
 264                         return -ENOMEM;
 265         }
 266
 267         kfree(pdev->resource);
 268         pdev->resource = r;
 269         pdev->num_resources = num;
 270         return 0;
 271 }
 272 EXPORT_SYMBOL_GPL(platform_device_add_resources);
 273
 274 /**
 275  * platform_device_add_data - add platform-specific data to a platform device
 276  * @pdev: platform device allocated by platform_device_alloc to add resources to
 277  * @data: platform specific data for this platform device
 278  * @size: size of platform specific data
 279  *
 280  * Add a copy of platform specific data to the platform device's
 281  * platform_data pointer.  The memory associated with the platform data
 282  * will be freed when the platform device is released.
 283  */
 284 int platform_device_add_data(struct platform_device *pdev, const void *data,
 285                              size_t size)
 286 {
 287         void *d = NULL;
 288
 289         if (data) {
 290                 d = kmemdup(data, size, GFP_KERNEL);
 291                 if (!d)
 292                         return -ENOMEM;
 293         }
 294
 295         kfree(pdev->dev.platform_data);
 296         pdev->dev.platform_data = d;
 297         return 0;
 298 }
 299 EXPORT_SYMBOL_GPL(platform_device_add_data);
 300
 301 /**
 302  * platform_device_add - add a platform device to device hierarchy
 303  * @pdev: platform device we're adding
 304  *
 305  * This is part 2 of platform_device_register(), though may be called
 306  * separately _iff_ pdev was allocated by platform_device_alloc().
 307  */
 308 int platform_device_add(struct platform_device *pdev)
 309 {
 310         int i, ret;
 311
 312         if (!pdev)
 313                 return -EINVAL;
 314
 315         if (!pdev->dev.parent)
 316                 pdev->dev.parent = &platform_bus;
 317
 318         pdev->dev.bus = &platform_bus_type;
 319
 320         switch (pdev->id) {
 321         default:
 322                 dev_set_name(&pdev->dev, "%s.%d", pdev->name,  pdev->id);
 323                 break;
 324         case PLATFORM_DEVID_NONE:
 325                 dev_set_name(&pdev->dev, "%s", pdev->name);
 326                 break;
 327         case PLATFORM_DEVID_AUTO:
 328                 /*
 329                  * Automatically allocated device ID. We mark it as such so
 330                  * that we remember it must be freed, and we append a suffix
 331                  * to avoid namespace collision with explicit IDs.
 332                  */
 333                 ret = ida_simple_get(&platform_devid_ida, 0, 0, GFP_KERNEL);
 334                 if (ret < 0)
 335                         goto err_out;
 336                 pdev->id = ret;
 337                 pdev->id_auto = true;
 338                 dev_set_name(&pdev->dev, "%s.%d.auto", pdev->name, pdev->id);
 339                 break;
 340         }
 341
 342         for (i = 0; i < pdev->num_resources; i++) {
 343                 struct resource *p, *r = &pdev->resource[i];
 344
 345                 if (r->name == NULL)
 346                         r->name = dev_name(&pdev->dev);
 347
 348                 p = r->parent;
 349                 if (!p) {
 350                         if (resource_type(r) == IORESOURCE_MEM)
 351                                 p = &iomem_resource;
 352                         else if (resource_type(r) == IORESOURCE_IO)
 353                                 p = &ioport_resource;
 354                 }
 355
 356                 if (p && insert_resource(p, r)) {
 357                         dev_err(&pdev->dev, "failed to claim resource %d\n", i);
 358                         ret = -EBUSY;
 359                         goto failed;
 360                 }
 361         }
 362
 363         pr_debug("Registering platform device '%s'. Parent at %s\n",
 364                  dev_name(&pdev->dev), dev_name(pdev->dev.parent));
 365
 366         ret = device_add(&pdev->dev);
 367         if (ret == 0)
 368                 return ret;
 369
 370  failed:
 371         if (pdev->id_auto) {
 372                 ida_simple_remove(&platform_devid_ida, pdev->id);
 373                 pdev->id = PLATFORM_DEVID_AUTO;
 374         }
 375
 376         while (--i >= 0) {
 377                 struct resource *r = &pdev->resource[i];
 378                 if (r->parent)
 379                         release_resource(r);
 380         }
 381
 382  err_out:
 383         return ret;
 384 }
 385 EXPORT_SYMBOL_GPL(platform_device_add);
 386
 387 /**
 388  * platform_device_del - remove a platform-level device
 389  * @pdev: platform device we're removing
 390  *
 391  * Note that this function will also release all memory- and port-based
 392  * resources owned by the device (@dev->resource).  This function must
 393  * _only_ be externally called in error cases.  All other usage is a bug.
 394  */
 395 void platform_device_del(struct platform_device *pdev)
 396 {
 397         int i;
 398
 399         if (pdev) {
 400                 device_del(&pdev->dev);
 401
 402                 if (pdev->id_auto) {
 403                         ida_simple_remove(&platform_devid_ida, pdev->id);
 404                         pdev->id = PLATFORM_DEVID_AUTO;
 405                 }
 406
 407                 for (i = 0; i < pdev->num_resources; i++) {
 408                         struct resource *r = &pdev->resource[i];
 409                         if (r->parent)
 410                                 release_resource(r);
 411                 }
 412         }
 413 }
 414 EXPORT_SYMBOL_GPL(platform_device_del);
 415
 416 /**
 417  * platform_device_register - add a platform-level device
 418  * @pdev: platform device we're adding
 419  */
 420 int platform_device_register(struct platform_device *pdev)
 421 {
 422         device_initialize(&pdev->dev);
 423         arch_setup_pdev_archdata(pdev);
 424         return platform_device_add(pdev);
 425 }
 426 EXPORT_SYMBOL_GPL(platform_device_register);
 427
 428 /**
 429  * platform_device_unregister - unregister a platform-level device
 430  * @pdev: platform device we're unregistering
 431  *
 432  * Unregistration is done in 2 steps. First we release all resources
 433  * and remove it from the subsystem, then we drop reference count by
 434  * calling platform_device_put().
 435  */
 436 void platform_device_unregister(struct platform_device *pdev)
 437 {
 438         platform_device_del(pdev);
 439         platform_device_put(pdev);
 440 }
 441 EXPORT_SYMBOL_GPL(platform_device_unregister);
 442
 443 /**
 444  * platform_device_register_full - add a platform-level device with
 445  * resources and platform-specific data
 446  *
 447  * @pdevinfo: data used to create device
 448  *
 449  * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
 450  */
 451 struct platform_device *platform_device_register_full(
 452                 const struct platform_device_info *pdevinfo)
 453 {
 454         int ret = -ENOMEM;
 455         struct platform_device *pdev;
 456
 457         pdev = platform_device_alloc(pdevinfo->name, pdevinfo->id);
 458         if (!pdev)
 459                 goto err_alloc;
 460
 461         pdev->dev.parent = pdevinfo->parent;
 462         pdev->dev.fwnode = pdevinfo->fwnode;
 463
 464         if (pdevinfo->dma_mask) {
 465                 /*
 466                  * This memory isn't freed when the device is put,
 467                  * I don't have a nice idea for that though.  Conceptually
 468                  * dma_mask in struct device should not be a pointer.
 469                  * See http://thread.gmane.org/gmane.linux.kernel.pci/9081
 470                  */
 471                 pdev->dev.dma_mask =
 472                         kmalloc(sizeof(*pdev->dev.dma_mask), GFP_KERNEL);
 473                 if (!pdev->dev.dma_mask)
 474                         goto err;
 475
 476                 *pdev->dev.dma_mask = pdevinfo->dma_mask;
 477                 pdev->dev.coherent_dma_mask = pdevinfo->dma_mask;
 478         }
 479
 480         ret = platform_device_add_resources(pdev,
 481                         pdevinfo->res, pdevinfo->num_res);
 482         if (ret)
 483                 goto err;
 484
 485         ret = platform_device_add_data(pdev,
 486                         pdevinfo->data, pdevinfo->size_data);
 487         if (ret)
 488                 goto err;
 489
 490         ret = platform_device_add(pdev);
 491         if (ret) {
 492 err:
 493                 ACPI_COMPANION_SET(&pdev->dev, NULL);
 494                 kfree(pdev->dev.dma_mask);
 495
 496 err_alloc:
 497                 platform_device_put(pdev);
 498                 return ERR_PTR(ret);
 499         }
 500
 501         return pdev;
 502 }
 503 EXPORT_SYMBOL_GPL(platform_device_register_full);
 504
 505 static int platform_drv_probe(struct device *_dev)
 506 {
 507         struct platform_driver *drv = to_platform_driver(_dev->driver);
 508         struct platform_device *dev = to_platform_device(_dev);
 509         int ret;
 510
 511         ret = of_clk_set_defaults(_dev->of_node, false);
 512         if (ret < 0)
 513                 return ret;
 514
 515         ret = dev_pm_domain_attach(_dev, true);
 516         if (ret != -EPROBE_DEFER) {
 517                 if (drv->probe) {
 518                         ret = drv->probe(dev);
 519                         if (ret)
 520                                 dev_pm_domain_detach(_dev, true);
 521                 } else {
 522                         /* don't fail if just dev_pm_domain_attach failed */
 523                         ret = 0;
 524                 }
 525         }
 526
 527         if (drv->prevent_deferred_probe && ret == -EPROBE_DEFER) {
 528                 dev_warn(_dev, "probe deferral not supported\n");
 529                 ret = -ENXIO;
 530         }
 531
 532         return ret;
 533 }
 534
 535 static int platform_drv_probe_fail(struct device *_dev)
 536 {
 537         return -ENXIO;
 538 }
 539
 540 static int platform_drv_remove(struct device *_dev)
 541 {
 542         struct platform_driver *drv = to_platform_driver(_dev->driver);
 543         struct platform_device *dev = to_platform_device(_dev);
 544         int ret = 0;
 545
 546         if (drv->remove)
 547                 ret = drv->remove(dev);
 548         dev_pm_domain_detach(_dev, true);
 549
 550         return ret;
 551 }
 552
 553 static void platform_drv_shutdown(struct device *_dev)
 554 {
 555         struct platform_driver *drv = to_platform_driver(_dev->driver);
 556         struct platform_device *dev = to_platform_device(_dev);
 557
 558         if (drv->shutdown)
 559                 drv->shutdown(dev);
 560 }
 561
 562 /**
 563  * __platform_driver_register - register a driver for platform-level devices
 564  * @drv: platform driver structure
 565  * @owner: owning module/driver
 566  */
 567 int __platform_driver_register(struct platform_driver *drv,
 568                                 struct module *owner)
 569 {
 570         drv->driver.owner = owner;
 571         drv->driver.bus = &platform_bus_type;
 572         drv->driver.probe = platform_drv_probe;
 573         drv->driver.remove = platform_drv_remove;
 574         drv->driver.shutdown = platform_drv_shutdown;
 575
 576         return driver_register(&drv->driver);
 577 }
 578 EXPORT_SYMBOL_GPL(__platform_driver_register);
 579
 580 /**
 581  * platform_driver_unregister - unregister a driver for platform-level devices
 582  * @drv: platform driver structure
 583  */
 584 void platform_driver_unregister(struct platform_driver *drv)
 585 {
 586         driver_unregister(&drv->driver);
 587 }
 588 EXPORT_SYMBOL_GPL(platform_driver_unregister);
 589
 590 /**
 591  * __platform_driver_probe - register driver for non-hotpluggable device
 592  * @drv: platform driver structure
 593  * @probe: the driver probe routine, probably from an __init section
 594  * @module: module which will be the owner of the driver
 595  *
 596  * Use this instead of platform_driver_register() when you know the device
 597  * is not hotpluggable and has already been registered, and you want to
 598  * remove its run-once probe() infrastructure from memory after the driver
 599  * has bound to the device.
 600  *
 601  * One typical use for this would be with drivers for controllers integrated
 602  * into system-on-chip processors, where the controller devices have been
 603  * configured as part of board setup.
 604  *
 605  * Note that this is incompatible with deferred probing.
 606  *
 607  * Returns zero if the driver registered and bound to a device, else returns
 608  * a negative error code and with the driver not registered.
 609  */
 610 int __init_or_module __platform_driver_probe(struct platform_driver *drv,
 611                 int (*probe)(struct platform_device *), struct module *module)
 612 {
 613         int retval, code;
 614
 615         if (drv->driver.probe_type == PROBE_PREFER_ASYNCHRONOUS) {
 616                 pr_err("%s: drivers registered with %s can not be probed asynchronously\n",
 617                          drv->driver.name, __func__);
 618                 return -EINVAL;
 619         }
 620
 621         /*
 622          * We have to run our probes synchronously because we check if
 623          * we find any devices to bind to and exit with error if there
 624          * are any.
 625          */
 626         drv->driver.probe_type = PROBE_FORCE_SYNCHRONOUS;
 627
 628         /*
 629          * Prevent driver from requesting probe deferral to avoid further
 630          * futile probe attempts.
 631          */
 632         drv->prevent_deferred_probe = true;
 633
 634         /* make sure driver won't have bind/unbind attributes */
 635         drv->driver.suppress_bind_attrs = true;
 636
 637         /* temporary section violation during probe() */
 638         drv->probe = probe;
 639         retval = code = __platform_driver_register(drv, module);
 640
 641         /*
 642          * Fixup that section violation, being paranoid about code scanning
 643          * the list of drivers in order to probe new devices.  Check to see
 644          * if the probe was successful, and make sure any forced probes of
 645          * new devices fail.
 646          */
 647         spin_lock(&drv->driver.bus->p->klist_drivers.k_lock);
 648         drv->probe = NULL;
 649         if (code == 0 && list_empty(&drv->driver.p->klist_devices.k_list))
 650                 retval = -ENODEV;
 651         drv->driver.probe = platform_drv_probe_fail;
 652         spin_unlock(&drv->driver.bus->p->klist_drivers.k_lock);
 653
 654         if (code != retval)
 655                 platform_driver_unregister(drv);
 656         return retval;
 657 }
 658 EXPORT_SYMBOL_GPL(__platform_driver_probe);
 659
 660 /**
 661  * __platform_create_bundle - register driver and create corresponding device
 662  * @driver: platform driver structure
 663  * @probe: the driver probe routine, probably from an __init section
 664  * @res: set of resources that needs to be allocated for the device
 665  * @n_res: number of resources
 666  * @data: platform specific data for this platform device
 667  * @size: size of platform specific data
 668  * @module: module which will be the owner of the driver
 669  *
 670  * Use this in legacy-style modules that probe hardware directly and
 671  * register a single platform device and corresponding platform driver.
 672  *
 673  * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
 674  */
 675 struct platform_device * __init_or_module __platform_create_bundle(
 676                         struct platform_driver *driver,
 677                         int (*probe)(struct platform_device *),
 678                         struct resource *res, unsigned int n_res,
 679                         const void *data, size_t size, struct module *module)
 680 {
 681         struct platform_device *pdev;
 682         int error;
 683
 684         pdev = platform_device_alloc(driver->driver.name, -1);
 685         if (!pdev) {
 686                 error = -ENOMEM;
 687                 goto err_out;
 688         }
 689
 690         error = platform_device_add_resources(pdev, res, n_res);
 691         if (error)
 692                 goto err_pdev_put;
 693
 694         error = platform_device_add_data(pdev, data, size);
 695         if (error)
 696                 goto err_pdev_put;
 697
 698         error = platform_device_add(pdev);
 699         if (error)
 700                 goto err_pdev_put;
 701
 702         error = __platform_driver_probe(driver, probe, module);
 703         if (error)
 704                 goto err_pdev_del;
 705
 706         return pdev;
 707
 708 err_pdev_del:
 709         platform_device_del(pdev);
 710 err_pdev_put:
 711         platform_device_put(pdev);
 712 err_out:
 713         return ERR_PTR(error);
 714 }
 715 EXPORT_SYMBOL_GPL(__platform_create_bundle);
 716
 717 /**
 718  * __platform_register_drivers - register an array of platform drivers
 719  * @drivers: an array of drivers to register
 720  * @count: the number of drivers to register
 721  * @owner: module owning the drivers
 722  *
 723  * Registers platform drivers specified by an array. On failure to register a
 724  * driver, all previously registered drivers will be unregistered. Callers of
 725  * this API should use platform_unregister_drivers() to unregister drivers in
 726  * the reverse order.
 727  *
 728  * Returns: 0 on success or a negative error code on failure.
 729  */
 730 int __platform_register_drivers(struct platform_driver * const *drivers,
 731                                 unsigned int count, struct module *owner)
 732 {
 733         unsigned int i;
 734         int err;
 735
 736         for (i = 0; i < count; i++) {
 737                 pr_debug("registering platform driver %ps\n", drivers[i]);
 738
 739                 err = __platform_driver_register(drivers[i], owner);
 740                 if (err < 0) {
 741                         pr_err("failed to register platform driver %ps: %d\n",
 742                                drivers[i], err);
 743                         goto error;
 744                 }
 745         }
 746
 747         return 0;
 748
 749 error:
 750         while (i--) {
 751                 pr_debug("unregistering platform driver %ps\n", drivers[i]);
 752                 platform_driver_unregister(drivers[i]);
 753         }
 754
 755         return err;
 756 }
 757 EXPORT_SYMBOL_GPL(__platform_register_drivers);
 758
 759 /**
 760  * platform_unregister_drivers - unregister an array of platform drivers
 761  * @drivers: an array of drivers to unregister
 762  * @count: the number of drivers to unregister
 763  *
 764  * Unegisters platform drivers specified by an array. This is typically used
 765  * to complement an earlier call to platform_register_drivers(). Drivers are
 766  * unregistered in the reverse order in which they were registered.
 767  */
 768 void platform_unregister_drivers(struct platform_driver * const *drivers,
 769                                  unsigned int count)
 770 {
 771         while (count--) {
 772                 pr_debug("unregistering platform driver %ps\n", drivers[count]);
 773                 platform_driver_unregister(drivers[count]);
 774         }
 775 }
 776 EXPORT_SYMBOL_GPL(platform_unregister_drivers);
 777
 778 /* modalias support enables more hands-off userspace setup:
 779  * (a) environment variable lets new-style hotplug events work once system is
 780  *     fully running:  "modprobe $MODALIAS"
 781  * (b) sysfs attribute lets new-style coldplug recover from hotplug events
 782  *     mishandled before system is fully running:  "modprobe $(cat modalias)"
 783  */
 784 static ssize_t modalias_show(struct device *dev, struct device_attribute *a,
 785                              char *buf)
 786 {
 787         struct platform_device  *pdev = to_platform_device(dev);
 788         int len;
 789
 790         len = of_device_get_modalias(dev, buf, PAGE_SIZE -1);
 791         if (len != -ENODEV)
 792                 return len;
 793
 794         len = acpi_device_modalias(dev, buf, PAGE_SIZE -1);
 795         if (len != -ENODEV)
 796                 return len;
 797
 798         len = snprintf(buf, PAGE_SIZE, "platform:%s\n", pdev->name);
 799
 800         return (len >= PAGE_SIZE) ? (PAGE_SIZE - 1) : len;
 801 }
 802 static DEVICE_ATTR_RO(modalias);
 803
 804 static ssize_t driver_override_store(struct device *dev,
 805                                      struct device_attribute *attr,
 806                                      const char *buf, size_t count)
 807 {
 808         struct platform_device *pdev = to_platform_device(dev);
 809         char *driver_override, *old = pdev->driver_override, *cp;
 810
 811         if (count > PATH_MAX)
 812                 return -EINVAL;
 813
 814         driver_override = kstrndup(buf, count, GFP_KERNEL);
 815         if (!driver_override)
 816                 return -ENOMEM;
 817
 818         cp = strchr(driver_override, '\n');
 819         if (cp)
 820                 *cp = '\0';
 821
 822         if (strlen(driver_override)) {
 823                 pdev->driver_override = driver_override;
 824         } else {
 825                 kfree(driver_override);
 826                 pdev->driver_override = NULL;
 827         }
 828
 829         kfree(old);
 830
 831         return count;
 832 }
 833
 834 static ssize_t driver_override_show(struct device *dev,
 835                                     struct device_attribute *attr, char *buf)
 836 {
 837         struct platform_device *pdev = to_platform_device(dev);
 838
 839         return sprintf(buf, "%s\n", pdev->driver_override);
 840 }
 841 static DEVICE_ATTR_RW(driver_override);
 842
 843
 844 static struct attribute *platform_dev_attrs[] = {
 845         &dev_attr_modalias.attr,
 846         &dev_attr_driver_override.attr,
 847         NULL,
 848 };
 849 ATTRIBUTE_GROUPS(platform_dev);
 850
 851 static int platform_uevent(struct device *dev, struct kobj_uevent_env *env)
 852 {
 853         struct platform_device  *pdev = to_platform_device(dev);
 854         int rc;
 855
 856         /* Some devices have extra OF data and an OF-style MODALIAS */
 857         rc = of_device_uevent_modalias(dev, env);
 858         if (rc != -ENODEV)
 859                 return rc;
 860
 861         rc = acpi_device_uevent_modalias(dev, env);
 862         if (rc != -ENODEV)
 863                 return rc;
 864
 865         add_uevent_var(env, "MODALIAS=%s%s", PLATFORM_MODULE_PREFIX,
 866                         pdev->name);
 867         return 0;
 868 }
 869
 870 static const struct platform_device_id *platform_match_id(
 871                         const struct platform_device_id *id,
 872                         struct platform_device *pdev)
 873 {
 874         while (id->name[0]) {
 875                 if (strcmp(pdev->name, id->name) == 0) {
 876                         pdev->id_entry = id;
 877                         return id;
 878                 }
 879                 id++;
 880         }
 881         return NULL;
 882 }
 883
 884 /**
 885  * platform_match - bind platform device to platform driver.
 886  * @dev: device.
 887  * @drv: driver.
 888  *
 889  * Platform device IDs are assumed to be encoded like this:
 890  * "<name><instance>", where <name> is a short description of the type of
 891  * device, like "pci" or "floppy", and <instance> is the enumerated
 892  * instance of the device, like '0' or '42'.  Driver IDs are simply
 893  * "<name>".  So, extract the <name> from the platform_device structure,
 894  * and compare it against the name of the driver. Return whether they match
 895  * or not.
 896  */
 897 static int platform_match(struct device *dev, struct device_driver *drv)
 898 {
 899         struct platform_device *pdev = to_platform_device(dev);
 900         struct platform_driver *pdrv = to_platform_driver(drv);
 901
 902         /* When driver_override is set, only bind to the matching driver */
 903         if (pdev->driver_override)
 904                 return !strcmp(pdev->driver_override, drv->name);
 905
 906         /* Attempt an OF style match first */
 907         if (of_driver_match_device(dev, drv))
 908                 return 1;
 909
 910         /* Then try ACPI style match */
 911         if (acpi_driver_match_device(dev, drv))
 912                 return 1;
 913
 914         /* Then try to match against the id table */
 915         if (pdrv->id_table)
 916                 return platform_match_id(pdrv->id_table, pdev) != NULL;
 917
 918         /* fall-back to driver name match */
 919         return (strcmp(pdev->name, drv->name) == 0);
 920 }
 921
 922 #ifdef CONFIG_PM_SLEEP
 923
 924 static int platform_legacy_suspend(struct device *dev, pm_message_t mesg)
 925 {
 926         struct platform_driver *pdrv = to_platform_driver(dev->driver);
 927         struct platform_device *pdev = to_platform_device(dev);
 928         int ret = 0;
 929
 930         if (dev->driver && pdrv->suspend)
 931                 ret = pdrv->suspend(pdev, mesg);
 932
 933         return ret;
 934 }
 935
 936 static int platform_legacy_resume(struct device *dev)
 937 {
 938         struct platform_driver *pdrv = to_platform_driver(dev->driver);
 939         struct platform_device *pdev = to_platform_device(dev);
 940         int ret = 0;
 941
 942         if (dev->driver && pdrv->resume)
 943                 ret = pdrv->resume(pdev);
 944
 945         return ret;
 946 }
 947
 948 #endif /* CONFIG_PM_SLEEP */
 949
 950 #ifdef CONFIG_SUSPEND
 951
 952 int platform_pm_suspend(struct device *dev)
 953 {
 954         struct device_driver *drv = dev->driver;
 955         int ret = 0;
 956
 957         if (!drv)
 958                 return 0;
 959
 960         if (drv->pm) {
 961                 if (drv->pm->suspend)
 962                         ret = drv->pm->suspend(dev);
 963         } else {
 964                 ret = platform_legacy_suspend(dev, PMSG_SUSPEND);
 965         }
 966
 967         return ret;
 968 }
 969
 970 int platform_pm_resume(struct device *dev)
 971 {
 972         struct device_driver *drv = dev->driver;
 973         int ret = 0;
 974
 975         if (!drv)
 976                 return 0;
 977
 978         if (drv->pm) {
 979                 if (drv->pm->resume)
 980                         ret = drv->pm->resume(dev);
 981         } else {
 982                 ret = platform_legacy_resume(dev);
 983         }
 984
 985         return ret;
 986 }
 987
 988 #endif /* CONFIG_SUSPEND */
 989
 990 #ifdef CONFIG_HIBERNATE_CALLBACKS
 991
 992 int platform_pm_freeze(struct device *dev)
 993 {
 994         struct device_driver *drv = dev->driver;
 995         int ret = 0;
 996
 997         if (!drv)
 998                 return 0;
 999
1000         if (drv->pm) {
1001                 if (drv->pm->freeze)
1002                         ret = drv->pm->freeze(dev);
1003         } else {
1004                 ret = platform_legacy_suspend(dev, PMSG_FREEZE);
1005         }
1006
1007         return ret;
1008 }
1009
1010 int platform_pm_thaw(struct device *dev)
1011 {
1012         struct device_driver *drv = dev->driver;
1013         int ret = 0;
1014
1015         if (!drv)
1016                 return 0;
1017
1018         if (drv->pm) {
1019                 if (drv->pm->thaw)
1020                         ret = drv->pm->thaw(dev);
1021         } else {
1022                 ret = platform_legacy_resume(dev);
1023         }
1024
1025         return ret;
1026 }
1027
1028 int platform_pm_poweroff(struct device *dev)
1029 {
1030         struct device_driver *drv = dev->driver;
1031         int ret = 0;
1032
1033         if (!drv)
1034                 return 0;
1035
1036         if (drv->pm) {
1037                 if (drv->pm->poweroff)
1038                         ret = drv->pm->poweroff(dev);
1039         } else {
1040                 ret = platform_legacy_suspend(dev, PMSG_HIBERNATE);
1041         }
1042
1043         return ret;
1044 }
1045
1046 int platform_pm_restore(struct device *dev)
1047 {
1048         struct device_driver *drv = dev->driver;
1049         int ret = 0;
1050
1051         if (!drv)
1052                 return 0;
1053
1054         if (drv->pm) {
1055                 if (drv->pm->restore)
1056                         ret = drv->pm->restore(dev);
1057         } else {
1058                 ret = platform_legacy_resume(dev);
1059         }
1060
1061         return ret;
1062 }
1063
1064 #endif /* CONFIG_HIBERNATE_CALLBACKS */
1065
1066 static const struct dev_pm_ops platform_dev_pm_ops = {
1067         .runtime_suspend = pm_generic_runtime_suspend,
1068         .runtime_resume = pm_generic_runtime_resume,
1069         USE_PLATFORM_PM_SLEEP_OPS
1070 };
1071
1072 struct bus_type platform_bus_type = {
1073         .name           = "platform",
1074         .dev_groups     = platform_dev_groups,
1075         .match          = platform_match,
1076         .uevent         = platform_uevent,
1077         .pm             = &platform_dev_pm_ops,
1078 };
1079 EXPORT_SYMBOL_GPL(platform_bus_type);
1080
1081 int __init platform_bus_init(void)
1082 {
1083         int error;
1084
1085         early_platform_cleanup();
1086
1087         error = device_register(&platform_bus);
1088         if (error)
1089                 return error;
1090         error =  bus_register(&platform_bus_type);
1091         if (error)
1092                 device_unregister(&platform_bus);
1093         of_platform_register_reconfig_notifier();
1094         return error;
1095 }
1096
1097 #ifndef ARCH_HAS_DMA_GET_REQUIRED_MASK
1098 u64 dma_get_required_mask(struct device *dev)
1099 {
1100         u32 low_totalram = ((max_pfn - 1) << PAGE_SHIFT);
1101         u32 high_totalram = ((max_pfn - 1) >> (32 - PAGE_SHIFT));
1102         u64 mask;
1103
1104         if (!high_totalram) {
1105                 /* convert to mask just covering totalram */
1106                 low_totalram = (1 << (fls(low_totalram) - 1));
1107                 low_totalram += low_totalram - 1;
1108                 mask = low_totalram;
1109         } else {
1110                 high_totalram = (1 << (fls(high_totalram) - 1));
1111                 high_totalram += high_totalram - 1;
1112                 mask = (((u64)high_totalram) << 32) + 0xffffffff;
1113         }
1114         return mask;
1115 }
1116 EXPORT_SYMBOL_GPL(dma_get_required_mask);
1117 #endif
1118
1119 static __initdata LIST_HEAD(early_platform_driver_list);
1120 static __initdata LIST_HEAD(early_platform_device_list);
1121
1122 /**
1123  * early_platform_driver_register - register early platform driver
1124  * @epdrv: early_platform driver structure
1125  * @buf: string passed from early_param()
1126  *
1127  * Helper function for early_platform_init() / early_platform_init_buffer()
1128  */
1129 int __init early_platform_driver_register(struct early_platform_driver *epdrv,
1130                                           char *buf)
1131 {
1132         char *tmp;
1133         int n;
1134
1135         /* Simply add the driver to the end of the global list.
1136          * Drivers will by default be put on the list in compiled-in order.
1137          */
1138         if (!epdrv->list.next) {
1139                 INIT_LIST_HEAD(&epdrv->list);
1140                 list_add_tail(&epdrv->list, &early_platform_driver_list);
1141         }
1142
1143         /* If the user has specified device then make sure the driver
1144          * gets prioritized. The driver of the last device specified on
1145          * command line will be put first on the list.
1146          */
1147         n = strlen(epdrv->pdrv->driver.name);
1148         if (buf && !strncmp(buf, epdrv->pdrv->driver.name, n)) {
1149                 list_move(&epdrv->list, &early_platform_driver_list);
1150
1151                 /* Allow passing parameters after device name */
1152                 if (buf[n] == '\0' || buf[n] == ',')
1153                         epdrv->requested_id = -1;
1154                 else {
1155                         epdrv->requested_id = simple_strtoul(&buf[n + 1],
1156                                                              &tmp, 10);
1157
1158                         if (buf[n] != '.' || (tmp == &buf[n + 1])) {
1159                                 epdrv->requested_id = EARLY_PLATFORM_ID_ERROR;
1160                                 n = 0;
1161                         } else
1162                                 n += strcspn(&buf[n + 1], ",") + 1;
1163                 }
1164
1165                 if (buf[n] == ',')
1166                         n++;
1167
1168                 if (epdrv->bufsize) {
1169                         memcpy(epdrv->buffer, &buf[n],
1170                                min_t(int, epdrv->bufsize, strlen(&buf[n]) + 1));
1171                         epdrv->buffer[epdrv->bufsize - 1] = '\0';
1172                 }
1173         }
1174
1175         return 0;
1176 }
1177
1178 /**
1179  * early_platform_add_devices - adds a number of early platform devices
1180  * @devs: array of early platform devices to add
1181  * @num: number of early platform devices in array
1182  *
1183  * Used by early architecture code to register early platform devices and
1184  * their platform data.
1185  */
1186 void __init early_platform_add_devices(struct platform_device **devs, int num)
1187 {
1188         struct device *dev;
1189         int i;
1190
1191         /* simply add the devices to list */
1192         for (i = 0; i < num; i++) {
1193                 dev = &devs[i]->dev;
1194
1195                 if (!dev->devres_head.next) {
1196                         pm_runtime_early_init(dev);
1197                         INIT_LIST_HEAD(&dev->devres_head);
1198                         list_add_tail(&dev->devres_head,
1199                                       &early_platform_device_list);
1200                 }
1201         }
1202 }
1203
1204 /**
1205  * early_platform_driver_register_all - register early platform drivers
1206  * @class_str: string to identify early platform driver class
1207  *
1208  * Used by architecture code to register all early platform drivers
1209  * for a certain class. If omitted then only early platform drivers
1210  * with matching kernel command line class parameters will be registered.
1211  */
1212 void __init early_platform_driver_register_all(char *class_str)
1213 {
1214         /* The "class_str" parameter may or may not be present on the kernel
1215          * command line. If it is present then there may be more than one
1216          * matching parameter.
1217          *
1218          * Since we register our early platform drivers using early_param()
1219          * we need to make sure that they also get registered in the case
1220          * when the parameter is missing from the kernel command line.
1221          *
1222          * We use parse_early_options() to make sure the early_param() gets
1223          * called at least once. The early_param() may be called more than
1224          * once since the name of the preferred device may be specified on
1225          * the kernel command line. early_platform_driver_register() handles
1226          * this case for us.
1227          */
1228         parse_early_options(class_str);
1229 }
1230
1231 /**
1232  * early_platform_match - find early platform device matching driver
1233  * @epdrv: early platform driver structure
1234  * @id: id to match against
1235  */
1236 static struct platform_device * __init
1237 early_platform_match(struct early_platform_driver *epdrv, int id)
1238 {
1239         struct platform_device *pd;
1240
1241         list_for_each_entry(pd, &early_platform_device_list, dev.devres_head)
1242                 if (platform_match(&pd->dev, &epdrv->pdrv->driver))
1243                         if (pd->id == id)
1244                                 return pd;
1245
1246         return NULL;
1247 }
1248
1249 /**
1250  * early_platform_left - check if early platform driver has matching devices
1251  * @epdrv: early platform driver structure
1252  * @id: return true if id or above exists
1253  */
1254 static int __init early_platform_left(struct early_platform_driver *epdrv,
1255                                        int id)
1256 {
1257         struct platform_device *pd;
1258
1259         list_for_each_entry(pd, &early_platform_device_list, dev.devres_head)
1260                 if (platform_match(&pd->dev, &epdrv->pdrv->driver))
1261                         if (pd->id >= id)
1262                                 return 1;
1263
1264         return 0;
1265 }
1266
1267 /**
1268  * early_platform_driver_probe_id - probe drivers matching class_str and id
1269  * @class_str: string to identify early platform driver class
1270  * @id: id to match against
1271  * @nr_probe: number of platform devices to successfully probe before exiting
1272  */
1273 static int __init early_platform_driver_probe_id(char *class_str,
1274                                                  int id,
1275                                                  int nr_probe)
1276 {
1277         struct early_platform_driver *epdrv;
1278         struct platform_device *match;
1279         int match_id;
1280         int n = 0;
1281         int left = 0;
1282
1283         list_for_each_entry(epdrv, &early_platform_driver_list, list) {
1284                 /* only use drivers matching our class_str */
1285                 if (strcmp(class_str, epdrv->class_str))
1286                         continue;
1287
1288                 if (id == -2) {
1289                         match_id = epdrv->requested_id;
1290                         left = 1;
1291
1292                 } else {
1293                         match_id = id;
1294                         left += early_platform_left(epdrv, id);
1295
1296                         /* skip requested id */
1297                         switch (epdrv->requested_id) {
1298                         case EARLY_PLATFORM_ID_ERROR:
1299                         case EARLY_PLATFORM_ID_UNSET:
1300                                 break;
1301                         default:
1302                                 if (epdrv->requested_id == id)
1303                                         match_id = EARLY_PLATFORM_ID_UNSET;
1304                         }
1305                 }
1306
1307                 switch (match_id) {
1308                 case EARLY_PLATFORM_ID_ERROR:
1309                         pr_warn("%s: unable to parse %s parameter\n",
1310                                 class_str, epdrv->pdrv->driver.name);
1311                         /* fall-through */
1312                 case EARLY_PLATFORM_ID_UNSET:
1313                         match = NULL;
1314                         break;
1315                 default:
1316                         match = early_platform_match(epdrv, match_id);
1317                 }
1318
1319                 if (match) {
1320                         /*
1321                          * Set up a sensible init_name to enable
1322                          * dev_name() and others to be used before the
1323                          * rest of the driver core is initialized.
1324                          */
1325                         if (!match->dev.init_name && slab_is_available()) {
1326                                 if (match->id != -1)
1327                                         match->dev.init_name =
1328                                                 kasprintf(GFP_KERNEL, "%s.%d",
1329                                                           match->name,
1330                                                           match->id);
1331                                 else
1332                                         match->dev.init_name =
1333                                                 kasprintf(GFP_KERNEL, "%s",
1334                                                           match->name);
1335
1336                                 if (!match->dev.init_name)
1337                                         return -ENOMEM;
1338                         }
1339
1340                         if (epdrv->pdrv->probe(match))
1341                                 pr_warn("%s: unable to probe %s early.\n",
1342                                         class_str, match->name);
1343                         else
1344                                 n++;
1345                 }
1346
1347                 if (n >= nr_probe)
1348                         break;
1349         }
1350
1351         if (left)
1352                 return n;
1353         else
1354                 return -ENODEV;
1355 }
1356
1357 /**
1358  * early_platform_driver_probe - probe a class of registered drivers
1359  * @class_str: string to identify early platform driver class
1360  * @nr_probe: number of platform devices to successfully probe before exiting
1361  * @user_only: only probe user specified early platform devices
1362  *
1363  * Used by architecture code to probe registered early platform drivers
1364  * within a certain class. For probe to happen a registered early platform
1365  * device matching a registered early platform driver is needed.
1366  */
1367 int __init early_platform_driver_probe(char *class_str,
1368                                        int nr_probe,
1369                                        int user_only)
1370 {
1371         int k, n, i;
1372
1373         n = 0;
1374         for (i = -2; n < nr_probe; i++) {
1375                 k = early_platform_driver_probe_id(class_str, i, nr_probe - n);
1376
1377                 if (k < 0)
1378                         break;
1379
1380                 n += k;
1381
1382                 if (user_only)
1383                         break;
1384         }
1385
1386         return n;
1387 }
1388
1389 /**
1390  * early_platform_cleanup - clean up early platform code
1391  */
1392 void __init early_platform_cleanup(void)
1393 {
1394         struct platform_device *pd, *pd2;
1395
1396         /* clean up the devres list used to chain devices */
1397         list_for_each_entry_safe(pd, pd2, &early_platform_device_list,
1398                                  dev.devres_head) {
1399                 list_del(&pd->dev.devres_head);
1400                 memset(&pd->dev.devres_head, 0, sizeof(pd->dev.devres_head));
1401         }
1402 }
1403