2 * Function to read values from the device tree node attached to a udevice.
4 * Copyright (c) 2017 Google, Inc
5 * Written by Simon Glass <sjg@chromium.org>
7 * SPDX-License-Identifier: GPL-2.0+
13 #include <dm/fdtaddr.h>
14 #include <dm/ofnode.h>
15 #include <dm/uclass.h>
19 #if CONFIG_IS_ENABLED(OF_LIVE)
20 static inline const struct device_node *dev_np(struct udevice *dev)
22 return ofnode_to_np(dev->node);
25 static inline const struct device_node *dev_np(struct udevice *dev)
32 * dev_ofnode() - get the DT node reference associated with a udevice
34 * @dev: device to check
35 * @return reference of the the device's DT node
37 static inline ofnode dev_ofnode(struct udevice *dev)
42 static inline bool dev_of_valid(struct udevice *dev)
44 return ofnode_valid(dev_ofnode(dev));
47 #ifndef CONFIG_DM_DEV_READ_INLINE
49 * dev_read_u32_default() - read a 32-bit integer from a device's DT property
51 * @dev: device to read DT property from
52 * @propname: name of the property to read from
53 * @def: default value to return if the property has no value
54 * @return property value, or @def if not found
56 int dev_read_u32_default(struct udevice *dev, const char *propname, int def);
59 * dev_read_string() - Read a string from a device's DT property
61 * @dev: device to read DT property from
62 * @propname: name of the property to read
63 * @return string from property value, or NULL if there is no such property
65 const char *dev_read_string(struct udevice *dev, const char *propname);
68 * dev_read_bool() - read a boolean value from a device's DT property
70 * @dev: device to read DT property from
71 * @propname: name of property to read
72 * @return true if property is present (meaning true), false if not present
74 bool dev_read_bool(struct udevice *dev, const char *propname);
77 * dev_read_subnode() - find a named subnode of a device
79 * @dev: device whose DT node contains the subnode
80 * @subnode_name: name of subnode to find
81 * @return reference to subnode (which can be invalid if there is no such
84 ofnode dev_read_subnode(struct udevice *dev, const char *subbnode_name);
87 * dev_read_size() - read the size of a property
89 * @dev: device to check
90 * @propname: property to check
91 * @return size of property if present, or -EINVAL if not
93 int dev_read_size(struct udevice *dev, const char *propname);
96 * dev_read_addr_index() - Get the indexed reg property of a device
98 * @dev: Device to read from
99 * @index: the 'reg' property can hold a list of <addr, size> pairs
100 * and @index is used to select which one is required
102 * @return address or FDT_ADDR_T_NONE if not found
104 fdt_addr_t dev_read_addr_index(struct udevice *dev, int index);
107 * dev_read_addr() - Get the reg property of a device
109 * @dev: Device to read from
111 * @return address or FDT_ADDR_T_NONE if not found
113 fdt_addr_t dev_read_addr(struct udevice *dev);
116 * dev_read_addr_size() - get address and size from a device property
118 * This does no address translation. It simply reads an property that contains
119 * an address and a size value, one after the other.
121 * @dev: Device to read from
122 * @propname: property to read
123 * @sizep: place to put size value (on success)
124 * @return address value, or FDT_ADDR_T_NONE on error
126 fdt_addr_t dev_read_addr_size(struct udevice *dev, const char *propname,
130 * dev_read_name() - get the name of a device's node
132 * @node: valid node to look up
133 * @return name of node
135 const char *dev_read_name(struct udevice *dev);
138 * dev_read_stringlist_search() - find string in a string list and return index
140 * Note that it is possible for this function to succeed on property values
141 * that are not NUL-terminated. That's because the function will stop after
142 * finding the first occurrence of @string. This can for example happen with
143 * small-valued cell properties, such as #address-cells, when searching for
146 * @dev: device to check
147 * @propname: name of the property containing the string list
148 * @string: string to look up in the string list
151 * the index of the string in the list of strings
152 * -ENODATA if the property is not found
153 * -EINVAL on some other error
155 int dev_read_stringlist_search(struct udevice *dev, const char *property,
159 * dev_read_phandle_with_args() - Find a node pointed by phandle in a list
161 * This function is useful to parse lists of phandles and their arguments.
162 * Returns 0 on success and fills out_args, on error returns appropriate
165 * Caller is responsible to call of_node_put() on the returned out_args->np
179 * list = <&phandle1 1 2 &phandle2 3>;
182 * To get a device_node of the `node2' node you may call this:
183 * dev_read_phandle_with_args(dev, "list", "#list-cells", 0, 1, &args);
185 * @dev: device whose node containing a list
186 * @list_name: property name that contains a list
187 * @cells_name: property name that specifies phandles' arguments count
188 * @cells_count: Cell count to use if @cells_name is NULL
189 * @index: index of a phandle to parse out
190 * @out_args: optional pointer to output arguments structure (will be filled)
191 * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if
192 * @list_name does not exist, -EINVAL if a phandle was not found,
193 * @cells_name could not be found, the arguments were truncated or there
194 * were too many arguments.
196 int dev_read_phandle_with_args(struct udevice *dev, const char *list_name,
197 const char *cells_name, int cell_count,
199 struct ofnode_phandle_args *out_args);
202 * dev_read_addr_cells() - Get the number of address cells for a device's node
204 * This walks back up the tree to find the closest #address-cells property
205 * which controls the given node.
207 * @dev: devioe to check
208 * @return number of address cells this node uses
210 int dev_read_addr_cells(struct udevice *dev);
213 * dev_read_size_cells() - Get the number of size cells for a device's node
215 * This walks back up the tree to find the closest #size-cells property
216 * which controls the given node.
218 * @dev: devioe to check
219 * @return number of size cells this node uses
221 int dev_read_size_cells(struct udevice *dev);
224 * dev_read_addr_cells() - Get the address cells property in a node
226 * This function matches fdt_address_cells().
228 * @dev: devioe to check
229 * @return number of address cells this node uses
231 int dev_read_simple_addr_cells(struct udevice *dev);
234 * dev_read_size_cells() - Get the size cells property in a node
236 * This function matches fdt_size_cells().
238 * @dev: devioe to check
239 * @return number of size cells this node uses
241 int dev_read_simple_size_cells(struct udevice *dev);
244 * dev_read_phandle() - Get the phandle from a device
246 * @dev: device to check
247 * @return phandle (1 or greater), or 0 if no phandle or other error
249 int dev_read_phandle(struct udevice *dev);
252 * dev_read_prop()- - read a property from a device's node
254 * @dev: device to check
255 * @propname: property to read
256 * @lenp: place to put length on success
257 * @return pointer to property, or NULL if not found
259 const void *dev_read_prop(struct udevice *dev, const char *propname, int *lenp);
262 * dev_read_alias_seq() - Get the alias sequence number of a node
264 * This works out whether a node is pointed to by an alias, and if so, the
265 * sequence number of that alias. Aliases are of the form <base><num> where
266 * <num> is the sequence number. For example spi2 would be sequence number 2.
268 * @dev: device to look up
269 * @devnump: set to the sequence number if one is found
270 * @return 0 if a sequence was found, -ve if not
272 int dev_read_alias_seq(struct udevice *dev, int *devnump);
275 * dev_read_u32_array() - Find and read an array of 32 bit integers
277 * Search for a property in a device node and read 32-bit value(s) from
280 * The out_values is modified only if a valid u32 value can be decoded.
282 * @dev: device to look up
283 * @propname: name of the property to read
284 * @out_values: pointer to return value, modified only if return value is 0
285 * @sz: number of array elements to read
286 * @return 0 on success, -EINVAL if the property does not exist, -ENODATA if
287 * property does not have a value, and -EOVERFLOW if the property data isn't
290 int dev_read_u32_array(struct udevice *dev, const char *propname,
291 u32 *out_values, size_t sz);
294 * dev_read_first_subnode() - find the first subnode of a device's node
296 * @dev: device to look up
297 * @return reference to the first subnode (which can be invalid if the device's
298 * node has no subnodes)
300 ofnode dev_read_first_subnode(struct udevice *dev);
303 * ofnode_next_subnode() - find the next sibling of a subnode
305 * @node: valid reference to previous node (sibling)
306 * @return reference to the next subnode (which can be invalid if the node
307 * has no more siblings)
309 ofnode dev_read_next_subnode(ofnode node);
312 * dev_read_u8_array_ptr() - find an 8-bit array
314 * Look up a device's node property and return a pointer to its contents as a
315 * byte array of given length. The property must have at least enough data
316 * for the array (count bytes). It may have more, but this will be ignored.
317 * The data is not copied.
319 * @dev: device to look up
320 * @propname: name of property to find
321 * @sz: number of array elements
322 * @return pointer to byte array if found, or NULL if the property is not
323 * found or there is not enough data
325 const uint8_t *dev_read_u8_array_ptr(struct udevice *dev, const char *propname,
329 * dev_read_enabled() - check whether a node is enabled
331 * This looks for a 'status' property. If this exists, then returns 1 if
332 * the status is 'ok' and 0 otherwise. If there is no status property,
333 * it returns 1 on the assumption that anything mentioned should be enabled
336 * @dev: device to examine
337 * @return integer value 0 (not enabled) or 1 (enabled)
339 int dev_read_enabled(struct udevice *dev);
342 * dev_read_resource() - obtain an indexed resource from a device.
344 * @dev: devuce to examine
345 * @index index of the resource to retrieve (0 = first)
346 * @res returns the resource
347 * @return 0 if ok, negative on error
349 int dev_read_resource(struct udevice *dev, uint index, struct resource *res);
351 #else /* CONFIG_DM_DEV_READ_INLINE is enabled */
353 static inline int dev_read_u32_default(struct udevice *dev,
354 const char *propname, int def)
356 return ofnode_read_u32_default(dev_ofnode(dev), propname, def);
359 static inline const char *dev_read_string(struct udevice *dev,
360 const char *propname)
362 return ofnode_read_string(dev_ofnode(dev), propname);
365 static inline bool dev_read_bool(struct udevice *dev, const char *propname)
367 return ofnode_read_bool(dev_ofnode(dev), propname);
370 static inline ofnode dev_read_subnode(struct udevice *dev,
371 const char *subbnode_name)
373 return ofnode_find_subnode(dev_ofnode(dev), subbnode_name);
376 static inline int dev_read_size(struct udevice *dev, const char *propname)
378 return ofnode_read_size(dev_ofnode(dev), propname);
381 static inline fdt_addr_t dev_read_addr_index(struct udevice *dev, int index)
383 return devfdt_get_addr_index(dev, index);
386 static inline fdt_addr_t dev_read_addr(struct udevice *dev)
388 return devfdt_get_addr(dev);
391 static inline fdt_addr_t dev_read_addr_size(struct udevice *dev,
392 const char *propname,
395 return ofnode_get_addr_size(dev_ofnode(dev), propname, sizep);
398 static inline const char *dev_read_name(struct udevice *dev)
400 return ofnode_get_name(dev_ofnode(dev));
403 static inline int dev_read_stringlist_search(struct udevice *dev,
404 const char *propname,
407 return ofnode_stringlist_search(dev_ofnode(dev), propname, string);
410 static inline int dev_read_phandle_with_args(struct udevice *dev,
411 const char *list_name, const char *cells_name, int cell_count,
412 int index, struct ofnode_phandle_args *out_args)
414 return ofnode_parse_phandle_with_args(dev_ofnode(dev), list_name,
415 cells_name, cell_count, index,
419 static inline int dev_read_addr_cells(struct udevice *dev)
421 /* NOTE: this call should walk up the parent stack */
422 return fdt_address_cells(gd->fdt_blob, dev_of_offset(dev));
425 static inline int dev_read_size_cells(struct udevice *dev)
427 /* NOTE: this call should walk up the parent stack */
428 return fdt_size_cells(gd->fdt_blob, dev_of_offset(dev));
431 static inline int dev_read_simple_addr_cells(struct udevice *dev)
433 return fdt_address_cells(gd->fdt_blob, dev_of_offset(dev));
436 static inline int dev_read_simple_size_cells(struct udevice *dev)
438 return fdt_size_cells(gd->fdt_blob, dev_of_offset(dev));
441 static inline int dev_read_phandle(struct udevice *dev)
443 return fdt_get_phandle(gd->fdt_blob, dev_of_offset(dev));
446 static inline const void *dev_read_prop(struct udevice *dev,
447 const char *propname, int *lenp)
449 return ofnode_get_property(dev_ofnode(dev), propname, lenp);
452 static inline int dev_read_alias_seq(struct udevice *dev, int *devnump)
454 return fdtdec_get_alias_seq(gd->fdt_blob, dev->uclass->uc_drv->name,
455 dev_of_offset(dev), devnump);
458 static inline int dev_read_u32_array(struct udevice *dev, const char *propname,
459 u32 *out_values, size_t sz)
461 return ofnode_read_u32_array(dev_ofnode(dev), propname, out_values, sz);
464 static inline ofnode dev_read_first_subnode(struct udevice *dev)
466 return ofnode_first_subnode(dev_ofnode(dev));
469 static inline ofnode dev_read_next_subnode(ofnode node)
471 return ofnode_next_subnode(node);
474 static inline const uint8_t *dev_read_u8_array_ptr(struct udevice *dev,
475 const char *propname, size_t sz)
477 return ofnode_read_u8_array_ptr(dev_ofnode(dev), propname, sz);
480 static inline int dev_read_enabled(struct udevice *dev)
482 return fdtdec_get_is_enabled(gd->fdt_blob, dev_of_offset(dev));
485 static inline int dev_read_resource(struct udevice *dev, uint index,
486 struct resource *res)
488 return ofnode_read_resource(dev_ofnode(dev), index, res);
491 #endif /* CONFIG_DM_DEV_READ_INLINE */
494 * dev_for_each_subnode() - Helper function to iterate through subnodes
496 * This creates a for() loop which works through the subnodes in a device's
499 * @subnode: ofnode holding the current subnode
500 * @dev: device to use for interation (struct udevice *)
502 #define dev_for_each_subnode(subnode, dev) \
503 for (subnode = dev_read_first_subnode(dev); \
504 ofnode_valid(subnode); \
505 subnode = ofnode_next_subnode(subnode))