blob: 3371e4a0624838516a7ae6bbb62862fd17eed711 [file] [log] [blame]
Rob Herringaf6074f2017-12-27 12:55:14 -06001// SPDX-License-Identifier: GPL-2.0+
Stephen Rothwell3f23de12007-05-03 02:38:57 +10002/*
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
Stephen Rothwell3f23de12007-05-03 02:38:57 +10008 */
Rob Herring606ad422016-06-15 08:32:18 -05009
10#define pr_fmt(fmt) "OF: " fmt
11
Stephen Rothwell3f23de12007-05-03 02:38:57 +100012#include <linux/errno.h>
Stephen Rothwell5c457082007-10-17 21:17:42 -070013#include <linux/module.h>
Grant Likely5de15402011-06-21 10:59:34 -060014#include <linux/amba/bus.h>
Stephen Rothwell3f23de12007-05-03 02:38:57 +100015#include <linux/device.h>
Grant Likely5fd200f2010-06-08 07:48:13 -060016#include <linux/dma-mapping.h>
Grant Likely50ef5282010-06-08 07:48:20 -060017#include <linux/slab.h>
Grant Likely9e3288d2010-06-08 07:48:26 -060018#include <linux/of_address.h>
Stephen Rothwell3f23de12007-05-03 02:38:57 +100019#include <linux/of_device.h>
Sricharan R09515ef2017-04-10 16:51:01 +053020#include <linux/of_iommu.h>
Grant Likely9e3288d2010-06-08 07:48:26 -060021#include <linux/of_irq.h>
Stephen Rothwell3f23de12007-05-03 02:38:57 +100022#include <linux/of_platform.h>
Grant Likelyeca39302010-06-08 07:48:21 -060023#include <linux/platform_device.h>
24
Grant Likelycbb49c22011-06-21 10:59:34 -060025const struct of_device_id of_default_bus_match_table[] = {
26 { .compatible = "simple-bus", },
Linus Walleij22869a92015-03-03 09:52:20 +010027 { .compatible = "simple-mfd", },
Paul Burtonecd76ed2016-09-19 22:21:24 +010028 { .compatible = "isa", },
Grant Likelycbb49c22011-06-21 10:59:34 -060029#ifdef CONFIG_ARM_AMBA
30 { .compatible = "arm,amba-bus", },
31#endif /* CONFIG_ARM_AMBA */
32 {} /* Empty terminated list */
33};
34
Viresh Kumar4550fe62018-04-17 11:57:34 +053035static const struct of_device_id of_skipped_node_table[] = {
36 { .compatible = "operating-points-v2", },
37 {} /* Empty terminated list */
38};
39
Jonas Bonnc6085582010-07-23 19:19:35 +020040/**
41 * of_find_device_by_node - Find the platform_device associated with a node
42 * @np: Pointer to device tree node
43 *
Johan Hovold4fb373d2016-11-01 11:53:22 +010044 * Takes a reference to the embedded struct device which needs to be dropped
45 * after use.
46 *
Jonas Bonnc6085582010-07-23 19:19:35 +020047 * Returns platform_device pointer, or NULL if not found
48 */
49struct platform_device *of_find_device_by_node(struct device_node *np)
50{
51 struct device *dev;
52
Suzuki K Poulosecfba5de2019-07-23 23:18:33 +010053 dev = bus_find_device_by_of_node(&platform_bus_type, np);
Jonas Bonnc6085582010-07-23 19:19:35 +020054 return dev ? to_platform_device(dev) : NULL;
55}
56EXPORT_SYMBOL(of_find_device_by_node);
57
Grant Likely964dba22012-02-24 14:58:34 -070058#ifdef CONFIG_OF_ADDRESS
Grant Likely5fd200f2010-06-08 07:48:13 -060059/*
60 * The following routines scan a subtree and registers a device for
61 * each applicable node.
62 *
63 * Note: sparc doesn't use these routines because it has a different
64 * mechanism for creating devices from device tree nodes.
65 */
66
67/**
Grant Likely94c09312010-06-08 07:48:14 -060068 * of_device_make_bus_id - Use the device node data to assign a unique name
69 * @dev: pointer to device structure that is linked to a device tree node
70 *
Grant Likely07e461c2014-05-21 15:40:31 +090071 * This routine will first try using the translated bus address to
72 * derive a unique name. If it cannot, then it will prepend names from
73 * parent nodes until a unique name can be derived.
Grant Likely94c09312010-06-08 07:48:14 -060074 */
Frank Rowande553f532016-10-17 12:17:43 -070075static void of_device_make_bus_id(struct device *dev)
Grant Likely94c09312010-06-08 07:48:14 -060076{
Grant Likely94c09312010-06-08 07:48:14 -060077 struct device_node *node = dev->of_node;
Kim Phillips24fb5302012-10-08 19:42:11 -050078 const __be32 *reg;
Grant Likely94c09312010-06-08 07:48:14 -060079 u64 addr;
Grant Likely94c09312010-06-08 07:48:14 -060080
Grant Likely07e461c2014-05-21 15:40:31 +090081 /* 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) {
Rob Herringa613b262018-08-27 20:00:19 -050089 dev_set_name(dev, dev_name(dev) ? "%llx.%pOFn:%s" : "%llx.%pOFn",
Geert Uytterhoevend88590d2019-06-24 14:46:20 +020090 addr, node, dev_name(dev));
Grant Likely94c09312010-06-08 07:48:14 -060091 return;
92 }
Grant Likely94c09312010-06-08 07:48:14 -060093
Grant Likely07e461c2014-05-21 15:40:31 +090094 /* format arguments only used if dev_name() resolves to NULL */
95 dev_set_name(dev, dev_name(dev) ? "%s:%s" : "%s",
Rob Herring95e6b1f2017-06-01 18:00:00 -050096 kbasename(node->full_name), dev_name(dev));
Grant Likely07e461c2014-05-21 15:40:31 +090097 node = node->parent;
Grant Likely94c09312010-06-08 07:48:14 -060098 }
Grant Likely94c09312010-06-08 07:48:14 -060099}
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 */
Grant Likely94a0cb12010-07-22 13:59:23 -0600107struct platform_device *of_device_alloc(struct device_node *np,
Grant Likely94c09312010-06-08 07:48:14 -0600108 const char *bus_id,
109 struct device *parent)
110{
Grant Likely94a0cb12010-07-22 13:59:23 -0600111 struct platform_device *dev;
Andres Salomon52f65372010-10-10 21:35:05 -0600112 int rc, i, num_reg = 0, num_irq;
Grant Likelyac80a512010-06-08 07:48:15 -0600113 struct resource *res, temp_res;
Grant Likely94c09312010-06-08 07:48:14 -0600114
Andy Shevchenko6d7e3bf82017-08-25 18:33:13 +0300115 dev = platform_device_alloc("", PLATFORM_DEVID_NONE);
Grant Likely7096d042010-10-20 11:45:13 -0600116 if (!dev)
117 return NULL;
118
119 /* count the io and irq resources */
Rob Herringd9c68662014-05-07 15:23:56 -0500120 while (of_address_to_resource(np, num_reg, &temp_res) == 0)
121 num_reg++;
Andres Salomon52f65372010-10-10 21:35:05 -0600122 num_irq = of_irq_count(np);
Grant Likelyac80a512010-06-08 07:48:15 -0600123
Grant Likelyac80a512010-06-08 07:48:15 -0600124 /* Populate the resource table */
125 if (num_irq || num_reg) {
Kees Cook6396bb22018-06-12 14:03:40 -0700126 res = kcalloc(num_irq + num_reg, sizeof(*res), GFP_KERNEL);
Grant Likely7096d042010-10-20 11:45:13 -0600127 if (!res) {
128 platform_device_put(dev);
129 return NULL;
130 }
131
Grant Likelyac80a512010-06-08 07:48:15 -0600132 dev->num_resources = num_reg + num_irq;
133 dev->resource = res;
134 for (i = 0; i < num_reg; i++, res++) {
135 rc = of_address_to_resource(np, i, res);
136 WARN_ON(rc);
137 }
Rob Herring9ec36ca2014-04-23 17:57:41 -0500138 if (of_irq_to_resource_table(np, res, num_irq) != num_irq)
Rob Herringa613b262018-08-27 20:00:19 -0500139 pr_debug("not all legacy IRQ resources mapped for %pOFn\n",
140 np);
Grant Likelyac80a512010-06-08 07:48:15 -0600141 }
Grant Likely94c09312010-06-08 07:48:14 -0600142
143 dev->dev.of_node = of_node_get(np);
Robin Murphyf94277a2016-09-14 16:01:24 +0100144 dev->dev.fwnode = &np->fwnode;
Grant Likely43c07672014-11-04 10:26:26 +0000145 dev->dev.parent = parent ? : &platform_bus;
Grant Likely94c09312010-06-08 07:48:14 -0600146
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}
154EXPORT_SYMBOL(of_device_alloc);
155
Santosh Shilimkar591c1ee2014-04-24 11:30:04 -0400156/**
Grant Likely15c35972011-06-21 10:59:35 -0600157 * of_platform_device_create_pdata - Alloc, initialize and register an of_device
Grant Likely5fd200f2010-06-08 07:48:13 -0600158 * @np: pointer to node to create device for
159 * @bus_id: name to assign device
Grant Likely15c35972011-06-21 10:59:35 -0600160 * @platform_data: pointer to populate platform_data pointer with
Grant Likely5fd200f2010-06-08 07:48:13 -0600161 * @parent: Linux device model parent device.
Grant Likelycd1e6502011-01-03 15:51:11 -0700162 *
163 * Returns pointer to created platform device, or NULL if a device was not
164 * registered. Unavailable devices will not get registered.
Grant Likely5fd200f2010-06-08 07:48:13 -0600165 */
Mark Brown245d9642013-07-01 20:26:52 +0100166static struct platform_device *of_platform_device_create_pdata(
Grant Likely15c35972011-06-21 10:59:35 -0600167 struct device_node *np,
168 const char *bus_id,
169 void *platform_data,
170 struct device *parent)
Grant Likely5fd200f2010-06-08 07:48:13 -0600171{
Grant Likely94a0cb12010-07-22 13:59:23 -0600172 struct platform_device *dev;
Grant Likely5fd200f2010-06-08 07:48:13 -0600173
Pawel Mollc6e126d2014-05-15 16:55:24 +0100174 if (!of_device_is_available(np) ||
175 of_node_test_and_set_flag(np, OF_POPULATED))
Grant Likelycd1e6502011-01-03 15:51:11 -0700176 return NULL;
177
Grant Likely5fd200f2010-06-08 07:48:13 -0600178 dev = of_device_alloc(np, bus_id, parent);
179 if (!dev)
Pawel Mollc6e126d2014-05-15 16:55:24 +0100180 goto err_clear_flag;
Grant Likely5fd200f2010-06-08 07:48:13 -0600181
Robin Murphya5516212018-07-27 15:14:15 +0100182 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;
Grant Likelyeca39302010-06-08 07:48:21 -0600185 dev->dev.bus = &platform_bus_type;
Grant Likely15c35972011-06-21 10:59:35 -0600186 dev->dev.platform_data = platform_data;
Marc Zyngierc706c232015-07-28 14:46:15 +0100187 of_msi_configure(&dev->dev, dev->dev.of_node);
Grant Likely5fd200f2010-06-08 07:48:13 -0600188
Grant Likely7096d042010-10-20 11:45:13 -0600189 if (of_device_add(dev) != 0) {
190 platform_device_put(dev);
Pawel Mollc6e126d2014-05-15 16:55:24 +0100191 goto err_clear_flag;
Grant Likely5fd200f2010-06-08 07:48:13 -0600192 }
193
194 return dev;
Pawel Mollc6e126d2014-05-15 16:55:24 +0100195
196err_clear_flag:
197 of_node_clear_flag(np, OF_POPULATED);
198 return NULL;
Grant Likely5fd200f2010-06-08 07:48:13 -0600199}
Grant Likely15c35972011-06-21 10:59:35 -0600200
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 * Returns pointer to created platform device, or NULL if a device was not
208 * registered. Unavailable devices will not get registered.
209 */
210struct 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}
Grant Likely5fd200f2010-06-08 07:48:13 -0600216EXPORT_SYMBOL(of_platform_device_create);
217
Grant Likely5de15402011-06-21 10:59:34 -0600218#ifdef CONFIG_ARM_AMBA
219static 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 const void *prop;
226 int i, ret;
227
Rob Herring0d638a02017-06-01 15:50:55 -0500228 pr_debug("Creating amba device %pOF\n", node);
Grant Likely5de15402011-06-21 10:59:34 -0600229
Pawel Mollc6e126d2014-05-15 16:55:24 +0100230 if (!of_device_is_available(node) ||
231 of_node_test_and_set_flag(node, OF_POPULATED))
Grant Likely5de15402011-06-21 10:59:34 -0600232 return NULL;
233
Russell Kingc0f72f82011-12-18 11:45:17 +0000234 dev = amba_device_alloc(NULL, 0, 0);
Rob Herring606ad422016-06-15 08:32:18 -0500235 if (!dev)
Pawel Mollc6e126d2014-05-15 16:55:24 +0100236 goto err_clear_flag;
Grant Likely5de15402011-06-21 10:59:34 -0600237
Linus Walleij8c89ef72018-08-31 16:13:07 +0200238 /* AMBA devices only support a single DMA mask */
239 dev->dev.coherent_dma_mask = DMA_BIT_MASK(32);
240 dev->dev.dma_mask = &dev->dev.coherent_dma_mask;
241
Grant Likely5de15402011-06-21 10:59:34 -0600242 /* setup generic device info */
Grant Likely5de15402011-06-21 10:59:34 -0600243 dev->dev.of_node = of_node_get(node);
Robin Murphyf94277a2016-09-14 16:01:24 +0100244 dev->dev.fwnode = &node->fwnode;
Grant Likely43c07672014-11-04 10:26:26 +0000245 dev->dev.parent = parent ? : &platform_bus;
Grant Likely5de15402011-06-21 10:59:34 -0600246 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
Grant Likely5de15402011-06-21 10:59:34 -0600252 /* Allow the HW Peripheral ID to be overridden */
253 prop = of_get_property(node, "arm,primecell-periphid", NULL);
254 if (prop)
255 dev->periphid = of_read_ulong(prop, 1);
256
257 /* Decode the IRQs and address ranges */
258 for (i = 0; i < AMBA_NR_IRQS; i++)
259 dev->irq[i] = irq_of_parse_and_map(node, i);
260
261 ret = of_address_to_resource(node, 0, &dev->res);
Bartlomiej Zolnierkiewicz2bc552d2013-08-30 13:17:29 +0200262 if (ret) {
Rob Herring0d638a02017-06-01 15:50:55 -0500263 pr_err("amba: of_address_to_resource() failed (%d) for %pOF\n",
264 ret, node);
Grant Likely5de15402011-06-21 10:59:34 -0600265 goto err_free;
Bartlomiej Zolnierkiewicz2bc552d2013-08-30 13:17:29 +0200266 }
Grant Likely5de15402011-06-21 10:59:34 -0600267
Russell Kingc0f72f82011-12-18 11:45:17 +0000268 ret = amba_device_add(dev, &iomem_resource);
Bartlomiej Zolnierkiewicz2bc552d2013-08-30 13:17:29 +0200269 if (ret) {
Rob Herring0d638a02017-06-01 15:50:55 -0500270 pr_err("amba_device_add() failed (%d) for %pOF\n",
271 ret, node);
Grant Likely5de15402011-06-21 10:59:34 -0600272 goto err_free;
Bartlomiej Zolnierkiewicz2bc552d2013-08-30 13:17:29 +0200273 }
Grant Likely5de15402011-06-21 10:59:34 -0600274
275 return dev;
276
277err_free:
Russell Kingc0f72f82011-12-18 11:45:17 +0000278 amba_device_put(dev);
Pawel Mollc6e126d2014-05-15 16:55:24 +0100279err_clear_flag:
280 of_node_clear_flag(node, OF_POPULATED);
Grant Likely5de15402011-06-21 10:59:34 -0600281 return NULL;
282}
283#else /* CONFIG_ARM_AMBA */
284static struct amba_device *of_amba_device_create(struct device_node *node,
285 const char *bus_id,
286 void *platform_data,
287 struct device *parent)
288{
289 return NULL;
290}
291#endif /* CONFIG_ARM_AMBA */
292
Grant Likely5fd200f2010-06-08 07:48:13 -0600293/**
Grant Likely15c35972011-06-21 10:59:35 -0600294 * of_devname_lookup() - Given a device node, lookup the preferred Linux name
295 */
296static const struct of_dev_auxdata *of_dev_lookup(const struct of_dev_auxdata *lookup,
297 struct device_node *np)
298{
Tony Lindgrenfc5cf802016-04-15 08:45:32 -0700299 const struct of_dev_auxdata *auxdata;
Grant Likely15c35972011-06-21 10:59:35 -0600300 struct resource res;
Tony Lindgrenfc5cf802016-04-15 08:45:32 -0700301 int compatible = 0;
Olof Johansson303f59d2011-11-02 22:07:29 -0700302
303 if (!lookup)
304 return NULL;
305
Tony Lindgrenfc5cf802016-04-15 08:45:32 -0700306 auxdata = lookup;
307 for (; auxdata->compatible; auxdata++) {
308 if (!of_device_is_compatible(np, auxdata->compatible))
Olof Johansson303f59d2011-11-02 22:07:29 -0700309 continue;
Tony Lindgrenfc5cf802016-04-15 08:45:32 -0700310 compatible++;
Lee Jones84774e62012-07-05 15:15:36 +0100311 if (!of_address_to_resource(np, 0, &res))
Tony Lindgrenfc5cf802016-04-15 08:45:32 -0700312 if (res.start != auxdata->phys_addr)
Lee Jones84774e62012-07-05 15:15:36 +0100313 continue;
Rob Herring0d638a02017-06-01 15:50:55 -0500314 pr_debug("%pOF: devname=%s\n", np, auxdata->name);
Tony Lindgrenfc5cf802016-04-15 08:45:32 -0700315 return auxdata;
316 }
317
318 if (!compatible)
319 return NULL;
320
321 /* Try compatible match if no phys_addr and name are specified */
322 auxdata = lookup;
323 for (; auxdata->compatible; auxdata++) {
324 if (!of_device_is_compatible(np, auxdata->compatible))
325 continue;
326 if (!auxdata->phys_addr && !auxdata->name) {
Rob Herring0d638a02017-06-01 15:50:55 -0500327 pr_debug("%pOF: compatible match\n", np);
Tony Lindgrenfc5cf802016-04-15 08:45:32 -0700328 return auxdata;
329 }
Grant Likely15c35972011-06-21 10:59:35 -0600330 }
Olof Johansson303f59d2011-11-02 22:07:29 -0700331
Grant Likely15c35972011-06-21 10:59:35 -0600332 return NULL;
333}
334
335/**
Grant Likely38e9e212011-03-18 10:21:28 -0600336 * of_platform_bus_create() - Create a device for a node and its children.
Grant Likely5fd200f2010-06-08 07:48:13 -0600337 * @bus: device node of the bus to instantiate
Grant Likely1eed4c02011-03-18 10:21:29 -0600338 * @matches: match table for bus nodes
Olof Johansson303f59d2011-11-02 22:07:29 -0700339 * @lookup: auxdata table for matching id and platform_data with device nodes
Grant Likely38e9e212011-03-18 10:21:28 -0600340 * @parent: parent for new device, or NULL for top level.
Olof Johansson303f59d2011-11-02 22:07:29 -0700341 * @strict: require compatible property
Grant Likely38e9e212011-03-18 10:21:28 -0600342 *
343 * Creates a platform_device for the provided device_node, and optionally
344 * recursively create devices for all the child nodes.
Grant Likely5fd200f2010-06-08 07:48:13 -0600345 */
Grant Likely38e9e212011-03-18 10:21:28 -0600346static int of_platform_bus_create(struct device_node *bus,
Grant Likely5fd200f2010-06-08 07:48:13 -0600347 const struct of_device_id *matches,
Grant Likely15c35972011-06-21 10:59:35 -0600348 const struct of_dev_auxdata *lookup,
Grant Likely29d4f8a2011-06-21 10:59:34 -0600349 struct device *parent, bool strict)
Grant Likely5fd200f2010-06-08 07:48:13 -0600350{
Grant Likely15c35972011-06-21 10:59:35 -0600351 const struct of_dev_auxdata *auxdata;
Grant Likely5fd200f2010-06-08 07:48:13 -0600352 struct device_node *child;
Grant Likely94a0cb12010-07-22 13:59:23 -0600353 struct platform_device *dev;
Grant Likely15c35972011-06-21 10:59:35 -0600354 const char *bus_id = NULL;
355 void *platform_data = NULL;
Grant Likely5fd200f2010-06-08 07:48:13 -0600356 int rc = 0;
357
Grant Likely29d4f8a2011-06-21 10:59:34 -0600358 /* Make sure it has a compatible property */
359 if (strict && (!of_get_property(bus, "compatible", NULL))) {
Rob Herring0d638a02017-06-01 15:50:55 -0500360 pr_debug("%s() - skipping %pOF, no compatible prop\n",
361 __func__, bus);
Grant Likely29d4f8a2011-06-21 10:59:34 -0600362 return 0;
363 }
364
Viresh Kumar4550fe62018-04-17 11:57:34 +0530365 /* Skip nodes for which we don't want to create devices */
366 if (unlikely(of_match_node(of_skipped_node_table, bus))) {
367 pr_debug("%s() - skipping %pOF node\n", __func__, bus);
368 return 0;
369 }
370
Kefeng Wang44a71852016-06-01 14:52:54 +0800371 if (of_node_check_flag(bus, OF_POPULATED_BUS)) {
Rob Herring0d638a02017-06-01 15:50:55 -0500372 pr_debug("%s() - skipping %pOF, already populated\n",
373 __func__, bus);
Kefeng Wang44a71852016-06-01 14:52:54 +0800374 return 0;
375 }
376
Grant Likely15c35972011-06-21 10:59:35 -0600377 auxdata = of_dev_lookup(lookup, bus);
378 if (auxdata) {
379 bus_id = auxdata->name;
380 platform_data = auxdata->platform_data;
381 }
382
Grant Likely5de15402011-06-21 10:59:34 -0600383 if (of_device_is_compatible(bus, "arm,primecell")) {
Bartlomiej Zolnierkiewicz2bc552d2013-08-30 13:17:29 +0200384 /*
385 * Don't return an error here to keep compatibility with older
386 * device tree files.
387 */
Grant Likely15c35972011-06-21 10:59:35 -0600388 of_amba_device_create(bus, bus_id, platform_data, parent);
Grant Likely5de15402011-06-21 10:59:34 -0600389 return 0;
390 }
391
Grant Likely15c35972011-06-21 10:59:35 -0600392 dev = of_platform_device_create_pdata(bus, bus_id, platform_data, parent);
Grant Likely38e9e212011-03-18 10:21:28 -0600393 if (!dev || !of_match_node(matches, bus))
394 return 0;
395
Grant Likely5fd200f2010-06-08 07:48:13 -0600396 for_each_child_of_node(bus, child) {
Rob Herring0d638a02017-06-01 15:50:55 -0500397 pr_debug(" create child: %pOF\n", child);
Grant Likely15c35972011-06-21 10:59:35 -0600398 rc = of_platform_bus_create(child, matches, lookup, &dev->dev, strict);
Grant Likely5fd200f2010-06-08 07:48:13 -0600399 if (rc) {
400 of_node_put(child);
401 break;
402 }
403 }
Grant Likely75f353b2014-06-24 16:13:47 +0100404 of_node_set_flag(bus, OF_POPULATED_BUS);
Grant Likely5fd200f2010-06-08 07:48:13 -0600405 return rc;
406}
407
408/**
Grant Likely38e9e212011-03-18 10:21:28 -0600409 * of_platform_bus_probe() - Probe the device-tree for platform buses
Grant Likely5fd200f2010-06-08 07:48:13 -0600410 * @root: parent of the first level to probe or NULL for the root of the tree
Grant Likely1eed4c02011-03-18 10:21:29 -0600411 * @matches: match table for bus nodes
Grant Likely5fd200f2010-06-08 07:48:13 -0600412 * @parent: parent to hook devices from, NULL for toplevel
413 *
414 * Note that children of the provided root are not instantiated as devices
415 * unless the specified root itself matches the bus list and is not NULL.
416 */
417int of_platform_bus_probe(struct device_node *root,
418 const struct of_device_id *matches,
419 struct device *parent)
420{
421 struct device_node *child;
Grant Likely5fd200f2010-06-08 07:48:13 -0600422 int rc = 0;
423
Grant Likely1eed4c02011-03-18 10:21:29 -0600424 root = root ? of_node_get(root) : of_find_node_by_path("/");
425 if (!root)
Grant Likely60d59912010-06-08 07:48:25 -0600426 return -EINVAL;
Grant Likely5fd200f2010-06-08 07:48:13 -0600427
Kefeng Wang44a71852016-06-01 14:52:54 +0800428 pr_debug("%s()\n", __func__);
Rob Herring0d638a02017-06-01 15:50:55 -0500429 pr_debug(" starting at: %pOF\n", root);
Grant Likely5fd200f2010-06-08 07:48:13 -0600430
Grant Likely1eed4c02011-03-18 10:21:29 -0600431 /* Do a self check of bus type, if there's a match, create children */
Grant Likely5fd200f2010-06-08 07:48:13 -0600432 if (of_match_node(matches, root)) {
Grant Likely15c35972011-06-21 10:59:35 -0600433 rc = of_platform_bus_create(root, matches, NULL, parent, false);
Grant Likely38e9e212011-03-18 10:21:28 -0600434 } else for_each_child_of_node(root, child) {
Grant Likely5fd200f2010-06-08 07:48:13 -0600435 if (!of_match_node(matches, child))
436 continue;
Grant Likely15c35972011-06-21 10:59:35 -0600437 rc = of_platform_bus_create(child, matches, NULL, parent, false);
Julia Lawall7fad948a2015-10-22 11:02:49 +0200438 if (rc) {
439 of_node_put(child);
Grant Likely5fd200f2010-06-08 07:48:13 -0600440 break;
Julia Lawall7fad948a2015-10-22 11:02:49 +0200441 }
Grant Likely5fd200f2010-06-08 07:48:13 -0600442 }
Grant Likely38e9e212011-03-18 10:21:28 -0600443
Grant Likely5fd200f2010-06-08 07:48:13 -0600444 of_node_put(root);
445 return rc;
446}
447EXPORT_SYMBOL(of_platform_bus_probe);
Grant Likely29d4f8a2011-06-21 10:59:34 -0600448
449/**
450 * of_platform_populate() - Populate platform_devices from device tree data
451 * @root: parent of the first level to probe or NULL for the root of the tree
452 * @matches: match table, NULL to use the default
Javi Merino92039ed2012-11-23 16:25:08 +0000453 * @lookup: auxdata table for matching id and platform_data with device nodes
Grant Likely29d4f8a2011-06-21 10:59:34 -0600454 * @parent: parent to hook devices from, NULL for toplevel
455 *
456 * Similar to of_platform_bus_probe(), this function walks the device tree
457 * and creates devices from nodes. It differs in that it follows the modern
458 * convention of requiring all device nodes to have a 'compatible' property,
459 * and it is suitable for creating devices which are children of the root
460 * node (of_platform_bus_probe will only create children of the root which
461 * are selected by the @matches argument).
462 *
463 * New board support should be using this function instead of
464 * of_platform_bus_probe().
465 *
466 * Returns 0 on success, < 0 on failure.
467 */
468int of_platform_populate(struct device_node *root,
469 const struct of_device_id *matches,
Grant Likely15c35972011-06-21 10:59:35 -0600470 const struct of_dev_auxdata *lookup,
Grant Likely29d4f8a2011-06-21 10:59:34 -0600471 struct device *parent)
472{
473 struct device_node *child;
474 int rc = 0;
475
476 root = root ? of_node_get(root) : of_find_node_by_path("/");
477 if (!root)
478 return -EINVAL;
479
Kefeng Wang44a71852016-06-01 14:52:54 +0800480 pr_debug("%s()\n", __func__);
Rob Herring0d638a02017-06-01 15:50:55 -0500481 pr_debug(" starting at: %pOF\n", root);
Kefeng Wang44a71852016-06-01 14:52:54 +0800482
Saravana Kannan5e666932019-09-04 14:11:24 -0700483 device_links_supplier_sync_state_pause();
Grant Likely29d4f8a2011-06-21 10:59:34 -0600484 for_each_child_of_node(root, child) {
Grant Likely15c35972011-06-21 10:59:35 -0600485 rc = of_platform_bus_create(child, matches, lookup, parent, true);
Julia Lawall7fad948a2015-10-22 11:02:49 +0200486 if (rc) {
487 of_node_put(child);
Grant Likely29d4f8a2011-06-21 10:59:34 -0600488 break;
Julia Lawall7fad948a2015-10-22 11:02:49 +0200489 }
Grant Likely29d4f8a2011-06-21 10:59:34 -0600490 }
Saravana Kannan5e666932019-09-04 14:11:24 -0700491 device_links_supplier_sync_state_resume();
492
Grant Likely2d0747c2014-11-19 22:35:39 +0000493 of_node_set_flag(root, OF_POPULATED_BUS);
Grant Likely29d4f8a2011-06-21 10:59:34 -0600494
495 of_node_put(root);
496 return rc;
497}
Stephen Warrene001f1c2012-06-07 17:57:36 -0600498EXPORT_SYMBOL_GPL(of_platform_populate);
Pawel Mollc6e126d2014-05-15 16:55:24 +0100499
Hauke Mehrtens43443ad2015-08-02 19:44:43 +0200500int of_platform_default_populate(struct device_node *root,
501 const struct of_dev_auxdata *lookup,
502 struct device *parent)
503{
504 return of_platform_populate(root, of_default_bus_match_table, lookup,
505 parent);
506}
507EXPORT_SYMBOL_GPL(of_platform_default_populate);
508
Kevin Haofc520f82016-08-12 13:49:34 +0800509#ifndef CONFIG_PPC
Bjorn Anderssona50ff192017-10-10 22:08:53 -0700510static const struct of_device_id reserved_mem_matches[] = {
Bjorn Anderssond1de6d62017-10-16 13:17:08 -0500511 { .compatible = "qcom,rmtfs-mem" },
Mahesh Sivasubramanian312416d2018-04-10 11:57:23 -0600512 { .compatible = "qcom,cmd-db" },
Bjorn Anderssona50ff192017-10-10 22:08:53 -0700513 { .compatible = "ramoops" },
514 {}
515};
516
Kefeng Wang44a71852016-06-01 14:52:54 +0800517static int __init of_platform_default_populate_init(void)
518{
Kees Cook529182e2016-07-29 18:11:32 -0700519 struct device_node *node;
520
Saravana Kannanee9b2802019-12-09 11:31:19 -0800521 device_links_supplier_sync_state_pause();
522
Kees Cook529182e2016-07-29 18:11:32 -0700523 if (!of_have_populated_dt())
524 return -ENODEV;
525
526 /*
Bjorn Anderssona50ff192017-10-10 22:08:53 -0700527 * Handle certain compatibles explicitly, since we don't want to create
528 * platform_devices for every node in /reserved-memory with a
529 * "compatible",
Kees Cook529182e2016-07-29 18:11:32 -0700530 */
Bjorn Anderssona50ff192017-10-10 22:08:53 -0700531 for_each_matching_node(node, reserved_mem_matches)
532 of_platform_device_create(node, NULL, NULL);
Kees Cook529182e2016-07-29 18:11:32 -0700533
Sudeep Holla3aa05822017-09-28 11:45:59 +0100534 node = of_find_node_by_path("/firmware");
Sudeep Hollae2105ca2018-01-18 10:43:39 +0000535 if (node) {
Sudeep Holla3aa05822017-09-28 11:45:59 +0100536 of_platform_populate(node, NULL, NULL, NULL);
Sudeep Hollae2105ca2018-01-18 10:43:39 +0000537 of_node_put(node);
538 }
Sudeep Holla3aa05822017-09-28 11:45:59 +0100539
Kees Cook529182e2016-07-29 18:11:32 -0700540 /* Populate everything else. */
541 of_platform_default_populate(NULL, NULL, NULL);
Kefeng Wang44a71852016-06-01 14:52:54 +0800542
543 return 0;
544}
545arch_initcall_sync(of_platform_default_populate_init);
Saravana Kannan5e666932019-09-04 14:11:24 -0700546
547static int __init of_platform_sync_state_init(void)
548{
Saravana Kannanee9b2802019-12-09 11:31:19 -0800549 device_links_supplier_sync_state_resume();
Saravana Kannan5e666932019-09-04 14:11:24 -0700550 return 0;
551}
552late_initcall_sync(of_platform_sync_state_init);
Kevin Haofc520f82016-08-12 13:49:34 +0800553#endif
Kefeng Wang44a71852016-06-01 14:52:54 +0800554
Jan Glauberc2372c22017-05-22 13:09:20 +0200555int of_platform_device_destroy(struct device *dev, void *data)
Pawel Mollc6e126d2014-05-15 16:55:24 +0100556{
Pawel Mollc6e126d2014-05-15 16:55:24 +0100557 /* Do not touch devices not populated from the device tree */
Grant Likely75f353b2014-06-24 16:13:47 +0100558 if (!dev->of_node || !of_node_check_flag(dev->of_node, OF_POPULATED))
Pawel Mollc6e126d2014-05-15 16:55:24 +0100559 return 0;
Pawel Mollc6e126d2014-05-15 16:55:24 +0100560
Grant Likely75f353b2014-06-24 16:13:47 +0100561 /* 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);
Pawel Mollc6e126d2014-05-15 16:55:24 +0100564
Srinivas Kandagatla522811e2018-06-04 15:14:08 +0100565 of_node_clear_flag(dev->of_node, OF_POPULATED);
566 of_node_clear_flag(dev->of_node, OF_POPULATED_BUS);
567
Pawel Mollc6e126d2014-05-15 16:55:24 +0100568 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));
573#endif
Pawel Mollc6e126d2014-05-15 16:55:24 +0100574
Pawel Mollc6e126d2014-05-15 16:55:24 +0100575 return 0;
576}
Jan Glauberc2372c22017-05-22 13:09:20 +0200577EXPORT_SYMBOL_GPL(of_platform_device_destroy);
Pawel Mollc6e126d2014-05-15 16:55:24 +0100578
579/**
580 * of_platform_depopulate() - Remove devices populated from device tree
Grant Likely75f353b2014-06-24 16:13:47 +0100581 * @parent: device which children will be removed
Pawel Mollc6e126d2014-05-15 16:55:24 +0100582 *
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).
Pawel Mollc6e126d2014-05-15 16:55:24 +0100587 */
Grant Likely75f353b2014-06-24 16:13:47 +0100588void of_platform_depopulate(struct device *parent)
Pawel Mollc6e126d2014-05-15 16:55:24 +0100589{
Grant Likely2d0747c2014-11-19 22:35:39 +0000590 if (parent->of_node && of_node_check_flag(parent->of_node, OF_POPULATED_BUS)) {
591 device_for_each_child(parent, NULL, of_platform_device_destroy);
592 of_node_clear_flag(parent->of_node, OF_POPULATED_BUS);
593 }
Pawel Mollc6e126d2014-05-15 16:55:24 +0100594}
595EXPORT_SYMBOL_GPL(of_platform_depopulate);
596
Benjamin Gaignard38b0b212017-02-24 17:14:33 +0100597static void devm_of_platform_populate_release(struct device *dev, void *res)
598{
599 of_platform_depopulate(*(struct device **)res);
600}
601
602/**
603 * devm_of_platform_populate() - Populate platform_devices from device tree data
604 * @dev: device that requested to populate from device tree data
605 *
606 * Similar to of_platform_populate(), but will automatically call
607 * of_platform_depopulate() when the device is unbound from the bus.
608 *
609 * Returns 0 on success, < 0 on failure.
610 */
611int devm_of_platform_populate(struct device *dev)
612{
613 struct device **ptr;
614 int ret;
615
616 if (!dev)
617 return -EINVAL;
618
619 ptr = devres_alloc(devm_of_platform_populate_release,
620 sizeof(*ptr), GFP_KERNEL);
621 if (!ptr)
622 return -ENOMEM;
623
624 ret = of_platform_populate(dev->of_node, NULL, NULL, dev);
625 if (ret) {
626 devres_free(ptr);
627 } else {
628 *ptr = dev;
629 devres_add(dev, ptr);
630 }
631
632 return ret;
633}
634EXPORT_SYMBOL_GPL(devm_of_platform_populate);
635
636static int devm_of_platform_match(struct device *dev, void *res, void *data)
637{
638 struct device **ptr = res;
639
640 if (!ptr) {
641 WARN_ON(!ptr);
642 return 0;
643 }
644
645 return *ptr == data;
646}
647
648/**
649 * devm_of_platform_depopulate() - Remove devices populated from device tree
650 * @dev: device that requested to depopulate from device tree data
651 *
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).
656 */
657void devm_of_platform_depopulate(struct device *dev)
658{
659 int ret;
660
661 ret = devres_release(dev, devm_of_platform_populate_release,
662 devm_of_platform_match, dev);
663
664 WARN_ON(ret);
665}
666EXPORT_SYMBOL_GPL(devm_of_platform_depopulate);
667
Pantelis Antoniou801d7282014-10-28 22:36:01 +0200668#ifdef CONFIG_OF_DYNAMIC
669static int of_platform_notify(struct notifier_block *nb,
670 unsigned long action, void *arg)
671{
672 struct of_reconfig_data *rd = arg;
673 struct platform_device *pdev_parent, *pdev;
674 bool children_left;
675
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 */
681
Pantelis Antoniou15204ab2014-12-16 19:45:26 +0200682 /* already populated? (driver using of_populate manually) */
683 if (of_node_check_flag(rd->dn, OF_POPULATED))
684 return NOTIFY_OK;
685
Pantelis Antoniou801d7282014-10-28 22:36:01 +0200686 /* 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 of_dev_put(pdev_parent);
691
692 if (pdev == NULL) {
Rob Herring0d638a02017-06-01 15:50:55 -0500693 pr_err("%s: failed to create for '%pOF'\n",
694 __func__, rd->dn);
Pantelis Antoniou801d7282014-10-28 22:36:01 +0200695 /* of_platform_device_create tosses the error code */
696 return notifier_from_errno(-EINVAL);
697 }
698 break;
699
700 case OF_RECONFIG_CHANGE_REMOVE:
Pantelis Antoniou15204ab2014-12-16 19:45:26 +0200701
702 /* already depopulated? */
703 if (!of_node_check_flag(rd->dn, OF_POPULATED))
704 return NOTIFY_OK;
705
Pantelis Antoniou801d7282014-10-28 22:36:01 +0200706 /* find our device by node */
707 pdev = of_find_device_by_node(rd->dn);
708 if (pdev == NULL)
709 return NOTIFY_OK; /* no? not meant for us */
710
711 /* unregister takes one ref away */
712 of_platform_device_destroy(&pdev->dev, &children_left);
713
714 /* and put the reference of the find */
715 of_dev_put(pdev);
716 break;
717 }
718
719 return NOTIFY_OK;
720}
721
722static struct notifier_block platform_of_notifier = {
723 .notifier_call = of_platform_notify,
724};
725
726void of_platform_register_reconfig_notifier(void)
727{
728 WARN_ON(of_reconfig_notifier_register(&platform_of_notifier));
729}
730#endif /* CONFIG_OF_DYNAMIC */
731
Grant Likely964dba22012-02-24 14:58:34 -0700732#endif /* CONFIG_OF_ADDRESS */