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