dm: core: Add ofnode function to read a 64-bit int
[pandora-u-boot.git] / include / dm / ofnode.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * Copyright (c) 2017 Google, Inc
4  * Written by Simon Glass <sjg@chromium.org>
5  */
6
7 #ifndef _DM_OFNODE_H
8 #define _DM_OFNODE_H
9
10 /* 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
17 struct resource;
18
19 /**
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
31  * here is NULL. This corresponds to a struct device_node * value of
32  * 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
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.
49  */
50 typedef union ofnode_union {
51         const struct device_node *np;   /* will be used for future live tree */
52         long of_offset;
53 } ofnode;
54
55 struct 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  */
69 static 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
78 /**
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  */
86 static inline int ofnode_to_offset(ofnode node)
87 {
88 #ifdef OF_CHECKS
89         if (of_live_active())
90                 return -1;
91 #endif
92         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  */
100 static inline bool ofnode_valid(ofnode node)
101 {
102         if (of_live_active())
103                 return node.np != NULL;
104         else
105                 return node.of_offset != -1;
106 }
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  */
114 static inline ofnode offset_to_ofnode(int of_offset)
115 {
116         ofnode node;
117
118         if (of_live_active())
119                 node.np = NULL;
120         else
121                 node.of_offset = of_offset;
122
123         return node;
124 }
125
126 /**
127  * 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  */
132 static 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  */
152 static 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 /**
167  * ofnode_equal() - check if two references are equal
168  *
169  * @return true if equal, else false
170  */
171 static 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
177 /**
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  */
183 static 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  */
203 int 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  */
213 static 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  */
227 int ofnode_read_u32_default(ofnode ref, const char *propname, u32 def);
228
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  */
237 int ofnode_read_s32_default(ofnode node, const char *propname, s32 def);
238
239 /**
240  * ofnode_read_u64_default() - Read a 64-bit integer from a property
241  *
242  * @ref:        valid node reference to read property from
243  * @propname:   name of the property to read from
244  * @def:        default value to return if the property has no value
245  * @return property value, or @def if not found
246  */
247 int ofnode_read_u64_default(ofnode node, const char *propname, u64 def);
248
249 /**
250  * ofnode_read_string() - Read a string from a property
251  *
252  * @ref:        valid node reference to read property from
253  * @propname:   name of the property to read
254  * @return string from property value, or NULL if there is no such property
255  */
256 const char *ofnode_read_string(ofnode node, const char *propname);
257
258 /**
259  * ofnode_read_u32_array() - Find and read an array of 32 bit integers
260  *
261  * @node:       valid node reference to read property from
262  * @propname:   name of the property to read
263  * @out_values: pointer to return value, modified only if return value is 0
264  * @sz:         number of array elements to read
265  *
266  * Search for a property in a device node and read 32-bit value(s) from
267  * it. Returns 0 on success, -EINVAL if the property does not exist,
268  * -ENODATA if property does not have a value, and -EOVERFLOW if the
269  * property data isn't large enough.
270  *
271  * The out_values is modified only if a valid u32 value can be decoded.
272  */
273 int ofnode_read_u32_array(ofnode node, const char *propname,
274                           u32 *out_values, size_t sz);
275
276 /**
277  * ofnode_read_bool() - read a boolean value from a property
278  *
279  * @node:       valid node reference to read property from
280  * @propname:   name of property to read
281  * @return true if property is present (meaning true), false if not present
282  */
283 bool ofnode_read_bool(ofnode node, const char *propname);
284
285 /**
286  * ofnode_find_subnode() - find a named subnode of a parent node
287  *
288  * @node:       valid reference to parent node
289  * @subnode_name: name of subnode to find
290  * @return reference to subnode (which can be invalid if there is no such
291  * subnode)
292  */
293 ofnode ofnode_find_subnode(ofnode node, const char *subnode_name);
294
295 /**
296  * ofnode_first_subnode() - find the first subnode of a parent node
297  *
298  * @node:       valid reference to a valid parent node
299  * @return reference to the first subnode (which can be invalid if the parent
300  * node has no subnodes)
301  */
302 ofnode ofnode_first_subnode(ofnode node);
303
304 /**
305  * ofnode_next_subnode() - find the next sibling of a subnode
306  *
307  * @node:       valid reference to previous node (sibling)
308  * @return reference to the next subnode (which can be invalid if the node
309  * has no more siblings)
310  */
311 ofnode ofnode_next_subnode(ofnode node);
312
313 /**
314  * ofnode_get_parent() - get the ofnode's parent (enclosing ofnode)
315  *
316  * @node: valid node to look up
317  * @return ofnode reference of the parent node
318  */
319 ofnode ofnode_get_parent(ofnode node);
320
321 /**
322  * ofnode_get_name() - get the name of a node
323  *
324  * @node: valid node to look up
325  * @return name or node
326  */
327 const char *ofnode_get_name(ofnode node);
328
329 /**
330  * ofnode_get_by_phandle() - get ofnode from phandle
331  *
332  * @phandle:    phandle to look up
333  * @return ofnode reference to the phandle
334  */
335 ofnode ofnode_get_by_phandle(uint phandle);
336
337 /**
338  * ofnode_read_size() - read the size of a property
339  *
340  * @node: node to check
341  * @propname: property to check
342  * @return size of property if present, or -EINVAL if not
343  */
344 int ofnode_read_size(ofnode node, const char *propname);
345
346 /**
347  * ofnode_get_addr_index() - get an address from a node
348  *
349  * This reads the register address from a node
350  *
351  * @node: node to read from
352  * @index: Index of address to read (0 for first)
353  * @return address, or FDT_ADDR_T_NONE if not present or invalid
354  */
355 phys_addr_t ofnode_get_addr_index(ofnode node, int index);
356
357 /**
358  * ofnode_get_addr() - get an address from a node
359  *
360  * This reads the register address from a node
361  *
362  * @node: node to read from
363  * @return address, or FDT_ADDR_T_NONE if not present or invalid
364  */
365 phys_addr_t ofnode_get_addr(ofnode node);
366
367 /**
368  * ofnode_stringlist_search() - find a string in a string list and return index
369  *
370  * Note that it is possible for this function to succeed on property values
371  * that are not NUL-terminated. That's because the function will stop after
372  * finding the first occurrence of @string. This can for example happen with
373  * small-valued cell properties, such as #address-cells, when searching for
374  * the empty string.
375  *
376  * @node: node to check
377  * @propname: name of the property containing the string list
378  * @string: string to look up in the string list
379  *
380  * @return:
381  *   the index of the string in the list of strings
382  *   -ENODATA if the property is not found
383  *   -EINVAL on some other error
384  */
385 int ofnode_stringlist_search(ofnode node, const char *propname,
386                              const char *string);
387
388 /**
389  * ofnode_read_string_index() - obtain an indexed string from a string list
390  *
391  * Note that this will successfully extract strings from properties with
392  * non-NUL-terminated values. For example on small-valued cell properties
393  * this function will return the empty string.
394  *
395  * If non-NULL, the length of the string (on success) or a negative error-code
396  * (on failure) will be stored in the integer pointer to by lenp.
397  *
398  * @node: node to check
399  * @propname: name of the property containing the string list
400  * @index: index of the string to return
401  * @lenp: return location for the string length or an error code on failure
402  *
403  * @return:
404  *   length of string, if found or -ve error value if not found
405  */
406 int ofnode_read_string_index(ofnode node, const char *propname, int index,
407                              const char **outp);
408
409 /**
410  * ofnode_read_string_count() - find the number of strings in a string list
411  *
412  * @node: node to check
413  * @propname: name of the property containing the string list
414  * @return:
415  *   number of strings in the list, or -ve error value if not found
416  */
417 int ofnode_read_string_count(ofnode node, const char *property);
418
419 /**
420  * ofnode_parse_phandle_with_args() - Find a node pointed by phandle in a list
421  *
422  * This function is useful to parse lists of phandles and their arguments.
423  * Returns 0 on success and fills out_args, on error returns appropriate
424  * errno value.
425  *
426  * Caller is responsible to call of_node_put() on the returned out_args->np
427  * pointer.
428  *
429  * Example:
430  *
431  * phandle1: node1 {
432  *      #list-cells = <2>;
433  * }
434  *
435  * phandle2: node2 {
436  *      #list-cells = <1>;
437  * }
438  *
439  * node3 {
440  *      list = <&phandle1 1 2 &phandle2 3>;
441  * }
442  *
443  * To get a device_node of the `node2' node you may call this:
444  * ofnode_parse_phandle_with_args(node3, "list", "#list-cells", 0, 1, &args);
445  *
446  * @node:       device tree node containing a list
447  * @list_name:  property name that contains a list
448  * @cells_name: property name that specifies phandles' arguments count
449  * @cells_count: Cell count to use if @cells_name is NULL
450  * @index:      index of a phandle to parse out
451  * @out_args:   optional pointer to output arguments structure (will be filled)
452  * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if
453  *      @list_name does not exist, -EINVAL if a phandle was not found,
454  *      @cells_name could not be found, the arguments were truncated or there
455  *      were too many arguments.
456  */
457 int ofnode_parse_phandle_with_args(ofnode node, const char *list_name,
458                                    const char *cells_name, int cell_count,
459                                    int index,
460                                    struct ofnode_phandle_args *out_args);
461
462 /**
463  * ofnode_count_phandle_with_args() - Count number of phandle in a list
464  *
465  * This function is useful to count phandles into a list.
466  * Returns number of phandle on success, on error returns appropriate
467  * errno value.
468  *
469  * @node:       device tree node containing a list
470  * @list_name:  property name that contains a list
471  * @cells_name: property name that specifies phandles' arguments count
472  * @return number of phandle on success, -ENOENT if @list_name does not
473  *      exist, -EINVAL if a phandle was not found, @cells_name could not
474  *      be found.
475  */
476 int ofnode_count_phandle_with_args(ofnode node, const char *list_name,
477                                    const char *cells_name);
478
479 /**
480  * ofnode_path() - find a node by full path
481  *
482  * @path: Full path to node, e.g. "/bus/spi@1"
483  * @return reference to the node found. Use ofnode_valid() to check if it exists
484  */
485 ofnode ofnode_path(const char *path);
486
487 /**
488  * ofnode_get_chosen_prop() - get the value of a chosen property
489  *
490  * This looks for a property within the /chosen node and returns its value
491  *
492  * @propname: Property name to look for
493  */
494 const char *ofnode_get_chosen_prop(const char *propname);
495
496 /**
497  * ofnode_get_chosen_node() - get the chosen node
498  *
499  * @return the chosen node if present, else ofnode_null()
500  */
501 ofnode ofnode_get_chosen_node(const char *name);
502
503 struct display_timing;
504 /**
505  * ofnode_decode_display_timing() - decode display timings
506  *
507  * Decode display timings from the supplied 'display-timings' node.
508  * See doc/device-tree-bindings/video/display-timing.txt for binding
509  * information.
510  *
511  * @node        'display-timing' node containing the timing subnodes
512  * @index       Index number to read (0=first timing subnode)
513  * @config      Place to put timings
514  * @return 0 if OK, -FDT_ERR_NOTFOUND if not found
515  */
516 int ofnode_decode_display_timing(ofnode node, int index,
517                                  struct display_timing *config);
518
519 /**
520  * ofnode_get_property()- - get a pointer to the value of a node property
521  *
522  * @node: node to read
523  * @propname: property to read
524  * @lenp: place to put length on success
525  * @return pointer to property, or NULL if not found
526  */
527 const void *ofnode_get_property(ofnode node, const char *propname, int *lenp);
528
529 /**
530  * ofnode_is_available() - check if a node is marked available
531  *
532  * @node: node to check
533  * @return true if node's 'status' property is "okay" (or is missing)
534  */
535 bool ofnode_is_available(ofnode node);
536
537 /**
538  * ofnode_get_addr_size() - get address and size from a property
539  *
540  * This does no address translation. It simply reads an property that contains
541  * an address and a size value, one after the other.
542  *
543  * @node: node to read from
544  * @propname: property to read
545  * @sizep: place to put size value (on success)
546  * @return address value, or FDT_ADDR_T_NONE on error
547  */
548 phys_addr_t ofnode_get_addr_size(ofnode node, const char *propname,
549                                  phys_size_t *sizep);
550
551 /**
552  * ofnode_read_u8_array_ptr() - find an 8-bit array
553  *
554  * Look up a property in a node and return a pointer to its contents as a
555  * byte array of given length. The property must have at least enough data
556  * for the array (count bytes). It may have more, but this will be ignored.
557  * The data is not copied.
558  *
559  * @node        node to examine
560  * @propname    name of property to find
561  * @sz          number of array elements
562  * @return pointer to byte array if found, or NULL if the property is not
563  *              found or there is not enough data
564  */
565 const uint8_t *ofnode_read_u8_array_ptr(ofnode node, const char *propname,
566                                         size_t sz);
567
568 /**
569  * ofnode_read_pci_addr() - look up a PCI address
570  *
571  * Look at an address property in a node and return the PCI address which
572  * corresponds to the given type in the form of fdt_pci_addr.
573  * The property must hold one fdt_pci_addr with a lengh.
574  *
575  * @node        node to examine
576  * @type        pci address type (FDT_PCI_SPACE_xxx)
577  * @propname    name of property to find
578  * @addr        returns pci address in the form of fdt_pci_addr
579  * @return 0 if ok, -ENOENT if the property did not exist, -EINVAL if the
580  *              format of the property was invalid, -ENXIO if the requested
581  *              address type was not found
582  */
583 int ofnode_read_pci_addr(ofnode node, enum fdt_pci_space type,
584                          const char *propname, struct fdt_pci_addr *addr);
585
586 /**
587  * ofnode_read_addr_cells() - Get the number of address cells for a node
588  *
589  * This walks back up the tree to find the closest #address-cells property
590  * which controls the given node.
591  *
592  * @node: Node to check
593  * @return number of address cells this node uses
594  */
595 int ofnode_read_addr_cells(ofnode node);
596
597 /**
598  * ofnode_read_size_cells() - Get the number of size cells for a node
599  *
600  * This walks back up the tree to find the closest #size-cells property
601  * which controls the given node.
602  *
603  * @node: Node to check
604  * @return number of size cells this node uses
605  */
606 int ofnode_read_size_cells(ofnode node);
607
608 /**
609  * ofnode_read_simple_addr_cells() - Get the address cells property in a node
610  *
611  * This function matches fdt_address_cells().
612  *
613  * @np: Node pointer to check
614  * @return value of #address-cells property in this node, or 2 if none
615  */
616 int ofnode_read_simple_addr_cells(ofnode node);
617
618 /**
619  * ofnode_read_simple_size_cells() - Get the size cells property in a node
620  *
621  * This function matches fdt_size_cells().
622  *
623  * @np: Node pointer to check
624  * @return value of #size-cells property in this node, or 2 if none
625  */
626 int ofnode_read_simple_size_cells(ofnode node);
627
628 /**
629  * ofnode_pre_reloc() - check if a node should be bound before relocation
630  *
631  * Device tree nodes can be marked as needing-to-be-bound in the loader stages
632  * via special device tree properties.
633  *
634  * Before relocation this function can be used to check if nodes are required
635  * in either SPL or TPL stages.
636  *
637  * After relocation and jumping into the real U-Boot binary it is possible to
638  * determine if a node was bound in one of SPL/TPL stages.
639  *
640  * There are 3 settings currently in use
641  * -
642  * - u-boot,dm-pre-reloc: legacy and indicates any of TPL or SPL
643  *   Existing platforms only use it to indicate nodes needed in
644  *   SPL. Should probably be replaced by u-boot,dm-spl for
645  *   new platforms.
646  *
647  * @node: node to check
648  * @eturns true if node is needed in SPL/TL, false otherwise
649  */
650 bool ofnode_pre_reloc(ofnode node);
651
652 int ofnode_read_resource(ofnode node, uint index, struct resource *res);
653 int ofnode_read_resource_byname(ofnode node, const char *name,
654                                 struct resource *res);
655
656 /**
657  * ofnode_for_each_subnode() - iterate over all subnodes of a parent
658  *
659  * @node:       child node (ofnode, lvalue)
660  * @parent:     parent node (ofnode)
661  *
662  * This is a wrapper around a for loop and is used like so:
663  *
664  *      ofnode node;
665  *
666  *      ofnode_for_each_subnode(node, parent) {
667  *              Use node
668  *              ...
669  *      }
670  *
671  * Note that this is implemented as a macro and @node is used as
672  * iterator in the loop. The parent variable can be a constant or even a
673  * literal.
674  */
675 #define ofnode_for_each_subnode(node, parent) \
676         for (node = ofnode_first_subnode(parent); \
677              ofnode_valid(node); \
678              node = ofnode_next_subnode(node))
679
680 /**
681  * ofnode_translate_address() - Tranlate a device-tree address
682  *
683  * Translate an address from the device-tree into a CPU physical address. This
684  * function walks up the tree and applies the various bus mappings along the
685  * way.
686  *
687  * @ofnode: Device tree node giving the context in which to translate the
688  *          address
689  * @in_addr: pointer to the address to translate
690  * @return the translated address; OF_BAD_ADDR on error
691  */
692 u64 ofnode_translate_address(ofnode node, const fdt32_t *in_addr);
693
694 /**
695  * ofnode_device_is_compatible() - check if the node is compatible with compat
696  *
697  * This allows to check whether the node is comaptible with the compat.
698  *
699  * @node:       Device tree node for which compatible needs to be verified.
700  * @compat:     Compatible string which needs to verified in the given node.
701  * @return true if OK, false if the compatible is not found
702  */
703 int ofnode_device_is_compatible(ofnode node, const char *compat);
704 #endif