1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * Copyright (c) 2017 Google, Inc
4 * Written by Simon Glass <sjg@chromium.org>
10 /* TODO(sjg@chromium.org): Drop fdtdec.h include */
13 #include <dm/of_access.h>
15 #include <phy_interface.h>
17 /* Enable checks to protect against invalid calls */
22 #include <dm/ofnode_decl.h>
24 struct ofnode_phandle_args {
27 uint32_t args[OF_MAX_PHANDLE_ARGS];
30 #if CONFIG_IS_ENABLED(OFNODE_MULTI_TREE)
32 * oftree_reset() - reset the state of the oftree list
34 * Reset the oftree list so it can be started again. This should be called
35 * once the control FDT is in place, but before the ofnode interface is used.
37 void oftree_reset(void);
40 * ofnode_to_fdt() - convert an ofnode to a flat DT pointer
42 * This cannot be called if the reference contains a node pointer.
44 * @node: Reference containing offset (possibly invalid)
45 * Return: DT offset (can be NULL)
47 __attribute_const__ void *ofnode_to_fdt(ofnode node);
50 * ofnode_to_offset() - convert an ofnode to a flat DT offset
52 * This cannot be called if the reference contains a node pointer.
54 * @node: Reference containing offset (possibly invalid)
55 * Return: DT offset (can be -1)
57 __attribute_const__ int ofnode_to_offset(ofnode node);
60 * oftree_from_fdt() - Returns an oftree from a flat device tree pointer
62 * @fdt: Device tree to use
64 * Returns: reference to the given node
66 oftree oftree_from_fdt(void *fdt);
69 * noffset_to_ofnode() - convert a DT offset to an ofnode
71 * @other_node: Node in the same tree to use as a reference
72 * @of_offset: DT offset (either valid, or -1)
73 * Return: reference to the associated DT offset
75 ofnode noffset_to_ofnode(ofnode other_node, int of_offset);
77 #else /* !OFNODE_MULTI_TREE */
78 static inline void oftree_reset(void) {}
80 static inline void *ofnode_to_fdt(ofnode node)
86 /* Use the control FDT by default */
87 return (void *)gd->fdt_blob;
90 static inline __attribute_const__ int ofnode_to_offset(ofnode node)
96 return node.of_offset;
99 static inline oftree oftree_from_fdt(void *fdt)
103 /* we cannot access other trees without OFNODE_MULTI_TREE */
104 if (fdt == gd->fdt_blob)
112 static inline ofnode noffset_to_ofnode(ofnode other_node, int of_offset)
116 if (of_live_active())
119 node.of_offset = of_offset;
124 #endif /* OFNODE_MULTI_TREE */
127 * ofnode_to_np() - convert an ofnode to a live DT node pointer
129 * This cannot be called if the reference contains an offset.
131 * @node: Reference containing struct device_node * (possibly invalid)
132 * Return: pointer to device node (can be NULL)
134 static inline struct device_node *ofnode_to_np(ofnode node)
137 if (!of_live_active())
144 * ofnode_valid() - check if an ofnode is valid
146 * @node: Reference containing offset (possibly invalid)
147 * Return: true if the reference contains a valid ofnode, false if not
149 static inline bool ofnode_valid(ofnode node)
151 if (of_live_active())
152 return node.np != NULL;
154 return node.of_offset >= 0;
158 * oftree_lookup_fdt() - obtain the FDT pointer from an oftree
160 * This can only be called when flat tree is enabled
162 * @tree: Tree to look at
163 * @return FDT pointer from the tree
165 static inline void *oftree_lookup_fdt(oftree tree)
167 if (of_live_active())
174 * offset_to_ofnode() - convert a DT offset to an ofnode
176 * @of_offset: DT offset (either valid, or -1)
177 * Return: reference to the associated DT offset
179 static inline ofnode offset_to_ofnode(int of_offset)
183 if (of_live_active())
186 node.of_offset = of_offset >= 0 ? of_offset : -1;
192 * np_to_ofnode() - convert a node pointer to an ofnode
194 * @np: Live node pointer (can be NULL)
195 * Return: reference to the associated node pointer
197 static inline ofnode np_to_ofnode(struct device_node *np)
207 * ofnode_is_np() - check if a reference is a node pointer
209 * This function associated that if there is a valid live tree then all
210 * references will use it. This is because using the flat DT when the live tree
211 * is valid is not permitted.
213 * @node: reference to check (possibly invalid)
214 * Return: true if the reference is a live node pointer, false if it is a DT
217 static inline bool ofnode_is_np(ofnode node)
221 * Check our assumption that flat tree offsets are not used when a
222 * live tree is in use.
224 assert(!ofnode_valid(node) ||
225 (of_live_active() ? ofnode_to_np(node)
226 : ofnode_to_np(node)));
228 return of_live_active() && ofnode_valid(node);
232 * ofnode_equal() - check if two references are equal
234 * @ref1: first reference to check (possibly invalid)
235 * @ref2: second reference to check (possibly invalid)
236 * Return: true if equal, else false
238 static inline bool ofnode_equal(ofnode ref1, ofnode ref2)
240 /* We only need to compare the contents */
241 return ref1.of_offset == ref2.of_offset;
245 * oftree_valid() - check if an oftree is valid
247 * @tree: Reference containing oftree
248 * Return: true if the reference contains a valid oftree, false if node
250 static inline bool oftree_valid(oftree tree)
252 if (of_live_active())
259 * oftree_null() - Obtain a null oftree
261 * This returns an oftree which points to no tree. It works both with the flat
264 static inline oftree oftree_null(void)
268 if (of_live_active())
277 * ofnode_null() - Obtain a null ofnode
279 * This returns an ofnode which points to no node. It works both with the flat
282 static inline ofnode ofnode_null(void)
286 if (of_live_active())
294 static inline ofnode ofnode_root(void)
298 if (of_live_active())
299 node.np = gd_of_root();
307 * ofprop_valid() - check if an ofprop is valid
309 * @prop: Pointer to ofprop to check
310 * Return: true if the reference contains a valid ofprop, false if not
312 static inline bool ofprop_valid(struct ofprop *prop)
314 if (of_live_active())
317 return prop->offset >= 0;
321 * oftree_default() - Returns the default device tree (U-Boot's control FDT)
323 * Returns: reference to the control FDT
325 static inline oftree oftree_default(void)
329 if (of_live_active())
330 tree.np = gd_of_root();
332 tree.fdt = (void *)gd->fdt_blob;
338 * oftree_from_np() - Returns an oftree from a node pointer
340 * @root: Root node of the tree
341 * Returns: reference to the given node
343 static inline oftree oftree_from_np(struct device_node *root)
353 * ofnode_name_eq() - Check if the node name is equivalent to a given name
354 * ignoring the unit address
356 * @node: valid node reference that has to be compared
357 * @name: name that has to be compared with the node name
358 * Return: true if matches, false if it doesn't match
360 bool ofnode_name_eq(ofnode node, const char *name);
363 * ofnode_read_u8() - Read a 8-bit integer from a property
365 * @node: valid node reference to read property from
366 * @propname: name of the property to read from
367 * @outp: place to put value (if found)
368 * Return: 0 if OK, -ve on error
370 int ofnode_read_u8(ofnode node, const char *propname, u8 *outp);
373 * ofnode_read_u8_default() - Read a 8-bit integer from a property
375 * @node: valid node reference to read property from
376 * @propname: name of the property to read from
377 * @def: default value to return if the property has no value
378 * Return: property value, or @def if not found
380 u8 ofnode_read_u8_default(ofnode node, const char *propname, u8 def);
383 * ofnode_read_u16() - Read a 16-bit integer from a property
385 * @node: valid node reference to read property from
386 * @propname: name of the property to read from
387 * @outp: place to put value (if found)
388 * Return: 0 if OK, -ve on error
390 int ofnode_read_u16(ofnode node, const char *propname, u16 *outp);
393 * ofnode_read_u16_default() - Read a 16-bit integer from a property
395 * @node: valid node reference to read property from
396 * @propname: name of the property to read from
397 * @def: default value to return if the property has no value
398 * Return: property value, or @def if not found
400 u16 ofnode_read_u16_default(ofnode node, const char *propname, u16 def);
403 * ofnode_read_u32() - Read a 32-bit integer from a property
405 * @node: valid node reference to read property from
406 * @propname: name of the property to read from
407 * @outp: place to put value (if found)
408 * Return: 0 if OK, -ve on error
410 int ofnode_read_u32(ofnode node, const char *propname, u32 *outp);
413 * ofnode_read_u32_index() - Read a 32-bit integer from a multi-value property
415 * @node: valid node reference to read property from
416 * @propname: name of the property to read from
417 * @index: index of the integer to return
418 * @outp: place to put value (if found)
419 * Return: 0 if OK, -ve on error
421 int ofnode_read_u32_index(ofnode node, const char *propname, int index,
425 * ofnode_read_s32() - Read a 32-bit integer from a property
427 * @node: valid node reference to read property from
428 * @propname: name of the property to read from
429 * @outp: place to put value (if found)
430 * Return: 0 if OK, -ve on error
432 static inline int ofnode_read_s32(ofnode node, const char *propname,
435 return ofnode_read_u32(node, propname, (u32 *)outp);
439 * ofnode_read_u32_default() - Read a 32-bit integer from a property
441 * @node: valid node reference to read property from
442 * @propname: name of the property to read from
443 * @def: default value to return if the property has no value
444 * Return: property value, or @def if not found
446 u32 ofnode_read_u32_default(ofnode node, const char *propname, u32 def);
449 * ofnode_read_u32_index_default() - Read a 32-bit integer from a multi-value
452 * @node: valid node reference to read property from
453 * @propname: name of the property to read from
454 * @index: index of the integer to return
455 * @def: default value to return if the property has no value
456 * Return: property value, or @def if not found
458 u32 ofnode_read_u32_index_default(ofnode node, const char *propname, int index,
462 * ofnode_read_s32_default() - Read a 32-bit integer from a property
464 * @node: valid node reference to read property from
465 * @propname: name of the property to read from
466 * @def: default value to return if the property has no value
467 * Return: property value, or @def if not found
469 int ofnode_read_s32_default(ofnode node, const char *propname, s32 def);
472 * ofnode_read_u64() - Read a 64-bit integer from a property
474 * @node: valid node reference to read property from
475 * @propname: name of the property to read from
476 * @outp: place to put value (if found)
477 * Return: 0 if OK, -ve on error
479 int ofnode_read_u64(ofnode node, const char *propname, u64 *outp);
482 * ofnode_read_u64_default() - Read a 64-bit integer from a property
484 * @node: valid node reference to read property from
485 * @propname: name of the property to read from
486 * @def: default value to return if the property has no value
487 * Return: property value, or @def if not found
489 u64 ofnode_read_u64_default(ofnode node, const char *propname, u64 def);
492 * ofnode_read_prop() - Read a property from a node
494 * @node: valid node reference to read property from
495 * @propname: name of the property to read
496 * @sizep: if non-NULL, returns the size of the property, or an error code
498 * Return: property value, or NULL if there is no such property
500 const void *ofnode_read_prop(ofnode node, const char *propname, int *sizep);
503 * ofnode_read_string() - Read a string from a property
505 * @node: valid node reference to read property from
506 * @propname: name of the property to read
507 * Return: string from property value, or NULL if there is no such property
509 const char *ofnode_read_string(ofnode node, const char *propname);
512 * ofnode_read_u32_array() - Find and read an array of 32 bit integers
514 * @node: valid node reference to read property from
515 * @propname: name of the property to read
516 * @out_values: pointer to return value, modified only if return value is 0
517 * @sz: number of array elements to read
518 * Return: 0 on success, -EINVAL if the property does not exist,
519 * -ENODATA if property does not have a value, and -EOVERFLOW if the
520 * property data isn't large enough
522 * Search for a property in a device node and read 32-bit value(s) from
525 * The out_values is modified only if a valid u32 value can be decoded.
527 int ofnode_read_u32_array(ofnode node, const char *propname,
528 u32 *out_values, size_t sz);
531 * ofnode_read_bool() - read a boolean value from a property
533 * @node: valid node reference to read property from
534 * @propname: name of property to read
535 * Return: true if property is present (meaning true), false if not present
537 bool ofnode_read_bool(ofnode node, const char *propname);
540 * ofnode_find_subnode() - find a named subnode of a parent node
542 * @node: valid reference to parent node
543 * @subnode_name: name of subnode to find
544 * Return: reference to subnode (which can be invalid if there is no such
547 ofnode ofnode_find_subnode(ofnode node, const char *subnode_name);
549 #if CONFIG_IS_ENABLED(DM_INLINE_OFNODE)
550 #include <asm/global_data.h>
552 static inline bool ofnode_is_enabled(ofnode node)
554 if (ofnode_is_np(node)) {
555 return of_device_is_available(ofnode_to_np(node));
557 return fdtdec_get_is_enabled(gd->fdt_blob,
558 ofnode_to_offset(node));
562 static inline ofnode ofnode_first_subnode(ofnode node)
564 assert(ofnode_valid(node));
565 if (ofnode_is_np(node))
566 return np_to_ofnode(node.np->child);
568 return offset_to_ofnode(
569 fdt_first_subnode(gd->fdt_blob, ofnode_to_offset(node)));
572 static inline ofnode ofnode_next_subnode(ofnode node)
574 assert(ofnode_valid(node));
575 if (ofnode_is_np(node))
576 return np_to_ofnode(node.np->sibling);
578 return offset_to_ofnode(
579 fdt_next_subnode(gd->fdt_blob, ofnode_to_offset(node)));
583 * ofnode_is_enabled() - Checks whether a node is enabled.
584 * This looks for a 'status' property. If this exists, then returns true if
585 * the status is 'okay' and false otherwise. If there is no status property,
586 * it returns true on the assumption that anything mentioned should be enabled
589 * @node: node to examine
590 * Return: false (not enabled) or true (enabled)
592 bool ofnode_is_enabled(ofnode node);
595 * ofnode_first_subnode() - find the first subnode of a parent node
597 * @node: valid reference to a valid parent node
598 * Return: reference to the first subnode (which can be invalid if the parent
599 * node has no subnodes)
601 ofnode ofnode_first_subnode(ofnode node);
604 * ofnode_next_subnode() - find the next sibling of a subnode
606 * @node: valid reference to previous node (sibling)
607 * Return: reference to the next subnode (which can be invalid if the node
608 * has no more siblings)
610 ofnode ofnode_next_subnode(ofnode node);
611 #endif /* DM_INLINE_OFNODE */
614 * ofnode_get_parent() - get the ofnode's parent (enclosing ofnode)
616 * @node: valid node to look up
617 * Return: ofnode reference of the parent node
619 ofnode ofnode_get_parent(ofnode node);
622 * ofnode_get_name() - get the name of a node
624 * @node: valid node to look up
625 * Return: name of node (for the root node this is "")
627 const char *ofnode_get_name(ofnode node);
630 * ofnode_get_path() - get the full path of a node
632 * @node: valid node to look up
633 * @buf: buffer to write the node path into
634 * @buflen: buffer size
635 * Return: 0 if OK, -ve on error
637 int ofnode_get_path(ofnode node, char *buf, int buflen);
640 * ofnode_get_by_phandle() - get ofnode from phandle
642 * This uses the default (control) device tree
644 * @phandle: phandle to look up
645 * Return: ofnode reference to the phandle
647 ofnode ofnode_get_by_phandle(uint phandle);
650 * oftree_get_by_phandle() - get ofnode from phandle
653 * @phandle: phandle to look up
654 * Return: ofnode reference to the phandle
656 ofnode oftree_get_by_phandle(oftree tree, uint phandle);
659 * ofnode_read_size() - read the size of a property
661 * @node: node to check
662 * @propname: property to check
663 * Return: size of property if present, or -EINVAL if not
665 int ofnode_read_size(ofnode node, const char *propname);
668 * ofnode_get_addr_size_index() - get an address/size from a node
671 * This reads the register address/size from a node based on index
673 * @node: node to read from
674 * @index: Index of address to read (0 for first)
675 * @size: Pointer to size of the address
676 * Return: address, or FDT_ADDR_T_NONE if not present or invalid
678 phys_addr_t ofnode_get_addr_size_index(ofnode node, int index,
682 * ofnode_get_addr_size_index_notrans() - get an address/size from a node
683 * based on index, without address
686 * This reads the register address/size from a node based on index.
687 * The resulting address is not translated. Useful for example for on-disk
690 * @node: node to read from
691 * @index: Index of address to read (0 for first)
692 * @size: Pointer to size of the address
693 * Return: address, or FDT_ADDR_T_NONE if not present or invalid
695 phys_addr_t ofnode_get_addr_size_index_notrans(ofnode node, int index,
699 * ofnode_get_addr_index() - get an address from a node
701 * This reads the register address from a node
703 * @node: node to read from
704 * @index: Index of address to read (0 for first)
705 * Return: address, or FDT_ADDR_T_NONE if not present or invalid
707 phys_addr_t ofnode_get_addr_index(ofnode node, int index);
710 * ofnode_get_addr() - get an address from a node
712 * This reads the register address from a node
714 * @node: node to read from
715 * Return: address, or FDT_ADDR_T_NONE if not present or invalid
717 phys_addr_t ofnode_get_addr(ofnode node);
720 * ofnode_get_size() - get size from a node
722 * This reads the register size from a node
724 * @node: node to read from
725 * Return: size of the address, or FDT_SIZE_T_NONE if not present or invalid
727 fdt_size_t ofnode_get_size(ofnode node);
730 * ofnode_stringlist_search() - find a string in a string list and return index
732 * Note that it is possible for this function to succeed on property values
733 * that are not NUL-terminated. That's because the function will stop after
734 * finding the first occurrence of @string. This can for example happen with
735 * small-valued cell properties, such as #address-cells, when searching for
738 * @node: node to check
739 * @propname: name of the property containing the string list
740 * @string: string to look up in the string list
743 * the index of the string in the list of strings
744 * -ENODATA if the property is not found
745 * -EINVAL on some other error
747 int ofnode_stringlist_search(ofnode node, const char *propname,
751 * ofnode_read_string_index() - obtain an indexed string from a string list
753 * Note that this will successfully extract strings from properties with
754 * non-NUL-terminated values. For example on small-valued cell properties
755 * this function will return the empty string.
757 * If non-NULL, the length of the string (on success) or a negative error-code
758 * (on failure) will be stored in the integer pointer to by lenp.
760 * @node: node to check
761 * @propname: name of the property containing the string list
762 * @index: index of the string to return (cannot be negative)
763 * @outp: return location for the string
766 * 0 if found or -ve error value if not found
768 int ofnode_read_string_index(ofnode node, const char *propname, int index,
772 * ofnode_read_string_count() - find the number of strings in a string list
774 * @node: node to check
775 * @property: name of the property containing the string list
777 * number of strings in the list, or -ve error value if not found
779 int ofnode_read_string_count(ofnode node, const char *property);
782 * ofnode_read_string_list() - read a list of strings
784 * This produces a list of string pointers with each one pointing to a string
785 * in the string list. If the property does not exist, it returns {NULL}.
787 * The data is allocated and the caller is reponsible for freeing the return
788 * value (the list of string pointers). The strings themselves may not be
789 * changed as they point directly into the devicetree property.
791 * @node: node to check
792 * @property: name of the property containing the string list
793 * @listp: returns an allocated, NULL-terminated list of strings if the return
794 * value is > 0, else is set to NULL
796 * number of strings in list, 0 if none, -ENOMEM if out of memory,
797 * -EINVAL if no such property, -EENODATA if property is empty
799 int ofnode_read_string_list(ofnode node, const char *property,
800 const char ***listp);
803 * ofnode_parse_phandle_with_args() - Find a node pointed by phandle in a list
805 * This function is useful to parse lists of phandles and their arguments.
806 * Returns 0 on success and fills out_args, on error returns appropriate
809 * Caller is responsible to call of_node_put() on the returned out_args->np
823 * list = <&phandle1 1 2 &phandle2 3>;
826 * To get a device_node of the `node2' node you may call this:
827 * ofnode_parse_phandle_with_args(node3, "list", "#list-cells", 0, 1, &args);
829 * @node: device tree node containing a list
830 * @list_name: property name that contains a list
831 * @cells_name: property name that specifies phandles' arguments count
832 * @cell_count: Cell count to use if @cells_name is NULL
833 * @index: index of a phandle to parse out
834 * @out_args: optional pointer to output arguments structure (will be filled)
836 * 0 on success (with @out_args filled out if not NULL), -ENOENT if
837 * @list_name does not exist, -EINVAL if a phandle was not found,
838 * @cells_name could not be found, the arguments were truncated or there
839 * were too many arguments.
841 int ofnode_parse_phandle_with_args(ofnode node, const char *list_name,
842 const char *cells_name, int cell_count,
844 struct ofnode_phandle_args *out_args);
847 * ofnode_count_phandle_with_args() - Count number of phandle in a list
849 * This function is useful to count phandles into a list.
850 * Returns number of phandle on success, on error returns appropriate
853 * @node: device tree node containing a list
854 * @list_name: property name that contains a list
855 * @cells_name: property name that specifies phandles' arguments count
856 * @cell_count: Cell count to use if @cells_name is NULL
858 * number of phandle on success, -ENOENT if @list_name does not exist,
859 * -EINVAL if a phandle was not found, @cells_name could not be found.
861 int ofnode_count_phandle_with_args(ofnode node, const char *list_name,
862 const char *cells_name, int cell_count);
865 * ofnode_path() - find a node by full path
867 * This uses the control FDT.
869 * @path: Full path to node, e.g. "/bus/spi@1"
870 * Return: reference to the node found. Use ofnode_valid() to check if it exists
872 ofnode ofnode_path(const char *path);
875 * oftree_path() - find a node by full path from a root node
877 * @tree: Device tree to use
878 * @path: Full path to node, e.g. "/bus/spi@1"
879 * Return: reference to the node found. Use ofnode_valid() to check if it exists
881 ofnode oftree_path(oftree tree, const char *path);
884 * oftree_root() - get the root node of a tree
886 * @tree: Device tree to use
887 * Return: reference to the root node
889 ofnode oftree_root(oftree tree);
892 * ofnode_read_chosen_prop() - get the value of a chosen property
894 * This looks for a property within the /chosen node and returns its value.
896 * This only works with the control FDT.
898 * @propname: Property name to look for
899 * @sizep: Returns size of property, or `FDT_ERR_...` error code if function
901 * Return: property value if found, else NULL
903 const void *ofnode_read_chosen_prop(const char *propname, int *sizep);
906 * ofnode_read_chosen_string() - get the string value of a chosen property
908 * This looks for a property within the /chosen node and returns its value,
909 * checking that it is a valid nul-terminated string
911 * This only works with the control FDT.
913 * @propname: Property name to look for
914 * Return: string value if found, else NULL
916 const char *ofnode_read_chosen_string(const char *propname);
919 * ofnode_get_chosen_node() - get a referenced node from the chosen node
921 * This looks up a named property in the chosen node and uses that as a path to
924 * This only works with the control FDT.
926 * @propname: Property name to look for
927 * Return: the referenced node if present, else ofnode_null()
929 ofnode ofnode_get_chosen_node(const char *propname);
932 * ofnode_read_aliases_prop() - get the value of a aliases property
934 * This looks for a property within the /aliases node and returns its value
936 * This only works with the control FDT.
938 * @propname: Property name to look for
939 * @sizep: Returns size of property, or `FDT_ERR_...` error code if function
941 * Return: property value if found, else NULL
943 const void *ofnode_read_aliases_prop(const char *propname, int *sizep);
946 * ofnode_get_aliases_node() - get a referenced node from the aliases node
948 * This looks up a named property in the aliases node and uses that as a path to
951 * This only works with the control FDT.
953 * @propname: Property name to look for
954 * Return: the referenced node if present, else ofnode_null()
956 ofnode ofnode_get_aliases_node(const char *propname);
958 struct display_timing;
960 * ofnode_decode_display_timing() - decode display timings
962 * Decode display timings from the supplied 'display-timings' node.
963 * See doc/device-tree-bindings/video/display-timing.txt for binding
966 * @node: 'display-timing' node containing the timing subnodes
967 * @index: Index number to read (0=first timing subnode)
968 * @config: Place to put timings
969 * Return: 0 if OK, -FDT_ERR_NOTFOUND if not found
971 int ofnode_decode_display_timing(ofnode node, int index,
972 struct display_timing *config);
975 * ofnode_get_property() - get a pointer to the value of a node property
977 * @node: node to read
978 * @propname: property to read
979 * @lenp: place to put length on success
980 * Return: pointer to property, or NULL if not found
982 const void *ofnode_get_property(ofnode node, const char *propname, int *lenp);
985 * ofnode_first_property()- get the reference of the first property
987 * Get reference to the first property of the node, it is used to iterate
988 * and read all the property with ofprop_get_property().
990 * @node: node to read
991 * @prop: place to put argument reference
992 * Return: 0 if OK, -ve on error. -FDT_ERR_NOTFOUND if not found
994 int ofnode_first_property(ofnode node, struct ofprop *prop);
997 * ofnode_next_property() - get the reference of the next property
999 * Get reference to the next property of the node, it is used to iterate
1000 * and read all the property with ofprop_get_property().
1002 * @prop: reference of current argument and place to put reference of next one
1003 * Return: 0 if OK, -ve on error. -FDT_ERR_NOTFOUND if not found
1005 int ofnode_next_property(struct ofprop *prop);
1008 * ofnode_for_each_prop() - iterate over all properties of a node
1010 * @prop: struct ofprop
1011 * @node: node (lvalue, ofnode)
1013 * This is a wrapper around a for loop and is used like this::
1016 * struct ofprop prop;
1018 * ofnode_for_each_prop(prop, node) {
1022 * Note that this is implemented as a macro and @prop is used as
1023 * iterator in the loop. The parent variable can be a constant or even a
1026 #define ofnode_for_each_prop(prop, node) \
1027 for (ofnode_first_property(node, &prop); \
1028 ofprop_valid(&prop); \
1029 ofnode_next_property(&prop))
1032 * ofprop_get_property() - get a pointer to the value of a property
1034 * Get value for the property identified by the provided reference.
1036 * @prop: reference on property
1037 * @propname: If non-NULL, place to property name on success,
1038 * @lenp: If non-NULL, place to put length on success, or error code on failure
1039 * Return: pointer to property, or NULL if not found
1041 const void *ofprop_get_property(const struct ofprop *prop,
1042 const char **propname, int *lenp);
1045 * ofnode_get_addr_size() - get address and size from a property
1047 * This does no address translation. It simply reads an property that contains
1048 * an address and a size value, one after the other.
1050 * @node: node to read from
1051 * @propname: property to read
1052 * @sizep: place to put size value (on success)
1053 * Return: address value, or FDT_ADDR_T_NONE on error
1055 phys_addr_t ofnode_get_addr_size(ofnode node, const char *propname,
1056 phys_size_t *sizep);
1059 * ofnode_read_u8_array_ptr() - find an 8-bit array
1061 * Look up a property in a node and return a pointer to its contents as a
1062 * byte array of given length. The property must have at least enough data
1063 * for the array (count bytes). It may have more, but this will be ignored.
1064 * The data is not copied.
1066 * @node: node to examine
1067 * @propname: name of property to find
1068 * @sz: number of array elements
1070 * pointer to byte array if found, or NULL if the property is not found or
1071 * there is not enough data
1073 const uint8_t *ofnode_read_u8_array_ptr(ofnode node, const char *propname,
1077 * ofnode_read_pci_addr() - look up a PCI address
1079 * Look at an address property in a node and return the PCI address which
1080 * corresponds to the given type in the form of fdt_pci_addr.
1081 * The property must hold one fdt_pci_addr with a lengh.
1083 * @node: node to examine
1084 * @type: pci address type (FDT_PCI_SPACE_xxx)
1085 * @propname: name of property to find
1086 * @addr: returns pci address in the form of fdt_pci_addr
1088 * 0 if ok, -ENOENT if the property did not exist, -EINVAL if the
1089 * format of the property was invalid, -ENXIO if the requested
1090 * address type was not found
1092 int ofnode_read_pci_addr(ofnode node, enum fdt_pci_space type,
1093 const char *propname, struct fdt_pci_addr *addr);
1096 * ofnode_read_pci_vendev() - look up PCI vendor and device id
1098 * Look at the compatible property of a device node that represents a PCI
1099 * device and extract pci vendor id and device id from it.
1101 * @node: node to examine
1102 * @vendor: vendor id of the pci device
1103 * @device: device id of the pci device
1104 * Return: 0 if ok, negative on error
1106 int ofnode_read_pci_vendev(ofnode node, u16 *vendor, u16 *device);
1109 * ofnode_read_eth_phy_id() - look up eth phy vendor and device id
1111 * Look at the compatible property of a device node that represents a eth phy
1112 * device and extract phy vendor id and device id from it.
1114 * @node: node to examine
1115 * @vendor: vendor id of the eth phy device
1116 * @device: device id of the eth phy device
1117 * Return: 0 if ok, negative on error
1119 int ofnode_read_eth_phy_id(ofnode node, u16 *vendor, u16 *device);
1122 * ofnode_read_addr_cells() - Get the number of address cells for a node
1124 * This walks back up the tree to find the closest #address-cells property
1125 * which controls the given node.
1127 * @node: Node to check
1128 * Return: number of address cells this node uses
1130 int ofnode_read_addr_cells(ofnode node);
1133 * ofnode_read_size_cells() - Get the number of size cells for a node
1135 * This walks back up the tree to find the closest #size-cells property
1136 * which controls the given node.
1138 * @node: Node to check
1139 * Return: number of size cells this node uses
1141 int ofnode_read_size_cells(ofnode node);
1144 * ofnode_read_simple_addr_cells() - Get the address cells property in a node
1146 * This function matches fdt_address_cells().
1148 * @node: Node to check
1149 * Return: value of #address-cells property in this node, or 2 if none
1151 int ofnode_read_simple_addr_cells(ofnode node);
1154 * ofnode_read_simple_size_cells() - Get the size cells property in a node
1156 * This function matches fdt_size_cells().
1158 * @node: Node to check
1159 * Return: value of #size-cells property in this node, or 2 if none
1161 int ofnode_read_simple_size_cells(ofnode node);
1164 * ofnode_pre_reloc() - check if a node should be bound before relocation
1166 * Device tree nodes can be marked as needing-to-be-bound in the loader stages
1167 * via special device tree properties.
1169 * Before relocation this function can be used to check if nodes are required
1170 * in either SPL or TPL stages.
1172 * After relocation and jumping into the real U-Boot binary it is possible to
1173 * determine if a node was bound in one of SPL/TPL stages.
1175 * There are 4 settings currently in use
1176 * - u-boot,dm-pre-proper: U-Boot proper pre-relocation only
1177 * - u-boot,dm-pre-reloc: legacy and indicates any of TPL or SPL
1178 * Existing platforms only use it to indicate nodes needed in
1179 * SPL. Should probably be replaced by u-boot,dm-spl for new platforms.
1180 * - u-boot,dm-spl: SPL and U-Boot pre-relocation
1181 * - u-boot,dm-tpl: TPL and U-Boot pre-relocation
1183 * @node: node to check
1184 * Return: true if node is needed in SPL/TL, false otherwise
1186 bool ofnode_pre_reloc(ofnode node);
1189 * ofnode_read_resource() - Read a resource from a node
1191 * Read resource information from a node at the given index
1193 * @node: Node to read from
1194 * @index: Index of resource to read (0 = first)
1195 * @res: Returns resource that was read, on success
1196 * Return: 0 if OK, -ve on error
1198 int ofnode_read_resource(ofnode node, uint index, struct resource *res);
1201 * ofnode_read_resource_byname() - Read a resource from a node by name
1203 * Read resource information from a node matching the given name. This uses a
1204 * 'reg-names' string list property with the names matching the associated
1205 * 'reg' property list.
1207 * @node: Node to read from
1208 * @name: Name of resource to read
1209 * @res: Returns resource that was read, on success
1210 * Return: 0 if OK, -ve on error
1212 int ofnode_read_resource_byname(ofnode node, const char *name,
1213 struct resource *res);
1216 * ofnode_by_compatible() - Find the next compatible node
1218 * Find the next node after @from that is compatible with @compat
1220 * @from: ofnode to start from (use ofnode_null() to start at the beginning)
1221 * @compat: Compatible string to match
1222 * Return: ofnode found, or ofnode_null() if none
1224 ofnode ofnode_by_compatible(ofnode from, const char *compat);
1227 * ofnode_by_prop_value() - Find the next node with given property value
1229 * Find the next node after @from that has a @propname with a value
1230 * @propval and a length @proplen.
1232 * @from: ofnode to start from. Use ofnode_null() to start at the
1233 * beginning, or the return value from oftree_root() to start at the first
1235 * @propname: property name to check
1236 * @propval: property value to search for
1237 * @proplen: length of the value in propval
1238 * Return: ofnode found, or ofnode_null() if none
1240 ofnode ofnode_by_prop_value(ofnode from, const char *propname,
1241 const void *propval, int proplen);
1244 * ofnode_for_each_subnode() - iterate over all subnodes of a parent
1246 * @node: child node (ofnode, lvalue)
1247 * @parent: parent node (ofnode)
1249 * This is a wrapper around a for loop and is used like so::
1252 * ofnode_for_each_subnode(node, parent) {
1257 * Note that this is implemented as a macro and @node is used as
1258 * iterator in the loop. The parent variable can be a constant or even a
1261 #define ofnode_for_each_subnode(node, parent) \
1262 for (node = ofnode_first_subnode(parent); \
1263 ofnode_valid(node); \
1264 node = ofnode_next_subnode(node))
1267 * ofnode_for_each_compatible_node() - iterate over all nodes with a given
1270 * @node: child node (ofnode, lvalue)
1271 * @compat: compatible string to match
1273 * This is a wrapper around a for loop and is used like so::
1276 * ofnode_for_each_compatible_node(node, parent, compatible) {
1281 * Note that this is implemented as a macro and @node is used as
1282 * iterator in the loop.
1284 #define ofnode_for_each_compatible_node(node, compat) \
1285 for (node = ofnode_by_compatible(ofnode_null(), compat); \
1286 ofnode_valid(node); \
1287 node = ofnode_by_compatible(node, compat))
1290 * ofnode_get_child_count() - get the child count of a ofnode
1292 * @parent: valid node to get its child count
1293 * Return: the number of subnodes
1295 int ofnode_get_child_count(ofnode parent);
1298 * ofnode_translate_address() - Translate a device-tree address
1300 * Translate an address from the device-tree into a CPU physical address. This
1301 * function walks up the tree and applies the various bus mappings along the
1304 * @node: Device tree node giving the context in which to translate the address
1305 * @in_addr: pointer to the address to translate
1306 * Return: the translated address; OF_BAD_ADDR on error
1308 u64 ofnode_translate_address(ofnode node, const fdt32_t *in_addr);
1311 * ofnode_translate_dma_address() - Translate a device-tree DMA address
1313 * Translate a DMA address from the device-tree into a CPU physical address.
1314 * This function walks up the tree and applies the various bus mappings along
1317 * @node: Device tree node giving the context in which to translate the
1319 * @in_addr: pointer to the DMA address to translate
1320 * Return: the translated DMA address; OF_BAD_ADDR on error
1322 u64 ofnode_translate_dma_address(ofnode node, const fdt32_t *in_addr);
1325 * ofnode_get_dma_range() - get dma-ranges for a specific DT node
1327 * Get DMA ranges for a specifc node, this is useful to perform bus->cpu and
1328 * cpu->bus address translations
1330 * @node: Device tree node
1331 * @cpu: Pointer to variable storing the range's cpu address
1332 * @bus: Pointer to variable storing the range's bus address
1333 * @size: Pointer to variable storing the range's size
1334 * Return: translated DMA address or OF_BAD_ADDR on error
1336 int ofnode_get_dma_range(ofnode node, phys_addr_t *cpu, dma_addr_t *bus,
1340 * ofnode_device_is_compatible() - check if the node is compatible with compat
1342 * This allows to check whether the node is comaptible with the compat.
1344 * @node: Device tree node for which compatible needs to be verified.
1345 * @compat: Compatible string which needs to verified in the given node.
1346 * Return: true if OK, false if the compatible is not found
1348 int ofnode_device_is_compatible(ofnode node, const char *compat);
1351 * ofnode_write_prop() - Set a property of a ofnode
1353 * Note that the value passed to the function is *not* allocated by the
1354 * function itself, but must be allocated by the caller if necessary. However
1355 * it does allocate memory for the property struct and name.
1357 * @node: The node for whose property should be set
1358 * @propname: The name of the property to set
1359 * @value: The new value of the property (must be valid prior to calling
1361 * @len: The length of the new value of the property
1362 * Return: 0 if successful, -ve on error
1364 int ofnode_write_prop(ofnode node, const char *propname, const void *value,
1368 * ofnode_write_string() - Set a string property of a ofnode
1370 * Note that the value passed to the function is *not* allocated by the
1371 * function itself, but must be allocated by the caller if necessary.
1373 * @node: The node for whose string property should be set
1374 * @propname: The name of the string property to set
1375 * @value: The new value of the string property (must be valid prior to
1376 * calling the function)
1377 * Return: 0 if successful, -ve on error
1379 int ofnode_write_string(ofnode node, const char *propname, const char *value);
1382 * ofnode_write_u32() - Set an integer property of an ofnode
1384 * @node: The node for whose string property should be set
1385 * @propname: The name of the string property to set
1386 * @value: The new value of the 32-bit integer property
1387 * Return: 0 if successful, -ve on error
1389 int ofnode_write_u32(ofnode node, const char *propname, u32 value);
1392 * ofnode_set_enabled() - Enable or disable a device tree node given by its
1395 * This function effectively sets the node's "status" property to either "okay"
1396 * or "disable", hence making it available for driver model initialization or
1399 * @node: The node to enable
1400 * @value: Flag that tells the function to either disable or enable the
1402 * Return: 0 if successful, -ve on error
1404 int ofnode_set_enabled(ofnode node, bool value);
1407 * ofnode_get_phy_node() - Get PHY node for a MAC (if not fixed-link)
1409 * This function parses PHY handle from the Ethernet controller's ofnode
1410 * (trying all possible PHY handle property names), and returns the PHY ofnode.
1412 * Before this is used, ofnode_phy_is_fixed_link() should be checked first, and
1413 * if the result to that is true, this function should not be called.
1415 * @eth_node: ofnode belonging to the Ethernet controller
1416 * Return: ofnode of the PHY, if it exists, otherwise an invalid ofnode
1418 ofnode ofnode_get_phy_node(ofnode eth_node);
1421 * ofnode_read_phy_mode() - Read PHY connection type from a MAC node
1423 * This function parses the "phy-mode" / "phy-connection-type" property and
1424 * returns the corresponding PHY interface type.
1426 * @mac_node: ofnode containing the property
1427 * Return: one of PHY_INTERFACE_MODE_* constants, PHY_INTERFACE_MODE_NA on
1430 phy_interface_t ofnode_read_phy_mode(ofnode mac_node);
1432 #if CONFIG_IS_ENABLED(DM)
1434 * ofnode_conf_read_bool() - Read a boolean value from the U-Boot config
1436 * This reads a property from the /config node of the devicetree.
1438 * This only works with the control FDT.
1440 * See doc/device-tree-bindings/config.txt for bindings
1442 * @prop_name: property name to look up
1443 * Return: true, if it exists, false if not
1445 bool ofnode_conf_read_bool(const char *prop_name);
1448 * ofnode_conf_read_int() - Read an integer value from the U-Boot config
1450 * This reads a property from the /config node of the devicetree.
1452 * See doc/device-tree-bindings/config.txt for bindings
1454 * @prop_name: property name to look up
1455 * @default_val: default value to return if the property is not found
1456 * Return: integer value, if found, or @default_val if not
1458 int ofnode_conf_read_int(const char *prop_name, int default_val);
1461 * ofnode_conf_read_str() - Read a string value from the U-Boot config
1463 * This reads a property from the /config node of the devicetree.
1465 * This only works with the control FDT.
1467 * See doc/device-tree-bindings/config.txt for bindings
1469 * @prop_name: property name to look up
1470 * Return: string value, if found, or NULL if not
1472 const char *ofnode_conf_read_str(const char *prop_name);
1474 #else /* CONFIG_DM */
1475 static inline bool ofnode_conf_read_bool(const char *prop_name)
1480 static inline int ofnode_conf_read_int(const char *prop_name, int default_val)
1485 static inline const char *ofnode_conf_read_str(const char *prop_name)
1490 #endif /* CONFIG_DM */
1493 * of_add_subnode() - add a new subnode to a node
1495 * @parent: parent node to add to
1496 * @name: name of subnode
1497 * @nodep: returns pointer to new subnode (valid if the function returns 0
1499 * Returns 0 if OK, -EEXIST if already exists, -ENOMEM if out of memory, other
1500 * -ve on other error
1502 int ofnode_add_subnode(ofnode parent, const char *name, ofnode *nodep);