d5f666290f6b40363a07306e5d60f793ff1a88d9
[linux-2.6.git] / include / linux / of.h
1 #ifndef _LINUX_OF_H
2 #define _LINUX_OF_H
3 /*
4  * Definitions for talking to the Open Firmware PROM on
5  * Power Macintosh and other computers.
6  *
7  * Copyright (C) 1996-2005 Paul Mackerras.
8  *
9  * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
10  * Updates for SPARC64 by David S. Miller
11  * Derived from PowerPC and Sparc prom.h files by Stephen Rothwell, IBM Corp.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version
16  * 2 of the License, or (at your option) any later version.
17  */
18 #include <linux/types.h>
19 #include <linux/bitops.h>
20 #include <linux/kref.h>
21 #include <linux/mod_devicetable.h>
22
23 typedef u32 phandle;
24 typedef u32 ihandle;
25
26 struct property {
27         char    *name;
28         int     length;
29         void    *value;
30         struct property *next;
31         unsigned long _flags;
32         unsigned int unique_id;
33 };
34
35 #if defined(CONFIG_SPARC)
36 struct of_irq_controller;
37 #endif
38
39 struct device_node {
40         const char *name;
41         const char *type;
42         phandle node;
43 #if !defined(CONFIG_SPARC)
44         phandle linux_phandle;
45 #endif
46         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
66 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
67 {
68         return test_bit(flag, &n->_flags);
69 }
70
71 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
72 {
73         set_bit(flag, &n->_flags);
74 }
75
76 static inline void
77 set_node_proc_entry(struct device_node *dn, struct proc_dir_entry *de)
78 {
79         dn->pde = de;
80 }
81
82 #include <asm/prom.h>
83
84 /* flag descriptions */
85 #define OF_DYNAMIC      1 /* node and properties were allocated via kmalloc */
86 #define OF_DETACHED     2 /* node has been detached from the device tree */
87
88 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
89 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
90
91 #define OF_BAD_ADDR     ((u64)-1)
92
93 extern struct device_node *of_find_node_by_name(struct device_node *from,
94         const char *name);
95 #define for_each_node_by_name(dn, name) \
96         for (dn = of_find_node_by_name(NULL, name); dn; \
97              dn = of_find_node_by_name(dn, name))
98 extern struct device_node *of_find_node_by_type(struct device_node *from,
99         const char *type);
100 #define for_each_node_by_type(dn, type) \
101         for (dn = of_find_node_by_type(NULL, type); dn; \
102              dn = of_find_node_by_type(dn, type))
103 extern struct device_node *of_find_compatible_node(struct device_node *from,
104         const char *type, const char *compat);
105 #define for_each_compatible_node(dn, type, compatible) \
106         for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
107              dn = of_find_compatible_node(dn, type, compatible))
108 extern struct device_node *of_find_matching_node(struct device_node *from,
109         const struct of_device_id *matches);
110 #define for_each_matching_node(dn, matches) \
111         for (dn = of_find_matching_node(NULL, matches); dn; \
112              dn = of_find_matching_node(dn, matches))
113 extern struct device_node *of_find_node_by_path(const char *path);
114 extern struct device_node *of_find_node_by_phandle(phandle handle);
115 extern struct device_node *of_get_parent(const struct device_node *node);
116 extern struct device_node *of_get_next_parent(struct device_node *node);
117 extern struct device_node *of_get_next_child(const struct device_node *node,
118                                              struct device_node *prev);
119 #define for_each_child_of_node(parent, child) \
120         for (child = of_get_next_child(parent, NULL); child != NULL; \
121              child = of_get_next_child(parent, child))
122
123 extern struct device_node *of_find_node_with_property(
124         struct device_node *from, const char *prop_name);
125 #define for_each_node_with_property(dn, prop_name) \
126         for (dn = of_find_node_with_property(NULL, prop_name); dn; \
127              dn = of_find_node_with_property(dn, prop_name))
128
129 extern struct property *of_find_property(const struct device_node *np,
130                                          const char *name,
131                                          int *lenp);
132 extern int of_device_is_compatible(const struct device_node *device,
133                                    const char *);
134 extern int of_device_is_available(const struct device_node *device);
135 extern const void *of_get_property(const struct device_node *node,
136                                 const char *name,
137                                 int *lenp);
138 extern int of_n_addr_cells(struct device_node *np);
139 extern int of_n_size_cells(struct device_node *np);
140 extern const struct of_device_id *of_match_node(
141         const struct of_device_id *matches, const struct device_node *node);
142 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
143 extern struct device_node *of_parse_phandle(struct device_node *np,
144                                             const char *phandle_name,
145                                             int index);
146 extern int of_parse_phandles_with_args(struct device_node *np,
147         const char *list_name, const char *cells_name, int index,
148         struct device_node **out_node, const void **out_args);
149
150 #endif /* _LINUX_OF_H */