drivers/of/platform.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  *    Copyright (C) 2006 Benjamin Herrenschmidt, IBM Corp.
   4  *                       <benh@kernel.crashing.org>
   5  *    and                Arnd Bergmann, IBM Corp.
   6  *    Merged from powerpc/kernel/of_platform.c and
   7  *    sparc{,64}/kernel/of_device.c by Stephen Rothwell
   8  */
   9
  10 #define pr_fmt(fmt)     "OF: " fmt
  11
  12 #include <linux/errno.h>
  13 #include <linux/module.h>
  14 #include <linux/amba/bus.h>
  15 #include <linux/device.h>
  16 #include <linux/dma-mapping.h>
  17 #include <linux/slab.h>
  18 #include <linux/of_address.h>
  19 #include <linux/of_device.h>
  20 #include <linux/of_irq.h>
  21 #include <linux/of_platform.h>
  22 #include <linux/platform_device.h>
  23
  24 const struct of_device_id of_default_bus_match_table[] = {
  25         { .compatible = "simple-bus", },
  26         { .compatible = "simple-mfd", },
  27         { .compatible = "isa", },
  28 #ifdef CONFIG_ARM_AMBA
  29         { .compatible = "arm,amba-bus", },
  30 #endif /* CONFIG_ARM_AMBA */
  31         {} /* Empty terminated list */
  32 };
  33
  34 static const struct of_device_id of_skipped_node_table[] = {
  35         { .compatible = "operating-points-v2", },
  36         {} /* Empty terminated list */
  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  * Takes a reference to the embedded struct device which needs to be dropped
  44  * after use.
  45  *
  46  * Return: platform_device pointer, or NULL if not found
  47  */
  48 struct platform_device *of_find_device_by_node(struct device_node *np)
  49 {
  50         struct device *dev;
  51
  52         dev = bus_find_device_by_of_node(&platform_bus_type, np);
  53         return dev ? to_platform_device(dev) : NULL;
  54 }
  55 EXPORT_SYMBOL(of_find_device_by_node);
  56
  57 #ifdef CONFIG_OF_ADDRESS
  58 /*
  59  * The following routines scan a subtree and registers a device for
  60  * each applicable node.
  61  *
  62  * Note: sparc doesn't use these routines because it has a different
  63  * mechanism for creating devices from device tree nodes.
  64  */
  65
  66 /**
  67  * of_device_make_bus_id - Use the device node data to assign a unique name
  68  * @dev: pointer to device structure that is linked to a device tree node
  69  *
  70  * This routine will first try using the translated bus address to
  71  * derive a unique name. If it cannot, then it will prepend names from
  72  * parent nodes until a unique name can be derived.
  73  */
  74 static void of_device_make_bus_id(struct device *dev)
  75 {
  76         struct device_node *node = dev->of_node;
  77         const __be32 *reg;
  78         u64 addr;
  79         u32 mask;
  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                         if (!of_property_read_u32(node, "mask", &mask))
  90                                 dev_set_name(dev, dev_name(dev) ? "%llx.%x.%pOFn:%s" : "%llx.%x.%pOFn",
  91                                              addr, ffs(mask) - 1, node, dev_name(dev));
  92
  93                         else
  94                                 dev_set_name(dev, dev_name(dev) ? "%llx.%pOFn:%s" : "%llx.%pOFn",
  95                                              addr, node, dev_name(dev));
  96                         return;
  97                 }
  98
  99                 /* format arguments only used if dev_name() resolves to NULL */
 100                 dev_set_name(dev, dev_name(dev) ? "%s:%s" : "%s",
 101                              kbasename(node->full_name), dev_name(dev));
 102                 node = node->parent;
 103         }
 104 }
 105
 106 /**
 107  * of_device_alloc - Allocate and initialize an of_device
 108  * @np: device node to assign to device
 109  * @bus_id: Name to assign to the device.  May be null to use default name.
 110  * @parent: Parent device.
 111  */
 112 struct platform_device *of_device_alloc(struct device_node *np,
 113                                   const char *bus_id,
 114                                   struct device *parent)
 115 {
 116         struct platform_device *dev;
 117         int rc, i, num_reg = 0;
 118         struct resource *res;
 119
 120         dev = platform_device_alloc("", PLATFORM_DEVID_NONE);
 121         if (!dev)
 122                 return NULL;
 123
 124         /* count the io resources */
 125         num_reg = of_address_count(np);
 126
 127         /* Populate the resource table */
 128         if (num_reg) {
 129                 res = kcalloc(num_reg, sizeof(*res), GFP_KERNEL);
 130                 if (!res) {
 131                         platform_device_put(dev);
 132                         return NULL;
 133                 }
 134
 135                 dev->num_resources = num_reg;
 136                 dev->resource = res;
 137                 for (i = 0; i < num_reg; i++, res++) {
 138                         rc = of_address_to_resource(np, i, res);
 139                         WARN_ON(rc);
 140                 }
 141         }
 142
 143         dev->dev.of_node = of_node_get(np);
 144         dev->dev.fwnode = &np->fwnode;
 145         dev->dev.parent = parent ? : &platform_bus;
 146
 147         if (bus_id)
 148                 dev_set_name(&dev->dev, "%s", bus_id);
 149         else
 150                 of_device_make_bus_id(&dev->dev);
 151
 152         return dev;
 153 }
 154 EXPORT_SYMBOL(of_device_alloc);
 155
 156 /**
 157  * of_platform_device_create_pdata - Alloc, initialize and register an of_device
 158  * @np: pointer to node to create device for
 159  * @bus_id: name to assign device
 160  * @platform_data: pointer to populate platform_data pointer with
 161  * @parent: Linux device model parent device.
 162  *
 163  * Return: Pointer to created platform device, or NULL if a device was not
 164  * registered.  Unavailable devices will not get registered.
 165  */
 166 static struct platform_device *of_platform_device_create_pdata(
 167                                         struct device_node *np,
 168                                         const char *bus_id,
 169                                         void *platform_data,
 170                                         struct device *parent)
 171 {
 172         struct platform_device *dev;
 173
 174         if (!of_device_is_available(np) ||
 175             of_node_test_and_set_flag(np, OF_POPULATED))
 176                 return NULL;
 177
 178         dev = of_device_alloc(np, bus_id, parent);
 179         if (!dev)
 180                 goto err_clear_flag;
 181
 182         dev->dev.coherent_dma_mask = DMA_BIT_MASK(32);
 183         if (!dev->dev.dma_mask)
 184                 dev->dev.dma_mask = &dev->dev.coherent_dma_mask;
 185         dev->dev.bus = &platform_bus_type;
 186         dev->dev.platform_data = platform_data;
 187         of_msi_configure(&dev->dev, dev->dev.of_node);
 188
 189         if (of_device_add(dev) != 0) {
 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  * Return: 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         int ret;
 226
 227         pr_debug("Creating amba device %pOF\n", node);
 228
 229         if (!of_device_is_available(node) ||
 230             of_node_test_and_set_flag(node, OF_POPULATED))
 231                 return NULL;
 232
 233         dev = amba_device_alloc(NULL, 0, 0);
 234         if (!dev)
 235                 goto err_clear_flag;
 236
 237         /* AMBA devices only support a single DMA mask */
 238         dev->dev.coherent_dma_mask = DMA_BIT_MASK(32);
 239         dev->dev.dma_mask = &dev->dev.coherent_dma_mask;
 240
 241         /* setup generic device info */
 242         dev->dev.of_node = of_node_get(node);
 243         dev->dev.fwnode = &node->fwnode;
 244         dev->dev.parent = parent ? : &platform_bus;
 245         dev->dev.platform_data = platform_data;
 246         if (bus_id)
 247                 dev_set_name(&dev->dev, "%s", bus_id);
 248         else
 249                 of_device_make_bus_id(&dev->dev);
 250
 251         /* Allow the HW Peripheral ID to be overridden */
 252         of_property_read_u32(node, "arm,primecell-periphid", &dev->periphid);
 253
 254         ret = of_address_to_resource(node, 0, &dev->res);
 255         if (ret) {
 256                 pr_err("amba: of_address_to_resource() failed (%d) for %pOF\n",
 257                        ret, node);
 258                 goto err_free;
 259         }
 260
 261         ret = amba_device_add(dev, &iomem_resource);
 262         if (ret) {
 263                 pr_err("amba_device_add() failed (%d) for %pOF\n",
 264                        ret, node);
 265                 goto err_free;
 266         }
 267
 268         return dev;
 269
 270 err_free:
 271         amba_device_put(dev);
 272 err_clear_flag:
 273         of_node_clear_flag(node, OF_POPULATED);
 274         return NULL;
 275 }
 276 #else /* CONFIG_ARM_AMBA */
 277 static struct amba_device *of_amba_device_create(struct device_node *node,
 278                                                  const char *bus_id,
 279                                                  void *platform_data,
 280                                                  struct device *parent)
 281 {
 282         return NULL;
 283 }
 284 #endif /* CONFIG_ARM_AMBA */
 285
 286 /*
 287  * of_dev_lookup() - Given a device node, lookup the preferred Linux name
 288  */
 289 static const struct of_dev_auxdata *of_dev_lookup(const struct of_dev_auxdata *lookup,
 290                                  struct device_node *np)
 291 {
 292         const struct of_dev_auxdata *auxdata;
 293         struct resource res;
 294         int compatible = 0;
 295
 296         if (!lookup)
 297                 return NULL;
 298
 299         auxdata = lookup;
 300         for (; auxdata->compatible; auxdata++) {
 301                 if (!of_device_is_compatible(np, auxdata->compatible))
 302                         continue;
 303                 compatible++;
 304                 if (!of_address_to_resource(np, 0, &res))
 305                         if (res.start != auxdata->phys_addr)
 306                                 continue;
 307                 pr_debug("%pOF: devname=%s\n", np, auxdata->name);
 308                 return auxdata;
 309         }
 310
 311         if (!compatible)
 312                 return NULL;
 313
 314         /* Try compatible match if no phys_addr and name are specified */
 315         auxdata = lookup;
 316         for (; auxdata->compatible; auxdata++) {
 317                 if (!of_device_is_compatible(np, auxdata->compatible))
 318                         continue;
 319                 if (!auxdata->phys_addr && !auxdata->name) {
 320                         pr_debug("%pOF: compatible match\n", np);
 321                         return auxdata;
 322                 }
 323         }
 324
 325         return NULL;
 326 }
 327
 328 /**
 329  * of_platform_bus_create() - Create a device for a node and its children.
 330  * @bus: device node of the bus to instantiate
 331  * @matches: match table for bus nodes
 332  * @lookup: auxdata table for matching id and platform_data with device nodes
 333  * @parent: parent for new device, or NULL for top level.
 334  * @strict: require compatible property
 335  *
 336  * Creates a platform_device for the provided device_node, and optionally
 337  * recursively create devices for all the child nodes.
 338  */
 339 static int of_platform_bus_create(struct device_node *bus,
 340                                   const struct of_device_id *matches,
 341                                   const struct of_dev_auxdata *lookup,
 342                                   struct device *parent, bool strict)
 343 {
 344         const struct of_dev_auxdata *auxdata;
 345         struct device_node *child;
 346         struct platform_device *dev;
 347         const char *bus_id = NULL;
 348         void *platform_data = NULL;
 349         int rc = 0;
 350
 351         /* Make sure it has a compatible property */
 352         if (strict && (!of_get_property(bus, "compatible", NULL))) {
 353                 pr_debug("%s() - skipping %pOF, no compatible prop\n",
 354                          __func__, bus);
 355                 return 0;
 356         }
 357
 358         /* Skip nodes for which we don't want to create devices */
 359         if (unlikely(of_match_node(of_skipped_node_table, bus))) {
 360                 pr_debug("%s() - skipping %pOF node\n", __func__, bus);
 361                 return 0;
 362         }
 363
 364         if (of_node_check_flag(bus, OF_POPULATED_BUS)) {
 365                 pr_debug("%s() - skipping %pOF, already populated\n",
 366                         __func__, bus);
 367                 return 0;
 368         }
 369
 370         auxdata = of_dev_lookup(lookup, bus);
 371         if (auxdata) {
 372                 bus_id = auxdata->name;
 373                 platform_data = auxdata->platform_data;
 374         }
 375
 376         if (of_device_is_compatible(bus, "arm,primecell")) {
 377                 /*
 378                  * Don't return an error here to keep compatibility with older
 379                  * device tree files.
 380                  */
 381                 of_amba_device_create(bus, bus_id, platform_data, parent);
 382                 return 0;
 383         }
 384
 385         dev = of_platform_device_create_pdata(bus, bus_id, platform_data, parent);
 386         if (!dev || !of_match_node(matches, bus))
 387                 return 0;
 388
 389         for_each_child_of_node(bus, child) {
 390                 pr_debug("   create child: %pOF\n", child);
 391                 rc = of_platform_bus_create(child, matches, lookup, &dev->dev, strict);
 392                 if (rc) {
 393                         of_node_put(child);
 394                         break;
 395                 }
 396         }
 397         of_node_set_flag(bus, OF_POPULATED_BUS);
 398         return rc;
 399 }
 400
 401 /**
 402  * of_platform_bus_probe() - Probe the device-tree for platform buses
 403  * @root: parent of the first level to probe or NULL for the root of the tree
 404  * @matches: match table for bus nodes
 405  * @parent: parent to hook devices from, NULL for toplevel
 406  *
 407  * Note that children of the provided root are not instantiated as devices
 408  * unless the specified root itself matches the bus list and is not NULL.
 409  */
 410 int of_platform_bus_probe(struct device_node *root,
 411                           const struct of_device_id *matches,
 412                           struct device *parent)
 413 {
 414         struct device_node *child;
 415         int rc = 0;
 416
 417         root = root ? of_node_get(root) : of_find_node_by_path("/");
 418         if (!root)
 419                 return -EINVAL;
 420
 421         pr_debug("%s()\n", __func__);
 422         pr_debug(" starting at: %pOF\n", root);
 423
 424         /* Do a self check of bus type, if there's a match, create children */
 425         if (of_match_node(matches, root)) {
 426                 rc = of_platform_bus_create(root, matches, NULL, parent, false);
 427         } else for_each_child_of_node(root, child) {
 428                 if (!of_match_node(matches, child))
 429                         continue;
 430                 rc = of_platform_bus_create(child, matches, NULL, parent, false);
 431                 if (rc) {
 432                         of_node_put(child);
 433                         break;
 434                 }
 435         }
 436
 437         of_node_put(root);
 438         return rc;
 439 }
 440 EXPORT_SYMBOL(of_platform_bus_probe);
 441
 442 /**
 443  * of_platform_populate() - Populate platform_devices from device tree data
 444  * @root: parent of the first level to probe or NULL for the root of the tree
 445  * @matches: match table, NULL to use the default
 446  * @lookup: auxdata table for matching id and platform_data with device nodes
 447  * @parent: parent to hook devices from, NULL for toplevel
 448  *
 449  * Similar to of_platform_bus_probe(), this function walks the device tree
 450  * and creates devices from nodes.  It differs in that it follows the modern
 451  * convention of requiring all device nodes to have a 'compatible' property,
 452  * and it is suitable for creating devices which are children of the root
 453  * node (of_platform_bus_probe will only create children of the root which
 454  * are selected by the @matches argument).
 455  *
 456  * New board support should be using this function instead of
 457  * of_platform_bus_probe().
 458  *
 459  * Return: 0 on success, < 0 on failure.
 460  */
 461 int of_platform_populate(struct device_node *root,
 462                         const struct of_device_id *matches,
 463                         const struct of_dev_auxdata *lookup,
 464                         struct device *parent)
 465 {
 466         struct device_node *child;
 467         int rc = 0;
 468
 469         root = root ? of_node_get(root) : of_find_node_by_path("/");
 470         if (!root)
 471                 return -EINVAL;
 472
 473         pr_debug("%s()\n", __func__);
 474         pr_debug(" starting at: %pOF\n", root);
 475
 476         device_links_supplier_sync_state_pause();
 477         for_each_child_of_node(root, child) {
 478                 rc = of_platform_bus_create(child, matches, lookup, parent, true);
 479                 if (rc) {
 480                         of_node_put(child);
 481                         break;
 482                 }
 483         }
 484         device_links_supplier_sync_state_resume();
 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 static const struct of_device_id reserved_mem_matches[] = {
 503         { .compatible = "phram" },
 504         { .compatible = "qcom,rmtfs-mem" },
 505         { .compatible = "qcom,cmd-db" },
 506         { .compatible = "qcom,smem" },
 507         { .compatible = "ramoops" },
 508         { .compatible = "nvmem-rmem" },
 509         { .compatible = "google,open-dice" },
 510         {}
 511 };
 512
 513 static int __init of_platform_default_populate_init(void)
 514 {
 515         struct device_node *node;
 516
 517         device_links_supplier_sync_state_pause();
 518
 519         if (!of_have_populated_dt())
 520                 return -ENODEV;
 521
 522         if (IS_ENABLED(CONFIG_PPC)) {
 523                 struct device_node *boot_display = NULL;
 524                 struct platform_device *dev;
 525                 int display_number = 0;
 526                 int ret;
 527
 528                 /* Check if we have a MacOS display without a node spec */
 529                 if (of_property_present(of_chosen, "linux,bootx-noscreen")) {
 530                         /*
 531                          * The old code tried to work out which node was the MacOS
 532                          * display based on the address. I'm dropping that since the
 533                          * lack of a node spec only happens with old BootX versions
 534                          * (users can update) and with this code, they'll still get
 535                          * a display (just not the palette hacks).
 536                          */
 537                         dev = platform_device_alloc("bootx-noscreen", 0);
 538                         if (WARN_ON(!dev))
 539                                 return -ENOMEM;
 540                         ret = platform_device_add(dev);
 541                         if (WARN_ON(ret)) {
 542                                 platform_device_put(dev);
 543                                 return ret;
 544                         }
 545                 }
 546
 547                 /*
 548                  * For OF framebuffers, first create the device for the boot display,
 549                  * then for the other framebuffers. Only fail for the boot display;
 550                  * ignore errors for the rest.
 551                  */
 552                 for_each_node_by_type(node, "display") {
 553                         if (!of_get_property(node, "linux,opened", NULL) ||
 554                             !of_get_property(node, "linux,boot-display", NULL))
 555                                 continue;
 556                         dev = of_platform_device_create(node, "of-display.0", NULL);
 557                         of_node_put(node);
 558                         if (WARN_ON(!dev))
 559                                 return -ENOMEM;
 560                         boot_display = node;
 561                         display_number++;
 562                         break;
 563                 }
 564                 for_each_node_by_type(node, "display") {
 565                         char buf[14];
 566                         const char *of_display_format = "of-display.%d";
 567
 568                         if (!of_get_property(node, "linux,opened", NULL) || node == boot_display)
 569                                 continue;
 570                         ret = snprintf(buf, sizeof(buf), of_display_format, display_number++);
 571                         if (ret < sizeof(buf))
 572                                 of_platform_device_create(node, buf, NULL);
 573                 }
 574
 575         } else {
 576                 /*
 577                  * Handle certain compatibles explicitly, since we don't want to create
 578                  * platform_devices for every node in /reserved-memory with a
 579                  * "compatible",
 580                  */
 581                 for_each_matching_node(node, reserved_mem_matches)
 582                         of_platform_device_create(node, NULL, NULL);
 583
 584                 node = of_find_node_by_path("/firmware");
 585                 if (node) {
 586                         of_platform_populate(node, NULL, NULL, NULL);
 587                         of_node_put(node);
 588                 }
 589
 590                 node = of_get_compatible_child(of_chosen, "simple-framebuffer");
 591                 of_platform_device_create(node, NULL, NULL);
 592                 of_node_put(node);
 593
 594                 /* Populate everything else. */
 595                 of_platform_default_populate(NULL, NULL, NULL);
 596         }
 597
 598         return 0;
 599 }
 600 arch_initcall_sync(of_platform_default_populate_init);
 601
 602 static int __init of_platform_sync_state_init(void)
 603 {
 604         device_links_supplier_sync_state_resume();
 605         return 0;
 606 }
 607 late_initcall_sync(of_platform_sync_state_init);
 608
 609 int of_platform_device_destroy(struct device *dev, void *data)
 610 {
 611         /* Do not touch devices not populated from the device tree */
 612         if (!dev->of_node || !of_node_check_flag(dev->of_node, OF_POPULATED))
 613                 return 0;
 614
 615         /* Recurse for any nodes that were treated as busses */
 616         if (of_node_check_flag(dev->of_node, OF_POPULATED_BUS))
 617                 device_for_each_child(dev, NULL, of_platform_device_destroy);
 618
 619         of_node_clear_flag(dev->of_node, OF_POPULATED);
 620         of_node_clear_flag(dev->of_node, OF_POPULATED_BUS);
 621
 622         if (dev->bus == &platform_bus_type)
 623                 platform_device_unregister(to_platform_device(dev));
 624 #ifdef CONFIG_ARM_AMBA
 625         else if (dev->bus == &amba_bustype)
 626                 amba_device_unregister(to_amba_device(dev));
 627 #endif
 628
 629         return 0;
 630 }
 631 EXPORT_SYMBOL_GPL(of_platform_device_destroy);
 632
 633 /**
 634  * of_platform_depopulate() - Remove devices populated from device tree
 635  * @parent: device which children will be removed
 636  *
 637  * Complementary to of_platform_populate(), this function removes children
 638  * of the given device (and, recurrently, their children) that have been
 639  * created from their respective device tree nodes (and only those,
 640  * leaving others - eg. manually created - unharmed).
 641  */
 642 void of_platform_depopulate(struct device *parent)
 643 {
 644         if (parent->of_node && of_node_check_flag(parent->of_node, OF_POPULATED_BUS)) {
 645                 device_for_each_child_reverse(parent, NULL, of_platform_device_destroy);
 646                 of_node_clear_flag(parent->of_node, OF_POPULATED_BUS);
 647         }
 648 }
 649 EXPORT_SYMBOL_GPL(of_platform_depopulate);
 650
 651 static void devm_of_platform_populate_release(struct device *dev, void *res)
 652 {
 653         of_platform_depopulate(*(struct device **)res);
 654 }
 655
 656 /**
 657  * devm_of_platform_populate() - Populate platform_devices from device tree data
 658  * @dev: device that requested to populate from device tree data
 659  *
 660  * Similar to of_platform_populate(), but will automatically call
 661  * of_platform_depopulate() when the device is unbound from the bus.
 662  *
 663  * Return: 0 on success, < 0 on failure.
 664  */
 665 int devm_of_platform_populate(struct device *dev)
 666 {
 667         struct device **ptr;
 668         int ret;
 669
 670         if (!dev)
 671                 return -EINVAL;
 672
 673         ptr = devres_alloc(devm_of_platform_populate_release,
 674                            sizeof(*ptr), GFP_KERNEL);
 675         if (!ptr)
 676                 return -ENOMEM;
 677
 678         ret = of_platform_populate(dev->of_node, NULL, NULL, dev);
 679         if (ret) {
 680                 devres_free(ptr);
 681         } else {
 682                 *ptr = dev;
 683                 devres_add(dev, ptr);
 684         }
 685
 686         return ret;
 687 }
 688 EXPORT_SYMBOL_GPL(devm_of_platform_populate);
 689
 690 static int devm_of_platform_match(struct device *dev, void *res, void *data)
 691 {
 692         struct device **ptr = res;
 693
 694         if (!ptr) {
 695                 WARN_ON(!ptr);
 696                 return 0;
 697         }
 698
 699         return *ptr == data;
 700 }
 701
 702 /**
 703  * devm_of_platform_depopulate() - Remove devices populated from device tree
 704  * @dev: device that requested to depopulate from device tree data
 705  *
 706  * Complementary to devm_of_platform_populate(), this function removes children
 707  * of the given device (and, recurrently, their children) that have been
 708  * created from their respective device tree nodes (and only those,
 709  * leaving others - eg. manually created - unharmed).
 710  */
 711 void devm_of_platform_depopulate(struct device *dev)
 712 {
 713         int ret;
 714
 715         ret = devres_release(dev, devm_of_platform_populate_release,
 716                              devm_of_platform_match, dev);
 717
 718         WARN_ON(ret);
 719 }
 720 EXPORT_SYMBOL_GPL(devm_of_platform_depopulate);
 721
 722 #ifdef CONFIG_OF_DYNAMIC
 723 static int of_platform_notify(struct notifier_block *nb,
 724                                 unsigned long action, void *arg)
 725 {
 726         struct of_reconfig_data *rd = arg;
 727         struct platform_device *pdev_parent, *pdev;
 728         bool children_left;
 729
 730         switch (of_reconfig_get_state_change(action, rd)) {
 731         case OF_RECONFIG_CHANGE_ADD:
 732                 /* verify that the parent is a bus */
 733                 if (!of_node_check_flag(rd->dn->parent, OF_POPULATED_BUS))
 734                         return NOTIFY_OK;       /* not for us */
 735
 736                 /* already populated? (driver using of_populate manually) */
 737                 if (of_node_check_flag(rd->dn, OF_POPULATED))
 738                         return NOTIFY_OK;
 739
 740                 /*
 741                  * Clear the flag before adding the device so that fw_devlink
 742                  * doesn't skip adding consumers to this device.
 743                  */
 744                 rd->dn->fwnode.flags &= ~FWNODE_FLAG_NOT_DEVICE;
 745                 /* pdev_parent may be NULL when no bus platform device */
 746                 pdev_parent = of_find_device_by_node(rd->dn->parent);
 747                 pdev = of_platform_device_create(rd->dn, NULL,
 748                                 pdev_parent ? &pdev_parent->dev : NULL);
 749                 platform_device_put(pdev_parent);
 750
 751                 if (pdev == NULL) {
 752                         pr_err("%s: failed to create for '%pOF'\n",
 753                                         __func__, rd->dn);
 754                         /* of_platform_device_create tosses the error code */
 755                         return notifier_from_errno(-EINVAL);
 756                 }
 757                 break;
 758
 759         case OF_RECONFIG_CHANGE_REMOVE:
 760
 761                 /* already depopulated? */
 762                 if (!of_node_check_flag(rd->dn, OF_POPULATED))
 763                         return NOTIFY_OK;
 764
 765                 /* find our device by node */
 766                 pdev = of_find_device_by_node(rd->dn);
 767                 if (pdev == NULL)
 768                         return NOTIFY_OK;       /* no? not meant for us */
 769
 770                 /* unregister takes one ref away */
 771                 of_platform_device_destroy(&pdev->dev, &children_left);
 772
 773                 /* and put the reference of the find */
 774                 platform_device_put(pdev);
 775                 break;
 776         }
 777
 778         return NOTIFY_OK;
 779 }
 780
 781 static struct notifier_block platform_of_notifier = {
 782         .notifier_call = of_platform_notify,
 783 };
 784
 785 void of_platform_register_reconfig_notifier(void)
 786 {
 787         WARN_ON(of_reconfig_notifier_register(&platform_of_notifier));
 788 }
 789 #endif /* CONFIG_OF_DYNAMIC */
 790
 791 #endif /* CONFIG_OF_ADDRESS */