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