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
  27 #include <asm/byteorder.h>
  28 #include <asm/errno.h>
  29
  30 typedef u32 phandle;
  31 typedef u32 ihandle;
  32
  33 struct property {
  34         char    *name;
  35         int     length;
  36         void    *value;
  37         struct property *next;
  38         unsigned long _flags;
  39         unsigned int unique_id;
  40         struct bin_attribute attr;
  41 };
  42
  43 #if defined(CONFIG_SPARC)
  44 struct of_irq_controller;
  45 #endif
  46
  47 struct device_node {
  48         const char *name;
  49         const char *type;
  50         phandle phandle;
  51         const char *full_name;
  52
  53         struct  property *properties;
  54         struct  property *deadprops;    /* removed properties */
  55         struct  device_node *parent;
  56         struct  device_node *child;
  57         struct  device_node *sibling;
  58         struct  device_node *next;      /* next device of same type */
  59         struct  device_node *allnext;   /* next in list of all nodes */
  60         struct  proc_dir_entry *pde;    /* this node's proc directory */
  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 extern int of_node_add(struct device_node *node);
  79
  80 #ifdef CONFIG_OF_DYNAMIC
  81 extern struct device_node *of_node_get(struct device_node *node);
  82 extern void of_node_put(struct device_node *node);
  83 #else /* CONFIG_OF_DYNAMIC */
  84 /* Dummy ref counting routines - to be implemented later */
  85 static inline struct device_node *of_node_get(struct device_node *node)
  86 {
  87         return node;
  88 }
  89 static inline void of_node_put(struct device_node *node) { }
  90 #endif /* !CONFIG_OF_DYNAMIC */
  91
  92 #ifdef CONFIG_OF
  93
  94 /* Pointer for first entry in chain of all nodes. */
  95 extern struct device_node *of_allnodes;
  96 extern struct device_node *of_chosen;
  97 extern struct device_node *of_aliases;
  98 extern raw_spinlock_t devtree_lock;
  99
 100 static inline bool of_have_populated_dt(void)
 101 {
 102         return of_allnodes != NULL;
 103 }
 104
 105 static inline bool of_node_is_root(const struct device_node *node)
 106 {
 107         return node && (node->parent == NULL);
 108 }
 109
 110 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
 111 {
 112         return test_bit(flag, &n->_flags);
 113 }
 114
 115 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
 116 {
 117         set_bit(flag, &n->_flags);
 118 }
 119
 120 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
 121 {
 122         clear_bit(flag, &n->_flags);
 123 }
 124
 125 static inline int of_property_check_flag(struct property *p, unsigned long flag)
 126 {
 127         return test_bit(flag, &p->_flags);
 128 }
 129
 130 static inline void of_property_set_flag(struct property *p, unsigned long flag)
 131 {
 132         set_bit(flag, &p->_flags);
 133 }
 134
 135 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
 136 {
 137         clear_bit(flag, &p->_flags);
 138 }
 139
 140 extern struct device_node *of_find_all_nodes(struct device_node *prev);
 141
 142 /*
 143  * OF address retrieval & translation
 144  */
 145
 146 /* Helper to read a big number; size is in cells (not bytes) */
 147 static inline u64 of_read_number(const __be32 *cell, int size)
 148 {
 149         u64 r = 0;
 150         while (size--)
 151                 r = (r << 32) | be32_to_cpu(*(cell++));
 152         return r;
 153 }
 154
 155 /* Like of_read_number, but we want an unsigned long result */
 156 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
 157 {
 158         /* toss away upper bits if unsigned long is smaller than u64 */
 159         return of_read_number(cell, size);
 160 }
 161
 162 #if defined(CONFIG_SPARC)
 163 #include <asm/prom.h>
 164 #endif
 165
 166 /* Default #address and #size cells.  Allow arch asm/prom.h to override */
 167 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
 168 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
 169 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
 170 #endif
 171
 172 /* Default string compare functions, Allow arch asm/prom.h to override */
 173 #if !defined(of_compat_cmp)
 174 #define of_compat_cmp(s1, s2, l)        strcasecmp((s1), (s2))
 175 #define of_prop_cmp(s1, s2)             strcmp((s1), (s2))
 176 #define of_node_cmp(s1, s2)             strcasecmp((s1), (s2))
 177 #endif
 178
 179 /* flag descriptions */
 180 #define OF_DYNAMIC      1 /* node and properties were allocated via kmalloc */
 181 #define OF_DETACHED     2 /* node has been detached from the device tree */
 182
 183 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
 184 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
 185
 186 #define OF_BAD_ADDR     ((u64)-1)
 187
 188 static inline const char *of_node_full_name(const struct device_node *np)
 189 {
 190         return np ? np->full_name : "<no-node>";
 191 }
 192
 193 #define for_each_of_allnodes(dn) \
 194         for (dn = of_allnodes; dn; dn = dn->allnext)
 195 extern struct device_node *of_find_node_by_name(struct device_node *from,
 196         const char *name);
 197 extern struct device_node *of_find_node_by_type(struct device_node *from,
 198         const char *type);
 199 extern struct device_node *of_find_compatible_node(struct device_node *from,
 200         const char *type, const char *compat);
 201 extern struct device_node *of_find_matching_node_and_match(
 202         struct device_node *from,
 203         const struct of_device_id *matches,
 204         const struct of_device_id **match);
 205
 206 extern struct device_node *of_find_node_by_path(const char *path);
 207 extern struct device_node *of_find_node_by_phandle(phandle handle);
 208 extern struct device_node *of_get_parent(const struct device_node *node);
 209 extern struct device_node *of_get_next_parent(struct device_node *node);
 210 extern struct device_node *of_get_next_child(const struct device_node *node,
 211                                              struct device_node *prev);
 212 extern struct device_node *of_get_next_available_child(
 213         const struct device_node *node, struct device_node *prev);
 214
 215 extern struct device_node *of_get_child_by_name(const struct device_node *node,
 216                                         const char *name);
 217
 218 /* cache lookup */
 219 extern struct device_node *of_find_next_cache_node(const struct device_node *);
 220 extern struct device_node *of_find_node_with_property(
 221         struct device_node *from, const char *prop_name);
 222
 223 extern struct property *of_find_property(const struct device_node *np,
 224                                          const char *name,
 225                                          int *lenp);
 226 extern int of_property_read_u32_index(const struct device_node *np,
 227                                        const char *propname,
 228                                        u32 index, u32 *out_value);
 229 extern int of_property_read_u8_array(const struct device_node *np,
 230                         const char *propname, u8 *out_values, size_t sz);
 231 extern int of_property_read_u16_array(const struct device_node *np,
 232                         const char *propname, u16 *out_values, size_t sz);
 233 extern int of_property_read_u32_array(const struct device_node *np,
 234                                       const char *propname,
 235                                       u32 *out_values,
 236                                       size_t sz);
 237 extern int of_property_read_u64(const struct device_node *np,
 238                                 const char *propname, u64 *out_value);
 239
 240 extern int of_property_read_string(struct device_node *np,
 241                                    const char *propname,
 242                                    const char **out_string);
 243 extern int of_property_read_string_index(struct device_node *np,
 244                                          const char *propname,
 245                                          int index, const char **output);
 246 extern int of_property_match_string(struct device_node *np,
 247                                     const char *propname,
 248                                     const char *string);
 249 extern int of_property_count_strings(struct device_node *np,
 250                                      const char *propname);
 251 extern int of_device_is_compatible(const struct device_node *device,
 252                                    const char *);
 253 extern int of_device_is_available(const struct device_node *device);
 254 extern const void *of_get_property(const struct device_node *node,
 255                                 const char *name,
 256                                 int *lenp);
 257 extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
 258 #define for_each_property_of_node(dn, pp) \
 259         for (pp = dn->properties; pp != NULL; pp = pp->next)
 260
 261 extern int of_n_addr_cells(struct device_node *np);
 262 extern int of_n_size_cells(struct device_node *np);
 263 extern const struct of_device_id *of_match_node(
 264         const struct of_device_id *matches, const struct device_node *node);
 265 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
 266 extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
 267 extern struct device_node *of_parse_phandle(const struct device_node *np,
 268                                             const char *phandle_name,
 269                                             int index);
 270 extern int of_parse_phandle_with_args(const struct device_node *np,
 271         const char *list_name, const char *cells_name, int index,
 272         struct of_phandle_args *out_args);
 273 extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
 274         const char *list_name, int cells_count, int index,
 275         struct of_phandle_args *out_args);
 276 extern int of_count_phandle_with_args(const struct device_node *np,
 277         const char *list_name, const char *cells_name);
 278
 279 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
 280 extern int of_alias_get_id(struct device_node *np, const char *stem);
 281
 282 extern int of_machine_is_compatible(const char *compat);
 283
 284 extern int of_add_property(struct device_node *np, struct property *prop);
 285 extern int of_remove_property(struct device_node *np, struct property *prop);
 286 extern int of_update_property(struct device_node *np, struct property *newprop);
 287
 288 /* For updating the device tree at runtime */
 289 #define OF_RECONFIG_ATTACH_NODE         0x0001
 290 #define OF_RECONFIG_DETACH_NODE         0x0002
 291 #define OF_RECONFIG_ADD_PROPERTY        0x0003
 292 #define OF_RECONFIG_REMOVE_PROPERTY     0x0004
 293 #define OF_RECONFIG_UPDATE_PROPERTY     0x0005
 294
 295 struct of_prop_reconfig {
 296         struct device_node      *dn;
 297         struct property         *prop;
 298 };
 299
 300 extern int of_reconfig_notifier_register(struct notifier_block *);
 301 extern int of_reconfig_notifier_unregister(struct notifier_block *);
 302 extern int of_reconfig_notify(unsigned long, void *);
 303
 304 extern int of_attach_node(struct device_node *);
 305 extern int of_detach_node(struct device_node *);
 306
 307 #define of_match_ptr(_ptr)      (_ptr)
 308
 309 /*
 310  * struct property *prop;
 311  * const __be32 *p;
 312  * u32 u;
 313  *
 314  * of_property_for_each_u32(np, "propname", prop, p, u)
 315  *         printk("U32 value: %x\n", u);
 316  */
 317 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
 318                                u32 *pu);
 319 /*
 320  * struct property *prop;
 321  * const char *s;
 322  *
 323  * of_property_for_each_string(np, "propname", prop, s)
 324  *         printk("String value: %s\n", s);
 325  */
 326 const char *of_prop_next_string(struct property *prop, const char *cur);
 327
 328 int of_device_is_stdout_path(struct device_node *dn);
 329
 330 #else /* CONFIG_OF */
 331
 332 static inline const char* of_node_full_name(struct device_node *np)
 333 {
 334         return "<no-node>";
 335 }
 336
 337 static inline struct device_node *of_find_node_by_name(struct device_node *from,
 338         const char *name)
 339 {
 340         return NULL;
 341 }
 342
 343 static inline struct device_node *of_find_node_by_type(struct device_node *from,
 344         const char *type)
 345 {
 346         return NULL;
 347 }
 348
 349 static inline struct device_node *of_find_matching_node_and_match(
 350         struct device_node *from,
 351         const struct of_device_id *matches,
 352         const struct of_device_id **match)
 353 {
 354         return NULL;
 355 }
 356
 357 static inline struct device_node *of_get_parent(const struct device_node *node)
 358 {
 359         return NULL;
 360 }
 361
 362 static inline struct device_node *of_get_next_child(
 363         const struct device_node *node, struct device_node *prev)
 364 {
 365         return NULL;
 366 }
 367
 368 static inline struct device_node *of_get_next_available_child(
 369         const struct device_node *node, struct device_node *prev)
 370 {
 371         return NULL;
 372 }
 373
 374 static inline struct device_node *of_find_node_with_property(
 375         struct device_node *from, const char *prop_name)
 376 {
 377         return NULL;
 378 }
 379
 380 static inline bool of_have_populated_dt(void)
 381 {
 382         return false;
 383 }
 384
 385 static inline struct device_node *of_get_child_by_name(
 386                                         const struct device_node *node,
 387                                         const char *name)
 388 {
 389         return NULL;
 390 }
 391
 392 static inline int of_device_is_compatible(const struct device_node *device,
 393                                           const char *name)
 394 {
 395         return 0;
 396 }
 397
 398 static inline int of_device_is_available(const struct device_node *device)
 399 {
 400         return 0;
 401 }
 402
 403 static inline struct property *of_find_property(const struct device_node *np,
 404                                                 const char *name,
 405                                                 int *lenp)
 406 {
 407         return NULL;
 408 }
 409
 410 static inline struct device_node *of_find_compatible_node(
 411                                                 struct device_node *from,
 412                                                 const char *type,
 413                                                 const char *compat)
 414 {
 415         return NULL;
 416 }
 417
 418 static inline int of_property_read_u32_index(const struct device_node *np,
 419                         const char *propname, u32 index, u32 *out_value)
 420 {
 421         return -ENOSYS;
 422 }
 423
 424 static inline int of_property_read_u8_array(const struct device_node *np,
 425                         const char *propname, u8 *out_values, size_t sz)
 426 {
 427         return -ENOSYS;
 428 }
 429
 430 static inline int of_property_read_u16_array(const struct device_node *np,
 431                         const char *propname, u16 *out_values, size_t sz)
 432 {
 433         return -ENOSYS;
 434 }
 435
 436 static inline int of_property_read_u32_array(const struct device_node *np,
 437                                              const char *propname,
 438                                              u32 *out_values, size_t sz)
 439 {
 440         return -ENOSYS;
 441 }
 442
 443 static inline int of_property_read_string(struct device_node *np,
 444                                           const char *propname,
 445                                           const char **out_string)
 446 {
 447         return -ENOSYS;
 448 }
 449
 450 static inline int of_property_read_string_index(struct device_node *np,
 451                                                 const char *propname, int index,
 452                                                 const char **out_string)
 453 {
 454         return -ENOSYS;
 455 }
 456
 457 static inline int of_property_count_strings(struct device_node *np,
 458                                             const char *propname)
 459 {
 460         return -ENOSYS;
 461 }
 462
 463 static inline const void *of_get_property(const struct device_node *node,
 464                                 const char *name,
 465                                 int *lenp)
 466 {
 467         return NULL;
 468 }
 469
 470 static inline struct device_node *of_get_cpu_node(int cpu,
 471                                         unsigned int *thread)
 472 {
 473         return NULL;
 474 }
 475
 476 static inline int of_property_read_u64(const struct device_node *np,
 477                                        const char *propname, u64 *out_value)
 478 {
 479         return -ENOSYS;
 480 }
 481
 482 static inline int of_property_match_string(struct device_node *np,
 483                                            const char *propname,
 484                                            const char *string)
 485 {
 486         return -ENOSYS;
 487 }
 488
 489 static inline struct device_node *of_parse_phandle(const struct device_node *np,
 490                                                    const char *phandle_name,
 491                                                    int index)
 492 {
 493         return NULL;
 494 }
 495
 496 static inline int of_parse_phandle_with_args(struct device_node *np,
 497                                              const char *list_name,
 498                                              const char *cells_name,
 499                                              int index,
 500                                              struct of_phandle_args *out_args)
 501 {
 502         return -ENOSYS;
 503 }
 504
 505 static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
 506         const char *list_name, int cells_count, int index,
 507         struct of_phandle_args *out_args)
 508 {
 509         return -ENOSYS;
 510 }
 511
 512 static inline int of_count_phandle_with_args(struct device_node *np,
 513                                              const char *list_name,
 514                                              const char *cells_name)
 515 {
 516         return -ENOSYS;
 517 }
 518
 519 static inline int of_alias_get_id(struct device_node *np, const char *stem)
 520 {
 521         return -ENOSYS;
 522 }
 523
 524 static inline int of_machine_is_compatible(const char *compat)
 525 {
 526         return 0;
 527 }
 528
 529 static inline int of_device_is_stdout_path(struct device_node *dn)
 530 {
 531         return 0;
 532 }
 533
 534 static inline const __be32 *of_prop_next_u32(struct property *prop,
 535                 const __be32 *cur, u32 *pu)
 536 {
 537         return NULL;
 538 }
 539
 540 static inline const char *of_prop_next_string(struct property *prop,
 541                 const char *cur)
 542 {
 543         return NULL;
 544 }
 545
 546 #define of_match_ptr(_ptr)      NULL
 547 #define of_match_node(_matches, _node)  NULL
 548 #endif /* CONFIG_OF */
 549
 550 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
 551 extern int of_node_to_nid(struct device_node *np);
 552 #else
 553 static inline int of_node_to_nid(struct device_node *device) { return 0; }
 554 #endif
 555
 556 static inline struct device_node *of_find_matching_node(
 557         struct device_node *from,
 558         const struct of_device_id *matches)
 559 {
 560         return of_find_matching_node_and_match(from, matches, NULL);
 561 }
 562
 563 /**
 564  * of_property_read_bool - Findfrom a property
 565  * @np:         device node from which the property value is to be read.
 566  * @propname:   name of the property to be searched.
 567  *
 568  * Search for a property in a device node.
 569  * Returns true if the property exist false otherwise.
 570  */
 571 static inline bool of_property_read_bool(const struct device_node *np,
 572                                          const char *propname)
 573 {
 574         struct property *prop = of_find_property(np, propname, NULL);
 575
 576         return prop ? true : false;
 577 }
 578
 579 static inline int of_property_read_u8(const struct device_node *np,
 580                                        const char *propname,
 581                                        u8 *out_value)
 582 {
 583         return of_property_read_u8_array(np, propname, out_value, 1);
 584 }
 585
 586 static inline int of_property_read_u16(const struct device_node *np,
 587                                        const char *propname,
 588                                        u16 *out_value)
 589 {
 590         return of_property_read_u16_array(np, propname, out_value, 1);
 591 }
 592
 593 static inline int of_property_read_u32(const struct device_node *np,
 594                                        const char *propname,
 595                                        u32 *out_value)
 596 {
 597         return of_property_read_u32_array(np, propname, out_value, 1);
 598 }
 599
 600 #define of_property_for_each_u32(np, propname, prop, p, u)      \
 601         for (prop = of_find_property(np, propname, NULL),       \
 602                 p = of_prop_next_u32(prop, NULL, &u);           \
 603                 p;                                              \
 604                 p = of_prop_next_u32(prop, p, &u))
 605
 606 #define of_property_for_each_string(np, propname, prop, s)      \
 607         for (prop = of_find_property(np, propname, NULL),       \
 608                 s = of_prop_next_string(prop, NULL);            \
 609                 s;                                              \
 610                 s = of_prop_next_string(prop, s))
 611
 612 #define for_each_node_by_name(dn, name) \
 613         for (dn = of_find_node_by_name(NULL, name); dn; \
 614              dn = of_find_node_by_name(dn, name))
 615 #define for_each_node_by_type(dn, type) \
 616         for (dn = of_find_node_by_type(NULL, type); dn; \
 617              dn = of_find_node_by_type(dn, type))
 618 #define for_each_compatible_node(dn, type, compatible) \
 619         for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
 620              dn = of_find_compatible_node(dn, type, compatible))
 621 #define for_each_matching_node(dn, matches) \
 622         for (dn = of_find_matching_node(NULL, matches); dn; \
 623              dn = of_find_matching_node(dn, matches))
 624 #define for_each_matching_node_and_match(dn, matches, match) \
 625         for (dn = of_find_matching_node_and_match(NULL, matches, match); \
 626              dn; dn = of_find_matching_node_and_match(dn, matches, match))
 627
 628 #define for_each_child_of_node(parent, child) \
 629         for (child = of_get_next_child(parent, NULL); child != NULL; \
 630              child = of_get_next_child(parent, child))
 631 #define for_each_available_child_of_node(parent, child) \
 632         for (child = of_get_next_available_child(parent, NULL); child != NULL; \
 633              child = of_get_next_available_child(parent, child))
 634
 635 #define for_each_node_with_property(dn, prop_name) \
 636         for (dn = of_find_node_with_property(NULL, prop_name); dn; \
 637              dn = of_find_node_with_property(dn, prop_name))
 638
 639 static inline int of_get_child_count(const struct device_node *np)
 640 {
 641         struct device_node *child;
 642         int num = 0;
 643
 644         for_each_child_of_node(np, child)
 645                 num++;
 646
 647         return num;
 648 }
 649
 650 static inline int of_get_available_child_count(const struct device_node *np)
 651 {
 652         struct device_node *child;
 653         int num = 0;
 654
 655         for_each_available_child_of_node(np, child)
 656                 num++;
 657
 658         return num;
 659 }
 660
 661 #if defined(CONFIG_PROC_FS) && defined(CONFIG_PROC_DEVICETREE)
 662 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
 663 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
 664 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
 665                                          struct property *prop);
 666 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
 667                                          struct property *newprop,
 668                                          struct property *oldprop);
 669 #endif
 670
 671 #endif /* _LINUX_OF_H */