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_EEH)
  62         struct eeh_dev *edev;
  63 #endif
  64 #if defined(CONFIG_SPARC)
  65         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 8
  72 struct of_phandle_args {
  73         struct device_node *np;
  74         int args_count;
  75         uint32_t args[MAX_PHANDLE_ARGS];
  76 };
  77
  78 #if defined(CONFIG_EEH)
  79 static inline struct eeh_dev *of_node_to_eeh_dev(struct device_node *dn)
  80 {
  81         return dn->edev;
  82 }
  83 #endif
  84
  85 #ifdef CONFIG_OF_DYNAMIC
  86 extern struct device_node *of_node_get(struct device_node *node);
  87 extern void of_node_put(struct device_node *node);
  88 #else /* CONFIG_OF_DYNAMIC */
  89 /* Dummy ref counting routines - to be implemented later */
  90 static inline struct device_node *of_node_get(struct device_node *node)
  91 {
  92         return node;
  93 }
  94 static inline void of_node_put(struct device_node *node) { }
  95 #endif /* !CONFIG_OF_DYNAMIC */
  96
  97 #ifdef CONFIG_OF
  98
  99 /* Pointer for first entry in chain of all nodes. */
 100 extern struct device_node *allnodes;
 101 extern struct device_node *of_chosen;
 102 extern struct device_node *of_aliases;
 103 extern rwlock_t devtree_lock;
 104
 105 static inline bool of_have_populated_dt(void)
 106 {
 107         return allnodes != NULL;
 108 }
 109
 110 static inline bool of_node_is_root(const struct device_node *node)
 111 {
 112         return node && (node->parent == NULL);
 113 }
 114
 115 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
 116 {
 117         return test_bit(flag, &n->_flags);
 118 }
 119
 120 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
 121 {
 122         set_bit(flag, &n->_flags);
 123 }
 124
 125 extern struct device_node *of_find_all_nodes(struct device_node *prev);
 126
 127 /*
 128  * OF address retrieval & translation
 129  */
 130
 131 /* Helper to read a big number; size is in cells (not bytes) */
 132 static inline u64 of_read_number(const __be32 *cell, int size)
 133 {
 134         u64 r = 0;
 135         while (size--)
 136                 r = (r << 32) | be32_to_cpu(*(cell++));
 137         return r;
 138 }
 139
 140 /* Like of_read_number, but we want an unsigned long result */
 141 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
 142 {
 143         /* toss away upper bits if unsigned long is smaller than u64 */
 144         return of_read_number(cell, size);
 145 }
 146
 147 #include <asm/prom.h>
 148
 149 /* Default #address and #size cells.  Allow arch asm/prom.h to override */
 150 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
 151 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
 152 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
 153 #endif
 154
 155 /* Default string compare functions, Allow arch asm/prom.h to override */
 156 #if !defined(of_compat_cmp)
 157 #define of_compat_cmp(s1, s2, l)        strcasecmp((s1), (s2))
 158 #define of_prop_cmp(s1, s2)             strcmp((s1), (s2))
 159 #define of_node_cmp(s1, s2)             strcasecmp((s1), (s2))
 160 #endif
 161
 162 /* flag descriptions */
 163 #define OF_DYNAMIC      1 /* node and properties were allocated via kmalloc */
 164 #define OF_DETACHED     2 /* node has been detached from the device tree */
 165
 166 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
 167 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
 168
 169 #define OF_BAD_ADDR     ((u64)-1)
 170
 171 #ifndef of_node_to_nid
 172 static inline int of_node_to_nid(struct device_node *np) { return -1; }
 173 #define of_node_to_nid of_node_to_nid
 174 #endif
 175
 176 extern struct device_node *of_find_node_by_name(struct device_node *from,
 177         const char *name);
 178 #define for_each_node_by_name(dn, name) \
 179         for (dn = of_find_node_by_name(NULL, name); dn; \
 180              dn = of_find_node_by_name(dn, name))
 181 extern struct device_node *of_find_node_by_type(struct device_node *from,
 182         const char *type);
 183 #define for_each_node_by_type(dn, type) \
 184         for (dn = of_find_node_by_type(NULL, type); dn; \
 185              dn = of_find_node_by_type(dn, type))
 186 extern struct device_node *of_find_compatible_node(struct device_node *from,
 187         const char *type, const char *compat);
 188 #define for_each_compatible_node(dn, type, compatible) \
 189         for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
 190              dn = of_find_compatible_node(dn, type, compatible))
 191 extern struct device_node *of_find_matching_node(struct device_node *from,
 192         const struct of_device_id *matches);
 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 extern struct device_node *of_find_node_by_path(const char *path);
 197 extern struct device_node *of_find_node_by_phandle(phandle handle);
 198 extern struct device_node *of_get_parent(const struct device_node *node);
 199 extern struct device_node *of_get_next_parent(struct device_node *node);
 200 extern struct device_node *of_get_next_child(const struct device_node *node,
 201                                              struct device_node *prev);
 202 #define for_each_child_of_node(parent, child) \
 203         for (child = of_get_next_child(parent, NULL); child != NULL; \
 204              child = of_get_next_child(parent, child))
 205
 206 extern struct device_node *of_find_node_with_property(
 207         struct device_node *from, const char *prop_name);
 208 #define for_each_node_with_property(dn, prop_name) \
 209         for (dn = of_find_node_with_property(NULL, prop_name); dn; \
 210              dn = of_find_node_with_property(dn, prop_name))
 211
 212 extern struct property *of_find_property(const struct device_node *np,
 213                                          const char *name,
 214                                          int *lenp);
 215 extern int of_property_read_u32_array(const struct device_node *np,
 216                                       const char *propname,
 217                                       u32 *out_values,
 218                                       size_t sz);
 219 extern int of_property_read_u64(const struct device_node *np,
 220                                 const char *propname, u64 *out_value);
 221
 222 extern int of_property_read_string(struct device_node *np,
 223                                    const char *propname,
 224                                    const char **out_string);
 225 extern int of_property_read_string_index(struct device_node *np,
 226                                          const char *propname,
 227                                          int index, const char **output);
 228 extern int of_property_match_string(struct device_node *np,
 229                                     const char *propname,
 230                                     const char *string);
 231 extern int of_property_count_strings(struct device_node *np,
 232                                      const char *propname);
 233 extern int of_device_is_compatible(const struct device_node *device,
 234                                    const char *);
 235 extern int of_device_is_available(const struct device_node *device);
 236 extern const void *of_get_property(const struct device_node *node,
 237                                 const char *name,
 238                                 int *lenp);
 239 #define for_each_property_of_node(dn, pp) \
 240         for (pp = dn->properties; pp != NULL; pp = pp->next)
 241
 242 extern int of_n_addr_cells(struct device_node *np);
 243 extern int of_n_size_cells(struct device_node *np);
 244 extern const struct of_device_id *of_match_node(
 245         const struct of_device_id *matches, const struct device_node *node);
 246 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
 247 extern struct device_node *of_parse_phandle(struct device_node *np,
 248                                             const char *phandle_name,
 249                                             int index);
 250 extern int of_parse_phandle_with_args(struct device_node *np,
 251         const char *list_name, const char *cells_name, int index,
 252         struct of_phandle_args *out_args);
 253
 254 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
 255 extern int of_alias_get_id(struct device_node *np, const char *stem);
 256
 257 extern int of_machine_is_compatible(const char *compat);
 258
 259 extern int prom_add_property(struct device_node* np, struct property* prop);
 260 extern int prom_remove_property(struct device_node *np, struct property *prop);
 261 extern int prom_update_property(struct device_node *np,
 262                                 struct property *newprop,
 263                                 struct property *oldprop);
 264
 265 #if defined(CONFIG_OF_DYNAMIC)
 266 /* For updating the device tree at runtime */
 267 extern void of_attach_node(struct device_node *);
 268 extern void of_detach_node(struct device_node *);
 269 #endif
 270
 271 #define of_match_ptr(_ptr)      (_ptr)
 272 #else /* CONFIG_OF */
 273
 274 static inline bool of_have_populated_dt(void)
 275 {
 276         return false;
 277 }
 278
 279 #define for_each_child_of_node(parent, child) \
 280         while (0)
 281
 282 static inline int of_device_is_compatible(const struct device_node *device,
 283                                           const char *name)
 284 {
 285         return 0;
 286 }
 287
 288 static inline struct property *of_find_property(const struct device_node *np,
 289                                                 const char *name,
 290                                                 int *lenp)
 291 {
 292         return NULL;
 293 }
 294
 295 static inline struct device_node *of_find_compatible_node(
 296                                                 struct device_node *from,
 297                                                 const char *type,
 298                                                 const char *compat)
 299 {
 300         return NULL;
 301 }
 302
 303 static inline int of_property_read_u32_array(const struct device_node *np,
 304                                              const char *propname,
 305                                              u32 *out_values, size_t sz)
 306 {
 307         return -ENOSYS;
 308 }
 309
 310 static inline int of_property_read_string(struct device_node *np,
 311                                           const char *propname,
 312                                           const char **out_string)
 313 {
 314         return -ENOSYS;
 315 }
 316
 317 static inline int of_property_read_string_index(struct device_node *np,
 318                                                 const char *propname, int index,
 319                                                 const char **out_string)
 320 {
 321         return -ENOSYS;
 322 }
 323
 324 static inline int of_property_count_strings(struct device_node *np,
 325                                             const char *propname)
 326 {
 327         return -ENOSYS;
 328 }
 329
 330 static inline const void *of_get_property(const struct device_node *node,
 331                                 const char *name,
 332                                 int *lenp)
 333 {
 334         return NULL;
 335 }
 336
 337 static inline int of_property_read_u64(const struct device_node *np,
 338                                        const char *propname, u64 *out_value)
 339 {
 340         return -ENOSYS;
 341 }
 342
 343 static inline struct device_node *of_parse_phandle(struct device_node *np,
 344                                                    const char *phandle_name,
 345                                                    int index)
 346 {
 347         return NULL;
 348 }
 349
 350 static inline int of_alias_get_id(struct device_node *np, const char *stem)
 351 {
 352         return -ENOSYS;
 353 }
 354
 355 static inline int of_machine_is_compatible(const char *compat)
 356 {
 357         return 0;
 358 }
 359
 360 #define of_match_ptr(_ptr)      NULL
 361 #define of_match_node(_matches, _node)  NULL
 362 #endif /* CONFIG_OF */
 363
 364 /**
 365  * of_property_read_bool - Findfrom a property
 366  * @np:         device node from which the property value is to be read.
 367  * @propname:   name of the property to be searched.
 368  *
 369  * Search for a property in a device node.
 370  * Returns true if the property exist false otherwise.
 371  */
 372 static inline bool of_property_read_bool(const struct device_node *np,
 373                                          const char *propname)
 374 {
 375         struct property *prop = of_find_property(np, propname, NULL);
 376
 377         return prop ? true : false;
 378 }
 379
 380 static inline int of_property_read_u32(const struct device_node *np,
 381                                        const char *propname,
 382                                        u32 *out_value)
 383 {
 384         return of_property_read_u32_array(np, propname, out_value, 1);
 385 }
 386
 387 #endif /* _LINUX_OF_H */