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];
31 * oftree_reset() - reset the state of the oftree list
33 * Reset the oftree list so it can be started again. This should be called
34 * once the control FDT is in place, but before the ofnode interface is used.
36 static inline void oftree_reset(void) {}
39 * ofnode_to_fdt() - convert an ofnode to a flat DT pointer
41 * This cannot be called if the reference contains a node pointer.
43 * @node: Reference containing offset (possibly invalid)
44 * Return: DT offset (can be NULL)
46 static inline void *ofnode_to_fdt(ofnode node)
53 /* Use the control FDT by default */
54 return (void *)gd->fdt_blob;
58 * ofnode_to_np() - convert an ofnode to a live DT node pointer
60 * This cannot be called if the reference contains an offset.
62 * @node: Reference containing struct device_node * (possibly invalid)
63 * Return: pointer to device node (can be NULL)
65 static inline struct device_node *ofnode_to_np(ofnode node)
68 if (!of_live_active())
75 * ofnode_to_offset() - convert an ofnode to a flat DT offset
77 * This cannot be called if the reference contains a node pointer.
79 * @node: Reference containing offset (possibly invalid)
80 * Return: DT offset (can be -1)
82 static inline int ofnode_to_offset(ofnode node)
88 return node.of_offset;
92 * ofnode_valid() - check if an ofnode is valid
94 * @node: Reference containing offset (possibly invalid)
95 * Return: true if the reference contains a valid ofnode, false if it is NULL
97 static inline bool ofnode_valid(ofnode node)
100 return node.np != NULL;
102 return node.of_offset >= 0;
106 * oftree_lookup_fdt() - obtain the FDT pointer from an oftree
108 * This can only be called when flat tree is enabled
110 * @tree: Tree to look at
111 * @return FDT pointer from the tree
113 static inline void *oftree_lookup_fdt(oftree tree)
115 if (of_live_active())
122 * offset_to_ofnode() - convert a DT offset to an ofnode
124 * @of_offset: DT offset (either valid, or -1)
125 * Return: reference to the associated DT offset
127 static inline ofnode offset_to_ofnode(int of_offset)
131 if (of_live_active())
134 node.of_offset = of_offset >= 0 ? of_offset : -1;
140 * np_to_ofnode() - convert a node pointer to an ofnode
142 * @np: Live node pointer (can be NULL)
143 * Return: reference to the associated node pointer
145 static inline ofnode np_to_ofnode(struct device_node *np)
155 * ofnode_is_np() - check if a reference is a node pointer
157 * This function associated that if there is a valid live tree then all
158 * references will use it. This is because using the flat DT when the live tree
159 * is valid is not permitted.
161 * @node: reference to check (possibly invalid)
162 * Return: true if the reference is a live node pointer, false if it is a DT
165 static inline bool ofnode_is_np(ofnode node)
169 * Check our assumption that flat tree offsets are not used when a
170 * live tree is in use.
172 assert(!ofnode_valid(node) ||
173 (of_live_active() ? ofnode_to_np(node)
174 : ofnode_to_np(node)));
176 return of_live_active() && ofnode_valid(node);
180 * ofnode_equal() - check if two references are equal
182 * @ref1: first reference to check (possibly invalid)
183 * @ref2: second reference to check (possibly invalid)
184 * Return: true if equal, else false
186 static inline bool ofnode_equal(ofnode ref1, ofnode ref2)
188 /* We only need to compare the contents */
189 return ref1.of_offset == ref2.of_offset;
193 * oftree_valid() - check if an oftree is valid
195 * @tree: Reference containing oftree
196 * Return: true if the reference contains a valid oftree, false if node
198 static inline bool oftree_valid(oftree tree)
200 if (of_live_active())
207 * oftree_null() - Obtain a null oftree
209 * This returns an oftree which points to no tree. It works both with the flat
212 static inline oftree oftree_null(void)
216 if (of_live_active())
225 * ofnode_null() - Obtain a null ofnode
227 * This returns an ofnode which points to no node. It works both with the flat
230 static inline ofnode ofnode_null(void)
234 if (of_live_active())
242 static inline ofnode ofnode_root(void)
246 if (of_live_active())
247 node.np = gd_of_root();
255 * ofprop_valid() - check if an ofprop is valid
257 * @prop: Pointer to ofprop to check
258 * Return: true if the reference contains a valid ofprop, false if not
260 static inline bool ofprop_valid(struct ofprop *prop)
262 if (of_live_active())
265 return prop->offset >= 0;
269 * oftree_default() - Returns the default device tree (U-Boot's control FDT)
271 * Returns: reference to the control FDT
273 static inline oftree oftree_default(void)
277 if (of_live_active())
278 tree.np = gd_of_root();
280 tree.fdt = (void *)gd->fdt_blob;
286 * oftree_from_np() - Returns an oftree from a node pointer
288 * @root: Root node of the tree
289 * Returns: reference to the given node
291 static inline oftree oftree_from_np(struct device_node *root)
301 * oftree_from_fdt() - Returns an oftree from a flat device tree pointer
303 * @fdt: Device tree to use
305 * Returns: reference to the given node
307 static inline oftree oftree_from_fdt(void *fdt)
317 * ofnode_name_eq() - Check if the node name is equivalent to a given name
318 * ignoring the unit address
320 * @node: valid node reference that has to be compared
321 * @name: name that has to be compared with the node name
322 * Return: true if matches, false if it doesn't match
324 bool ofnode_name_eq(ofnode node, const char *name);
327 * ofnode_read_u8() - Read a 8-bit integer from a property
329 * @node: valid node reference to read property from
330 * @propname: name of the property to read from
331 * @outp: place to put value (if found)
332 * Return: 0 if OK, -ve on error
334 int ofnode_read_u8(ofnode node, const char *propname, u8 *outp);
337 * ofnode_read_u8_default() - Read a 8-bit integer from a property
339 * @node: valid node reference to read property from
340 * @propname: name of the property to read from
341 * @def: default value to return if the property has no value
342 * Return: property value, or @def if not found
344 u8 ofnode_read_u8_default(ofnode node, const char *propname, u8 def);
347 * ofnode_read_u16() - Read a 16-bit integer from a property
349 * @node: valid node reference to read property from
350 * @propname: name of the property to read from
351 * @outp: place to put value (if found)
352 * Return: 0 if OK, -ve on error
354 int ofnode_read_u16(ofnode node, const char *propname, u16 *outp);
357 * ofnode_read_u16_default() - Read a 16-bit integer from a property
359 * @node: valid node reference to read property from
360 * @propname: name of the property to read from
361 * @def: default value to return if the property has no value
362 * Return: property value, or @def if not found
364 u16 ofnode_read_u16_default(ofnode node, const char *propname, u16 def);
367 * ofnode_read_u32() - Read a 32-bit integer from a property
369 * @node: valid node reference to read property from
370 * @propname: name of the property to read from
371 * @outp: place to put value (if found)
372 * Return: 0 if OK, -ve on error
374 int ofnode_read_u32(ofnode node, const char *propname, u32 *outp);
377 * ofnode_read_u32_index() - Read a 32-bit integer from a multi-value property
379 * @node: valid node reference to read property from
380 * @propname: name of the property to read from
381 * @index: index of the integer to return
382 * @outp: place to put value (if found)
383 * Return: 0 if OK, -ve on error
385 int ofnode_read_u32_index(ofnode node, const char *propname, int index,
389 * ofnode_read_s32() - Read a 32-bit integer from a property
391 * @node: valid node reference to read property from
392 * @propname: name of the property to read from
393 * @outp: place to put value (if found)
394 * Return: 0 if OK, -ve on error
396 static inline int ofnode_read_s32(ofnode node, const char *propname,
399 return ofnode_read_u32(node, propname, (u32 *)outp);
403 * ofnode_read_u32_default() - 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 * @def: default value to return if the property has no value
408 * Return: property value, or @def if not found
410 u32 ofnode_read_u32_default(ofnode node, const char *propname, u32 def);
413 * ofnode_read_u32_index_default() - Read a 32-bit integer from a multi-value
416 * @node: valid node reference to read property from
417 * @propname: name of the property to read from
418 * @index: index of the integer to return
419 * @def: default value to return if the property has no value
420 * Return: property value, or @def if not found
422 u32 ofnode_read_u32_index_default(ofnode node, const char *propname, int index,
426 * ofnode_read_s32_default() - Read a 32-bit integer from a property
428 * @node: valid node reference to read property from
429 * @propname: name of the property to read from
430 * @def: default value to return if the property has no value
431 * Return: property value, or @def if not found
433 int ofnode_read_s32_default(ofnode node, const char *propname, s32 def);
436 * ofnode_read_u64() - Read a 64-bit integer from a property
438 * @node: valid node reference to read property from
439 * @propname: name of the property to read from
440 * @outp: place to put value (if found)
441 * Return: 0 if OK, -ve on error
443 int ofnode_read_u64(ofnode node, const char *propname, u64 *outp);
446 * ofnode_read_u64_default() - Read a 64-bit integer from a property
448 * @node: valid node reference to read property from
449 * @propname: name of the property to read from
450 * @def: default value to return if the property has no value
451 * Return: property value, or @def if not found
453 u64 ofnode_read_u64_default(ofnode node, const char *propname, u64 def);
456 * ofnode_read_prop() - Read a property from a node
458 * @node: valid node reference to read property from
459 * @propname: name of the property to read
460 * @sizep: if non-NULL, returns the size of the property, or an error code
462 * Return: property value, or NULL if there is no such property
464 const void *ofnode_read_prop(ofnode node, const char *propname, int *sizep);
467 * ofnode_read_string() - Read a string from a property
469 * @node: valid node reference to read property from
470 * @propname: name of the property to read
471 * Return: string from property value, or NULL if there is no such property
473 const char *ofnode_read_string(ofnode node, const char *propname);
476 * ofnode_read_u32_array() - Find and read an array of 32 bit integers
478 * @node: valid node reference to read property from
479 * @propname: name of the property to read
480 * @out_values: pointer to return value, modified only if return value is 0
481 * @sz: number of array elements to read
482 * Return: 0 on success, -EINVAL if the property does not exist,
483 * -ENODATA if property does not have a value, and -EOVERFLOW if the
484 * property data isn't large enough
486 * Search for a property in a device node and read 32-bit value(s) from
489 * The out_values is modified only if a valid u32 value can be decoded.
491 int ofnode_read_u32_array(ofnode node, const char *propname,
492 u32 *out_values, size_t sz);
495 * ofnode_read_bool() - read a boolean value from a property
497 * @node: valid node reference to read property from
498 * @propname: name of property to read
499 * Return: true if property is present (meaning true), false if not present
501 bool ofnode_read_bool(ofnode node, const char *propname);
504 * ofnode_find_subnode() - find a named subnode of a parent node
506 * @node: valid reference to parent node
507 * @subnode_name: name of subnode to find
508 * Return: reference to subnode (which can be invalid if there is no such
511 ofnode ofnode_find_subnode(ofnode node, const char *subnode_name);
513 #if CONFIG_IS_ENABLED(DM_INLINE_OFNODE)
514 #include <asm/global_data.h>
516 static inline bool ofnode_is_enabled(ofnode node)
518 if (ofnode_is_np(node)) {
519 return of_device_is_available(ofnode_to_np(node));
521 return fdtdec_get_is_enabled(gd->fdt_blob,
522 ofnode_to_offset(node));
526 static inline ofnode ofnode_first_subnode(ofnode node)
528 assert(ofnode_valid(node));
529 if (ofnode_is_np(node))
530 return np_to_ofnode(node.np->child);
532 return offset_to_ofnode(
533 fdt_first_subnode(gd->fdt_blob, ofnode_to_offset(node)));
536 static inline ofnode ofnode_next_subnode(ofnode node)
538 assert(ofnode_valid(node));
539 if (ofnode_is_np(node))
540 return np_to_ofnode(node.np->sibling);
542 return offset_to_ofnode(
543 fdt_next_subnode(gd->fdt_blob, ofnode_to_offset(node)));
547 * ofnode_is_enabled() - Checks whether a node is enabled.
548 * This looks for a 'status' property. If this exists, then returns true if
549 * the status is 'okay' and false otherwise. If there is no status property,
550 * it returns true on the assumption that anything mentioned should be enabled
553 * @node: node to examine
554 * Return: false (not enabled) or true (enabled)
556 bool ofnode_is_enabled(ofnode node);
559 * ofnode_first_subnode() - find the first subnode of a parent node
561 * @node: valid reference to a valid parent node
562 * Return: reference to the first subnode (which can be invalid if the parent
563 * node has no subnodes)
565 ofnode ofnode_first_subnode(ofnode node);
568 * ofnode_next_subnode() - find the next sibling of a subnode
570 * @node: valid reference to previous node (sibling)
571 * Return: reference to the next subnode (which can be invalid if the node
572 * has no more siblings)
574 ofnode ofnode_next_subnode(ofnode node);
575 #endif /* DM_INLINE_OFNODE */
578 * ofnode_get_parent() - get the ofnode's parent (enclosing ofnode)
580 * @node: valid node to look up
581 * Return: ofnode reference of the parent node
583 ofnode ofnode_get_parent(ofnode node);
586 * ofnode_get_name() - get the name of a node
588 * @node: valid node to look up
589 * Return: name of node (for the root node this is "")
591 const char *ofnode_get_name(ofnode node);
594 * ofnode_get_path() - get the full path of a node
596 * @node: valid node to look up
597 * @buf: buffer to write the node path into
598 * @buflen: buffer size
599 * Return: 0 if OK, -ve on error
601 int ofnode_get_path(ofnode node, char *buf, int buflen);
604 * ofnode_get_by_phandle() - get ofnode from phandle
606 * This uses the default (control) device tree
608 * @phandle: phandle to look up
609 * Return: ofnode reference to the phandle
611 ofnode ofnode_get_by_phandle(uint phandle);
614 * oftree_get_by_phandle() - get ofnode from phandle
617 * @phandle: phandle to look up
618 * Return: ofnode reference to the phandle
620 ofnode oftree_get_by_phandle(oftree tree, uint phandle);
623 * ofnode_read_size() - read the size of a property
625 * @node: node to check
626 * @propname: property to check
627 * Return: size of property if present, or -EINVAL if not
629 int ofnode_read_size(ofnode node, const char *propname);
632 * ofnode_get_addr_size_index() - get an address/size from a node
635 * This reads the register address/size from a node based on index
637 * @node: node to read from
638 * @index: Index of address to read (0 for first)
639 * @size: Pointer to size of the address
640 * Return: address, or FDT_ADDR_T_NONE if not present or invalid
642 phys_addr_t ofnode_get_addr_size_index(ofnode node, int index,
646 * ofnode_get_addr_size_index_notrans() - get an address/size from a node
647 * based on index, without address
650 * This reads the register address/size from a node based on index.
651 * The resulting address is not translated. Useful for example for on-disk
654 * @node: node to read from
655 * @index: Index of address to read (0 for first)
656 * @size: Pointer to size of the address
657 * Return: address, or FDT_ADDR_T_NONE if not present or invalid
659 phys_addr_t ofnode_get_addr_size_index_notrans(ofnode node, int index,
663 * ofnode_get_addr_index() - get an address from a node
665 * This reads the register address from a node
667 * @node: node to read from
668 * @index: Index of address to read (0 for first)
669 * Return: address, or FDT_ADDR_T_NONE if not present or invalid
671 phys_addr_t ofnode_get_addr_index(ofnode node, int index);
674 * ofnode_get_addr() - get an address from a node
676 * This reads the register address from a node
678 * @node: node to read from
679 * Return: address, or FDT_ADDR_T_NONE if not present or invalid
681 phys_addr_t ofnode_get_addr(ofnode node);
684 * ofnode_get_size() - get size from a node
686 * This reads the register size from a node
688 * @node: node to read from
689 * Return: size of the address, or FDT_SIZE_T_NONE if not present or invalid
691 fdt_size_t ofnode_get_size(ofnode node);
694 * ofnode_stringlist_search() - find a string in a string list and return index
696 * Note that it is possible for this function to succeed on property values
697 * that are not NUL-terminated. That's because the function will stop after
698 * finding the first occurrence of @string. This can for example happen with
699 * small-valued cell properties, such as #address-cells, when searching for
702 * @node: node to check
703 * @propname: name of the property containing the string list
704 * @string: string to look up in the string list
707 * the index of the string in the list of strings
708 * -ENODATA if the property is not found
709 * -EINVAL on some other error
711 int ofnode_stringlist_search(ofnode node, const char *propname,
715 * ofnode_read_string_index() - obtain an indexed string from a string list
717 * Note that this will successfully extract strings from properties with
718 * non-NUL-terminated values. For example on small-valued cell properties
719 * this function will return the empty string.
721 * If non-NULL, the length of the string (on success) or a negative error-code
722 * (on failure) will be stored in the integer pointer to by lenp.
724 * @node: node to check
725 * @propname: name of the property containing the string list
726 * @index: index of the string to return (cannot be negative)
727 * @outp: return location for the string
730 * 0 if found or -ve error value if not found
732 int ofnode_read_string_index(ofnode node, const char *propname, int index,
736 * ofnode_read_string_count() - find the number of strings in a string list
738 * @node: node to check
739 * @property: name of the property containing the string list
741 * number of strings in the list, or -ve error value if not found
743 int ofnode_read_string_count(ofnode node, const char *property);
746 * ofnode_read_string_list() - read a list of strings
748 * This produces a list of string pointers with each one pointing to a string
749 * in the string list. If the property does not exist, it returns {NULL}.
751 * The data is allocated and the caller is reponsible for freeing the return
752 * value (the list of string pointers). The strings themselves may not be
753 * changed as they point directly into the devicetree property.
755 * @node: node to check
756 * @property: name of the property containing the string list
757 * @listp: returns an allocated, NULL-terminated list of strings if the return
758 * value is > 0, else is set to NULL
760 * number of strings in list, 0 if none, -ENOMEM if out of memory,
761 * -EINVAL if no such property, -EENODATA if property is empty
763 int ofnode_read_string_list(ofnode node, const char *property,
764 const char ***listp);
767 * ofnode_parse_phandle_with_args() - Find a node pointed by phandle in a list
769 * This function is useful to parse lists of phandles and their arguments.
770 * Returns 0 on success and fills out_args, on error returns appropriate
773 * Caller is responsible to call of_node_put() on the returned out_args->np
787 * list = <&phandle1 1 2 &phandle2 3>;
790 * To get a device_node of the `node2' node you may call this:
791 * ofnode_parse_phandle_with_args(node3, "list", "#list-cells", 0, 1, &args);
793 * @node: device tree node containing a list
794 * @list_name: property name that contains a list
795 * @cells_name: property name that specifies phandles' arguments count
796 * @cell_count: Cell count to use if @cells_name is NULL
797 * @index: index of a phandle to parse out
798 * @out_args: optional pointer to output arguments structure (will be filled)
800 * 0 on success (with @out_args filled out if not NULL), -ENOENT if
801 * @list_name does not exist, -EINVAL if a phandle was not found,
802 * @cells_name could not be found, the arguments were truncated or there
803 * were too many arguments.
805 int ofnode_parse_phandle_with_args(ofnode node, const char *list_name,
806 const char *cells_name, int cell_count,
808 struct ofnode_phandle_args *out_args);
811 * ofnode_count_phandle_with_args() - Count number of phandle in a list
813 * This function is useful to count phandles into a list.
814 * Returns number of phandle on success, on error returns appropriate
817 * @node: device tree node containing a list
818 * @list_name: property name that contains a list
819 * @cells_name: property name that specifies phandles' arguments count
820 * @cell_count: Cell count to use if @cells_name is NULL
822 * number of phandle on success, -ENOENT if @list_name does not exist,
823 * -EINVAL if a phandle was not found, @cells_name could not be found.
825 int ofnode_count_phandle_with_args(ofnode node, const char *list_name,
826 const char *cells_name, int cell_count);
829 * ofnode_path() - find a node by full path
831 * This uses the control FDT.
833 * @path: Full path to node, e.g. "/bus/spi@1"
834 * Return: reference to the node found. Use ofnode_valid() to check if it exists
836 ofnode ofnode_path(const char *path);
839 * ofnode_path_root() - find a node by full path from a root node
841 * @tree: Device tree to use
842 * @path: Full path to node, e.g. "/bus/spi@1"
843 * Return: reference to the node found. Use ofnode_valid() to check if it exists
845 ofnode ofnode_path_root(oftree tree, const char *path);
848 * ofnode_read_chosen_prop() - get the value of a chosen property
850 * This looks for a property within the /chosen node and returns its value
852 * @propname: Property name to look for
853 * @sizep: Returns size of property, or `FDT_ERR_...` error code if function
855 * Return: property value if found, else NULL
857 const void *ofnode_read_chosen_prop(const char *propname, int *sizep);
860 * ofnode_read_chosen_string() - get the string value of a chosen property
862 * This looks for a property within the /chosen node and returns its value,
863 * checking that it is a valid nul-terminated string
865 * @propname: Property name to look for
866 * Return: string value if found, else NULL
868 const char *ofnode_read_chosen_string(const char *propname);
871 * ofnode_get_chosen_node() - get a referenced node from the chosen node
873 * This looks up a named property in the chosen node and uses that as a path to
876 * @propname: Property name to look for
877 * Return: the referenced node if present, else ofnode_null()
879 ofnode ofnode_get_chosen_node(const char *propname);
882 * ofnode_read_aliases_prop() - get the value of a aliases property
884 * This looks for a property within the /aliases node and returns its value
886 * @propname: Property name to look for
887 * @sizep: Returns size of property, or `FDT_ERR_...` error code if function
889 * Return: property value if found, else NULL
891 const void *ofnode_read_aliases_prop(const char *propname, int *sizep);
894 * ofnode_get_aliases_node() - get a referenced node from the aliases node
896 * This looks up a named property in the aliases node and uses that as a path to
899 * @propname: Property name to look for
900 * Return: the referenced node if present, else ofnode_null()
902 ofnode ofnode_get_aliases_node(const char *propname);
904 struct display_timing;
906 * ofnode_decode_display_timing() - decode display timings
908 * Decode display timings from the supplied 'display-timings' node.
909 * See doc/device-tree-bindings/video/display-timing.txt for binding
912 * @node: 'display-timing' node containing the timing subnodes
913 * @index: Index number to read (0=first timing subnode)
914 * @config: Place to put timings
915 * Return: 0 if OK, -FDT_ERR_NOTFOUND if not found
917 int ofnode_decode_display_timing(ofnode node, int index,
918 struct display_timing *config);
921 * ofnode_get_property() - get a pointer to the value of a node property
923 * @node: node to read
924 * @propname: property to read
925 * @lenp: place to put length on success
926 * Return: pointer to property, or NULL if not found
928 const void *ofnode_get_property(ofnode node, const char *propname, int *lenp);
931 * ofnode_first_property()- get the reference of the first property
933 * Get reference to the first property of the node, it is used to iterate
934 * and read all the property with ofprop_get_property().
936 * @node: node to read
937 * @prop: place to put argument reference
938 * Return: 0 if OK, -ve on error. -FDT_ERR_NOTFOUND if not found
940 int ofnode_first_property(ofnode node, struct ofprop *prop);
943 * ofnode_next_property() - get the reference of the next property
945 * Get reference to the next property of the node, it is used to iterate
946 * and read all the property with ofprop_get_property().
948 * @prop: reference of current argument and place to put reference of next one
949 * Return: 0 if OK, -ve on error. -FDT_ERR_NOTFOUND if not found
951 int ofnode_next_property(struct ofprop *prop);
954 * ofnode_for_each_prop() - iterate over all properties of a node
956 * @prop: struct ofprop
957 * @node: node (lvalue, ofnode)
959 * This is a wrapper around a for loop and is used like this::
962 * struct ofprop prop;
964 * ofnode_for_each_prop(prop, node) {
968 * Note that this is implemented as a macro and @prop is used as
969 * iterator in the loop. The parent variable can be a constant or even a
972 #define ofnode_for_each_prop(prop, node) \
973 for (ofnode_first_property(node, &prop); \
974 ofprop_valid(&prop); \
975 ofnode_next_property(&prop))
978 * ofprop_get_property() - get a pointer to the value of a property
980 * Get value for the property identified by the provided reference.
982 * @prop: reference on property
983 * @propname: If non-NULL, place to property name on success,
984 * @lenp: If non-NULL, place to put length on success, or error code on failure
985 * Return: pointer to property, or NULL if not found
987 const void *ofprop_get_property(const struct ofprop *prop,
988 const char **propname, int *lenp);
991 * ofnode_get_addr_size() - get address and size from a property
993 * This does no address translation. It simply reads an property that contains
994 * an address and a size value, one after the other.
996 * @node: node to read from
997 * @propname: property to read
998 * @sizep: place to put size value (on success)
999 * Return: address value, or FDT_ADDR_T_NONE on error
1001 phys_addr_t ofnode_get_addr_size(ofnode node, const char *propname,
1002 phys_size_t *sizep);
1005 * ofnode_read_u8_array_ptr() - find an 8-bit array
1007 * Look up a property in a node and return a pointer to its contents as a
1008 * byte array of given length. The property must have at least enough data
1009 * for the array (count bytes). It may have more, but this will be ignored.
1010 * The data is not copied.
1012 * @node: node to examine
1013 * @propname: name of property to find
1014 * @sz: number of array elements
1016 * pointer to byte array if found, or NULL if the property is not found or
1017 * there is not enough data
1019 const uint8_t *ofnode_read_u8_array_ptr(ofnode node, const char *propname,
1023 * ofnode_read_pci_addr() - look up a PCI address
1025 * Look at an address property in a node and return the PCI address which
1026 * corresponds to the given type in the form of fdt_pci_addr.
1027 * The property must hold one fdt_pci_addr with a lengh.
1029 * @node: node to examine
1030 * @type: pci address type (FDT_PCI_SPACE_xxx)
1031 * @propname: name of property to find
1032 * @addr: returns pci address in the form of fdt_pci_addr
1034 * 0 if ok, -ENOENT if the property did not exist, -EINVAL if the
1035 * format of the property was invalid, -ENXIO if the requested
1036 * address type was not found
1038 int ofnode_read_pci_addr(ofnode node, enum fdt_pci_space type,
1039 const char *propname, struct fdt_pci_addr *addr);
1042 * ofnode_read_pci_vendev() - look up PCI vendor and device id
1044 * Look at the compatible property of a device node that represents a PCI
1045 * device and extract pci vendor id and device id from it.
1047 * @node: node to examine
1048 * @vendor: vendor id of the pci device
1049 * @device: device id of the pci device
1050 * Return: 0 if ok, negative on error
1052 int ofnode_read_pci_vendev(ofnode node, u16 *vendor, u16 *device);
1055 * ofnode_read_eth_phy_id() - look up eth phy vendor and device id
1057 * Look at the compatible property of a device node that represents a eth phy
1058 * device and extract phy vendor id and device id from it.
1060 * @node: node to examine
1061 * @vendor: vendor id of the eth phy device
1062 * @device: device id of the eth phy device
1063 * Return: 0 if ok, negative on error
1065 int ofnode_read_eth_phy_id(ofnode node, u16 *vendor, u16 *device);
1068 * ofnode_read_addr_cells() - Get the number of address cells for a node
1070 * This walks back up the tree to find the closest #address-cells property
1071 * which controls the given node.
1073 * @node: Node to check
1074 * Return: number of address cells this node uses
1076 int ofnode_read_addr_cells(ofnode node);
1079 * ofnode_read_size_cells() - Get the number of size cells for a node
1081 * This walks back up the tree to find the closest #size-cells property
1082 * which controls the given node.
1084 * @node: Node to check
1085 * Return: number of size cells this node uses
1087 int ofnode_read_size_cells(ofnode node);
1090 * ofnode_read_simple_addr_cells() - Get the address cells property in a node
1092 * This function matches fdt_address_cells().
1094 * @node: Node to check
1095 * Return: value of #address-cells property in this node, or 2 if none
1097 int ofnode_read_simple_addr_cells(ofnode node);
1100 * ofnode_read_simple_size_cells() - Get the size cells property in a node
1102 * This function matches fdt_size_cells().
1104 * @node: Node to check
1105 * Return: value of #size-cells property in this node, or 2 if none
1107 int ofnode_read_simple_size_cells(ofnode node);
1110 * ofnode_pre_reloc() - check if a node should be bound before relocation
1112 * Device tree nodes can be marked as needing-to-be-bound in the loader stages
1113 * via special device tree properties.
1115 * Before relocation this function can be used to check if nodes are required
1116 * in either SPL or TPL stages.
1118 * After relocation and jumping into the real U-Boot binary it is possible to
1119 * determine if a node was bound in one of SPL/TPL stages.
1121 * There are 4 settings currently in use
1122 * - u-boot,dm-pre-proper: U-Boot proper pre-relocation only
1123 * - u-boot,dm-pre-reloc: legacy and indicates any of TPL or SPL
1124 * Existing platforms only use it to indicate nodes needed in
1125 * SPL. Should probably be replaced by u-boot,dm-spl for new platforms.
1126 * - u-boot,dm-spl: SPL and U-Boot pre-relocation
1127 * - u-boot,dm-tpl: TPL and U-Boot pre-relocation
1129 * @node: node to check
1130 * Return: true if node is needed in SPL/TL, false otherwise
1132 bool ofnode_pre_reloc(ofnode node);
1135 * ofnode_read_resource() - Read a resource from a node
1137 * Read resource information from a node at the given index
1139 * @node: Node to read from
1140 * @index: Index of resource to read (0 = first)
1141 * @res: Returns resource that was read, on success
1142 * Return: 0 if OK, -ve on error
1144 int ofnode_read_resource(ofnode node, uint index, struct resource *res);
1147 * ofnode_read_resource_byname() - Read a resource from a node by name
1149 * Read resource information from a node matching the given name. This uses a
1150 * 'reg-names' string list property with the names matching the associated
1151 * 'reg' property list.
1153 * @node: Node to read from
1154 * @name: Name of resource to read
1155 * @res: Returns resource that was read, on success
1156 * Return: 0 if OK, -ve on error
1158 int ofnode_read_resource_byname(ofnode node, const char *name,
1159 struct resource *res);
1162 * ofnode_by_compatible() - Find the next compatible node
1164 * Find the next node after @from that is compatible with @compat
1166 * @from: ofnode to start from (use ofnode_null() to start at the beginning)
1167 * @compat: Compatible string to match
1168 * Return: ofnode found, or ofnode_null() if none
1170 ofnode ofnode_by_compatible(ofnode from, const char *compat);
1173 * ofnode_by_prop_value() - Find the next node with given property value
1175 * Find the next node after @from that has a @propname with a value
1176 * @propval and a length @proplen.
1178 * @from: ofnode to start from (use ofnode_null() to start at the
1180 * @propname: property name to check
1181 * @propval: property value to search for
1182 * @proplen: length of the value in propval
1183 * Return: ofnode found, or ofnode_null() if none
1185 ofnode ofnode_by_prop_value(ofnode from, const char *propname,
1186 const void *propval, int proplen);
1189 * ofnode_for_each_subnode() - iterate over all subnodes of a parent
1191 * @node: child node (ofnode, lvalue)
1192 * @parent: parent node (ofnode)
1194 * This is a wrapper around a for loop and is used like so::
1197 * ofnode_for_each_subnode(node, parent) {
1202 * Note that this is implemented as a macro and @node is used as
1203 * iterator in the loop. The parent variable can be a constant or even a
1206 #define ofnode_for_each_subnode(node, parent) \
1207 for (node = ofnode_first_subnode(parent); \
1208 ofnode_valid(node); \
1209 node = ofnode_next_subnode(node))
1212 * ofnode_for_each_compatible_node() - iterate over all nodes with a given
1215 * @node: child node (ofnode, lvalue)
1216 * @compat: compatible string to match
1218 * This is a wrapper around a for loop and is used like so::
1221 * ofnode_for_each_compatible_node(node, parent, compatible) {
1226 * Note that this is implemented as a macro and @node is used as
1227 * iterator in the loop.
1229 #define ofnode_for_each_compatible_node(node, compat) \
1230 for (node = ofnode_by_compatible(ofnode_null(), compat); \
1231 ofnode_valid(node); \
1232 node = ofnode_by_compatible(node, compat))
1235 * ofnode_get_child_count() - get the child count of a ofnode
1237 * @parent: valid node to get its child count
1238 * Return: the number of subnodes
1240 int ofnode_get_child_count(ofnode parent);
1243 * ofnode_translate_address() - Translate a device-tree address
1245 * Translate an address from the device-tree into a CPU physical address. This
1246 * function walks up the tree and applies the various bus mappings along the
1249 * @node: Device tree node giving the context in which to translate the address
1250 * @in_addr: pointer to the address to translate
1251 * Return: the translated address; OF_BAD_ADDR on error
1253 u64 ofnode_translate_address(ofnode node, const fdt32_t *in_addr);
1256 * ofnode_translate_dma_address() - Translate a device-tree DMA address
1258 * Translate a DMA address from the device-tree into a CPU physical address.
1259 * This function walks up the tree and applies the various bus mappings along
1262 * @node: Device tree node giving the context in which to translate the
1264 * @in_addr: pointer to the DMA address to translate
1265 * Return: the translated DMA address; OF_BAD_ADDR on error
1267 u64 ofnode_translate_dma_address(ofnode node, const fdt32_t *in_addr);
1270 * ofnode_get_dma_range() - get dma-ranges for a specific DT node
1272 * Get DMA ranges for a specifc node, this is useful to perform bus->cpu and
1273 * cpu->bus address translations
1275 * @node: Device tree node
1276 * @cpu: Pointer to variable storing the range's cpu address
1277 * @bus: Pointer to variable storing the range's bus address
1278 * @size: Pointer to variable storing the range's size
1279 * Return: translated DMA address or OF_BAD_ADDR on error
1281 int ofnode_get_dma_range(ofnode node, phys_addr_t *cpu, dma_addr_t *bus,
1285 * ofnode_device_is_compatible() - check if the node is compatible with compat
1287 * This allows to check whether the node is comaptible with the compat.
1289 * @node: Device tree node for which compatible needs to be verified.
1290 * @compat: Compatible string which needs to verified in the given node.
1291 * Return: true if OK, false if the compatible is not found
1293 int ofnode_device_is_compatible(ofnode node, const char *compat);
1296 * ofnode_write_prop() - Set a property of a ofnode
1298 * Note that the value passed to the function is *not* allocated by the
1299 * function itself, but must be allocated by the caller if necessary. However
1300 * it does allocate memory for the property struct and name.
1302 * @node: The node for whose property should be set
1303 * @propname: The name of the property to set
1304 * @value: The new value of the property (must be valid prior to calling
1306 * @len: The length of the new value of the property
1307 * Return: 0 if successful, -ve on error
1309 int ofnode_write_prop(ofnode node, const char *propname, const void *value,
1313 * ofnode_write_string() - Set a string property of a ofnode
1315 * Note that the value passed to the function is *not* allocated by the
1316 * function itself, but must be allocated by the caller if necessary.
1318 * @node: The node for whose string property should be set
1319 * @propname: The name of the string property to set
1320 * @value: The new value of the string property (must be valid prior to
1321 * calling the function)
1322 * Return: 0 if successful, -ve on error
1324 int ofnode_write_string(ofnode node, const char *propname, const char *value);
1327 * ofnode_write_u32() - Set an integer property of an ofnode
1329 * @node: The node for whose string property should be set
1330 * @propname: The name of the string property to set
1331 * @value: The new value of the 32-bit integer property
1332 * Return: 0 if successful, -ve on error
1334 int ofnode_write_u32(ofnode node, const char *propname, u32 value);
1337 * ofnode_set_enabled() - Enable or disable a device tree node given by its
1340 * This function effectively sets the node's "status" property to either "okay"
1341 * or "disable", hence making it available for driver model initialization or
1344 * @node: The node to enable
1345 * @value: Flag that tells the function to either disable or enable the
1347 * Return: 0 if successful, -ve on error
1349 int ofnode_set_enabled(ofnode node, bool value);
1352 * ofnode_get_phy_node() - Get PHY node for a MAC (if not fixed-link)
1354 * This function parses PHY handle from the Ethernet controller's ofnode
1355 * (trying all possible PHY handle property names), and returns the PHY ofnode.
1357 * Before this is used, ofnode_phy_is_fixed_link() should be checked first, and
1358 * if the result to that is true, this function should not be called.
1360 * @eth_node: ofnode belonging to the Ethernet controller
1361 * Return: ofnode of the PHY, if it exists, otherwise an invalid ofnode
1363 ofnode ofnode_get_phy_node(ofnode eth_node);
1366 * ofnode_read_phy_mode() - Read PHY connection type from a MAC node
1368 * This function parses the "phy-mode" / "phy-connection-type" property and
1369 * returns the corresponding PHY interface type.
1371 * @mac_node: ofnode containing the property
1372 * Return: one of PHY_INTERFACE_MODE_* constants, PHY_INTERFACE_MODE_NA on
1375 phy_interface_t ofnode_read_phy_mode(ofnode mac_node);
1377 #if CONFIG_IS_ENABLED(DM)
1379 * ofnode_conf_read_bool() - Read a boolean value from the U-Boot config
1381 * This reads a property from the /config node of the devicetree.
1383 * See doc/config.txt for bindings
1385 * @prop_name: property name to look up
1386 * Return: true, if it exists, false if not
1388 bool ofnode_conf_read_bool(const char *prop_name);
1391 * ofnode_conf_read_int() - Read an integer value from the U-Boot config
1393 * This reads a property from the /config node of the devicetree.
1395 * See doc/config.txt for bindings
1397 * @prop_name: property name to look up
1398 * @default_val: default value to return if the property is not found
1399 * Return: integer value, if found, or @default_val if not
1401 int ofnode_conf_read_int(const char *prop_name, int default_val);
1404 * ofnode_conf_read_str() - Read a string value from the U-Boot config
1406 * This reads a property from the /config node of the devicetree.
1408 * See doc/config.txt for bindings
1410 * @prop_name: property name to look up
1411 * Return: string value, if found, or NULL if not
1413 const char *ofnode_conf_read_str(const char *prop_name);
1415 #else /* CONFIG_DM */
1416 static inline bool ofnode_conf_read_bool(const char *prop_name)
1421 static inline int ofnode_conf_read_int(const char *prop_name, int default_val)
1426 static inline const char *ofnode_conf_read_str(const char *prop_name)
1431 #endif /* CONFIG_DM */
1434 * of_add_subnode() - add a new subnode to a node
1436 * @parent: parent node to add to
1437 * @name: name of subnode
1438 * @nodep: returns pointer to new subnode (valid if the function returns 0
1440 * Returns 0 if OK, -EEXIST if already exists, -ENOMEM if out of memory, other
1441 * -ve on other error
1443 int ofnode_add_subnode(ofnode parent, const char *name, ofnode *nodep);