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