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