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