include/linux/of.h

   1 #ifndef _LINUX_OF_H
   2 #define _LINUX_OF_H
   3 /*
   4  * Definitions for talking to the Open Firmware PROM on
   5  * Power Macintosh and other computers.
   6  *
   7  * Copyright (C) 1996-2005 Paul Mackerras.
   8  *
   9  * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
  10  * Updates for SPARC64 by David S. Miller
  11  * Derived from PowerPC and Sparc prom.h files by Stephen Rothwell, IBM Corp.
  12  *
  13  * This program is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU General Public License
  15  * as published by the Free Software Foundation; either version
  16  * 2 of the License, or (at your option) any later version.
  17  */
  18 #include <linux/types.h>
  19 #include <linux/bitops.h>
  20 #include <linux/errno.h>
  21 #include <linux/kobject.h>
  22 #include <linux/mod_devicetable.h>
  23 #include <linux/spinlock.h>
  24 #include <linux/topology.h>
  25 #include <linux/notifier.h>
  26 #include <linux/property.h>
  27 #include <linux/list.h>
  28
  29 #include <asm/byteorder.h>
  30 #include <asm/errno.h>
  31
  32 typedef u32 phandle;
  33 typedef u32 ihandle;
  34
  35 struct property {
  36         char    *name;
  37         int     length;
  38         void    *value;
  39         struct property *next;
  40         unsigned long _flags;
  41         unsigned int unique_id;
  42         struct bin_attribute attr;
  43 };
  44
  45 #if defined(CONFIG_SPARC)
  46 struct of_irq_controller;
  47 #endif
  48
  49 struct device_node {
  50         const char *name;
  51         const char *type;
  52         phandle phandle;
  53         const char *full_name;
  54         struct fwnode_handle fwnode;
  55
  56         struct  property *properties;
  57         struct  property *deadprops;    /* removed properties */
  58         struct  device_node *parent;
  59         struct  device_node *child;
  60         struct  device_node *sibling;
  61         struct  kobject kobj;
  62         unsigned long _flags;
  63         void    *data;
  64 #if defined(CONFIG_SPARC)
  65         const char *path_component_name;
  66         unsigned int unique_id;
  67         struct of_irq_controller *irq_trans;
  68 #endif
  69 };
  70
  71 #define MAX_PHANDLE_ARGS 16
  72 struct of_phandle_args {
  73         struct device_node *np;
  74         int args_count;
  75         uint32_t args[MAX_PHANDLE_ARGS];
  76 };
  77
  78 struct of_reconfig_data {
  79         struct device_node      *dn;
  80         struct property         *prop;
  81         struct property         *old_prop;
  82 };
  83
  84 /* initialize a node */
  85 extern struct kobj_type of_node_ktype;
  86 static inline void of_node_init(struct device_node *node)
  87 {
  88         kobject_init(&node->kobj, &of_node_ktype);
  89         node->fwnode.type = FWNODE_OF;
  90 }
  91
  92 /* true when node is initialized */
  93 static inline int of_node_is_initialized(struct device_node *node)
  94 {
  95         return node && node->kobj.state_initialized;
  96 }
  97
  98 /* true when node is attached (i.e. present on sysfs) */
  99 static inline int of_node_is_attached(struct device_node *node)
 100 {
 101         return node && node->kobj.state_in_sysfs;
 102 }
 103
 104 #ifdef CONFIG_OF_DYNAMIC
 105 extern struct device_node *of_node_get(struct device_node *node);
 106 extern void of_node_put(struct device_node *node);
 107 #else /* CONFIG_OF_DYNAMIC */
 108 /* Dummy ref counting routines - to be implemented later */
 109 static inline struct device_node *of_node_get(struct device_node *node)
 110 {
 111         return node;
 112 }
 113 static inline void of_node_put(struct device_node *node) { }
 114 #endif /* !CONFIG_OF_DYNAMIC */
 115
 116 /* Pointer for first entry in chain of all nodes. */
 117 extern struct device_node *of_root;
 118 extern struct device_node *of_chosen;
 119 extern struct device_node *of_aliases;
 120 extern struct device_node *of_stdout;
 121 extern raw_spinlock_t devtree_lock;
 122
 123 #ifdef CONFIG_OF
 124 static inline bool is_of_node(struct fwnode_handle *fwnode)
 125 {
 126         return fwnode && fwnode->type == FWNODE_OF;
 127 }
 128
 129 static inline struct device_node *of_node(struct fwnode_handle *fwnode)
 130 {
 131         return fwnode ? container_of(fwnode, struct device_node, fwnode) : NULL;
 132 }
 133
 134 static inline bool of_have_populated_dt(void)
 135 {
 136         return of_root != NULL;
 137 }
 138
 139 static inline bool of_node_is_root(const struct device_node *node)
 140 {
 141         return node && (node->parent == NULL);
 142 }
 143
 144 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
 145 {
 146         return test_bit(flag, &n->_flags);
 147 }
 148
 149 static inline int of_node_test_and_set_flag(struct device_node *n,
 150                                             unsigned long flag)
 151 {
 152         return test_and_set_bit(flag, &n->_flags);
 153 }
 154
 155 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
 156 {
 157         set_bit(flag, &n->_flags);
 158 }
 159
 160 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
 161 {
 162         clear_bit(flag, &n->_flags);
 163 }
 164
 165 static inline int of_property_check_flag(struct property *p, unsigned long flag)
 166 {
 167         return test_bit(flag, &p->_flags);
 168 }
 169
 170 static inline void of_property_set_flag(struct property *p, unsigned long flag)
 171 {
 172         set_bit(flag, &p->_flags);
 173 }
 174
 175 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
 176 {
 177         clear_bit(flag, &p->_flags);
 178 }
 179
 180 extern struct device_node *__of_find_all_nodes(struct device_node *prev);
 181 extern struct device_node *of_find_all_nodes(struct device_node *prev);
 182
 183 /*
 184  * OF address retrieval & translation
 185  */
 186
 187 /* Helper to read a big number; size is in cells (not bytes) */
 188 static inline u64 of_read_number(const __be32 *cell, int size)
 189 {
 190         u64 r = 0;
 191         while (size--)
 192                 r = (r << 32) | be32_to_cpu(*(cell++));
 193         return r;
 194 }
 195
 196 /* Like of_read_number, but we want an unsigned long result */
 197 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
 198 {
 199         /* toss away upper bits if unsigned long is smaller than u64 */
 200         return of_read_number(cell, size);
 201 }
 202
 203 #if defined(CONFIG_SPARC)
 204 #include <asm/prom.h>
 205 #endif
 206
 207 /* Default #address and #size cells.  Allow arch asm/prom.h to override */
 208 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
 209 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
 210 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
 211 #endif
 212
 213 /* Default string compare functions, Allow arch asm/prom.h to override */
 214 #if !defined(of_compat_cmp)
 215 #define of_compat_cmp(s1, s2, l)        strcasecmp((s1), (s2))
 216 #define of_prop_cmp(s1, s2)             strcmp((s1), (s2))
 217 #define of_node_cmp(s1, s2)             strcasecmp((s1), (s2))
 218 #endif
 219
 220 /* flag descriptions */
 221 #define OF_DYNAMIC      1 /* node and properties were allocated via kmalloc */
 222 #define OF_DETACHED     2 /* node has been detached from the device tree */
 223 #define OF_POPULATED    3 /* device already created for the node */
 224 #define OF_POPULATED_BUS        4 /* of_platform_populate recursed to children of this node */
 225
 226 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
 227 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
 228
 229 #define OF_BAD_ADDR     ((u64)-1)
 230
 231 static inline const char *of_node_full_name(const struct device_node *np)
 232 {
 233         return np ? np->full_name : "<no-node>";
 234 }
 235
 236 #define for_each_of_allnodes_from(from, dn) \
 237         for (dn = __of_find_all_nodes(from); dn; dn = __of_find_all_nodes(dn))
 238 #define for_each_of_allnodes(dn) for_each_of_allnodes_from(NULL, dn)
 239 extern struct device_node *of_find_node_by_name(struct device_node *from,
 240         const char *name);
 241 extern struct device_node *of_find_node_by_type(struct device_node *from,
 242         const char *type);
 243 extern struct device_node *of_find_compatible_node(struct device_node *from,
 244         const char *type, const char *compat);
 245 extern struct device_node *of_find_matching_node_and_match(
 246         struct device_node *from,
 247         const struct of_device_id *matches,
 248         const struct of_device_id **match);
 249
 250 extern struct device_node *of_find_node_opts_by_path(const char *path,
 251         const char **opts);
 252 static inline struct device_node *of_find_node_by_path(const char *path)
 253 {
 254         return of_find_node_opts_by_path(path, NULL);
 255 }
 256
 257 extern struct device_node *of_find_node_by_phandle(phandle handle);
 258 extern struct device_node *of_get_parent(const struct device_node *node);
 259 extern struct device_node *of_get_next_parent(struct device_node *node);
 260 extern struct device_node *of_get_next_child(const struct device_node *node,
 261                                              struct device_node *prev);
 262 extern struct device_node *of_get_next_available_child(
 263         const struct device_node *node, struct device_node *prev);
 264
 265 extern struct device_node *of_get_child_by_name(const struct device_node *node,
 266                                         const char *name);
 267
 268 /* cache lookup */
 269 extern struct device_node *of_find_next_cache_node(const struct device_node *);
 270 extern struct device_node *of_find_node_with_property(
 271         struct device_node *from, const char *prop_name);
 272
 273 extern struct property *of_find_property(const struct device_node *np,
 274                                          const char *name,
 275                                          int *lenp);
 276 extern int of_property_count_elems_of_size(const struct device_node *np,
 277                                 const char *propname, int elem_size);
 278 extern int of_property_read_u32_index(const struct device_node *np,
 279                                        const char *propname,
 280                                        u32 index, u32 *out_value);
 281 extern int of_property_read_u8_array(const struct device_node *np,
 282                         const char *propname, u8 *out_values, size_t sz);
 283 extern int of_property_read_u16_array(const struct device_node *np,
 284                         const char *propname, u16 *out_values, size_t sz);
 285 extern int of_property_read_u32_array(const struct device_node *np,
 286                                       const char *propname,
 287                                       u32 *out_values,
 288                                       size_t sz);
 289 extern int of_property_read_u64(const struct device_node *np,
 290                                 const char *propname, u64 *out_value);
 291 extern int of_property_read_u64_array(const struct device_node *np,
 292                                       const char *propname,
 293                                       u64 *out_values,
 294                                       size_t sz);
 295
 296 extern int of_property_read_string(struct device_node *np,
 297                                    const char *propname,
 298                                    const char **out_string);
 299 extern int of_property_match_string(struct device_node *np,
 300                                     const char *propname,
 301                                     const char *string);
 302 extern int of_property_read_string_helper(struct device_node *np,
 303                                               const char *propname,
 304                                               const char **out_strs, size_t sz, int index);
 305 extern int of_device_is_compatible(const struct device_node *device,
 306                                    const char *);
 307 extern bool of_device_is_available(const struct device_node *device);
 308 extern const void *of_get_property(const struct device_node *node,
 309                                 const char *name,
 310                                 int *lenp);
 311 extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
 312 #define for_each_property_of_node(dn, pp) \
 313         for (pp = dn->properties; pp != NULL; pp = pp->next)
 314
 315 extern int of_n_addr_cells(struct device_node *np);
 316 extern int of_n_size_cells(struct device_node *np);
 317 extern const struct of_device_id *of_match_node(
 318         const struct of_device_id *matches, const struct device_node *node);
 319 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
 320 extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
 321 extern struct device_node *of_parse_phandle(const struct device_node *np,
 322                                             const char *phandle_name,
 323                                             int index);
 324 extern int of_parse_phandle_with_args(const struct device_node *np,
 325         const char *list_name, const char *cells_name, int index,
 326         struct of_phandle_args *out_args);
 327 extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
 328         const char *list_name, int cells_count, int index,
 329         struct of_phandle_args *out_args);
 330 extern int of_count_phandle_with_args(const struct device_node *np,
 331         const char *list_name, const char *cells_name);
 332
 333 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
 334 extern int of_alias_get_id(struct device_node *np, const char *stem);
 335 extern int of_alias_get_highest_id(const char *stem);
 336
 337 extern int of_machine_is_compatible(const char *compat);
 338
 339 extern int of_add_property(struct device_node *np, struct property *prop);
 340 extern int of_remove_property(struct device_node *np, struct property *prop);
 341 extern int of_update_property(struct device_node *np, struct property *newprop);
 342
 343 /* For updating the device tree at runtime */
 344 #define OF_RECONFIG_ATTACH_NODE         0x0001
 345 #define OF_RECONFIG_DETACH_NODE         0x0002
 346 #define OF_RECONFIG_ADD_PROPERTY        0x0003
 347 #define OF_RECONFIG_REMOVE_PROPERTY     0x0004
 348 #define OF_RECONFIG_UPDATE_PROPERTY     0x0005
 349
 350 extern int of_attach_node(struct device_node *);
 351 extern int of_detach_node(struct device_node *);
 352
 353 #define of_match_ptr(_ptr)      (_ptr)
 354
 355 /*
 356  * struct property *prop;
 357  * const __be32 *p;
 358  * u32 u;
 359  *
 360  * of_property_for_each_u32(np, "propname", prop, p, u)
 361  *         printk("U32 value: %x\n", u);
 362  */
 363 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
 364                                u32 *pu);
 365 /*
 366  * struct property *prop;
 367  * const char *s;
 368  *
 369  * of_property_for_each_string(np, "propname", prop, s)
 370  *         printk("String value: %s\n", s);
 371  */
 372 const char *of_prop_next_string(struct property *prop, const char *cur);
 373
 374 bool of_console_check(struct device_node *dn, char *name, int index);
 375
 376 #else /* CONFIG_OF */
 377
 378 static inline bool is_of_node(struct fwnode_handle *fwnode)
 379 {
 380         return false;
 381 }
 382
 383 static inline struct device_node *of_node(struct fwnode_handle *fwnode)
 384 {
 385         return NULL;
 386 }
 387
 388 static inline const char* of_node_full_name(const struct device_node *np)
 389 {
 390         return "<no-node>";
 391 }
 392
 393 static inline struct device_node *of_find_node_by_name(struct device_node *from,
 394         const char *name)
 395 {
 396         return NULL;
 397 }
 398
 399 static inline struct device_node *of_find_node_by_type(struct device_node *from,
 400         const char *type)
 401 {
 402         return NULL;
 403 }
 404
 405 static inline struct device_node *of_find_matching_node_and_match(
 406         struct device_node *from,
 407         const struct of_device_id *matches,
 408         const struct of_device_id **match)
 409 {
 410         return NULL;
 411 }
 412
 413 static inline struct device_node *of_find_node_by_path(const char *path)
 414 {
 415         return NULL;
 416 }
 417
 418 static inline struct device_node *of_find_node_opts_by_path(const char *path,
 419         const char **opts)
 420 {
 421         return NULL;
 422 }
 423
 424 static inline struct device_node *of_get_parent(const struct device_node *node)
 425 {
 426         return NULL;
 427 }
 428
 429 static inline struct device_node *of_get_next_child(
 430         const struct device_node *node, struct device_node *prev)
 431 {
 432         return NULL;
 433 }
 434
 435 static inline struct device_node *of_get_next_available_child(
 436         const struct device_node *node, struct device_node *prev)
 437 {
 438         return NULL;
 439 }
 440
 441 static inline struct device_node *of_find_node_with_property(
 442         struct device_node *from, const char *prop_name)
 443 {
 444         return NULL;
 445 }
 446
 447 static inline bool of_have_populated_dt(void)
 448 {
 449         return false;
 450 }
 451
 452 static inline struct device_node *of_get_child_by_name(
 453                                         const struct device_node *node,
 454                                         const char *name)
 455 {
 456         return NULL;
 457 }
 458
 459 static inline int of_device_is_compatible(const struct device_node *device,
 460                                           const char *name)
 461 {
 462         return 0;
 463 }
 464
 465 static inline bool of_device_is_available(const struct device_node *device)
 466 {
 467         return false;
 468 }
 469
 470 static inline struct property *of_find_property(const struct device_node *np,
 471                                                 const char *name,
 472                                                 int *lenp)
 473 {
 474         return NULL;
 475 }
 476
 477 static inline struct device_node *of_find_compatible_node(
 478                                                 struct device_node *from,
 479                                                 const char *type,
 480                                                 const char *compat)
 481 {
 482         return NULL;
 483 }
 484
 485 static inline int of_property_count_elems_of_size(const struct device_node *np,
 486                         const char *propname, int elem_size)
 487 {
 488         return -ENOSYS;
 489 }
 490
 491 static inline int of_property_read_u32_index(const struct device_node *np,
 492                         const char *propname, u32 index, u32 *out_value)
 493 {
 494         return -ENOSYS;
 495 }
 496
 497 static inline int of_property_read_u8_array(const struct device_node *np,
 498                         const char *propname, u8 *out_values, size_t sz)
 499 {
 500         return -ENOSYS;
 501 }
 502
 503 static inline int of_property_read_u16_array(const struct device_node *np,
 504                         const char *propname, u16 *out_values, size_t sz)
 505 {
 506         return -ENOSYS;
 507 }
 508
 509 static inline int of_property_read_u32_array(const struct device_node *np,
 510                                              const char *propname,
 511                                              u32 *out_values, size_t sz)
 512 {
 513         return -ENOSYS;
 514 }
 515
 516 static inline int of_property_read_u64_array(const struct device_node *np,
 517                                              const char *propname,
 518                                              u64 *out_values, size_t sz)
 519 {
 520         return -ENOSYS;
 521 }
 522
 523 static inline int of_property_read_string(struct device_node *np,
 524                                           const char *propname,
 525                                           const char **out_string)
 526 {
 527         return -ENOSYS;
 528 }
 529
 530 static inline int of_property_read_string_helper(struct device_node *np,
 531                                                  const char *propname,
 532                                                  const char **out_strs, size_t sz, int index)
 533 {
 534         return -ENOSYS;
 535 }
 536
 537 static inline const void *of_get_property(const struct device_node *node,
 538                                 const char *name,
 539                                 int *lenp)
 540 {
 541         return NULL;
 542 }
 543
 544 static inline struct device_node *of_get_cpu_node(int cpu,
 545                                         unsigned int *thread)
 546 {
 547         return NULL;
 548 }
 549
 550 static inline int of_property_read_u64(const struct device_node *np,
 551                                        const char *propname, u64 *out_value)
 552 {
 553         return -ENOSYS;
 554 }
 555
 556 static inline int of_property_match_string(struct device_node *np,
 557                                            const char *propname,
 558                                            const char *string)
 559 {
 560         return -ENOSYS;
 561 }
 562
 563 static inline struct device_node *of_parse_phandle(const struct device_node *np,
 564                                                    const char *phandle_name,
 565                                                    int index)
 566 {
 567         return NULL;
 568 }
 569
 570 static inline int of_parse_phandle_with_args(struct device_node *np,
 571                                              const char *list_name,
 572                                              const char *cells_name,
 573                                              int index,
 574                                              struct of_phandle_args *out_args)
 575 {
 576         return -ENOSYS;
 577 }
 578
 579 static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
 580         const char *list_name, int cells_count, int index,
 581         struct of_phandle_args *out_args)
 582 {
 583         return -ENOSYS;
 584 }
 585
 586 static inline int of_count_phandle_with_args(struct device_node *np,
 587                                              const char *list_name,
 588                                              const char *cells_name)
 589 {
 590         return -ENOSYS;
 591 }
 592
 593 static inline int of_alias_get_id(struct device_node *np, const char *stem)
 594 {
 595         return -ENOSYS;
 596 }
 597
 598 static inline int of_alias_get_highest_id(const char *stem)
 599 {
 600         return -ENOSYS;
 601 }
 602
 603 static inline int of_machine_is_compatible(const char *compat)
 604 {
 605         return 0;
 606 }
 607
 608 static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
 609 {
 610         return false;
 611 }
 612
 613 static inline const __be32 *of_prop_next_u32(struct property *prop,
 614                 const __be32 *cur, u32 *pu)
 615 {
 616         return NULL;
 617 }
 618
 619 static inline const char *of_prop_next_string(struct property *prop,
 620                 const char *cur)
 621 {
 622         return NULL;
 623 }
 624
 625 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
 626 {
 627         return 0;
 628 }
 629
 630 static inline int of_node_test_and_set_flag(struct device_node *n,
 631                                             unsigned long flag)
 632 {
 633         return 0;
 634 }
 635
 636 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
 637 {
 638 }
 639
 640 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
 641 {
 642 }
 643
 644 static inline int of_property_check_flag(struct property *p, unsigned long flag)
 645 {
 646         return 0;
 647 }
 648
 649 static inline void of_property_set_flag(struct property *p, unsigned long flag)
 650 {
 651 }
 652
 653 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
 654 {
 655 }
 656
 657 #define of_match_ptr(_ptr)      NULL
 658 #define of_match_node(_matches, _node)  NULL
 659 #endif /* CONFIG_OF */
 660
 661 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
 662 extern int of_node_to_nid(struct device_node *np);
 663 #else
 664 static inline int of_node_to_nid(struct device_node *device) { return 0; }
 665 #endif
 666
 667 static inline struct device_node *of_find_matching_node(
 668         struct device_node *from,
 669         const struct of_device_id *matches)
 670 {
 671         return of_find_matching_node_and_match(from, matches, NULL);
 672 }
 673
 674 /**
 675  * of_property_count_u8_elems - Count the number of u8 elements in a property
 676  *
 677  * @np:         device node from which the property value is to be read.
 678  * @propname:   name of the property to be searched.
 679  *
 680  * Search for a property in a device node and count the number of u8 elements
 681  * in it. Returns number of elements on sucess, -EINVAL if the property does
 682  * not exist or its length does not match a multiple of u8 and -ENODATA if the
 683  * property does not have a value.
 684  */
 685 static inline int of_property_count_u8_elems(const struct device_node *np,
 686                                 const char *propname)
 687 {
 688         return of_property_count_elems_of_size(np, propname, sizeof(u8));
 689 }
 690
 691 /**
 692  * of_property_count_u16_elems - Count the number of u16 elements in a property
 693  *
 694  * @np:         device node from which the property value is to be read.
 695  * @propname:   name of the property to be searched.
 696  *
 697  * Search for a property in a device node and count the number of u16 elements
 698  * in it. Returns number of elements on sucess, -EINVAL if the property does
 699  * not exist or its length does not match a multiple of u16 and -ENODATA if the
 700  * property does not have a value.
 701  */
 702 static inline int of_property_count_u16_elems(const struct device_node *np,
 703                                 const char *propname)
 704 {
 705         return of_property_count_elems_of_size(np, propname, sizeof(u16));
 706 }
 707
 708 /**
 709  * of_property_count_u32_elems - Count the number of u32 elements in a property
 710  *
 711  * @np:         device node from which the property value is to be read.
 712  * @propname:   name of the property to be searched.
 713  *
 714  * Search for a property in a device node and count the number of u32 elements
 715  * in it. Returns number of elements on sucess, -EINVAL if the property does
 716  * not exist or its length does not match a multiple of u32 and -ENODATA if the
 717  * property does not have a value.
 718  */
 719 static inline int of_property_count_u32_elems(const struct device_node *np,
 720                                 const char *propname)
 721 {
 722         return of_property_count_elems_of_size(np, propname, sizeof(u32));
 723 }
 724
 725 /**
 726  * of_property_count_u64_elems - Count the number of u64 elements in a property
 727  *
 728  * @np:         device node from which the property value is to be read.
 729  * @propname:   name of the property to be searched.
 730  *
 731  * Search for a property in a device node and count the number of u64 elements
 732  * in it. Returns number of elements on sucess, -EINVAL if the property does
 733  * not exist or its length does not match a multiple of u64 and -ENODATA if the
 734  * property does not have a value.
 735  */
 736 static inline int of_property_count_u64_elems(const struct device_node *np,
 737                                 const char *propname)
 738 {
 739         return of_property_count_elems_of_size(np, propname, sizeof(u64));
 740 }
 741
 742 /**
 743  * of_property_read_string_array() - Read an array of strings from a multiple
 744  * strings property.
 745  * @np:         device node from which the property value is to be read.
 746  * @propname:   name of the property to be searched.
 747  * @out_strs:   output array of string pointers.
 748  * @sz:         number of array elements to read.
 749  *
 750  * Search for a property in a device tree node and retrieve a list of
 751  * terminated string values (pointer to data, not a copy) in that property.
 752  *
 753  * If @out_strs is NULL, the number of strings in the property is returned.
 754  */
 755 static inline int of_property_read_string_array(struct device_node *np,
 756                                                 const char *propname, const char **out_strs,
 757                                                 size_t sz)
 758 {
 759         return of_property_read_string_helper(np, propname, out_strs, sz, 0);
 760 }
 761
 762 /**
 763  * of_property_count_strings() - Find and return the number of strings from a
 764  * multiple strings property.
 765  * @np:         device node from which the property value is to be read.
 766  * @propname:   name of the property to be searched.
 767  *
 768  * Search for a property in a device tree node and retrieve the number of null
 769  * terminated string contain in it. Returns the number of strings on
 770  * success, -EINVAL if the property does not exist, -ENODATA if property
 771  * does not have a value, and -EILSEQ if the string is not null-terminated
 772  * within the length of the property data.
 773  */
 774 static inline int of_property_count_strings(struct device_node *np,
 775                                             const char *propname)
 776 {
 777         return of_property_read_string_helper(np, propname, NULL, 0, 0);
 778 }
 779
 780 /**
 781  * of_property_read_string_index() - Find and read a string from a multiple
 782  * strings property.
 783  * @np:         device node from which the property value is to be read.
 784  * @propname:   name of the property to be searched.
 785  * @index:      index of the string in the list of strings
 786  * @out_string: pointer to null terminated return string, modified only if
 787  *              return value is 0.
 788  *
 789  * Search for a property in a device tree node and retrieve a null
 790  * terminated string value (pointer to data, not a copy) in the list of strings
 791  * contained in that property.
 792  * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
 793  * property does not have a value, and -EILSEQ if the string is not
 794  * null-terminated within the length of the property data.
 795  *
 796  * The out_string pointer is modified only if a valid string can be decoded.
 797  */
 798 static inline int of_property_read_string_index(struct device_node *np,
 799                                                 const char *propname,
 800                                                 int index, const char **output)
 801 {
 802         int rc = of_property_read_string_helper(np, propname, output, 1, index);
 803         return rc < 0 ? rc : 0;
 804 }
 805
 806 /**
 807  * of_property_read_bool - Findfrom a property
 808  * @np:         device node from which the property value is to be read.
 809  * @propname:   name of the property to be searched.
 810  *
 811  * Search for a property in a device node.
 812  * Returns true if the property exist false otherwise.
 813  */
 814 static inline bool of_property_read_bool(const struct device_node *np,
 815                                          const char *propname)
 816 {
 817         struct property *prop = of_find_property(np, propname, NULL);
 818
 819         return prop ? true : false;
 820 }
 821
 822 static inline int of_property_read_u8(const struct device_node *np,
 823                                        const char *propname,
 824                                        u8 *out_value)
 825 {
 826         return of_property_read_u8_array(np, propname, out_value, 1);
 827 }
 828
 829 static inline int of_property_read_u16(const struct device_node *np,
 830                                        const char *propname,
 831                                        u16 *out_value)
 832 {
 833         return of_property_read_u16_array(np, propname, out_value, 1);
 834 }
 835
 836 static inline int of_property_read_u32(const struct device_node *np,
 837                                        const char *propname,
 838                                        u32 *out_value)
 839 {
 840         return of_property_read_u32_array(np, propname, out_value, 1);
 841 }
 842
 843 static inline int of_property_read_s32(const struct device_node *np,
 844                                        const char *propname,
 845                                        s32 *out_value)
 846 {
 847         return of_property_read_u32(np, propname, (u32*) out_value);
 848 }
 849
 850 #define of_property_for_each_u32(np, propname, prop, p, u)      \
 851         for (prop = of_find_property(np, propname, NULL),       \
 852                 p = of_prop_next_u32(prop, NULL, &u);           \
 853                 p;                                              \
 854                 p = of_prop_next_u32(prop, p, &u))
 855
 856 #define of_property_for_each_string(np, propname, prop, s)      \
 857         for (prop = of_find_property(np, propname, NULL),       \
 858                 s = of_prop_next_string(prop, NULL);            \
 859                 s;                                              \
 860                 s = of_prop_next_string(prop, s))
 861
 862 #define for_each_node_by_name(dn, name) \
 863         for (dn = of_find_node_by_name(NULL, name); dn; \
 864              dn = of_find_node_by_name(dn, name))
 865 #define for_each_node_by_type(dn, type) \
 866         for (dn = of_find_node_by_type(NULL, type); dn; \
 867              dn = of_find_node_by_type(dn, type))
 868 #define for_each_compatible_node(dn, type, compatible) \
 869         for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
 870              dn = of_find_compatible_node(dn, type, compatible))
 871 #define for_each_matching_node(dn, matches) \
 872         for (dn = of_find_matching_node(NULL, matches); dn; \
 873              dn = of_find_matching_node(dn, matches))
 874 #define for_each_matching_node_and_match(dn, matches, match) \
 875         for (dn = of_find_matching_node_and_match(NULL, matches, match); \
 876              dn; dn = of_find_matching_node_and_match(dn, matches, match))
 877
 878 #define for_each_child_of_node(parent, child) \
 879         for (child = of_get_next_child(parent, NULL); child != NULL; \
 880              child = of_get_next_child(parent, child))
 881 #define for_each_available_child_of_node(parent, child) \
 882         for (child = of_get_next_available_child(parent, NULL); child != NULL; \
 883              child = of_get_next_available_child(parent, child))
 884
 885 #define for_each_node_with_property(dn, prop_name) \
 886         for (dn = of_find_node_with_property(NULL, prop_name); dn; \
 887              dn = of_find_node_with_property(dn, prop_name))
 888
 889 static inline int of_get_child_count(const struct device_node *np)
 890 {
 891         struct device_node *child;
 892         int num = 0;
 893
 894         for_each_child_of_node(np, child)
 895                 num++;
 896
 897         return num;
 898 }
 899
 900 static inline int of_get_available_child_count(const struct device_node *np)
 901 {
 902         struct device_node *child;
 903         int num = 0;
 904
 905         for_each_available_child_of_node(np, child)
 906                 num++;
 907
 908         return num;
 909 }
 910
 911 #ifdef CONFIG_OF
 912 #define _OF_DECLARE(table, name, compat, fn, fn_type)                   \
 913         static const struct of_device_id __of_table_##name              \
 914                 __used __section(__##table##_of_table)                  \
 915                  = { .compatible = compat,                              \
 916                      .data = (fn == (fn_type)NULL) ? fn : fn  }
 917 #else
 918 #define _OF_DECLARE(table, name, compat, fn, fn_type)                   \
 919         static const struct of_device_id __of_table_##name              \
 920                 __attribute__((unused))                                 \
 921                  = { .compatible = compat,                              \
 922                      .data = (fn == (fn_type)NULL) ? fn : fn }
 923 #endif
 924
 925 typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
 926 typedef void (*of_init_fn_1)(struct device_node *);
 927
 928 #define OF_DECLARE_1(table, name, compat, fn) \
 929                 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
 930 #define OF_DECLARE_2(table, name, compat, fn) \
 931                 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
 932
 933 /**
 934  * struct of_changeset_entry    - Holds a changeset entry
 935  *
 936  * @node:       list_head for the log list
 937  * @action:     notifier action
 938  * @np:         pointer to the device node affected
 939  * @prop:       pointer to the property affected
 940  * @old_prop:   hold a pointer to the original property
 941  *
 942  * Every modification of the device tree during a changeset
 943  * is held in a list of of_changeset_entry structures.
 944  * That way we can recover from a partial application, or we can
 945  * revert the changeset
 946  */
 947 struct of_changeset_entry {
 948         struct list_head node;
 949         unsigned long action;
 950         struct device_node *np;
 951         struct property *prop;
 952         struct property *old_prop;
 953 };
 954
 955 /**
 956  * struct of_changeset - changeset tracker structure
 957  *
 958  * @entries:    list_head for the changeset entries
 959  *
 960  * changesets are a convenient way to apply bulk changes to the
 961  * live tree. In case of an error, changes are rolled-back.
 962  * changesets live on after initial application, and if not
 963  * destroyed after use, they can be reverted in one single call.
 964  */
 965 struct of_changeset {
 966         struct list_head entries;
 967 };
 968
 969 enum of_reconfig_change {
 970         OF_RECONFIG_NO_CHANGE = 0,
 971         OF_RECONFIG_CHANGE_ADD,
 972         OF_RECONFIG_CHANGE_REMOVE,
 973 };
 974
 975 #ifdef CONFIG_OF_DYNAMIC
 976 extern int of_reconfig_notifier_register(struct notifier_block *);
 977 extern int of_reconfig_notifier_unregister(struct notifier_block *);
 978 extern int of_reconfig_notify(unsigned long, struct of_reconfig_data *rd);
 979 extern int of_reconfig_get_state_change(unsigned long action,
 980                                         struct of_reconfig_data *arg);
 981
 982 extern void of_changeset_init(struct of_changeset *ocs);
 983 extern void of_changeset_destroy(struct of_changeset *ocs);
 984 extern int of_changeset_apply(struct of_changeset *ocs);
 985 extern int of_changeset_revert(struct of_changeset *ocs);
 986 extern int of_changeset_action(struct of_changeset *ocs,
 987                 unsigned long action, struct device_node *np,
 988                 struct property *prop);
 989
 990 static inline int of_changeset_attach_node(struct of_changeset *ocs,
 991                 struct device_node *np)
 992 {
 993         return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
 994 }
 995
 996 static inline int of_changeset_detach_node(struct of_changeset *ocs,
 997                 struct device_node *np)
 998 {
 999         return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
1000 }
1001
1002 static inline int of_changeset_add_property(struct of_changeset *ocs,
1003                 struct device_node *np, struct property *prop)
1004 {
1005         return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
1006 }
1007
1008 static inline int of_changeset_remove_property(struct of_changeset *ocs,
1009                 struct device_node *np, struct property *prop)
1010 {
1011         return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
1012 }
1013
1014 static inline int of_changeset_update_property(struct of_changeset *ocs,
1015                 struct device_node *np, struct property *prop)
1016 {
1017         return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
1018 }
1019 #else /* CONFIG_OF_DYNAMIC */
1020 static inline int of_reconfig_notifier_register(struct notifier_block *nb)
1021 {
1022         return -EINVAL;
1023 }
1024 static inline int of_reconfig_notifier_unregister(struct notifier_block *nb)
1025 {
1026         return -EINVAL;
1027 }
1028 static inline int of_reconfig_notify(unsigned long action,
1029                                      struct of_reconfig_data *arg)
1030 {
1031         return -EINVAL;
1032 }
1033 static inline int of_reconfig_get_state_change(unsigned long action,
1034                                                 struct of_reconfig_data *arg)
1035 {
1036         return -EINVAL;
1037 }
1038 #endif /* CONFIG_OF_DYNAMIC */
1039
1040 /* CONFIG_OF_RESOLVE api */
1041 extern int of_resolve_phandles(struct device_node *tree);
1042
1043 /**
1044  * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
1045  * @np: Pointer to the given device_node
1046  *
1047  * return true if present false otherwise
1048  */
1049 static inline bool of_device_is_system_power_controller(const struct device_node *np)
1050 {
1051         return of_property_read_bool(np, "system-power-controller");
1052 }
1053
1054 /**
1055  * Overlay support
1056  */
1057
1058 #ifdef CONFIG_OF_OVERLAY
1059
1060 /* ID based overlays; the API for external users */
1061 int of_overlay_create(struct device_node *tree);
1062 int of_overlay_destroy(int id);
1063 int of_overlay_destroy_all(void);
1064
1065 #else
1066
1067 static inline int of_overlay_create(struct device_node *tree)
1068 {
1069         return -ENOTSUPP;
1070 }
1071
1072 static inline int of_overlay_destroy(int id)
1073 {
1074         return -ENOTSUPP;
1075 }
1076
1077 static inline int of_overlay_destroy_all(void)
1078 {
1079         return -ENOTSUPP;
1080 }
1081
1082 #endif
1083
1084 #endif /* _LINUX_OF_H */