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);
448 if (strnlen(prop->value, prop->length) >= prop->length)
450 *out_string = prop->value;
453 EXPORT_SYMBOL_GPL(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.
464 int of_property_match_string(const struct device_node *np, const char *propname,
467 const struct property *prop = of_find_property(np, propname, NULL);
478 end = p + prop->length;
480 for (i = 0; p < end; i++, p += l) {
481 l = strnlen(p, end - p) + 1;
484 pr_debug("comparing %s with %s\n", string, p);
485 if (strcmp(string, p) == 0)
486 return i; /* Found it; return index */
490 EXPORT_SYMBOL_GPL(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.
498 * @skip: Number of strings to skip over at beginning of list.
500 * Don't call this function directly. It is a utility helper for the
501 * of_property_read_string*() family of functions.
503 int of_property_read_string_helper(const struct device_node *np,
504 const char *propname, const char **out_strs,
507 const struct property *prop = of_find_property(np, propname, NULL);
516 end = p + prop->length;
518 for (i = 0; p < end && (!out_strs || i < skip + sz); i++, p += l) {
519 l = strnlen(p, end - p) + 1;
522 if (out_strs && i >= skip)
526 return i <= 0 ? -ENODATA : i;
528 EXPORT_SYMBOL_GPL(of_property_read_string_helper);
530 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
533 const void *curv = cur;
543 curv += sizeof(*cur);
544 if (curv >= prop->value + prop->length)
548 *pu = be32_to_cpup(curv);
551 EXPORT_SYMBOL_GPL(of_prop_next_u32);
553 const char *of_prop_next_string(struct property *prop, const char *cur)
555 const void *curv = cur;
563 curv += strlen(cur) + 1;
564 if (curv >= prop->value + prop->length)
569 EXPORT_SYMBOL_GPL(of_prop_next_string);
572 * of_graph_parse_endpoint() - parse common endpoint node properties
573 * @node: pointer to endpoint device_node
574 * @endpoint: pointer to the OF endpoint data structure
576 * The caller should hold a reference to @node.
578 int of_graph_parse_endpoint(const struct device_node *node,
579 struct of_endpoint *endpoint)
581 struct device_node *port_node = of_get_parent(node);
583 WARN_ONCE(!port_node, "%s(): endpoint %pOF has no parent node\n",
586 memset(endpoint, 0, sizeof(*endpoint));
588 endpoint->local_node = node;
590 * It doesn't matter whether the two calls below succeed.
591 * If they don't then the default value 0 is used.
593 of_property_read_u32(port_node, "reg", &endpoint->port);
594 of_property_read_u32(node, "reg", &endpoint->id);
596 of_node_put(port_node);
600 EXPORT_SYMBOL(of_graph_parse_endpoint);
603 * of_graph_get_port_by_id() - get the port matching a given id
604 * @parent: pointer to the parent device node
605 * @id: id of the port
607 * Return: A 'port' node pointer with refcount incremented. The caller
608 * has to use of_node_put() on it when done.
610 struct device_node *of_graph_get_port_by_id(struct device_node *parent, u32 id)
612 struct device_node *node, *port;
614 node = of_get_child_by_name(parent, "ports");
618 for_each_child_of_node(parent, port) {
621 if (!of_node_name_eq(port, "port"))
623 of_property_read_u32(port, "reg", &port_id);
632 EXPORT_SYMBOL(of_graph_get_port_by_id);
635 * of_graph_get_next_endpoint() - get next endpoint node
636 * @parent: pointer to the parent device node
637 * @prev: previous endpoint node, or NULL to get first
639 * Return: An 'endpoint' node pointer with refcount incremented. Refcount
640 * of the passed @prev node is decremented.
642 struct device_node *of_graph_get_next_endpoint(const struct device_node *parent,
643 struct device_node *prev)
645 struct device_node *endpoint;
646 struct device_node *port;
652 * Start by locating the port node. If no previous endpoint is specified
653 * search for the first port node, otherwise get the previous endpoint
657 struct device_node *node;
659 node = of_get_child_by_name(parent, "ports");
663 port = of_get_child_by_name(parent, "port");
667 pr_err("graph: no port node found in %pOF\n", parent);
671 port = of_get_parent(prev);
672 if (WARN_ONCE(!port, "%s(): endpoint %pOF has no parent node\n",
679 * Now that we have a port node, get the next endpoint by
680 * getting the next child. If the previous endpoint is NULL this
681 * will return the first child.
683 endpoint = of_get_next_child(port, prev);
689 /* No more endpoints under this port, try the next one. */
693 port = of_get_next_child(parent, port);
696 } while (!of_node_name_eq(port, "port"));
699 EXPORT_SYMBOL(of_graph_get_next_endpoint);
702 * of_graph_get_endpoint_by_regs() - get endpoint node of specific identifiers
703 * @parent: pointer to the parent device node
704 * @port_reg: identifier (value of reg property) of the parent port node
705 * @reg: identifier (value of reg property) of the endpoint node
707 * Return: An 'endpoint' node pointer which is identified by reg and at the same
708 * is the child of a port node identified by port_reg. reg and port_reg are
709 * ignored when they are -1. Use of_node_put() on the pointer when done.
711 struct device_node *of_graph_get_endpoint_by_regs(
712 const struct device_node *parent, int port_reg, int reg)
714 struct of_endpoint endpoint;
715 struct device_node *node = NULL;
717 for_each_endpoint_of_node(parent, node) {
718 of_graph_parse_endpoint(node, &endpoint);
719 if (((port_reg == -1) || (endpoint.port == port_reg)) &&
720 ((reg == -1) || (endpoint.id == reg)))
726 EXPORT_SYMBOL(of_graph_get_endpoint_by_regs);
729 * of_graph_get_remote_endpoint() - get remote endpoint node
730 * @node: pointer to a local endpoint device_node
732 * Return: Remote endpoint node associated with remote endpoint node linked
733 * to @node. Use of_node_put() on it when done.
735 struct device_node *of_graph_get_remote_endpoint(const struct device_node *node)
737 /* Get remote endpoint node. */
738 return of_parse_phandle(node, "remote-endpoint", 0);
740 EXPORT_SYMBOL(of_graph_get_remote_endpoint);
743 * of_graph_get_port_parent() - get port's parent node
744 * @node: pointer to a local endpoint device_node
746 * Return: device node associated with endpoint node linked
747 * to @node. Use of_node_put() on it when done.
749 struct device_node *of_graph_get_port_parent(struct device_node *node)
757 * Preserve usecount for passed in node as of_get_next_parent()
758 * will do of_node_put() on it.
762 /* Walk 3 levels up only if there is 'ports' node. */
763 for (depth = 3; depth && node; depth--) {
764 node = of_get_next_parent(node);
765 if (depth == 2 && !of_node_name_eq(node, "ports") &&
766 !of_node_name_eq(node, "in-ports") &&
767 !of_node_name_eq(node, "out-ports"))
772 EXPORT_SYMBOL(of_graph_get_port_parent);
775 * of_graph_get_remote_port_parent() - get remote port's parent node
776 * @node: pointer to a local endpoint device_node
778 * Return: Remote device node associated with remote endpoint node linked
779 * to @node. Use of_node_put() on it when done.
781 struct device_node *of_graph_get_remote_port_parent(
782 const struct device_node *node)
784 struct device_node *np, *pp;
786 /* Get remote endpoint node. */
787 np = of_graph_get_remote_endpoint(node);
789 pp = of_graph_get_port_parent(np);
795 EXPORT_SYMBOL(of_graph_get_remote_port_parent);
798 * of_graph_get_remote_port() - get remote port node
799 * @node: pointer to a local endpoint device_node
801 * Return: Remote port node associated with remote endpoint node linked
802 * to @node. Use of_node_put() on it when done.
804 struct device_node *of_graph_get_remote_port(const struct device_node *node)
806 struct device_node *np;
808 /* Get remote endpoint node. */
809 np = of_graph_get_remote_endpoint(node);
812 return of_get_next_parent(np);
814 EXPORT_SYMBOL(of_graph_get_remote_port);
816 int of_graph_get_endpoint_count(const struct device_node *np)
818 struct device_node *endpoint;
821 for_each_endpoint_of_node(np, endpoint)
826 EXPORT_SYMBOL(of_graph_get_endpoint_count);
829 * of_graph_get_remote_node() - get remote parent device_node for given port/endpoint
830 * @node: pointer to parent device_node containing graph port/endpoint
831 * @port: identifier (value of reg property) of the parent port node
832 * @endpoint: identifier (value of reg property) of the endpoint node
834 * Return: Remote device node associated with remote endpoint node linked
835 * to @node. Use of_node_put() on it when done.
837 struct device_node *of_graph_get_remote_node(const struct device_node *node,
838 u32 port, u32 endpoint)
840 struct device_node *endpoint_node, *remote;
842 endpoint_node = of_graph_get_endpoint_by_regs(node, port, endpoint);
843 if (!endpoint_node) {
844 pr_debug("no valid endpoint (%d, %d) for node %pOF\n",
845 port, endpoint, node);
849 remote = of_graph_get_remote_port_parent(endpoint_node);
850 of_node_put(endpoint_node);
852 pr_debug("no valid remote node\n");
856 if (!of_device_is_available(remote)) {
857 pr_debug("not available for remote node\n");
864 EXPORT_SYMBOL(of_graph_get_remote_node);
866 static struct fwnode_handle *of_fwnode_get(struct fwnode_handle *fwnode)
868 return of_fwnode_handle(of_node_get(to_of_node(fwnode)));
871 static void of_fwnode_put(struct fwnode_handle *fwnode)
873 of_node_put(to_of_node(fwnode));
876 static bool of_fwnode_device_is_available(const struct fwnode_handle *fwnode)
878 return of_device_is_available(to_of_node(fwnode));
881 static bool of_fwnode_device_dma_supported(const struct fwnode_handle *fwnode)
886 static enum dev_dma_attr
887 of_fwnode_device_get_dma_attr(const struct fwnode_handle *fwnode)
889 if (of_dma_is_coherent(to_of_node(fwnode)))
890 return DEV_DMA_COHERENT;
892 return DEV_DMA_NON_COHERENT;
895 static bool of_fwnode_property_present(const struct fwnode_handle *fwnode,
896 const char *propname)
898 return of_property_read_bool(to_of_node(fwnode), propname);
901 static int of_fwnode_property_read_int_array(const struct fwnode_handle *fwnode,
902 const char *propname,
903 unsigned int elem_size, void *val,
906 const struct device_node *node = to_of_node(fwnode);
909 return of_property_count_elems_of_size(node, propname,
914 return of_property_read_u8_array(node, propname, val, nval);
916 return of_property_read_u16_array(node, propname, val, nval);
918 return of_property_read_u32_array(node, propname, val, nval);
920 return of_property_read_u64_array(node, propname, val, nval);
927 of_fwnode_property_read_string_array(const struct fwnode_handle *fwnode,
928 const char *propname, const char **val,
931 const struct device_node *node = to_of_node(fwnode);
934 of_property_read_string_array(node, propname, val, nval) :
935 of_property_count_strings(node, propname);
938 static const char *of_fwnode_get_name(const struct fwnode_handle *fwnode)
940 return kbasename(to_of_node(fwnode)->full_name);
943 static const char *of_fwnode_get_name_prefix(const struct fwnode_handle *fwnode)
945 /* Root needs no prefix here (its name is "/"). */
946 if (!to_of_node(fwnode)->parent)
952 static struct fwnode_handle *
953 of_fwnode_get_parent(const struct fwnode_handle *fwnode)
955 return of_fwnode_handle(of_get_parent(to_of_node(fwnode)));
958 static struct fwnode_handle *
959 of_fwnode_get_next_child_node(const struct fwnode_handle *fwnode,
960 struct fwnode_handle *child)
962 return of_fwnode_handle(of_get_next_available_child(to_of_node(fwnode),
966 static struct fwnode_handle *
967 of_fwnode_get_named_child_node(const struct fwnode_handle *fwnode,
968 const char *childname)
970 const struct device_node *node = to_of_node(fwnode);
971 struct device_node *child;
973 for_each_available_child_of_node(node, child)
974 if (of_node_name_eq(child, childname))
975 return of_fwnode_handle(child);
981 of_fwnode_get_reference_args(const struct fwnode_handle *fwnode,
982 const char *prop, const char *nargs_prop,
983 unsigned int nargs, unsigned int index,
984 struct fwnode_reference_args *args)
986 struct of_phandle_args of_args;
991 ret = of_parse_phandle_with_args(to_of_node(fwnode), prop,
992 nargs_prop, index, &of_args);
994 ret = of_parse_phandle_with_fixed_args(to_of_node(fwnode), prop,
995 nargs, index, &of_args);
999 of_node_put(of_args.np);
1003 args->nargs = of_args.args_count;
1004 args->fwnode = of_fwnode_handle(of_args.np);
1006 for (i = 0; i < NR_FWNODE_REFERENCE_ARGS; i++)
1007 args->args[i] = i < of_args.args_count ? of_args.args[i] : 0;
1012 static struct fwnode_handle *
1013 of_fwnode_graph_get_next_endpoint(const struct fwnode_handle *fwnode,
1014 struct fwnode_handle *prev)
1016 return of_fwnode_handle(of_graph_get_next_endpoint(to_of_node(fwnode),
1020 static struct fwnode_handle *
1021 of_fwnode_graph_get_remote_endpoint(const struct fwnode_handle *fwnode)
1023 return of_fwnode_handle(
1024 of_graph_get_remote_endpoint(to_of_node(fwnode)));
1027 static struct fwnode_handle *
1028 of_fwnode_graph_get_port_parent(struct fwnode_handle *fwnode)
1030 struct device_node *np;
1032 /* Get the parent of the port */
1033 np = of_get_parent(to_of_node(fwnode));
1037 /* Is this the "ports" node? If not, it's the port parent. */
1038 if (!of_node_name_eq(np, "ports"))
1039 return of_fwnode_handle(np);
1041 return of_fwnode_handle(of_get_next_parent(np));
1044 static int of_fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode,
1045 struct fwnode_endpoint *endpoint)
1047 const struct device_node *node = to_of_node(fwnode);
1048 struct device_node *port_node = of_get_parent(node);
1050 endpoint->local_fwnode = fwnode;
1052 of_property_read_u32(port_node, "reg", &endpoint->port);
1053 of_property_read_u32(node, "reg", &endpoint->id);
1055 of_node_put(port_node);
1061 of_fwnode_device_get_match_data(const struct fwnode_handle *fwnode,
1062 const struct device *dev)
1064 return of_device_get_match_data(dev);
1067 static void of_link_to_phandle(struct device_node *con_np,
1068 struct device_node *sup_np)
1070 struct device_node *tmp_np = of_node_get(sup_np);
1072 /* Check that sup_np and its ancestors are available. */
1074 if (of_fwnode_handle(tmp_np)->dev) {
1075 of_node_put(tmp_np);
1079 if (!of_device_is_available(tmp_np)) {
1080 of_node_put(tmp_np);
1084 tmp_np = of_get_next_parent(tmp_np);
1087 fwnode_link_add(of_fwnode_handle(con_np), of_fwnode_handle(sup_np));
1091 * parse_prop_cells - Property parsing function for suppliers
1093 * @np: Pointer to device tree node containing a list
1094 * @prop_name: Name of property to be parsed. Expected to hold phandle values
1095 * @index: For properties holding a list of phandles, this is the index
1097 * @list_name: Property name that is known to contain list of phandle(s) to
1099 * @cells_name: property name that specifies phandles' arguments count
1101 * This is a helper function to parse properties that have a known fixed name
1102 * and are a list of phandles and phandle arguments.
1105 * - phandle node pointer with refcount incremented. Caller must of_node_put()
1107 * - NULL if no phandle found at index
1109 static struct device_node *parse_prop_cells(struct device_node *np,
1110 const char *prop_name, int index,
1111 const char *list_name,
1112 const char *cells_name)
1114 struct of_phandle_args sup_args;
1116 if (strcmp(prop_name, list_name))
1119 if (__of_parse_phandle_with_args(np, list_name, cells_name, 0, index,
1126 #define DEFINE_SIMPLE_PROP(fname, name, cells) \
1127 static struct device_node *parse_##fname(struct device_node *np, \
1128 const char *prop_name, int index) \
1130 return parse_prop_cells(np, prop_name, index, name, cells); \
1133 static int strcmp_suffix(const char *str, const char *suffix)
1135 unsigned int len, suffix_len;
1138 suffix_len = strlen(suffix);
1139 if (len <= suffix_len)
1141 return strcmp(str + len - suffix_len, suffix);
1145 * parse_suffix_prop_cells - Suffix property parsing function for suppliers
1147 * @np: Pointer to device tree node containing a list
1148 * @prop_name: Name of property to be parsed. Expected to hold phandle values
1149 * @index: For properties holding a list of phandles, this is the index
1151 * @suffix: Property suffix that is known to contain list of phandle(s) to
1153 * @cells_name: property name that specifies phandles' arguments count
1155 * This is a helper function to parse properties that have a known fixed suffix
1156 * and are a list of phandles and phandle arguments.
1159 * - phandle node pointer with refcount incremented. Caller must of_node_put()
1161 * - NULL if no phandle found at index
1163 static struct device_node *parse_suffix_prop_cells(struct device_node *np,
1164 const char *prop_name, int index,
1166 const char *cells_name)
1168 struct of_phandle_args sup_args;
1170 if (strcmp_suffix(prop_name, suffix))
1173 if (of_parse_phandle_with_args(np, prop_name, cells_name, index,
1180 #define DEFINE_SUFFIX_PROP(fname, suffix, cells) \
1181 static struct device_node *parse_##fname(struct device_node *np, \
1182 const char *prop_name, int index) \
1184 return parse_suffix_prop_cells(np, prop_name, index, suffix, cells); \
1188 * struct supplier_bindings - Property parsing functions for suppliers
1190 * @parse_prop: function name
1191 * parse_prop() finds the node corresponding to a supplier phandle
1192 * @parse_prop.np: Pointer to device node holding supplier phandle property
1193 * @parse_prop.prop_name: Name of property holding a phandle value
1194 * @parse_prop.index: For properties holding a list of phandles, this is the
1195 * index into the list
1196 * @get_con_dev: If the consumer node containing the property is never converted
1197 * to a struct device, implement this ops so fw_devlink can use it
1198 * to find the true consumer.
1199 * @optional: Describes whether a supplier is mandatory or not
1202 * parse_prop() return values are
1203 * - phandle node pointer with refcount incremented. Caller must of_node_put()
1205 * - NULL if no phandle found at index
1207 struct supplier_bindings {
1208 struct device_node *(*parse_prop)(struct device_node *np,
1209 const char *prop_name, int index);
1210 struct device_node *(*get_con_dev)(struct device_node *np);
1214 DEFINE_SIMPLE_PROP(clocks, "clocks", "#clock-cells")
1215 DEFINE_SIMPLE_PROP(interconnects, "interconnects", "#interconnect-cells")
1216 DEFINE_SIMPLE_PROP(iommus, "iommus", "#iommu-cells")
1217 DEFINE_SIMPLE_PROP(mboxes, "mboxes", "#mbox-cells")
1218 DEFINE_SIMPLE_PROP(io_channels, "io-channels", "#io-channel-cells")
1219 DEFINE_SIMPLE_PROP(interrupt_parent, "interrupt-parent", NULL)
1220 DEFINE_SIMPLE_PROP(dmas, "dmas", "#dma-cells")
1221 DEFINE_SIMPLE_PROP(power_domains, "power-domains", "#power-domain-cells")
1222 DEFINE_SIMPLE_PROP(hwlocks, "hwlocks", "#hwlock-cells")
1223 DEFINE_SIMPLE_PROP(extcon, "extcon", NULL)
1224 DEFINE_SIMPLE_PROP(nvmem_cells, "nvmem-cells", "#nvmem-cell-cells")
1225 DEFINE_SIMPLE_PROP(phys, "phys", "#phy-cells")
1226 DEFINE_SIMPLE_PROP(wakeup_parent, "wakeup-parent", NULL)
1227 DEFINE_SIMPLE_PROP(pinctrl0, "pinctrl-0", NULL)
1228 DEFINE_SIMPLE_PROP(pinctrl1, "pinctrl-1", NULL)
1229 DEFINE_SIMPLE_PROP(pinctrl2, "pinctrl-2", NULL)
1230 DEFINE_SIMPLE_PROP(pinctrl3, "pinctrl-3", NULL)
1231 DEFINE_SIMPLE_PROP(pinctrl4, "pinctrl-4", NULL)
1232 DEFINE_SIMPLE_PROP(pinctrl5, "pinctrl-5", NULL)
1233 DEFINE_SIMPLE_PROP(pinctrl6, "pinctrl-6", NULL)
1234 DEFINE_SIMPLE_PROP(pinctrl7, "pinctrl-7", NULL)
1235 DEFINE_SIMPLE_PROP(pinctrl8, "pinctrl-8", NULL)
1236 DEFINE_SIMPLE_PROP(pwms, "pwms", "#pwm-cells")
1237 DEFINE_SIMPLE_PROP(resets, "resets", "#reset-cells")
1238 DEFINE_SIMPLE_PROP(leds, "leds", NULL)
1239 DEFINE_SIMPLE_PROP(backlight, "backlight", NULL)
1240 DEFINE_SIMPLE_PROP(panel, "panel", NULL)
1241 DEFINE_SIMPLE_PROP(msi_parent, "msi-parent", "#msi-cells")
1242 DEFINE_SUFFIX_PROP(regulators, "-supply", NULL)
1243 DEFINE_SUFFIX_PROP(gpio, "-gpio", "#gpio-cells")
1245 static struct device_node *parse_gpios(struct device_node *np,
1246 const char *prop_name, int index)
1248 if (!strcmp_suffix(prop_name, ",nr-gpios"))
1251 return parse_suffix_prop_cells(np, prop_name, index, "-gpios",
1255 static struct device_node *parse_iommu_maps(struct device_node *np,
1256 const char *prop_name, int index)
1258 if (strcmp(prop_name, "iommu-map"))
1261 return of_parse_phandle(np, prop_name, (index * 4) + 1);
1264 static struct device_node *parse_gpio_compat(struct device_node *np,
1265 const char *prop_name, int index)
1267 struct of_phandle_args sup_args;
1269 if (strcmp(prop_name, "gpio") && strcmp(prop_name, "gpios"))
1273 * Ignore node with gpio-hog property since its gpios are all provided
1276 if (of_property_read_bool(np, "gpio-hog"))
1279 if (of_parse_phandle_with_args(np, prop_name, "#gpio-cells", index,
1286 static struct device_node *parse_interrupts(struct device_node *np,
1287 const char *prop_name, int index)
1289 struct of_phandle_args sup_args;
1291 if (!IS_ENABLED(CONFIG_OF_IRQ) || IS_ENABLED(CONFIG_PPC))
1294 if (strcmp(prop_name, "interrupts") &&
1295 strcmp(prop_name, "interrupts-extended"))
1298 return of_irq_parse_one(np, index, &sup_args) ? NULL : sup_args.np;
1301 static struct device_node *parse_remote_endpoint(struct device_node *np,
1302 const char *prop_name,
1305 /* Return NULL for index > 0 to signify end of remote-endpoints. */
1306 if (index > 0 || strcmp(prop_name, "remote-endpoint"))
1309 return of_graph_get_remote_port_parent(np);
1312 static const struct supplier_bindings of_supplier_bindings[] = {
1313 { .parse_prop = parse_clocks, },
1314 { .parse_prop = parse_interconnects, },
1315 { .parse_prop = parse_iommus, .optional = true, },
1316 { .parse_prop = parse_iommu_maps, .optional = true, },
1317 { .parse_prop = parse_mboxes, },
1318 { .parse_prop = parse_io_channels, },
1319 { .parse_prop = parse_interrupt_parent, },
1320 { .parse_prop = parse_dmas, .optional = true, },
1321 { .parse_prop = parse_power_domains, },
1322 { .parse_prop = parse_hwlocks, },
1323 { .parse_prop = parse_extcon, },
1324 { .parse_prop = parse_nvmem_cells, },
1325 { .parse_prop = parse_phys, },
1326 { .parse_prop = parse_wakeup_parent, },
1327 { .parse_prop = parse_pinctrl0, },
1328 { .parse_prop = parse_pinctrl1, },
1329 { .parse_prop = parse_pinctrl2, },
1330 { .parse_prop = parse_pinctrl3, },
1331 { .parse_prop = parse_pinctrl4, },
1332 { .parse_prop = parse_pinctrl5, },
1333 { .parse_prop = parse_pinctrl6, },
1334 { .parse_prop = parse_pinctrl7, },
1335 { .parse_prop = parse_pinctrl8, },
1337 .parse_prop = parse_remote_endpoint,
1338 .get_con_dev = of_graph_get_port_parent,
1340 { .parse_prop = parse_pwms, },
1341 { .parse_prop = parse_resets, },
1342 { .parse_prop = parse_leds, },
1343 { .parse_prop = parse_backlight, },
1344 { .parse_prop = parse_panel, },
1345 { .parse_prop = parse_msi_parent, },
1346 { .parse_prop = parse_gpio_compat, },
1347 { .parse_prop = parse_interrupts, },
1348 { .parse_prop = parse_regulators, },
1349 { .parse_prop = parse_gpio, },
1350 { .parse_prop = parse_gpios, },
1355 * of_link_property - Create device links to suppliers listed in a property
1356 * @con_np: The consumer device tree node which contains the property
1357 * @prop_name: Name of property to be parsed
1359 * This function checks if the property @prop_name that is present in the
1360 * @con_np device tree node is one of the known common device tree bindings
1361 * that list phandles to suppliers. If @prop_name isn't one, this function
1362 * doesn't do anything.
1364 * If @prop_name is one, this function attempts to create fwnode links from the
1365 * consumer device tree node @con_np to all the suppliers device tree nodes
1366 * listed in @prop_name.
1368 * Any failed attempt to create a fwnode link will NOT result in an immediate
1369 * return. of_link_property() must create links to all the available supplier
1370 * device tree nodes even when attempts to create a link to one or more
1373 static int of_link_property(struct device_node *con_np, const char *prop_name)
1375 struct device_node *phandle;
1376 const struct supplier_bindings *s = of_supplier_bindings;
1378 bool matched = false;
1380 /* Do not stop at first failed link, link all available suppliers. */
1381 while (!matched && s->parse_prop) {
1382 if (s->optional && !fw_devlink_is_strict()) {
1387 while ((phandle = s->parse_prop(con_np, prop_name, i))) {
1388 struct device_node *con_dev_np;
1390 con_dev_np = s->get_con_dev
1391 ? s->get_con_dev(con_np)
1392 : of_node_get(con_np);
1395 of_link_to_phandle(con_dev_np, phandle);
1396 of_node_put(phandle);
1397 of_node_put(con_dev_np);
1404 static void __iomem *of_fwnode_iomap(struct fwnode_handle *fwnode, int index)
1406 #ifdef CONFIG_OF_ADDRESS
1407 return of_iomap(to_of_node(fwnode), index);
1413 static int of_fwnode_irq_get(const struct fwnode_handle *fwnode,
1416 return of_irq_get(to_of_node(fwnode), index);
1419 static int of_fwnode_add_links(struct fwnode_handle *fwnode)
1422 struct device_node *con_np = to_of_node(fwnode);
1424 if (IS_ENABLED(CONFIG_X86))
1430 for_each_property_of_node(con_np, p)
1431 of_link_property(con_np, p->name);
1436 const struct fwnode_operations of_fwnode_ops = {
1437 .get = of_fwnode_get,
1438 .put = of_fwnode_put,
1439 .device_is_available = of_fwnode_device_is_available,
1440 .device_get_match_data = of_fwnode_device_get_match_data,
1441 .device_dma_supported = of_fwnode_device_dma_supported,
1442 .device_get_dma_attr = of_fwnode_device_get_dma_attr,
1443 .property_present = of_fwnode_property_present,
1444 .property_read_int_array = of_fwnode_property_read_int_array,
1445 .property_read_string_array = of_fwnode_property_read_string_array,
1446 .get_name = of_fwnode_get_name,
1447 .get_name_prefix = of_fwnode_get_name_prefix,
1448 .get_parent = of_fwnode_get_parent,
1449 .get_next_child_node = of_fwnode_get_next_child_node,
1450 .get_named_child_node = of_fwnode_get_named_child_node,
1451 .get_reference_args = of_fwnode_get_reference_args,
1452 .graph_get_next_endpoint = of_fwnode_graph_get_next_endpoint,
1453 .graph_get_remote_endpoint = of_fwnode_graph_get_remote_endpoint,
1454 .graph_get_port_parent = of_fwnode_graph_get_port_parent,
1455 .graph_parse_endpoint = of_fwnode_graph_parse_endpoint,
1456 .iomap = of_fwnode_iomap,
1457 .irq_get = of_fwnode_irq_get,
1458 .add_links = of_fwnode_add_links,
1460 EXPORT_SYMBOL_GPL(of_fwnode_ops);