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                 unsigned long type = resource_type(r);
 345
 346                 if (r->name == NULL)
 347                         r->name = dev_name(&pdev->dev);
 348
 349                 if (!(type == IORESOURCE_MEM || type == IORESOURCE_IO))
 350                         continue;
 351
 352                 p = r->parent;
 353                 if (!p) {
 354                         if (type == IORESOURCE_MEM)
 355                                 p = &iomem_resource;
 356                         else if (type == IORESOURCE_IO)
 357                                 p = &ioport_resource;
 358                 }
 359
 360                 if (insert_resource(p, r)) {
 361                         dev_err(&pdev->dev, "failed to claim resource %d\n", i);
 362                         ret = -EBUSY;
 363                         goto failed;
 364                 }
 365         }
 366
 367         pr_debug("Registering platform device '%s'. Parent at %s\n",
 368                  dev_name(&pdev->dev), dev_name(pdev->dev.parent));
 369
 370         ret = device_add(&pdev->dev);
 371         if (ret == 0)
 372                 return ret;
 373
 374  failed:
 375         if (pdev->id_auto) {
 376                 ida_simple_remove(&platform_devid_ida, pdev->id);
 377                 pdev->id = PLATFORM_DEVID_AUTO;
 378         }
 379
 380         while (--i >= 0) {
 381                 struct resource *r = &pdev->resource[i];
 382                 unsigned long type = resource_type(r);
 383
 384                 if (type == IORESOURCE_MEM || type == IORESOURCE_IO)
 385                         release_resource(r);
 386         }
 387
 388  err_out:
 389         return ret;
 390 }
 391 EXPORT_SYMBOL_GPL(platform_device_add);
 392
 393 /**
 394  * platform_device_del - remove a platform-level device
 395  * @pdev: platform device we're removing
 396  *
 397  * Note that this function will also release all memory- and port-based
 398  * resources owned by the device (@dev->resource).  This function must
 399  * _only_ be externally called in error cases.  All other usage is a bug.
 400  */
 401 void platform_device_del(struct platform_device *pdev)
 402 {
 403         int i;
 404
 405         if (pdev) {
 406                 device_del(&pdev->dev);
 407
 408                 if (pdev->id_auto) {
 409                         ida_simple_remove(&platform_devid_ida, pdev->id);
 410                         pdev->id = PLATFORM_DEVID_AUTO;
 411                 }
 412
 413                 for (i = 0; i < pdev->num_resources; i++) {
 414                         struct resource *r = &pdev->resource[i];
 415                         unsigned long type = resource_type(r);
 416
 417                         if (type == IORESOURCE_MEM || type == IORESOURCE_IO)
 418                                 release_resource(r);
 419                 }
 420         }
 421 }
 422 EXPORT_SYMBOL_GPL(platform_device_del);
 423
 424 /**
 425  * platform_device_register - add a platform-level device
 426  * @pdev: platform device we're adding
 427  */
 428 int platform_device_register(struct platform_device *pdev)
 429 {
 430         device_initialize(&pdev->dev);
 431         arch_setup_pdev_archdata(pdev);
 432         return platform_device_add(pdev);
 433 }
 434 EXPORT_SYMBOL_GPL(platform_device_register);
 435
 436 /**
 437  * platform_device_unregister - unregister a platform-level device
 438  * @pdev: platform device we're unregistering
 439  *
 440  * Unregistration is done in 2 steps. First we release all resources
 441  * and remove it from the subsystem, then we drop reference count by
 442  * calling platform_device_put().
 443  */
 444 void platform_device_unregister(struct platform_device *pdev)
 445 {
 446         platform_device_del(pdev);
 447         platform_device_put(pdev);
 448 }
 449 EXPORT_SYMBOL_GPL(platform_device_unregister);
 450
 451 /**
 452  * platform_device_register_full - add a platform-level device with
 453  * resources and platform-specific data
 454  *
 455  * @pdevinfo: data used to create device
 456  *
 457  * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
 458  */
 459 struct platform_device *platform_device_register_full(
 460                 const struct platform_device_info *pdevinfo)
 461 {
 462         int ret = -ENOMEM;
 463         struct platform_device *pdev;
 464
 465         pdev = platform_device_alloc(pdevinfo->name, pdevinfo->id);
 466         if (!pdev)
 467                 goto err_alloc;
 468
 469         pdev->dev.parent = pdevinfo->parent;
 470         pdev->dev.fwnode = pdevinfo->fwnode;
 471
 472         if (pdevinfo->dma_mask) {
 473                 /*
 474                  * This memory isn't freed when the device is put,
 475                  * I don't have a nice idea for that though.  Conceptually
 476                  * dma_mask in struct device should not be a pointer.
 477                  * See http://thread.gmane.org/gmane.linux.kernel.pci/9081
 478                  */
 479                 pdev->dev.dma_mask =
 480                         kmalloc(sizeof(*pdev->dev.dma_mask), GFP_KERNEL);
 481                 if (!pdev->dev.dma_mask)
 482                         goto err;
 483
 484                 *pdev->dev.dma_mask = pdevinfo->dma_mask;
 485                 pdev->dev.coherent_dma_mask = pdevinfo->dma_mask;
 486         }
 487
 488         ret = platform_device_add_resources(pdev,
 489                         pdevinfo->res, pdevinfo->num_res);
 490         if (ret)
 491                 goto err;
 492
 493         ret = platform_device_add_data(pdev,
 494                         pdevinfo->data, pdevinfo->size_data);
 495         if (ret)
 496                 goto err;
 497
 498         ret = platform_device_add(pdev);
 499         if (ret) {
 500 err:
 501                 ACPI_COMPANION_SET(&pdev->dev, NULL);
 502                 kfree(pdev->dev.dma_mask);
 503
 504 err_alloc:
 505                 platform_device_put(pdev);
 506                 return ERR_PTR(ret);
 507         }
 508
 509         return pdev;
 510 }
 511 EXPORT_SYMBOL_GPL(platform_device_register_full);
 512
 513 static int platform_drv_probe(struct device *_dev)
 514 {
 515         struct platform_driver *drv = to_platform_driver(_dev->driver);
 516         struct platform_device *dev = to_platform_device(_dev);
 517         int ret;
 518
 519         ret = of_clk_set_defaults(_dev->of_node, false);
 520         if (ret < 0)
 521                 return ret;
 522
 523         ret = dev_pm_domain_attach(_dev, true);
 524         if (ret != -EPROBE_DEFER) {
 525                 ret = drv->probe(dev);
 526                 if (ret)
 527                         dev_pm_domain_detach(_dev, true);
 528         }
 529
 530         if (drv->prevent_deferred_probe && ret == -EPROBE_DEFER) {
 531                 dev_warn(_dev, "probe deferral not supported\n");
 532                 ret = -ENXIO;
 533         }
 534
 535         return ret;
 536 }
 537
 538 static int platform_drv_probe_fail(struct device *_dev)
 539 {
 540         return -ENXIO;
 541 }
 542
 543 static int platform_drv_remove(struct device *_dev)
 544 {
 545         struct platform_driver *drv = to_platform_driver(_dev->driver);
 546         struct platform_device *dev = to_platform_device(_dev);
 547         int ret;
 548
 549         ret = drv->remove(dev);
 550         dev_pm_domain_detach(_dev, true);
 551
 552         return ret;
 553 }
 554
 555 static void platform_drv_shutdown(struct device *_dev)
 556 {
 557         struct platform_driver *drv = to_platform_driver(_dev->driver);
 558         struct platform_device *dev = to_platform_device(_dev);
 559
 560         drv->shutdown(dev);
 561         dev_pm_domain_detach(_dev, true);
 562 }
 563
 564 /**
 565  * __platform_driver_register - register a driver for platform-level devices
 566  * @drv: platform driver structure
 567  * @owner: owning module/driver
 568  */
 569 int __platform_driver_register(struct platform_driver *drv,
 570                                 struct module *owner)
 571 {
 572         drv->driver.owner = owner;
 573         drv->driver.bus = &platform_bus_type;
 574         if (drv->probe)
 575                 drv->driver.probe = platform_drv_probe;
 576         if (drv->remove)
 577                 drv->driver.remove = platform_drv_remove;
 578         if (drv->shutdown)
 579                 drv->driver.shutdown = platform_drv_shutdown;
 580
 581         return driver_register(&drv->driver);
 582 }
 583 EXPORT_SYMBOL_GPL(__platform_driver_register);
 584
 585 /**
 586  * platform_driver_unregister - unregister a driver for platform-level devices
 587  * @drv: platform driver structure
 588  */
 589 void platform_driver_unregister(struct platform_driver *drv)
 590 {
 591         driver_unregister(&drv->driver);
 592 }
 593 EXPORT_SYMBOL_GPL(platform_driver_unregister);
 594
 595 /**
 596  * __platform_driver_probe - register driver for non-hotpluggable device
 597  * @drv: platform driver structure
 598  * @probe: the driver probe routine, probably from an __init section
 599  * @module: module which will be the owner of the driver
 600  *
 601  * Use this instead of platform_driver_register() when you know the device
 602  * is not hotpluggable and has already been registered, and you want to
 603  * remove its run-once probe() infrastructure from memory after the driver
 604  * has bound to the device.
 605  *
 606  * One typical use for this would be with drivers for controllers integrated
 607  * into system-on-chip processors, where the controller devices have been
 608  * configured as part of board setup.
 609  *
 610  * Note that this is incompatible with deferred probing.
 611  *
 612  * Returns zero if the driver registered and bound to a device, else returns
 613  * a negative error code and with the driver not registered.
 614  */
 615 int __init_or_module __platform_driver_probe(struct platform_driver *drv,
 616                 int (*probe)(struct platform_device *), struct module *module)
 617 {
 618         int retval, code;
 619
 620         if (drv->driver.probe_type == PROBE_PREFER_ASYNCHRONOUS) {
 621                 pr_err("%s: drivers registered with %s can not be probed asynchronously\n",
 622                          drv->driver.name, __func__);
 623                 return -EINVAL;
 624         }
 625
 626         /*
 627          * We have to run our probes synchronously because we check if
 628          * we find any devices to bind to and exit with error if there
 629          * are any.
 630          */
 631         drv->driver.probe_type = PROBE_FORCE_SYNCHRONOUS;
 632
 633         /*
 634          * Prevent driver from requesting probe deferral to avoid further
 635          * futile probe attempts.
 636          */
 637         drv->prevent_deferred_probe = true;
 638
 639         /* make sure driver won't have bind/unbind attributes */
 640         drv->driver.suppress_bind_attrs = true;
 641
 642         /* temporary section violation during probe() */
 643         drv->probe = probe;
 644         retval = code = __platform_driver_register(drv, module);
 645
 646         /*
 647          * Fixup that section violation, being paranoid about code scanning
 648          * the list of drivers in order to probe new devices.  Check to see
 649          * if the probe was successful, and make sure any forced probes of
 650          * new devices fail.
 651          */
 652         spin_lock(&drv->driver.bus->p->klist_drivers.k_lock);
 653         drv->probe = NULL;
 654         if (code == 0 && list_empty(&drv->driver.p->klist_devices.k_list))
 655                 retval = -ENODEV;
 656         drv->driver.probe = platform_drv_probe_fail;
 657         spin_unlock(&drv->driver.bus->p->klist_drivers.k_lock);
 658
 659         if (code != retval)
 660                 platform_driver_unregister(drv);
 661         return retval;
 662 }
 663 EXPORT_SYMBOL_GPL(__platform_driver_probe);
 664
 665 /**
 666  * __platform_create_bundle - register driver and create corresponding device
 667  * @driver: platform driver structure
 668  * @probe: the driver probe routine, probably from an __init section
 669  * @res: set of resources that needs to be allocated for the device
 670  * @n_res: number of resources
 671  * @data: platform specific data for this platform device
 672  * @size: size of platform specific data
 673  * @module: module which will be the owner of the driver
 674  *
 675  * Use this in legacy-style modules that probe hardware directly and
 676  * register a single platform device and corresponding platform driver.
 677  *
 678  * Returns &struct platform_device pointer on success, or ERR_PTR() on error.
 679  */
 680 struct platform_device * __init_or_module __platform_create_bundle(
 681                         struct platform_driver *driver,
 682                         int (*probe)(struct platform_device *),
 683                         struct resource *res, unsigned int n_res,
 684                         const void *data, size_t size, struct module *module)
 685 {
 686         struct platform_device *pdev;
 687         int error;
 688
 689         pdev = platform_device_alloc(driver->driver.name, -1);
 690         if (!pdev) {
 691                 error = -ENOMEM;
 692                 goto err_out;
 693         }
 694
 695         error = platform_device_add_resources(pdev, res, n_res);
 696         if (error)
 697                 goto err_pdev_put;
 698
 699         error = platform_device_add_data(pdev, data, size);
 700         if (error)
 701                 goto err_pdev_put;
 702
 703         error = platform_device_add(pdev);
 704         if (error)
 705                 goto err_pdev_put;
 706
 707         error = __platform_driver_probe(driver, probe, module);
 708         if (error)
 709                 goto err_pdev_del;
 710
 711         return pdev;
 712
 713 err_pdev_del:
 714         platform_device_del(pdev);
 715 err_pdev_put:
 716         platform_device_put(pdev);
 717 err_out:
 718         return ERR_PTR(error);
 719 }
 720 EXPORT_SYMBOL_GPL(__platform_create_bundle);
 721
 722 /* modalias support enables more hands-off userspace setup:
 723  * (a) environment variable lets new-style hotplug events work once system is
 724  *     fully running:  "modprobe $MODALIAS"
 725  * (b) sysfs attribute lets new-style coldplug recover from hotplug events
 726  *     mishandled before system is fully running:  "modprobe $(cat modalias)"
 727  */
 728 static ssize_t modalias_show(struct device *dev, struct device_attribute *a,
 729                              char *buf)
 730 {
 731         struct platform_device  *pdev = to_platform_device(dev);
 732         int len;
 733
 734         len = of_device_get_modalias(dev, buf, PAGE_SIZE -1);
 735         if (len != -ENODEV)
 736                 return len;
 737
 738         len = acpi_device_modalias(dev, buf, PAGE_SIZE -1);
 739         if (len != -ENODEV)
 740                 return len;
 741
 742         len = snprintf(buf, PAGE_SIZE, "platform:%s\n", pdev->name);
 743
 744         return (len >= PAGE_SIZE) ? (PAGE_SIZE - 1) : len;
 745 }
 746 static DEVICE_ATTR_RO(modalias);
 747
 748 static ssize_t driver_override_store(struct device *dev,
 749                                      struct device_attribute *attr,
 750                                      const char *buf, size_t count)
 751 {
 752         struct platform_device *pdev = to_platform_device(dev);
 753         char *driver_override, *old = pdev->driver_override, *cp;
 754
 755         if (count > PATH_MAX)
 756                 return -EINVAL;
 757
 758         driver_override = kstrndup(buf, count, GFP_KERNEL);
 759         if (!driver_override)
 760                 return -ENOMEM;
 761
 762         cp = strchr(driver_override, '\n');
 763         if (cp)
 764                 *cp = '\0';
 765
 766         if (strlen(driver_override)) {
 767                 pdev->driver_override = driver_override;
 768         } else {
 769                 kfree(driver_override);
 770                 pdev->driver_override = NULL;
 771         }
 772
 773         kfree(old);
 774
 775         return count;
 776 }
 777
 778 static ssize_t driver_override_show(struct device *dev,
 779                                     struct device_attribute *attr, char *buf)
 780 {
 781         struct platform_device *pdev = to_platform_device(dev);
 782
 783         return sprintf(buf, "%s\n", pdev->driver_override);
 784 }
 785 static DEVICE_ATTR_RW(driver_override);
 786
 787
 788 static struct attribute *platform_dev_attrs[] = {
 789         &dev_attr_modalias.attr,
 790         &dev_attr_driver_override.attr,
 791         NULL,
 792 };
 793 ATTRIBUTE_GROUPS(platform_dev);
 794
 795 static int platform_uevent(struct device *dev, struct kobj_uevent_env *env)
 796 {
 797         struct platform_device  *pdev = to_platform_device(dev);
 798         int rc;
 799
 800         /* Some devices have extra OF data and an OF-style MODALIAS */
 801         rc = of_device_uevent_modalias(dev, env);
 802         if (rc != -ENODEV)
 803                 return rc;
 804
 805         rc = acpi_device_uevent_modalias(dev, env);
 806         if (rc != -ENODEV)
 807                 return rc;
 808
 809         add_uevent_var(env, "MODALIAS=%s%s", PLATFORM_MODULE_PREFIX,
 810                         pdev->name);
 811         return 0;
 812 }
 813
 814 static const struct platform_device_id *platform_match_id(
 815                         const struct platform_device_id *id,
 816                         struct platform_device *pdev)
 817 {
 818         while (id->name[0]) {
 819                 if (strcmp(pdev->name, id->name) == 0) {
 820                         pdev->id_entry = id;
 821                         return id;
 822                 }
 823                 id++;
 824         }
 825         return NULL;
 826 }
 827
 828 /**
 829  * platform_match - bind platform device to platform driver.
 830  * @dev: device.
 831  * @drv: driver.
 832  *
 833  * Platform device IDs are assumed to be encoded like this:
 834  * "<name><instance>", where <name> is a short description of the type of
 835  * device, like "pci" or "floppy", and <instance> is the enumerated
 836  * instance of the device, like '0' or '42'.  Driver IDs are simply
 837  * "<name>".  So, extract the <name> from the platform_device structure,
 838  * and compare it against the name of the driver. Return whether they match
 839  * or not.
 840  */
 841 static int platform_match(struct device *dev, struct device_driver *drv)
 842 {
 843         struct platform_device *pdev = to_platform_device(dev);
 844         struct platform_driver *pdrv = to_platform_driver(drv);
 845
 846         /* When driver_override is set, only bind to the matching driver */
 847         if (pdev->driver_override)
 848                 return !strcmp(pdev->driver_override, drv->name);
 849
 850         /* Attempt an OF style match first */
 851         if (of_driver_match_device(dev, drv))
 852                 return 1;
 853
 854         /* Then try ACPI style match */
 855         if (acpi_driver_match_device(dev, drv))
 856                 return 1;
 857
 858         /* Then try to match against the id table */
 859         if (pdrv->id_table)
 860                 return platform_match_id(pdrv->id_table, pdev) != NULL;
 861
 862         /* fall-back to driver name match */
 863         return (strcmp(pdev->name, drv->name) == 0);
 864 }
 865
 866 #ifdef CONFIG_PM_SLEEP
 867
 868 static int platform_legacy_suspend(struct device *dev, pm_message_t mesg)
 869 {
 870         struct platform_driver *pdrv = to_platform_driver(dev->driver);
 871         struct platform_device *pdev = to_platform_device(dev);
 872         int ret = 0;
 873
 874         if (dev->driver && pdrv->suspend)
 875                 ret = pdrv->suspend(pdev, mesg);
 876
 877         return ret;
 878 }
 879
 880 static int platform_legacy_resume(struct device *dev)
 881 {
 882         struct platform_driver *pdrv = to_platform_driver(dev->driver);
 883         struct platform_device *pdev = to_platform_device(dev);
 884         int ret = 0;
 885
 886         if (dev->driver && pdrv->resume)
 887                 ret = pdrv->resume(pdev);
 888
 889         return ret;
 890 }
 891
 892 #endif /* CONFIG_PM_SLEEP */
 893
 894 #ifdef CONFIG_SUSPEND
 895
 896 int platform_pm_suspend(struct device *dev)
 897 {
 898         struct device_driver *drv = dev->driver;
 899         int ret = 0;
 900
 901         if (!drv)
 902                 return 0;
 903
 904         if (drv->pm) {
 905                 if (drv->pm->suspend)
 906                         ret = drv->pm->suspend(dev);
 907         } else {
 908                 ret = platform_legacy_suspend(dev, PMSG_SUSPEND);
 909         }
 910
 911         return ret;
 912 }
 913
 914 int platform_pm_resume(struct device *dev)
 915 {
 916         struct device_driver *drv = dev->driver;
 917         int ret = 0;
 918
 919         if (!drv)
 920                 return 0;
 921
 922         if (drv->pm) {
 923                 if (drv->pm->resume)
 924                         ret = drv->pm->resume(dev);
 925         } else {
 926                 ret = platform_legacy_resume(dev);
 927         }
 928
 929         return ret;
 930 }
 931
 932 #endif /* CONFIG_SUSPEND */
 933
 934 #ifdef CONFIG_HIBERNATE_CALLBACKS
 935
 936 int platform_pm_freeze(struct device *dev)
 937 {
 938         struct device_driver *drv = dev->driver;
 939         int ret = 0;
 940
 941         if (!drv)
 942                 return 0;
 943
 944         if (drv->pm) {
 945                 if (drv->pm->freeze)
 946                         ret = drv->pm->freeze(dev);
 947         } else {
 948                 ret = platform_legacy_suspend(dev, PMSG_FREEZE);
 949         }
 950
 951         return ret;
 952 }
 953
 954 int platform_pm_thaw(struct device *dev)
 955 {
 956         struct device_driver *drv = dev->driver;
 957         int ret = 0;
 958
 959         if (!drv)
 960                 return 0;
 961
 962         if (drv->pm) {
 963                 if (drv->pm->thaw)
 964                         ret = drv->pm->thaw(dev);
 965         } else {
 966                 ret = platform_legacy_resume(dev);
 967         }
 968
 969         return ret;
 970 }
 971
 972 int platform_pm_poweroff(struct device *dev)
 973 {
 974         struct device_driver *drv = dev->driver;
 975         int ret = 0;
 976
 977         if (!drv)
 978                 return 0;
 979
 980         if (drv->pm) {
 981                 if (drv->pm->poweroff)
 982                         ret = drv->pm->poweroff(dev);
 983         } else {
 984                 ret = platform_legacy_suspend(dev, PMSG_HIBERNATE);
 985         }
 986
 987         return ret;
 988 }
 989
 990 int platform_pm_restore(struct device *dev)
 991 {
 992         struct device_driver *drv = dev->driver;
 993         int ret = 0;
 994
 995         if (!drv)
 996                 return 0;
 997
 998         if (drv->pm) {
 999                 if (drv->pm->restore)
1000                         ret = drv->pm->restore(dev);
1001         } else {
1002                 ret = platform_legacy_resume(dev);
1003         }
1004
1005         return ret;
1006 }
1007
1008 #endif /* CONFIG_HIBERNATE_CALLBACKS */
1009
1010 static const struct dev_pm_ops platform_dev_pm_ops = {
1011         .runtime_suspend = pm_generic_runtime_suspend,
1012         .runtime_resume = pm_generic_runtime_resume,
1013         USE_PLATFORM_PM_SLEEP_OPS
1014 };
1015
1016 struct bus_type platform_bus_type = {
1017         .name           = "platform",
1018         .dev_groups     = platform_dev_groups,
1019         .match          = platform_match,
1020         .uevent         = platform_uevent,
1021         .pm             = &platform_dev_pm_ops,
1022 };
1023 EXPORT_SYMBOL_GPL(platform_bus_type);
1024
1025 int __init platform_bus_init(void)
1026 {
1027         int error;
1028
1029         early_platform_cleanup();
1030
1031         error = device_register(&platform_bus);
1032         if (error)
1033                 return error;
1034         error =  bus_register(&platform_bus_type);
1035         if (error)
1036                 device_unregister(&platform_bus);
1037         of_platform_register_reconfig_notifier();
1038         return error;
1039 }
1040
1041 #ifndef ARCH_HAS_DMA_GET_REQUIRED_MASK
1042 u64 dma_get_required_mask(struct device *dev)
1043 {
1044         u32 low_totalram = ((max_pfn - 1) << PAGE_SHIFT);
1045         u32 high_totalram = ((max_pfn - 1) >> (32 - PAGE_SHIFT));
1046         u64 mask;
1047
1048         if (!high_totalram) {
1049                 /* convert to mask just covering totalram */
1050                 low_totalram = (1 << (fls(low_totalram) - 1));
1051                 low_totalram += low_totalram - 1;
1052                 mask = low_totalram;
1053         } else {
1054                 high_totalram = (1 << (fls(high_totalram) - 1));
1055                 high_totalram += high_totalram - 1;
1056                 mask = (((u64)high_totalram) << 32) + 0xffffffff;
1057         }
1058         return mask;
1059 }
1060 EXPORT_SYMBOL_GPL(dma_get_required_mask);
1061 #endif
1062
1063 static __initdata LIST_HEAD(early_platform_driver_list);
1064 static __initdata LIST_HEAD(early_platform_device_list);
1065
1066 /**
1067  * early_platform_driver_register - register early platform driver
1068  * @epdrv: early_platform driver structure
1069  * @buf: string passed from early_param()
1070  *
1071  * Helper function for early_platform_init() / early_platform_init_buffer()
1072  */
1073 int __init early_platform_driver_register(struct early_platform_driver *epdrv,
1074                                           char *buf)
1075 {
1076         char *tmp;
1077         int n;
1078
1079         /* Simply add the driver to the end of the global list.
1080          * Drivers will by default be put on the list in compiled-in order.
1081          */
1082         if (!epdrv->list.next) {
1083                 INIT_LIST_HEAD(&epdrv->list);
1084                 list_add_tail(&epdrv->list, &early_platform_driver_list);
1085         }
1086
1087         /* If the user has specified device then make sure the driver
1088          * gets prioritized. The driver of the last device specified on
1089          * command line will be put first on the list.
1090          */
1091         n = strlen(epdrv->pdrv->driver.name);
1092         if (buf && !strncmp(buf, epdrv->pdrv->driver.name, n)) {
1093                 list_move(&epdrv->list, &early_platform_driver_list);
1094
1095                 /* Allow passing parameters after device name */
1096                 if (buf[n] == '\0' || buf[n] == ',')
1097                         epdrv->requested_id = -1;
1098                 else {
1099                         epdrv->requested_id = simple_strtoul(&buf[n + 1],
1100                                                              &tmp, 10);
1101
1102                         if (buf[n] != '.' || (tmp == &buf[n + 1])) {
1103                                 epdrv->requested_id = EARLY_PLATFORM_ID_ERROR;
1104                                 n = 0;
1105                         } else
1106                                 n += strcspn(&buf[n + 1], ",") + 1;
1107                 }
1108
1109                 if (buf[n] == ',')
1110                         n++;
1111
1112                 if (epdrv->bufsize) {
1113                         memcpy(epdrv->buffer, &buf[n],
1114                                min_t(int, epdrv->bufsize, strlen(&buf[n]) + 1));
1115                         epdrv->buffer[epdrv->bufsize - 1] = '\0';
1116                 }
1117         }
1118
1119         return 0;
1120 }
1121
1122 /**
1123  * early_platform_add_devices - adds a number of early platform devices
1124  * @devs: array of early platform devices to add
1125  * @num: number of early platform devices in array
1126  *
1127  * Used by early architecture code to register early platform devices and
1128  * their platform data.
1129  */
1130 void __init early_platform_add_devices(struct platform_device **devs, int num)
1131 {
1132         struct device *dev;
1133         int i;
1134
1135         /* simply add the devices to list */
1136         for (i = 0; i < num; i++) {
1137                 dev = &devs[i]->dev;
1138
1139                 if (!dev->devres_head.next) {
1140                         pm_runtime_early_init(dev);
1141                         INIT_LIST_HEAD(&dev->devres_head);
1142                         list_add_tail(&dev->devres_head,
1143                                       &early_platform_device_list);
1144                 }
1145         }
1146 }
1147
1148 /**
1149  * early_platform_driver_register_all - register early platform drivers
1150  * @class_str: string to identify early platform driver class
1151  *
1152  * Used by architecture code to register all early platform drivers
1153  * for a certain class. If omitted then only early platform drivers
1154  * with matching kernel command line class parameters will be registered.
1155  */
1156 void __init early_platform_driver_register_all(char *class_str)
1157 {
1158         /* The "class_str" parameter may or may not be present on the kernel
1159          * command line. If it is present then there may be more than one
1160          * matching parameter.
1161          *
1162          * Since we register our early platform drivers using early_param()
1163          * we need to make sure that they also get registered in the case
1164          * when the parameter is missing from the kernel command line.
1165          *
1166          * We use parse_early_options() to make sure the early_param() gets
1167          * called at least once. The early_param() may be called more than
1168          * once since the name of the preferred device may be specified on
1169          * the kernel command line. early_platform_driver_register() handles
1170          * this case for us.
1171          */
1172         parse_early_options(class_str);
1173 }
1174
1175 /**
1176  * early_platform_match - find early platform device matching driver
1177  * @epdrv: early platform driver structure
1178  * @id: id to match against
1179  */
1180 static struct platform_device * __init
1181 early_platform_match(struct early_platform_driver *epdrv, int id)
1182 {
1183         struct platform_device *pd;
1184
1185         list_for_each_entry(pd, &early_platform_device_list, dev.devres_head)
1186                 if (platform_match(&pd->dev, &epdrv->pdrv->driver))
1187                         if (pd->id == id)
1188                                 return pd;
1189
1190         return NULL;
1191 }
1192
1193 /**
1194  * early_platform_left - check if early platform driver has matching devices
1195  * @epdrv: early platform driver structure
1196  * @id: return true if id or above exists
1197  */
1198 static int __init early_platform_left(struct early_platform_driver *epdrv,
1199                                        int id)
1200 {
1201         struct platform_device *pd;
1202
1203         list_for_each_entry(pd, &early_platform_device_list, dev.devres_head)
1204                 if (platform_match(&pd->dev, &epdrv->pdrv->driver))
1205                         if (pd->id >= id)
1206                                 return 1;
1207
1208         return 0;
1209 }
1210
1211 /**
1212  * early_platform_driver_probe_id - probe drivers matching class_str and id
1213  * @class_str: string to identify early platform driver class
1214  * @id: id to match against
1215  * @nr_probe: number of platform devices to successfully probe before exiting
1216  */
1217 static int __init early_platform_driver_probe_id(char *class_str,
1218                                                  int id,
1219                                                  int nr_probe)
1220 {
1221         struct early_platform_driver *epdrv;
1222         struct platform_device *match;
1223         int match_id;
1224         int n = 0;
1225         int left = 0;
1226
1227         list_for_each_entry(epdrv, &early_platform_driver_list, list) {
1228                 /* only use drivers matching our class_str */
1229                 if (strcmp(class_str, epdrv->class_str))
1230                         continue;
1231
1232                 if (id == -2) {
1233                         match_id = epdrv->requested_id;
1234                         left = 1;
1235
1236                 } else {
1237                         match_id = id;
1238                         left += early_platform_left(epdrv, id);
1239
1240                         /* skip requested id */
1241                         switch (epdrv->requested_id) {
1242                         case EARLY_PLATFORM_ID_ERROR:
1243                         case EARLY_PLATFORM_ID_UNSET:
1244                                 break;
1245                         default:
1246                                 if (epdrv->requested_id == id)
1247                                         match_id = EARLY_PLATFORM_ID_UNSET;
1248                         }
1249                 }
1250
1251                 switch (match_id) {
1252                 case EARLY_PLATFORM_ID_ERROR:
1253                         pr_warn("%s: unable to parse %s parameter\n",
1254                                 class_str, epdrv->pdrv->driver.name);
1255                         /* fall-through */
1256                 case EARLY_PLATFORM_ID_UNSET:
1257                         match = NULL;
1258                         break;
1259                 default:
1260                         match = early_platform_match(epdrv, match_id);
1261                 }
1262
1263                 if (match) {
1264                         /*
1265                          * Set up a sensible init_name to enable
1266                          * dev_name() and others to be used before the
1267                          * rest of the driver core is initialized.
1268                          */
1269                         if (!match->dev.init_name && slab_is_available()) {
1270                                 if (match->id != -1)
1271                                         match->dev.init_name =
1272                                                 kasprintf(GFP_KERNEL, "%s.%d",
1273                                                           match->name,
1274                                                           match->id);
1275                                 else
1276                                         match->dev.init_name =
1277                                                 kasprintf(GFP_KERNEL, "%s",
1278                                                           match->name);
1279
1280                                 if (!match->dev.init_name)
1281                                         return -ENOMEM;
1282                         }
1283
1284                         if (epdrv->pdrv->probe(match))
1285                                 pr_warn("%s: unable to probe %s early.\n",
1286                                         class_str, match->name);
1287                         else
1288                                 n++;
1289                 }
1290
1291                 if (n >= nr_probe)
1292                         break;
1293         }
1294
1295         if (left)
1296                 return n;
1297         else
1298                 return -ENODEV;
1299 }
1300
1301 /**
1302  * early_platform_driver_probe - probe a class of registered drivers
1303  * @class_str: string to identify early platform driver class
1304  * @nr_probe: number of platform devices to successfully probe before exiting
1305  * @user_only: only probe user specified early platform devices
1306  *
1307  * Used by architecture code to probe registered early platform drivers
1308  * within a certain class. For probe to happen a registered early platform
1309  * device matching a registered early platform driver is needed.
1310  */
1311 int __init early_platform_driver_probe(char *class_str,
1312                                        int nr_probe,
1313                                        int user_only)
1314 {
1315         int k, n, i;
1316
1317         n = 0;
1318         for (i = -2; n < nr_probe; i++) {
1319                 k = early_platform_driver_probe_id(class_str, i, nr_probe - n);
1320
1321                 if (k < 0)
1322                         break;
1323
1324                 n += k;
1325
1326                 if (user_only)
1327                         break;
1328         }
1329
1330         return n;
1331 }
1332
1333 /**
1334  * early_platform_cleanup - clean up early platform code
1335  */
1336 void __init early_platform_cleanup(void)
1337 {
1338         struct platform_device *pd, *pd2;
1339
1340         /* clean up the devres list used to chain devices */
1341         list_for_each_entry_safe(pd, pd2, &early_platform_device_list,
1342                                  dev.devres_head) {
1343                 list_del(&pd->dev.devres_head);
1344                 memset(&pd->dev.devres_head, 0, sizeof(pd->dev.devres_head));
1345         }
1346 }
1347