1 // SPDX-License-Identifier: GPL-2.0+
6  * Copyright (C) 1996-2005 Paul Mackerras.
67 	node_name = kbasename(np->full_name);  in of_node_name_eq()
68 	len = strchrnul(node_name, '@') - node_name;  in of_node_name_eq()
79 	return strncmp(kbasename(np->full_name), prefix, strlen(prefix)) == 0;  in of_node_name_prefix()
85 	const char *match = __of_get_property(np, "device_type", NULL);  in __of_node_is_type()  local
87 	return np && match && type && !strcmp(match, type);  in __of_node_is_type()
94 	for (; np; np = np->parent)  in of_bus_n_addr_cells()
95 		if (!of_property_read_u32(np, "#address-cells", &cells))  in of_bus_n_addr_cells()
98 	/* No #address-cells property for the root node */  in of_bus_n_addr_cells()
104 	if (np->parent)  in of_n_addr_cells()
105 		np = np->parent;  in of_n_addr_cells()
115 	for (; np; np = np->parent)  in of_bus_n_size_cells()
116 		if (!of_property_read_u32(np, "#size-cells", &cells))  in of_bus_n_size_cells()
119 	/* No #size-cells property for the root node */  in of_bus_n_size_cells()
125 	if (np->parent)  in of_n_size_cells()
126 		np = np->parent;  in of_n_size_cells()
163 	if (np && handle == np->phandle)  in __of_phandle_cache_inv_entry()
182 		if (np->phandle && !phandle_cache[of_phandle_cache_hash(np->phandle)])  in of_core_init()
183 			phandle_cache[of_phandle_cache_hash(np->phandle)] = np;  in of_core_init()
189 		proc_symlink("device-tree", NULL, "/sys/firmware/devicetree/base");  in of_core_init()
200 	for (pp = np->properties; pp; pp = pp->next) {  in __of_find_property()
201 		if (of_prop_cmp(pp->name, name) == 0) {  in __of_find_property()
203 				*lenp = pp->length;  in __of_find_property()
231 	} else if (prev->child) {  in __of_find_all_nodes()
232 		np = prev->child;  in __of_find_all_nodes()
236 		while (np->parent && !np->sibling)  in __of_find_all_nodes()
237 			np = np->parent;  in __of_find_all_nodes()
238 		np = np->sibling; /* Might be null at the end of the tree */  in __of_find_all_nodes()
244  * of_find_all_nodes - Get next node in global list
274 	return pp ? pp->value : NULL;  in __of_get_property()
286 	return pp ? pp->value : NULL;  in of_get_property()
291  * arch_match_cpu_phys_id - Match the given logical CPU and physical id
297  * However this __weak function provides a default match of physical
299  * from the device tree which must match the hardware internal registers.
341  * arch_find_n_match_cpu_physical_id - See if the given device node is
343  * else false.  If 'thread' is non-NULL, the local thread number within the
349 	/* Check for non-standard "ibm,ppc-interrupt-server#s" property  in arch_find_n_match_cpu_physical_id()
355 					   "ibm,ppc-interrupt-server#s",  in arch_find_n_match_cpu_physical_id()
363  * of_get_cpu_node - Get device node associated with the given logical CPU
398  * Return: The logical CPU number of the given CPU device_node or -ENODEV if the
415 	return -ENODEV;  in of_cpu_node_to_id()
420  * of_get_cpu_state_node - Get CPU's idle state node at the given index
426  * a flattened description through the "cpu-idle-states" binding or via the
427  * hierarchical layout, using the "power-domains" and the "domain-idle-states"
440 	err = of_parse_phandle_with_args(cpu_node, "power-domains",  in of_get_cpu_state_node()
441 					"#power-domain-cells", 0, &args);  in of_get_cpu_state_node()
444 			of_parse_phandle(args.np, "domain-idle-states", index);  in of_get_cpu_state_node()
451 	return of_parse_phandle(cpu_node, "cpu-idle-states", index);  in of_get_cpu_state_node()
456  * __of_device_is_compatible() - Check if the node matches given constraints
458  * @compat: required compatible string, NULL or "" for any match
459  * @type: required device_type value, NULL or "" for any match
460  * @name: required node name, NULL or "" for any match
462  * Checks if the given @compat, @type and @name strings match the
466  * Returns 0 for no match, and a positive integer on match. The return
492 	/* Compatible match has highest priority */  in __of_device_is_compatible()
498 				score = INT_MAX/2 - (index << 2);  in __of_device_is_compatible()
540  *  a NULL terminated array of strings. Returns the best match
562  * of_machine_is_compatible - Test root of device tree for a given compatible value
583  *  __of_device_is_available - check if a device is available for use
611  *  of_device_is_available - check if a device is available for use
632  *  of_device_is_big_endian - check if a device has BE registers
636  *  Return: True if the device has a "big-endian" property, or if the kernel
637  *  was compiled for BE *and* the device has a "native-endian" property.
645 	if (of_property_read_bool(device, "big-endian"))  in of_device_is_big_endian()
648 	    of_property_read_bool(device, "native-endian"))  in of_device_is_big_endian()
655  * of_get_parent - Get a node's parent if any
670 	np = of_node_get(node->parent);  in of_get_parent()
677  * of_get_next_parent - Iterate to a node's parent
696 	parent = of_node_get(node->parent);  in of_get_next_parent()
711 	next = prev ? prev->sibling : node->child;  in __of_get_next_child()
721  * of_get_next_child - Iterate a node childs
743  * of_get_next_available_child - Find the next available child node
760 	next = prev ? prev->sibling : node->child;  in of_get_next_available_child()
761 	for (; next; next = next->sibling) {  in of_get_next_available_child()
774  * of_get_next_cpu_node - Iterate on cpu nodes
792 		next = prev->sibling;  in of_get_next_cpu_node()
794 		next = node->child;  in of_get_next_cpu_node()
797 	for (; next; next = next->sibling) {  in of_get_next_cpu_node()
811  * of_get_compatible_child - Find compatible child node
836  * of_get_child_by_name - Find the child node by name for a given parent
869 		const char *name = kbasename(child->full_name);  in __of_find_node_by_path()
895  * of_find_node_opts_by_path - Find a node matching a full OF path
896  * @path: Either the full path to match, or if the path does not
905  *  * /foo/bar	Full path
907  *  * foo/bar	Valid alias + relative path
932 		len = p - path;  in of_find_node_opts_by_path()
939 			if (strlen(pp->name) == len && !strncmp(pp->name, path, len)) {  in of_find_node_opts_by_path()
940 				np = of_find_node_by_path(pp->value);  in of_find_node_opts_by_path()
960  * of_find_node_by_name - Find a node by its "name" property
965  * @name:	The name string to match against
987  * of_find_node_by_type - Find a node by its "device_type" property
993  * @type:	The type string to match against
1015  * of_find_compatible_node - Find a node based on type and one of the
1021  * @type:	The type string to match "device_type" or NULL to ignore
1022  * @compatible:	The string to match to one of the tokens in the device
1046  * of_find_node_with_property - Find a node which has a property with
1066 		for (pp = np->properties; pp; pp = pp->next) {  in of_find_node_with_property()
1067 			if (of_prop_cmp(pp->name, prop_name) == 0) {  in of_find_node_with_property()
1090 	for (; matches->name[0] || matches->type[0] || matches->compatible[0]; matches++) {  in __of_match_node()
1091 		score = __of_device_is_compatible(node, matches->compatible,  in __of_match_node()
1092 						  matches->type, matches->name);  in __of_match_node()
1103  * of_match_node - Tell if a device_node has a matching of_match structure
1104  * @matches:	array of of device match structures to search in
1105  * @node:	the of device structure to match against
1112 	const struct of_device_id *match;  in of_match_node()  local
1116 	match = __of_match_node(matches, node);  in of_match_node()
1118 	return match;  in of_match_node()
1123  * of_find_matching_node_and_match - Find a node based on an of_device_id
1124  *				     match table.
1129  * @matches:	array of of device match structures to search in
1130  * @match:	Updated to point at the matches entry which matched
1137 					const struct of_device_id **match)  in of_find_matching_node_and_match()  argument
1143 	if (match)  in of_find_matching_node_and_match()
1144 		*match = NULL;  in of_find_matching_node_and_match()
1150 			if (match)  in of_find_matching_node_and_match()
1151 				*match = m;  in of_find_matching_node_and_match()
1162  * of_modalias_node - Lookup appropriate modalias for a device node
1181 		return -ENODEV;  in of_modalias_node()
1189  * of_find_node_by_phandle - Find a node given a phandle
1209 	    handle == phandle_cache[handle_hash]->phandle)  in of_find_node_by_phandle()
1214 			if (np->phandle == handle &&  in of_find_node_by_phandle()
1230 	printk("%s %pOF", msg, args->np);  in of_print_phandle_args()
1231 	for (i = 0; i < args->args_count; i++) {  in of_print_phandle_args()
1234 		pr_cont("%c%08x", delim, args->args[i]);  in of_print_phandle_args()
1255 		return -EINVAL;  in of_phandle_iterator_init()
1259 		return -ENOENT;  in of_phandle_iterator_init()
1261 	it->cells_name = cells_name;  in of_phandle_iterator_init()
1262 	it->cell_count = cell_count;  in of_phandle_iterator_init()
1263 	it->parent = np;  in of_phandle_iterator_init()
1264 	it->list_end = list + size / sizeof(*list);  in of_phandle_iterator_init()
1265 	it->phandle_end = list;  in of_phandle_iterator_init()
1266 	it->cur = list;  in of_phandle_iterator_init()
1276 	if (it->node) {  in of_phandle_iterator_next()
1277 		of_node_put(it->node);  in of_phandle_iterator_next()
1278 		it->node = NULL;  in of_phandle_iterator_next()
1281 	if (!it->cur || it->phandle_end >= it->list_end)  in of_phandle_iterator_next()
1282 		return -ENOENT;  in of_phandle_iterator_next()
1284 	it->cur = it->phandle_end;  in of_phandle_iterator_next()
1286 	/* If phandle is 0, then it is an empty entry with no arguments. */  in of_phandle_iterator_next()
1287 	it->phandle = be32_to_cpup(it->cur++);  in of_phandle_iterator_next()
1289 	if (it->phandle) {  in of_phandle_iterator_next()
1292 		 * Find the provider node and parse the #*-cells property to  in of_phandle_iterator_next()
1295 		it->node = of_find_node_by_phandle(it->phandle);  in of_phandle_iterator_next()
1297 		if (it->cells_name) {  in of_phandle_iterator_next()
1298 			if (!it->node) {  in of_phandle_iterator_next()
1300 				       it->parent, it->phandle);  in of_phandle_iterator_next()
1304 			if (of_property_read_u32(it->node, it->cells_name,  in of_phandle_iterator_next()
1311 				if (it->cell_count >= 0) {  in of_phandle_iterator_next()
1312 					count = it->cell_count;  in of_phandle_iterator_next()
1315 					       it->parent,  in of_phandle_iterator_next()
1316 					       it->cells_name,  in of_phandle_iterator_next()
1317 					       it->node);  in of_phandle_iterator_next()
1322 			count = it->cell_count;  in of_phandle_iterator_next()
1329 		if (it->cur + count > it->list_end) {  in of_phandle_iterator_next()
1331 			       it->parent, it->cells_name,  in of_phandle_iterator_next()
1332 			       count, it->cell_count);  in of_phandle_iterator_next()
1337 	it->phandle_end = it->cur + count;  in of_phandle_iterator_next()
1338 	it->cur_count = count;  in of_phandle_iterator_next()
1343 	if (it->node) {  in of_phandle_iterator_next()
1344 		of_node_put(it->node);  in of_phandle_iterator_next()
1345 		it->node = NULL;  in of_phandle_iterator_next()
1348 	return -EINVAL;  in of_phandle_iterator_next()
1358 	count = it->cur_count;  in of_phandle_iterator_args()
1364 		args[i] = be32_to_cpup(it->cur++);  in of_phandle_iterator_args()
1384 		 * or return -ENOENT for an empty entry.  in __of_parse_phandle_with_args()
1386 		rc = -ENOENT;  in __of_parse_phandle_with_args()
1395 							     out_args->args,  in __of_parse_phandle_with_args()
1397 				out_args->np = it.node;  in __of_parse_phandle_with_args()
1398 				out_args->args_count = c;  in __of_parse_phandle_with_args()
1412 	 * -ENOENT : index is for empty phandle  in __of_parse_phandle_with_args()
1413 	 * -EINVAL : parsing error on data  in __of_parse_phandle_with_args()
1422  * of_parse_phandle - Resolve a phandle property to a device_node pointer
1448  * of_parse_phandle_with_args() - Find a node pointed by phandle in a list
1459  * Caller is responsible to call of_node_put() on the returned out_args->np
1465  *	#list-cells = <2>;
1469  *	#list-cells = <1>;
1477  * of_parse_phandle_with_args(node3, "list", "#list-cells", 1, &args);
1483 	int cell_count = -1;  in of_parse_phandle_with_args()
1486 		return -EINVAL;  in of_parse_phandle_with_args()
1498  * of_parse_phandle_with_args_map() - Find a node pointed by phandle in a list and remap it
1509  * a <@stem_name>-map property.
1511  * Caller is responsible to call of_node_put() on the returned out_args->np
1517  *  	#list-cells = <2>;
1521  *  	#list-cells = <1>;
1525  *  	#list-cells = <1>;
1526  *  	list-map = <0 &phandle2 3>,
1529  *  	list-map-mask = <0x3>;
1552 	int i, ret, map_len, match;  in of_parse_phandle_with_args_map()  local
1556 		return -EINVAL;  in of_parse_phandle_with_args_map()
1558 	cells_name = kasprintf(GFP_KERNEL, "#%s-cells", stem_name);  in of_parse_phandle_with_args_map()
1560 		return -ENOMEM;  in of_parse_phandle_with_args_map()
1562 	ret = -ENOMEM;  in of_parse_phandle_with_args_map()
1563 	map_name = kasprintf(GFP_KERNEL, "%s-map", stem_name);  in of_parse_phandle_with_args_map()
1567 	mask_name = kasprintf(GFP_KERNEL, "%s-map-mask", stem_name);  in of_parse_phandle_with_args_map()
1571 	pass_name = kasprintf(GFP_KERNEL, "%s-map-pass-thru", stem_name);  in of_parse_phandle_with_args_map()
1575 	ret = __of_parse_phandle_with_args(np, list_name, cells_name, -1, index,  in of_parse_phandle_with_args_map()
1580 	/* Get the #<list>-cells property */  in of_parse_phandle_with_args_map()
1581 	cur = out_args->np;  in of_parse_phandle_with_args_map()
1586 	/* Precalculate the match array - this simplifies match loop */  in of_parse_phandle_with_args_map()
1588 		initial_match_array[i] = cpu_to_be32(out_args->args[i]);  in of_parse_phandle_with_args_map()
1590 	ret = -EINVAL;  in of_parse_phandle_with_args_map()
1592 		/* Get the <list>-map property */  in of_parse_phandle_with_args_map()
1600 		/* Get the <list>-map-mask property (optional) */  in of_parse_phandle_with_args_map()
1604 		/* Iterate through <list>-map property */  in of_parse_phandle_with_args_map()
1605 		match = 0;  in of_parse_phandle_with_args_map()
1606 		while (map_len > (list_size + 1) && !match) {  in of_parse_phandle_with_args_map()
1608 			match = 1;  in of_parse_phandle_with_args_map()
1609 			for (i = 0; i < list_size; i++, map_len--)  in of_parse_phandle_with_args_map()
1610 				match &= !((match_array[i] ^ *map++) & mask[i]);  in of_parse_phandle_with_args_map()
1615 			map_len--;  in of_parse_phandle_with_args_map()
1622 				match = 0;  in of_parse_phandle_with_args_map()
1634 			/* Move forward by new node's #<list>-cells amount */  in of_parse_phandle_with_args_map()
1636 			map_len -= new_size;  in of_parse_phandle_with_args_map()
1638 		if (!match)  in of_parse_phandle_with_args_map()
1641 		/* Get the <list>-map-pass-thru property (optional) */  in of_parse_phandle_with_args_map()
1647 		 * Successfully parsed a <list>-map translation; copy new  in of_parse_phandle_with_args_map()
1649 		 * bits specified in <list>-map-pass-thru.  in of_parse_phandle_with_args_map()
1651 		match_array = map - new_size;  in of_parse_phandle_with_args_map()
1653 			__be32 val = *(map - new_size + i);  in of_parse_phandle_with_args_map()
1657 				val |= cpu_to_be32(out_args->args[i]) & pass[i];  in of_parse_phandle_with_args_map()
1660 			out_args->args[i] = be32_to_cpu(val);  in of_parse_phandle_with_args_map()
1662 		out_args->args_count = list_size = new_size;  in of_parse_phandle_with_args_map()
1664 		out_args->np = new;  in of_parse_phandle_with_args_map()
1682  * of_parse_phandle_with_fixed_args() - Find a node pointed by phandle in a list
1693  * Caller is responsible to call of_node_put() on the returned out_args->np
1716 		return -EINVAL;  in of_parse_phandle_with_fixed_args()
1723  * of_count_phandle_with_args() - Find the number of phandles references in a property
1731  * by a property in the phandle-target node. For example, a gpios
1734  * determined by the #gpio-cells property in the node pointed to by the
1746 	 * phandle and no arguments are to consider. So we don't iterate through  in of_count_phandle_with_args()
1755 			return -ENOENT;  in of_count_phandle_with_args()
1760 	rc = of_phandle_iterator_init(&it, np, list_name, cells_name, -1);  in of_count_phandle_with_args()
1767 	if (rc != -ENOENT)  in of_count_phandle_with_args()
1775  * __of_add_property - Add a property to a node without lock operations
1783 	prop->next = NULL;  in __of_add_property()
1784 	next = &np->properties;  in __of_add_property()
1786 		if (strcmp(prop->name, (*next)->name) == 0)  in __of_add_property()
1788 			return -EEXIST;  in __of_add_property()
1790 		next = &(*next)->next;  in __of_add_property()
1798  * of_add_property - Add a property to a node
1829 	for (next = &np->properties; *next; next = &(*next)->next) {  in __of_remove_property()
1834 		return -ENODEV;  in __of_remove_property()
1837 	*next = prop->next;  in __of_remove_property()
1838 	prop->next = np->deadprops;  in __of_remove_property()
1839 	np->deadprops = prop;  in __of_remove_property()
1845  * of_remove_property - Remove a property from a node.
1850  * who-knows-how-many pointers to the data using get-property.
1860 		return -ENODEV;  in of_remove_property()
1885 	for (next = &np->properties; *next; next = &(*next)->next) {  in __of_update_property()
1886 		if (of_prop_cmp((*next)->name, newprop->name) == 0)  in __of_update_property()
1893 		newprop->next = oldprop->next;  in __of_update_property()
1895 		oldprop->next = np->deadprops;  in __of_update_property()
1896 		np->deadprops = oldprop;  in __of_update_property()
1899 		newprop->next = NULL;  in __of_update_property()
1907  * of_update_property - Update a property in a node, if the property does
1911  * who-knows-how-many pointers to the data using get-property.
1921 	if (!newprop->name)  in of_update_property()
1922 		return -EINVAL;  in of_update_property()
1944 	ap->np = np;  in of_alias_add()
1945 	ap->id = id;  in of_alias_add()
1946 	strncpy(ap->stem, stem, stem_len);  in of_alias_add()
1947 	ap->stem[stem_len] = 0;  in of_alias_add()
1948 	list_add_tail(&ap->link, &aliases_lookup);  in of_alias_add()
1950 		 ap->alias, ap->stem, ap->id, np);  in of_alias_add()
1954  * of_alias_scan - Scan all properties of the 'aliases' node
1972 		/* linux,stdout-path and /aliases/stdout are for legacy compatibility */  in of_alias_scan()
1975 		if (of_property_read_string(of_chosen, "stdout-path", &name))  in of_alias_scan()
1976 			of_property_read_string(of_chosen, "linux,stdout-path",  in of_alias_scan()
1988 		const char *start = pp->name;  in of_alias_scan()
1995 		if (!strcmp(pp->name, "name") ||  in of_alias_scan()
1996 		    !strcmp(pp->name, "phandle") ||  in of_alias_scan()
1997 		    !strcmp(pp->name, "linux,phandle"))  in of_alias_scan()
2000 		np = of_find_node_by_path(pp->value);  in of_alias_scan()
2006 		while (isdigit(*(end-1)) && end > start)  in of_alias_scan()
2007 			end--;  in of_alias_scan()
2008 		len = end - start;  in of_alias_scan()
2018 		ap->alias = start;  in of_alias_scan()
2024  * of_alias_get_id - Get alias id for the given device_node
2036 	int id = -ENODEV;  in of_alias_get_id()
2040 		if (strcmp(app->stem, stem) != 0)  in of_alias_get_id()
2043 		if (np == app->np) {  in of_alias_get_id()
2044 			id = app->id;  in of_alias_get_id()
2055  * of_alias_get_alias_list - Get alias list for the given device driver
2056  * @matches:	Array of OF device match structures to search in
2059  * @nbits:	Maximum number of alias IDs which can be recorded in bitmap
2062  * device match structures and alias stem.
2064  * Return:	0 or -ENOSYS when !CONFIG_OF or
2065  *		-EOVERFLOW if alias ID is greater then allocated nbits
2069 			     unsigned int nbits)  in of_alias_get_alias_list()  argument
2075 	bitmap_zero(bitmap, nbits);  in of_alias_get_alias_list()
2081 			 __func__, app->stem, app->id);  in of_alias_get_alias_list()
2083 		if (strcmp(app->stem, stem) != 0) {  in of_alias_get_alias_list()
2085 				 __func__, app->stem);  in of_alias_get_alias_list()
2089 		if (of_match_node(matches, app->np)) {  in of_alias_get_alias_list()
2090 			pr_debug("%s: Allocated ID %d\n", __func__, app->id);  in of_alias_get_alias_list()
2092 			if (app->id >= nbits) {  in of_alias_get_alias_list()
2094 					__func__, app->id, nbits);  in of_alias_get_alias_list()
2095 				ret = -EOVERFLOW;  in of_alias_get_alias_list()
2097 				set_bit(app->id, bitmap);  in of_alias_get_alias_list()
2108  * of_alias_get_highest_id - Get highest alias id for the given stem
2117 	int id = -ENODEV;  in of_alias_get_highest_id()
2121 		if (strcmp(app->stem, stem) != 0)  in of_alias_get_highest_id()
2124 		if (app->id > id)  in of_alias_get_highest_id()
2125 			id = app->id;  in of_alias_get_highest_id()
2134  * of_console_check() - Test and setup console for DT setup
2139  * Check if the given device node matches the stdout-path property in the
2158  * of_find_next_cache_node - Find a node's subsidiary cache
2169 	cache_node = of_parse_phandle(np, "l2-cache", 0);  in of_find_next_cache_node()
2171 		cache_node = of_parse_phandle(np, "next-level-cache", 0);  in of_find_next_cache_node()
2176 	/* OF on pmac has nodes instead of properties named "l2-cache"  in of_find_next_cache_node()
2188  * of_find_last_cache_level - Find the level at which the last cache is
2207 	of_property_read_u32(prev, "cache-level", &cache_level);  in of_find_last_cache_level()
2213  * of_map_id - Translate an ID through a downstream mapping.
2221  * Given a device ID, look up the appropriate implementation-defined
2223  * ID, as per the "iommu-map" and "msi-map" bindings. Either of @target or
2225  * a non-NULL device node pointer, only entries targeting that node will be
2240 		return -EINVAL;  in of_map_id()
2245 			return -ENODEV;  in of_map_id()
2246 		/* Otherwise, no map implies no translation */  in of_map_id()
2254 		return -EINVAL;  in of_map_id()
2261 	 * Can be overridden by "{iommu,msi}-map-mask" property.  in of_map_id()
2268 	for ( ; map_len > 0; map_len -= 4 * sizeof(*map), map += 4) {  in of_map_id()
2276 			pr_err("%pOF: Invalid %s translation - %s-mask (0x%x) ignores id-base (0x%x)\n",  in of_map_id()
2279 			return -EFAULT;  in of_map_id()
2287 			return -ENODEV;  in of_map_id()
2300 			*id_out = masked_id - id_base + out_base;  in of_map_id()
2302 …pr_debug("%pOF: %s, using mask %08x, id-base: %08x, out-base: %08x, length: %08x, id: %08x -> %08x…  in of_map_id()
2304 			id_len, id, masked_id - id_base + out_base);  in of_map_id()
2308 	pr_info("%pOF: no %s translation for id 0x%x on %pOF\n", np, map_name,  in of_map_id()