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