[POWERPC] Fix warning in powermac pci.c
[linux-2.6-block.git] / include / asm-powerpc / prom.h
CommitLineData
9b6b563c
PM
1#ifndef _POWERPC_PROM_H
2#define _POWERPC_PROM_H
3#ifdef __KERNEL__
4
5/*
6 * Definitions for talking to the Open Firmware PROM on
7 * Power Macintosh computers.
8 *
9 * Copyright (C) 1996-2005 Paul Mackerras.
10 *
11 * Updates for PPC64 by Peter Bergner & David Engebretsen, 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/proc_fs.h>
a9b14973 20#include <linux/platform_device.h>
9b6b563c
PM
21#include <asm/atomic.h>
22
23/* Definitions used by the flattened device tree */
24#define OF_DT_HEADER 0xd00dfeed /* marker */
25#define OF_DT_BEGIN_NODE 0x1 /* Start of node, full name */
26#define OF_DT_END_NODE 0x2 /* End node */
27#define OF_DT_PROP 0x3 /* Property: name off, size,
28 * content */
29#define OF_DT_NOP 0x4 /* nop */
30#define OF_DT_END 0x9
31
32#define OF_DT_VERSION 0x10
33
34/*
35 * This is what gets passed to the kernel by prom_init or kexec
36 *
37 * The dt struct contains the device tree structure, full pathes and
38 * property contents. The dt strings contain a separate block with just
39 * the strings for the property names, and is fully page aligned and
40 * self contained in a page, so that it can be kept around by the kernel,
41 * each property name appears only once in this page (cheap compression)
42 *
43 * the mem_rsvmap contains a map of reserved ranges of physical memory,
44 * passing it here instead of in the device-tree itself greatly simplifies
45 * the job of everybody. It's just a list of u64 pairs (base/size) that
46 * ends when size is 0
47 */
48struct boot_param_header
49{
50 u32 magic; /* magic word OF_DT_HEADER */
51 u32 totalsize; /* total size of DT block */
52 u32 off_dt_struct; /* offset to structure */
53 u32 off_dt_strings; /* offset to strings */
54 u32 off_mem_rsvmap; /* offset to memory reserve map */
55 u32 version; /* format version */
56 u32 last_comp_version; /* last compatible version */
57 /* version 2 fields below */
58 u32 boot_cpuid_phys; /* Physical CPU id we're booting on */
59 /* version 3 fields below */
60 u32 dt_strings_size; /* size of the DT strings block */
61};
62
63
64
65typedef u32 phandle;
66typedef u32 ihandle;
67
9b6b563c
PM
68struct property {
69 char *name;
70 int length;
71 unsigned char *value;
72 struct property *next;
73};
74
75struct device_node {
a7f67bdf
JK
76 const char *name;
77 const char *type;
9b6b563c
PM
78 phandle node;
79 phandle linux_phandle;
9b6b563c
PM
80 char *full_name;
81
82 struct property *properties;
088186de 83 struct property *deadprops; /* removed properties */
9b6b563c
PM
84 struct device_node *parent;
85 struct device_node *child;
86 struct device_node *sibling;
87 struct device_node *next; /* next device of same type */
88 struct device_node *allnext; /* next in list of all nodes */
89 struct proc_dir_entry *pde; /* this node's proc directory */
90 struct kref kref;
91 unsigned long _flags;
92 void *data;
93};
94
95extern struct device_node *of_chosen;
96
97/* flag descriptions */
98#define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
99
100#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
101#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
102
103#define HAVE_ARCH_DEVTREE_FIXUPS
104
105static inline void set_node_proc_entry(struct device_node *dn, struct proc_dir_entry *de)
106{
107 dn->pde = de;
108}
109
110
111/* OBSOLETE: Old style node lookup */
bf20a000
PM
112extern struct device_node *find_devices(const char *name);
113extern struct device_node *find_type_devices(const char *type);
114extern struct device_node *find_path_device(const char *path);
115extern struct device_node *find_compatible_devices(const char *type,
9b6b563c 116 const char *compat);
bf20a000 117extern struct device_node *find_all_nodes(void);
9b6b563c
PM
118
119/* New style node lookup */
120extern struct device_node *of_find_node_by_name(struct device_node *from,
121 const char *name);
e3385222
CH
122#define for_each_node_by_name(dn, name) \
123 for (dn = of_find_node_by_name(NULL, name); dn; \
124 dn = of_find_node_by_name(dn, name))
9b6b563c
PM
125extern struct device_node *of_find_node_by_type(struct device_node *from,
126 const char *type);
e3385222
CH
127#define for_each_node_by_type(dn, type) \
128 for (dn = of_find_node_by_type(NULL, type); dn; \
129 dn = of_find_node_by_type(dn, type))
9b6b563c
PM
130extern struct device_node *of_find_compatible_node(struct device_node *from,
131 const char *type, const char *compat);
132extern struct device_node *of_find_node_by_path(const char *path);
133extern struct device_node *of_find_node_by_phandle(phandle handle);
134extern struct device_node *of_find_all_nodes(struct device_node *prev);
135extern struct device_node *of_get_parent(const struct device_node *node);
136extern struct device_node *of_get_next_child(const struct device_node *node,
137 struct device_node *prev);
e2100efb 138extern struct property *of_find_property(const struct device_node *np,
ecaa8b0f
DB
139 const char *name,
140 int *lenp);
9b6b563c
PM
141extern struct device_node *of_node_get(struct device_node *node);
142extern void of_node_put(struct device_node *node);
143
3c726f8d 144/* For scanning the flat device-tree at boot time */
e8222502
BH
145extern int __init of_scan_flat_dt(int (*it)(unsigned long node,
146 const char *uname, int depth,
147 void *data),
148 void *data);
149extern void* __init of_get_flat_dt_prop(unsigned long node, const char *name,
150 unsigned long *size);
151extern int __init of_flat_dt_is_compatible(unsigned long node, const char *name);
152extern unsigned long __init of_get_flat_dt_root(void);
3c726f8d 153
9b6b563c
PM
154/* For updating the device tree at runtime */
155extern void of_attach_node(struct device_node *);
156extern void of_detach_node(const struct device_node *);
157
158/* Other Prototypes */
159extern void finish_device_tree(void);
160extern void unflatten_device_tree(void);
161extern void early_init_devtree(void *);
e2100efb
BH
162extern int device_is_compatible(const struct device_node *device,
163 const char *);
9b6b563c 164extern int machine_is_compatible(const char *compat);
e2100efb
BH
165extern const void *get_property(const struct device_node *node,
166 const char *name,
167 int *lenp);
9b6b563c
PM
168extern void print_properties(struct device_node *node);
169extern int prom_n_addr_cells(struct device_node* np);
170extern int prom_n_size_cells(struct device_node* np);
171extern int prom_n_intr_cells(struct device_node* np);
172extern void prom_get_irq_senses(unsigned char *senses, int off, int max);
183d0202 173extern int prom_add_property(struct device_node* np, struct property* prop);
088186de
DB
174extern int prom_remove_property(struct device_node *np, struct property *prop);
175extern int prom_update_property(struct device_node *np,
176 struct property *newprop,
177 struct property *oldprop);
9b6b563c 178
40ef8cbc 179#ifdef CONFIG_PPC32
9b6b563c
PM
180/*
181 * PCI <-> OF matching functions
182 * (XXX should these be here?)
183 */
184struct pci_bus;
185struct pci_dev;
186extern int pci_device_from_OF_node(struct device_node *node,
187 u8* bus, u8* devfn);
188extern struct device_node* pci_busdev_to_OF_node(struct pci_bus *, int);
189extern struct device_node* pci_device_to_OF_node(struct pci_dev *);
190extern void pci_create_OF_bus_map(void);
40ef8cbc
PM
191#endif
192
9b6b563c
PM
193extern struct resource *request_OF_resource(struct device_node* node,
194 int index, const char* name_postfix);
195extern int release_OF_resource(struct device_node* node, int index);
196
d2dd482b 197
d1405b86 198/*
d2dd482b
BH
199 * OF address retreival & translation
200 */
201
202
a4dc7ff0 203/* Helper to read a big number; size is in cells (not bytes) */
b5a1a9ab 204static inline u64 of_read_number(const u32 *cell, int size)
cc9fd71c
BH
205{
206 u64 r = 0;
207 while (size--)
208 r = (r << 32) | *(cell++);
209 return r;
210}
211
a4dc7ff0
PM
212/* Like of_read_number, but we want an unsigned long result */
213#ifdef CONFIG_PPC32
214static inline unsigned long of_read_ulong(const u32 *cell, int size)
215{
216 return cell[size-1];
217}
218#else
219#define of_read_ulong(cell, size) of_read_number(cell, size)
220#endif
221
d2dd482b 222/* Translate an OF address block into a CPU physical address
d1405b86
BH
223 */
224#define OF_BAD_ADDR ((u64)-1)
a7f67bdf 225extern u64 of_translate_address(struct device_node *np, const u32 *addr);
d1405b86 226
d2dd482b
BH
227/* Extract an address from a device, returns the region size and
228 * the address space flags too. The PCI version uses a BAR number
229 * instead of an absolute index
230 */
a7f67bdf 231extern const u32 *of_get_address(struct device_node *dev, int index,
d2dd482b 232 u64 *size, unsigned int *flags);
a7f67bdf 233extern const u32 *of_get_pci_address(struct device_node *dev, int bar_no,
d2dd482b
BH
234 u64 *size, unsigned int *flags);
235
236/* Get an address as a resource. Note that if your address is
237 * a PIO address, the conversion will fail if the physical address
238 * can't be internally converted to an IO token with
239 * pci_address_to_pio(), that is because it's either called to early
240 * or it can't be matched to any host bridge IO space
241 */
242extern int of_address_to_resource(struct device_node *dev, int index,
243 struct resource *r);
244extern int of_pci_address_to_resource(struct device_node *dev, int bar,
245 struct resource *r);
d1405b86 246
d4ad66fa
JK
247/* Parse the ibm,dma-window property of an OF node into the busno, phys and
248 * size parameters.
249 */
a7f67bdf 250void of_parse_dma_window(struct device_node *dn, const void *dma_window_prop,
d4ad66fa
JK
251 unsigned long *busno, unsigned long *phys, unsigned long *size);
252
b68239ee
ME
253extern void kdump_move_device_tree(void);
254
acf7d768
BH
255/* CPU OF node matching */
256struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
257
29cfe6f4
TT
258/* Get the MAC address */
259extern const void *of_get_mac_address(struct device_node *np);
cc9fd71c
BH
260
261/*
262 * OF interrupt mapping
263 */
264
265/* This structure is returned when an interrupt is mapped. The controller
266 * field needs to be put() after use
267 */
268
269#define OF_MAX_IRQ_SPEC 4 /* We handle specifiers of at most 4 cells */
270
271struct of_irq {
272 struct device_node *controller; /* Interrupt controller node */
273 u32 size; /* Specifier size */
274 u32 specifier[OF_MAX_IRQ_SPEC]; /* Specifier copy */
275};
276
40681b95 277/**
cc9fd71c
BH
278 * of_irq_map_init - Initialize the irq remapper
279 * @flags: flags defining workarounds to enable
280 *
281 * Some machines have bugs in the device-tree which require certain workarounds
282 * to be applied. Call this before any interrupt mapping attempts to enable
283 * those workarounds.
284 */
285#define OF_IMAP_OLDWORLD_MAC 0x00000001
286#define OF_IMAP_NO_PHANDLE 0x00000002
287
288extern void of_irq_map_init(unsigned int flags);
289
40681b95 290/**
cc9fd71c
BH
291 * of_irq_map_raw - Low level interrupt tree parsing
292 * @parent: the device interrupt parent
293 * @intspec: interrupt specifier ("interrupts" property of the device)
006b64de 294 * @ointsize: size of the passed in interrupt specifier
cc9fd71c
BH
295 * @addr: address specifier (start of "reg" property of the device)
296 * @out_irq: structure of_irq filled by this function
297 *
298 * Returns 0 on success and a negative number on error
299 *
300 * This function is a low-level interrupt tree walking function. It
301 * can be used to do a partial walk with synthetized reg and interrupts
302 * properties, for example when resolving PCI interrupts when no device
303 * node exist for the parent.
304 *
305 */
306
a7f67bdf 307extern int of_irq_map_raw(struct device_node *parent, const u32 *intspec,
aa43f779 308 u32 ointsize, const u32 *addr,
cc9fd71c
BH
309 struct of_irq *out_irq);
310
311
40681b95 312/**
cc9fd71c
BH
313 * of_irq_map_one - Resolve an interrupt for a device
314 * @device: the device whose interrupt is to be resolved
315 * @index: index of the interrupt to resolve
316 * @out_irq: structure of_irq filled by this function
317 *
318 * This function resolves an interrupt, walking the tree, for a given
319 * device-tree node. It's the high level pendant to of_irq_map_raw().
320 * It also implements the workarounds for OldWolrd Macs.
321 */
322extern int of_irq_map_one(struct device_node *device, int index,
323 struct of_irq *out_irq);
324
40681b95 325/**
cc9fd71c
BH
326 * of_irq_map_pci - Resolve the interrupt for a PCI device
327 * @pdev: the device whose interrupt is to be resolved
328 * @out_irq: structure of_irq filled by this function
329 *
330 * This function resolves the PCI interrupt for a given PCI device. If a
331 * device-node exists for a given pci_dev, it will use normal OF tree
332 * walking. If not, it will implement standard swizzling and walk up the
333 * PCI tree until an device-node is found, at which point it will finish
334 * resolving using the OF tree walking.
335 */
336struct pci_dev;
337extern int of_irq_map_pci(struct pci_dev *pdev, struct of_irq *out_irq);
338
66a91e9c 339static inline int of_irq_to_resource(struct device_node *dev, int index, struct resource *r)
a9b14973 340{
66a91e9c
AF
341 int irq = irq_of_parse_and_map(dev, index);
342
343 /* Only dereference the resource if both the
344 * resource and the irq are valid. */
345 if (r && irq != NO_IRQ) {
346 r->start = r->end = irq;
347 r->flags = IORESOURCE_IRQ;
348 }
349
350 return irq;
a9b14973
AF
351}
352
cc9fd71c 353
9b6b563c
PM
354#endif /* __KERNEL__ */
355#endif /* _POWERPC_PROM_H */