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 "hw.h"
  25 #include "pc.h"
  26 #include "isa.h"
  27 #include "monitor.h"
  28 #include "qemu-timer.h"
  29
  30 /* debug PIC */
  31 //#define DEBUG_PIC
  32
  33 #ifdef DEBUG_PIC
  34 #define DPRINTF(fmt, ...)                                       \
  35     do { printf("pic: " fmt , ## __VA_ARGS__); } while (0)
  36 #else
  37 #define DPRINTF(fmt, ...)
  38 #endif
  39
  40 //#define DEBUG_IRQ_LATENCY
  41 //#define DEBUG_IRQ_COUNT
  42
  43 typedef struct PicState {
  44     uint8_t last_irr; /* edge detection */
  45     uint8_t irr; /* interrupt request register */
  46     uint8_t imr; /* interrupt mask register */
  47     uint8_t isr; /* interrupt service register */
  48     uint8_t priority_add; /* highest irq priority */
  49     uint8_t irq_base;
  50     uint8_t read_reg_select;
  51     uint8_t poll;
  52     uint8_t special_mask;
  53     uint8_t init_state;
  54     uint8_t auto_eoi;
  55     uint8_t rotate_on_auto_eoi;
  56     uint8_t special_fully_nested_mode;
  57     uint8_t init4; /* true if 4 byte init */
  58     uint8_t single_mode; /* true if slave pic is not initialized */
  59     uint8_t elcr; /* PIIX edge/trigger selection*/
  60     uint8_t elcr_mask;
  61     qemu_irq int_out;
  62     PicState2 *pics_state;
  63     MemoryRegion base_io;
  64     MemoryRegion elcr_io;
  65 } PicState;
  66
  67 struct PicState2 {
  68     /* 0 is master pic, 1 is slave pic */
  69     /* XXX: better separation between the two pics */
  70     PicState pics[2];
  71     void *irq_request_opaque;
  72 };
  73
  74 #if defined(DEBUG_PIC) || defined (DEBUG_IRQ_COUNT)
  75 static int irq_level[16];
  76 #endif
  77 #ifdef DEBUG_IRQ_COUNT
  78 static uint64_t irq_count[16];
  79 #endif
  80 PicState2 *isa_pic;
  81
  82 /* return the highest priority found in mask (highest = smallest
  83    number). Return 8 if no irq */
  84 static int get_priority(PicState *s, int mask)
  85 {
  86     int priority;
  87     if (mask == 0)
  88         return 8;
  89     priority = 0;
  90     while ((mask & (1 << ((priority + s->priority_add) & 7))) == 0)
  91         priority++;
  92     return priority;
  93 }
  94
  95 /* return the pic wanted interrupt. return -1 if none */
  96 static int pic_get_irq(PicState *s)
  97 {
  98     int mask, cur_priority, priority;
  99
 100     mask = s->irr & ~s->imr;
 101     priority = get_priority(s, mask);
 102     if (priority == 8)
 103         return -1;
 104     /* compute current priority. If special fully nested mode on the
 105        master, the IRQ coming from the slave is not taken into account
 106        for the priority computation. */
 107     mask = s->isr;
 108     if (s->special_mask)
 109         mask &= ~s->imr;
 110     if (s->special_fully_nested_mode && s == &s->pics_state->pics[0])
 111         mask &= ~(1 << 2);
 112     cur_priority = get_priority(s, mask);
 113     if (priority < cur_priority) {
 114         /* higher priority found: an irq should be generated */
 115         return (priority + s->priority_add) & 7;
 116     } else {
 117         return -1;
 118     }
 119 }
 120
 121 static void pic_set_irq1(PicState *s, int irq, int level);
 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(PicState2 *s)
 126 {
 127     int irq2, irq;
 128
 129     /* first look at slave pic */
 130     irq2 = pic_get_irq(&s->pics[1]);
 131     if (irq2 >= 0) {
 132         /* if irq request by slave pic, signal master PIC */
 133         pic_set_irq1(&s->pics[0], 2, 1);
 134         pic_set_irq1(&s->pics[0], 2, 0);
 135     }
 136     /* look at requested irq */
 137     irq = pic_get_irq(&s->pics[0]);
 138     if (irq >= 0) {
 139 #if defined(DEBUG_PIC)
 140         {
 141             int i;
 142             for(i = 0; i < 2; i++) {
 143                 printf("pic%d: imr=%x irr=%x padd=%d\n",
 144                        i, s->pics[i].imr, s->pics[i].irr,
 145                        s->pics[i].priority_add);
 146
 147             }
 148         }
 149         printf("pic: cpu_interrupt\n");
 150 #endif
 151         qemu_irq_raise(s->pics[0].int_out);
 152     } else {
 153         qemu_irq_lower(s->pics[0].int_out);
 154     }
 155 }
 156
 157 /* set irq level. If an edge is detected, then the IRR is set to 1 */
 158 static void pic_set_irq1(PicState *s, int irq, int level)
 159 {
 160     int mask;
 161     mask = 1 << irq;
 162     if (s->elcr & mask) {
 163         /* level triggered */
 164         if (level) {
 165             s->irr |= mask;
 166             s->last_irr |= mask;
 167         } else {
 168             s->irr &= ~mask;
 169             s->last_irr &= ~mask;
 170         }
 171     } else {
 172         /* edge triggered */
 173         if (level) {
 174             if ((s->last_irr & mask) == 0) {
 175                 s->irr |= mask;
 176             }
 177             s->last_irr |= mask;
 178         } else {
 179             s->last_irr &= ~mask;
 180         }
 181     }
 182 }
 183
 184 #ifdef DEBUG_IRQ_LATENCY
 185 int64_t irq_time[16];
 186 #endif
 187
 188 static void i8259_set_irq(void *opaque, int irq, int level)
 189 {
 190     PicState2 *s = opaque;
 191
 192 #if defined(DEBUG_PIC) || defined(DEBUG_IRQ_COUNT)
 193     if (level != irq_level[irq]) {
 194         DPRINTF("i8259_set_irq: irq=%d level=%d\n", irq, level);
 195         irq_level[irq] = level;
 196 #ifdef DEBUG_IRQ_COUNT
 197         if (level == 1)
 198             irq_count[irq]++;
 199 #endif
 200     }
 201 #endif
 202 #ifdef DEBUG_IRQ_LATENCY
 203     if (level) {
 204         irq_time[irq] = qemu_get_clock_ns(vm_clock);
 205     }
 206 #endif
 207     pic_set_irq1(&s->pics[irq >> 3], irq & 7, level);
 208     pic_update_irq(s);
 209 }
 210
 211 /* acknowledge interrupt 'irq' */
 212 static void pic_intack(PicState *s, int irq)
 213 {
 214     if (s->auto_eoi) {
 215         if (s->rotate_on_auto_eoi)
 216             s->priority_add = (irq + 1) & 7;
 217     } else {
 218         s->isr |= (1 << irq);
 219     }
 220     /* We don't clear a level sensitive interrupt here */
 221     if (!(s->elcr & (1 << irq)))
 222         s->irr &= ~(1 << irq);
 223 }
 224
 225 int pic_read_irq(PicState2 *s)
 226 {
 227     int irq, irq2, intno;
 228
 229     irq = pic_get_irq(&s->pics[0]);
 230     if (irq >= 0) {
 231         if (irq == 2) {
 232             irq2 = pic_get_irq(&s->pics[1]);
 233             if (irq2 >= 0) {
 234                 pic_intack(&s->pics[1], irq2);
 235             } else {
 236                 /* spurious IRQ on slave controller */
 237                 irq2 = 7;
 238             }
 239             intno = s->pics[1].irq_base + irq2;
 240         } else {
 241             intno = s->pics[0].irq_base + irq;
 242         }
 243         pic_intack(&s->pics[0], irq);
 244     } else {
 245         /* spurious IRQ on host controller */
 246         irq = 7;
 247         intno = s->pics[0].irq_base + irq;
 248     }
 249     pic_update_irq(s);
 250
 251 #if defined(DEBUG_PIC) || defined(DEBUG_IRQ_LATENCY)
 252     if (irq == 2) {
 253         irq = irq2 + 8;
 254     }
 255 #endif
 256 #ifdef DEBUG_IRQ_LATENCY
 257     printf("IRQ%d latency=%0.3fus\n",
 258            irq,
 259            (double)(qemu_get_clock_ns(vm_clock) -
 260                     irq_time[irq]) * 1000000.0 / get_ticks_per_sec());
 261 #endif
 262     DPRINTF("pic_interrupt: irq=%d\n", irq);
 263     return intno;
 264 }
 265
 266 static void pic_reset(void *opaque)
 267 {
 268     PicState *s = opaque;
 269
 270     s->last_irr = 0;
 271     s->irr = 0;
 272     s->imr = 0;
 273     s->isr = 0;
 274     s->priority_add = 0;
 275     s->irq_base = 0;
 276     s->read_reg_select = 0;
 277     s->poll = 0;
 278     s->special_mask = 0;
 279     s->init_state = 0;
 280     s->auto_eoi = 0;
 281     s->rotate_on_auto_eoi = 0;
 282     s->special_fully_nested_mode = 0;
 283     s->init4 = 0;
 284     s->single_mode = 0;
 285     /* Note: ELCR is not reset */
 286 }
 287
 288 static void pic_ioport_write(void *opaque, target_phys_addr_t addr64,
 289                              uint64_t val64, unsigned size)
 290 {
 291     PicState *s = opaque;
 292     uint32_t addr = addr64;
 293     uint32_t val = val64;
 294     int priority, cmd, irq;
 295
 296     DPRINTF("write: addr=0x%02x val=0x%02x\n", addr, val);
 297     if (addr == 0) {
 298         if (val & 0x10) {
 299             /* init */
 300             pic_reset(s);
 301             /* deassert a pending interrupt */
 302             qemu_irq_lower(s->pics_state->pics[0].int_out);
 303             s->init_state = 1;
 304             s->init4 = val & 1;
 305             s->single_mode = val & 2;
 306             if (val & 0x08)
 307                 hw_error("level sensitive irq not supported");
 308         } else if (val & 0x08) {
 309             if (val & 0x04)
 310                 s->poll = 1;
 311             if (val & 0x02)
 312                 s->read_reg_select = val & 1;
 313             if (val & 0x40)
 314                 s->special_mask = (val >> 5) & 1;
 315         } else {
 316             cmd = val >> 5;
 317             switch(cmd) {
 318             case 0:
 319             case 4:
 320                 s->rotate_on_auto_eoi = cmd >> 2;
 321                 break;
 322             case 1: /* end of interrupt */
 323             case 5:
 324                 priority = get_priority(s, s->isr);
 325                 if (priority != 8) {
 326                     irq = (priority + s->priority_add) & 7;
 327                     s->isr &= ~(1 << irq);
 328                     if (cmd == 5)
 329                         s->priority_add = (irq + 1) & 7;
 330                     pic_update_irq(s->pics_state);
 331                 }
 332                 break;
 333             case 3:
 334                 irq = val & 7;
 335                 s->isr &= ~(1 << irq);
 336                 pic_update_irq(s->pics_state);
 337                 break;
 338             case 6:
 339                 s->priority_add = (val + 1) & 7;
 340                 pic_update_irq(s->pics_state);
 341                 break;
 342             case 7:
 343                 irq = val & 7;
 344                 s->isr &= ~(1 << irq);
 345                 s->priority_add = (irq + 1) & 7;
 346                 pic_update_irq(s->pics_state);
 347                 break;
 348             default:
 349                 /* no operation */
 350                 break;
 351             }
 352         }
 353     } else {
 354         switch(s->init_state) {
 355         case 0:
 356             /* normal mode */
 357             s->imr = val;
 358             pic_update_irq(s->pics_state);
 359             break;
 360         case 1:
 361             s->irq_base = val & 0xf8;
 362             s->init_state = s->single_mode ? (s->init4 ? 3 : 0) : 2;
 363             break;
 364         case 2:
 365             if (s->init4) {
 366                 s->init_state = 3;
 367             } else {
 368                 s->init_state = 0;
 369             }
 370             break;
 371         case 3:
 372             s->special_fully_nested_mode = (val >> 4) & 1;
 373             s->auto_eoi = (val >> 1) & 1;
 374             s->init_state = 0;
 375             break;
 376         }
 377     }
 378 }
 379
 380 static uint32_t pic_poll_read(PicState *s)
 381 {
 382     int ret;
 383
 384     ret = pic_get_irq(s);
 385     if (ret >= 0) {
 386         bool slave = (s == &isa_pic->pics[1]);
 387
 388         if (slave) {
 389             s->pics_state->pics[0].isr &= ~(1 << 2);
 390             s->pics_state->pics[0].irr &= ~(1 << 2);
 391         }
 392         s->irr &= ~(1 << ret);
 393         s->isr &= ~(1 << ret);
 394         if (slave || ret != 2)
 395             pic_update_irq(s->pics_state);
 396     } else {
 397         ret = 0x07;
 398     }
 399
 400     return ret;
 401 }
 402
 403 static uint64_t pic_ioport_read(void *opaque, target_phys_addr_t addr1,
 404                                 unsigned size)
 405 {
 406     PicState *s = opaque;
 407     unsigned int addr = addr1;
 408     int ret;
 409
 410     if (s->poll) {
 411         ret = pic_poll_read(s);
 412         s->poll = 0;
 413     } else {
 414         if (addr == 0) {
 415             if (s->read_reg_select)
 416                 ret = s->isr;
 417             else
 418                 ret = s->irr;
 419         } else {
 420             ret = s->imr;
 421         }
 422     }
 423     DPRINTF("read: addr=0x%02x val=0x%02x\n", addr, ret);
 424     return ret;
 425 }
 426
 427 /* memory mapped interrupt status */
 428 /* XXX: may be the same than pic_read_irq() */
 429 uint32_t pic_intack_read(PicState2 *s)
 430 {
 431     int ret;
 432
 433     ret = pic_poll_read(&s->pics[0]);
 434     if (ret == 2)
 435         ret = pic_poll_read(&s->pics[1]) + 8;
 436     /* Prepare for ISR read */
 437     s->pics[0].read_reg_select = 1;
 438
 439     return ret;
 440 }
 441
 442 int pic_get_output(PicState2 *s)
 443 {
 444     return (pic_get_irq(&s->pics[0]) >= 0);
 445 }
 446
 447 static void elcr_ioport_write(void *opaque, target_phys_addr_t addr,
 448                               uint64_t val, unsigned size)
 449 {
 450     PicState *s = opaque;
 451     s->elcr = val & s->elcr_mask;
 452 }
 453
 454 static uint64_t elcr_ioport_read(void *opaque, target_phys_addr_t addr,
 455                                  unsigned size)
 456 {
 457     PicState *s = opaque;
 458     return s->elcr;
 459 }
 460
 461 static const VMStateDescription vmstate_pic = {
 462     .name = "i8259",
 463     .version_id = 1,
 464     .minimum_version_id = 1,
 465     .minimum_version_id_old = 1,
 466     .fields      = (VMStateField []) {
 467         VMSTATE_UINT8(last_irr, PicState),
 468         VMSTATE_UINT8(irr, PicState),
 469         VMSTATE_UINT8(imr, PicState),
 470         VMSTATE_UINT8(isr, PicState),
 471         VMSTATE_UINT8(priority_add, PicState),
 472         VMSTATE_UINT8(irq_base, PicState),
 473         VMSTATE_UINT8(read_reg_select, PicState),
 474         VMSTATE_UINT8(poll, PicState),
 475         VMSTATE_UINT8(special_mask, PicState),
 476         VMSTATE_UINT8(init_state, PicState),
 477         VMSTATE_UINT8(auto_eoi, PicState),
 478         VMSTATE_UINT8(rotate_on_auto_eoi, PicState),
 479         VMSTATE_UINT8(special_fully_nested_mode, PicState),
 480         VMSTATE_UINT8(init4, PicState),
 481         VMSTATE_UINT8(single_mode, PicState),
 482         VMSTATE_UINT8(elcr, PicState),
 483         VMSTATE_END_OF_LIST()
 484     }
 485 };
 486
 487 static const MemoryRegionOps pic_base_ioport_ops = {
 488     .read = pic_ioport_read,
 489     .write = pic_ioport_write,
 490     .impl = {
 491         .min_access_size = 1,
 492         .max_access_size = 1,
 493     },
 494 };
 495
 496 static const MemoryRegionOps pic_elcr_ioport_ops = {
 497     .read = elcr_ioport_read,
 498     .write = elcr_ioport_write,
 499     .impl = {
 500         .min_access_size = 1,
 501         .max_access_size = 1,
 502     },
 503 };
 504
 505 /* XXX: add generic master/slave system */
 506 static void pic_init(int io_addr, int elcr_addr, PicState *s, qemu_irq int_out)
 507 {
 508     s->int_out = int_out;
 509
 510     memory_region_init_io(&s->base_io, &pic_base_ioport_ops, s, "pic", 2);
 511     memory_region_init_io(&s->elcr_io, &pic_elcr_ioport_ops, s, "elcr", 1);
 512
 513     isa_register_ioport(NULL, &s->base_io, io_addr);
 514     if (elcr_addr >= 0) {
 515         isa_register_ioport(NULL, &s->elcr_io, elcr_addr);
 516     }
 517
 518     vmstate_register(NULL, io_addr, &vmstate_pic, s);
 519     qemu_register_reset(pic_reset, s);
 520 }
 521
 522 void pic_info(Monitor *mon)
 523 {
 524     int i;
 525     PicState *s;
 526
 527     if (!isa_pic)
 528         return;
 529
 530     for(i=0;i<2;i++) {
 531         s = &isa_pic->pics[i];
 532         monitor_printf(mon, "pic%d: irr=%02x imr=%02x isr=%02x hprio=%d "
 533                        "irq_base=%02x rr_sel=%d elcr=%02x fnm=%d\n",
 534                        i, s->irr, s->imr, s->isr, s->priority_add,
 535                        s->irq_base, s->read_reg_select, s->elcr,
 536                        s->special_fully_nested_mode);
 537     }
 538 }
 539
 540 void irq_info(Monitor *mon)
 541 {
 542 #ifndef DEBUG_IRQ_COUNT
 543     monitor_printf(mon, "irq statistic code not compiled.\n");
 544 #else
 545     int i;
 546     int64_t count;
 547
 548     monitor_printf(mon, "IRQ statistics:\n");
 549     for (i = 0; i < 16; i++) {
 550         count = irq_count[i];
 551         if (count > 0)
 552             monitor_printf(mon, "%2d: %" PRId64 "\n", i, count);
 553     }
 554 #endif
 555 }
 556
 557 qemu_irq *i8259_init(qemu_irq parent_irq)
 558 {
 559     qemu_irq *irqs;
 560     PicState2 *s;
 561
 562     s = g_malloc0(sizeof(PicState2));
 563     irqs = qemu_allocate_irqs(i8259_set_irq, s, 16);
 564     pic_init(0x20, 0x4d0, &s->pics[0], parent_irq);
 565     pic_init(0xa0, 0x4d1, &s->pics[1], irqs[2]);
 566     s->pics[0].elcr_mask = 0xf8;
 567     s->pics[1].elcr_mask = 0xde;
 568     s->pics[0].pics_state = s;
 569     s->pics[1].pics_state = s;
 570     isa_pic = s;
 571     return irqs;
 572 }