1 /* SPDX-License-Identifier: GPL-2.0+ */ 2 #ifndef _LINUX_OF_H 3 #define _LINUX_OF_H 4 /* 5 * Definitions for talking to the Open Firmware PROM on 6 * Power Macintosh and other computers. 7 * 8 * Copyright (C) 1996-2005 Paul Mackerras. 9 * 10 * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp. 11 * Updates for SPARC64 by David S. Miller 12 * Derived from PowerPC and Sparc prom.h files by Stephen Rothwell, IBM Corp. 13 */ 14 #include <linux/types.h> 15 #include <linux/bitops.h> 16 #include <linux/errno.h> 17 #include <linux/kobject.h> 18 #include <linux/mod_devicetable.h> 19 #include <linux/property.h> 20 #include <linux/list.h> 21 22 #include <asm/byteorder.h> 23 24 typedef u32 phandle; 25 typedef u32 ihandle; 26 27 struct property { 28 char *name; 29 int length; 30 void *value; 31 struct property *next; 32 #if defined(CONFIG_OF_DYNAMIC) || defined(CONFIG_SPARC) 33 unsigned long _flags; 34 #endif 35 #if defined(CONFIG_OF_PROMTREE) 36 unsigned int unique_id; 37 #endif 38 #if defined(CONFIG_OF_KOBJ) 39 struct bin_attribute attr; 40 #endif 41 }; 42 43 #if defined(CONFIG_SPARC) 44 struct of_irq_controller; 45 #endif 46 47 struct device_node { 48 const char *name; 49 phandle phandle; 50 const char *full_name; 51 struct fwnode_handle fwnode; 52 53 struct property *properties; 54 struct property *deadprops; /* removed properties */ 55 struct device_node *parent; 56 struct device_node *child; 57 struct device_node *sibling; 58 #if defined(CONFIG_OF_KOBJ) 59 struct kobject kobj; 60 #endif 61 unsigned long _flags; 62 void *data; 63 #if defined(CONFIG_SPARC) 64 unsigned int unique_id; 65 struct of_irq_controller *irq_trans; 66 #endif 67 }; 68 69 #define MAX_PHANDLE_ARGS 16 70 struct of_phandle_args { 71 struct device_node *np; 72 int args_count; 73 uint32_t args[MAX_PHANDLE_ARGS]; 74 }; 75 76 struct of_phandle_iterator { 77 /* Common iterator information */ 78 const char *cells_name; 79 int cell_count; 80 const struct device_node *parent; 81 82 /* List size information */ 83 const __be32 *list_end; 84 const __be32 *phandle_end; 85 86 /* Current position state */ 87 const __be32 *cur; 88 uint32_t cur_count; 89 phandle phandle; 90 struct device_node *node; 91 }; 92 93 struct of_reconfig_data { 94 struct device_node *dn; 95 struct property *prop; 96 struct property *old_prop; 97 }; 98 99 extern const struct kobj_type of_node_ktype; 100 extern const struct fwnode_operations of_fwnode_ops; 101 102 /** 103 * of_node_init - initialize a devicetree node 104 * @node: Pointer to device node that has been created by kzalloc() 105 * 106 * On return the device_node refcount is set to one. Use of_node_put() 107 * on @node when done to free the memory allocated for it. If the node 108 * is NOT a dynamic node the memory will not be freed. The decision of 109 * whether to free the memory will be done by node->release(), which is 110 * of_node_release(). 111 */ 112 static inline void of_node_init(struct device_node *node) 113 { 114 #if defined(CONFIG_OF_KOBJ) 115 kobject_init(&node->kobj, &of_node_ktype); 116 #endif 117 fwnode_init(&node->fwnode, &of_fwnode_ops); 118 } 119 120 #if defined(CONFIG_OF_KOBJ) 121 #define of_node_kobj(n) (&(n)->kobj) 122 #else 123 #define of_node_kobj(n) NULL 124 #endif 125 126 #ifdef CONFIG_OF_DYNAMIC 127 extern struct device_node *of_node_get(struct device_node *node); 128 extern void of_node_put(struct device_node *node); 129 #else /* CONFIG_OF_DYNAMIC */ 130 /* Dummy ref counting routines - to be implemented later */ 131 static inline struct device_node *of_node_get(struct device_node *node) 132 { 133 return node; 134 } 135 static inline void of_node_put(struct device_node *node) { } 136 #endif /* !CONFIG_OF_DYNAMIC */ 137 138 /* Pointer for first entry in chain of all nodes. */ 139 extern struct device_node *of_root; 140 extern struct device_node *of_chosen; 141 extern struct device_node *of_aliases; 142 extern struct device_node *of_stdout; 143 144 /* 145 * struct device_node flag descriptions 146 * (need to be visible even when !CONFIG_OF) 147 */ 148 #define OF_DYNAMIC 1 /* (and properties) allocated via kmalloc */ 149 #define OF_DETACHED 2 /* detached from the device tree */ 150 #define OF_POPULATED 3 /* device already created */ 151 #define OF_POPULATED_BUS 4 /* platform bus created for children */ 152 #define OF_OVERLAY 5 /* allocated for an overlay */ 153 #define OF_OVERLAY_FREE_CSET 6 /* in overlay cset being freed */ 154 155 #define OF_BAD_ADDR ((u64)-1) 156 157 #ifdef CONFIG_OF 158 void of_core_init(void); 159 160 static inline bool is_of_node(const struct fwnode_handle *fwnode) 161 { 162 return !IS_ERR_OR_NULL(fwnode) && fwnode->ops == &of_fwnode_ops; 163 } 164 165 #define to_of_node(__fwnode) \ 166 ({ \ 167 typeof(__fwnode) __to_of_node_fwnode = (__fwnode); \ 168 \ 169 is_of_node(__to_of_node_fwnode) ? \ 170 container_of(__to_of_node_fwnode, \ 171 struct device_node, fwnode) : \ 172 NULL; \ 173 }) 174 175 #define of_fwnode_handle(node) \ 176 ({ \ 177 typeof(node) __of_fwnode_handle_node = (node); \ 178 \ 179 __of_fwnode_handle_node ? \ 180 &__of_fwnode_handle_node->fwnode : NULL; \ 181 }) 182 183 static inline bool of_have_populated_dt(void) 184 { 185 return of_root != NULL; 186 } 187 188 static inline bool of_node_is_root(const struct device_node *node) 189 { 190 return node && (node->parent == NULL); 191 } 192 193 static inline int of_node_check_flag(const struct device_node *n, unsigned long flag) 194 { 195 return test_bit(flag, &n->_flags); 196 } 197 198 static inline int of_node_test_and_set_flag(struct device_node *n, 199 unsigned long flag) 200 { 201 return test_and_set_bit(flag, &n->_flags); 202 } 203 204 static inline void of_node_set_flag(struct device_node *n, unsigned long flag) 205 { 206 set_bit(flag, &n->_flags); 207 } 208 209 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag) 210 { 211 clear_bit(flag, &n->_flags); 212 } 213 214 #if defined(CONFIG_OF_DYNAMIC) || defined(CONFIG_SPARC) 215 static inline int of_property_check_flag(const struct property *p, unsigned long flag) 216 { 217 return test_bit(flag, &p->_flags); 218 } 219 220 static inline void of_property_set_flag(struct property *p, unsigned long flag) 221 { 222 set_bit(flag, &p->_flags); 223 } 224 225 static inline void of_property_clear_flag(struct property *p, unsigned long flag) 226 { 227 clear_bit(flag, &p->_flags); 228 } 229 #endif 230 231 extern struct device_node *__of_find_all_nodes(struct device_node *prev); 232 extern struct device_node *of_find_all_nodes(struct device_node *prev); 233 234 /* 235 * OF address retrieval & translation 236 */ 237 238 /* Helper to read a big number; size is in cells (not bytes) */ 239 static inline u64 of_read_number(const __be32 *cell, int size) 240 { 241 u64 r = 0; 242 for (; size--; cell++) 243 r = (r << 32) | be32_to_cpu(*cell); 244 return r; 245 } 246 247 /* Like of_read_number, but we want an unsigned long result */ 248 static inline unsigned long of_read_ulong(const __be32 *cell, int size) 249 { 250 /* toss away upper bits if unsigned long is smaller than u64 */ 251 return of_read_number(cell, size); 252 } 253 254 #if defined(CONFIG_SPARC) 255 #include <asm/prom.h> 256 #endif 257 258 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags) 259 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags) 260 261 extern bool of_node_name_eq(const struct device_node *np, const char *name); 262 extern bool of_node_name_prefix(const struct device_node *np, const char *prefix); 263 264 static inline const char *of_node_full_name(const struct device_node *np) 265 { 266 return np ? np->full_name : "<no-node>"; 267 } 268 269 #define for_each_of_allnodes_from(from, dn) \ 270 for (dn = __of_find_all_nodes(from); dn; dn = __of_find_all_nodes(dn)) 271 #define for_each_of_allnodes(dn) for_each_of_allnodes_from(NULL, dn) 272 extern struct device_node *of_find_node_by_name(struct device_node *from, 273 const char *name); 274 extern struct device_node *of_find_node_by_type(struct device_node *from, 275 const char *type); 276 extern struct device_node *of_find_compatible_node(struct device_node *from, 277 const char *type, const char *compat); 278 extern struct device_node *of_find_matching_node_and_match( 279 struct device_node *from, 280 const struct of_device_id *matches, 281 const struct of_device_id **match); 282 283 extern struct device_node *of_find_node_opts_by_path(const char *path, 284 const char **opts); 285 static inline struct device_node *of_find_node_by_path(const char *path) 286 { 287 return of_find_node_opts_by_path(path, NULL); 288 } 289 290 extern struct device_node *of_find_node_by_phandle(phandle handle); 291 extern struct device_node *of_get_parent(const struct device_node *node); 292 extern struct device_node *of_get_next_parent(struct device_node *node); 293 extern struct device_node *of_get_next_child(const struct device_node *node, 294 struct device_node *prev); 295 extern struct device_node *of_get_next_available_child( 296 const struct device_node *node, struct device_node *prev); 297 298 extern struct device_node *of_get_compatible_child(const struct device_node *parent, 299 const char *compatible); 300 extern struct device_node *of_get_child_by_name(const struct device_node *node, 301 const char *name); 302 303 /* cache lookup */ 304 extern struct device_node *of_find_next_cache_node(const struct device_node *); 305 extern int of_find_last_cache_level(unsigned int cpu); 306 extern struct device_node *of_find_node_with_property( 307 struct device_node *from, const char *prop_name); 308 309 extern struct property *of_find_property(const struct device_node *np, 310 const char *name, 311 int *lenp); 312 extern int of_property_count_elems_of_size(const struct device_node *np, 313 const char *propname, int elem_size); 314 extern int of_property_read_u32_index(const struct device_node *np, 315 const char *propname, 316 u32 index, u32 *out_value); 317 extern int of_property_read_u64_index(const struct device_node *np, 318 const char *propname, 319 u32 index, u64 *out_value); 320 extern int of_property_read_variable_u8_array(const struct device_node *np, 321 const char *propname, u8 *out_values, 322 size_t sz_min, size_t sz_max); 323 extern int of_property_read_variable_u16_array(const struct device_node *np, 324 const char *propname, u16 *out_values, 325 size_t sz_min, size_t sz_max); 326 extern int of_property_read_variable_u32_array(const struct device_node *np, 327 const char *propname, 328 u32 *out_values, 329 size_t sz_min, 330 size_t sz_max); 331 extern int of_property_read_u64(const struct device_node *np, 332 const char *propname, u64 *out_value); 333 extern int of_property_read_variable_u64_array(const struct device_node *np, 334 const char *propname, 335 u64 *out_values, 336 size_t sz_min, 337 size_t sz_max); 338 339 extern int of_property_read_string(const struct device_node *np, 340 const char *propname, 341 const char **out_string); 342 extern int of_property_match_string(const struct device_node *np, 343 const char *propname, 344 const char *string); 345 extern int of_property_read_string_helper(const struct device_node *np, 346 const char *propname, 347 const char **out_strs, size_t sz, int index); 348 extern int of_device_is_compatible(const struct device_node *device, 349 const char *); 350 extern int of_device_compatible_match(const struct device_node *device, 351 const char *const *compat); 352 extern bool of_device_is_available(const struct device_node *device); 353 extern bool of_device_is_big_endian(const struct device_node *device); 354 extern const void *of_get_property(const struct device_node *node, 355 const char *name, 356 int *lenp); 357 extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread); 358 extern struct device_node *of_cpu_device_node_get(int cpu); 359 extern int of_cpu_node_to_id(struct device_node *np); 360 extern struct device_node *of_get_next_cpu_node(struct device_node *prev); 361 extern struct device_node *of_get_cpu_state_node(struct device_node *cpu_node, 362 int index); 363 extern u64 of_get_cpu_hwid(struct device_node *cpun, unsigned int thread); 364 365 #define for_each_property_of_node(dn, pp) \ 366 for (pp = dn->properties; pp != NULL; pp = pp->next) 367 368 extern int of_n_addr_cells(struct device_node *np); 369 extern int of_n_size_cells(struct device_node *np); 370 extern const struct of_device_id *of_match_node( 371 const struct of_device_id *matches, const struct device_node *node); 372 extern const void *of_device_get_match_data(const struct device *dev); 373 extern int of_alias_from_compatible(const struct device_node *node, char *alias, 374 int len); 375 extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args); 376 extern int __of_parse_phandle_with_args(const struct device_node *np, 377 const char *list_name, const char *cells_name, int cell_count, 378 int index, struct of_phandle_args *out_args); 379 extern int of_parse_phandle_with_args_map(const struct device_node *np, 380 const char *list_name, const char *stem_name, int index, 381 struct of_phandle_args *out_args); 382 extern int of_count_phandle_with_args(const struct device_node *np, 383 const char *list_name, const char *cells_name); 384 385 /* module functions */ 386 extern ssize_t of_modalias(const struct device_node *np, char *str, ssize_t len); 387 extern int of_request_module(const struct device_node *np); 388 389 /* phandle iterator functions */ 390 extern int of_phandle_iterator_init(struct of_phandle_iterator *it, 391 const struct device_node *np, 392 const char *list_name, 393 const char *cells_name, 394 int cell_count); 395 396 extern int of_phandle_iterator_next(struct of_phandle_iterator *it); 397 extern int of_phandle_iterator_args(struct of_phandle_iterator *it, 398 uint32_t *args, 399 int size); 400 401 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align)); 402 extern int of_alias_get_id(struct device_node *np, const char *stem); 403 extern int of_alias_get_highest_id(const char *stem); 404 405 extern int of_machine_is_compatible(const char *compat); 406 407 extern int of_add_property(struct device_node *np, struct property *prop); 408 extern int of_remove_property(struct device_node *np, struct property *prop); 409 extern int of_update_property(struct device_node *np, struct property *newprop); 410 411 /* For updating the device tree at runtime */ 412 #define OF_RECONFIG_ATTACH_NODE 0x0001 413 #define OF_RECONFIG_DETACH_NODE 0x0002 414 #define OF_RECONFIG_ADD_PROPERTY 0x0003 415 #define OF_RECONFIG_REMOVE_PROPERTY 0x0004 416 #define OF_RECONFIG_UPDATE_PROPERTY 0x0005 417 418 extern int of_attach_node(struct device_node *); 419 extern int of_detach_node(struct device_node *); 420 421 #define of_match_ptr(_ptr) (_ptr) 422 423 /* 424 * struct property *prop; 425 * const __be32 *p; 426 * u32 u; 427 * 428 * of_property_for_each_u32(np, "propname", prop, p, u) 429 * printk("U32 value: %x\n", u); 430 */ 431 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur, 432 u32 *pu); 433 /* 434 * struct property *prop; 435 * const char *s; 436 * 437 * of_property_for_each_string(np, "propname", prop, s) 438 * printk("String value: %s\n", s); 439 */ 440 const char *of_prop_next_string(struct property *prop, const char *cur); 441 442 bool of_console_check(struct device_node *dn, char *name, int index); 443 444 int of_map_id(struct device_node *np, u32 id, 445 const char *map_name, const char *map_mask_name, 446 struct device_node **target, u32 *id_out); 447 448 phys_addr_t of_dma_get_max_cpu_address(struct device_node *np); 449 450 struct kimage; 451 void *of_kexec_alloc_and_setup_fdt(const struct kimage *image, 452 unsigned long initrd_load_addr, 453 unsigned long initrd_len, 454 const char *cmdline, size_t extra_fdt_size); 455 #else /* CONFIG_OF */ 456 457 static inline void of_core_init(void) 458 { 459 } 460 461 static inline bool is_of_node(const struct fwnode_handle *fwnode) 462 { 463 return false; 464 } 465 466 static inline struct device_node *to_of_node(const struct fwnode_handle *fwnode) 467 { 468 return NULL; 469 } 470 471 static inline bool of_node_name_eq(const struct device_node *np, const char *name) 472 { 473 return false; 474 } 475 476 static inline bool of_node_name_prefix(const struct device_node *np, const char *prefix) 477 { 478 return false; 479 } 480 481 static inline const char* of_node_full_name(const struct device_node *np) 482 { 483 return "<no-node>"; 484 } 485 486 static inline struct device_node *of_find_node_by_name(struct device_node *from, 487 const char *name) 488 { 489 return NULL; 490 } 491 492 static inline struct device_node *of_find_node_by_type(struct device_node *from, 493 const char *type) 494 { 495 return NULL; 496 } 497 498 static inline struct device_node *of_find_matching_node_and_match( 499 struct device_node *from, 500 const struct of_device_id *matches, 501 const struct of_device_id **match) 502 { 503 return NULL; 504 } 505 506 static inline struct device_node *of_find_node_by_path(const char *path) 507 { 508 return NULL; 509 } 510 511 static inline struct device_node *of_find_node_opts_by_path(const char *path, 512 const char **opts) 513 { 514 return NULL; 515 } 516 517 static inline struct device_node *of_find_node_by_phandle(phandle handle) 518 { 519 return NULL; 520 } 521 522 static inline struct device_node *of_get_parent(const struct device_node *node) 523 { 524 return NULL; 525 } 526 527 static inline struct device_node *of_get_next_parent(struct device_node *node) 528 { 529 return NULL; 530 } 531 532 static inline struct device_node *of_get_next_child( 533 const struct device_node *node, struct device_node *prev) 534 { 535 return NULL; 536 } 537 538 static inline struct device_node *of_get_next_available_child( 539 const struct device_node *node, struct device_node *prev) 540 { 541 return NULL; 542 } 543 544 static inline struct device_node *of_find_node_with_property( 545 struct device_node *from, const char *prop_name) 546 { 547 return NULL; 548 } 549 550 #define of_fwnode_handle(node) NULL 551 552 static inline bool of_have_populated_dt(void) 553 { 554 return false; 555 } 556 557 static inline struct device_node *of_get_compatible_child(const struct device_node *parent, 558 const char *compatible) 559 { 560 return NULL; 561 } 562 563 static inline struct device_node *of_get_child_by_name( 564 const struct device_node *node, 565 const char *name) 566 { 567 return NULL; 568 } 569 570 static inline int of_device_is_compatible(const struct device_node *device, 571 const char *name) 572 { 573 return 0; 574 } 575 576 static inline int of_device_compatible_match(const struct device_node *device, 577 const char *const *compat) 578 { 579 return 0; 580 } 581 582 static inline bool of_device_is_available(const struct device_node *device) 583 { 584 return false; 585 } 586 587 static inline bool of_device_is_big_endian(const struct device_node *device) 588 { 589 return false; 590 } 591 592 static inline struct property *of_find_property(const struct device_node *np, 593 const char *name, 594 int *lenp) 595 { 596 return NULL; 597 } 598 599 static inline struct device_node *of_find_compatible_node( 600 struct device_node *from, 601 const char *type, 602 const char *compat) 603 { 604 return NULL; 605 } 606 607 static inline int of_property_count_elems_of_size(const struct device_node *np, 608 const char *propname, int elem_size) 609 { 610 return -ENOSYS; 611 } 612 613 static inline int of_property_read_u32_index(const struct device_node *np, 614 const char *propname, u32 index, u32 *out_value) 615 { 616 return -ENOSYS; 617 } 618 619 static inline int of_property_read_u64_index(const struct device_node *np, 620 const char *propname, u32 index, u64 *out_value) 621 { 622 return -ENOSYS; 623 } 624 625 static inline const void *of_get_property(const struct device_node *node, 626 const char *name, 627 int *lenp) 628 { 629 return NULL; 630 } 631 632 static inline struct device_node *of_get_cpu_node(int cpu, 633 unsigned int *thread) 634 { 635 return NULL; 636 } 637 638 static inline struct device_node *of_cpu_device_node_get(int cpu) 639 { 640 return NULL; 641 } 642 643 static inline int of_cpu_node_to_id(struct device_node *np) 644 { 645 return -ENODEV; 646 } 647 648 static inline struct device_node *of_get_next_cpu_node(struct device_node *prev) 649 { 650 return NULL; 651 } 652 653 static inline struct device_node *of_get_cpu_state_node(struct device_node *cpu_node, 654 int index) 655 { 656 return NULL; 657 } 658 659 static inline int of_n_addr_cells(struct device_node *np) 660 { 661 return 0; 662 663 } 664 static inline int of_n_size_cells(struct device_node *np) 665 { 666 return 0; 667 } 668 669 static inline int of_property_read_variable_u8_array(const struct device_node *np, 670 const char *propname, u8 *out_values, 671 size_t sz_min, size_t sz_max) 672 { 673 return -ENOSYS; 674 } 675 676 static inline int of_property_read_variable_u16_array(const struct device_node *np, 677 const char *propname, u16 *out_values, 678 size_t sz_min, size_t sz_max) 679 { 680 return -ENOSYS; 681 } 682 683 static inline int of_property_read_variable_u32_array(const struct device_node *np, 684 const char *propname, 685 u32 *out_values, 686 size_t sz_min, 687 size_t sz_max) 688 { 689 return -ENOSYS; 690 } 691 692 static inline int of_property_read_u64(const struct device_node *np, 693 const char *propname, u64 *out_value) 694 { 695 return -ENOSYS; 696 } 697 698 static inline int of_property_read_variable_u64_array(const struct device_node *np, 699 const char *propname, 700 u64 *out_values, 701 size_t sz_min, 702 size_t sz_max) 703 { 704 return -ENOSYS; 705 } 706 707 static inline int of_property_read_string(const struct device_node *np, 708 const char *propname, 709 const char **out_string) 710 { 711 return -ENOSYS; 712 } 713 714 static inline int of_property_match_string(const struct device_node *np, 715 const char *propname, 716 const char *string) 717 { 718 return -ENOSYS; 719 } 720 721 static inline int of_property_read_string_helper(const struct device_node *np, 722 const char *propname, 723 const char **out_strs, size_t sz, int index) 724 { 725 return -ENOSYS; 726 } 727 728 static inline int __of_parse_phandle_with_args(const struct device_node *np, 729 const char *list_name, 730 const char *cells_name, 731 int cell_count, 732 int index, 733 struct of_phandle_args *out_args) 734 { 735 return -ENOSYS; 736 } 737 738 static inline int of_parse_phandle_with_args_map(const struct device_node *np, 739 const char *list_name, 740 const char *stem_name, 741 int index, 742 struct of_phandle_args *out_args) 743 { 744 return -ENOSYS; 745 } 746 747 static inline int of_count_phandle_with_args(const struct device_node *np, 748 const char *list_name, 749 const char *cells_name) 750 { 751 return -ENOSYS; 752 } 753 754 static inline ssize_t of_modalias(const struct device_node *np, char *str, 755 ssize_t len) 756 { 757 return -ENODEV; 758 } 759 760 static inline int of_request_module(const struct device_node *np) 761 { 762 return -ENODEV; 763 } 764 765 static inline int of_phandle_iterator_init(struct of_phandle_iterator *it, 766 const struct device_node *np, 767 const char *list_name, 768 const char *cells_name, 769 int cell_count) 770 { 771 return -ENOSYS; 772 } 773 774 static inline int of_phandle_iterator_next(struct of_phandle_iterator *it) 775 { 776 return -ENOSYS; 777 } 778 779 static inline int of_phandle_iterator_args(struct of_phandle_iterator *it, 780 uint32_t *args, 781 int size) 782 { 783 return 0; 784 } 785 786 static inline int of_alias_get_id(struct device_node *np, const char *stem) 787 { 788 return -ENOSYS; 789 } 790 791 static inline int of_alias_get_highest_id(const char *stem) 792 { 793 return -ENOSYS; 794 } 795 796 static inline int of_machine_is_compatible(const char *compat) 797 { 798 return 0; 799 } 800 801 static inline int of_add_property(struct device_node *np, struct property *prop) 802 { 803 return 0; 804 } 805 806 static inline int of_remove_property(struct device_node *np, struct property *prop) 807 { 808 return 0; 809 } 810 811 static inline bool of_console_check(const struct device_node *dn, const char *name, int index) 812 { 813 return false; 814 } 815 816 static inline const __be32 *of_prop_next_u32(struct property *prop, 817 const __be32 *cur, u32 *pu) 818 { 819 return NULL; 820 } 821 822 static inline const char *of_prop_next_string(struct property *prop, 823 const char *cur) 824 { 825 return NULL; 826 } 827 828 static inline int of_node_check_flag(struct device_node *n, unsigned long flag) 829 { 830 return 0; 831 } 832 833 static inline int of_node_test_and_set_flag(struct device_node *n, 834 unsigned long flag) 835 { 836 return 0; 837 } 838 839 static inline void of_node_set_flag(struct device_node *n, unsigned long flag) 840 { 841 } 842 843 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag) 844 { 845 } 846 847 static inline int of_property_check_flag(const struct property *p, 848 unsigned long flag) 849 { 850 return 0; 851 } 852 853 static inline void of_property_set_flag(struct property *p, unsigned long flag) 854 { 855 } 856 857 static inline void of_property_clear_flag(struct property *p, unsigned long flag) 858 { 859 } 860 861 static inline int of_map_id(struct device_node *np, u32 id, 862 const char *map_name, const char *map_mask_name, 863 struct device_node **target, u32 *id_out) 864 { 865 return -EINVAL; 866 } 867 868 static inline phys_addr_t of_dma_get_max_cpu_address(struct device_node *np) 869 { 870 return PHYS_ADDR_MAX; 871 } 872 873 static inline const void *of_device_get_match_data(const struct device *dev) 874 { 875 return NULL; 876 } 877 878 #define of_match_ptr(_ptr) NULL 879 #define of_match_node(_matches, _node) NULL 880 #endif /* CONFIG_OF */ 881 882 /* Default string compare functions, Allow arch asm/prom.h to override */ 883 #if !defined(of_compat_cmp) 884 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2)) 885 #define of_prop_cmp(s1, s2) strcmp((s1), (s2)) 886 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2)) 887 #endif 888 889 static inline int of_prop_val_eq(struct property *p1, struct property *p2) 890 { 891 return p1->length == p2->length && 892 !memcmp(p1->value, p2->value, (size_t)p1->length); 893 } 894 895 #if defined(CONFIG_OF) && defined(CONFIG_NUMA) 896 extern int of_node_to_nid(struct device_node *np); 897 #else 898 static inline int of_node_to_nid(struct device_node *device) 899 { 900 return NUMA_NO_NODE; 901 } 902 #endif 903 904 #ifdef CONFIG_OF_NUMA 905 extern int of_numa_init(void); 906 #else 907 static inline int of_numa_init(void) 908 { 909 return -ENOSYS; 910 } 911 #endif 912 913 static inline struct device_node *of_find_matching_node( 914 struct device_node *from, 915 const struct of_device_id *matches) 916 { 917 return of_find_matching_node_and_match(from, matches, NULL); 918 } 919 920 static inline const char *of_node_get_device_type(const struct device_node *np) 921 { 922 return of_get_property(np, "device_type", NULL); 923 } 924 925 static inline bool of_node_is_type(const struct device_node *np, const char *type) 926 { 927 const char *match = of_node_get_device_type(np); 928 929 return np && match && type && !strcmp(match, type); 930 } 931 932 /** 933 * of_parse_phandle - Resolve a phandle property to a device_node pointer 934 * @np: Pointer to device node holding phandle property 935 * @phandle_name: Name of property holding a phandle value 936 * @index: For properties holding a table of phandles, this is the index into 937 * the table 938 * 939 * Return: The device_node pointer with refcount incremented. Use 940 * of_node_put() on it when done. 941 */ 942 static inline struct device_node *of_parse_phandle(const struct device_node *np, 943 const char *phandle_name, 944 int index) 945 { 946 struct of_phandle_args args; 947 948 if (__of_parse_phandle_with_args(np, phandle_name, NULL, 0, 949 index, &args)) 950 return NULL; 951 952 return args.np; 953 } 954 955 /** 956 * of_parse_phandle_with_args() - Find a node pointed by phandle in a list 957 * @np: pointer to a device tree node containing a list 958 * @list_name: property name that contains a list 959 * @cells_name: property name that specifies phandles' arguments count 960 * @index: index of a phandle to parse out 961 * @out_args: optional pointer to output arguments structure (will be filled) 962 * 963 * This function is useful to parse lists of phandles and their arguments. 964 * Returns 0 on success and fills out_args, on error returns appropriate 965 * errno value. 966 * 967 * Caller is responsible to call of_node_put() on the returned out_args->np 968 * pointer. 969 * 970 * Example:: 971 * 972 * phandle1: node1 { 973 * #list-cells = <2>; 974 * }; 975 * 976 * phandle2: node2 { 977 * #list-cells = <1>; 978 * }; 979 * 980 * node3 { 981 * list = <&phandle1 1 2 &phandle2 3>; 982 * }; 983 * 984 * To get a device_node of the ``node2`` node you may call this: 985 * of_parse_phandle_with_args(node3, "list", "#list-cells", 1, &args); 986 */ 987 static inline int of_parse_phandle_with_args(const struct device_node *np, 988 const char *list_name, 989 const char *cells_name, 990 int index, 991 struct of_phandle_args *out_args) 992 { 993 int cell_count = -1; 994 995 /* If cells_name is NULL we assume a cell count of 0 */ 996 if (!cells_name) 997 cell_count = 0; 998 999 return __of_parse_phandle_with_args(np, list_name, cells_name, 1000 cell_count, index, out_args); 1001 } 1002 1003 /** 1004 * of_parse_phandle_with_fixed_args() - Find a node pointed by phandle in a list 1005 * @np: pointer to a device tree node containing a list 1006 * @list_name: property name that contains a list 1007 * @cell_count: number of argument cells following the phandle 1008 * @index: index of a phandle to parse out 1009 * @out_args: optional pointer to output arguments structure (will be filled) 1010 * 1011 * This function is useful to parse lists of phandles and their arguments. 1012 * Returns 0 on success and fills out_args, on error returns appropriate 1013 * errno value. 1014 * 1015 * Caller is responsible to call of_node_put() on the returned out_args->np 1016 * pointer. 1017 * 1018 * Example:: 1019 * 1020 * phandle1: node1 { 1021 * }; 1022 * 1023 * phandle2: node2 { 1024 * }; 1025 * 1026 * node3 { 1027 * list = <&phandle1 0 2 &phandle2 2 3>; 1028 * }; 1029 * 1030 * To get a device_node of the ``node2`` node you may call this: 1031 * of_parse_phandle_with_fixed_args(node3, "list", 2, 1, &args); 1032 */ 1033 static inline int of_parse_phandle_with_fixed_args(const struct device_node *np, 1034 const char *list_name, 1035 int cell_count, 1036 int index, 1037 struct of_phandle_args *out_args) 1038 { 1039 return __of_parse_phandle_with_args(np, list_name, NULL, cell_count, 1040 index, out_args); 1041 } 1042 1043 /** 1044 * of_parse_phandle_with_optional_args() - Find a node pointed by phandle in a list 1045 * @np: pointer to a device tree node containing a list 1046 * @list_name: property name that contains a list 1047 * @cells_name: property name that specifies phandles' arguments count 1048 * @index: index of a phandle to parse out 1049 * @out_args: optional pointer to output arguments structure (will be filled) 1050 * 1051 * Same as of_parse_phandle_with_args() except that if the cells_name property 1052 * is not found, cell_count of 0 is assumed. 1053 * 1054 * This is used to useful, if you have a phandle which didn't have arguments 1055 * before and thus doesn't have a '#*-cells' property but is now migrated to 1056 * having arguments while retaining backwards compatibility. 1057 */ 1058 static inline int of_parse_phandle_with_optional_args(const struct device_node *np, 1059 const char *list_name, 1060 const char *cells_name, 1061 int index, 1062 struct of_phandle_args *out_args) 1063 { 1064 return __of_parse_phandle_with_args(np, list_name, cells_name, 1065 0, index, out_args); 1066 } 1067 1068 /** 1069 * of_phandle_args_equal() - Compare two of_phandle_args 1070 * @a1: First of_phandle_args to compare 1071 * @a2: Second of_phandle_args to compare 1072 * 1073 * Return: True if a1 and a2 are the same (same node pointer, same phandle 1074 * args), false otherwise. 1075 */ 1076 static inline bool of_phandle_args_equal(const struct of_phandle_args *a1, 1077 const struct of_phandle_args *a2) 1078 { 1079 return a1->np == a2->np && 1080 a1->args_count == a2->args_count && 1081 !memcmp(a1->args, a2->args, sizeof(a1->args[0]) * a1->args_count); 1082 } 1083 1084 /** 1085 * of_property_count_u8_elems - Count the number of u8 elements in a property 1086 * 1087 * @np: device node from which the property value is to be read. 1088 * @propname: name of the property to be searched. 1089 * 1090 * Search for a property in a device node and count the number of u8 elements 1091 * in it. 1092 * 1093 * Return: The number of elements on sucess, -EINVAL if the property does 1094 * not exist or its length does not match a multiple of u8 and -ENODATA if the 1095 * property does not have a value. 1096 */ 1097 static inline int of_property_count_u8_elems(const struct device_node *np, 1098 const char *propname) 1099 { 1100 return of_property_count_elems_of_size(np, propname, sizeof(u8)); 1101 } 1102 1103 /** 1104 * of_property_count_u16_elems - Count the number of u16 elements in a property 1105 * 1106 * @np: device node from which the property value is to be read. 1107 * @propname: name of the property to be searched. 1108 * 1109 * Search for a property in a device node and count the number of u16 elements 1110 * in it. 1111 * 1112 * Return: The number of elements on sucess, -EINVAL if the property does 1113 * not exist or its length does not match a multiple of u16 and -ENODATA if the 1114 * property does not have a value. 1115 */ 1116 static inline int of_property_count_u16_elems(const struct device_node *np, 1117 const char *propname) 1118 { 1119 return of_property_count_elems_of_size(np, propname, sizeof(u16)); 1120 } 1121 1122 /** 1123 * of_property_count_u32_elems - Count the number of u32 elements in a property 1124 * 1125 * @np: device node from which the property value is to be read. 1126 * @propname: name of the property to be searched. 1127 * 1128 * Search for a property in a device node and count the number of u32 elements 1129 * in it. 1130 * 1131 * Return: The number of elements on sucess, -EINVAL if the property does 1132 * not exist or its length does not match a multiple of u32 and -ENODATA if the 1133 * property does not have a value. 1134 */ 1135 static inline int of_property_count_u32_elems(const struct device_node *np, 1136 const char *propname) 1137 { 1138 return of_property_count_elems_of_size(np, propname, sizeof(u32)); 1139 } 1140 1141 /** 1142 * of_property_count_u64_elems - Count the number of u64 elements in a property 1143 * 1144 * @np: device node from which the property value is to be read. 1145 * @propname: name of the property to be searched. 1146 * 1147 * Search for a property in a device node and count the number of u64 elements 1148 * in it. 1149 * 1150 * Return: The number of elements on sucess, -EINVAL if the property does 1151 * not exist or its length does not match a multiple of u64 and -ENODATA if the 1152 * property does not have a value. 1153 */ 1154 static inline int of_property_count_u64_elems(const struct device_node *np, 1155 const char *propname) 1156 { 1157 return of_property_count_elems_of_size(np, propname, sizeof(u64)); 1158 } 1159 1160 /** 1161 * of_property_read_string_array() - Read an array of strings from a multiple 1162 * strings property. 1163 * @np: device node from which the property value is to be read. 1164 * @propname: name of the property to be searched. 1165 * @out_strs: output array of string pointers. 1166 * @sz: number of array elements to read. 1167 * 1168 * Search for a property in a device tree node and retrieve a list of 1169 * terminated string values (pointer to data, not a copy) in that property. 1170 * 1171 * Return: If @out_strs is NULL, the number of strings in the property is returned. 1172 */ 1173 static inline int of_property_read_string_array(const struct device_node *np, 1174 const char *propname, const char **out_strs, 1175 size_t sz) 1176 { 1177 return of_property_read_string_helper(np, propname, out_strs, sz, 0); 1178 } 1179 1180 /** 1181 * of_property_count_strings() - Find and return the number of strings from a 1182 * multiple strings property. 1183 * @np: device node from which the property value is to be read. 1184 * @propname: name of the property to be searched. 1185 * 1186 * Search for a property in a device tree node and retrieve the number of null 1187 * terminated string contain in it. 1188 * 1189 * Return: The number of strings on success, -EINVAL if the property does not 1190 * exist, -ENODATA if property does not have a value, and -EILSEQ if the string 1191 * is not null-terminated within the length of the property data. 1192 */ 1193 static inline int of_property_count_strings(const struct device_node *np, 1194 const char *propname) 1195 { 1196 return of_property_read_string_helper(np, propname, NULL, 0, 0); 1197 } 1198 1199 /** 1200 * of_property_read_string_index() - Find and read a string from a multiple 1201 * strings property. 1202 * @np: device node from which the property value is to be read. 1203 * @propname: name of the property to be searched. 1204 * @index: index of the string in the list of strings 1205 * @output: pointer to null terminated return string, modified only if 1206 * return value is 0. 1207 * 1208 * Search for a property in a device tree node and retrieve a null 1209 * terminated string value (pointer to data, not a copy) in the list of strings 1210 * contained in that property. 1211 * 1212 * Return: 0 on success, -EINVAL if the property does not exist, -ENODATA if 1213 * property does not have a value, and -EILSEQ if the string is not 1214 * null-terminated within the length of the property data. 1215 * 1216 * The out_string pointer is modified only if a valid string can be decoded. 1217 */ 1218 static inline int of_property_read_string_index(const struct device_node *np, 1219 const char *propname, 1220 int index, const char **output) 1221 { 1222 int rc = of_property_read_string_helper(np, propname, output, 1, index); 1223 return rc < 0 ? rc : 0; 1224 } 1225 1226 /** 1227 * of_property_read_bool - Find a property 1228 * @np: device node from which the property value is to be read. 1229 * @propname: name of the property to be searched. 1230 * 1231 * Search for a boolean property in a device node. Usage on non-boolean 1232 * property types is deprecated. 1233 * 1234 * Return: true if the property exists false otherwise. 1235 */ 1236 static inline bool of_property_read_bool(const struct device_node *np, 1237 const char *propname) 1238 { 1239 struct property *prop = of_find_property(np, propname, NULL); 1240 1241 return prop ? true : false; 1242 } 1243 1244 /** 1245 * of_property_present - Test if a property is present in a node 1246 * @np: device node to search for the property. 1247 * @propname: name of the property to be searched. 1248 * 1249 * Test for a property present in a device node. 1250 * 1251 * Return: true if the property exists false otherwise. 1252 */ 1253 static inline bool of_property_present(const struct device_node *np, const char *propname) 1254 { 1255 return of_property_read_bool(np, propname); 1256 } 1257 1258 /** 1259 * of_property_read_u8_array - Find and read an array of u8 from a property. 1260 * 1261 * @np: device node from which the property value is to be read. 1262 * @propname: name of the property to be searched. 1263 * @out_values: pointer to return value, modified only if return value is 0. 1264 * @sz: number of array elements to read 1265 * 1266 * Search for a property in a device node and read 8-bit value(s) from 1267 * it. 1268 * 1269 * dts entry of array should be like: 1270 * ``property = /bits/ 8 <0x50 0x60 0x70>;`` 1271 * 1272 * Return: 0 on success, -EINVAL if the property does not exist, 1273 * -ENODATA if property does not have a value, and -EOVERFLOW if the 1274 * property data isn't large enough. 1275 * 1276 * The out_values is modified only if a valid u8 value can be decoded. 1277 */ 1278 static inline int of_property_read_u8_array(const struct device_node *np, 1279 const char *propname, 1280 u8 *out_values, size_t sz) 1281 { 1282 int ret = of_property_read_variable_u8_array(np, propname, out_values, 1283 sz, 0); 1284 if (ret >= 0) 1285 return 0; 1286 else 1287 return ret; 1288 } 1289 1290 /** 1291 * of_property_read_u16_array - Find and read an array of u16 from a property. 1292 * 1293 * @np: device node from which the property value is to be read. 1294 * @propname: name of the property to be searched. 1295 * @out_values: pointer to return value, modified only if return value is 0. 1296 * @sz: number of array elements to read 1297 * 1298 * Search for a property in a device node and read 16-bit value(s) from 1299 * it. 1300 * 1301 * dts entry of array should be like: 1302 * ``property = /bits/ 16 <0x5000 0x6000 0x7000>;`` 1303 * 1304 * Return: 0 on success, -EINVAL if the property does not exist, 1305 * -ENODATA if property does not have a value, and -EOVERFLOW if the 1306 * property data isn't large enough. 1307 * 1308 * The out_values is modified only if a valid u16 value can be decoded. 1309 */ 1310 static inline int of_property_read_u16_array(const struct device_node *np, 1311 const char *propname, 1312 u16 *out_values, size_t sz) 1313 { 1314 int ret = of_property_read_variable_u16_array(np, propname, out_values, 1315 sz, 0); 1316 if (ret >= 0) 1317 return 0; 1318 else 1319 return ret; 1320 } 1321 1322 /** 1323 * of_property_read_u32_array - Find and read an array of 32 bit integers 1324 * from a property. 1325 * 1326 * @np: device node from which the property value is to be read. 1327 * @propname: name of the property to be searched. 1328 * @out_values: pointer to return value, modified only if return value is 0. 1329 * @sz: number of array elements to read 1330 * 1331 * Search for a property in a device node and read 32-bit value(s) from 1332 * it. 1333 * 1334 * Return: 0 on success, -EINVAL if the property does not exist, 1335 * -ENODATA if property does not have a value, and -EOVERFLOW if the 1336 * property data isn't large enough. 1337 * 1338 * The out_values is modified only if a valid u32 value can be decoded. 1339 */ 1340 static inline int of_property_read_u32_array(const struct device_node *np, 1341 const char *propname, 1342 u32 *out_values, size_t sz) 1343 { 1344 int ret = of_property_read_variable_u32_array(np, propname, out_values, 1345 sz, 0); 1346 if (ret >= 0) 1347 return 0; 1348 else 1349 return ret; 1350 } 1351 1352 /** 1353 * of_property_read_u64_array - Find and read an array of 64 bit integers 1354 * from a property. 1355 * 1356 * @np: device node from which the property value is to be read. 1357 * @propname: name of the property to be searched. 1358 * @out_values: pointer to return value, modified only if return value is 0. 1359 * @sz: number of array elements to read 1360 * 1361 * Search for a property in a device node and read 64-bit value(s) from 1362 * it. 1363 * 1364 * Return: 0 on success, -EINVAL if the property does not exist, 1365 * -ENODATA if property does not have a value, and -EOVERFLOW if the 1366 * property data isn't large enough. 1367 * 1368 * The out_values is modified only if a valid u64 value can be decoded. 1369 */ 1370 static inline int of_property_read_u64_array(const struct device_node *np, 1371 const char *propname, 1372 u64 *out_values, size_t sz) 1373 { 1374 int ret = of_property_read_variable_u64_array(np, propname, out_values, 1375 sz, 0); 1376 if (ret >= 0) 1377 return 0; 1378 else 1379 return ret; 1380 } 1381 1382 static inline int of_property_read_u8(const struct device_node *np, 1383 const char *propname, 1384 u8 *out_value) 1385 { 1386 return of_property_read_u8_array(np, propname, out_value, 1); 1387 } 1388 1389 static inline int of_property_read_u16(const struct device_node *np, 1390 const char *propname, 1391 u16 *out_value) 1392 { 1393 return of_property_read_u16_array(np, propname, out_value, 1); 1394 } 1395 1396 static inline int of_property_read_u32(const struct device_node *np, 1397 const char *propname, 1398 u32 *out_value) 1399 { 1400 return of_property_read_u32_array(np, propname, out_value, 1); 1401 } 1402 1403 static inline int of_property_read_s32(const struct device_node *np, 1404 const char *propname, 1405 s32 *out_value) 1406 { 1407 return of_property_read_u32(np, propname, (u32*) out_value); 1408 } 1409 1410 #define of_for_each_phandle(it, err, np, ln, cn, cc) \ 1411 for (of_phandle_iterator_init((it), (np), (ln), (cn), (cc)), \ 1412 err = of_phandle_iterator_next(it); \ 1413 err == 0; \ 1414 err = of_phandle_iterator_next(it)) 1415 1416 #define of_property_for_each_u32(np, propname, prop, p, u) \ 1417 for (prop = of_find_property(np, propname, NULL), \ 1418 p = of_prop_next_u32(prop, NULL, &u); \ 1419 p; \ 1420 p = of_prop_next_u32(prop, p, &u)) 1421 1422 #define of_property_for_each_string(np, propname, prop, s) \ 1423 for (prop = of_find_property(np, propname, NULL), \ 1424 s = of_prop_next_string(prop, NULL); \ 1425 s; \ 1426 s = of_prop_next_string(prop, s)) 1427 1428 #define for_each_node_by_name(dn, name) \ 1429 for (dn = of_find_node_by_name(NULL, name); dn; \ 1430 dn = of_find_node_by_name(dn, name)) 1431 #define for_each_node_by_type(dn, type) \ 1432 for (dn = of_find_node_by_type(NULL, type); dn; \ 1433 dn = of_find_node_by_type(dn, type)) 1434 #define for_each_compatible_node(dn, type, compatible) \ 1435 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \ 1436 dn = of_find_compatible_node(dn, type, compatible)) 1437 #define for_each_matching_node(dn, matches) \ 1438 for (dn = of_find_matching_node(NULL, matches); dn; \ 1439 dn = of_find_matching_node(dn, matches)) 1440 #define for_each_matching_node_and_match(dn, matches, match) \ 1441 for (dn = of_find_matching_node_and_match(NULL, matches, match); \ 1442 dn; dn = of_find_matching_node_and_match(dn, matches, match)) 1443 1444 #define for_each_child_of_node(parent, child) \ 1445 for (child = of_get_next_child(parent, NULL); child != NULL; \ 1446 child = of_get_next_child(parent, child)) 1447 #define for_each_available_child_of_node(parent, child) \ 1448 for (child = of_get_next_available_child(parent, NULL); child != NULL; \ 1449 child = of_get_next_available_child(parent, child)) 1450 1451 #define for_each_of_cpu_node(cpu) \ 1452 for (cpu = of_get_next_cpu_node(NULL); cpu != NULL; \ 1453 cpu = of_get_next_cpu_node(cpu)) 1454 1455 #define for_each_node_with_property(dn, prop_name) \ 1456 for (dn = of_find_node_with_property(NULL, prop_name); dn; \ 1457 dn = of_find_node_with_property(dn, prop_name)) 1458 1459 static inline int of_get_child_count(const struct device_node *np) 1460 { 1461 struct device_node *child; 1462 int num = 0; 1463 1464 for_each_child_of_node(np, child) 1465 num++; 1466 1467 return num; 1468 } 1469 1470 static inline int of_get_available_child_count(const struct device_node *np) 1471 { 1472 struct device_node *child; 1473 int num = 0; 1474 1475 for_each_available_child_of_node(np, child) 1476 num++; 1477 1478 return num; 1479 } 1480 1481 #define _OF_DECLARE_STUB(table, name, compat, fn, fn_type) \ 1482 static const struct of_device_id __of_table_##name \ 1483 __attribute__((unused)) \ 1484 = { .compatible = compat, \ 1485 .data = (fn == (fn_type)NULL) ? fn : fn } 1486 1487 #if defined(CONFIG_OF) && !defined(MODULE) 1488 #define _OF_DECLARE(table, name, compat, fn, fn_type) \ 1489 static const struct of_device_id __of_table_##name \ 1490 __used __section("__" #table "_of_table") \ 1491 __aligned(__alignof__(struct of_device_id)) \ 1492 = { .compatible = compat, \ 1493 .data = (fn == (fn_type)NULL) ? fn : fn } 1494 #else 1495 #define _OF_DECLARE(table, name, compat, fn, fn_type) \ 1496 _OF_DECLARE_STUB(table, name, compat, fn, fn_type) 1497 #endif 1498 1499 typedef int (*of_init_fn_2)(struct device_node *, struct device_node *); 1500 typedef int (*of_init_fn_1_ret)(struct device_node *); 1501 typedef void (*of_init_fn_1)(struct device_node *); 1502 1503 #define OF_DECLARE_1(table, name, compat, fn) \ 1504 _OF_DECLARE(table, name, compat, fn, of_init_fn_1) 1505 #define OF_DECLARE_1_RET(table, name, compat, fn) \ 1506 _OF_DECLARE(table, name, compat, fn, of_init_fn_1_ret) 1507 #define OF_DECLARE_2(table, name, compat, fn) \ 1508 _OF_DECLARE(table, name, compat, fn, of_init_fn_2) 1509 1510 /** 1511 * struct of_changeset_entry - Holds a changeset entry 1512 * 1513 * @node: list_head for the log list 1514 * @action: notifier action 1515 * @np: pointer to the device node affected 1516 * @prop: pointer to the property affected 1517 * @old_prop: hold a pointer to the original property 1518 * 1519 * Every modification of the device tree during a changeset 1520 * is held in a list of of_changeset_entry structures. 1521 * That way we can recover from a partial application, or we can 1522 * revert the changeset 1523 */ 1524 struct of_changeset_entry { 1525 struct list_head node; 1526 unsigned long action; 1527 struct device_node *np; 1528 struct property *prop; 1529 struct property *old_prop; 1530 }; 1531 1532 /** 1533 * struct of_changeset - changeset tracker structure 1534 * 1535 * @entries: list_head for the changeset entries 1536 * 1537 * changesets are a convenient way to apply bulk changes to the 1538 * live tree. In case of an error, changes are rolled-back. 1539 * changesets live on after initial application, and if not 1540 * destroyed after use, they can be reverted in one single call. 1541 */ 1542 struct of_changeset { 1543 struct list_head entries; 1544 }; 1545 1546 enum of_reconfig_change { 1547 OF_RECONFIG_NO_CHANGE = 0, 1548 OF_RECONFIG_CHANGE_ADD, 1549 OF_RECONFIG_CHANGE_REMOVE, 1550 }; 1551 1552 struct notifier_block; 1553 1554 #ifdef CONFIG_OF_DYNAMIC 1555 extern int of_reconfig_notifier_register(struct notifier_block *); 1556 extern int of_reconfig_notifier_unregister(struct notifier_block *); 1557 extern int of_reconfig_notify(unsigned long, struct of_reconfig_data *rd); 1558 extern int of_reconfig_get_state_change(unsigned long action, 1559 struct of_reconfig_data *arg); 1560 1561 extern void of_changeset_init(struct of_changeset *ocs); 1562 extern void of_changeset_destroy(struct of_changeset *ocs); 1563 extern int of_changeset_apply(struct of_changeset *ocs); 1564 extern int of_changeset_revert(struct of_changeset *ocs); 1565 extern int of_changeset_action(struct of_changeset *ocs, 1566 unsigned long action, struct device_node *np, 1567 struct property *prop); 1568 1569 static inline int of_changeset_attach_node(struct of_changeset *ocs, 1570 struct device_node *np) 1571 { 1572 return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL); 1573 } 1574 1575 static inline int of_changeset_detach_node(struct of_changeset *ocs, 1576 struct device_node *np) 1577 { 1578 return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL); 1579 } 1580 1581 static inline int of_changeset_add_property(struct of_changeset *ocs, 1582 struct device_node *np, struct property *prop) 1583 { 1584 return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop); 1585 } 1586 1587 static inline int of_changeset_remove_property(struct of_changeset *ocs, 1588 struct device_node *np, struct property *prop) 1589 { 1590 return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop); 1591 } 1592 1593 static inline int of_changeset_update_property(struct of_changeset *ocs, 1594 struct device_node *np, struct property *prop) 1595 { 1596 return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop); 1597 } 1598 1599 struct device_node *of_changeset_create_node(struct of_changeset *ocs, 1600 struct device_node *parent, 1601 const char *full_name); 1602 int of_changeset_add_prop_string(struct of_changeset *ocs, 1603 struct device_node *np, 1604 const char *prop_name, const char *str); 1605 int of_changeset_add_prop_string_array(struct of_changeset *ocs, 1606 struct device_node *np, 1607 const char *prop_name, 1608 const char **str_array, size_t sz); 1609 int of_changeset_add_prop_u32_array(struct of_changeset *ocs, 1610 struct device_node *np, 1611 const char *prop_name, 1612 const u32 *array, size_t sz); 1613 static inline int of_changeset_add_prop_u32(struct of_changeset *ocs, 1614 struct device_node *np, 1615 const char *prop_name, 1616 const u32 val) 1617 { 1618 return of_changeset_add_prop_u32_array(ocs, np, prop_name, &val, 1); 1619 } 1620 1621 #else /* CONFIG_OF_DYNAMIC */ 1622 static inline int of_reconfig_notifier_register(struct notifier_block *nb) 1623 { 1624 return -EINVAL; 1625 } 1626 static inline int of_reconfig_notifier_unregister(struct notifier_block *nb) 1627 { 1628 return -EINVAL; 1629 } 1630 static inline int of_reconfig_notify(unsigned long action, 1631 struct of_reconfig_data *arg) 1632 { 1633 return -EINVAL; 1634 } 1635 static inline int of_reconfig_get_state_change(unsigned long action, 1636 struct of_reconfig_data *arg) 1637 { 1638 return -EINVAL; 1639 } 1640 #endif /* CONFIG_OF_DYNAMIC */ 1641 1642 /** 1643 * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node 1644 * @np: Pointer to the given device_node 1645 * 1646 * Return: true if present false otherwise 1647 */ 1648 static inline bool of_device_is_system_power_controller(const struct device_node *np) 1649 { 1650 return of_property_read_bool(np, "system-power-controller"); 1651 } 1652 1653 /* 1654 * Overlay support 1655 */ 1656 1657 enum of_overlay_notify_action { 1658 OF_OVERLAY_INIT = 0, /* kzalloc() of ovcs sets this value */ 1659 OF_OVERLAY_PRE_APPLY, 1660 OF_OVERLAY_POST_APPLY, 1661 OF_OVERLAY_PRE_REMOVE, 1662 OF_OVERLAY_POST_REMOVE, 1663 }; 1664 1665 static inline const char *of_overlay_action_name(enum of_overlay_notify_action action) 1666 { 1667 static const char *const of_overlay_action_name[] = { 1668 "init", 1669 "pre-apply", 1670 "post-apply", 1671 "pre-remove", 1672 "post-remove", 1673 }; 1674 1675 return of_overlay_action_name[action]; 1676 } 1677 1678 struct of_overlay_notify_data { 1679 struct device_node *overlay; 1680 struct device_node *target; 1681 }; 1682 1683 #ifdef CONFIG_OF_OVERLAY 1684 1685 int of_overlay_fdt_apply(const void *overlay_fdt, u32 overlay_fdt_size, 1686 int *ovcs_id, struct device_node *target_base); 1687 int of_overlay_remove(int *ovcs_id); 1688 int of_overlay_remove_all(void); 1689 1690 int of_overlay_notifier_register(struct notifier_block *nb); 1691 int of_overlay_notifier_unregister(struct notifier_block *nb); 1692 1693 #else 1694 1695 static inline int of_overlay_fdt_apply(const void *overlay_fdt, u32 overlay_fdt_size, 1696 int *ovcs_id, struct device_node *target_base) 1697 { 1698 return -ENOTSUPP; 1699 } 1700 1701 static inline int of_overlay_remove(int *ovcs_id) 1702 { 1703 return -ENOTSUPP; 1704 } 1705 1706 static inline int of_overlay_remove_all(void) 1707 { 1708 return -ENOTSUPP; 1709 } 1710 1711 static inline int of_overlay_notifier_register(struct notifier_block *nb) 1712 { 1713 return 0; 1714 } 1715 1716 static inline int of_overlay_notifier_unregister(struct notifier_block *nb) 1717 { 1718 return 0; 1719 } 1720 1721 #endif 1722 1723 #endif /* _LINUX_OF_H */ 1724