14984de2bSSimon Glass /* 24984de2bSSimon Glass * Copyright (c) 2017 Google, Inc 34984de2bSSimon Glass * Written by Simon Glass <sjg@chromium.org> 44984de2bSSimon Glass * 54984de2bSSimon Glass * SPDX-License-Identifier: GPL-2.0+ 64984de2bSSimon Glass */ 74984de2bSSimon Glass 84984de2bSSimon Glass #ifndef _DM_OFNODE_H 94984de2bSSimon Glass #define _DM_OFNODE_H 104984de2bSSimon Glass 119e512045SSimon Glass /* TODO(sjg@chromium.org): Drop fdtdec.h include */ 129e512045SSimon Glass #include <fdtdec.h> 139e512045SSimon Glass #include <dm/of.h> 149e512045SSimon Glass 159e512045SSimon Glass /* Enable checks to protect against invalid calls */ 169e512045SSimon Glass #undef OF_CHECKS 179e512045SSimon Glass 18dcf98852SSimon Glass struct resource; 19dcf98852SSimon Glass 204984de2bSSimon Glass /** 214984de2bSSimon Glass * ofnode - reference to a device tree node 224984de2bSSimon Glass * 234984de2bSSimon Glass * This union can hold either a straightforward pointer to a struct device_node 244984de2bSSimon Glass * in the live device tree, or an offset within the flat device tree. In the 254984de2bSSimon Glass * latter case, the pointer value is just the integer offset within the flat DT. 264984de2bSSimon Glass * 274984de2bSSimon Glass * Thus we can reference nodes in both the live tree (once available) and the 284984de2bSSimon Glass * flat tree (until then). Functions are available to translate between an 294984de2bSSimon Glass * ofnode and either an offset or a struct device_node *. 304984de2bSSimon Glass * 314984de2bSSimon Glass * The reference can also hold a null offset, in which case the pointer value 329e512045SSimon Glass * here is NULL. This corresponds to a struct device_node * value of 334984de2bSSimon Glass * NULL, or an offset of -1. 344984de2bSSimon Glass * 354984de2bSSimon Glass * There is no ambiguity as to whether ofnode holds an offset or a node 364984de2bSSimon Glass * pointer: when the live tree is active it holds a node pointer, otherwise it 374984de2bSSimon Glass * holds an offset. The value itself does not need to be unique and in theory 384984de2bSSimon Glass * the same value could point to a valid device node or a valid offset. We 394984de2bSSimon Glass * could arrange for a unique value to be used (e.g. by making the pointer 404984de2bSSimon Glass * point to an offset within the flat device tree in the case of an offset) but 414984de2bSSimon Glass * this increases code size slightly due to the subtraction. Since it offers no 424984de2bSSimon Glass * real benefit, the approach described here seems best. 434984de2bSSimon Glass * 444984de2bSSimon Glass * For now these points use constant types, since we don't allow writing 454984de2bSSimon Glass * the DT. 464984de2bSSimon Glass * 474984de2bSSimon Glass * @np: Pointer to device node, used for live tree 484984de2bSSimon Glass * @flat_ptr: Pointer into flat device tree, used for flat tree. Note that this 494984de2bSSimon Glass * is not a really a pointer to a node: it is an offset value. See above. 504984de2bSSimon Glass */ 514984de2bSSimon Glass typedef union ofnode_union { 524984de2bSSimon Glass const struct device_node *np; /* will be used for future live tree */ 534984de2bSSimon Glass long of_offset; 544984de2bSSimon Glass } ofnode; 554984de2bSSimon Glass 569e512045SSimon Glass struct ofnode_phandle_args { 579e512045SSimon Glass ofnode node; 589e512045SSimon Glass int args_count; 599e512045SSimon Glass uint32_t args[OF_MAX_PHANDLE_ARGS]; 609e512045SSimon Glass }; 619e512045SSimon Glass 629e512045SSimon Glass /** 639e512045SSimon Glass * _ofnode_to_np() - convert an ofnode to a live DT node pointer 649e512045SSimon Glass * 659e512045SSimon Glass * This cannot be called if the reference contains an offset. 669e512045SSimon Glass * 679e512045SSimon Glass * @node: Reference containing struct device_node * (possibly invalid) 689e512045SSimon Glass * @return pointer to device node (can be NULL) 699e512045SSimon Glass */ 709e512045SSimon Glass static inline const struct device_node *ofnode_to_np(ofnode node) 719e512045SSimon Glass { 729e512045SSimon Glass #ifdef OF_CHECKS 739e512045SSimon Glass if (!of_live_active()) 749e512045SSimon Glass return NULL; 759e512045SSimon Glass #endif 769e512045SSimon Glass return node.np; 779e512045SSimon Glass } 789e512045SSimon Glass 794984de2bSSimon Glass /** 804984de2bSSimon Glass * ofnode_to_offset() - convert an ofnode to a flat DT offset 814984de2bSSimon Glass * 824984de2bSSimon Glass * This cannot be called if the reference contains a node pointer. 834984de2bSSimon Glass * 844984de2bSSimon Glass * @node: Reference containing offset (possibly invalid) 854984de2bSSimon Glass * @return DT offset (can be -1) 864984de2bSSimon Glass */ 874984de2bSSimon Glass static inline int ofnode_to_offset(ofnode node) 884984de2bSSimon Glass { 899e512045SSimon Glass #ifdef OF_CHECKS 909e512045SSimon Glass if (of_live_active()) 919e512045SSimon Glass return -1; 929e512045SSimon Glass #endif 934984de2bSSimon Glass return node.of_offset; 944984de2bSSimon Glass } 954984de2bSSimon Glass 964984de2bSSimon Glass /** 974984de2bSSimon Glass * ofnode_valid() - check if an ofnode is valid 984984de2bSSimon Glass * 994984de2bSSimon Glass * @return true if the reference contains a valid ofnode, false if it is NULL 1004984de2bSSimon Glass */ 1014984de2bSSimon Glass static inline bool ofnode_valid(ofnode node) 1024984de2bSSimon Glass { 1039e512045SSimon Glass if (of_live_active()) 1049e512045SSimon Glass return node.np != NULL; 1059e512045SSimon Glass else 1064984de2bSSimon Glass return node.of_offset != -1; 1074984de2bSSimon Glass } 1084984de2bSSimon Glass 1094984de2bSSimon Glass /** 1104984de2bSSimon Glass * offset_to_ofnode() - convert a DT offset to an ofnode 1114984de2bSSimon Glass * 1124984de2bSSimon Glass * @of_offset: DT offset (either valid, or -1) 1134984de2bSSimon Glass * @return reference to the associated DT offset 1144984de2bSSimon Glass */ 1154984de2bSSimon Glass static inline ofnode offset_to_ofnode(int of_offset) 1164984de2bSSimon Glass { 1174984de2bSSimon Glass ofnode node; 1184984de2bSSimon Glass 1199e512045SSimon Glass if (of_live_active()) 1209e512045SSimon Glass node.np = NULL; 1219e512045SSimon Glass else 1224984de2bSSimon Glass node.of_offset = of_offset; 1234984de2bSSimon Glass 1244984de2bSSimon Glass return node; 1254984de2bSSimon Glass } 1264984de2bSSimon Glass 1274984de2bSSimon Glass /** 1289e512045SSimon Glass * np_to_ofnode() - convert a node pointer to an ofnode 1299e512045SSimon Glass * 1309e512045SSimon Glass * @np: Live node pointer (can be NULL) 1319e512045SSimon Glass * @return reference to the associated node pointer 1329e512045SSimon Glass */ 1339e512045SSimon Glass static inline ofnode np_to_ofnode(const struct device_node *np) 1349e512045SSimon Glass { 1359e512045SSimon Glass ofnode node; 1369e512045SSimon Glass 1379e512045SSimon Glass node.np = np; 1389e512045SSimon Glass 1399e512045SSimon Glass return node; 1409e512045SSimon Glass } 1419e512045SSimon Glass 1429e512045SSimon Glass /** 1439e512045SSimon Glass * ofnode_is_np() - check if a reference is a node pointer 1449e512045SSimon Glass * 1459e512045SSimon Glass * This function associated that if there is a valid live tree then all 1469e512045SSimon Glass * references will use it. This is because using the flat DT when the live tree 1479e512045SSimon Glass * is valid is not permitted. 1489e512045SSimon Glass * 1499e512045SSimon Glass * @node: reference to check (possibly invalid) 1509e512045SSimon Glass * @return true if the reference is a live node pointer, false if it is a DT 1519e512045SSimon Glass * offset 1529e512045SSimon Glass */ 1539e512045SSimon Glass static inline bool ofnode_is_np(ofnode node) 1549e512045SSimon Glass { 1559e512045SSimon Glass #ifdef OF_CHECKS 1569e512045SSimon Glass /* 1579e512045SSimon Glass * Check our assumption that flat tree offsets are not used when a 1589e512045SSimon Glass * live tree is in use. 1599e512045SSimon Glass */ 1609e512045SSimon Glass assert(!ofnode_valid(node) || 1619e512045SSimon Glass (of_live_active() ? _ofnode_to_np(node) 1629e512045SSimon Glass : _ofnode_to_np(node))); 1639e512045SSimon Glass #endif 1649e512045SSimon Glass return of_live_active() && ofnode_valid(node); 1659e512045SSimon Glass } 1669e512045SSimon Glass 1679e512045SSimon Glass /** 1684984de2bSSimon Glass * ofnode_equal() - check if two references are equal 1694984de2bSSimon Glass * 1704984de2bSSimon Glass * @return true if equal, else false 1714984de2bSSimon Glass */ 1724984de2bSSimon Glass static inline bool ofnode_equal(ofnode ref1, ofnode ref2) 1734984de2bSSimon Glass { 1744984de2bSSimon Glass /* We only need to compare the contents */ 1754984de2bSSimon Glass return ref1.of_offset == ref2.of_offset; 1764984de2bSSimon Glass } 1774984de2bSSimon Glass 1789e512045SSimon Glass /** 1799e512045SSimon Glass * ofnode_null() - Obtain a null ofnode 1809e512045SSimon Glass * 1819e512045SSimon Glass * This returns an ofnode which points to no node. It works both with the flat 1829e512045SSimon Glass * tree and livetree. 1839e512045SSimon Glass */ 1849e512045SSimon Glass static inline ofnode ofnode_null(void) 1859e512045SSimon Glass { 1869e512045SSimon Glass ofnode node; 1879e512045SSimon Glass 1889e512045SSimon Glass if (of_live_active()) 1899e512045SSimon Glass node.np = NULL; 1909e512045SSimon Glass else 1919e512045SSimon Glass node.of_offset = -1; 1929e512045SSimon Glass 1939e512045SSimon Glass return node; 1949e512045SSimon Glass } 1959e512045SSimon Glass 1969e512045SSimon Glass /** 1979e512045SSimon Glass * ofnode_read_u32() - Read a 32-bit integer from a property 1989e512045SSimon Glass * 1999e512045SSimon Glass * @ref: valid node reference to read property from 2009e512045SSimon Glass * @propname: name of the property to read from 2019e512045SSimon Glass * @outp: place to put value (if found) 2029e512045SSimon Glass * @return 0 if OK, -ve on error 2039e512045SSimon Glass */ 2049e512045SSimon Glass int ofnode_read_u32(ofnode node, const char *propname, u32 *outp); 2059e512045SSimon Glass 2069e512045SSimon Glass /** 2079e512045SSimon Glass * ofnode_read_s32() - Read a 32-bit integer from a property 2089e512045SSimon Glass * 2099e512045SSimon Glass * @ref: valid node reference to read property from 2109e512045SSimon Glass * @propname: name of the property to read from 2119e512045SSimon Glass * @outp: place to put value (if found) 2129e512045SSimon Glass * @return 0 if OK, -ve on error 2139e512045SSimon Glass */ 2149e512045SSimon Glass static inline int ofnode_read_s32(ofnode node, const char *propname, 2159e512045SSimon Glass s32 *out_value) 2169e512045SSimon Glass { 2179e512045SSimon Glass return ofnode_read_u32(node, propname, (u32 *)out_value); 2189e512045SSimon Glass } 2199e512045SSimon Glass 2209e512045SSimon Glass /** 2219e512045SSimon Glass * ofnode_read_u32_default() - Read a 32-bit integer from a property 2229e512045SSimon Glass * 2239e512045SSimon Glass * @ref: valid node reference to read property from 2249e512045SSimon Glass * @propname: name of the property to read from 2259e512045SSimon Glass * @def: default value to return if the property has no value 2269e512045SSimon Glass * @return property value, or @def if not found 2279e512045SSimon Glass */ 2289e512045SSimon Glass int ofnode_read_u32_default(ofnode ref, const char *propname, u32 def); 2299e512045SSimon Glass 2309e512045SSimon Glass /** 2319e512045SSimon Glass * ofnode_read_s32_default() - Read a 32-bit integer from a property 2329e512045SSimon Glass * 2339e512045SSimon Glass * @ref: valid node reference to read property from 2349e512045SSimon Glass * @propname: name of the property to read from 2359e512045SSimon Glass * @def: default value to return if the property has no value 2369e512045SSimon Glass * @return property value, or @def if not found 2379e512045SSimon Glass */ 2389e512045SSimon Glass int ofnode_read_s32_default(ofnode node, const char *propname, s32 def); 2399e512045SSimon Glass 2409e512045SSimon Glass /** 2419e512045SSimon Glass * ofnode_read_string() - Read a string from a property 2429e512045SSimon Glass * 2439e512045SSimon Glass * @ref: valid node reference to read property from 2449e512045SSimon Glass * @propname: name of the property to read 2459e512045SSimon Glass * @return string from property value, or NULL if there is no such property 2469e512045SSimon Glass */ 2479e512045SSimon Glass const char *ofnode_read_string(ofnode node, const char *propname); 2489e512045SSimon Glass 2499e512045SSimon Glass /** 250bed77496SSimon Glass * ofnode_read_u32_array() - Find and read an array of 32 bit integers 2519e512045SSimon Glass * 2529e512045SSimon Glass * @node: valid node reference to read property from 2539e512045SSimon Glass * @propname: name of the property to read 2549e512045SSimon Glass * @out_values: pointer to return value, modified only if return value is 0 2559e512045SSimon Glass * @sz: number of array elements to read 2569e512045SSimon Glass * 2579e512045SSimon Glass * Search for a property in a device node and read 32-bit value(s) from 2589e512045SSimon Glass * it. Returns 0 on success, -EINVAL if the property does not exist, 2599e512045SSimon Glass * -ENODATA if property does not have a value, and -EOVERFLOW if the 2609e512045SSimon Glass * property data isn't large enough. 2619e512045SSimon Glass * 2629e512045SSimon Glass * The out_values is modified only if a valid u32 value can be decoded. 2639e512045SSimon Glass */ 2649e512045SSimon Glass int ofnode_read_u32_array(ofnode node, const char *propname, 2659e512045SSimon Glass u32 *out_values, size_t sz); 2669e512045SSimon Glass 2679e512045SSimon Glass /** 2689e512045SSimon Glass * ofnode_read_bool() - read a boolean value from a property 2699e512045SSimon Glass * 2709e512045SSimon Glass * @node: valid node reference to read property from 2719e512045SSimon Glass * @propname: name of property to read 2729e512045SSimon Glass * @return true if property is present (meaning true), false if not present 2739e512045SSimon Glass */ 2749e512045SSimon Glass bool ofnode_read_bool(ofnode node, const char *propname); 2759e512045SSimon Glass 2769e512045SSimon Glass /** 2779e512045SSimon Glass * ofnode_find_subnode() - find a named subnode of a parent node 2789e512045SSimon Glass * 2799e512045SSimon Glass * @node: valid reference to parent node 2809e512045SSimon Glass * @subnode_name: name of subnode to find 2819e512045SSimon Glass * @return reference to subnode (which can be invalid if there is no such 2829e512045SSimon Glass * subnode) 2839e512045SSimon Glass */ 2849e512045SSimon Glass ofnode ofnode_find_subnode(ofnode node, const char *subnode_name); 2859e512045SSimon Glass 2869e512045SSimon Glass /** 2879e512045SSimon Glass * ofnode_first_subnode() - find the first subnode of a parent node 2889e512045SSimon Glass * 2899e512045SSimon Glass * @node: valid reference to a valid parent node 2909e512045SSimon Glass * @return reference to the first subnode (which can be invalid if the parent 2919e512045SSimon Glass * node has no subnodes) 2929e512045SSimon Glass */ 2939e512045SSimon Glass ofnode ofnode_first_subnode(ofnode node); 2949e512045SSimon Glass 2959e512045SSimon Glass /** 2969e512045SSimon Glass * ofnode_next_subnode() - find the next sibling of a subnode 2979e512045SSimon Glass * 2989e512045SSimon Glass * @node: valid reference to previous node (sibling) 2999e512045SSimon Glass * @return reference to the next subnode (which can be invalid if the node 3009e512045SSimon Glass * has no more siblings) 3019e512045SSimon Glass */ 3029e512045SSimon Glass ofnode ofnode_next_subnode(ofnode node); 3039e512045SSimon Glass 3049e512045SSimon Glass /** 3059e512045SSimon Glass * ofnode_get_name() - get the name of a node 3069e512045SSimon Glass * 3079e512045SSimon Glass * @node: valid node to look up 3089e512045SSimon Glass * @return name or node 3099e512045SSimon Glass */ 3109e512045SSimon Glass const char *ofnode_get_name(ofnode node); 3119e512045SSimon Glass 3129e512045SSimon Glass /** 3139e512045SSimon Glass * ofnode_read_size() - read the size of a property 3149e512045SSimon Glass * 3159e512045SSimon Glass * @node: node to check 3169e512045SSimon Glass * @propname: property to check 3179e512045SSimon Glass * @return size of property if present, or -EINVAL if not 3189e512045SSimon Glass */ 3199e512045SSimon Glass int ofnode_read_size(ofnode node, const char *propname); 3209e512045SSimon Glass 3219e512045SSimon Glass /** 322bed77496SSimon Glass * ofnode_get_addr_index() - get an address from a node 323bed77496SSimon Glass * 324bed77496SSimon Glass * This reads the register address from a node 325bed77496SSimon Glass * 326bed77496SSimon Glass * @node: node to read from 327bed77496SSimon Glass * @index: Index of address to read (0 for first) 328bed77496SSimon Glass * @return address, or FDT_ADDR_T_NONE if not present or invalid 329bed77496SSimon Glass */ 330bed77496SSimon Glass phys_addr_t ofnode_get_addr_index(ofnode node, int index); 331bed77496SSimon Glass 332bed77496SSimon Glass /** 333bed77496SSimon Glass * ofnode_get_addr() - get an address from a node 334bed77496SSimon Glass * 335bed77496SSimon Glass * This reads the register address from a node 336bed77496SSimon Glass * 337bed77496SSimon Glass * @node: node to read from 338bed77496SSimon Glass * @return address, or FDT_ADDR_T_NONE if not present or invalid 339bed77496SSimon Glass */ 340bed77496SSimon Glass phys_addr_t ofnode_get_addr(ofnode node); 341bed77496SSimon Glass 342bed77496SSimon Glass /** 3439e512045SSimon Glass * ofnode_stringlist_search() - find a string in a string list and return index 3449e512045SSimon Glass * 3459e512045SSimon Glass * Note that it is possible for this function to succeed on property values 3469e512045SSimon Glass * that are not NUL-terminated. That's because the function will stop after 3479e512045SSimon Glass * finding the first occurrence of @string. This can for example happen with 3489e512045SSimon Glass * small-valued cell properties, such as #address-cells, when searching for 3499e512045SSimon Glass * the empty string. 3509e512045SSimon Glass * 3519e512045SSimon Glass * @node: node to check 3529e512045SSimon Glass * @propname: name of the property containing the string list 3539e512045SSimon Glass * @string: string to look up in the string list 3549e512045SSimon Glass * 3559e512045SSimon Glass * @return: 3569e512045SSimon Glass * the index of the string in the list of strings 3579e512045SSimon Glass * -ENODATA if the property is not found 3589e512045SSimon Glass * -EINVAL on some other error 3599e512045SSimon Glass */ 3609e512045SSimon Glass int ofnode_stringlist_search(ofnode node, const char *propname, 3619e512045SSimon Glass const char *string); 3629e512045SSimon Glass 3639e512045SSimon Glass /** 3648c293d6aSSimon Glass * ofnode_read_string_index() - obtain an indexed string from a string list 3659e512045SSimon Glass * 3669e512045SSimon Glass * Note that this will successfully extract strings from properties with 3679e512045SSimon Glass * non-NUL-terminated values. For example on small-valued cell properties 3689e512045SSimon Glass * this function will return the empty string. 3699e512045SSimon Glass * 3709e512045SSimon Glass * If non-NULL, the length of the string (on success) or a negative error-code 3719e512045SSimon Glass * (on failure) will be stored in the integer pointer to by lenp. 3729e512045SSimon Glass * 3739e512045SSimon Glass * @node: node to check 3749e512045SSimon Glass * @propname: name of the property containing the string list 3759e512045SSimon Glass * @index: index of the string to return 3769e512045SSimon Glass * @lenp: return location for the string length or an error code on failure 3779e512045SSimon Glass * 3789e512045SSimon Glass * @return: 3799e512045SSimon Glass * length of string, if found or -ve error value if not found 3809e512045SSimon Glass */ 3819e512045SSimon Glass int ofnode_read_string_index(ofnode node, const char *propname, int index, 3829e512045SSimon Glass const char **outp); 3839e512045SSimon Glass 3849e512045SSimon Glass /** 3858c293d6aSSimon Glass * ofnode_read_string_count() - find the number of strings in a string list 3868c293d6aSSimon Glass * 3878c293d6aSSimon Glass * @node: node to check 3888c293d6aSSimon Glass * @propname: name of the property containing the string list 3898c293d6aSSimon Glass * @return: 3908c293d6aSSimon Glass * number of strings in the list, or -ve error value if not found 3918c293d6aSSimon Glass */ 3928c293d6aSSimon Glass int ofnode_read_string_count(ofnode node, const char *property); 3938c293d6aSSimon Glass 3948c293d6aSSimon Glass /** 3959e512045SSimon Glass * ofnode_parse_phandle_with_args() - Find a node pointed by phandle in a list 3969e512045SSimon Glass * 3979e512045SSimon Glass * This function is useful to parse lists of phandles and their arguments. 3989e512045SSimon Glass * Returns 0 on success and fills out_args, on error returns appropriate 3999e512045SSimon Glass * errno value. 4009e512045SSimon Glass * 4019e512045SSimon Glass * Caller is responsible to call of_node_put() on the returned out_args->np 4029e512045SSimon Glass * pointer. 4039e512045SSimon Glass * 4049e512045SSimon Glass * Example: 4059e512045SSimon Glass * 4069e512045SSimon Glass * phandle1: node1 { 4079e512045SSimon Glass * #list-cells = <2>; 4089e512045SSimon Glass * } 4099e512045SSimon Glass * 4109e512045SSimon Glass * phandle2: node2 { 4119e512045SSimon Glass * #list-cells = <1>; 4129e512045SSimon Glass * } 4139e512045SSimon Glass * 4149e512045SSimon Glass * node3 { 4159e512045SSimon Glass * list = <&phandle1 1 2 &phandle2 3>; 4169e512045SSimon Glass * } 4179e512045SSimon Glass * 4189e512045SSimon Glass * To get a device_node of the `node2' node you may call this: 4199e512045SSimon Glass * ofnode_parse_phandle_with_args(node3, "list", "#list-cells", 0, 1, &args); 4209e512045SSimon Glass * 4219e512045SSimon Glass * @node: device tree node containing a list 4229e512045SSimon Glass * @list_name: property name that contains a list 4239e512045SSimon Glass * @cells_name: property name that specifies phandles' arguments count 4249e512045SSimon Glass * @cells_count: Cell count to use if @cells_name is NULL 4259e512045SSimon Glass * @index: index of a phandle to parse out 4269e512045SSimon Glass * @out_args: optional pointer to output arguments structure (will be filled) 4279e512045SSimon Glass * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if 4289e512045SSimon Glass * @list_name does not exist, -EINVAL if a phandle was not found, 4299e512045SSimon Glass * @cells_name could not be found, the arguments were truncated or there 4309e512045SSimon Glass * were too many arguments. 4319e512045SSimon Glass */ 4329e512045SSimon Glass int ofnode_parse_phandle_with_args(ofnode node, const char *list_name, 4339e512045SSimon Glass const char *cells_name, int cell_count, 4349e512045SSimon Glass int index, 4359e512045SSimon Glass struct ofnode_phandle_args *out_args); 4369e512045SSimon Glass 4379e512045SSimon Glass /** 438642346aeSPatrice Chotard * ofnode_count_phandle_with_args() - Count number of phandle in a list 439642346aeSPatrice Chotard * 440642346aeSPatrice Chotard * This function is useful to count phandles into a list. 441642346aeSPatrice Chotard * Returns number of phandle on success, on error returns appropriate 442642346aeSPatrice Chotard * errno value. 443642346aeSPatrice Chotard * 444642346aeSPatrice Chotard * @node: device tree node containing a list 445642346aeSPatrice Chotard * @list_name: property name that contains a list 446642346aeSPatrice Chotard * @cells_name: property name that specifies phandles' arguments count 447642346aeSPatrice Chotard * @return number of phandle on success, -ENOENT if @list_name does not 448642346aeSPatrice Chotard * exist, -EINVAL if a phandle was not found, @cells_name could not 449642346aeSPatrice Chotard * be found. 450642346aeSPatrice Chotard */ 451642346aeSPatrice Chotard int ofnode_count_phandle_with_args(ofnode node, const char *list_name, 452642346aeSPatrice Chotard const char *cells_name); 453642346aeSPatrice Chotard 454642346aeSPatrice Chotard /** 4559e512045SSimon Glass * ofnode_path() - find a node by full path 4569e512045SSimon Glass * 4579e512045SSimon Glass * @path: Full path to node, e.g. "/bus/spi@1" 4589e512045SSimon Glass * @return reference to the node found. Use ofnode_valid() to check if it exists 4599e512045SSimon Glass */ 4609e512045SSimon Glass ofnode ofnode_path(const char *path); 4619e512045SSimon Glass 4629e512045SSimon Glass /** 4639e512045SSimon Glass * ofnode_get_chosen_prop() - get the value of a chosen property 4649e512045SSimon Glass * 4659e512045SSimon Glass * This looks for a property within the /chosen node and returns its value 4669e512045SSimon Glass * 4679e512045SSimon Glass * @propname: Property name to look for 4689e512045SSimon Glass */ 4699e512045SSimon Glass const char *ofnode_get_chosen_prop(const char *propname); 4709e512045SSimon Glass 4719e512045SSimon Glass /** 4729e512045SSimon Glass * ofnode_get_chosen_node() - get the chosen node 4739e512045SSimon Glass * 4749e512045SSimon Glass * @return the chosen node if present, else ofnode_null() 4759e512045SSimon Glass */ 4769e512045SSimon Glass ofnode ofnode_get_chosen_node(const char *name); 4779e512045SSimon Glass 4789e512045SSimon Glass struct display_timing; 4799e512045SSimon Glass /** 4809e512045SSimon Glass * ofnode_decode_display_timing() - decode display timings 4819e512045SSimon Glass * 4829e512045SSimon Glass * Decode display timings from the supplied 'display-timings' node. 4839e512045SSimon Glass * See doc/device-tree-bindings/video/display-timing.txt for binding 4849e512045SSimon Glass * information. 4859e512045SSimon Glass * 4869e512045SSimon Glass * @node 'display-timing' node containing the timing subnodes 4879e512045SSimon Glass * @index Index number to read (0=first timing subnode) 4889e512045SSimon Glass * @config Place to put timings 4899e512045SSimon Glass * @return 0 if OK, -FDT_ERR_NOTFOUND if not found 4909e512045SSimon Glass */ 4919e512045SSimon Glass int ofnode_decode_display_timing(ofnode node, int index, 4929e512045SSimon Glass struct display_timing *config); 4939e512045SSimon Glass 4949e512045SSimon Glass /** 49561e51babSMasahiro Yamada * ofnode_get_property()- - get a pointer to the value of a node property 4969e512045SSimon Glass * 4979e512045SSimon Glass * @node: node to read 4989e512045SSimon Glass * @propname: property to read 4999e512045SSimon Glass * @lenp: place to put length on success 5009e512045SSimon Glass * @return pointer to property, or NULL if not found 5019e512045SSimon Glass */ 50261e51babSMasahiro Yamada const void *ofnode_get_property(ofnode node, const char *propname, int *lenp); 5039e512045SSimon Glass 5049e512045SSimon Glass /** 5059e512045SSimon Glass * ofnode_is_available() - check if a node is marked available 5069e512045SSimon Glass * 5079e512045SSimon Glass * @node: node to check 5089e512045SSimon Glass * @return true if node's 'status' property is "okay" (or is missing) 5099e512045SSimon Glass */ 5109e512045SSimon Glass bool ofnode_is_available(ofnode node); 5119e512045SSimon Glass 5129e512045SSimon Glass /** 5139e512045SSimon Glass * ofnode_get_addr_size() - get address and size from a property 5149e512045SSimon Glass * 5159e512045SSimon Glass * This does no address translation. It simply reads an property that contains 5169e512045SSimon Glass * an address and a size value, one after the other. 5179e512045SSimon Glass * 5189e512045SSimon Glass * @node: node to read from 5199e512045SSimon Glass * @propname: property to read 5209e512045SSimon Glass * @sizep: place to put size value (on success) 5219e512045SSimon Glass * @return address value, or FDT_ADDR_T_NONE on error 5229e512045SSimon Glass */ 5239e512045SSimon Glass phys_addr_t ofnode_get_addr_size(ofnode node, const char *propname, 5249e512045SSimon Glass phys_size_t *sizep); 5259e512045SSimon Glass 5269e512045SSimon Glass /** 5279e512045SSimon Glass * ofnode_read_u8_array_ptr() - find an 8-bit array 5289e512045SSimon Glass * 5299e512045SSimon Glass * Look up a property in a node and return a pointer to its contents as a 5309e512045SSimon Glass * byte array of given length. The property must have at least enough data 5319e512045SSimon Glass * for the array (count bytes). It may have more, but this will be ignored. 5329e512045SSimon Glass * The data is not copied. 5339e512045SSimon Glass * 5349e512045SSimon Glass * @node node to examine 5359e512045SSimon Glass * @propname name of property to find 5369e512045SSimon Glass * @sz number of array elements 5379e512045SSimon Glass * @return pointer to byte array if found, or NULL if the property is not 5389e512045SSimon Glass * found or there is not enough data 5399e512045SSimon Glass */ 5409e512045SSimon Glass const uint8_t *ofnode_read_u8_array_ptr(ofnode node, const char *propname, 5419e512045SSimon Glass size_t sz); 5429e512045SSimon Glass 5439e512045SSimon Glass /** 5449e512045SSimon Glass * ofnode_read_pci_addr() - look up a PCI address 5459e512045SSimon Glass * 5469e512045SSimon Glass * Look at an address property in a node and return the PCI address which 5479e512045SSimon Glass * corresponds to the given type in the form of fdt_pci_addr. 5489e512045SSimon Glass * The property must hold one fdt_pci_addr with a lengh. 5499e512045SSimon Glass * 5509e512045SSimon Glass * @node node to examine 5519e512045SSimon Glass * @type pci address type (FDT_PCI_SPACE_xxx) 5529e512045SSimon Glass * @propname name of property to find 5539e512045SSimon Glass * @addr returns pci address in the form of fdt_pci_addr 5549e512045SSimon Glass * @return 0 if ok, -ENOENT if the property did not exist, -EINVAL if the 5559e512045SSimon Glass * format of the property was invalid, -ENXIO if the requested 5569e512045SSimon Glass * address type was not found 5579e512045SSimon Glass */ 5589e512045SSimon Glass int ofnode_read_pci_addr(ofnode node, enum fdt_pci_space type, 5599e512045SSimon Glass const char *propname, struct fdt_pci_addr *addr); 5609e512045SSimon Glass 5619e512045SSimon Glass /** 5629e512045SSimon Glass * ofnode_read_addr_cells() - Get the number of address cells for a node 5639e512045SSimon Glass * 5649e512045SSimon Glass * This walks back up the tree to find the closest #address-cells property 5659e512045SSimon Glass * which controls the given node. 5669e512045SSimon Glass * 5679e512045SSimon Glass * @node: Node to check 5689e512045SSimon Glass * @return number of address cells this node uses 5699e512045SSimon Glass */ 5709e512045SSimon Glass int ofnode_read_addr_cells(ofnode node); 5719e512045SSimon Glass 5729e512045SSimon Glass /** 5739e512045SSimon Glass * ofnode_read_size_cells() - Get the number of size cells for a node 5749e512045SSimon Glass * 5759e512045SSimon Glass * This walks back up the tree to find the closest #size-cells property 5769e512045SSimon Glass * which controls the given node. 5779e512045SSimon Glass * 5789e512045SSimon Glass * @node: Node to check 5799e512045SSimon Glass * @return number of size cells this node uses 5809e512045SSimon Glass */ 5819e512045SSimon Glass int ofnode_read_size_cells(ofnode node); 5829e512045SSimon Glass 5839e512045SSimon Glass /** 584878d68c0SSimon Glass * ofnode_read_simple_addr_cells() - Get the address cells property in a node 585878d68c0SSimon Glass * 586878d68c0SSimon Glass * This function matches fdt_address_cells(). 587878d68c0SSimon Glass * 588878d68c0SSimon Glass * @np: Node pointer to check 589878d68c0SSimon Glass * @return value of #address-cells property in this node, or 2 if none 590878d68c0SSimon Glass */ 591878d68c0SSimon Glass int ofnode_read_simple_addr_cells(ofnode node); 592878d68c0SSimon Glass 593878d68c0SSimon Glass /** 594878d68c0SSimon Glass * ofnode_read_simple_size_cells() - Get the size cells property in a node 595878d68c0SSimon Glass * 596878d68c0SSimon Glass * This function matches fdt_size_cells(). 597878d68c0SSimon Glass * 598878d68c0SSimon Glass * @np: Node pointer to check 599878d68c0SSimon Glass * @return value of #size-cells property in this node, or 2 if none 600878d68c0SSimon Glass */ 601878d68c0SSimon Glass int ofnode_read_simple_size_cells(ofnode node); 602878d68c0SSimon Glass 603878d68c0SSimon Glass /** 6049e512045SSimon Glass * ofnode_pre_reloc() - check if a node should be bound before relocation 6059e512045SSimon Glass * 6069e512045SSimon Glass * Device tree nodes can be marked as needing-to-be-bound in the loader stages 6079e512045SSimon Glass * via special device tree properties. 6089e512045SSimon Glass * 6099e512045SSimon Glass * Before relocation this function can be used to check if nodes are required 6109e512045SSimon Glass * in either SPL or TPL stages. 6119e512045SSimon Glass * 6129e512045SSimon Glass * After relocation and jumping into the real U-Boot binary it is possible to 6139e512045SSimon Glass * determine if a node was bound in one of SPL/TPL stages. 6149e512045SSimon Glass * 6159e512045SSimon Glass * There are 3 settings currently in use 6169e512045SSimon Glass * - 6179e512045SSimon Glass * - u-boot,dm-pre-reloc: legacy and indicates any of TPL or SPL 6189e512045SSimon Glass * Existing platforms only use it to indicate nodes needed in 6199e512045SSimon Glass * SPL. Should probably be replaced by u-boot,dm-spl for 6209e512045SSimon Glass * new platforms. 6219e512045SSimon Glass * 6229e512045SSimon Glass * @node: node to check 6239e512045SSimon Glass * @eturns true if node is needed in SPL/TL, false otherwise 6249e512045SSimon Glass */ 6259e512045SSimon Glass bool ofnode_pre_reloc(ofnode node); 6269e512045SSimon Glass 627dcf98852SSimon Glass int ofnode_read_resource(ofnode node, uint index, struct resource *res); 6287b8b47bdSMasahiro Yamada int ofnode_read_resource_byname(ofnode node, const char *name, 6297b8b47bdSMasahiro Yamada struct resource *res); 630dcf98852SSimon Glass 631*3991f42eSSimon Glass /** 632*3991f42eSSimon Glass * ofnode_for_each_subnode() - iterate over all subnodes of a parent 633*3991f42eSSimon Glass * 634*3991f42eSSimon Glass * @node: child node (ofnode, lvalue) 635*3991f42eSSimon Glass * @parent: parent node (ofnode) 636*3991f42eSSimon Glass * 637*3991f42eSSimon Glass * This is a wrapper around a for loop and is used like so: 638*3991f42eSSimon Glass * 639*3991f42eSSimon Glass * ofnode node; 640*3991f42eSSimon Glass * 641*3991f42eSSimon Glass * ofnode_for_each_subnode(node, parent) { 642*3991f42eSSimon Glass * Use node 643*3991f42eSSimon Glass * ... 644*3991f42eSSimon Glass * } 645*3991f42eSSimon Glass * 646*3991f42eSSimon Glass * Note that this is implemented as a macro and @node is used as 647*3991f42eSSimon Glass * iterator in the loop. The parent variable can be a constant or even a 648*3991f42eSSimon Glass * literal. 649*3991f42eSSimon Glass */ 650*3991f42eSSimon Glass #define ofnode_for_each_subnode(node, parent) \ 651*3991f42eSSimon Glass for (node = ofnode_first_subnode(parent); \ 652*3991f42eSSimon Glass ofnode_valid(node); \ 653*3991f42eSSimon Glass node = ofnode_next_subnode(node)) 654*3991f42eSSimon Glass 6554984de2bSSimon Glass #endif 656