1 // SPDX-License-Identifier: GPL-2.0+
3  * drivers/of/property.c - Procedures for accessing and interpreting
7  * file contains the OF property as well as the OF graph interface
11  * Copyright (C) 1996-2005 Paul Mackerras.
29 #include <linux/string.h>
35  * of_graph_is_present() - check graph's presence
38  * Return: True if @node has a port or ports (with a port) sub-node,
58  * of_property_count_elems_of_size - Count the number of elements in a property
60  * @np:		device node from which the property value is to be read.
61  * @propname:	name of the property to be searched.
64  * Search for a property in a device node and count the number of elements of
67  * Return: The number of elements on sucess, -EINVAL if the property does not
68  * exist or its length does not match a multiple of elem_size and -ENODATA if
69  * the property does not have a value.
74 	struct property *prop = of_find_property(np, propname, NULL);  in of_property_count_elems_of_size()
77 		return -EINVAL;  in of_property_count_elems_of_size()
78 	if (!prop->value)  in of_property_count_elems_of_size()
79 		return -ENODATA;  in of_property_count_elems_of_size()
81 	if (prop->length % elem_size != 0) {  in of_property_count_elems_of_size()
84 		return -EINVAL;  in of_property_count_elems_of_size()
87 	return prop->length / elem_size;  in of_property_count_elems_of_size()
94  * @np:		device node from which the property value is to be read.
95  * @propname:	name of the property to be searched.
96  * @min:	minimum allowed length of property value
97  * @max:	maximum allowed length of property value (0 means unlimited)
100  * Search for a property in a device node and valid the requested size.
102  * Return: The property value on success, -EINVAL if the property does not
103  * exist, -ENODATA if property does not have a value, and -EOVERFLOW if the
104  * property data is too small or too large.
110 	struct property *prop = of_find_property(np, propname, NULL);  in of_find_property_value_of_size()
113 		return ERR_PTR(-EINVAL);  in of_find_property_value_of_size()
114 	if (!prop->value)  in of_find_property_value_of_size()
115 		return ERR_PTR(-ENODATA);  in of_find_property_value_of_size()
116 	if (prop->length < min)  in of_find_property_value_of_size()
117 		return ERR_PTR(-EOVERFLOW);  in of_find_property_value_of_size()
118 	if (max && prop->length > max)  in of_find_property_value_of_size()
119 		return ERR_PTR(-EOVERFLOW);  in of_find_property_value_of_size()
122 		*len = prop->length;  in of_find_property_value_of_size()
124 	return prop->value;  in of_find_property_value_of_size()
128  * of_property_read_u32_index - Find and read a u32 from a multi-value property.
130  * @np:		device node from which the property value is to be read.
131  * @propname:	name of the property to be searched.
135  * Search for a property in a device node and read nth 32-bit value from
138  * Return: 0 on success, -EINVAL if the property does not exist,
139  * -ENODATA if property does not have a value, and -EOVERFLOW if the
140  * property data isn't large enough.
162  * of_property_read_u64_index - Find and read a u64 from a multi-value property.
164  * @np:		device node from which the property value is to be read.
165  * @propname:	name of the property to be searched.
169  * Search for a property in a device node and read nth 64-bit value from
172  * Return: 0 on success, -EINVAL if the property does not exist,
173  * -ENODATA if property does not have a value, and -EOVERFLOW if the
174  * property data isn't large enough.
195  * of_property_read_variable_u8_array - Find and read an array of u8 from a
196  * property, with bounds on the minimum and maximum array size.
198  * @np:		device node from which the property value is to be read.
199  * @propname:	name of the property to be searched.
201  * @sz_min:	minimum number of array elements to read
202  * @sz_max:	maximum number of array elements to read, if zero there is no
206  * Search for a property in a device node and read 8-bit value(s) from
209  * dts entry of array should be like:
210  *  ``property = /bits/ 8 <0x50 0x60 0x70>;``
212  * Return: The number of elements read on success, -EINVAL if the property
213  * does not exist, -ENODATA if property does not have a value, and -EOVERFLOW
214  * if the property data is smaller than sz_min or longer than sz_max.
237 	while (count--)  in of_property_read_variable_u8_array()
245  * of_property_read_variable_u16_array - Find and read an array of u16 from a
246  * property, with bounds on the minimum and maximum array size.
248  * @np:		device node from which the property value is to be read.
249  * @propname:	name of the property to be searched.
251  * @sz_min:	minimum number of array elements to read
252  * @sz_max:	maximum number of array elements to read, if zero there is no
256  * Search for a property in a device node and read 16-bit value(s) from
259  * dts entry of array should be like:
260  *  ``property = /bits/ 16 <0x5000 0x6000 0x7000>;``
262  * Return: The number of elements read on success, -EINVAL if the property
263  * does not exist, -ENODATA if property does not have a value, and -EOVERFLOW
264  * if the property data is smaller than sz_min or longer than sz_max.
287 	while (count--)  in of_property_read_variable_u16_array()
295  * of_property_read_variable_u32_array - Find and read an array of 32 bit
296  * integers from a property, with bounds on the minimum and maximum array size.
298  * @np:		device node from which the property value is to be read.
299  * @propname:	name of the property to be searched.
301  * @sz_min:	minimum number of array elements to read
302  * @sz_max:	maximum number of array elements to read, if zero there is no
306  * Search for a property in a device node and read 32-bit value(s) from
309  * Return: The number of elements read on success, -EINVAL if the property
310  * does not exist, -ENODATA if property does not have a value, and -EOVERFLOW
311  * if the property data is smaller than sz_min or longer than sz_max.
334 	while (count--)  in of_property_read_variable_u32_array()
342  * of_property_read_u64 - Find and read a 64 bit integer from a property
343  * @np:		device node from which the property value is to be read.
344  * @propname:	name of the property to be searched.
347  * Search for a property in a device node and read a 64-bit value from
350  * Return: 0 on success, -EINVAL if the property does not exist,
351  * -ENODATA if property does not have a value, and -EOVERFLOW if the
352  * property data isn't large enough.
373  * of_property_read_variable_u64_array - Find and read an array of 64 bit
374  * integers from a property, with bounds on the minimum and maximum array size.
376  * @np:		device node from which the property value is to be read.
377  * @propname:	name of the property to be searched.
379  * @sz_min:	minimum number of array elements to read
380  * @sz_max:	maximum number of array elements to read, if zero there is no
384  * Search for a property in a device node and read 64-bit value(s) from
387  * Return: The number of elements read on success, -EINVAL if the property
388  * does not exist, -ENODATA if property does not have a value, and -EOVERFLOW
389  * if the property data is smaller than sz_min or longer than sz_max.
412 	while (count--) {  in of_property_read_variable_u64_array()
422  * of_property_read_string - Find and read a string from a property
423  * @np:		device node from which the property value is to be read.
424  * @propname:	name of the property to be searched.
425  * @out_string:	pointer to null terminated return string, modified only if
428  * Search for a property in a device tree node and retrieve a null
429  * terminated string value (pointer to data, not a copy).
431  * Return: 0 on success, -EINVAL if the property does not exist, -ENODATA if
432  * property does not have a value, and -EILSEQ if the string is not
433  * null-terminated within the length of the property data.
435  * Note that the empty string "" has length of 1, thus -ENODATA cannot
436  * be interpreted as an empty string.
438  * The out_string pointer is modified only if a valid string can be decoded.
443 	const struct property *prop = of_find_property(np, propname, NULL);  in of_property_read_string()
445 		return -EINVAL;  in of_property_read_string()
446 	if (!prop->length)  in of_property_read_string()
447 		return -ENODATA;  in of_property_read_string()
448 	if (strnlen(prop->value, prop->length) >= prop->length)  in of_property_read_string()
449 		return -EILSEQ;  in of_property_read_string()
450 	*out_string = prop->value;  in of_property_read_string()
456  * of_property_match_string() - Find string in a list and return index
457  * @np: pointer to node containing string list property
458  * @propname: string list property name
459  * @string: pointer to string to search for in string list
461  * This function searches a string list property and returns the index
462  * of a specific string value.
465 			     const char *string)  in of_property_match_string()  argument
467 	const struct property *prop = of_find_property(np, propname, NULL);  in of_property_match_string()
473 		return -EINVAL;  in of_property_match_string()
474 	if (!prop->value)  in of_property_match_string()
475 		return -ENODATA;  in of_property_match_string()
477 	p = prop->value;  in of_property_match_string()
478 	end = p + prop->length;  in of_property_match_string()
481 		l = strnlen(p, end - p) + 1;  in of_property_match_string()
483 			return -EILSEQ;  in of_property_match_string()
484 		pr_debug("comparing %s with %s\n", string, p);  in of_property_match_string()
485 		if (strcmp(string, p) == 0)  in of_property_match_string()
488 	return -ENODATA;  in of_property_match_string()
493  * of_property_read_string_helper() - Utility helper for parsing string properties
494  * @np:		device node from which the property value is to be read.
495  * @propname:	name of the property to be searched.
496  * @out_strs:	output array of string pointers.
497  * @sz:		number of array elements to read.
507 	const struct property *prop = of_find_property(np, propname, NULL);  in of_property_read_string_helper()
512 		return -EINVAL;  in of_property_read_string_helper()
513 	if (!prop->value)  in of_property_read_string_helper()
514 		return -ENODATA;  in of_property_read_string_helper()
515 	p = prop->value;  in of_property_read_string_helper()
516 	end = p + prop->length;  in of_property_read_string_helper()
519 		l = strnlen(p, end - p) + 1;  in of_property_read_string_helper()
521 			return -EILSEQ;  in of_property_read_string_helper()
525 	i -= skip;  in of_property_read_string_helper()
526 	return i <= 0 ? -ENODATA : i;  in of_property_read_string_helper()
530 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,  in of_prop_next_u32()
539 		curv = prop->value;  in of_prop_next_u32()
544 	if (curv >= prop->value + prop->length)  in of_prop_next_u32()
553 const char *of_prop_next_string(struct property *prop, const char *cur)  in of_prop_next_string()
561 		return prop->value;  in of_prop_next_string()
564 	if (curv >= prop->value + prop->length)  in of_prop_next_string()
572  * of_graph_parse_endpoint() - parse common endpoint node properties
588 	endpoint->local_node = node;  in of_graph_parse_endpoint()
593 	of_property_read_u32(port_node, "reg", &endpoint->port);  in of_graph_parse_endpoint()
594 	of_property_read_u32(node, "reg", &endpoint->id);  in of_graph_parse_endpoint()
603  * of_graph_get_port_by_id() - get the port matching a given id
635  * of_graph_get_next_endpoint() - get next endpoint node
702  * of_graph_get_endpoint_by_regs() - get endpoint node of specific identifiers
704  * @port_reg: identifier (value of reg property) of the parent port node
705  * @reg: identifier (value of reg property) of the endpoint node
709  * ignored when they are -1. Use of_node_put() on the pointer when done.
719 		if (((port_reg == -1) || (endpoint.port == port_reg)) &&  in of_graph_get_endpoint_by_regs()
720 			((reg == -1) || (endpoint.id == reg)))  in of_graph_get_endpoint_by_regs()
729  * of_graph_get_remote_endpoint() - get remote endpoint node
738 	return of_parse_phandle(node, "remote-endpoint", 0);  in of_graph_get_remote_endpoint()
743  * of_graph_get_port_parent() - get port's parent node
763 	for (depth = 3; depth && node; depth--) {  in of_graph_get_port_parent()
773  * of_graph_get_remote_port_parent() - get remote port's parent node
796  * of_graph_get_remote_port() - get remote port node
827  * of_graph_get_remote_node() - get remote parent device_node for given port/endpoint
829  * @port: identifier (value of reg property) of the parent port node
830  * @endpoint: identifier (value of reg property) of the endpoint node
921 	return -ENXIO;  in of_fwnode_property_read_int_array()
938 	return kbasename(to_of_node(fwnode)->full_name);  in of_fwnode_get_name()
944 	if (!to_of_node(fwnode)->parent)  in of_fwnode_get_name_prefix()
1001 	args->nargs = of_args.args_count;  in of_fwnode_get_reference_args()
1002 	args->fwnode = of_fwnode_handle(of_args.np);  in of_fwnode_get_reference_args()
1005 		args->args[i] = i < of_args.args_count ? of_args.args[i] : 0;  in of_fwnode_get_reference_args()
1048 	endpoint->local_fwnode = fwnode;  in of_fwnode_graph_parse_endpoint()
1050 	of_property_read_u32(port_node, "reg", &endpoint->port);  in of_fwnode_graph_parse_endpoint()
1051 	of_property_read_u32(node, "reg", &endpoint->id);  in of_fwnode_graph_parse_endpoint()
1102 		if (of_fwnode_handle(tmp_np)->dev) {  in of_link_to_phandle()
1119  * parse_prop_cells - Property parsing function for suppliers
1122  * @prop_name:	Name of property to be parsed. Expected to hold phandle values
1125  * @list_name:	Property name that is known to contain list of phandle(s) to
1127  * @cells_name:	property name that specifies phandles' arguments count
1133  * - phandle node pointer with refcount incremented. Caller must of_node_put()
1135  * - NULL if no phandle found at index
1168 		return -1;  in strcmp_suffix()
1169 	return strcmp(str + len - suffix_len, suffix);  in strcmp_suffix()
1173  * parse_suffix_prop_cells - Suffix property parsing function for suppliers
1176  * @prop_name:	Name of property to be parsed. Expected to hold phandle values
1179  * @suffix:	Property suffix that is known to contain list of phandle(s) to
1181  * @cells_name:	property name that specifies phandles' arguments count
1187  * - phandle node pointer with refcount incremented. Caller must of_node_put()
1189  * - NULL if no phandle found at index
1216  * struct supplier_bindings - Property parsing functions for suppliers
1220  * @parse_prop.np: Pointer to device node holding supplier phandle property
1221  * @parse_prop.prop_name: Name of property holding a phandle value
1225  * @node_not_dev: The consumer node containing the property is never converted
1227  *		  compatible property to find a node corresponding to a device.
1231  * - phandle node pointer with refcount incremented. Caller must of_node_put()
1233  * - NULL if no phandle found at index
1242 DEFINE_SIMPLE_PROP(clocks, "clocks", "#clock-cells")
1243 DEFINE_SIMPLE_PROP(interconnects, "interconnects", "#interconnect-cells")
1244 DEFINE_SIMPLE_PROP(iommus, "iommus", "#iommu-cells")
1245 DEFINE_SIMPLE_PROP(mboxes, "mboxes", "#mbox-cells")
1246 DEFINE_SIMPLE_PROP(io_channels, "io-channel", "#io-channel-cells")
1247 DEFINE_SIMPLE_PROP(interrupt_parent, "interrupt-parent", NULL)
1248 DEFINE_SIMPLE_PROP(dmas, "dmas", "#dma-cells")
1249 DEFINE_SIMPLE_PROP(power_domains, "power-domains", "#power-domain-cells")
1250 DEFINE_SIMPLE_PROP(hwlocks, "hwlocks", "#hwlock-cells")
1252 DEFINE_SIMPLE_PROP(nvmem_cells, "nvmem-cells", "#nvmem-cell-cells")
1253 DEFINE_SIMPLE_PROP(phys, "phys", "#phy-cells")
1254 DEFINE_SIMPLE_PROP(wakeup_parent, "wakeup-parent", NULL)
1255 DEFINE_SIMPLE_PROP(pinctrl0, "pinctrl-0", NULL)
1256 DEFINE_SIMPLE_PROP(pinctrl1, "pinctrl-1", NULL)
1257 DEFINE_SIMPLE_PROP(pinctrl2, "pinctrl-2", NULL)
1258 DEFINE_SIMPLE_PROP(pinctrl3, "pinctrl-3", NULL)
1259 DEFINE_SIMPLE_PROP(pinctrl4, "pinctrl-4", NULL)
1260 DEFINE_SIMPLE_PROP(pinctrl5, "pinctrl-5", NULL)
1261 DEFINE_SIMPLE_PROP(pinctrl6, "pinctrl-6", NULL)
1262 DEFINE_SIMPLE_PROP(pinctrl7, "pinctrl-7", NULL)
1263 DEFINE_SIMPLE_PROP(pinctrl8, "pinctrl-8", NULL)
1264 DEFINE_SIMPLE_PROP(remote_endpoint, "remote-endpoint", NULL)
1265 DEFINE_SIMPLE_PROP(pwms, "pwms", "#pwm-cells")
1266 DEFINE_SIMPLE_PROP(resets, "resets", "#reset-cells")
1270 DEFINE_SUFFIX_PROP(regulators, "-supply", NULL)
1271 DEFINE_SUFFIX_PROP(gpio, "-gpio", "#gpio-cells")
1276 	if (!strcmp_suffix(prop_name, ",nr-gpios"))  in parse_gpios()
1279 	return parse_suffix_prop_cells(np, prop_name, index, "-gpios",  in parse_gpios()
1280 				       "#gpio-cells");  in parse_gpios()
1286 	if (strcmp(prop_name, "iommu-map"))  in parse_iommu_maps()
1301 	 * Ignore node with gpio-hog property since its gpios are all provided  in parse_gpio_compat()
1304 	if (of_property_read_bool(np, "gpio-hog"))  in parse_gpio_compat()
1307 	if (of_parse_phandle_with_args(np, prop_name, "#gpio-cells", index,  in parse_gpio_compat()
1323 	    strcmp(prop_name, "interrupts-extended"))  in parse_interrupts()
1368  * of_link_property - Create device links to suppliers listed in a property
1369  * @con_np: The consumer device tree node which contains the property
1370  * @prop_name: Name of property to be parsed
1372  * This function checks if the property @prop_name that is present in the
1394 	while (!matched && s->parse_prop) {  in of_link_property()
1395 		if (s->optional && !fw_devlink_is_strict()) {  in of_link_property()
1400 		while ((phandle = s->parse_prop(con_np, prop_name, i))) {  in of_link_property()
1403 			con_dev_np = s->node_not_dev  in of_link_property()
1434 	struct property *p;  in of_fwnode_add_links()
1441 		return -EINVAL;  in of_fwnode_add_links()
1444 		of_link_property(con_np, p->name);  in of_fwnode_add_links()