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