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