1 // SPDX-License-Identifier: GPL-2.0+
3 * drivers/of/property.c - Procedures for accessing and interpreting
4 * Devicetree properties and graphs.
6 * Initially created by copying procedures from drivers/of/base.c. This
7 * file contains the OF property as well as the OF graph interface
10 * Paul Mackerras August 1996.
11 * Copyright (C) 1996-2005 Paul Mackerras.
13 * Adapted for 64bit PowerPC by Dave Engebretsen and Peter Bergner.
14 * {engebret|bergner}@us.ibm.com
16 * Adapted for sparc and sparc64 by David S. Miller davem@davemloft.net
18 * Reconsolidated from arch/x/kernel/prom.c by Stephen Rothwell and
22 #define pr_fmt(fmt) "OF: " fmt
25 #include <linux/of_address.h>
26 #include <linux/of_device.h>
27 #include <linux/of_graph.h>
28 #include <linux/of_irq.h>
29 #include <linux/string.h>
30 #include <linux/moduleparam.h>
32 #include "of_private.h"
35 * of_graph_is_present() - check graph's presence
36 * @node: pointer to device_node containing graph port
38 * Return: True if @node has a port or ports (with a port) sub-node,
41 bool of_graph_is_present(const struct device_node *node)
43 struct device_node *ports, *port;
45 ports = of_get_child_by_name(node, "ports");
49 port = of_get_child_by_name(node, "port");
55 EXPORT_SYMBOL(of_graph_is_present);
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.
62 * @elem_size: size of the individual element
64 * Search for a property in a device node and count the number of elements of
65 * size elem_size in it.
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.
71 int of_property_count_elems_of_size(const struct device_node *np,
72 const char *propname, int elem_size)
74 struct property *prop = of_find_property(np, propname, NULL);
81 if (prop->length % elem_size != 0) {
82 pr_err("size of %s in node %pOF is not a multiple of %d\n",
83 propname, np, elem_size);
87 return prop->length / elem_size;
89 EXPORT_SYMBOL_GPL(of_property_count_elems_of_size);
92 * of_find_property_value_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)
98 * @len: if !=NULL, actual length is written to here
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.
107 static void *of_find_property_value_of_size(const struct device_node *np,
108 const char *propname, u32 min, u32 max, size_t *len)
110 struct property *prop = of_find_property(np, propname, NULL);
113 return ERR_PTR(-EINVAL);
115 return ERR_PTR(-ENODATA);
116 if (prop->length < min)
117 return ERR_PTR(-EOVERFLOW);
118 if (max && prop->length > max)
119 return ERR_PTR(-EOVERFLOW);
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.
132 * @index: index of the u32 in the list of values
133 * @out_value: pointer to return value, modified only if no error.
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.
142 * The out_value is modified only if a valid u32 value can be decoded.
144 int of_property_read_u32_index(const struct device_node *np,
145 const char *propname,
146 u32 index, u32 *out_value)
148 const u32 *val = of_find_property_value_of_size(np, propname,
149 ((index + 1) * sizeof(*out_value)),
156 *out_value = be32_to_cpup(((__be32 *)val) + index);
159 EXPORT_SYMBOL_GPL(of_property_read_u32_index);
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.
166 * @index: index of the u64 in the list of values
167 * @out_value: pointer to return value, modified only if no error.
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.
176 * The out_value is modified only if a valid u64 value can be decoded.
178 int of_property_read_u64_index(const struct device_node *np,
179 const char *propname,
180 u32 index, u64 *out_value)
182 const u64 *val = of_find_property_value_of_size(np, propname,
183 ((index + 1) * sizeof(*out_value)),
189 *out_value = be64_to_cpup(((__be64 *)val) + index);
192 EXPORT_SYMBOL_GPL(of_property_read_u64_index);
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.
200 * @out_values: pointer to found values.
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
203 * upper limit on the number of elements in the dts entry but only
204 * sz_min will be read.
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.
216 * The out_values is modified only if a valid u8 value can be decoded.
218 int of_property_read_variable_u8_array(const struct device_node *np,
219 const char *propname, u8 *out_values,
220 size_t sz_min, size_t sz_max)
223 const u8 *val = of_find_property_value_of_size(np, propname,
224 (sz_min * sizeof(*out_values)),
225 (sz_max * sizeof(*out_values)),
234 sz /= sizeof(*out_values);
238 *out_values++ = *val++;
242 EXPORT_SYMBOL_GPL(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.
250 * @out_values: pointer to found values.
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
253 * upper limit on the number of elements in the dts entry but only
254 * sz_min will be read.
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.
266 * The out_values is modified only if a valid u16 value can be decoded.
268 int of_property_read_variable_u16_array(const struct device_node *np,
269 const char *propname, u16 *out_values,
270 size_t sz_min, size_t sz_max)
273 const __be16 *val = of_find_property_value_of_size(np, propname,
274 (sz_min * sizeof(*out_values)),
275 (sz_max * sizeof(*out_values)),
284 sz /= sizeof(*out_values);
288 *out_values++ = be16_to_cpup(val++);
292 EXPORT_SYMBOL_GPL(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.
300 * @out_values: pointer to return found values.
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
303 * upper limit on the number of elements in the dts entry but only
304 * sz_min will be read.
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.
313 * The out_values is modified only if a valid u32 value can be decoded.
315 int of_property_read_variable_u32_array(const struct device_node *np,
316 const char *propname, u32 *out_values,
317 size_t sz_min, size_t sz_max)
320 const __be32 *val = of_find_property_value_of_size(np, propname,
321 (sz_min * sizeof(*out_values)),
322 (sz_max * sizeof(*out_values)),
331 sz /= sizeof(*out_values);
335 *out_values++ = be32_to_cpup(val++);
339 EXPORT_SYMBOL_GPL(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.
345 * @out_value: pointer to return value, modified only if return value is 0.
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.
354 * The out_value is modified only if a valid u64 value can be decoded.
356 int of_property_read_u64(const struct device_node *np, const char *propname,
359 const __be32 *val = of_find_property_value_of_size(np, propname,
367 *out_value = of_read_number(val, 2);
370 EXPORT_SYMBOL_GPL(of_property_read_u64);
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.
378 * @out_values: pointer to found values.
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
381 * upper limit on the number of elements in the dts entry but only
382 * sz_min will be read.
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.
391 * The out_values is modified only if a valid u64 value can be decoded.
393 int of_property_read_variable_u64_array(const struct device_node *np,
394 const char *propname, u64 *out_values,
395 size_t sz_min, size_t sz_max)
398 const __be32 *val = of_find_property_value_of_size(np, propname,
399 (sz_min * sizeof(*out_values)),
400 (sz_max * sizeof(*out_values)),
409 sz /= sizeof(*out_values);
413 *out_values++ = of_read_number(val, 2);
419 EXPORT_SYMBOL_GPL(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.
440 int of_property_read_string(const struct device_node *np, const char *propname,
441 const char **out_string)
443 const struct property *prop = of_find_property(np, propname, NULL);
449 if (strnlen(prop->value, prop->length) >= prop->length)
451 *out_string = prop->value;
454 EXPORT_SYMBOL_GPL(of_property_read_string);
457 * of_property_match_string() - Find string in a list and return index
458 * @np: pointer to node containing string list property
459 * @propname: string list property name
460 * @string: pointer to string to search for in string list
462 * This function searches a string list property and returns the index
463 * of a specific string value.
465 int of_property_match_string(const struct device_node *np, const char *propname,
468 const struct property *prop = of_find_property(np, propname, NULL);
479 end = p + prop->length;
481 for (i = 0; p < end; i++, p += l) {
482 l = strnlen(p, end - p) + 1;
485 pr_debug("comparing %s with %s\n", string, p);
486 if (strcmp(string, p) == 0)
487 return i; /* Found it; return index */
491 EXPORT_SYMBOL_GPL(of_property_match_string);
494 * of_property_read_string_helper() - Utility helper for parsing string properties
495 * @np: device node from which the property value is to be read.
496 * @propname: name of the property to be searched.
497 * @out_strs: output array of string pointers.
498 * @sz: number of array elements to read.
499 * @skip: Number of strings to skip over at beginning of list.
501 * Don't call this function directly. It is a utility helper for the
502 * of_property_read_string*() family of functions.
504 int of_property_read_string_helper(const struct device_node *np,
505 const char *propname, const char **out_strs,
508 const struct property *prop = of_find_property(np, propname, NULL);
517 end = p + prop->length;
519 for (i = 0; p < end && (!out_strs || i < skip + sz); i++, p += l) {
520 l = strnlen(p, end - p) + 1;
523 if (out_strs && i >= skip)
527 return i <= 0 ? -ENODATA : i;
529 EXPORT_SYMBOL_GPL(of_property_read_string_helper);
531 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
534 const void *curv = cur;
544 curv += sizeof(*cur);
545 if (curv >= prop->value + prop->length)
549 *pu = be32_to_cpup(curv);
552 EXPORT_SYMBOL_GPL(of_prop_next_u32);
554 const char *of_prop_next_string(struct property *prop, const char *cur)
556 const void *curv = cur;
564 curv += strlen(cur) + 1;
565 if (curv >= prop->value + prop->length)
570 EXPORT_SYMBOL_GPL(of_prop_next_string);
573 * of_graph_parse_endpoint() - parse common endpoint node properties
574 * @node: pointer to endpoint device_node
575 * @endpoint: pointer to the OF endpoint data structure
577 * The caller should hold a reference to @node.
579 int of_graph_parse_endpoint(const struct device_node *node,
580 struct of_endpoint *endpoint)
582 struct device_node *port_node = of_get_parent(node);
584 WARN_ONCE(!port_node, "%s(): endpoint %pOF has no parent node\n",
587 memset(endpoint, 0, sizeof(*endpoint));
589 endpoint->local_node = node;
591 * It doesn't matter whether the two calls below succeed.
592 * If they don't then the default value 0 is used.
594 of_property_read_u32(port_node, "reg", &endpoint->port);
595 of_property_read_u32(node, "reg", &endpoint->id);
597 of_node_put(port_node);
601 EXPORT_SYMBOL(of_graph_parse_endpoint);
604 * of_graph_get_port_by_id() - get the port matching a given id
605 * @parent: pointer to the parent device node
606 * @id: id of the port
608 * Return: A 'port' node pointer with refcount incremented. The caller
609 * has to use of_node_put() on it when done.
611 struct device_node *of_graph_get_port_by_id(struct device_node *parent, u32 id)
613 struct device_node *node, *port;
615 node = of_get_child_by_name(parent, "ports");
619 for_each_child_of_node(parent, port) {
622 if (!of_node_name_eq(port, "port"))
624 of_property_read_u32(port, "reg", &port_id);
633 EXPORT_SYMBOL(of_graph_get_port_by_id);
636 * of_graph_get_next_endpoint() - get next endpoint node
637 * @parent: pointer to the parent device node
638 * @prev: previous endpoint node, or NULL to get first
640 * Return: An 'endpoint' node pointer with refcount incremented. Refcount
641 * of the passed @prev node is decremented.
643 struct device_node *of_graph_get_next_endpoint(const struct device_node *parent,
644 struct device_node *prev)
646 struct device_node *endpoint;
647 struct device_node *port;
653 * Start by locating the port node. If no previous endpoint is specified
654 * search for the first port node, otherwise get the previous endpoint
658 struct device_node *node;
660 node = of_get_child_by_name(parent, "ports");
664 port = of_get_child_by_name(parent, "port");
668 pr_debug("graph: no port node found in %pOF\n", parent);
672 port = of_get_parent(prev);
673 if (WARN_ONCE(!port, "%s(): endpoint %pOF has no parent node\n",
680 * Now that we have a port node, get the next endpoint by
681 * getting the next child. If the previous endpoint is NULL this
682 * will return the first child.
684 endpoint = of_get_next_child(port, prev);
690 /* No more endpoints under this port, try the next one. */
694 port = of_get_next_child(parent, port);
697 } while (!of_node_name_eq(port, "port"));
700 EXPORT_SYMBOL(of_graph_get_next_endpoint);
703 * of_graph_get_endpoint_by_regs() - get endpoint node of specific identifiers
704 * @parent: pointer to the parent device node
705 * @port_reg: identifier (value of reg property) of the parent port node
706 * @reg: identifier (value of reg property) of the endpoint node
708 * Return: An 'endpoint' node pointer which is identified by reg and at the same
709 * is the child of a port node identified by port_reg. reg and port_reg are
710 * ignored when they are -1. Use of_node_put() on the pointer when done.
712 struct device_node *of_graph_get_endpoint_by_regs(
713 const struct device_node *parent, int port_reg, int reg)
715 struct of_endpoint endpoint;
716 struct device_node *node = NULL;
718 for_each_endpoint_of_node(parent, node) {
719 of_graph_parse_endpoint(node, &endpoint);
720 if (((port_reg == -1) || (endpoint.port == port_reg)) &&
721 ((reg == -1) || (endpoint.id == reg)))
727 EXPORT_SYMBOL(of_graph_get_endpoint_by_regs);
730 * of_graph_get_remote_endpoint() - get remote endpoint node
731 * @node: pointer to a local endpoint device_node
733 * Return: Remote endpoint node associated with remote endpoint node linked
734 * to @node. Use of_node_put() on it when done.
736 struct device_node *of_graph_get_remote_endpoint(const struct device_node *node)
738 /* Get remote endpoint node. */
739 return of_parse_phandle(node, "remote-endpoint", 0);
741 EXPORT_SYMBOL(of_graph_get_remote_endpoint);
744 * of_graph_get_port_parent() - get port's parent node
745 * @node: pointer to a local endpoint device_node
747 * Return: device node associated with endpoint node linked
748 * to @node. Use of_node_put() on it when done.
750 struct device_node *of_graph_get_port_parent(struct device_node *node)
758 * Preserve usecount for passed in node as of_get_next_parent()
759 * will do of_node_put() on it.
763 /* Walk 3 levels up only if there is 'ports' node. */
764 for (depth = 3; depth && node; depth--) {
765 node = of_get_next_parent(node);
766 if (depth == 2 && !of_node_name_eq(node, "ports") &&
767 !of_node_name_eq(node, "in-ports") &&
768 !of_node_name_eq(node, "out-ports"))
773 EXPORT_SYMBOL(of_graph_get_port_parent);
776 * of_graph_get_remote_port_parent() - get remote port's parent node
777 * @node: pointer to a local endpoint device_node
779 * Return: Remote device node associated with remote endpoint node linked
780 * to @node. Use of_node_put() on it when done.
782 struct device_node *of_graph_get_remote_port_parent(
783 const struct device_node *node)
785 struct device_node *np, *pp;
787 /* Get remote endpoint node. */
788 np = of_graph_get_remote_endpoint(node);
790 pp = of_graph_get_port_parent(np);
796 EXPORT_SYMBOL(of_graph_get_remote_port_parent);
799 * of_graph_get_remote_port() - get remote port node
800 * @node: pointer to a local endpoint device_node
802 * Return: Remote port node associated with remote endpoint node linked
803 * to @node. Use of_node_put() on it when done.
805 struct device_node *of_graph_get_remote_port(const struct device_node *node)
807 struct device_node *np;
809 /* Get remote endpoint node. */
810 np = of_graph_get_remote_endpoint(node);
813 return of_get_next_parent(np);
815 EXPORT_SYMBOL(of_graph_get_remote_port);
818 * of_graph_get_endpoint_count() - get the number of endpoints in a device node
819 * @np: parent device node containing ports and endpoints
821 * Return: count of endpoint of this device node
823 unsigned int of_graph_get_endpoint_count(const struct device_node *np)
825 struct device_node *endpoint;
826 unsigned int num = 0;
828 for_each_endpoint_of_node(np, endpoint)
833 EXPORT_SYMBOL(of_graph_get_endpoint_count);
836 * of_graph_get_remote_node() - get remote parent device_node for given port/endpoint
837 * @node: pointer to parent device_node containing graph port/endpoint
838 * @port: identifier (value of reg property) of the parent port node
839 * @endpoint: identifier (value of reg property) of the endpoint node
841 * Return: Remote device node associated with remote endpoint node linked
842 * to @node. Use of_node_put() on it when done.
844 struct device_node *of_graph_get_remote_node(const struct device_node *node,
845 u32 port, u32 endpoint)
847 struct device_node *endpoint_node, *remote;
849 endpoint_node = of_graph_get_endpoint_by_regs(node, port, endpoint);
850 if (!endpoint_node) {
851 pr_debug("no valid endpoint (%d, %d) for node %pOF\n",
852 port, endpoint, node);
856 remote = of_graph_get_remote_port_parent(endpoint_node);
857 of_node_put(endpoint_node);
859 pr_debug("no valid remote node\n");
863 if (!of_device_is_available(remote)) {
864 pr_debug("not available for remote node\n");
871 EXPORT_SYMBOL(of_graph_get_remote_node);
873 static struct fwnode_handle *of_fwnode_get(struct fwnode_handle *fwnode)
875 return of_fwnode_handle(of_node_get(to_of_node(fwnode)));
878 static void of_fwnode_put(struct fwnode_handle *fwnode)
880 of_node_put(to_of_node(fwnode));
883 static bool of_fwnode_device_is_available(const struct fwnode_handle *fwnode)
885 return of_device_is_available(to_of_node(fwnode));
888 static bool of_fwnode_device_dma_supported(const struct fwnode_handle *fwnode)
893 static enum dev_dma_attr
894 of_fwnode_device_get_dma_attr(const struct fwnode_handle *fwnode)
896 if (of_dma_is_coherent(to_of_node(fwnode)))
897 return DEV_DMA_COHERENT;
899 return DEV_DMA_NON_COHERENT;
902 static bool of_fwnode_property_present(const struct fwnode_handle *fwnode,
903 const char *propname)
905 return of_property_read_bool(to_of_node(fwnode), propname);
908 static int of_fwnode_property_read_int_array(const struct fwnode_handle *fwnode,
909 const char *propname,
910 unsigned int elem_size, void *val,
913 const struct device_node *node = to_of_node(fwnode);
916 return of_property_count_elems_of_size(node, propname,
921 return of_property_read_u8_array(node, propname, val, nval);
923 return of_property_read_u16_array(node, propname, val, nval);
925 return of_property_read_u32_array(node, propname, val, nval);
927 return of_property_read_u64_array(node, propname, val, nval);
934 of_fwnode_property_read_string_array(const struct fwnode_handle *fwnode,
935 const char *propname, const char **val,
938 const struct device_node *node = to_of_node(fwnode);
941 of_property_read_string_array(node, propname, val, nval) :
942 of_property_count_strings(node, propname);
945 static const char *of_fwnode_get_name(const struct fwnode_handle *fwnode)
947 return kbasename(to_of_node(fwnode)->full_name);
950 static const char *of_fwnode_get_name_prefix(const struct fwnode_handle *fwnode)
952 /* Root needs no prefix here (its name is "/"). */
953 if (!to_of_node(fwnode)->parent)
959 static struct fwnode_handle *
960 of_fwnode_get_parent(const struct fwnode_handle *fwnode)
962 return of_fwnode_handle(of_get_parent(to_of_node(fwnode)));
965 static struct fwnode_handle *
966 of_fwnode_get_next_child_node(const struct fwnode_handle *fwnode,
967 struct fwnode_handle *child)
969 return of_fwnode_handle(of_get_next_available_child(to_of_node(fwnode),
973 static struct fwnode_handle *
974 of_fwnode_get_named_child_node(const struct fwnode_handle *fwnode,
975 const char *childname)
977 const struct device_node *node = to_of_node(fwnode);
978 struct device_node *child;
980 for_each_available_child_of_node(node, child)
981 if (of_node_name_eq(child, childname))
982 return of_fwnode_handle(child);
988 of_fwnode_get_reference_args(const struct fwnode_handle *fwnode,
989 const char *prop, const char *nargs_prop,
990 unsigned int nargs, unsigned int index,
991 struct fwnode_reference_args *args)
993 struct of_phandle_args of_args;
998 ret = of_parse_phandle_with_args(to_of_node(fwnode), prop,
999 nargs_prop, index, &of_args);
1001 ret = of_parse_phandle_with_fixed_args(to_of_node(fwnode), prop,
1002 nargs, index, &of_args);
1006 of_node_put(of_args.np);
1010 args->nargs = of_args.args_count;
1011 args->fwnode = of_fwnode_handle(of_args.np);
1013 for (i = 0; i < NR_FWNODE_REFERENCE_ARGS; i++)
1014 args->args[i] = i < of_args.args_count ? of_args.args[i] : 0;
1019 static struct fwnode_handle *
1020 of_fwnode_graph_get_next_endpoint(const struct fwnode_handle *fwnode,
1021 struct fwnode_handle *prev)
1023 return of_fwnode_handle(of_graph_get_next_endpoint(to_of_node(fwnode),
1027 static struct fwnode_handle *
1028 of_fwnode_graph_get_remote_endpoint(const struct fwnode_handle *fwnode)
1030 return of_fwnode_handle(
1031 of_graph_get_remote_endpoint(to_of_node(fwnode)));
1034 static struct fwnode_handle *
1035 of_fwnode_graph_get_port_parent(struct fwnode_handle *fwnode)
1037 struct device_node *np;
1039 /* Get the parent of the port */
1040 np = of_get_parent(to_of_node(fwnode));
1044 /* Is this the "ports" node? If not, it's the port parent. */
1045 if (!of_node_name_eq(np, "ports"))
1046 return of_fwnode_handle(np);
1048 return of_fwnode_handle(of_get_next_parent(np));
1051 static int of_fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode,
1052 struct fwnode_endpoint *endpoint)
1054 const struct device_node *node = to_of_node(fwnode);
1055 struct device_node *port_node = of_get_parent(node);
1057 endpoint->local_fwnode = fwnode;
1059 of_property_read_u32(port_node, "reg", &endpoint->port);
1060 of_property_read_u32(node, "reg", &endpoint->id);
1062 of_node_put(port_node);
1068 of_fwnode_device_get_match_data(const struct fwnode_handle *fwnode,
1069 const struct device *dev)
1071 return of_device_get_match_data(dev);
1074 static void of_link_to_phandle(struct device_node *con_np,
1075 struct device_node *sup_np,
1078 struct device_node *tmp_np = of_node_get(sup_np);
1080 /* Check that sup_np and its ancestors are available. */
1082 if (of_fwnode_handle(tmp_np)->dev) {
1083 of_node_put(tmp_np);
1087 if (!of_device_is_available(tmp_np)) {
1088 of_node_put(tmp_np);
1092 tmp_np = of_get_next_parent(tmp_np);
1095 fwnode_link_add(of_fwnode_handle(con_np), of_fwnode_handle(sup_np), flags);
1099 * parse_prop_cells - Property parsing function for suppliers
1101 * @np: Pointer to device tree node containing a list
1102 * @prop_name: Name of property to be parsed. Expected to hold phandle values
1103 * @index: For properties holding a list of phandles, this is the index
1105 * @list_name: Property name that is known to contain list of phandle(s) to
1107 * @cells_name: property name that specifies phandles' arguments count
1109 * This is a helper function to parse properties that have a known fixed name
1110 * and are a list of phandles and phandle arguments.
1113 * - phandle node pointer with refcount incremented. Caller must of_node_put()
1115 * - NULL if no phandle found at index
1117 static struct device_node *parse_prop_cells(struct device_node *np,
1118 const char *prop_name, int index,
1119 const char *list_name,
1120 const char *cells_name)
1122 struct of_phandle_args sup_args;
1124 if (strcmp(prop_name, list_name))
1127 if (__of_parse_phandle_with_args(np, list_name, cells_name, 0, index,
1134 #define DEFINE_SIMPLE_PROP(fname, name, cells) \
1135 static struct device_node *parse_##fname(struct device_node *np, \
1136 const char *prop_name, int index) \
1138 return parse_prop_cells(np, prop_name, index, name, cells); \
1141 static int strcmp_suffix(const char *str, const char *suffix)
1143 unsigned int len, suffix_len;
1146 suffix_len = strlen(suffix);
1147 if (len <= suffix_len)
1149 return strcmp(str + len - suffix_len, suffix);
1153 * parse_suffix_prop_cells - Suffix property parsing function for suppliers
1155 * @np: Pointer to device tree node containing a list
1156 * @prop_name: Name of property to be parsed. Expected to hold phandle values
1157 * @index: For properties holding a list of phandles, this is the index
1159 * @suffix: Property suffix that is known to contain list of phandle(s) to
1161 * @cells_name: property name that specifies phandles' arguments count
1163 * This is a helper function to parse properties that have a known fixed suffix
1164 * and are a list of phandles and phandle arguments.
1167 * - phandle node pointer with refcount incremented. Caller must of_node_put()
1169 * - NULL if no phandle found at index
1171 static struct device_node *parse_suffix_prop_cells(struct device_node *np,
1172 const char *prop_name, int index,
1174 const char *cells_name)
1176 struct of_phandle_args sup_args;
1178 if (strcmp_suffix(prop_name, suffix))
1181 if (of_parse_phandle_with_args(np, prop_name, cells_name, index,
1188 #define DEFINE_SUFFIX_PROP(fname, suffix, cells) \
1189 static struct device_node *parse_##fname(struct device_node *np, \
1190 const char *prop_name, int index) \
1192 return parse_suffix_prop_cells(np, prop_name, index, suffix, cells); \
1196 * struct supplier_bindings - Property parsing functions for suppliers
1198 * @parse_prop: function name
1199 * parse_prop() finds the node corresponding to a supplier phandle
1200 * parse_prop.np: Pointer to device node holding supplier phandle property
1201 * parse_prop.prop_name: Name of property holding a phandle value
1202 * parse_prop.index: For properties holding a list of phandles, this is the
1203 * index into the list
1204 * @get_con_dev: If the consumer node containing the property is never converted
1205 * to a struct device, implement this ops so fw_devlink can use it
1206 * to find the true consumer.
1207 * @optional: Describes whether a supplier is mandatory or not
1208 * @fwlink_flags: Optional fwnode link flags to use when creating a fwnode link
1209 * for this property.
1212 * parse_prop() return values are
1213 * - phandle node pointer with refcount incremented. Caller must of_node_put()
1215 * - NULL if no phandle found at index
1217 struct supplier_bindings {
1218 struct device_node *(*parse_prop)(struct device_node *np,
1219 const char *prop_name, int index);
1220 struct device_node *(*get_con_dev)(struct device_node *np);
1225 DEFINE_SIMPLE_PROP(clocks, "clocks", "#clock-cells")
1226 DEFINE_SIMPLE_PROP(interconnects, "interconnects", "#interconnect-cells")
1227 DEFINE_SIMPLE_PROP(iommus, "iommus", "#iommu-cells")
1228 DEFINE_SIMPLE_PROP(mboxes, "mboxes", "#mbox-cells")
1229 DEFINE_SIMPLE_PROP(io_channels, "io-channels", "#io-channel-cells")
1230 DEFINE_SIMPLE_PROP(io_backends, "io-backends", "#io-backend-cells")
1231 DEFINE_SIMPLE_PROP(interrupt_parent, "interrupt-parent", NULL)
1232 DEFINE_SIMPLE_PROP(dmas, "dmas", "#dma-cells")
1233 DEFINE_SIMPLE_PROP(power_domains, "power-domains", "#power-domain-cells")
1234 DEFINE_SIMPLE_PROP(hwlocks, "hwlocks", "#hwlock-cells")
1235 DEFINE_SIMPLE_PROP(extcon, "extcon", NULL)
1236 DEFINE_SIMPLE_PROP(nvmem_cells, "nvmem-cells", "#nvmem-cell-cells")
1237 DEFINE_SIMPLE_PROP(phys, "phys", "#phy-cells")
1238 DEFINE_SIMPLE_PROP(wakeup_parent, "wakeup-parent", NULL)
1239 DEFINE_SIMPLE_PROP(pinctrl0, "pinctrl-0", NULL)
1240 DEFINE_SIMPLE_PROP(pinctrl1, "pinctrl-1", NULL)
1241 DEFINE_SIMPLE_PROP(pinctrl2, "pinctrl-2", NULL)
1242 DEFINE_SIMPLE_PROP(pinctrl3, "pinctrl-3", NULL)
1243 DEFINE_SIMPLE_PROP(pinctrl4, "pinctrl-4", NULL)
1244 DEFINE_SIMPLE_PROP(pinctrl5, "pinctrl-5", NULL)
1245 DEFINE_SIMPLE_PROP(pinctrl6, "pinctrl-6", NULL)
1246 DEFINE_SIMPLE_PROP(pinctrl7, "pinctrl-7", NULL)
1247 DEFINE_SIMPLE_PROP(pinctrl8, "pinctrl-8", NULL)
1248 DEFINE_SIMPLE_PROP(pwms, "pwms", "#pwm-cells")
1249 DEFINE_SIMPLE_PROP(resets, "resets", "#reset-cells")
1250 DEFINE_SIMPLE_PROP(leds, "leds", NULL)
1251 DEFINE_SIMPLE_PROP(backlight, "backlight", NULL)
1252 DEFINE_SIMPLE_PROP(panel, "panel", NULL)
1253 DEFINE_SIMPLE_PROP(msi_parent, "msi-parent", "#msi-cells")
1254 DEFINE_SIMPLE_PROP(post_init_providers, "post-init-providers", NULL)
1255 DEFINE_SUFFIX_PROP(regulators, "-supply", NULL)
1256 DEFINE_SUFFIX_PROP(gpio, "-gpio", "#gpio-cells")
1258 static struct device_node *parse_gpios(struct device_node *np,
1259 const char *prop_name, int index)
1261 if (!strcmp_suffix(prop_name, ",nr-gpios"))
1264 return parse_suffix_prop_cells(np, prop_name, index, "-gpios",
1268 static struct device_node *parse_iommu_maps(struct device_node *np,
1269 const char *prop_name, int index)
1271 if (strcmp(prop_name, "iommu-map"))
1274 return of_parse_phandle(np, prop_name, (index * 4) + 1);
1277 static struct device_node *parse_gpio_compat(struct device_node *np,
1278 const char *prop_name, int index)
1280 struct of_phandle_args sup_args;
1282 if (strcmp(prop_name, "gpio") && strcmp(prop_name, "gpios"))
1286 * Ignore node with gpio-hog property since its gpios are all provided
1289 if (of_property_read_bool(np, "gpio-hog"))
1292 if (of_parse_phandle_with_args(np, prop_name, "#gpio-cells", index,
1299 static struct device_node *parse_interrupts(struct device_node *np,
1300 const char *prop_name, int index)
1302 struct of_phandle_args sup_args;
1304 if (!IS_ENABLED(CONFIG_OF_IRQ) || IS_ENABLED(CONFIG_PPC))
1307 if (strcmp(prop_name, "interrupts") &&
1308 strcmp(prop_name, "interrupts-extended"))
1311 return of_irq_parse_one(np, index, &sup_args) ? NULL : sup_args.np;
1314 static struct device_node *parse_remote_endpoint(struct device_node *np,
1315 const char *prop_name,
1318 /* Return NULL for index > 0 to signify end of remote-endpoints. */
1319 if (index > 0 || strcmp(prop_name, "remote-endpoint"))
1322 return of_graph_get_remote_port_parent(np);
1325 static const struct supplier_bindings of_supplier_bindings[] = {
1326 { .parse_prop = parse_clocks, },
1327 { .parse_prop = parse_interconnects, },
1328 { .parse_prop = parse_iommus, .optional = true, },
1329 { .parse_prop = parse_iommu_maps, .optional = true, },
1330 { .parse_prop = parse_mboxes, },
1331 { .parse_prop = parse_io_channels, },
1332 { .parse_prop = parse_io_backends, },
1333 { .parse_prop = parse_interrupt_parent, },
1334 { .parse_prop = parse_dmas, .optional = true, },
1335 { .parse_prop = parse_power_domains, },
1336 { .parse_prop = parse_hwlocks, },
1337 { .parse_prop = parse_extcon, },
1338 { .parse_prop = parse_nvmem_cells, },
1339 { .parse_prop = parse_phys, },
1340 { .parse_prop = parse_wakeup_parent, },
1341 { .parse_prop = parse_pinctrl0, },
1342 { .parse_prop = parse_pinctrl1, },
1343 { .parse_prop = parse_pinctrl2, },
1344 { .parse_prop = parse_pinctrl3, },
1345 { .parse_prop = parse_pinctrl4, },
1346 { .parse_prop = parse_pinctrl5, },
1347 { .parse_prop = parse_pinctrl6, },
1348 { .parse_prop = parse_pinctrl7, },
1349 { .parse_prop = parse_pinctrl8, },
1351 .parse_prop = parse_remote_endpoint,
1352 .get_con_dev = of_graph_get_port_parent,
1354 { .parse_prop = parse_pwms, },
1355 { .parse_prop = parse_resets, },
1356 { .parse_prop = parse_leds, },
1357 { .parse_prop = parse_backlight, },
1358 { .parse_prop = parse_panel, },
1359 { .parse_prop = parse_msi_parent, },
1360 { .parse_prop = parse_gpio_compat, },
1361 { .parse_prop = parse_interrupts, },
1362 { .parse_prop = parse_regulators, },
1363 { .parse_prop = parse_gpio, },
1364 { .parse_prop = parse_gpios, },
1366 .parse_prop = parse_post_init_providers,
1367 .fwlink_flags = FWLINK_FLAG_IGNORE,
1373 * of_link_property - Create device links to suppliers listed in a property
1374 * @con_np: The consumer device tree node which contains the property
1375 * @prop_name: Name of property to be parsed
1377 * This function checks if the property @prop_name that is present in the
1378 * @con_np device tree node is one of the known common device tree bindings
1379 * that list phandles to suppliers. If @prop_name isn't one, this function
1380 * doesn't do anything.
1382 * If @prop_name is one, this function attempts to create fwnode links from the
1383 * consumer device tree node @con_np to all the suppliers device tree nodes
1384 * listed in @prop_name.
1386 * Any failed attempt to create a fwnode link will NOT result in an immediate
1387 * return. of_link_property() must create links to all the available supplier
1388 * device tree nodes even when attempts to create a link to one or more
1391 static int of_link_property(struct device_node *con_np, const char *prop_name)
1393 struct device_node *phandle;
1394 const struct supplier_bindings *s = of_supplier_bindings;
1396 bool matched = false;
1398 /* Do not stop at first failed link, link all available suppliers. */
1399 while (!matched && s->parse_prop) {
1400 if (s->optional && !fw_devlink_is_strict()) {
1405 while ((phandle = s->parse_prop(con_np, prop_name, i))) {
1406 struct device_node *con_dev_np;
1408 con_dev_np = s->get_con_dev
1409 ? s->get_con_dev(con_np)
1410 : of_node_get(con_np);
1413 of_link_to_phandle(con_dev_np, phandle, s->fwlink_flags);
1414 of_node_put(phandle);
1415 of_node_put(con_dev_np);
1422 static void __iomem *of_fwnode_iomap(struct fwnode_handle *fwnode, int index)
1424 #ifdef CONFIG_OF_ADDRESS
1425 return of_iomap(to_of_node(fwnode), index);
1431 static int of_fwnode_irq_get(const struct fwnode_handle *fwnode,
1434 return of_irq_get(to_of_node(fwnode), index);
1437 static int of_fwnode_add_links(struct fwnode_handle *fwnode)
1440 struct device_node *con_np = to_of_node(fwnode);
1442 if (IS_ENABLED(CONFIG_X86))
1448 for_each_property_of_node(con_np, p)
1449 of_link_property(con_np, p->name);
1454 const struct fwnode_operations of_fwnode_ops = {
1455 .get = of_fwnode_get,
1456 .put = of_fwnode_put,
1457 .device_is_available = of_fwnode_device_is_available,
1458 .device_get_match_data = of_fwnode_device_get_match_data,
1459 .device_dma_supported = of_fwnode_device_dma_supported,
1460 .device_get_dma_attr = of_fwnode_device_get_dma_attr,
1461 .property_present = of_fwnode_property_present,
1462 .property_read_int_array = of_fwnode_property_read_int_array,
1463 .property_read_string_array = of_fwnode_property_read_string_array,
1464 .get_name = of_fwnode_get_name,
1465 .get_name_prefix = of_fwnode_get_name_prefix,
1466 .get_parent = of_fwnode_get_parent,
1467 .get_next_child_node = of_fwnode_get_next_child_node,
1468 .get_named_child_node = of_fwnode_get_named_child_node,
1469 .get_reference_args = of_fwnode_get_reference_args,
1470 .graph_get_next_endpoint = of_fwnode_graph_get_next_endpoint,
1471 .graph_get_remote_endpoint = of_fwnode_graph_get_remote_endpoint,
1472 .graph_get_port_parent = of_fwnode_graph_get_port_parent,
1473 .graph_parse_endpoint = of_fwnode_graph_parse_endpoint,
1474 .iomap = of_fwnode_iomap,
1475 .irq_get = of_fwnode_irq_get,
1476 .add_links = of_fwnode_add_links,
1478 EXPORT_SYMBOL_GPL(of_fwnode_ops);