2 * This file is part of the Palacios Virtual Machine Monitor developed
3 * by the V3VEE Project with funding from the United States National
4 * Science Foundation and the Department of Energy.
6 * The V3VEE Project is a joint project between Northwestern University
7 * and the University of New Mexico. You can find out more at
10 * Copyright (c) 2008, Jack Lange <jarusl@cs.northwestern.edu>
11 * Copyright (c) 2008, The V3VEE Project <http://www.v3vee.org>
12 * All rights reserved.
14 * Author: Jack Lange <jarusl@cs.northwestern.edu>
16 * This is free software. You are permitted to use,
17 * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
21 #include <devices/8259a.h>
22 #include <palacios/vmm_intr.h>
23 #include <palacios/vmm_types.h>
24 #include <palacios/vmm.h>
28 #define PrintDebug(fmt, args...)
32 typedef enum {RESET, ICW1, ICW2, ICW3, ICW4, READY} pic_state_t;
34 static const uint_t MASTER_PORT1 = 0x20;
35 static const uint_t MASTER_PORT2 = 0x21;
36 static const uint_t SLAVE_PORT1 = 0xA0;
37 static const uint_t SLAVE_PORT2 = 0xA1;
39 static const uint_t ELCR1_PORT = 0x4d0;
40 static const uint_t ELCR2_PORT = 0x4d1;
43 #define IS_ICW1(x) (((x & 0x10) >> 4) == 0x1)
44 #define IS_OCW2(x) (((x & 0x18) >> 3) == 0x0)
45 #define IS_OCW3(x) (((x & 0x18) >> 3) == 0x1)
49 uint_t ic4 : 1; // ICW4 has to be read
50 uint_t sngl : 1; // single (only one PIC)
51 uint_t adi : 1; // call address interval
52 uint_t ltim : 1; // level interrupt mode
64 // Each bit that is set indicates that the IR input has a slave
76 // The ID is the Slave device ID
83 uint_t uPM : 1; // 1=x86
84 uint_t AEOI : 1; // Automatic End of Interrupt
85 uint_t M_S : 1; // only if buffered 1=master,0=slave
86 uint_t BUF : 1; // buffered mode
87 uint_t SFNM : 1; // special fully nexted mode
105 uint_t cw_code : 2; // should be 00
115 uint_t cw_code : 2; // should be 01
122 struct pic_internal {
133 uchar_t master_elcr_mask;
134 uchar_t slave_elcr_mask;
155 pic_state_t master_state;
156 pic_state_t slave_state;
160 static void DumpPICState(struct pic_internal *p)
163 PrintDebug("8259 PIC: master_state=0x%x\n",p->master_state);
164 PrintDebug("8259 PIC: master_irr=0x%x\n",p->master_irr);
165 PrintDebug("8259 PIC: master_isr=0x%x\n",p->master_isr);
166 PrintDebug("8259 PIC: master_imr=0x%x\n",p->master_imr);
168 PrintDebug("8259 PIC: master_ocw2=0x%x\n",p->master_ocw2);
169 PrintDebug("8259 PIC: master_ocw3=0x%x\n",p->master_ocw3);
171 PrintDebug("8259 PIC: master_icw1=0x%x\n",p->master_icw1);
172 PrintDebug("8259 PIC: master_icw2=0x%x\n",p->master_icw2);
173 PrintDebug("8259 PIC: master_icw3=0x%x\n",p->master_icw3);
174 PrintDebug("8259 PIC: master_icw4=0x%x\n",p->master_icw4);
176 PrintDebug("8259 PIC: slave_state=0x%x\n",p->slave_state);
177 PrintDebug("8259 PIC: slave_irr=0x%x\n",p->slave_irr);
178 PrintDebug("8259 PIC: slave_isr=0x%x\n",p->slave_isr);
179 PrintDebug("8259 PIC: slave_imr=0x%x\n",p->slave_imr);
181 PrintDebug("8259 PIC: slave_ocw2=0x%x\n",p->slave_ocw2);
182 PrintDebug("8259 PIC: slave_ocw3=0x%x\n",p->slave_ocw3);
184 PrintDebug("8259 PIC: slave_icw1=0x%x\n",p->slave_icw1);
185 PrintDebug("8259 PIC: slave_icw2=0x%x\n",p->slave_icw2);
186 PrintDebug("8259 PIC: slave_icw3=0x%x\n",p->slave_icw3);
187 PrintDebug("8259 PIC: slave_icw4=0x%x\n",p->slave_icw4);
192 static int pic_raise_intr(void * private_data, int irq) {
193 struct pic_internal * state = (struct pic_internal*)private_data;
197 state->master_irr |= 0x04; // PAD
200 PrintDebug("8259 PIC: Raising irq %d in the PIC\n", irq);
203 state->master_irr |= 0x01 << irq;
204 } else if ((irq > 7) && (irq < 16)) {
205 state->slave_irr |= 0x01 << (irq - 8); // PAD if -7 then irq 15=no irq
207 PrintDebug("8259 PIC: Invalid IRQ raised (%d)\n", irq);
215 static int pic_lower_intr(void *private_data, int irq) {
217 struct pic_internal *state = (struct pic_internal*)private_data;
219 PrintDebug("[pic_lower_intr] IRQ line %d now low\n", irq);
222 state->master_irr &= ~(1 << irq);
223 if ((state->master_irr & ~(state->master_imr)) == 0) {
224 PrintDebug("\t\tFIXME: Master maybe should do sth\n");
226 } else if ((irq > 7) && (irq < 16)) {
228 state->slave_irr &= ~(1 << (irq - 8));
229 if ((state->slave_irr & (~(state->slave_imr))) == 0) {
230 PrintDebug("\t\tFIXME: Slave maybe should do sth\n");
238 static int pic_intr_pending(void * private_data) {
239 struct pic_internal * state = (struct pic_internal*)private_data;
241 if ((state->master_irr & ~(state->master_imr)) ||
242 (state->slave_irr & ~(state->slave_imr))) {
249 static int pic_get_intr_number(void * private_data) {
250 struct pic_internal * state = (struct pic_internal *)private_data;
254 PrintDebug("8259 PIC: getnum: master_irr: 0x%x master_imr: 0x%x\n", state->master_irr, state->master_imr);
255 PrintDebug("8259 PIC: getnum: slave_irr: 0x%x slave_imr: 0x%x\n", state->slave_irr, state->slave_imr);
257 for (i = 0; i < 16; i++) {
259 if (((state->master_irr & ~(state->master_imr)) >> i) == 0x01) {
260 //state->master_isr |= (0x1 << i);
262 //state->master_irr &= ~(0x1 << i);
263 PrintDebug("8259 PIC: IRQ: %d, master_icw2: %x\n", i, state->master_icw2);
264 irq = i + state->master_icw2;
268 if (((state->slave_irr & ~(state->slave_imr)) >> (i - 8)) == 0x01) {
269 //state->slave_isr |= (0x1 << (i - 8));
270 //state->slave_irr &= ~(0x1 << (i - 8));
271 PrintDebug("8259 PIC: IRQ: %d, slave_icw2: %x\n", i, state->slave_icw2);
272 irq= (i - 8) + state->slave_icw2;
278 if ((i == 15) || (i == 6)) {
291 /* The IRQ number is the number returned by pic_get_intr_number(), not the pin number */
292 static int pic_begin_irq(void * private_data, int irq) {
293 struct pic_internal * state = (struct pic_internal*)private_data;
295 if ((irq >= state->master_icw2) && (irq <= state->master_icw2 + 7)) {
297 } else if ((irq >= state->slave_icw2) && (irq <= state->slave_icw2 + 7)) {
301 // PrintError("8259 PIC: Could not find IRQ (0x%x) to Begin\n",irq);
306 if (((state->master_irr & ~(state->master_imr)) >> irq) == 0x01) {
307 state->master_isr |= (0x1 << irq);
309 if (!(state->master_elcr & (0x1 << irq))) {
310 state->master_irr &= ~(0x1 << irq);
314 state->slave_isr |= (0x1 << (irq - 8));
316 if (!(state->slave_elcr & (0x1 << irq))) {
317 state->slave_irr &= ~(0x1 << (irq - 8));
326 static int pic_end_irq(void * private_data, int irq) {
333 static struct intr_ctrl_ops intr_ops = {
334 .intr_pending = pic_intr_pending,
335 .get_intr_number = pic_get_intr_number,
336 .raise_intr = pic_raise_intr,
337 .begin_irq = pic_begin_irq,
338 .lower_intr = pic_lower_intr,
345 static int read_master_port1(ushort_t port, void * dst, uint_t length, struct vm_device * dev) {
346 struct pic_internal * state = (struct pic_internal*)dev->private_data;
349 PrintError("8259 PIC: Invalid Read length (rd_Master1)\n");
353 if ((state->master_ocw3 & 0x03) == 0x02) {
354 *(uchar_t *)dst = state->master_irr;
355 } else if ((state->master_ocw3 & 0x03) == 0x03) {
356 *(uchar_t *)dst = state->master_isr;
364 static int read_master_port2(ushort_t port, void * dst, uint_t length, struct vm_device * dev) {
365 struct pic_internal * state = (struct pic_internal*)dev->private_data;
368 PrintError("8259 PIC: Invalid Read length (rd_Master2)\n");
372 *(uchar_t *)dst = state->master_imr;
378 static int read_slave_port1(ushort_t port, void * dst, uint_t length, struct vm_device * dev) {
379 struct pic_internal * state = (struct pic_internal*)dev->private_data;
382 PrintError("8259 PIC: Invalid Read length (rd_Slave1)\n");
386 if ((state->slave_ocw3 & 0x03) == 0x02) {
387 *(uchar_t*)dst = state->slave_irr;
388 } else if ((state->slave_ocw3 & 0x03) == 0x03) {
389 *(uchar_t *)dst = state->slave_isr;
397 static int read_slave_port2(ushort_t port, void * dst, uint_t length, struct vm_device * dev) {
398 struct pic_internal * state = (struct pic_internal*)dev->private_data;
401 PrintError("8259 PIC: Invalid Read length (rd_Slave2)\n");
405 *(uchar_t *)dst = state->slave_imr;
411 static int write_master_port1(ushort_t port, void * src, uint_t length, struct vm_device * dev) {
412 struct pic_internal * state = (struct pic_internal*)dev->private_data;
413 uchar_t cw = *(uchar_t *)src;
415 PrintDebug("8259 PIC: Write master port 1 with 0x%x\n",cw);
418 PrintError("8259 PIC: Invalid Write length (wr_Master1)\n");
424 PrintDebug("8259 PIC: Setting ICW1 = %x (wr_Master1)\n", cw);
426 state->master_icw1 = cw;
427 state->master_state = ICW2;
429 } else if (state->master_state == READY) {
431 // handle the EOI here
432 struct ocw2 * cw2 = (struct ocw2*)&cw;
434 PrintDebug("8259 PIC: Handling OCW2 = %x (wr_Master1)\n", cw);
436 if ((cw2->EOI) && (!cw2->R) && (cw2->SL)) {
438 state->master_isr &= ~(0x01 << cw2->level);
439 } else if ((cw2->EOI) & (!cw2->R) && (!cw2->SL)) {
442 PrintDebug("8259 PIC: Pre ISR = %x (wr_Master1)\n", state->master_isr);
443 for (i = 0; i < 8; i++) {
444 if (state->master_isr & (0x01 << i)) {
445 state->master_isr &= ~(0x01 << i);
449 PrintDebug("8259 PIC: Post ISR = %x (wr_Master1)\n", state->master_isr);
451 PrintError("8259 PIC: Command not handled, or in error (wr_Master1)\n");
455 state->master_ocw2 = cw;
456 } else if (IS_OCW3(cw)) {
457 PrintDebug("8259 PIC: Handling OCW3 = %x (wr_Master1)\n", cw);
458 state->master_ocw3 = cw;
460 PrintError("8259 PIC: Invalid OCW to PIC (wr_Master1)\n");
461 PrintError("8259 PIC: CW=%x\n", cw);
465 PrintError("8259 PIC: Invalid PIC State (wr_Master1)\n");
466 PrintError("8259 PIC: CW=%x\n", cw);
473 static int write_master_port2(ushort_t port, void * src, uint_t length, struct vm_device * dev) {
474 struct pic_internal * state = (struct pic_internal*)dev->private_data;
475 uchar_t cw = *(uchar_t *)src;
477 PrintDebug("8259 PIC: Write master port 2 with 0x%x\n",cw);
480 PrintError("8259 PIC: Invalid Write length (wr_Master2)\n");
484 if (state->master_state == ICW2) {
485 struct icw1 * cw1 = (struct icw1 *)&(state->master_icw1);
487 PrintDebug("8259 PIC: Setting ICW2 = %x (wr_Master2)\n", cw);
488 state->master_icw2 = cw;
490 if (cw1->sngl == 0) {
491 state->master_state = ICW3;
492 } else if (cw1->ic4 == 1) {
493 state->master_state = ICW4;
495 state->master_state = READY;
498 } else if (state->master_state == ICW3) {
499 struct icw1 * cw1 = (struct icw1 *)&(state->master_icw1);
501 PrintDebug("8259 PIC: Setting ICW3 = %x (wr_Master2)\n", cw);
503 state->master_icw3 = cw;
506 state->master_state = ICW4;
508 state->master_state = READY;
511 } else if (state->master_state == ICW4) {
512 PrintDebug("8259 PIC: Setting ICW4 = %x (wr_Master2)\n", cw);
513 state->master_icw4 = cw;
514 state->master_state = READY;
515 } else if (state->master_state == READY) {
516 PrintDebug("8259 PIC: Setting IMR = %x (wr_Master2)\n", cw);
517 state->master_imr = cw;
520 PrintError("8259 PIC: Invalid master PIC State (wr_Master2)\n");
527 static int write_slave_port1(ushort_t port, void * src, uint_t length, struct vm_device * dev) {
528 struct pic_internal * state = (struct pic_internal*)dev->private_data;
529 uchar_t cw = *(uchar_t *)src;
531 PrintDebug("8259 PIC: Write slave port 1 with 0x%x\n",cw);
535 PrintError("8259 PIC: Invalid Write length (wr_Slave1)\n");
540 PrintDebug("8259 PIC: Setting ICW1 = %x (wr_Slave1)\n", cw);
541 state->slave_icw1 = cw;
542 state->slave_state = ICW2;
543 } else if (state->slave_state == READY) {
545 // handle the EOI here
546 struct ocw2 * cw2 = (struct ocw2 *)&cw;
548 PrintDebug("8259 PIC: Setting OCW2 = %x (wr_Slave1)\n", cw);
550 if ((cw2->EOI) && (!cw2->R) && (cw2->SL)) {
552 state->slave_isr &= ~(0x01 << cw2->level);
553 } else if ((cw2->EOI) & (!cw2->R) && (!cw2->SL)) {
556 PrintDebug("8259 PIC: Pre ISR = %x (wr_Slave1)\n", state->slave_isr);
557 for (i = 0; i < 8; i++) {
558 if (state->slave_isr & (0x01 << i)) {
559 state->slave_isr &= ~(0x01 << i);
563 PrintDebug("8259 PIC: Post ISR = %x (wr_Slave1)\n", state->slave_isr);
565 PrintError("8259 PIC: Command not handled or invalid (wr_Slave1)\n");
569 state->slave_ocw2 = cw;
570 } else if (IS_OCW3(cw)) {
571 // Basically sets the IRR/ISR read flag
572 PrintDebug("8259 PIC: Setting OCW3 = %x (wr_Slave1)\n", cw);
573 state->slave_ocw3 = cw;
575 PrintError("8259 PIC: Invalid command work (wr_Slave1)\n");
579 PrintError("8259 PIC: Invalid State writing (wr_Slave1)\n");
586 static int write_slave_port2(ushort_t port, void * src, uint_t length, struct vm_device * dev) {
587 struct pic_internal * state = (struct pic_internal*)dev->private_data;
588 uchar_t cw = *(uchar_t *)src;
590 PrintDebug("8259 PIC: Write slave port 2 with 0x%x\n",cw);
593 PrintError("8259 PIC: Invalid write length (wr_Slave2)\n");
597 if (state->slave_state == ICW2) {
598 struct icw1 * cw1 = (struct icw1 *)&(state->master_icw1);
600 PrintDebug("8259 PIC: Setting ICW2 = %x (wr_Slave2)\n", cw);
602 state->slave_icw2 = cw;
604 if (cw1->sngl == 0) {
605 state->slave_state = ICW3;
606 } else if (cw1->ic4 == 1) {
607 state->slave_state = ICW4;
609 state->slave_state = READY;
612 } else if (state->slave_state == ICW3) {
613 struct icw1 * cw1 = (struct icw1 *)&(state->master_icw1);
615 PrintDebug("8259 PIC: Setting ICW3 = %x (wr_Slave2)\n", cw);
617 state->slave_icw3 = cw;
620 state->slave_state = ICW4;
622 state->slave_state = READY;
625 } else if (state->slave_state == ICW4) {
626 PrintDebug("8259 PIC: Setting ICW4 = %x (wr_Slave2)\n", cw);
627 state->slave_icw4 = cw;
628 state->slave_state = READY;
629 } else if (state->slave_state == READY) {
630 PrintDebug("8259 PIC: Setting IMR = %x (wr_Slave2)\n", cw);
631 state->slave_imr = cw;
633 PrintError("8259 PIC: Invalid State at write (wr_Slave2)\n");
643 static int read_elcr_port(ushort_t port, void * dst, uint_t length, struct vm_device * dev) {
644 struct pic_internal * state = (struct pic_internal*)dev->private_data;
647 PrintError("ELCR read of invalid length %d\n", length);
651 if (port == ELCR1_PORT) {
653 *(uint8_t *)dst = state->master_elcr;
654 } else if (port == ELCR2_PORT) {
655 *(uint8_t *)dst = state->slave_elcr;
657 PrintError("Invalid port %x\n", port);
665 static int write_elcr_port(ushort_t port, void * src, uint_t length, struct vm_device * dev) {
666 struct pic_internal * state = (struct pic_internal*)dev->private_data;
669 PrintError("ELCR read of invalid length %d\n", length);
673 if (port == ELCR1_PORT) {
675 state->master_elcr = (*(uint8_t *)src) & state->master_elcr_mask;
676 } else if (port == ELCR2_PORT) {
677 state->slave_elcr = (*(uint8_t *)src) & state->slave_elcr_mask;
679 PrintError("Invalid port %x\n", port);
688 static int pic_init(struct vm_device * dev) {
689 struct pic_internal * state = (struct pic_internal*)dev->private_data;
691 v3_register_intr_controller(dev->vm, &intr_ops, state);
693 state->master_irr = 0;
694 state->master_isr = 0;
695 state->master_elcr = 0;
696 state->master_elcr_mask = 0xf8;
697 state->master_icw1 = 0;
698 state->master_icw2 = 0;
699 state->master_icw3 = 0;
700 state->master_icw4 = 0;
701 state->master_imr = 0;
702 state->master_ocw2 = 0;
703 state->master_ocw3 = 0x02;
704 state->master_state = ICW1;
707 state->slave_irr = 0;
708 state->slave_isr = 0;
709 state->slave_elcr = 0;
710 state->slave_elcr_mask = 0xde;
711 state->slave_icw1 = 0;
712 state->slave_icw2 = 0;
713 state->slave_icw3 = 0;
714 state->slave_icw4 = 0;
715 state->slave_imr = 0;
716 state->slave_ocw2 = 0;
717 state->slave_ocw3 = 0x02;
718 state->slave_state = ICW1;
721 v3_dev_hook_io(dev, MASTER_PORT1, &read_master_port1, &write_master_port1);
722 v3_dev_hook_io(dev, MASTER_PORT2, &read_master_port2, &write_master_port2);
723 v3_dev_hook_io(dev, SLAVE_PORT1, &read_slave_port1, &write_slave_port1);
724 v3_dev_hook_io(dev, SLAVE_PORT2, &read_slave_port2, &write_slave_port2);
727 v3_dev_hook_io(dev, ELCR1_PORT, &read_elcr_port, &write_elcr_port);
728 v3_dev_hook_io(dev, ELCR2_PORT, &read_elcr_port, &write_elcr_port);
734 static int pic_deinit(struct vm_device * dev) {
735 v3_dev_unhook_io(dev, MASTER_PORT1);
736 v3_dev_unhook_io(dev, MASTER_PORT2);
737 v3_dev_unhook_io(dev, SLAVE_PORT1);
738 v3_dev_unhook_io(dev, SLAVE_PORT2);
749 static struct vm_device_ops dev_ops = {
751 .deinit = pic_deinit,
758 struct vm_device * v3_create_pic() {
759 struct pic_internal * state = NULL;
760 state = (struct pic_internal *)V3_Malloc(sizeof(struct pic_internal));
761 V3_ASSERT(state != NULL);
763 struct vm_device *device = v3_create_device("8259A", &dev_ops, state);