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