added copyright headers to new files
[bootcensus] / src / 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 "intr.h"
20 #include "desc.h"
21 #include "segm.h"
22 #include "asmops.h"
23 #include "panic.h"
24
25 #define SYSCALL_INT             0x80
26
27 /* IDT gate descriptor bits */
28 #define GATE_TASK               (5 << 8)
29 #define GATE_INTR               (6 << 8)
30 #define GATE_TRAP               (7 << 8)
31 #define GATE_DEFAULT    (1 << 11)
32 #define GATE_PRESENT    (1 << 15)
33
34 /* PIC command and data ports */
35 #define PIC1_CMD        0x20
36 #define PIC1_DATA       0x21
37 #define PIC2_CMD        0xa0
38 #define PIC2_DATA       0xa1
39
40 /* PIC initialization command word 1 bits */
41 #define ICW1_ICW4_NEEDED        (1 << 0)
42 #define ICW1_SINGLE                     (1 << 1)
43 #define ICW1_INTERVAL4          (1 << 2)
44 #define ICW1_LEVEL                      (1 << 3)
45 #define ICW1_INIT                       (1 << 4)
46 /* PIC initialization command word 4 bits */
47 #define ICW4_8086                       (1 << 0)
48 #define ICW4_AUTO_EOI           (1 << 1)
49 #define ICW4_BUF_SLAVE          (1 << 3) /* 1000 */
50 #define ICW4_BUF_MASTER         (3 << 2) /* 1100 */
51 #define ICW4_SPECIAL            (1 << 4)
52
53 /* PIC operation command word 2 bits */
54 #define OCW2_EOI        (1 << 5)
55
56
57 static void init_pic(int offset);
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
64 /* the IDT (interrupt descriptor table) */
65 static desc_t idt[256] __attribute__((aligned(8)));
66
67 /* table of handler functions for all interrupts */
68 static intr_func_t intr_func[256];
69
70 static struct intr_frame *cur_intr_frame;
71 static int eoi_pending;
72
73
74 void init_intr(void)
75 {
76         int i;
77
78         set_idt((uint32_t)idt, sizeof idt - 1);
79
80         /* initialize all entry points and interrupt handlers */
81         for(i=0; i<256; i++) {
82                 set_intr_entry(i, intr_entry_default);
83                 interrupt(i, 0);
84         }
85
86         /* by including intrtab.h here (without ASM being defined)
87          * the series of INTR_ENTRY_* macros will be expanded to a series
88          * of function prototypes for all interrupt entry points and the
89          * corresponding calls to set_intr_entry to set up the IDT slots
90          */
91 #include "intrtab.h"
92
93         /* initialize the programmable interrupt controller
94          * setting up the maping of IRQs [0, 15] to interrupts [32, 47]
95          */
96         init_pic(IRQ_OFFSET);
97         eoi_pending = 0;
98 }
99
100 /* retrieve the current interrupt frame.
101  * returns 0 when called during init.
102  */
103 struct intr_frame *get_intr_frame(void)
104 {
105         return cur_intr_frame;
106 }
107
108 /* set an interrupt handler function for a particular interrupt */
109 void interrupt(int intr_num, intr_func_t func)
110 {
111         intr_func[intr_num] = func;
112 }
113
114 /* this function is called from all interrupt entry points
115  * it calls the appropriate interrupt handlers if available and handles
116  * sending an end-of-interrupt command to the PICs when finished.
117  */
118 void dispatch_intr(struct intr_frame frm)
119 {
120         cur_intr_frame = &frm;
121
122         if(IS_IRQ(frm.inum)) {
123                 eoi_pending = frm.inum;
124         }
125
126         if(intr_func[frm.inum]) {
127                 intr_func[frm.inum](frm.inum);
128         } else {
129                 if(frm.inum < 32) {
130                         panic("unhandled exception %d, error code: %d\n", frm.inum, frm.err);
131                 }
132                 printf("unhandled interrupt %d\n", frm.inum);
133         }
134
135         disable_intr();
136         if(eoi_pending) {
137                 end_of_irq(INTR_TO_IRQ(eoi_pending));
138         }
139 }
140
141 static void init_pic(int offset)
142 {
143         /* send ICW1 saying we'll follow with ICW4 later on */
144         outb(ICW1_INIT | ICW1_ICW4_NEEDED, PIC1_CMD);
145         outb(ICW1_INIT | ICW1_ICW4_NEEDED, PIC2_CMD);
146         /* send ICW2 with IRQ remapping */
147         outb(offset, PIC1_DATA);
148         outb(offset + 8, PIC2_DATA);
149         /* send ICW3 to setup the master/slave relationship */
150         /* ... set bit3 = 3rd interrupt input has a slave */
151         outb(4, PIC1_DATA);
152         /* ... set slave ID to 2 */
153         outb(2, PIC2_DATA);
154         /* send ICW4 to set 8086 mode (no calls generated) */
155         outb(ICW4_8086, PIC1_DATA);
156         outb(ICW4_8086, PIC2_DATA);
157         /* done, just reset the data port to 0 */
158         outb(0, PIC1_DATA);
159         outb(0, PIC2_DATA);
160 }
161
162 static void gate_desc(desc_t *desc, uint16_t sel, uint32_t addr, int dpl, int type)
163 {
164         /* first 16bit part is the low 16bits of the entry address */
165         desc->d[0] = addr & 0xffff;
166         /* second 16bit part is the segment selector for the entry code */
167         desc->d[1] = sel;
168         /* third 16bit part has the privilege level, type, and present bit */
169         desc->d[2] = ((dpl & 3) << 13) | type | GATE_DEFAULT | GATE_PRESENT;
170         /* last 16bit part is the high 16bits of the entry address */
171         desc->d[3] = (addr & 0xffff0000) >> 16;
172 }
173
174 #define IS_TRAP(n)      ((n) >= 32 && !IS_IRQ(n))
175 void set_intr_entry(int num, void (*handler)(void))
176 {
177         int type = IS_TRAP(num) ? GATE_TRAP : GATE_INTR;
178
179         /* the syscall interrupt has to have a dpl of 3 otherwise calling it from
180          * user space will raise a general protection exception. All the rest should
181          * have a dpl of 0 to disallow user programs to execute critical interrupt
182          * handlers and possibly crashing the system.
183          */
184         int dpl = (num == SYSCALL_INT) ? 3 : 0;
185
186         gate_desc(idt + num, selector(SEGM_KCODE, 0), (uint32_t)handler, dpl, type);
187 }
188
189 void end_of_irq(int irq)
190 {
191         int intr_state = get_intr_flag();
192         disable_intr();
193
194         if(!eoi_pending) {
195                 return;
196         }
197         eoi_pending = 0;
198
199         if(irq > 7) {
200                 outb(OCW2_EOI, PIC2_CMD);
201         }
202         outb(OCW2_EOI, PIC1_CMD);
203
204         set_intr_flag(intr_state);
205 }