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