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/kref.h> 21 #include <linux/mod_devicetable.h> 22 #include <linux/spinlock.h> 23 24 #include <asm/byteorder.h> 25 26 #ifdef CONFIG_OF 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 /* Pointer for first entry in chain of all nodes. */ 69 extern struct device_node *allnodes; 70 extern struct device_node *of_chosen; 71 extern rwlock_t devtree_lock; 72 73 static inline bool of_node_is_root(const struct device_node *node) 74 { 75 return node && (node->parent == NULL); 76 } 77 78 static inline int of_node_check_flag(struct device_node *n, unsigned long flag) 79 { 80 return test_bit(flag, &n->_flags); 81 } 82 83 static inline void of_node_set_flag(struct device_node *n, unsigned long flag) 84 { 85 set_bit(flag, &n->_flags); 86 } 87 88 extern struct device_node *of_find_all_nodes(struct device_node *prev); 89 90 #if defined(CONFIG_SPARC) 91 /* Dummy ref counting routines - to be implemented later */ 92 static inline struct device_node *of_node_get(struct device_node *node) 93 { 94 return node; 95 } 96 static inline void of_node_put(struct device_node *node) 97 { 98 } 99 100 #else 101 extern struct device_node *of_node_get(struct device_node *node); 102 extern void of_node_put(struct device_node *node); 103 #endif 104 105 /* 106 * OF address retreival & translation 107 */ 108 109 /* Helper to read a big number; size is in cells (not bytes) */ 110 static inline u64 of_read_number(const __be32 *cell, int size) 111 { 112 u64 r = 0; 113 while (size--) 114 r = (r << 32) | be32_to_cpu(*(cell++)); 115 return r; 116 } 117 118 /* Like of_read_number, but we want an unsigned long result */ 119 static inline unsigned long of_read_ulong(const __be32 *cell, int size) 120 { 121 /* toss away upper bits if unsigned long is smaller than u64 */ 122 return of_read_number(cell, size); 123 } 124 125 #include <asm/prom.h> 126 127 /* Default #address and #size cells. Allow arch asm/prom.h to override */ 128 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT) 129 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1 130 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1 131 #endif 132 133 /* Default string compare functions, Allow arch asm/prom.h to override */ 134 #if !defined(of_compat_cmp) 135 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2)) 136 #define of_prop_cmp(s1, s2) strcmp((s1), (s2)) 137 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2)) 138 #endif 139 140 /* flag descriptions */ 141 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */ 142 #define OF_DETACHED 2 /* node has been detached from the device tree */ 143 144 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags) 145 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags) 146 147 #define OF_BAD_ADDR ((u64)-1) 148 149 #ifndef of_node_to_nid 150 static inline int of_node_to_nid(struct device_node *np) { return -1; } 151 #define of_node_to_nid of_node_to_nid 152 #endif 153 154 extern struct device_node *of_find_node_by_name(struct device_node *from, 155 const char *name); 156 #define for_each_node_by_name(dn, name) \ 157 for (dn = of_find_node_by_name(NULL, name); dn; \ 158 dn = of_find_node_by_name(dn, name)) 159 extern struct device_node *of_find_node_by_type(struct device_node *from, 160 const char *type); 161 #define for_each_node_by_type(dn, type) \ 162 for (dn = of_find_node_by_type(NULL, type); dn; \ 163 dn = of_find_node_by_type(dn, type)) 164 extern struct device_node *of_find_compatible_node(struct device_node *from, 165 const char *type, const char *compat); 166 #define for_each_compatible_node(dn, type, compatible) \ 167 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \ 168 dn = of_find_compatible_node(dn, type, compatible)) 169 extern struct device_node *of_find_matching_node(struct device_node *from, 170 const struct of_device_id *matches); 171 #define for_each_matching_node(dn, matches) \ 172 for (dn = of_find_matching_node(NULL, matches); dn; \ 173 dn = of_find_matching_node(dn, matches)) 174 extern struct device_node *of_find_node_by_path(const char *path); 175 extern struct device_node *of_find_node_by_phandle(phandle handle); 176 extern struct device_node *of_get_parent(const struct device_node *node); 177 extern struct device_node *of_get_next_parent(struct device_node *node); 178 extern struct device_node *of_get_next_child(const struct device_node *node, 179 struct device_node *prev); 180 #define for_each_child_of_node(parent, child) \ 181 for (child = of_get_next_child(parent, NULL); child != NULL; \ 182 child = of_get_next_child(parent, child)) 183 184 extern struct device_node *of_find_node_with_property( 185 struct device_node *from, const char *prop_name); 186 #define for_each_node_with_property(dn, prop_name) \ 187 for (dn = of_find_node_with_property(NULL, prop_name); dn; \ 188 dn = of_find_node_with_property(dn, prop_name)) 189 190 extern struct property *of_find_property(const struct device_node *np, 191 const char *name, 192 int *lenp); 193 extern int of_device_is_compatible(const struct device_node *device, 194 const char *); 195 extern int of_device_is_available(const struct device_node *device); 196 extern const void *of_get_property(const struct device_node *node, 197 const char *name, 198 int *lenp); 199 extern int of_n_addr_cells(struct device_node *np); 200 extern int of_n_size_cells(struct device_node *np); 201 extern const struct of_device_id *of_match_node( 202 const struct of_device_id *matches, const struct device_node *node); 203 extern int of_modalias_node(struct device_node *node, char *modalias, int len); 204 extern struct device_node *of_parse_phandle(struct device_node *np, 205 const char *phandle_name, 206 int index); 207 extern int of_parse_phandles_with_args(struct device_node *np, 208 const char *list_name, const char *cells_name, int index, 209 struct device_node **out_node, const void **out_args); 210 211 extern int of_machine_is_compatible(const char *compat); 212 213 extern int prom_add_property(struct device_node* np, struct property* prop); 214 extern int prom_remove_property(struct device_node *np, struct property *prop); 215 extern int prom_update_property(struct device_node *np, 216 struct property *newprop, 217 struct property *oldprop); 218 219 #if defined(CONFIG_OF_DYNAMIC) 220 /* For updating the device tree at runtime */ 221 extern void of_attach_node(struct device_node *); 222 extern void of_detach_node(struct device_node *); 223 #endif 224 225 #endif /* CONFIG_OF */ 226 #endif /* _LINUX_OF_H */ 227