use new timer API
[qemu] / hw / i8259.c
1 /*
2  * QEMU 8259 interrupt controller emulation
3  * 
4  * Copyright (c) 2003-2004 Fabrice Bellard
5  * 
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  */
24 #include <stdlib.h>
25 #include <stdio.h>
26 #include <stdarg.h>
27 #include <string.h>
28 #include <getopt.h>
29 #include <inttypes.h>
30 #include <unistd.h>
31 #include <sys/mman.h>
32 #include <fcntl.h>
33 #include <signal.h>
34 #include <time.h>
35 #include <sys/time.h>
36 #include <malloc.h>
37 #include <termios.h>
38 #include <sys/poll.h>
39 #include <errno.h>
40 #include <sys/wait.h>
41 #include <netinet/in.h>
42
43 #include "cpu.h"
44 #include "vl.h"
45
46 /* debug PIC */
47 //#define DEBUG_PIC
48
49 //#define DEBUG_IRQ_LATENCY
50
51 typedef struct PicState {
52     uint8_t last_irr; /* edge detection */
53     uint8_t irr; /* interrupt request register */
54     uint8_t imr; /* interrupt mask register */
55     uint8_t isr; /* interrupt service register */
56     uint8_t priority_add; /* highest irq priority */
57     uint8_t irq_base;
58     uint8_t read_reg_select;
59     uint8_t poll;
60     uint8_t special_mask;
61     uint8_t init_state;
62     uint8_t auto_eoi;
63     uint8_t rotate_on_auto_eoi;
64     uint8_t special_fully_nested_mode;
65     uint8_t init4; /* true if 4 byte init */
66 } PicState;
67
68 /* 0 is master pic, 1 is slave pic */
69 PicState pics[2];
70 int pic_irq_requested;
71
72 /* set irq level. If an edge is detected, then the IRR is set to 1 */
73 static inline void pic_set_irq1(PicState *s, int irq, int level)
74 {
75     int mask;
76     mask = 1 << irq;
77     if (level) {
78         if ((s->last_irr & mask) == 0)
79             s->irr |= mask;
80         s->last_irr |= mask;
81     } else {
82         s->last_irr &= ~mask;
83     }
84 }
85
86 /* return the highest priority found in mask (highest = smallest
87    number). Return 8 if no irq */
88 static inline int get_priority(PicState *s, int mask)
89 {
90     int priority;
91     if (mask == 0)
92         return 8;
93     priority = 0;
94     while ((mask & (1 << ((priority + s->priority_add) & 7))) == 0)
95         priority++;
96     return priority;
97 }
98
99 /* return the pic wanted interrupt. return -1 if none */
100 static int pic_get_irq(PicState *s)
101 {
102     int mask, cur_priority, priority;
103
104     mask = s->irr & ~s->imr;
105     priority = get_priority(s, mask);
106     if (priority == 8)
107         return -1;
108     /* compute current priority. If special fully nested mode on the
109        master, the IRQ coming from the slave is not taken into account
110        for the priority computation. */
111     mask = s->isr;
112     if (s->special_fully_nested_mode && s == &pics[0])
113         mask &= ~(1 << 2);
114     cur_priority = get_priority(s, mask);
115     if (priority < cur_priority) {
116         /* higher priority found: an irq should be generated */
117         return (priority + s->priority_add) & 7;
118     } else {
119         return -1;
120     }
121 }
122
123 /* raise irq to CPU if necessary. must be called every time the active
124    irq may change */
125 static void pic_update_irq(void)
126 {
127     int irq2, irq;
128
129     /* first look at slave pic */
130     irq2 = pic_get_irq(&pics[1]);
131     if (irq2 >= 0) {
132         /* if irq request by slave pic, signal master PIC */
133         pic_set_irq1(&pics[0], 2, 1);
134         pic_set_irq1(&pics[0], 2, 0);
135     }
136     /* look at requested irq */
137     irq = pic_get_irq(&pics[0]);
138     if (irq >= 0) {
139         if (irq == 2) {
140             /* from slave pic */
141             pic_irq_requested = 8 + irq2;
142         } else {
143             /* from master pic */
144             pic_irq_requested = irq;
145         }
146 #if defined(DEBUG_PIC)
147         {
148             int i;
149             for(i = 0; i < 2; i++) {
150                 printf("pic%d: imr=%x irr=%x padd=%d\n", 
151                        i, pics[i].imr, pics[i].irr, pics[i].priority_add);
152                 
153             }
154         }
155         printf("pic: cpu_interrupt req=%d\n", pic_irq_requested);
156 #endif
157         cpu_interrupt(cpu_single_env, CPU_INTERRUPT_HARD);
158     }
159 }
160
161 #ifdef DEBUG_IRQ_LATENCY
162 int64_t irq_time[16];
163 #endif
164 #if defined(DEBUG_PIC)
165 int irq_level[16];
166 #endif
167
168 void pic_set_irq(int irq, int level)
169 {
170 #if defined(DEBUG_PIC)
171     if (level != irq_level[irq]) {
172         printf("pic_set_irq: irq=%d level=%d\n", irq, level);
173         irq_level[irq] = level;
174     }
175 #endif
176 #ifdef DEBUG_IRQ_LATENCY
177     if (level) {
178         irq_time[irq] = cpu_get_ticks();
179     }
180 #endif
181     pic_set_irq1(&pics[irq >> 3], irq & 7, level);
182     pic_update_irq();
183 }
184
185 /* acknowledge interrupt 'irq' */
186 static inline void pic_intack(PicState *s, int irq)
187 {
188     if (s->auto_eoi) {
189         if (s->rotate_on_auto_eoi)
190             s->priority_add = (irq + 1) & 7;
191     } else {
192         s->isr |= (1 << irq);
193     }
194     s->irr &= ~(1 << irq);
195 }
196
197 int cpu_x86_get_pic_interrupt(CPUState *env)
198 {
199     int irq, irq2, intno;
200
201     /* signal the pic that the irq was acked by the CPU */
202     irq = pic_irq_requested;
203 #ifdef DEBUG_IRQ_LATENCY
204     printf("IRQ%d latency=%0.3fus\n", 
205            irq, 
206            (double)(cpu_get_ticks() - irq_time[irq]) * 1000000.0 / ticks_per_sec);
207 #endif
208 #if defined(DEBUG_PIC)
209     printf("pic_interrupt: irq=%d\n", irq);
210 #endif
211
212     if (irq >= 8) {
213         irq2 = irq & 7;
214         pic_intack(&pics[1], irq2);
215         irq = 2;
216         intno = pics[1].irq_base + irq2;
217     } else {
218         intno = pics[0].irq_base + irq;
219     }
220     pic_intack(&pics[0], irq);
221     return intno;
222 }
223
224 static void pic_ioport_write(void *opaque, uint32_t addr, uint32_t val)
225 {
226     PicState *s = opaque;
227     int priority, cmd, irq;
228
229 #ifdef DEBUG_PIC
230     printf("pic_write: addr=0x%02x val=0x%02x\n", addr, val);
231 #endif
232     addr &= 1;
233     if (addr == 0) {
234         if (val & 0x10) {
235             /* init */
236             memset(s, 0, sizeof(PicState));
237             s->init_state = 1;
238             s->init4 = val & 1;
239             if (val & 0x02)
240                 hw_error("single mode not supported");
241             if (val & 0x08)
242                 hw_error("level sensitive irq not supported");
243         } else if (val & 0x08) {
244             if (val & 0x04)
245                 s->poll = 1;
246             if (val & 0x02)
247                 s->read_reg_select = val & 1;
248             if (val & 0x40)
249                 s->special_mask = (val >> 5) & 1;
250         } else {
251             cmd = val >> 5;
252             switch(cmd) {
253             case 0:
254             case 4:
255                 s->rotate_on_auto_eoi = cmd >> 2;
256                 break;
257             case 1: /* end of interrupt */
258             case 5:
259                 priority = get_priority(s, s->isr);
260                 if (priority != 8) {
261                     irq = (priority + s->priority_add) & 7;
262                     s->isr &= ~(1 << irq);
263                     if (cmd == 5)
264                         s->priority_add = (irq + 1) & 7;
265                     pic_update_irq();
266                 }
267                 break;
268             case 3:
269                 irq = val & 7;
270                 s->isr &= ~(1 << irq);
271                 pic_update_irq();
272                 break;
273             case 6:
274                 s->priority_add = (val + 1) & 7;
275                 pic_update_irq();
276                 break;
277             case 7:
278                 irq = val & 7;
279                 s->isr &= ~(1 << irq);
280                 s->priority_add = (irq + 1) & 7;
281                 pic_update_irq();
282                 break;
283             default:
284                 /* no operation */
285                 break;
286             }
287         }
288     } else {
289         switch(s->init_state) {
290         case 0:
291             /* normal mode */
292             s->imr = val;
293             pic_update_irq();
294             break;
295         case 1:
296             s->irq_base = val & 0xf8;
297             s->init_state = 2;
298             break;
299         case 2:
300             if (s->init4) {
301                 s->init_state = 3;
302             } else {
303                 s->init_state = 0;
304             }
305             break;
306         case 3:
307             s->special_fully_nested_mode = (val >> 4) & 1;
308             s->auto_eoi = (val >> 1) & 1;
309             s->init_state = 0;
310             break;
311         }
312     }
313 }
314
315 static uint32_t pic_poll_read (PicState *s, uint32_t addr1)
316 {
317     int ret;
318
319     ret = pic_get_irq(s);
320     if (ret >= 0) {
321         if (addr1 >> 7) {
322             pics[0].isr &= ~(1 << 2);
323             pics[0].irr &= ~(1 << 2);
324         }
325         s->irr &= ~(1 << ret);
326         s->isr &= ~(1 << ret);
327         if (addr1 >> 7 || ret != 2)
328             pic_update_irq();
329     } else {
330         ret = 0x07;
331         pic_update_irq();
332     }
333
334     return ret;
335 }
336
337 static uint32_t pic_ioport_read(void *opaque, uint32_t addr1)
338 {
339     PicState *s = opaque;
340     unsigned int addr;
341     int ret;
342
343     addr = addr1;
344     addr &= 1;
345     if (s->poll) {
346         ret = pic_poll_read(s, addr1);
347         s->poll = 0;
348     } else {
349         if (addr == 0) {
350             if (s->read_reg_select)
351                 ret = s->isr;
352             else
353                 ret = s->irr;
354         } else {
355             ret = s->imr;
356         }
357     }
358 #ifdef DEBUG_PIC
359     printf("pic_read: addr=0x%02x val=0x%02x\n", addr1, ret);
360 #endif
361     return ret;
362 }
363
364 /* memory mapped interrupt status */
365 uint32_t pic_intack_read(CPUState *env)
366 {
367     int ret;
368
369     ret = pic_poll_read(&pics[0], 0x00);
370     if (ret == 2)
371         ret = pic_poll_read(&pics[1], 0x80) + 8;
372     /* Prepare for ISR read */
373     pics[0].read_reg_select = 1;
374     
375     return ret;
376 }
377
378 static void pic_save(QEMUFile *f, void *opaque)
379 {
380     PicState *s = opaque;
381     
382     qemu_put_8s(f, &s->last_irr);
383     qemu_put_8s(f, &s->irr);
384     qemu_put_8s(f, &s->imr);
385     qemu_put_8s(f, &s->isr);
386     qemu_put_8s(f, &s->priority_add);
387     qemu_put_8s(f, &s->irq_base);
388     qemu_put_8s(f, &s->read_reg_select);
389     qemu_put_8s(f, &s->poll);
390     qemu_put_8s(f, &s->special_mask);
391     qemu_put_8s(f, &s->init_state);
392     qemu_put_8s(f, &s->auto_eoi);
393     qemu_put_8s(f, &s->rotate_on_auto_eoi);
394     qemu_put_8s(f, &s->special_fully_nested_mode);
395     qemu_put_8s(f, &s->init4);
396 }
397
398 static int pic_load(QEMUFile *f, void *opaque, int version_id)
399 {
400     PicState *s = opaque;
401     
402     if (version_id != 1)
403         return -EINVAL;
404
405     qemu_get_8s(f, &s->last_irr);
406     qemu_get_8s(f, &s->irr);
407     qemu_get_8s(f, &s->imr);
408     qemu_get_8s(f, &s->isr);
409     qemu_get_8s(f, &s->priority_add);
410     qemu_get_8s(f, &s->irq_base);
411     qemu_get_8s(f, &s->read_reg_select);
412     qemu_get_8s(f, &s->poll);
413     qemu_get_8s(f, &s->special_mask);
414     qemu_get_8s(f, &s->init_state);
415     qemu_get_8s(f, &s->auto_eoi);
416     qemu_get_8s(f, &s->rotate_on_auto_eoi);
417     qemu_get_8s(f, &s->special_fully_nested_mode);
418     qemu_get_8s(f, &s->init4);
419     return 0;
420 }
421
422 /* XXX: add generic master/slave system */
423 static void pic_init1(int io_addr, PicState *s)
424 {
425     register_ioport_write(io_addr, 2, 1, pic_ioport_write, s);
426     register_ioport_read(io_addr, 2, 1, pic_ioport_read, s);
427
428     register_savevm("i8259", io_addr, 1, pic_save, pic_load, s);
429 }
430
431 void pic_init(void)
432 {
433     pic_init1(0x20, &pics[0]);
434     pic_init1(0xa0, &pics[1]);
435 }
436