blob: 78b7b0d494c0b353ea67659a969a20b84b3bfb86 [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>
Andy Fleminga9b14972006-10-19 19:52:26 -050020#include <linux/platform_device.h>
Andrew Morton99ddef92007-02-17 18:17:16 -070021#include <asm/irq.h>
Paul Mackerras9b6b5632005-10-06 12:06:20 +100022#include <asm/atomic.h>
23
Stephen Rothwell97e873e2007-05-01 16:26:07 +100024#define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
25#define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
26
Scott Wood804ace82007-08-21 02:36:59 +100027#define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
Stephen Rothwell581b6052007-04-24 16:46:53 +100028#define of_prop_cmp(s1, s2) strcmp((s1), (s2))
Stephen Rothwell1ef4d422007-04-24 17:57:33 +100029#define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
Stephen Rothwell0081cbc2007-05-01 16:29:19 +100030
Paul Mackerras9b6b5632005-10-06 12:06:20 +100031/* Definitions used by the flattened device tree */
32#define OF_DT_HEADER 0xd00dfeed /* marker */
33#define OF_DT_BEGIN_NODE 0x1 /* Start of node, full name */
34#define OF_DT_END_NODE 0x2 /* End node */
35#define OF_DT_PROP 0x3 /* Property: name off, size,
36 * content */
37#define OF_DT_NOP 0x4 /* nop */
38#define OF_DT_END 0x9
39
40#define OF_DT_VERSION 0x10
41
42/*
43 * This is what gets passed to the kernel by prom_init or kexec
44 *
45 * The dt struct contains the device tree structure, full pathes and
46 * property contents. The dt strings contain a separate block with just
47 * the strings for the property names, and is fully page aligned and
48 * self contained in a page, so that it can be kept around by the kernel,
49 * each property name appears only once in this page (cheap compression)
50 *
51 * the mem_rsvmap contains a map of reserved ranges of physical memory,
52 * passing it here instead of in the device-tree itself greatly simplifies
53 * the job of everybody. It's just a list of u64 pairs (base/size) that
54 * ends when size is 0
55 */
56struct boot_param_header
57{
58 u32 magic; /* magic word OF_DT_HEADER */
59 u32 totalsize; /* total size of DT block */
60 u32 off_dt_struct; /* offset to structure */
61 u32 off_dt_strings; /* offset to strings */
62 u32 off_mem_rsvmap; /* offset to memory reserve map */
63 u32 version; /* format version */
64 u32 last_comp_version; /* last compatible version */
65 /* version 2 fields below */
66 u32 boot_cpuid_phys; /* Physical CPU id we're booting on */
67 /* version 3 fields below */
68 u32 dt_strings_size; /* size of the DT strings block */
David Gibson0e0293c2007-03-14 11:50:40 +110069 /* version 17 fields below */
70 u32 dt_struct_size; /* size of the DT structure block */
Paul Mackerras9b6b5632005-10-06 12:06:20 +100071};
72
73
74
75typedef u32 phandle;
76typedef u32 ihandle;
77
Paul Mackerras9b6b5632005-10-06 12:06:20 +100078struct property {
79 char *name;
80 int length;
Stephen Rothwell1a381472007-04-03 10:58:52 +100081 void *value;
Paul Mackerras9b6b5632005-10-06 12:06:20 +100082 struct property *next;
83};
84
85struct device_node {
Jeremy Kerra7f67bd2006-07-12 15:35:54 +100086 const char *name;
87 const char *type;
Paul Mackerras9b6b5632005-10-06 12:06:20 +100088 phandle node;
89 phandle linux_phandle;
Paul Mackerras9b6b5632005-10-06 12:06:20 +100090 char *full_name;
91
92 struct property *properties;
Dave C Boutcher088186d2006-01-12 16:08:27 -060093 struct property *deadprops; /* removed properties */
Paul Mackerras9b6b5632005-10-06 12:06:20 +100094 struct device_node *parent;
95 struct device_node *child;
96 struct device_node *sibling;
97 struct device_node *next; /* next device of same type */
98 struct device_node *allnext; /* next in list of all nodes */
99 struct proc_dir_entry *pde; /* this node's proc directory */
100 struct kref kref;
101 unsigned long _flags;
102 void *data;
103};
104
105extern struct device_node *of_chosen;
106
Michael Ellermand3b814b2007-06-19 16:07:58 +1000107static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
108{
109 return test_bit(flag, &n->_flags);
110}
111
112static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
113{
114 set_bit(flag, &n->_flags);
115}
116
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000117
118#define HAVE_ARCH_DEVTREE_FIXUPS
119
120static inline void set_node_proc_entry(struct device_node *dn, struct proc_dir_entry *de)
121{
122 dn->pde = de;
123}
124
125
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000126extern struct device_node *of_find_all_nodes(struct device_node *prev);
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000127extern struct device_node *of_node_get(struct device_node *node);
128extern void of_node_put(struct device_node *node);
129
Benjamin Herrenschmidt3c726f82005-11-07 11:06:55 +1100130/* For scanning the flat device-tree at boot time */
Benjamin Herrenschmidte8222502006-03-28 23:15:54 +1100131extern int __init of_scan_flat_dt(int (*it)(unsigned long node,
132 const char *uname, int depth,
133 void *data),
134 void *data);
135extern void* __init of_get_flat_dt_prop(unsigned long node, const char *name,
136 unsigned long *size);
137extern int __init of_flat_dt_is_compatible(unsigned long node, const char *name);
138extern unsigned long __init of_get_flat_dt_root(void);
Benjamin Herrenschmidt3c726f82005-11-07 11:06:55 +1100139
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000140/* For updating the device tree at runtime */
141extern void of_attach_node(struct device_node *);
Segher Boessenkool34f329d2007-07-20 15:58:38 +1000142extern void of_detach_node(struct device_node *);
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000143
144/* Other Prototypes */
145extern void finish_device_tree(void);
146extern void unflatten_device_tree(void);
147extern void early_init_devtree(void *);
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000148extern int machine_is_compatible(const char *compat);
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000149extern void print_properties(struct device_node *node);
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000150extern int prom_n_intr_cells(struct device_node* np);
151extern void prom_get_irq_senses(unsigned char *senses, int off, int max);
Benjamin Herrenschmidt183d0202005-11-07 14:29:02 +1100152extern int prom_add_property(struct device_node* np, struct property* prop);
Dave C Boutcher088186d2006-01-12 16:08:27 -0600153extern int prom_remove_property(struct device_node *np, struct property *prop);
154extern int prom_update_property(struct device_node *np,
155 struct property *newprop,
156 struct property *oldprop);
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000157
Paul Mackerras40ef8cb2005-10-10 22:50:37 +1000158#ifdef CONFIG_PPC32
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000159/*
160 * PCI <-> OF matching functions
161 * (XXX should these be here?)
162 */
163struct pci_bus;
164struct pci_dev;
165extern int pci_device_from_OF_node(struct device_node *node,
166 u8* bus, u8* devfn);
167extern struct device_node* pci_busdev_to_OF_node(struct pci_bus *, int);
168extern struct device_node* pci_device_to_OF_node(struct pci_dev *);
169extern void pci_create_OF_bus_map(void);
Paul Mackerras40ef8cb2005-10-10 22:50:37 +1000170#endif
171
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000172extern struct resource *request_OF_resource(struct device_node* node,
173 int index, const char* name_postfix);
174extern int release_OF_resource(struct device_node* node, int index);
175
Benjamin Herrenschmidtd2dd4822005-11-30 16:57:28 +1100176
Benjamin Herrenschmidtd1405b82005-11-23 17:53:42 +1100177/*
Benjamin Herrenschmidtd2dd4822005-11-30 16:57:28 +1100178 * OF address retreival & translation
179 */
180
181
Paul Mackerrasa4dc7ff2006-09-19 14:06:27 +1000182/* Helper to read a big number; size is in cells (not bytes) */
Jeremy Kerrb5a1a9a2006-07-04 16:46:44 +1000183static inline u64 of_read_number(const u32 *cell, int size)
Benjamin Herrenschmidtcc9fd712006-07-03 19:35:17 +1000184{
185 u64 r = 0;
186 while (size--)
187 r = (r << 32) | *(cell++);
188 return r;
189}
190
Paul Mackerrasa4dc7ff2006-09-19 14:06:27 +1000191/* Like of_read_number, but we want an unsigned long result */
192#ifdef CONFIG_PPC32
193static inline unsigned long of_read_ulong(const u32 *cell, int size)
194{
195 return cell[size-1];
196}
197#else
198#define of_read_ulong(cell, size) of_read_number(cell, size)
199#endif
200
Benjamin Herrenschmidtd2dd4822005-11-30 16:57:28 +1100201/* Translate an OF address block into a CPU physical address
Benjamin Herrenschmidtd1405b82005-11-23 17:53:42 +1100202 */
Jeremy Kerra7f67bd2006-07-12 15:35:54 +1000203extern u64 of_translate_address(struct device_node *np, const u32 *addr);
Benjamin Herrenschmidtd1405b82005-11-23 17:53:42 +1100204
Benjamin Herrenschmidt837c54d2007-12-11 14:48:22 +1100205/* Translate a DMA address from device space to CPU space */
206extern u64 of_translate_dma_address(struct device_node *dev,
207 const u32 *in_addr);
208
Benjamin Herrenschmidtd2dd4822005-11-30 16:57:28 +1100209/* Extract an address from a device, returns the region size and
210 * the address space flags too. The PCI version uses a BAR number
211 * instead of an absolute index
212 */
Jeremy Kerra7f67bd2006-07-12 15:35:54 +1000213extern const u32 *of_get_address(struct device_node *dev, int index,
Benjamin Herrenschmidtd2dd4822005-11-30 16:57:28 +1100214 u64 *size, unsigned int *flags);
Jeremy Kerra7f67bd2006-07-12 15:35:54 +1000215extern const u32 *of_get_pci_address(struct device_node *dev, int bar_no,
Benjamin Herrenschmidtd2dd4822005-11-30 16:57:28 +1100216 u64 *size, unsigned int *flags);
217
218/* Get an address as a resource. Note that if your address is
219 * a PIO address, the conversion will fail if the physical address
220 * can't be internally converted to an IO token with
221 * pci_address_to_pio(), that is because it's either called to early
222 * or it can't be matched to any host bridge IO space
223 */
224extern int of_address_to_resource(struct device_node *dev, int index,
225 struct resource *r);
226extern int of_pci_address_to_resource(struct device_node *dev, int bar,
227 struct resource *r);
Benjamin Herrenschmidtd1405b82005-11-23 17:53:42 +1100228
Jeremy Kerrd4ad66f2006-05-18 18:05:15 +1000229/* Parse the ibm,dma-window property of an OF node into the busno, phys and
230 * size parameters.
231 */
Jeremy Kerra7f67bd2006-07-12 15:35:54 +1000232void of_parse_dma_window(struct device_node *dn, const void *dma_window_prop,
Jeremy Kerrd4ad66f2006-05-18 18:05:15 +1000233 unsigned long *busno, unsigned long *phys, unsigned long *size);
234
Michael Ellermanb68239e2006-02-03 19:05:47 +1100235extern void kdump_move_device_tree(void);
236
Benjamin Herrenschmidtacf7d762006-06-19 20:33:16 +0200237/* CPU OF node matching */
238struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
239
Timur Tabi29cfe6f2007-02-16 12:01:29 -0600240/* Get the MAC address */
241extern const void *of_get_mac_address(struct device_node *np);
Benjamin Herrenschmidtcc9fd712006-07-03 19:35:17 +1000242
243/*
244 * OF interrupt mapping
245 */
246
247/* This structure is returned when an interrupt is mapped. The controller
248 * field needs to be put() after use
249 */
250
251#define OF_MAX_IRQ_SPEC 4 /* We handle specifiers of at most 4 cells */
252
253struct of_irq {
254 struct device_node *controller; /* Interrupt controller node */
255 u32 size; /* Specifier size */
256 u32 specifier[OF_MAX_IRQ_SPEC]; /* Specifier copy */
257};
258
Michael Ellerman40681b92006-08-02 11:13:50 +1000259/**
Benjamin Herrenschmidtcc9fd712006-07-03 19:35:17 +1000260 * of_irq_map_init - Initialize the irq remapper
261 * @flags: flags defining workarounds to enable
262 *
263 * Some machines have bugs in the device-tree which require certain workarounds
264 * to be applied. Call this before any interrupt mapping attempts to enable
265 * those workarounds.
266 */
267#define OF_IMAP_OLDWORLD_MAC 0x00000001
268#define OF_IMAP_NO_PHANDLE 0x00000002
269
270extern void of_irq_map_init(unsigned int flags);
271
Michael Ellerman40681b92006-08-02 11:13:50 +1000272/**
Benjamin Herrenschmidtcc9fd712006-07-03 19:35:17 +1000273 * of_irq_map_raw - Low level interrupt tree parsing
274 * @parent: the device interrupt parent
275 * @intspec: interrupt specifier ("interrupts" property of the device)
Benjamin Herrenschmidt006b64d2006-08-25 14:46:23 +1000276 * @ointsize: size of the passed in interrupt specifier
Benjamin Herrenschmidtcc9fd712006-07-03 19:35:17 +1000277 * @addr: address specifier (start of "reg" property of the device)
278 * @out_irq: structure of_irq filled by this function
279 *
280 * Returns 0 on success and a negative number on error
281 *
282 * This function is a low-level interrupt tree walking function. It
283 * can be used to do a partial walk with synthetized reg and interrupts
284 * properties, for example when resolving PCI interrupts when no device
285 * node exist for the parent.
286 *
287 */
288
Jeremy Kerra7f67bd2006-07-12 15:35:54 +1000289extern int of_irq_map_raw(struct device_node *parent, const u32 *intspec,
Paul Mackerrasaa43f772006-08-31 15:45:48 +1000290 u32 ointsize, const u32 *addr,
Benjamin Herrenschmidtcc9fd712006-07-03 19:35:17 +1000291 struct of_irq *out_irq);
292
293
Michael Ellerman40681b92006-08-02 11:13:50 +1000294/**
Benjamin Herrenschmidtcc9fd712006-07-03 19:35:17 +1000295 * of_irq_map_one - Resolve an interrupt for a device
296 * @device: the device whose interrupt is to be resolved
297 * @index: index of the interrupt to resolve
298 * @out_irq: structure of_irq filled by this function
299 *
300 * This function resolves an interrupt, walking the tree, for a given
301 * device-tree node. It's the high level pendant to of_irq_map_raw().
302 * It also implements the workarounds for OldWolrd Macs.
303 */
304extern int of_irq_map_one(struct device_node *device, int index,
305 struct of_irq *out_irq);
306
Michael Ellerman40681b92006-08-02 11:13:50 +1000307/**
Benjamin Herrenschmidtcc9fd712006-07-03 19:35:17 +1000308 * of_irq_map_pci - Resolve the interrupt for a PCI device
309 * @pdev: the device whose interrupt is to be resolved
310 * @out_irq: structure of_irq filled by this function
311 *
312 * This function resolves the PCI interrupt for a given PCI device. If a
313 * device-node exists for a given pci_dev, it will use normal OF tree
314 * walking. If not, it will implement standard swizzling and walk up the
315 * PCI tree until an device-node is found, at which point it will finish
316 * resolving using the OF tree walking.
317 */
318struct pci_dev;
319extern int of_irq_map_pci(struct pci_dev *pdev, struct of_irq *out_irq);
320
Mathieu Desnoyersc0b3ae12007-02-06 12:03:31 +1100321extern int of_irq_to_resource(struct device_node *dev, int index,
322 struct resource *r);
Andy Fleminga9b14972006-10-19 19:52:26 -0500323
Christian Krafftc3e80112007-04-25 01:32:02 +1000324/**
325 * of_iomap - Maps the memory mapped IO for a given device_node
326 * @device: the device whose io range will be mapped
327 * @index: index of the io range
328 *
329 * Returns a pointer to the mapped memory
330 */
331extern void __iomem *of_iomap(struct device_node *device, int index);
Benjamin Herrenschmidtcc9fd712006-07-03 19:35:17 +1000332
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000333/*
334 * NB: This is here while we transition from using asm/prom.h
335 * to linux/of.h
336 */
337#include <linux/of.h>
338
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000339#endif /* __KERNEL__ */
340#endif /* _POWERPC_PROM_H */