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 */
14 /* Enable checks to protect against invalid calls */
20 * ofnode - reference to a device tree node
22 * This union can hold either a straightforward pointer to a struct device_node
23 * in the live device tree, or an offset within the flat device tree. In the
24 * latter case, the pointer value is just the integer offset within the flat DT.
26 * Thus we can reference nodes in both the live tree (once available) and the
27 * flat tree (until then). Functions are available to translate between an
28 * ofnode and either an offset or a struct device_node *.
30 * The reference can also hold a null offset, in which case the pointer value
31 * here is NULL. This corresponds to a struct device_node * value of
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
36 * holds an offset. The value itself does not need to be unique and in theory
37 * the same value could point to a valid device node or a valid offset. We
38 * could arrange for a unique value to be used (e.g. by making the pointer
39 * point to an offset within the flat device tree in the case of an offset) but
40 * this increases code size slightly due to the subtraction. Since it offers no
41 * real benefit, the approach described here seems best.
43 * For now these points use constant types, since we don't allow writing
46 * @np: Pointer to device node, used for live tree
47 * @of_offset: Pointer into flat device tree, used for flat tree. Note that this
48 * is not a really a pointer to a node: it is an offset value. See above.
50 typedef union ofnode_union {
51 const struct device_node *np; /* will be used for future live tree */
55 struct ofnode_phandle_args {
58 uint32_t args[OF_MAX_PHANDLE_ARGS];
62 * ofprop - reference to a property of a device tree node
64 * This struct hold the reference on one property of one node,
65 * using struct ofnode and an offset within the flat device tree or either
66 * a pointer to a struct property in the live device tree.
68 * Thus we can reference arguments in both the live tree and the flat tree.
70 * The property reference can also hold a null reference. This corresponds to
71 * a struct property NULL pointer or an offset of -1.
73 * @node: Pointer to device node
74 * @offset: Pointer into flat device tree, used for flat tree.
75 * @prop: Pointer to property, used for live treee.
82 const struct property *prop;
87 * _ofnode_to_np() - convert an ofnode to a live DT node pointer
89 * This cannot be called if the reference contains an offset.
91 * @node: Reference containing struct device_node * (possibly invalid)
92 * @return pointer to device node (can be NULL)
94 static inline const struct device_node *ofnode_to_np(ofnode node)
97 if (!of_live_active())
104 * ofnode_to_offset() - convert an ofnode to a flat DT offset
106 * This cannot be called if the reference contains a node pointer.
108 * @node: Reference containing offset (possibly invalid)
109 * @return DT offset (can be -1)
111 static inline int ofnode_to_offset(ofnode node)
114 if (of_live_active())
117 return node.of_offset;
121 * ofnode_valid() - check if an ofnode is valid
123 * @return true if the reference contains a valid ofnode, false if it is NULL
125 static inline bool ofnode_valid(ofnode node)
127 if (of_live_active())
128 return node.np != NULL;
130 return node.of_offset != -1;
134 * offset_to_ofnode() - convert a DT offset to an ofnode
136 * @of_offset: DT offset (either valid, or -1)
137 * @return reference to the associated DT offset
139 static inline ofnode offset_to_ofnode(int of_offset)
143 if (of_live_active())
146 node.of_offset = of_offset >= 0 ? of_offset : -1;
152 * np_to_ofnode() - convert a node pointer to an ofnode
154 * @np: Live node pointer (can be NULL)
155 * @return reference to the associated node pointer
157 static inline ofnode np_to_ofnode(const struct device_node *np)
167 * ofnode_is_np() - check if a reference is a node pointer
169 * This function associated that if there is a valid live tree then all
170 * references will use it. This is because using the flat DT when the live tree
171 * is valid is not permitted.
173 * @node: reference to check (possibly invalid)
174 * @return true if the reference is a live node pointer, false if it is a DT
177 static inline bool ofnode_is_np(ofnode node)
181 * Check our assumption that flat tree offsets are not used when a
182 * live tree is in use.
184 assert(!ofnode_valid(node) ||
185 (of_live_active() ? _ofnode_to_np(node)
186 : _ofnode_to_np(node)));
188 return of_live_active() && ofnode_valid(node);
192 * ofnode_equal() - check if two references are equal
194 * @return true if equal, else false
196 static inline bool ofnode_equal(ofnode ref1, ofnode ref2)
198 /* We only need to compare the contents */
199 return ref1.of_offset == ref2.of_offset;
203 * ofnode_null() - Obtain a null ofnode
205 * This returns an ofnode which points to no node. It works both with the flat
208 static inline ofnode ofnode_null(void)
212 if (of_live_active())
221 * ofnode_read_u32() - Read a 32-bit integer from a property
223 * @ref: valid node reference to read property from
224 * @propname: name of the property to read from
225 * @outp: place to put value (if found)
226 * @return 0 if OK, -ve on error
228 int ofnode_read_u32(ofnode node, const char *propname, u32 *outp);
231 * ofnode_read_u32_index() - Read a 32-bit integer from a multi-value property
233 * @ref: valid node reference to read property from
234 * @propname: name of the property to read from
235 * @index: index of the integer to return
236 * @outp: place to put value (if found)
237 * @return 0 if OK, -ve on error
239 int ofnode_read_u32_index(ofnode node, const char *propname, int index,
243 * ofnode_read_s32() - Read a 32-bit integer from a property
245 * @ref: valid node reference to read property from
246 * @propname: name of the property to read from
247 * @outp: place to put value (if found)
248 * @return 0 if OK, -ve on error
250 static inline int ofnode_read_s32(ofnode node, const char *propname,
253 return ofnode_read_u32(node, propname, (u32 *)out_value);
257 * ofnode_read_u32_default() - Read a 32-bit integer from a property
259 * @ref: valid node reference to read property from
260 * @propname: name of the property to read from
261 * @def: default value to return if the property has no value
262 * @return property value, or @def if not found
264 u32 ofnode_read_u32_default(ofnode ref, const char *propname, u32 def);
267 * ofnode_read_u32_index_default() - Read a 32-bit integer from a multi-value
270 * @ref: valid node reference to read property from
271 * @propname: name of the property to read from
272 * @index: index of the integer to return
273 * @def: default value to return if the property has no value
274 * @return property value, or @def if not found
276 u32 ofnode_read_u32_index_default(ofnode ref, const char *propname, int index,
280 * ofnode_read_s32_default() - Read a 32-bit integer from a property
282 * @ref: valid node reference to read property from
283 * @propname: name of the property to read from
284 * @def: default value to return if the property has no value
285 * @return property value, or @def if not found
287 int ofnode_read_s32_default(ofnode node, const char *propname, s32 def);
290 * ofnode_read_u64() - Read a 64-bit integer from a property
292 * @node: valid node reference to read property from
293 * @propname: name of the property to read from
294 * @outp: place to put value (if found)
295 * @return 0 if OK, -ve on error
297 int ofnode_read_u64(ofnode node, const char *propname, u64 *outp);
300 * ofnode_read_u64_default() - Read a 64-bit integer from a property
302 * @ref: valid node reference to read property from
303 * @propname: name of the property to read from
304 * @def: default value to return if the property has no value
305 * @return property value, or @def if not found
307 u64 ofnode_read_u64_default(ofnode node, const char *propname, u64 def);
310 * ofnode_read_prop() - Read a property from a node
312 * @node: valid node reference to read property from
313 * @propname: name of the property to read
314 * @sizep: if non-NULL, returns the size of the property, or an error code
316 * @return property value, or NULL if there is no such property
318 const void *ofnode_read_prop(ofnode node, const char *propname, int *sizep);
321 * ofnode_read_string() - Read a string from a property
323 * @node: valid node reference to read property from
324 * @propname: name of the property to read
325 * @return string from property value, or NULL if there is no such property
327 const char *ofnode_read_string(ofnode node, const char *propname);
330 * ofnode_read_u32_array() - Find and read an array of 32 bit integers
332 * @node: valid node reference to read property from
333 * @propname: name of the property to read
334 * @out_values: pointer to return value, modified only if return value is 0
335 * @sz: number of array elements to read
336 * @return 0 if OK, -ve on error
338 * Search for a property in a device node and read 32-bit value(s) from
339 * it. Returns 0 on success, -EINVAL if the property does not exist,
340 * -ENODATA if property does not have a value, and -EOVERFLOW if the
341 * property data isn't large enough.
343 * The out_values is modified only if a valid u32 value can be decoded.
345 int ofnode_read_u32_array(ofnode node, const char *propname,
346 u32 *out_values, size_t sz);
349 * ofnode_read_bool() - read a boolean value from a property
351 * @node: valid node reference to read property from
352 * @propname: name of property to read
353 * @return true if property is present (meaning true), false if not present
355 bool ofnode_read_bool(ofnode node, const char *propname);
358 * ofnode_find_subnode() - find a named subnode of a parent node
360 * @node: valid reference to parent node
361 * @subnode_name: name of subnode to find
362 * @return reference to subnode (which can be invalid if there is no such
365 ofnode ofnode_find_subnode(ofnode node, const char *subnode_name);
368 * ofnode_first_subnode() - find the first subnode of a parent node
370 * @node: valid reference to a valid parent node
371 * @return reference to the first subnode (which can be invalid if the parent
372 * node has no subnodes)
374 ofnode ofnode_first_subnode(ofnode node);
377 * ofnode_next_subnode() - find the next sibling of a subnode
379 * @node: valid reference to previous node (sibling)
380 * @return reference to the next subnode (which can be invalid if the node
381 * has no more siblings)
383 ofnode ofnode_next_subnode(ofnode node);
386 * ofnode_get_parent() - get the ofnode's parent (enclosing ofnode)
388 * @node: valid node to look up
389 * @return ofnode reference of the parent node
391 ofnode ofnode_get_parent(ofnode node);
394 * ofnode_get_name() - get the name of a node
396 * @node: valid node to look up
397 * @return name of node
399 const char *ofnode_get_name(ofnode node);
402 * ofnode_get_by_phandle() - get ofnode from phandle
404 * @phandle: phandle to look up
405 * @return ofnode reference to the phandle
407 ofnode ofnode_get_by_phandle(uint phandle);
410 * ofnode_read_size() - read the size of a property
412 * @node: node to check
413 * @propname: property to check
414 * @return size of property if present, or -EINVAL if not
416 int ofnode_read_size(ofnode node, const char *propname);
419 * ofnode_get_addr_size_index() - get an address/size from a node
422 * This reads the register address/size from a node based on index
424 * @node: node to read from
425 * @index: Index of address to read (0 for first)
426 * @size: Pointer to size of the address
427 * @return address, or FDT_ADDR_T_NONE if not present or invalid
429 phys_addr_t ofnode_get_addr_size_index(ofnode node, int index,
433 * ofnode_get_addr_index() - get an address from a node
435 * This reads the register address from a node
437 * @node: node to read from
438 * @index: Index of address to read (0 for first)
439 * @return address, or FDT_ADDR_T_NONE if not present or invalid
441 phys_addr_t ofnode_get_addr_index(ofnode node, int index);
444 * ofnode_get_addr() - get an address from a node
446 * This reads the register address from a node
448 * @node: node to read from
449 * @return address, or FDT_ADDR_T_NONE if not present or invalid
451 phys_addr_t ofnode_get_addr(ofnode node);
454 * ofnode_stringlist_search() - find a string in a string list and return index
456 * Note that it is possible for this function to succeed on property values
457 * that are not NUL-terminated. That's because the function will stop after
458 * finding the first occurrence of @string. This can for example happen with
459 * small-valued cell properties, such as #address-cells, when searching for
462 * @node: node to check
463 * @propname: name of the property containing the string list
464 * @string: string to look up in the string list
467 * the index of the string in the list of strings
468 * -ENODATA if the property is not found
469 * -EINVAL on some other error
471 int ofnode_stringlist_search(ofnode node, const char *propname,
475 * ofnode_read_string_index() - obtain an indexed string from a string list
477 * Note that this will successfully extract strings from properties with
478 * non-NUL-terminated values. For example on small-valued cell properties
479 * this function will return the empty string.
481 * If non-NULL, the length of the string (on success) or a negative error-code
482 * (on failure) will be stored in the integer pointer to by lenp.
484 * @node: node to check
485 * @propname: name of the property containing the string list
486 * @index: index of the string to return
487 * @lenp: return location for the string length or an error code on failure
490 * length of string, if found or -ve error value if not found
492 int ofnode_read_string_index(ofnode node, const char *propname, int index,
496 * ofnode_read_string_count() - find the number of strings in a string list
498 * @node: node to check
499 * @propname: name of the property containing the string list
501 * number of strings in the list, or -ve error value if not found
503 int ofnode_read_string_count(ofnode node, const char *property);
506 * ofnode_parse_phandle_with_args() - Find a node pointed by phandle in a list
508 * This function is useful to parse lists of phandles and their arguments.
509 * Returns 0 on success and fills out_args, on error returns appropriate
512 * Caller is responsible to call of_node_put() on the returned out_args->np
526 * list = <&phandle1 1 2 &phandle2 3>;
529 * To get a device_node of the `node2' node you may call this:
530 * ofnode_parse_phandle_with_args(node3, "list", "#list-cells", 0, 1, &args);
532 * @node: device tree node containing a list
533 * @list_name: property name that contains a list
534 * @cells_name: property name that specifies phandles' arguments count
535 * @cells_count: Cell count to use if @cells_name is NULL
536 * @index: index of a phandle to parse out
537 * @out_args: optional pointer to output arguments structure (will be filled)
538 * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if
539 * @list_name does not exist, -EINVAL if a phandle was not found,
540 * @cells_name could not be found, the arguments were truncated or there
541 * were too many arguments.
543 int ofnode_parse_phandle_with_args(ofnode node, const char *list_name,
544 const char *cells_name, int cell_count,
546 struct ofnode_phandle_args *out_args);
549 * ofnode_count_phandle_with_args() - Count number of phandle in a list
551 * This function is useful to count phandles into a list.
552 * Returns number of phandle on success, on error returns appropriate
555 * @node: device tree node containing a list
556 * @list_name: property name that contains a list
557 * @cells_name: property name that specifies phandles' arguments count
558 * @return number of phandle on success, -ENOENT if @list_name does not
559 * exist, -EINVAL if a phandle was not found, @cells_name could not
562 int ofnode_count_phandle_with_args(ofnode node, const char *list_name,
563 const char *cells_name);
566 * ofnode_path() - find a node by full path
568 * @path: Full path to node, e.g. "/bus/spi@1"
569 * @return reference to the node found. Use ofnode_valid() to check if it exists
571 ofnode ofnode_path(const char *path);
574 * ofnode_read_chosen_prop() - get the value of a chosen property
576 * This looks for a property within the /chosen node and returns its value
578 * @propname: Property name to look for
579 * @sizep: Returns size of property, or FDT_ERR_... error code if function
581 * @return property value if found, else NULL
583 const void *ofnode_read_chosen_prop(const char *propname, int *sizep);
586 * ofnode_read_chosen_string() - get the string value of a chosen property
588 * This looks for a property within the /chosen node and returns its value,
589 * checking that it is a valid nul-terminated string
591 * @propname: Property name to look for
592 * @return string value if found, else NULL
594 const char *ofnode_read_chosen_string(const char *propname);
597 * ofnode_get_chosen_node() - get a referenced node from the chosen node
599 * This looks up a named property in the chosen node and uses that as a path to
602 * @return the referenced node if present, else ofnode_null()
604 ofnode ofnode_get_chosen_node(const char *propname);
606 struct display_timing;
608 * ofnode_decode_display_timing() - decode display timings
610 * Decode display timings from the supplied 'display-timings' node.
611 * See doc/device-tree-bindings/video/display-timing.txt for binding
614 * @node 'display-timing' node containing the timing subnodes
615 * @index Index number to read (0=first timing subnode)
616 * @config Place to put timings
617 * @return 0 if OK, -FDT_ERR_NOTFOUND if not found
619 int ofnode_decode_display_timing(ofnode node, int index,
620 struct display_timing *config);
623 * ofnode_get_property() - get a pointer to the value of a node property
625 * @node: node to read
626 * @propname: property to read
627 * @lenp: place to put length on success
628 * @return pointer to property, or NULL if not found
630 const void *ofnode_get_property(ofnode node, const char *propname, int *lenp);
633 * ofnode_get_first_property()- get the reference of the first property
635 * Get reference to the first property of the node, it is used to iterate
636 * and read all the property with ofnode_get_property_by_prop().
638 * @node: node to read
639 * @prop: place to put argument reference
640 * @return 0 if OK, -ve on error. -FDT_ERR_NOTFOUND if not found
642 int ofnode_get_first_property(ofnode node, struct ofprop *prop);
645 * ofnode_get_next_property() - get the reference of the next property
647 * Get reference to the next property of the node, it is used to iterate
648 * and read all the property with ofnode_get_property_by_prop().
650 * @prop: reference of current argument and place to put reference of next one
651 * @return 0 if OK, -ve on error. -FDT_ERR_NOTFOUND if not found
653 int ofnode_get_next_property(struct ofprop *prop);
656 * ofnode_get_property_by_prop() - get a pointer to the value of a property
658 * Get value for the property identified by the provided reference.
660 * @prop: reference on property
661 * @propname: If non-NULL, place to property name on success,
662 * @lenp: If non-NULL, place to put length on success
663 * @return 0 if OK, -ve on error. -FDT_ERR_NOTFOUND if not found
665 const void *ofnode_get_property_by_prop(const struct ofprop *prop,
666 const char **propname, int *lenp);
669 * ofnode_is_available() - check if a node is marked available
671 * @node: node to check
672 * @return true if node's 'status' property is "okay" (or is missing)
674 bool ofnode_is_available(ofnode node);
677 * ofnode_get_addr_size() - get address and size from a property
679 * This does no address translation. It simply reads an property that contains
680 * an address and a size value, one after the other.
682 * @node: node to read from
683 * @propname: property to read
684 * @sizep: place to put size value (on success)
685 * @return address value, or FDT_ADDR_T_NONE on error
687 phys_addr_t ofnode_get_addr_size(ofnode node, const char *propname,
691 * ofnode_read_u8_array_ptr() - find an 8-bit array
693 * Look up a property in a node and return a pointer to its contents as a
694 * byte array of given length. The property must have at least enough data
695 * for the array (count bytes). It may have more, but this will be ignored.
696 * The data is not copied.
698 * @node node to examine
699 * @propname name of property to find
700 * @sz number of array elements
701 * @return pointer to byte array if found, or NULL if the property is not
702 * found or there is not enough data
704 const uint8_t *ofnode_read_u8_array_ptr(ofnode node, const char *propname,
708 * ofnode_read_pci_addr() - look up a PCI address
710 * Look at an address property in a node and return the PCI address which
711 * corresponds to the given type in the form of fdt_pci_addr.
712 * The property must hold one fdt_pci_addr with a lengh.
714 * @node node to examine
715 * @type pci address type (FDT_PCI_SPACE_xxx)
716 * @propname name of property to find
717 * @addr returns pci address in the form of fdt_pci_addr
718 * @return 0 if ok, -ENOENT if the property did not exist, -EINVAL if the
719 * format of the property was invalid, -ENXIO if the requested
720 * address type was not found
722 int ofnode_read_pci_addr(ofnode node, enum fdt_pci_space type,
723 const char *propname, struct fdt_pci_addr *addr);
726 * ofnode_read_pci_vendev() - look up PCI vendor and device id
728 * Look at the compatible property of a device node that represents a PCI
729 * device and extract pci vendor id and device id from it.
731 * @param node node to examine
732 * @param vendor vendor id of the pci device
733 * @param device device id of the pci device
734 * @return 0 if ok, negative on error
736 int ofnode_read_pci_vendev(ofnode node, u16 *vendor, u16 *device);
739 * ofnode_read_addr_cells() - Get the number of address cells for a node
741 * This walks back up the tree to find the closest #address-cells property
742 * which controls the given node.
744 * @node: Node to check
745 * @return number of address cells this node uses
747 int ofnode_read_addr_cells(ofnode node);
750 * ofnode_read_size_cells() - Get the number of size cells for a node
752 * This walks back up the tree to find the closest #size-cells property
753 * which controls the given node.
755 * @node: Node to check
756 * @return number of size cells this node uses
758 int ofnode_read_size_cells(ofnode node);
761 * ofnode_read_simple_addr_cells() - Get the address cells property in a node
763 * This function matches fdt_address_cells().
765 * @np: Node pointer to check
766 * @return value of #address-cells property in this node, or 2 if none
768 int ofnode_read_simple_addr_cells(ofnode node);
771 * ofnode_read_simple_size_cells() - Get the size cells property in a node
773 * This function matches fdt_size_cells().
775 * @np: Node pointer to check
776 * @return value of #size-cells property in this node, or 2 if none
778 int ofnode_read_simple_size_cells(ofnode node);
781 * ofnode_pre_reloc() - check if a node should be bound before relocation
783 * Device tree nodes can be marked as needing-to-be-bound in the loader stages
784 * via special device tree properties.
786 * Before relocation this function can be used to check if nodes are required
787 * in either SPL or TPL stages.
789 * After relocation and jumping into the real U-Boot binary it is possible to
790 * determine if a node was bound in one of SPL/TPL stages.
792 * There are 4 settings currently in use
793 * - u-boot,dm-pre-proper: U-Boot proper pre-relocation only
794 * - u-boot,dm-pre-reloc: legacy and indicates any of TPL or SPL
795 * Existing platforms only use it to indicate nodes needed in
796 * SPL. Should probably be replaced by u-boot,dm-spl for
798 * - u-boot,dm-spl: SPL and U-Boot pre-relocation
799 * - u-boot,dm-tpl: TPL and U-Boot pre-relocation
801 * @node: node to check
802 * @return true if node is needed in SPL/TL, false otherwise
804 bool ofnode_pre_reloc(ofnode node);
807 * ofnode_read_resource() - Read a resource from a node
809 * Read resource information from a node at the given index
811 * @node: Node to read from
812 * @index: Index of resource to read (0 = first)
813 * @res: Returns resource that was read, on success
814 * @return 0 if OK, -ve on error
816 int ofnode_read_resource(ofnode node, uint index, struct resource *res);
819 * ofnode_read_resource_byname() - Read a resource from a node by name
821 * Read resource information from a node matching the given name. This uses a
822 * 'reg-names' string list property with the names matching the associated
823 * 'reg' property list.
825 * @node: Node to read from
826 * @name: Name of resource to read
827 * @res: Returns resource that was read, on success
828 * @return 0 if OK, -ve on error
830 int ofnode_read_resource_byname(ofnode node, const char *name,
831 struct resource *res);
834 * ofnode_by_compatible() - Find the next compatible node
836 * Find the next node after @from that is compatible with @compat
838 * @from: ofnode to start from (use ofnode_null() to start at the beginning)
839 * @compat: Compatible string to match
840 * @return ofnode found, or ofnode_null() if none
842 ofnode ofnode_by_compatible(ofnode from, const char *compat);
845 * ofnode_by_prop_value() - Find the next node with given property value
847 * Find the next node after @from that has a @propname with a value
848 * @propval and a length @proplen.
850 * @from: ofnode to start from (use ofnode_null() to start at the
851 * beginning) @propname: property name to check @propval: property value to
852 * search for @proplen: length of the value in propval @return ofnode
853 * found, or ofnode_null() if none
855 ofnode ofnode_by_prop_value(ofnode from, const char *propname,
856 const void *propval, int proplen);
859 * ofnode_for_each_subnode() - iterate over all subnodes of a parent
861 * @node: child node (ofnode, lvalue)
862 * @parent: parent node (ofnode)
864 * This is a wrapper around a for loop and is used like so:
868 * ofnode_for_each_subnode(node, parent) {
873 * Note that this is implemented as a macro and @node is used as
874 * iterator in the loop. The parent variable can be a constant or even a
877 #define ofnode_for_each_subnode(node, parent) \
878 for (node = ofnode_first_subnode(parent); \
879 ofnode_valid(node); \
880 node = ofnode_next_subnode(node))
883 * ofnode_get_child_count() - get the child count of a ofnode
885 * @node: valid node to get its child count
886 * @return the number of subnodes
888 int ofnode_get_child_count(ofnode parent);
891 * ofnode_translate_address() - Translate a device-tree address
893 * Translate an address from the device-tree into a CPU physical address. This
894 * function walks up the tree and applies the various bus mappings along the
897 * @ofnode: Device tree node giving the context in which to translate the
899 * @in_addr: pointer to the address to translate
900 * @return the translated address; OF_BAD_ADDR on error
902 u64 ofnode_translate_address(ofnode node, const fdt32_t *in_addr);
905 * ofnode_translate_dma_address() - Translate a device-tree DMA address
907 * Translate a DMA address from the device-tree into a CPU physical address.
908 * This function walks up the tree and applies the various bus mappings along
911 * @ofnode: Device tree node giving the context in which to translate the
913 * @in_addr: pointer to the DMA address to translate
914 * @return the translated DMA address; OF_BAD_ADDR on error
916 u64 ofnode_translate_dma_address(ofnode node, const fdt32_t *in_addr);
919 * ofnode_device_is_compatible() - check if the node is compatible with compat
921 * This allows to check whether the node is comaptible with the compat.
923 * @node: Device tree node for which compatible needs to be verified.
924 * @compat: Compatible string which needs to verified in the given node.
925 * @return true if OK, false if the compatible is not found
927 int ofnode_device_is_compatible(ofnode node, const char *compat);
930 * ofnode_write_prop() - Set a property of a ofnode
932 * Note that the value passed to the function is *not* allocated by the
933 * function itself, but must be allocated by the caller if necessary.
935 * @node: The node for whose property should be set
936 * @propname: The name of the property to set
937 * @len: The length of the new value of the property
938 * @value: The new value of the property (must be valid prior to calling
940 * @return 0 if successful, -ve on error
942 int ofnode_write_prop(ofnode node, const char *propname, int len,
946 * ofnode_write_string() - Set a string property of a ofnode
948 * Note that the value passed to the function is *not* allocated by the
949 * function itself, but must be allocated by the caller if necessary.
951 * @node: The node for whose string property should be set
952 * @propname: The name of the string property to set
953 * @value: The new value of the string property (must be valid prior to
954 * calling the function)
955 * @return 0 if successful, -ve on error
957 int ofnode_write_string(ofnode node, const char *propname, const char *value);
960 * ofnode_set_enabled() - Enable or disable a device tree node given by its
963 * This function effectively sets the node's "status" property to either "okay"
964 * or "disable", hence making it available for driver model initialization or
967 * @node: The node to enable
968 * @value: Flag that tells the function to either disable or enable the
970 * @return 0 if successful, -ve on error
972 int ofnode_set_enabled(ofnode node, bool value);