1 // SPDX-License-Identifier: GPL-2.0+
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
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 /* Decode the IRQs and address ranges */
257 for (i
= 0; i
< AMBA_NR_IRQS
; i
++)
258 dev
->irq
[i
] = irq_of_parse_and_map(node
, i
);
260 ret
= of_address_to_resource(node
, 0, &dev
->res
);
262 pr_err("amba: of_address_to_resource() failed (%d) for %pOF\n",
267 ret
= amba_device_add(dev
, &iomem_resource
);
269 pr_err("amba_device_add() failed (%d) for %pOF\n",
277 amba_device_put(dev
);
279 of_node_clear_flag(node
, OF_POPULATED
);
282 #else /* CONFIG_ARM_AMBA */
283 static struct amba_device
*of_amba_device_create(struct device_node
*node
,
286 struct device
*parent
)
290 #endif /* CONFIG_ARM_AMBA */
293 * of_dev_lookup() - Given a device node, lookup the preferred Linux name
295 static const struct of_dev_auxdata
*of_dev_lookup(const struct of_dev_auxdata
*lookup
,
296 struct device_node
*np
)
298 const struct of_dev_auxdata
*auxdata
;
306 for (; auxdata
->compatible
; auxdata
++) {
307 if (!of_device_is_compatible(np
, auxdata
->compatible
))
310 if (!of_address_to_resource(np
, 0, &res
))
311 if (res
.start
!= auxdata
->phys_addr
)
313 pr_debug("%pOF: devname=%s\n", np
, auxdata
->name
);
320 /* Try compatible match if no phys_addr and name are specified */
322 for (; auxdata
->compatible
; auxdata
++) {
323 if (!of_device_is_compatible(np
, auxdata
->compatible
))
325 if (!auxdata
->phys_addr
&& !auxdata
->name
) {
326 pr_debug("%pOF: compatible match\n", np
);
335 * of_platform_bus_create() - Create a device for a node and its children.
336 * @bus: device node of the bus to instantiate
337 * @matches: match table for bus nodes
338 * @lookup: auxdata table for matching id and platform_data with device nodes
339 * @parent: parent for new device, or NULL for top level.
340 * @strict: require compatible property
342 * Creates a platform_device for the provided device_node, and optionally
343 * recursively create devices for all the child nodes.
345 static int of_platform_bus_create(struct device_node
*bus
,
346 const struct of_device_id
*matches
,
347 const struct of_dev_auxdata
*lookup
,
348 struct device
*parent
, bool strict
)
350 const struct of_dev_auxdata
*auxdata
;
351 struct device_node
*child
;
352 struct platform_device
*dev
;
353 const char *bus_id
= NULL
;
354 void *platform_data
= NULL
;
357 /* Make sure it has a compatible property */
358 if (strict
&& (!of_get_property(bus
, "compatible", NULL
))) {
359 pr_debug("%s() - skipping %pOF, no compatible prop\n",
364 /* Skip nodes for which we don't want to create devices */
365 if (unlikely(of_match_node(of_skipped_node_table
, bus
))) {
366 pr_debug("%s() - skipping %pOF node\n", __func__
, bus
);
370 if (of_node_check_flag(bus
, OF_POPULATED_BUS
)) {
371 pr_debug("%s() - skipping %pOF, already populated\n",
376 auxdata
= of_dev_lookup(lookup
, bus
);
378 bus_id
= auxdata
->name
;
379 platform_data
= auxdata
->platform_data
;
382 if (of_device_is_compatible(bus
, "arm,primecell")) {
384 * Don't return an error here to keep compatibility with older
387 of_amba_device_create(bus
, bus_id
, platform_data
, parent
);
391 dev
= of_platform_device_create_pdata(bus
, bus_id
, platform_data
, parent
);
392 if (!dev
|| !of_match_node(matches
, bus
))
395 for_each_child_of_node(bus
, child
) {
396 pr_debug(" create child: %pOF\n", child
);
397 rc
= of_platform_bus_create(child
, matches
, lookup
, &dev
->dev
, strict
);
403 of_node_set_flag(bus
, OF_POPULATED_BUS
);
408 * of_platform_bus_probe() - Probe the device-tree for platform buses
409 * @root: parent of the first level to probe or NULL for the root of the tree
410 * @matches: match table for bus nodes
411 * @parent: parent to hook devices from, NULL for toplevel
413 * Note that children of the provided root are not instantiated as devices
414 * unless the specified root itself matches the bus list and is not NULL.
416 int of_platform_bus_probe(struct device_node
*root
,
417 const struct of_device_id
*matches
,
418 struct device
*parent
)
420 struct device_node
*child
;
423 root
= root
? of_node_get(root
) : of_find_node_by_path("/");
427 pr_debug("%s()\n", __func__
);
428 pr_debug(" starting at: %pOF\n", root
);
430 /* Do a self check of bus type, if there's a match, create children */
431 if (of_match_node(matches
, root
)) {
432 rc
= of_platform_bus_create(root
, matches
, NULL
, parent
, false);
433 } else for_each_child_of_node(root
, child
) {
434 if (!of_match_node(matches
, child
))
436 rc
= of_platform_bus_create(child
, matches
, NULL
, parent
, false);
446 EXPORT_SYMBOL(of_platform_bus_probe
);
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
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).
462 * New board support should be using this function instead of
463 * of_platform_bus_probe().
465 * Return: 0 on success, < 0 on failure.
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
)
472 struct device_node
*child
;
475 root
= root
? of_node_get(root
) : of_find_node_by_path("/");
479 pr_debug("%s()\n", __func__
);
480 pr_debug(" starting at: %pOF\n", root
);
482 device_links_supplier_sync_state_pause();
483 for_each_child_of_node(root
, child
) {
484 rc
= of_platform_bus_create(child
, matches
, lookup
, parent
, true);
490 device_links_supplier_sync_state_resume();
492 of_node_set_flag(root
, OF_POPULATED_BUS
);
497 EXPORT_SYMBOL_GPL(of_platform_populate
);
499 int of_platform_default_populate(struct device_node
*root
,
500 const struct of_dev_auxdata
*lookup
,
501 struct device
*parent
)
503 return of_platform_populate(root
, of_default_bus_match_table
, lookup
,
506 EXPORT_SYMBOL_GPL(of_platform_default_populate
);
509 static const struct of_device_id reserved_mem_matches
[] = {
510 { .compatible
= "qcom,rmtfs-mem" },
511 { .compatible
= "qcom,cmd-db" },
512 { .compatible
= "ramoops" },
513 { .compatible
= "nvmem-rmem" },
517 static int __init
of_platform_default_populate_init(void)
519 struct device_node
*node
;
521 device_links_supplier_sync_state_pause();
523 if (!of_have_populated_dt())
527 * Handle certain compatibles explicitly, since we don't want to create
528 * platform_devices for every node in /reserved-memory with a
531 for_each_matching_node(node
, reserved_mem_matches
)
532 of_platform_device_create(node
, NULL
, NULL
);
534 node
= of_find_node_by_path("/firmware");
536 of_platform_populate(node
, NULL
, NULL
, NULL
);
540 /* Populate everything else. */
541 of_platform_default_populate(NULL
, NULL
, NULL
);
545 arch_initcall_sync(of_platform_default_populate_init
);
547 static int __init
of_platform_sync_state_init(void)
549 device_links_supplier_sync_state_resume();
552 late_initcall_sync(of_platform_sync_state_init
);
555 int of_platform_device_destroy(struct device
*dev
, void *data
)
557 /* Do not touch devices not populated from the device tree */
558 if (!dev
->of_node
|| !of_node_check_flag(dev
->of_node
, OF_POPULATED
))
561 /* Recurse for any nodes that were treated as busses */
562 if (of_node_check_flag(dev
->of_node
, OF_POPULATED_BUS
))
563 device_for_each_child(dev
, NULL
, of_platform_device_destroy
);
565 of_node_clear_flag(dev
->of_node
, OF_POPULATED
);
566 of_node_clear_flag(dev
->of_node
, OF_POPULATED_BUS
);
568 if (dev
->bus
== &platform_bus_type
)
569 platform_device_unregister(to_platform_device(dev
));
570 #ifdef CONFIG_ARM_AMBA
571 else if (dev
->bus
== &amba_bustype
)
572 amba_device_unregister(to_amba_device(dev
));
577 EXPORT_SYMBOL_GPL(of_platform_device_destroy
);
580 * of_platform_depopulate() - Remove devices populated from device tree
581 * @parent: device which children will be removed
583 * Complementary to of_platform_populate(), this function removes children
584 * of the given device (and, recurrently, their children) that have been
585 * created from their respective device tree nodes (and only those,
586 * leaving others - eg. manually created - unharmed).
588 void of_platform_depopulate(struct device
*parent
)
590 if (parent
->of_node
&& of_node_check_flag(parent
->of_node
, OF_POPULATED_BUS
)) {
591 device_for_each_child_reverse(parent
, NULL
, of_platform_device_destroy
);
592 of_node_clear_flag(parent
->of_node
, OF_POPULATED_BUS
);
595 EXPORT_SYMBOL_GPL(of_platform_depopulate
);
597 static void devm_of_platform_populate_release(struct device
*dev
, void *res
)
599 of_platform_depopulate(*(struct device
**)res
);
603 * devm_of_platform_populate() - Populate platform_devices from device tree data
604 * @dev: device that requested to populate from device tree data
606 * Similar to of_platform_populate(), but will automatically call
607 * of_platform_depopulate() when the device is unbound from the bus.
609 * Return: 0 on success, < 0 on failure.
611 int devm_of_platform_populate(struct device
*dev
)
619 ptr
= devres_alloc(devm_of_platform_populate_release
,
620 sizeof(*ptr
), GFP_KERNEL
);
624 ret
= of_platform_populate(dev
->of_node
, NULL
, NULL
, dev
);
629 devres_add(dev
, ptr
);
634 EXPORT_SYMBOL_GPL(devm_of_platform_populate
);
636 static int devm_of_platform_match(struct device
*dev
, void *res
, void *data
)
638 struct device
**ptr
= res
;
649 * devm_of_platform_depopulate() - Remove devices populated from device tree
650 * @dev: device that requested to depopulate from device tree data
652 * Complementary to devm_of_platform_populate(), this function removes children
653 * of the given device (and, recurrently, their children) that have been
654 * created from their respective device tree nodes (and only those,
655 * leaving others - eg. manually created - unharmed).
657 void devm_of_platform_depopulate(struct device
*dev
)
661 ret
= devres_release(dev
, devm_of_platform_populate_release
,
662 devm_of_platform_match
, dev
);
666 EXPORT_SYMBOL_GPL(devm_of_platform_depopulate
);
668 #ifdef CONFIG_OF_DYNAMIC
669 static int of_platform_notify(struct notifier_block
*nb
,
670 unsigned long action
, void *arg
)
672 struct of_reconfig_data
*rd
= arg
;
673 struct platform_device
*pdev_parent
, *pdev
;
676 switch (of_reconfig_get_state_change(action
, rd
)) {
677 case OF_RECONFIG_CHANGE_ADD
:
678 /* verify that the parent is a bus */
679 if (!of_node_check_flag(rd
->dn
->parent
, OF_POPULATED_BUS
))
680 return NOTIFY_OK
; /* not for us */
682 /* already populated? (driver using of_populate manually) */
683 if (of_node_check_flag(rd
->dn
, OF_POPULATED
))
686 /* pdev_parent may be NULL when no bus platform device */
687 pdev_parent
= of_find_device_by_node(rd
->dn
->parent
);
688 pdev
= of_platform_device_create(rd
->dn
, NULL
,
689 pdev_parent
? &pdev_parent
->dev
: NULL
);
690 platform_device_put(pdev_parent
);
693 pr_err("%s: failed to create for '%pOF'\n",
695 /* of_platform_device_create tosses the error code */
696 return notifier_from_errno(-EINVAL
);
700 case OF_RECONFIG_CHANGE_REMOVE
:
702 /* already depopulated? */
703 if (!of_node_check_flag(rd
->dn
, OF_POPULATED
))
706 /* find our device by node */
707 pdev
= of_find_device_by_node(rd
->dn
);
709 return NOTIFY_OK
; /* no? not meant for us */
711 /* unregister takes one ref away */
712 of_platform_device_destroy(&pdev
->dev
, &children_left
);
714 /* and put the reference of the find */
715 platform_device_put(pdev
);
722 static struct notifier_block platform_of_notifier
= {
723 .notifier_call
= of_platform_notify
,
726 void of_platform_register_reconfig_notifier(void)
728 WARN_ON(of_reconfig_notifier_register(&platform_of_notifier
));
730 #endif /* CONFIG_OF_DYNAMIC */
732 #endif /* CONFIG_OF_ADDRESS */