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