sys/x86/include/apicvar.h

   1 /*-
   2  * Copyright (c) 2003 John Baldwin <jhb@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef _X86_APICVAR_H_
  30 #define _X86_APICVAR_H_
  31
  32 /*
  33  * Local && I/O APIC variable definitions.
  34  */
  35
  36 /*
  37  * Layout of local APIC interrupt vectors:
  38  *
  39  *      0xff (255)  +-------------+
  40  *                  |             | 15 (Spurious / IPIs / Local Interrupts)
  41  *      0xf0 (240)  +-------------+
  42  *                  |             | 14 (I/O Interrupts / Timer)
  43  *      0xe0 (224)  +-------------+
  44  *                  |             | 13 (I/O Interrupts)
  45  *      0xd0 (208)  +-------------+
  46  *                  |             | 12 (I/O Interrupts)
  47  *      0xc0 (192)  +-------------+
  48  *                  |             | 11 (I/O Interrupts)
  49  *      0xb0 (176)  +-------------+
  50  *                  |             | 10 (I/O Interrupts)
  51  *      0xa0 (160)  +-------------+
  52  *                  |             | 9 (I/O Interrupts)
  53  *      0x90 (144)  +-------------+
  54  *                  |             | 8 (I/O Interrupts / System Calls)
  55  *      0x80 (128)  +-------------+
  56  *                  |             | 7 (I/O Interrupts)
  57  *      0x70 (112)  +-------------+
  58  *                  |             | 6 (I/O Interrupts)
  59  *      0x60 (96)   +-------------+
  60  *                  |             | 5 (I/O Interrupts)
  61  *      0x50 (80)   +-------------+
  62  *                  |             | 4 (I/O Interrupts)
  63  *      0x40 (64)   +-------------+
  64  *                  |             | 3 (I/O Interrupts)
  65  *      0x30 (48)   +-------------+
  66  *                  |             | 2 (ATPIC Interrupts)
  67  *      0x20 (32)   +-------------+
  68  *                  |             | 1 (Exceptions, traps, faults, etc.)
  69  *      0x10 (16)   +-------------+
  70  *                  |             | 0 (Exceptions, traps, faults, etc.)
  71  *      0x00 (0)    +-------------+
  72  *
  73  * Note: 0x80 needs to be handled specially and not allocated to an
  74  * I/O device!
  75  */
  76
  77 #define MAX_APIC_ID     0xfe
  78 #define APIC_ID_ALL     0xff
  79
  80 /* I/O Interrupts are used for external devices such as ISA, PCI, etc. */
  81 #define APIC_IO_INTS    (IDT_IO_INTS + 16)
  82 #define APIC_NUM_IOINTS 191
  83
  84 /* The timer interrupt is used for clock handling and drives hardclock, etc. */
  85 #define APIC_TIMER_INT  (APIC_IO_INTS + APIC_NUM_IOINTS)
  86
  87 /*
  88  ********************* !!! WARNING !!! ******************************
  89  * Each local apic has an interrupt receive fifo that is two entries deep
  90  * for each interrupt priority class (higher 4 bits of interrupt vector).
  91  * Once the fifo is full the APIC can no longer receive interrupts for this
  92  * class and sending IPIs from other CPUs will be blocked.
  93  * To avoid deadlocks there should be no more than two IPI interrupts
  94  * pending at the same time.
  95  * Currently this is guaranteed by dividing the IPIs in two groups that have
  96  * each at most one IPI interrupt pending. The first group is protected by the
  97  * smp_ipi_mtx and waits for the completion of the IPI (Only one IPI user
  98  * at a time) The second group uses a single interrupt and a bitmap to avoid
  99  * redundant IPI interrupts.
 100  */
 101
 102 /* Interrupts for local APIC LVT entries other than the timer. */
 103 #define APIC_LOCAL_INTS 240
 104 #define APIC_ERROR_INT  APIC_LOCAL_INTS
 105 #define APIC_THERMAL_INT (APIC_LOCAL_INTS + 1)
 106 #define APIC_CMC_INT    (APIC_LOCAL_INTS + 2)
 107 #define APIC_IPI_INTS   (APIC_LOCAL_INTS + 3)
 108
 109 #define IPI_RENDEZVOUS  (APIC_IPI_INTS)         /* Inter-CPU rendezvous. */
 110 #define IPI_INVLTLB     (APIC_IPI_INTS + 1)     /* TLB Shootdown IPIs */
 111 #define IPI_INVLPG      (APIC_IPI_INTS + 2)
 112 #define IPI_INVLRNG     (APIC_IPI_INTS + 3)
 113 #define IPI_INVLCACHE   (APIC_IPI_INTS + 4)
 114 /* Vector to handle bitmap based IPIs */
 115 #define IPI_BITMAP_VECTOR       (APIC_IPI_INTS + 5)
 116
 117 /* IPIs handled by IPI_BITMAP_VECTOR */
 118 #define IPI_AST         0       /* Generate software trap. */
 119 #define IPI_PREEMPT     1
 120 #define IPI_HARDCLOCK   2
 121 #define IPI_BITMAP_LAST IPI_HARDCLOCK
 122 #define IPI_IS_BITMAPED(x) ((x) <= IPI_BITMAP_LAST)
 123
 124 #define IPI_STOP        (APIC_IPI_INTS + 6)     /* Stop CPU until restarted. */
 125 #define IPI_SUSPEND     (APIC_IPI_INTS + 7)     /* Suspend CPU until restarted. */
 126 #ifdef __i386__
 127 #define IPI_LAZYPMAP    (APIC_IPI_INTS + 8)     /* Lazy pmap release. */
 128 #define IPI_DYN_FIRST   (APIC_IPI_INTS + 9)
 129 #else
 130 #define IPI_DYN_FIRST   (APIC_IPI_INTS + 8)
 131 #endif
 132 #define IPI_DYN_LAST    (254)                   /* IPIs allocated at runtime */
 133
 134 /*
 135  * IPI_STOP_HARD does not need to occupy a slot in the IPI vector space since
 136  * it is delivered using an NMI anyways.
 137  */
 138 #define IPI_STOP_HARD   255                     /* Stop CPU with a NMI. */
 139
 140 /*
 141  * The spurious interrupt can share the priority class with the IPIs since
 142  * it is not a normal interrupt. (Does not use the APIC's interrupt fifo)
 143  */
 144 #define APIC_SPURIOUS_INT 255
 145
 146 #ifndef LOCORE
 147
 148 #define APIC_IPI_DEST_SELF      -1
 149 #define APIC_IPI_DEST_ALL       -2
 150 #define APIC_IPI_DEST_OTHERS    -3
 151
 152 #define APIC_BUS_UNKNOWN        -1
 153 #define APIC_BUS_ISA            0
 154 #define APIC_BUS_EISA           1
 155 #define APIC_BUS_PCI            2
 156 #define APIC_BUS_MAX            APIC_BUS_PCI
 157
 158 #define IRQ_EXTINT              (NUM_IO_INTS + 1)
 159 #define IRQ_NMI                 (NUM_IO_INTS + 2)
 160 #define IRQ_SMI                 (NUM_IO_INTS + 3)
 161 #define IRQ_DISABLED            (NUM_IO_INTS + 4)
 162
 163 /*
 164  * An APIC enumerator is a psuedo bus driver that enumerates APIC's including
 165  * CPU's and I/O APIC's.
 166  */
 167 struct apic_enumerator {
 168         const char *apic_name;
 169         int (*apic_probe)(void);
 170         int (*apic_probe_cpus)(void);
 171         int (*apic_setup_local)(void);
 172         int (*apic_setup_io)(void);
 173         SLIST_ENTRY(apic_enumerator) apic_next;
 174 };
 175
 176 inthand_t
 177         IDTVEC(apic_isr1), IDTVEC(apic_isr2), IDTVEC(apic_isr3),
 178         IDTVEC(apic_isr4), IDTVEC(apic_isr5), IDTVEC(apic_isr6),
 179         IDTVEC(apic_isr7), IDTVEC(cmcint), IDTVEC(errorint),
 180         IDTVEC(spuriousint), IDTVEC(timerint);
 181
 182 extern vm_paddr_t lapic_paddr;
 183 extern int apic_cpuids[];
 184
 185 void    apic_register_enumerator(struct apic_enumerator *enumerator);
 186 void    *ioapic_create(vm_paddr_t addr, int32_t apic_id, int intbase);
 187 int     ioapic_disable_pin(void *cookie, u_int pin);
 188 int     ioapic_get_vector(void *cookie, u_int pin);
 189 void    ioapic_register(void *cookie);
 190 int     ioapic_remap_vector(void *cookie, u_int pin, int vector);
 191 int     ioapic_set_bus(void *cookie, u_int pin, int bus_type);
 192 int     ioapic_set_extint(void *cookie, u_int pin);
 193 int     ioapic_set_nmi(void *cookie, u_int pin);
 194 int     ioapic_set_polarity(void *cookie, u_int pin, enum intr_polarity pol);
 195 int     ioapic_set_triggermode(void *cookie, u_int pin,
 196             enum intr_trigger trigger);
 197 int     ioapic_set_smi(void *cookie, u_int pin);
 198
 199 /*
 200  * Struct containing pointers to APIC functions whose
 201  * implementation is run time selectable.
 202  */
 203 struct apic_ops {
 204         void    (*create)(u_int, int);
 205         void    (*init)(vm_paddr_t);
 206         void    (*xapic_mode)(void);
 207         void    (*setup)(int);
 208         void    (*dump)(const char *);
 209         void    (*disable)(void);
 210         void    (*eoi)(void);
 211         int     (*id)(void);
 212         int     (*intr_pending)(u_int);
 213         void    (*set_logical_id)(u_int, u_int, u_int);
 214         u_int   (*cpuid)(u_int);
 215
 216         /* Vectors */
 217         u_int   (*alloc_vector)(u_int, u_int);
 218         u_int   (*alloc_vectors)(u_int, u_int *, u_int, u_int);
 219         void    (*enable_vector)(u_int, u_int);
 220         void    (*disable_vector)(u_int, u_int);
 221         void    (*free_vector)(u_int, u_int, u_int);
 222
 223
 224         /* PMC */
 225         int     (*enable_pmc)(void);
 226         void    (*disable_pmc)(void);
 227         void    (*reenable_pmc)(void);
 228
 229         /* CMC */
 230         void    (*enable_cmc)(void);
 231
 232         /* IPI */
 233         void    (*ipi_raw)(register_t, u_int);
 234         void    (*ipi_vectored)(u_int, int);
 235         int     (*ipi_wait)(int);
 236         int     (*ipi_alloc)(inthand_t *ipifunc);
 237         void    (*ipi_free)(int vector);
 238
 239         /* LVT */
 240         int     (*set_lvt_mask)(u_int, u_int, u_char);
 241         int     (*set_lvt_mode)(u_int, u_int, u_int32_t);
 242         int     (*set_lvt_polarity)(u_int, u_int, enum intr_polarity);
 243         int     (*set_lvt_triggermode)(u_int, u_int, enum intr_trigger);
 244 };
 245
 246 extern struct apic_ops apic_ops;
 247
 248 static inline void
 249 lapic_create(u_int apic_id, int boot_cpu)
 250 {
 251
 252         apic_ops.create(apic_id, boot_cpu);
 253 }
 254
 255 static inline void
 256 lapic_init(vm_paddr_t addr)
 257 {
 258
 259         apic_ops.init(addr);
 260 }
 261
 262 static inline void
 263 lapic_xapic_mode(void)
 264 {
 265
 266         apic_ops.xapic_mode();
 267 }
 268
 269 static inline void
 270 lapic_setup(int boot)
 271 {
 272
 273         apic_ops.setup(boot);
 274 }
 275
 276 static inline void
 277 lapic_dump(const char *str)
 278 {
 279
 280         apic_ops.dump(str);
 281 }
 282
 283 static inline void
 284 lapic_disable(void)
 285 {
 286
 287         apic_ops.disable();
 288 }
 289
 290 static inline void
 291 lapic_eoi(void)
 292 {
 293
 294         apic_ops.eoi();
 295 }
 296
 297 static inline int
 298 lapic_id(void)
 299 {
 300
 301         return (apic_ops.id());
 302 }
 303
 304 static inline int
 305 lapic_intr_pending(u_int vector)
 306 {
 307
 308         return (apic_ops.intr_pending(vector));
 309 }
 310
 311 /* XXX: UNUSED */
 312 static inline void
 313 lapic_set_logical_id(u_int apic_id, u_int cluster, u_int cluster_id)
 314 {
 315
 316         apic_ops.set_logical_id(apic_id, cluster, cluster_id);
 317 }
 318
 319 static inline u_int
 320 apic_cpuid(u_int apic_id)
 321 {
 322
 323         return (apic_ops.cpuid(apic_id));
 324 }
 325
 326 static inline u_int
 327 apic_alloc_vector(u_int apic_id, u_int irq)
 328 {
 329
 330         return (apic_ops.alloc_vector(apic_id, irq));
 331 }
 332
 333 static inline u_int
 334 apic_alloc_vectors(u_int apic_id, u_int *irqs, u_int count, u_int align)
 335 {
 336
 337         return (apic_ops.alloc_vectors(apic_id, irqs, count, align));
 338 }
 339
 340 static inline void
 341 apic_enable_vector(u_int apic_id, u_int vector)
 342 {
 343
 344         apic_ops.enable_vector(apic_id, vector);
 345 }
 346
 347 static inline void
 348 apic_disable_vector(u_int apic_id, u_int vector)
 349 {
 350
 351         apic_ops.disable_vector(apic_id, vector);
 352 }
 353
 354 static inline void
 355 apic_free_vector(u_int apic_id, u_int vector, u_int irq)
 356 {
 357
 358         apic_ops.free_vector(apic_id, vector, irq);
 359 }
 360
 361 static inline int
 362 lapic_enable_pmc(void)
 363 {
 364
 365         return (apic_ops.enable_pmc());
 366 }
 367
 368 static inline void
 369 lapic_disable_pmc(void)
 370 {
 371
 372         apic_ops.disable_pmc();
 373 }
 374
 375 static inline void
 376 lapic_reenable_pmc(void)
 377 {
 378
 379         apic_ops.reenable_pmc();
 380 }
 381
 382 static inline void
 383 lapic_enable_cmc(void)
 384 {
 385
 386         apic_ops.enable_cmc();
 387 }
 388
 389 static inline void
 390 lapic_ipi_raw(register_t icrlo, u_int dest)
 391 {
 392
 393         apic_ops.ipi_raw(icrlo, dest);
 394 }
 395
 396 static inline void
 397 lapic_ipi_vectored(u_int vector, int dest)
 398 {
 399
 400         apic_ops.ipi_vectored(vector, dest);
 401 }
 402
 403 static inline int
 404 lapic_ipi_wait(int delay)
 405 {
 406
 407         return (apic_ops.ipi_wait(delay));
 408 }
 409
 410 static inline int
 411 lapic_ipi_alloc(inthand_t *ipifunc)
 412 {
 413
 414         return (apic_ops.ipi_alloc(ipifunc));
 415 }
 416
 417 static inline void
 418 lapic_ipi_free(int vector)
 419 {
 420
 421         return (apic_ops.ipi_free(vector));
 422 }
 423
 424 static inline int
 425 lapic_set_lvt_mask(u_int apic_id, u_int lvt, u_char masked)
 426 {
 427
 428         return (apic_ops.set_lvt_mask(apic_id, lvt, masked));
 429 }
 430
 431 static inline int
 432 lapic_set_lvt_mode(u_int apic_id, u_int lvt, u_int32_t mode)
 433 {
 434
 435         return (apic_ops.set_lvt_mode(apic_id, lvt, mode));
 436 }
 437
 438 static inline int
 439 lapic_set_lvt_polarity(u_int apic_id, u_int lvt, enum intr_polarity pol)
 440 {
 441
 442         return (apic_ops.set_lvt_polarity(apic_id, lvt, pol));
 443 }
 444
 445 static inline int
 446 lapic_set_lvt_triggermode(u_int apic_id, u_int lvt, enum intr_trigger trigger)
 447 {
 448
 449         return (apic_ops.set_lvt_triggermode(apic_id, lvt, trigger));
 450 }
 451
 452 void    lapic_handle_cmc(void);
 453 void    lapic_handle_error(void);
 454 void    lapic_handle_intr(int vector, struct trapframe *frame);
 455 void    lapic_handle_timer(struct trapframe *frame);
 456 void    xen_intr_handle_upcall(struct trapframe *frame);
 457 void    hv_vector_handler(struct trapframe *frame);
 458
 459 extern int x2apic_mode;
 460 extern int lapic_eoi_suppression;
 461
 462 #ifdef _SYS_SYSCTL_H_
 463 SYSCTL_DECL(_hw_apic);
 464 #endif
 465
 466 #endif /* !LOCORE */
 467 #endif /* _X86_APICVAR_H_ */