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