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
  25 #include <asm/byteorder.h>
  26 #include <asm/errno.h>
  27
  28 typedef u32 phandle;
  29 typedef u32 ihandle;
  30
  31 struct property {
  32         char    *name;
  33         int     length;
  34         void    *value;
  35         struct property *next;
  36         unsigned long _flags;
  37         unsigned int unique_id;
  38 };
  39
  40 #if defined(CONFIG_SPARC)
  41 struct of_irq_controller;
  42 #endif
  43
  44 struct device_node {
  45         const char *name;
  46         const char *type;
  47         phandle phandle;
  48         char    *full_name;
  49
  50         struct  property *properties;
  51         struct  property *deadprops;    /* removed properties */
  52         struct  device_node *parent;
  53         struct  device_node *child;
  54         struct  device_node *sibling;
  55         struct  device_node *next;      /* next device of same type */
  56         struct  device_node *allnext;   /* next in list of all nodes */
  57         struct  proc_dir_entry *pde;    /* this node's proc directory */
  58         struct  kref kref;
  59         unsigned long _flags;
  60         void    *data;
  61 #if defined(CONFIG_SPARC)
  62         char    *path_component_name;
  63         unsigned int unique_id;
  64         struct of_irq_controller *irq_trans;
  65 #endif
  66 };
  67
  68 #if defined(CONFIG_SPARC) || !defined(CONFIG_OF)
  69 /* Dummy ref counting routines - to be implemented later */
  70 static inline struct device_node *of_node_get(struct device_node *node)
  71 {
  72         return node;
  73 }
  74 static inline void of_node_put(struct device_node *node)
  75 {
  76 }
  77 #else
  78 extern struct device_node *of_node_get(struct device_node *node);
  79 extern void of_node_put(struct device_node *node);
  80 #endif
  81
  82 #ifdef CONFIG_OF
  83
  84 /* Pointer for first entry in chain of all nodes. */
  85 extern struct device_node *allnodes;
  86 extern struct device_node *of_chosen;
  87 extern struct device_node *of_aliases;
  88 extern rwlock_t devtree_lock;
  89
  90 static inline bool of_have_populated_dt(void)
  91 {
  92         return allnodes != NULL;
  93 }
  94
  95 static inline bool of_node_is_root(const struct device_node *node)
  96 {
  97         return node && (node->parent == NULL);
  98 }
  99
 100 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
 101 {
 102         return test_bit(flag, &n->_flags);
 103 }
 104
 105 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
 106 {
 107         set_bit(flag, &n->_flags);
 108 }
 109
 110 extern struct device_node *of_find_all_nodes(struct device_node *prev);
 111
 112 /*
 113  * OF address retrieval & translation
 114  */
 115
 116 /* Helper to read a big number; size is in cells (not bytes) */
 117 static inline u64 of_read_number(const __be32 *cell, int size)
 118 {
 119         u64 r = 0;
 120         while (size--)
 121                 r = (r << 32) | be32_to_cpu(*(cell++));
 122         return r;
 123 }
 124
 125 /* Like of_read_number, but we want an unsigned long result */
 126 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
 127 {
 128         /* toss away upper bits if unsigned long is smaller than u64 */
 129         return of_read_number(cell, size);
 130 }
 131
 132 #include <asm/prom.h>
 133
 134 /* Default #address and #size cells.  Allow arch asm/prom.h to override */
 135 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
 136 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
 137 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
 138 #endif
 139
 140 /* Default string compare functions, Allow arch asm/prom.h to override */
 141 #if !defined(of_compat_cmp)
 142 #define of_compat_cmp(s1, s2, l)        strcasecmp((s1), (s2))
 143 #define of_prop_cmp(s1, s2)             strcmp((s1), (s2))
 144 #define of_node_cmp(s1, s2)             strcasecmp((s1), (s2))
 145 #endif
 146
 147 /* flag descriptions */
 148 #define OF_DYNAMIC      1 /* node and properties were allocated via kmalloc */
 149 #define OF_DETACHED     2 /* node has been detached from the device tree */
 150
 151 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
 152 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
 153
 154 #define OF_BAD_ADDR     ((u64)-1)
 155
 156 #ifndef of_node_to_nid
 157 static inline int of_node_to_nid(struct device_node *np) { return -1; }
 158 #define of_node_to_nid of_node_to_nid
 159 #endif
 160
 161 extern struct device_node *of_find_node_by_name(struct device_node *from,
 162         const char *name);
 163 #define for_each_node_by_name(dn, name) \
 164         for (dn = of_find_node_by_name(NULL, name); dn; \
 165              dn = of_find_node_by_name(dn, name))
 166 extern struct device_node *of_find_node_by_type(struct device_node *from,
 167         const char *type);
 168 #define for_each_node_by_type(dn, type) \
 169         for (dn = of_find_node_by_type(NULL, type); dn; \
 170              dn = of_find_node_by_type(dn, type))
 171 extern struct device_node *of_find_compatible_node(struct device_node *from,
 172         const char *type, const char *compat);
 173 #define for_each_compatible_node(dn, type, compatible) \
 174         for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
 175              dn = of_find_compatible_node(dn, type, compatible))
 176 extern struct device_node *of_find_matching_node(struct device_node *from,
 177         const struct of_device_id *matches);
 178 #define for_each_matching_node(dn, matches) \
 179         for (dn = of_find_matching_node(NULL, matches); dn; \
 180              dn = of_find_matching_node(dn, matches))
 181 extern struct device_node *of_find_node_by_path(const char *path);
 182 extern struct device_node *of_find_node_by_phandle(phandle handle);
 183 extern struct device_node *of_get_parent(const struct device_node *node);
 184 extern struct device_node *of_get_next_parent(struct device_node *node);
 185 extern struct device_node *of_get_next_child(const struct device_node *node,
 186                                              struct device_node *prev);
 187 #define for_each_child_of_node(parent, child) \
 188         for (child = of_get_next_child(parent, NULL); child != NULL; \
 189              child = of_get_next_child(parent, child))
 190
 191 extern struct device_node *of_find_node_with_property(
 192         struct device_node *from, const char *prop_name);
 193 #define for_each_node_with_property(dn, prop_name) \
 194         for (dn = of_find_node_with_property(NULL, prop_name); dn; \
 195              dn = of_find_node_with_property(dn, prop_name))
 196
 197 extern struct property *of_find_property(const struct device_node *np,
 198                                          const char *name,
 199                                          int *lenp);
 200 extern int of_property_read_u32_array(const struct device_node *np,
 201                                       const char *propname,
 202                                       u32 *out_values,
 203                                       size_t sz);
 204 extern int of_property_read_u64(const struct device_node *np,
 205                                 const char *propname, u64 *out_value);
 206
 207 extern int of_property_read_string(struct device_node *np,
 208                                    const char *propname,
 209                                    const char **out_string);
 210 extern int of_property_read_string_index(struct device_node *np,
 211                                          const char *propname,
 212                                          int index, const char **output);
 213 extern int of_property_count_strings(struct device_node *np,
 214                                      const char *propname);
 215 extern int of_device_is_compatible(const struct device_node *device,
 216                                    const char *);
 217 extern int of_device_is_available(const struct device_node *device);
 218 extern const void *of_get_property(const struct device_node *node,
 219                                 const char *name,
 220                                 int *lenp);
 221 #define for_each_property_of_node(dn, pp) \
 222         for (pp = dn->properties; pp != NULL; pp = pp->next)
 223
 224 extern int of_n_addr_cells(struct device_node *np);
 225 extern int of_n_size_cells(struct device_node *np);
 226 extern const struct of_device_id *of_match_node(
 227         const struct of_device_id *matches, const struct device_node *node);
 228 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
 229 extern struct device_node *of_parse_phandle(struct device_node *np,
 230                                             const char *phandle_name,
 231                                             int index);
 232 extern int of_parse_phandles_with_args(struct device_node *np,
 233         const char *list_name, const char *cells_name, int index,
 234         struct device_node **out_node, const void **out_args);
 235
 236 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
 237 extern int of_alias_get_id(struct device_node *np, const char *stem);
 238
 239 extern int of_machine_is_compatible(const char *compat);
 240
 241 extern int prom_add_property(struct device_node* np, struct property* prop);
 242 extern int prom_remove_property(struct device_node *np, struct property *prop);
 243 extern int prom_update_property(struct device_node *np,
 244                                 struct property *newprop,
 245                                 struct property *oldprop);
 246
 247 #if defined(CONFIG_OF_DYNAMIC)
 248 /* For updating the device tree at runtime */
 249 extern void of_attach_node(struct device_node *);
 250 extern void of_detach_node(struct device_node *);
 251 #endif
 252
 253 #define of_match_ptr(_ptr)      (_ptr)
 254 #else /* CONFIG_OF */
 255
 256 static inline bool of_have_populated_dt(void)
 257 {
 258         return false;
 259 }
 260
 261 #define for_each_child_of_node(parent, child) \
 262         while (0)
 263
 264 static inline int of_device_is_compatible(const struct device_node *device,
 265                                           const char *name)
 266 {
 267         return 0;
 268 }
 269
 270 static inline struct property *of_find_property(const struct device_node *np,
 271                                                 const char *name,
 272                                                 int *lenp)
 273 {
 274         return NULL;
 275 }
 276
 277 static inline int of_property_read_u32_array(const struct device_node *np,
 278                                              const char *propname,
 279                                              u32 *out_values, size_t sz)
 280 {
 281         return -ENOSYS;
 282 }
 283
 284 static inline int of_property_read_string(struct device_node *np,
 285                                           const char *propname,
 286                                           const char **out_string)
 287 {
 288         return -ENOSYS;
 289 }
 290
 291 static inline int of_property_read_string_index(struct device_node *np,
 292                                                 const char *propname, int index,
 293                                                 const char **out_string)
 294 {
 295         return -ENOSYS;
 296 }
 297
 298 static inline int of_property_count_strings(struct device_node *np,
 299                                             const char *propname)
 300 {
 301         return -ENOSYS;
 302 }
 303
 304 static inline const void *of_get_property(const struct device_node *node,
 305                                 const char *name,
 306                                 int *lenp)
 307 {
 308         return NULL;
 309 }
 310
 311 static inline int of_property_read_u64(const struct device_node *np,
 312                                        const char *propname, u64 *out_value)
 313 {
 314         return -ENOSYS;
 315 }
 316
 317 static inline struct device_node *of_parse_phandle(struct device_node *np,
 318                                                    const char *phandle_name,
 319                                                    int index)
 320 {
 321         return NULL;
 322 }
 323
 324 static inline int of_alias_get_id(struct device_node *np, const char *stem)
 325 {
 326         return -ENOSYS;
 327 }
 328
 329 static inline int of_machine_is_compatible(const char *compat)
 330 {
 331         return 0;
 332 }
 333
 334 #define of_match_ptr(_ptr)      NULL
 335 #define of_match_node(_matches, _node)  NULL
 336 #endif /* CONFIG_OF */
 337
 338 static inline int of_property_read_u32(const struct device_node *np,
 339                                        const char *propname,
 340                                        u32 *out_value)
 341 {
 342         return of_property_read_u32_array(np, propname, out_value, 1);
 343 }
 344
 345 #endif /* _LINUX_OF_H */