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