Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 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> |
Jiri Slaby | 1977f03 | 2007-10-18 23:40:25 -0700 | [diff] [blame] | 19 | #include <linux/bitops.h> |
Kalle Valo | e51130c | 2011-10-06 15:40:44 +0300 | [diff] [blame] | 20 | #include <linux/errno.h> |
Grant Likely | 6f19249 | 2009-10-15 10:57:49 -0600 | [diff] [blame] | 21 | #include <linux/kref.h> |
Grant Likely | 283029d | 2008-01-09 06:20:40 +1100 | [diff] [blame] | 22 | #include <linux/mod_devicetable.h> |
Grant Likely | 0d351c3 | 2010-02-14 14:13:57 -0700 | [diff] [blame] | 23 | #include <linux/spinlock.h> |
Paul Mundt | 5ca4db6 | 2012-06-03 22:04:34 -0700 | [diff] [blame] | 24 | #include <linux/topology.h> |
Nathan Fontenot | 1cf3d8b | 2012-10-02 16:57:57 +0000 | [diff] [blame] | 25 | #include <linux/notifier.h> |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 26 | |
Jeremy Kerr | 2e89e68 | 2010-01-30 01:41:49 -0700 | [diff] [blame] | 27 | #include <asm/byteorder.h> |
Paul Gortmaker | d0a9940 | 2011-10-29 10:17:06 -0400 | [diff] [blame] | 28 | #include <asm/errno.h> |
Jeremy Kerr | 2e89e68 | 2010-01-30 01:41:49 -0700 | [diff] [blame] | 29 | |
Grant Likely | 731581e | 2009-10-15 10:57:46 -0600 | [diff] [blame] | 30 | typedef u32 phandle; |
| 31 | typedef u32 ihandle; |
| 32 | |
| 33 | struct property { |
| 34 | char *name; |
| 35 | int length; |
| 36 | void *value; |
| 37 | struct property *next; |
| 38 | unsigned long _flags; |
| 39 | unsigned int unique_id; |
| 40 | }; |
| 41 | |
Grant Likely | 6f19249 | 2009-10-15 10:57:49 -0600 | [diff] [blame] | 42 | #if defined(CONFIG_SPARC) |
| 43 | struct of_irq_controller; |
| 44 | #endif |
| 45 | |
| 46 | struct device_node { |
| 47 | const char *name; |
| 48 | const char *type; |
Grant Likely | 6016a36 | 2010-01-28 14:06:53 -0700 | [diff] [blame] | 49 | phandle phandle; |
Grant Likely | c22618a | 2012-11-14 22:37:12 +0000 | [diff] [blame] | 50 | const char *full_name; |
Grant Likely | 6f19249 | 2009-10-15 10:57:49 -0600 | [diff] [blame] | 51 | |
| 52 | struct property *properties; |
| 53 | struct property *deadprops; /* removed properties */ |
| 54 | struct device_node *parent; |
| 55 | struct device_node *child; |
| 56 | struct device_node *sibling; |
| 57 | struct device_node *next; /* next device of same type */ |
| 58 | struct device_node *allnext; /* next in list of all nodes */ |
| 59 | struct proc_dir_entry *pde; /* this node's proc directory */ |
| 60 | struct kref kref; |
| 61 | unsigned long _flags; |
| 62 | void *data; |
| 63 | #if defined(CONFIG_SPARC) |
Grant Likely | c22618a | 2012-11-14 22:37:12 +0000 | [diff] [blame] | 64 | const char *path_component_name; |
Grant Likely | 6f19249 | 2009-10-15 10:57:49 -0600 | [diff] [blame] | 65 | unsigned int unique_id; |
| 66 | struct of_irq_controller *irq_trans; |
| 67 | #endif |
| 68 | }; |
| 69 | |
Andreas Herrmann | b66548e | 2014-01-17 12:08:30 +0100 | [diff] [blame^] | 70 | #define MAX_PHANDLE_ARGS 16 |
Grant Likely | 15c9a0a | 2011-12-12 09:25:57 -0700 | [diff] [blame] | 71 | struct of_phandle_args { |
| 72 | struct device_node *np; |
| 73 | int args_count; |
| 74 | uint32_t args[MAX_PHANDLE_ARGS]; |
| 75 | }; |
| 76 | |
Grant Likely | 0f22dd3 | 2012-02-15 20:38:40 -0700 | [diff] [blame] | 77 | #ifdef CONFIG_OF_DYNAMIC |
| 78 | extern struct device_node *of_node_get(struct device_node *node); |
| 79 | extern void of_node_put(struct device_node *node); |
| 80 | #else /* CONFIG_OF_DYNAMIC */ |
Rob Herring | 3ecdd05 | 2011-12-13 09:13:54 -0600 | [diff] [blame] | 81 | /* Dummy ref counting routines - to be implemented later */ |
| 82 | static inline struct device_node *of_node_get(struct device_node *node) |
| 83 | { |
| 84 | return node; |
| 85 | } |
Grant Likely | 0f22dd3 | 2012-02-15 20:38:40 -0700 | [diff] [blame] | 86 | static inline void of_node_put(struct device_node *node) { } |
| 87 | #endif /* !CONFIG_OF_DYNAMIC */ |
Rob Herring | 3ecdd05 | 2011-12-13 09:13:54 -0600 | [diff] [blame] | 88 | |
Grant Likely | c9e358d | 2011-01-21 09:24:48 -0700 | [diff] [blame] | 89 | #ifdef CONFIG_OF |
| 90 | |
Grant Likely | 41f8800 | 2009-11-23 20:07:01 -0700 | [diff] [blame] | 91 | /* Pointer for first entry in chain of all nodes. */ |
Randy Dunlap | 465aac6 | 2012-11-30 10:01:51 +0000 | [diff] [blame] | 92 | extern struct device_node *of_allnodes; |
Grant Likely | fc0bdae | 2010-02-14 07:13:55 -0700 | [diff] [blame] | 93 | extern struct device_node *of_chosen; |
Shawn Guo | 611cad7 | 2011-08-15 15:28:14 +0800 | [diff] [blame] | 94 | extern struct device_node *of_aliases; |
Thomas Gleixner | d6d3c4e | 2013-02-06 15:30:56 -0500 | [diff] [blame] | 95 | extern raw_spinlock_t devtree_lock; |
Grant Likely | 41f8800 | 2009-11-23 20:07:01 -0700 | [diff] [blame] | 96 | |
Sebastian Andrzej Siewior | 3bcbaf6 | 2011-02-22 21:07:46 +0100 | [diff] [blame] | 97 | static inline bool of_have_populated_dt(void) |
| 98 | { |
Randy Dunlap | 465aac6 | 2012-11-30 10:01:51 +0000 | [diff] [blame] | 99 | return of_allnodes != NULL; |
Sebastian Andrzej Siewior | 3bcbaf6 | 2011-02-22 21:07:46 +0100 | [diff] [blame] | 100 | } |
| 101 | |
Andres Salomon | 035ebef | 2010-07-13 09:42:26 +0000 | [diff] [blame] | 102 | static inline bool of_node_is_root(const struct device_node *node) |
| 103 | { |
| 104 | return node && (node->parent == NULL); |
| 105 | } |
| 106 | |
Grant Likely | 5043631 | 2009-10-15 10:57:58 -0600 | [diff] [blame] | 107 | static inline int of_node_check_flag(struct device_node *n, unsigned long flag) |
| 108 | { |
| 109 | return test_bit(flag, &n->_flags); |
| 110 | } |
| 111 | |
| 112 | static inline void of_node_set_flag(struct device_node *n, unsigned long flag) |
| 113 | { |
| 114 | set_bit(flag, &n->_flags); |
| 115 | } |
| 116 | |
Pantelis Antoniou | 588453c | 2013-11-08 17:03:56 +0200 | [diff] [blame] | 117 | static inline void of_node_clear_flag(struct device_node *n, unsigned long flag) |
| 118 | { |
| 119 | clear_bit(flag, &n->_flags); |
| 120 | } |
| 121 | |
| 122 | static inline int of_property_check_flag(struct property *p, unsigned long flag) |
| 123 | { |
| 124 | return test_bit(flag, &p->_flags); |
| 125 | } |
| 126 | |
| 127 | static inline void of_property_set_flag(struct property *p, unsigned long flag) |
| 128 | { |
| 129 | set_bit(flag, &p->_flags); |
| 130 | } |
| 131 | |
| 132 | static inline void of_property_clear_flag(struct property *p, unsigned long flag) |
| 133 | { |
| 134 | clear_bit(flag, &p->_flags); |
| 135 | } |
| 136 | |
Grant Likely | e91edcf | 2009-10-15 10:58:09 -0600 | [diff] [blame] | 137 | extern struct device_node *of_find_all_nodes(struct device_node *prev); |
| 138 | |
Grant Likely | b6caf2a | 2009-10-15 10:58:00 -0600 | [diff] [blame] | 139 | /* |
Lennert Buytenhek | 3d6b882 | 2011-02-22 18:18:51 +0100 | [diff] [blame] | 140 | * OF address retrieval & translation |
Grant Likely | b6caf2a | 2009-10-15 10:58:00 -0600 | [diff] [blame] | 141 | */ |
| 142 | |
| 143 | /* Helper to read a big number; size is in cells (not bytes) */ |
Jeremy Kerr | 2e89e68 | 2010-01-30 01:41:49 -0700 | [diff] [blame] | 144 | static inline u64 of_read_number(const __be32 *cell, int size) |
Grant Likely | b6caf2a | 2009-10-15 10:58:00 -0600 | [diff] [blame] | 145 | { |
| 146 | u64 r = 0; |
| 147 | while (size--) |
Jeremy Kerr | 2e89e68 | 2010-01-30 01:41:49 -0700 | [diff] [blame] | 148 | r = (r << 32) | be32_to_cpu(*(cell++)); |
Grant Likely | b6caf2a | 2009-10-15 10:58:00 -0600 | [diff] [blame] | 149 | return r; |
| 150 | } |
| 151 | |
| 152 | /* Like of_read_number, but we want an unsigned long result */ |
Jeremy Kerr | 2e89e68 | 2010-01-30 01:41:49 -0700 | [diff] [blame] | 153 | static inline unsigned long of_read_ulong(const __be32 *cell, int size) |
Grant Likely | b6caf2a | 2009-10-15 10:58:00 -0600 | [diff] [blame] | 154 | { |
Grant Likely | 2be09cb | 2009-11-23 20:16:46 -0700 | [diff] [blame] | 155 | /* toss away upper bits if unsigned long is smaller than u64 */ |
| 156 | return of_read_number(cell, size); |
Grant Likely | b6caf2a | 2009-10-15 10:58:00 -0600 | [diff] [blame] | 157 | } |
Grant Likely | b6caf2a | 2009-10-15 10:58:00 -0600 | [diff] [blame] | 158 | |
Rob Herring | b5b4bb3 | 2013-09-07 14:08:20 -0500 | [diff] [blame] | 159 | #if defined(CONFIG_SPARC) |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 160 | #include <asm/prom.h> |
Rob Herring | b5b4bb3 | 2013-09-07 14:08:20 -0500 | [diff] [blame] | 161 | #endif |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 162 | |
Grant Likely | 7c7b60c | 2010-02-14 07:13:50 -0700 | [diff] [blame] | 163 | /* Default #address and #size cells. Allow arch asm/prom.h to override */ |
| 164 | #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT) |
| 165 | #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1 |
| 166 | #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1 |
| 167 | #endif |
| 168 | |
| 169 | /* Default string compare functions, Allow arch asm/prom.h to override */ |
| 170 | #if !defined(of_compat_cmp) |
Grant Likely | 1976152 | 2010-03-18 07:30:31 -0600 | [diff] [blame] | 171 | #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2)) |
Grant Likely | 7c7b60c | 2010-02-14 07:13:50 -0700 | [diff] [blame] | 172 | #define of_prop_cmp(s1, s2) strcmp((s1), (s2)) |
| 173 | #define of_node_cmp(s1, s2) strcasecmp((s1), (s2)) |
| 174 | #endif |
| 175 | |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 176 | /* flag descriptions */ |
| 177 | #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */ |
| 178 | #define OF_DETACHED 2 /* node has been detached from the device tree */ |
| 179 | |
Grant Likely | 61e955d | 2009-10-15 10:57:51 -0600 | [diff] [blame] | 180 | #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags) |
| 181 | #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags) |
| 182 | |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 183 | #define OF_BAD_ADDR ((u64)-1) |
| 184 | |
Steffen Trumtrar | c0a05bf | 2012-12-18 11:32:03 +0100 | [diff] [blame] | 185 | static inline const char *of_node_full_name(const struct device_node *np) |
Grant Likely | 74a7f08 | 2012-06-15 11:50:25 -0600 | [diff] [blame] | 186 | { |
| 187 | return np ? np->full_name : "<no-node>"; |
| 188 | } |
| 189 | |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 190 | extern struct device_node *of_find_node_by_name(struct device_node *from, |
| 191 | const char *name); |
| 192 | #define for_each_node_by_name(dn, name) \ |
| 193 | for (dn = of_find_node_by_name(NULL, name); dn; \ |
| 194 | dn = of_find_node_by_name(dn, name)) |
| 195 | extern struct device_node *of_find_node_by_type(struct device_node *from, |
| 196 | const char *type); |
| 197 | #define for_each_node_by_type(dn, type) \ |
| 198 | for (dn = of_find_node_by_type(NULL, type); dn; \ |
| 199 | dn = of_find_node_by_type(dn, type)) |
| 200 | extern struct device_node *of_find_compatible_node(struct device_node *from, |
| 201 | const char *type, const char *compat); |
| 202 | #define for_each_compatible_node(dn, type, compatible) \ |
| 203 | for (dn = of_find_compatible_node(NULL, type, compatible); dn; \ |
| 204 | dn = of_find_compatible_node(dn, type, compatible)) |
Stephen Warren | 50c8af4 | 2012-11-20 16:12:20 -0700 | [diff] [blame] | 205 | extern struct device_node *of_find_matching_node_and_match( |
| 206 | struct device_node *from, |
| 207 | const struct of_device_id *matches, |
| 208 | const struct of_device_id **match); |
| 209 | static inline struct device_node *of_find_matching_node( |
| 210 | struct device_node *from, |
| 211 | const struct of_device_id *matches) |
| 212 | { |
| 213 | return of_find_matching_node_and_match(from, matches, NULL); |
| 214 | } |
Grant Likely | 283029d | 2008-01-09 06:20:40 +1100 | [diff] [blame] | 215 | #define for_each_matching_node(dn, matches) \ |
| 216 | for (dn = of_find_matching_node(NULL, matches); dn; \ |
| 217 | dn = of_find_matching_node(dn, matches)) |
Stephen Warren | 50c8af4 | 2012-11-20 16:12:20 -0700 | [diff] [blame] | 218 | #define for_each_matching_node_and_match(dn, matches, match) \ |
| 219 | for (dn = of_find_matching_node_and_match(NULL, matches, match); \ |
| 220 | dn; dn = of_find_matching_node_and_match(dn, matches, match)) |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 221 | extern struct device_node *of_find_node_by_path(const char *path); |
| 222 | extern struct device_node *of_find_node_by_phandle(phandle handle); |
| 223 | extern struct device_node *of_get_parent(const struct device_node *node); |
Michael Ellerman | f4eb010 | 2007-10-26 16:54:31 +1000 | [diff] [blame] | 224 | extern struct device_node *of_get_next_parent(struct device_node *node); |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 225 | extern struct device_node *of_get_next_child(const struct device_node *node, |
| 226 | struct device_node *prev); |
Timur Tabi | 3296193 | 2012-08-14 13:20:23 +0000 | [diff] [blame] | 227 | extern struct device_node *of_get_next_available_child( |
| 228 | const struct device_node *node, struct device_node *prev); |
| 229 | |
Srinivas Kandagatla | 9c19761 | 2012-09-18 08:10:28 +0100 | [diff] [blame] | 230 | extern struct device_node *of_get_child_by_name(const struct device_node *node, |
| 231 | const char *name); |
Michael Ellerman | aabc08d | 2007-11-26 19:03:45 +1100 | [diff] [blame] | 232 | #define for_each_child_of_node(parent, child) \ |
| 233 | for (child = of_get_next_child(parent, NULL); child != NULL; \ |
| 234 | child = of_get_next_child(parent, child)) |
| 235 | |
Timur Tabi | 3296193 | 2012-08-14 13:20:23 +0000 | [diff] [blame] | 236 | #define for_each_available_child_of_node(parent, child) \ |
| 237 | for (child = of_get_next_available_child(parent, NULL); child != NULL; \ |
| 238 | child = of_get_next_available_child(parent, child)) |
| 239 | |
Dong Aisheng | 183f1d0 | 2012-04-27 11:36:20 +0800 | [diff] [blame] | 240 | static inline int of_get_child_count(const struct device_node *np) |
| 241 | { |
| 242 | struct device_node *child; |
| 243 | int num = 0; |
| 244 | |
| 245 | for_each_child_of_node(np, child) |
| 246 | num++; |
| 247 | |
| 248 | return num; |
| 249 | } |
| 250 | |
Bryan Wu | 954e04b | 2013-09-24 10:38:26 -0700 | [diff] [blame] | 251 | static inline int of_get_available_child_count(const struct device_node *np) |
| 252 | { |
| 253 | struct device_node *child; |
| 254 | int num = 0; |
| 255 | |
| 256 | for_each_available_child_of_node(np, child) |
| 257 | num++; |
| 258 | |
| 259 | return num; |
| 260 | } |
| 261 | |
Sudeep KarkadaNagesha | a3e31b4 | 2013-09-18 11:53:05 +0100 | [diff] [blame] | 262 | /* cache lookup */ |
| 263 | extern struct device_node *of_find_next_cache_node(const struct device_node *); |
Michael Ellerman | 1e291b1 | 2008-11-12 18:54:42 +0000 | [diff] [blame] | 264 | extern struct device_node *of_find_node_with_property( |
| 265 | struct device_node *from, const char *prop_name); |
| 266 | #define for_each_node_with_property(dn, prop_name) \ |
| 267 | for (dn = of_find_node_with_property(NULL, prop_name); dn; \ |
| 268 | dn = of_find_node_with_property(dn, prop_name)) |
| 269 | |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 270 | extern struct property *of_find_property(const struct device_node *np, |
| 271 | const char *name, |
| 272 | int *lenp); |
Tony Prisk | 3daf372 | 2013-03-23 17:02:15 +1300 | [diff] [blame] | 273 | extern int of_property_read_u32_index(const struct device_node *np, |
| 274 | const char *propname, |
| 275 | u32 index, u32 *out_value); |
Viresh Kumar | be19324 | 2012-11-20 10:15:19 +0530 | [diff] [blame] | 276 | extern int of_property_read_u8_array(const struct device_node *np, |
| 277 | const char *propname, u8 *out_values, size_t sz); |
| 278 | extern int of_property_read_u16_array(const struct device_node *np, |
| 279 | const char *propname, u16 *out_values, size_t sz); |
Rob Herring | 0e37363 | 2011-07-06 15:42:58 -0500 | [diff] [blame] | 280 | extern int of_property_read_u32_array(const struct device_node *np, |
Jamie Iles | aac285c | 2011-08-02 15:45:07 +0100 | [diff] [blame] | 281 | const char *propname, |
Rob Herring | 0e37363 | 2011-07-06 15:42:58 -0500 | [diff] [blame] | 282 | u32 *out_values, |
| 283 | size_t sz); |
Jamie Iles | 4cd7f7a | 2011-09-14 20:49:59 +0100 | [diff] [blame] | 284 | extern int of_property_read_u64(const struct device_node *np, |
| 285 | const char *propname, u64 *out_value); |
Rob Herring | 0e37363 | 2011-07-06 15:42:58 -0500 | [diff] [blame] | 286 | |
Jamie Iles | aac285c | 2011-08-02 15:45:07 +0100 | [diff] [blame] | 287 | extern int of_property_read_string(struct device_node *np, |
| 288 | const char *propname, |
| 289 | const char **out_string); |
Benoit Cousson | 4fcd15a | 2011-09-27 17:45:43 +0200 | [diff] [blame] | 290 | extern int of_property_read_string_index(struct device_node *np, |
| 291 | const char *propname, |
| 292 | int index, const char **output); |
Grant Likely | 7aff0fe | 2011-12-12 09:25:58 -0700 | [diff] [blame] | 293 | extern int of_property_match_string(struct device_node *np, |
| 294 | const char *propname, |
| 295 | const char *string); |
Benoit Cousson | 4fcd15a | 2011-09-27 17:45:43 +0200 | [diff] [blame] | 296 | extern int of_property_count_strings(struct device_node *np, |
| 297 | const char *propname); |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 298 | extern int of_device_is_compatible(const struct device_node *device, |
| 299 | const char *); |
Josh Boyer | 834d97d | 2008-03-27 00:33:14 +1100 | [diff] [blame] | 300 | extern int of_device_is_available(const struct device_node *device); |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 301 | extern const void *of_get_property(const struct device_node *node, |
| 302 | const char *name, |
| 303 | int *lenp); |
Sudeep KarkadaNagesha | 183912d | 2013-08-15 14:01:40 +0100 | [diff] [blame] | 304 | extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread); |
Dong Aisheng | 8af0da9 | 2011-12-22 20:19:24 +0800 | [diff] [blame] | 305 | #define for_each_property_of_node(dn, pp) \ |
| 306 | for (pp = dn->properties; pp != NULL; pp = pp->next) |
Shawn Guo | 611cad7 | 2011-08-15 15:28:14 +0800 | [diff] [blame] | 307 | |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 308 | extern int of_n_addr_cells(struct device_node *np); |
| 309 | extern int of_n_size_cells(struct device_node *np); |
Grant Likely | 283029d | 2008-01-09 06:20:40 +1100 | [diff] [blame] | 310 | extern const struct of_device_id *of_match_node( |
| 311 | const struct of_device_id *matches, const struct device_node *node); |
Grant Likely | 3f07af4 | 2008-07-25 22:25:13 -0400 | [diff] [blame] | 312 | extern int of_modalias_node(struct device_node *node, char *modalias, int len); |
Grant Likely | 624cfca | 2013-10-11 22:05:10 +0100 | [diff] [blame] | 313 | extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args); |
Steffen Trumtrar | b8fbdc4 | 2012-11-22 12:16:43 +0100 | [diff] [blame] | 314 | extern struct device_node *of_parse_phandle(const struct device_node *np, |
Grant Likely | 739649c | 2009-04-25 12:52:40 +0000 | [diff] [blame] | 315 | const char *phandle_name, |
| 316 | int index); |
Guennadi Liakhovetski | 93c667c | 2012-12-10 20:41:30 +0100 | [diff] [blame] | 317 | extern int of_parse_phandle_with_args(const struct device_node *np, |
Anton Vorontsov | 64b60e0 | 2008-10-10 04:43:17 +0000 | [diff] [blame] | 318 | const char *list_name, const char *cells_name, int index, |
Grant Likely | 15c9a0a | 2011-12-12 09:25:57 -0700 | [diff] [blame] | 319 | struct of_phandle_args *out_args); |
Stephen Warren | 035fd94 | 2013-08-14 15:27:10 -0600 | [diff] [blame] | 320 | extern int of_parse_phandle_with_fixed_args(const struct device_node *np, |
| 321 | const char *list_name, int cells_count, int index, |
| 322 | struct of_phandle_args *out_args); |
Grant Likely | bd69f73 | 2013-02-10 22:57:21 +0000 | [diff] [blame] | 323 | extern int of_count_phandle_with_args(const struct device_node *np, |
| 324 | const char *list_name, const char *cells_name); |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 325 | |
Shawn Guo | 611cad7 | 2011-08-15 15:28:14 +0800 | [diff] [blame] | 326 | extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align)); |
| 327 | extern int of_alias_get_id(struct device_node *np, const char *stem); |
| 328 | |
Grant Likely | 21b082e | 2010-02-14 07:13:38 -0700 | [diff] [blame] | 329 | extern int of_machine_is_compatible(const char *compat); |
| 330 | |
Nathan Fontenot | 79d1c71 | 2012-10-02 16:58:46 +0000 | [diff] [blame] | 331 | extern int of_add_property(struct device_node *np, struct property *prop); |
| 332 | extern int of_remove_property(struct device_node *np, struct property *prop); |
| 333 | extern int of_update_property(struct device_node *np, struct property *newprop); |
Grant Likely | 21b082e | 2010-02-14 07:13:38 -0700 | [diff] [blame] | 334 | |
Grant Likely | fcdeb7f | 2010-01-29 05:04:33 -0700 | [diff] [blame] | 335 | /* For updating the device tree at runtime */ |
Nathan Fontenot | 1cf3d8b | 2012-10-02 16:57:57 +0000 | [diff] [blame] | 336 | #define OF_RECONFIG_ATTACH_NODE 0x0001 |
| 337 | #define OF_RECONFIG_DETACH_NODE 0x0002 |
| 338 | #define OF_RECONFIG_ADD_PROPERTY 0x0003 |
| 339 | #define OF_RECONFIG_REMOVE_PROPERTY 0x0004 |
| 340 | #define OF_RECONFIG_UPDATE_PROPERTY 0x0005 |
| 341 | |
| 342 | struct of_prop_reconfig { |
| 343 | struct device_node *dn; |
| 344 | struct property *prop; |
| 345 | }; |
| 346 | |
| 347 | extern int of_reconfig_notifier_register(struct notifier_block *); |
| 348 | extern int of_reconfig_notifier_unregister(struct notifier_block *); |
| 349 | extern int of_reconfig_notify(unsigned long, void *); |
| 350 | |
| 351 | extern int of_attach_node(struct device_node *); |
| 352 | extern int of_detach_node(struct device_node *); |
Grant Likely | fcdeb7f | 2010-01-29 05:04:33 -0700 | [diff] [blame] | 353 | |
Ben Dooks | 3a1e362 | 2011-08-03 10:11:42 +0100 | [diff] [blame] | 354 | #define of_match_ptr(_ptr) (_ptr) |
Stephen Warren | c541adc | 2012-04-04 09:27:46 -0600 | [diff] [blame] | 355 | |
| 356 | /* |
| 357 | * struct property *prop; |
| 358 | * const __be32 *p; |
| 359 | * u32 u; |
| 360 | * |
| 361 | * of_property_for_each_u32(np, "propname", prop, p, u) |
| 362 | * printk("U32 value: %x\n", u); |
| 363 | */ |
| 364 | const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur, |
| 365 | u32 *pu); |
Stephen Warren | c541adc | 2012-04-04 09:27:46 -0600 | [diff] [blame] | 366 | /* |
| 367 | * struct property *prop; |
| 368 | * const char *s; |
| 369 | * |
| 370 | * of_property_for_each_string(np, "propname", prop, s) |
| 371 | * printk("String value: %s\n", s); |
| 372 | */ |
| 373 | const char *of_prop_next_string(struct property *prop, const char *cur); |
Stephen Warren | c541adc | 2012-04-04 09:27:46 -0600 | [diff] [blame] | 374 | |
Sascha Hauer | 5c19e95 | 2013-08-05 14:40:44 +0200 | [diff] [blame] | 375 | int of_device_is_stdout_path(struct device_node *dn); |
| 376 | |
Shawn Guo | b98c023 | 2011-07-08 16:27:33 +0800 | [diff] [blame] | 377 | #else /* CONFIG_OF */ |
Sebastian Andrzej Siewior | 3bcbaf6 | 2011-02-22 21:07:46 +0100 | [diff] [blame] | 378 | |
Grant Likely | 74a7f08 | 2012-06-15 11:50:25 -0600 | [diff] [blame] | 379 | static inline const char* of_node_full_name(struct device_node *np) |
| 380 | { |
| 381 | return "<no-node>"; |
| 382 | } |
| 383 | |
Peter Ujfalusi | 1cc44f4 | 2012-09-10 13:46:24 +0300 | [diff] [blame] | 384 | static inline struct device_node *of_find_node_by_name(struct device_node *from, |
| 385 | const char *name) |
| 386 | { |
| 387 | return NULL; |
| 388 | } |
| 389 | |
Alexander Shiyan | 066ec1d | 2013-04-09 19:47:40 +0400 | [diff] [blame] | 390 | static inline struct device_node *of_get_parent(const struct device_node *node) |
| 391 | { |
| 392 | return NULL; |
| 393 | } |
| 394 | |
Sebastian Andrzej Siewior | 3bcbaf6 | 2011-02-22 21:07:46 +0100 | [diff] [blame] | 395 | static inline bool of_have_populated_dt(void) |
| 396 | { |
| 397 | return false; |
| 398 | } |
| 399 | |
David Howells | 00b2c76 | 2014-01-23 15:54:02 -0800 | [diff] [blame] | 400 | /* Kill an unused variable warning on a device_node pointer */ |
| 401 | static inline void __of_use_dn(const struct device_node *np) |
| 402 | { |
| 403 | } |
| 404 | |
Stephen Warren | aba3dff | 2011-09-21 13:23:10 -0600 | [diff] [blame] | 405 | #define for_each_child_of_node(parent, child) \ |
David Howells | 00b2c76 | 2014-01-23 15:54:02 -0800 | [diff] [blame] | 406 | while (__of_use_dn(parent), __of_use_dn(child), 0) |
Stephen Warren | aba3dff | 2011-09-21 13:23:10 -0600 | [diff] [blame] | 407 | |
Sylwester Nawrocki | f6f0747 | 2013-10-28 13:12:35 -0500 | [diff] [blame] | 408 | #define for_each_available_child_of_node(parent, child) \ |
| 409 | while (0) |
| 410 | |
Olof Johansson | 25c040c | 2012-10-07 10:40:54 -0700 | [diff] [blame] | 411 | static inline struct device_node *of_get_child_by_name( |
| 412 | const struct device_node *node, |
| 413 | const char *name) |
| 414 | { |
| 415 | return NULL; |
| 416 | } |
| 417 | |
Dong Aisheng | 183f1d0 | 2012-04-27 11:36:20 +0800 | [diff] [blame] | 418 | static inline int of_get_child_count(const struct device_node *np) |
| 419 | { |
| 420 | return 0; |
| 421 | } |
| 422 | |
Bryan Wu | 954e04b | 2013-09-24 10:38:26 -0700 | [diff] [blame] | 423 | static inline int of_get_available_child_count(const struct device_node *np) |
| 424 | { |
| 425 | return 0; |
| 426 | } |
| 427 | |
Rajendra Nayak | 36a0904 | 2011-10-10 21:49:35 +0530 | [diff] [blame] | 428 | static inline int of_device_is_compatible(const struct device_node *device, |
| 429 | const char *name) |
| 430 | { |
| 431 | return 0; |
| 432 | } |
| 433 | |
Rob Herring | d719569 | 2013-03-20 16:56:18 -0500 | [diff] [blame] | 434 | static inline int of_device_is_available(const struct device_node *device) |
| 435 | { |
| 436 | return 0; |
| 437 | } |
| 438 | |
Stephen Warren | aba3dff | 2011-09-21 13:23:10 -0600 | [diff] [blame] | 439 | static inline struct property *of_find_property(const struct device_node *np, |
| 440 | const char *name, |
| 441 | int *lenp) |
| 442 | { |
| 443 | return NULL; |
| 444 | } |
| 445 | |
Shawn Guo | 2261cc6 | 2012-02-15 10:47:42 -0800 | [diff] [blame] | 446 | static inline struct device_node *of_find_compatible_node( |
| 447 | struct device_node *from, |
| 448 | const char *type, |
| 449 | const char *compat) |
| 450 | { |
| 451 | return NULL; |
| 452 | } |
| 453 | |
Tony Prisk | 3daf372 | 2013-03-23 17:02:15 +1300 | [diff] [blame] | 454 | static inline int of_property_read_u32_index(const struct device_node *np, |
| 455 | const char *propname, u32 index, u32 *out_value) |
| 456 | { |
| 457 | return -ENOSYS; |
| 458 | } |
| 459 | |
Viresh Kumar | be19324 | 2012-11-20 10:15:19 +0530 | [diff] [blame] | 460 | static inline int of_property_read_u8_array(const struct device_node *np, |
| 461 | const char *propname, u8 *out_values, size_t sz) |
| 462 | { |
| 463 | return -ENOSYS; |
| 464 | } |
| 465 | |
| 466 | static inline int of_property_read_u16_array(const struct device_node *np, |
| 467 | const char *propname, u16 *out_values, size_t sz) |
| 468 | { |
| 469 | return -ENOSYS; |
| 470 | } |
| 471 | |
Shawn Guo | b98c023 | 2011-07-08 16:27:33 +0800 | [diff] [blame] | 472 | static inline int of_property_read_u32_array(const struct device_node *np, |
Jamie Iles | aac285c | 2011-08-02 15:45:07 +0100 | [diff] [blame] | 473 | const char *propname, |
| 474 | u32 *out_values, size_t sz) |
Shawn Guo | b98c023 | 2011-07-08 16:27:33 +0800 | [diff] [blame] | 475 | { |
| 476 | return -ENOSYS; |
| 477 | } |
| 478 | |
| 479 | static inline int of_property_read_string(struct device_node *np, |
Jamie Iles | aac285c | 2011-08-02 15:45:07 +0100 | [diff] [blame] | 480 | const char *propname, |
| 481 | const char **out_string) |
Shawn Guo | b98c023 | 2011-07-08 16:27:33 +0800 | [diff] [blame] | 482 | { |
| 483 | return -ENOSYS; |
| 484 | } |
| 485 | |
Benoit Cousson | 4fcd15a | 2011-09-27 17:45:43 +0200 | [diff] [blame] | 486 | static inline int of_property_read_string_index(struct device_node *np, |
| 487 | const char *propname, int index, |
| 488 | const char **out_string) |
| 489 | { |
| 490 | return -ENOSYS; |
| 491 | } |
| 492 | |
| 493 | static inline int of_property_count_strings(struct device_node *np, |
| 494 | const char *propname) |
| 495 | { |
| 496 | return -ENOSYS; |
| 497 | } |
| 498 | |
Stephen Warren | 89272b8 | 2011-08-05 16:50:30 -0600 | [diff] [blame] | 499 | static inline const void *of_get_property(const struct device_node *node, |
| 500 | const char *name, |
| 501 | int *lenp) |
| 502 | { |
| 503 | return NULL; |
| 504 | } |
| 505 | |
Sudeep KarkadaNagesha | 183912d | 2013-08-15 14:01:40 +0100 | [diff] [blame] | 506 | static inline struct device_node *of_get_cpu_node(int cpu, |
| 507 | unsigned int *thread) |
| 508 | { |
| 509 | return NULL; |
| 510 | } |
| 511 | |
Jamie Iles | 4cd7f7a | 2011-09-14 20:49:59 +0100 | [diff] [blame] | 512 | static inline int of_property_read_u64(const struct device_node *np, |
| 513 | const char *propname, u64 *out_value) |
| 514 | { |
| 515 | return -ENOSYS; |
| 516 | } |
| 517 | |
Thierry Reding | bd3d550 | 2012-04-13 16:18:34 +0200 | [diff] [blame] | 518 | static inline int of_property_match_string(struct device_node *np, |
| 519 | const char *propname, |
| 520 | const char *string) |
| 521 | { |
| 522 | return -ENOSYS; |
| 523 | } |
| 524 | |
Steffen Trumtrar | b8fbdc4 | 2012-11-22 12:16:43 +0100 | [diff] [blame] | 525 | static inline struct device_node *of_parse_phandle(const struct device_node *np, |
Rajendra Nayak | 36a0904 | 2011-10-10 21:49:35 +0530 | [diff] [blame] | 526 | const char *phandle_name, |
| 527 | int index) |
| 528 | { |
| 529 | return NULL; |
| 530 | } |
| 531 | |
Thierry Reding | e05e507 | 2012-04-13 16:19:21 +0200 | [diff] [blame] | 532 | static inline int of_parse_phandle_with_args(struct device_node *np, |
| 533 | const char *list_name, |
| 534 | const char *cells_name, |
| 535 | int index, |
| 536 | struct of_phandle_args *out_args) |
| 537 | { |
| 538 | return -ENOSYS; |
| 539 | } |
| 540 | |
Stephen Warren | 035fd94 | 2013-08-14 15:27:10 -0600 | [diff] [blame] | 541 | static inline int of_parse_phandle_with_fixed_args(const struct device_node *np, |
| 542 | const char *list_name, int cells_count, int index, |
| 543 | struct of_phandle_args *out_args) |
| 544 | { |
| 545 | return -ENOSYS; |
| 546 | } |
| 547 | |
Grant Likely | bd69f73 | 2013-02-10 22:57:21 +0000 | [diff] [blame] | 548 | static inline int of_count_phandle_with_args(struct device_node *np, |
| 549 | const char *list_name, |
| 550 | const char *cells_name) |
| 551 | { |
| 552 | return -ENOSYS; |
| 553 | } |
| 554 | |
Nicolas Ferre | ed5f886 | 2011-10-27 11:07:28 +0200 | [diff] [blame] | 555 | static inline int of_alias_get_id(struct device_node *np, const char *stem) |
| 556 | { |
| 557 | return -ENOSYS; |
| 558 | } |
| 559 | |
Stephen Warren | 50e07f8 | 2011-10-25 14:01:26 +0200 | [diff] [blame] | 560 | static inline int of_machine_is_compatible(const char *compat) |
| 561 | { |
| 562 | return 0; |
| 563 | } |
| 564 | |
Sascha Hauer | 5c19e95 | 2013-08-05 14:40:44 +0200 | [diff] [blame] | 565 | static inline int of_device_is_stdout_path(struct device_node *dn) |
| 566 | { |
| 567 | return 0; |
| 568 | } |
| 569 | |
Sebastian Andrzej Siewior | 2adfffa | 2013-06-17 16:48:13 +0200 | [diff] [blame] | 570 | static inline const __be32 *of_prop_next_u32(struct property *prop, |
| 571 | const __be32 *cur, u32 *pu) |
| 572 | { |
| 573 | return NULL; |
| 574 | } |
| 575 | |
| 576 | static inline const char *of_prop_next_string(struct property *prop, |
| 577 | const char *cur) |
| 578 | { |
| 579 | return NULL; |
| 580 | } |
| 581 | |
Ben Dooks | 3a1e362 | 2011-08-03 10:11:42 +0100 | [diff] [blame] | 582 | #define of_match_ptr(_ptr) NULL |
Nicolas Ferre | 5762c20 | 2011-10-24 11:53:32 +0200 | [diff] [blame] | 583 | #define of_match_node(_matches, _node) NULL |
Jeremy Kerr | 9dfbf20 | 2010-02-14 07:13:43 -0700 | [diff] [blame] | 584 | #endif /* CONFIG_OF */ |
Shawn Guo | b98c023 | 2011-07-08 16:27:33 +0800 | [diff] [blame] | 585 | |
Rob Herring | 0c3f061 | 2013-09-17 10:42:50 -0500 | [diff] [blame] | 586 | #if defined(CONFIG_OF) && defined(CONFIG_NUMA) |
| 587 | extern int of_node_to_nid(struct device_node *np); |
| 588 | #else |
| 589 | static inline int of_node_to_nid(struct device_node *device) { return 0; } |
Paul Mundt | 5ca4db6 | 2012-06-03 22:04:34 -0700 | [diff] [blame] | 590 | #endif |
| 591 | |
Jean-Christophe PLAGNIOL-VILLARD | fa4d34c | 2012-02-07 12:12:51 +0800 | [diff] [blame] | 592 | /** |
| 593 | * of_property_read_bool - Findfrom a property |
| 594 | * @np: device node from which the property value is to be read. |
| 595 | * @propname: name of the property to be searched. |
| 596 | * |
| 597 | * Search for a property in a device node. |
| 598 | * Returns true if the property exist false otherwise. |
| 599 | */ |
| 600 | static inline bool of_property_read_bool(const struct device_node *np, |
| 601 | const char *propname) |
| 602 | { |
| 603 | struct property *prop = of_find_property(np, propname, NULL); |
| 604 | |
| 605 | return prop ? true : false; |
| 606 | } |
| 607 | |
Viresh Kumar | be19324 | 2012-11-20 10:15:19 +0530 | [diff] [blame] | 608 | static inline int of_property_read_u8(const struct device_node *np, |
| 609 | const char *propname, |
| 610 | u8 *out_value) |
| 611 | { |
| 612 | return of_property_read_u8_array(np, propname, out_value, 1); |
| 613 | } |
| 614 | |
| 615 | static inline int of_property_read_u16(const struct device_node *np, |
| 616 | const char *propname, |
| 617 | u16 *out_value) |
| 618 | { |
| 619 | return of_property_read_u16_array(np, propname, out_value, 1); |
| 620 | } |
| 621 | |
Shawn Guo | b98c023 | 2011-07-08 16:27:33 +0800 | [diff] [blame] | 622 | static inline int of_property_read_u32(const struct device_node *np, |
Jamie Iles | aac285c | 2011-08-02 15:45:07 +0100 | [diff] [blame] | 623 | const char *propname, |
Shawn Guo | b98c023 | 2011-07-08 16:27:33 +0800 | [diff] [blame] | 624 | u32 *out_value) |
| 625 | { |
| 626 | return of_property_read_u32_array(np, propname, out_value, 1); |
| 627 | } |
| 628 | |
Sebastian Andrzej Siewior | 2adfffa | 2013-06-17 16:48:13 +0200 | [diff] [blame] | 629 | #define of_property_for_each_u32(np, propname, prop, p, u) \ |
| 630 | for (prop = of_find_property(np, propname, NULL), \ |
| 631 | p = of_prop_next_u32(prop, NULL, &u); \ |
| 632 | p; \ |
| 633 | p = of_prop_next_u32(prop, p, &u)) |
| 634 | |
| 635 | #define of_property_for_each_string(np, propname, prop, s) \ |
| 636 | for (prop = of_find_property(np, propname, NULL), \ |
| 637 | s = of_prop_next_string(prop, NULL); \ |
| 638 | s; \ |
| 639 | s = of_prop_next_string(prop, s)) |
| 640 | |
David Howells | 34db8aa | 2013-04-12 02:29:19 +0100 | [diff] [blame] | 641 | #if defined(CONFIG_PROC_FS) && defined(CONFIG_PROC_DEVICETREE) |
| 642 | extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *); |
| 643 | extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop); |
| 644 | extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde, |
| 645 | struct property *prop); |
| 646 | extern void proc_device_tree_update_prop(struct proc_dir_entry *pde, |
| 647 | struct property *newprop, |
| 648 | struct property *oldprop); |
| 649 | #endif |
| 650 | |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 651 | #endif /* _LINUX_OF_H */ |