blob: 56f6ea0c76de9b7eb7e1421d9afdc04cc8a3c206 [file] [log] [blame]
Paul Mackerras9b6b5632005-10-06 12:06:20 +10001#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>
20#include <asm/atomic.h>
21
22/* Definitions used by the flattened device tree */
23#define OF_DT_HEADER 0xd00dfeed /* marker */
24#define OF_DT_BEGIN_NODE 0x1 /* Start of node, full name */
25#define OF_DT_END_NODE 0x2 /* End node */
26#define OF_DT_PROP 0x3 /* Property: name off, size,
27 * content */
28#define OF_DT_NOP 0x4 /* nop */
29#define OF_DT_END 0x9
30
31#define OF_DT_VERSION 0x10
32
33/*
34 * This is what gets passed to the kernel by prom_init or kexec
35 *
36 * The dt struct contains the device tree structure, full pathes and
37 * property contents. The dt strings contain a separate block with just
38 * the strings for the property names, and is fully page aligned and
39 * self contained in a page, so that it can be kept around by the kernel,
40 * each property name appears only once in this page (cheap compression)
41 *
42 * the mem_rsvmap contains a map of reserved ranges of physical memory,
43 * passing it here instead of in the device-tree itself greatly simplifies
44 * the job of everybody. It's just a list of u64 pairs (base/size) that
45 * ends when size is 0
46 */
47struct boot_param_header
48{
49 u32 magic; /* magic word OF_DT_HEADER */
50 u32 totalsize; /* total size of DT block */
51 u32 off_dt_struct; /* offset to structure */
52 u32 off_dt_strings; /* offset to strings */
53 u32 off_mem_rsvmap; /* offset to memory reserve map */
54 u32 version; /* format version */
55 u32 last_comp_version; /* last compatible version */
56 /* version 2 fields below */
57 u32 boot_cpuid_phys; /* Physical CPU id we're booting on */
58 /* version 3 fields below */
59 u32 dt_strings_size; /* size of the DT strings block */
60};
61
62
63
64typedef u32 phandle;
65typedef u32 ihandle;
66
Paul Mackerras9b6b5632005-10-06 12:06:20 +100067struct property {
68 char *name;
69 int length;
70 unsigned char *value;
71 struct property *next;
72};
73
74struct device_node {
75 char *name;
76 char *type;
77 phandle node;
78 phandle linux_phandle;
Paul Mackerras9b6b5632005-10-06 12:06:20 +100079 char *full_name;
80
81 struct property *properties;
Dave C Boutcher088186d2006-01-12 16:08:27 -060082 struct property *deadprops; /* removed properties */
Paul Mackerras9b6b5632005-10-06 12:06:20 +100083 struct device_node *parent;
84 struct device_node *child;
85 struct device_node *sibling;
86 struct device_node *next; /* next device of same type */
87 struct device_node *allnext; /* next in list of all nodes */
88 struct proc_dir_entry *pde; /* this node's proc directory */
89 struct kref kref;
90 unsigned long _flags;
91 void *data;
92};
93
94extern struct device_node *of_chosen;
95
96/* flag descriptions */
97#define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
98
99#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
100#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
101
102#define HAVE_ARCH_DEVTREE_FIXUPS
103
104static inline void set_node_proc_entry(struct device_node *dn, struct proc_dir_entry *de)
105{
106 dn->pde = de;
107}
108
109
110/* OBSOLETE: Old style node lookup */
Paul Mackerrasbf20a002005-10-27 16:45:29 +1000111extern struct device_node *find_devices(const char *name);
112extern struct device_node *find_type_devices(const char *type);
113extern struct device_node *find_path_device(const char *path);
114extern struct device_node *find_compatible_devices(const char *type,
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000115 const char *compat);
Paul Mackerrasbf20a002005-10-27 16:45:29 +1000116extern struct device_node *find_all_nodes(void);
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000117
118/* New style node lookup */
119extern struct device_node *of_find_node_by_name(struct device_node *from,
120 const char *name);
Christoph Hellwige3385222006-03-08 16:47:00 +0100121#define for_each_node_by_name(dn, name) \
122 for (dn = of_find_node_by_name(NULL, name); dn; \
123 dn = of_find_node_by_name(dn, name))
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000124extern struct device_node *of_find_node_by_type(struct device_node *from,
125 const char *type);
Christoph Hellwige3385222006-03-08 16:47:00 +0100126#define for_each_node_by_type(dn, type) \
127 for (dn = of_find_node_by_type(NULL, type); dn; \
128 dn = of_find_node_by_type(dn, type))
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000129extern struct device_node *of_find_compatible_node(struct device_node *from,
130 const char *type, const char *compat);
131extern struct device_node *of_find_node_by_path(const char *path);
132extern struct device_node *of_find_node_by_phandle(phandle handle);
133extern struct device_node *of_find_all_nodes(struct device_node *prev);
134extern struct device_node *of_get_parent(const struct device_node *node);
135extern struct device_node *of_get_next_child(const struct device_node *node,
136 struct device_node *prev);
Dave C Boutcherecaa8b02006-01-12 16:09:29 -0600137extern struct property *of_find_property(struct device_node *np,
138 const char *name,
139 int *lenp);
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000140extern struct device_node *of_node_get(struct device_node *node);
141extern void of_node_put(struct device_node *node);
142
Benjamin Herrenschmidt3c726f82005-11-07 11:06:55 +1100143/* For scanning the flat device-tree at boot time */
Benjamin Herrenschmidte8222502006-03-28 23:15:54 +1100144extern int __init of_scan_flat_dt(int (*it)(unsigned long node,
145 const char *uname, int depth,
146 void *data),
147 void *data);
148extern void* __init of_get_flat_dt_prop(unsigned long node, const char *name,
149 unsigned long *size);
150extern int __init of_flat_dt_is_compatible(unsigned long node, const char *name);
151extern unsigned long __init of_get_flat_dt_root(void);
Benjamin Herrenschmidt3c726f82005-11-07 11:06:55 +1100152
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000153/* For updating the device tree at runtime */
154extern void of_attach_node(struct device_node *);
155extern void of_detach_node(const struct device_node *);
156
157/* Other Prototypes */
158extern void finish_device_tree(void);
159extern void unflatten_device_tree(void);
160extern void early_init_devtree(void *);
161extern int device_is_compatible(struct device_node *device, const char *);
162extern int machine_is_compatible(const char *compat);
Jeremy Kerra1af5b22006-06-29 20:28:18 +1000163extern void *get_property(struct device_node *node, const char *name,
164 int *lenp);
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000165extern void print_properties(struct device_node *node);
166extern int prom_n_addr_cells(struct device_node* np);
167extern int prom_n_size_cells(struct device_node* np);
168extern int prom_n_intr_cells(struct device_node* np);
169extern void prom_get_irq_senses(unsigned char *senses, int off, int max);
Benjamin Herrenschmidt183d0202005-11-07 14:29:02 +1100170extern int prom_add_property(struct device_node* np, struct property* prop);
Dave C Boutcher088186d2006-01-12 16:08:27 -0600171extern int prom_remove_property(struct device_node *np, struct property *prop);
172extern int prom_update_property(struct device_node *np,
173 struct property *newprop,
174 struct property *oldprop);
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000175
Paul Mackerras40ef8cb2005-10-10 22:50:37 +1000176#ifdef CONFIG_PPC32
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000177/*
178 * PCI <-> OF matching functions
179 * (XXX should these be here?)
180 */
181struct pci_bus;
182struct pci_dev;
183extern int pci_device_from_OF_node(struct device_node *node,
184 u8* bus, u8* devfn);
185extern struct device_node* pci_busdev_to_OF_node(struct pci_bus *, int);
186extern struct device_node* pci_device_to_OF_node(struct pci_dev *);
187extern void pci_create_OF_bus_map(void);
Paul Mackerras40ef8cb2005-10-10 22:50:37 +1000188#endif
189
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000190extern struct resource *request_OF_resource(struct device_node* node,
191 int index, const char* name_postfix);
192extern int release_OF_resource(struct device_node* node, int index);
193
Benjamin Herrenschmidtd2dd4822005-11-30 16:57:28 +1100194
Benjamin Herrenschmidtd1405b82005-11-23 17:53:42 +1100195/*
Benjamin Herrenschmidtd2dd4822005-11-30 16:57:28 +1100196 * OF address retreival & translation
197 */
198
199
Benjamin Herrenschmidtcc9fd712006-07-03 19:35:17 +1000200/* Helper to read a big number */
Jeremy Kerrb5a1a9a2006-07-04 16:46:44 +1000201static inline u64 of_read_number(const u32 *cell, int size)
Benjamin Herrenschmidtcc9fd712006-07-03 19:35:17 +1000202{
203 u64 r = 0;
204 while (size--)
205 r = (r << 32) | *(cell++);
206 return r;
207}
208
Benjamin Herrenschmidtd2dd4822005-11-30 16:57:28 +1100209/* Translate an OF address block into a CPU physical address
Benjamin Herrenschmidtd1405b82005-11-23 17:53:42 +1100210 */
211#define OF_BAD_ADDR ((u64)-1)
212extern u64 of_translate_address(struct device_node *np, u32 *addr);
Benjamin Herrenschmidtd1405b82005-11-23 17:53:42 +1100213
Benjamin Herrenschmidtd2dd4822005-11-30 16:57:28 +1100214/* Extract an address from a device, returns the region size and
215 * the address space flags too. The PCI version uses a BAR number
216 * instead of an absolute index
217 */
218extern u32 *of_get_address(struct device_node *dev, int index,
219 u64 *size, unsigned int *flags);
220extern u32 *of_get_pci_address(struct device_node *dev, int bar_no,
221 u64 *size, unsigned int *flags);
222
223/* Get an address as a resource. Note that if your address is
224 * a PIO address, the conversion will fail if the physical address
225 * can't be internally converted to an IO token with
226 * pci_address_to_pio(), that is because it's either called to early
227 * or it can't be matched to any host bridge IO space
228 */
229extern int of_address_to_resource(struct device_node *dev, int index,
230 struct resource *r);
231extern int of_pci_address_to_resource(struct device_node *dev, int bar,
232 struct resource *r);
Benjamin Herrenschmidtd1405b82005-11-23 17:53:42 +1100233
Jeremy Kerrd4ad66f2006-05-18 18:05:15 +1000234/* Parse the ibm,dma-window property of an OF node into the busno, phys and
235 * size parameters.
236 */
237void of_parse_dma_window(struct device_node *dn, unsigned char *dma_window_prop,
238 unsigned long *busno, unsigned long *phys, unsigned long *size);
239
Michael Ellermanb68239e2006-02-03 19:05:47 +1100240extern void kdump_move_device_tree(void);
241
Benjamin Herrenschmidtacf7d762006-06-19 20:33:16 +0200242/* CPU OF node matching */
243struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
244
Benjamin Herrenschmidtcc9fd712006-07-03 19:35:17 +1000245
246/*
247 * OF interrupt mapping
248 */
249
250/* This structure is returned when an interrupt is mapped. The controller
251 * field needs to be put() after use
252 */
253
254#define OF_MAX_IRQ_SPEC 4 /* We handle specifiers of at most 4 cells */
255
256struct of_irq {
257 struct device_node *controller; /* Interrupt controller node */
258 u32 size; /* Specifier size */
259 u32 specifier[OF_MAX_IRQ_SPEC]; /* Specifier copy */
260};
261
262/***
263 * of_irq_map_init - Initialize the irq remapper
264 * @flags: flags defining workarounds to enable
265 *
266 * Some machines have bugs in the device-tree which require certain workarounds
267 * to be applied. Call this before any interrupt mapping attempts to enable
268 * those workarounds.
269 */
270#define OF_IMAP_OLDWORLD_MAC 0x00000001
271#define OF_IMAP_NO_PHANDLE 0x00000002
272
273extern void of_irq_map_init(unsigned int flags);
274
275/***
276 * of_irq_map_raw - Low level interrupt tree parsing
277 * @parent: the device interrupt parent
278 * @intspec: interrupt specifier ("interrupts" property of the device)
279 * @addr: address specifier (start of "reg" property of the device)
280 * @out_irq: structure of_irq filled by this function
281 *
282 * Returns 0 on success and a negative number on error
283 *
284 * This function is a low-level interrupt tree walking function. It
285 * can be used to do a partial walk with synthetized reg and interrupts
286 * properties, for example when resolving PCI interrupts when no device
287 * node exist for the parent.
288 *
289 */
290
291extern int of_irq_map_raw(struct device_node *parent, u32 *intspec, u32 *addr,
292 struct of_irq *out_irq);
293
294
295/***
296 * of_irq_map_one - Resolve an interrupt for a device
297 * @device: the device whose interrupt is to be resolved
298 * @index: index of the interrupt to resolve
299 * @out_irq: structure of_irq filled by this function
300 *
301 * This function resolves an interrupt, walking the tree, for a given
302 * device-tree node. It's the high level pendant to of_irq_map_raw().
303 * It also implements the workarounds for OldWolrd Macs.
304 */
305extern int of_irq_map_one(struct device_node *device, int index,
306 struct of_irq *out_irq);
307
308/***
309 * of_irq_map_pci - Resolve the interrupt for a PCI device
310 * @pdev: the device whose interrupt is to be resolved
311 * @out_irq: structure of_irq filled by this function
312 *
313 * This function resolves the PCI interrupt for a given PCI device. If a
314 * device-node exists for a given pci_dev, it will use normal OF tree
315 * walking. If not, it will implement standard swizzling and walk up the
316 * PCI tree until an device-node is found, at which point it will finish
317 * resolving using the OF tree walking.
318 */
319struct pci_dev;
320extern int of_irq_map_pci(struct pci_dev *pdev, struct of_irq *out_irq);
321
322
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000323#endif /* __KERNEL__ */
324#endif /* _POWERPC_PROM_H */