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 19struct 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 */ 52typedef union ofnode_union { 53 const struct device_node *np; 54 long of_offset; 55} ofnode; 56 57struct 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 80struct 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 */ 96static 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 */ 113static 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 */ 127static 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 */ 141static 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 */ 159static 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 */ 179static 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 */ 198static 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 */ 210static 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 222static 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 */ 242bool 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 */ 252int 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 */ 263int 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 */ 274static 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 */ 288u32 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 */ 300u32 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 */ 311int 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 */ 321int 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 */ 331u64 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 */ 342const 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 */ 351const 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 */ 369int 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 */ 379bool 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 */ 389ofnode 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 394static 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 404static 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 414static 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 */ 434bool 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 */ 443ofnode 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 */ 452ofnode 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 */ 461ofnode 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 */ 469const 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 */ 479int 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 */ 487ofnode 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 */ 496int 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 */ 509phys_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 */ 526phys_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 */ 538phys_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 */ 548phys_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 */ 558fdt_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 */ 578int 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 594 * @lenp: return location for the string length or an error code on failure 595 * 596 * @return: 597 * length of string, if found or -ve error value if not found 598 */ 599int 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 */ 610int ofnode_read_string_count(ofnode node, const char *property); 611 612/** 613 * ofnode_parse_phandle_with_args() - Find a node pointed by phandle in a list 614 * 615 * This function is useful to parse lists of phandles and their arguments. 616 * Returns 0 on success and fills out_args, on error returns appropriate 617 * errno value. 618 * 619 * Caller is responsible to call of_node_put() on the returned out_args->np 620 * pointer. 621 * 622 * Example: 623 * 624 * phandle1: node1 { 625 * #list-cells = <2>; 626 * } 627 * 628 * phandle2: node2 { 629 * #list-cells = <1>; 630 * } 631 * 632 * node3 { 633 * list = <&phandle1 1 2 &phandle2 3>; 634 * } 635 * 636 * To get a device_node of the `node2' node you may call this: 637 * ofnode_parse_phandle_with_args(node3, "list", "#list-cells", 0, 1, &args); 638 * 639 * @node: device tree node containing a list 640 * @list_name: property name that contains a list 641 * @cells_name: property name that specifies phandles' arguments count 642 * @cells_count: Cell count to use if @cells_name is NULL 643 * @index: index of a phandle to parse out 644 * @out_args: optional pointer to output arguments structure (will be filled) 645 * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if 646 * @list_name does not exist, -EINVAL if a phandle was not found, 647 * @cells_name could not be found, the arguments were truncated or there 648 * were too many arguments. 649 */ 650int ofnode_parse_phandle_with_args(ofnode node, const char *list_name, 651 const char *cells_name, int cell_count, 652 int index, 653 struct ofnode_phandle_args *out_args); 654 655/** 656 * ofnode_count_phandle_with_args() - Count number of phandle in a list 657 * 658 * This function is useful to count phandles into a list. 659 * Returns number of phandle on success, on error returns appropriate 660 * errno value. 661 * 662 * @node: device tree node containing a list 663 * @list_name: property name that contains a list 664 * @cells_name: property name that specifies phandles' arguments count 665 * @cells_count: Cell count to use if @cells_name is NULL 666 * @return number of phandle on success, -ENOENT if @list_name does not 667 * exist, -EINVAL if a phandle was not found, @cells_name could not 668 * be found. 669 */ 670int ofnode_count_phandle_with_args(ofnode node, const char *list_name, 671 const char *cells_name, int cell_count); 672 673/** 674 * ofnode_path() - find a node by full path 675 * 676 * @path: Full path to node, e.g. "/bus/spi@1" 677 * @return reference to the node found. Use ofnode_valid() to check if it exists 678 */ 679ofnode ofnode_path(const char *path); 680 681/** 682 * ofnode_read_chosen_prop() - get the value of a chosen property 683 * 684 * This looks for a property within the /chosen node and returns its value 685 * 686 * @propname: Property name to look for 687 * @sizep: Returns size of property, or FDT_ERR_... error code if function 688 * returns NULL 689 * @return property value if found, else NULL 690 */ 691const void *ofnode_read_chosen_prop(const char *propname, int *sizep); 692 693/** 694 * ofnode_read_chosen_string() - get the string value of a chosen property 695 * 696 * This looks for a property within the /chosen node and returns its value, 697 * checking that it is a valid nul-terminated string 698 * 699 * @propname: Property name to look for 700 * @return string value if found, else NULL 701 */ 702const char *ofnode_read_chosen_string(const char *propname); 703 704/** 705 * ofnode_get_chosen_node() - get a referenced node from the chosen node 706 * 707 * This looks up a named property in the chosen node and uses that as a path to 708 * look up a code. 709 * 710 * @return the referenced node if present, else ofnode_null() 711 */ 712ofnode ofnode_get_chosen_node(const char *propname); 713 714/** 715 * ofnode_read_aliases_prop() - get the value of a aliases property 716 * 717 * This looks for a property within the /aliases node and returns its value 718 * 719 * @propname: Property name to look for 720 * @sizep: Returns size of property, or FDT_ERR_... error code if function 721 * returns NULL 722 * @return property value if found, else NULL 723 */ 724const void *ofnode_read_aliases_prop(const char *propname, int *sizep); 725 726/** 727 * ofnode_get_aliases_node() - get a referenced node from the aliases node 728 * 729 * This looks up a named property in the aliases node and uses that as a path to 730 * look up a code. 731 * 732 * @return the referenced node if present, else ofnode_null() 733 */ 734ofnode ofnode_get_aliases_node(const char *propname); 735 736struct display_timing; 737/** 738 * ofnode_decode_display_timing() - decode display timings 739 * 740 * Decode display timings from the supplied 'display-timings' node. 741 * See doc/device-tree-bindings/video/display-timing.txt for binding 742 * information. 743 * 744 * @node 'display-timing' node containing the timing subnodes 745 * @index Index number to read (0=first timing subnode) 746 * @config Place to put timings 747 * @return 0 if OK, -FDT_ERR_NOTFOUND if not found 748 */ 749int ofnode_decode_display_timing(ofnode node, int index, 750 struct display_timing *config); 751 752/** 753 * ofnode_get_property() - get a pointer to the value of a node property 754 * 755 * @node: node to read 756 * @propname: property to read 757 * @lenp: place to put length on success 758 * @return pointer to property, or NULL if not found 759 */ 760const void *ofnode_get_property(ofnode node, const char *propname, int *lenp); 761 762/** 763 * ofnode_get_first_property()- get the reference of the first property 764 * 765 * Get reference to the first property of the node, it is used to iterate 766 * and read all the property with ofnode_get_property_by_prop(). 767 * 768 * @node: node to read 769 * @prop: place to put argument reference 770 * @return 0 if OK, -ve on error. -FDT_ERR_NOTFOUND if not found 771 */ 772int ofnode_get_first_property(ofnode node, struct ofprop *prop); 773 774/** 775 * ofnode_get_next_property() - get the reference of the next property 776 * 777 * Get reference to the next property of the node, it is used to iterate 778 * and read all the property with ofnode_get_property_by_prop(). 779 * 780 * @prop: reference of current argument and place to put reference of next one 781 * @return 0 if OK, -ve on error. -FDT_ERR_NOTFOUND if not found 782 */ 783int ofnode_get_next_property(struct ofprop *prop); 784 785/** 786 * ofnode_get_property_by_prop() - get a pointer to the value of a property 787 * 788 * Get value for the property identified by the provided reference. 789 * 790 * @prop: reference on property 791 * @propname: If non-NULL, place to property name on success, 792 * @lenp: If non-NULL, place to put length on success 793 * @return 0 if OK, -ve on error. -FDT_ERR_NOTFOUND if not found 794 */ 795const void *ofnode_get_property_by_prop(const struct ofprop *prop, 796 const char **propname, int *lenp); 797 798/** 799 * ofnode_is_available() - check if a node is marked available 800 * 801 * @node: node to check 802 * @return true if node's 'status' property is "okay" (or is missing) 803 */ 804bool ofnode_is_available(ofnode node); 805 806/** 807 * ofnode_get_addr_size() - get address and size from a property 808 * 809 * This does no address translation. It simply reads an property that contains 810 * an address and a size value, one after the other. 811 * 812 * @node: node to read from 813 * @propname: property to read 814 * @sizep: place to put size value (on success) 815 * @return address value, or FDT_ADDR_T_NONE on error 816 */ 817phys_addr_t ofnode_get_addr_size(ofnode node, const char *propname, 818 phys_size_t *sizep); 819 820/** 821 * ofnode_read_u8_array_ptr() - find an 8-bit array 822 * 823 * Look up a property in a node and return a pointer to its contents as a 824 * byte array of given length. The property must have at least enough data 825 * for the array (count bytes). It may have more, but this will be ignored. 826 * The data is not copied. 827 * 828 * @node node to examine 829 * @propname name of property to find 830 * @sz number of array elements 831 * @return pointer to byte array if found, or NULL if the property is not 832 * found or there is not enough data 833 */ 834const uint8_t *ofnode_read_u8_array_ptr(ofnode node, const char *propname, 835 size_t sz); 836 837/** 838 * ofnode_read_pci_addr() - look up a PCI address 839 * 840 * Look at an address property in a node and return the PCI address which 841 * corresponds to the given type in the form of fdt_pci_addr. 842 * The property must hold one fdt_pci_addr with a lengh. 843 * 844 * @node node to examine 845 * @type pci address type (FDT_PCI_SPACE_xxx) 846 * @propname name of property to find 847 * @addr returns pci address in the form of fdt_pci_addr 848 * @return 0 if ok, -ENOENT if the property did not exist, -EINVAL if the 849 * format of the property was invalid, -ENXIO if the requested 850 * address type was not found 851 */ 852int ofnode_read_pci_addr(ofnode node, enum fdt_pci_space type, 853 const char *propname, struct fdt_pci_addr *addr); 854 855/** 856 * ofnode_read_pci_vendev() - look up PCI vendor and device id 857 * 858 * Look at the compatible property of a device node that represents a PCI 859 * device and extract pci vendor id and device id from it. 860 * 861 * @param node node to examine 862 * @param vendor vendor id of the pci device 863 * @param device device id of the pci device 864 * @return 0 if ok, negative on error 865 */ 866int ofnode_read_pci_vendev(ofnode node, u16 *vendor, u16 *device); 867 868/** 869 * ofnode_read_addr_cells() - Get the number of address cells for a node 870 * 871 * This walks back up the tree to find the closest #address-cells property 872 * which controls the given node. 873 * 874 * @node: Node to check 875 * @return number of address cells this node uses 876 */ 877int ofnode_read_addr_cells(ofnode node); 878 879/** 880 * ofnode_read_size_cells() - Get the number of size cells for a node 881 * 882 * This walks back up the tree to find the closest #size-cells property 883 * which controls the given node. 884 * 885 * @node: Node to check 886 * @return number of size cells this node uses 887 */ 888int ofnode_read_size_cells(ofnode node); 889 890/** 891 * ofnode_read_simple_addr_cells() - Get the address cells property in a node 892 * 893 * This function matches fdt_address_cells(). 894 * 895 * @np: Node pointer to check 896 * @return value of #address-cells property in this node, or 2 if none 897 */ 898int ofnode_read_simple_addr_cells(ofnode node); 899 900/** 901 * ofnode_read_simple_size_cells() - Get the size cells property in a node 902 * 903 * This function matches fdt_size_cells(). 904 * 905 * @np: Node pointer to check 906 * @return value of #size-cells property in this node, or 2 if none 907 */ 908int ofnode_read_simple_size_cells(ofnode node); 909 910/** 911 * ofnode_pre_reloc() - check if a node should be bound before relocation 912 * 913 * Device tree nodes can be marked as needing-to-be-bound in the loader stages 914 * via special device tree properties. 915 * 916 * Before relocation this function can be used to check if nodes are required 917 * in either SPL or TPL stages. 918 * 919 * After relocation and jumping into the real U-Boot binary it is possible to 920 * determine if a node was bound in one of SPL/TPL stages. 921 * 922 * There are 4 settings currently in use 923 * - u-boot,dm-pre-proper: U-Boot proper pre-relocation only 924 * - u-boot,dm-pre-reloc: legacy and indicates any of TPL or SPL 925 * Existing platforms only use it to indicate nodes needed in 926 * SPL. Should probably be replaced by u-boot,dm-spl for 927 * new platforms. 928 * - u-boot,dm-spl: SPL and U-Boot pre-relocation 929 * - u-boot,dm-tpl: TPL and U-Boot pre-relocation 930 * 931 * @node: node to check 932 * @return true if node is needed in SPL/TL, false otherwise 933 */ 934bool ofnode_pre_reloc(ofnode node); 935 936/** 937 * ofnode_read_resource() - Read a resource from a node 938 * 939 * Read resource information from a node at the given index 940 * 941 * @node: Node to read from 942 * @index: Index of resource to read (0 = first) 943 * @res: Returns resource that was read, on success 944 * @return 0 if OK, -ve on error 945 */ 946int ofnode_read_resource(ofnode node, uint index, struct resource *res); 947 948/** 949 * ofnode_read_resource_byname() - Read a resource from a node by name 950 * 951 * Read resource information from a node matching the given name. This uses a 952 * 'reg-names' string list property with the names matching the associated 953 * 'reg' property list. 954 * 955 * @node: Node to read from 956 * @name: Name of resource to read 957 * @res: Returns resource that was read, on success 958 * @return 0 if OK, -ve on error 959 */ 960int ofnode_read_resource_byname(ofnode node, const char *name, 961 struct resource *res); 962 963/** 964 * ofnode_by_compatible() - Find the next compatible node 965 * 966 * Find the next node after @from that is compatible with @compat 967 * 968 * @from: ofnode to start from (use ofnode_null() to start at the beginning) 969 * @compat: Compatible string to match 970 * @return ofnode found, or ofnode_null() if none 971 */ 972ofnode ofnode_by_compatible(ofnode from, const char *compat); 973 974/** 975 * ofnode_by_prop_value() - Find the next node with given property value 976 * 977 * Find the next node after @from that has a @propname with a value 978 * @propval and a length @proplen. 979 * 980 * @from: ofnode to start from (use ofnode_null() to start at the 981 * beginning) @propname: property name to check @propval: property value to 982 * search for @proplen: length of the value in propval @return ofnode 983 * found, or ofnode_null() if none 984 */ 985ofnode ofnode_by_prop_value(ofnode from, const char *propname, 986 const void *propval, int proplen); 987 988/** 989 * ofnode_for_each_subnode() - iterate over all subnodes of a parent 990 * 991 * @node: child node (ofnode, lvalue) 992 * @parent: parent node (ofnode) 993 * 994 * This is a wrapper around a for loop and is used like so: 995 * 996 * ofnode node; 997 * 998 * ofnode_for_each_subnode(node, parent) { 999 * Use node 1000 * ...
1001 * } 1002 * 1003 * Note that this is implemented as a macro and @node is used as 1004 * iterator in the loop. The parent variable can be a constant or even a 1005 * literal. 1006 */ 1007#define ofnode_for_each_subnode(node, parent) \ 1008 for (node = ofnode_first_subnode(parent); \ 1009 ofnode_valid(node); \ 1010 node = ofnode_next_subnode(node)) 1011 1012/** 1013 * ofnode_for_each_compatible_node() - iterate over all nodes with a given 1014 * compatible string 1015 * 1016 * @node: child node (ofnode, lvalue) 1017 * @compat: compatible string to match 1018 * 1019 * This is a wrapper around a for loop and is used like so: 1020 * 1021 * ofnode node; 1022 * 1023 * ofnode_for_each_compatible_node(node, parent, compatible) { 1024 * Use node 1025 * ... 1026 * } 1027 * 1028 * Note that this is implemented as a macro and @node is used as 1029 * iterator in the loop. 1030 */ 1031#define ofnode_for_each_compatible_node(node, compat) \ 1032 for (node = ofnode_by_compatible(ofnode_null(), compat); \ 1033 ofnode_valid(node); \ 1034 node = ofnode_by_compatible(node, compat)) 1035 1036/** 1037 * ofnode_get_child_count() - get the child count of a ofnode 1038 * 1039 * @node: valid node to get its child count 1040 * @return the number of subnodes 1041 */ 1042int ofnode_get_child_count(ofnode parent); 1043 1044/** 1045 * ofnode_translate_address() - Translate a device-tree address 1046 * 1047 * Translate an address from the device-tree into a CPU physical address. This 1048 * function walks up the tree and applies the various bus mappings along the 1049 * way. 1050 * 1051 * @ofnode: Device tree node giving the context in which to translate the 1052 * address 1053 * @in_addr: pointer to the address to translate 1054 * @return the translated address; OF_BAD_ADDR on error 1055 */ 1056u64 ofnode_translate_address(ofnode node, const fdt32_t *in_addr); 1057 1058/** 1059 * ofnode_translate_dma_address() - Translate a device-tree DMA address 1060 * 1061 * Translate a DMA address from the device-tree into a CPU physical address. 1062 * This function walks up the tree and applies the various bus mappings along 1063 * the way. 1064 * 1065 * @ofnode: Device tree node giving the context in which to translate the 1066 * DMA address 1067 * @in_addr: pointer to the DMA address to translate 1068 * @return the translated DMA address; OF_BAD_ADDR on error 1069 */ 1070u64 ofnode_translate_dma_address(ofnode node, const fdt32_t *in_addr); 1071 1072/** 1073 * ofnode_get_dma_range() - get dma-ranges for a specific DT node 1074 * 1075 * Get DMA ranges for a specifc node, this is useful to perform bus->cpu and 1076 * cpu->bus address translations 1077 * 1078 * @param blob Pointer to device tree blob 1079 * @param node_offset Node DT offset 1080 * @param cpu Pointer to variable storing the range's cpu address 1081 * @param bus Pointer to variable storing the range's bus address 1082 * @param size Pointer to variable storing the range's size 1083 * @return translated DMA address or OF_BAD_ADDR on error 1084 */ 1085int ofnode_get_dma_range(ofnode node, phys_addr_t *cpu, dma_addr_t *bus, 1086 u64 *size); 1087 1088/** 1089 * ofnode_device_is_compatible() - check if the node is compatible with compat 1090 * 1091 * This allows to check whether the node is comaptible with the compat. 1092 * 1093 * @node: Device tree node for which compatible needs to be verified. 1094 * @compat: Compatible string which needs to verified in the given node. 1095 * @return true if OK, false if the compatible is not found 1096 */ 1097int ofnode_device_is_compatible(ofnode node, const char *compat); 1098 1099/** 1100 * ofnode_write_prop() - Set a property of a ofnode 1101 * 1102 * Note that the value passed to the function is *not* allocated by the 1103 * function itself, but must be allocated by the caller if necessary. 1104 * 1105 * @node: The node for whose property should be set 1106 * @propname: The name of the property to set 1107 * @len: The length of the new value of the property 1108 * @value: The new value of the property (must be valid prior to calling 1109 * the function) 1110 * @return 0 if successful, -ve on error 1111 */ 1112int ofnode_write_prop(ofnode node, const char *propname, int len, 1113 const void *value); 1114 1115/** 1116 * ofnode_write_string() - Set a string property of a ofnode 1117 * 1118 * Note that the value passed to the function is *not* allocated by the 1119 * function itself, but must be allocated by the caller if necessary. 1120 * 1121 * @node: The node for whose string property should be set 1122 * @propname: The name of the string property to set 1123 * @value: The new value of the string property (must be valid prior to 1124 * calling the function) 1125 * @return 0 if successful, -ve on error 1126 */ 1127int ofnode_write_string(ofnode node, const char *propname, const char *value); 1128 1129/** 1130 * ofnode_set_enabled() - Enable or disable a device tree node given by its 1131 * ofnode 1132 * 1133 * This function effectively sets the node's "status" property to either "okay" 1134 * or "disable", hence making it available for driver model initialization or 1135 * not. 1136 * 1137 * @node: The node to enable 1138 * @value: Flag that tells the function to either disable or enable the 1139 * node 1140 * @return 0 if successful, -ve on error 1141 */ 1142int ofnode_set_enabled(ofnode node, bool value); 1143 1144/** 1145 * ofnode_conf_read_bool() - Read a boolean value from the U-Boot config 1146 * 1147 * This reads a property from the /config node of the devicetree. 1148 * 1149 * See doc/config.txt for bindings 1150 * 1151 * @prop_name property name to look up 1152 * @return true, if it exists, false if not 1153 */ 1154bool ofnode_conf_read_bool(const char *prop_name); 1155 1156/** 1157 * ofnode_conf_read_int() - Read an integer value from the U-Boot config 1158 * 1159 * This reads a property from the /config node of the devicetree. 1160 * 1161 * See doc/config.txt for bindings 1162 * 1163 * @prop_name: property name to look up 1164 * @default_val: default value to return if the property is not found 1165 * @return integer value, if found, or @default_val if not 1166 */ 1167int ofnode_conf_read_int(const char *prop_name, int default_val); 1168 1169/** 1170 * ofnode_conf_read_str() - Read a string value from the U-Boot config 1171 * 1172 * This reads a property from the /config node of the devicetree. 1173 * 1174 * See doc/config.txt for bindings 1175 * 1176 * @prop_name: property name to look up 1177 * @return string value, if found, or NULL if not 1178 */ 1179const char *ofnode_conf_read_str(const char *prop_name); 1180 1181#endif 1182