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