1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2006 Benjamin Herrenschmidt, IBM Corp.
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
10 #define pr_fmt(fmt) "OF: " fmt
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>
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 */
34 static const struct of_device_id of_skipped_node_table[] = {
35 { .compatible = "operating-points-v2", },
36 {} /* Empty terminated list */
40 * of_find_device_by_node - Find the platform_device associated with a node
41 * @np: Pointer to device tree node
43 * Takes a reference to the embedded struct device which needs to be dropped
46 * Return: platform_device pointer, or NULL if not found
48 struct platform_device *of_find_device_by_node(struct device_node *np)
52 dev = bus_find_device_by_of_node(&platform_bus_type, np);
53 return dev ? to_platform_device(dev) : NULL;
55 EXPORT_SYMBOL(of_find_device_by_node);
57 #ifdef CONFIG_OF_ADDRESS
59 * The following routines scan a subtree and registers a device for
60 * each applicable node.
62 * Note: sparc doesn't use these routines because it has a different
63 * mechanism for creating devices from device tree nodes.
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
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.
74 static void of_device_make_bus_id(struct device *dev)
76 struct device_node *node = dev->of_node;
80 /* Construct the name, using parent nodes if necessary to ensure uniqueness */
81 while (node->parent) {
83 * If the address can be translated, then that is as much
84 * uniqueness as we need. Make it the first component and return
86 reg = of_get_property(node, "reg", NULL);
87 if (reg && (addr = of_translate_address(node, reg)) != OF_BAD_ADDR) {
88 dev_set_name(dev, dev_name(dev) ? "%llx.%pOFn:%s" : "%llx.%pOFn",
89 addr, node, dev_name(dev));
93 /* format arguments only used if dev_name() resolves to NULL */
94 dev_set_name(dev, dev_name(dev) ? "%s:%s" : "%s",
95 kbasename(node->full_name), dev_name(dev));
101 * of_device_alloc - Allocate and initialize an of_device
102 * @np: device node to assign to device
103 * @bus_id: Name to assign to the device. May be null to use default name.
104 * @parent: Parent device.
106 struct platform_device *of_device_alloc(struct device_node *np,
108 struct device *parent)
110 struct platform_device *dev;
111 int rc, i, num_reg = 0, num_irq;
112 struct resource *res, temp_res;
114 dev = platform_device_alloc("", PLATFORM_DEVID_NONE);
118 /* count the io and irq resources */
119 while (of_address_to_resource(np, num_reg, &temp_res) == 0)
121 num_irq = of_irq_count(np);
123 /* Populate the resource table */
124 if (num_irq || num_reg) {
125 res = kcalloc(num_irq + num_reg, sizeof(*res), GFP_KERNEL);
127 platform_device_put(dev);
131 dev->num_resources = num_reg + num_irq;
133 for (i = 0; i < num_reg; i++, res++) {
134 rc = of_address_to_resource(np, i, res);
137 if (of_irq_to_resource_table(np, res, num_irq) != num_irq)
138 pr_debug("not all legacy IRQ resources mapped for %pOFn\n",
142 dev->dev.of_node = of_node_get(np);
143 dev->dev.fwnode = &np->fwnode;
144 dev->dev.parent = parent ? : &platform_bus;
147 dev_set_name(&dev->dev, "%s", bus_id);
149 of_device_make_bus_id(&dev->dev);
153 EXPORT_SYMBOL(of_device_alloc);
156 * of_platform_device_create_pdata - Alloc, initialize and register an of_device
157 * @np: pointer to node to create device for
158 * @bus_id: name to assign device
159 * @platform_data: pointer to populate platform_data pointer with
160 * @parent: Linux device model parent device.
162 * Return: Pointer to created platform device, or NULL if a device was not
163 * registered. Unavailable devices will not get registered.
165 static struct platform_device *of_platform_device_create_pdata(
166 struct device_node *np,
169 struct device *parent)
171 struct platform_device *dev;
173 if (!of_device_is_available(np) ||
174 of_node_test_and_set_flag(np, OF_POPULATED))
177 dev = of_device_alloc(np, bus_id, parent);
181 dev->dev.coherent_dma_mask = DMA_BIT_MASK(32);
182 if (!dev->dev.dma_mask)
183 dev->dev.dma_mask = &dev->dev.coherent_dma_mask;
184 dev->dev.bus = &platform_bus_type;
185 dev->dev.platform_data = platform_data;
186 of_msi_configure(&dev->dev, dev->dev.of_node);
188 if (of_device_add(dev) != 0) {
189 platform_device_put(dev);
196 of_node_clear_flag(np, OF_POPULATED);
201 * of_platform_device_create - Alloc, initialize and register an of_device
202 * @np: pointer to node to create device for
203 * @bus_id: name to assign device
204 * @parent: Linux device model parent device.
206 * Return: Pointer to created platform device, or NULL if a device was not
207 * registered. Unavailable devices will not get registered.
209 struct platform_device *of_platform_device_create(struct device_node *np,
211 struct device *parent)
213 return of_platform_device_create_pdata(np, bus_id, NULL, parent);
215 EXPORT_SYMBOL(of_platform_device_create);
217 #ifdef CONFIG_ARM_AMBA
218 static struct amba_device *of_amba_device_create(struct device_node *node,
221 struct device *parent)
223 struct amba_device *dev;
227 pr_debug("Creating amba device %pOF\n", node);
229 if (!of_device_is_available(node) ||
230 of_node_test_and_set_flag(node, OF_POPULATED))
233 dev = amba_device_alloc(NULL, 0, 0);
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;
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;
247 dev_set_name(&dev->dev, "%s", bus_id);
249 of_device_make_bus_id(&dev->dev);
251 /* Allow the HW Peripheral ID to be overridden */
252 prop = of_get_property(node, "arm,primecell-periphid", NULL);
254 dev->periphid = of_read_ulong(prop, 1);
256 ret = of_address_to_resource(node, 0, &dev->res);
258 pr_err("amba: of_address_to_resource() failed (%d) for %pOF\n",
263 ret = amba_device_add(dev, &iomem_resource);
265 pr_err("amba_device_add() failed (%d) for %pOF\n",
273 amba_device_put(dev);
275 of_node_clear_flag(node, OF_POPULATED);
278 #else /* CONFIG_ARM_AMBA */
279 static struct amba_device *of_amba_device_create(struct device_node *node,
282 struct device *parent)
286 #endif /* CONFIG_ARM_AMBA */
289 * of_dev_lookup() - Given a device node, lookup the preferred Linux name
291 static const struct of_dev_auxdata *of_dev_lookup(const struct of_dev_auxdata *lookup,
292 struct device_node *np)
294 const struct of_dev_auxdata *auxdata;
302 for (; auxdata->compatible; auxdata++) {
303 if (!of_device_is_compatible(np, auxdata->compatible))
306 if (!of_address_to_resource(np, 0, &res))
307 if (res.start != auxdata->phys_addr)
309 pr_debug("%pOF: devname=%s\n", np, auxdata->name);
316 /* Try compatible match if no phys_addr and name are specified */
318 for (; auxdata->compatible; auxdata++) {
319 if (!of_device_is_compatible(np, auxdata->compatible))
321 if (!auxdata->phys_addr && !auxdata->name) {
322 pr_debug("%pOF: compatible match\n", np);
331 * of_platform_bus_create() - Create a device for a node and its children.
332 * @bus: device node of the bus to instantiate
333 * @matches: match table for bus nodes
334 * @lookup: auxdata table for matching id and platform_data with device nodes
335 * @parent: parent for new device, or NULL for top level.
336 * @strict: require compatible property
338 * Creates a platform_device for the provided device_node, and optionally
339 * recursively create devices for all the child nodes.
341 static int of_platform_bus_create(struct device_node *bus,
342 const struct of_device_id *matches,
343 const struct of_dev_auxdata *lookup,
344 struct device *parent, bool strict)
346 const struct of_dev_auxdata *auxdata;
347 struct device_node *child;
348 struct platform_device *dev;
349 const char *bus_id = NULL;
350 void *platform_data = NULL;
353 /* Make sure it has a compatible property */
354 if (strict && (!of_get_property(bus, "compatible", NULL))) {
355 pr_debug("%s() - skipping %pOF, no compatible prop\n",
360 /* Skip nodes for which we don't want to create devices */
361 if (unlikely(of_match_node(of_skipped_node_table, bus))) {
362 pr_debug("%s() - skipping %pOF node\n", __func__, bus);
366 if (of_node_check_flag(bus, OF_POPULATED_BUS)) {
367 pr_debug("%s() - skipping %pOF, already populated\n",
372 auxdata = of_dev_lookup(lookup, bus);
374 bus_id = auxdata->name;
375 platform_data = auxdata->platform_data;
378 if (of_device_is_compatible(bus, "arm,primecell")) {
380 * Don't return an error here to keep compatibility with older
383 of_amba_device_create(bus, bus_id, platform_data, parent);
387 dev = of_platform_device_create_pdata(bus, bus_id, platform_data, parent);
388 if (!dev || !of_match_node(matches, bus))
391 for_each_child_of_node(bus, child) {
392 pr_debug(" create child: %pOF\n", child);
393 rc = of_platform_bus_create(child, matches, lookup, &dev->dev, strict);
399 of_node_set_flag(bus, OF_POPULATED_BUS);
404 * of_platform_bus_probe() - Probe the device-tree for platform buses
405 * @root: parent of the first level to probe or NULL for the root of the tree
406 * @matches: match table for bus nodes
407 * @parent: parent to hook devices from, NULL for toplevel
409 * Note that children of the provided root are not instantiated as devices
410 * unless the specified root itself matches the bus list and is not NULL.
412 int of_platform_bus_probe(struct device_node *root,
413 const struct of_device_id *matches,
414 struct device *parent)
416 struct device_node *child;
419 root = root ? of_node_get(root) : of_find_node_by_path("/");
423 pr_debug("%s()\n", __func__);
424 pr_debug(" starting at: %pOF\n", root);
426 /* Do a self check of bus type, if there's a match, create children */
427 if (of_match_node(matches, root)) {
428 rc = of_platform_bus_create(root, matches, NULL, parent, false);
429 } else for_each_child_of_node(root, child) {
430 if (!of_match_node(matches, child))
432 rc = of_platform_bus_create(child, matches, NULL, parent, false);
442 EXPORT_SYMBOL(of_platform_bus_probe);
445 * of_platform_populate() - Populate platform_devices from device tree data
446 * @root: parent of the first level to probe or NULL for the root of the tree
447 * @matches: match table, NULL to use the default
448 * @lookup: auxdata table for matching id and platform_data with device nodes
449 * @parent: parent to hook devices from, NULL for toplevel
451 * Similar to of_platform_bus_probe(), this function walks the device tree
452 * and creates devices from nodes. It differs in that it follows the modern
453 * convention of requiring all device nodes to have a 'compatible' property,
454 * and it is suitable for creating devices which are children of the root
455 * node (of_platform_bus_probe will only create children of the root which
456 * are selected by the @matches argument).
458 * New board support should be using this function instead of
459 * of_platform_bus_probe().
461 * Return: 0 on success, < 0 on failure.
463 int of_platform_populate(struct device_node *root,
464 const struct of_device_id *matches,
465 const struct of_dev_auxdata *lookup,
466 struct device *parent)
468 struct device_node *child;
471 root = root ? of_node_get(root) : of_find_node_by_path("/");
475 pr_debug("%s()\n", __func__);
476 pr_debug(" starting at: %pOF\n", root);
478 device_links_supplier_sync_state_pause();
479 for_each_child_of_node(root, child) {
480 rc = of_platform_bus_create(child, matches, lookup, parent, true);
486 device_links_supplier_sync_state_resume();
488 of_node_set_flag(root, OF_POPULATED_BUS);
493 EXPORT_SYMBOL_GPL(of_platform_populate);
495 int of_platform_default_populate(struct device_node *root,
496 const struct of_dev_auxdata *lookup,
497 struct device *parent)
499 return of_platform_populate(root, of_default_bus_match_table, lookup,
502 EXPORT_SYMBOL_GPL(of_platform_default_populate);
505 static const struct of_device_id reserved_mem_matches[] = {
506 { .compatible = "qcom,rmtfs-mem" },
507 { .compatible = "qcom,cmd-db" },
508 { .compatible = "qcom,smem" },
509 { .compatible = "ramoops" },
510 { .compatible = "nvmem-rmem" },
514 static int __init of_platform_default_populate_init(void)
516 struct device_node *node;
518 device_links_supplier_sync_state_pause();
520 if (!of_have_populated_dt())
524 * Handle certain compatibles explicitly, since we don't want to create
525 * platform_devices for every node in /reserved-memory with a
528 for_each_matching_node(node, reserved_mem_matches)
529 of_platform_device_create(node, NULL, NULL);
531 node = of_find_node_by_path("/firmware");
533 of_platform_populate(node, NULL, NULL, NULL);
537 /* Populate everything else. */
538 of_platform_default_populate(NULL, NULL, NULL);
542 arch_initcall_sync(of_platform_default_populate_init);
544 static int __init of_platform_sync_state_init(void)
546 device_links_supplier_sync_state_resume();
549 late_initcall_sync(of_platform_sync_state_init);
552 int of_platform_device_destroy(struct device *dev, void *data)
554 /* Do not touch devices not populated from the device tree */
555 if (!dev->of_node || !of_node_check_flag(dev->of_node, OF_POPULATED))
558 /* Recurse for any nodes that were treated as busses */
559 if (of_node_check_flag(dev->of_node, OF_POPULATED_BUS))
560 device_for_each_child(dev, NULL, of_platform_device_destroy);
562 of_node_clear_flag(dev->of_node, OF_POPULATED);
563 of_node_clear_flag(dev->of_node, OF_POPULATED_BUS);
565 if (dev->bus == &platform_bus_type)
566 platform_device_unregister(to_platform_device(dev));
567 #ifdef CONFIG_ARM_AMBA
568 else if (dev->bus == &amba_bustype)
569 amba_device_unregister(to_amba_device(dev));
574 EXPORT_SYMBOL_GPL(of_platform_device_destroy);
577 * of_platform_depopulate() - Remove devices populated from device tree
578 * @parent: device which children will be removed
580 * Complementary to of_platform_populate(), this function removes children
581 * of the given device (and, recurrently, their children) that have been
582 * created from their respective device tree nodes (and only those,
583 * leaving others - eg. manually created - unharmed).
585 void of_platform_depopulate(struct device *parent)
587 if (parent->of_node && of_node_check_flag(parent->of_node, OF_POPULATED_BUS)) {
588 device_for_each_child_reverse(parent, NULL, of_platform_device_destroy);
589 of_node_clear_flag(parent->of_node, OF_POPULATED_BUS);
592 EXPORT_SYMBOL_GPL(of_platform_depopulate);
594 static void devm_of_platform_populate_release(struct device *dev, void *res)
596 of_platform_depopulate(*(struct device **)res);
600 * devm_of_platform_populate() - Populate platform_devices from device tree data
601 * @dev: device that requested to populate from device tree data
603 * Similar to of_platform_populate(), but will automatically call
604 * of_platform_depopulate() when the device is unbound from the bus.
606 * Return: 0 on success, < 0 on failure.
608 int devm_of_platform_populate(struct device *dev)
616 ptr = devres_alloc(devm_of_platform_populate_release,
617 sizeof(*ptr), GFP_KERNEL);
621 ret = of_platform_populate(dev->of_node, NULL, NULL, dev);
626 devres_add(dev, ptr);
631 EXPORT_SYMBOL_GPL(devm_of_platform_populate);
633 static int devm_of_platform_match(struct device *dev, void *res, void *data)
635 struct device **ptr = res;
646 * devm_of_platform_depopulate() - Remove devices populated from device tree
647 * @dev: device that requested to depopulate from device tree data
649 * Complementary to devm_of_platform_populate(), this function removes children
650 * of the given device (and, recurrently, their children) that have been
651 * created from their respective device tree nodes (and only those,
652 * leaving others - eg. manually created - unharmed).
654 void devm_of_platform_depopulate(struct device *dev)
658 ret = devres_release(dev, devm_of_platform_populate_release,
659 devm_of_platform_match, dev);
663 EXPORT_SYMBOL_GPL(devm_of_platform_depopulate);
665 #ifdef CONFIG_OF_DYNAMIC
666 static int of_platform_notify(struct notifier_block *nb,
667 unsigned long action, void *arg)
669 struct of_reconfig_data *rd = arg;
670 struct platform_device *pdev_parent, *pdev;
673 switch (of_reconfig_get_state_change(action, rd)) {
674 case OF_RECONFIG_CHANGE_ADD:
675 /* verify that the parent is a bus */
676 if (!of_node_check_flag(rd->dn->parent, OF_POPULATED_BUS))
677 return NOTIFY_OK; /* not for us */
679 /* already populated? (driver using of_populate manually) */
680 if (of_node_check_flag(rd->dn, OF_POPULATED))
683 /* pdev_parent may be NULL when no bus platform device */
684 pdev_parent = of_find_device_by_node(rd->dn->parent);
685 pdev = of_platform_device_create(rd->dn, NULL,
686 pdev_parent ? &pdev_parent->dev : NULL);
687 platform_device_put(pdev_parent);
690 pr_err("%s: failed to create for '%pOF'\n",
692 /* of_platform_device_create tosses the error code */
693 return notifier_from_errno(-EINVAL);
697 case OF_RECONFIG_CHANGE_REMOVE:
699 /* already depopulated? */
700 if (!of_node_check_flag(rd->dn, OF_POPULATED))
703 /* find our device by node */
704 pdev = of_find_device_by_node(rd->dn);
706 return NOTIFY_OK; /* no? not meant for us */
708 /* unregister takes one ref away */
709 of_platform_device_destroy(&pdev->dev, &children_left);
711 /* and put the reference of the find */
712 platform_device_put(pdev);
719 static struct notifier_block platform_of_notifier = {
720 .notifier_call = of_platform_notify,
723 void of_platform_register_reconfig_notifier(void)
725 WARN_ON(of_reconfig_notifier_register(&platform_of_notifier));
727 #endif /* CONFIG_OF_DYNAMIC */
729 #endif /* CONFIG_OF_ADDRESS */