sortof works
[com32] / 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 "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 void init_pic(void);
59 static void gate_desc(desc_t *desc, uint16_t sel, uint32_t addr, int dpl, int type);
60
61 /* defined in intr_asm.S */
62 void set_idt(uint32_t addr, uint16_t limit);
63 void intr_entry_default(void);
64 void irq7_entry_check_spurious(void);
65 void irq15_entry_check_spurious(void);
66
67 /* the IDT (interrupt descriptor table) */
68 static desc_t idt[256] __attribute__((aligned(8)));
69
70 /* table of handler functions for all interrupts */
71 static intr_func_t intr_func[256];
72
73 static struct intr_frame *cur_intr_frame;
74 static int eoi_pending;
75
76 #define INTR_ENTRY_EC(n, name)          \
77         void intr_entry_##name(void);   \
78         set_intr_entry(n, intr_entry_##name);
79 #define INTR_ENTRY_NOEC(n, name)        INTR_ENTRY_EC(n, name)
80
81 void init_intr(void)
82 {
83         int i;
84
85         set_idt((uint32_t)idt, sizeof idt - 1);
86
87         /* initialize all entry points and interrupt handlers */
88         for(i=0; i<256; i++) {
89                 set_intr_entry(i, intr_entry_default);
90                 interrupt(i, 0);
91         }
92
93         /* by including intrtab.h here the series of INTR_ENTRY_* macros will be
94          * expanded to a series of function prototypes for all interrupt entry
95          * points and the corresponding calls to set_intr_entry to set up the IDT
96          * slots
97          */
98 #include "intrtab.h"
99
100         /* change irq7 and irq15 to special entry points which first
101          * make sure we didn't get a spurious interrupt before proceeding
102          */
103         set_intr_entry(IRQ_TO_INTR(7), irq7_entry_check_spurious);
104         set_intr_entry(IRQ_TO_INTR(15), irq15_entry_check_spurious);
105
106         /* initialize the programmable interrupt controller
107          * setting up the maping of IRQs [0, 15] to interrupts [32, 47]
108          */
109         init_pic();
110         eoi_pending = 0;
111 }
112
113 /* retrieve the current interrupt frame.
114  * returns 0 when called during init.
115  */
116 struct intr_frame *get_intr_frame(void)
117 {
118         return cur_intr_frame;
119 }
120
121 /* set an interrupt handler function for a particular interrupt */
122 void interrupt(int intr_num, intr_func_t func)
123 {
124         int iflag = get_intr_flag();
125         disable_intr();
126         intr_func[intr_num] = func;
127         set_intr_flag(iflag);
128 }
129
130 /* this function is called from all interrupt entry points
131  * it calls the appropriate interrupt handlers if available and handles
132  * sending an end-of-interrupt command to the PICs when finished.
133  */
134 void dispatch_intr(struct intr_frame frm)
135 {
136         cur_intr_frame = &frm;
137
138         if(IS_IRQ(frm.inum)) {
139                 eoi_pending = frm.inum;
140         }
141
142         if(intr_func[frm.inum]) {
143                 intr_func[frm.inum](frm.inum);
144         } else {
145                 if(frm.inum < 32) {
146                         panic("unhandled exception %u, error code: %u, at cs:eip=%x:%x\n",
147                                         frm.inum, frm.err, frm.cs, frm.eip);
148                 }
149                 printf("unhandled interrupt %d\n", frm.inum);
150         }
151
152         disable_intr();
153         if(eoi_pending) {
154                 end_of_irq(INTR_TO_IRQ(eoi_pending));
155         }
156 }
157
158 void init_pic(void)
159 {
160         prog_pic(IRQ_OFFSET);
161 }
162
163 void prog_pic(int offs)
164 {
165         /* send ICW1 saying we'll follow with ICW4 later on */
166         outp(PIC1_CMD, ICW1_INIT | ICW1_ICW4_NEEDED);
167         outp(PIC2_CMD, ICW1_INIT | ICW1_ICW4_NEEDED);
168         /* send ICW2 with IRQ remapping */
169         outp(PIC1_DATA, offs);
170         outp(PIC2_DATA, offs + 8);
171         /* send ICW3 to setup the master/slave relationship */
172         /* ... set bit3 = 3rd interrupt input has a slave */
173         outp(PIC1_DATA, 4);
174         /* ... set slave ID to 2 */
175         outp(PIC2_DATA, 2);
176         /* send ICW4 to set 8086 mode (no calls generated) */
177         outp(PIC1_DATA, ICW4_8086);
178         outp(PIC2_DATA, ICW4_8086);
179         /* done, just reset the data port to 0 */
180         outp(PIC1_DATA, 0);
181         outp(PIC2_DATA, 0);
182 }
183
184 static void gate_desc(desc_t *desc, uint16_t sel, uint32_t addr, int dpl, int type)
185 {
186         /* first 16bit part is the low 16bits of the entry address */
187         desc->d[0] = addr & 0xffff;
188         /* second 16bit part is the segment selector for the entry code */
189         desc->d[1] = sel;
190         /* third 16bit part has the privilege level, type, and present bit */
191         desc->d[2] = ((dpl & 3) << 13) | type | GATE_DEFAULT | GATE_PRESENT;
192         /* last 16bit part is the high 16bits of the entry address */
193         desc->d[3] = (addr & 0xffff0000) >> 16;
194 }
195
196 #define IS_TRAP(n)      ((n) >= 32 && !IS_IRQ(n))
197 void set_intr_entry(int num, void (*handler)(void))
198 {
199         int type = IS_TRAP(num) ? GATE_TRAP : GATE_INTR;
200
201         /* the syscall interrupt has to have a dpl of 3 otherwise calling it from
202          * user space will raise a general protection exception. All the rest should
203          * have a dpl of 0 to disallow user programs to execute critical interrupt
204          * handlers and possibly crashing the system.
205          */
206         int dpl = (num == SYSCALL_INT) ? 3 : 0;
207
208         gate_desc(idt + num, selector(SEGM_KCODE, 0), (uint32_t)handler, dpl, type);
209 }
210
211 void set_pic_mask(int pic, unsigned char mask)
212 {
213         outp(pic > 0 ? PIC2_DATA : PIC1_DATA, mask);
214 }
215
216 unsigned char get_pic_mask(int pic)
217 {
218         return inp(pic > 0 ? PIC2_DATA : PIC1_DATA);
219 }
220
221 void mask_irq(int irq)
222 {
223         int port;
224         unsigned char mask;
225
226         if(irq < 8) {
227                 port = PIC1_DATA;
228         } else {
229                 port = PIC2_DATA;
230                 irq -= 8;
231         }
232
233         mask = inp(port) | (1 << irq);
234         outp(port, mask);
235 }
236
237 void unmask_irq(int irq)
238 {
239         int port;
240         unsigned char mask;
241
242         if(irq < 8) {
243                 port = PIC1_DATA;
244         } else {
245                 port = PIC2_DATA;
246                 irq -= 8;
247         }
248
249         mask = inp(port) & ~(1 << irq);
250         outp(port, mask);
251 }
252
253
254 void end_of_irq(int irq)
255 {
256         int intr_state = get_intr_flag();
257         disable_intr();
258
259         if(!eoi_pending) {
260                 set_intr_flag(intr_state);
261                 return;
262         }
263         eoi_pending = 0;
264
265         if(irq > 7) {
266                 outp(PIC2_CMD, OCW2_EOI);
267         }
268         outp(PIC1_CMD, OCW2_EOI);
269
270         set_intr_flag(intr_state);
271 }
272
273 #ifdef ENABLE_GDB_STUB
274 void exceptionHandler(int id, void (*func)())
275 {
276         set_intr_entry(id, func);
277 }
278 #endif