blob: 0085bb01c041e969276b2ab5107dc4e2446d445c [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>
Grant Likely6f192492009-10-15 10:57:49 -060020#include <linux/kref.h>
Grant Likely283029d2008-01-09 06:20:40 +110021#include <linux/mod_devicetable.h>
Grant Likely0d351c32010-02-14 14:13:57 -070022#include <linux/spinlock.h>
Stephen Rothwell76c1ce72007-05-01 16:19:07 +100023
Jeremy Kerr2e89e682010-01-30 01:41:49 -070024#include <asm/byteorder.h>
25
Grant Likely731581e2009-10-15 10:57:46 -060026typedef u32 phandle;
27typedef u32 ihandle;
28
29struct property {
30 char *name;
31 int length;
32 void *value;
33 struct property *next;
34 unsigned long _flags;
35 unsigned int unique_id;
36};
37
Grant Likely6f192492009-10-15 10:57:49 -060038#if defined(CONFIG_SPARC)
39struct of_irq_controller;
40#endif
41
42struct device_node {
43 const char *name;
44 const char *type;
Grant Likely6016a362010-01-28 14:06:53 -070045 phandle phandle;
Grant Likely6f192492009-10-15 10:57:49 -060046 char *full_name;
47
48 struct property *properties;
49 struct property *deadprops; /* removed properties */
50 struct device_node *parent;
51 struct device_node *child;
52 struct device_node *sibling;
53 struct device_node *next; /* next device of same type */
54 struct device_node *allnext; /* next in list of all nodes */
55 struct proc_dir_entry *pde; /* this node's proc directory */
56 struct kref kref;
57 unsigned long _flags;
58 void *data;
59#if defined(CONFIG_SPARC)
60 char *path_component_name;
61 unsigned int unique_id;
62 struct of_irq_controller *irq_trans;
63#endif
64};
65
Grant Likelyc9e358d2011-01-21 09:24:48 -070066#ifdef CONFIG_OF
67
Grant Likely41f88002009-11-23 20:07:01 -070068/* Pointer for first entry in chain of all nodes. */
69extern struct device_node *allnodes;
Grant Likelyfc0bdae2010-02-14 07:13:55 -070070extern struct device_node *of_chosen;
Grant Likely0d351c32010-02-14 14:13:57 -070071extern rwlock_t devtree_lock;
Grant Likely41f88002009-11-23 20:07:01 -070072
Sebastian Andrzej Siewior3bcbaf62011-02-22 21:07:46 +010073static inline bool of_have_populated_dt(void)
74{
75 return allnodes != NULL;
76}
77
Andres Salomon035ebef2010-07-13 09:42:26 +000078static inline bool of_node_is_root(const struct device_node *node)
79{
80 return node && (node->parent == NULL);
81}
82
Grant Likely50436312009-10-15 10:57:58 -060083static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
84{
85 return test_bit(flag, &n->_flags);
86}
87
88static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
89{
90 set_bit(flag, &n->_flags);
91}
92
Grant Likelye91edcf2009-10-15 10:58:09 -060093extern struct device_node *of_find_all_nodes(struct device_node *prev);
94
Grant Likely526b5b32009-10-15 10:58:02 -060095#if defined(CONFIG_SPARC)
96/* Dummy ref counting routines - to be implemented later */
97static inline struct device_node *of_node_get(struct device_node *node)
98{
99 return node;
100}
101static inline void of_node_put(struct device_node *node)
102{
103}
104
105#else
Grant Likely526b5b32009-10-15 10:58:02 -0600106extern struct device_node *of_node_get(struct device_node *node);
107extern void of_node_put(struct device_node *node);
108#endif
109
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600110/*
Lennert Buytenhek3d6b8822011-02-22 18:18:51 +0100111 * OF address retrieval & translation
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600112 */
113
114/* Helper to read a big number; size is in cells (not bytes) */
Jeremy Kerr2e89e682010-01-30 01:41:49 -0700115static inline u64 of_read_number(const __be32 *cell, int size)
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600116{
117 u64 r = 0;
118 while (size--)
Jeremy Kerr2e89e682010-01-30 01:41:49 -0700119 r = (r << 32) | be32_to_cpu(*(cell++));
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600120 return r;
121}
122
123/* Like of_read_number, but we want an unsigned long result */
Jeremy Kerr2e89e682010-01-30 01:41:49 -0700124static inline unsigned long of_read_ulong(const __be32 *cell, int size)
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600125{
Grant Likely2be09cb2009-11-23 20:16:46 -0700126 /* toss away upper bits if unsigned long is smaller than u64 */
127 return of_read_number(cell, size);
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600128}
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600129
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000130#include <asm/prom.h>
131
Grant Likely7c7b60c2010-02-14 07:13:50 -0700132/* Default #address and #size cells. Allow arch asm/prom.h to override */
133#if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
134#define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
135#define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
136#endif
137
138/* Default string compare functions, Allow arch asm/prom.h to override */
139#if !defined(of_compat_cmp)
Grant Likely19761522010-03-18 07:30:31 -0600140#define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
Grant Likely7c7b60c2010-02-14 07:13:50 -0700141#define of_prop_cmp(s1, s2) strcmp((s1), (s2))
142#define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
143#endif
144
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000145/* flag descriptions */
146#define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
147#define OF_DETACHED 2 /* node has been detached from the device tree */
148
Grant Likely61e955d2009-10-15 10:57:51 -0600149#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
150#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
151
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000152#define OF_BAD_ADDR ((u64)-1)
153
Grant Likely559e2b72010-07-23 20:11:18 -0600154#ifndef of_node_to_nid
155static inline int of_node_to_nid(struct device_node *np) { return -1; }
156#define of_node_to_nid of_node_to_nid
157#endif
158
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000159extern struct device_node *of_find_node_by_name(struct device_node *from,
160 const char *name);
161#define for_each_node_by_name(dn, name) \
162 for (dn = of_find_node_by_name(NULL, name); dn; \
163 dn = of_find_node_by_name(dn, name))
164extern struct device_node *of_find_node_by_type(struct device_node *from,
165 const char *type);
166#define for_each_node_by_type(dn, type) \
167 for (dn = of_find_node_by_type(NULL, type); dn; \
168 dn = of_find_node_by_type(dn, type))
169extern struct device_node *of_find_compatible_node(struct device_node *from,
170 const char *type, const char *compat);
171#define for_each_compatible_node(dn, type, compatible) \
172 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
173 dn = of_find_compatible_node(dn, type, compatible))
Grant Likely283029d2008-01-09 06:20:40 +1100174extern struct device_node *of_find_matching_node(struct device_node *from,
175 const struct of_device_id *matches);
176#define for_each_matching_node(dn, matches) \
177 for (dn = of_find_matching_node(NULL, matches); dn; \
178 dn = of_find_matching_node(dn, matches))
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000179extern struct device_node *of_find_node_by_path(const char *path);
180extern struct device_node *of_find_node_by_phandle(phandle handle);
181extern struct device_node *of_get_parent(const struct device_node *node);
Michael Ellermanf4eb0102007-10-26 16:54:31 +1000182extern struct device_node *of_get_next_parent(struct device_node *node);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000183extern struct device_node *of_get_next_child(const struct device_node *node,
184 struct device_node *prev);
Michael Ellermanaabc08d2007-11-26 19:03:45 +1100185#define for_each_child_of_node(parent, child) \
186 for (child = of_get_next_child(parent, NULL); child != NULL; \
187 child = of_get_next_child(parent, child))
188
Michael Ellerman1e291b12008-11-12 18:54:42 +0000189extern struct device_node *of_find_node_with_property(
190 struct device_node *from, const char *prop_name);
191#define for_each_node_with_property(dn, prop_name) \
192 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
193 dn = of_find_node_with_property(dn, prop_name))
194
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000195extern struct property *of_find_property(const struct device_node *np,
196 const char *name,
197 int *lenp);
Rob Herring0e373632011-07-06 15:42:58 -0500198extern int of_property_read_u32_array(const struct device_node *np,
Jamie Ilesaac285c2011-08-02 15:45:07 +0100199 const char *propname,
Rob Herring0e373632011-07-06 15:42:58 -0500200 u32 *out_values,
201 size_t sz);
202
Jamie Ilesaac285c2011-08-02 15:45:07 +0100203extern int of_property_read_string(struct device_node *np,
204 const char *propname,
205 const char **out_string);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000206extern int of_device_is_compatible(const struct device_node *device,
207 const char *);
Josh Boyer834d97d2008-03-27 00:33:14 +1100208extern int of_device_is_available(const struct device_node *device);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000209extern const void *of_get_property(const struct device_node *node,
210 const char *name,
211 int *lenp);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000212extern int of_n_addr_cells(struct device_node *np);
213extern int of_n_size_cells(struct device_node *np);
Grant Likely283029d2008-01-09 06:20:40 +1100214extern const struct of_device_id *of_match_node(
215 const struct of_device_id *matches, const struct device_node *node);
Grant Likely3f07af42008-07-25 22:25:13 -0400216extern int of_modalias_node(struct device_node *node, char *modalias, int len);
Grant Likely739649c2009-04-25 12:52:40 +0000217extern struct device_node *of_parse_phandle(struct device_node *np,
218 const char *phandle_name,
219 int index);
Anton Vorontsov64b60e02008-10-10 04:43:17 +0000220extern int of_parse_phandles_with_args(struct device_node *np,
221 const char *list_name, const char *cells_name, int index,
222 struct device_node **out_node, const void **out_args);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000223
Grant Likely21b082e2010-02-14 07:13:38 -0700224extern int of_machine_is_compatible(const char *compat);
225
226extern int prom_add_property(struct device_node* np, struct property* prop);
227extern int prom_remove_property(struct device_node *np, struct property *prop);
228extern int prom_update_property(struct device_node *np,
229 struct property *newprop,
230 struct property *oldprop);
231
Grant Likelyfcdeb7f2010-01-29 05:04:33 -0700232#if defined(CONFIG_OF_DYNAMIC)
233/* For updating the device tree at runtime */
234extern void of_attach_node(struct device_node *);
235extern void of_detach_node(struct device_node *);
236#endif
237
Shawn Guob98c0232011-07-08 16:27:33 +0800238#else /* CONFIG_OF */
Sebastian Andrzej Siewior3bcbaf62011-02-22 21:07:46 +0100239
240static inline bool of_have_populated_dt(void)
241{
242 return false;
243}
244
Shawn Guob98c0232011-07-08 16:27:33 +0800245static inline int of_property_read_u32_array(const struct device_node *np,
Jamie Ilesaac285c2011-08-02 15:45:07 +0100246 const char *propname,
247 u32 *out_values, size_t sz)
Shawn Guob98c0232011-07-08 16:27:33 +0800248{
249 return -ENOSYS;
250}
251
252static inline int of_property_read_string(struct device_node *np,
Jamie Ilesaac285c2011-08-02 15:45:07 +0100253 const char *propname,
254 const char **out_string)
Shawn Guob98c0232011-07-08 16:27:33 +0800255{
256 return -ENOSYS;
257}
258
Jeremy Kerr9dfbf202010-02-14 07:13:43 -0700259#endif /* CONFIG_OF */
Shawn Guob98c0232011-07-08 16:27:33 +0800260
261static inline int of_property_read_u32(const struct device_node *np,
Jamie Ilesaac285c2011-08-02 15:45:07 +0100262 const char *propname,
Shawn Guob98c0232011-07-08 16:27:33 +0800263 u32 *out_value)
264{
265 return of_property_read_u32_array(np, propname, out_value, 1);
266}
267
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000268#endif /* _LINUX_OF_H */