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 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             of_node_test_and_set_flag(np, OF_POPULATED))
 209                 return NULL;
 210
 211         dev = of_device_alloc(np, bus_id, parent);
 212         if (!dev)
 213                 goto err_clear_flag;
 214
 215 #if defined(CONFIG_MICROBLAZE)
 216         dev->archdata.dma_mask = 0xffffffffUL;
 217 #endif
 218         dev->dev.coherent_dma_mask = DMA_BIT_MASK(32);
 219         dev->dev.bus = &platform_bus_type;
 220         dev->dev.platform_data = platform_data;
 221
 222         /* We do not fill the DMA ops for platform devices by default.
 223          * This is currently the responsibility of the platform code
 224          * to do such, possibly using a device notifier
 225          */
 226
 227         if (of_device_add(dev) != 0) {
 228                 platform_device_put(dev);
 229                 goto err_clear_flag;
 230         }
 231
 232         return dev;
 233
 234 err_clear_flag:
 235         of_node_clear_flag(np, OF_POPULATED);
 236         return NULL;
 237 }
 238
 239 /**
 240  * of_platform_device_create - Alloc, initialize and register an of_device
 241  * @np: pointer to node to create device for
 242  * @bus_id: name to assign device
 243  * @parent: Linux device model parent device.
 244  *
 245  * Returns pointer to created platform device, or NULL if a device was not
 246  * registered.  Unavailable devices will not get registered.
 247  */
 248 struct platform_device *of_platform_device_create(struct device_node *np,
 249                                             const char *bus_id,
 250                                             struct device *parent)
 251 {
 252         return of_platform_device_create_pdata(np, bus_id, NULL, parent);
 253 }
 254 EXPORT_SYMBOL(of_platform_device_create);
 255
 256 #ifdef CONFIG_ARM_AMBA
 257 static struct amba_device *of_amba_device_create(struct device_node *node,
 258                                                  const char *bus_id,
 259                                                  void *platform_data,
 260                                                  struct device *parent)
 261 {
 262         struct amba_device *dev;
 263         const void *prop;
 264         int i, ret;
 265
 266         pr_debug("Creating amba device %s\n", node->full_name);
 267
 268         if (!of_device_is_available(node) ||
 269             of_node_test_and_set_flag(node, OF_POPULATED))
 270                 return NULL;
 271
 272         dev = amba_device_alloc(NULL, 0, 0);
 273         if (!dev) {
 274                 pr_err("%s(): amba_device_alloc() failed for %s\n",
 275                        __func__, node->full_name);
 276                 goto err_clear_flag;
 277         }
 278
 279         /* setup generic device info */
 280         dev->dev.coherent_dma_mask = ~0;
 281         dev->dev.of_node = of_node_get(node);
 282         dev->dev.parent = parent;
 283         dev->dev.platform_data = platform_data;
 284         if (bus_id)
 285                 dev_set_name(&dev->dev, "%s", bus_id);
 286         else
 287                 of_device_make_bus_id(&dev->dev);
 288
 289         /* setup amba-specific device info */
 290         dev->dma_mask = ~0;
 291
 292         /* Allow the HW Peripheral ID to be overridden */
 293         prop = of_get_property(node, "arm,primecell-periphid", NULL);
 294         if (prop)
 295                 dev->periphid = of_read_ulong(prop, 1);
 296
 297         /* Decode the IRQs and address ranges */
 298         for (i = 0; i < AMBA_NR_IRQS; i++)
 299                 dev->irq[i] = irq_of_parse_and_map(node, i);
 300
 301         ret = of_address_to_resource(node, 0, &dev->res);
 302         if (ret)
 303                 goto err_free;
 304
 305         ret = amba_device_add(dev, &iomem_resource);
 306         if (ret)
 307                 goto err_free;
 308
 309         return dev;
 310
 311 err_free:
 312         amba_device_put(dev);
 313 err_clear_flag:
 314         of_node_clear_flag(node, OF_POPULATED);
 315         return NULL;
 316 }
 317 #else /* CONFIG_ARM_AMBA */
 318 static struct amba_device *of_amba_device_create(struct device_node *node,
 319                                                  const char *bus_id,
 320                                                  void *platform_data,
 321                                                  struct device *parent)
 322 {
 323         return NULL;
 324 }
 325 #endif /* CONFIG_ARM_AMBA */
 326
 327 /**
 328  * of_devname_lookup() - Given a device node, lookup the preferred Linux name
 329  */
 330 static const struct of_dev_auxdata *of_dev_lookup(const struct of_dev_auxdata *lookup,
 331                                  struct device_node *np)
 332 {
 333         struct resource res;
 334
 335         if (!lookup)
 336                 return NULL;
 337
 338         for(; lookup->compatible != NULL; lookup++) {
 339                 if (!of_device_is_compatible(np, lookup->compatible))
 340                         continue;
 341                 if (!of_address_to_resource(np, 0, &res))
 342                         if (res.start != lookup->phys_addr)
 343                                 continue;
 344                 pr_debug("%s: devname=%s\n", np->full_name, lookup->name);
 345                 return lookup;
 346         }
 347
 348         return NULL;
 349 }
 350
 351 /**
 352  * of_platform_bus_create() - Create a device for a node and its children.
 353  * @bus: device node of the bus to instantiate
 354  * @matches: match table for bus nodes
 355  * @lookup: auxdata table for matching id and platform_data with device nodes
 356  * @parent: parent for new device, or NULL for top level.
 357  * @strict: require compatible property
 358  *
 359  * Creates a platform_device for the provided device_node, and optionally
 360  * recursively create devices for all the child nodes.
 361  */
 362 static int of_platform_bus_create(struct device_node *bus,
 363                                   const struct of_device_id *matches,
 364                                   const struct of_dev_auxdata *lookup,
 365                                   struct device *parent, bool strict)
 366 {
 367         const struct of_dev_auxdata *auxdata;
 368         struct device_node *child;
 369         struct platform_device *dev;
 370         const char *bus_id = NULL;
 371         void *platform_data = NULL;
 372         int rc = 0;
 373
 374         /* Make sure it has a compatible property */
 375         if (strict && (!of_get_property(bus, "compatible", NULL))) {
 376                 pr_debug("%s() - skipping %s, no compatible prop\n",
 377                          __func__, bus->full_name);
 378                 return 0;
 379         }
 380
 381         auxdata = of_dev_lookup(lookup, bus);
 382         if (auxdata) {
 383                 bus_id = auxdata->name;
 384                 platform_data = auxdata->platform_data;
 385         }
 386
 387         if (of_device_is_compatible(bus, "arm,primecell")) {
 388                 of_amba_device_create(bus, bus_id, platform_data, parent);
 389                 return 0;
 390         }
 391
 392         dev = of_platform_device_create_pdata(bus, bus_id, platform_data, parent);
 393         if (!dev || !of_match_node(matches, bus))
 394                 return 0;
 395
 396         for_each_child_of_node(bus, child) {
 397                 pr_debug("   create child: %s\n", child->full_name);
 398                 rc = of_platform_bus_create(child, matches, lookup, &dev->dev, strict);
 399                 if (rc) {
 400                         of_node_put(child);
 401                         break;
 402                 }
 403         }
 404         of_node_set_flag(bus, OF_POPULATED_BUS);
 405         return rc;
 406 }
 407
 408 /**
 409  * of_platform_bus_probe() - Probe the device-tree for platform buses
 410  * @root: parent of the first level to probe or NULL for the root of the tree
 411  * @matches: match table for bus nodes
 412  * @parent: parent to hook devices from, NULL for toplevel
 413  *
 414  * Note that children of the provided root are not instantiated as devices
 415  * unless the specified root itself matches the bus list and is not NULL.
 416  */
 417 int of_platform_bus_probe(struct device_node *root,
 418                           const struct of_device_id *matches,
 419                           struct device *parent)
 420 {
 421         struct device_node *child;
 422         int rc = 0;
 423
 424         root = root ? of_node_get(root) : of_find_node_by_path("/");
 425         if (!root)
 426                 return -EINVAL;
 427
 428         pr_debug("of_platform_bus_probe()\n");
 429         pr_debug(" starting at: %s\n", root->full_name);
 430
 431         /* Do a self check of bus type, if there's a match, create children */
 432         if (of_match_node(matches, root)) {
 433                 rc = of_platform_bus_create(root, matches, NULL, parent, false);
 434         } else for_each_child_of_node(root, child) {
 435                 if (!of_match_node(matches, child))
 436                         continue;
 437                 rc = of_platform_bus_create(child, matches, NULL, parent, false);
 438                 if (rc)
 439                         break;
 440         }
 441
 442         of_node_put(root);
 443         return rc;
 444 }
 445 EXPORT_SYMBOL(of_platform_bus_probe);
 446
 447 /**
 448  * of_platform_populate() - Populate platform_devices from device tree data
 449  * @root: parent of the first level to probe or NULL for the root of the tree
 450  * @matches: match table, NULL to use the default
 451  * @lookup: auxdata table for matching id and platform_data with device nodes
 452  * @parent: parent to hook devices from, NULL for toplevel
 453  *
 454  * Similar to of_platform_bus_probe(), this function walks the device tree
 455  * and creates devices from nodes.  It differs in that it follows the modern
 456  * convention of requiring all device nodes to have a 'compatible' property,
 457  * and it is suitable for creating devices which are children of the root
 458  * node (of_platform_bus_probe will only create children of the root which
 459  * are selected by the @matches argument).
 460  *
 461  * New board support should be using this function instead of
 462  * of_platform_bus_probe().
 463  *
 464  * Returns 0 on success, < 0 on failure.
 465  */
 466 int of_platform_populate(struct device_node *root,
 467                         const struct of_device_id *matches,
 468                         const struct of_dev_auxdata *lookup,
 469                         struct device *parent)
 470 {
 471         struct device_node *child;
 472         int rc = 0;
 473
 474         root = root ? of_node_get(root) : of_find_node_by_path("/");
 475         if (!root)
 476                 return -EINVAL;
 477
 478         for_each_child_of_node(root, child) {
 479                 rc = of_platform_bus_create(child, matches, lookup, parent, true);
 480                 if (rc)
 481                         break;
 482         }
 483
 484         of_node_put(root);
 485         return rc;
 486 }
 487 EXPORT_SYMBOL_GPL(of_platform_populate);
 488
 489 static int of_platform_device_destroy(struct device *dev, void *data)
 490 {
 491         /* Do not touch devices not populated from the device tree */
 492         if (!dev->of_node || !of_node_check_flag(dev->of_node, OF_POPULATED))
 493                 return 0;
 494
 495         /* Recurse for any nodes that were treated as busses */
 496         if (of_node_check_flag(dev->of_node, OF_POPULATED_BUS))
 497                 device_for_each_child(dev, NULL, of_platform_device_destroy);
 498
 499         if (dev->bus == &platform_bus_type)
 500                 platform_device_unregister(to_platform_device(dev));
 501 #ifdef CONFIG_ARM_AMBA
 502         else if (dev->bus == &amba_bustype)
 503                 amba_device_unregister(to_amba_device(dev));
 504 #endif
 505
 506         of_node_clear_flag(dev->of_node, OF_POPULATED);
 507         of_node_clear_flag(dev->of_node, OF_POPULATED_BUS);
 508         return 0;
 509 }
 510
 511 /**
 512  * of_platform_depopulate() - Remove devices populated from device tree
 513  * @parent: device which children will be removed
 514  *
 515  * Complementary to of_platform_populate(), this function removes children
 516  * of the given device (and, recurrently, their children) that have been
 517  * created from their respective device tree nodes (and only those,
 518  * leaving others - eg. manually created - unharmed).
 519  *
 520  * Returns 0 when all children devices have been removed or
 521  * -EBUSY when some children remained.
 522  */
 523 void of_platform_depopulate(struct device *parent)
 524 {
 525         device_for_each_child(parent, NULL, of_platform_device_destroy);
 526 }
 527 EXPORT_SYMBOL_GPL(of_platform_depopulate);
 528
 529 #ifdef CONFIG_OF_DYNAMIC
 530 static int of_platform_notify(struct notifier_block *nb,
 531                                 unsigned long action, void *arg)
 532 {
 533         struct of_reconfig_data *rd = arg;
 534         struct platform_device *pdev_parent, *pdev;
 535         bool children_left;
 536
 537         switch (of_reconfig_get_state_change(action, rd)) {
 538         case OF_RECONFIG_CHANGE_ADD:
 539                 /* verify that the parent is a bus */
 540                 if (!of_node_check_flag(rd->dn->parent, OF_POPULATED_BUS))
 541                         return NOTIFY_OK;       /* not for us */
 542
 543                 /* already populated? (driver using of_populate manually) */
 544                 if (of_node_check_flag(rd->dn, OF_POPULATED))
 545                         return NOTIFY_OK;
 546
 547                 /* pdev_parent may be NULL when no bus platform device */
 548                 pdev_parent = of_find_device_by_node(rd->dn->parent);
 549                 pdev = of_platform_device_create(rd->dn, NULL,
 550                                 pdev_parent ? &pdev_parent->dev : NULL);
 551                 of_dev_put(pdev_parent);
 552
 553                 if (pdev == NULL) {
 554                         pr_err("%s: failed to create for '%s'\n",
 555                                         __func__, rd->dn->full_name);
 556                         /* of_platform_device_create tosses the error code */
 557                         return notifier_from_errno(-EINVAL);
 558                 }
 559                 break;
 560
 561         case OF_RECONFIG_CHANGE_REMOVE:
 562
 563                 /* already depopulated? */
 564                 if (!of_node_check_flag(rd->dn, OF_POPULATED))
 565                         return NOTIFY_OK;
 566
 567                 /* find our device by node */
 568                 pdev = of_find_device_by_node(rd->dn);
 569                 if (pdev == NULL)
 570                         return NOTIFY_OK;       /* no? not meant for us */
 571
 572                 /* unregister takes one ref away */
 573                 of_platform_device_destroy(&pdev->dev, &children_left);
 574
 575                 /* and put the reference of the find */
 576                 of_dev_put(pdev);
 577                 break;
 578         }
 579
 580         return NOTIFY_OK;
 581 }
 582
 583 static struct notifier_block platform_of_notifier = {
 584         .notifier_call = of_platform_notify,
 585 };
 586
 587 void of_platform_register_reconfig_notifier(void)
 588 {
 589         WARN_ON(of_reconfig_notifier_register(&platform_of_notifier));
 590 }
 591 #endif /* CONFIG_OF_DYNAMIC */
 592
 593 #endif /* CONFIG_OF_ADDRESS */