summaryrefslogtreecommitdiff
path: root/arch/x86/machine/pic.c
blob: 3c7e76234fcfe41f3665d801c27918021e5b906d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
/*
 * Copyright (c) 2012-2017 Richard Braun.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <assert.h>
#include <errno.h>
#include <stdbool.h>
#include <stdint.h>

#include <kern/error.h>
#include <kern/init.h>
#include <kern/intr.h>
#include <kern/panic.h>
#include <machine/cpu.h>
#include <machine/io.h>
#include <machine/lapic.h>
#include <machine/pic.h>
#include <machine/trap.h>

/*
 * I/O ports.
 */
#define PIC_MASTER_CMD      0x20
#define PIC_MASTER_IMR      0x21
#define PIC_SLAVE_CMD       0xa0
#define PIC_SLAVE_IMR       0xa1

/*
 * Register bits.
 */
#define PIC_ICW1_IC4        0x01
#define PIC_ICW1_INIT       0x10
#define PIC_ICW4_8086       0x01
#define PIC_OCW3_ISR        0x0b
#define PIC_EOI             0x20

/*
 * Special interrupts.
 */
#define PIC_SLAVE_INTR      2
#define PIC_SPURIOUS_INTR   7

static unsigned int pic_nr_slave_intrs;

static uint8_t pic_master_mask;
static uint8_t pic_slave_mask;

static uint8_t pic_master_spurious_intr;
static uint8_t pic_slave_spurious_intr;

static bool
pic_is_slave_intr(unsigned int intr)
{
    assert(intr <= PIC_MAX_INTR);
    return (intr >= PIC_NR_INTRS);
}

static void
pic_inc_slave_intrs(void)
{
    if (pic_nr_slave_intrs == 0) {
        pic_master_mask |= 1 << PIC_SLAVE_INTR;
        io_write_byte(PIC_MASTER_IMR, pic_master_mask);
    }

    pic_nr_slave_intrs++;
    assert(pic_nr_slave_intrs != 0);
}

static void
pic_dec_slave_intrs(void)
{
    assert(pic_nr_slave_intrs != 0);

    pic_nr_slave_intrs--;

    if (pic_nr_slave_intrs == 0) {
        pic_master_mask &= ~(1 << PIC_SLAVE_INTR);
        io_write_byte(PIC_MASTER_IMR, pic_master_mask);
    }
}

static void
pic_eoi(unsigned long intr)
{
    if (intr >= PIC_NR_INTRS) {
        io_write_byte(PIC_SLAVE_CMD, PIC_EOI);
    }

    io_write_byte(PIC_MASTER_CMD, PIC_EOI);
}

static uint8_t
pic_read_isr(uint16_t port)
{
    io_write_byte(port, PIC_OCW3_ISR);
    return io_read_byte(port);
}

static void
pic_ops_enable(void *priv, unsigned int intr, unsigned int cpu)
{
    (void)priv;
    (void)cpu;

    if (pic_is_slave_intr(intr)) {
        pic_slave_mask &= ~(1 << (intr - PIC_NR_INTRS));
        io_write_byte(PIC_SLAVE_IMR, pic_slave_mask);
        pic_inc_slave_intrs();
    } else {
        pic_master_mask &= ~(1 << intr);
        io_write_byte(PIC_MASTER_IMR, pic_master_mask);
    }
}

static void
pic_ops_disable(void *priv, unsigned int intr)
{
    (void)priv;

    if (pic_is_slave_intr(intr)) {
        pic_dec_slave_intrs();
        pic_slave_mask |= 1 << (intr - PIC_NR_INTRS);
        io_write_byte(PIC_SLAVE_IMR, pic_slave_mask);
    } else {
        pic_master_mask |= 1 << intr;
        io_write_byte(PIC_MASTER_IMR, pic_master_mask);
    }
}

static void
pic_ops_eoi(void *priv, unsigned int intr)
{
    (void)priv;
    pic_eoi(intr);
}

static const struct intr_ops pic_ops = {
    .enable = pic_ops_enable,
    .disable = pic_ops_disable,
    .eoi = pic_ops_eoi,
};

static void
pic_intr(struct trap_frame *frame)
{
    intr_handle(frame->vector - TRAP_INTR_FIRST);
}

static void __init
pic_register(void)
{
    unsigned int intr;

    intr_register_ctl(&pic_ops, NULL, 0, PIC_MAX_INTR);

    for (intr = 0; intr <= PIC_MAX_INTR; intr++) {
        trap_register(TRAP_INTR_FIRST + intr, pic_intr);
    }
}

static int
pic_spurious_intr(void *arg)
{
    uint8_t intr, isr;

    intr = *(const uint8_t *)arg;

    if (arg == &pic_master_spurious_intr) {
        isr = pic_read_isr(PIC_MASTER_CMD);

        if (isr & (1 << PIC_SPURIOUS_INTR)) {
            panic("pic: real interrupt %hhu", intr);
        }
    } else {
        isr = pic_read_isr(PIC_SLAVE_CMD);

        if (isr & (1 << PIC_SPURIOUS_INTR)) {
            panic("pic: real interrupt %hhu", intr);
        }

        pic_eoi(PIC_SLAVE_INTR);
    }

    return 0;
}

static void __init
pic_setup_common(bool register_ctl)
{
    int error;

    pic_nr_slave_intrs = 0;
    pic_master_mask = 0xff;
    pic_slave_mask = 0xff;

    /* ICW 1 - State that ICW 4 will be sent */
    io_write_byte(PIC_MASTER_CMD, PIC_ICW1_INIT | PIC_ICW1_IC4);
    io_write_byte(PIC_SLAVE_CMD, PIC_ICW1_INIT | PIC_ICW1_IC4);

    /* ICW 2 */
    io_write_byte(PIC_MASTER_IMR, TRAP_INTR_FIRST);
    io_write_byte(PIC_SLAVE_IMR, TRAP_INTR_FIRST + PIC_NR_INTRS);

    /* ICW 3 - Set up cascading */
    io_write_byte(PIC_MASTER_IMR, 1 << PIC_SLAVE_INTR);
    io_write_byte(PIC_SLAVE_IMR, PIC_SLAVE_INTR);

    /* ICW 4 - Set 8086 mode */
    io_write_byte(PIC_MASTER_IMR, PIC_ICW4_8086);
    io_write_byte(PIC_SLAVE_IMR, PIC_ICW4_8086);

    /* OCW 1 - Mask all interrupts */
    io_write_byte(PIC_MASTER_IMR, pic_master_mask);
    io_write_byte(PIC_SLAVE_IMR, pic_slave_mask);

    if (register_ctl) {
        pic_register();
    }

    pic_master_spurious_intr = PIC_SPURIOUS_INTR;
    error = intr_register(pic_master_spurious_intr, pic_spurious_intr,
                          &pic_master_spurious_intr);
    error_check(error, __func__);

    pic_slave_spurious_intr = PIC_NR_INTRS + PIC_SPURIOUS_INTR;
    error = intr_register(pic_slave_spurious_intr, pic_spurious_intr,
                          &pic_slave_spurious_intr);
    error_check(error, __func__);
}

void __init
pic_setup(void)
{
    pic_setup_common(true);
}

void __init
pic_setup_disabled(void)
{
    pic_setup_common(false);
}