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 27 typedef u32 phandle; 28 typedef u32 ihandle; 29 30 struct property { 31 char *name; 32 int length; 33 void *value; 34 struct property *next; 35 unsigned long _flags; 36 unsigned int unique_id; 37 }; 38 39 #if defined(CONFIG_SPARC) 40 struct of_irq_controller; 41 #endif 42 43 struct device_node { 44 const char *name; 45 const char *type; 46 phandle phandle; 47 char *full_name; 48 49 struct property *properties; 50 struct property *deadprops; /* removed properties */ 51 struct device_node *parent; 52 struct device_node *child; 53 struct device_node *sibling; 54 struct device_node *next; /* next device of same type */ 55 struct device_node *allnext; /* next in list of all nodes */ 56 struct proc_dir_entry *pde; /* this node's proc directory */ 57 struct kref kref; 58 unsigned long _flags; 59 void *data; 60 #if defined(CONFIG_SPARC) 61 char *path_component_name; 62 unsigned int unique_id; 63 struct of_irq_controller *irq_trans; 64 #endif 65 }; 66 67 #ifdef CONFIG_OF 68 69 /* Pointer for first entry in chain of all nodes. */ 70 extern struct device_node *allnodes; 71 extern struct device_node *of_chosen; 72 extern struct device_node *of_aliases; 73 extern rwlock_t devtree_lock; 74 75 static inline bool of_have_populated_dt(void) 76 { 77 return allnodes != NULL; 78 } 79 80 static inline bool of_node_is_root(const struct device_node *node) 81 { 82 return node && (node->parent == NULL); 83 } 84 85 static inline int of_node_check_flag(struct device_node *n, unsigned long flag) 86 { 87 return test_bit(flag, &n->_flags); 88 } 89 90 static inline void of_node_set_flag(struct device_node *n, unsigned long flag) 91 { 92 set_bit(flag, &n->_flags); 93 } 94 95 extern struct device_node *of_find_all_nodes(struct device_node *prev); 96 97 #if defined(CONFIG_SPARC) 98 /* Dummy ref counting routines - to be implemented later */ 99 static inline struct device_node *of_node_get(struct device_node *node) 100 { 101 return node; 102 } 103 static inline void of_node_put(struct device_node *node) 104 { 105 } 106 107 #else 108 extern struct device_node *of_node_get(struct device_node *node); 109 extern void of_node_put(struct device_node *node); 110 #endif 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_device_is_compatible(const struct device_node *device, 211 const char *); 212 extern int of_device_is_available(const struct device_node *device); 213 extern const void *of_get_property(const struct device_node *node, 214 const char *name, 215 int *lenp); 216 #define for_each_property(pp, properties) \ 217 for (pp = properties; pp != NULL; pp = pp->next) 218 219 extern int of_n_addr_cells(struct device_node *np); 220 extern int of_n_size_cells(struct device_node *np); 221 extern const struct of_device_id *of_match_node( 222 const struct of_device_id *matches, const struct device_node *node); 223 extern int of_modalias_node(struct device_node *node, char *modalias, int len); 224 extern struct device_node *of_parse_phandle(struct device_node *np, 225 const char *phandle_name, 226 int index); 227 extern int of_parse_phandles_with_args(struct device_node *np, 228 const char *list_name, const char *cells_name, int index, 229 struct device_node **out_node, const void **out_args); 230 231 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align)); 232 extern int of_alias_get_id(struct device_node *np, const char *stem); 233 234 extern int of_machine_is_compatible(const char *compat); 235 236 extern int prom_add_property(struct device_node* np, struct property* prop); 237 extern int prom_remove_property(struct device_node *np, struct property *prop); 238 extern int prom_update_property(struct device_node *np, 239 struct property *newprop, 240 struct property *oldprop); 241 242 #if defined(CONFIG_OF_DYNAMIC) 243 /* For updating the device tree at runtime */ 244 extern void of_attach_node(struct device_node *); 245 extern void of_detach_node(struct device_node *); 246 #endif 247 248 #define of_match_ptr(_ptr) (_ptr) 249 #else /* CONFIG_OF */ 250 251 static inline bool of_have_populated_dt(void) 252 { 253 return false; 254 } 255 256 #define for_each_child_of_node(parent, child) \ 257 while (0) 258 259 static inline int of_device_is_compatible(const struct device_node *device, 260 const char *name) 261 { 262 return 0; 263 } 264 265 static inline struct property *of_find_property(const struct device_node *np, 266 const char *name, 267 int *lenp) 268 { 269 return NULL; 270 } 271 272 static inline int of_property_read_u32_array(const struct device_node *np, 273 const char *propname, 274 u32 *out_values, size_t sz) 275 { 276 return -ENOSYS; 277 } 278 279 static inline int of_property_read_string(struct device_node *np, 280 const char *propname, 281 const char **out_string) 282 { 283 return -ENOSYS; 284 } 285 286 static inline const void *of_get_property(const struct device_node *node, 287 const char *name, 288 int *lenp) 289 { 290 return NULL; 291 } 292 293 static inline int of_property_read_u64(const struct device_node *np, 294 const char *propname, u64 *out_value) 295 { 296 return -ENOSYS; 297 } 298 299 static inline struct device_node *of_parse_phandle(struct device_node *np, 300 const char *phandle_name, 301 int index) 302 { 303 return NULL; 304 } 305 306 #define of_match_ptr(_ptr) NULL 307 #define of_match_node(_matches, _node) NULL 308 #endif /* CONFIG_OF */ 309 310 static inline int of_property_read_u32(const struct device_node *np, 311 const char *propname, 312 u32 *out_value) 313 { 314 return of_property_read_u32_array(np, propname, out_value, 1); 315 } 316 317 #endif /* _LINUX_OF_H */ 318