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>
25 /* Definitions used by the flattened device tree */
26 #define OF_DT_HEADER 0xd00dfeed /* marker */
27 #define OF_DT_BEGIN_NODE 0x1 /* Start of node, full name */
28 #define OF_DT_END_NODE 0x2 /* End node */
29 #define OF_DT_PROP 0x3 /* Property: name off, size,
31 #define OF_DT_NOP 0x4 /* nop */
34 #define OF_DT_VERSION 0x10
37 * This is what gets passed to the kernel by prom_init or kexec
39 * The dt struct contains the device tree structure, full pathes and
40 * property contents. The dt strings contain a separate block with just
41 * the strings for the property names, and is fully page aligned and
42 * self contained in a page, so that it can be kept around by the kernel,
43 * each property name appears only once in this page (cheap compression)
45 * the mem_rsvmap contains a map of reserved ranges of physical memory,
46 * passing it here instead of in the device-tree itself greatly simplifies
47 * the job of everybody. It's just a list of u64 pairs (base/size) that
50 struct boot_param_header
52 u32 magic
; /* magic word OF_DT_HEADER */
53 u32 totalsize
; /* total size of DT block */
54 u32 off_dt_struct
; /* offset to structure */
55 u32 off_dt_strings
; /* offset to strings */
56 u32 off_mem_rsvmap
; /* offset to memory reserve map */
57 u32 version
; /* format version */
58 u32 last_comp_version
; /* last compatible version */
59 /* version 2 fields below */
60 u32 boot_cpuid_phys
; /* Physical CPU id we're booting on */
61 /* version 3 fields below */
62 u32 dt_strings_size
; /* size of the DT strings block */
63 /* version 17 fields below */
64 u32 dt_struct_size
; /* size of the DT structure block */
76 struct property
*next
;
83 phandle linux_phandle
;
86 struct property
*properties
;
87 struct property
*deadprops
; /* removed properties */
88 struct device_node
*parent
;
89 struct device_node
*child
;
90 struct device_node
*sibling
;
91 struct device_node
*next
; /* next device of same type */
92 struct device_node
*allnext
; /* next in list of all nodes */
93 struct proc_dir_entry
*pde
; /* this node's proc directory */
99 extern struct device_node
*of_chosen
;
101 /* flag descriptions */
102 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
104 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
105 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
107 #define HAVE_ARCH_DEVTREE_FIXUPS
109 static inline void set_node_proc_entry(struct device_node
*dn
, struct proc_dir_entry
*de
)
115 /* OBSOLETE: Old style node lookup */
116 extern struct device_node
*find_devices(const char *name
);
117 extern struct device_node
*find_type_devices(const char *type
);
118 extern struct device_node
*find_path_device(const char *path
);
120 /* New style node lookup */
121 extern struct device_node
*of_find_node_by_name(struct device_node
*from
,
123 #define for_each_node_by_name(dn, name) \
124 for (dn = of_find_node_by_name(NULL, name); dn; \
125 dn = of_find_node_by_name(dn, name))
126 extern struct device_node
*of_find_node_by_type(struct device_node
*from
,
128 #define for_each_node_by_type(dn, type) \
129 for (dn = of_find_node_by_type(NULL, type); dn; \
130 dn = of_find_node_by_type(dn, type))
131 extern struct device_node
*of_find_compatible_node(struct device_node
*from
,
132 const char *type
, const char *compat
);
133 extern struct device_node
*of_find_node_by_path(const char *path
);
134 extern struct device_node
*of_find_node_by_phandle(phandle handle
);
135 extern struct device_node
*of_find_all_nodes(struct device_node
*prev
);
136 extern struct device_node
*of_get_parent(const struct device_node
*node
);
137 extern struct device_node
*of_get_next_child(const struct device_node
*node
,
138 struct device_node
*prev
);
139 extern struct property
*of_find_property(const struct device_node
*np
,
142 extern struct device_node
*of_node_get(struct device_node
*node
);
143 extern void of_node_put(struct device_node
*node
);
145 /* For scanning the flat device-tree at boot time */
146 extern int __init
of_scan_flat_dt(int (*it
)(unsigned long node
,
147 const char *uname
, int depth
,
150 extern void* __init
of_get_flat_dt_prop(unsigned long node
, const char *name
,
151 unsigned long *size
);
152 extern int __init
of_flat_dt_is_compatible(unsigned long node
, const char *name
);
153 extern unsigned long __init
of_get_flat_dt_root(void);
155 /* For updating the device tree at runtime */
156 extern void of_attach_node(struct device_node
*);
157 extern void of_detach_node(const struct device_node
*);
159 /* Other Prototypes */
160 extern void finish_device_tree(void);
161 extern void unflatten_device_tree(void);
162 extern void early_init_devtree(void *);
163 extern int of_device_is_compatible(const struct device_node
*device
,
165 #define device_is_compatible(d, c) of_device_is_compatible((d), (c))
166 extern int machine_is_compatible(const char *compat
);
167 extern const void *of_get_property(const struct device_node
*node
,
170 #define get_property(a, b, c) of_get_property((a), (b), (c))
171 extern void print_properties(struct device_node
*node
);
172 extern int of_n_addr_cells(struct device_node
* np
);
173 extern int of_n_size_cells(struct device_node
* np
);
174 extern int prom_n_intr_cells(struct device_node
* np
);
175 extern void prom_get_irq_senses(unsigned char *senses
, int off
, int max
);
176 extern int prom_add_property(struct device_node
* np
, struct property
* prop
);
177 extern int prom_remove_property(struct device_node
*np
, struct property
*prop
);
178 extern int prom_update_property(struct device_node
*np
,
179 struct property
*newprop
,
180 struct property
*oldprop
);
184 * PCI <-> OF matching functions
185 * (XXX should these be here?)
189 extern int pci_device_from_OF_node(struct device_node
*node
,
191 extern struct device_node
* pci_busdev_to_OF_node(struct pci_bus
*, int);
192 extern struct device_node
* pci_device_to_OF_node(struct pci_dev
*);
193 extern void pci_create_OF_bus_map(void);
196 extern struct resource
*request_OF_resource(struct device_node
* node
,
197 int index
, const char* name_postfix
);
198 extern int release_OF_resource(struct device_node
* node
, int index
);
202 * OF address retreival & translation
206 /* Helper to read a big number; size is in cells (not bytes) */
207 static inline u64
of_read_number(const u32
*cell
, int size
)
211 r
= (r
<< 32) | *(cell
++);
215 /* Like of_read_number, but we want an unsigned long result */
217 static inline unsigned long of_read_ulong(const u32
*cell
, int size
)
222 #define of_read_ulong(cell, size) of_read_number(cell, size)
225 /* Translate an OF address block into a CPU physical address
227 #define OF_BAD_ADDR ((u64)-1)
228 extern u64
of_translate_address(struct device_node
*np
, const u32
*addr
);
230 /* Extract an address from a device, returns the region size and
231 * the address space flags too. The PCI version uses a BAR number
232 * instead of an absolute index
234 extern const u32
*of_get_address(struct device_node
*dev
, int index
,
235 u64
*size
, unsigned int *flags
);
236 extern const u32
*of_get_pci_address(struct device_node
*dev
, int bar_no
,
237 u64
*size
, unsigned int *flags
);
239 /* Get an address as a resource. Note that if your address is
240 * a PIO address, the conversion will fail if the physical address
241 * can't be internally converted to an IO token with
242 * pci_address_to_pio(), that is because it's either called to early
243 * or it can't be matched to any host bridge IO space
245 extern int of_address_to_resource(struct device_node
*dev
, int index
,
247 extern int of_pci_address_to_resource(struct device_node
*dev
, int bar
,
250 /* Parse the ibm,dma-window property of an OF node into the busno, phys and
253 void of_parse_dma_window(struct device_node
*dn
, const void *dma_window_prop
,
254 unsigned long *busno
, unsigned long *phys
, unsigned long *size
);
256 extern void kdump_move_device_tree(void);
258 /* CPU OF node matching */
259 struct device_node
*of_get_cpu_node(int cpu
, unsigned int *thread
);
261 /* Get the MAC address */
262 extern const void *of_get_mac_address(struct device_node
*np
);
265 * OF interrupt mapping
268 /* This structure is returned when an interrupt is mapped. The controller
269 * field needs to be put() after use
272 #define OF_MAX_IRQ_SPEC 4 /* We handle specifiers of at most 4 cells */
275 struct device_node
*controller
; /* Interrupt controller node */
276 u32 size
; /* Specifier size */
277 u32 specifier
[OF_MAX_IRQ_SPEC
]; /* Specifier copy */
281 * of_irq_map_init - Initialize the irq remapper
282 * @flags: flags defining workarounds to enable
284 * Some machines have bugs in the device-tree which require certain workarounds
285 * to be applied. Call this before any interrupt mapping attempts to enable
288 #define OF_IMAP_OLDWORLD_MAC 0x00000001
289 #define OF_IMAP_NO_PHANDLE 0x00000002
291 extern void of_irq_map_init(unsigned int flags
);
294 * of_irq_map_raw - Low level interrupt tree parsing
295 * @parent: the device interrupt parent
296 * @intspec: interrupt specifier ("interrupts" property of the device)
297 * @ointsize: size of the passed in interrupt specifier
298 * @addr: address specifier (start of "reg" property of the device)
299 * @out_irq: structure of_irq filled by this function
301 * Returns 0 on success and a negative number on error
303 * This function is a low-level interrupt tree walking function. It
304 * can be used to do a partial walk with synthetized reg and interrupts
305 * properties, for example when resolving PCI interrupts when no device
306 * node exist for the parent.
310 extern int of_irq_map_raw(struct device_node
*parent
, const u32
*intspec
,
311 u32 ointsize
, const u32
*addr
,
312 struct of_irq
*out_irq
);
316 * of_irq_map_one - Resolve an interrupt for a device
317 * @device: the device whose interrupt is to be resolved
318 * @index: index of the interrupt to resolve
319 * @out_irq: structure of_irq filled by this function
321 * This function resolves an interrupt, walking the tree, for a given
322 * device-tree node. It's the high level pendant to of_irq_map_raw().
323 * It also implements the workarounds for OldWolrd Macs.
325 extern int of_irq_map_one(struct device_node
*device
, int index
,
326 struct of_irq
*out_irq
);
329 * of_irq_map_pci - Resolve the interrupt for a PCI device
330 * @pdev: the device whose interrupt is to be resolved
331 * @out_irq: structure of_irq filled by this function
333 * This function resolves the PCI interrupt for a given PCI device. If a
334 * device-node exists for a given pci_dev, it will use normal OF tree
335 * walking. If not, it will implement standard swizzling and walk up the
336 * PCI tree until an device-node is found, at which point it will finish
337 * resolving using the OF tree walking.
340 extern int of_irq_map_pci(struct pci_dev
*pdev
, struct of_irq
*out_irq
);
342 static inline int of_irq_to_resource(struct device_node
*dev
, int index
, struct resource
*r
)
344 int irq
= irq_of_parse_and_map(dev
, index
);
346 /* Only dereference the resource if both the
347 * resource and the irq are valid. */
348 if (r
&& irq
!= NO_IRQ
) {
349 r
->start
= r
->end
= irq
;
350 r
->flags
= IORESOURCE_IRQ
;
356 static inline void __iomem
*of_iomap(struct device_node
*np
, int index
)
360 if (of_address_to_resource(np
, index
, &res
))
363 return ioremap(res
.start
, 1 + res
.end
- res
.start
);
367 #endif /* __KERNEL__ */
368 #endif /* _POWERPC_PROM_H */