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 | 75b57ec | 2014-02-20 18:02:11 +0000 | [diff] [blame] | 21 | #include <linux/kobject.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; |
Grant Likely | 75b57ec | 2014-02-20 18:02:11 +0000 | [diff] [blame] | 40 | struct bin_attribute attr; |
Grant Likely | 731581e | 2009-10-15 10:57:46 -0600 | [diff] [blame] | 41 | }; |
| 42 | |
Grant Likely | 6f19249 | 2009-10-15 10:57:49 -0600 | [diff] [blame] | 43 | #if defined(CONFIG_SPARC) |
| 44 | struct of_irq_controller; |
| 45 | #endif |
| 46 | |
| 47 | struct device_node { |
| 48 | const char *name; |
| 49 | const char *type; |
Grant Likely | 6016a36 | 2010-01-28 14:06:53 -0700 | [diff] [blame] | 50 | phandle phandle; |
Grant Likely | c22618a | 2012-11-14 22:37:12 +0000 | [diff] [blame] | 51 | const char *full_name; |
Grant Likely | 6f19249 | 2009-10-15 10:57:49 -0600 | [diff] [blame] | 52 | |
| 53 | struct property *properties; |
| 54 | struct property *deadprops; /* removed properties */ |
| 55 | struct device_node *parent; |
| 56 | struct device_node *child; |
| 57 | struct device_node *sibling; |
| 58 | struct device_node *next; /* next device of same type */ |
Grant Likely | 75b57ec | 2014-02-20 18:02:11 +0000 | [diff] [blame] | 59 | struct kobject kobj; |
Grant Likely | 6f19249 | 2009-10-15 10:57:49 -0600 | [diff] [blame] | 60 | unsigned long _flags; |
| 61 | void *data; |
| 62 | #if defined(CONFIG_SPARC) |
Grant Likely | c22618a | 2012-11-14 22:37:12 +0000 | [diff] [blame] | 63 | const char *path_component_name; |
Grant Likely | 6f19249 | 2009-10-15 10:57:49 -0600 | [diff] [blame] | 64 | unsigned int unique_id; |
| 65 | struct of_irq_controller *irq_trans; |
| 66 | #endif |
| 67 | }; |
| 68 | |
Andreas Herrmann | b66548e | 2014-01-17 12:08:30 +0100 | [diff] [blame] | 69 | #define MAX_PHANDLE_ARGS 16 |
Grant Likely | 15c9a0a | 2011-12-12 09:25:57 -0700 | [diff] [blame] | 70 | struct of_phandle_args { |
| 71 | struct device_node *np; |
| 72 | int args_count; |
| 73 | uint32_t args[MAX_PHANDLE_ARGS]; |
| 74 | }; |
| 75 | |
Grant Likely | f5242e5 | 2014-11-24 17:58:01 +0000 | [diff] [blame^] | 76 | struct of_reconfig_data { |
| 77 | struct device_node *dn; |
| 78 | struct property *prop; |
| 79 | struct property *old_prop; |
| 80 | }; |
| 81 | |
Pantelis Antoniou | 0829f6d | 2013-12-13 20:08:59 +0200 | [diff] [blame] | 82 | /* initialize a node */ |
| 83 | extern struct kobj_type of_node_ktype; |
| 84 | static inline void of_node_init(struct device_node *node) |
| 85 | { |
| 86 | kobject_init(&node->kobj, &of_node_ktype); |
| 87 | } |
| 88 | |
| 89 | /* true when node is initialized */ |
| 90 | static inline int of_node_is_initialized(struct device_node *node) |
| 91 | { |
| 92 | return node && node->kobj.state_initialized; |
| 93 | } |
| 94 | |
| 95 | /* true when node is attached (i.e. present on sysfs) */ |
| 96 | static inline int of_node_is_attached(struct device_node *node) |
| 97 | { |
| 98 | return node && node->kobj.state_in_sysfs; |
| 99 | } |
| 100 | |
Grant Likely | 0f22dd3 | 2012-02-15 20:38:40 -0700 | [diff] [blame] | 101 | #ifdef CONFIG_OF_DYNAMIC |
| 102 | extern struct device_node *of_node_get(struct device_node *node); |
| 103 | extern void of_node_put(struct device_node *node); |
| 104 | #else /* CONFIG_OF_DYNAMIC */ |
Rob Herring | 3ecdd05 | 2011-12-13 09:13:54 -0600 | [diff] [blame] | 105 | /* Dummy ref counting routines - to be implemented later */ |
| 106 | static inline struct device_node *of_node_get(struct device_node *node) |
| 107 | { |
| 108 | return node; |
| 109 | } |
Grant Likely | 0f22dd3 | 2012-02-15 20:38:40 -0700 | [diff] [blame] | 110 | static inline void of_node_put(struct device_node *node) { } |
| 111 | #endif /* !CONFIG_OF_DYNAMIC */ |
Rob Herring | 3ecdd05 | 2011-12-13 09:13:54 -0600 | [diff] [blame] | 112 | |
Grant Likely | c9e358d | 2011-01-21 09:24:48 -0700 | [diff] [blame] | 113 | #ifdef CONFIG_OF |
| 114 | |
Grant Likely | 41f8800 | 2009-11-23 20:07:01 -0700 | [diff] [blame] | 115 | /* Pointer for first entry in chain of all nodes. */ |
Grant Likely | 5063e25 | 2014-10-03 16:28:27 +0100 | [diff] [blame] | 116 | extern struct device_node *of_root; |
Grant Likely | fc0bdae | 2010-02-14 07:13:55 -0700 | [diff] [blame] | 117 | extern struct device_node *of_chosen; |
Shawn Guo | 611cad7 | 2011-08-15 15:28:14 +0800 | [diff] [blame] | 118 | extern struct device_node *of_aliases; |
Grant Likely | a752ee5 | 2014-03-28 08:12:18 -0700 | [diff] [blame] | 119 | extern struct device_node *of_stdout; |
Thomas Gleixner | d6d3c4e | 2013-02-06 15:30:56 -0500 | [diff] [blame] | 120 | extern raw_spinlock_t devtree_lock; |
Grant Likely | 41f8800 | 2009-11-23 20:07:01 -0700 | [diff] [blame] | 121 | |
Sebastian Andrzej Siewior | 3bcbaf6 | 2011-02-22 21:07:46 +0100 | [diff] [blame] | 122 | static inline bool of_have_populated_dt(void) |
| 123 | { |
Grant Likely | 5063e25 | 2014-10-03 16:28:27 +0100 | [diff] [blame] | 124 | return of_root != NULL; |
Sebastian Andrzej Siewior | 3bcbaf6 | 2011-02-22 21:07:46 +0100 | [diff] [blame] | 125 | } |
| 126 | |
Andres Salomon | 035ebef | 2010-07-13 09:42:26 +0000 | [diff] [blame] | 127 | static inline bool of_node_is_root(const struct device_node *node) |
| 128 | { |
| 129 | return node && (node->parent == NULL); |
| 130 | } |
| 131 | |
Grant Likely | 5043631 | 2009-10-15 10:57:58 -0600 | [diff] [blame] | 132 | static inline int of_node_check_flag(struct device_node *n, unsigned long flag) |
| 133 | { |
| 134 | return test_bit(flag, &n->_flags); |
| 135 | } |
| 136 | |
Pawel Moll | c6e126d | 2014-05-15 16:55:24 +0100 | [diff] [blame] | 137 | static inline int of_node_test_and_set_flag(struct device_node *n, |
| 138 | unsigned long flag) |
| 139 | { |
| 140 | return test_and_set_bit(flag, &n->_flags); |
| 141 | } |
| 142 | |
Grant Likely | 5043631 | 2009-10-15 10:57:58 -0600 | [diff] [blame] | 143 | static inline void of_node_set_flag(struct device_node *n, unsigned long flag) |
| 144 | { |
| 145 | set_bit(flag, &n->_flags); |
| 146 | } |
| 147 | |
Pantelis Antoniou | 588453c | 2013-11-08 17:03:56 +0200 | [diff] [blame] | 148 | static inline void of_node_clear_flag(struct device_node *n, unsigned long flag) |
| 149 | { |
| 150 | clear_bit(flag, &n->_flags); |
| 151 | } |
| 152 | |
| 153 | static inline int of_property_check_flag(struct property *p, unsigned long flag) |
| 154 | { |
| 155 | return test_bit(flag, &p->_flags); |
| 156 | } |
| 157 | |
| 158 | static inline void of_property_set_flag(struct property *p, unsigned long flag) |
| 159 | { |
| 160 | set_bit(flag, &p->_flags); |
| 161 | } |
| 162 | |
| 163 | static inline void of_property_clear_flag(struct property *p, unsigned long flag) |
| 164 | { |
| 165 | clear_bit(flag, &p->_flags); |
| 166 | } |
| 167 | |
Grant Likely | 5063e25 | 2014-10-03 16:28:27 +0100 | [diff] [blame] | 168 | extern struct device_node *__of_find_all_nodes(struct device_node *prev); |
Grant Likely | e91edcf | 2009-10-15 10:58:09 -0600 | [diff] [blame] | 169 | extern struct device_node *of_find_all_nodes(struct device_node *prev); |
| 170 | |
Grant Likely | b6caf2a | 2009-10-15 10:58:00 -0600 | [diff] [blame] | 171 | /* |
Lennert Buytenhek | 3d6b882 | 2011-02-22 18:18:51 +0100 | [diff] [blame] | 172 | * OF address retrieval & translation |
Grant Likely | b6caf2a | 2009-10-15 10:58:00 -0600 | [diff] [blame] | 173 | */ |
| 174 | |
| 175 | /* Helper to read a big number; size is in cells (not bytes) */ |
Jeremy Kerr | 2e89e68 | 2010-01-30 01:41:49 -0700 | [diff] [blame] | 176 | static inline u64 of_read_number(const __be32 *cell, int size) |
Grant Likely | b6caf2a | 2009-10-15 10:58:00 -0600 | [diff] [blame] | 177 | { |
| 178 | u64 r = 0; |
| 179 | while (size--) |
Jeremy Kerr | 2e89e68 | 2010-01-30 01:41:49 -0700 | [diff] [blame] | 180 | r = (r << 32) | be32_to_cpu(*(cell++)); |
Grant Likely | b6caf2a | 2009-10-15 10:58:00 -0600 | [diff] [blame] | 181 | return r; |
| 182 | } |
| 183 | |
| 184 | /* Like of_read_number, but we want an unsigned long result */ |
Jeremy Kerr | 2e89e68 | 2010-01-30 01:41:49 -0700 | [diff] [blame] | 185 | static inline unsigned long of_read_ulong(const __be32 *cell, int size) |
Grant Likely | b6caf2a | 2009-10-15 10:58:00 -0600 | [diff] [blame] | 186 | { |
Grant Likely | 2be09cb | 2009-11-23 20:16:46 -0700 | [diff] [blame] | 187 | /* toss away upper bits if unsigned long is smaller than u64 */ |
| 188 | return of_read_number(cell, size); |
Grant Likely | b6caf2a | 2009-10-15 10:58:00 -0600 | [diff] [blame] | 189 | } |
Grant Likely | b6caf2a | 2009-10-15 10:58:00 -0600 | [diff] [blame] | 190 | |
Rob Herring | b5b4bb3 | 2013-09-07 14:08:20 -0500 | [diff] [blame] | 191 | #if defined(CONFIG_SPARC) |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 192 | #include <asm/prom.h> |
Rob Herring | b5b4bb3 | 2013-09-07 14:08:20 -0500 | [diff] [blame] | 193 | #endif |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 194 | |
Grant Likely | 7c7b60c | 2010-02-14 07:13:50 -0700 | [diff] [blame] | 195 | /* Default #address and #size cells. Allow arch asm/prom.h to override */ |
| 196 | #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT) |
| 197 | #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1 |
| 198 | #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1 |
| 199 | #endif |
| 200 | |
| 201 | /* Default string compare functions, Allow arch asm/prom.h to override */ |
| 202 | #if !defined(of_compat_cmp) |
Grant Likely | 1976152 | 2010-03-18 07:30:31 -0600 | [diff] [blame] | 203 | #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2)) |
Grant Likely | 7c7b60c | 2010-02-14 07:13:50 -0700 | [diff] [blame] | 204 | #define of_prop_cmp(s1, s2) strcmp((s1), (s2)) |
| 205 | #define of_node_cmp(s1, s2) strcasecmp((s1), (s2)) |
| 206 | #endif |
| 207 | |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 208 | /* flag descriptions */ |
| 209 | #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */ |
| 210 | #define OF_DETACHED 2 /* node has been detached from the device tree */ |
Pawel Moll | c6e126d | 2014-05-15 16:55:24 +0100 | [diff] [blame] | 211 | #define OF_POPULATED 3 /* device already created for the node */ |
Grant Likely | 75f353b | 2014-06-24 16:13:47 +0100 | [diff] [blame] | 212 | #define OF_POPULATED_BUS 4 /* of_platform_populate recursed to children of this node */ |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 213 | |
Grant Likely | 61e955d | 2009-10-15 10:57:51 -0600 | [diff] [blame] | 214 | #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags) |
| 215 | #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags) |
| 216 | |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 217 | #define OF_BAD_ADDR ((u64)-1) |
| 218 | |
Steffen Trumtrar | c0a05bf | 2012-12-18 11:32:03 +0100 | [diff] [blame] | 219 | 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] | 220 | { |
| 221 | return np ? np->full_name : "<no-node>"; |
| 222 | } |
| 223 | |
Grant Likely | 5063e25 | 2014-10-03 16:28:27 +0100 | [diff] [blame] | 224 | #define for_each_of_allnodes_from(from, dn) \ |
| 225 | for (dn = __of_find_all_nodes(from); dn; dn = __of_find_all_nodes(dn)) |
| 226 | #define for_each_of_allnodes(dn) for_each_of_allnodes_from(NULL, dn) |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 227 | extern struct device_node *of_find_node_by_name(struct device_node *from, |
| 228 | const char *name); |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 229 | extern struct device_node *of_find_node_by_type(struct device_node *from, |
| 230 | const char *type); |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 231 | extern struct device_node *of_find_compatible_node(struct device_node *from, |
| 232 | const char *type, const char *compat); |
Stephen Warren | 50c8af4 | 2012-11-20 16:12:20 -0700 | [diff] [blame] | 233 | extern struct device_node *of_find_matching_node_and_match( |
| 234 | struct device_node *from, |
| 235 | const struct of_device_id *matches, |
| 236 | const struct of_device_id **match); |
Rob Herring | 662372e | 2014-02-03 08:53:44 -0600 | [diff] [blame] | 237 | |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 238 | extern struct device_node *of_find_node_by_path(const char *path); |
| 239 | extern struct device_node *of_find_node_by_phandle(phandle handle); |
| 240 | extern struct device_node *of_get_parent(const struct device_node *node); |
Michael Ellerman | f4eb010 | 2007-10-26 16:54:31 +1000 | [diff] [blame] | 241 | extern struct device_node *of_get_next_parent(struct device_node *node); |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 242 | extern struct device_node *of_get_next_child(const struct device_node *node, |
| 243 | struct device_node *prev); |
Timur Tabi | 3296193 | 2012-08-14 13:20:23 +0000 | [diff] [blame] | 244 | extern struct device_node *of_get_next_available_child( |
| 245 | const struct device_node *node, struct device_node *prev); |
| 246 | |
Srinivas Kandagatla | 9c19761 | 2012-09-18 08:10:28 +0100 | [diff] [blame] | 247 | extern struct device_node *of_get_child_by_name(const struct device_node *node, |
| 248 | const char *name); |
Bryan Wu | 954e04b | 2013-09-24 10:38:26 -0700 | [diff] [blame] | 249 | |
Sudeep KarkadaNagesha | a3e31b4 | 2013-09-18 11:53:05 +0100 | [diff] [blame] | 250 | /* cache lookup */ |
| 251 | 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] | 252 | extern struct device_node *of_find_node_with_property( |
| 253 | struct device_node *from, const char *prop_name); |
Michael Ellerman | 1e291b1 | 2008-11-12 18:54:42 +0000 | [diff] [blame] | 254 | |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 255 | extern struct property *of_find_property(const struct device_node *np, |
| 256 | const char *name, |
| 257 | int *lenp); |
Heiko Stuebner | ad54a0c | 2014-02-12 01:00:34 +0100 | [diff] [blame] | 258 | extern int of_property_count_elems_of_size(const struct device_node *np, |
| 259 | const char *propname, int elem_size); |
Tony Prisk | 3daf372 | 2013-03-23 17:02:15 +1300 | [diff] [blame] | 260 | extern int of_property_read_u32_index(const struct device_node *np, |
| 261 | const char *propname, |
| 262 | u32 index, u32 *out_value); |
Viresh Kumar | be19324 | 2012-11-20 10:15:19 +0530 | [diff] [blame] | 263 | extern int of_property_read_u8_array(const struct device_node *np, |
| 264 | const char *propname, u8 *out_values, size_t sz); |
| 265 | extern int of_property_read_u16_array(const struct device_node *np, |
| 266 | const char *propname, u16 *out_values, size_t sz); |
Rob Herring | 0e37363 | 2011-07-06 15:42:58 -0500 | [diff] [blame] | 267 | extern int of_property_read_u32_array(const struct device_node *np, |
Jamie Iles | aac285c | 2011-08-02 15:45:07 +0100 | [diff] [blame] | 268 | const char *propname, |
Rob Herring | 0e37363 | 2011-07-06 15:42:58 -0500 | [diff] [blame] | 269 | u32 *out_values, |
| 270 | size_t sz); |
Jamie Iles | 4cd7f7a | 2011-09-14 20:49:59 +0100 | [diff] [blame] | 271 | extern int of_property_read_u64(const struct device_node *np, |
| 272 | const char *propname, u64 *out_value); |
Rob Herring | 0e37363 | 2011-07-06 15:42:58 -0500 | [diff] [blame] | 273 | |
Jamie Iles | aac285c | 2011-08-02 15:45:07 +0100 | [diff] [blame] | 274 | extern int of_property_read_string(struct device_node *np, |
| 275 | const char *propname, |
| 276 | const char **out_string); |
Grant Likely | 7aff0fe | 2011-12-12 09:25:58 -0700 | [diff] [blame] | 277 | extern int of_property_match_string(struct device_node *np, |
| 278 | const char *propname, |
| 279 | const char *string); |
Grant Likely | a87fa1d | 2014-11-03 15:15:35 +0000 | [diff] [blame] | 280 | extern int of_property_read_string_helper(struct device_node *np, |
| 281 | const char *propname, |
| 282 | const char **out_strs, size_t sz, int index); |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 283 | extern int of_device_is_compatible(const struct device_node *device, |
| 284 | const char *); |
Kevin Cernekee | 53a4ab9 | 2014-11-12 12:54:01 -0800 | [diff] [blame] | 285 | extern bool of_device_is_available(const struct device_node *device); |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 286 | extern const void *of_get_property(const struct device_node *node, |
| 287 | const char *name, |
| 288 | int *lenp); |
Sudeep KarkadaNagesha | 183912d | 2013-08-15 14:01:40 +0100 | [diff] [blame] | 289 | 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] | 290 | #define for_each_property_of_node(dn, pp) \ |
| 291 | for (pp = dn->properties; pp != NULL; pp = pp->next) |
Shawn Guo | 611cad7 | 2011-08-15 15:28:14 +0800 | [diff] [blame] | 292 | |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 293 | extern int of_n_addr_cells(struct device_node *np); |
| 294 | extern int of_n_size_cells(struct device_node *np); |
Grant Likely | 283029d | 2008-01-09 06:20:40 +1100 | [diff] [blame] | 295 | extern const struct of_device_id *of_match_node( |
| 296 | const struct of_device_id *matches, const struct device_node *node); |
Grant Likely | 3f07af4 | 2008-07-25 22:25:13 -0400 | [diff] [blame] | 297 | 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] | 298 | 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] | 299 | extern struct device_node *of_parse_phandle(const struct device_node *np, |
Grant Likely | 739649c | 2009-04-25 12:52:40 +0000 | [diff] [blame] | 300 | const char *phandle_name, |
| 301 | int index); |
Guennadi Liakhovetski | 93c667c | 2012-12-10 20:41:30 +0100 | [diff] [blame] | 302 | extern int of_parse_phandle_with_args(const struct device_node *np, |
Anton Vorontsov | 64b60e0 | 2008-10-10 04:43:17 +0000 | [diff] [blame] | 303 | const char *list_name, const char *cells_name, int index, |
Grant Likely | 15c9a0a | 2011-12-12 09:25:57 -0700 | [diff] [blame] | 304 | struct of_phandle_args *out_args); |
Stephen Warren | 035fd94 | 2013-08-14 15:27:10 -0600 | [diff] [blame] | 305 | extern int of_parse_phandle_with_fixed_args(const struct device_node *np, |
| 306 | const char *list_name, int cells_count, int index, |
| 307 | struct of_phandle_args *out_args); |
Grant Likely | bd69f73 | 2013-02-10 22:57:21 +0000 | [diff] [blame] | 308 | extern int of_count_phandle_with_args(const struct device_node *np, |
| 309 | const char *list_name, const char *cells_name); |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 310 | |
Shawn Guo | 611cad7 | 2011-08-15 15:28:14 +0800 | [diff] [blame] | 311 | extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align)); |
| 312 | extern int of_alias_get_id(struct device_node *np, const char *stem); |
| 313 | |
Grant Likely | 21b082e | 2010-02-14 07:13:38 -0700 | [diff] [blame] | 314 | extern int of_machine_is_compatible(const char *compat); |
| 315 | |
Nathan Fontenot | 79d1c71 | 2012-10-02 16:58:46 +0000 | [diff] [blame] | 316 | extern int of_add_property(struct device_node *np, struct property *prop); |
| 317 | extern int of_remove_property(struct device_node *np, struct property *prop); |
| 318 | extern int of_update_property(struct device_node *np, struct property *newprop); |
Grant Likely | 21b082e | 2010-02-14 07:13:38 -0700 | [diff] [blame] | 319 | |
Grant Likely | fcdeb7f | 2010-01-29 05:04:33 -0700 | [diff] [blame] | 320 | /* For updating the device tree at runtime */ |
Nathan Fontenot | 1cf3d8b | 2012-10-02 16:57:57 +0000 | [diff] [blame] | 321 | #define OF_RECONFIG_ATTACH_NODE 0x0001 |
| 322 | #define OF_RECONFIG_DETACH_NODE 0x0002 |
| 323 | #define OF_RECONFIG_ADD_PROPERTY 0x0003 |
| 324 | #define OF_RECONFIG_REMOVE_PROPERTY 0x0004 |
| 325 | #define OF_RECONFIG_UPDATE_PROPERTY 0x0005 |
| 326 | |
Nathan Fontenot | 1cf3d8b | 2012-10-02 16:57:57 +0000 | [diff] [blame] | 327 | extern int of_attach_node(struct device_node *); |
| 328 | extern int of_detach_node(struct device_node *); |
Grant Likely | fcdeb7f | 2010-01-29 05:04:33 -0700 | [diff] [blame] | 329 | |
Ben Dooks | 3a1e362 | 2011-08-03 10:11:42 +0100 | [diff] [blame] | 330 | #define of_match_ptr(_ptr) (_ptr) |
Stephen Warren | c541adc | 2012-04-04 09:27:46 -0600 | [diff] [blame] | 331 | |
| 332 | /* |
| 333 | * struct property *prop; |
| 334 | * const __be32 *p; |
| 335 | * u32 u; |
| 336 | * |
| 337 | * of_property_for_each_u32(np, "propname", prop, p, u) |
| 338 | * printk("U32 value: %x\n", u); |
| 339 | */ |
| 340 | const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur, |
| 341 | u32 *pu); |
Stephen Warren | c541adc | 2012-04-04 09:27:46 -0600 | [diff] [blame] | 342 | /* |
| 343 | * struct property *prop; |
| 344 | * const char *s; |
| 345 | * |
| 346 | * of_property_for_each_string(np, "propname", prop, s) |
| 347 | * printk("String value: %s\n", s); |
| 348 | */ |
| 349 | const char *of_prop_next_string(struct property *prop, const char *cur); |
Stephen Warren | c541adc | 2012-04-04 09:27:46 -0600 | [diff] [blame] | 350 | |
Grant Likely | 3482f2c | 2014-03-27 17:18:55 -0700 | [diff] [blame] | 351 | bool of_console_check(struct device_node *dn, char *name, int index); |
Sascha Hauer | 5c19e95 | 2013-08-05 14:40:44 +0200 | [diff] [blame] | 352 | |
Shawn Guo | b98c023 | 2011-07-08 16:27:33 +0800 | [diff] [blame] | 353 | #else /* CONFIG_OF */ |
Sebastian Andrzej Siewior | 3bcbaf6 | 2011-02-22 21:07:46 +0100 | [diff] [blame] | 354 | |
Stephen Rothwell | 4c358e1 | 2014-05-15 14:44:30 +1000 | [diff] [blame] | 355 | 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] | 356 | { |
| 357 | return "<no-node>"; |
| 358 | } |
| 359 | |
Peter Ujfalusi | 1cc44f4 | 2012-09-10 13:46:24 +0300 | [diff] [blame] | 360 | static inline struct device_node *of_find_node_by_name(struct device_node *from, |
| 361 | const char *name) |
| 362 | { |
| 363 | return NULL; |
| 364 | } |
| 365 | |
Rob Herring | 662372e | 2014-02-03 08:53:44 -0600 | [diff] [blame] | 366 | static inline struct device_node *of_find_node_by_type(struct device_node *from, |
| 367 | const char *type) |
| 368 | { |
| 369 | return NULL; |
| 370 | } |
| 371 | |
| 372 | static inline struct device_node *of_find_matching_node_and_match( |
| 373 | struct device_node *from, |
| 374 | const struct of_device_id *matches, |
| 375 | const struct of_device_id **match) |
| 376 | { |
| 377 | return NULL; |
| 378 | } |
| 379 | |
Alexander Shiyan | 20cd477 | 2014-04-16 10:49:20 +0400 | [diff] [blame] | 380 | static inline struct device_node *of_find_node_by_path(const char *path) |
| 381 | { |
| 382 | return NULL; |
| 383 | } |
| 384 | |
Alexander Shiyan | 066ec1d | 2013-04-09 19:47:40 +0400 | [diff] [blame] | 385 | static inline struct device_node *of_get_parent(const struct device_node *node) |
| 386 | { |
| 387 | return NULL; |
| 388 | } |
| 389 | |
Rob Herring | 662372e | 2014-02-03 08:53:44 -0600 | [diff] [blame] | 390 | static inline struct device_node *of_get_next_child( |
| 391 | const struct device_node *node, struct device_node *prev) |
| 392 | { |
| 393 | return NULL; |
| 394 | } |
| 395 | |
| 396 | static inline struct device_node *of_get_next_available_child( |
| 397 | const struct device_node *node, struct device_node *prev) |
| 398 | { |
| 399 | return NULL; |
| 400 | } |
| 401 | |
| 402 | static inline struct device_node *of_find_node_with_property( |
| 403 | struct device_node *from, const char *prop_name) |
| 404 | { |
| 405 | return NULL; |
| 406 | } |
| 407 | |
Sebastian Andrzej Siewior | 3bcbaf6 | 2011-02-22 21:07:46 +0100 | [diff] [blame] | 408 | static inline bool of_have_populated_dt(void) |
| 409 | { |
| 410 | return false; |
| 411 | } |
| 412 | |
Olof Johansson | 25c040c | 2012-10-07 10:40:54 -0700 | [diff] [blame] | 413 | static inline struct device_node *of_get_child_by_name( |
| 414 | const struct device_node *node, |
| 415 | const char *name) |
| 416 | { |
| 417 | return NULL; |
| 418 | } |
| 419 | |
Rajendra Nayak | 36a0904 | 2011-10-10 21:49:35 +0530 | [diff] [blame] | 420 | static inline int of_device_is_compatible(const struct device_node *device, |
| 421 | const char *name) |
| 422 | { |
| 423 | return 0; |
| 424 | } |
| 425 | |
Kevin Cernekee | 53a4ab9 | 2014-11-12 12:54:01 -0800 | [diff] [blame] | 426 | static inline bool of_device_is_available(const struct device_node *device) |
Rob Herring | d719569 | 2013-03-20 16:56:18 -0500 | [diff] [blame] | 427 | { |
Kevin Cernekee | 53a4ab9 | 2014-11-12 12:54:01 -0800 | [diff] [blame] | 428 | return false; |
Rob Herring | d719569 | 2013-03-20 16:56:18 -0500 | [diff] [blame] | 429 | } |
| 430 | |
Stephen Warren | aba3dff | 2011-09-21 13:23:10 -0600 | [diff] [blame] | 431 | static inline struct property *of_find_property(const struct device_node *np, |
| 432 | const char *name, |
| 433 | int *lenp) |
| 434 | { |
| 435 | return NULL; |
| 436 | } |
| 437 | |
Shawn Guo | 2261cc6 | 2012-02-15 10:47:42 -0800 | [diff] [blame] | 438 | static inline struct device_node *of_find_compatible_node( |
| 439 | struct device_node *from, |
| 440 | const char *type, |
| 441 | const char *compat) |
| 442 | { |
| 443 | return NULL; |
| 444 | } |
| 445 | |
Heiko Stuebner | ad54a0c | 2014-02-12 01:00:34 +0100 | [diff] [blame] | 446 | static inline int of_property_count_elems_of_size(const struct device_node *np, |
| 447 | const char *propname, int elem_size) |
| 448 | { |
| 449 | return -ENOSYS; |
| 450 | } |
| 451 | |
Tony Prisk | 3daf372 | 2013-03-23 17:02:15 +1300 | [diff] [blame] | 452 | static inline int of_property_read_u32_index(const struct device_node *np, |
| 453 | const char *propname, u32 index, u32 *out_value) |
| 454 | { |
| 455 | return -ENOSYS; |
| 456 | } |
| 457 | |
Viresh Kumar | be19324 | 2012-11-20 10:15:19 +0530 | [diff] [blame] | 458 | static inline int of_property_read_u8_array(const struct device_node *np, |
| 459 | const char *propname, u8 *out_values, size_t sz) |
| 460 | { |
| 461 | return -ENOSYS; |
| 462 | } |
| 463 | |
| 464 | static inline int of_property_read_u16_array(const struct device_node *np, |
| 465 | const char *propname, u16 *out_values, size_t sz) |
| 466 | { |
| 467 | return -ENOSYS; |
| 468 | } |
| 469 | |
Shawn Guo | b98c023 | 2011-07-08 16:27:33 +0800 | [diff] [blame] | 470 | 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] | 471 | const char *propname, |
| 472 | u32 *out_values, size_t sz) |
Shawn Guo | b98c023 | 2011-07-08 16:27:33 +0800 | [diff] [blame] | 473 | { |
| 474 | return -ENOSYS; |
| 475 | } |
| 476 | |
| 477 | static inline int of_property_read_string(struct device_node *np, |
Jamie Iles | aac285c | 2011-08-02 15:45:07 +0100 | [diff] [blame] | 478 | const char *propname, |
| 479 | const char **out_string) |
Shawn Guo | b98c023 | 2011-07-08 16:27:33 +0800 | [diff] [blame] | 480 | { |
| 481 | return -ENOSYS; |
| 482 | } |
| 483 | |
Grant Likely | a87fa1d | 2014-11-03 15:15:35 +0000 | [diff] [blame] | 484 | static inline int of_property_read_string_helper(struct device_node *np, |
| 485 | const char *propname, |
| 486 | const char **out_strs, size_t sz, int index) |
Benoit Cousson | 4fcd15a | 2011-09-27 17:45:43 +0200 | [diff] [blame] | 487 | { |
| 488 | return -ENOSYS; |
| 489 | } |
| 490 | |
Stephen Warren | 89272b8 | 2011-08-05 16:50:30 -0600 | [diff] [blame] | 491 | static inline const void *of_get_property(const struct device_node *node, |
| 492 | const char *name, |
| 493 | int *lenp) |
| 494 | { |
| 495 | return NULL; |
| 496 | } |
| 497 | |
Sudeep KarkadaNagesha | 183912d | 2013-08-15 14:01:40 +0100 | [diff] [blame] | 498 | static inline struct device_node *of_get_cpu_node(int cpu, |
| 499 | unsigned int *thread) |
| 500 | { |
| 501 | return NULL; |
| 502 | } |
| 503 | |
Jamie Iles | 4cd7f7a | 2011-09-14 20:49:59 +0100 | [diff] [blame] | 504 | static inline int of_property_read_u64(const struct device_node *np, |
| 505 | const char *propname, u64 *out_value) |
| 506 | { |
| 507 | return -ENOSYS; |
| 508 | } |
| 509 | |
Thierry Reding | bd3d550 | 2012-04-13 16:18:34 +0200 | [diff] [blame] | 510 | static inline int of_property_match_string(struct device_node *np, |
| 511 | const char *propname, |
| 512 | const char *string) |
| 513 | { |
| 514 | return -ENOSYS; |
| 515 | } |
| 516 | |
Steffen Trumtrar | b8fbdc4 | 2012-11-22 12:16:43 +0100 | [diff] [blame] | 517 | 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] | 518 | const char *phandle_name, |
| 519 | int index) |
| 520 | { |
| 521 | return NULL; |
| 522 | } |
| 523 | |
Thierry Reding | e05e507 | 2012-04-13 16:19:21 +0200 | [diff] [blame] | 524 | static inline int of_parse_phandle_with_args(struct device_node *np, |
| 525 | const char *list_name, |
| 526 | const char *cells_name, |
| 527 | int index, |
| 528 | struct of_phandle_args *out_args) |
| 529 | { |
| 530 | return -ENOSYS; |
| 531 | } |
| 532 | |
Stephen Warren | 035fd94 | 2013-08-14 15:27:10 -0600 | [diff] [blame] | 533 | static inline int of_parse_phandle_with_fixed_args(const struct device_node *np, |
| 534 | const char *list_name, int cells_count, int index, |
| 535 | struct of_phandle_args *out_args) |
| 536 | { |
| 537 | return -ENOSYS; |
| 538 | } |
| 539 | |
Grant Likely | bd69f73 | 2013-02-10 22:57:21 +0000 | [diff] [blame] | 540 | static inline int of_count_phandle_with_args(struct device_node *np, |
| 541 | const char *list_name, |
| 542 | const char *cells_name) |
| 543 | { |
| 544 | return -ENOSYS; |
| 545 | } |
| 546 | |
Nicolas Ferre | ed5f886 | 2011-10-27 11:07:28 +0200 | [diff] [blame] | 547 | static inline int of_alias_get_id(struct device_node *np, const char *stem) |
| 548 | { |
| 549 | return -ENOSYS; |
| 550 | } |
| 551 | |
Stephen Warren | 50e07f8 | 2011-10-25 14:01:26 +0200 | [diff] [blame] | 552 | static inline int of_machine_is_compatible(const char *compat) |
| 553 | { |
| 554 | return 0; |
| 555 | } |
| 556 | |
Grant Likely | 3482f2c | 2014-03-27 17:18:55 -0700 | [diff] [blame] | 557 | static inline bool of_console_check(const struct device_node *dn, const char *name, int index) |
Sascha Hauer | 5c19e95 | 2013-08-05 14:40:44 +0200 | [diff] [blame] | 558 | { |
Grant Likely | 3482f2c | 2014-03-27 17:18:55 -0700 | [diff] [blame] | 559 | return false; |
Sascha Hauer | 5c19e95 | 2013-08-05 14:40:44 +0200 | [diff] [blame] | 560 | } |
| 561 | |
Sebastian Andrzej Siewior | 2adfffa | 2013-06-17 16:48:13 +0200 | [diff] [blame] | 562 | static inline const __be32 *of_prop_next_u32(struct property *prop, |
| 563 | const __be32 *cur, u32 *pu) |
| 564 | { |
| 565 | return NULL; |
| 566 | } |
| 567 | |
| 568 | static inline const char *of_prop_next_string(struct property *prop, |
| 569 | const char *cur) |
| 570 | { |
| 571 | return NULL; |
| 572 | } |
| 573 | |
Ben Dooks | 3a1e362 | 2011-08-03 10:11:42 +0100 | [diff] [blame] | 574 | #define of_match_ptr(_ptr) NULL |
Nicolas Ferre | 5762c20 | 2011-10-24 11:53:32 +0200 | [diff] [blame] | 575 | #define of_match_node(_matches, _node) NULL |
Jeremy Kerr | 9dfbf20 | 2010-02-14 07:13:43 -0700 | [diff] [blame] | 576 | #endif /* CONFIG_OF */ |
Shawn Guo | b98c023 | 2011-07-08 16:27:33 +0800 | [diff] [blame] | 577 | |
Rob Herring | 0c3f061 | 2013-09-17 10:42:50 -0500 | [diff] [blame] | 578 | #if defined(CONFIG_OF) && defined(CONFIG_NUMA) |
| 579 | extern int of_node_to_nid(struct device_node *np); |
| 580 | #else |
| 581 | 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] | 582 | #endif |
| 583 | |
Rob Herring | 662372e | 2014-02-03 08:53:44 -0600 | [diff] [blame] | 584 | static inline struct device_node *of_find_matching_node( |
| 585 | struct device_node *from, |
| 586 | const struct of_device_id *matches) |
| 587 | { |
| 588 | return of_find_matching_node_and_match(from, matches, NULL); |
| 589 | } |
| 590 | |
Jean-Christophe PLAGNIOL-VILLARD | fa4d34c | 2012-02-07 12:12:51 +0800 | [diff] [blame] | 591 | /** |
Heiko Stuebner | ad54a0c | 2014-02-12 01:00:34 +0100 | [diff] [blame] | 592 | * of_property_count_u8_elems - Count the number of u8 elements in a property |
| 593 | * |
| 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 and count the number of u8 elements |
| 598 | * in it. Returns number of elements on sucess, -EINVAL if the property does |
| 599 | * not exist or its length does not match a multiple of u8 and -ENODATA if the |
| 600 | * property does not have a value. |
| 601 | */ |
| 602 | static inline int of_property_count_u8_elems(const struct device_node *np, |
| 603 | const char *propname) |
| 604 | { |
| 605 | return of_property_count_elems_of_size(np, propname, sizeof(u8)); |
| 606 | } |
| 607 | |
| 608 | /** |
| 609 | * of_property_count_u16_elems - Count the number of u16 elements in a property |
| 610 | * |
| 611 | * @np: device node from which the property value is to be read. |
| 612 | * @propname: name of the property to be searched. |
| 613 | * |
| 614 | * Search for a property in a device node and count the number of u16 elements |
| 615 | * in it. Returns number of elements on sucess, -EINVAL if the property does |
| 616 | * not exist or its length does not match a multiple of u16 and -ENODATA if the |
| 617 | * property does not have a value. |
| 618 | */ |
| 619 | static inline int of_property_count_u16_elems(const struct device_node *np, |
| 620 | const char *propname) |
| 621 | { |
| 622 | return of_property_count_elems_of_size(np, propname, sizeof(u16)); |
| 623 | } |
| 624 | |
| 625 | /** |
| 626 | * of_property_count_u32_elems - Count the number of u32 elements in a property |
| 627 | * |
| 628 | * @np: device node from which the property value is to be read. |
| 629 | * @propname: name of the property to be searched. |
| 630 | * |
| 631 | * Search for a property in a device node and count the number of u32 elements |
| 632 | * in it. Returns number of elements on sucess, -EINVAL if the property does |
| 633 | * not exist or its length does not match a multiple of u32 and -ENODATA if the |
| 634 | * property does not have a value. |
| 635 | */ |
| 636 | static inline int of_property_count_u32_elems(const struct device_node *np, |
| 637 | const char *propname) |
| 638 | { |
| 639 | return of_property_count_elems_of_size(np, propname, sizeof(u32)); |
| 640 | } |
| 641 | |
| 642 | /** |
| 643 | * of_property_count_u64_elems - Count the number of u64 elements in a property |
| 644 | * |
| 645 | * @np: device node from which the property value is to be read. |
| 646 | * @propname: name of the property to be searched. |
| 647 | * |
| 648 | * Search for a property in a device node and count the number of u64 elements |
| 649 | * in it. Returns number of elements on sucess, -EINVAL if the property does |
| 650 | * not exist or its length does not match a multiple of u64 and -ENODATA if the |
| 651 | * property does not have a value. |
| 652 | */ |
| 653 | static inline int of_property_count_u64_elems(const struct device_node *np, |
| 654 | const char *propname) |
| 655 | { |
| 656 | return of_property_count_elems_of_size(np, propname, sizeof(u64)); |
| 657 | } |
| 658 | |
Jean-Christophe PLAGNIOL-VILLARD | fa4d34c | 2012-02-07 12:12:51 +0800 | [diff] [blame] | 659 | /** |
Grant Likely | a87fa1d | 2014-11-03 15:15:35 +0000 | [diff] [blame] | 660 | * of_property_read_string_array() - Read an array of strings from a multiple |
| 661 | * strings property. |
| 662 | * @np: device node from which the property value is to be read. |
| 663 | * @propname: name of the property to be searched. |
| 664 | * @out_strs: output array of string pointers. |
| 665 | * @sz: number of array elements to read. |
| 666 | * |
| 667 | * Search for a property in a device tree node and retrieve a list of |
| 668 | * terminated string values (pointer to data, not a copy) in that property. |
| 669 | * |
| 670 | * If @out_strs is NULL, the number of strings in the property is returned. |
| 671 | */ |
| 672 | static inline int of_property_read_string_array(struct device_node *np, |
| 673 | const char *propname, const char **out_strs, |
| 674 | size_t sz) |
| 675 | { |
| 676 | return of_property_read_string_helper(np, propname, out_strs, sz, 0); |
| 677 | } |
| 678 | |
| 679 | /** |
| 680 | * of_property_count_strings() - Find and return the number of strings from a |
| 681 | * multiple strings property. |
| 682 | * @np: device node from which the property value is to be read. |
| 683 | * @propname: name of the property to be searched. |
| 684 | * |
| 685 | * Search for a property in a device tree node and retrieve the number of null |
| 686 | * terminated string contain in it. Returns the number of strings on |
| 687 | * success, -EINVAL if the property does not exist, -ENODATA if property |
| 688 | * does not have a value, and -EILSEQ if the string is not null-terminated |
| 689 | * within the length of the property data. |
| 690 | */ |
| 691 | static inline int of_property_count_strings(struct device_node *np, |
| 692 | const char *propname) |
| 693 | { |
| 694 | return of_property_read_string_helper(np, propname, NULL, 0, 0); |
| 695 | } |
| 696 | |
| 697 | /** |
| 698 | * of_property_read_string_index() - Find and read a string from a multiple |
| 699 | * strings property. |
| 700 | * @np: device node from which the property value is to be read. |
| 701 | * @propname: name of the property to be searched. |
| 702 | * @index: index of the string in the list of strings |
| 703 | * @out_string: pointer to null terminated return string, modified only if |
| 704 | * return value is 0. |
| 705 | * |
| 706 | * Search for a property in a device tree node and retrieve a null |
| 707 | * terminated string value (pointer to data, not a copy) in the list of strings |
| 708 | * contained in that property. |
| 709 | * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if |
| 710 | * property does not have a value, and -EILSEQ if the string is not |
| 711 | * null-terminated within the length of the property data. |
| 712 | * |
| 713 | * The out_string pointer is modified only if a valid string can be decoded. |
| 714 | */ |
| 715 | static inline int of_property_read_string_index(struct device_node *np, |
| 716 | const char *propname, |
| 717 | int index, const char **output) |
| 718 | { |
| 719 | int rc = of_property_read_string_helper(np, propname, output, 1, index); |
| 720 | return rc < 0 ? rc : 0; |
| 721 | } |
| 722 | |
| 723 | /** |
Jean-Christophe PLAGNIOL-VILLARD | fa4d34c | 2012-02-07 12:12:51 +0800 | [diff] [blame] | 724 | * of_property_read_bool - Findfrom a property |
| 725 | * @np: device node from which the property value is to be read. |
| 726 | * @propname: name of the property to be searched. |
| 727 | * |
| 728 | * Search for a property in a device node. |
| 729 | * Returns true if the property exist false otherwise. |
| 730 | */ |
| 731 | static inline bool of_property_read_bool(const struct device_node *np, |
| 732 | const char *propname) |
| 733 | { |
| 734 | struct property *prop = of_find_property(np, propname, NULL); |
| 735 | |
| 736 | return prop ? true : false; |
| 737 | } |
| 738 | |
Viresh Kumar | be19324 | 2012-11-20 10:15:19 +0530 | [diff] [blame] | 739 | static inline int of_property_read_u8(const struct device_node *np, |
| 740 | const char *propname, |
| 741 | u8 *out_value) |
| 742 | { |
| 743 | return of_property_read_u8_array(np, propname, out_value, 1); |
| 744 | } |
| 745 | |
| 746 | static inline int of_property_read_u16(const struct device_node *np, |
| 747 | const char *propname, |
| 748 | u16 *out_value) |
| 749 | { |
| 750 | return of_property_read_u16_array(np, propname, out_value, 1); |
| 751 | } |
| 752 | |
Shawn Guo | b98c023 | 2011-07-08 16:27:33 +0800 | [diff] [blame] | 753 | static inline int of_property_read_u32(const struct device_node *np, |
Jamie Iles | aac285c | 2011-08-02 15:45:07 +0100 | [diff] [blame] | 754 | const char *propname, |
Shawn Guo | b98c023 | 2011-07-08 16:27:33 +0800 | [diff] [blame] | 755 | u32 *out_value) |
| 756 | { |
| 757 | return of_property_read_u32_array(np, propname, out_value, 1); |
| 758 | } |
| 759 | |
Sebastian Reichel | e7a00e4 | 2014-04-06 12:52:11 +0200 | [diff] [blame] | 760 | static inline int of_property_read_s32(const struct device_node *np, |
| 761 | const char *propname, |
| 762 | s32 *out_value) |
| 763 | { |
| 764 | return of_property_read_u32(np, propname, (u32*) out_value); |
| 765 | } |
| 766 | |
Sebastian Andrzej Siewior | 2adfffa | 2013-06-17 16:48:13 +0200 | [diff] [blame] | 767 | #define of_property_for_each_u32(np, propname, prop, p, u) \ |
| 768 | for (prop = of_find_property(np, propname, NULL), \ |
| 769 | p = of_prop_next_u32(prop, NULL, &u); \ |
| 770 | p; \ |
| 771 | p = of_prop_next_u32(prop, p, &u)) |
| 772 | |
| 773 | #define of_property_for_each_string(np, propname, prop, s) \ |
| 774 | for (prop = of_find_property(np, propname, NULL), \ |
| 775 | s = of_prop_next_string(prop, NULL); \ |
| 776 | s; \ |
| 777 | s = of_prop_next_string(prop, s)) |
| 778 | |
Rob Herring | 662372e | 2014-02-03 08:53:44 -0600 | [diff] [blame] | 779 | #define for_each_node_by_name(dn, name) \ |
| 780 | for (dn = of_find_node_by_name(NULL, name); dn; \ |
| 781 | dn = of_find_node_by_name(dn, name)) |
| 782 | #define for_each_node_by_type(dn, type) \ |
| 783 | for (dn = of_find_node_by_type(NULL, type); dn; \ |
| 784 | dn = of_find_node_by_type(dn, type)) |
| 785 | #define for_each_compatible_node(dn, type, compatible) \ |
| 786 | for (dn = of_find_compatible_node(NULL, type, compatible); dn; \ |
| 787 | dn = of_find_compatible_node(dn, type, compatible)) |
| 788 | #define for_each_matching_node(dn, matches) \ |
| 789 | for (dn = of_find_matching_node(NULL, matches); dn; \ |
| 790 | dn = of_find_matching_node(dn, matches)) |
| 791 | #define for_each_matching_node_and_match(dn, matches, match) \ |
| 792 | for (dn = of_find_matching_node_and_match(NULL, matches, match); \ |
| 793 | dn; dn = of_find_matching_node_and_match(dn, matches, match)) |
| 794 | |
| 795 | #define for_each_child_of_node(parent, child) \ |
| 796 | for (child = of_get_next_child(parent, NULL); child != NULL; \ |
| 797 | child = of_get_next_child(parent, child)) |
| 798 | #define for_each_available_child_of_node(parent, child) \ |
| 799 | for (child = of_get_next_available_child(parent, NULL); child != NULL; \ |
| 800 | child = of_get_next_available_child(parent, child)) |
| 801 | |
| 802 | #define for_each_node_with_property(dn, prop_name) \ |
| 803 | for (dn = of_find_node_with_property(NULL, prop_name); dn; \ |
| 804 | dn = of_find_node_with_property(dn, prop_name)) |
| 805 | |
| 806 | static inline int of_get_child_count(const struct device_node *np) |
| 807 | { |
| 808 | struct device_node *child; |
| 809 | int num = 0; |
| 810 | |
| 811 | for_each_child_of_node(np, child) |
| 812 | num++; |
| 813 | |
| 814 | return num; |
| 815 | } |
| 816 | |
| 817 | static inline int of_get_available_child_count(const struct device_node *np) |
| 818 | { |
| 819 | struct device_node *child; |
| 820 | int num = 0; |
| 821 | |
| 822 | for_each_available_child_of_node(np, child) |
| 823 | num++; |
| 824 | |
| 825 | return num; |
| 826 | } |
| 827 | |
Rob Herring | 54196cc | 2014-05-08 16:09:24 -0500 | [diff] [blame] | 828 | #ifdef CONFIG_OF |
| 829 | #define _OF_DECLARE(table, name, compat, fn, fn_type) \ |
| 830 | static const struct of_device_id __of_table_##name \ |
| 831 | __used __section(__##table##_of_table) \ |
| 832 | = { .compatible = compat, \ |
| 833 | .data = (fn == (fn_type)NULL) ? fn : fn } |
| 834 | #else |
Thierry Reding | 5f56358 | 2014-10-02 16:01:10 +0200 | [diff] [blame] | 835 | #define _OF_DECLARE(table, name, compat, fn, fn_type) \ |
Rob Herring | 54196cc | 2014-05-08 16:09:24 -0500 | [diff] [blame] | 836 | static const struct of_device_id __of_table_##name \ |
| 837 | __attribute__((unused)) \ |
| 838 | = { .compatible = compat, \ |
| 839 | .data = (fn == (fn_type)NULL) ? fn : fn } |
| 840 | #endif |
| 841 | |
| 842 | typedef int (*of_init_fn_2)(struct device_node *, struct device_node *); |
| 843 | typedef void (*of_init_fn_1)(struct device_node *); |
| 844 | |
| 845 | #define OF_DECLARE_1(table, name, compat, fn) \ |
| 846 | _OF_DECLARE(table, name, compat, fn, of_init_fn_1) |
| 847 | #define OF_DECLARE_2(table, name, compat, fn) \ |
| 848 | _OF_DECLARE(table, name, compat, fn, of_init_fn_2) |
| 849 | |
Pantelis Antoniou | 201c910 | 2014-07-04 19:58:49 +0300 | [diff] [blame] | 850 | /** |
| 851 | * struct of_changeset_entry - Holds a changeset entry |
| 852 | * |
| 853 | * @node: list_head for the log list |
| 854 | * @action: notifier action |
| 855 | * @np: pointer to the device node affected |
| 856 | * @prop: pointer to the property affected |
| 857 | * @old_prop: hold a pointer to the original property |
| 858 | * |
| 859 | * Every modification of the device tree during a changeset |
| 860 | * is held in a list of of_changeset_entry structures. |
| 861 | * That way we can recover from a partial application, or we can |
| 862 | * revert the changeset |
| 863 | */ |
| 864 | struct of_changeset_entry { |
| 865 | struct list_head node; |
| 866 | unsigned long action; |
| 867 | struct device_node *np; |
| 868 | struct property *prop; |
| 869 | struct property *old_prop; |
| 870 | }; |
| 871 | |
| 872 | /** |
| 873 | * struct of_changeset - changeset tracker structure |
| 874 | * |
| 875 | * @entries: list_head for the changeset entries |
| 876 | * |
| 877 | * changesets are a convenient way to apply bulk changes to the |
| 878 | * live tree. In case of an error, changes are rolled-back. |
| 879 | * changesets live on after initial application, and if not |
| 880 | * destroyed after use, they can be reverted in one single call. |
| 881 | */ |
| 882 | struct of_changeset { |
| 883 | struct list_head entries; |
| 884 | }; |
| 885 | |
Pantelis Antoniou | b53a234 | 2014-10-28 22:33:53 +0200 | [diff] [blame] | 886 | enum of_reconfig_change { |
| 887 | OF_RECONFIG_NO_CHANGE = 0, |
| 888 | OF_RECONFIG_CHANGE_ADD, |
| 889 | OF_RECONFIG_CHANGE_REMOVE, |
| 890 | }; |
| 891 | |
Pantelis Antoniou | 201c910 | 2014-07-04 19:58:49 +0300 | [diff] [blame] | 892 | #ifdef CONFIG_OF_DYNAMIC |
Grant Likely | f6892d1 | 2014-11-21 15:14:58 +0000 | [diff] [blame] | 893 | extern int of_reconfig_notifier_register(struct notifier_block *); |
| 894 | extern int of_reconfig_notifier_unregister(struct notifier_block *); |
Grant Likely | f5242e5 | 2014-11-24 17:58:01 +0000 | [diff] [blame^] | 895 | extern int of_reconfig_notify(unsigned long, struct of_reconfig_data *rd); |
| 896 | extern int of_reconfig_get_state_change(unsigned long action, |
| 897 | struct of_reconfig_data *arg); |
Grant Likely | f6892d1 | 2014-11-21 15:14:58 +0000 | [diff] [blame] | 898 | |
Pantelis Antoniou | 201c910 | 2014-07-04 19:58:49 +0300 | [diff] [blame] | 899 | extern void of_changeset_init(struct of_changeset *ocs); |
| 900 | extern void of_changeset_destroy(struct of_changeset *ocs); |
| 901 | extern int of_changeset_apply(struct of_changeset *ocs); |
| 902 | extern int of_changeset_revert(struct of_changeset *ocs); |
| 903 | extern int of_changeset_action(struct of_changeset *ocs, |
| 904 | unsigned long action, struct device_node *np, |
| 905 | struct property *prop); |
| 906 | |
| 907 | static inline int of_changeset_attach_node(struct of_changeset *ocs, |
| 908 | struct device_node *np) |
| 909 | { |
| 910 | return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL); |
| 911 | } |
| 912 | |
| 913 | static inline int of_changeset_detach_node(struct of_changeset *ocs, |
| 914 | struct device_node *np) |
| 915 | { |
| 916 | return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL); |
| 917 | } |
| 918 | |
| 919 | static inline int of_changeset_add_property(struct of_changeset *ocs, |
| 920 | struct device_node *np, struct property *prop) |
| 921 | { |
| 922 | return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop); |
| 923 | } |
| 924 | |
| 925 | static inline int of_changeset_remove_property(struct of_changeset *ocs, |
| 926 | struct device_node *np, struct property *prop) |
| 927 | { |
| 928 | return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop); |
| 929 | } |
| 930 | |
| 931 | static inline int of_changeset_update_property(struct of_changeset *ocs, |
| 932 | struct device_node *np, struct property *prop) |
| 933 | { |
| 934 | return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop); |
| 935 | } |
Grant Likely | f6892d1 | 2014-11-21 15:14:58 +0000 | [diff] [blame] | 936 | #else /* CONFIG_OF_DYNAMIC */ |
| 937 | static inline int of_reconfig_notifier_register(struct notifier_block *nb) |
| 938 | { |
| 939 | return -EINVAL; |
| 940 | } |
| 941 | static inline int of_reconfig_notifier_unregister(struct notifier_block *nb) |
| 942 | { |
| 943 | return -EINVAL; |
| 944 | } |
Grant Likely | f5242e5 | 2014-11-24 17:58:01 +0000 | [diff] [blame^] | 945 | static inline int of_reconfig_notify(unsigned long action, |
| 946 | struct of_reconfig_data *arg) |
Grant Likely | f6892d1 | 2014-11-21 15:14:58 +0000 | [diff] [blame] | 947 | { |
| 948 | return -EINVAL; |
| 949 | } |
Grant Likely | f5242e5 | 2014-11-24 17:58:01 +0000 | [diff] [blame^] | 950 | static inline int of_reconfig_get_state_change(unsigned long action, |
| 951 | struct of_reconfig_data *arg) |
Grant Likely | f6892d1 | 2014-11-21 15:14:58 +0000 | [diff] [blame] | 952 | { |
| 953 | return -EINVAL; |
| 954 | } |
| 955 | #endif /* CONFIG_OF_DYNAMIC */ |
Pantelis Antoniou | 201c910 | 2014-07-04 19:58:49 +0300 | [diff] [blame] | 956 | |
Pantelis Antoniou | 7941b27 | 2014-07-04 19:59:20 +0300 | [diff] [blame] | 957 | /* CONFIG_OF_RESOLVE api */ |
| 958 | extern int of_resolve_phandles(struct device_node *tree); |
| 959 | |
Stephen Rothwell | 76c1ce7 | 2007-05-01 16:19:07 +1000 | [diff] [blame] | 960 | #endif /* _LINUX_OF_H */ |