blob: 3e710d878085f1fae9a2ac40a5807be85ce25215 [file] [log] [blame]
Stephen Rothwell76c1ce72007-05-01 16:19:07 +10001#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 Slaby1977f032007-10-18 23:40:25 -070019#include <linux/bitops.h>
Kalle Valoe51130c2011-10-06 15:40:44 +030020#include <linux/errno.h>
Grant Likely6f192492009-10-15 10:57:49 -060021#include <linux/kref.h>
Grant Likely283029d2008-01-09 06:20:40 +110022#include <linux/mod_devicetable.h>
Grant Likely0d351c32010-02-14 14:13:57 -070023#include <linux/spinlock.h>
Stephen Rothwell76c1ce72007-05-01 16:19:07 +100024
Jeremy Kerr2e89e682010-01-30 01:41:49 -070025#include <asm/byteorder.h>
Paul Gortmakerd0a99402011-10-29 10:17:06 -040026#include <asm/errno.h>
Jeremy Kerr2e89e682010-01-30 01:41:49 -070027
Grant Likely731581e2009-10-15 10:57:46 -060028typedef u32 phandle;
29typedef u32 ihandle;
30
31struct 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
Grant Likely6f192492009-10-15 10:57:49 -060040#if defined(CONFIG_SPARC)
41struct of_irq_controller;
42#endif
43
44struct device_node {
45 const char *name;
46 const char *type;
Grant Likely6016a362010-01-28 14:06:53 -070047 phandle phandle;
Grant Likely6f192492009-10-15 10:57:49 -060048 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;
Gavin Shaneb740b52012-02-27 20:04:04 +000061#if defined(CONFIG_EEH)
62 struct eeh_dev *edev;
63#endif
Grant Likely6f192492009-10-15 10:57:49 -060064#if defined(CONFIG_SPARC)
65 char *path_component_name;
66 unsigned int unique_id;
67 struct of_irq_controller *irq_trans;
68#endif
69};
70
Grant Likely15c9a0a2011-12-12 09:25:57 -070071#define MAX_PHANDLE_ARGS 8
72struct of_phandle_args {
73 struct device_node *np;
74 int args_count;
75 uint32_t args[MAX_PHANDLE_ARGS];
76};
77
Gavin Shaneb740b52012-02-27 20:04:04 +000078#if defined(CONFIG_EEH)
79static inline struct eeh_dev *of_node_to_eeh_dev(struct device_node *dn)
80{
81 return dn->edev;
82}
83#endif
84
Rob Herring3ecdd052011-12-13 09:13:54 -060085#if defined(CONFIG_SPARC) || !defined(CONFIG_OF)
86/* Dummy ref counting routines - to be implemented later */
87static inline struct device_node *of_node_get(struct device_node *node)
88{
89 return node;
90}
91static inline void of_node_put(struct device_node *node)
92{
93}
94#else
95extern struct device_node *of_node_get(struct device_node *node);
96extern void of_node_put(struct device_node *node);
97#endif
98
Grant Likelyc9e358d2011-01-21 09:24:48 -070099#ifdef CONFIG_OF
100
Grant Likely41f88002009-11-23 20:07:01 -0700101/* Pointer for first entry in chain of all nodes. */
102extern struct device_node *allnodes;
Grant Likelyfc0bdae2010-02-14 07:13:55 -0700103extern struct device_node *of_chosen;
Shawn Guo611cad72011-08-15 15:28:14 +0800104extern struct device_node *of_aliases;
Grant Likely0d351c32010-02-14 14:13:57 -0700105extern rwlock_t devtree_lock;
Grant Likely41f88002009-11-23 20:07:01 -0700106
Sebastian Andrzej Siewior3bcbaf62011-02-22 21:07:46 +0100107static inline bool of_have_populated_dt(void)
108{
109 return allnodes != NULL;
110}
111
Andres Salomon035ebef2010-07-13 09:42:26 +0000112static inline bool of_node_is_root(const struct device_node *node)
113{
114 return node && (node->parent == NULL);
115}
116
Grant Likely50436312009-10-15 10:57:58 -0600117static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
118{
119 return test_bit(flag, &n->_flags);
120}
121
122static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
123{
124 set_bit(flag, &n->_flags);
125}
126
Grant Likelye91edcf2009-10-15 10:58:09 -0600127extern struct device_node *of_find_all_nodes(struct device_node *prev);
128
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600129/*
Lennert Buytenhek3d6b8822011-02-22 18:18:51 +0100130 * OF address retrieval & translation
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600131 */
132
133/* Helper to read a big number; size is in cells (not bytes) */
Jeremy Kerr2e89e682010-01-30 01:41:49 -0700134static inline u64 of_read_number(const __be32 *cell, int size)
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600135{
136 u64 r = 0;
137 while (size--)
Jeremy Kerr2e89e682010-01-30 01:41:49 -0700138 r = (r << 32) | be32_to_cpu(*(cell++));
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600139 return r;
140}
141
142/* Like of_read_number, but we want an unsigned long result */
Jeremy Kerr2e89e682010-01-30 01:41:49 -0700143static inline unsigned long of_read_ulong(const __be32 *cell, int size)
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600144{
Grant Likely2be09cb2009-11-23 20:16:46 -0700145 /* toss away upper bits if unsigned long is smaller than u64 */
146 return of_read_number(cell, size);
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600147}
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600148
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000149#include <asm/prom.h>
150
Grant Likely7c7b60c2010-02-14 07:13:50 -0700151/* Default #address and #size cells. Allow arch asm/prom.h to override */
152#if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
153#define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
154#define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
155#endif
156
157/* Default string compare functions, Allow arch asm/prom.h to override */
158#if !defined(of_compat_cmp)
Grant Likely19761522010-03-18 07:30:31 -0600159#define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
Grant Likely7c7b60c2010-02-14 07:13:50 -0700160#define of_prop_cmp(s1, s2) strcmp((s1), (s2))
161#define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
162#endif
163
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000164/* flag descriptions */
165#define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
166#define OF_DETACHED 2 /* node has been detached from the device tree */
167
Grant Likely61e955d2009-10-15 10:57:51 -0600168#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
169#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
170
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000171#define OF_BAD_ADDR ((u64)-1)
172
Grant Likely559e2b72010-07-23 20:11:18 -0600173#ifndef of_node_to_nid
174static inline int of_node_to_nid(struct device_node *np) { return -1; }
175#define of_node_to_nid of_node_to_nid
176#endif
177
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000178extern struct device_node *of_find_node_by_name(struct device_node *from,
179 const char *name);
180#define for_each_node_by_name(dn, name) \
181 for (dn = of_find_node_by_name(NULL, name); dn; \
182 dn = of_find_node_by_name(dn, name))
183extern struct device_node *of_find_node_by_type(struct device_node *from,
184 const char *type);
185#define for_each_node_by_type(dn, type) \
186 for (dn = of_find_node_by_type(NULL, type); dn; \
187 dn = of_find_node_by_type(dn, type))
188extern struct device_node *of_find_compatible_node(struct device_node *from,
189 const char *type, const char *compat);
190#define for_each_compatible_node(dn, type, compatible) \
191 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
192 dn = of_find_compatible_node(dn, type, compatible))
Grant Likely283029d2008-01-09 06:20:40 +1100193extern struct device_node *of_find_matching_node(struct device_node *from,
194 const struct of_device_id *matches);
195#define for_each_matching_node(dn, matches) \
196 for (dn = of_find_matching_node(NULL, matches); dn; \
197 dn = of_find_matching_node(dn, matches))
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000198extern struct device_node *of_find_node_by_path(const char *path);
199extern struct device_node *of_find_node_by_phandle(phandle handle);
200extern struct device_node *of_get_parent(const struct device_node *node);
Michael Ellermanf4eb0102007-10-26 16:54:31 +1000201extern struct device_node *of_get_next_parent(struct device_node *node);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000202extern struct device_node *of_get_next_child(const struct device_node *node,
203 struct device_node *prev);
Michael Ellermanaabc08d2007-11-26 19:03:45 +1100204#define for_each_child_of_node(parent, child) \
205 for (child = of_get_next_child(parent, NULL); child != NULL; \
206 child = of_get_next_child(parent, child))
207
Michael Ellerman1e291b12008-11-12 18:54:42 +0000208extern struct device_node *of_find_node_with_property(
209 struct device_node *from, const char *prop_name);
210#define for_each_node_with_property(dn, prop_name) \
211 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
212 dn = of_find_node_with_property(dn, prop_name))
213
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000214extern struct property *of_find_property(const struct device_node *np,
215 const char *name,
216 int *lenp);
Rob Herring0e373632011-07-06 15:42:58 -0500217extern int of_property_read_u32_array(const struct device_node *np,
Jamie Ilesaac285c2011-08-02 15:45:07 +0100218 const char *propname,
Rob Herring0e373632011-07-06 15:42:58 -0500219 u32 *out_values,
220 size_t sz);
Jamie Iles4cd7f7a2011-09-14 20:49:59 +0100221extern int of_property_read_u64(const struct device_node *np,
222 const char *propname, u64 *out_value);
Rob Herring0e373632011-07-06 15:42:58 -0500223
Jamie Ilesaac285c2011-08-02 15:45:07 +0100224extern int of_property_read_string(struct device_node *np,
225 const char *propname,
226 const char **out_string);
Benoit Cousson4fcd15a2011-09-27 17:45:43 +0200227extern int of_property_read_string_index(struct device_node *np,
228 const char *propname,
229 int index, const char **output);
230extern int of_property_count_strings(struct device_node *np,
231 const char *propname);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000232extern int of_device_is_compatible(const struct device_node *device,
233 const char *);
Josh Boyer834d97d2008-03-27 00:33:14 +1100234extern int of_device_is_available(const struct device_node *device);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000235extern const void *of_get_property(const struct device_node *node,
236 const char *name,
237 int *lenp);
Dong Aisheng8af0da92011-12-22 20:19:24 +0800238#define for_each_property_of_node(dn, pp) \
239 for (pp = dn->properties; pp != NULL; pp = pp->next)
Shawn Guo611cad72011-08-15 15:28:14 +0800240
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000241extern int of_n_addr_cells(struct device_node *np);
242extern int of_n_size_cells(struct device_node *np);
Grant Likely283029d2008-01-09 06:20:40 +1100243extern const struct of_device_id *of_match_node(
244 const struct of_device_id *matches, const struct device_node *node);
Grant Likely3f07af42008-07-25 22:25:13 -0400245extern int of_modalias_node(struct device_node *node, char *modalias, int len);
Grant Likely739649c2009-04-25 12:52:40 +0000246extern struct device_node *of_parse_phandle(struct device_node *np,
247 const char *phandle_name,
248 int index);
Grant Likely15c9a0a2011-12-12 09:25:57 -0700249extern int of_parse_phandle_with_args(struct device_node *np,
Anton Vorontsov64b60e02008-10-10 04:43:17 +0000250 const char *list_name, const char *cells_name, int index,
Grant Likely15c9a0a2011-12-12 09:25:57 -0700251 struct of_phandle_args *out_args);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000252
Shawn Guo611cad72011-08-15 15:28:14 +0800253extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
254extern int of_alias_get_id(struct device_node *np, const char *stem);
255
Grant Likely21b082e2010-02-14 07:13:38 -0700256extern int of_machine_is_compatible(const char *compat);
257
258extern int prom_add_property(struct device_node* np, struct property* prop);
259extern int prom_remove_property(struct device_node *np, struct property *prop);
260extern int prom_update_property(struct device_node *np,
261 struct property *newprop,
262 struct property *oldprop);
263
Grant Likelyfcdeb7f2010-01-29 05:04:33 -0700264#if defined(CONFIG_OF_DYNAMIC)
265/* For updating the device tree at runtime */
266extern void of_attach_node(struct device_node *);
267extern void of_detach_node(struct device_node *);
268#endif
269
Ben Dooks3a1e3622011-08-03 10:11:42 +0100270#define of_match_ptr(_ptr) (_ptr)
Shawn Guob98c0232011-07-08 16:27:33 +0800271#else /* CONFIG_OF */
Sebastian Andrzej Siewior3bcbaf62011-02-22 21:07:46 +0100272
273static inline bool of_have_populated_dt(void)
274{
275 return false;
276}
277
Stephen Warrenaba3dff2011-09-21 13:23:10 -0600278#define for_each_child_of_node(parent, child) \
279 while (0)
280
Rajendra Nayak36a09042011-10-10 21:49:35 +0530281static inline int of_device_is_compatible(const struct device_node *device,
282 const char *name)
283{
284 return 0;
285}
286
Stephen Warrenaba3dff2011-09-21 13:23:10 -0600287static inline struct property *of_find_property(const struct device_node *np,
288 const char *name,
289 int *lenp)
290{
291 return NULL;
292}
293
Shawn Guob98c0232011-07-08 16:27:33 +0800294static inline int of_property_read_u32_array(const struct device_node *np,
Jamie Ilesaac285c2011-08-02 15:45:07 +0100295 const char *propname,
296 u32 *out_values, size_t sz)
Shawn Guob98c0232011-07-08 16:27:33 +0800297{
298 return -ENOSYS;
299}
300
301static inline int of_property_read_string(struct device_node *np,
Jamie Ilesaac285c2011-08-02 15:45:07 +0100302 const char *propname,
303 const char **out_string)
Shawn Guob98c0232011-07-08 16:27:33 +0800304{
305 return -ENOSYS;
306}
307
Benoit Cousson4fcd15a2011-09-27 17:45:43 +0200308static inline int of_property_read_string_index(struct device_node *np,
309 const char *propname, int index,
310 const char **out_string)
311{
312 return -ENOSYS;
313}
314
315static inline int of_property_count_strings(struct device_node *np,
316 const char *propname)
317{
318 return -ENOSYS;
319}
320
Stephen Warren89272b82011-08-05 16:50:30 -0600321static inline const void *of_get_property(const struct device_node *node,
322 const char *name,
323 int *lenp)
324{
325 return NULL;
326}
327
Jamie Iles4cd7f7a2011-09-14 20:49:59 +0100328static inline int of_property_read_u64(const struct device_node *np,
329 const char *propname, u64 *out_value)
330{
331 return -ENOSYS;
332}
333
Rajendra Nayak36a09042011-10-10 21:49:35 +0530334static inline struct device_node *of_parse_phandle(struct device_node *np,
335 const char *phandle_name,
336 int index)
337{
338 return NULL;
339}
340
Nicolas Ferreed5f8862011-10-27 11:07:28 +0200341static inline int of_alias_get_id(struct device_node *np, const char *stem)
342{
343 return -ENOSYS;
344}
345
Stephen Warren50e07f82011-10-25 14:01:26 +0200346static inline int of_machine_is_compatible(const char *compat)
347{
348 return 0;
349}
350
Ben Dooks3a1e3622011-08-03 10:11:42 +0100351#define of_match_ptr(_ptr) NULL
Nicolas Ferre5762c202011-10-24 11:53:32 +0200352#define of_match_node(_matches, _node) NULL
Jeremy Kerr9dfbf202010-02-14 07:13:43 -0700353#endif /* CONFIG_OF */
Shawn Guob98c0232011-07-08 16:27:33 +0800354
355static inline int of_property_read_u32(const struct device_node *np,
Jamie Ilesaac285c2011-08-02 15:45:07 +0100356 const char *propname,
Shawn Guob98c0232011-07-08 16:27:33 +0800357 u32 *out_value)
358{
359 return of_property_read_u32_array(np, propname, out_value, 1);
360}
361
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000362#endif /* _LINUX_OF_H */