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) strcasecmp((s1), (s2))
28 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
29 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
31 /* 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,
37 #define OF_DT_NOP 0x4 /* nop */
40 #define OF_DT_VERSION 0x10
43 * This is what gets passed to the kernel by prom_init or kexec
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)
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
56 struct boot_param_header
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 */
69 /* version 17 fields below */
70 u32 dt_struct_size
; /* size of the DT structure block */
82 struct property
*next
;
89 phandle linux_phandle
;
92 struct property
*properties
;
93 struct property
*deadprops
; /* removed properties */
94 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 */
101 unsigned long _flags
;
105 extern struct device_node
*of_chosen
;
107 static inline int of_node_check_flag(struct device_node
*n
, unsigned long flag
)
109 return test_bit(flag
, &n
->_flags
);
112 static inline void of_node_set_flag(struct device_node
*n
, unsigned long flag
)
114 set_bit(flag
, &n
->_flags
);
118 #define HAVE_ARCH_DEVTREE_FIXUPS
120 static inline void set_node_proc_entry(struct device_node
*dn
, struct proc_dir_entry
*de
)
126 extern struct device_node
*of_find_all_nodes(struct device_node
*prev
);
127 extern struct device_node
*of_node_get(struct device_node
*node
);
128 extern void of_node_put(struct device_node
*node
);
130 /* For scanning the flat device-tree at boot time */
131 extern int __init
of_scan_flat_dt(int (*it
)(unsigned long node
,
132 const char *uname
, int depth
,
135 extern void* __init
of_get_flat_dt_prop(unsigned long node
, const char *name
,
136 unsigned long *size
);
137 extern int __init
of_flat_dt_is_compatible(unsigned long node
, const char *name
);
138 extern unsigned long __init
of_get_flat_dt_root(void);
140 /* For updating the device tree at runtime */
141 extern void of_attach_node(struct device_node
*);
142 extern void of_detach_node(struct device_node
*);
144 /* Other Prototypes */
145 extern void finish_device_tree(void);
146 extern void unflatten_device_tree(void);
147 extern void early_init_devtree(void *);
148 extern int machine_is_compatible(const char *compat
);
149 extern void print_properties(struct device_node
*node
);
150 extern int prom_n_intr_cells(struct device_node
* np
);
151 extern void prom_get_irq_senses(unsigned char *senses
, int off
, int max
);
152 extern int prom_add_property(struct device_node
* np
, struct property
* prop
);
153 extern int prom_remove_property(struct device_node
*np
, struct property
*prop
);
154 extern int prom_update_property(struct device_node
*np
,
155 struct property
*newprop
,
156 struct property
*oldprop
);
160 * PCI <-> OF matching functions
161 * (XXX should these be here?)
165 extern int pci_device_from_OF_node(struct device_node
*node
,
167 extern struct device_node
* pci_busdev_to_OF_node(struct pci_bus
*, int);
168 extern struct device_node
* pci_device_to_OF_node(struct pci_dev
*);
169 extern void pci_create_OF_bus_map(void);
172 extern struct resource
*request_OF_resource(struct device_node
* node
,
173 int index
, const char* name_postfix
);
174 extern int release_OF_resource(struct device_node
* node
, int index
);
178 * OF address retreival & translation
182 /* Helper to read a big number; size is in cells (not bytes) */
183 static inline u64
of_read_number(const u32
*cell
, int size
)
187 r
= (r
<< 32) | *(cell
++);
191 /* Like of_read_number, but we want an unsigned long result */
193 static inline unsigned long of_read_ulong(const u32
*cell
, int size
)
198 #define of_read_ulong(cell, size) of_read_number(cell, size)
201 /* Translate an OF address block into a CPU physical address
203 extern u64
of_translate_address(struct device_node
*np
, const u32
*addr
);
205 /* Translate a DMA address from device space to CPU space */
206 extern u64
of_translate_dma_address(struct device_node
*dev
,
209 /* 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
213 extern const u32
*of_get_address(struct device_node
*dev
, int index
,
214 u64
*size
, unsigned int *flags
);
215 extern const u32
*of_get_pci_address(struct device_node
*dev
, int bar_no
,
216 u64
*size
, unsigned int *flags
);
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
224 extern int of_address_to_resource(struct device_node
*dev
, int index
,
226 extern int of_pci_address_to_resource(struct device_node
*dev
, int bar
,
229 /* Parse the ibm,dma-window property of an OF node into the busno, phys and
232 void of_parse_dma_window(struct device_node
*dn
, const void *dma_window_prop
,
233 unsigned long *busno
, unsigned long *phys
, unsigned long *size
);
235 extern void kdump_move_device_tree(void);
237 /* CPU OF node matching */
238 struct device_node
*of_get_cpu_node(int cpu
, unsigned int *thread
);
240 /* Get the MAC address */
241 extern const void *of_get_mac_address(struct device_node
*np
);
244 * OF interrupt mapping
247 /* This structure is returned when an interrupt is mapped. The controller
248 * field needs to be put() after use
251 #define OF_MAX_IRQ_SPEC 4 /* We handle specifiers of at most 4 cells */
254 struct device_node
*controller
; /* Interrupt controller node */
255 u32 size
; /* Specifier size */
256 u32 specifier
[OF_MAX_IRQ_SPEC
]; /* Specifier copy */
260 * of_irq_map_init - Initialize the irq remapper
261 * @flags: flags defining workarounds to enable
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
267 #define OF_IMAP_OLDWORLD_MAC 0x00000001
268 #define OF_IMAP_NO_PHANDLE 0x00000002
270 extern void of_irq_map_init(unsigned int flags
);
273 * of_irq_map_raw - Low level interrupt tree parsing
274 * @parent: the device interrupt parent
275 * @intspec: interrupt specifier ("interrupts" property of the device)
276 * @ointsize: size of the passed in interrupt specifier
277 * @addr: address specifier (start of "reg" property of the device)
278 * @out_irq: structure of_irq filled by this function
280 * Returns 0 on success and a negative number on error
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.
289 extern int of_irq_map_raw(struct device_node
*parent
, const u32
*intspec
,
290 u32 ointsize
, const u32
*addr
,
291 struct of_irq
*out_irq
);
295 * 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
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.
304 extern int of_irq_map_one(struct device_node
*device
, int index
,
305 struct of_irq
*out_irq
);
308 * 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
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.
319 extern int of_irq_map_pci(struct pci_dev
*pdev
, struct of_irq
*out_irq
);
321 extern int of_irq_to_resource(struct device_node
*dev
, int index
,
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
329 * Returns a pointer to the mapped memory
331 extern void __iomem
*of_iomap(struct device_node
*device
, int index
);
334 * NB: This is here while we transition from using asm/prom.h
337 #include <linux/of.h>
339 #endif /* __KERNEL__ */
340 #endif /* _POWERPC_PROM_H */
This page took 0.037399 seconds and 5 git commands to generate.