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