of: merge of_node_*_flag() and set_node_proc_entry()
[linux-2.6.git] / arch / powerpc / include / asm / prom.h
1 #include <linux/of.h>   /* linux/of.h gets to determine #include ordering */
2 #ifndef _POWERPC_PROM_H
3 #define _POWERPC_PROM_H
4 #ifdef __KERNEL__
5
6 /*
7  * Definitions for talking to the Open Firmware PROM on
8  * Power Macintosh computers.
9  *
10  * Copyright (C) 1996-2005 Paul Mackerras.
11  *
12  * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
13  *
14  * This program is free software; you can redistribute it and/or
15  * modify it under the terms of the GNU General Public License
16  * as published by the Free Software Foundation; either version
17  * 2 of the License, or (at your option) any later version.
18  */
19 #include <linux/types.h>
20 #include <linux/of_fdt.h>
21 #include <linux/proc_fs.h>
22 #include <linux/platform_device.h>
23 #include <asm/irq.h>
24 #include <asm/atomic.h>
25
26 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
27 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
28
29 #define of_compat_cmp(s1, s2, l)        strcasecmp((s1), (s2))
30 #define of_prop_cmp(s1, s2)             strcmp((s1), (s2))
31 #define of_node_cmp(s1, s2)             strcasecmp((s1), (s2))
32
33 extern struct device_node *of_chosen;
34
35 #define HAVE_ARCH_DEVTREE_FIXUPS
36
37 extern struct device_node *of_find_all_nodes(struct device_node *prev);
38 extern struct device_node *of_node_get(struct device_node *node);
39 extern void of_node_put(struct device_node *node);
40
41 /* For scanning the flat device-tree at boot time */
42 extern int __init of_scan_flat_dt(int (*it)(unsigned long node,
43                                             const char *uname, int depth,
44                                             void *data),
45                                   void *data);
46 extern void* __init of_get_flat_dt_prop(unsigned long node, const char *name,
47                                         unsigned long *size);
48 extern int __init of_flat_dt_is_compatible(unsigned long node, const char *name);
49 extern unsigned long __init of_get_flat_dt_root(void);
50
51 /* For updating the device tree at runtime */
52 extern void of_attach_node(struct device_node *);
53 extern void of_detach_node(struct device_node *);
54
55 /* Other Prototypes */
56 extern void finish_device_tree(void);
57 extern void unflatten_device_tree(void);
58 extern void early_init_devtree(void *);
59 extern int machine_is_compatible(const char *compat);
60 extern void print_properties(struct device_node *node);
61 extern int prom_n_intr_cells(struct device_node* np);
62 extern void prom_get_irq_senses(unsigned char *senses, int off, int max);
63 extern int prom_add_property(struct device_node* np, struct property* prop);
64 extern int prom_remove_property(struct device_node *np, struct property *prop);
65 extern int prom_update_property(struct device_node *np,
66                                 struct property *newprop,
67                                 struct property *oldprop);
68
69 #ifdef CONFIG_PPC32
70 /*
71  * PCI <-> OF matching functions
72  * (XXX should these be here?)
73  */
74 struct pci_bus;
75 struct pci_dev;
76 extern int pci_device_from_OF_node(struct device_node *node,
77                                    u8* bus, u8* devfn);
78 extern struct device_node* pci_busdev_to_OF_node(struct pci_bus *, int);
79 extern struct device_node* pci_device_to_OF_node(struct pci_dev *);
80 extern void pci_create_OF_bus_map(void);
81 #endif
82
83 extern struct resource *request_OF_resource(struct device_node* node,
84                                 int index, const char* name_postfix);
85 extern int release_OF_resource(struct device_node* node, int index);
86
87
88 /*
89  * OF address retreival & translation
90  */
91
92
93 /* Helper to read a big number; size is in cells (not bytes) */
94 static inline u64 of_read_number(const u32 *cell, int size)
95 {
96         u64 r = 0;
97         while (size--)
98                 r = (r << 32) | *(cell++);
99         return r;
100 }
101
102 /* Like of_read_number, but we want an unsigned long result */
103 #ifdef CONFIG_PPC32
104 static inline unsigned long of_read_ulong(const u32 *cell, int size)
105 {
106         return cell[size-1];
107 }
108 #else
109 #define of_read_ulong(cell, size)       of_read_number(cell, size)
110 #endif
111
112 /* Translate an OF address block into a CPU physical address
113  */
114 extern u64 of_translate_address(struct device_node *np, const u32 *addr);
115
116 /* Translate a DMA address from device space to CPU space */
117 extern u64 of_translate_dma_address(struct device_node *dev,
118                                     const u32 *in_addr);
119
120 /* Extract an address from a device, returns the region size and
121  * the address space flags too. The PCI version uses a BAR number
122  * instead of an absolute index
123  */
124 extern const u32 *of_get_address(struct device_node *dev, int index,
125                            u64 *size, unsigned int *flags);
126 #ifdef CONFIG_PCI
127 extern const u32 *of_get_pci_address(struct device_node *dev, int bar_no,
128                                u64 *size, unsigned int *flags);
129 #else
130 static inline const u32 *of_get_pci_address(struct device_node *dev,
131                 int bar_no, u64 *size, unsigned int *flags)
132 {
133         return NULL;
134 }
135 #endif /* CONFIG_PCI */
136
137 /* Get an address as a resource. Note that if your address is
138  * a PIO address, the conversion will fail if the physical address
139  * can't be internally converted to an IO token with
140  * pci_address_to_pio(), that is because it's either called to early
141  * or it can't be matched to any host bridge IO space
142  */
143 extern int of_address_to_resource(struct device_node *dev, int index,
144                                   struct resource *r);
145 #ifdef CONFIG_PCI
146 extern int of_pci_address_to_resource(struct device_node *dev, int bar,
147                                       struct resource *r);
148 #else
149 static inline int of_pci_address_to_resource(struct device_node *dev, int bar,
150                 struct resource *r)
151 {
152         return -ENOSYS;
153 }
154 #endif /* CONFIG_PCI */
155
156 /* Parse the ibm,dma-window property of an OF node into the busno, phys and
157  * size parameters.
158  */
159 void of_parse_dma_window(struct device_node *dn, const void *dma_window_prop,
160                 unsigned long *busno, unsigned long *phys, unsigned long *size);
161
162 extern void kdump_move_device_tree(void);
163
164 /* CPU OF node matching */
165 struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
166
167 /* cache lookup */
168 struct device_node *of_find_next_cache_node(struct device_node *np);
169
170 /* Get the MAC address */
171 extern const void *of_get_mac_address(struct device_node *np);
172
173 /*
174  * OF interrupt mapping
175  */
176
177 /* This structure is returned when an interrupt is mapped. The controller
178  * field needs to be put() after use
179  */
180
181 #define OF_MAX_IRQ_SPEC          4 /* We handle specifiers of at most 4 cells */
182
183 struct of_irq {
184         struct device_node *controller; /* Interrupt controller node */
185         u32 size;                       /* Specifier size */
186         u32 specifier[OF_MAX_IRQ_SPEC]; /* Specifier copy */
187 };
188
189 /**
190  * of_irq_map_init - Initialize the irq remapper
191  * @flags:      flags defining workarounds to enable
192  *
193  * Some machines have bugs in the device-tree which require certain workarounds
194  * to be applied. Call this before any interrupt mapping attempts to enable
195  * those workarounds.
196  */
197 #define OF_IMAP_OLDWORLD_MAC    0x00000001
198 #define OF_IMAP_NO_PHANDLE      0x00000002
199
200 extern void of_irq_map_init(unsigned int flags);
201
202 /**
203  * of_irq_map_raw - Low level interrupt tree parsing
204  * @parent:     the device interrupt parent
205  * @intspec:    interrupt specifier ("interrupts" property of the device)
206  * @ointsize:   size of the passed in interrupt specifier
207  * @addr:       address specifier (start of "reg" property of the device)
208  * @out_irq:    structure of_irq filled by this function
209  *
210  * Returns 0 on success and a negative number on error
211  *
212  * This function is a low-level interrupt tree walking function. It
213  * can be used to do a partial walk with synthetized reg and interrupts
214  * properties, for example when resolving PCI interrupts when no device
215  * node exist for the parent.
216  *
217  */
218
219 extern int of_irq_map_raw(struct device_node *parent, const u32 *intspec,
220                           u32 ointsize, const u32 *addr,
221                           struct of_irq *out_irq);
222
223
224 /**
225  * of_irq_map_one - Resolve an interrupt for a device
226  * @device:     the device whose interrupt is to be resolved
227  * @index:      index of the interrupt to resolve
228  * @out_irq:    structure of_irq filled by this function
229  *
230  * This function resolves an interrupt, walking the tree, for a given
231  * device-tree node. It's the high level pendant to of_irq_map_raw().
232  * It also implements the workarounds for OldWolrd Macs.
233  */
234 extern int of_irq_map_one(struct device_node *device, int index,
235                           struct of_irq *out_irq);
236
237 /**
238  * of_irq_map_pci - Resolve the interrupt for a PCI device
239  * @pdev:       the device whose interrupt is to be resolved
240  * @out_irq:    structure of_irq filled by this function
241  *
242  * This function resolves the PCI interrupt for a given PCI device. If a
243  * device-node exists for a given pci_dev, it will use normal OF tree
244  * walking. If not, it will implement standard swizzling and walk up the
245  * PCI tree until an device-node is found, at which point it will finish
246  * resolving using the OF tree walking.
247  */
248 struct pci_dev;
249 extern int of_irq_map_pci(struct pci_dev *pdev, struct of_irq *out_irq);
250
251 extern int of_irq_to_resource(struct device_node *dev, int index,
252                         struct resource *r);
253
254 /**
255  * of_iomap - Maps the memory mapped IO for a given device_node
256  * @device:     the device whose io range will be mapped
257  * @index:      index of the io range
258  *
259  * Returns a pointer to the mapped memory
260  */
261 extern void __iomem *of_iomap(struct device_node *device, int index);
262
263 #endif /* __KERNEL__ */
264 #endif /* _POWERPC_PROM_H */