1 #ifndef _POWERPC_PROM_H
2 #define _POWERPC_PROM_H
6 * Definitions for talking to the Open Firmware PROM on
7 * Power Macintosh computers.
9 * Copyright (C) 1996-2005 Paul Mackerras.
11 * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
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.
18 #include <linux/types.h>
19 #include <linux/proc_fs.h>
20 #include <linux/platform_device.h>
22 #include <asm/atomic.h>
24 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
25 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
27 #define of_compat_cmp(s1, s2, l) strncasecmp((s1), (s2), (l))
29 /* Definitions used by the flattened device tree */
30 #define OF_DT_HEADER 0xd00dfeed /* marker */
31 #define OF_DT_BEGIN_NODE 0x1 /* Start of node, full name */
32 #define OF_DT_END_NODE 0x2 /* End node */
33 #define OF_DT_PROP 0x3 /* Property: name off, size,
35 #define OF_DT_NOP 0x4 /* nop */
38 #define OF_DT_VERSION 0x10
41 * This is what gets passed to the kernel by prom_init or kexec
43 * The dt struct contains the device tree structure, full pathes and
44 * property contents. The dt strings contain a separate block with just
45 * the strings for the property names, and is fully page aligned and
46 * self contained in a page, so that it can be kept around by the kernel,
47 * each property name appears only once in this page (cheap compression)
49 * the mem_rsvmap contains a map of reserved ranges of physical memory,
50 * passing it here instead of in the device-tree itself greatly simplifies
51 * the job of everybody. It's just a list of u64 pairs (base/size) that
54 struct boot_param_header
56 u32 magic; /* magic word OF_DT_HEADER */
57 u32 totalsize; /* total size of DT block */
58 u32 off_dt_struct; /* offset to structure */
59 u32 off_dt_strings; /* offset to strings */
60 u32 off_mem_rsvmap; /* offset to memory reserve map */
61 u32 version; /* format version */
62 u32 last_comp_version; /* last compatible version */
63 /* version 2 fields below */
64 u32 boot_cpuid_phys; /* Physical CPU id we're booting on */
65 /* version 3 fields below */
66 u32 dt_strings_size; /* size of the DT strings block */
67 /* version 17 fields below */
68 u32 dt_struct_size; /* size of the DT structure block */
80 struct property *next;
87 phandle linux_phandle;
90 struct property *properties;
91 struct property *deadprops; /* removed properties */
92 struct device_node *parent;
93 struct device_node *child;
94 struct device_node *sibling;
95 struct device_node *next; /* next device of same type */
96 struct device_node *allnext; /* next in list of all nodes */
97 struct proc_dir_entry *pde; /* this node's proc directory */
103 extern struct device_node *of_chosen;
105 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
107 return test_bit(flag, &n->_flags);
110 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
112 set_bit(flag, &n->_flags);
116 #define HAVE_ARCH_DEVTREE_FIXUPS
118 static inline void set_node_proc_entry(struct device_node *dn, struct proc_dir_entry *de)
124 extern struct device_node *of_find_all_nodes(struct device_node *prev);
125 extern struct device_node *of_node_get(struct device_node *node);
126 extern void of_node_put(struct device_node *node);
128 /* For scanning the flat device-tree at boot time */
129 extern int __init of_scan_flat_dt(int (*it)(unsigned long node,
130 const char *uname, int depth,
133 extern void* __init of_get_flat_dt_prop(unsigned long node, const char *name,
134 unsigned long *size);
135 extern int __init of_flat_dt_is_compatible(unsigned long node, const char *name);
136 extern unsigned long __init of_get_flat_dt_root(void);
138 /* For updating the device tree at runtime */
139 extern void of_attach_node(struct device_node *);
140 extern void of_detach_node(const struct device_node *);
142 /* Other Prototypes */
143 extern void finish_device_tree(void);
144 extern void unflatten_device_tree(void);
145 extern void early_init_devtree(void *);
146 #define device_is_compatible(d, c) of_device_is_compatible((d), (c))
147 extern int machine_is_compatible(const char *compat);
148 extern void print_properties(struct device_node *node);
149 extern int prom_n_intr_cells(struct device_node* np);
150 extern void prom_get_irq_senses(unsigned char *senses, int off, int max);
151 extern int prom_add_property(struct device_node* np, struct property* prop);
152 extern int prom_remove_property(struct device_node *np, struct property *prop);
153 extern int prom_update_property(struct device_node *np,
154 struct property *newprop,
155 struct property *oldprop);
159 * PCI <-> OF matching functions
160 * (XXX should these be here?)
164 extern int pci_device_from_OF_node(struct device_node *node,
166 extern struct device_node* pci_busdev_to_OF_node(struct pci_bus *, int);
167 extern struct device_node* pci_device_to_OF_node(struct pci_dev *);
168 extern void pci_create_OF_bus_map(void);
171 extern struct resource *request_OF_resource(struct device_node* node,
172 int index, const char* name_postfix);
173 extern int release_OF_resource(struct device_node* node, int index);
177 * OF address retreival & translation
181 /* Helper to read a big number; size is in cells (not bytes) */
182 static inline u64 of_read_number(const u32 *cell, int size)
186 r = (r << 32) | *(cell++);
190 /* Like of_read_number, but we want an unsigned long result */
192 static inline unsigned long of_read_ulong(const u32 *cell, int size)
197 #define of_read_ulong(cell, size) of_read_number(cell, size)
200 /* Translate an OF address block into a CPU physical address
202 extern u64 of_translate_address(struct device_node *np, const u32 *addr);
204 /* Extract an address from a device, returns the region size and
205 * the address space flags too. The PCI version uses a BAR number
206 * instead of an absolute index
208 extern const u32 *of_get_address(struct device_node *dev, int index,
209 u64 *size, unsigned int *flags);
210 extern const u32 *of_get_pci_address(struct device_node *dev, int bar_no,
211 u64 *size, unsigned int *flags);
213 /* Get an address as a resource. Note that if your address is
214 * a PIO address, the conversion will fail if the physical address
215 * can't be internally converted to an IO token with
216 * pci_address_to_pio(), that is because it's either called to early
217 * or it can't be matched to any host bridge IO space
219 extern int of_address_to_resource(struct device_node *dev, int index,
221 extern int of_pci_address_to_resource(struct device_node *dev, int bar,
224 /* Parse the ibm,dma-window property of an OF node into the busno, phys and
227 void of_parse_dma_window(struct device_node *dn, const void *dma_window_prop,
228 unsigned long *busno, unsigned long *phys, unsigned long *size);
230 extern void kdump_move_device_tree(void);
232 /* CPU OF node matching */
233 struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
235 /* Get the MAC address */
236 extern const void *of_get_mac_address(struct device_node *np);
239 * OF interrupt mapping
242 /* This structure is returned when an interrupt is mapped. The controller
243 * field needs to be put() after use
246 #define OF_MAX_IRQ_SPEC 4 /* We handle specifiers of at most 4 cells */
249 struct device_node *controller; /* Interrupt controller node */
250 u32 size; /* Specifier size */
251 u32 specifier[OF_MAX_IRQ_SPEC]; /* Specifier copy */
255 * of_irq_map_init - Initialize the irq remapper
256 * @flags: flags defining workarounds to enable
258 * Some machines have bugs in the device-tree which require certain workarounds
259 * to be applied. Call this before any interrupt mapping attempts to enable
262 #define OF_IMAP_OLDWORLD_MAC 0x00000001
263 #define OF_IMAP_NO_PHANDLE 0x00000002
265 extern void of_irq_map_init(unsigned int flags);
268 * of_irq_map_raw - Low level interrupt tree parsing
269 * @parent: the device interrupt parent
270 * @intspec: interrupt specifier ("interrupts" property of the device)
271 * @ointsize: size of the passed in interrupt specifier
272 * @addr: address specifier (start of "reg" property of the device)
273 * @out_irq: structure of_irq filled by this function
275 * Returns 0 on success and a negative number on error
277 * This function is a low-level interrupt tree walking function. It
278 * can be used to do a partial walk with synthetized reg and interrupts
279 * properties, for example when resolving PCI interrupts when no device
280 * node exist for the parent.
284 extern int of_irq_map_raw(struct device_node *parent, const u32 *intspec,
285 u32 ointsize, const u32 *addr,
286 struct of_irq *out_irq);
290 * of_irq_map_one - Resolve an interrupt for a device
291 * @device: the device whose interrupt is to be resolved
292 * @index: index of the interrupt to resolve
293 * @out_irq: structure of_irq filled by this function
295 * This function resolves an interrupt, walking the tree, for a given
296 * device-tree node. It's the high level pendant to of_irq_map_raw().
297 * It also implements the workarounds for OldWolrd Macs.
299 extern int of_irq_map_one(struct device_node *device, int index,
300 struct of_irq *out_irq);
303 * of_irq_map_pci - Resolve the interrupt for a PCI device
304 * @pdev: the device whose interrupt is to be resolved
305 * @out_irq: structure of_irq filled by this function
307 * This function resolves the PCI interrupt for a given PCI device. If a
308 * device-node exists for a given pci_dev, it will use normal OF tree
309 * walking. If not, it will implement standard swizzling and walk up the
310 * PCI tree until an device-node is found, at which point it will finish
311 * resolving using the OF tree walking.
314 extern int of_irq_map_pci(struct pci_dev *pdev, struct of_irq *out_irq);
316 extern int of_irq_to_resource(struct device_node *dev, int index,
320 * of_iomap - Maps the memory mapped IO for a given device_node
321 * @device: the device whose io range will be mapped
322 * @index: index of the io range
324 * Returns a pointer to the mapped memory
326 extern void __iomem *of_iomap(struct device_node *device, int index);
329 * NB: This is here while we transition from using asm/prom.h
332 #include <linux/of.h>
334 #endif /* __KERNEL__ */
335 #endif /* _POWERPC_PROM_H */