git.mutantstargoat.com Git - metatoy/blob - src/kern/intr.c

   1 /*
   2 pcboot - bootable PC demo/game kernel
   3 Copyright (C) 2018  John Tsiombikas <nuclear@member.fsf.org>
   4
   5 This program is free software: you can redistribute it and/or modify
   6 it under the terms of the GNU General Public License as published by
   7 the Free Software Foundation, either version 3 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY, without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program.  If not, see <https://www.gnu.org/licenses/>.
  17 */
  18 #include <stdio.h>
  19 #include "config.h"
  20 #include "intr.h"
  21 #include "desc.h"
  22 #include "segm.h"
  23 #include "asmops.h"
  24 #include "panic.h"
  25
  26 #define SYSCALL_INT             0x80
  27
  28 /* IDT gate descriptor bits */
  29 #define GATE_TASK               (5 << 8)
  30 #define GATE_INTR               (6 << 8)
  31 #define GATE_TRAP               (7 << 8)
  32 #define GATE_DEFAULT    (1 << 11)
  33 #define GATE_PRESENT    (1 << 15)
  34
  35 /* PIC command and data ports */
  36 #define PIC1_CMD        0x20
  37 #define PIC1_DATA       0x21
  38 #define PIC2_CMD        0xa0
  39 #define PIC2_DATA       0xa1
  40
  41 /* PIC initialization command word 1 bits */
  42 #define ICW1_ICW4_NEEDED        (1 << 0)
  43 #define ICW1_SINGLE                     (1 << 1)
  44 #define ICW1_INTERVAL4          (1 << 2)
  45 #define ICW1_LEVEL                      (1 << 3)
  46 #define ICW1_INIT                       (1 << 4)
  47 /* PIC initialization command word 4 bits */
  48 #define ICW4_8086                       (1 << 0)
  49 #define ICW4_AUTO_EOI           (1 << 1)
  50 #define ICW4_BUF_SLAVE          (1 << 3) /* 1000 */
  51 #define ICW4_BUF_MASTER         (3 << 2) /* 1100 */
  52 #define ICW4_SPECIAL            (1 << 4)
  53
  54 /* PIC operation command word 2 bits */
  55 #define OCW2_EOI        (1 << 5)
  56
  57
  58 static void gate_desc(desc_t *desc, uint16_t sel, uint32_t addr, int dpl, int type);
  59
  60 /* defined in intr_asm.S */
  61 void set_idt(uint32_t addr, uint16_t limit);
  62 void intr_entry_default(void);
  63 void irq7_entry_check_spurious(void);
  64 void irq15_entry_check_spurious(void);
  65
  66 /* the IDT (interrupt descriptor table) */
  67 static desc_t idt[256] __attribute__((aligned(8)));
  68
  69 /* table of handler functions for all interrupts */
  70 static intr_func_t intr_func[256];
  71
  72 static struct intr_frame *cur_intr_frame;
  73 static int eoi_pending;
  74
  75 #define INTR_ENTRY_EC(n, name)          \
  76         void intr_entry_##name(void);   \
  77         set_intr_entry(n, intr_entry_##name);
  78 #define INTR_ENTRY_NOEC(n, name)        INTR_ENTRY_EC(n, name)
  79
  80 void init_intr(void)
  81 {
  82         int i;
  83
  84         set_idt((uint32_t)idt, sizeof idt - 1);
  85
  86         /* initialize all entry points and interrupt handlers */
  87         for(i=0; i<256; i++) {
  88                 set_intr_entry(i, intr_entry_default);
  89                 interrupt(i, 0);
  90         }
  91
  92         /* by including intrtab.h here the series of INTR_ENTRY_* macros will be
  93          * expanded to a series of function prototypes for all interrupt entry
  94          * points and the corresponding calls to set_intr_entry to set up the IDT
  95          * slots
  96          */
  97 #include "intrtab.h"
  98
  99         /* change irq7 and irq15 to special entry points which first
 100          * make sure we didn't get a spurious interrupt before proceeding
 101          */
 102         set_intr_entry(IRQ_TO_INTR(7), irq7_entry_check_spurious);
 103         set_intr_entry(IRQ_TO_INTR(15), irq15_entry_check_spurious);
 104
 105         /* initialize the programmable interrupt controller
 106          * setting up the maping of IRQs [0, 15] to interrupts [32, 47]
 107          */
 108         prog_pic(IRQ_OFFSET);
 109         eoi_pending = 0;
 110 }
 111
 112 void cleanup_intr(void)
 113 {
 114         disable_intr();
 115         /* reprogram the PIC to the default BIOS offset (8) */
 116         prog_pic(8);
 117 }
 118
 119 /* retrieve the current interrupt frame.
 120  * returns 0 when called during init.
 121  */
 122 struct intr_frame *get_intr_frame(void)
 123 {
 124         return cur_intr_frame;
 125 }
 126
 127 /* set an interrupt handler function for a particular interrupt */
 128 void interrupt(int intr_num, intr_func_t func)
 129 {
 130         int iflag = get_intr_flag();
 131         disable_intr();
 132         intr_func[intr_num] = func;
 133         set_intr_flag(iflag);
 134 }
 135
 136 /* this function is called from all interrupt entry points
 137  * it calls the appropriate interrupt handlers if available and handles
 138  * sending an end-of-interrupt command to the PICs when finished.
 139  */
 140 void dispatch_intr(struct intr_frame frm)
 141 {
 142         cur_intr_frame = &frm;
 143
 144         if(IS_IRQ(frm.inum)) {
 145                 eoi_pending = frm.inum;
 146         }
 147
 148         if(intr_func[frm.inum]) {
 149                 intr_func[frm.inum](frm.inum);
 150         } else {
 151                 if(frm.inum < 32) {
 152                         panic("unhandled exception %u, error code: %u, at cs:eip=%x:%x\n",
 153                                         frm.inum, frm.err, frm.cs, frm.eip);
 154                 }
 155                 /*printf("unhandled interrupt %d\n", frm.inum);*/
 156         }
 157
 158         disable_intr();
 159         if(eoi_pending) {
 160                 end_of_irq(INTR_TO_IRQ(eoi_pending));
 161         }
 162 }
 163
 164 void prog_pic(int offs)
 165 {
 166         /* send ICW1 saying we'll follow with ICW4 later on */
 167         outp(PIC1_CMD, ICW1_INIT | ICW1_ICW4_NEEDED);
 168         outp(PIC2_CMD, ICW1_INIT | ICW1_ICW4_NEEDED);
 169         /* send ICW2 with IRQ remapping */
 170         outp(PIC1_DATA, offs);
 171         outp(PIC2_DATA, offs + 8);
 172         /* send ICW3 to setup the master/slave relationship */
 173         /* ... set bit3 = 3rd interrupt input has a slave */
 174         outp(PIC1_DATA, 4);
 175         /* ... set slave ID to 2 */
 176         outp(PIC2_DATA, 2);
 177         /* send ICW4 to set 8086 mode (no calls generated) */
 178         outp(PIC1_DATA, ICW4_8086);
 179         outp(PIC2_DATA, ICW4_8086);
 180         /* done, just reset the data port to 0 */
 181         outp(PIC1_DATA, 0);
 182         outp(PIC2_DATA, 0);
 183 }
 184
 185 static void gate_desc(desc_t *desc, uint16_t sel, uint32_t addr, int dpl, int type)
 186 {
 187         /* first 16bit part is the low 16bits of the entry address */
 188         desc->d[0] = addr & 0xffff;
 189         /* second 16bit part is the segment selector for the entry code */
 190         desc->d[1] = sel;
 191         /* third 16bit part has the privilege level, type, and present bit */
 192         desc->d[2] = ((dpl & 3) << 13) | type | GATE_DEFAULT | GATE_PRESENT;
 193         /* last 16bit part is the high 16bits of the entry address */
 194         desc->d[3] = (addr & 0xffff0000) >> 16;
 195 }
 196
 197 #define IS_TRAP(n)      ((n) >= 32 && !IS_IRQ(n))
 198 void set_intr_entry(int num, void (*handler)(void))
 199 {
 200         int type = IS_TRAP(num) ? GATE_TRAP : GATE_INTR;
 201
 202         /* the syscall interrupt has to have a dpl of 3 otherwise calling it from
 203          * user space will raise a general protection exception. All the rest should
 204          * have a dpl of 0 to disallow user programs to execute critical interrupt
 205          * handlers and possibly crashing the system.
 206          */
 207         int dpl = (num == SYSCALL_INT) ? 3 : 0;
 208
 209         gate_desc(idt + num, selector(SEGM_CODE, 0), (uint32_t)handler, dpl, type);
 210 }
 211
 212 void set_pic_mask(int pic, unsigned char mask)
 213 {
 214         outp(pic > 0 ? PIC2_DATA : PIC1_DATA, mask);
 215 }
 216
 217 unsigned char get_pic_mask(int pic)
 218 {
 219         return inp(pic > 0 ? PIC2_DATA : PIC1_DATA);
 220 }
 221
 222 void mask_irq(int irq)
 223 {
 224         int port;
 225         unsigned char mask;
 226
 227         if(irq < 8) {
 228                 port = PIC1_DATA;
 229         } else {
 230                 port = PIC2_DATA;
 231                 irq -= 8;
 232         }
 233
 234         mask = inp(port) | (1 << irq);
 235         outp(port, mask);
 236 }
 237
 238 void unmask_irq(int irq)
 239 {
 240         int port;
 241         unsigned char mask;
 242
 243         if(irq < 8) {
 244                 port = PIC1_DATA;
 245         } else {
 246                 port = PIC2_DATA;
 247                 irq -= 8;
 248         }
 249
 250         mask = inp(port) & ~(1 << irq);
 251         outp(port, mask);
 252 }
 253
 254
 255 void end_of_irq(int irq)
 256 {
 257         int intr_state = get_intr_flag();
 258         disable_intr();
 259
 260         if(!eoi_pending) {
 261                 set_intr_flag(intr_state);
 262                 return;
 263         }
 264         eoi_pending = 0;
 265
 266         if(irq > 7) {
 267                 outp(PIC2_CMD, OCW2_EOI);
 268         }
 269         outp(PIC1_CMD, OCW2_EOI);
 270
 271         set_intr_flag(intr_state);
 272 }
 273
 274 #ifdef ENABLE_GDB_STUB
 275 void exceptionHandler(int id, void (*func)())
 276 {
 277         set_intr_entry(id, func);
 278 }
 279 #endif