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