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