1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * Function to read values from the device tree node attached to a udevice.
5 * Copyright (c) 2017 Google, Inc
6 * Written by Simon Glass <sjg@chromium.org>
12 #include <dm/fdtaddr.h>
13 #include <dm/ofnode.h>
14 #include <dm/uclass.h>
18 #if CONFIG_IS_ENABLED(OF_LIVE)
19 static inline const struct device_node *dev_np(struct udevice *dev)
21 return ofnode_to_np(dev->node);
24 static inline const struct device_node *dev_np(struct udevice *dev)
31 * dev_ofnode() - get the DT node reference associated with a udevice
33 * @dev: device to check
34 * @return reference of the the device's DT node
36 static inline ofnode dev_ofnode(struct udevice *dev)
41 static inline bool dev_of_valid(struct udevice *dev)
43 return ofnode_valid(dev_ofnode(dev));
46 #ifndef CONFIG_DM_DEV_READ_INLINE
48 * dev_read_u32() - read a 32-bit integer from a device's DT property
50 * @dev: device to read DT property from
51 * @propname: name of the property to read from
52 * @outp: place to put value (if found)
53 * @return 0 if OK, -ve on error
55 int dev_read_u32(struct udevice *dev, const char *propname, u32 *outp);
58 * dev_read_u32_default() - read a 32-bit integer from a device's DT property
60 * @dev: device to read DT property from
61 * @propname: name of the property to read from
62 * @def: default value to return if the property has no value
63 * @return property value, or @def if not found
65 int dev_read_u32_default(struct udevice *dev, const char *propname, int def);
68 * dev_read_s32() - read a signed 32-bit integer from a device's DT property
70 * @dev: device to read DT property from
71 * @propname: name of the property to read from
72 * @outp: place to put value (if found)
73 * @return 0 if OK, -ve on error
75 int dev_read_s32(struct udevice *dev, const char *propname, s32 *outp);
78 * dev_read_s32_default() - read a signed 32-bit int from a device's DT property
80 * @dev: device to read DT property from
81 * @propname: name of the property to read from
82 * @def: default value to return if the property has no value
83 * @return property value, or @def if not found
85 int dev_read_s32_default(struct udevice *dev, const char *propname, int def);
88 * dev_read_u32u() - read a 32-bit integer from a device's DT property
90 * This version uses a standard uint type.
92 * @dev: device to read DT property from
93 * @propname: name of the property to read from
94 * @outp: place to put value (if found)
95 * @return 0 if OK, -ve on error
97 int dev_read_u32u(struct udevice *dev, const char *propname, uint *outp);
100 * dev_read_string() - Read a string from a device's DT property
102 * @dev: device to read DT property from
103 * @propname: name of the property to read
104 * @return string from property value, or NULL if there is no such property
106 const char *dev_read_string(struct udevice *dev, const char *propname);
109 * dev_read_bool() - read a boolean value from a device's DT property
111 * @dev: device to read DT property from
112 * @propname: name of property to read
113 * @return true if property is present (meaning true), false if not present
115 bool dev_read_bool(struct udevice *dev, const char *propname);
118 * dev_read_subnode() - find a named subnode of a device
120 * @dev: device whose DT node contains the subnode
121 * @subnode_name: name of subnode to find
122 * @return reference to subnode (which can be invalid if there is no such
125 ofnode dev_read_subnode(struct udevice *dev, const char *subbnode_name);
128 * dev_read_size() - read the size of a property
130 * @dev: device to check
131 * @propname: property to check
132 * @return size of property if present, or -EINVAL if not
134 int dev_read_size(struct udevice *dev, const char *propname);
137 * dev_read_addr_index() - Get the indexed reg property of a device
139 * @dev: Device to read from
140 * @index: the 'reg' property can hold a list of <addr, size> pairs
141 * and @index is used to select which one is required
143 * @return address or FDT_ADDR_T_NONE if not found
145 fdt_addr_t dev_read_addr_index(struct udevice *dev, int index);
148 * dev_read_addr_size_index() - Get the indexed reg property of a device
150 * @dev: Device to read from
151 * @index: the 'reg' property can hold a list of <addr, size> pairs
152 * and @index is used to select which one is required
153 * @size: place to put size value (on success)
155 * @return address or FDT_ADDR_T_NONE if not found
157 fdt_addr_t dev_read_addr_size_index(struct udevice *dev, int index,
161 * dev_remap_addr_index() - Get the indexed reg property of a device
162 * as a memory-mapped I/O pointer
164 * @dev: Device to read from
165 * @index: the 'reg' property can hold a list of <addr, size> pairs
166 * and @index is used to select which one is required
168 * @return pointer or NULL if not found
170 void *dev_remap_addr_index(struct udevice *dev, int index);
173 * dev_read_addr_name() - Get the reg property of a device, indexed by name
175 * @dev: Device to read from
176 * @name: the 'reg' property can hold a list of <addr, size> pairs, with the
177 * 'reg-names' property providing named-based identification. @index
178 * indicates the value to search for in 'reg-names'.
180 * @return address or FDT_ADDR_T_NONE if not found
182 fdt_addr_t dev_read_addr_name(struct udevice *dev, const char* name);
185 * dev_read_addr_size_name() - Get the reg property of a device, indexed by name
187 * @dev: Device to read from
188 * @name: the 'reg' property can hold a list of <addr, size> pairs, with the
189 * 'reg-names' property providing named-based identification. @index
190 * indicates the value to search for in 'reg-names'.
191 * @size: place to put size value (on success)
193 * @return address or FDT_ADDR_T_NONE if not found
195 fdt_addr_t dev_read_addr_size_name(struct udevice *dev, const char *name,
199 * dev_remap_addr_name() - Get the reg property of a device, indexed by name,
200 * as a memory-mapped I/O pointer
202 * @dev: Device to read from
203 * @name: the 'reg' property can hold a list of <addr, size> pairs, with the
204 * 'reg-names' property providing named-based identification. @index
205 * indicates the value to search for in 'reg-names'.
207 * @return pointer or NULL if not found
209 void *dev_remap_addr_name(struct udevice *dev, const char* name);
212 * dev_read_addr() - Get the reg property of a device
214 * @dev: Device to read from
216 * @return address or FDT_ADDR_T_NONE if not found
218 fdt_addr_t dev_read_addr(struct udevice *dev);
221 * dev_read_addr_ptr() - Get the reg property of a device
224 * @dev: Device to read from
226 * @return pointer or NULL if not found
228 void *dev_read_addr_ptr(struct udevice *dev);
231 * dev_remap_addr() - Get the reg property of a device as a
232 * memory-mapped I/O pointer
234 * @dev: Device to read from
236 * @return pointer or NULL if not found
238 void *dev_remap_addr(struct udevice *dev);
241 * dev_read_addr_size() - get address and size from a device property
243 * This does no address translation. It simply reads an property that contains
244 * an address and a size value, one after the other.
246 * @dev: Device to read from
247 * @propname: property to read
248 * @sizep: place to put size value (on success)
249 * @return address value, or FDT_ADDR_T_NONE on error
251 fdt_addr_t dev_read_addr_size(struct udevice *dev, const char *propname,
255 * dev_read_name() - get the name of a device's node
257 * @dev: Device to read from
258 * @return name of node
260 const char *dev_read_name(struct udevice *dev);
263 * dev_read_stringlist_search() - find string in a string list and return index
265 * Note that it is possible for this function to succeed on property values
266 * that are not NUL-terminated. That's because the function will stop after
267 * finding the first occurrence of @string. This can for example happen with
268 * small-valued cell properties, such as #address-cells, when searching for
271 * @dev: device to check
272 * @propname: name of the property containing the string list
273 * @string: string to look up in the string list
276 * the index of the string in the list of strings
277 * -ENODATA if the property is not found
278 * -EINVAL on some other error
280 int dev_read_stringlist_search(struct udevice *dev, const char *property,
284 * dev_read_string_index() - obtain an indexed string from a string list
286 * @dev: device to examine
287 * @propname: name of the property containing the string list
288 * @index: index of the string to return
289 * @out: return location for the string
292 * length of string, if found or -ve error value if not found
294 int dev_read_string_index(struct udevice *dev, const char *propname, int index,
298 * dev_read_string_count() - find the number of strings in a string list
300 * @dev: device to examine
301 * @propname: name of the property containing the string list
303 * number of strings in the list, or -ve error value if not found
305 int dev_read_string_count(struct udevice *dev, const char *propname);
307 * dev_read_phandle_with_args() - Find a node pointed by phandle in a list
309 * This function is useful to parse lists of phandles and their arguments.
310 * Returns 0 on success and fills out_args, on error returns appropriate
313 * Caller is responsible to call of_node_put() on the returned out_args->np
327 * list = <&phandle1 1 2 &phandle2 3>;
330 * To get a device_node of the `node2' node you may call this:
331 * dev_read_phandle_with_args(dev, "list", "#list-cells", 0, 1, &args);
333 * @dev: device whose node containing a list
334 * @list_name: property name that contains a list
335 * @cells_name: property name that specifies phandles' arguments count
336 * @cells_count: Cell count to use if @cells_name is NULL
337 * @index: index of a phandle to parse out
338 * @out_args: optional pointer to output arguments structure (will be filled)
339 * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if
340 * @list_name does not exist, -EINVAL if a phandle was not found,
341 * @cells_name could not be found, the arguments were truncated or there
342 * were too many arguments.
344 int dev_read_phandle_with_args(struct udevice *dev, const char *list_name,
345 const char *cells_name, int cell_count,
347 struct ofnode_phandle_args *out_args);
350 * dev_count_phandle_with_args() - Return phandle number in a list
352 * This function is usefull to get phandle number contained in a property list.
353 * For example, this allows to allocate the right amount of memory to keep
354 * clock's reference contained into the "clocks" property.
357 * @dev: device whose node containing a list
358 * @list_name: property name that contains a list
359 * @cells_name: property name that specifies phandles' arguments count
360 * @Returns number of phandle found on success, on error returns appropriate
364 int dev_count_phandle_with_args(struct udevice *dev, const char *list_name,
365 const char *cells_name);
368 * dev_read_addr_cells() - Get the number of address cells for a device's node
370 * This walks back up the tree to find the closest #address-cells property
371 * which controls the given node.
373 * @dev: device to check
374 * @return number of address cells this node uses
376 int dev_read_addr_cells(struct udevice *dev);
379 * dev_read_size_cells() - Get the number of size cells for a device's node
381 * This walks back up the tree to find the closest #size-cells property
382 * which controls the given node.
384 * @dev: device to check
385 * @return number of size cells this node uses
387 int dev_read_size_cells(struct udevice *dev);
390 * dev_read_addr_cells() - Get the address cells property in a node
392 * This function matches fdt_address_cells().
394 * @dev: device to check
395 * @return number of address cells this node uses
397 int dev_read_simple_addr_cells(struct udevice *dev);
400 * dev_read_size_cells() - Get the size cells property in a node
402 * This function matches fdt_size_cells().
404 * @dev: device to check
405 * @return number of size cells this node uses
407 int dev_read_simple_size_cells(struct udevice *dev);
410 * dev_read_phandle() - Get the phandle from a device
412 * @dev: device to check
413 * @return phandle (1 or greater), or 0 if no phandle or other error
415 int dev_read_phandle(struct udevice *dev);
418 * dev_read_prop()- - read a property from a device's node
420 * @dev: device to check
421 * @propname: property to read
422 * @lenp: place to put length on success
423 * @return pointer to property, or NULL if not found
425 const void *dev_read_prop(struct udevice *dev, const char *propname, int *lenp);
428 * dev_read_alias_seq() - Get the alias sequence number of a node
430 * This works out whether a node is pointed to by an alias, and if so, the
431 * sequence number of that alias. Aliases are of the form <base><num> where
432 * <num> is the sequence number. For example spi2 would be sequence number 2.
434 * @dev: device to look up
435 * @devnump: set to the sequence number if one is found
436 * @return 0 if a sequence was found, -ve if not
438 int dev_read_alias_seq(struct udevice *dev, int *devnump);
441 * dev_read_u32_array() - Find and read an array of 32 bit integers
443 * Search for a property in a device node and read 32-bit value(s) from
446 * The out_values is modified only if a valid u32 value can be decoded.
448 * @dev: device to look up
449 * @propname: name of the property to read
450 * @out_values: pointer to return value, modified only if return value is 0
451 * @sz: number of array elements to read
452 * @return 0 on success, -EINVAL if the property does not exist, -ENODATA if
453 * property does not have a value, and -EOVERFLOW if the property data isn't
456 int dev_read_u32_array(struct udevice *dev, const char *propname,
457 u32 *out_values, size_t sz);
460 * dev_read_first_subnode() - find the first subnode of a device's node
462 * @dev: device to look up
463 * @return reference to the first subnode (which can be invalid if the device's
464 * node has no subnodes)
466 ofnode dev_read_first_subnode(struct udevice *dev);
469 * ofnode_next_subnode() - find the next sibling of a subnode
471 * @node: valid reference to previous node (sibling)
472 * @return reference to the next subnode (which can be invalid if the node
473 * has no more siblings)
475 ofnode dev_read_next_subnode(ofnode node);
478 * dev_read_u8_array_ptr() - find an 8-bit array
480 * Look up a device's node property and return a pointer to its contents as a
481 * byte array of given length. The property must have at least enough data
482 * for the array (count bytes). It may have more, but this will be ignored.
483 * The data is not copied.
485 * @dev: device to look up
486 * @propname: name of property to find
487 * @sz: number of array elements
488 * @return pointer to byte array if found, or NULL if the property is not
489 * found or there is not enough data
491 const uint8_t *dev_read_u8_array_ptr(struct udevice *dev, const char *propname,
495 * dev_read_enabled() - check whether a node is enabled
497 * This looks for a 'status' property. If this exists, then returns 1 if
498 * the status is 'ok' and 0 otherwise. If there is no status property,
499 * it returns 1 on the assumption that anything mentioned should be enabled
502 * @dev: device to examine
503 * @return integer value 0 (not enabled) or 1 (enabled)
505 int dev_read_enabled(struct udevice *dev);
508 * dev_read_resource() - obtain an indexed resource from a device.
510 * @dev: device to examine
511 * @index index of the resource to retrieve (0 = first)
512 * @res returns the resource
513 * @return 0 if ok, negative on error
515 int dev_read_resource(struct udevice *dev, uint index, struct resource *res);
518 * dev_read_resource_byname() - obtain a named resource from a device.
520 * @dev: device to examine
521 * @name: name of the resource to retrieve
522 * @res: returns the resource
523 * @return 0 if ok, negative on error
525 int dev_read_resource_byname(struct udevice *dev, const char *name,
526 struct resource *res);
529 * dev_translate_address() - Translate a device-tree address
531 * Translate an address from the device-tree into a CPU physical address. This
532 * function walks up the tree and applies the various bus mappings along the
535 * @dev: device giving the context in which to translate the address
536 * @in_addr: pointer to the address to translate
537 * @return the translated address; OF_BAD_ADDR on error
539 u64 dev_translate_address(struct udevice *dev, const fdt32_t *in_addr);
542 * dev_translate_dma_address() - Translate a device-tree DMA address
544 * Translate a DMA address from the device-tree into a CPU physical address.
545 * This function walks up the tree and applies the various bus mappings along
548 * @dev: device giving the context in which to translate the DMA address
549 * @in_addr: pointer to the DMA address to translate
550 * @return the translated DMA address; OF_BAD_ADDR on error
552 u64 dev_translate_dma_address(struct udevice *dev, const fdt32_t *in_addr);
555 * dev_read_alias_highest_id - Get highest alias id for the given stem
556 * @stem: Alias stem to be examined
558 * The function travels the lookup table to get the highest alias id for the
560 * @return alias ID, if found, else -1
562 int dev_read_alias_highest_id(const char *stem);
564 #else /* CONFIG_DM_DEV_READ_INLINE is enabled */
566 static inline int dev_read_u32(struct udevice *dev,
567 const char *propname, u32 *outp)
569 return ofnode_read_u32(dev_ofnode(dev), propname, outp);
572 static inline int dev_read_u32_default(struct udevice *dev,
573 const char *propname, int def)
575 return ofnode_read_u32_default(dev_ofnode(dev), propname, def);
578 static inline int dev_read_s32(struct udevice *dev,
579 const char *propname, s32 *outp)
581 return ofnode_read_s32(dev_ofnode(dev), propname, outp);
584 static inline int dev_read_s32_default(struct udevice *dev,
585 const char *propname, int def)
587 return ofnode_read_s32_default(dev_ofnode(dev), propname, def);
590 static inline int dev_read_u32u(struct udevice *dev,
591 const char *propname, uint *outp)
596 ret = ofnode_read_u32(dev_ofnode(dev), propname, &val);
604 static inline const char *dev_read_string(struct udevice *dev,
605 const char *propname)
607 return ofnode_read_string(dev_ofnode(dev), propname);
610 static inline bool dev_read_bool(struct udevice *dev, const char *propname)
612 return ofnode_read_bool(dev_ofnode(dev), propname);
615 static inline ofnode dev_read_subnode(struct udevice *dev,
616 const char *subbnode_name)
618 return ofnode_find_subnode(dev_ofnode(dev), subbnode_name);
621 static inline int dev_read_size(struct udevice *dev, const char *propname)
623 return ofnode_read_size(dev_ofnode(dev), propname);
626 static inline fdt_addr_t dev_read_addr_index(struct udevice *dev, int index)
628 return devfdt_get_addr_index(dev, index);
631 static inline fdt_addr_t dev_read_addr_size_index(struct udevice *dev,
635 return devfdt_get_addr_size_index(dev, index, size);
638 static inline fdt_addr_t dev_read_addr_name(struct udevice *dev,
641 return devfdt_get_addr_name(dev, name);
644 static inline fdt_addr_t dev_read_addr_size_name(struct udevice *dev,
648 return devfdt_get_addr_size_name(dev, name, size);
651 static inline fdt_addr_t dev_read_addr(struct udevice *dev)
653 return devfdt_get_addr(dev);
656 static inline void *dev_read_addr_ptr(struct udevice *dev)
658 return devfdt_get_addr_ptr(dev);
661 static inline void *dev_remap_addr(struct udevice *dev)
663 return devfdt_remap_addr(dev);
666 static inline void *dev_remap_addr_index(struct udevice *dev, int index)
668 return devfdt_remap_addr_index(dev, index);
671 static inline void *dev_remap_addr_name(struct udevice *dev, const char *name)
673 return devfdt_remap_addr_name(dev, name);
676 static inline fdt_addr_t dev_read_addr_size(struct udevice *dev,
677 const char *propname,
680 return ofnode_get_addr_size(dev_ofnode(dev), propname, sizep);
683 static inline const char *dev_read_name(struct udevice *dev)
685 return ofnode_get_name(dev_ofnode(dev));
688 static inline int dev_read_stringlist_search(struct udevice *dev,
689 const char *propname,
692 return ofnode_stringlist_search(dev_ofnode(dev), propname, string);
695 static inline int dev_read_string_index(struct udevice *dev,
696 const char *propname, int index,
699 return ofnode_read_string_index(dev_ofnode(dev), propname, index, outp);
702 static inline int dev_read_string_count(struct udevice *dev,
703 const char *propname)
705 return ofnode_read_string_count(dev_ofnode(dev), propname);
708 static inline int dev_read_phandle_with_args(struct udevice *dev,
709 const char *list_name, const char *cells_name, int cell_count,
710 int index, struct ofnode_phandle_args *out_args)
712 return ofnode_parse_phandle_with_args(dev_ofnode(dev), list_name,
713 cells_name, cell_count, index,
717 static inline int dev_count_phandle_with_args(struct udevice *dev,
718 const char *list_name, const char *cells_name)
720 return ofnode_count_phandle_with_args(dev_ofnode(dev), list_name,
724 static inline int dev_read_addr_cells(struct udevice *dev)
726 /* NOTE: this call should walk up the parent stack */
727 return fdt_address_cells(gd->fdt_blob, dev_of_offset(dev));
730 static inline int dev_read_size_cells(struct udevice *dev)
732 /* NOTE: this call should walk up the parent stack */
733 return fdt_size_cells(gd->fdt_blob, dev_of_offset(dev));
736 static inline int dev_read_simple_addr_cells(struct udevice *dev)
738 return fdt_address_cells(gd->fdt_blob, dev_of_offset(dev));
741 static inline int dev_read_simple_size_cells(struct udevice *dev)
743 return fdt_size_cells(gd->fdt_blob, dev_of_offset(dev));
746 static inline int dev_read_phandle(struct udevice *dev)
748 return fdt_get_phandle(gd->fdt_blob, dev_of_offset(dev));
751 static inline const void *dev_read_prop(struct udevice *dev,
752 const char *propname, int *lenp)
754 return ofnode_get_property(dev_ofnode(dev), propname, lenp);
757 static inline int dev_read_alias_seq(struct udevice *dev, int *devnump)
759 return fdtdec_get_alias_seq(gd->fdt_blob, dev->uclass->uc_drv->name,
760 dev_of_offset(dev), devnump);
763 static inline int dev_read_u32_array(struct udevice *dev, const char *propname,
764 u32 *out_values, size_t sz)
766 return ofnode_read_u32_array(dev_ofnode(dev), propname, out_values, sz);
769 static inline ofnode dev_read_first_subnode(struct udevice *dev)
771 return ofnode_first_subnode(dev_ofnode(dev));
774 static inline ofnode dev_read_next_subnode(ofnode node)
776 return ofnode_next_subnode(node);
779 static inline const uint8_t *dev_read_u8_array_ptr(struct udevice *dev,
780 const char *propname, size_t sz)
782 return ofnode_read_u8_array_ptr(dev_ofnode(dev), propname, sz);
785 static inline int dev_read_enabled(struct udevice *dev)
787 return fdtdec_get_is_enabled(gd->fdt_blob, dev_of_offset(dev));
790 static inline int dev_read_resource(struct udevice *dev, uint index,
791 struct resource *res)
793 return ofnode_read_resource(dev_ofnode(dev), index, res);
796 static inline int dev_read_resource_byname(struct udevice *dev,
798 struct resource *res)
800 return ofnode_read_resource_byname(dev_ofnode(dev), name, res);
803 static inline u64 dev_translate_address(struct udevice *dev, const fdt32_t *in_addr)
805 return ofnode_translate_address(dev_ofnode(dev), in_addr);
808 static inline u64 dev_translate_dma_address(struct udevice *dev, const fdt32_t *in_addr)
810 return ofnode_translate_dma_address(dev_ofnode(dev), in_addr);
813 static inline int dev_read_alias_highest_id(const char *stem)
815 return fdtdec_get_alias_highest_id(gd->fdt_blob, stem);
818 #endif /* CONFIG_DM_DEV_READ_INLINE */
821 * dev_for_each_subnode() - Helper function to iterate through subnodes
823 * This creates a for() loop which works through the subnodes in a device's
826 * @subnode: ofnode holding the current subnode
827 * @dev: device to use for interation (struct udevice *)
829 #define dev_for_each_subnode(subnode, dev) \
830 for (subnode = dev_read_first_subnode(dev); \
831 ofnode_valid(subnode); \
832 subnode = ofnode_next_subnode(subnode))