drivers/base/platform.c

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