drivers/of/platform.c

   1 /*
   2  *    Copyright (C) 2006 Benjamin Herrenschmidt, IBM Corp.
   3  *                       <benh@kernel.crashing.org>
   4  *    and                Arnd Bergmann, IBM Corp.
   5  *    Merged from powerpc/kernel/of_platform.c and
   6  *    sparc{,64}/kernel/of_device.c by Stephen Rothwell
   7  *
   8  *  This program is free software; you can redistribute it and/or
   9  *  modify it under the terms of the GNU General Public License
  10  *  as published by the Free Software Foundation; either version
  11  *  2 of the License, or (at your option) any later version.
  12  *
  13  */
  14
  15 #define pr_fmt(fmt)     "OF: " fmt
  16
  17 #include <linux/errno.h>
  18 #include <linux/module.h>
  19 #include <linux/amba/bus.h>
  20 #include <linux/device.h>
  21 #include <linux/dma-mapping.h>
  22 #include <linux/slab.h>
  23 #include <linux/of_address.h>
  24 #include <linux/of_device.h>
  25 #include <linux/of_irq.h>
  26 #include <linux/of_platform.h>
  27 #include <linux/platform_device.h>
  28
  29 const struct of_device_id of_default_bus_match_table[] = {
  30         { .compatible = "simple-bus", },
  31         { .compatible = "simple-mfd", },
  32 #ifdef CONFIG_ARM_AMBA
  33         { .compatible = "arm,amba-bus", },
  34 #endif /* CONFIG_ARM_AMBA */
  35         {} /* Empty terminated list */
  36 };
  37
  38 static int of_dev_node_match(struct device *dev, void *data)
  39 {
  40         return dev->of_node == data;
  41 }
  42
  43 /**
  44  * of_find_device_by_node - Find the platform_device associated with a node
  45  * @np: Pointer to device tree node
  46  *
  47  * Returns platform_device pointer, or NULL if not found
  48  */
  49 struct platform_device *of_find_device_by_node(struct device_node *np)
  50 {
  51         struct device *dev;
  52
  53         dev = bus_find_device(&platform_bus_type, NULL, np, of_dev_node_match);
  54         return dev ? to_platform_device(dev) : NULL;
  55 }
  56 EXPORT_SYMBOL(of_find_device_by_node);
  57
  58 #ifdef CONFIG_OF_ADDRESS
  59 /*
  60  * The following routines scan a subtree and registers a device for
  61  * each applicable node.
  62  *
  63  * Note: sparc doesn't use these routines because it has a different
  64  * mechanism for creating devices from device tree nodes.
  65  */
  66
  67 /**
  68  * of_device_make_bus_id - Use the device node data to assign a unique name
  69  * @dev: pointer to device structure that is linked to a device tree node
  70  *
  71  * This routine will first try using the translated bus address to
  72  * derive a unique name. If it cannot, then it will prepend names from
  73  * parent nodes until a unique name can be derived.
  74  */
  75 void of_device_make_bus_id(struct device *dev)
  76 {
  77         struct device_node *node = dev->of_node;
  78         const __be32 *reg;
  79         u64 addr;
  80
  81         /* Construct the name, using parent nodes if necessary to ensure uniqueness */
  82         while (node->parent) {
  83                 /*
  84                  * If the address can be translated, then that is as much
  85                  * uniqueness as we need. Make it the first component and return
  86                  */
  87                 reg = of_get_property(node, "reg", NULL);
  88                 if (reg && (addr = of_translate_address(node, reg)) != OF_BAD_ADDR) {
  89                         dev_set_name(dev, dev_name(dev) ? "%llx.%s:%s" : "%llx.%s",
  90                                      (unsigned long long)addr, node->name,
  91                                      dev_name(dev));
  92                         return;
  93                 }
  94
  95                 /* format arguments only used if dev_name() resolves to NULL */
  96                 dev_set_name(dev, dev_name(dev) ? "%s:%s" : "%s",
  97                              strrchr(node->full_name, '/') + 1, dev_name(dev));
  98                 node = node->parent;
  99         }
 100 }
 101
 102 /**
 103  * of_device_alloc - Allocate and initialize an of_device
 104  * @np: device node to assign to device
 105  * @bus_id: Name to assign to the device.  May be null to use default name.
 106  * @parent: Parent device.
 107  */
 108 struct platform_device *of_device_alloc(struct device_node *np,
 109                                   const char *bus_id,
 110                                   struct device *parent)
 111 {
 112         struct platform_device *dev;
 113         int rc, i, num_reg = 0, num_irq;
 114         struct resource *res, temp_res;
 115
 116         dev = platform_device_alloc("", -1);
 117         if (!dev)
 118                 return NULL;
 119
 120         /* count the io and irq resources */
 121         while (of_address_to_resource(np, num_reg, &temp_res) == 0)
 122                 num_reg++;
 123         num_irq = of_irq_count(np);
 124
 125         /* Populate the resource table */
 126         if (num_irq || num_reg) {
 127                 res = kzalloc(sizeof(*res) * (num_irq + num_reg), GFP_KERNEL);
 128                 if (!res) {
 129                         platform_device_put(dev);
 130                         return NULL;
 131                 }
 132
 133                 dev->num_resources = num_reg + num_irq;
 134                 dev->resource = res;
 135                 for (i = 0; i < num_reg; i++, res++) {
 136                         rc = of_address_to_resource(np, i, res);
 137                         WARN_ON(rc);
 138                 }
 139                 if (of_irq_to_resource_table(np, res, num_irq) != num_irq)
 140                         pr_debug("not all legacy IRQ resources mapped for %s\n",
 141                                  np->name);
 142         }
 143
 144         dev->dev.of_node = of_node_get(np);
 145         dev->dev.fwnode = &np->fwnode;
 146         dev->dev.parent = parent ? : &platform_bus;
 147
 148         if (bus_id)
 149                 dev_set_name(&dev->dev, "%s", bus_id);
 150         else
 151                 of_device_make_bus_id(&dev->dev);
 152
 153         return dev;
 154 }
 155 EXPORT_SYMBOL(of_device_alloc);
 156
 157 static void of_dma_deconfigure(struct device *dev)
 158 {
 159         arch_teardown_dma_ops(dev);
 160 }
 161
 162 /**
 163  * of_platform_device_create_pdata - Alloc, initialize and register an of_device
 164  * @np: pointer to node to create device for
 165  * @bus_id: name to assign device
 166  * @platform_data: pointer to populate platform_data pointer with
 167  * @parent: Linux device model parent device.
 168  *
 169  * Returns pointer to created platform device, or NULL if a device was not
 170  * registered.  Unavailable devices will not get registered.
 171  */
 172 static struct platform_device *of_platform_device_create_pdata(
 173                                         struct device_node *np,
 174                                         const char *bus_id,
 175                                         void *platform_data,
 176                                         struct device *parent)
 177 {
 178         struct platform_device *dev;
 179
 180         if (!of_device_is_available(np) ||
 181             of_node_test_and_set_flag(np, OF_POPULATED))
 182                 return NULL;
 183
 184         dev = of_device_alloc(np, bus_id, parent);
 185         if (!dev)
 186                 goto err_clear_flag;
 187
 188         dev->dev.bus = &platform_bus_type;
 189         dev->dev.platform_data = platform_data;
 190         of_dma_configure(&dev->dev, dev->dev.of_node);
 191         of_msi_configure(&dev->dev, dev->dev.of_node);
 192
 193         if (of_device_add(dev) != 0) {
 194                 of_dma_deconfigure(&dev->dev);
 195                 platform_device_put(dev);
 196                 goto err_clear_flag;
 197         }
 198
 199         return dev;
 200
 201 err_clear_flag:
 202         of_node_clear_flag(np, OF_POPULATED);
 203         return NULL;
 204 }
 205
 206 /**
 207  * of_platform_device_create - Alloc, initialize and register an of_device
 208  * @np: pointer to node to create device for
 209  * @bus_id: name to assign device
 210  * @parent: Linux device model parent device.
 211  *
 212  * Returns pointer to created platform device, or NULL if a device was not
 213  * registered.  Unavailable devices will not get registered.
 214  */
 215 struct platform_device *of_platform_device_create(struct device_node *np,
 216                                             const char *bus_id,
 217                                             struct device *parent)
 218 {
 219         return of_platform_device_create_pdata(np, bus_id, NULL, parent);
 220 }
 221 EXPORT_SYMBOL(of_platform_device_create);
 222
 223 #ifdef CONFIG_ARM_AMBA
 224 static struct amba_device *of_amba_device_create(struct device_node *node,
 225                                                  const char *bus_id,
 226                                                  void *platform_data,
 227                                                  struct device *parent)
 228 {
 229         struct amba_device *dev;
 230         const void *prop;
 231         int i, ret;
 232
 233         pr_debug("Creating amba device %s\n", node->full_name);
 234
 235         if (!of_device_is_available(node) ||
 236             of_node_test_and_set_flag(node, OF_POPULATED))
 237                 return NULL;
 238
 239         dev = amba_device_alloc(NULL, 0, 0);
 240         if (!dev)
 241                 goto err_clear_flag;
 242
 243         /* setup generic device info */
 244         dev->dev.of_node = of_node_get(node);
 245         dev->dev.fwnode = &node->fwnode;
 246         dev->dev.parent = parent ? : &platform_bus;
 247         dev->dev.platform_data = platform_data;
 248         if (bus_id)
 249                 dev_set_name(&dev->dev, "%s", bus_id);
 250         else
 251                 of_device_make_bus_id(&dev->dev);
 252         of_dma_configure(&dev->dev, dev->dev.of_node);
 253
 254         /* Allow the HW Peripheral ID to be overridden */
 255         prop = of_get_property(node, "arm,primecell-periphid", NULL);
 256         if (prop)
 257                 dev->periphid = of_read_ulong(prop, 1);
 258
 259         /* Decode the IRQs and address ranges */
 260         for (i = 0; i < AMBA_NR_IRQS; i++)
 261                 dev->irq[i] = irq_of_parse_and_map(node, i);
 262
 263         ret = of_address_to_resource(node, 0, &dev->res);
 264         if (ret) {
 265                 pr_err("amba: of_address_to_resource() failed (%d) for %s\n",
 266                        ret, node->full_name);
 267                 goto err_free;
 268         }
 269
 270         ret = amba_device_add(dev, &iomem_resource);
 271         if (ret) {
 272                 pr_err("amba_device_add() failed (%d) for %s\n",
 273                        ret, node->full_name);
 274                 goto err_free;
 275         }
 276
 277         return dev;
 278
 279 err_free:
 280         amba_device_put(dev);
 281 err_clear_flag:
 282         of_node_clear_flag(node, OF_POPULATED);
 283         return NULL;
 284 }
 285 #else /* CONFIG_ARM_AMBA */
 286 static struct amba_device *of_amba_device_create(struct device_node *node,
 287                                                  const char *bus_id,
 288                                                  void *platform_data,
 289                                                  struct device *parent)
 290 {
 291         return NULL;
 292 }
 293 #endif /* CONFIG_ARM_AMBA */
 294
 295 /**
 296  * of_devname_lookup() - Given a device node, lookup the preferred Linux name
 297  */
 298 static const struct of_dev_auxdata *of_dev_lookup(const struct of_dev_auxdata *lookup,
 299                                  struct device_node *np)
 300 {
 301         const struct of_dev_auxdata *auxdata;
 302         struct resource res;
 303         int compatible = 0;
 304
 305         if (!lookup)
 306                 return NULL;
 307
 308         auxdata = lookup;
 309         for (; auxdata->compatible; auxdata++) {
 310                 if (!of_device_is_compatible(np, auxdata->compatible))
 311                         continue;
 312                 compatible++;
 313                 if (!of_address_to_resource(np, 0, &res))
 314                         if (res.start != auxdata->phys_addr)
 315                                 continue;
 316                 pr_debug("%s: devname=%s\n", np->full_name, auxdata->name);
 317                 return auxdata;
 318         }
 319
 320         if (!compatible)
 321                 return NULL;
 322
 323         /* Try compatible match if no phys_addr and name are specified */
 324         auxdata = lookup;
 325         for (; auxdata->compatible; auxdata++) {
 326                 if (!of_device_is_compatible(np, auxdata->compatible))
 327                         continue;
 328                 if (!auxdata->phys_addr && !auxdata->name) {
 329                         pr_debug("%s: compatible match\n", np->full_name);
 330                         return auxdata;
 331                 }
 332         }
 333
 334         return NULL;
 335 }
 336
 337 /**
 338  * of_platform_bus_create() - Create a device for a node and its children.
 339  * @bus: device node of the bus to instantiate
 340  * @matches: match table for bus nodes
 341  * @lookup: auxdata table for matching id and platform_data with device nodes
 342  * @parent: parent for new device, or NULL for top level.
 343  * @strict: require compatible property
 344  *
 345  * Creates a platform_device for the provided device_node, and optionally
 346  * recursively create devices for all the child nodes.
 347  */
 348 static int of_platform_bus_create(struct device_node *bus,
 349                                   const struct of_device_id *matches,
 350                                   const struct of_dev_auxdata *lookup,
 351                                   struct device *parent, bool strict)
 352 {
 353         const struct of_dev_auxdata *auxdata;
 354         struct device_node *child;
 355         struct platform_device *dev;
 356         const char *bus_id = NULL;
 357         void *platform_data = NULL;
 358         int rc = 0;
 359
 360         /* Make sure it has a compatible property */
 361         if (strict && (!of_get_property(bus, "compatible", NULL))) {
 362                 pr_debug("%s() - skipping %s, no compatible prop\n",
 363                          __func__, bus->full_name);
 364                 return 0;
 365         }
 366
 367         if (of_node_check_flag(bus, OF_POPULATED_BUS)) {
 368                 pr_debug("%s() - skipping %s, already populated\n",
 369                         __func__, bus->full_name);
 370                 return 0;
 371         }
 372
 373         auxdata = of_dev_lookup(lookup, bus);
 374         if (auxdata) {
 375                 bus_id = auxdata->name;
 376                 platform_data = auxdata->platform_data;
 377         }
 378
 379         if (of_device_is_compatible(bus, "arm,primecell")) {
 380                 /*
 381                  * Don't return an error here to keep compatibility with older
 382                  * device tree files.
 383                  */
 384                 of_amba_device_create(bus, bus_id, platform_data, parent);
 385                 return 0;
 386         }
 387
 388         dev = of_platform_device_create_pdata(bus, bus_id, platform_data, parent);
 389         if (!dev || !of_match_node(matches, bus))
 390                 return 0;
 391
 392         for_each_child_of_node(bus, child) {
 393                 pr_debug("   create child: %s\n", child->full_name);
 394                 rc = of_platform_bus_create(child, matches, lookup, &dev->dev, strict);
 395                 if (rc) {
 396                         of_node_put(child);
 397                         break;
 398                 }
 399         }
 400         of_node_set_flag(bus, OF_POPULATED_BUS);
 401         return rc;
 402 }
 403
 404 /**
 405  * of_platform_bus_probe() - Probe the device-tree for platform buses
 406  * @root: parent of the first level to probe or NULL for the root of the tree
 407  * @matches: match table for bus nodes
 408  * @parent: parent to hook devices from, NULL for toplevel
 409  *
 410  * Note that children of the provided root are not instantiated as devices
 411  * unless the specified root itself matches the bus list and is not NULL.
 412  */
 413 int of_platform_bus_probe(struct device_node *root,
 414                           const struct of_device_id *matches,
 415                           struct device *parent)
 416 {
 417         struct device_node *child;
 418         int rc = 0;
 419
 420         root = root ? of_node_get(root) : of_find_node_by_path("/");
 421         if (!root)
 422                 return -EINVAL;
 423
 424         pr_debug("%s()\n", __func__);
 425         pr_debug(" starting at: %s\n", root->full_name);
 426
 427         /* Do a self check of bus type, if there's a match, create children */
 428         if (of_match_node(matches, root)) {
 429                 rc = of_platform_bus_create(root, matches, NULL, parent, false);
 430         } else for_each_child_of_node(root, child) {
 431                 if (!of_match_node(matches, child))
 432                         continue;
 433                 rc = of_platform_bus_create(child, matches, NULL, parent, false);
 434                 if (rc) {
 435                         of_node_put(child);
 436                         break;
 437                 }
 438         }
 439
 440         of_node_put(root);
 441         return rc;
 442 }
 443 EXPORT_SYMBOL(of_platform_bus_probe);
 444
 445 /**
 446  * of_platform_populate() - Populate platform_devices from device tree data
 447  * @root: parent of the first level to probe or NULL for the root of the tree
 448  * @matches: match table, NULL to use the default
 449  * @lookup: auxdata table for matching id and platform_data with device nodes
 450  * @parent: parent to hook devices from, NULL for toplevel
 451  *
 452  * Similar to of_platform_bus_probe(), this function walks the device tree
 453  * and creates devices from nodes.  It differs in that it follows the modern
 454  * convention of requiring all device nodes to have a 'compatible' property,
 455  * and it is suitable for creating devices which are children of the root
 456  * node (of_platform_bus_probe will only create children of the root which
 457  * are selected by the @matches argument).
 458  *
 459  * New board support should be using this function instead of
 460  * of_platform_bus_probe().
 461  *
 462  * Returns 0 on success, < 0 on failure.
 463  */
 464 int of_platform_populate(struct device_node *root,
 465                         const struct of_device_id *matches,
 466                         const struct of_dev_auxdata *lookup,
 467                         struct device *parent)
 468 {
 469         struct device_node *child;
 470         int rc = 0;
 471
 472         root = root ? of_node_get(root) : of_find_node_by_path("/");
 473         if (!root)
 474                 return -EINVAL;
 475
 476         pr_debug("%s()\n", __func__);
 477         pr_debug(" starting at: %s\n", root->full_name);
 478
 479         for_each_child_of_node(root, child) {
 480                 rc = of_platform_bus_create(child, matches, lookup, parent, true);
 481                 if (rc) {
 482                         of_node_put(child);
 483                         break;
 484                 }
 485         }
 486         of_node_set_flag(root, OF_POPULATED_BUS);
 487
 488         of_node_put(root);
 489         return rc;
 490 }
 491 EXPORT_SYMBOL_GPL(of_platform_populate);
 492
 493 int of_platform_default_populate(struct device_node *root,
 494                                  const struct of_dev_auxdata *lookup,
 495                                  struct device *parent)
 496 {
 497         return of_platform_populate(root, of_default_bus_match_table, lookup,
 498                                     parent);
 499 }
 500 EXPORT_SYMBOL_GPL(of_platform_default_populate);
 501
 502 #ifndef CONFIG_PPC
 503 static int __init of_platform_default_populate_init(void)
 504 {
 505         struct device_node *node;
 506
 507         if (!of_have_populated_dt())
 508                 return -ENODEV;
 509
 510         /*
 511          * Handle ramoops explicitly, since it is inside /reserved-memory,
 512          * which lacks a "compatible" property.
 513          */
 514         node = of_find_node_by_path("/reserved-memory");
 515         if (node) {
 516                 node = of_find_compatible_node(node, NULL, "ramoops");
 517                 if (node)
 518                         of_platform_device_create(node, NULL, NULL);
 519         }
 520
 521         /* Populate everything else. */
 522         of_platform_default_populate(NULL, NULL, NULL);
 523
 524         return 0;
 525 }
 526 arch_initcall_sync(of_platform_default_populate_init);
 527 #endif
 528
 529 static int of_platform_device_destroy(struct device *dev, void *data)
 530 {
 531         /* Do not touch devices not populated from the device tree */
 532         if (!dev->of_node || !of_node_check_flag(dev->of_node, OF_POPULATED))
 533                 return 0;
 534
 535         /* Recurse for any nodes that were treated as busses */
 536         if (of_node_check_flag(dev->of_node, OF_POPULATED_BUS))
 537                 device_for_each_child(dev, NULL, of_platform_device_destroy);
 538
 539         if (dev->bus == &platform_bus_type)
 540                 platform_device_unregister(to_platform_device(dev));
 541 #ifdef CONFIG_ARM_AMBA
 542         else if (dev->bus == &amba_bustype)
 543                 amba_device_unregister(to_amba_device(dev));
 544 #endif
 545
 546         of_dma_deconfigure(dev);
 547         of_node_clear_flag(dev->of_node, OF_POPULATED);
 548         of_node_clear_flag(dev->of_node, OF_POPULATED_BUS);
 549         return 0;
 550 }
 551
 552 /**
 553  * of_platform_depopulate() - Remove devices populated from device tree
 554  * @parent: device which children will be removed
 555  *
 556  * Complementary to of_platform_populate(), this function removes children
 557  * of the given device (and, recurrently, their children) that have been
 558  * created from their respective device tree nodes (and only those,
 559  * leaving others - eg. manually created - unharmed).
 560  *
 561  * Returns 0 when all children devices have been removed or
 562  * -EBUSY when some children remained.
 563  */
 564 void of_platform_depopulate(struct device *parent)
 565 {
 566         if (parent->of_node && of_node_check_flag(parent->of_node, OF_POPULATED_BUS)) {
 567                 device_for_each_child(parent, NULL, of_platform_device_destroy);
 568                 of_node_clear_flag(parent->of_node, OF_POPULATED_BUS);
 569         }
 570 }
 571 EXPORT_SYMBOL_GPL(of_platform_depopulate);
 572
 573 #ifdef CONFIG_OF_DYNAMIC
 574 static int of_platform_notify(struct notifier_block *nb,
 575                                 unsigned long action, void *arg)
 576 {
 577         struct of_reconfig_data *rd = arg;
 578         struct platform_device *pdev_parent, *pdev;
 579         bool children_left;
 580
 581         switch (of_reconfig_get_state_change(action, rd)) {
 582         case OF_RECONFIG_CHANGE_ADD:
 583                 /* verify that the parent is a bus */
 584                 if (!of_node_check_flag(rd->dn->parent, OF_POPULATED_BUS))
 585                         return NOTIFY_OK;       /* not for us */
 586
 587                 /* already populated? (driver using of_populate manually) */
 588                 if (of_node_check_flag(rd->dn, OF_POPULATED))
 589                         return NOTIFY_OK;
 590
 591                 /* pdev_parent may be NULL when no bus platform device */
 592                 pdev_parent = of_find_device_by_node(rd->dn->parent);
 593                 pdev = of_platform_device_create(rd->dn, NULL,
 594                                 pdev_parent ? &pdev_parent->dev : NULL);
 595                 of_dev_put(pdev_parent);
 596
 597                 if (pdev == NULL) {
 598                         pr_err("%s: failed to create for '%s'\n",
 599                                         __func__, rd->dn->full_name);
 600                         /* of_platform_device_create tosses the error code */
 601                         return notifier_from_errno(-EINVAL);
 602                 }
 603                 break;
 604
 605         case OF_RECONFIG_CHANGE_REMOVE:
 606
 607                 /* already depopulated? */
 608                 if (!of_node_check_flag(rd->dn, OF_POPULATED))
 609                         return NOTIFY_OK;
 610
 611                 /* find our device by node */
 612                 pdev = of_find_device_by_node(rd->dn);
 613                 if (pdev == NULL)
 614                         return NOTIFY_OK;       /* no? not meant for us */
 615
 616                 /* unregister takes one ref away */
 617                 of_platform_device_destroy(&pdev->dev, &children_left);
 618
 619                 /* and put the reference of the find */
 620                 of_dev_put(pdev);
 621                 break;
 622         }
 623
 624         return NOTIFY_OK;
 625 }
 626
 627 static struct notifier_block platform_of_notifier = {
 628         .notifier_call = of_platform_notify,
 629 };
 630
 631 void of_platform_register_reconfig_notifier(void)
 632 {
 633         WARN_ON(of_reconfig_notifier_register(&platform_of_notifier));
 634 }
 635 #endif /* CONFIG_OF_DYNAMIC */
 636
 637 #endif /* CONFIG_OF_ADDRESS */