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 #include <asm/prom.h>
 140
 141 /* Default #address and #size cells.  Allow arch asm/prom.h to override */
 142 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
 143 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
 144 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
 145 #endif
 146
 147 /* Default string compare functions, Allow arch asm/prom.h to override */
 148 #if !defined(of_compat_cmp)
 149 #define of_compat_cmp(s1, s2, l)        strcasecmp((s1), (s2))
 150 #define of_prop_cmp(s1, s2)             strcmp((s1), (s2))
 151 #define of_node_cmp(s1, s2)             strcasecmp((s1), (s2))
 152 #endif
 153
 154 /* flag descriptions */
 155 #define OF_DYNAMIC      1 /* node and properties were allocated via kmalloc */
 156 #define OF_DETACHED     2 /* node has been detached from the device tree */
 157
 158 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
 159 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
 160
 161 #define OF_BAD_ADDR     ((u64)-1)
 162
 163 static inline const char *of_node_full_name(const struct device_node *np)
 164 {
 165         return np ? np->full_name : "<no-node>";
 166 }
 167
 168 extern struct device_node *of_find_node_by_name(struct device_node *from,
 169         const char *name);
 170 #define for_each_node_by_name(dn, name) \
 171         for (dn = of_find_node_by_name(NULL, name); dn; \
 172              dn = of_find_node_by_name(dn, name))
 173 extern struct device_node *of_find_node_by_type(struct device_node *from,
 174         const char *type);
 175 #define for_each_node_by_type(dn, type) \
 176         for (dn = of_find_node_by_type(NULL, type); dn; \
 177              dn = of_find_node_by_type(dn, type))
 178 extern struct device_node *of_find_compatible_node(struct device_node *from,
 179         const char *type, const char *compat);
 180 #define for_each_compatible_node(dn, type, compatible) \
 181         for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
 182              dn = of_find_compatible_node(dn, type, compatible))
 183 extern struct device_node *of_find_matching_node_and_match(
 184         struct device_node *from,
 185         const struct of_device_id *matches,
 186         const struct of_device_id **match);
 187 static inline struct device_node *of_find_matching_node(
 188         struct device_node *from,
 189         const struct of_device_id *matches)
 190 {
 191         return of_find_matching_node_and_match(from, matches, NULL);
 192 }
 193 #define for_each_matching_node(dn, matches) \
 194         for (dn = of_find_matching_node(NULL, matches); dn; \
 195              dn = of_find_matching_node(dn, matches))
 196 #define for_each_matching_node_and_match(dn, matches, match) \
 197         for (dn = of_find_matching_node_and_match(NULL, matches, match); \
 198              dn; dn = of_find_matching_node_and_match(dn, matches, match))
 199 extern struct device_node *of_find_node_by_path(const char *path);
 200 extern struct device_node *of_find_node_by_phandle(phandle handle);
 201 extern struct device_node *of_get_parent(const struct device_node *node);
 202 extern struct device_node *of_get_next_parent(struct device_node *node);
 203 extern struct device_node *of_get_next_child(const struct device_node *node,
 204                                              struct device_node *prev);
 205 extern struct device_node *of_get_next_available_child(
 206         const struct device_node *node, struct device_node *prev);
 207
 208 extern struct device_node *of_get_child_by_name(const struct device_node *node,
 209                                         const char *name);
 210 #define for_each_child_of_node(parent, child) \
 211         for (child = of_get_next_child(parent, NULL); child != NULL; \
 212              child = of_get_next_child(parent, child))
 213
 214 #define for_each_available_child_of_node(parent, child) \
 215         for (child = of_get_next_available_child(parent, NULL); child != NULL; \
 216              child = of_get_next_available_child(parent, child))
 217
 218 static inline int of_get_child_count(const struct device_node *np)
 219 {
 220         struct device_node *child;
 221         int num = 0;
 222
 223         for_each_child_of_node(np, child)
 224                 num++;
 225
 226         return num;
 227 }
 228
 229 extern struct device_node *of_find_node_with_property(
 230         struct device_node *from, const char *prop_name);
 231 #define for_each_node_with_property(dn, prop_name) \
 232         for (dn = of_find_node_with_property(NULL, prop_name); dn; \
 233              dn = of_find_node_with_property(dn, prop_name))
 234
 235 extern struct property *of_find_property(const struct device_node *np,
 236                                          const char *name,
 237                                          int *lenp);
 238 extern int of_property_read_u32_index(const struct device_node *np,
 239                                        const char *propname,
 240                                        u32 index, u32 *out_value);
 241
 242 extern int of_property_read_u8_array_tp(const struct device_node *np,
 243                         const char *propname, u8 *out_values, size_t sz);
 244
 245 extern int of_property_read_u8_array(const struct device_node *np,
 246                         const char *propname, u8 *out_values, size_t sz);
 247 extern int of_property_read_u16_array(const struct device_node *np,
 248                         const char *propname, u16 *out_values, size_t sz);
 249 extern int of_property_read_u32_array(const struct device_node *np,
 250                                       const char *propname,
 251                                       u32 *out_values,
 252                                       size_t sz);
 253 extern int of_property_read_u64(const struct device_node *np,
 254                                 const char *propname, u64 *out_value);
 255
 256 extern int of_property_read_string(struct device_node *np,
 257                                    const char *propname,
 258                                    const char **out_string);
 259 extern int of_property_match_string(struct device_node *np,
 260                                     const char *propname,
 261                                     const char *string);
 262 extern int of_property_read_string_helper(struct device_node *np,
 263                                               const char *propname,
 264                                               const char **out_strs, size_t sz, int index);
 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_count_phandle_with_args(const struct device_node *np,
 287         const char *list_name, const char *cells_name);
 288
 289 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
 290 extern int of_alias_get_id(struct device_node *np, const char *stem);
 291
 292 extern int of_machine_is_compatible(const char *compat);
 293
 294 extern int of_add_property(struct device_node *np, struct property *prop);
 295 extern int of_remove_property(struct device_node *np, struct property *prop);
 296 extern int of_update_property(struct device_node *np, struct property *newprop);
 297
 298 /* For updating the device tree at runtime */
 299 #define OF_RECONFIG_ATTACH_NODE         0x0001
 300 #define OF_RECONFIG_DETACH_NODE         0x0002
 301 #define OF_RECONFIG_ADD_PROPERTY        0x0003
 302 #define OF_RECONFIG_REMOVE_PROPERTY     0x0004
 303 #define OF_RECONFIG_UPDATE_PROPERTY     0x0005
 304
 305 struct of_prop_reconfig {
 306         struct device_node      *dn;
 307         struct property         *prop;
 308 };
 309
 310 extern int of_reconfig_notifier_register(struct notifier_block *);
 311 extern int of_reconfig_notifier_unregister(struct notifier_block *);
 312 extern int of_reconfig_notify(unsigned long, void *);
 313
 314 extern int of_attach_node(struct device_node *);
 315 extern int of_detach_node(struct device_node *);
 316
 317 #define of_match_ptr(_ptr)      (_ptr)
 318
 319 /*
 320  * struct property *prop;
 321  * const __be32 *p;
 322  * u32 u;
 323  *
 324  * of_property_for_each_u32(np, "propname", prop, p, u)
 325  *         printk("U32 value: %x\n", u);
 326  */
 327 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
 328                                u32 *pu);
 329 #define of_property_for_each_u32(np, propname, prop, p, u)      \
 330         for (prop = of_find_property(np, propname, NULL),       \
 331                 p = of_prop_next_u32(prop, NULL, &u);           \
 332                 p;                                              \
 333                 p = of_prop_next_u32(prop, p, &u))
 334
 335 /*
 336  * struct property *prop;
 337  * const char *s;
 338  *
 339  * of_property_for_each_string(np, "propname", prop, s)
 340  *         printk("String value: %s\n", s);
 341  */
 342 const char *of_prop_next_string(struct property *prop, const char *cur);
 343 #define of_property_for_each_string(np, propname, prop, s)      \
 344         for (prop = of_find_property(np, propname, NULL),       \
 345                 s = of_prop_next_string(prop, NULL);            \
 346                 s;                                              \
 347                 s = of_prop_next_string(prop, s))
 348
 349 int of_device_is_stdout_path(struct device_node *dn);
 350
 351 #else /* CONFIG_OF */
 352
 353 static inline const char* of_node_full_name(struct device_node *np)
 354 {
 355         return "<no-node>";
 356 }
 357
 358 static inline struct device_node *of_find_node_by_name(struct device_node *from,
 359         const char *name)
 360 {
 361         return NULL;
 362 }
 363
 364 static inline struct device_node *of_get_parent(const struct device_node *node)
 365 {
 366         return NULL;
 367 }
 368
 369 static inline bool of_have_populated_dt(void)
 370 {
 371         return false;
 372 }
 373
 374 #define for_each_child_of_node(parent, child) \
 375         while (0)
 376
 377 static inline struct device_node *of_get_child_by_name(
 378                                         const struct device_node *node,
 379                                         const char *name)
 380 {
 381         return NULL;
 382 }
 383
 384 static inline int of_get_child_count(const struct device_node *np)
 385 {
 386         return 0;
 387 }
 388
 389 static inline int of_device_is_compatible(const struct device_node *device,
 390                                           const char *name)
 391 {
 392         return 0;
 393 }
 394
 395 static inline int of_device_is_available(const struct device_node *device)
 396 {
 397         return 0;
 398 }
 399
 400 static inline struct property *of_find_property(const struct device_node *np,
 401                                                 const char *name,
 402                                                 int *lenp)
 403 {
 404         return NULL;
 405 }
 406
 407 static inline struct device_node *of_find_compatible_node(
 408                                                 struct device_node *from,
 409                                                 const char *type,
 410                                                 const char *compat)
 411 {
 412         return NULL;
 413 }
 414
 415
 416 static inline int of_property_read_u32_index(const struct device_node *np,
 417                         const char *propname, u32 index, u32 *out_value)
 418 {
 419         return -ENOSYS;
 420 }
 421
 422 static inline int of_property_read_u8_array_tp(const struct device_node *np,
 423                         const char *propname, u8 *out_values, size_t sz)
 424 {
 425         return -ENOSYS;
 426 }
 427
 428
 429
 430 static inline int of_property_read_u8_array(const struct device_node *np,
 431                         const char *propname, u8 *out_values, size_t sz)
 432 {
 433         return -ENOSYS;
 434 }
 435
 436 static inline int of_property_read_u16_array(const struct device_node *np,
 437                         const char *propname, u16 *out_values, size_t sz)
 438 {
 439         return -ENOSYS;
 440 }
 441
 442 static inline int of_property_read_u32_array(const struct device_node *np,
 443                                              const char *propname,
 444                                              u32 *out_values, size_t sz)
 445 {
 446         return -ENOSYS;
 447 }
 448
 449 static inline int of_property_read_string(struct device_node *np,
 450                                           const char *propname,
 451                                           const char **out_string)
 452 {
 453         return -ENOSYS;
 454 }
 455
 456 static inline int of_property_read_string_helper(struct device_node *np,
 457                                                  const char *propname,
 458                                                  const char **out_strs, size_t sz, int index)
 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_count_phandle_with_args(struct device_node *np,
 506                                              const char *list_name,
 507                                              const char *cells_name)
 508 {
 509         return -ENOSYS;
 510 }
 511
 512 static inline int of_alias_get_id(struct device_node *np, const char *stem)
 513 {
 514         return -ENOSYS;
 515 }
 516
 517 static inline int of_machine_is_compatible(const char *compat)
 518 {
 519         return 0;
 520 }
 521
 522 static inline int of_device_is_stdout_path(struct device_node *dn)
 523 {
 524         return 0;
 525 }
 526
 527 #define of_match_ptr(_ptr)      NULL
 528 #define of_match_node(_matches, _node)  NULL
 529 #define of_property_for_each_u32(np, propname, prop, p, u) \
 530         while (0)
 531 #define of_property_for_each_string(np, propname, prop, s) \
 532         while (0)
 533 #endif /* CONFIG_OF */
 534
 535 #ifndef of_node_to_nid
 536 static inline int of_node_to_nid(struct device_node *np)
 537 {
 538         return numa_node_id();
 539 }
 540
 541 #define of_node_to_nid of_node_to_nid
 542 #endif
 543
 544 /**
 545  * of_property_read_string_array() - Read an array of strings from a multiple
 546  * strings property.
 547  * @np:         device node from which the property value is to be read.
 548  * @propname:   name of the property to be searched.
 549  * @out_strs:   output array of string pointers.
 550  * @sz:         number of array elements to read.
 551  *
 552  * Search for a property in a device tree node and retrieve a list of
 553  * terminated string values (pointer to data, not a copy) in that property.
 554  *
 555  * If @out_strs is NULL, the number of strings in the property is returned.
 556  */
 557 static inline int of_property_read_string_array(struct device_node *np,
 558                                                 const char *propname, const char **out_strs,
 559                                                 size_t sz)
 560 {
 561         return of_property_read_string_helper(np, propname, out_strs, sz, 0);
 562 }
 563
 564 /**
 565  * of_property_count_strings() - Find and return the number of strings from a
 566  * multiple strings property.
 567  * @np:         device node from which the property value is to be read.
 568  * @propname:   name of the property to be searched.
 569  *
 570  * Search for a property in a device tree node and retrieve the number of null
 571  * terminated string contain in it. Returns the number of strings on
 572  * success, -EINVAL if the property does not exist, -ENODATA if property
 573  * does not have a value, and -EILSEQ if the string is not null-terminated
 574  * within the length of the property data.
 575  */
 576 static inline int of_property_count_strings(struct device_node *np,
 577                                             const char *propname)
 578 {
 579         return of_property_read_string_helper(np, propname, NULL, 0, 0);
 580 }
 581
 582 /**
 583  * of_property_read_string_index() - Find and read a string from a multiple
 584  * strings property.
 585  * @np:         device node from which the property value is to be read.
 586  * @propname:   name of the property to be searched.
 587  * @index:      index of the string in the list of strings
 588  * @out_string: pointer to null terminated return string, modified only if
 589  *              return value is 0.
 590  *
 591  * Search for a property in a device tree node and retrieve a null
 592  * terminated string value (pointer to data, not a copy) in the list of strings
 593  * contained in that property.
 594  * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
 595  * property does not have a value, and -EILSEQ if the string is not
 596  * null-terminated within the length of the property data.
 597  *
 598  * The out_string pointer is modified only if a valid string can be decoded.
 599  */
 600 static inline int of_property_read_string_index(struct device_node *np,
 601                                                 const char *propname,
 602                                                 int index, const char **output)
 603 {
 604         int rc = of_property_read_string_helper(np, propname, output, 1, index);
 605         return rc < 0 ? rc : 0;
 606 }
 607
 608 /**
 609  * of_property_read_bool - Findfrom a property
 610  * @np:         device node from which the property value is to be read.
 611  * @propname:   name of the property to be searched.
 612  *
 613  * Search for a property in a device node.
 614  * Returns true if the property exist false otherwise.
 615  */
 616 static inline bool of_property_read_bool(const struct device_node *np,
 617                                          const char *propname)
 618 {
 619         struct property *prop = of_find_property(np, propname, NULL);
 620
 621         return prop ? true : false;
 622 }
 623
 624 static inline int of_property_read_u8(const struct device_node *np,
 625                                        const char *propname,
 626                                        u8 *out_value)
 627 {
 628         return of_property_read_u8_array(np, propname, out_value, 1);
 629 }
 630
 631 static inline int of_property_read_u16(const struct device_node *np,
 632                                        const char *propname,
 633                                        u16 *out_value)
 634 {
 635         return of_property_read_u16_array(np, propname, out_value, 1);
 636 }
 637
 638 static inline int of_property_read_u32(const struct device_node *np,
 639                                        const char *propname,
 640                                        u32 *out_value)
 641 {
 642         return of_property_read_u32_array(np, propname, out_value, 1);
 643 }
 644
 645 #if defined(CONFIG_PROC_FS) && defined(CONFIG_PROC_DEVICETREE)
 646 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
 647 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
 648 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
 649                                          struct property *prop);
 650 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
 651                                          struct property *newprop,
 652                                          struct property *oldprop);
 653 #endif
 654
 655 #endif /* _LINUX_OF_H */