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