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