convert to use generic dma_map_ops struct, cleanup
[cascardo/linux.git] / arch / ia64 / include / asm / machvec.h
1 /*
2  * Machine vector for IA-64.
3  *
4  * Copyright (C) 1999 Silicon Graphics, Inc.
5  * Copyright (C) Srinivasa Thirumalachar <sprasad@engr.sgi.com>
6  * Copyright (C) Vijay Chander <vijay@engr.sgi.com>
7  * Copyright (C) 1999-2001, 2003-2004 Hewlett-Packard Co.
8  *      David Mosberger-Tang <davidm@hpl.hp.com>
9  */
10 #ifndef _ASM_IA64_MACHVEC_H
11 #define _ASM_IA64_MACHVEC_H
12
13 #include <linux/types.h>
14
15 /* forward declarations: */
16 struct device;
17 struct pt_regs;
18 struct scatterlist;
19 struct page;
20 struct mm_struct;
21 struct pci_bus;
22 struct task_struct;
23 struct pci_dev;
24 struct msi_desc;
25 struct dma_attrs;
26
27 typedef void ia64_mv_setup_t (char **);
28 typedef void ia64_mv_cpu_init_t (void);
29 typedef void ia64_mv_irq_init_t (void);
30 typedef void ia64_mv_send_ipi_t (int, int, int, int);
31 typedef void ia64_mv_timer_interrupt_t (int, void *);
32 typedef void ia64_mv_global_tlb_purge_t (struct mm_struct *, unsigned long, unsigned long, unsigned long);
33 typedef void ia64_mv_tlb_migrate_finish_t (struct mm_struct *);
34 typedef u8 ia64_mv_irq_to_vector (int);
35 typedef unsigned int ia64_mv_local_vector_to_irq (u8);
36 typedef char *ia64_mv_pci_get_legacy_mem_t (struct pci_bus *);
37 typedef int ia64_mv_pci_legacy_read_t (struct pci_bus *, u16 port, u32 *val,
38                                        u8 size);
39 typedef int ia64_mv_pci_legacy_write_t (struct pci_bus *, u16 port, u32 val,
40                                         u8 size);
41 typedef void ia64_mv_migrate_t(struct task_struct * task);
42 typedef void ia64_mv_pci_fixup_bus_t (struct pci_bus *);
43 typedef void ia64_mv_kernel_launch_event_t(void);
44
45 /* DMA-mapping interface: */
46 typedef void ia64_mv_dma_init (void);
47 typedef struct dma_map_ops *ia64_mv_dma_get_ops(struct device *);
48
49 /*
50  * WARNING: The legacy I/O space is _architected_.  Platforms are
51  * expected to follow this architected model (see Section 10.7 in the
52  * IA-64 Architecture Software Developer's Manual).  Unfortunately,
53  * some broken machines do not follow that model, which is why we have
54  * to make the inX/outX operations part of the machine vector.
55  * Platform designers should follow the architected model whenever
56  * possible.
57  */
58 typedef unsigned int ia64_mv_inb_t (unsigned long);
59 typedef unsigned int ia64_mv_inw_t (unsigned long);
60 typedef unsigned int ia64_mv_inl_t (unsigned long);
61 typedef void ia64_mv_outb_t (unsigned char, unsigned long);
62 typedef void ia64_mv_outw_t (unsigned short, unsigned long);
63 typedef void ia64_mv_outl_t (unsigned int, unsigned long);
64 typedef void ia64_mv_mmiowb_t (void);
65 typedef unsigned char ia64_mv_readb_t (const volatile void __iomem *);
66 typedef unsigned short ia64_mv_readw_t (const volatile void __iomem *);
67 typedef unsigned int ia64_mv_readl_t (const volatile void __iomem *);
68 typedef unsigned long ia64_mv_readq_t (const volatile void __iomem *);
69 typedef unsigned char ia64_mv_readb_relaxed_t (const volatile void __iomem *);
70 typedef unsigned short ia64_mv_readw_relaxed_t (const volatile void __iomem *);
71 typedef unsigned int ia64_mv_readl_relaxed_t (const volatile void __iomem *);
72 typedef unsigned long ia64_mv_readq_relaxed_t (const volatile void __iomem *);
73
74 typedef int ia64_mv_setup_msi_irq_t (struct pci_dev *pdev, struct msi_desc *);
75 typedef void ia64_mv_teardown_msi_irq_t (unsigned int irq);
76
77 static inline void
78 machvec_noop (void)
79 {
80 }
81
82 static inline void
83 machvec_noop_mm (struct mm_struct *mm)
84 {
85 }
86
87 static inline void
88 machvec_noop_task (struct task_struct *task)
89 {
90 }
91
92 static inline void
93 machvec_noop_bus (struct pci_bus *bus)
94 {
95 }
96
97 extern void machvec_setup (char **);
98 extern void machvec_timer_interrupt (int, void *);
99 extern void machvec_tlb_migrate_finish (struct mm_struct *);
100
101 # if defined (CONFIG_IA64_HP_SIM)
102 #  include <asm/machvec_hpsim.h>
103 # elif defined (CONFIG_IA64_DIG)
104 #  include <asm/machvec_dig.h>
105 # elif defined(CONFIG_IA64_DIG_VTD)
106 #  include <asm/machvec_dig_vtd.h>
107 # elif defined (CONFIG_IA64_HP_ZX1)
108 #  include <asm/machvec_hpzx1.h>
109 # elif defined (CONFIG_IA64_HP_ZX1_SWIOTLB)
110 #  include <asm/machvec_hpzx1_swiotlb.h>
111 # elif defined (CONFIG_IA64_SGI_SN2)
112 #  include <asm/machvec_sn2.h>
113 # elif defined (CONFIG_IA64_SGI_UV)
114 #  include <asm/machvec_uv.h>
115 # elif defined (CONFIG_IA64_XEN_GUEST)
116 #  include <asm/machvec_xen.h>
117 # elif defined (CONFIG_IA64_GENERIC)
118
119 # ifdef MACHVEC_PLATFORM_HEADER
120 #  include MACHVEC_PLATFORM_HEADER
121 # else
122 #  define platform_name         ia64_mv.name
123 #  define platform_setup        ia64_mv.setup
124 #  define platform_cpu_init     ia64_mv.cpu_init
125 #  define platform_irq_init     ia64_mv.irq_init
126 #  define platform_send_ipi     ia64_mv.send_ipi
127 #  define platform_timer_interrupt      ia64_mv.timer_interrupt
128 #  define platform_global_tlb_purge     ia64_mv.global_tlb_purge
129 #  define platform_tlb_migrate_finish   ia64_mv.tlb_migrate_finish
130 #  define platform_dma_init             ia64_mv.dma_init
131 #  define platform_dma_get_ops          ia64_mv.dma_get_ops
132 #  define platform_irq_to_vector        ia64_mv.irq_to_vector
133 #  define platform_local_vector_to_irq  ia64_mv.local_vector_to_irq
134 #  define platform_pci_get_legacy_mem   ia64_mv.pci_get_legacy_mem
135 #  define platform_pci_legacy_read      ia64_mv.pci_legacy_read
136 #  define platform_pci_legacy_write     ia64_mv.pci_legacy_write
137 #  define platform_inb          ia64_mv.inb
138 #  define platform_inw          ia64_mv.inw
139 #  define platform_inl          ia64_mv.inl
140 #  define platform_outb         ia64_mv.outb
141 #  define platform_outw         ia64_mv.outw
142 #  define platform_outl         ia64_mv.outl
143 #  define platform_mmiowb       ia64_mv.mmiowb
144 #  define platform_readb        ia64_mv.readb
145 #  define platform_readw        ia64_mv.readw
146 #  define platform_readl        ia64_mv.readl
147 #  define platform_readq        ia64_mv.readq
148 #  define platform_readb_relaxed        ia64_mv.readb_relaxed
149 #  define platform_readw_relaxed        ia64_mv.readw_relaxed
150 #  define platform_readl_relaxed        ia64_mv.readl_relaxed
151 #  define platform_readq_relaxed        ia64_mv.readq_relaxed
152 #  define platform_migrate              ia64_mv.migrate
153 #  define platform_setup_msi_irq        ia64_mv.setup_msi_irq
154 #  define platform_teardown_msi_irq     ia64_mv.teardown_msi_irq
155 #  define platform_pci_fixup_bus        ia64_mv.pci_fixup_bus
156 #  define platform_kernel_launch_event  ia64_mv.kernel_launch_event
157 # endif
158
159 /* __attribute__((__aligned__(16))) is required to make size of the
160  * structure multiple of 16 bytes.
161  * This will fillup the holes created because of section 3.3.1 in
162  * Software Conventions guide.
163  */
164 struct ia64_machine_vector {
165         const char *name;
166         ia64_mv_setup_t *setup;
167         ia64_mv_cpu_init_t *cpu_init;
168         ia64_mv_irq_init_t *irq_init;
169         ia64_mv_send_ipi_t *send_ipi;
170         ia64_mv_timer_interrupt_t *timer_interrupt;
171         ia64_mv_global_tlb_purge_t *global_tlb_purge;
172         ia64_mv_tlb_migrate_finish_t *tlb_migrate_finish;
173         ia64_mv_dma_init *dma_init;
174         ia64_mv_dma_get_ops *dma_get_ops;
175         ia64_mv_irq_to_vector *irq_to_vector;
176         ia64_mv_local_vector_to_irq *local_vector_to_irq;
177         ia64_mv_pci_get_legacy_mem_t *pci_get_legacy_mem;
178         ia64_mv_pci_legacy_read_t *pci_legacy_read;
179         ia64_mv_pci_legacy_write_t *pci_legacy_write;
180         ia64_mv_inb_t *inb;
181         ia64_mv_inw_t *inw;
182         ia64_mv_inl_t *inl;
183         ia64_mv_outb_t *outb;
184         ia64_mv_outw_t *outw;
185         ia64_mv_outl_t *outl;
186         ia64_mv_mmiowb_t *mmiowb;
187         ia64_mv_readb_t *readb;
188         ia64_mv_readw_t *readw;
189         ia64_mv_readl_t *readl;
190         ia64_mv_readq_t *readq;
191         ia64_mv_readb_relaxed_t *readb_relaxed;
192         ia64_mv_readw_relaxed_t *readw_relaxed;
193         ia64_mv_readl_relaxed_t *readl_relaxed;
194         ia64_mv_readq_relaxed_t *readq_relaxed;
195         ia64_mv_migrate_t *migrate;
196         ia64_mv_setup_msi_irq_t *setup_msi_irq;
197         ia64_mv_teardown_msi_irq_t *teardown_msi_irq;
198         ia64_mv_pci_fixup_bus_t *pci_fixup_bus;
199         ia64_mv_kernel_launch_event_t *kernel_launch_event;
200 } __attribute__((__aligned__(16))); /* align attrib? see above comment */
201
202 #define MACHVEC_INIT(name)                      \
203 {                                               \
204         #name,                                  \
205         platform_setup,                         \
206         platform_cpu_init,                      \
207         platform_irq_init,                      \
208         platform_send_ipi,                      \
209         platform_timer_interrupt,               \
210         platform_global_tlb_purge,              \
211         platform_tlb_migrate_finish,            \
212         platform_dma_init,                      \
213         platform_dma_get_ops,                   \
214         platform_irq_to_vector,                 \
215         platform_local_vector_to_irq,           \
216         platform_pci_get_legacy_mem,            \
217         platform_pci_legacy_read,               \
218         platform_pci_legacy_write,              \
219         platform_inb,                           \
220         platform_inw,                           \
221         platform_inl,                           \
222         platform_outb,                          \
223         platform_outw,                          \
224         platform_outl,                          \
225         platform_mmiowb,                        \
226         platform_readb,                         \
227         platform_readw,                         \
228         platform_readl,                         \
229         platform_readq,                         \
230         platform_readb_relaxed,                 \
231         platform_readw_relaxed,                 \
232         platform_readl_relaxed,                 \
233         platform_readq_relaxed,                 \
234         platform_migrate,                       \
235         platform_setup_msi_irq,                 \
236         platform_teardown_msi_irq,              \
237         platform_pci_fixup_bus,                 \
238         platform_kernel_launch_event            \
239 }
240
241 extern struct ia64_machine_vector ia64_mv;
242 extern void machvec_init (const char *name);
243 extern void machvec_init_from_cmdline(const char *cmdline);
244
245 # else
246 #  error Unknown configuration.  Update arch/ia64/include/asm/machvec.h.
247 # endif /* CONFIG_IA64_GENERIC */
248
249 extern void swiotlb_dma_init(void);
250 extern struct dma_map_ops *dma_get_ops(struct device *);
251
252 /*
253  * Define default versions so we can extend machvec for new platforms without having
254  * to update the machvec files for all existing platforms.
255  */
256 #ifndef platform_setup
257 # define platform_setup                 machvec_setup
258 #endif
259 #ifndef platform_cpu_init
260 # define platform_cpu_init              machvec_noop
261 #endif
262 #ifndef platform_irq_init
263 # define platform_irq_init              machvec_noop
264 #endif
265
266 #ifndef platform_send_ipi
267 # define platform_send_ipi              ia64_send_ipi   /* default to architected version */
268 #endif
269 #ifndef platform_timer_interrupt
270 # define platform_timer_interrupt       machvec_timer_interrupt
271 #endif
272 #ifndef platform_global_tlb_purge
273 # define platform_global_tlb_purge      ia64_global_tlb_purge /* default to architected version */
274 #endif
275 #ifndef platform_tlb_migrate_finish
276 # define platform_tlb_migrate_finish    machvec_noop_mm
277 #endif
278 #ifndef platform_kernel_launch_event
279 # define platform_kernel_launch_event   machvec_noop
280 #endif
281 #ifndef platform_dma_init
282 # define platform_dma_init              swiotlb_dma_init
283 #endif
284 #ifndef platform_dma_get_ops
285 # define platform_dma_get_ops           dma_get_ops
286 #endif
287 #ifndef platform_irq_to_vector
288 # define platform_irq_to_vector         __ia64_irq_to_vector
289 #endif
290 #ifndef platform_local_vector_to_irq
291 # define platform_local_vector_to_irq   __ia64_local_vector_to_irq
292 #endif
293 #ifndef platform_pci_get_legacy_mem
294 # define platform_pci_get_legacy_mem    ia64_pci_get_legacy_mem
295 #endif
296 #ifndef platform_pci_legacy_read
297 # define platform_pci_legacy_read       ia64_pci_legacy_read
298 extern int ia64_pci_legacy_read(struct pci_bus *bus, u16 port, u32 *val, u8 size);
299 #endif
300 #ifndef platform_pci_legacy_write
301 # define platform_pci_legacy_write      ia64_pci_legacy_write
302 extern int ia64_pci_legacy_write(struct pci_bus *bus, u16 port, u32 val, u8 size);
303 #endif
304 #ifndef platform_inb
305 # define platform_inb           __ia64_inb
306 #endif
307 #ifndef platform_inw
308 # define platform_inw           __ia64_inw
309 #endif
310 #ifndef platform_inl
311 # define platform_inl           __ia64_inl
312 #endif
313 #ifndef platform_outb
314 # define platform_outb          __ia64_outb
315 #endif
316 #ifndef platform_outw
317 # define platform_outw          __ia64_outw
318 #endif
319 #ifndef platform_outl
320 # define platform_outl          __ia64_outl
321 #endif
322 #ifndef platform_mmiowb
323 # define platform_mmiowb        __ia64_mmiowb
324 #endif
325 #ifndef platform_readb
326 # define platform_readb         __ia64_readb
327 #endif
328 #ifndef platform_readw
329 # define platform_readw         __ia64_readw
330 #endif
331 #ifndef platform_readl
332 # define platform_readl         __ia64_readl
333 #endif
334 #ifndef platform_readq
335 # define platform_readq         __ia64_readq
336 #endif
337 #ifndef platform_readb_relaxed
338 # define platform_readb_relaxed __ia64_readb_relaxed
339 #endif
340 #ifndef platform_readw_relaxed
341 # define platform_readw_relaxed __ia64_readw_relaxed
342 #endif
343 #ifndef platform_readl_relaxed
344 # define platform_readl_relaxed __ia64_readl_relaxed
345 #endif
346 #ifndef platform_readq_relaxed
347 # define platform_readq_relaxed __ia64_readq_relaxed
348 #endif
349 #ifndef platform_migrate
350 # define platform_migrate machvec_noop_task
351 #endif
352 #ifndef platform_setup_msi_irq
353 # define platform_setup_msi_irq         ((ia64_mv_setup_msi_irq_t*)NULL)
354 #endif
355 #ifndef platform_teardown_msi_irq
356 # define platform_teardown_msi_irq      ((ia64_mv_teardown_msi_irq_t*)NULL)
357 #endif
358 #ifndef platform_pci_fixup_bus
359 # define platform_pci_fixup_bus machvec_noop_bus
360 #endif
361
362 #endif /* _ASM_IA64_MACHVEC_H */