sys/i386/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  * 3. Neither the name of the author nor the names of any co-contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * $FreeBSD$
  30  */
  31
  32 #ifndef _MACHINE_APICVAR_H_
  33 #define _MACHINE_APICVAR_H_
  34
  35 /*
  36  * Local && I/O APIC variable definitions.
  37  */
  38
  39 /*
  40  * Layout of local APIC interrupt vectors:
  41  *
  42  *      0xff (255)  +-------------+
  43  *                  |             | 15 (Spurious / IPIs / Local Interrupts)
  44  *      0xf0 (240)  +-------------+
  45  *                  |             | 14 (I/O Interrupts / Timer)
  46  *      0xe0 (224)  +-------------+
  47  *                  |             | 13 (I/O Interrupts)
  48  *      0xd0 (208)  +-------------+
  49  *                  |             | 12 (I/O Interrupts)
  50  *      0xc0 (192)  +-------------+
  51  *                  |             | 11 (I/O Interrupts)
  52  *      0xb0 (176)  +-------------+
  53  *                  |             | 10 (I/O Interrupts)
  54  *      0xa0 (160)  +-------------+
  55  *                  |             | 9 (I/O Interrupts)
  56  *      0x90 (144)  +-------------+
  57  *                  |             | 8 (I/O Interrupts / System Calls)
  58  *      0x80 (128)  +-------------+
  59  *                  |             | 7 (I/O Interrupts)
  60  *      0x70 (112)  +-------------+
  61  *                  |             | 6 (I/O Interrupts)
  62  *      0x60 (96)   +-------------+
  63  *                  |             | 5 (I/O Interrupts)
  64  *      0x50 (80)   +-------------+
  65  *                  |             | 4 (I/O Interrupts)
  66  *      0x40 (64)   +-------------+
  67  *                  |             | 3 (I/O Interrupts)
  68  *      0x30 (48)   +-------------+
  69  *                  |             | 2 (ATPIC Interrupts)
  70  *      0x20 (32)   +-------------+
  71  *                  |             | 1 (Exceptions, traps, faults, etc.)
  72  *      0x10 (16)   +-------------+
  73  *                  |             | 0 (Exceptions, traps, faults, etc.)
  74  *      0x00 (0)    +-------------+
  75  *
  76  * Note: 0x80 needs to be handled specially and not allocated to an
  77  * I/O device!
  78  */
  79
  80 #define APIC_ID_ALL     0xff
  81
  82 /* I/O Interrupts are used for external devices such as ISA, PCI, etc. */
  83 #define APIC_IO_INTS    (IDT_IO_INTS + 16)
  84 #define APIC_NUM_IOINTS 191
  85
  86 /* The timer interrupt is used for clock handling and drives hardclock, etc. */
  87 #define APIC_TIMER_INT  (APIC_IO_INTS + APIC_NUM_IOINTS)
  88
  89 /*
  90  ********************* !!! WARNING !!! ******************************
  91  * Each local apic has an interrupt receive fifo that is two entries deep
  92  * for each interrupt priority class (higher 4 bits of interrupt vector).
  93  * Once the fifo is full the APIC can no longer receive interrupts for this
  94  * class and sending IPIs from other CPUs will be blocked.
  95  * To avoid deadlocks there should be no more than two IPI interrupts
  96  * pending at the same time.
  97  * Currently this is guaranteed by dividing the IPIs in two groups that have
  98  * each at most one IPI interrupt pending. The first group is protected by the
  99  * smp_ipi_mtx and waits for the completion of the IPI (Only one IPI user
 100  * at a time) The second group uses a single interrupt and a bitmap to avoid
 101  * redundant IPI interrupts.
 102  *
 103  * Right now IPI_STOP used by kdb shares the interrupt priority class with
 104  * the two IPI groups mentioned above. As such IPI_STOP may cause a deadlock.
 105  * Eventually IPI_STOP should use NMI IPIs - this would eliminate this and
 106  * other deadlocks caused by IPI_STOP.
 107  */
 108
 109 /* Interrupts for local APIC LVT entries other than the timer. */
 110 #define APIC_LOCAL_INTS 240
 111 #define APIC_ERROR_INT  APIC_LOCAL_INTS
 112 #define APIC_THERMAL_INT (APIC_LOCAL_INTS + 1)
 113
 114 #define APIC_IPI_INTS   (APIC_LOCAL_INTS + 2)
 115 #define IPI_RENDEZVOUS  (APIC_IPI_INTS)         /* Inter-CPU rendezvous. */
 116 #define IPI_INVLTLB     (APIC_IPI_INTS + 1)     /* TLB Shootdown IPIs */
 117 #define IPI_INVLPG      (APIC_IPI_INTS + 2)
 118 #define IPI_INVLRNG     (APIC_IPI_INTS + 3)
 119 #define IPI_LAZYPMAP    (APIC_IPI_INTS + 4)     /* Lazy pmap release. */
 120 /* Vector to handle bitmap based IPIs */
 121 #define IPI_BITMAP_VECTOR       (APIC_IPI_INTS + 5)
 122
 123 /* IPIs handled by IPI_BITMAPED_VECTOR  (XXX ups is there a better place?) */
 124 #define IPI_AST         0       /* Generate software trap. */
 125 #define IPI_PREEMPT     1
 126 #define IPI_BITMAP_LAST IPI_PREEMPT
 127 #define IPI_IS_BITMAPED(x) ((x) <= IPI_BITMAP_LAST)
 128
 129 #define IPI_STOP        (APIC_IPI_INTS + 6)     /* Stop CPU until restarted. */
 130
 131 /*
 132  * The spurious interrupt can share the priority class with the IPIs since
 133  * it is not a normal interrupt. (Does not use the APIC's interrupt fifo)
 134  */
 135 #define APIC_SPURIOUS_INT 255
 136
 137 #define LVT_LINT0       0
 138 #define LVT_LINT1       1
 139 #define LVT_TIMER       2
 140 #define LVT_ERROR       3
 141 #define LVT_PMC         4
 142 #define LVT_THERMAL     5
 143 #define LVT_MAX         LVT_THERMAL
 144
 145 #ifndef LOCORE
 146
 147 #define APIC_IPI_DEST_SELF      -1
 148 #define APIC_IPI_DEST_ALL       -2
 149 #define APIC_IPI_DEST_OTHERS    -3
 150
 151 #define APIC_BUS_UNKNOWN        -1
 152 #define APIC_BUS_ISA            0
 153 #define APIC_BUS_EISA           1
 154 #define APIC_BUS_PCI            2
 155 #define APIC_BUS_MAX            APIC_BUS_PCI
 156
 157 /*
 158  * An APIC enumerator is a psuedo bus driver that enumerates APIC's including
 159  * CPU's and I/O APIC's.
 160  */
 161 struct apic_enumerator {
 162         const char *apic_name;
 163         int (*apic_probe)(void);
 164         int (*apic_probe_cpus)(void);
 165         int (*apic_setup_local)(void);
 166         int (*apic_setup_io)(void);
 167         SLIST_ENTRY(apic_enumerator) apic_next;
 168 };
 169
 170 inthand_t
 171         IDTVEC(apic_isr1), IDTVEC(apic_isr2), IDTVEC(apic_isr3),
 172         IDTVEC(apic_isr4), IDTVEC(apic_isr5), IDTVEC(apic_isr6),
 173         IDTVEC(apic_isr7), IDTVEC(spuriousint), IDTVEC(timerint);
 174
 175 u_int   apic_alloc_vector(u_int irq);
 176 void    apic_enable_vector(u_int vector);
 177 void    apic_free_vector(u_int vector, u_int irq);
 178 u_int   apic_idt_to_irq(u_int vector);
 179 void    apic_register_enumerator(struct apic_enumerator *enumerator);
 180 void    *ioapic_create(uintptr_t addr, int32_t id, int intbase);
 181 int     ioapic_disable_pin(void *cookie, u_int pin);
 182 int     ioapic_get_vector(void *cookie, u_int pin);
 183 int     ioapic_next_logical_cluster(void);
 184 void    ioapic_register(void *cookie);
 185 int     ioapic_remap_vector(void *cookie, u_int pin, int vector);
 186 int     ioapic_set_bus(void *cookie, u_int pin, int bus_type);
 187 int     ioapic_set_extint(void *cookie, u_int pin);
 188 int     ioapic_set_nmi(void *cookie, u_int pin);
 189 int     ioapic_set_polarity(void *cookie, u_int pin, enum intr_polarity pol);
 190 int     ioapic_set_triggermode(void *cookie, u_int pin,
 191             enum intr_trigger trigger);
 192 int     ioapic_set_smi(void *cookie, u_int pin);
 193 void    lapic_create(u_int apic_id, int boot_cpu);
 194 void    lapic_disable(void);
 195 void    lapic_dump(const char *str);
 196 void    lapic_eoi(void);
 197 int     lapic_id(void);
 198 void    lapic_init(uintptr_t addr);
 199 int     lapic_intr_pending(u_int vector);
 200 void    lapic_ipi_raw(register_t icrlo, u_int dest);
 201 void    lapic_ipi_vectored(u_int vector, int dest);
 202 int     lapic_ipi_wait(int delay);
 203 void    lapic_handle_intr(struct intrframe frame);
 204 void    lapic_handle_timer(struct clockframe frame);
 205 void    lapic_set_logical_id(u_int apic_id, u_int cluster, u_int cluster_id);
 206 int     lapic_set_lvt_mask(u_int apic_id, u_int lvt, u_char masked);
 207 int     lapic_set_lvt_mode(u_int apic_id, u_int lvt, u_int32_t mode);
 208 int     lapic_set_lvt_polarity(u_int apic_id, u_int lvt,
 209             enum intr_polarity pol);
 210 int     lapic_set_lvt_triggermode(u_int apic_id, u_int lvt,
 211             enum intr_trigger trigger);
 212 void    lapic_set_tpr(u_int vector);
 213 void    lapic_setup(void);
 214 int     lapic_setup_clock(void);
 215
 216 #endif /* !LOCORE */
 217 #endif /* _MACHINE_APICVAR_H_ */