1 // SPDX-License-Identifier: GPL-2.0+
6  * Copyright (C) 1996-2005 Paul Mackerras.
66 	node_name = kbasename(np->full_name);  in of_node_name_eq()
67 	len = strchrnul(node_name, '@') - node_name;  in of_node_name_eq()
78 	return strncmp(kbasename(np->full_name), prefix, strlen(prefix)) == 0;  in of_node_name_prefix()
93 	for (; np; np = np->parent)  in of_bus_n_addr_cells()
94 		if (!of_property_read_u32(np, "#address-cells", &cells))  in of_bus_n_addr_cells()
97 	/* No #address-cells property for the root node */  in of_bus_n_addr_cells()
103 	if (np->parent)  in of_n_addr_cells()
104 		np = np->parent;  in of_n_addr_cells()
114 	for (; np; np = np->parent)  in of_bus_n_size_cells()
115 		if (!of_property_read_u32(np, "#size-cells", &cells))  in of_bus_n_size_cells()
118 	/* No #size-cells property for the root node */  in of_bus_n_size_cells()
124 	if (np->parent)  in of_n_size_cells()
125 		np = np->parent;  in of_n_size_cells()
162 	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  * __of_device_is_compatible() - Check if the node matches given constraints
333 				score = INT_MAX/2 - (index << 2);  in __of_device_is_compatible()
398  * of_machine_is_compatible - Test root of device tree for a given compatible value
419  *  __of_device_is_available - check if a device is available for use
447  *  of_device_is_available - check if a device is available for use
468  *  __of_device_is_fail - check if a device has status "fail" or "fail-..."
472  *  Return: True if the status property is set to "fail" or "fail-..." (for any
486 	return !strcmp(status, "fail") || !strncmp(status, "fail-", 5);  in __of_device_is_fail()
490  *  of_device_is_big_endian - check if a device has BE registers
494  *  Return: True if the device has a "big-endian" property, or if the kernel
495  *  was compiled for BE *and* the device has a "native-endian" property.
503 	if (of_property_read_bool(device, "big-endian"))  in of_device_is_big_endian()
506 	    of_property_read_bool(device, "native-endian"))  in of_device_is_big_endian()
513  * of_get_parent - Get a node's parent if any
528 	np = of_node_get(node->parent);  in of_get_parent()
535  * of_get_next_parent - Iterate to a node's parent
554 	parent = of_node_get(node->parent);  in of_get_next_parent()
569 	next = prev ? prev->sibling : node->child;  in __of_get_next_child()
579  * of_get_next_child - Iterate a node childs
601  * of_get_next_available_child - Find the next available child node
618 	next = prev ? prev->sibling : node->child;  in of_get_next_available_child()
619 	for (; next; next = next->sibling) {  in of_get_next_available_child()
632  * of_get_next_cpu_node - Iterate on cpu nodes
635  * Unusable CPUs (those with the status property set to "fail" or "fail-...")
653 		next = prev->sibling;  in of_get_next_cpu_node()
655 		next = node->child;  in of_get_next_cpu_node()
658 	for (; next; next = next->sibling) {  in of_get_next_cpu_node()
674  * of_get_compatible_child - Find compatible child node
699  * of_get_child_by_name - Find the child node by name for a given parent
732 		const char *name = kbasename(child->full_name);  in __of_find_node_by_path()
758  * of_find_node_opts_by_path - Find a node matching a full OF path
761  *       node (an alias).  In the case of an alias, the node
762  *       matching the alias' value will be returned.
769  *  * foo	Valid alias
770  *  * foo/bar	Valid alias + relative path
788 	/* The path could begin with an alias */  in of_find_node_opts_by_path()
795 		len = p - path;  in of_find_node_opts_by_path()
802 			if (strlen(pp->name) == len && !strncmp(pp->name, path, len)) {  in of_find_node_opts_by_path()
803 				np = of_find_node_by_path(pp->value);  in of_find_node_opts_by_path()
823  * of_find_node_by_name - Find a node by its "name" property
850  * of_find_node_by_type - Find a node by its "device_type" property
878  * of_find_compatible_node - Find a node based on type and one of the
909  * of_find_node_with_property - Find a node which has a property with
929 		for (pp = np->properties; pp; pp = pp->next) {  in of_find_node_with_property()
930 			if (of_prop_cmp(pp->name, prop_name) == 0) {  in of_find_node_with_property()
953 	for (; matches->name[0] || matches->type[0] || matches->compatible[0]; matches++) {  in __of_match_node()
954 		score = __of_device_is_compatible(node, matches->compatible,  in __of_match_node()
955 						  matches->type, matches->name);  in __of_match_node()
966  * of_match_node - Tell if a device_node has a matching of_match structure
986  * of_find_matching_node_and_match - Find a node based on an of_device_id
1025  * of_alias_from_compatible - Lookup appropriate alias for a device node
1028  * @alias:	Pointer to buffer that alias value will be copied into
1029  * @len:	Length of alias value
1032  * to choose an appropriate alias value for a particular device tree node.
1037  * from I2C and SPI. Please do not add any new user.
1041 int of_alias_from_compatible(const struct device_node *node, char *alias, int len)  in of_alias_from_compatible()  argument
1048 		return -ENODEV;  in of_alias_from_compatible()
1050 	strscpy(alias, p ? p + 1 : compatible, len);  in of_alias_from_compatible()
1056  * of_find_node_by_phandle - Find a node given a phandle
1076 	    handle == phandle_cache[handle_hash]->phandle)  in of_find_node_by_phandle()
1081 			if (np->phandle == handle &&  in of_find_node_by_phandle()
1097 	printk("%s %pOF", msg, args->np);  in of_print_phandle_args()
1098 	for (i = 0; i < args->args_count; i++) {  in of_print_phandle_args()
1101 		pr_cont("%c%08x", delim, args->args[i]);  in of_print_phandle_args()
1122 		return -EINVAL;  in of_phandle_iterator_init()
1126 		return -ENOENT;  in of_phandle_iterator_init()
1128 	it->cells_name = cells_name;  in of_phandle_iterator_init()
1129 	it->cell_count = cell_count;  in of_phandle_iterator_init()
1130 	it->parent = np;  in of_phandle_iterator_init()
1131 	it->list_end = list + size / sizeof(*list);  in of_phandle_iterator_init()
1132 	it->phandle_end = list;  in of_phandle_iterator_init()
1133 	it->cur = list;  in of_phandle_iterator_init()
1143 	if (it->node) {  in of_phandle_iterator_next()
1144 		of_node_put(it->node);  in of_phandle_iterator_next()
1145 		it->node = NULL;  in of_phandle_iterator_next()
1148 	if (!it->cur || it->phandle_end >= it->list_end)  in of_phandle_iterator_next()
1149 		return -ENOENT;  in of_phandle_iterator_next()
1151 	it->cur = it->phandle_end;  in of_phandle_iterator_next()
1154 	it->phandle = be32_to_cpup(it->cur++);  in of_phandle_iterator_next()
1156 	if (it->phandle) {  in of_phandle_iterator_next()
1159 		 * Find the provider node and parse the #*-cells property to  in of_phandle_iterator_next()
1162 		it->node = of_find_node_by_phandle(it->phandle);  in of_phandle_iterator_next()
1164 		if (it->cells_name) {  in of_phandle_iterator_next()
1165 			if (!it->node) {  in of_phandle_iterator_next()
1167 				       it->parent, it->phandle);  in of_phandle_iterator_next()
1171 			if (of_property_read_u32(it->node, it->cells_name,  in of_phandle_iterator_next()
1178 				if (it->cell_count >= 0) {  in of_phandle_iterator_next()
1179 					count = it->cell_count;  in of_phandle_iterator_next()
1182 					       it->parent,  in of_phandle_iterator_next()
1183 					       it->cells_name,  in of_phandle_iterator_next()
1184 					       it->node);  in of_phandle_iterator_next()
1189 			count = it->cell_count;  in of_phandle_iterator_next()
1196 		if (it->cur + count > it->list_end) {  in of_phandle_iterator_next()
1197 			if (it->cells_name)  in of_phandle_iterator_next()
1199 					it->parent, it->cells_name,  in of_phandle_iterator_next()
1200 					count, it->list_end - it->cur);  in of_phandle_iterator_next()
1203 					it->parent, of_node_full_name(it->node),  in of_phandle_iterator_next()
1204 					count, it->list_end - it->cur);  in of_phandle_iterator_next()
1209 	it->phandle_end = it->cur + count;  in of_phandle_iterator_next()
1210 	it->cur_count = count;  in of_phandle_iterator_next()
1215 	if (it->node) {  in of_phandle_iterator_next()
1216 		of_node_put(it->node);  in of_phandle_iterator_next()
1217 		it->node = NULL;  in of_phandle_iterator_next()
1220 	return -EINVAL;  in of_phandle_iterator_next()
1230 	count = it->cur_count;  in of_phandle_iterator_args()
1236 		args[i] = be32_to_cpup(it->cur++);  in of_phandle_iterator_args()
1251 		return -EINVAL;  in __of_parse_phandle_with_args()
1259 		 * or return -ENOENT for an empty entry.  in __of_parse_phandle_with_args()
1261 		rc = -ENOENT;  in __of_parse_phandle_with_args()
1270 							     out_args->args,  in __of_parse_phandle_with_args()
1272 				out_args->np = it.node;  in __of_parse_phandle_with_args()
1273 				out_args->args_count = c;  in __of_parse_phandle_with_args()
1287 	 * -ENOENT : index is for empty phandle  in __of_parse_phandle_with_args()
1288 	 * -EINVAL : parsing error on data  in __of_parse_phandle_with_args()
1298  * of_parse_phandle_with_args_map() - Find a node pointed by phandle in a list and remap it
1309  * a <@stem_name>-map property.
1311  * Caller is responsible to call of_node_put() on the returned out_args->np
1317  *  	#list-cells = <2>;
1321  *  	#list-cells = <1>;
1325  *  	#list-cells = <1>;
1326  *  	list-map = <0 &phandle2 3>,
1329  *  	list-map-mask = <0x3>;
1356 		return -EINVAL;  in of_parse_phandle_with_args_map()
1358 	cells_name = kasprintf(GFP_KERNEL, "#%s-cells", stem_name);  in of_parse_phandle_with_args_map()
1360 		return -ENOMEM;  in of_parse_phandle_with_args_map()
1362 	ret = -ENOMEM;  in of_parse_phandle_with_args_map()
1363 	map_name = kasprintf(GFP_KERNEL, "%s-map", stem_name);  in of_parse_phandle_with_args_map()
1367 	mask_name = kasprintf(GFP_KERNEL, "%s-map-mask", stem_name);  in of_parse_phandle_with_args_map()
1371 	pass_name = kasprintf(GFP_KERNEL, "%s-map-pass-thru", stem_name);  in of_parse_phandle_with_args_map()
1375 	ret = __of_parse_phandle_with_args(np, list_name, cells_name, -1, index,  in of_parse_phandle_with_args_map()
1380 	/* Get the #<list>-cells property */  in of_parse_phandle_with_args_map()
1381 	cur = out_args->np;  in of_parse_phandle_with_args_map()
1386 	/* Precalculate the match array - this simplifies match loop */  in of_parse_phandle_with_args_map()
1388 		initial_match_array[i] = cpu_to_be32(out_args->args[i]);  in of_parse_phandle_with_args_map()
1390 	ret = -EINVAL;  in of_parse_phandle_with_args_map()
1392 		/* Get the <list>-map property */  in of_parse_phandle_with_args_map()
1400 		/* Get the <list>-map-mask property (optional) */  in of_parse_phandle_with_args_map()
1404 		/* Iterate through <list>-map property */  in of_parse_phandle_with_args_map()
1409 			for (i = 0; i < list_size; i++, map_len--)  in of_parse_phandle_with_args_map()
1415 			map_len--;  in of_parse_phandle_with_args_map()
1419 				ret = -EINVAL;  in of_parse_phandle_with_args_map()
1433 				ret = -EINVAL;  in of_parse_phandle_with_args_map()
1437 			/* Move forward by new node's #<list>-cells amount */  in of_parse_phandle_with_args_map()
1439 			map_len -= new_size;  in of_parse_phandle_with_args_map()
1442 			ret = -ENOENT;  in of_parse_phandle_with_args_map()
1446 		/* Get the <list>-map-pass-thru property (optional) */  in of_parse_phandle_with_args_map()
1452 		 * Successfully parsed a <list>-map translation; copy new  in of_parse_phandle_with_args_map()
1454 		 * bits specified in <list>-map-pass-thru.  in of_parse_phandle_with_args_map()
1457 			__be32 val = *(map - new_size + i);  in of_parse_phandle_with_args_map()
1461 				val |= cpu_to_be32(out_args->args[i]) & pass[i];  in of_parse_phandle_with_args_map()
1465 			out_args->args[i] = be32_to_cpu(val);  in of_parse_phandle_with_args_map()
1467 		out_args->args_count = list_size = new_size;  in of_parse_phandle_with_args_map()
1469 		out_args->np = new;  in of_parse_phandle_with_args_map()
1488  * of_count_phandle_with_args() - Find the number of phandles references in a property
1496  * by a property in the phandle-target node. For example, a gpios
1499  * determined by the #gpio-cells property in the node pointed to by the
1520 			return -ENOENT;  in of_count_phandle_with_args()
1525 	rc = of_phandle_iterator_init(&it, np, list_name, cells_name, -1);  in of_count_phandle_with_args()
1532 	if (rc != -ENOENT)  in of_count_phandle_with_args()
1543 	for (next = list; *next; next = &(*next)->next) {  in __of_remove_property_from_list()
1545 			*next = prop->next;  in __of_remove_property_from_list()
1546 			prop->next = NULL;  in __of_remove_property_from_list()
1554  * __of_add_property - Add a property to a node without lock operations
1566 	__of_remove_property_from_list(&np->deadprops, prop);  in __of_add_property()
1568 	prop->next = NULL;  in __of_add_property()
1569 	next = &np->properties;  in __of_add_property()
1571 		if (strcmp(prop->name, (*next)->name) == 0) {  in __of_add_property()
1573 			rc = -EEXIST;  in __of_add_property()
1576 		next = &(*next)->next;  in __of_add_property()
1590  * of_add_property - Add a property to a node
1612 	int rc = -ENODEV;  in __of_remove_property()
1616 	if (__of_remove_property_from_list(&np->properties, prop)) {  in __of_remove_property()
1618 		prop->next = np->deadprops;  in __of_remove_property()
1619 		np->deadprops = prop;  in __of_remove_property()
1632  * of_remove_property - Remove a property from a node.
1637  * who-knows-how-many pointers to the data using get-property.
1646 		return -ENODEV;  in of_remove_property()
1667 	__of_remove_property_from_list(&np->deadprops, newprop);  in __of_update_property()
1669 	for (next = &np->properties; *next; next = &(*next)->next) {  in __of_update_property()
1670 		if (of_prop_cmp((*next)->name, newprop->name) == 0)  in __of_update_property()
1677 		newprop->next = oldprop->next;  in __of_update_property()
1679 		oldprop->next = np->deadprops;  in __of_update_property()
1680 		np->deadprops = oldprop;  in __of_update_property()
1683 		newprop->next = NULL;  in __of_update_property()
1695  * of_update_property - Update a property in a node, if the property does
1699  * who-knows-how-many pointers to the data using get-property.
1708 	if (!newprop->name)  in of_update_property()
1709 		return -EINVAL;  in of_update_property()
1724 	ap->np = np;  in of_alias_add()
1725 	ap->id = id;  in of_alias_add()
1726 	strscpy(ap->stem, stem, stem_len + 1);  in of_alias_add()
1727 	list_add_tail(&ap->link, &aliases_lookup);  in of_alias_add()
1728 	pr_debug("adding DT alias:%s: stem=%s id=%i node=%pOF\n",  in of_alias_add()
1729 		 ap->alias, ap->stem, ap->id, np);  in of_alias_add()
1733  * of_alias_scan - Scan all properties of the 'aliases' node
1739  * number of alias properties found, or an error code in case of failure.
1751 		/* linux,stdout-path and /aliases/stdout are for legacy compatibility */  in of_alias_scan()
1754 		if (of_property_read_string(of_chosen, "stdout-path", &name))  in of_alias_scan()
1755 			of_property_read_string(of_chosen, "linux,stdout-path",  in of_alias_scan()
1762 			of_stdout->fwnode.flags |= FWNODE_FLAG_BEST_EFFORT;  in of_alias_scan()
1769 		const char *start = pp->name;  in of_alias_scan()
1776 		if (!strcmp(pp->name, "name") ||  in of_alias_scan()
1777 		    !strcmp(pp->name, "phandle") ||  in of_alias_scan()
1778 		    !strcmp(pp->name, "linux,phandle"))  in of_alias_scan()
1781 		np = of_find_node_by_path(pp->value);  in of_alias_scan()
1785 		/* walk the alias backwards to extract the id and work out  in of_alias_scan()
1787 		while (isdigit(*(end-1)) && end > start)  in of_alias_scan()
1788 			end--;  in of_alias_scan()
1789 		len = end - start;  in of_alias_scan()
1799 		ap->alias = start;  in of_alias_scan()
1805  * of_alias_get_id - Get alias id for the given device_node
1807  * @stem:	Alias stem of the given device_node
1809  * The function travels the lookup table to get the alias id for the given
1810  * device_node and alias stem.
1812  * Return: The alias id if found.
1817 	int id = -ENODEV;  in of_alias_get_id()
1821 		if (strcmp(app->stem, stem) != 0)  in of_alias_get_id()
1824 		if (np == app->np) {  in of_alias_get_id()
1825 			id = app->id;  in of_alias_get_id()
1836  * of_alias_get_highest_id - Get highest alias id for the given stem
1837  * @stem:	Alias stem to be examined
1839  * The function travels the lookup table to get the highest alias id for the
1840  * given alias stem.  It returns the alias id if found.
1845 	int id = -ENODEV;  in of_alias_get_highest_id()
1849 		if (strcmp(app->stem, stem) != 0)  in of_alias_get_highest_id()
1852 		if (app->id > id)  in of_alias_get_highest_id()
1853 			id = app->id;  in of_alias_get_highest_id()
1862  * of_console_check() - Test and setup console for DT setup
1867  * Check if the given device node matches the stdout-path property in the
1886  * of_find_next_cache_node - Find a node's subsidiary cache
1897 	cache_node = of_parse_phandle(np, "l2-cache", 0);  in of_find_next_cache_node()
1899 		cache_node = of_parse_phandle(np, "next-level-cache", 0);  in of_find_next_cache_node()
1904 	/* OF on pmac has nodes instead of properties named "l2-cache"  in of_find_next_cache_node()
1916  * of_find_last_cache_level - Find the level at which the last cache is
1935 	of_property_read_u32(prev, "cache-level", &cache_level);  in of_find_last_cache_level()
1942  * of_map_id - Translate an ID through a downstream mapping.
1950  * Given a device ID, look up the appropriate implementation-defined
1952  * ID, as per the "iommu-map" and "msi-map" bindings. Either of @target or
1954  * a non-NULL device node pointer, only entries targeting that node will be
1969 		return -EINVAL;  in of_map_id()
1974 			return -ENODEV;  in of_map_id()
1983 		return -EINVAL;  in of_map_id()
1990 	 * Can be overridden by "{iommu,msi}-map-mask" property.  in of_map_id()
1997 	for ( ; map_len > 0; map_len -= 4 * sizeof(*map), map += 4) {  in of_map_id()
2005 			pr_err("%pOF: Invalid %s translation - %s-mask (0x%x) ignores id-base (0x%x)\n",  in of_map_id()
2008 			return -EFAULT;  in of_map_id()
2016 			return -ENODEV;  in of_map_id()
2029 			*id_out = masked_id - id_base + out_base;  in of_map_id()
2031 …pr_debug("%pOF: %s, using mask %08x, id-base: %08x, out-base: %08x, length: %08x, id: %08x -> %08x…  in of_map_id()
2033 			id_len, id, masked_id - id_base + out_base);  in of_map_id()