include/linux/of.h

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