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 #if defined(CONFIG_PPC_DCR)
  55 #include <asm/dcr.h>
  56 #endif
  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 either the dcr-reg or the reg property
  72  * value to derive a unique name.  As a last resort it will use the node
  73  * name followed by a unique number.
  74  */
  75 void of_device_make_bus_id(struct device *dev)
  76 {
  77         static atomic_t bus_no_reg_magic;
  78         struct device_node *node = dev->of_node;
  79         const __be32 *reg;
  80         u64 addr;
  81         const __be32 *addrp;
  82         int magic;
  83
  84 #ifdef CONFIG_PPC_DCR
  85         /*
  86          * If it's a DCR based device, use 'd' for native DCRs
  87          * and 'D' for MMIO DCRs.
  88          */
  89         reg = of_get_property(node, "dcr-reg", NULL);
  90         if (reg) {
  91 #ifdef CONFIG_PPC_DCR_NATIVE
  92                 dev_set_name(dev, "d%x.%s", *reg, node->name);
  93 #else /* CONFIG_PPC_DCR_NATIVE */
  94                 u64 addr = of_translate_dcr_address(node, *reg, NULL);
  95                 if (addr != OF_BAD_ADDR) {
  96                         dev_set_name(dev, "D%llx.%s",
  97                                      (unsigned long long)addr, node->name);
  98                         return;
  99                 }
 100 #endif /* !CONFIG_PPC_DCR_NATIVE */
 101         }
 102 #endif /* CONFIG_PPC_DCR */
 103
 104         /*
 105          * For MMIO, get the physical address
 106          */
 107         reg = of_get_property(node, "reg", NULL);
 108         if (reg) {
 109                 if (of_can_translate_address(node)) {
 110                         addr = of_translate_address(node, reg);
 111                 } else {
 112                         addrp = of_get_address(node, 0, NULL, NULL);
 113                         if (addrp)
 114                                 addr = of_read_number(addrp, 1);
 115                         else
 116                                 addr = OF_BAD_ADDR;
 117                 }
 118                 if (addr != OF_BAD_ADDR) {
 119                         dev_set_name(dev, "%llx.%s",
 120                                      (unsigned long long)addr, node->name);
 121                         return;
 122                 }
 123         }
 124
 125         /*
 126          * No BusID, use the node name and add a globally incremented
 127          * counter (and pray...)
 128          */
 129         magic = atomic_add_return(1, &bus_no_reg_magic);
 130         dev_set_name(dev, "%s.%d", node->name, magic - 1);
 131 }
 132
 133 /**
 134  * of_device_alloc - Allocate and initialize an of_device
 135  * @np: device node to assign to device
 136  * @bus_id: Name to assign to the device.  May be null to use default name.
 137  * @parent: Parent device.
 138  */
 139 struct platform_device *of_device_alloc(struct device_node *np,
 140                                   const char *bus_id,
 141                                   struct device *parent)
 142 {
 143         struct platform_device *dev;
 144         int rc, i, num_reg = 0, num_irq;
 145         struct resource *res, temp_res;
 146
 147         dev = platform_device_alloc("", -1);
 148         if (!dev)
 149                 return NULL;
 150
 151         /* count the io and irq resources */
 152         if (of_can_translate_address(np))
 153                 while (of_address_to_resource(np, num_reg, &temp_res) == 0)
 154                         num_reg++;
 155         num_irq = of_irq_count(np);
 156
 157         /* Populate the resource table */
 158         if (num_irq || num_reg) {
 159                 res = kzalloc(sizeof(*res) * (num_irq + num_reg), GFP_KERNEL);
 160                 if (!res) {
 161                         platform_device_put(dev);
 162                         return NULL;
 163                 }
 164
 165                 dev->num_resources = num_reg + num_irq;
 166                 dev->resource = res;
 167                 for (i = 0; i < num_reg; i++, res++) {
 168                         rc = of_address_to_resource(np, i, res);
 169                         WARN_ON(rc);
 170                 }
 171                 WARN_ON(of_irq_to_resource_table(np, res, num_irq) != num_irq);
 172         }
 173
 174         dev->dev.of_node = of_node_get(np);
 175 #if defined(CONFIG_MICROBLAZE)
 176         dev->dev.dma_mask = &dev->archdata.dma_mask;
 177 #endif
 178         dev->dev.parent = parent;
 179
 180         if (bus_id)
 181                 dev_set_name(&dev->dev, "%s", bus_id);
 182         else
 183                 of_device_make_bus_id(&dev->dev);
 184
 185         return dev;
 186 }
 187 EXPORT_SYMBOL(of_device_alloc);
 188
 189 /**
 190  * of_platform_device_create_pdata - Alloc, initialize and register an of_device
 191  * @np: pointer to node to create device for
 192  * @bus_id: name to assign device
 193  * @platform_data: pointer to populate platform_data pointer with
 194  * @parent: Linux device model parent device.
 195  *
 196  * Returns pointer to created platform device, or NULL if a device was not
 197  * registered.  Unavailable devices will not get registered.
 198  */
 199 static struct platform_device *of_platform_device_create_pdata(
 200                                         struct device_node *np,
 201                                         const char *bus_id,
 202                                         void *platform_data,
 203                                         struct device *parent)
 204 {
 205         struct platform_device *dev;
 206
 207         if (!of_device_is_available(np))
 208                 return NULL;
 209
 210         dev = of_device_alloc(np, bus_id, parent);
 211         if (!dev)
 212                 return NULL;
 213
 214 #if defined(CONFIG_MICROBLAZE)
 215         dev->archdata.dma_mask = 0xffffffffUL;
 216 #endif
 217         dev->dev.coherent_dma_mask = DMA_BIT_MASK(32);
 218         dev->dev.bus = &platform_bus_type;
 219         dev->dev.platform_data = platform_data;
 220
 221         /* We do not fill the DMA ops for platform devices by default.
 222          * This is currently the responsibility of the platform code
 223          * to do such, possibly using a device notifier
 224          */
 225
 226         if (of_device_add(dev) != 0) {
 227                 platform_device_put(dev);
 228                 return NULL;
 229         }
 230
 231         return dev;
 232 }
 233
 234 /**
 235  * of_platform_device_create - Alloc, initialize and register an of_device
 236  * @np: pointer to node to create device for
 237  * @bus_id: name to assign device
 238  * @parent: Linux device model parent device.
 239  *
 240  * Returns pointer to created platform device, or NULL if a device was not
 241  * registered.  Unavailable devices will not get registered.
 242  */
 243 struct platform_device *of_platform_device_create(struct device_node *np,
 244                                             const char *bus_id,
 245                                             struct device *parent)
 246 {
 247         return of_platform_device_create_pdata(np, bus_id, NULL, parent);
 248 }
 249 EXPORT_SYMBOL(of_platform_device_create);
 250
 251 #ifdef CONFIG_ARM_AMBA
 252 static struct amba_device *of_amba_device_create(struct device_node *node,
 253                                                  const char *bus_id,
 254                                                  void *platform_data,
 255                                                  struct device *parent)
 256 {
 257         struct amba_device *dev;
 258         const void *prop;
 259         int i, ret;
 260
 261         pr_debug("Creating amba device %s\n", node->full_name);
 262
 263         if (!of_device_is_available(node))
 264                 return NULL;
 265
 266         dev = amba_device_alloc(NULL, 0, 0);
 267         if (!dev) {
 268                 pr_err("%s(): amba_device_alloc() failed for %s\n",
 269                        __func__, node->full_name);
 270                 return NULL;
 271         }
 272
 273         /* setup generic device info */
 274         dev->dev.coherent_dma_mask = ~0;
 275         dev->dev.of_node = of_node_get(node);
 276         dev->dev.parent = parent;
 277         dev->dev.platform_data = platform_data;
 278         if (bus_id)
 279                 dev_set_name(&dev->dev, "%s", bus_id);
 280         else
 281                 of_device_make_bus_id(&dev->dev);
 282
 283         /* setup amba-specific device info */
 284         dev->dma_mask = ~0;
 285
 286         /* Allow the HW Peripheral ID to be overridden */
 287         prop = of_get_property(node, "arm,primecell-periphid", NULL);
 288         if (prop)
 289                 dev->periphid = of_read_ulong(prop, 1);
 290
 291         /* Decode the IRQs and address ranges */
 292         for (i = 0; i < AMBA_NR_IRQS; i++)
 293                 dev->irq[i] = irq_of_parse_and_map(node, i);
 294
 295         ret = of_address_to_resource(node, 0, &dev->res);
 296         if (ret) {
 297                 pr_err("%s(): of_address_to_resource() failed (%d) for %s\n",
 298                        __func__, ret, node->full_name);
 299                 goto err_free;
 300         }
 301
 302         ret = amba_device_add(dev, &iomem_resource);
 303         if (ret) {
 304                 pr_err("%s(): amba_device_add() failed (%d) for %s\n",
 305                        __func__, ret, node->full_name);
 306                 goto err_free;
 307         }
 308
 309         return dev;
 310
 311 err_free:
 312         amba_device_put(dev);
 313         return NULL;
 314 }
 315 #else /* CONFIG_ARM_AMBA */
 316 static struct amba_device *of_amba_device_create(struct device_node *node,
 317                                                  const char *bus_id,
 318                                                  void *platform_data,
 319                                                  struct device *parent)
 320 {
 321         return NULL;
 322 }
 323 #endif /* CONFIG_ARM_AMBA */
 324
 325 /**
 326  * of_devname_lookup() - Given a device node, lookup the preferred Linux name
 327  */
 328 static const struct of_dev_auxdata *of_dev_lookup(const struct of_dev_auxdata *lookup,
 329                                  struct device_node *np)
 330 {
 331         struct resource res;
 332
 333         if (!lookup)
 334                 return NULL;
 335
 336         for(; lookup->compatible != NULL; lookup++) {
 337                 if (!of_device_is_compatible(np, lookup->compatible))
 338                         continue;
 339                 if (!of_address_to_resource(np, 0, &res))
 340                         if (res.start != lookup->phys_addr)
 341                                 continue;
 342                 pr_debug("%s: devname=%s\n", np->full_name, lookup->name);
 343                 return lookup;
 344         }
 345
 346         return NULL;
 347 }
 348
 349 /**
 350  * of_platform_bus_create() - Create a device for a node and its children.
 351  * @bus: device node of the bus to instantiate
 352  * @matches: match table for bus nodes
 353  * @lookup: auxdata table for matching id and platform_data with device nodes
 354  * @parent: parent for new device, or NULL for top level.
 355  * @strict: require compatible property
 356  *
 357  * Creates a platform_device for the provided device_node, and optionally
 358  * recursively create devices for all the child nodes.
 359  */
 360 static int of_platform_bus_create(struct device_node *bus,
 361                                   const struct of_device_id *matches,
 362                                   const struct of_dev_auxdata *lookup,
 363                                   struct device *parent, bool strict)
 364 {
 365         const struct of_dev_auxdata *auxdata;
 366         struct device_node *child;
 367         struct platform_device *dev;
 368         const char *bus_id = NULL;
 369         void *platform_data = NULL;
 370         int rc = 0;
 371
 372         /* Make sure it has a compatible property */
 373         if (strict && (!of_get_property(bus, "compatible", NULL))) {
 374                 pr_debug("%s() - skipping %s, no compatible prop\n",
 375                          __func__, bus->full_name);
 376                 return 0;
 377         }
 378
 379         auxdata = of_dev_lookup(lookup, bus);
 380         if (auxdata) {
 381                 bus_id = auxdata->name;
 382                 platform_data = auxdata->platform_data;
 383         }
 384
 385         if (of_device_is_compatible(bus, "arm,primecell")) {
 386                 /*
 387                  * Don't return an error here to keep compatibility with older
 388                  * device tree files.
 389                  */
 390                 of_amba_device_create(bus, bus_id, platform_data, parent);
 391                 return 0;
 392         }
 393
 394         dev = of_platform_device_create_pdata(bus, bus_id, platform_data, parent);
 395         if (!dev || !of_match_node(matches, bus))
 396                 return 0;
 397
 398         for_each_child_of_node(bus, child) {
 399                 pr_debug("   create child: %s\n", child->full_name);
 400                 rc = of_platform_bus_create(child, matches, lookup, &dev->dev, strict);
 401                 if (rc) {
 402                         of_node_put(child);
 403                         break;
 404                 }
 405         }
 406         return rc;
 407 }
 408
 409 /**
 410  * of_platform_bus_probe() - Probe the device-tree for platform buses
 411  * @root: parent of the first level to probe or NULL for the root of the tree
 412  * @matches: match table for bus nodes
 413  * @parent: parent to hook devices from, NULL for toplevel
 414  *
 415  * Note that children of the provided root are not instantiated as devices
 416  * unless the specified root itself matches the bus list and is not NULL.
 417  */
 418 int of_platform_bus_probe(struct device_node *root,
 419                           const struct of_device_id *matches,
 420                           struct device *parent)
 421 {
 422         struct device_node *child;
 423         int rc = 0;
 424
 425         root = root ? of_node_get(root) : of_find_node_by_path("/");
 426         if (!root)
 427                 return -EINVAL;
 428
 429         pr_debug("of_platform_bus_probe()\n");
 430         pr_debug(" starting at: %s\n", root->full_name);
 431
 432         /* Do a self check of bus type, if there's a match, create children */
 433         if (of_match_node(matches, root)) {
 434                 rc = of_platform_bus_create(root, matches, NULL, parent, false);
 435         } else for_each_child_of_node(root, child) {
 436                 if (!of_match_node(matches, child))
 437                         continue;
 438                 rc = of_platform_bus_create(child, matches, NULL, parent, false);
 439                 if (rc)
 440                         break;
 441         }
 442
 443         of_node_put(root);
 444         return rc;
 445 }
 446 EXPORT_SYMBOL(of_platform_bus_probe);
 447
 448 /**
 449  * of_platform_populate() - Populate platform_devices from device tree data
 450  * @root: parent of the first level to probe or NULL for the root of the tree
 451  * @matches: match table, NULL to use the default
 452  * @lookup: auxdata table for matching id and platform_data with device nodes
 453  * @parent: parent to hook devices from, NULL for toplevel
 454  *
 455  * Similar to of_platform_bus_probe(), this function walks the device tree
 456  * and creates devices from nodes.  It differs in that it follows the modern
 457  * convention of requiring all device nodes to have a 'compatible' property,
 458  * and it is suitable for creating devices which are children of the root
 459  * node (of_platform_bus_probe will only create children of the root which
 460  * are selected by the @matches argument).
 461  *
 462  * New board support should be using this function instead of
 463  * of_platform_bus_probe().
 464  *
 465  * Returns 0 on success, < 0 on failure.
 466  */
 467 int of_platform_populate(struct device_node *root,
 468                         const struct of_device_id *matches,
 469                         const struct of_dev_auxdata *lookup,
 470                         struct device *parent)
 471 {
 472         struct device_node *child;
 473         int rc = 0;
 474
 475         root = root ? of_node_get(root) : of_find_node_by_path("/");
 476         if (!root)
 477                 return -EINVAL;
 478
 479         for_each_child_of_node(root, child) {
 480                 rc = of_platform_bus_create(child, matches, lookup, parent, true);
 481                 if (rc)
 482                         break;
 483         }
 484
 485         of_node_put(root);
 486         return rc;
 487 }
 488 EXPORT_SYMBOL_GPL(of_platform_populate);
 489 #endif /* CONFIG_OF_ADDRESS */