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