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