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 <palacios/vmm.h>
22 #include <palacios/vmm_dev_mgr.h>
23 #include <devices/icc_bus.h>
24 #include <palacios/vm_guest.h>
26 #ifndef CONFIG_DEBUG_IO_APIC
28 #define PrintDebug(fmt, args...)
33 #define IO_APIC_BASE_ADDR 0xfec00000
36 #define IOAPIC_ID_REG 0x00
37 #define IOAPIC_VER_REG 0x01
38 #define IOAPIC_ARB_REG 0x02
40 #define IOAPIC_REDIR_BASE_REG 0x10
42 #define REDIR_LO_MASK ~0x00005000
44 struct ioapic_reg_sel {
50 } __attribute__((packed));
51 } __attribute__((packed));
52 } __attribute__((packed));
54 struct ioapic_id_reg {
61 } __attribute__((packed));
62 } __attribute__((packed));
63 } __attribute__((packed));
65 struct ioapic_ver_reg {
73 } __attribute__((packed));
74 } __attribute__((packed));
75 } __attribute__((packed));
78 struct ioapic_arb_reg {
85 } __attribute__((packed));
86 } __attribute__((packed));
87 } __attribute__((packed));
90 struct redir_tbl_entry {
96 } __attribute__((packed));
101 #define LOWEST_PRIOR 0x1
108 #define PHSYICAL_DST_MODE 0
109 #define LOGICAL_DST_MODE 1
111 uint_t del_status : 1;
113 #define HIGH_ACTIVE 0
117 uint_t trig_mode : 1;
120 uint_t dst_field : 8;
121 } __attribute__((packed));
122 } __attribute__((packed));
123 } __attribute__((packed));
127 struct io_apic_state {
132 struct ioapic_id_reg ioapic_id;
133 struct ioapic_ver_reg ioapic_ver;
134 struct ioapic_arb_reg ioapic_arb_id;
136 struct redir_tbl_entry redir_tbl[24];
138 struct vm_device * icc_bus;
143 static void init_ioapic_state(struct io_apic_state * ioapic) {
145 ioapic->base_addr = IO_APIC_BASE_ADDR;
146 ioapic->index_reg = 0;
148 ioapic->ioapic_id.val = 0x00000000;
149 ioapic->ioapic_ver.val = 0x00170011;
150 ioapic->ioapic_arb_id.val = 0x00000000;
152 for (i = 0; i < 24; i++) {
153 ioapic->redir_tbl[i].val = 0x0001000000000000LL;
154 // Mask all interrupts until they are enabled....
155 ioapic->redir_tbl[i].mask = 1;
160 static int ioapic_read(struct guest_info * core, addr_t guest_addr, void * dst, uint_t length, void * priv_data) {
161 struct vm_device * dev = (struct vm_device *)priv_data;
162 struct io_apic_state * ioapic = (struct io_apic_state *)(dev->private_data);
163 uint32_t reg_tgt = guest_addr - ioapic->base_addr;
164 uint32_t * op_val = (uint32_t *)dst;
166 PrintDebug("IOAPIC Read at %p\n", (void *)guest_addr);
168 if (reg_tgt == 0x00) {
169 *op_val = ioapic->index_reg;
170 } else if (reg_tgt == 0x10) {
172 switch (ioapic->index_reg) {
174 *op_val = ioapic->ioapic_id.val;
177 *op_val = ioapic->ioapic_ver.val;
180 *op_val = ioapic->ioapic_arb_id.val;
184 uint_t redir_index = (ioapic->index_reg - IOAPIC_REDIR_BASE_REG) >> 1;
185 uint_t hi_val = (ioapic->index_reg - IOAPIC_REDIR_BASE_REG) % 1;
187 if (redir_index > 0x3f) {
188 PrintError("Invalid redirection table entry %x\n", (uint32_t)redir_index);
192 *op_val = ioapic->redir_tbl[redir_index].hi;
194 *op_val = ioapic->redir_tbl[redir_index].lo;
204 static int ioapic_write(struct guest_info * core, addr_t guest_addr, void * src, uint_t length, void * priv_data) {
205 struct vm_device * dev = (struct vm_device *)priv_data;
206 struct io_apic_state * ioapic = (struct io_apic_state *)(dev->private_data);
207 uint32_t reg_tgt = guest_addr - ioapic->base_addr;
208 uint32_t op_val = *(uint32_t *)src;
210 PrintDebug("IOAPIC Write at %p (val = %d)\n", (void *)guest_addr, *(uint32_t *)src);
212 if (reg_tgt == 0x00) {
213 ioapic->index_reg = op_val;
214 } else if (reg_tgt == 0x10) {
216 switch (ioapic->index_reg) {
218 ioapic->ioapic_id.val = op_val;
221 // GPF/PageFault/Ignore?
222 PrintError("Writing to read only IOAPIC register\n");
225 ioapic->ioapic_arb_id.val = op_val;
229 uint_t redir_index = (ioapic->index_reg - IOAPIC_REDIR_BASE_REG) >> 1;
230 uint_t hi_val = (ioapic->index_reg - IOAPIC_REDIR_BASE_REG) % 1;
235 if (redir_index > 0x3f) {
236 PrintError("Invalid redirection table entry %x\n", (uint32_t)redir_index);
240 PrintDebug("Writing to hi of pin %d\n", redir_index);
241 ioapic->redir_tbl[redir_index].hi = op_val;
243 PrintDebug("Writing to lo of pin %d\n", redir_index);
244 op_val &= REDIR_LO_MASK;
245 ioapic->redir_tbl[redir_index].lo &= ~REDIR_LO_MASK;
246 ioapic->redir_tbl[redir_index].lo |= op_val;
256 static int ioapic_raise_irq(struct v3_vm_info * vm, void * private_data, int irq) {
257 struct vm_device * dev = (struct vm_device *)private_data;
258 struct io_apic_state * ioapic = (struct io_apic_state *)(dev->private_data);
259 struct redir_tbl_entry * irq_entry = NULL;
262 PrintDebug("IRQ out of range of IO APIC\n");
266 irq_entry = &(ioapic->redir_tbl[irq]);
268 if (irq_entry->mask == 0) {
269 PrintDebug("IOAPIC Signalling APIC to raise INTR %d\n", irq_entry->vec);
270 v3_icc_send_irq(ioapic->icc_bus, irq_entry->dst_field, irq_entry->vec);
276 /* I don't know if we can do anything here.... */
277 static int ioapic_lower_irq(struct v3_vm_info * vm, void * private_data, int irq) {
281 static struct intr_router_ops router_ops = {
282 .raise_intr = ioapic_raise_irq,
283 .lower_intr = ioapic_lower_irq,
289 static int io_apic_free(struct vm_device * dev) {
290 // struct guest_info * info = dev->vm;
296 static struct v3_device_ops dev_ops = {
297 .free = io_apic_free,
305 static int ioapic_init(struct v3_vm_info * vm, v3_cfg_tree_t * cfg) {
306 struct vm_device * icc_bus = v3_find_dev(vm, v3_cfg_val(cfg, "irq_bus"));
307 char * name = v3_cfg_val(cfg, "name");
310 PrintError("Could not locate ICC BUS device (%s)\n", v3_cfg_val(cfg, "irq_bus"));
314 PrintDebug("Creating IO APIC\n");
316 struct io_apic_state * ioapic = (struct io_apic_state *)V3_Malloc(sizeof(struct io_apic_state));
318 ioapic->icc_bus = icc_bus;
320 struct vm_device * dev = v3_allocate_device(name, &dev_ops, ioapic);
323 if (v3_attach_device(vm, dev) == -1) {
324 PrintError("Could not attach device %s\n", name);
329 v3_register_intr_router(vm, &router_ops, dev);
330 init_ioapic_state(ioapic);
332 v3_hook_full_mem(vm, V3_MEM_CORE_ANY, ioapic->base_addr, ioapic->base_addr + PAGE_SIZE_4KB,
333 ioapic_read, ioapic_write, dev);
339 device_register("IOAPIC", ioapic_init)