SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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/kref.h>
  21 #include <linux/mod_devicetable.h>
  22
  23 typedef u32 phandle;
  24 typedef u32 ihandle;
  25
  26 struct property {
  27         char    *name;
  28         int     length;
  29         void    *value;
  30         struct property *next;
  31         unsigned long _flags;
  32         unsigned int unique_id;
  33 };
  34
  35 #if defined(CONFIG_SPARC)
  36 struct of_irq_controller;
  37 #endif
  38
  39 struct device_node {
  40         const char *name;
  41         const char *type;
  42         phandle phandle;
  43         char    *full_name;
  44
  45         struct  property *properties;
  46         struct  property *deadprops;    /* removed properties */
  47         struct  device_node *parent;
  48         struct  device_node *child;
  49         struct  device_node *sibling;
  50         struct  device_node *next;      /* next device of same type */
  51         struct  device_node *allnext;   /* next in list of all nodes */
  52         struct  proc_dir_entry *pde;    /* this node's proc directory */
  53         struct  kref kref;
  54         unsigned long _flags;
  55         void    *data;
  56 #if defined(CONFIG_SPARC)
  57         char    *path_component_name;
  58         unsigned int unique_id;
  59         struct of_irq_controller *irq_trans;
  60 #endif
  61 };
  62
  63 /* Pointer for first entry in chain of all nodes. */
  64 extern struct device_node *allnodes;
  65
  66 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
  67 {
  68         return test_bit(flag, &n->_flags);
  69 }
  70
  71 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
  72 {
  73         set_bit(flag, &n->_flags);
  74 }
  75
  76 extern struct device_node *of_find_all_nodes(struct device_node *prev);
  77
  78 #if defined(CONFIG_SPARC)
  79 /* Dummy ref counting routines - to be implemented later */
  80 static inline struct device_node *of_node_get(struct device_node *node)
  81 {
  82         return node;
  83 }
  84 static inline void of_node_put(struct device_node *node)
  85 {
  86 }
  87
  88 #else
  89 extern struct device_node *of_node_get(struct device_node *node);
  90 extern void of_node_put(struct device_node *node);
  91 #endif
  92
  93 /*
  94  * OF address retreival & translation
  95  */
  96
  97 /* Helper to read a big number; size is in cells (not bytes) */
  98 static inline u64 of_read_number(const u32 *cell, int size)
  99 {
 100         u64 r = 0;
 101         while (size--)
 102                 r = (r << 32) | *(cell++);
 103         return r;
 104 }
 105
 106 /* Like of_read_number, but we want an unsigned long result */
 107 static inline unsigned long of_read_ulong(const u32 *cell, int size)
 108 {
 109         /* toss away upper bits if unsigned long is smaller than u64 */
 110         return of_read_number(cell, size);
 111 }
 112
 113 #include <asm/prom.h>
 114
 115 /* flag descriptions */
 116 #define OF_DYNAMIC      1 /* node and properties were allocated via kmalloc */
 117 #define OF_DETACHED     2 /* node has been detached from the device tree */
 118
 119 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
 120 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
 121
 122 #define OF_BAD_ADDR     ((u64)-1)
 123
 124 extern struct device_node *of_find_node_by_name(struct device_node *from,
 125         const char *name);
 126 #define for_each_node_by_name(dn, name) \
 127         for (dn = of_find_node_by_name(NULL, name); dn; \
 128              dn = of_find_node_by_name(dn, name))
 129 extern struct device_node *of_find_node_by_type(struct device_node *from,
 130         const char *type);
 131 #define for_each_node_by_type(dn, type) \
 132         for (dn = of_find_node_by_type(NULL, type); dn; \
 133              dn = of_find_node_by_type(dn, type))
 134 extern struct device_node *of_find_compatible_node(struct device_node *from,
 135         const char *type, const char *compat);
 136 #define for_each_compatible_node(dn, type, compatible) \
 137         for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
 138              dn = of_find_compatible_node(dn, type, compatible))
 139 extern struct device_node *of_find_matching_node(struct device_node *from,
 140         const struct of_device_id *matches);
 141 #define for_each_matching_node(dn, matches) \
 142         for (dn = of_find_matching_node(NULL, matches); dn; \
 143              dn = of_find_matching_node(dn, matches))
 144 extern struct device_node *of_find_node_by_path(const char *path);
 145 extern struct device_node *of_find_node_by_phandle(phandle handle);
 146 extern struct device_node *of_get_parent(const struct device_node *node);
 147 extern struct device_node *of_get_next_parent(struct device_node *node);
 148 extern struct device_node *of_get_next_child(const struct device_node *node,
 149                                              struct device_node *prev);
 150 #define for_each_child_of_node(parent, child) \
 151         for (child = of_get_next_child(parent, NULL); child != NULL; \
 152              child = of_get_next_child(parent, child))
 153
 154 extern struct device_node *of_find_node_with_property(
 155         struct device_node *from, const char *prop_name);
 156 #define for_each_node_with_property(dn, prop_name) \
 157         for (dn = of_find_node_with_property(NULL, prop_name); dn; \
 158              dn = of_find_node_with_property(dn, prop_name))
 159
 160 extern struct property *of_find_property(const struct device_node *np,
 161                                          const char *name,
 162                                          int *lenp);
 163 extern int of_device_is_compatible(const struct device_node *device,
 164                                    const char *);
 165 extern int of_device_is_available(const struct device_node *device);
 166 extern const void *of_get_property(const struct device_node *node,
 167                                 const char *name,
 168                                 int *lenp);
 169 extern int of_n_addr_cells(struct device_node *np);
 170 extern int of_n_size_cells(struct device_node *np);
 171 extern const struct of_device_id *of_match_node(
 172         const struct of_device_id *matches, const struct device_node *node);
 173 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
 174 extern struct device_node *of_parse_phandle(struct device_node *np,
 175                                             const char *phandle_name,
 176                                             int index);
 177 extern int of_parse_phandles_with_args(struct device_node *np,
 178         const char *list_name, const char *cells_name, int index,
 179         struct device_node **out_node, const void **out_args);
 180
 181 #if defined(CONFIG_OF_DYNAMIC)
 182 /* For updating the device tree at runtime */
 183 extern void of_attach_node(struct device_node *);
 184 extern void of_detach_node(struct device_node *);
 185 #endif
 186
 187 #endif /* _LINUX_OF_H */