Linux Audio

Check our new training course

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