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 bool of_device_is_big_endian(const struct device_node *device);
 309 extern const void *of_get_property(const struct device_node *node,
 310                                 const char *name,
 311                                 int *lenp);
 312 extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
 313 #define for_each_property_of_node(dn, pp) \
 314         for (pp = dn->properties; pp != NULL; pp = pp->next)
 315
 316 extern int of_n_addr_cells(struct device_node *np);
 317 extern int of_n_size_cells(struct device_node *np);
 318 extern const struct of_device_id *of_match_node(
 319         const struct of_device_id *matches, const struct device_node *node);
 320 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
 321 extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
 322 extern struct device_node *of_parse_phandle(const struct device_node *np,
 323                                             const char *phandle_name,
 324                                             int index);
 325 extern int of_parse_phandle_with_args(const struct device_node *np,
 326         const char *list_name, const char *cells_name, int index,
 327         struct of_phandle_args *out_args);
 328 extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
 329         const char *list_name, int cells_count, int index,
 330         struct of_phandle_args *out_args);
 331 extern int of_count_phandle_with_args(const struct device_node *np,
 332         const char *list_name, const char *cells_name);
 333
 334 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
 335 extern int of_alias_get_id(struct device_node *np, const char *stem);
 336 extern int of_alias_get_highest_id(const char *stem);
 337
 338 extern int of_machine_is_compatible(const char *compat);
 339
 340 extern int of_add_property(struct device_node *np, struct property *prop);
 341 extern int of_remove_property(struct device_node *np, struct property *prop);
 342 extern int of_update_property(struct device_node *np, struct property *newprop);
 343
 344 /* For updating the device tree at runtime */
 345 #define OF_RECONFIG_ATTACH_NODE         0x0001
 346 #define OF_RECONFIG_DETACH_NODE         0x0002
 347 #define OF_RECONFIG_ADD_PROPERTY        0x0003
 348 #define OF_RECONFIG_REMOVE_PROPERTY     0x0004
 349 #define OF_RECONFIG_UPDATE_PROPERTY     0x0005
 350
 351 extern int of_attach_node(struct device_node *);
 352 extern int of_detach_node(struct device_node *);
 353
 354 #define of_match_ptr(_ptr)      (_ptr)
 355
 356 /*
 357  * struct property *prop;
 358  * const __be32 *p;
 359  * u32 u;
 360  *
 361  * of_property_for_each_u32(np, "propname", prop, p, u)
 362  *         printk("U32 value: %x\n", u);
 363  */
 364 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
 365                                u32 *pu);
 366 /*
 367  * struct property *prop;
 368  * const char *s;
 369  *
 370  * of_property_for_each_string(np, "propname", prop, s)
 371  *         printk("String value: %s\n", s);
 372  */
 373 const char *of_prop_next_string(struct property *prop, const char *cur);
 374
 375 bool of_console_check(struct device_node *dn, char *name, int index);
 376
 377 #else /* CONFIG_OF */
 378
 379 static inline bool is_of_node(struct fwnode_handle *fwnode)
 380 {
 381         return false;
 382 }
 383
 384 static inline struct device_node *of_node(struct fwnode_handle *fwnode)
 385 {
 386         return NULL;
 387 }
 388
 389 static inline const char* of_node_full_name(const struct device_node *np)
 390 {
 391         return "<no-node>";
 392 }
 393
 394 static inline struct device_node *of_find_node_by_name(struct device_node *from,
 395         const char *name)
 396 {
 397         return NULL;
 398 }
 399
 400 static inline struct device_node *of_find_node_by_type(struct device_node *from,
 401         const char *type)
 402 {
 403         return NULL;
 404 }
 405
 406 static inline struct device_node *of_find_matching_node_and_match(
 407         struct device_node *from,
 408         const struct of_device_id *matches,
 409         const struct of_device_id **match)
 410 {
 411         return NULL;
 412 }
 413
 414 static inline struct device_node *of_find_node_by_path(const char *path)
 415 {
 416         return NULL;
 417 }
 418
 419 static inline struct device_node *of_find_node_opts_by_path(const char *path,
 420         const char **opts)
 421 {
 422         return NULL;
 423 }
 424
 425 static inline struct device_node *of_get_parent(const struct device_node *node)
 426 {
 427         return NULL;
 428 }
 429
 430 static inline struct device_node *of_get_next_child(
 431         const struct device_node *node, struct device_node *prev)
 432 {
 433         return NULL;
 434 }
 435
 436 static inline struct device_node *of_get_next_available_child(
 437         const struct device_node *node, struct device_node *prev)
 438 {
 439         return NULL;
 440 }
 441
 442 static inline struct device_node *of_find_node_with_property(
 443         struct device_node *from, const char *prop_name)
 444 {
 445         return NULL;
 446 }
 447
 448 static inline bool of_have_populated_dt(void)
 449 {
 450         return false;
 451 }
 452
 453 static inline struct device_node *of_get_child_by_name(
 454                                         const struct device_node *node,
 455                                         const char *name)
 456 {
 457         return NULL;
 458 }
 459
 460 static inline int of_device_is_compatible(const struct device_node *device,
 461                                           const char *name)
 462 {
 463         return 0;
 464 }
 465
 466 static inline bool of_device_is_available(const struct device_node *device)
 467 {
 468         return false;
 469 }
 470
 471 static inline bool of_device_is_big_endian(const struct device_node *device)
 472 {
 473         return false;
 474 }
 475
 476 static inline struct property *of_find_property(const struct device_node *np,
 477                                                 const char *name,
 478                                                 int *lenp)
 479 {
 480         return NULL;
 481 }
 482
 483 static inline struct device_node *of_find_compatible_node(
 484                                                 struct device_node *from,
 485                                                 const char *type,
 486                                                 const char *compat)
 487 {
 488         return NULL;
 489 }
 490
 491 static inline int of_property_count_elems_of_size(const struct device_node *np,
 492                         const char *propname, int elem_size)
 493 {
 494         return -ENOSYS;
 495 }
 496
 497 static inline int of_property_read_u32_index(const struct device_node *np,
 498                         const char *propname, u32 index, u32 *out_value)
 499 {
 500         return -ENOSYS;
 501 }
 502
 503 static inline int of_property_read_u8_array(const struct device_node *np,
 504                         const char *propname, u8 *out_values, size_t sz)
 505 {
 506         return -ENOSYS;
 507 }
 508
 509 static inline int of_property_read_u16_array(const struct device_node *np,
 510                         const char *propname, u16 *out_values, size_t sz)
 511 {
 512         return -ENOSYS;
 513 }
 514
 515 static inline int of_property_read_u32_array(const struct device_node *np,
 516                                              const char *propname,
 517                                              u32 *out_values, size_t sz)
 518 {
 519         return -ENOSYS;
 520 }
 521
 522 static inline int of_property_read_u64_array(const struct device_node *np,
 523                                              const char *propname,
 524                                              u64 *out_values, size_t sz)
 525 {
 526         return -ENOSYS;
 527 }
 528
 529 static inline int of_property_read_string(struct device_node *np,
 530                                           const char *propname,
 531                                           const char **out_string)
 532 {
 533         return -ENOSYS;
 534 }
 535
 536 static inline int of_property_read_string_helper(struct device_node *np,
 537                                                  const char *propname,
 538                                                  const char **out_strs, size_t sz, int index)
 539 {
 540         return -ENOSYS;
 541 }
 542
 543 static inline const void *of_get_property(const struct device_node *node,
 544                                 const char *name,
 545                                 int *lenp)
 546 {
 547         return NULL;
 548 }
 549
 550 static inline struct device_node *of_get_cpu_node(int cpu,
 551                                         unsigned int *thread)
 552 {
 553         return NULL;
 554 }
 555
 556 static inline int of_property_read_u64(const struct device_node *np,
 557                                        const char *propname, u64 *out_value)
 558 {
 559         return -ENOSYS;
 560 }
 561
 562 static inline int of_property_match_string(struct device_node *np,
 563                                            const char *propname,
 564                                            const char *string)
 565 {
 566         return -ENOSYS;
 567 }
 568
 569 static inline struct device_node *of_parse_phandle(const struct device_node *np,
 570                                                    const char *phandle_name,
 571                                                    int index)
 572 {
 573         return NULL;
 574 }
 575
 576 static inline int of_parse_phandle_with_args(struct device_node *np,
 577                                              const char *list_name,
 578                                              const char *cells_name,
 579                                              int index,
 580                                              struct of_phandle_args *out_args)
 581 {
 582         return -ENOSYS;
 583 }
 584
 585 static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
 586         const char *list_name, int cells_count, int index,
 587         struct of_phandle_args *out_args)
 588 {
 589         return -ENOSYS;
 590 }
 591
 592 static inline int of_count_phandle_with_args(struct device_node *np,
 593                                              const char *list_name,
 594                                              const char *cells_name)
 595 {
 596         return -ENOSYS;
 597 }
 598
 599 static inline int of_alias_get_id(struct device_node *np, const char *stem)
 600 {
 601         return -ENOSYS;
 602 }
 603
 604 static inline int of_alias_get_highest_id(const char *stem)
 605 {
 606         return -ENOSYS;
 607 }
 608
 609 static inline int of_machine_is_compatible(const char *compat)
 610 {
 611         return 0;
 612 }
 613
 614 static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
 615 {
 616         return false;
 617 }
 618
 619 static inline const __be32 *of_prop_next_u32(struct property *prop,
 620                 const __be32 *cur, u32 *pu)
 621 {
 622         return NULL;
 623 }
 624
 625 static inline const char *of_prop_next_string(struct property *prop,
 626                 const char *cur)
 627 {
 628         return NULL;
 629 }
 630
 631 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
 632 {
 633         return 0;
 634 }
 635
 636 static inline int of_node_test_and_set_flag(struct device_node *n,
 637                                             unsigned long flag)
 638 {
 639         return 0;
 640 }
 641
 642 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
 643 {
 644 }
 645
 646 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
 647 {
 648 }
 649
 650 static inline int of_property_check_flag(struct property *p, unsigned long flag)
 651 {
 652         return 0;
 653 }
 654
 655 static inline void of_property_set_flag(struct property *p, unsigned long flag)
 656 {
 657 }
 658
 659 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
 660 {
 661 }
 662
 663 #define of_match_ptr(_ptr)      NULL
 664 #define of_match_node(_matches, _node)  NULL
 665 #endif /* CONFIG_OF */
 666
 667 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
 668 extern int of_node_to_nid(struct device_node *np);
 669 #else
 670 static inline int of_node_to_nid(struct device_node *device)
 671 {
 672         return NUMA_NO_NODE;
 673 }
 674 #endif
 675
 676 static inline struct device_node *of_find_matching_node(
 677         struct device_node *from,
 678         const struct of_device_id *matches)
 679 {
 680         return of_find_matching_node_and_match(from, matches, NULL);
 681 }
 682
 683 /**
 684  * of_property_count_u8_elems - Count the number of u8 elements in a property
 685  *
 686  * @np:         device node from which the property value is to be read.
 687  * @propname:   name of the property to be searched.
 688  *
 689  * Search for a property in a device node and count the number of u8 elements
 690  * in it. Returns number of elements on sucess, -EINVAL if the property does
 691  * not exist or its length does not match a multiple of u8 and -ENODATA if the
 692  * property does not have a value.
 693  */
 694 static inline int of_property_count_u8_elems(const struct device_node *np,
 695                                 const char *propname)
 696 {
 697         return of_property_count_elems_of_size(np, propname, sizeof(u8));
 698 }
 699
 700 /**
 701  * of_property_count_u16_elems - Count the number of u16 elements in a property
 702  *
 703  * @np:         device node from which the property value is to be read.
 704  * @propname:   name of the property to be searched.
 705  *
 706  * Search for a property in a device node and count the number of u16 elements
 707  * in it. Returns number of elements on sucess, -EINVAL if the property does
 708  * not exist or its length does not match a multiple of u16 and -ENODATA if the
 709  * property does not have a value.
 710  */
 711 static inline int of_property_count_u16_elems(const struct device_node *np,
 712                                 const char *propname)
 713 {
 714         return of_property_count_elems_of_size(np, propname, sizeof(u16));
 715 }
 716
 717 /**
 718  * of_property_count_u32_elems - Count the number of u32 elements in a property
 719  *
 720  * @np:         device node from which the property value is to be read.
 721  * @propname:   name of the property to be searched.
 722  *
 723  * Search for a property in a device node and count the number of u32 elements
 724  * in it. Returns number of elements on sucess, -EINVAL if the property does
 725  * not exist or its length does not match a multiple of u32 and -ENODATA if the
 726  * property does not have a value.
 727  */
 728 static inline int of_property_count_u32_elems(const struct device_node *np,
 729                                 const char *propname)
 730 {
 731         return of_property_count_elems_of_size(np, propname, sizeof(u32));
 732 }
 733
 734 /**
 735  * of_property_count_u64_elems - Count the number of u64 elements in a property
 736  *
 737  * @np:         device node from which the property value is to be read.
 738  * @propname:   name of the property to be searched.
 739  *
 740  * Search for a property in a device node and count the number of u64 elements
 741  * in it. Returns number of elements on sucess, -EINVAL if the property does
 742  * not exist or its length does not match a multiple of u64 and -ENODATA if the
 743  * property does not have a value.
 744  */
 745 static inline int of_property_count_u64_elems(const struct device_node *np,
 746                                 const char *propname)
 747 {
 748         return of_property_count_elems_of_size(np, propname, sizeof(u64));
 749 }
 750
 751 /**
 752  * of_property_read_string_array() - Read an array of strings from a multiple
 753  * strings property.
 754  * @np:         device node from which the property value is to be read.
 755  * @propname:   name of the property to be searched.
 756  * @out_strs:   output array of string pointers.
 757  * @sz:         number of array elements to read.
 758  *
 759  * Search for a property in a device tree node and retrieve a list of
 760  * terminated string values (pointer to data, not a copy) in that property.
 761  *
 762  * If @out_strs is NULL, the number of strings in the property is returned.
 763  */
 764 static inline int of_property_read_string_array(struct device_node *np,
 765                                                 const char *propname, const char **out_strs,
 766                                                 size_t sz)
 767 {
 768         return of_property_read_string_helper(np, propname, out_strs, sz, 0);
 769 }
 770
 771 /**
 772  * of_property_count_strings() - Find and return the number of strings from a
 773  * multiple strings property.
 774  * @np:         device node from which the property value is to be read.
 775  * @propname:   name of the property to be searched.
 776  *
 777  * Search for a property in a device tree node and retrieve the number of null
 778  * terminated string contain in it. Returns the number of strings on
 779  * success, -EINVAL if the property does not exist, -ENODATA if property
 780  * does not have a value, and -EILSEQ if the string is not null-terminated
 781  * within the length of the property data.
 782  */
 783 static inline int of_property_count_strings(struct device_node *np,
 784                                             const char *propname)
 785 {
 786         return of_property_read_string_helper(np, propname, NULL, 0, 0);
 787 }
 788
 789 /**
 790  * of_property_read_string_index() - Find and read a string from a multiple
 791  * strings property.
 792  * @np:         device node from which the property value is to be read.
 793  * @propname:   name of the property to be searched.
 794  * @index:      index of the string in the list of strings
 795  * @out_string: pointer to null terminated return string, modified only if
 796  *              return value is 0.
 797  *
 798  * Search for a property in a device tree node and retrieve a null
 799  * terminated string value (pointer to data, not a copy) in the list of strings
 800  * contained in that property.
 801  * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
 802  * property does not have a value, and -EILSEQ if the string is not
 803  * null-terminated within the length of the property data.
 804  *
 805  * The out_string pointer is modified only if a valid string can be decoded.
 806  */
 807 static inline int of_property_read_string_index(struct device_node *np,
 808                                                 const char *propname,
 809                                                 int index, const char **output)
 810 {
 811         int rc = of_property_read_string_helper(np, propname, output, 1, index);
 812         return rc < 0 ? rc : 0;
 813 }
 814
 815 /**
 816  * of_property_read_bool - Findfrom a property
 817  * @np:         device node from which the property value is to be read.
 818  * @propname:   name of the property to be searched.
 819  *
 820  * Search for a property in a device node.
 821  * Returns true if the property exist false otherwise.
 822  */
 823 static inline bool of_property_read_bool(const struct device_node *np,
 824                                          const char *propname)
 825 {
 826         struct property *prop = of_find_property(np, propname, NULL);
 827
 828         return prop ? true : false;
 829 }
 830
 831 static inline int of_property_read_u8(const struct device_node *np,
 832                                        const char *propname,
 833                                        u8 *out_value)
 834 {
 835         return of_property_read_u8_array(np, propname, out_value, 1);
 836 }
 837
 838 static inline int of_property_read_u16(const struct device_node *np,
 839                                        const char *propname,
 840                                        u16 *out_value)
 841 {
 842         return of_property_read_u16_array(np, propname, out_value, 1);
 843 }
 844
 845 static inline int of_property_read_u32(const struct device_node *np,
 846                                        const char *propname,
 847                                        u32 *out_value)
 848 {
 849         return of_property_read_u32_array(np, propname, out_value, 1);
 850 }
 851
 852 static inline int of_property_read_s32(const struct device_node *np,
 853                                        const char *propname,
 854                                        s32 *out_value)
 855 {
 856         return of_property_read_u32(np, propname, (u32*) out_value);
 857 }
 858
 859 #define of_property_for_each_u32(np, propname, prop, p, u)      \
 860         for (prop = of_find_property(np, propname, NULL),       \
 861                 p = of_prop_next_u32(prop, NULL, &u);           \
 862                 p;                                              \
 863                 p = of_prop_next_u32(prop, p, &u))
 864
 865 #define of_property_for_each_string(np, propname, prop, s)      \
 866         for (prop = of_find_property(np, propname, NULL),       \
 867                 s = of_prop_next_string(prop, NULL);            \
 868                 s;                                              \
 869                 s = of_prop_next_string(prop, s))
 870
 871 #define for_each_node_by_name(dn, name) \
 872         for (dn = of_find_node_by_name(NULL, name); dn; \
 873              dn = of_find_node_by_name(dn, name))
 874 #define for_each_node_by_type(dn, type) \
 875         for (dn = of_find_node_by_type(NULL, type); dn; \
 876              dn = of_find_node_by_type(dn, type))
 877 #define for_each_compatible_node(dn, type, compatible) \
 878         for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
 879              dn = of_find_compatible_node(dn, type, compatible))
 880 #define for_each_matching_node(dn, matches) \
 881         for (dn = of_find_matching_node(NULL, matches); dn; \
 882              dn = of_find_matching_node(dn, matches))
 883 #define for_each_matching_node_and_match(dn, matches, match) \
 884         for (dn = of_find_matching_node_and_match(NULL, matches, match); \
 885              dn; dn = of_find_matching_node_and_match(dn, matches, match))
 886
 887 #define for_each_child_of_node(parent, child) \
 888         for (child = of_get_next_child(parent, NULL); child != NULL; \
 889              child = of_get_next_child(parent, child))
 890 #define for_each_available_child_of_node(parent, child) \
 891         for (child = of_get_next_available_child(parent, NULL); child != NULL; \
 892              child = of_get_next_available_child(parent, child))
 893
 894 #define for_each_node_with_property(dn, prop_name) \
 895         for (dn = of_find_node_with_property(NULL, prop_name); dn; \
 896              dn = of_find_node_with_property(dn, prop_name))
 897
 898 static inline int of_get_child_count(const struct device_node *np)
 899 {
 900         struct device_node *child;
 901         int num = 0;
 902
 903         for_each_child_of_node(np, child)
 904                 num++;
 905
 906         return num;
 907 }
 908
 909 static inline int of_get_available_child_count(const struct device_node *np)
 910 {
 911         struct device_node *child;
 912         int num = 0;
 913
 914         for_each_available_child_of_node(np, child)
 915                 num++;
 916
 917         return num;
 918 }
 919
 920 #ifdef CONFIG_OF
 921 #define _OF_DECLARE(table, name, compat, fn, fn_type)                   \
 922         static const struct of_device_id __of_table_##name              \
 923                 __used __section(__##table##_of_table)                  \
 924                  = { .compatible = compat,                              \
 925                      .data = (fn == (fn_type)NULL) ? fn : fn  }
 926 #else
 927 #define _OF_DECLARE(table, name, compat, fn, fn_type)                   \
 928         static const struct of_device_id __of_table_##name              \
 929                 __attribute__((unused))                                 \
 930                  = { .compatible = compat,                              \
 931                      .data = (fn == (fn_type)NULL) ? fn : fn }
 932 #endif
 933
 934 typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
 935 typedef void (*of_init_fn_1)(struct device_node *);
 936
 937 #define OF_DECLARE_1(table, name, compat, fn) \
 938                 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
 939 #define OF_DECLARE_2(table, name, compat, fn) \
 940                 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
 941
 942 /**
 943  * struct of_changeset_entry    - Holds a changeset entry
 944  *
 945  * @node:       list_head for the log list
 946  * @action:     notifier action
 947  * @np:         pointer to the device node affected
 948  * @prop:       pointer to the property affected
 949  * @old_prop:   hold a pointer to the original property
 950  *
 951  * Every modification of the device tree during a changeset
 952  * is held in a list of of_changeset_entry structures.
 953  * That way we can recover from a partial application, or we can
 954  * revert the changeset
 955  */
 956 struct of_changeset_entry {
 957         struct list_head node;
 958         unsigned long action;
 959         struct device_node *np;
 960         struct property *prop;
 961         struct property *old_prop;
 962 };
 963
 964 /**
 965  * struct of_changeset - changeset tracker structure
 966  *
 967  * @entries:    list_head for the changeset entries
 968  *
 969  * changesets are a convenient way to apply bulk changes to the
 970  * live tree. In case of an error, changes are rolled-back.
 971  * changesets live on after initial application, and if not
 972  * destroyed after use, they can be reverted in one single call.
 973  */
 974 struct of_changeset {
 975         struct list_head entries;
 976 };
 977
 978 enum of_reconfig_change {
 979         OF_RECONFIG_NO_CHANGE = 0,
 980         OF_RECONFIG_CHANGE_ADD,
 981         OF_RECONFIG_CHANGE_REMOVE,
 982 };
 983
 984 #ifdef CONFIG_OF_DYNAMIC
 985 extern int of_reconfig_notifier_register(struct notifier_block *);
 986 extern int of_reconfig_notifier_unregister(struct notifier_block *);
 987 extern int of_reconfig_notify(unsigned long, struct of_reconfig_data *rd);
 988 extern int of_reconfig_get_state_change(unsigned long action,
 989                                         struct of_reconfig_data *arg);
 990
 991 extern void of_changeset_init(struct of_changeset *ocs);
 992 extern void of_changeset_destroy(struct of_changeset *ocs);
 993 extern int of_changeset_apply(struct of_changeset *ocs);
 994 extern int of_changeset_revert(struct of_changeset *ocs);
 995 extern int of_changeset_action(struct of_changeset *ocs,
 996                 unsigned long action, struct device_node *np,
 997                 struct property *prop);
 998
 999 static inline int of_changeset_attach_node(struct of_changeset *ocs,
1000                 struct device_node *np)
1001 {
1002         return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
1003 }
1004
1005 static inline int of_changeset_detach_node(struct of_changeset *ocs,
1006                 struct device_node *np)
1007 {
1008         return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
1009 }
1010
1011 static inline int of_changeset_add_property(struct of_changeset *ocs,
1012                 struct device_node *np, struct property *prop)
1013 {
1014         return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
1015 }
1016
1017 static inline int of_changeset_remove_property(struct of_changeset *ocs,
1018                 struct device_node *np, struct property *prop)
1019 {
1020         return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
1021 }
1022
1023 static inline int of_changeset_update_property(struct of_changeset *ocs,
1024                 struct device_node *np, struct property *prop)
1025 {
1026         return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
1027 }
1028 #else /* CONFIG_OF_DYNAMIC */
1029 static inline int of_reconfig_notifier_register(struct notifier_block *nb)
1030 {
1031         return -EINVAL;
1032 }
1033 static inline int of_reconfig_notifier_unregister(struct notifier_block *nb)
1034 {
1035         return -EINVAL;
1036 }
1037 static inline int of_reconfig_notify(unsigned long action,
1038                                      struct of_reconfig_data *arg)
1039 {
1040         return -EINVAL;
1041 }
1042 static inline int of_reconfig_get_state_change(unsigned long action,
1043                                                 struct of_reconfig_data *arg)
1044 {
1045         return -EINVAL;
1046 }
1047 #endif /* CONFIG_OF_DYNAMIC */
1048
1049 /* CONFIG_OF_RESOLVE api */
1050 extern int of_resolve_phandles(struct device_node *tree);
1051
1052 /**
1053  * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
1054  * @np: Pointer to the given device_node
1055  *
1056  * return true if present false otherwise
1057  */
1058 static inline bool of_device_is_system_power_controller(const struct device_node *np)
1059 {
1060         return of_property_read_bool(np, "system-power-controller");
1061 }
1062
1063 /**
1064  * Overlay support
1065  */
1066
1067 #ifdef CONFIG_OF_OVERLAY
1068
1069 /* ID based overlays; the API for external users */
1070 int of_overlay_create(struct device_node *tree);
1071 int of_overlay_destroy(int id);
1072 int of_overlay_destroy_all(void);
1073
1074 #else
1075
1076 static inline int of_overlay_create(struct device_node *tree)
1077 {
1078         return -ENOTSUPP;
1079 }
1080
1081 static inline int of_overlay_destroy(int id)
1082 {
1083         return -ENOTSUPP;
1084 }
1085
1086 static inline int of_overlay_destroy_all(void)
1087 {
1088         return -ENOTSUPP;
1089 }
1090
1091 #endif
1092
1093 #endif /* _LINUX_OF_H */