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 #include <dm/of_access.h>
  14 #include <log.h>
  15
  16 /* Enable checks to protect against invalid calls */
  17 #undef OF_CHECKS
  18
  19 struct resource;
  20
  21 /**
  22  * ofnode - reference to a device tree node
  23  *
  24  * This union can hold either a straightforward pointer to a struct device_node
  25  * in the live device tree, or an offset within the flat device tree. In the
  26  * latter case, the pointer value is just the integer offset within the flat DT.
  27  *
  28  * Thus we can reference nodes in both the live tree (once available) and the
  29  * flat tree (until then). Functions are available to translate between an
  30  * ofnode and either an offset or a struct device_node *.
  31  *
  32  * The reference can also hold a null offset, in which case the pointer value
  33  * here is NULL. This corresponds to a struct device_node * value of
  34  * NULL, or an offset of -1.
  35  *
  36  * There is no ambiguity as to whether ofnode holds an offset or a node
  37  * pointer: when the live tree is active it holds a node pointer, otherwise it
  38  * holds an offset. The value itself does not need to be unique and in theory
  39  * the same value could point to a valid device node or a valid offset. We
  40  * could arrange for a unique value to be used (e.g. by making the pointer
  41  * point to an offset within the flat device tree in the case of an offset) but
  42  * this increases code size slightly due to the subtraction. Since it offers no
  43  * real benefit, the approach described here seems best.
  44  *
  45  * For now these points use constant types, since we don't allow writing
  46  * the DT.
  47  *
  48  * @np: Pointer to device node, used for live tree
  49  * @of_offset: Pointer into flat device tree, used for flat tree. Note that this
  50  *      is not a really a pointer to a node: it is an offset value. See above.
  51  */
  52 typedef union ofnode_union {
  53         const struct device_node *np;
  54         long of_offset;
  55 } ofnode;
  56
  57 struct ofnode_phandle_args {
  58         ofnode node;
  59         int args_count;
  60         uint32_t args[OF_MAX_PHANDLE_ARGS];
  61 };
  62
  63 /**
  64  * ofprop - reference to a property of a device tree node
  65  *
  66  * This struct hold the reference on one property of one node,
  67  * using struct ofnode and an offset within the flat device tree or either
  68  * a pointer to a struct property in the live device tree.
  69  *
  70  * Thus we can reference arguments in both the live tree and the flat tree.
  71  *
  72  * The property reference can also hold a null reference. This corresponds to
  73  * a struct property NULL pointer or an offset of -1.
  74  *
  75  * @node: Pointer to device node
  76  * @offset: Pointer into flat device tree, used for flat tree.
  77  * @prop: Pointer to property, used for live treee.
  78  */
  79
  80 struct ofprop {
  81         ofnode node;
  82         union {
  83                 int offset;
  84                 const struct property *prop;
  85         };
  86 };
  87
  88 /**
  89  * ofnode_to_np() - convert an ofnode to a live DT node pointer
  90  *
  91  * This cannot be called if the reference contains an offset.
  92  *
  93  * @node: Reference containing struct device_node * (possibly invalid)
  94  * @return pointer to device node (can be NULL)
  95  */
  96 static inline const struct device_node *ofnode_to_np(ofnode node)
  97 {
  98 #ifdef OF_CHECKS
  99         if (!of_live_active())
 100                 return NULL;
 101 #endif
 102         return node.np;
 103 }
 104
 105 /**
 106  * ofnode_to_offset() - convert an ofnode to a flat DT offset
 107  *
 108  * This cannot be called if the reference contains a node pointer.
 109  *
 110  * @node: Reference containing offset (possibly invalid)
 111  * @return DT offset (can be -1)
 112  */
 113 static inline int ofnode_to_offset(ofnode node)
 114 {
 115 #ifdef OF_CHECKS
 116         if (of_live_active())
 117                 return -1;
 118 #endif
 119         return node.of_offset;
 120 }
 121
 122 /**
 123  * ofnode_valid() - check if an ofnode is valid
 124  *
 125  * @return true if the reference contains a valid ofnode, false if it is NULL
 126  */
 127 static inline bool ofnode_valid(ofnode node)
 128 {
 129         if (of_live_active())
 130                 return node.np != NULL;
 131         else
 132                 return node.of_offset >= 0;
 133 }
 134
 135 /**
 136  * offset_to_ofnode() - convert a DT offset to an ofnode
 137  *
 138  * @of_offset: DT offset (either valid, or -1)
 139  * @return reference to the associated DT offset
 140  */
 141 static inline ofnode offset_to_ofnode(int of_offset)
 142 {
 143         ofnode node;
 144
 145         if (of_live_active())
 146                 node.np = NULL;
 147         else
 148                 node.of_offset = of_offset >= 0 ? of_offset : -1;
 149
 150         return node;
 151 }
 152
 153 /**
 154  * np_to_ofnode() - convert a node pointer to an ofnode
 155  *
 156  * @np: Live node pointer (can be NULL)
 157  * @return reference to the associated node pointer
 158  */
 159 static inline ofnode np_to_ofnode(const struct device_node *np)
 160 {
 161         ofnode node;
 162
 163         node.np = np;
 164
 165         return node;
 166 }
 167
 168 /**
 169  * ofnode_is_np() - check if a reference is a node pointer
 170  *
 171  * This function associated that if there is a valid live tree then all
 172  * references will use it. This is because using the flat DT when the live tree
 173  * is valid is not permitted.
 174  *
 175  * @node: reference to check (possibly invalid)
 176  * @return true if the reference is a live node pointer, false if it is a DT
 177  * offset
 178  */
 179 static inline bool ofnode_is_np(ofnode node)
 180 {
 181 #ifdef OF_CHECKS
 182         /*
 183          * Check our assumption that flat tree offsets are not used when a
 184          * live tree is in use.
 185          */
 186         assert(!ofnode_valid(node) ||
 187                (of_live_active() ? ofnode_to_np(node)
 188                                   : ofnode_to_np(node)));
 189 #endif
 190         return of_live_active() && ofnode_valid(node);
 191 }
 192
 193 /**
 194  * ofnode_equal() - check if two references are equal
 195  *
 196  * @return true if equal, else false
 197  */
 198 static inline bool ofnode_equal(ofnode ref1, ofnode ref2)
 199 {
 200         /* We only need to compare the contents */
 201         return ref1.of_offset == ref2.of_offset;
 202 }
 203
 204 /**
 205  * ofnode_null() - Obtain a null ofnode
 206  *
 207  * This returns an ofnode which points to no node. It works both with the flat
 208  * tree and livetree.
 209  */
 210 static inline ofnode ofnode_null(void)
 211 {
 212         ofnode node;
 213
 214         if (of_live_active())
 215                 node.np = NULL;
 216         else
 217                 node.of_offset = -1;
 218
 219         return node;
 220 }
 221
 222 static inline ofnode ofnode_root(void)
 223 {
 224         ofnode node;
 225
 226         if (of_live_active())
 227                 node.np = gd_of_root();
 228         else
 229                 node.of_offset = 0;
 230
 231         return node;
 232 }
 233
 234 /**
 235  * ofnode_name_eq() - Check if the node name is equivalent to a given name
 236  *                    ignoring the unit address
 237  *
 238  * @node:       valid node reference that has to be compared
 239  * @name:       name that has to be compared with the node name
 240  * @return true if matches, false if it doesn't match
 241  */
 242 bool ofnode_name_eq(ofnode node, const char *name);
 243
 244 /**
 245  * ofnode_read_u32() - Read a 32-bit integer from a property
 246  *
 247  * @ref:        valid node reference to read property from
 248  * @propname:   name of the property to read from
 249  * @outp:       place to put value (if found)
 250  * @return 0 if OK, -ve on error
 251  */
 252 int ofnode_read_u32(ofnode node, const char *propname, u32 *outp);
 253
 254 /**
 255  * ofnode_read_u32_index() - Read a 32-bit integer from a multi-value property
 256  *
 257  * @ref:        valid node reference to read property from
 258  * @propname:   name of the property to read from
 259  * @index:      index of the integer to return
 260  * @outp:       place to put value (if found)
 261  * @return 0 if OK, -ve on error
 262  */
 263 int ofnode_read_u32_index(ofnode node, const char *propname, int index,
 264                           u32 *outp);
 265
 266 /**
 267  * ofnode_read_s32() - Read a 32-bit integer from a property
 268  *
 269  * @ref:        valid node reference to read property from
 270  * @propname:   name of the property to read from
 271  * @outp:       place to put value (if found)
 272  * @return 0 if OK, -ve on error
 273  */
 274 static inline int ofnode_read_s32(ofnode node, const char *propname,
 275                                   s32 *out_value)
 276 {
 277         return ofnode_read_u32(node, propname, (u32 *)out_value);
 278 }
 279
 280 /**
 281  * ofnode_read_u32_default() - Read a 32-bit integer from a property
 282  *
 283  * @ref:        valid node reference to read property from
 284  * @propname:   name of the property to read from
 285  * @def:        default value to return if the property has no value
 286  * @return property value, or @def if not found
 287  */
 288 u32 ofnode_read_u32_default(ofnode ref, const char *propname, u32 def);
 289
 290 /**
 291  * ofnode_read_u32_index_default() - Read a 32-bit integer from a multi-value
 292  *                                   property
 293  *
 294  * @ref:        valid node reference to read property from
 295  * @propname:   name of the property to read from
 296  * @index:      index of the integer to return
 297  * @def:        default value to return if the property has no value
 298  * @return property value, or @def if not found
 299  */
 300 u32 ofnode_read_u32_index_default(ofnode ref, const char *propname, int index,
 301                                   u32 def);
 302
 303 /**
 304  * ofnode_read_s32_default() - Read a 32-bit integer from a property
 305  *
 306  * @ref:        valid node reference to read property from
 307  * @propname:   name of the property to read from
 308  * @def:        default value to return if the property has no value
 309  * @return property value, or @def if not found
 310  */
 311 int ofnode_read_s32_default(ofnode node, const char *propname, s32 def);
 312
 313 /**
 314  * ofnode_read_u64() - Read a 64-bit integer from a property
 315  *
 316  * @node:       valid node reference to read property from
 317  * @propname:   name of the property to read from
 318  * @outp:       place to put value (if found)
 319  * @return 0 if OK, -ve on error
 320  */
 321 int ofnode_read_u64(ofnode node, const char *propname, u64 *outp);
 322
 323 /**
 324  * ofnode_read_u64_default() - Read a 64-bit integer from a property
 325  *
 326  * @ref:        valid node reference to read property from
 327  * @propname:   name of the property to read from
 328  * @def:        default value to return if the property has no value
 329  * @return property value, or @def if not found
 330  */
 331 u64 ofnode_read_u64_default(ofnode node, const char *propname, u64 def);
 332
 333 /**
 334  * ofnode_read_prop() - Read a property from a node
 335  *
 336  * @node:       valid node reference to read property from
 337  * @propname:   name of the property to read
 338  * @sizep:      if non-NULL, returns the size of the property, or an error code
 339                 if not found
 340  * @return property value, or NULL if there is no such property
 341  */
 342 const void *ofnode_read_prop(ofnode node, const char *propname, int *sizep);
 343
 344 /**
 345  * ofnode_read_string() - Read a string from a property
 346  *
 347  * @node:       valid node reference to read property from
 348  * @propname:   name of the property to read
 349  * @return string from property value, or NULL if there is no such property
 350  */
 351 const char *ofnode_read_string(ofnode node, const char *propname);
 352
 353 /**
 354  * ofnode_read_u32_array() - Find and read an array of 32 bit integers
 355  *
 356  * @node:       valid node reference to read property from
 357  * @propname:   name of the property to read
 358  * @out_values: pointer to return value, modified only if return value is 0
 359  * @sz:         number of array elements to read
 360  * @return 0 if OK, -ve on error
 361  *
 362  * Search for a property in a device node and read 32-bit value(s) from
 363  * it. Returns 0 on success, -EINVAL if the property does not exist,
 364  * -ENODATA if property does not have a value, and -EOVERFLOW if the
 365  * property data isn't large enough.
 366  *
 367  * The out_values is modified only if a valid u32 value can be decoded.
 368  */
 369 int ofnode_read_u32_array(ofnode node, const char *propname,
 370                           u32 *out_values, size_t sz);
 371
 372 /**
 373  * ofnode_read_bool() - read a boolean value from a property
 374  *
 375  * @node:       valid node reference to read property from
 376  * @propname:   name of property to read
 377  * @return true if property is present (meaning true), false if not present
 378  */
 379 bool ofnode_read_bool(ofnode node, const char *propname);
 380
 381 /**
 382  * ofnode_find_subnode() - find a named subnode of a parent node
 383  *
 384  * @node:       valid reference to parent node
 385  * @subnode_name: name of subnode to find
 386  * @return reference to subnode (which can be invalid if there is no such
 387  * subnode)
 388  */
 389 ofnode ofnode_find_subnode(ofnode node, const char *subnode_name);
 390
 391 #if CONFIG_IS_ENABLED(DM_INLINE_OFNODE)
 392 #include <asm/global_data.h>
 393
 394 static inline bool ofnode_is_enabled(ofnode node)
 395 {
 396         if (ofnode_is_np(node)) {
 397                 return of_device_is_available(ofnode_to_np(node));
 398         } else {
 399                 return fdtdec_get_is_enabled(gd->fdt_blob,
 400                                              ofnode_to_offset(node));
 401         }
 402 }
 403
 404 static inline ofnode ofnode_first_subnode(ofnode node)
 405 {
 406         assert(ofnode_valid(node));
 407         if (ofnode_is_np(node))
 408                 return np_to_ofnode(node.np->child);
 409
 410         return offset_to_ofnode(
 411                 fdt_first_subnode(gd->fdt_blob, ofnode_to_offset(node)));
 412 }
 413
 414 static inline ofnode ofnode_next_subnode(ofnode node)
 415 {
 416         assert(ofnode_valid(node));
 417         if (ofnode_is_np(node))
 418                 return np_to_ofnode(node.np->sibling);
 419
 420         return offset_to_ofnode(
 421                 fdt_next_subnode(gd->fdt_blob, ofnode_to_offset(node)));
 422 }
 423 #else
 424 /**
 425  * ofnode_is_enabled() - Checks whether a node is enabled.
 426  * This looks for a 'status' property. If this exists, then returns true if
 427  * the status is 'okay' and false otherwise. If there is no status property,
 428  * it returns true on the assumption that anything mentioned should be enabled
 429  * by default.
 430  *
 431  * @node: node to examine
 432  * @return false (not enabled) or true (enabled)
 433  */
 434 bool ofnode_is_enabled(ofnode node);
 435
 436 /**
 437  * ofnode_first_subnode() - find the first subnode of a parent node
 438  *
 439  * @node:       valid reference to a valid parent node
 440  * @return reference to the first subnode (which can be invalid if the parent
 441  * node has no subnodes)
 442  */
 443 ofnode ofnode_first_subnode(ofnode node);
 444
 445 /**
 446  * ofnode_next_subnode() - find the next sibling of a subnode
 447  *
 448  * @node:       valid reference to previous node (sibling)
 449  * @return reference to the next subnode (which can be invalid if the node
 450  * has no more siblings)
 451  */
 452 ofnode ofnode_next_subnode(ofnode node);
 453 #endif /* DM_INLINE_OFNODE */
 454
 455 /**
 456  * ofnode_get_parent() - get the ofnode's parent (enclosing ofnode)
 457  *
 458  * @node: valid node to look up
 459  * @return ofnode reference of the parent node
 460  */
 461 ofnode ofnode_get_parent(ofnode node);
 462
 463 /**
 464  * ofnode_get_name() - get the name of a node
 465  *
 466  * @node: valid node to look up
 467  * @return name of node
 468  */
 469 const char *ofnode_get_name(ofnode node);
 470
 471 /**
 472  * ofnode_get_path() - get the full path of a node
 473  *
 474  * @node: valid node to look up
 475  * @buf: buffer to write the node path into
 476  * @buflen: buffer size
 477  * @return 0 if OK, -ve on error
 478  */
 479 int ofnode_get_path(ofnode node, char *buf, int buflen);
 480
 481 /**
 482  * ofnode_get_by_phandle() - get ofnode from phandle
 483  *
 484  * @phandle:    phandle to look up
 485  * @return ofnode reference to the phandle
 486  */
 487 ofnode ofnode_get_by_phandle(uint phandle);
 488
 489 /**
 490  * ofnode_read_size() - read the size of a property
 491  *
 492  * @node: node to check
 493  * @propname: property to check
 494  * @return size of property if present, or -EINVAL if not
 495  */
 496 int ofnode_read_size(ofnode node, const char *propname);
 497
 498 /**
 499  * ofnode_get_addr_size_index() - get an address/size from a node
 500  *                                based on index
 501  *
 502  * This reads the register address/size from a node based on index
 503  *
 504  * @node: node to read from
 505  * @index: Index of address to read (0 for first)
 506  * @size: Pointer to size of the address
 507  * @return address, or FDT_ADDR_T_NONE if not present or invalid
 508  */
 509 phys_addr_t ofnode_get_addr_size_index(ofnode node, int index,
 510                                        fdt_size_t *size);
 511
 512 /**
 513  * ofnode_get_addr_size_index_notrans() - get an address/size from a node
 514  *                                        based on index, without address
 515  *                                        translation
 516  *
 517  * This reads the register address/size from a node based on index.
 518  * The resulting address is not translated. Useful for example for on-disk
 519  * addresses.
 520  *
 521  * @node: node to read from
 522  * @index: Index of address to read (0 for first)
 523  * @size: Pointer to size of the address
 524  * @return address, or FDT_ADDR_T_NONE if not present or invalid
 525  */
 526 phys_addr_t ofnode_get_addr_size_index_notrans(ofnode node, int index,
 527                                                fdt_size_t *size);
 528
 529 /**
 530  * ofnode_get_addr_index() - get an address from a node
 531  *
 532  * This reads the register address from a node
 533  *
 534  * @node: node to read from
 535  * @index: Index of address to read (0 for first)
 536  * @return address, or FDT_ADDR_T_NONE if not present or invalid
 537  */
 538 phys_addr_t ofnode_get_addr_index(ofnode node, int index);
 539
 540 /**
 541  * ofnode_get_addr() - get an address from a node
 542  *
 543  * This reads the register address from a node
 544  *
 545  * @node: node to read from
 546  * @return address, or FDT_ADDR_T_NONE if not present or invalid
 547  */
 548 phys_addr_t ofnode_get_addr(ofnode node);
 549
 550 /**
 551  * ofnode_get_size() - get size from a node
 552  *
 553  * This reads the register size from a node
 554  *
 555  * @node: node to read from
 556  * @return size of the address, or FDT_SIZE_T_NONE if not present or invalid
 557  */
 558 fdt_size_t ofnode_get_size(ofnode node);
 559
 560 /**
 561  * ofnode_stringlist_search() - find a string in a string list and return index
 562  *
 563  * Note that it is possible for this function to succeed on property values
 564  * that are not NUL-terminated. That's because the function will stop after
 565  * finding the first occurrence of @string. This can for example happen with
 566  * small-valued cell properties, such as #address-cells, when searching for
 567  * the empty string.
 568  *
 569  * @node: node to check
 570  * @propname: name of the property containing the string list
 571  * @string: string to look up in the string list
 572  *
 573  * @return:
 574  *   the index of the string in the list of strings
 575  *   -ENODATA if the property is not found
 576  *   -EINVAL on some other error
 577  */
 578 int ofnode_stringlist_search(ofnode node, const char *propname,
 579                              const char *string);
 580
 581 /**
 582  * ofnode_read_string_index() - obtain an indexed string from a string list
 583  *
 584  * Note that this will successfully extract strings from properties with
 585  * non-NUL-terminated values. For example on small-valued cell properties
 586  * this function will return the empty string.
 587  *
 588  * If non-NULL, the length of the string (on success) or a negative error-code
 589  * (on failure) will be stored in the integer pointer to by lenp.
 590  *
 591  * @node: node to check
 592  * @propname: name of the property containing the string list
 593  * @index: index of the string to return (cannot be negative)
 594  * @lenp: return location for the string length or an error code on failure
 595  *
 596  * @return:
 597  *   0 if found or -ve error value if not found
 598  */
 599 int ofnode_read_string_index(ofnode node, const char *propname, int index,
 600                              const char **outp);
 601
 602 /**
 603  * ofnode_read_string_count() - find the number of strings in a string list
 604  *
 605  * @node: node to check
 606  * @propname: name of the property containing the string list
 607  * @return:
 608  *   number of strings in the list, or -ve error value if not found
 609  */
 610 int ofnode_read_string_count(ofnode node, const char *property);
 611
 612 /**
 613  * ofnode_read_string_list() - read a list of strings
 614  *
 615  * This produces a list of string pointers with each one pointing to a string
 616  * in the string list. If the property does not exist, it returns {NULL}.
 617  *
 618  * The data is allocated and the caller is reponsible for freeing the return
 619  * value (the list of string pointers). The strings themselves may not be
 620  * changed as they point directly into the devicetree property.
 621  *
 622  * @node: node to check
 623  * @listp: returns an allocated, NULL-terminated list of strings if the return
 624  *      value is > 0, else is set to NULL
 625  * @return number of strings in list, 0 if none, -ENOMEM if out of memory,
 626  *      -EINVAL if no such property, -EENODATA if property is empty
 627  * @return: NULL-terminated list of strings (NULL if no property or empty)
 628  */
 629 int ofnode_read_string_list(ofnode node, const char *property,
 630                             const char ***listp);
 631
 632 /**
 633  * ofnode_parse_phandle_with_args() - Find a node pointed by phandle in a list
 634  *
 635  * This function is useful to parse lists of phandles and their arguments.
 636  * Returns 0 on success and fills out_args, on error returns appropriate
 637  * errno value.
 638  *
 639  * Caller is responsible to call of_node_put() on the returned out_args->np
 640  * pointer.
 641  *
 642  * Example:
 643  *
 644  * phandle1: node1 {
 645  *      #list-cells = <2>;
 646  * }
 647  *
 648  * phandle2: node2 {
 649  *      #list-cells = <1>;
 650  * }
 651  *
 652  * node3 {
 653  *      list = <&phandle1 1 2 &phandle2 3>;
 654  * }
 655  *
 656  * To get a device_node of the `node2' node you may call this:
 657  * ofnode_parse_phandle_with_args(node3, "list", "#list-cells", 0, 1, &args);
 658  *
 659  * @node:       device tree node containing a list
 660  * @list_name:  property name that contains a list
 661  * @cells_name: property name that specifies phandles' arguments count
 662  * @cells_count: Cell count to use if @cells_name is NULL
 663  * @index:      index of a phandle to parse out
 664  * @out_args:   optional pointer to output arguments structure (will be filled)
 665  * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if
 666  *      @list_name does not exist, -EINVAL if a phandle was not found,
 667  *      @cells_name could not be found, the arguments were truncated or there
 668  *      were too many arguments.
 669  */
 670 int ofnode_parse_phandle_with_args(ofnode node, const char *list_name,
 671                                    const char *cells_name, int cell_count,
 672                                    int index,
 673                                    struct ofnode_phandle_args *out_args);
 674
 675 /**
 676  * ofnode_count_phandle_with_args() - Count number of phandle in a list
 677  *
 678  * This function is useful to count phandles into a list.
 679  * Returns number of phandle on success, on error returns appropriate
 680  * errno value.
 681  *
 682  * @node:       device tree node containing a list
 683  * @list_name:  property name that contains a list
 684  * @cells_name: property name that specifies phandles' arguments count
 685  * @cells_count: Cell count to use if @cells_name is NULL
 686  * @return number of phandle on success, -ENOENT if @list_name does not
 687  *      exist, -EINVAL if a phandle was not found, @cells_name could not
 688  *      be found.
 689  */
 690 int ofnode_count_phandle_with_args(ofnode node, const char *list_name,
 691                                    const char *cells_name, int cell_count);
 692
 693 /**
 694  * ofnode_path() - find a node by full path
 695  *
 696  * @path: Full path to node, e.g. "/bus/spi@1"
 697  * @return reference to the node found. Use ofnode_valid() to check if it exists
 698  */
 699 ofnode ofnode_path(const char *path);
 700
 701 /**
 702  * ofnode_read_chosen_prop() - get the value of a chosen property
 703  *
 704  * This looks for a property within the /chosen node and returns its value
 705  *
 706  * @propname: Property name to look for
 707  * @sizep: Returns size of property, or FDT_ERR_... error code if function
 708  *      returns NULL
 709  * @return property value if found, else NULL
 710  */
 711 const void *ofnode_read_chosen_prop(const char *propname, int *sizep);
 712
 713 /**
 714  * ofnode_read_chosen_string() - get the string value of a chosen property
 715  *
 716  * This looks for a property within the /chosen node and returns its value,
 717  * checking that it is a valid nul-terminated string
 718  *
 719  * @propname: Property name to look for
 720  * @return string value if found, else NULL
 721  */
 722 const char *ofnode_read_chosen_string(const char *propname);
 723
 724 /**
 725  * ofnode_get_chosen_node() - get a referenced node from the chosen node
 726  *
 727  * This looks up a named property in the chosen node and uses that as a path to
 728  * look up a code.
 729  *
 730  * @return the referenced node if present, else ofnode_null()
 731  */
 732 ofnode ofnode_get_chosen_node(const char *propname);
 733
 734 /**
 735  * ofnode_read_aliases_prop() - get the value of a aliases property
 736  *
 737  * This looks for a property within the /aliases node and returns its value
 738  *
 739  * @propname: Property name to look for
 740  * @sizep: Returns size of property, or FDT_ERR_... error code if function
 741  *      returns NULL
 742  * @return property value if found, else NULL
 743  */
 744 const void *ofnode_read_aliases_prop(const char *propname, int *sizep);
 745
 746 /**
 747  * ofnode_get_aliases_node() - get a referenced node from the aliases node
 748  *
 749  * This looks up a named property in the aliases node and uses that as a path to
 750  * look up a code.
 751  *
 752  * @return the referenced node if present, else ofnode_null()
 753  */
 754 ofnode ofnode_get_aliases_node(const char *propname);
 755
 756 struct display_timing;
 757 /**
 758  * ofnode_decode_display_timing() - decode display timings
 759  *
 760  * Decode display timings from the supplied 'display-timings' node.
 761  * See doc/device-tree-bindings/video/display-timing.txt for binding
 762  * information.
 763  *
 764  * @node        'display-timing' node containing the timing subnodes
 765  * @index       Index number to read (0=first timing subnode)
 766  * @config      Place to put timings
 767  * @return 0 if OK, -FDT_ERR_NOTFOUND if not found
 768  */
 769 int ofnode_decode_display_timing(ofnode node, int index,
 770                                  struct display_timing *config);
 771
 772 /**
 773  * ofnode_get_property() - get a pointer to the value of a node property
 774  *
 775  * @node: node to read
 776  * @propname: property to read
 777  * @lenp: place to put length on success
 778  * @return pointer to property, or NULL if not found
 779  */
 780 const void *ofnode_get_property(ofnode node, const char *propname, int *lenp);
 781
 782 /**
 783  * ofnode_get_first_property()- get the reference of the first property
 784  *
 785  * Get reference to the first property of the node, it is used to iterate
 786  * and read all the property with ofnode_get_property_by_prop().
 787  *
 788  * @node: node to read
 789  * @prop: place to put argument reference
 790  * @return 0 if OK, -ve on error. -FDT_ERR_NOTFOUND if not found
 791  */
 792 int ofnode_get_first_property(ofnode node, struct ofprop *prop);
 793
 794 /**
 795  * ofnode_get_next_property() - get the reference of the next property
 796  *
 797  * Get reference to the next property of the node, it is used to iterate
 798  * and read all the property with ofnode_get_property_by_prop().
 799  *
 800  * @prop: reference of current argument and place to put reference of next one
 801  * @return 0 if OK, -ve on error. -FDT_ERR_NOTFOUND if not found
 802  */
 803 int ofnode_get_next_property(struct ofprop *prop);
 804
 805 /**
 806  * ofnode_get_property_by_prop() - get a pointer to the value of a property
 807  *
 808  * Get value for the property identified by the provided reference.
 809  *
 810  * @prop: reference on property
 811  * @propname: If non-NULL, place to property name on success,
 812  * @lenp: If non-NULL, place to put length on success
 813  * @return 0 if OK, -ve on error. -FDT_ERR_NOTFOUND if not found
 814  */
 815 const void *ofnode_get_property_by_prop(const struct ofprop *prop,
 816                                         const char **propname, int *lenp);
 817
 818 /**
 819  * ofnode_is_available() - check if a node is marked available
 820  *
 821  * @node: node to check
 822  * @return true if node's 'status' property is "okay" (or is missing)
 823  */
 824 bool ofnode_is_available(ofnode node);
 825
 826 /**
 827  * ofnode_get_addr_size() - get address and size from a property
 828  *
 829  * This does no address translation. It simply reads an property that contains
 830  * an address and a size value, one after the other.
 831  *
 832  * @node: node to read from
 833  * @propname: property to read
 834  * @sizep: place to put size value (on success)
 835  * @return address value, or FDT_ADDR_T_NONE on error
 836  */
 837 phys_addr_t ofnode_get_addr_size(ofnode node, const char *propname,
 838                                  phys_size_t *sizep);
 839
 840 /**
 841  * ofnode_read_u8_array_ptr() - find an 8-bit array
 842  *
 843  * Look up a property in a node and return a pointer to its contents as a
 844  * byte array of given length. The property must have at least enough data
 845  * for the array (count bytes). It may have more, but this will be ignored.
 846  * The data is not copied.
 847  *
 848  * @node        node to examine
 849  * @propname    name of property to find
 850  * @sz          number of array elements
 851  * @return pointer to byte array if found, or NULL if the property is not
 852  *              found or there is not enough data
 853  */
 854 const uint8_t *ofnode_read_u8_array_ptr(ofnode node, const char *propname,
 855                                         size_t sz);
 856
 857 /**
 858  * ofnode_read_pci_addr() - look up a PCI address
 859  *
 860  * Look at an address property in a node and return the PCI address which
 861  * corresponds to the given type in the form of fdt_pci_addr.
 862  * The property must hold one fdt_pci_addr with a lengh.
 863  *
 864  * @node        node to examine
 865  * @type        pci address type (FDT_PCI_SPACE_xxx)
 866  * @propname    name of property to find
 867  * @addr        returns pci address in the form of fdt_pci_addr
 868  * @return 0 if ok, -ENOENT if the property did not exist, -EINVAL if the
 869  *              format of the property was invalid, -ENXIO if the requested
 870  *              address type was not found
 871  */
 872 int ofnode_read_pci_addr(ofnode node, enum fdt_pci_space type,
 873                          const char *propname, struct fdt_pci_addr *addr);
 874
 875 /**
 876  * ofnode_read_pci_vendev() - look up PCI vendor and device id
 877  *
 878  * Look at the compatible property of a device node that represents a PCI
 879  * device and extract pci vendor id and device id from it.
 880  *
 881  * @param node          node to examine
 882  * @param vendor        vendor id of the pci device
 883  * @param device        device id of the pci device
 884  * @return 0 if ok, negative on error
 885  */
 886 int ofnode_read_pci_vendev(ofnode node, u16 *vendor, u16 *device);
 887
 888 /**
 889  * ofnode_read_addr_cells() - Get the number of address cells for a node
 890  *
 891  * This walks back up the tree to find the closest #address-cells property
 892  * which controls the given node.
 893  *
 894  * @node: Node to check
 895  * @return number of address cells this node uses
 896  */
 897 int ofnode_read_addr_cells(ofnode node);
 898
 899 /**
 900  * ofnode_read_size_cells() - Get the number of size cells for a node
 901  *
 902  * This walks back up the tree to find the closest #size-cells property
 903  * which controls the given node.
 904  *
 905  * @node: Node to check
 906  * @return number of size cells this node uses
 907  */
 908 int ofnode_read_size_cells(ofnode node);
 909
 910 /**
 911  * ofnode_read_simple_addr_cells() - Get the address cells property in a node
 912  *
 913  * This function matches fdt_address_cells().
 914  *
 915  * @np: Node pointer to check
 916  * @return value of #address-cells property in this node, or 2 if none
 917  */
 918 int ofnode_read_simple_addr_cells(ofnode node);
 919
 920 /**
 921  * ofnode_read_simple_size_cells() - Get the size cells property in a node
 922  *
 923  * This function matches fdt_size_cells().
 924  *
 925  * @np: Node pointer to check
 926  * @return value of #size-cells property in this node, or 2 if none
 927  */
 928 int ofnode_read_simple_size_cells(ofnode node);
 929
 930 /**
 931  * ofnode_pre_reloc() - check if a node should be bound before relocation
 932  *
 933  * Device tree nodes can be marked as needing-to-be-bound in the loader stages
 934  * via special device tree properties.
 935  *
 936  * Before relocation this function can be used to check if nodes are required
 937  * in either SPL or TPL stages.
 938  *
 939  * After relocation and jumping into the real U-Boot binary it is possible to
 940  * determine if a node was bound in one of SPL/TPL stages.
 941  *
 942  * There are 4 settings currently in use
 943  * - u-boot,dm-pre-proper: U-Boot proper pre-relocation only
 944  * - u-boot,dm-pre-reloc: legacy and indicates any of TPL or SPL
 945  *   Existing platforms only use it to indicate nodes needed in
 946  *   SPL. Should probably be replaced by u-boot,dm-spl for
 947  *   new platforms.
 948  * - u-boot,dm-spl: SPL and U-Boot pre-relocation
 949  * - u-boot,dm-tpl: TPL and U-Boot pre-relocation
 950  *
 951  * @node: node to check
 952  * @return true if node is needed in SPL/TL, false otherwise
 953  */
 954 bool ofnode_pre_reloc(ofnode node);
 955
 956 /**
 957  * ofnode_read_resource() - Read a resource from a node
 958  *
 959  * Read resource information from a node at the given index
 960  *
 961  * @node: Node to read from
 962  * @index: Index of resource to read (0 = first)
 963  * @res: Returns resource that was read, on success
 964  * @return 0 if OK, -ve on error
 965  */
 966 int ofnode_read_resource(ofnode node, uint index, struct resource *res);
 967
 968 /**
 969  * ofnode_read_resource_byname() - Read a resource from a node by name
 970  *
 971  * Read resource information from a node matching the given name. This uses a
 972  * 'reg-names' string list property with the names matching the associated
 973  * 'reg' property list.
 974  *
 975  * @node: Node to read from
 976  * @name: Name of resource to read
 977  * @res: Returns resource that was read, on success
 978  * @return 0 if OK, -ve on error
 979  */
 980 int ofnode_read_resource_byname(ofnode node, const char *name,
 981                                 struct resource *res);
 982
 983 /**
 984  * ofnode_by_compatible() - Find the next compatible node
 985  *
 986  * Find the next node after @from that is compatible with @compat
 987  *
 988  * @from: ofnode to start from (use ofnode_null() to start at the beginning)
 989  * @compat: Compatible string to match
 990  * @return ofnode found, or ofnode_null() if none
 991  */
 992 ofnode ofnode_by_compatible(ofnode from, const char *compat);
 993
 994 /**
 995  * ofnode_by_prop_value() - Find the next node with given property value
 996  *
 997  * Find the next node after @from that has a @propname with a value
 998  * @propval and a length @proplen.
 999  *
1000  * @from: ofnode to start from (use ofnode_null() to start at the
1001  * beginning) @propname: property name to check @propval: property value to
1002  * search for @proplen: length of the value in propval @return ofnode
1003  * found, or ofnode_null() if none
1004  */
1005 ofnode ofnode_by_prop_value(ofnode from, const char *propname,
1006                             const void *propval, int proplen);
1007
1008 /**
1009  * ofnode_for_each_subnode() - iterate over all subnodes of a parent
1010  *
1011  * @node:       child node (ofnode, lvalue)
1012  * @parent:     parent node (ofnode)
1013  *
1014  * This is a wrapper around a for loop and is used like so:
1015  *
1016  *      ofnode node;
1017  *
1018  *      ofnode_for_each_subnode(node, parent) {
1019  *              Use node
1020  *              ...
1021  *      }
1022  *
1023  * Note that this is implemented as a macro and @node is used as
1024  * iterator in the loop. The parent variable can be a constant or even a
1025  * literal.
1026  */
1027 #define ofnode_for_each_subnode(node, parent) \
1028         for (node = ofnode_first_subnode(parent); \
1029              ofnode_valid(node); \
1030              node = ofnode_next_subnode(node))
1031
1032 /**
1033  * ofnode_for_each_compatible_node() - iterate over all nodes with a given
1034  *                                     compatible string
1035  *
1036  * @node:       child node (ofnode, lvalue)
1037  * @compat:     compatible string to match
1038  *
1039  * This is a wrapper around a for loop and is used like so:
1040  *
1041  *      ofnode node;
1042  *
1043  *      ofnode_for_each_compatible_node(node, parent, compatible) {
1044  *              Use node
1045  *              ...
1046  *      }
1047  *
1048  * Note that this is implemented as a macro and @node is used as
1049  * iterator in the loop.
1050  */
1051 #define ofnode_for_each_compatible_node(node, compat) \
1052         for (node = ofnode_by_compatible(ofnode_null(), compat); \
1053              ofnode_valid(node); \
1054              node = ofnode_by_compatible(node, compat))
1055
1056 /**
1057  * ofnode_get_child_count() - get the child count of a ofnode
1058  *
1059  * @node: valid node to get its child count
1060  * @return the number of subnodes
1061  */
1062 int ofnode_get_child_count(ofnode parent);
1063
1064 /**
1065  * ofnode_translate_address() - Translate a device-tree address
1066  *
1067  * Translate an address from the device-tree into a CPU physical address. This
1068  * function walks up the tree and applies the various bus mappings along the
1069  * way.
1070  *
1071  * @ofnode: Device tree node giving the context in which to translate the
1072  *          address
1073  * @in_addr: pointer to the address to translate
1074  * @return the translated address; OF_BAD_ADDR on error
1075  */
1076 u64 ofnode_translate_address(ofnode node, const fdt32_t *in_addr);
1077
1078 /**
1079  * ofnode_translate_dma_address() - Translate a device-tree DMA address
1080  *
1081  * Translate a DMA address from the device-tree into a CPU physical address.
1082  * This function walks up the tree and applies the various bus mappings along
1083  * the way.
1084  *
1085  * @ofnode: Device tree node giving the context in which to translate the
1086  *          DMA address
1087  * @in_addr: pointer to the DMA address to translate
1088  * @return the translated DMA address; OF_BAD_ADDR on error
1089  */
1090 u64 ofnode_translate_dma_address(ofnode node, const fdt32_t *in_addr);
1091
1092 /**
1093  * ofnode_get_dma_range() - get dma-ranges for a specific DT node
1094  *
1095  * Get DMA ranges for a specifc node, this is useful to perform bus->cpu and
1096  * cpu->bus address translations
1097  *
1098  * @param blob          Pointer to device tree blob
1099  * @param node_offset   Node DT offset
1100  * @param cpu           Pointer to variable storing the range's cpu address
1101  * @param bus           Pointer to variable storing the range's bus address
1102  * @param size          Pointer to variable storing the range's size
1103  * @return translated DMA address or OF_BAD_ADDR on error
1104  */
1105 int ofnode_get_dma_range(ofnode node, phys_addr_t *cpu, dma_addr_t *bus,
1106                          u64 *size);
1107
1108 /**
1109  * ofnode_device_is_compatible() - check if the node is compatible with compat
1110  *
1111  * This allows to check whether the node is comaptible with the compat.
1112  *
1113  * @node:       Device tree node for which compatible needs to be verified.
1114  * @compat:     Compatible string which needs to verified in the given node.
1115  * @return true if OK, false if the compatible is not found
1116  */
1117 int ofnode_device_is_compatible(ofnode node, const char *compat);
1118
1119 /**
1120  * ofnode_write_prop() - Set a property of a ofnode
1121  *
1122  * Note that the value passed to the function is *not* allocated by the
1123  * function itself, but must be allocated by the caller if necessary.
1124  *
1125  * @node:       The node for whose property should be set
1126  * @propname:   The name of the property to set
1127  * @len:        The length of the new value of the property
1128  * @value:      The new value of the property (must be valid prior to calling
1129  *              the function)
1130  * @return 0 if successful, -ve on error
1131  */
1132 int ofnode_write_prop(ofnode node, const char *propname, int len,
1133                       const void *value);
1134
1135 /**
1136  * ofnode_write_string() - Set a string property of a ofnode
1137  *
1138  * Note that the value passed to the function is *not* allocated by the
1139  * function itself, but must be allocated by the caller if necessary.
1140  *
1141  * @node:       The node for whose string property should be set
1142  * @propname:   The name of the string property to set
1143  * @value:      The new value of the string property (must be valid prior to
1144  *              calling the function)
1145  * @return 0 if successful, -ve on error
1146  */
1147 int ofnode_write_string(ofnode node, const char *propname, const char *value);
1148
1149 /**
1150  * ofnode_set_enabled() - Enable or disable a device tree node given by its
1151  *                        ofnode
1152  *
1153  * This function effectively sets the node's "status" property to either "okay"
1154  * or "disable", hence making it available for driver model initialization or
1155  * not.
1156  *
1157  * @node:       The node to enable
1158  * @value:      Flag that tells the function to either disable or enable the
1159  *              node
1160  * @return 0 if successful, -ve on error
1161  */
1162 int ofnode_set_enabled(ofnode node, bool value);
1163
1164 /**
1165  * ofnode_conf_read_bool() - Read a boolean value from the U-Boot config
1166  *
1167  * This reads a property from the /config node of the devicetree.
1168  *
1169  * See doc/config.txt for bindings
1170  *
1171  * @prop_name   property name to look up
1172  * @return true, if it exists, false if not
1173  */
1174 bool ofnode_conf_read_bool(const char *prop_name);
1175
1176 /**
1177  * ofnode_conf_read_int() - Read an integer value from the U-Boot config
1178  *
1179  * This reads a property from the /config node of the devicetree.
1180  *
1181  * See doc/config.txt for bindings
1182  *
1183  * @prop_name: property name to look up
1184  * @default_val: default value to return if the property is not found
1185  * @return integer value, if found, or @default_val if not
1186  */
1187 int ofnode_conf_read_int(const char *prop_name, int default_val);
1188
1189 /**
1190  * ofnode_conf_read_str() - Read a string value from the U-Boot config
1191  *
1192  * This reads a property from the /config node of the devicetree.
1193  *
1194  * See doc/config.txt for bindings
1195  *
1196  * @prop_name: property name to look up
1197  * @return string value, if found, or NULL if not
1198  */
1199 const char *ofnode_conf_read_str(const char *prop_name);
1200
1201 #endif