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