GNU Linux-libre 4.9.337-gnu1
[releases.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
26 typedef void ia64_mv_setup_t (char **);
27 typedef void ia64_mv_cpu_init_t (void);
28 typedef void ia64_mv_irq_init_t (void);
29 typedef void ia64_mv_send_ipi_t (int, int, int, int);
30 typedef void ia64_mv_timer_interrupt_t (int, void *);
31 typedef void ia64_mv_global_tlb_purge_t (struct mm_struct *, unsigned long, unsigned long, unsigned long);
32 typedef void ia64_mv_tlb_migrate_finish_t (struct mm_struct *);
33 typedef u8 ia64_mv_irq_to_vector (int);
34 typedef unsigned int ia64_mv_local_vector_to_irq (u8);
35 typedef char *ia64_mv_pci_get_legacy_mem_t (struct pci_bus *);
36 typedef int ia64_mv_pci_legacy_read_t (struct pci_bus *, u16 port, u32 *val,
37                                        u8 size);
38 typedef int ia64_mv_pci_legacy_write_t (struct pci_bus *, u16 port, u32 val,
39                                         u8 size);
40 typedef void ia64_mv_migrate_t(struct task_struct * task);
41 typedef void ia64_mv_pci_fixup_bus_t (struct pci_bus *);
42 typedef void ia64_mv_kernel_launch_event_t(void);
43
44 /* DMA-mapping interface: */
45 typedef void ia64_mv_dma_init (void);
46 typedef u64 ia64_mv_dma_get_required_mask (struct device *);
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_GENERIC)
116
117 # ifdef MACHVEC_PLATFORM_HEADER
118 #  include MACHVEC_PLATFORM_HEADER
119 # else
120 #  define ia64_platform_name    ia64_mv.name
121 #  define platform_setup        ia64_mv.setup
122 #  define platform_cpu_init     ia64_mv.cpu_init
123 #  define platform_irq_init     ia64_mv.irq_init
124 #  define platform_send_ipi     ia64_mv.send_ipi
125 #  define platform_timer_interrupt      ia64_mv.timer_interrupt
126 #  define platform_global_tlb_purge     ia64_mv.global_tlb_purge
127 #  define platform_tlb_migrate_finish   ia64_mv.tlb_migrate_finish
128 #  define platform_dma_init             ia64_mv.dma_init
129 #  define platform_dma_get_required_mask ia64_mv.dma_get_required_mask
130 #  define platform_dma_get_ops          ia64_mv.dma_get_ops
131 #  define platform_irq_to_vector        ia64_mv.irq_to_vector
132 #  define platform_local_vector_to_irq  ia64_mv.local_vector_to_irq
133 #  define platform_pci_get_legacy_mem   ia64_mv.pci_get_legacy_mem
134 #  define platform_pci_legacy_read      ia64_mv.pci_legacy_read
135 #  define platform_pci_legacy_write     ia64_mv.pci_legacy_write
136 #  define platform_inb          ia64_mv.inb
137 #  define platform_inw          ia64_mv.inw
138 #  define platform_inl          ia64_mv.inl
139 #  define platform_outb         ia64_mv.outb
140 #  define platform_outw         ia64_mv.outw
141 #  define platform_outl         ia64_mv.outl
142 #  define platform_mmiowb       ia64_mv.mmiowb
143 #  define platform_readb        ia64_mv.readb
144 #  define platform_readw        ia64_mv.readw
145 #  define platform_readl        ia64_mv.readl
146 #  define platform_readq        ia64_mv.readq
147 #  define platform_readb_relaxed        ia64_mv.readb_relaxed
148 #  define platform_readw_relaxed        ia64_mv.readw_relaxed
149 #  define platform_readl_relaxed        ia64_mv.readl_relaxed
150 #  define platform_readq_relaxed        ia64_mv.readq_relaxed
151 #  define platform_migrate              ia64_mv.migrate
152 #  define platform_setup_msi_irq        ia64_mv.setup_msi_irq
153 #  define platform_teardown_msi_irq     ia64_mv.teardown_msi_irq
154 #  define platform_pci_fixup_bus        ia64_mv.pci_fixup_bus
155 #  define platform_kernel_launch_event  ia64_mv.kernel_launch_event
156 # endif
157
158 /* __attribute__((__aligned__(16))) is required to make size of the
159  * structure multiple of 16 bytes.
160  * This will fillup the holes created because of section 3.3.1 in
161  * Software Conventions guide.
162  */
163 struct ia64_machine_vector {
164         const char *name;
165         ia64_mv_setup_t *setup;
166         ia64_mv_cpu_init_t *cpu_init;
167         ia64_mv_irq_init_t *irq_init;
168         ia64_mv_send_ipi_t *send_ipi;
169         ia64_mv_timer_interrupt_t *timer_interrupt;
170         ia64_mv_global_tlb_purge_t *global_tlb_purge;
171         ia64_mv_tlb_migrate_finish_t *tlb_migrate_finish;
172         ia64_mv_dma_init *dma_init;
173         ia64_mv_dma_get_required_mask *dma_get_required_mask;
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_required_mask,         \
214         platform_dma_get_ops,                   \
215         platform_irq_to_vector,                 \
216         platform_local_vector_to_irq,           \
217         platform_pci_get_legacy_mem,            \
218         platform_pci_legacy_read,               \
219         platform_pci_legacy_write,              \
220         platform_inb,                           \
221         platform_inw,                           \
222         platform_inl,                           \
223         platform_outb,                          \
224         platform_outw,                          \
225         platform_outl,                          \
226         platform_mmiowb,                        \
227         platform_readb,                         \
228         platform_readw,                         \
229         platform_readl,                         \
230         platform_readq,                         \
231         platform_readb_relaxed,                 \
232         platform_readw_relaxed,                 \
233         platform_readl_relaxed,                 \
234         platform_readq_relaxed,                 \
235         platform_migrate,                       \
236         platform_setup_msi_irq,                 \
237         platform_teardown_msi_irq,              \
238         platform_pci_fixup_bus,                 \
239         platform_kernel_launch_event            \
240 }
241
242 extern struct ia64_machine_vector ia64_mv;
243 extern void machvec_init (const char *name);
244 extern void machvec_init_from_cmdline(const char *cmdline);
245
246 # else
247 #  error Unknown configuration.  Update arch/ia64/include/asm/machvec.h.
248 # endif /* CONFIG_IA64_GENERIC */
249
250 extern void swiotlb_dma_init(void);
251 extern struct dma_map_ops *dma_get_ops(struct device *);
252
253 /*
254  * Define default versions so we can extend machvec for new platforms without having
255  * to update the machvec files for all existing platforms.
256  */
257 #ifndef platform_setup
258 # define platform_setup                 machvec_setup
259 #endif
260 #ifndef platform_cpu_init
261 # define platform_cpu_init              machvec_noop
262 #endif
263 #ifndef platform_irq_init
264 # define platform_irq_init              machvec_noop
265 #endif
266
267 #ifndef platform_send_ipi
268 # define platform_send_ipi              ia64_send_ipi   /* default to architected version */
269 #endif
270 #ifndef platform_timer_interrupt
271 # define platform_timer_interrupt       machvec_timer_interrupt
272 #endif
273 #ifndef platform_global_tlb_purge
274 # define platform_global_tlb_purge      ia64_global_tlb_purge /* default to architected version */
275 #endif
276 #ifndef platform_tlb_migrate_finish
277 # define platform_tlb_migrate_finish    machvec_noop_mm
278 #endif
279 #ifndef platform_kernel_launch_event
280 # define platform_kernel_launch_event   machvec_noop
281 #endif
282 #ifndef platform_dma_init
283 # define platform_dma_init              swiotlb_dma_init
284 #endif
285 #ifndef platform_dma_get_ops
286 # define platform_dma_get_ops           dma_get_ops
287 #endif
288 #ifndef platform_dma_get_required_mask
289 # define  platform_dma_get_required_mask        ia64_dma_get_required_mask
290 #endif
291 #ifndef platform_irq_to_vector
292 # define platform_irq_to_vector         __ia64_irq_to_vector
293 #endif
294 #ifndef platform_local_vector_to_irq
295 # define platform_local_vector_to_irq   __ia64_local_vector_to_irq
296 #endif
297 #ifndef platform_pci_get_legacy_mem
298 # define platform_pci_get_legacy_mem    ia64_pci_get_legacy_mem
299 #endif
300 #ifndef platform_pci_legacy_read
301 # define platform_pci_legacy_read       ia64_pci_legacy_read
302 extern int ia64_pci_legacy_read(struct pci_bus *bus, u16 port, u32 *val, u8 size);
303 #endif
304 #ifndef platform_pci_legacy_write
305 # define platform_pci_legacy_write      ia64_pci_legacy_write
306 extern int ia64_pci_legacy_write(struct pci_bus *bus, u16 port, u32 val, u8 size);
307 #endif
308 #ifndef platform_inb
309 # define platform_inb           __ia64_inb
310 #endif
311 #ifndef platform_inw
312 # define platform_inw           __ia64_inw
313 #endif
314 #ifndef platform_inl
315 # define platform_inl           __ia64_inl
316 #endif
317 #ifndef platform_outb
318 # define platform_outb          __ia64_outb
319 #endif
320 #ifndef platform_outw
321 # define platform_outw          __ia64_outw
322 #endif
323 #ifndef platform_outl
324 # define platform_outl          __ia64_outl
325 #endif
326 #ifndef platform_mmiowb
327 # define platform_mmiowb        __ia64_mmiowb
328 #endif
329 #ifndef platform_readb
330 # define platform_readb         __ia64_readb
331 #endif
332 #ifndef platform_readw
333 # define platform_readw         __ia64_readw
334 #endif
335 #ifndef platform_readl
336 # define platform_readl         __ia64_readl
337 #endif
338 #ifndef platform_readq
339 # define platform_readq         __ia64_readq
340 #endif
341 #ifndef platform_readb_relaxed
342 # define platform_readb_relaxed __ia64_readb_relaxed
343 #endif
344 #ifndef platform_readw_relaxed
345 # define platform_readw_relaxed __ia64_readw_relaxed
346 #endif
347 #ifndef platform_readl_relaxed
348 # define platform_readl_relaxed __ia64_readl_relaxed
349 #endif
350 #ifndef platform_readq_relaxed
351 # define platform_readq_relaxed __ia64_readq_relaxed
352 #endif
353 #ifndef platform_migrate
354 # define platform_migrate machvec_noop_task
355 #endif
356 #ifndef platform_setup_msi_irq
357 # define platform_setup_msi_irq         ((ia64_mv_setup_msi_irq_t*)NULL)
358 #endif
359 #ifndef platform_teardown_msi_irq
360 # define platform_teardown_msi_irq      ((ia64_mv_teardown_msi_irq_t*)NULL)
361 #endif
362 #ifndef platform_pci_fixup_bus
363 # define platform_pci_fixup_bus machvec_noop_bus
364 #endif
365
366 #endif /* _ASM_IA64_MACHVEC_H */