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 extern struct device_node *of_find_node_by_name(struct device_node *from, 167 const char *name); 168 #define for_each_node_by_name(dn, name) \ 169 for (dn = of_find_node_by_name(NULL, name); dn; \ 170 dn = of_find_node_by_name(dn, name)) 171 extern struct device_node *of_find_node_by_type(struct device_node *from, 172 const char *type); 173 #define for_each_node_by_type(dn, type) \ 174 for (dn = of_find_node_by_type(NULL, type); dn; \ 175 dn = of_find_node_by_type(dn, type)) 176 extern struct device_node *of_find_compatible_node(struct device_node *from, 177 const char *type, const char *compat); 178 #define for_each_compatible_node(dn, type, compatible) \ 179 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \ 180 dn = of_find_compatible_node(dn, type, compatible)) 181 extern struct device_node *of_find_matching_node(struct device_node *from, 182 const struct of_device_id *matches); 183 #define for_each_matching_node(dn, matches) \ 184 for (dn = of_find_matching_node(NULL, matches); dn; \ 185 dn = of_find_matching_node(dn, matches)) 186 extern struct device_node *of_find_node_by_path(const char *path); 187 extern struct device_node *of_find_node_by_phandle(phandle handle); 188 extern struct device_node *of_get_parent(const struct device_node *node); 189 extern struct device_node *of_get_next_parent(struct device_node *node); 190 extern struct device_node *of_get_next_child(const struct device_node *node, 191 struct device_node *prev); 192 #define for_each_child_of_node(parent, child) \ 193 for (child = of_get_next_child(parent, NULL); child != NULL; \ 194 child = of_get_next_child(parent, child)) 195 196 extern struct device_node *of_find_node_with_property( 197 struct device_node *from, const char *prop_name); 198 #define for_each_node_with_property(dn, prop_name) \ 199 for (dn = of_find_node_with_property(NULL, prop_name); dn; \ 200 dn = of_find_node_with_property(dn, prop_name)) 201 202 extern struct property *of_find_property(const struct device_node *np, 203 const char *name, 204 int *lenp); 205 extern int of_property_read_u32_array(const struct device_node *np, 206 const char *propname, 207 u32 *out_values, 208 size_t sz); 209 extern int of_property_read_u64(const struct device_node *np, 210 const char *propname, u64 *out_value); 211 212 extern int of_property_read_string(struct device_node *np, 213 const char *propname, 214 const char **out_string); 215 extern int of_property_read_string_index(struct device_node *np, 216 const char *propname, 217 int index, const char **output); 218 extern int of_property_match_string(struct device_node *np, 219 const char *propname, 220 const char *string); 221 extern int of_property_count_strings(struct device_node *np, 222 const char *propname); 223 extern int of_device_is_compatible(const struct device_node *device, 224 const char *); 225 extern int of_device_is_available(const struct device_node *device); 226 extern const void *of_get_property(const struct device_node *node, 227 const char *name, 228 int *lenp); 229 #define for_each_property_of_node(dn, pp) \ 230 for (pp = dn->properties; pp != NULL; pp = pp->next) 231 232 extern int of_n_addr_cells(struct device_node *np); 233 extern int of_n_size_cells(struct device_node *np); 234 extern const struct of_device_id *of_match_node( 235 const struct of_device_id *matches, const struct device_node *node); 236 extern int of_modalias_node(struct device_node *node, char *modalias, int len); 237 extern struct device_node *of_parse_phandle(struct device_node *np, 238 const char *phandle_name, 239 int index); 240 extern int of_parse_phandle_with_args(struct device_node *np, 241 const char *list_name, const char *cells_name, int index, 242 struct of_phandle_args *out_args); 243 244 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align)); 245 extern int of_alias_get_id(struct device_node *np, const char *stem); 246 247 extern int of_machine_is_compatible(const char *compat); 248 249 extern int prom_add_property(struct device_node* np, struct property* prop); 250 extern int prom_remove_property(struct device_node *np, struct property *prop); 251 extern int prom_update_property(struct device_node *np, 252 struct property *newprop, 253 struct property *oldprop); 254 255 #if defined(CONFIG_OF_DYNAMIC) 256 /* For updating the device tree at runtime */ 257 extern void of_attach_node(struct device_node *); 258 extern void of_detach_node(struct device_node *); 259 #endif 260 261 #define of_match_ptr(_ptr) (_ptr) 262 #else /* CONFIG_OF */ 263 264 static inline bool of_have_populated_dt(void) 265 { 266 return false; 267 } 268 269 #define for_each_child_of_node(parent, child) \ 270 while (0) 271 272 static inline int of_device_is_compatible(const struct device_node *device, 273 const char *name) 274 { 275 return 0; 276 } 277 278 static inline struct property *of_find_property(const struct device_node *np, 279 const char *name, 280 int *lenp) 281 { 282 return NULL; 283 } 284 285 static inline struct device_node *of_find_compatible_node( 286 struct device_node *from, 287 const char *type, 288 const char *compat) 289 { 290 return NULL; 291 } 292 293 static inline int of_property_read_u32_array(const struct device_node *np, 294 const char *propname, 295 u32 *out_values, size_t sz) 296 { 297 return -ENOSYS; 298 } 299 300 static inline int of_property_read_string(struct device_node *np, 301 const char *propname, 302 const char **out_string) 303 { 304 return -ENOSYS; 305 } 306 307 static inline int of_property_read_string_index(struct device_node *np, 308 const char *propname, int index, 309 const char **out_string) 310 { 311 return -ENOSYS; 312 } 313 314 static inline int of_property_count_strings(struct device_node *np, 315 const char *propname) 316 { 317 return -ENOSYS; 318 } 319 320 static inline const void *of_get_property(const struct device_node *node, 321 const char *name, 322 int *lenp) 323 { 324 return NULL; 325 } 326 327 static inline int of_property_read_u64(const struct device_node *np, 328 const char *propname, u64 *out_value) 329 { 330 return -ENOSYS; 331 } 332 333 static inline struct device_node *of_parse_phandle(struct device_node *np, 334 const char *phandle_name, 335 int index) 336 { 337 return NULL; 338 } 339 340 static inline int of_alias_get_id(struct device_node *np, const char *stem) 341 { 342 return -ENOSYS; 343 } 344 345 static inline int of_machine_is_compatible(const char *compat) 346 { 347 return 0; 348 } 349 350 #define of_match_ptr(_ptr) NULL 351 #define of_match_node(_matches, _node) NULL 352 #endif /* CONFIG_OF */ 353 354 /** 355 * of_property_read_bool - Findfrom a property 356 * @np: device node from which the property value is to be read. 357 * @propname: name of the property to be searched. 358 * 359 * Search for a property in a device node. 360 * Returns true if the property exist false otherwise. 361 */ 362 static inline bool of_property_read_bool(const struct device_node *np, 363 const char *propname) 364 { 365 struct property *prop = of_find_property(np, propname, NULL); 366 367 return prop ? true : false; 368 } 369 370 static inline int of_property_read_u32(const struct device_node *np, 371 const char *propname, 372 u32 *out_value) 373 { 374 return of_property_read_u32_array(np, propname, out_value, 1); 375 } 376 377 #endif /* _LINUX_OF_H */ 378