xref: /openbmc/linux/arch/powerpc/include/asm/prom.h (revision a09d2831)
1 #include <linux/of.h>	/* linux/of.h gets to determine #include ordering */
2 #ifndef _POWERPC_PROM_H
3 #define _POWERPC_PROM_H
4 #ifdef __KERNEL__
5 
6 /*
7  * Definitions for talking to the Open Firmware PROM on
8  * Power Macintosh computers.
9  *
10  * Copyright (C) 1996-2005 Paul Mackerras.
11  *
12  * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
13  *
14  * This program is free software; you can redistribute it and/or
15  * modify it under the terms of the GNU General Public License
16  * as published by the Free Software Foundation; either version
17  * 2 of the License, or (at your option) any later version.
18  */
19 #include <linux/types.h>
20 #include <linux/of_fdt.h>
21 #include <linux/proc_fs.h>
22 #include <linux/platform_device.h>
23 #include <asm/irq.h>
24 #include <asm/atomic.h>
25 
26 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT	1
27 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT	1
28 
29 #define of_compat_cmp(s1, s2, l)	strcasecmp((s1), (s2))
30 #define of_prop_cmp(s1, s2)		strcmp((s1), (s2))
31 #define of_node_cmp(s1, s2)		strcasecmp((s1), (s2))
32 
33 extern struct device_node *of_chosen;
34 
35 #define HAVE_ARCH_DEVTREE_FIXUPS
36 
37 /* For updating the device tree at runtime */
38 extern void of_attach_node(struct device_node *);
39 extern void of_detach_node(struct device_node *);
40 
41 #ifdef CONFIG_PPC32
42 /*
43  * PCI <-> OF matching functions
44  * (XXX should these be here?)
45  */
46 struct pci_bus;
47 struct pci_dev;
48 extern int pci_device_from_OF_node(struct device_node *node,
49 				   u8* bus, u8* devfn);
50 extern struct device_node* pci_busdev_to_OF_node(struct pci_bus *, int);
51 extern struct device_node* pci_device_to_OF_node(struct pci_dev *);
52 extern void pci_create_OF_bus_map(void);
53 #endif
54 
55 extern struct resource *request_OF_resource(struct device_node* node,
56 				int index, const char* name_postfix);
57 extern int release_OF_resource(struct device_node* node, int index);
58 
59 
60 /*
61  * OF address retreival & translation
62  */
63 
64 /* Translate an OF address block into a CPU physical address
65  */
66 extern u64 of_translate_address(struct device_node *np, const u32 *addr);
67 
68 /* Translate a DMA address from device space to CPU space */
69 extern u64 of_translate_dma_address(struct device_node *dev,
70 				    const u32 *in_addr);
71 
72 /* Extract an address from a device, returns the region size and
73  * the address space flags too. The PCI version uses a BAR number
74  * instead of an absolute index
75  */
76 extern const u32 *of_get_address(struct device_node *dev, int index,
77 			   u64 *size, unsigned int *flags);
78 #ifdef CONFIG_PCI
79 extern const u32 *of_get_pci_address(struct device_node *dev, int bar_no,
80 			       u64 *size, unsigned int *flags);
81 #else
82 static inline const u32 *of_get_pci_address(struct device_node *dev,
83 		int bar_no, u64 *size, unsigned int *flags)
84 {
85 	return NULL;
86 }
87 #endif /* CONFIG_PCI */
88 
89 /* Get an address as a resource. Note that if your address is
90  * a PIO address, the conversion will fail if the physical address
91  * can't be internally converted to an IO token with
92  * pci_address_to_pio(), that is because it's either called to early
93  * or it can't be matched to any host bridge IO space
94  */
95 extern int of_address_to_resource(struct device_node *dev, int index,
96 				  struct resource *r);
97 #ifdef CONFIG_PCI
98 extern int of_pci_address_to_resource(struct device_node *dev, int bar,
99 				      struct resource *r);
100 #else
101 static inline int of_pci_address_to_resource(struct device_node *dev, int bar,
102 		struct resource *r)
103 {
104 	return -ENOSYS;
105 }
106 #endif /* CONFIG_PCI */
107 
108 /* Parse the ibm,dma-window property of an OF node into the busno, phys and
109  * size parameters.
110  */
111 void of_parse_dma_window(struct device_node *dn, const void *dma_window_prop,
112 		unsigned long *busno, unsigned long *phys, unsigned long *size);
113 
114 extern void kdump_move_device_tree(void);
115 
116 /* CPU OF node matching */
117 struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
118 
119 /* cache lookup */
120 struct device_node *of_find_next_cache_node(struct device_node *np);
121 
122 /* Get the MAC address */
123 extern const void *of_get_mac_address(struct device_node *np);
124 
125 /*
126  * OF interrupt mapping
127  */
128 
129 /* This structure is returned when an interrupt is mapped. The controller
130  * field needs to be put() after use
131  */
132 
133 #define OF_MAX_IRQ_SPEC		 4 /* We handle specifiers of at most 4 cells */
134 
135 struct of_irq {
136 	struct device_node *controller;	/* Interrupt controller node */
137 	u32 size;			/* Specifier size */
138 	u32 specifier[OF_MAX_IRQ_SPEC];	/* Specifier copy */
139 };
140 
141 /**
142  * of_irq_map_init - Initialize the irq remapper
143  * @flags:	flags defining workarounds to enable
144  *
145  * Some machines have bugs in the device-tree which require certain workarounds
146  * to be applied. Call this before any interrupt mapping attempts to enable
147  * those workarounds.
148  */
149 #define OF_IMAP_OLDWORLD_MAC	0x00000001
150 #define OF_IMAP_NO_PHANDLE	0x00000002
151 
152 extern void of_irq_map_init(unsigned int flags);
153 
154 /**
155  * of_irq_map_raw - Low level interrupt tree parsing
156  * @parent:	the device interrupt parent
157  * @intspec:	interrupt specifier ("interrupts" property of the device)
158  * @ointsize:   size of the passed in interrupt specifier
159  * @addr:	address specifier (start of "reg" property of the device)
160  * @out_irq:	structure of_irq filled by this function
161  *
162  * Returns 0 on success and a negative number on error
163  *
164  * This function is a low-level interrupt tree walking function. It
165  * can be used to do a partial walk with synthetized reg and interrupts
166  * properties, for example when resolving PCI interrupts when no device
167  * node exist for the parent.
168  *
169  */
170 
171 extern int of_irq_map_raw(struct device_node *parent, const u32 *intspec,
172 			  u32 ointsize, const u32 *addr,
173 			  struct of_irq *out_irq);
174 
175 
176 /**
177  * of_irq_map_one - Resolve an interrupt for a device
178  * @device:	the device whose interrupt is to be resolved
179  * @index:     	index of the interrupt to resolve
180  * @out_irq:	structure of_irq filled by this function
181  *
182  * This function resolves an interrupt, walking the tree, for a given
183  * device-tree node. It's the high level pendant to of_irq_map_raw().
184  * It also implements the workarounds for OldWolrd Macs.
185  */
186 extern int of_irq_map_one(struct device_node *device, int index,
187 			  struct of_irq *out_irq);
188 
189 /**
190  * of_irq_map_pci - Resolve the interrupt for a PCI device
191  * @pdev:	the device whose interrupt is to be resolved
192  * @out_irq:	structure of_irq filled by this function
193  *
194  * This function resolves the PCI interrupt for a given PCI device. If a
195  * device-node exists for a given pci_dev, it will use normal OF tree
196  * walking. If not, it will implement standard swizzling and walk up the
197  * PCI tree until an device-node is found, at which point it will finish
198  * resolving using the OF tree walking.
199  */
200 struct pci_dev;
201 extern int of_irq_map_pci(struct pci_dev *pdev, struct of_irq *out_irq);
202 
203 extern int of_irq_to_resource(struct device_node *dev, int index,
204 			struct resource *r);
205 
206 /**
207  * of_iomap - Maps the memory mapped IO for a given device_node
208  * @device:	the device whose io range will be mapped
209  * @index:	index of the io range
210  *
211  * Returns a pointer to the mapped memory
212  */
213 extern void __iomem *of_iomap(struct device_node *device, int index);
214 
215 #endif /* __KERNEL__ */
216 #endif /* _POWERPC_PROM_H */
217