kernel.org linux-2.6.10
[linux-2.6.git] / include / asm-ia64 / 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/config.h>
14 #include <linux/types.h>
15
16 /* forward declarations: */
17 struct device;
18 struct pt_regs;
19 struct scatterlist;
20 struct irq_desc;
21 struct page;
22 struct mm_struct;
23
24 typedef void ia64_mv_setup_t (char **);
25 typedef void ia64_mv_cpu_init_t (void);
26 typedef void ia64_mv_irq_init_t (void);
27 typedef void ia64_mv_send_ipi_t (int, int, int, int);
28 typedef void ia64_mv_timer_interrupt_t (int, void *, struct pt_regs *);
29 typedef void ia64_mv_global_tlb_purge_t (unsigned long, unsigned long, unsigned long);
30 typedef void ia64_mv_tlb_migrate_finish_t (struct mm_struct *);
31 typedef struct irq_desc *ia64_mv_irq_desc (unsigned int);
32 typedef u8 ia64_mv_irq_to_vector (unsigned int);
33 typedef unsigned int ia64_mv_local_vector_to_irq (u8);
34
35 /* DMA-mapping interface: */
36 typedef void ia64_mv_dma_init (void);
37 typedef void *ia64_mv_dma_alloc_coherent (struct device *, size_t, dma_addr_t *, int);
38 typedef void ia64_mv_dma_free_coherent (struct device *, size_t, void *, dma_addr_t);
39 typedef dma_addr_t ia64_mv_dma_map_single (struct device *, void *, size_t, int);
40 typedef void ia64_mv_dma_unmap_single (struct device *, dma_addr_t, size_t, int);
41 typedef int ia64_mv_dma_map_sg (struct device *, struct scatterlist *, int, int);
42 typedef void ia64_mv_dma_unmap_sg (struct device *, struct scatterlist *, int, int);
43 typedef void ia64_mv_dma_sync_single_for_cpu (struct device *, dma_addr_t, size_t, int);
44 typedef void ia64_mv_dma_sync_sg_for_cpu (struct device *, struct scatterlist *, int, int);
45 typedef void ia64_mv_dma_sync_single_for_device (struct device *, dma_addr_t, size_t, int);
46 typedef void ia64_mv_dma_sync_sg_for_device (struct device *, struct scatterlist *, int, int);
47 typedef int ia64_mv_dma_mapping_error (dma_addr_t dma_addr);
48 typedef int ia64_mv_dma_supported (struct device *, u64);
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 static inline void
76 machvec_noop (void)
77 {
78 }
79
80 static inline void
81 machvec_noop_mm (struct mm_struct *mm)
82 {
83 }
84
85 extern void machvec_setup (char **);
86 extern void machvec_timer_interrupt (int, void *, struct pt_regs *);
87 extern void machvec_dma_sync_single (struct device *, dma_addr_t, size_t, int);
88 extern void machvec_dma_sync_sg (struct device *, struct scatterlist *, int, int);
89 extern void machvec_tlb_migrate_finish (struct mm_struct *);
90
91 # if defined (CONFIG_IA64_HP_SIM)
92 #  include <asm/machvec_hpsim.h>
93 # elif defined (CONFIG_IA64_DIG)
94 #  include <asm/machvec_dig.h>
95 # elif defined (CONFIG_IA64_HP_ZX1)
96 #  include <asm/machvec_hpzx1.h>
97 # elif defined (CONFIG_IA64_SGI_SN2)
98 #  include <asm/machvec_sn2.h>
99 # elif defined (CONFIG_IA64_GENERIC)
100
101 # ifdef MACHVEC_PLATFORM_HEADER
102 #  include MACHVEC_PLATFORM_HEADER
103 # else
104 #  define platform_name         ia64_mv.name
105 #  define platform_setup        ia64_mv.setup
106 #  define platform_cpu_init     ia64_mv.cpu_init
107 #  define platform_irq_init     ia64_mv.irq_init
108 #  define platform_send_ipi     ia64_mv.send_ipi
109 #  define platform_timer_interrupt      ia64_mv.timer_interrupt
110 #  define platform_global_tlb_purge     ia64_mv.global_tlb_purge
111 #  define platform_tlb_migrate_finish   ia64_mv.tlb_migrate_finish
112 #  define platform_dma_init             ia64_mv.dma_init
113 #  define platform_dma_alloc_coherent   ia64_mv.dma_alloc_coherent
114 #  define platform_dma_free_coherent    ia64_mv.dma_free_coherent
115 #  define platform_dma_map_single       ia64_mv.dma_map_single
116 #  define platform_dma_unmap_single     ia64_mv.dma_unmap_single
117 #  define platform_dma_map_sg           ia64_mv.dma_map_sg
118 #  define platform_dma_unmap_sg         ia64_mv.dma_unmap_sg
119 #  define platform_dma_sync_single_for_cpu ia64_mv.dma_sync_single_for_cpu
120 #  define platform_dma_sync_sg_for_cpu  ia64_mv.dma_sync_sg_for_cpu
121 #  define platform_dma_sync_single_for_device ia64_mv.dma_sync_single_for_device
122 #  define platform_dma_sync_sg_for_device ia64_mv.dma_sync_sg_for_device
123 #  define platform_dma_mapping_error            ia64_mv.dma_mapping_error
124 #  define platform_dma_supported        ia64_mv.dma_supported
125 #  define platform_irq_desc             ia64_mv.irq_desc
126 #  define platform_irq_to_vector        ia64_mv.irq_to_vector
127 #  define platform_local_vector_to_irq  ia64_mv.local_vector_to_irq
128 #  define platform_inb          ia64_mv.inb
129 #  define platform_inw          ia64_mv.inw
130 #  define platform_inl          ia64_mv.inl
131 #  define platform_outb         ia64_mv.outb
132 #  define platform_outw         ia64_mv.outw
133 #  define platform_outl         ia64_mv.outl
134 #  define platform_mmiowb       ia64_mv.mmiowb
135 #  define platform_readb        ia64_mv.readb
136 #  define platform_readw        ia64_mv.readw
137 #  define platform_readl        ia64_mv.readl
138 #  define platform_readq        ia64_mv.readq
139 #  define platform_readb_relaxed        ia64_mv.readb_relaxed
140 #  define platform_readw_relaxed        ia64_mv.readw_relaxed
141 #  define platform_readl_relaxed        ia64_mv.readl_relaxed
142 #  define platform_readq_relaxed        ia64_mv.readq_relaxed
143 # endif
144
145 /* __attribute__((__aligned__(16))) is required to make size of the
146  * structure multiple of 16 bytes.
147  * This will fillup the holes created because of section 3.3.1 in
148  * Software Conventions guide.
149  */
150 struct ia64_machine_vector {
151         const char *name;
152         ia64_mv_setup_t *setup;
153         ia64_mv_cpu_init_t *cpu_init;
154         ia64_mv_irq_init_t *irq_init;
155         ia64_mv_send_ipi_t *send_ipi;
156         ia64_mv_timer_interrupt_t *timer_interrupt;
157         ia64_mv_global_tlb_purge_t *global_tlb_purge;
158         ia64_mv_tlb_migrate_finish_t *tlb_migrate_finish;
159         ia64_mv_dma_init *dma_init;
160         ia64_mv_dma_alloc_coherent *dma_alloc_coherent;
161         ia64_mv_dma_free_coherent *dma_free_coherent;
162         ia64_mv_dma_map_single *dma_map_single;
163         ia64_mv_dma_unmap_single *dma_unmap_single;
164         ia64_mv_dma_map_sg *dma_map_sg;
165         ia64_mv_dma_unmap_sg *dma_unmap_sg;
166         ia64_mv_dma_sync_single_for_cpu *dma_sync_single_for_cpu;
167         ia64_mv_dma_sync_sg_for_cpu *dma_sync_sg_for_cpu;
168         ia64_mv_dma_sync_single_for_device *dma_sync_single_for_device;
169         ia64_mv_dma_sync_sg_for_device *dma_sync_sg_for_device;
170         ia64_mv_dma_mapping_error *dma_mapping_error;
171         ia64_mv_dma_supported *dma_supported;
172         ia64_mv_irq_desc *irq_desc;
173         ia64_mv_irq_to_vector *irq_to_vector;
174         ia64_mv_local_vector_to_irq *local_vector_to_irq;
175         ia64_mv_inb_t *inb;
176         ia64_mv_inw_t *inw;
177         ia64_mv_inl_t *inl;
178         ia64_mv_outb_t *outb;
179         ia64_mv_outw_t *outw;
180         ia64_mv_outl_t *outl;
181         ia64_mv_mmiowb_t *mmiowb;
182         ia64_mv_readb_t *readb;
183         ia64_mv_readw_t *readw;
184         ia64_mv_readl_t *readl;
185         ia64_mv_readq_t *readq;
186         ia64_mv_readb_relaxed_t *readb_relaxed;
187         ia64_mv_readw_relaxed_t *readw_relaxed;
188         ia64_mv_readl_relaxed_t *readl_relaxed;
189         ia64_mv_readq_relaxed_t *readq_relaxed;
190 } __attribute__((__aligned__(16))); /* align attrib? see above comment */
191
192 #define MACHVEC_INIT(name)                      \
193 {                                               \
194         #name,                                  \
195         platform_setup,                         \
196         platform_cpu_init,                      \
197         platform_irq_init,                      \
198         platform_send_ipi,                      \
199         platform_timer_interrupt,               \
200         platform_global_tlb_purge,              \
201         platform_tlb_migrate_finish,            \
202         platform_dma_init,                      \
203         platform_dma_alloc_coherent,            \
204         platform_dma_free_coherent,             \
205         platform_dma_map_single,                \
206         platform_dma_unmap_single,              \
207         platform_dma_map_sg,                    \
208         platform_dma_unmap_sg,                  \
209         platform_dma_sync_single_for_cpu,       \
210         platform_dma_sync_sg_for_cpu,           \
211         platform_dma_sync_single_for_device,    \
212         platform_dma_sync_sg_for_device,        \
213         platform_dma_mapping_error,                     \
214         platform_dma_supported,                 \
215         platform_irq_desc,                      \
216         platform_irq_to_vector,                 \
217         platform_local_vector_to_irq,           \
218         platform_inb,                           \
219         platform_inw,                           \
220         platform_inl,                           \
221         platform_outb,                          \
222         platform_outw,                          \
223         platform_outl,                          \
224         platform_mmiowb,                        \
225         platform_readb,                         \
226         platform_readw,                         \
227         platform_readl,                         \
228         platform_readq,                         \
229         platform_readb_relaxed,                 \
230         platform_readw_relaxed,                 \
231         platform_readl_relaxed,                 \
232         platform_readq_relaxed,                 \
233 }
234
235 extern struct ia64_machine_vector ia64_mv;
236 extern void machvec_init (const char *name);
237
238 # else
239 #  error Unknown configuration.  Update asm-ia64/machvec.h.
240 # endif /* CONFIG_IA64_GENERIC */
241
242 /*
243  * Declare default routines which aren't declared anywhere else:
244  */
245 extern ia64_mv_dma_init                 swiotlb_init;
246 extern ia64_mv_dma_alloc_coherent       swiotlb_alloc_coherent;
247 extern ia64_mv_dma_free_coherent        swiotlb_free_coherent;
248 extern ia64_mv_dma_map_single           swiotlb_map_single;
249 extern ia64_mv_dma_unmap_single         swiotlb_unmap_single;
250 extern ia64_mv_dma_map_sg               swiotlb_map_sg;
251 extern ia64_mv_dma_unmap_sg             swiotlb_unmap_sg;
252 extern ia64_mv_dma_sync_single_for_cpu  swiotlb_sync_single_for_cpu;
253 extern ia64_mv_dma_sync_sg_for_cpu      swiotlb_sync_sg_for_cpu;
254 extern ia64_mv_dma_sync_single_for_device swiotlb_sync_single_for_device;
255 extern ia64_mv_dma_sync_sg_for_device   swiotlb_sync_sg_for_device;
256 extern ia64_mv_dma_mapping_error        swiotlb_dma_mapping_error;
257 extern ia64_mv_dma_supported            swiotlb_dma_supported;
258
259 /*
260  * Define default versions so we can extend machvec for new platforms without having
261  * to update the machvec files for all existing platforms.
262  */
263 #ifndef platform_setup
264 # define platform_setup                 machvec_setup
265 #endif
266 #ifndef platform_cpu_init
267 # define platform_cpu_init              machvec_noop
268 #endif
269 #ifndef platform_irq_init
270 # define platform_irq_init              machvec_noop
271 #endif
272
273 #ifndef platform_send_ipi
274 # define platform_send_ipi              ia64_send_ipi   /* default to architected version */
275 #endif
276 #ifndef platform_timer_interrupt
277 # define platform_timer_interrupt       machvec_timer_interrupt
278 #endif
279 #ifndef platform_global_tlb_purge
280 # define platform_global_tlb_purge      ia64_global_tlb_purge /* default to architected version */
281 #endif
282 #ifndef platform_tlb_migrate_finish
283 # define platform_tlb_migrate_finish    machvec_noop_mm
284 #endif
285 #ifndef platform_dma_init
286 # define platform_dma_init              swiotlb_init
287 #endif
288 #ifndef platform_dma_alloc_coherent
289 # define platform_dma_alloc_coherent    swiotlb_alloc_coherent
290 #endif
291 #ifndef platform_dma_free_coherent
292 # define platform_dma_free_coherent     swiotlb_free_coherent
293 #endif
294 #ifndef platform_dma_map_single
295 # define platform_dma_map_single        swiotlb_map_single
296 #endif
297 #ifndef platform_dma_unmap_single
298 # define platform_dma_unmap_single      swiotlb_unmap_single
299 #endif
300 #ifndef platform_dma_map_sg
301 # define platform_dma_map_sg            swiotlb_map_sg
302 #endif
303 #ifndef platform_dma_unmap_sg
304 # define platform_dma_unmap_sg          swiotlb_unmap_sg
305 #endif
306 #ifndef platform_dma_sync_single_for_cpu
307 # define platform_dma_sync_single_for_cpu       swiotlb_sync_single_for_cpu
308 #endif
309 #ifndef platform_dma_sync_sg_for_cpu
310 # define platform_dma_sync_sg_for_cpu           swiotlb_sync_sg_for_cpu
311 #endif
312 #ifndef platform_dma_sync_single_for_device
313 # define platform_dma_sync_single_for_device    swiotlb_sync_single_for_device
314 #endif
315 #ifndef platform_dma_sync_sg_for_device
316 # define platform_dma_sync_sg_for_device        swiotlb_sync_sg_for_device
317 #endif
318 #ifndef platform_dma_mapping_error
319 # define platform_dma_mapping_error             swiotlb_dma_mapping_error
320 #endif
321 #ifndef platform_dma_supported
322 # define  platform_dma_supported        swiotlb_dma_supported
323 #endif
324 #ifndef platform_irq_desc
325 # define platform_irq_desc              __ia64_irq_desc
326 #endif
327 #ifndef platform_irq_to_vector
328 # define platform_irq_to_vector         __ia64_irq_to_vector
329 #endif
330 #ifndef platform_local_vector_to_irq
331 # define platform_local_vector_to_irq   __ia64_local_vector_to_irq
332 #endif
333 #ifndef platform_inb
334 # define platform_inb           __ia64_inb
335 #endif
336 #ifndef platform_inw
337 # define platform_inw           __ia64_inw
338 #endif
339 #ifndef platform_inl
340 # define platform_inl           __ia64_inl
341 #endif
342 #ifndef platform_outb
343 # define platform_outb          __ia64_outb
344 #endif
345 #ifndef platform_outw
346 # define platform_outw          __ia64_outw
347 #endif
348 #ifndef platform_outl
349 # define platform_outl          __ia64_outl
350 #endif
351 #ifndef platform_mmiowb
352 # define platform_mmiowb        __ia64_mmiowb
353 #endif
354 #ifndef platform_readb
355 # define platform_readb         __ia64_readb
356 #endif
357 #ifndef platform_readw
358 # define platform_readw         __ia64_readw
359 #endif
360 #ifndef platform_readl
361 # define platform_readl         __ia64_readl
362 #endif
363 #ifndef platform_readq
364 # define platform_readq         __ia64_readq
365 #endif
366 #ifndef platform_readb_relaxed
367 # define platform_readb_relaxed __ia64_readb_relaxed
368 #endif
369 #ifndef platform_readw_relaxed
370 # define platform_readw_relaxed __ia64_readw_relaxed
371 #endif
372 #ifndef platform_readl_relaxed
373 # define platform_readl_relaxed __ia64_readl_relaxed
374 #endif
375 #ifndef platform_readq_relaxed
376 # define platform_readq_relaxed __ia64_readq_relaxed
377 #endif
378
379 #endif /* _ASM_IA64_MACHVEC_H */