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