blob: 5c4cbf09986922cace122a66110f55cbd93b6c93 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Simon Glass4984de22017-05-17 17:18:10 -06002/*
3 * Copyright (c) 2017 Google, Inc
4 * Written by Simon Glass <sjg@chromium.org>
Simon Glass4984de22017-05-17 17:18:10 -06005 */
6
7#ifndef _DM_OFNODE_H
8#define _DM_OFNODE_H
9
Simon Glass9e512042017-05-18 20:08:58 -060010/* TODO(sjg@chromium.org): Drop fdtdec.h include */
11#include <fdtdec.h>
12#include <dm/of.h>
13
14/* Enable checks to protect against invalid calls */
15#undef OF_CHECKS
16
Simon Glassdcf98852017-07-25 08:29:55 -060017struct resource;
18
Simon Glass4984de22017-05-17 17:18:10 -060019/**
20 * ofnode - reference to a device tree node
21 *
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.
25 *
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 *.
29 *
30 * The reference can also hold a null offset, in which case the pointer value
Simon Glass9e512042017-05-18 20:08:58 -060031 * here is NULL. This corresponds to a struct device_node * value of
Simon Glass4984de22017-05-17 17:18:10 -060032 * NULL, or an offset of -1.
33 *
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.
42 *
43 * For now these points use constant types, since we don't allow writing
44 * the DT.
45 *
46 * @np: Pointer to device node, used for live tree
Baruch Siachafc1a782017-11-09 13:44:28 +020047 * @of_offset: Pointer into flat device tree, used for flat tree. Note that this
Simon Glass4984de22017-05-17 17:18:10 -060048 * is not a really a pointer to a node: it is an offset value. See above.
49 */
50typedef union ofnode_union {
51 const struct device_node *np; /* will be used for future live tree */
52 long of_offset;
53} ofnode;
54
Simon Glass9e512042017-05-18 20:08:58 -060055struct ofnode_phandle_args {
56 ofnode node;
57 int args_count;
58 uint32_t args[OF_MAX_PHANDLE_ARGS];
59};
60
61/**
62 * _ofnode_to_np() - convert an ofnode to a live DT node pointer
63 *
64 * This cannot be called if the reference contains an offset.
65 *
66 * @node: Reference containing struct device_node * (possibly invalid)
67 * @return pointer to device node (can be NULL)
68 */
69static inline const struct device_node *ofnode_to_np(ofnode node)
70{
71#ifdef OF_CHECKS
72 if (!of_live_active())
73 return NULL;
74#endif
75 return node.np;
76}
77
Simon Glass4984de22017-05-17 17:18:10 -060078/**
79 * ofnode_to_offset() - convert an ofnode to a flat DT offset
80 *
81 * This cannot be called if the reference contains a node pointer.
82 *
83 * @node: Reference containing offset (possibly invalid)
84 * @return DT offset (can be -1)
85 */
86static inline int ofnode_to_offset(ofnode node)
87{
Simon Glass9e512042017-05-18 20:08:58 -060088#ifdef OF_CHECKS
89 if (of_live_active())
90 return -1;
91#endif
Simon Glass4984de22017-05-17 17:18:10 -060092 return node.of_offset;
93}
94
95/**
96 * ofnode_valid() - check if an ofnode is valid
97 *
98 * @return true if the reference contains a valid ofnode, false if it is NULL
99 */
100static inline bool ofnode_valid(ofnode node)
101{
Simon Glass9e512042017-05-18 20:08:58 -0600102 if (of_live_active())
103 return node.np != NULL;
104 else
105 return node.of_offset != -1;
Simon Glass4984de22017-05-17 17:18:10 -0600106}
107
108/**
109 * offset_to_ofnode() - convert a DT offset to an ofnode
110 *
111 * @of_offset: DT offset (either valid, or -1)
112 * @return reference to the associated DT offset
113 */
114static inline ofnode offset_to_ofnode(int of_offset)
115{
116 ofnode node;
117
Simon Glass9e512042017-05-18 20:08:58 -0600118 if (of_live_active())
119 node.np = NULL;
120 else
121 node.of_offset = of_offset;
Simon Glass4984de22017-05-17 17:18:10 -0600122
123 return node;
124}
125
126/**
Simon Glass9e512042017-05-18 20:08:58 -0600127 * np_to_ofnode() - convert a node pointer to an ofnode
128 *
129 * @np: Live node pointer (can be NULL)
130 * @return reference to the associated node pointer
131 */
132static inline ofnode np_to_ofnode(const struct device_node *np)
133{
134 ofnode node;
135
136 node.np = np;
137
138 return node;
139}
140
141/**
142 * ofnode_is_np() - check if a reference is a node pointer
143 *
144 * This function associated that if there is a valid live tree then all
145 * references will use it. This is because using the flat DT when the live tree
146 * is valid is not permitted.
147 *
148 * @node: reference to check (possibly invalid)
149 * @return true if the reference is a live node pointer, false if it is a DT
150 * offset
151 */
152static inline bool ofnode_is_np(ofnode node)
153{
154#ifdef OF_CHECKS
155 /*
156 * Check our assumption that flat tree offsets are not used when a
157 * live tree is in use.
158 */
159 assert(!ofnode_valid(node) ||
160 (of_live_active() ? _ofnode_to_np(node)
161 : _ofnode_to_np(node)));
162#endif
163 return of_live_active() && ofnode_valid(node);
164}
165
166/**
Simon Glass4984de22017-05-17 17:18:10 -0600167 * ofnode_equal() - check if two references are equal
168 *
169 * @return true if equal, else false
170 */
171static inline bool ofnode_equal(ofnode ref1, ofnode ref2)
172{
173 /* We only need to compare the contents */
174 return ref1.of_offset == ref2.of_offset;
175}
176
Simon Glass9e512042017-05-18 20:08:58 -0600177/**
178 * ofnode_null() - Obtain a null ofnode
179 *
180 * This returns an ofnode which points to no node. It works both with the flat
181 * tree and livetree.
182 */
183static inline ofnode ofnode_null(void)
184{
185 ofnode node;
186
187 if (of_live_active())
188 node.np = NULL;
189 else
190 node.of_offset = -1;
191
192 return node;
193}
194
195/**
196 * ofnode_read_u32() - Read a 32-bit integer from a property
197 *
198 * @ref: valid node reference to read property from
199 * @propname: name of the property to read from
200 * @outp: place to put value (if found)
201 * @return 0 if OK, -ve on error
202 */
203int ofnode_read_u32(ofnode node, const char *propname, u32 *outp);
204
205/**
206 * ofnode_read_s32() - Read a 32-bit integer from a property
207 *
208 * @ref: valid node reference to read property from
209 * @propname: name of the property to read from
210 * @outp: place to put value (if found)
211 * @return 0 if OK, -ve on error
212 */
213static inline int ofnode_read_s32(ofnode node, const char *propname,
214 s32 *out_value)
215{
216 return ofnode_read_u32(node, propname, (u32 *)out_value);
217}
218
219/**
220 * ofnode_read_u32_default() - Read a 32-bit integer from a property
221 *
222 * @ref: valid node reference to read property from
223 * @propname: name of the property to read from
224 * @def: default value to return if the property has no value
225 * @return property value, or @def if not found
226 */
Trent Piephob061ef32019-05-10 17:48:20 +0000227u32 ofnode_read_u32_default(ofnode ref, const char *propname, u32 def);
Simon Glass9e512042017-05-18 20:08:58 -0600228
229/**
230 * ofnode_read_s32_default() - Read a 32-bit integer from a property
231 *
232 * @ref: valid node reference to read property from
233 * @propname: name of the property to read from
234 * @def: default value to return if the property has no value
235 * @return property value, or @def if not found
236 */
237int ofnode_read_s32_default(ofnode node, const char *propname, s32 def);
238
239/**
Lukas Auerafb30122018-11-22 11:26:35 +0100240 * ofnode_read_u64() - Read a 64-bit integer from a property
241 *
242 * @node: valid node reference to read property from
243 * @propname: name of the property to read from
244 * @outp: place to put value (if found)
245 * @return 0 if OK, -ve on error
246 */
247int ofnode_read_u64(ofnode node, const char *propname, u64 *outp);
248
249/**
Simon Glass7e5196c2018-06-11 13:07:10 -0600250 * ofnode_read_u64_default() - Read a 64-bit integer from a property
251 *
252 * @ref: valid node reference to read property from
253 * @propname: name of the property to read from
254 * @def: default value to return if the property has no value
255 * @return property value, or @def if not found
256 */
T Karthik Reddy3f3d7712019-09-02 16:34:30 +0200257u64 ofnode_read_u64_default(ofnode node, const char *propname, u64 def);
Simon Glass7e5196c2018-06-11 13:07:10 -0600258
259/**
Simon Glass9e512042017-05-18 20:08:58 -0600260 * ofnode_read_string() - Read a string from a property
261 *
262 * @ref: valid node reference to read property from
263 * @propname: name of the property to read
264 * @return string from property value, or NULL if there is no such property
265 */
266const char *ofnode_read_string(ofnode node, const char *propname);
267
268/**
Simon Glassbed77492017-05-18 20:09:01 -0600269 * ofnode_read_u32_array() - Find and read an array of 32 bit integers
Simon Glass9e512042017-05-18 20:08:58 -0600270 *
271 * @node: valid node reference to read property from
272 * @propname: name of the property to read
273 * @out_values: pointer to return value, modified only if return value is 0
274 * @sz: number of array elements to read
Simon Glassfbe8d032018-06-11 13:07:11 -0600275 * @return 0 if OK, -ve on error
Simon Glass9e512042017-05-18 20:08:58 -0600276 *
277 * Search for a property in a device node and read 32-bit value(s) from
278 * it. Returns 0 on success, -EINVAL if the property does not exist,
279 * -ENODATA if property does not have a value, and -EOVERFLOW if the
280 * property data isn't large enough.
281 *
282 * The out_values is modified only if a valid u32 value can be decoded.
283 */
284int ofnode_read_u32_array(ofnode node, const char *propname,
285 u32 *out_values, size_t sz);
286
287/**
288 * ofnode_read_bool() - read a boolean value from a property
289 *
290 * @node: valid node reference to read property from
291 * @propname: name of property to read
292 * @return true if property is present (meaning true), false if not present
293 */
294bool ofnode_read_bool(ofnode node, const char *propname);
295
296/**
297 * ofnode_find_subnode() - find a named subnode of a parent node
298 *
299 * @node: valid reference to parent node
300 * @subnode_name: name of subnode to find
301 * @return reference to subnode (which can be invalid if there is no such
302 * subnode)
303 */
304ofnode ofnode_find_subnode(ofnode node, const char *subnode_name);
305
306/**
307 * ofnode_first_subnode() - find the first subnode of a parent node
308 *
309 * @node: valid reference to a valid parent node
310 * @return reference to the first subnode (which can be invalid if the parent
311 * node has no subnodes)
312 */
313ofnode ofnode_first_subnode(ofnode node);
314
315/**
316 * ofnode_next_subnode() - find the next sibling of a subnode
317 *
318 * @node: valid reference to previous node (sibling)
319 * @return reference to the next subnode (which can be invalid if the node
320 * has no more siblings)
321 */
322ofnode ofnode_next_subnode(ofnode node);
323
324/**
Philipp Tomsiche2d59972018-02-23 17:38:49 +0100325 * ofnode_get_parent() - get the ofnode's parent (enclosing ofnode)
326 *
327 * @node: valid node to look up
328 * @return ofnode reference of the parent node
329 */
330ofnode ofnode_get_parent(ofnode node);
331
332/**
Simon Glass9e512042017-05-18 20:08:58 -0600333 * ofnode_get_name() - get the name of a node
334 *
335 * @node: valid node to look up
Baruch Siach33810b42018-11-18 14:39:20 +0200336 * @return name of node
Simon Glass9e512042017-05-18 20:08:58 -0600337 */
338const char *ofnode_get_name(ofnode node);
339
340/**
Kever Yangb4f20762018-02-23 17:38:50 +0100341 * ofnode_get_by_phandle() - get ofnode from phandle
342 *
343 * @phandle: phandle to look up
344 * @return ofnode reference to the phandle
345 */
346ofnode ofnode_get_by_phandle(uint phandle);
347
348/**
Simon Glass9e512042017-05-18 20:08:58 -0600349 * ofnode_read_size() - read the size of a property
350 *
351 * @node: node to check
352 * @propname: property to check
353 * @return size of property if present, or -EINVAL if not
354 */
355int ofnode_read_size(ofnode node, const char *propname);
356
357/**
Keerthye679d032019-04-24 17:19:53 +0530358 * ofnode_get_addr_size_index() - get an address/size from a node
359 * based on index
360 *
361 * This reads the register address/size from a node based on index
362 *
363 * @node: node to read from
364 * @index: Index of address to read (0 for first)
365 * @size: Pointer to size of the address
366 * @return address, or FDT_ADDR_T_NONE if not present or invalid
367 */
368phys_addr_t ofnode_get_addr_size_index(ofnode node, int index,
369 fdt_size_t *size);
370
371/**
Simon Glassbed77492017-05-18 20:09:01 -0600372 * ofnode_get_addr_index() - get an address from a node
373 *
374 * This reads the register address from a node
375 *
376 * @node: node to read from
377 * @index: Index of address to read (0 for first)
378 * @return address, or FDT_ADDR_T_NONE if not present or invalid
379 */
380phys_addr_t ofnode_get_addr_index(ofnode node, int index);
381
382/**
383 * ofnode_get_addr() - get an address from a node
384 *
385 * This reads the register address from a node
386 *
387 * @node: node to read from
388 * @return address, or FDT_ADDR_T_NONE if not present or invalid
389 */
390phys_addr_t ofnode_get_addr(ofnode node);
391
392/**
Simon Glass9e512042017-05-18 20:08:58 -0600393 * ofnode_stringlist_search() - find a string in a string list and return index
394 *
395 * Note that it is possible for this function to succeed on property values
396 * that are not NUL-terminated. That's because the function will stop after
397 * finding the first occurrence of @string. This can for example happen with
398 * small-valued cell properties, such as #address-cells, when searching for
399 * the empty string.
400 *
401 * @node: node to check
402 * @propname: name of the property containing the string list
403 * @string: string to look up in the string list
404 *
405 * @return:
406 * the index of the string in the list of strings
407 * -ENODATA if the property is not found
408 * -EINVAL on some other error
409 */
410int ofnode_stringlist_search(ofnode node, const char *propname,
411 const char *string);
412
413/**
Simon Glass8c293d62017-06-12 06:21:28 -0600414 * ofnode_read_string_index() - obtain an indexed string from a string list
Simon Glass9e512042017-05-18 20:08:58 -0600415 *
416 * Note that this will successfully extract strings from properties with
417 * non-NUL-terminated values. For example on small-valued cell properties
418 * this function will return the empty string.
419 *
420 * If non-NULL, the length of the string (on success) or a negative error-code
421 * (on failure) will be stored in the integer pointer to by lenp.
422 *
423 * @node: node to check
424 * @propname: name of the property containing the string list
425 * @index: index of the string to return
426 * @lenp: return location for the string length or an error code on failure
427 *
428 * @return:
429 * length of string, if found or -ve error value if not found
430 */
431int ofnode_read_string_index(ofnode node, const char *propname, int index,
432 const char **outp);
433
434/**
Simon Glass8c293d62017-06-12 06:21:28 -0600435 * ofnode_read_string_count() - find the number of strings in a string list
436 *
437 * @node: node to check
438 * @propname: name of the property containing the string list
439 * @return:
440 * number of strings in the list, or -ve error value if not found
441 */
442int ofnode_read_string_count(ofnode node, const char *property);
443
444/**
Simon Glass9e512042017-05-18 20:08:58 -0600445 * ofnode_parse_phandle_with_args() - Find a node pointed by phandle in a list
446 *
447 * This function is useful to parse lists of phandles and their arguments.
448 * Returns 0 on success and fills out_args, on error returns appropriate
449 * errno value.
450 *
451 * Caller is responsible to call of_node_put() on the returned out_args->np
452 * pointer.
453 *
454 * Example:
455 *
456 * phandle1: node1 {
457 * #list-cells = <2>;
458 * }
459 *
460 * phandle2: node2 {
461 * #list-cells = <1>;
462 * }
463 *
464 * node3 {
465 * list = <&phandle1 1 2 &phandle2 3>;
466 * }
467 *
468 * To get a device_node of the `node2' node you may call this:
469 * ofnode_parse_phandle_with_args(node3, "list", "#list-cells", 0, 1, &args);
470 *
471 * @node: device tree node containing a list
472 * @list_name: property name that contains a list
473 * @cells_name: property name that specifies phandles' arguments count
474 * @cells_count: Cell count to use if @cells_name is NULL
475 * @index: index of a phandle to parse out
476 * @out_args: optional pointer to output arguments structure (will be filled)
477 * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if
478 * @list_name does not exist, -EINVAL if a phandle was not found,
479 * @cells_name could not be found, the arguments were truncated or there
480 * were too many arguments.
481 */
482int ofnode_parse_phandle_with_args(ofnode node, const char *list_name,
483 const char *cells_name, int cell_count,
484 int index,
485 struct ofnode_phandle_args *out_args);
486
487/**
Patrice Chotard642346a2017-07-18 11:57:08 +0200488 * ofnode_count_phandle_with_args() - Count number of phandle in a list
489 *
490 * This function is useful to count phandles into a list.
491 * Returns number of phandle on success, on error returns appropriate
492 * errno value.
493 *
494 * @node: device tree node containing a list
495 * @list_name: property name that contains a list
496 * @cells_name: property name that specifies phandles' arguments count
497 * @return number of phandle on success, -ENOENT if @list_name does not
498 * exist, -EINVAL if a phandle was not found, @cells_name could not
499 * be found.
500 */
501int ofnode_count_phandle_with_args(ofnode node, const char *list_name,
502 const char *cells_name);
503
504/**
Simon Glass9e512042017-05-18 20:08:58 -0600505 * ofnode_path() - find a node by full path
506 *
507 * @path: Full path to node, e.g. "/bus/spi@1"
508 * @return reference to the node found. Use ofnode_valid() to check if it exists
509 */
510ofnode ofnode_path(const char *path);
511
512/**
513 * ofnode_get_chosen_prop() - get the value of a chosen property
514 *
515 * This looks for a property within the /chosen node and returns its value
516 *
517 * @propname: Property name to look for
Simon Glassfbe8d032018-06-11 13:07:11 -0600518 * @return property value if found, else NULL
Simon Glass9e512042017-05-18 20:08:58 -0600519 */
520const char *ofnode_get_chosen_prop(const char *propname);
521
522/**
523 * ofnode_get_chosen_node() - get the chosen node
524 *
525 * @return the chosen node if present, else ofnode_null()
526 */
527ofnode ofnode_get_chosen_node(const char *name);
528
529struct display_timing;
530/**
531 * ofnode_decode_display_timing() - decode display timings
532 *
533 * Decode display timings from the supplied 'display-timings' node.
534 * See doc/device-tree-bindings/video/display-timing.txt for binding
535 * information.
536 *
537 * @node 'display-timing' node containing the timing subnodes
538 * @index Index number to read (0=first timing subnode)
539 * @config Place to put timings
540 * @return 0 if OK, -FDT_ERR_NOTFOUND if not found
541 */
542int ofnode_decode_display_timing(ofnode node, int index,
543 struct display_timing *config);
544
545/**
Masahiro Yamada61e51ba2017-06-22 16:54:05 +0900546 * ofnode_get_property()- - get a pointer to the value of a node property
Simon Glass9e512042017-05-18 20:08:58 -0600547 *
548 * @node: node to read
549 * @propname: property to read
550 * @lenp: place to put length on success
551 * @return pointer to property, or NULL if not found
552 */
Masahiro Yamada61e51ba2017-06-22 16:54:05 +0900553const void *ofnode_get_property(ofnode node, const char *propname, int *lenp);
Simon Glass9e512042017-05-18 20:08:58 -0600554
555/**
556 * ofnode_is_available() - check if a node is marked available
557 *
558 * @node: node to check
559 * @return true if node's 'status' property is "okay" (or is missing)
560 */
561bool ofnode_is_available(ofnode node);
562
563/**
564 * ofnode_get_addr_size() - get address and size from a property
565 *
566 * This does no address translation. It simply reads an property that contains
567 * an address and a size value, one after the other.
568 *
569 * @node: node to read from
570 * @propname: property to read
571 * @sizep: place to put size value (on success)
572 * @return address value, or FDT_ADDR_T_NONE on error
573 */
574phys_addr_t ofnode_get_addr_size(ofnode node, const char *propname,
575 phys_size_t *sizep);
576
577/**
578 * ofnode_read_u8_array_ptr() - find an 8-bit array
579 *
580 * Look up a property in a node and return a pointer to its contents as a
581 * byte array of given length. The property must have at least enough data
582 * for the array (count bytes). It may have more, but this will be ignored.
583 * The data is not copied.
584 *
585 * @node node to examine
586 * @propname name of property to find
587 * @sz number of array elements
588 * @return pointer to byte array if found, or NULL if the property is not
589 * found or there is not enough data
590 */
591const uint8_t *ofnode_read_u8_array_ptr(ofnode node, const char *propname,
592 size_t sz);
593
594/**
595 * ofnode_read_pci_addr() - look up a PCI address
596 *
597 * Look at an address property in a node and return the PCI address which
598 * corresponds to the given type in the form of fdt_pci_addr.
599 * The property must hold one fdt_pci_addr with a lengh.
600 *
601 * @node node to examine
602 * @type pci address type (FDT_PCI_SPACE_xxx)
603 * @propname name of property to find
604 * @addr returns pci address in the form of fdt_pci_addr
605 * @return 0 if ok, -ENOENT if the property did not exist, -EINVAL if the
606 * format of the property was invalid, -ENXIO if the requested
607 * address type was not found
608 */
609int ofnode_read_pci_addr(ofnode node, enum fdt_pci_space type,
610 const char *propname, struct fdt_pci_addr *addr);
611
612/**
Bin Meng7b9cbad2018-08-03 01:14:35 -0700613 * ofnode_read_pci_vendev() - look up PCI vendor and device id
614 *
615 * Look at the compatible property of a device node that represents a PCI
616 * device and extract pci vendor id and device id from it.
617 *
618 * @param node node to examine
619 * @param vendor vendor id of the pci device
620 * @param device device id of the pci device
621 * @return 0 if ok, negative on error
622 */
623int ofnode_read_pci_vendev(ofnode node, u16 *vendor, u16 *device);
624
625/**
Simon Glass9e512042017-05-18 20:08:58 -0600626 * ofnode_read_addr_cells() - Get the number of address cells for a node
627 *
628 * This walks back up the tree to find the closest #address-cells property
629 * which controls the given node.
630 *
631 * @node: Node to check
632 * @return number of address cells this node uses
633 */
634int ofnode_read_addr_cells(ofnode node);
635
636/**
637 * ofnode_read_size_cells() - Get the number of size cells for a node
638 *
639 * This walks back up the tree to find the closest #size-cells property
640 * which controls the given node.
641 *
642 * @node: Node to check
643 * @return number of size cells this node uses
644 */
645int ofnode_read_size_cells(ofnode node);
646
647/**
Simon Glass878d68c2017-06-12 06:21:31 -0600648 * ofnode_read_simple_addr_cells() - Get the address cells property in a node
649 *
650 * This function matches fdt_address_cells().
651 *
652 * @np: Node pointer to check
653 * @return value of #address-cells property in this node, or 2 if none
654 */
655int ofnode_read_simple_addr_cells(ofnode node);
656
657/**
658 * ofnode_read_simple_size_cells() - Get the size cells property in a node
659 *
660 * This function matches fdt_size_cells().
661 *
662 * @np: Node pointer to check
663 * @return value of #size-cells property in this node, or 2 if none
664 */
665int ofnode_read_simple_size_cells(ofnode node);
666
667/**
Simon Glass9e512042017-05-18 20:08:58 -0600668 * ofnode_pre_reloc() - check if a node should be bound before relocation
669 *
670 * Device tree nodes can be marked as needing-to-be-bound in the loader stages
671 * via special device tree properties.
672 *
673 * Before relocation this function can be used to check if nodes are required
674 * in either SPL or TPL stages.
675 *
676 * After relocation and jumping into the real U-Boot binary it is possible to
677 * determine if a node was bound in one of SPL/TPL stages.
678 *
Patrick Delaunay54e12232019-05-21 19:19:13 +0200679 * There are 4 settings currently in use
680 * - u-boot,dm-pre-proper: U-Boot proper pre-relocation only
Simon Glass9e512042017-05-18 20:08:58 -0600681 * - u-boot,dm-pre-reloc: legacy and indicates any of TPL or SPL
682 * Existing platforms only use it to indicate nodes needed in
683 * SPL. Should probably be replaced by u-boot,dm-spl for
684 * new platforms.
Patrick Delaunay54e12232019-05-21 19:19:13 +0200685 * - u-boot,dm-spl: SPL and U-Boot pre-relocation
686 * - u-boot,dm-tpl: TPL and U-Boot pre-relocation
Simon Glass9e512042017-05-18 20:08:58 -0600687 *
688 * @node: node to check
Simon Glassfbe8d032018-06-11 13:07:11 -0600689 * @return true if node is needed in SPL/TL, false otherwise
Simon Glass9e512042017-05-18 20:08:58 -0600690 */
691bool ofnode_pre_reloc(ofnode node);
692
Simon Glassc98ad442018-06-11 13:07:12 -0600693/**
694 * ofnode_read_resource() - Read a resource from a node
695 *
696 * Read resource information from a node at the given index
697 *
698 * @node: Node to read from
699 * @index: Index of resource to read (0 = first)
700 * @res: Returns resource that was read, on success
701 * @return 0 if OK, -ve on error
702 */
Simon Glassdcf98852017-07-25 08:29:55 -0600703int ofnode_read_resource(ofnode node, uint index, struct resource *res);
Simon Glassc98ad442018-06-11 13:07:12 -0600704
705/**
706 * ofnode_read_resource_byname() - Read a resource from a node by name
707 *
708 * Read resource information from a node matching the given name. This uses a
709 * 'reg-names' string list property with the names matching the associated
710 * 'reg' property list.
711 *
712 * @node: Node to read from
713 * @name: Name of resource to read
714 * @res: Returns resource that was read, on success
715 * @return 0 if OK, -ve on error
716 */
Masahiro Yamada7b8b47b2017-08-26 01:12:30 +0900717int ofnode_read_resource_byname(ofnode node, const char *name,
718 struct resource *res);
Simon Glassdcf98852017-07-25 08:29:55 -0600719
Simon Glass3991f422017-08-05 15:45:54 -0600720/**
Simon Glassc60f6712018-06-11 13:07:13 -0600721 * ofnode_by_compatible() - Find the next compatible node
722 *
723 * Find the next node after @from that is compatible with @compat
724 *
725 * @from: ofnode to start from (use ofnode_null() to start at the beginning)
726 * @compat: Compatible string to match
727 * @return ofnode found, or ofnode_null() if none
728 */
729ofnode ofnode_by_compatible(ofnode from, const char *compat);
730
731/**
Jens Wiklander61fba0f2018-08-20 11:09:58 +0200732 * ofnode_by_prop_value() - Find the next node with given property value
733 *
734 * Find the next node after @from that has a @propname with a value
735 * @propval and a length @proplen.
736 *
737 * @from: ofnode to start from (use ofnode_null() to start at the
738 * beginning) @propname: property name to check @propval: property value to
739 * search for @proplen: length of the value in propval @return ofnode
740 * found, or ofnode_null() if none
741 */
742ofnode ofnode_by_prop_value(ofnode from, const char *propname,
743 const void *propval, int proplen);
744
745/**
Simon Glass3991f422017-08-05 15:45:54 -0600746 * ofnode_for_each_subnode() - iterate over all subnodes of a parent
747 *
748 * @node: child node (ofnode, lvalue)
749 * @parent: parent node (ofnode)
750 *
751 * This is a wrapper around a for loop and is used like so:
752 *
753 * ofnode node;
754 *
755 * ofnode_for_each_subnode(node, parent) {
756 * Use node
757 * ...
758 * }
759 *
760 * Note that this is implemented as a macro and @node is used as
761 * iterator in the loop. The parent variable can be a constant or even a
762 * literal.
763 */
764#define ofnode_for_each_subnode(node, parent) \
765 for (node = ofnode_first_subnode(parent); \
766 ofnode_valid(node); \
767 node = ofnode_next_subnode(node))
768
Mario Six147c6072018-01-15 11:07:19 +0100769/**
Fabien Dessenne641067f2019-05-31 15:11:30 +0200770 * ofnode_translate_address() - Translate a device-tree address
Mario Six147c6072018-01-15 11:07:19 +0100771 *
772 * Translate an address from the device-tree into a CPU physical address. This
773 * function walks up the tree and applies the various bus mappings along the
774 * way.
775 *
776 * @ofnode: Device tree node giving the context in which to translate the
777 * address
778 * @in_addr: pointer to the address to translate
779 * @return the translated address; OF_BAD_ADDR on error
780 */
781u64 ofnode_translate_address(ofnode node, const fdt32_t *in_addr);
Masahiro Yamada5ccc2c22018-04-19 12:14:02 +0900782
783/**
Fabien Dessenne641067f2019-05-31 15:11:30 +0200784 * ofnode_translate_dma_address() - Translate a device-tree DMA address
785 *
786 * Translate a DMA address from the device-tree into a CPU physical address.
787 * This function walks up the tree and applies the various bus mappings along
788 * the way.
789 *
790 * @ofnode: Device tree node giving the context in which to translate the
791 * DMA address
792 * @in_addr: pointer to the DMA address to translate
793 * @return the translated DMA address; OF_BAD_ADDR on error
794 */
795u64 ofnode_translate_dma_address(ofnode node, const fdt32_t *in_addr);
796
797/**
Masahiro Yamada5ccc2c22018-04-19 12:14:02 +0900798 * ofnode_device_is_compatible() - check if the node is compatible with compat
799 *
800 * This allows to check whether the node is comaptible with the compat.
801 *
802 * @node: Device tree node for which compatible needs to be verified.
803 * @compat: Compatible string which needs to verified in the given node.
804 * @return true if OK, false if the compatible is not found
805 */
806int ofnode_device_is_compatible(ofnode node, const char *compat);
Mario Sixe369e582018-06-26 08:46:48 +0200807
808/**
809 * ofnode_write_prop() - Set a property of a ofnode
810 *
811 * Note that the value passed to the function is *not* allocated by the
812 * function itself, but must be allocated by the caller if necessary.
813 *
814 * @node: The node for whose property should be set
815 * @propname: The name of the property to set
816 * @len: The length of the new value of the property
817 * @value: The new value of the property (must be valid prior to calling
818 * the function)
819 * @return 0 if successful, -ve on error
820 */
821int ofnode_write_prop(ofnode node, const char *propname, int len,
822 const void *value);
823
824/**
825 * ofnode_write_string() - Set a string property of a ofnode
826 *
827 * Note that the value passed to the function is *not* allocated by the
828 * function itself, but must be allocated by the caller if necessary.
829 *
830 * @node: The node for whose string property should be set
831 * @propname: The name of the string property to set
832 * @value: The new value of the string property (must be valid prior to
833 * calling the function)
834 * @return 0 if successful, -ve on error
835 */
836int ofnode_write_string(ofnode node, const char *propname, const char *value);
837
838/**
839 * ofnode_set_enabled() - Enable or disable a device tree node given by its
840 * ofnode
841 *
842 * This function effectively sets the node's "status" property to either "okay"
843 * or "disable", hence making it available for driver model initialization or
844 * not.
845 *
846 * @node: The node to enable
847 * @value: Flag that tells the function to either disable or enable the
848 * node
849 * @return 0 if successful, -ve on error
850 */
851int ofnode_set_enabled(ofnode node, bool value);
852
Simon Glass4984de22017-05-17 17:18:10 -0600853#endif