1 /* SPDX-License-Identifier: GPL-2.0+ */
20  * ofnode - reference to a device tree node
24  * latter case, the pointer value is just the integer offset within the flat DT.
32  * NULL, or an offset of -1.
34  * There is no ambiguity as to whether ofnode holds an offset or a node
35  * pointer: when the live tree is active it holds a node pointer, otherwise it
37  * the same value could point to a valid device node or a valid offset. We
44  * the DT.
46  * @np: Pointer to device node, used for live tree
48  *	is not a really a pointer to a node: it is an offset value. See above.
56 	ofnode node;  member
62  * _ofnode_to_np() - convert an ofnode to a live DT node pointer
66  * @node: Reference containing struct device_node * (possibly invalid)
67  * @return pointer to device node (can be NULL)
69 static inline const struct device_node *ofnode_to_np(ofnode node)  in ofnode_to_np()  argument
75 	return node.np;  in ofnode_to_np()
79  * ofnode_to_offset() - convert an ofnode to a flat DT offset
81  * This cannot be called if the reference contains a node pointer.
83  * @node: Reference containing offset (possibly invalid)
84  * @return DT offset (can be -1)
86 static inline int ofnode_to_offset(ofnode node)  in ofnode_to_offset()  argument
90 		return -1;  in ofnode_to_offset()
92 	return node.of_offset;  in ofnode_to_offset()
96  * ofnode_valid() - check if an ofnode is valid
100 static inline bool ofnode_valid(ofnode node)  in ofnode_valid()  argument
103 		return node.np != NULL;  in ofnode_valid()
105 		return node.of_offset != -1;  in ofnode_valid()
109  * offset_to_ofnode() - convert a DT offset to an ofnode
111  * @of_offset: DT offset (either valid, or -1)
112  * @return reference to the associated DT offset
116 	ofnode node;  in offset_to_ofnode()  local
119 		node.np = NULL;  in offset_to_ofnode()
121 		node.of_offset = of_offset;  in offset_to_ofnode()
123 	return node;  in offset_to_ofnode()
127  * np_to_ofnode() - convert a node pointer to an ofnode
129  * @np: Live node pointer (can be NULL)
130  * @return reference to the associated node pointer
134 	ofnode node;  in np_to_ofnode()  local
136 	node.np = np;  in np_to_ofnode()
138 	return node;  in np_to_ofnode()
142  * ofnode_is_np() - check if a reference is a node pointer
145  * references will use it. This is because using the flat DT when the live tree
148  * @node: reference to check (possibly invalid)
149  * @return true if the reference is a live node pointer, false if it is a DT
152 static inline bool ofnode_is_np(ofnode node)  in ofnode_is_np()  argument
159 	assert(!ofnode_valid(node) ||  in ofnode_is_np()
160 	       (of_live_active() ? _ofnode_to_np(node)  in ofnode_is_np()
161 				  : _ofnode_to_np(node)));  in ofnode_is_np()
163 	return of_live_active() && ofnode_valid(node);  in ofnode_is_np()
167  * ofnode_equal() - check if two references are equal
178  * ofnode_null() - Obtain a null ofnode
180  * This returns an ofnode which points to no node. It works both with the flat
185 	ofnode node;  in ofnode_null()  local
188 		node.np = NULL;  in ofnode_null()
190 		node.of_offset = -1;  in ofnode_null()
192 	return node;  in ofnode_null()
196  * ofnode_read_u32() - Read a 32-bit integer from a property
198  * @ref:	valid node reference to read property from
201  * @return 0 if OK, -ve on error
203 int ofnode_read_u32(ofnode node, const char *propname, u32 *outp);
206  * ofnode_read_s32() - Read a 32-bit integer from a property
208  * @ref:	valid node reference to read property from
211  * @return 0 if OK, -ve on error
213 static inline int ofnode_read_s32(ofnode node, const char *propname,  in ofnode_read_s32()  argument
216 	return ofnode_read_u32(node, propname, (u32 *)out_value);  in ofnode_read_s32()
220  * ofnode_read_u32_default() - Read a 32-bit integer from a property
222  * @ref:	valid node reference to read property from
230  * ofnode_read_s32_default() - Read a 32-bit integer from a property
232  * @ref:	valid node reference to read property from
237 int ofnode_read_s32_default(ofnode node, const char *propname, s32 def);
240  * ofnode_read_u64() - Read a 64-bit integer from a property
242  * @node:	valid node reference to read property from
245  * @return 0 if OK, -ve on error
247 int ofnode_read_u64(ofnode node, const char *propname, u64 *outp);
250  * ofnode_read_u64_default() - Read a 64-bit integer from a property
252  * @ref:	valid node reference to read property from
257 int ofnode_read_u64_default(ofnode node, const char *propname, u64 def);
260  * ofnode_read_string() - Read a string from a property
262  * @ref:	valid node reference to read property from
266 const char *ofnode_read_string(ofnode node, const char *propname);
269  * ofnode_read_u32_array() - Find and read an array of 32 bit integers
271  * @node:	valid node reference to read property from
275  * @return 0 if OK, -ve on error
277  * Search for a property in a device node and read 32-bit value(s) from
278  * it. Returns 0 on success, -EINVAL if the property does not exist,
279  * -ENODATA if property does not have a value, and -EOVERFLOW if the
284 int ofnode_read_u32_array(ofnode node, const char *propname,
288  * ofnode_read_bool() - read a boolean value from a property
290  * @node:	valid node reference to read property from
294 bool ofnode_read_bool(ofnode node, const char *propname);
297  * ofnode_find_subnode() - find a named subnode of a parent node
299  * @node:	valid reference to parent node
304 ofnode ofnode_find_subnode(ofnode node, const char *subnode_name);
307  * ofnode_first_subnode() - find the first subnode of a parent node
309  * @node:	valid reference to a valid parent node
311  * node has no subnodes)
313 ofnode ofnode_first_subnode(ofnode node);
316  * ofnode_next_subnode() - find the next sibling of a subnode
318  * @node:	valid reference to previous node (sibling)
319  * @return reference to the next subnode (which can be invalid if the node
322 ofnode ofnode_next_subnode(ofnode node);
325  * ofnode_get_parent() - get the ofnode's parent (enclosing ofnode)
327  * @node: valid node to look up
328  * @return ofnode reference of the parent node
330 ofnode ofnode_get_parent(ofnode node);
333  * ofnode_get_name() - get the name of a node
335  * @node: valid node to look up
336  * @return name of node
338 const char *ofnode_get_name(ofnode node);
341  * ofnode_get_by_phandle() - get ofnode from phandle
349  * ofnode_read_size() - read the size of a property
351  * @node: node to check
353  * @return size of property if present, or -EINVAL if not
355 int ofnode_read_size(ofnode node, const char *propname);
358  * ofnode_get_addr_index() - get an address from a node
360  * This reads the register address from a node
362  * @node: node to read from
366 phys_addr_t ofnode_get_addr_index(ofnode node, int index);
369  * ofnode_get_addr() - get an address from a node
371  * This reads the register address from a node
373  * @node: node to read from
376 phys_addr_t ofnode_get_addr(ofnode node);
379  * ofnode_stringlist_search() - find a string in a string list and return index
382  * that are not NUL-terminated. That's because the function will stop after
384  * small-valued cell properties, such as #address-cells, when searching for
387  * @node: node to check
393  *   -ENODATA if the property is not found
394  *   -EINVAL on some other error
396 int ofnode_stringlist_search(ofnode node, const char *propname,
400  * ofnode_read_string_index() - obtain an indexed string from a string list
403  * non-NUL-terminated values. For example on small-valued cell properties
406  * If non-NULL, the length of the string (on success) or a negative error-code
409  * @node: node to check
415  *   length of string, if found or -ve error value if not found
417 int ofnode_read_string_index(ofnode node, const char *propname, int index,
421  * ofnode_read_string_count() - find the number of strings in a string list
423  * @node: node to check
426  *   number of strings in the list, or -ve error value if not found
428 int ofnode_read_string_count(ofnode node, const char *property);
431  * ofnode_parse_phandle_with_args() - Find a node pointed by phandle in a list
437  * Caller is responsible to call of_node_put() on the returned out_args->np
443  *	#list-cells = <2>;
447  *	#list-cells = <1>;
454  * To get a device_node of the `node2' node you may call this:
455  * ofnode_parse_phandle_with_args(node3, "list", "#list-cells", 0, 1, &args);
457  * @node:	device tree node containing a list
463  * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if
464  *	@list_name does not exist, -EINVAL if a phandle was not found,
468 int ofnode_parse_phandle_with_args(ofnode node, const char *list_name,
474  * ofnode_count_phandle_with_args() - Count number of phandle in a list
480  * @node:	device tree node containing a list
483  * @return number of phandle on success, -ENOENT if @list_name does not
484  *      exist, -EINVAL if a phandle was not found, @cells_name could not
487 int ofnode_count_phandle_with_args(ofnode node, const char *list_name,
491  * ofnode_path() - find a node by full path
493  * @path: Full path to node, e.g. "/bus/spi@1"
494  * @return reference to the node found. Use ofnode_valid() to check if it exists
499  * ofnode_get_chosen_prop() - get the value of a chosen property
501  * This looks for a property within the /chosen node and returns its value
509  * ofnode_get_chosen_node() - get the chosen node
511  * @return the chosen node if present, else ofnode_null()
517  * ofnode_decode_display_timing() - decode display timings
519  * Decode display timings from the supplied 'display-timings' node.
520  * See doc/device-tree-bindings/video/display-timing.txt for binding
523  * @node	'display-timing' node containing the timing subnodes
526  * @return 0 if OK, -FDT_ERR_NOTFOUND if not found
528 int ofnode_decode_display_timing(ofnode node, int index,
532  * ofnode_get_property()- - get a pointer to the value of a node property
534  * @node: node to read
539 const void *ofnode_get_property(ofnode node, const char *propname, int *lenp);
542  * ofnode_is_available() - check if a node is marked available
544  * @node: node to check
545  * @return true if node's 'status' property is "okay" (or is missing)
547 bool ofnode_is_available(ofnode node);
550  * ofnode_get_addr_size() - get address and size from a property
555  * @node: node to read from
560 phys_addr_t ofnode_get_addr_size(ofnode node, const char *propname,
564  * ofnode_read_u8_array_ptr() - find an 8-bit array
566  * Look up a property in a node and return a pointer to its contents as a
571  * @node	node to examine
577 const uint8_t *ofnode_read_u8_array_ptr(ofnode node, const char *propname,
581  * ofnode_read_pci_addr() - look up a PCI address
583  * Look at an address property in a node and return the PCI address which
587  * @node	node to examine
591  * @return 0 if ok, -ENOENT if the property did not exist, -EINVAL if the
592  *		format of the property was invalid, -ENXIO if the requested
595 int ofnode_read_pci_addr(ofnode node, enum fdt_pci_space type,
599  * ofnode_read_pci_vendev() - look up PCI vendor and device id
601  * Look at the compatible property of a device node that represents a PCI
604  * @param node		node to examine
609 int ofnode_read_pci_vendev(ofnode node, u16 *vendor, u16 *device);
612  * ofnode_read_addr_cells() - Get the number of address cells for a node
614  * This walks back up the tree to find the closest #address-cells property
615  * which controls the given node.
617  * @node: Node to check
618  * @return number of address cells this node uses
620 int ofnode_read_addr_cells(ofnode node);
623  * ofnode_read_size_cells() - Get the number of size cells for a node
625  * This walks back up the tree to find the closest #size-cells property
626  * which controls the given node.
628  * @node: Node to check
629  * @return number of size cells this node uses
631 int ofnode_read_size_cells(ofnode node);
634  * ofnode_read_simple_addr_cells() - Get the address cells property in a node
638  * @np: Node pointer to check
639  * @return value of #address-cells property in this node, or 2 if none
641 int ofnode_read_simple_addr_cells(ofnode node);
644  * ofnode_read_simple_size_cells() - Get the size cells property in a node
648  * @np: Node pointer to check
649  * @return value of #size-cells property in this node, or 2 if none
651 int ofnode_read_simple_size_cells(ofnode node);
654  * ofnode_pre_reloc() - check if a node should be bound before relocation
656  * Device tree nodes can be marked as needing-to-be-bound in the loader stages
662  * After relocation and jumping into the real U-Boot binary it is possible to
663  * determine if a node was bound in one of SPL/TPL stages.
666  * -
667  * - u-boot,dm-pre-reloc: legacy and indicates any of TPL or SPL
669  *   SPL. Should probably be replaced by u-boot,dm-spl for
672  * @node: node to check
673  * @return true if node is needed in SPL/TL, false otherwise
675 bool ofnode_pre_reloc(ofnode node);
678  * ofnode_read_resource() - Read a resource from a node
680  * Read resource information from a node at the given index
682  * @node: Node to read from
685  * @return 0 if OK, -ve on error
687 int ofnode_read_resource(ofnode node, uint index, struct resource *res);
690  * ofnode_read_resource_byname() - Read a resource from a node by name
692  * Read resource information from a node matching the given name. This uses a
693  * 'reg-names' string list property with the names matching the associated
696  * @node: Node to read from
699  * @return 0 if OK, -ve on error
701 int ofnode_read_resource_byname(ofnode node, const char *name,
705  * ofnode_by_compatible() - Find the next compatible node
707  * Find the next node after @from that is compatible with @compat
716  * ofnode_by_prop_value() - Find the next node with given property value
718  * Find the next node after @from that has a @propname with a value
730  * ofnode_for_each_subnode() - iterate over all subnodes of a parent
732  * @node:       child node (ofnode, lvalue)
733  * @parent:     parent node (ofnode)
737  *	ofnode node;
739  *	ofnode_for_each_subnode(node, parent) {
740  *		Use node
744  * Note that this is implemented as a macro and @node is used as
748 #define ofnode_for_each_subnode(node, parent) \  argument
749 	for (node = ofnode_first_subnode(parent); \
750 	     ofnode_valid(node); \
751 	     node = ofnode_next_subnode(node))
754  * ofnode_translate_address() - Tranlate a device-tree address
756  * Translate an address from the device-tree into a CPU physical address. This
760  * @ofnode: Device tree node giving the context in which to translate the
765 u64 ofnode_translate_address(ofnode node, const fdt32_t *in_addr);
768  * ofnode_device_is_compatible() - check if the node is compatible with compat
770  * This allows to check whether the node is comaptible with the compat.
772  * @node:	Device tree node for which compatible needs to be verified.
773  * @compat:	Compatible string which needs to verified in the given node.
776 int ofnode_device_is_compatible(ofnode node, const char *compat);
779  * ofnode_write_prop() - Set a property of a ofnode
784  * @node:	The node for whose property should be set
789  * @return 0 if successful, -ve on error
791 int ofnode_write_prop(ofnode node, const char *propname, int len,
795  * ofnode_write_string() - Set a string property of a ofnode
800  * @node:	The node for whose string property should be set
804  * @return 0 if successful, -ve on error
806 int ofnode_write_string(ofnode node, const char *propname, const char *value);
809  * ofnode_set_enabled() - Enable or disable a device tree node given by its
812  * This function effectively sets the node's "status" property to either "okay"
816  * @node:	The node to enable
818  *		node
819  * @return 0 if successful, -ve on error
821 int ofnode_set_enabled(ofnode node, bool value);