arch/ia64/include/asm/machvec.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Machine vector for IA-64.
   4  *
   5  * Copyright (C) 1999 Silicon Graphics, Inc.
   6  * Copyright (C) Srinivasa Thirumalachar <sprasad@engr.sgi.com>
   7  * Copyright (C) Vijay Chander <vijay@engr.sgi.com>
   8  * Copyright (C) 1999-2001, 2003-2004 Hewlett-Packard Co.
   9  *      David Mosberger-Tang <davidm@hpl.hp.com>
  10  */
  11 #ifndef _ASM_IA64_MACHVEC_H
  12 #define _ASM_IA64_MACHVEC_H
  13
  14 #include <linux/types.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
  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 const 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_ops          ia64_mv.dma_get_ops
 130 #  define platform_irq_to_vector        ia64_mv.irq_to_vector
 131 #  define platform_local_vector_to_irq  ia64_mv.local_vector_to_irq
 132 #  define platform_pci_get_legacy_mem   ia64_mv.pci_get_legacy_mem
 133 #  define platform_pci_legacy_read      ia64_mv.pci_legacy_read
 134 #  define platform_pci_legacy_write     ia64_mv.pci_legacy_write
 135 #  define platform_inb          ia64_mv.inb
 136 #  define platform_inw          ia64_mv.inw
 137 #  define platform_inl          ia64_mv.inl
 138 #  define platform_outb         ia64_mv.outb
 139 #  define platform_outw         ia64_mv.outw
 140 #  define platform_outl         ia64_mv.outl
 141 #  define platform_mmiowb       ia64_mv.mmiowb
 142 #  define platform_readb        ia64_mv.readb
 143 #  define platform_readw        ia64_mv.readw
 144 #  define platform_readl        ia64_mv.readl
 145 #  define platform_readq        ia64_mv.readq
 146 #  define platform_readb_relaxed        ia64_mv.readb_relaxed
 147 #  define platform_readw_relaxed        ia64_mv.readw_relaxed
 148 #  define platform_readl_relaxed        ia64_mv.readl_relaxed
 149 #  define platform_readq_relaxed        ia64_mv.readq_relaxed
 150 #  define platform_migrate              ia64_mv.migrate
 151 #  define platform_setup_msi_irq        ia64_mv.setup_msi_irq
 152 #  define platform_teardown_msi_irq     ia64_mv.teardown_msi_irq
 153 #  define platform_pci_fixup_bus        ia64_mv.pci_fixup_bus
 154 #  define platform_kernel_launch_event  ia64_mv.kernel_launch_event
 155 # endif
 156
 157 /* __attribute__((__aligned__(16))) is required to make size of the
 158  * structure multiple of 16 bytes.
 159  * This will fillup the holes created because of section 3.3.1 in
 160  * Software Conventions guide.
 161  */
 162 struct ia64_machine_vector {
 163         const char *name;
 164         ia64_mv_setup_t *setup;
 165         ia64_mv_cpu_init_t *cpu_init;
 166         ia64_mv_irq_init_t *irq_init;
 167         ia64_mv_send_ipi_t *send_ipi;
 168         ia64_mv_timer_interrupt_t *timer_interrupt;
 169         ia64_mv_global_tlb_purge_t *global_tlb_purge;
 170         ia64_mv_tlb_migrate_finish_t *tlb_migrate_finish;
 171         ia64_mv_dma_init *dma_init;
 172         ia64_mv_dma_get_ops *dma_get_ops;
 173         ia64_mv_irq_to_vector *irq_to_vector;
 174         ia64_mv_local_vector_to_irq *local_vector_to_irq;
 175         ia64_mv_pci_get_legacy_mem_t *pci_get_legacy_mem;
 176         ia64_mv_pci_legacy_read_t *pci_legacy_read;
 177         ia64_mv_pci_legacy_write_t *pci_legacy_write;
 178         ia64_mv_inb_t *inb;
 179         ia64_mv_inw_t *inw;
 180         ia64_mv_inl_t *inl;
 181         ia64_mv_outb_t *outb;
 182         ia64_mv_outw_t *outw;
 183         ia64_mv_outl_t *outl;
 184         ia64_mv_mmiowb_t *mmiowb;
 185         ia64_mv_readb_t *readb;
 186         ia64_mv_readw_t *readw;
 187         ia64_mv_readl_t *readl;
 188         ia64_mv_readq_t *readq;
 189         ia64_mv_readb_relaxed_t *readb_relaxed;
 190         ia64_mv_readw_relaxed_t *readw_relaxed;
 191         ia64_mv_readl_relaxed_t *readl_relaxed;
 192         ia64_mv_readq_relaxed_t *readq_relaxed;
 193         ia64_mv_migrate_t *migrate;
 194         ia64_mv_setup_msi_irq_t *setup_msi_irq;
 195         ia64_mv_teardown_msi_irq_t *teardown_msi_irq;
 196         ia64_mv_pci_fixup_bus_t *pci_fixup_bus;
 197         ia64_mv_kernel_launch_event_t *kernel_launch_event;
 198 } __attribute__((__aligned__(16))); /* align attrib? see above comment */
 199
 200 #define MACHVEC_INIT(name)                      \
 201 {                                               \
 202         #name,                                  \
 203         platform_setup,                         \
 204         platform_cpu_init,                      \
 205         platform_irq_init,                      \
 206         platform_send_ipi,                      \
 207         platform_timer_interrupt,               \
 208         platform_global_tlb_purge,              \
 209         platform_tlb_migrate_finish,            \
 210         platform_dma_init,                      \
 211         platform_dma_get_ops,                   \
 212         platform_irq_to_vector,                 \
 213         platform_local_vector_to_irq,           \
 214         platform_pci_get_legacy_mem,            \
 215         platform_pci_legacy_read,               \
 216         platform_pci_legacy_write,              \
 217         platform_inb,                           \
 218         platform_inw,                           \
 219         platform_inl,                           \
 220         platform_outb,                          \
 221         platform_outw,                          \
 222         platform_outl,                          \
 223         platform_mmiowb,                        \
 224         platform_readb,                         \
 225         platform_readw,                         \
 226         platform_readl,                         \
 227         platform_readq,                         \
 228         platform_readb_relaxed,                 \
 229         platform_readw_relaxed,                 \
 230         platform_readl_relaxed,                 \
 231         platform_readq_relaxed,                 \
 232         platform_migrate,                       \
 233         platform_setup_msi_irq,                 \
 234         platform_teardown_msi_irq,              \
 235         platform_pci_fixup_bus,                 \
 236         platform_kernel_launch_event            \
 237 }
 238
 239 extern struct ia64_machine_vector ia64_mv;
 240 extern void machvec_init (const char *name);
 241 extern void machvec_init_from_cmdline(const char *cmdline);
 242
 243 # else
 244 #  error Unknown configuration.  Update arch/ia64/include/asm/machvec.h.
 245 # endif /* CONFIG_IA64_GENERIC */
 246
 247 extern void swiotlb_dma_init(void);
 248 extern const struct dma_map_ops *dma_get_ops(struct device *);
 249
 250 /*
 251  * Define default versions so we can extend machvec for new platforms without having
 252  * to update the machvec files for all existing platforms.
 253  */
 254 #ifndef platform_setup
 255 # define platform_setup                 machvec_setup
 256 #endif
 257 #ifndef platform_cpu_init
 258 # define platform_cpu_init              machvec_noop
 259 #endif
 260 #ifndef platform_irq_init
 261 # define platform_irq_init              machvec_noop
 262 #endif
 263
 264 #ifndef platform_send_ipi
 265 # define platform_send_ipi              ia64_send_ipi   /* default to architected version */
 266 #endif
 267 #ifndef platform_timer_interrupt
 268 # define platform_timer_interrupt       machvec_timer_interrupt
 269 #endif
 270 #ifndef platform_global_tlb_purge
 271 # define platform_global_tlb_purge      ia64_global_tlb_purge /* default to architected version */
 272 #endif
 273 #ifndef platform_tlb_migrate_finish
 274 # define platform_tlb_migrate_finish    machvec_noop_mm
 275 #endif
 276 #ifndef platform_kernel_launch_event
 277 # define platform_kernel_launch_event   machvec_noop
 278 #endif
 279 #ifndef platform_dma_init
 280 # define platform_dma_init              swiotlb_dma_init
 281 #endif
 282 #ifndef platform_dma_get_ops
 283 # define platform_dma_get_ops           dma_get_ops
 284 #endif
 285 #ifndef platform_irq_to_vector
 286 # define platform_irq_to_vector         __ia64_irq_to_vector
 287 #endif
 288 #ifndef platform_local_vector_to_irq
 289 # define platform_local_vector_to_irq   __ia64_local_vector_to_irq
 290 #endif
 291 #ifndef platform_pci_get_legacy_mem
 292 # define platform_pci_get_legacy_mem    ia64_pci_get_legacy_mem
 293 #endif
 294 #ifndef platform_pci_legacy_read
 295 # define platform_pci_legacy_read       ia64_pci_legacy_read
 296 extern int ia64_pci_legacy_read(struct pci_bus *bus, u16 port, u32 *val, u8 size);
 297 #endif
 298 #ifndef platform_pci_legacy_write
 299 # define platform_pci_legacy_write      ia64_pci_legacy_write
 300 extern int ia64_pci_legacy_write(struct pci_bus *bus, u16 port, u32 val, u8 size);
 301 #endif
 302 #ifndef platform_inb
 303 # define platform_inb           __ia64_inb
 304 #endif
 305 #ifndef platform_inw
 306 # define platform_inw           __ia64_inw
 307 #endif
 308 #ifndef platform_inl
 309 # define platform_inl           __ia64_inl
 310 #endif
 311 #ifndef platform_outb
 312 # define platform_outb          __ia64_outb
 313 #endif
 314 #ifndef platform_outw
 315 # define platform_outw          __ia64_outw
 316 #endif
 317 #ifndef platform_outl
 318 # define platform_outl          __ia64_outl
 319 #endif
 320 #ifndef platform_mmiowb
 321 # define platform_mmiowb        __ia64_mmiowb
 322 #endif
 323 #ifndef platform_readb
 324 # define platform_readb         __ia64_readb
 325 #endif
 326 #ifndef platform_readw
 327 # define platform_readw         __ia64_readw
 328 #endif
 329 #ifndef platform_readl
 330 # define platform_readl         __ia64_readl
 331 #endif
 332 #ifndef platform_readq
 333 # define platform_readq         __ia64_readq
 334 #endif
 335 #ifndef platform_readb_relaxed
 336 # define platform_readb_relaxed __ia64_readb_relaxed
 337 #endif
 338 #ifndef platform_readw_relaxed
 339 # define platform_readw_relaxed __ia64_readw_relaxed
 340 #endif
 341 #ifndef platform_readl_relaxed
 342 # define platform_readl_relaxed __ia64_readl_relaxed
 343 #endif
 344 #ifndef platform_readq_relaxed
 345 # define platform_readq_relaxed __ia64_readq_relaxed
 346 #endif
 347 #ifndef platform_migrate
 348 # define platform_migrate machvec_noop_task
 349 #endif
 350 #ifndef platform_setup_msi_irq
 351 # define platform_setup_msi_irq         ((ia64_mv_setup_msi_irq_t*)NULL)
 352 #endif
 353 #ifndef platform_teardown_msi_irq
 354 # define platform_teardown_msi_irq      ((ia64_mv_teardown_msi_irq_t*)NULL)
 355 #endif
 356 #ifndef platform_pci_fixup_bus
 357 # define platform_pci_fixup_bus machvec_noop_bus
 358 #endif
 359
 360 #endif /* _ASM_IA64_MACHVEC_H */