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