drivers/base/platform.c

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