1af6074fcSRob Herring // SPDX-License-Identifier: GPL-2.0+ 21df09bc6SSakari Ailus /* 31df09bc6SSakari Ailus * drivers/of/property.c - Procedures for accessing and interpreting 41df09bc6SSakari Ailus * Devicetree properties and graphs. 51df09bc6SSakari Ailus * 61df09bc6SSakari Ailus * Initially created by copying procedures from drivers/of/base.c. This 71df09bc6SSakari Ailus * file contains the OF property as well as the OF graph interface 81df09bc6SSakari Ailus * functions. 91df09bc6SSakari Ailus * 101df09bc6SSakari Ailus * Paul Mackerras August 1996. 111df09bc6SSakari Ailus * Copyright (C) 1996-2005 Paul Mackerras. 121df09bc6SSakari Ailus * 131df09bc6SSakari Ailus * Adapted for 64bit PowerPC by Dave Engebretsen and Peter Bergner. 141df09bc6SSakari Ailus * {engebret|bergner}@us.ibm.com 151df09bc6SSakari Ailus * 161df09bc6SSakari Ailus * Adapted for sparc and sparc64 by David S. Miller davem@davemloft.net 171df09bc6SSakari Ailus * 181df09bc6SSakari Ailus * Reconsolidated from arch/x/kernel/prom.c by Stephen Rothwell and 191df09bc6SSakari Ailus * Grant Likely. 201df09bc6SSakari Ailus */ 211df09bc6SSakari Ailus 221df09bc6SSakari Ailus #define pr_fmt(fmt) "OF: " fmt 231df09bc6SSakari Ailus 241df09bc6SSakari Ailus #include <linux/of.h> 251df09bc6SSakari Ailus #include <linux/of_device.h> 261df09bc6SSakari Ailus #include <linux/of_graph.h> 274104ca77SSaravana Kannan #include <linux/of_irq.h> 281df09bc6SSakari Ailus #include <linux/string.h> 29a3e1d1a7SSaravana Kannan #include <linux/moduleparam.h> 301df09bc6SSakari Ailus 311df09bc6SSakari Ailus #include "of_private.h" 321df09bc6SSakari Ailus 331df09bc6SSakari Ailus /** 344ec0a44bSDmitry Osipenko * of_graph_is_present() - check graph's presence 354ec0a44bSDmitry Osipenko * @node: pointer to device_node containing graph port 364ec0a44bSDmitry Osipenko * 374ec0a44bSDmitry Osipenko * Return: True if @node has a port or ports (with a port) sub-node, 384ec0a44bSDmitry Osipenko * false otherwise. 394ec0a44bSDmitry Osipenko */ 404ec0a44bSDmitry Osipenko bool of_graph_is_present(const struct device_node *node) 414ec0a44bSDmitry Osipenko { 424ec0a44bSDmitry Osipenko struct device_node *ports, *port; 434ec0a44bSDmitry Osipenko 444ec0a44bSDmitry Osipenko ports = of_get_child_by_name(node, "ports"); 454ec0a44bSDmitry Osipenko if (ports) 464ec0a44bSDmitry Osipenko node = ports; 474ec0a44bSDmitry Osipenko 484ec0a44bSDmitry Osipenko port = of_get_child_by_name(node, "port"); 494ec0a44bSDmitry Osipenko of_node_put(ports); 504ec0a44bSDmitry Osipenko of_node_put(port); 514ec0a44bSDmitry Osipenko 524ec0a44bSDmitry Osipenko return !!port; 534ec0a44bSDmitry Osipenko } 544ec0a44bSDmitry Osipenko EXPORT_SYMBOL(of_graph_is_present); 554ec0a44bSDmitry Osipenko 564ec0a44bSDmitry Osipenko /** 571df09bc6SSakari Ailus * of_property_count_elems_of_size - Count the number of elements in a property 581df09bc6SSakari Ailus * 591df09bc6SSakari Ailus * @np: device node from which the property value is to be read. 601df09bc6SSakari Ailus * @propname: name of the property to be searched. 611df09bc6SSakari Ailus * @elem_size: size of the individual element 621df09bc6SSakari Ailus * 631df09bc6SSakari Ailus * Search for a property in a device node and count the number of elements of 641df09bc6SSakari Ailus * size elem_size in it. Returns number of elements on sucess, -EINVAL if the 651df09bc6SSakari Ailus * property does not exist or its length does not match a multiple of elem_size 661df09bc6SSakari Ailus * and -ENODATA if the property does not have a value. 671df09bc6SSakari Ailus */ 681df09bc6SSakari Ailus int of_property_count_elems_of_size(const struct device_node *np, 691df09bc6SSakari Ailus const char *propname, int elem_size) 701df09bc6SSakari Ailus { 711df09bc6SSakari Ailus struct property *prop = of_find_property(np, propname, NULL); 721df09bc6SSakari Ailus 731df09bc6SSakari Ailus if (!prop) 741df09bc6SSakari Ailus return -EINVAL; 751df09bc6SSakari Ailus if (!prop->value) 761df09bc6SSakari Ailus return -ENODATA; 771df09bc6SSakari Ailus 781df09bc6SSakari Ailus if (prop->length % elem_size != 0) { 790d638a07SRob Herring pr_err("size of %s in node %pOF is not a multiple of %d\n", 800d638a07SRob Herring propname, np, elem_size); 811df09bc6SSakari Ailus return -EINVAL; 821df09bc6SSakari Ailus } 831df09bc6SSakari Ailus 841df09bc6SSakari Ailus return prop->length / elem_size; 851df09bc6SSakari Ailus } 861df09bc6SSakari Ailus EXPORT_SYMBOL_GPL(of_property_count_elems_of_size); 871df09bc6SSakari Ailus 881df09bc6SSakari Ailus /** 891df09bc6SSakari Ailus * of_find_property_value_of_size 901df09bc6SSakari Ailus * 911df09bc6SSakari Ailus * @np: device node from which the property value is to be read. 921df09bc6SSakari Ailus * @propname: name of the property to be searched. 931df09bc6SSakari Ailus * @min: minimum allowed length of property value 941df09bc6SSakari Ailus * @max: maximum allowed length of property value (0 means unlimited) 951df09bc6SSakari Ailus * @len: if !=NULL, actual length is written to here 961df09bc6SSakari Ailus * 971df09bc6SSakari Ailus * Search for a property in a device node and valid the requested size. 981df09bc6SSakari Ailus * Returns the property value on success, -EINVAL if the property does not 991df09bc6SSakari Ailus * exist, -ENODATA if property does not have a value, and -EOVERFLOW if the 1001df09bc6SSakari Ailus * property data is too small or too large. 1011df09bc6SSakari Ailus * 1021df09bc6SSakari Ailus */ 1031df09bc6SSakari Ailus static void *of_find_property_value_of_size(const struct device_node *np, 1041df09bc6SSakari Ailus const char *propname, u32 min, u32 max, size_t *len) 1051df09bc6SSakari Ailus { 1061df09bc6SSakari Ailus struct property *prop = of_find_property(np, propname, NULL); 1071df09bc6SSakari Ailus 1081df09bc6SSakari Ailus if (!prop) 1091df09bc6SSakari Ailus return ERR_PTR(-EINVAL); 1101df09bc6SSakari Ailus if (!prop->value) 1111df09bc6SSakari Ailus return ERR_PTR(-ENODATA); 1121df09bc6SSakari Ailus if (prop->length < min) 1131df09bc6SSakari Ailus return ERR_PTR(-EOVERFLOW); 1141df09bc6SSakari Ailus if (max && prop->length > max) 1151df09bc6SSakari Ailus return ERR_PTR(-EOVERFLOW); 1161df09bc6SSakari Ailus 1171df09bc6SSakari Ailus if (len) 1181df09bc6SSakari Ailus *len = prop->length; 1191df09bc6SSakari Ailus 1201df09bc6SSakari Ailus return prop->value; 1211df09bc6SSakari Ailus } 1221df09bc6SSakari Ailus 1231df09bc6SSakari Ailus /** 1241df09bc6SSakari Ailus * of_property_read_u32_index - Find and read a u32 from a multi-value property. 1251df09bc6SSakari Ailus * 1261df09bc6SSakari Ailus * @np: device node from which the property value is to be read. 1271df09bc6SSakari Ailus * @propname: name of the property to be searched. 1281df09bc6SSakari Ailus * @index: index of the u32 in the list of values 1291df09bc6SSakari Ailus * @out_value: pointer to return value, modified only if no error. 1301df09bc6SSakari Ailus * 1311df09bc6SSakari Ailus * Search for a property in a device node and read nth 32-bit value from 1321df09bc6SSakari Ailus * it. Returns 0 on success, -EINVAL if the property does not exist, 1331df09bc6SSakari Ailus * -ENODATA if property does not have a value, and -EOVERFLOW if the 1341df09bc6SSakari Ailus * property data isn't large enough. 1351df09bc6SSakari Ailus * 1361df09bc6SSakari Ailus * The out_value is modified only if a valid u32 value can be decoded. 1371df09bc6SSakari Ailus */ 1381df09bc6SSakari Ailus int of_property_read_u32_index(const struct device_node *np, 1391df09bc6SSakari Ailus const char *propname, 1401df09bc6SSakari Ailus u32 index, u32 *out_value) 1411df09bc6SSakari Ailus { 1421df09bc6SSakari Ailus const u32 *val = of_find_property_value_of_size(np, propname, 1431df09bc6SSakari Ailus ((index + 1) * sizeof(*out_value)), 1441df09bc6SSakari Ailus 0, 1451df09bc6SSakari Ailus NULL); 1461df09bc6SSakari Ailus 1471df09bc6SSakari Ailus if (IS_ERR(val)) 1481df09bc6SSakari Ailus return PTR_ERR(val); 1491df09bc6SSakari Ailus 1501df09bc6SSakari Ailus *out_value = be32_to_cpup(((__be32 *)val) + index); 1511df09bc6SSakari Ailus return 0; 1521df09bc6SSakari Ailus } 1531df09bc6SSakari Ailus EXPORT_SYMBOL_GPL(of_property_read_u32_index); 1541df09bc6SSakari Ailus 1551df09bc6SSakari Ailus /** 1561df09bc6SSakari Ailus * of_property_read_u64_index - Find and read a u64 from a multi-value property. 1571df09bc6SSakari Ailus * 1581df09bc6SSakari Ailus * @np: device node from which the property value is to be read. 1591df09bc6SSakari Ailus * @propname: name of the property to be searched. 1601df09bc6SSakari Ailus * @index: index of the u64 in the list of values 1611df09bc6SSakari Ailus * @out_value: pointer to return value, modified only if no error. 1621df09bc6SSakari Ailus * 1631df09bc6SSakari Ailus * Search for a property in a device node and read nth 64-bit value from 1641df09bc6SSakari Ailus * it. Returns 0 on success, -EINVAL if the property does not exist, 1651df09bc6SSakari Ailus * -ENODATA if property does not have a value, and -EOVERFLOW if the 1661df09bc6SSakari Ailus * property data isn't large enough. 1671df09bc6SSakari Ailus * 1681df09bc6SSakari Ailus * The out_value is modified only if a valid u64 value can be decoded. 1691df09bc6SSakari Ailus */ 1701df09bc6SSakari Ailus int of_property_read_u64_index(const struct device_node *np, 1711df09bc6SSakari Ailus const char *propname, 1721df09bc6SSakari Ailus u32 index, u64 *out_value) 1731df09bc6SSakari Ailus { 1741df09bc6SSakari Ailus const u64 *val = of_find_property_value_of_size(np, propname, 1751df09bc6SSakari Ailus ((index + 1) * sizeof(*out_value)), 1761df09bc6SSakari Ailus 0, NULL); 1771df09bc6SSakari Ailus 1781df09bc6SSakari Ailus if (IS_ERR(val)) 1791df09bc6SSakari Ailus return PTR_ERR(val); 1801df09bc6SSakari Ailus 1811df09bc6SSakari Ailus *out_value = be64_to_cpup(((__be64 *)val) + index); 1821df09bc6SSakari Ailus return 0; 1831df09bc6SSakari Ailus } 1841df09bc6SSakari Ailus EXPORT_SYMBOL_GPL(of_property_read_u64_index); 1851df09bc6SSakari Ailus 1861df09bc6SSakari Ailus /** 1871df09bc6SSakari Ailus * of_property_read_variable_u8_array - Find and read an array of u8 from a 1881df09bc6SSakari Ailus * property, with bounds on the minimum and maximum array size. 1891df09bc6SSakari Ailus * 1901df09bc6SSakari Ailus * @np: device node from which the property value is to be read. 1911df09bc6SSakari Ailus * @propname: name of the property to be searched. 1927f3fefeeSMatti Vaittinen * @out_values: pointer to found values. 1931df09bc6SSakari Ailus * @sz_min: minimum number of array elements to read 1941df09bc6SSakari Ailus * @sz_max: maximum number of array elements to read, if zero there is no 1951df09bc6SSakari Ailus * upper limit on the number of elements in the dts entry but only 1961df09bc6SSakari Ailus * sz_min will be read. 1971df09bc6SSakari Ailus * 1981df09bc6SSakari Ailus * Search for a property in a device node and read 8-bit value(s) from 1991df09bc6SSakari Ailus * it. Returns number of elements read on success, -EINVAL if the property 2001df09bc6SSakari Ailus * does not exist, -ENODATA if property does not have a value, and -EOVERFLOW 2011df09bc6SSakari Ailus * if the property data is smaller than sz_min or longer than sz_max. 2021df09bc6SSakari Ailus * 2031df09bc6SSakari Ailus * dts entry of array should be like: 2041df09bc6SSakari Ailus * property = /bits/ 8 <0x50 0x60 0x70>; 2051df09bc6SSakari Ailus * 2061df09bc6SSakari Ailus * The out_values is modified only if a valid u8 value can be decoded. 2071df09bc6SSakari Ailus */ 2081df09bc6SSakari Ailus int of_property_read_variable_u8_array(const struct device_node *np, 2091df09bc6SSakari Ailus const char *propname, u8 *out_values, 2101df09bc6SSakari Ailus size_t sz_min, size_t sz_max) 2111df09bc6SSakari Ailus { 2121df09bc6SSakari Ailus size_t sz, count; 2131df09bc6SSakari Ailus const u8 *val = of_find_property_value_of_size(np, propname, 2141df09bc6SSakari Ailus (sz_min * sizeof(*out_values)), 2151df09bc6SSakari Ailus (sz_max * sizeof(*out_values)), 2161df09bc6SSakari Ailus &sz); 2171df09bc6SSakari Ailus 2181df09bc6SSakari Ailus if (IS_ERR(val)) 2191df09bc6SSakari Ailus return PTR_ERR(val); 2201df09bc6SSakari Ailus 2211df09bc6SSakari Ailus if (!sz_max) 2221df09bc6SSakari Ailus sz = sz_min; 2231df09bc6SSakari Ailus else 2241df09bc6SSakari Ailus sz /= sizeof(*out_values); 2251df09bc6SSakari Ailus 2261df09bc6SSakari Ailus count = sz; 2271df09bc6SSakari Ailus while (count--) 2281df09bc6SSakari Ailus *out_values++ = *val++; 2291df09bc6SSakari Ailus 2301df09bc6SSakari Ailus return sz; 2311df09bc6SSakari Ailus } 2321df09bc6SSakari Ailus EXPORT_SYMBOL_GPL(of_property_read_variable_u8_array); 2331df09bc6SSakari Ailus 2341df09bc6SSakari Ailus /** 2351df09bc6SSakari Ailus * of_property_read_variable_u16_array - Find and read an array of u16 from a 2361df09bc6SSakari Ailus * property, with bounds on the minimum and maximum array size. 2371df09bc6SSakari Ailus * 2381df09bc6SSakari Ailus * @np: device node from which the property value is to be read. 2391df09bc6SSakari Ailus * @propname: name of the property to be searched. 2407f3fefeeSMatti Vaittinen * @out_values: pointer to found values. 2411df09bc6SSakari Ailus * @sz_min: minimum number of array elements to read 2421df09bc6SSakari Ailus * @sz_max: maximum number of array elements to read, if zero there is no 2431df09bc6SSakari Ailus * upper limit on the number of elements in the dts entry but only 2441df09bc6SSakari Ailus * sz_min will be read. 2451df09bc6SSakari Ailus * 2461df09bc6SSakari Ailus * Search for a property in a device node and read 16-bit value(s) from 2471df09bc6SSakari Ailus * it. Returns number of elements read on success, -EINVAL if the property 2481df09bc6SSakari Ailus * does not exist, -ENODATA if property does not have a value, and -EOVERFLOW 2491df09bc6SSakari Ailus * if the property data is smaller than sz_min or longer than sz_max. 2501df09bc6SSakari Ailus * 2511df09bc6SSakari Ailus * dts entry of array should be like: 2521df09bc6SSakari Ailus * property = /bits/ 16 <0x5000 0x6000 0x7000>; 2531df09bc6SSakari Ailus * 2541df09bc6SSakari Ailus * The out_values is modified only if a valid u16 value can be decoded. 2551df09bc6SSakari Ailus */ 2561df09bc6SSakari Ailus int of_property_read_variable_u16_array(const struct device_node *np, 2571df09bc6SSakari Ailus const char *propname, u16 *out_values, 2581df09bc6SSakari Ailus size_t sz_min, size_t sz_max) 2591df09bc6SSakari Ailus { 2601df09bc6SSakari Ailus size_t sz, count; 2611df09bc6SSakari Ailus const __be16 *val = of_find_property_value_of_size(np, propname, 2621df09bc6SSakari Ailus (sz_min * sizeof(*out_values)), 2631df09bc6SSakari Ailus (sz_max * sizeof(*out_values)), 2641df09bc6SSakari Ailus &sz); 2651df09bc6SSakari Ailus 2661df09bc6SSakari Ailus if (IS_ERR(val)) 2671df09bc6SSakari Ailus return PTR_ERR(val); 2681df09bc6SSakari Ailus 2691df09bc6SSakari Ailus if (!sz_max) 2701df09bc6SSakari Ailus sz = sz_min; 2711df09bc6SSakari Ailus else 2721df09bc6SSakari Ailus sz /= sizeof(*out_values); 2731df09bc6SSakari Ailus 2741df09bc6SSakari Ailus count = sz; 2751df09bc6SSakari Ailus while (count--) 2761df09bc6SSakari Ailus *out_values++ = be16_to_cpup(val++); 2771df09bc6SSakari Ailus 2781df09bc6SSakari Ailus return sz; 2791df09bc6SSakari Ailus } 2801df09bc6SSakari Ailus EXPORT_SYMBOL_GPL(of_property_read_variable_u16_array); 2811df09bc6SSakari Ailus 2821df09bc6SSakari Ailus /** 2831df09bc6SSakari Ailus * of_property_read_variable_u32_array - Find and read an array of 32 bit 2841df09bc6SSakari Ailus * integers from a property, with bounds on the minimum and maximum array size. 2851df09bc6SSakari Ailus * 2861df09bc6SSakari Ailus * @np: device node from which the property value is to be read. 2871df09bc6SSakari Ailus * @propname: name of the property to be searched. 2887f3fefeeSMatti Vaittinen * @out_values: pointer to return found values. 2891df09bc6SSakari Ailus * @sz_min: minimum number of array elements to read 2901df09bc6SSakari Ailus * @sz_max: maximum number of array elements to read, if zero there is no 2911df09bc6SSakari Ailus * upper limit on the number of elements in the dts entry but only 2921df09bc6SSakari Ailus * sz_min will be read. 2931df09bc6SSakari Ailus * 2941df09bc6SSakari Ailus * Search for a property in a device node and read 32-bit value(s) from 2951df09bc6SSakari Ailus * it. Returns number of elements read on success, -EINVAL if the property 2961df09bc6SSakari Ailus * does not exist, -ENODATA if property does not have a value, and -EOVERFLOW 2971df09bc6SSakari Ailus * if the property data is smaller than sz_min or longer than sz_max. 2981df09bc6SSakari Ailus * 2991df09bc6SSakari Ailus * The out_values is modified only if a valid u32 value can be decoded. 3001df09bc6SSakari Ailus */ 3011df09bc6SSakari Ailus int of_property_read_variable_u32_array(const struct device_node *np, 3021df09bc6SSakari Ailus const char *propname, u32 *out_values, 3031df09bc6SSakari Ailus size_t sz_min, size_t sz_max) 3041df09bc6SSakari Ailus { 3051df09bc6SSakari Ailus size_t sz, count; 3061df09bc6SSakari Ailus const __be32 *val = of_find_property_value_of_size(np, propname, 3071df09bc6SSakari Ailus (sz_min * sizeof(*out_values)), 3081df09bc6SSakari Ailus (sz_max * sizeof(*out_values)), 3091df09bc6SSakari Ailus &sz); 3101df09bc6SSakari Ailus 3111df09bc6SSakari Ailus if (IS_ERR(val)) 3121df09bc6SSakari Ailus return PTR_ERR(val); 3131df09bc6SSakari Ailus 3141df09bc6SSakari Ailus if (!sz_max) 3151df09bc6SSakari Ailus sz = sz_min; 3161df09bc6SSakari Ailus else 3171df09bc6SSakari Ailus sz /= sizeof(*out_values); 3181df09bc6SSakari Ailus 3191df09bc6SSakari Ailus count = sz; 3201df09bc6SSakari Ailus while (count--) 3211df09bc6SSakari Ailus *out_values++ = be32_to_cpup(val++); 3221df09bc6SSakari Ailus 3231df09bc6SSakari Ailus return sz; 3241df09bc6SSakari Ailus } 3251df09bc6SSakari Ailus EXPORT_SYMBOL_GPL(of_property_read_variable_u32_array); 3261df09bc6SSakari Ailus 3271df09bc6SSakari Ailus /** 3281df09bc6SSakari Ailus * of_property_read_u64 - Find and read a 64 bit integer from a property 3291df09bc6SSakari Ailus * @np: device node from which the property value is to be read. 3301df09bc6SSakari Ailus * @propname: name of the property to be searched. 3311df09bc6SSakari Ailus * @out_value: pointer to return value, modified only if return value is 0. 3321df09bc6SSakari Ailus * 3331df09bc6SSakari Ailus * Search for a property in a device node and read a 64-bit value from 3341df09bc6SSakari Ailus * it. Returns 0 on success, -EINVAL if the property does not exist, 3351df09bc6SSakari Ailus * -ENODATA if property does not have a value, and -EOVERFLOW if the 3361df09bc6SSakari Ailus * property data isn't large enough. 3371df09bc6SSakari Ailus * 3381df09bc6SSakari Ailus * The out_value is modified only if a valid u64 value can be decoded. 3391df09bc6SSakari Ailus */ 3401df09bc6SSakari Ailus int of_property_read_u64(const struct device_node *np, const char *propname, 3411df09bc6SSakari Ailus u64 *out_value) 3421df09bc6SSakari Ailus { 3431df09bc6SSakari Ailus const __be32 *val = of_find_property_value_of_size(np, propname, 3441df09bc6SSakari Ailus sizeof(*out_value), 3451df09bc6SSakari Ailus 0, 3461df09bc6SSakari Ailus NULL); 3471df09bc6SSakari Ailus 3481df09bc6SSakari Ailus if (IS_ERR(val)) 3491df09bc6SSakari Ailus return PTR_ERR(val); 3501df09bc6SSakari Ailus 3511df09bc6SSakari Ailus *out_value = of_read_number(val, 2); 3521df09bc6SSakari Ailus return 0; 3531df09bc6SSakari Ailus } 3541df09bc6SSakari Ailus EXPORT_SYMBOL_GPL(of_property_read_u64); 3551df09bc6SSakari Ailus 3561df09bc6SSakari Ailus /** 3571df09bc6SSakari Ailus * of_property_read_variable_u64_array - Find and read an array of 64 bit 3581df09bc6SSakari Ailus * integers from a property, with bounds on the minimum and maximum array size. 3591df09bc6SSakari Ailus * 3601df09bc6SSakari Ailus * @np: device node from which the property value is to be read. 3611df09bc6SSakari Ailus * @propname: name of the property to be searched. 3627f3fefeeSMatti Vaittinen * @out_values: pointer to found values. 3631df09bc6SSakari Ailus * @sz_min: minimum number of array elements to read 3641df09bc6SSakari Ailus * @sz_max: maximum number of array elements to read, if zero there is no 3651df09bc6SSakari Ailus * upper limit on the number of elements in the dts entry but only 3661df09bc6SSakari Ailus * sz_min will be read. 3671df09bc6SSakari Ailus * 3681df09bc6SSakari Ailus * Search for a property in a device node and read 64-bit value(s) from 3691df09bc6SSakari Ailus * it. Returns number of elements read on success, -EINVAL if the property 3701df09bc6SSakari Ailus * does not exist, -ENODATA if property does not have a value, and -EOVERFLOW 3711df09bc6SSakari Ailus * if the property data is smaller than sz_min or longer than sz_max. 3721df09bc6SSakari Ailus * 3731df09bc6SSakari Ailus * The out_values is modified only if a valid u64 value can be decoded. 3741df09bc6SSakari Ailus */ 3751df09bc6SSakari Ailus int of_property_read_variable_u64_array(const struct device_node *np, 3761df09bc6SSakari Ailus const char *propname, u64 *out_values, 3771df09bc6SSakari Ailus size_t sz_min, size_t sz_max) 3781df09bc6SSakari Ailus { 3791df09bc6SSakari Ailus size_t sz, count; 3801df09bc6SSakari Ailus const __be32 *val = of_find_property_value_of_size(np, propname, 3811df09bc6SSakari Ailus (sz_min * sizeof(*out_values)), 3821df09bc6SSakari Ailus (sz_max * sizeof(*out_values)), 3831df09bc6SSakari Ailus &sz); 3841df09bc6SSakari Ailus 3851df09bc6SSakari Ailus if (IS_ERR(val)) 3861df09bc6SSakari Ailus return PTR_ERR(val); 3871df09bc6SSakari Ailus 3881df09bc6SSakari Ailus if (!sz_max) 3891df09bc6SSakari Ailus sz = sz_min; 3901df09bc6SSakari Ailus else 3911df09bc6SSakari Ailus sz /= sizeof(*out_values); 3921df09bc6SSakari Ailus 3931df09bc6SSakari Ailus count = sz; 3941df09bc6SSakari Ailus while (count--) { 3951df09bc6SSakari Ailus *out_values++ = of_read_number(val, 2); 3961df09bc6SSakari Ailus val += 2; 3971df09bc6SSakari Ailus } 3981df09bc6SSakari Ailus 3991df09bc6SSakari Ailus return sz; 4001df09bc6SSakari Ailus } 4011df09bc6SSakari Ailus EXPORT_SYMBOL_GPL(of_property_read_variable_u64_array); 4021df09bc6SSakari Ailus 4031df09bc6SSakari Ailus /** 4041df09bc6SSakari Ailus * of_property_read_string - Find and read a string from a property 4051df09bc6SSakari Ailus * @np: device node from which the property value is to be read. 4061df09bc6SSakari Ailus * @propname: name of the property to be searched. 4071df09bc6SSakari Ailus * @out_string: pointer to null terminated return string, modified only if 4081df09bc6SSakari Ailus * return value is 0. 4091df09bc6SSakari Ailus * 4101df09bc6SSakari Ailus * Search for a property in a device tree node and retrieve a null 4111df09bc6SSakari Ailus * terminated string value (pointer to data, not a copy). Returns 0 on 4121df09bc6SSakari Ailus * success, -EINVAL if the property does not exist, -ENODATA if property 4131df09bc6SSakari Ailus * does not have a value, and -EILSEQ if the string is not null-terminated 4141df09bc6SSakari Ailus * within the length of the property data. 4151df09bc6SSakari Ailus * 4161df09bc6SSakari Ailus * The out_string pointer is modified only if a valid string can be decoded. 4171df09bc6SSakari Ailus */ 4181df09bc6SSakari Ailus int of_property_read_string(const struct device_node *np, const char *propname, 4191df09bc6SSakari Ailus const char **out_string) 4201df09bc6SSakari Ailus { 4211df09bc6SSakari Ailus const struct property *prop = of_find_property(np, propname, NULL); 4221df09bc6SSakari Ailus if (!prop) 4231df09bc6SSakari Ailus return -EINVAL; 4241df09bc6SSakari Ailus if (!prop->value) 4251df09bc6SSakari Ailus return -ENODATA; 4261df09bc6SSakari Ailus if (strnlen(prop->value, prop->length) >= prop->length) 4271df09bc6SSakari Ailus return -EILSEQ; 4281df09bc6SSakari Ailus *out_string = prop->value; 4291df09bc6SSakari Ailus return 0; 4301df09bc6SSakari Ailus } 4311df09bc6SSakari Ailus EXPORT_SYMBOL_GPL(of_property_read_string); 4321df09bc6SSakari Ailus 4331df09bc6SSakari Ailus /** 4341df09bc6SSakari Ailus * of_property_match_string() - Find string in a list and return index 4351df09bc6SSakari Ailus * @np: pointer to node containing string list property 4361df09bc6SSakari Ailus * @propname: string list property name 4371df09bc6SSakari Ailus * @string: pointer to string to search for in string list 4381df09bc6SSakari Ailus * 4391df09bc6SSakari Ailus * This function searches a string list property and returns the index 4401df09bc6SSakari Ailus * of a specific string value. 4411df09bc6SSakari Ailus */ 4421df09bc6SSakari Ailus int of_property_match_string(const struct device_node *np, const char *propname, 4431df09bc6SSakari Ailus const char *string) 4441df09bc6SSakari Ailus { 4451df09bc6SSakari Ailus const struct property *prop = of_find_property(np, propname, NULL); 4461df09bc6SSakari Ailus size_t l; 4471df09bc6SSakari Ailus int i; 4481df09bc6SSakari Ailus const char *p, *end; 4491df09bc6SSakari Ailus 4501df09bc6SSakari Ailus if (!prop) 4511df09bc6SSakari Ailus return -EINVAL; 4521df09bc6SSakari Ailus if (!prop->value) 4531df09bc6SSakari Ailus return -ENODATA; 4541df09bc6SSakari Ailus 4551df09bc6SSakari Ailus p = prop->value; 4561df09bc6SSakari Ailus end = p + prop->length; 4571df09bc6SSakari Ailus 4581df09bc6SSakari Ailus for (i = 0; p < end; i++, p += l) { 4591df09bc6SSakari Ailus l = strnlen(p, end - p) + 1; 4601df09bc6SSakari Ailus if (p + l > end) 4611df09bc6SSakari Ailus return -EILSEQ; 4621df09bc6SSakari Ailus pr_debug("comparing %s with %s\n", string, p); 4631df09bc6SSakari Ailus if (strcmp(string, p) == 0) 4641df09bc6SSakari Ailus return i; /* Found it; return index */ 4651df09bc6SSakari Ailus } 4661df09bc6SSakari Ailus return -ENODATA; 4671df09bc6SSakari Ailus } 4681df09bc6SSakari Ailus EXPORT_SYMBOL_GPL(of_property_match_string); 4691df09bc6SSakari Ailus 4701df09bc6SSakari Ailus /** 4711df09bc6SSakari Ailus * of_property_read_string_helper() - Utility helper for parsing string properties 4721df09bc6SSakari Ailus * @np: device node from which the property value is to be read. 4731df09bc6SSakari Ailus * @propname: name of the property to be searched. 4741df09bc6SSakari Ailus * @out_strs: output array of string pointers. 4751df09bc6SSakari Ailus * @sz: number of array elements to read. 4761df09bc6SSakari Ailus * @skip: Number of strings to skip over at beginning of list. 4771df09bc6SSakari Ailus * 4781df09bc6SSakari Ailus * Don't call this function directly. It is a utility helper for the 4791df09bc6SSakari Ailus * of_property_read_string*() family of functions. 4801df09bc6SSakari Ailus */ 4811df09bc6SSakari Ailus int of_property_read_string_helper(const struct device_node *np, 4821df09bc6SSakari Ailus const char *propname, const char **out_strs, 4831df09bc6SSakari Ailus size_t sz, int skip) 4841df09bc6SSakari Ailus { 4851df09bc6SSakari Ailus const struct property *prop = of_find_property(np, propname, NULL); 4861df09bc6SSakari Ailus int l = 0, i = 0; 4871df09bc6SSakari Ailus const char *p, *end; 4881df09bc6SSakari Ailus 4891df09bc6SSakari Ailus if (!prop) 4901df09bc6SSakari Ailus return -EINVAL; 4911df09bc6SSakari Ailus if (!prop->value) 4921df09bc6SSakari Ailus return -ENODATA; 4931df09bc6SSakari Ailus p = prop->value; 4941df09bc6SSakari Ailus end = p + prop->length; 4951df09bc6SSakari Ailus 4961df09bc6SSakari Ailus for (i = 0; p < end && (!out_strs || i < skip + sz); i++, p += l) { 4971df09bc6SSakari Ailus l = strnlen(p, end - p) + 1; 4981df09bc6SSakari Ailus if (p + l > end) 4991df09bc6SSakari Ailus return -EILSEQ; 5001df09bc6SSakari Ailus if (out_strs && i >= skip) 5011df09bc6SSakari Ailus *out_strs++ = p; 5021df09bc6SSakari Ailus } 5031df09bc6SSakari Ailus i -= skip; 5041df09bc6SSakari Ailus return i <= 0 ? -ENODATA : i; 5051df09bc6SSakari Ailus } 5061df09bc6SSakari Ailus EXPORT_SYMBOL_GPL(of_property_read_string_helper); 5071df09bc6SSakari Ailus 5081df09bc6SSakari Ailus const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur, 5091df09bc6SSakari Ailus u32 *pu) 5101df09bc6SSakari Ailus { 5111df09bc6SSakari Ailus const void *curv = cur; 5121df09bc6SSakari Ailus 5131df09bc6SSakari Ailus if (!prop) 5141df09bc6SSakari Ailus return NULL; 5151df09bc6SSakari Ailus 5161df09bc6SSakari Ailus if (!cur) { 5171df09bc6SSakari Ailus curv = prop->value; 5181df09bc6SSakari Ailus goto out_val; 5191df09bc6SSakari Ailus } 5201df09bc6SSakari Ailus 5211df09bc6SSakari Ailus curv += sizeof(*cur); 5221df09bc6SSakari Ailus if (curv >= prop->value + prop->length) 5231df09bc6SSakari Ailus return NULL; 5241df09bc6SSakari Ailus 5251df09bc6SSakari Ailus out_val: 5261df09bc6SSakari Ailus *pu = be32_to_cpup(curv); 5271df09bc6SSakari Ailus return curv; 5281df09bc6SSakari Ailus } 5291df09bc6SSakari Ailus EXPORT_SYMBOL_GPL(of_prop_next_u32); 5301df09bc6SSakari Ailus 5311df09bc6SSakari Ailus const char *of_prop_next_string(struct property *prop, const char *cur) 5321df09bc6SSakari Ailus { 5331df09bc6SSakari Ailus const void *curv = cur; 5341df09bc6SSakari Ailus 5351df09bc6SSakari Ailus if (!prop) 5361df09bc6SSakari Ailus return NULL; 5371df09bc6SSakari Ailus 5381df09bc6SSakari Ailus if (!cur) 5391df09bc6SSakari Ailus return prop->value; 5401df09bc6SSakari Ailus 5411df09bc6SSakari Ailus curv += strlen(cur) + 1; 5421df09bc6SSakari Ailus if (curv >= prop->value + prop->length) 5431df09bc6SSakari Ailus return NULL; 5441df09bc6SSakari Ailus 5451df09bc6SSakari Ailus return curv; 5461df09bc6SSakari Ailus } 5471df09bc6SSakari Ailus EXPORT_SYMBOL_GPL(of_prop_next_string); 5481df09bc6SSakari Ailus 5491df09bc6SSakari Ailus /** 5501df09bc6SSakari Ailus * of_graph_parse_endpoint() - parse common endpoint node properties 5511df09bc6SSakari Ailus * @node: pointer to endpoint device_node 5521df09bc6SSakari Ailus * @endpoint: pointer to the OF endpoint data structure 5531df09bc6SSakari Ailus * 5541df09bc6SSakari Ailus * The caller should hold a reference to @node. 5551df09bc6SSakari Ailus */ 5561df09bc6SSakari Ailus int of_graph_parse_endpoint(const struct device_node *node, 5571df09bc6SSakari Ailus struct of_endpoint *endpoint) 5581df09bc6SSakari Ailus { 5591df09bc6SSakari Ailus struct device_node *port_node = of_get_parent(node); 5601df09bc6SSakari Ailus 5610d638a07SRob Herring WARN_ONCE(!port_node, "%s(): endpoint %pOF has no parent node\n", 5620d638a07SRob Herring __func__, node); 5631df09bc6SSakari Ailus 5641df09bc6SSakari Ailus memset(endpoint, 0, sizeof(*endpoint)); 5651df09bc6SSakari Ailus 5661df09bc6SSakari Ailus endpoint->local_node = node; 5671df09bc6SSakari Ailus /* 5681df09bc6SSakari Ailus * It doesn't matter whether the two calls below succeed. 5691df09bc6SSakari Ailus * If they don't then the default value 0 is used. 5701df09bc6SSakari Ailus */ 5711df09bc6SSakari Ailus of_property_read_u32(port_node, "reg", &endpoint->port); 5721df09bc6SSakari Ailus of_property_read_u32(node, "reg", &endpoint->id); 5731df09bc6SSakari Ailus 5741df09bc6SSakari Ailus of_node_put(port_node); 5751df09bc6SSakari Ailus 5761df09bc6SSakari Ailus return 0; 5771df09bc6SSakari Ailus } 5781df09bc6SSakari Ailus EXPORT_SYMBOL(of_graph_parse_endpoint); 5791df09bc6SSakari Ailus 5801df09bc6SSakari Ailus /** 5811df09bc6SSakari Ailus * of_graph_get_port_by_id() - get the port matching a given id 5821df09bc6SSakari Ailus * @parent: pointer to the parent device node 5831df09bc6SSakari Ailus * @id: id of the port 5841df09bc6SSakari Ailus * 5851df09bc6SSakari Ailus * Return: A 'port' node pointer with refcount incremented. The caller 5861df09bc6SSakari Ailus * has to use of_node_put() on it when done. 5871df09bc6SSakari Ailus */ 5881df09bc6SSakari Ailus struct device_node *of_graph_get_port_by_id(struct device_node *parent, u32 id) 5891df09bc6SSakari Ailus { 5901df09bc6SSakari Ailus struct device_node *node, *port; 5911df09bc6SSakari Ailus 5921df09bc6SSakari Ailus node = of_get_child_by_name(parent, "ports"); 5931df09bc6SSakari Ailus if (node) 5941df09bc6SSakari Ailus parent = node; 5951df09bc6SSakari Ailus 5961df09bc6SSakari Ailus for_each_child_of_node(parent, port) { 5971df09bc6SSakari Ailus u32 port_id = 0; 5981df09bc6SSakari Ailus 599b3e46d1aSRob Herring if (!of_node_name_eq(port, "port")) 6001df09bc6SSakari Ailus continue; 6011df09bc6SSakari Ailus of_property_read_u32(port, "reg", &port_id); 6021df09bc6SSakari Ailus if (id == port_id) 6031df09bc6SSakari Ailus break; 6041df09bc6SSakari Ailus } 6051df09bc6SSakari Ailus 6061df09bc6SSakari Ailus of_node_put(node); 6071df09bc6SSakari Ailus 6081df09bc6SSakari Ailus return port; 6091df09bc6SSakari Ailus } 6101df09bc6SSakari Ailus EXPORT_SYMBOL(of_graph_get_port_by_id); 6111df09bc6SSakari Ailus 6121df09bc6SSakari Ailus /** 6131df09bc6SSakari Ailus * of_graph_get_next_endpoint() - get next endpoint node 6141df09bc6SSakari Ailus * @parent: pointer to the parent device node 6151df09bc6SSakari Ailus * @prev: previous endpoint node, or NULL to get first 6161df09bc6SSakari Ailus * 6171df09bc6SSakari Ailus * Return: An 'endpoint' node pointer with refcount incremented. Refcount 6181df09bc6SSakari Ailus * of the passed @prev node is decremented. 6191df09bc6SSakari Ailus */ 6201df09bc6SSakari Ailus struct device_node *of_graph_get_next_endpoint(const struct device_node *parent, 6211df09bc6SSakari Ailus struct device_node *prev) 6221df09bc6SSakari Ailus { 6231df09bc6SSakari Ailus struct device_node *endpoint; 6241df09bc6SSakari Ailus struct device_node *port; 6251df09bc6SSakari Ailus 6261df09bc6SSakari Ailus if (!parent) 6271df09bc6SSakari Ailus return NULL; 6281df09bc6SSakari Ailus 6291df09bc6SSakari Ailus /* 6301df09bc6SSakari Ailus * Start by locating the port node. If no previous endpoint is specified 6311df09bc6SSakari Ailus * search for the first port node, otherwise get the previous endpoint 6321df09bc6SSakari Ailus * parent port node. 6331df09bc6SSakari Ailus */ 6341df09bc6SSakari Ailus if (!prev) { 6351df09bc6SSakari Ailus struct device_node *node; 6361df09bc6SSakari Ailus 6371df09bc6SSakari Ailus node = of_get_child_by_name(parent, "ports"); 6381df09bc6SSakari Ailus if (node) 6391df09bc6SSakari Ailus parent = node; 6401df09bc6SSakari Ailus 6411df09bc6SSakari Ailus port = of_get_child_by_name(parent, "port"); 6421df09bc6SSakari Ailus of_node_put(node); 6431df09bc6SSakari Ailus 6441df09bc6SSakari Ailus if (!port) { 6450d638a07SRob Herring pr_err("graph: no port node found in %pOF\n", parent); 6461df09bc6SSakari Ailus return NULL; 6471df09bc6SSakari Ailus } 6481df09bc6SSakari Ailus } else { 6491df09bc6SSakari Ailus port = of_get_parent(prev); 6500d638a07SRob Herring if (WARN_ONCE(!port, "%s(): endpoint %pOF has no parent node\n", 6510d638a07SRob Herring __func__, prev)) 6521df09bc6SSakari Ailus return NULL; 6531df09bc6SSakari Ailus } 6541df09bc6SSakari Ailus 6551df09bc6SSakari Ailus while (1) { 6561df09bc6SSakari Ailus /* 6571df09bc6SSakari Ailus * Now that we have a port node, get the next endpoint by 6581df09bc6SSakari Ailus * getting the next child. If the previous endpoint is NULL this 6591df09bc6SSakari Ailus * will return the first child. 6601df09bc6SSakari Ailus */ 6611df09bc6SSakari Ailus endpoint = of_get_next_child(port, prev); 6621df09bc6SSakari Ailus if (endpoint) { 6631df09bc6SSakari Ailus of_node_put(port); 6641df09bc6SSakari Ailus return endpoint; 6651df09bc6SSakari Ailus } 6661df09bc6SSakari Ailus 6671df09bc6SSakari Ailus /* No more endpoints under this port, try the next one. */ 6681df09bc6SSakari Ailus prev = NULL; 6691df09bc6SSakari Ailus 6701df09bc6SSakari Ailus do { 6711df09bc6SSakari Ailus port = of_get_next_child(parent, port); 6721df09bc6SSakari Ailus if (!port) 6731df09bc6SSakari Ailus return NULL; 674b3e46d1aSRob Herring } while (!of_node_name_eq(port, "port")); 6751df09bc6SSakari Ailus } 6761df09bc6SSakari Ailus } 6771df09bc6SSakari Ailus EXPORT_SYMBOL(of_graph_get_next_endpoint); 6781df09bc6SSakari Ailus 6791df09bc6SSakari Ailus /** 6801df09bc6SSakari Ailus * of_graph_get_endpoint_by_regs() - get endpoint node of specific identifiers 6811df09bc6SSakari Ailus * @parent: pointer to the parent device node 6821df09bc6SSakari Ailus * @port_reg: identifier (value of reg property) of the parent port node 6831df09bc6SSakari Ailus * @reg: identifier (value of reg property) of the endpoint node 6841df09bc6SSakari Ailus * 6851df09bc6SSakari Ailus * Return: An 'endpoint' node pointer which is identified by reg and at the same 6861df09bc6SSakari Ailus * is the child of a port node identified by port_reg. reg and port_reg are 687deb387d4SMaxime Ripard * ignored when they are -1. Use of_node_put() on the pointer when done. 6881df09bc6SSakari Ailus */ 6891df09bc6SSakari Ailus struct device_node *of_graph_get_endpoint_by_regs( 6901df09bc6SSakari Ailus const struct device_node *parent, int port_reg, int reg) 6911df09bc6SSakari Ailus { 6921df09bc6SSakari Ailus struct of_endpoint endpoint; 6931df09bc6SSakari Ailus struct device_node *node = NULL; 6941df09bc6SSakari Ailus 6951df09bc6SSakari Ailus for_each_endpoint_of_node(parent, node) { 6961df09bc6SSakari Ailus of_graph_parse_endpoint(node, &endpoint); 6971df09bc6SSakari Ailus if (((port_reg == -1) || (endpoint.port == port_reg)) && 6981df09bc6SSakari Ailus ((reg == -1) || (endpoint.id == reg))) 6991df09bc6SSakari Ailus return node; 7001df09bc6SSakari Ailus } 7011df09bc6SSakari Ailus 7021df09bc6SSakari Ailus return NULL; 7031df09bc6SSakari Ailus } 7041df09bc6SSakari Ailus EXPORT_SYMBOL(of_graph_get_endpoint_by_regs); 7051df09bc6SSakari Ailus 7061df09bc6SSakari Ailus /** 707b8ba92b1SRob Herring * of_graph_get_remote_endpoint() - get remote endpoint node 708b8ba92b1SRob Herring * @node: pointer to a local endpoint device_node 709b8ba92b1SRob Herring * 710b8ba92b1SRob Herring * Return: Remote endpoint node associated with remote endpoint node linked 711b8ba92b1SRob Herring * to @node. Use of_node_put() on it when done. 712b8ba92b1SRob Herring */ 713b8ba92b1SRob Herring struct device_node *of_graph_get_remote_endpoint(const struct device_node *node) 714b8ba92b1SRob Herring { 715b8ba92b1SRob Herring /* Get remote endpoint node. */ 716b8ba92b1SRob Herring return of_parse_phandle(node, "remote-endpoint", 0); 717b8ba92b1SRob Herring } 718b8ba92b1SRob Herring EXPORT_SYMBOL(of_graph_get_remote_endpoint); 719b8ba92b1SRob Herring 720b8ba92b1SRob Herring /** 721b8ba92b1SRob Herring * of_graph_get_port_parent() - get port's parent node 722b8ba92b1SRob Herring * @node: pointer to a local endpoint device_node 723b8ba92b1SRob Herring * 724b8ba92b1SRob Herring * Return: device node associated with endpoint node linked 725b8ba92b1SRob Herring * to @node. Use of_node_put() on it when done. 726b8ba92b1SRob Herring */ 727b8ba92b1SRob Herring struct device_node *of_graph_get_port_parent(struct device_node *node) 728b8ba92b1SRob Herring { 729b8ba92b1SRob Herring unsigned int depth; 730b8ba92b1SRob Herring 731c0a480d1STony Lindgren if (!node) 732c0a480d1STony Lindgren return NULL; 733c0a480d1STony Lindgren 734c0a480d1STony Lindgren /* 735c0a480d1STony Lindgren * Preserve usecount for passed in node as of_get_next_parent() 736c0a480d1STony Lindgren * will do of_node_put() on it. 737c0a480d1STony Lindgren */ 738c0a480d1STony Lindgren of_node_get(node); 739c0a480d1STony Lindgren 740b8ba92b1SRob Herring /* Walk 3 levels up only if there is 'ports' node. */ 741b8ba92b1SRob Herring for (depth = 3; depth && node; depth--) { 742b8ba92b1SRob Herring node = of_get_next_parent(node); 743b3e46d1aSRob Herring if (depth == 2 && !of_node_name_eq(node, "ports")) 744b8ba92b1SRob Herring break; 745b8ba92b1SRob Herring } 746b8ba92b1SRob Herring return node; 747b8ba92b1SRob Herring } 748b8ba92b1SRob Herring EXPORT_SYMBOL(of_graph_get_port_parent); 749b8ba92b1SRob Herring 750b8ba92b1SRob Herring /** 7511df09bc6SSakari Ailus * of_graph_get_remote_port_parent() - get remote port's parent node 7521df09bc6SSakari Ailus * @node: pointer to a local endpoint device_node 7531df09bc6SSakari Ailus * 7541df09bc6SSakari Ailus * Return: Remote device node associated with remote endpoint node linked 7551df09bc6SSakari Ailus * to @node. Use of_node_put() on it when done. 7561df09bc6SSakari Ailus */ 7571df09bc6SSakari Ailus struct device_node *of_graph_get_remote_port_parent( 7581df09bc6SSakari Ailus const struct device_node *node) 7591df09bc6SSakari Ailus { 760c0a480d1STony Lindgren struct device_node *np, *pp; 7611df09bc6SSakari Ailus 7621df09bc6SSakari Ailus /* Get remote endpoint node. */ 763b8ba92b1SRob Herring np = of_graph_get_remote_endpoint(node); 7641df09bc6SSakari Ailus 765c0a480d1STony Lindgren pp = of_graph_get_port_parent(np); 766c0a480d1STony Lindgren 767c0a480d1STony Lindgren of_node_put(np); 768c0a480d1STony Lindgren 769c0a480d1STony Lindgren return pp; 7701df09bc6SSakari Ailus } 7711df09bc6SSakari Ailus EXPORT_SYMBOL(of_graph_get_remote_port_parent); 7721df09bc6SSakari Ailus 7731df09bc6SSakari Ailus /** 7741df09bc6SSakari Ailus * of_graph_get_remote_port() - get remote port node 7751df09bc6SSakari Ailus * @node: pointer to a local endpoint device_node 7761df09bc6SSakari Ailus * 7771df09bc6SSakari Ailus * Return: Remote port node associated with remote endpoint node linked 7781df09bc6SSakari Ailus * to @node. Use of_node_put() on it when done. 7791df09bc6SSakari Ailus */ 7801df09bc6SSakari Ailus struct device_node *of_graph_get_remote_port(const struct device_node *node) 7811df09bc6SSakari Ailus { 7821df09bc6SSakari Ailus struct device_node *np; 7831df09bc6SSakari Ailus 7841df09bc6SSakari Ailus /* Get remote endpoint node. */ 785b8ba92b1SRob Herring np = of_graph_get_remote_endpoint(node); 7861df09bc6SSakari Ailus if (!np) 7871df09bc6SSakari Ailus return NULL; 7881df09bc6SSakari Ailus return of_get_next_parent(np); 7891df09bc6SSakari Ailus } 7901df09bc6SSakari Ailus EXPORT_SYMBOL(of_graph_get_remote_port); 7911df09bc6SSakari Ailus 792b8ba92b1SRob Herring int of_graph_get_endpoint_count(const struct device_node *np) 793b8ba92b1SRob Herring { 794b8ba92b1SRob Herring struct device_node *endpoint; 795b8ba92b1SRob Herring int num = 0; 796b8ba92b1SRob Herring 797b8ba92b1SRob Herring for_each_endpoint_of_node(np, endpoint) 798b8ba92b1SRob Herring num++; 799b8ba92b1SRob Herring 800b8ba92b1SRob Herring return num; 801b8ba92b1SRob Herring } 802b8ba92b1SRob Herring EXPORT_SYMBOL(of_graph_get_endpoint_count); 803b8ba92b1SRob Herring 8041df09bc6SSakari Ailus /** 8051df09bc6SSakari Ailus * of_graph_get_remote_node() - get remote parent device_node for given port/endpoint 8061df09bc6SSakari Ailus * @node: pointer to parent device_node containing graph port/endpoint 8071df09bc6SSakari Ailus * @port: identifier (value of reg property) of the parent port node 8081df09bc6SSakari Ailus * @endpoint: identifier (value of reg property) of the endpoint node 8091df09bc6SSakari Ailus * 8101df09bc6SSakari Ailus * Return: Remote device node associated with remote endpoint node linked 8111df09bc6SSakari Ailus * to @node. Use of_node_put() on it when done. 8121df09bc6SSakari Ailus */ 8131df09bc6SSakari Ailus struct device_node *of_graph_get_remote_node(const struct device_node *node, 8141df09bc6SSakari Ailus u32 port, u32 endpoint) 8151df09bc6SSakari Ailus { 8161df09bc6SSakari Ailus struct device_node *endpoint_node, *remote; 8171df09bc6SSakari Ailus 8181df09bc6SSakari Ailus endpoint_node = of_graph_get_endpoint_by_regs(node, port, endpoint); 8191df09bc6SSakari Ailus if (!endpoint_node) { 8200d638a07SRob Herring pr_debug("no valid endpoint (%d, %d) for node %pOF\n", 8210d638a07SRob Herring port, endpoint, node); 8221df09bc6SSakari Ailus return NULL; 8231df09bc6SSakari Ailus } 8241df09bc6SSakari Ailus 8251df09bc6SSakari Ailus remote = of_graph_get_remote_port_parent(endpoint_node); 8261df09bc6SSakari Ailus of_node_put(endpoint_node); 8271df09bc6SSakari Ailus if (!remote) { 8281df09bc6SSakari Ailus pr_debug("no valid remote node\n"); 8291df09bc6SSakari Ailus return NULL; 8301df09bc6SSakari Ailus } 8311df09bc6SSakari Ailus 8321df09bc6SSakari Ailus if (!of_device_is_available(remote)) { 8331df09bc6SSakari Ailus pr_debug("not available for remote node\n"); 83428b170e8SJulia Lawall of_node_put(remote); 8351df09bc6SSakari Ailus return NULL; 8361df09bc6SSakari Ailus } 8371df09bc6SSakari Ailus 8381df09bc6SSakari Ailus return remote; 8391df09bc6SSakari Ailus } 8401df09bc6SSakari Ailus EXPORT_SYMBOL(of_graph_get_remote_node); 8413708184aSSakari Ailus 842cf89a31cSSakari Ailus static struct fwnode_handle *of_fwnode_get(struct fwnode_handle *fwnode) 8433708184aSSakari Ailus { 844cf89a31cSSakari Ailus return of_fwnode_handle(of_node_get(to_of_node(fwnode))); 8453708184aSSakari Ailus } 8463708184aSSakari Ailus 8473708184aSSakari Ailus static void of_fwnode_put(struct fwnode_handle *fwnode) 8483708184aSSakari Ailus { 8493708184aSSakari Ailus of_node_put(to_of_node(fwnode)); 8503708184aSSakari Ailus } 8513708184aSSakari Ailus 85237ba983cSSakari Ailus static bool of_fwnode_device_is_available(const struct fwnode_handle *fwnode) 8532294b3afSSakari Ailus { 8542294b3afSSakari Ailus return of_device_is_available(to_of_node(fwnode)); 8552294b3afSSakari Ailus } 8562294b3afSSakari Ailus 85737ba983cSSakari Ailus static bool of_fwnode_property_present(const struct fwnode_handle *fwnode, 8583708184aSSakari Ailus const char *propname) 8593708184aSSakari Ailus { 8603708184aSSakari Ailus return of_property_read_bool(to_of_node(fwnode), propname); 8613708184aSSakari Ailus } 8623708184aSSakari Ailus 86337ba983cSSakari Ailus static int of_fwnode_property_read_int_array(const struct fwnode_handle *fwnode, 8643708184aSSakari Ailus const char *propname, 8653708184aSSakari Ailus unsigned int elem_size, void *val, 8663708184aSSakari Ailus size_t nval) 8673708184aSSakari Ailus { 86837ba983cSSakari Ailus const struct device_node *node = to_of_node(fwnode); 8693708184aSSakari Ailus 8703708184aSSakari Ailus if (!val) 8713708184aSSakari Ailus return of_property_count_elems_of_size(node, propname, 8723708184aSSakari Ailus elem_size); 8733708184aSSakari Ailus 8743708184aSSakari Ailus switch (elem_size) { 8753708184aSSakari Ailus case sizeof(u8): 8763708184aSSakari Ailus return of_property_read_u8_array(node, propname, val, nval); 8773708184aSSakari Ailus case sizeof(u16): 8783708184aSSakari Ailus return of_property_read_u16_array(node, propname, val, nval); 8793708184aSSakari Ailus case sizeof(u32): 8803708184aSSakari Ailus return of_property_read_u32_array(node, propname, val, nval); 8813708184aSSakari Ailus case sizeof(u64): 8823708184aSSakari Ailus return of_property_read_u64_array(node, propname, val, nval); 8833708184aSSakari Ailus } 8843708184aSSakari Ailus 8853708184aSSakari Ailus return -ENXIO; 8863708184aSSakari Ailus } 8873708184aSSakari Ailus 88837ba983cSSakari Ailus static int 88937ba983cSSakari Ailus of_fwnode_property_read_string_array(const struct fwnode_handle *fwnode, 89037ba983cSSakari Ailus const char *propname, const char **val, 89137ba983cSSakari Ailus size_t nval) 8923708184aSSakari Ailus { 89337ba983cSSakari Ailus const struct device_node *node = to_of_node(fwnode); 8943708184aSSakari Ailus 8953708184aSSakari Ailus return val ? 8963708184aSSakari Ailus of_property_read_string_array(node, propname, val, nval) : 8973708184aSSakari Ailus of_property_count_strings(node, propname); 8983708184aSSakari Ailus } 8993708184aSSakari Ailus 900bc0500c1SSakari Ailus static const char *of_fwnode_get_name(const struct fwnode_handle *fwnode) 901bc0500c1SSakari Ailus { 902bc0500c1SSakari Ailus return kbasename(to_of_node(fwnode)->full_name); 903bc0500c1SSakari Ailus } 904bc0500c1SSakari Ailus 905e7e242bcSSakari Ailus static const char *of_fwnode_get_name_prefix(const struct fwnode_handle *fwnode) 906e7e242bcSSakari Ailus { 907e7e242bcSSakari Ailus /* Root needs no prefix here (its name is "/"). */ 908e7e242bcSSakari Ailus if (!to_of_node(fwnode)->parent) 909e7e242bcSSakari Ailus return ""; 910e7e242bcSSakari Ailus 911e7e242bcSSakari Ailus return "/"; 912e7e242bcSSakari Ailus } 913e7e242bcSSakari Ailus 91437ba983cSSakari Ailus static struct fwnode_handle * 91537ba983cSSakari Ailus of_fwnode_get_parent(const struct fwnode_handle *fwnode) 9163708184aSSakari Ailus { 9173708184aSSakari Ailus return of_fwnode_handle(of_get_parent(to_of_node(fwnode))); 9183708184aSSakari Ailus } 9193708184aSSakari Ailus 9203708184aSSakari Ailus static struct fwnode_handle * 92137ba983cSSakari Ailus of_fwnode_get_next_child_node(const struct fwnode_handle *fwnode, 9223708184aSSakari Ailus struct fwnode_handle *child) 9233708184aSSakari Ailus { 9243708184aSSakari Ailus return of_fwnode_handle(of_get_next_available_child(to_of_node(fwnode), 9253708184aSSakari Ailus to_of_node(child))); 9263708184aSSakari Ailus } 9273708184aSSakari Ailus 9283708184aSSakari Ailus static struct fwnode_handle * 92937ba983cSSakari Ailus of_fwnode_get_named_child_node(const struct fwnode_handle *fwnode, 9303708184aSSakari Ailus const char *childname) 9313708184aSSakari Ailus { 93237ba983cSSakari Ailus const struct device_node *node = to_of_node(fwnode); 9333708184aSSakari Ailus struct device_node *child; 9343708184aSSakari Ailus 9353708184aSSakari Ailus for_each_available_child_of_node(node, child) 936b3e46d1aSRob Herring if (of_node_name_eq(child, childname)) 9373708184aSSakari Ailus return of_fwnode_handle(child); 9383708184aSSakari Ailus 9393708184aSSakari Ailus return NULL; 9403708184aSSakari Ailus } 9413708184aSSakari Ailus 9423e3119d3SSakari Ailus static int 9433e3119d3SSakari Ailus of_fwnode_get_reference_args(const struct fwnode_handle *fwnode, 9443e3119d3SSakari Ailus const char *prop, const char *nargs_prop, 9453e3119d3SSakari Ailus unsigned int nargs, unsigned int index, 9463e3119d3SSakari Ailus struct fwnode_reference_args *args) 9473e3119d3SSakari Ailus { 9483e3119d3SSakari Ailus struct of_phandle_args of_args; 9493e3119d3SSakari Ailus unsigned int i; 9503e3119d3SSakari Ailus int ret; 9513e3119d3SSakari Ailus 9523e3119d3SSakari Ailus if (nargs_prop) 9533e3119d3SSakari Ailus ret = of_parse_phandle_with_args(to_of_node(fwnode), prop, 9543e3119d3SSakari Ailus nargs_prop, index, &of_args); 9553e3119d3SSakari Ailus else 9563e3119d3SSakari Ailus ret = of_parse_phandle_with_fixed_args(to_of_node(fwnode), prop, 9573e3119d3SSakari Ailus nargs, index, &of_args); 9583e3119d3SSakari Ailus if (ret < 0) 9593e3119d3SSakari Ailus return ret; 9603e3119d3SSakari Ailus if (!args) 9613e3119d3SSakari Ailus return 0; 9623e3119d3SSakari Ailus 9633e3119d3SSakari Ailus args->nargs = of_args.args_count; 9643e3119d3SSakari Ailus args->fwnode = of_fwnode_handle(of_args.np); 9653e3119d3SSakari Ailus 9663e3119d3SSakari Ailus for (i = 0; i < NR_FWNODE_REFERENCE_ARGS; i++) 9673e3119d3SSakari Ailus args->args[i] = i < of_args.args_count ? of_args.args[i] : 0; 9683e3119d3SSakari Ailus 9693e3119d3SSakari Ailus return 0; 9703e3119d3SSakari Ailus } 9713e3119d3SSakari Ailus 9723b27d00eSSakari Ailus static struct fwnode_handle * 97337ba983cSSakari Ailus of_fwnode_graph_get_next_endpoint(const struct fwnode_handle *fwnode, 9743b27d00eSSakari Ailus struct fwnode_handle *prev) 9753b27d00eSSakari Ailus { 9763b27d00eSSakari Ailus return of_fwnode_handle(of_graph_get_next_endpoint(to_of_node(fwnode), 9773b27d00eSSakari Ailus to_of_node(prev))); 9783b27d00eSSakari Ailus } 9793b27d00eSSakari Ailus 9803b27d00eSSakari Ailus static struct fwnode_handle * 98137ba983cSSakari Ailus of_fwnode_graph_get_remote_endpoint(const struct fwnode_handle *fwnode) 9823b27d00eSSakari Ailus { 983358155edSKuninori Morimoto return of_fwnode_handle( 984358155edSKuninori Morimoto of_graph_get_remote_endpoint(to_of_node(fwnode))); 9853b27d00eSSakari Ailus } 9863b27d00eSSakari Ailus 9873b27d00eSSakari Ailus static struct fwnode_handle * 9883b27d00eSSakari Ailus of_fwnode_graph_get_port_parent(struct fwnode_handle *fwnode) 9893b27d00eSSakari Ailus { 9903b27d00eSSakari Ailus struct device_node *np; 9913b27d00eSSakari Ailus 9923b27d00eSSakari Ailus /* Get the parent of the port */ 9933314c6bdSNiklas Söderlund np = of_get_parent(to_of_node(fwnode)); 9943b27d00eSSakari Ailus if (!np) 9953b27d00eSSakari Ailus return NULL; 9963b27d00eSSakari Ailus 9973b27d00eSSakari Ailus /* Is this the "ports" node? If not, it's the port parent. */ 998b3e46d1aSRob Herring if (!of_node_name_eq(np, "ports")) 9993b27d00eSSakari Ailus return of_fwnode_handle(np); 10003b27d00eSSakari Ailus 10013b27d00eSSakari Ailus return of_fwnode_handle(of_get_next_parent(np)); 10023b27d00eSSakari Ailus } 10033b27d00eSSakari Ailus 100437ba983cSSakari Ailus static int of_fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode, 10053b27d00eSSakari Ailus struct fwnode_endpoint *endpoint) 10063b27d00eSSakari Ailus { 100737ba983cSSakari Ailus const struct device_node *node = to_of_node(fwnode); 10083b27d00eSSakari Ailus struct device_node *port_node = of_get_parent(node); 10093b27d00eSSakari Ailus 10103b27d00eSSakari Ailus endpoint->local_fwnode = fwnode; 10113b27d00eSSakari Ailus 10123b27d00eSSakari Ailus of_property_read_u32(port_node, "reg", &endpoint->port); 10133b27d00eSSakari Ailus of_property_read_u32(node, "reg", &endpoint->id); 10143b27d00eSSakari Ailus 10153b27d00eSSakari Ailus of_node_put(port_node); 10163b27d00eSSakari Ailus 10173b27d00eSSakari Ailus return 0; 10183b27d00eSSakari Ailus } 10193b27d00eSSakari Ailus 102067dcc26dSAndy Shevchenko static const void * 10211c2c82eaSSinan Kaya of_fwnode_device_get_match_data(const struct fwnode_handle *fwnode, 10221c2c82eaSSinan Kaya const struct device *dev) 10231c2c82eaSSinan Kaya { 102467dcc26dSAndy Shevchenko return of_device_get_match_data(dev); 10251c2c82eaSSinan Kaya } 10261c2c82eaSSinan Kaya 1027a3e1d1a7SSaravana Kannan static bool of_is_ancestor_of(struct device_node *test_ancestor, 1028a3e1d1a7SSaravana Kannan struct device_node *child) 1029a3e1d1a7SSaravana Kannan { 1030a3e1d1a7SSaravana Kannan of_node_get(child); 1031a3e1d1a7SSaravana Kannan while (child) { 1032a3e1d1a7SSaravana Kannan if (child == test_ancestor) { 1033a3e1d1a7SSaravana Kannan of_node_put(child); 103438835391SSaravana Kannan return true; 1035a3e1d1a7SSaravana Kannan } 1036a3e1d1a7SSaravana Kannan child = of_get_next_parent(child); 1037a3e1d1a7SSaravana Kannan } 103838835391SSaravana Kannan return false; 1039a3e1d1a7SSaravana Kannan } 1040a3e1d1a7SSaravana Kannan 1041a3e1d1a7SSaravana Kannan /** 10428a06d1eaSSaravana Kannan * of_link_to_phandle - Add fwnode link to supplier from supplier phandle 10438a06d1eaSSaravana Kannan * @con_np: consumer device tree node 10448a06d1eaSSaravana Kannan * @sup_np: supplier device tree node 1045a3e1d1a7SSaravana Kannan * 1046a3e1d1a7SSaravana Kannan * Given a phandle to a supplier device tree node (@sup_np), this function 1047a3e1d1a7SSaravana Kannan * finds the device that owns the supplier device tree node and creates a 1048a3e1d1a7SSaravana Kannan * device link from @dev consumer device to the supplier device. This function 1049a3e1d1a7SSaravana Kannan * doesn't create device links for invalid scenarios such as trying to create a 1050a3e1d1a7SSaravana Kannan * link with a parent device as the consumer of its child device. In such 1051a3e1d1a7SSaravana Kannan * cases, it returns an error. 1052a3e1d1a7SSaravana Kannan * 1053a3e1d1a7SSaravana Kannan * Returns: 10548a06d1eaSSaravana Kannan * - 0 if fwnode link successfully created to supplier 1055a3e1d1a7SSaravana Kannan * - -EINVAL if the supplier link is invalid and should not be created 10568a06d1eaSSaravana Kannan * - -ENODEV if struct device will never be create for supplier 1057a3e1d1a7SSaravana Kannan */ 10588a06d1eaSSaravana Kannan static int of_link_to_phandle(struct device_node *con_np, 10598a06d1eaSSaravana Kannan struct device_node *sup_np) 1060a3e1d1a7SSaravana Kannan { 10618a06d1eaSSaravana Kannan struct device *sup_dev; 1062a3e1d1a7SSaravana Kannan struct device_node *tmp_np = sup_np; 1063a3e1d1a7SSaravana Kannan 1064a3e1d1a7SSaravana Kannan of_node_get(sup_np); 1065a3e1d1a7SSaravana Kannan /* 1066a3e1d1a7SSaravana Kannan * Find the device node that contains the supplier phandle. It may be 1067a3e1d1a7SSaravana Kannan * @sup_np or it may be an ancestor of @sup_np. 1068a3e1d1a7SSaravana Kannan */ 10697456427aSNicolas Saenz Julienne while (sup_np) { 10707456427aSNicolas Saenz Julienne 10717456427aSNicolas Saenz Julienne /* Don't allow linking to a disabled supplier */ 10727456427aSNicolas Saenz Julienne if (!of_device_is_available(sup_np)) { 10737456427aSNicolas Saenz Julienne of_node_put(sup_np); 10747456427aSNicolas Saenz Julienne sup_np = NULL; 10757456427aSNicolas Saenz Julienne } 10767456427aSNicolas Saenz Julienne 10777456427aSNicolas Saenz Julienne if (of_find_property(sup_np, "compatible", NULL)) 10787456427aSNicolas Saenz Julienne break; 10797456427aSNicolas Saenz Julienne 1080a3e1d1a7SSaravana Kannan sup_np = of_get_next_parent(sup_np); 10817456427aSNicolas Saenz Julienne } 10827456427aSNicolas Saenz Julienne 1083a3e1d1a7SSaravana Kannan if (!sup_np) { 10848a06d1eaSSaravana Kannan pr_debug("Not linking %pOFP to %pOFP - No device\n", 10858a06d1eaSSaravana Kannan con_np, tmp_np); 1086a3e1d1a7SSaravana Kannan return -ENODEV; 1087a3e1d1a7SSaravana Kannan } 1088a3e1d1a7SSaravana Kannan 1089a3e1d1a7SSaravana Kannan /* 1090a3e1d1a7SSaravana Kannan * Don't allow linking a device node as a consumer of one of its 1091a3e1d1a7SSaravana Kannan * descendant nodes. By definition, a child node can't be a functional 1092a3e1d1a7SSaravana Kannan * dependency for the parent node. 1093a3e1d1a7SSaravana Kannan */ 10948a06d1eaSSaravana Kannan if (of_is_ancestor_of(con_np, sup_np)) { 10958a06d1eaSSaravana Kannan pr_debug("Not linking %pOFP to %pOFP - is descendant\n", 10968a06d1eaSSaravana Kannan con_np, sup_np); 1097a3e1d1a7SSaravana Kannan of_node_put(sup_np); 1098a3e1d1a7SSaravana Kannan return -EINVAL; 1099a3e1d1a7SSaravana Kannan } 11008a06d1eaSSaravana Kannan 11018a06d1eaSSaravana Kannan /* 11028a06d1eaSSaravana Kannan * Don't create links to "early devices" that won't have struct devices 11038a06d1eaSSaravana Kannan * created for them. 11048a06d1eaSSaravana Kannan */ 1105a3e1d1a7SSaravana Kannan sup_dev = get_dev_from_fwnode(&sup_np->fwnode); 11061753c4d1SSaravana Kannan if (!sup_dev && 11071753c4d1SSaravana Kannan (of_node_check_flag(sup_np, OF_POPULATED) || 11081753c4d1SSaravana Kannan sup_np->fwnode.flags & FWNODE_FLAG_NOT_DEVICE)) { 11098a06d1eaSSaravana Kannan pr_debug("Not linking %pOFP to %pOFP - No struct device\n", 11108a06d1eaSSaravana Kannan con_np, sup_np); 1111bb278b14SSaravana Kannan of_node_put(sup_np); 1112ba861f8eSSaravana Kannan return -ENODEV; 1113ba861f8eSSaravana Kannan } 1114a3e1d1a7SSaravana Kannan put_device(sup_dev); 11158a06d1eaSSaravana Kannan 11168a06d1eaSSaravana Kannan fwnode_link_add(of_fwnode_handle(con_np), of_fwnode_handle(sup_np)); 11178a06d1eaSSaravana Kannan of_node_put(sup_np); 11188a06d1eaSSaravana Kannan 11198a06d1eaSSaravana Kannan return 0; 1120a3e1d1a7SSaravana Kannan } 1121a3e1d1a7SSaravana Kannan 1122a3e1d1a7SSaravana Kannan /** 1123a3e1d1a7SSaravana Kannan * parse_prop_cells - Property parsing function for suppliers 1124a3e1d1a7SSaravana Kannan * 1125a3e1d1a7SSaravana Kannan * @np: Pointer to device tree node containing a list 1126a3e1d1a7SSaravana Kannan * @prop_name: Name of property to be parsed. Expected to hold phandle values 1127a3e1d1a7SSaravana Kannan * @index: For properties holding a list of phandles, this is the index 1128a3e1d1a7SSaravana Kannan * into the list. 1129a3e1d1a7SSaravana Kannan * @list_name: Property name that is known to contain list of phandle(s) to 1130a3e1d1a7SSaravana Kannan * supplier(s) 1131a3e1d1a7SSaravana Kannan * @cells_name: property name that specifies phandles' arguments count 1132a3e1d1a7SSaravana Kannan * 1133a3e1d1a7SSaravana Kannan * This is a helper function to parse properties that have a known fixed name 1134a3e1d1a7SSaravana Kannan * and are a list of phandles and phandle arguments. 1135a3e1d1a7SSaravana Kannan * 1136a3e1d1a7SSaravana Kannan * Returns: 1137a3e1d1a7SSaravana Kannan * - phandle node pointer with refcount incremented. Caller must of_node_put() 1138a3e1d1a7SSaravana Kannan * on it when done. 1139a3e1d1a7SSaravana Kannan * - NULL if no phandle found at index 1140a3e1d1a7SSaravana Kannan */ 1141a3e1d1a7SSaravana Kannan static struct device_node *parse_prop_cells(struct device_node *np, 1142a3e1d1a7SSaravana Kannan const char *prop_name, int index, 1143a3e1d1a7SSaravana Kannan const char *list_name, 1144a3e1d1a7SSaravana Kannan const char *cells_name) 1145a3e1d1a7SSaravana Kannan { 1146a3e1d1a7SSaravana Kannan struct of_phandle_args sup_args; 1147a3e1d1a7SSaravana Kannan 1148a3e1d1a7SSaravana Kannan if (strcmp(prop_name, list_name)) 1149a3e1d1a7SSaravana Kannan return NULL; 1150a3e1d1a7SSaravana Kannan 1151a3e1d1a7SSaravana Kannan if (of_parse_phandle_with_args(np, list_name, cells_name, index, 1152a3e1d1a7SSaravana Kannan &sup_args)) 1153a3e1d1a7SSaravana Kannan return NULL; 1154a3e1d1a7SSaravana Kannan 1155a3e1d1a7SSaravana Kannan return sup_args.np; 1156a3e1d1a7SSaravana Kannan } 1157a3e1d1a7SSaravana Kannan 1158a436ef4aSSaravana Kannan #define DEFINE_SIMPLE_PROP(fname, name, cells) \ 1159a436ef4aSSaravana Kannan static struct device_node *parse_##fname(struct device_node *np, \ 1160a436ef4aSSaravana Kannan const char *prop_name, int index) \ 1161a436ef4aSSaravana Kannan { \ 1162a436ef4aSSaravana Kannan return parse_prop_cells(np, prop_name, index, name, cells); \ 1163a3e1d1a7SSaravana Kannan } 1164a3e1d1a7SSaravana Kannan 1165a3e1d1a7SSaravana Kannan static int strcmp_suffix(const char *str, const char *suffix) 1166a3e1d1a7SSaravana Kannan { 1167a3e1d1a7SSaravana Kannan unsigned int len, suffix_len; 1168a3e1d1a7SSaravana Kannan 1169a3e1d1a7SSaravana Kannan len = strlen(str); 1170a3e1d1a7SSaravana Kannan suffix_len = strlen(suffix); 1171a3e1d1a7SSaravana Kannan if (len <= suffix_len) 1172a3e1d1a7SSaravana Kannan return -1; 1173a3e1d1a7SSaravana Kannan return strcmp(str + len - suffix_len, suffix); 1174a3e1d1a7SSaravana Kannan } 1175a3e1d1a7SSaravana Kannan 1176a436ef4aSSaravana Kannan /** 1177a436ef4aSSaravana Kannan * parse_suffix_prop_cells - Suffix property parsing function for suppliers 1178a436ef4aSSaravana Kannan * 1179a436ef4aSSaravana Kannan * @np: Pointer to device tree node containing a list 1180a436ef4aSSaravana Kannan * @prop_name: Name of property to be parsed. Expected to hold phandle values 1181a436ef4aSSaravana Kannan * @index: For properties holding a list of phandles, this is the index 1182a436ef4aSSaravana Kannan * into the list. 1183a436ef4aSSaravana Kannan * @suffix: Property suffix that is known to contain list of phandle(s) to 1184a436ef4aSSaravana Kannan * supplier(s) 1185a436ef4aSSaravana Kannan * @cells_name: property name that specifies phandles' arguments count 1186a436ef4aSSaravana Kannan * 1187a436ef4aSSaravana Kannan * This is a helper function to parse properties that have a known fixed suffix 1188a436ef4aSSaravana Kannan * and are a list of phandles and phandle arguments. 1189a436ef4aSSaravana Kannan * 1190a436ef4aSSaravana Kannan * Returns: 1191a436ef4aSSaravana Kannan * - phandle node pointer with refcount incremented. Caller must of_node_put() 1192a436ef4aSSaravana Kannan * on it when done. 1193a436ef4aSSaravana Kannan * - NULL if no phandle found at index 1194a436ef4aSSaravana Kannan */ 1195a436ef4aSSaravana Kannan static struct device_node *parse_suffix_prop_cells(struct device_node *np, 1196a436ef4aSSaravana Kannan const char *prop_name, int index, 1197a436ef4aSSaravana Kannan const char *suffix, 1198a436ef4aSSaravana Kannan const char *cells_name) 1199a3e1d1a7SSaravana Kannan { 1200a436ef4aSSaravana Kannan struct of_phandle_args sup_args; 1201a436ef4aSSaravana Kannan 1202a436ef4aSSaravana Kannan if (strcmp_suffix(prop_name, suffix)) 1203a3e1d1a7SSaravana Kannan return NULL; 1204a3e1d1a7SSaravana Kannan 1205a436ef4aSSaravana Kannan if (of_parse_phandle_with_args(np, prop_name, cells_name, index, 1206a436ef4aSSaravana Kannan &sup_args)) 1207a436ef4aSSaravana Kannan return NULL; 1208a436ef4aSSaravana Kannan 1209a436ef4aSSaravana Kannan return sup_args.np; 1210a436ef4aSSaravana Kannan } 1211a436ef4aSSaravana Kannan 1212a436ef4aSSaravana Kannan #define DEFINE_SUFFIX_PROP(fname, suffix, cells) \ 1213a436ef4aSSaravana Kannan static struct device_node *parse_##fname(struct device_node *np, \ 1214a436ef4aSSaravana Kannan const char *prop_name, int index) \ 1215a436ef4aSSaravana Kannan { \ 1216a436ef4aSSaravana Kannan return parse_suffix_prop_cells(np, prop_name, index, suffix, cells); \ 1217a3e1d1a7SSaravana Kannan } 1218a3e1d1a7SSaravana Kannan 1219a3e1d1a7SSaravana Kannan /** 1220a3e1d1a7SSaravana Kannan * struct supplier_bindings - Property parsing functions for suppliers 1221a3e1d1a7SSaravana Kannan * 1222a3e1d1a7SSaravana Kannan * @parse_prop: function name 1223a3e1d1a7SSaravana Kannan * parse_prop() finds the node corresponding to a supplier phandle 1224a3e1d1a7SSaravana Kannan * @parse_prop.np: Pointer to device node holding supplier phandle property 1225a3e1d1a7SSaravana Kannan * @parse_prop.prop_name: Name of property holding a phandle value 1226a3e1d1a7SSaravana Kannan * @parse_prop.index: For properties holding a list of phandles, this is the 1227a3e1d1a7SSaravana Kannan * index into the list 1228a3e1d1a7SSaravana Kannan * 1229a3e1d1a7SSaravana Kannan * Returns: 1230a3e1d1a7SSaravana Kannan * parse_prop() return values are 1231a3e1d1a7SSaravana Kannan * - phandle node pointer with refcount incremented. Caller must of_node_put() 1232a3e1d1a7SSaravana Kannan * on it when done. 1233a3e1d1a7SSaravana Kannan * - NULL if no phandle found at index 1234a3e1d1a7SSaravana Kannan */ 1235a3e1d1a7SSaravana Kannan struct supplier_bindings { 1236a3e1d1a7SSaravana Kannan struct device_node *(*parse_prop)(struct device_node *np, 1237a3e1d1a7SSaravana Kannan const char *prop_name, int index); 1238a9dd8f3cSSaravana Kannan bool optional; 1239a3e1d1a7SSaravana Kannan }; 1240a3e1d1a7SSaravana Kannan 1241a436ef4aSSaravana Kannan DEFINE_SIMPLE_PROP(clocks, "clocks", "#clock-cells") 1242a436ef4aSSaravana Kannan DEFINE_SIMPLE_PROP(interconnects, "interconnects", "#interconnect-cells") 12438e12257dSSaravana Kannan DEFINE_SIMPLE_PROP(iommus, "iommus", "#iommu-cells") 12448e12257dSSaravana Kannan DEFINE_SIMPLE_PROP(mboxes, "mboxes", "#mbox-cells") 12458e12257dSSaravana Kannan DEFINE_SIMPLE_PROP(io_channels, "io-channel", "#io-channel-cells") 12467f00be96SSaravana Kannan DEFINE_SIMPLE_PROP(interrupt_parent, "interrupt-parent", NULL) 12477f00be96SSaravana Kannan DEFINE_SIMPLE_PROP(dmas, "dmas", "#dma-cells") 12482f7afc34SSaravana Kannan DEFINE_SIMPLE_PROP(power_domains, "power-domains", "#power-domain-cells") 12492f7afc34SSaravana Kannan DEFINE_SIMPLE_PROP(hwlocks, "hwlocks", "#hwlock-cells") 125078056e70SSaravana Kannan DEFINE_SIMPLE_PROP(extcon, "extcon", NULL) 125153e6a671SSaravana Kannan DEFINE_SIMPLE_PROP(nvmem_cells, "nvmem-cells", NULL) 125253e6a671SSaravana Kannan DEFINE_SIMPLE_PROP(phys, "phys", "#phy-cells") 125353e6a671SSaravana Kannan DEFINE_SIMPLE_PROP(wakeup_parent, "wakeup-parent", NULL) 1254fb820b49SSaravana Kannan DEFINE_SIMPLE_PROP(pinctrl0, "pinctrl-0", NULL) 1255fb820b49SSaravana Kannan DEFINE_SIMPLE_PROP(pinctrl1, "pinctrl-1", NULL) 1256fb820b49SSaravana Kannan DEFINE_SIMPLE_PROP(pinctrl2, "pinctrl-2", NULL) 1257fb820b49SSaravana Kannan DEFINE_SIMPLE_PROP(pinctrl3, "pinctrl-3", NULL) 1258fb820b49SSaravana Kannan DEFINE_SIMPLE_PROP(pinctrl4, "pinctrl-4", NULL) 1259fb820b49SSaravana Kannan DEFINE_SIMPLE_PROP(pinctrl5, "pinctrl-5", NULL) 1260fb820b49SSaravana Kannan DEFINE_SIMPLE_PROP(pinctrl6, "pinctrl-6", NULL) 1261fb820b49SSaravana Kannan DEFINE_SIMPLE_PROP(pinctrl7, "pinctrl-7", NULL) 1262fb820b49SSaravana Kannan DEFINE_SIMPLE_PROP(pinctrl8, "pinctrl-8", NULL) 1263a436ef4aSSaravana Kannan DEFINE_SUFFIX_PROP(regulators, "-supply", NULL) 12647f00be96SSaravana Kannan DEFINE_SUFFIX_PROP(gpio, "-gpio", "#gpio-cells") 12657f00be96SSaravana Kannan DEFINE_SUFFIX_PROP(gpios, "-gpios", "#gpio-cells") 1266a436ef4aSSaravana Kannan 1267e149573bSWill Deacon static struct device_node *parse_iommu_maps(struct device_node *np, 1268e149573bSWill Deacon const char *prop_name, int index) 1269e149573bSWill Deacon { 1270e149573bSWill Deacon if (strcmp(prop_name, "iommu-map")) 1271e149573bSWill Deacon return NULL; 1272e149573bSWill Deacon 1273e149573bSWill Deacon return of_parse_phandle(np, prop_name, (index * 4) + 1); 1274e149573bSWill Deacon } 1275e149573bSWill Deacon 1276e13f5b7aSSaravana Kannan static struct device_node *parse_gpio_compat(struct device_node *np, 1277e13f5b7aSSaravana Kannan const char *prop_name, int index) 1278e13f5b7aSSaravana Kannan { 1279e13f5b7aSSaravana Kannan struct of_phandle_args sup_args; 1280e13f5b7aSSaravana Kannan 1281e13f5b7aSSaravana Kannan if (strcmp(prop_name, "gpio") && strcmp(prop_name, "gpios")) 1282e13f5b7aSSaravana Kannan return NULL; 1283e13f5b7aSSaravana Kannan 1284e13f5b7aSSaravana Kannan /* 1285e13f5b7aSSaravana Kannan * Ignore node with gpio-hog property since its gpios are all provided 1286e13f5b7aSSaravana Kannan * by its parent. 1287e13f5b7aSSaravana Kannan */ 1288e13f5b7aSSaravana Kannan if (of_find_property(np, "gpio-hog", NULL)) 1289e13f5b7aSSaravana Kannan return NULL; 1290e13f5b7aSSaravana Kannan 1291e13f5b7aSSaravana Kannan if (of_parse_phandle_with_args(np, prop_name, "#gpio-cells", index, 1292e13f5b7aSSaravana Kannan &sup_args)) 1293e13f5b7aSSaravana Kannan return NULL; 1294e13f5b7aSSaravana Kannan 1295e13f5b7aSSaravana Kannan return sup_args.np; 1296e13f5b7aSSaravana Kannan } 1297e13f5b7aSSaravana Kannan 12984104ca77SSaravana Kannan static struct device_node *parse_interrupts(struct device_node *np, 12994104ca77SSaravana Kannan const char *prop_name, int index) 13004104ca77SSaravana Kannan { 1301f265f06aSSaravana Kannan struct of_phandle_args sup_args; 1302f265f06aSSaravana Kannan 1303*bd6d617aSSaravana Kannan if (!IS_ENABLED(CONFIG_OF_IRQ) || IS_ENABLED(CONFIG_PPC)) 1304*bd6d617aSSaravana Kannan return NULL; 1305*bd6d617aSSaravana Kannan 1306f265f06aSSaravana Kannan if (strcmp(prop_name, "interrupts") && 1307f265f06aSSaravana Kannan strcmp(prop_name, "interrupts-extended")) 13084104ca77SSaravana Kannan return NULL; 13094104ca77SSaravana Kannan 1310f265f06aSSaravana Kannan return of_irq_parse_one(np, index, &sup_args) ? NULL : sup_args.np; 13114104ca77SSaravana Kannan } 13124104ca77SSaravana Kannan 1313af1b967aSSaravana Kannan static const struct supplier_bindings of_supplier_bindings[] = { 1314a3e1d1a7SSaravana Kannan { .parse_prop = parse_clocks, }, 1315a3e1d1a7SSaravana Kannan { .parse_prop = parse_interconnects, }, 1316a9dd8f3cSSaravana Kannan { .parse_prop = parse_iommus, .optional = true, }, 1317a9dd8f3cSSaravana Kannan { .parse_prop = parse_iommu_maps, .optional = true, }, 13188e12257dSSaravana Kannan { .parse_prop = parse_mboxes, }, 13198e12257dSSaravana Kannan { .parse_prop = parse_io_channels, }, 13207f00be96SSaravana Kannan { .parse_prop = parse_interrupt_parent, }, 1321a9dd8f3cSSaravana Kannan { .parse_prop = parse_dmas, .optional = true, }, 13222f7afc34SSaravana Kannan { .parse_prop = parse_power_domains, }, 13232f7afc34SSaravana Kannan { .parse_prop = parse_hwlocks, }, 132478056e70SSaravana Kannan { .parse_prop = parse_extcon, }, 132553e6a671SSaravana Kannan { .parse_prop = parse_nvmem_cells, }, 132653e6a671SSaravana Kannan { .parse_prop = parse_phys, }, 132753e6a671SSaravana Kannan { .parse_prop = parse_wakeup_parent, }, 1328fb820b49SSaravana Kannan { .parse_prop = parse_pinctrl0, }, 1329fb820b49SSaravana Kannan { .parse_prop = parse_pinctrl1, }, 1330fb820b49SSaravana Kannan { .parse_prop = parse_pinctrl2, }, 1331fb820b49SSaravana Kannan { .parse_prop = parse_pinctrl3, }, 1332fb820b49SSaravana Kannan { .parse_prop = parse_pinctrl4, }, 1333fb820b49SSaravana Kannan { .parse_prop = parse_pinctrl5, }, 1334fb820b49SSaravana Kannan { .parse_prop = parse_pinctrl6, }, 1335fb820b49SSaravana Kannan { .parse_prop = parse_pinctrl7, }, 1336fb820b49SSaravana Kannan { .parse_prop = parse_pinctrl8, }, 1337e13f5b7aSSaravana Kannan { .parse_prop = parse_gpio_compat, }, 13384104ca77SSaravana Kannan { .parse_prop = parse_interrupts, }, 1339a3e1d1a7SSaravana Kannan { .parse_prop = parse_regulators, }, 13407f00be96SSaravana Kannan { .parse_prop = parse_gpio, }, 13417f00be96SSaravana Kannan { .parse_prop = parse_gpios, }, 1342af1b967aSSaravana Kannan {} 1343a3e1d1a7SSaravana Kannan }; 1344a3e1d1a7SSaravana Kannan 1345a3e1d1a7SSaravana Kannan /** 1346a3e1d1a7SSaravana Kannan * of_link_property - Create device links to suppliers listed in a property 1347a3e1d1a7SSaravana Kannan * @dev: Consumer device 1348a3e1d1a7SSaravana Kannan * @con_np: The consumer device tree node which contains the property 1349a3e1d1a7SSaravana Kannan * @prop_name: Name of property to be parsed 1350a3e1d1a7SSaravana Kannan * 1351a3e1d1a7SSaravana Kannan * This function checks if the property @prop_name that is present in the 1352a3e1d1a7SSaravana Kannan * @con_np device tree node is one of the known common device tree bindings 1353a3e1d1a7SSaravana Kannan * that list phandles to suppliers. If @prop_name isn't one, this function 1354a3e1d1a7SSaravana Kannan * doesn't do anything. 1355a3e1d1a7SSaravana Kannan * 13568a06d1eaSSaravana Kannan * If @prop_name is one, this function attempts to create fwnode links from the 13578a06d1eaSSaravana Kannan * consumer device tree node @con_np to all the suppliers device tree nodes 13588a06d1eaSSaravana Kannan * listed in @prop_name. 1359a3e1d1a7SSaravana Kannan * 13608a06d1eaSSaravana Kannan * Any failed attempt to create a fwnode link will NOT result in an immediate 1361a3e1d1a7SSaravana Kannan * return. of_link_property() must create links to all the available supplier 13628a06d1eaSSaravana Kannan * device tree nodes even when attempts to create a link to one or more 13638a06d1eaSSaravana Kannan * suppliers fail. 1364a3e1d1a7SSaravana Kannan */ 13658a06d1eaSSaravana Kannan static int of_link_property(struct device_node *con_np, const char *prop_name) 1366a3e1d1a7SSaravana Kannan { 1367a3e1d1a7SSaravana Kannan struct device_node *phandle; 1368af1b967aSSaravana Kannan const struct supplier_bindings *s = of_supplier_bindings; 1369a3e1d1a7SSaravana Kannan unsigned int i = 0; 1370a3e1d1a7SSaravana Kannan bool matched = false; 1371a3e1d1a7SSaravana Kannan int ret = 0; 1372a3e1d1a7SSaravana Kannan 1373a3e1d1a7SSaravana Kannan /* Do not stop at first failed link, link all available suppliers. */ 1374a3e1d1a7SSaravana Kannan while (!matched && s->parse_prop) { 1375a9dd8f3cSSaravana Kannan if (s->optional && !fw_devlink_is_strict()) { 1376a9dd8f3cSSaravana Kannan s++; 1377a9dd8f3cSSaravana Kannan continue; 1378a9dd8f3cSSaravana Kannan } 1379a9dd8f3cSSaravana Kannan 1380a3e1d1a7SSaravana Kannan while ((phandle = s->parse_prop(con_np, prop_name, i))) { 1381a3e1d1a7SSaravana Kannan matched = true; 1382a3e1d1a7SSaravana Kannan i++; 13838a06d1eaSSaravana Kannan of_link_to_phandle(con_np, phandle); 1384a3e1d1a7SSaravana Kannan of_node_put(phandle); 1385a3e1d1a7SSaravana Kannan } 1386a3e1d1a7SSaravana Kannan s++; 1387a3e1d1a7SSaravana Kannan } 1388a3e1d1a7SSaravana Kannan return ret; 1389a3e1d1a7SSaravana Kannan } 1390a3e1d1a7SSaravana Kannan 13912d09e6ebSSaravana Kannan static int of_fwnode_add_links(struct fwnode_handle *fwnode) 1392a3e1d1a7SSaravana Kannan { 13938a06d1eaSSaravana Kannan struct property *p; 13948a06d1eaSSaravana Kannan struct device_node *con_np = to_of_node(fwnode); 1395a3e1d1a7SSaravana Kannan 13968a06d1eaSSaravana Kannan if (!con_np) 13978a06d1eaSSaravana Kannan return -EINVAL; 13988a06d1eaSSaravana Kannan 13998a06d1eaSSaravana Kannan for_each_property_of_node(con_np, p) 14008a06d1eaSSaravana Kannan of_link_property(con_np, p->name); 14018a06d1eaSSaravana Kannan 14028a06d1eaSSaravana Kannan return 0; 1403a3e1d1a7SSaravana Kannan } 1404a3e1d1a7SSaravana Kannan 14053708184aSSakari Ailus const struct fwnode_operations of_fwnode_ops = { 14063708184aSSakari Ailus .get = of_fwnode_get, 14073708184aSSakari Ailus .put = of_fwnode_put, 14082294b3afSSakari Ailus .device_is_available = of_fwnode_device_is_available, 14091c2c82eaSSinan Kaya .device_get_match_data = of_fwnode_device_get_match_data, 14103708184aSSakari Ailus .property_present = of_fwnode_property_present, 14113708184aSSakari Ailus .property_read_int_array = of_fwnode_property_read_int_array, 14123708184aSSakari Ailus .property_read_string_array = of_fwnode_property_read_string_array, 1413bc0500c1SSakari Ailus .get_name = of_fwnode_get_name, 1414e7e242bcSSakari Ailus .get_name_prefix = of_fwnode_get_name_prefix, 14153708184aSSakari Ailus .get_parent = of_fwnode_get_parent, 14163708184aSSakari Ailus .get_next_child_node = of_fwnode_get_next_child_node, 14173708184aSSakari Ailus .get_named_child_node = of_fwnode_get_named_child_node, 14183e3119d3SSakari Ailus .get_reference_args = of_fwnode_get_reference_args, 14193b27d00eSSakari Ailus .graph_get_next_endpoint = of_fwnode_graph_get_next_endpoint, 14203b27d00eSSakari Ailus .graph_get_remote_endpoint = of_fwnode_graph_get_remote_endpoint, 14213b27d00eSSakari Ailus .graph_get_port_parent = of_fwnode_graph_get_port_parent, 14223b27d00eSSakari Ailus .graph_parse_endpoint = of_fwnode_graph_parse_endpoint, 1423a3e1d1a7SSaravana Kannan .add_links = of_fwnode_add_links, 14243708184aSSakari Ailus }; 1425db3e50f3SSakari Ailus EXPORT_SYMBOL_GPL(of_fwnode_ops); 1426