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 extern int of_property_read_u8_array(const struct device_node *np,
 242                         const char *propname, u8 *out_values, size_t sz);
 243 extern int of_property_read_u16_array(const struct device_node *np,
 244                         const char *propname, u16 *out_values, size_t sz);
 245 extern int of_property_read_u32_array(const struct device_node *np,
 246                                       const char *propname,
 247                                       u32 *out_values,
 248                                       size_t sz);
 249 extern int of_property_read_u64(const struct device_node *np,
 250                                 const char *propname, u64 *out_value);
 251
 252 extern int of_property_read_string(struct device_node *np,
 253                                    const char *propname,
 254                                    const char **out_string);
 255 extern int of_property_match_string(struct device_node *np,
 256                                     const char *propname,
 257                                     const char *string);
 258 extern int of_property_read_string_helper(struct device_node *np,
 259                                               const char *propname,
 260                                               const char **out_strs, size_t sz, int index);
 261 extern int of_device_is_compatible(const struct device_node *device,
 262                                    const char *);
 263 extern int of_device_is_available(const struct device_node *device);
 264 extern const void *of_get_property(const struct device_node *node,
 265                                 const char *name,
 266                                 int *lenp);
 267 #define for_each_property_of_node(dn, pp) \
 268         for (pp = dn->properties; pp != NULL; pp = pp->next)
 269
 270 extern int of_n_addr_cells(struct device_node *np);
 271 extern int of_n_size_cells(struct device_node *np);
 272 extern const struct of_device_id *of_match_node(
 273         const struct of_device_id *matches, const struct device_node *node);
 274 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
 275 extern struct device_node *of_parse_phandle(const struct device_node *np,
 276                                             const char *phandle_name,
 277                                             int index);
 278 extern int of_parse_phandle_with_args(const struct device_node *np,
 279         const char *list_name, const char *cells_name, int index,
 280         struct of_phandle_args *out_args);
 281 extern int of_count_phandle_with_args(const struct device_node *np,
 282         const char *list_name, const char *cells_name);
 283
 284 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
 285 extern int of_alias_get_id(struct device_node *np, const char *stem);
 286
 287 extern int of_machine_is_compatible(const char *compat);
 288
 289 extern int of_add_property(struct device_node *np, struct property *prop);
 290 extern int of_remove_property(struct device_node *np, struct property *prop);
 291 extern int of_update_property(struct device_node *np, struct property *newprop);
 292
 293 /* For updating the device tree at runtime */
 294 #define OF_RECONFIG_ATTACH_NODE         0x0001
 295 #define OF_RECONFIG_DETACH_NODE         0x0002
 296 #define OF_RECONFIG_ADD_PROPERTY        0x0003
 297 #define OF_RECONFIG_REMOVE_PROPERTY     0x0004
 298 #define OF_RECONFIG_UPDATE_PROPERTY     0x0005
 299
 300 struct of_prop_reconfig {
 301         struct device_node      *dn;
 302         struct property         *prop;
 303 };
 304
 305 extern int of_reconfig_notifier_register(struct notifier_block *);
 306 extern int of_reconfig_notifier_unregister(struct notifier_block *);
 307 extern int of_reconfig_notify(unsigned long, void *);
 308
 309 extern int of_attach_node(struct device_node *);
 310 extern int of_detach_node(struct device_node *);
 311
 312 #define of_match_ptr(_ptr)      (_ptr)
 313
 314 /*
 315  * struct property *prop;
 316  * const __be32 *p;
 317  * u32 u;
 318  *
 319  * of_property_for_each_u32(np, "propname", prop, p, u)
 320  *         printk("U32 value: %x\n", u);
 321  */
 322 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
 323                                u32 *pu);
 324 #define of_property_for_each_u32(np, propname, prop, p, u)      \
 325         for (prop = of_find_property(np, propname, NULL),       \
 326                 p = of_prop_next_u32(prop, NULL, &u);           \
 327                 p;                                              \
 328                 p = of_prop_next_u32(prop, p, &u))
 329
 330 /*
 331  * struct property *prop;
 332  * const char *s;
 333  *
 334  * of_property_for_each_string(np, "propname", prop, s)
 335  *         printk("String value: %s\n", s);
 336  */
 337 const char *of_prop_next_string(struct property *prop, const char *cur);
 338 #define of_property_for_each_string(np, propname, prop, s)      \
 339         for (prop = of_find_property(np, propname, NULL),       \
 340                 s = of_prop_next_string(prop, NULL);            \
 341                 s;                                              \
 342                 s = of_prop_next_string(prop, s))
 343
 344 #else /* CONFIG_OF */
 345
 346 static inline const char* of_node_full_name(struct device_node *np)
 347 {
 348         return "<no-node>";
 349 }
 350
 351 static inline struct device_node *of_find_node_by_name(struct device_node *from,
 352         const char *name)
 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 bool of_have_populated_dt(void)
 363 {
 364         return false;
 365 }
 366
 367 #define for_each_child_of_node(parent, child) \
 368         while (0)
 369
 370 static inline struct device_node *of_get_child_by_name(
 371                                         const struct device_node *node,
 372                                         const char *name)
 373 {
 374         return NULL;
 375 }
 376
 377 static inline int of_get_child_count(const struct device_node *np)
 378 {
 379         return 0;
 380 }
 381
 382 static inline int of_device_is_compatible(const struct device_node *device,
 383                                           const char *name)
 384 {
 385         return 0;
 386 }
 387
 388 static inline int of_device_is_available(const struct device_node *device)
 389 {
 390         return 0;
 391 }
 392
 393 static inline struct property *of_find_property(const struct device_node *np,
 394                                                 const char *name,
 395                                                 int *lenp)
 396 {
 397         return NULL;
 398 }
 399
 400 static inline struct device_node *of_find_compatible_node(
 401                                                 struct device_node *from,
 402                                                 const char *type,
 403                                                 const char *compat)
 404 {
 405         return NULL;
 406 }
 407
 408 static inline int of_property_read_u32_index(const struct device_node *np,
 409                         const char *propname, u32 index, u32 *out_value)
 410 {
 411         return -ENOSYS;
 412 }
 413
 414 static inline int of_property_read_u8_array(const struct device_node *np,
 415                         const char *propname, u8 *out_values, size_t sz)
 416 {
 417         return -ENOSYS;
 418 }
 419
 420 static inline int of_property_read_u16_array(const struct device_node *np,
 421                         const char *propname, u16 *out_values, size_t sz)
 422 {
 423         return -ENOSYS;
 424 }
 425
 426 static inline int of_property_read_u32_array(const struct device_node *np,
 427                                              const char *propname,
 428                                              u32 *out_values, size_t sz)
 429 {
 430         return -ENOSYS;
 431 }
 432
 433 static inline int of_property_read_string(struct device_node *np,
 434                                           const char *propname,
 435                                           const char **out_string)
 436 {
 437         return -ENOSYS;
 438 }
 439
 440 static inline int of_property_read_string_helper(struct device_node *np,
 441                                                  const char *propname,
 442                                                  const char **out_strs, size_t sz, int index)
 443 {
 444         return -ENOSYS;
 445 }
 446
 447 static inline const void *of_get_property(const struct device_node *node,
 448                                 const char *name,
 449                                 int *lenp)
 450 {
 451         return NULL;
 452 }
 453
 454 static inline int of_property_read_u64(const struct device_node *np,
 455                                        const char *propname, u64 *out_value)
 456 {
 457         return -ENOSYS;
 458 }
 459
 460 static inline int of_property_match_string(struct device_node *np,
 461                                            const char *propname,
 462                                            const char *string)
 463 {
 464         return -ENOSYS;
 465 }
 466
 467 static inline struct device_node *of_parse_phandle(const struct device_node *np,
 468                                                    const char *phandle_name,
 469                                                    int index)
 470 {
 471         return NULL;
 472 }
 473
 474 static inline int of_parse_phandle_with_args(struct device_node *np,
 475                                              const char *list_name,
 476                                              const char *cells_name,
 477                                              int index,
 478                                              struct of_phandle_args *out_args)
 479 {
 480         return -ENOSYS;
 481 }
 482
 483 static inline int of_count_phandle_with_args(struct device_node *np,
 484                                              const char *list_name,
 485                                              const char *cells_name)
 486 {
 487         return -ENOSYS;
 488 }
 489
 490 static inline int of_alias_get_id(struct device_node *np, const char *stem)
 491 {
 492         return -ENOSYS;
 493 }
 494
 495 static inline int of_machine_is_compatible(const char *compat)
 496 {
 497         return 0;
 498 }
 499
 500 #define of_match_ptr(_ptr)      NULL
 501 #define of_match_node(_matches, _node)  NULL
 502 #define of_property_for_each_u32(np, propname, prop, p, u) \
 503         while (0)
 504 #define of_property_for_each_string(np, propname, prop, s) \
 505         while (0)
 506 #endif /* CONFIG_OF */
 507
 508 #ifndef of_node_to_nid
 509 static inline int of_node_to_nid(struct device_node *np)
 510 {
 511         return numa_node_id();
 512 }
 513
 514 #define of_node_to_nid of_node_to_nid
 515 #endif
 516
 517 /**
 518  * of_property_read_string_array() - Read an array of strings from a multiple
 519  * strings property.
 520  * @np:         device node from which the property value is to be read.
 521  * @propname:   name of the property to be searched.
 522  * @out_strs:   output array of string pointers.
 523  * @sz:         number of array elements to read.
 524  *
 525  * Search for a property in a device tree node and retrieve a list of
 526  * terminated string values (pointer to data, not a copy) in that property.
 527  *
 528  * If @out_strs is NULL, the number of strings in the property is returned.
 529  */
 530 static inline int of_property_read_string_array(struct device_node *np,
 531                                                 const char *propname, const char **out_strs,
 532                                                 size_t sz)
 533 {
 534         return of_property_read_string_helper(np, propname, out_strs, sz, 0);
 535 }
 536
 537 /**
 538  * of_property_count_strings() - Find and return the number of strings from a
 539  * multiple strings property.
 540  * @np:         device node from which the property value is to be read.
 541  * @propname:   name of the property to be searched.
 542  *
 543  * Search for a property in a device tree node and retrieve the number of null
 544  * terminated string contain in it. Returns the number of strings on
 545  * success, -EINVAL if the property does not exist, -ENODATA if property
 546  * does not have a value, and -EILSEQ if the string is not null-terminated
 547  * within the length of the property data.
 548  */
 549 static inline int of_property_count_strings(struct device_node *np,
 550                                             const char *propname)
 551 {
 552         return of_property_read_string_helper(np, propname, NULL, 0, 0);
 553 }
 554
 555 /**
 556  * of_property_read_string_index() - Find and read a string from a multiple
 557  * strings property.
 558  * @np:         device node from which the property value is to be read.
 559  * @propname:   name of the property to be searched.
 560  * @index:      index of the string in the list of strings
 561  * @out_string: pointer to null terminated return string, modified only if
 562  *              return value is 0.
 563  *
 564  * Search for a property in a device tree node and retrieve a null
 565  * terminated string value (pointer to data, not a copy) in the list of strings
 566  * contained in that property.
 567  * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
 568  * property does not have a value, and -EILSEQ if the string is not
 569  * null-terminated within the length of the property data.
 570  *
 571  * The out_string pointer is modified only if a valid string can be decoded.
 572  */
 573 static inline int of_property_read_string_index(struct device_node *np,
 574                                                 const char *propname,
 575                                                 int index, const char **output)
 576 {
 577         int rc = of_property_read_string_helper(np, propname, output, 1, index);
 578         return rc < 0 ? rc : 0;
 579 }
 580
 581 /**
 582  * of_property_read_bool - Findfrom a property
 583  * @np:         device node from which the property value is to be read.
 584  * @propname:   name of the property to be searched.
 585  *
 586  * Search for a property in a device node.
 587  * Returns true if the property exist false otherwise.
 588  */
 589 static inline bool of_property_read_bool(const struct device_node *np,
 590                                          const char *propname)
 591 {
 592         struct property *prop = of_find_property(np, propname, NULL);
 593
 594         return prop ? true : false;
 595 }
 596
 597 static inline int of_property_read_u8(const struct device_node *np,
 598                                        const char *propname,
 599                                        u8 *out_value)
 600 {
 601         return of_property_read_u8_array(np, propname, out_value, 1);
 602 }
 603
 604 static inline int of_property_read_u16(const struct device_node *np,
 605                                        const char *propname,
 606                                        u16 *out_value)
 607 {
 608         return of_property_read_u16_array(np, propname, out_value, 1);
 609 }
 610
 611 static inline int of_property_read_u32(const struct device_node *np,
 612                                        const char *propname,
 613                                        u32 *out_value)
 614 {
 615         return of_property_read_u32_array(np, propname, out_value, 1);
 616 }
 617
 618 #if defined(CONFIG_PROC_FS) && defined(CONFIG_PROC_DEVICETREE)
 619 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
 620 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
 621 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
 622                                          struct property *prop);
 623 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
 624                                          struct property *newprop,
 625                                          struct property *oldprop);
 626 #endif
 627
 628 #endif /* _LINUX_OF_H */