x86: moves the PIC into its own file
[akaros.git] / kern / arch / x86 / pic.c
1 /* Copyright (c) 2009, 2014 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * PIC: 8259 interrupt controller */
6
7 #include <arch/pic.h>
8 #include <arch/x86.h>
9 #include <atomic.h>
10 #include <assert.h>
11 #include <stdio.h>
12
13 spinlock_t piclock = SPINLOCK_INITIALIZER_IRQSAVE;
14
15 /* * Remaps the Programmable Interrupt Controller to use IRQs 32-47
16  * http://wiki.osdev.org/PIC
17  * Check osdev for a more thorough explanation/implementation.
18  * http://bochs.sourceforge.net/techspec/PORTS.LST  */
19 void pic_remap(void)
20 {
21         spin_lock_irqsave(&piclock);
22         /* start initialization (ICW1) */
23         outb(PIC1_CMD, 0x11);
24         outb(PIC2_CMD, 0x11);
25         /* set new offsets (ICW2) */
26         outb(PIC1_DATA, PIC1_OFFSET);
27         outb(PIC2_DATA, PIC2_OFFSET);
28         /* set up cascading (ICW3) */
29         outb(PIC1_DATA, 0x04);
30         outb(PIC2_DATA, 0x02);
31         /* other stuff (put in 8086/88 mode, or whatever) (ICW4) */
32         outb(PIC1_DATA, 0x01);
33         outb(PIC2_DATA, 0x01);
34         /* Init done, further data R/W access the interrupt mask */
35         /* set masks, defaulting to all masked for now */
36         outb(PIC1_DATA, 0xff);
37         outb(PIC2_DATA, 0xff);
38         spin_unlock_irqsave(&piclock);
39 }
40
41 void pic_mask_irq(int trap_nr)
42 {
43         int irq = trap_nr - PIC1_OFFSET;
44         spin_lock_irqsave(&piclock);
45         if (irq > 7)
46                 outb(PIC2_DATA, inb(PIC2_DATA) | (1 << (irq - 8)));
47         else
48                 outb(PIC1_DATA, inb(PIC1_DATA) | (1 << irq));
49         spin_unlock_irqsave(&piclock);
50 }
51
52 void pic_unmask_irq(int trap_nr)
53 {
54         int irq = trap_nr - PIC1_OFFSET;
55         spin_lock_irqsave(&piclock);
56         if (irq > 7) {
57                 outb(PIC2_DATA, inb(PIC2_DATA) & ~(1 << (irq - 8)));
58                 outb(PIC1_DATA, inb(PIC1_DATA) & 0xfb); // make sure irq2 is unmasked
59         } else
60                 outb(PIC1_DATA, inb(PIC1_DATA) & ~(1 << irq));
61         spin_unlock_irqsave(&piclock);
62 }
63
64 void pic_mask_all(void)
65 {
66         for (int i = 0 + PIC1_OFFSET; i < 16 + PIC1_OFFSET; i++)
67                 pic_mask_irq(i);
68 }
69
70 /* Aka, the IMR.  Simply reading the data port are OCW1s. */
71 uint16_t pic_get_mask(void)
72 {
73         uint16_t ret;
74         spin_lock_irqsave(&piclock);
75         ret = (inb(PIC2_DATA) << 8) | inb(PIC1_DATA);
76         spin_unlock_irqsave(&piclock);
77         return ret;
78 }
79
80 static uint16_t __pic_get_irq_reg(int ocw3)
81 {
82         uint16_t ret;
83         spin_lock_irqsave(&piclock);
84         /* OCW3 to PIC CMD to get the register values.  PIC2 is chained, and
85          * represents IRQs 8-15.  PIC1 is IRQs 0-7, with 2 being the chain */
86         outb(PIC1_CMD, ocw3);
87         outb(PIC2_CMD, ocw3);
88         ret = (inb(PIC2_CMD) << 8) | inb(PIC1_CMD);
89         spin_unlock_irqsave(&piclock);
90         return ret;
91 }
92
93 /* Returns the combined value of the cascaded PICs irq request register */
94 uint16_t pic_get_irr(void)
95 {
96         return __pic_get_irq_reg(PIC_READ_IRR);
97 }
98
99 /* Returns the combined value of the cascaded PICs irq service register */
100 uint16_t pic_get_isr(void)
101 {
102         return __pic_get_irq_reg(PIC_READ_ISR);
103 }
104
105 /* Takes a raw vector/trap number (32-47), not a device IRQ (0-15) */
106 bool pic_check_spurious(int trap_nr)
107 {
108         /* the PIC may send spurious irqs via one of the chips irq 7.  if the isr
109          * doesn't show that irq, then it was spurious, and we don't send an eoi.
110          * Check out http://wiki.osdev.org/8259_PIC#Spurious_IRQs */
111         if ((trap_nr == PIC1_SPURIOUS) && !(pic_get_isr() & (1 << 7))) {
112                 printd("Spurious PIC1 irq!\n"); /* want to know if this happens */
113                 return TRUE;
114         }
115         if ((trap_nr == PIC2_SPURIOUS) && !(pic_get_isr() & (1 << 15))) {
116                 printd("Spurious PIC2 irq!\n"); /* want to know if this happens */
117                 /* for the cascaded PIC, we *do* need to send an EOI to the master's
118                  * cascade irq (2). */
119                 pic_send_eoi(2 + PIC1_OFFSET);
120                 return TRUE;
121         }
122         return FALSE;
123 }
124
125 void pic_send_eoi(int trap_nr)
126 {
127         int irq = trap_nr - PIC1_OFFSET;
128         spin_lock_irqsave(&piclock);
129         // all irqs beyond the first seven need to be chained to the slave
130         if (irq > 7)
131                 outb(PIC2_CMD, PIC_EOI);
132         outb(PIC1_CMD, PIC_EOI);
133         spin_unlock_irqsave(&piclock);
134 }