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