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 <devices/apic_regs.h>
25 #include <palacios/vm_guest.h>
27 #ifndef CONFIG_DEBUG_IO_APIC
29 #define PrintDebug(fmt, args...)
34 #define IO_APIC_BASE_ADDR 0xfec00000
37 #define IOAPIC_ID_REG 0x00
38 #define IOAPIC_VER_REG 0x01
39 #define IOAPIC_ARB_REG 0x02
41 #define IOAPIC_REDIR_BASE_REG 0x10
43 #define REDIR_LO_MASK ~0x00005000
45 struct ioapic_reg_sel {
51 } __attribute__((packed));
52 } __attribute__((packed));
53 } __attribute__((packed));
55 struct ioapic_id_reg {
62 } __attribute__((packed));
63 } __attribute__((packed));
64 } __attribute__((packed));
66 struct ioapic_ver_reg {
74 } __attribute__((packed));
75 } __attribute__((packed));
76 } __attribute__((packed));
79 struct ioapic_arb_reg {
86 } __attribute__((packed));
87 } __attribute__((packed));
88 } __attribute__((packed));
91 struct redir_tbl_entry {
97 } __attribute__((packed));
102 #define LOWEST_PRIOR 0x1
109 #define PHSYICAL_DST_MODE 0
110 #define LOGICAL_DST_MODE 1
112 uint_t del_status : 1;
114 #define HIGH_ACTIVE 0
118 uint_t trig_mode : 1;
121 uint_t dst_field : 8;
122 } __attribute__((packed));
123 } __attribute__((packed));
124 } __attribute__((packed));
128 struct io_apic_state {
133 struct ioapic_id_reg ioapic_id;
134 struct ioapic_ver_reg ioapic_ver;
135 struct ioapic_arb_reg ioapic_arb_id;
137 struct redir_tbl_entry redir_tbl[24];
139 struct vm_device * icc_bus;
144 static void init_ioapic_state(struct io_apic_state * ioapic, uint32_t id) {
146 ioapic->base_addr = IO_APIC_BASE_ADDR;
147 ioapic->index_reg = 0;
149 ioapic->ioapic_id.id = id;
150 ioapic->ioapic_ver.val = 0x00170011;
151 ioapic->ioapic_arb_id.val = 0x00000000;
153 for (i = 0; i < 24; i++) {
154 ioapic->redir_tbl[i].val = 0x0001000000000000LL;
155 // Mask all interrupts until they are enabled....
156 ioapic->redir_tbl[i].mask = 1;
159 // special case redir_tbl[0] for pin 0 as ExtInt for Virtual Wire Mode
160 // ioapic->redir_tbl[0].del_mode=EXTINT;
161 // ioapic->redir_tbl[0].mask=0;
165 static int ioapic_read(struct guest_info * core, addr_t guest_addr, void * dst, uint_t length, void * priv_data) {
166 struct vm_device * dev = (struct vm_device *)priv_data;
167 struct io_apic_state * ioapic = (struct io_apic_state *)(dev->private_data);
168 uint32_t reg_tgt = guest_addr - ioapic->base_addr;
169 uint32_t * op_val = (uint32_t *)dst;
171 PrintDebug("ioapic %u: IOAPIC Read at %p\n", ioapic->ioapic_id.id, (void *)guest_addr);
173 if (reg_tgt == 0x00) {
174 *op_val = ioapic->index_reg;
175 } else if (reg_tgt == 0x10) {
177 switch (ioapic->index_reg) {
179 *op_val = ioapic->ioapic_id.val;
182 *op_val = ioapic->ioapic_ver.val;
185 *op_val = ioapic->ioapic_arb_id.val;
188 uint_t redir_index = (ioapic->index_reg - IOAPIC_REDIR_BASE_REG) >> 1;
189 uint_t hi_val = (ioapic->index_reg - IOAPIC_REDIR_BASE_REG) & 1;
191 if (redir_index > 0x3f) {
192 PrintError("ioapic %u: Invalid redirection table entry %x\n", ioapic->ioapic_id.id, (uint32_t)redir_index);
197 *op_val = ioapic->redir_tbl[redir_index].hi;
199 *op_val = ioapic->redir_tbl[redir_index].lo;
205 PrintDebug("ioapic %u: IOAPIC Read at %p gave value 0x%x\n", ioapic->ioapic_id.id, (void *)guest_addr, *op_val);
211 static int ioapic_write(struct guest_info * core, addr_t guest_addr, void * src, uint_t length, void * priv_data) {
212 struct vm_device * dev = (struct vm_device *)priv_data;
213 struct io_apic_state * ioapic = (struct io_apic_state *)(dev->private_data);
214 uint32_t reg_tgt = guest_addr - ioapic->base_addr;
215 uint32_t op_val = *(uint32_t *)src;
217 PrintDebug("ioapic %u: IOAPIC Write at %p (val = %d)\n", ioapic->ioapic_id.id, (void *)guest_addr, *(uint32_t *)src);
219 if (reg_tgt == 0x00) {
220 PrintDebug("ioapic %u: Setting ioapic index register to 0x%x.\n", ioapic->ioapic_id.id, op_val);
221 ioapic->index_reg = op_val;
222 } else if (reg_tgt == 0x10) {
224 switch (ioapic->index_reg) {
226 // What does this do to our relationship with the ICC bus?
227 ioapic->ioapic_id.val = op_val;
230 // GPF/PageFault/Ignore?
231 PrintError("ioapic %u: Writing to read only IOAPIC register\n", ioapic->ioapic_id.id);
234 ioapic->ioapic_arb_id.val = op_val;
238 uint_t redir_index = (ioapic->index_reg - IOAPIC_REDIR_BASE_REG) >> 1;
239 uint_t hi_val = (ioapic->index_reg - IOAPIC_REDIR_BASE_REG) & 1;
241 PrintDebug("ioapic %u: Writing value 0x%x to redirection entry %u (%s)\n",
242 ioapic->ioapic_id.id, op_val, redir_index, hi_val ? "hi" : "low");
244 if (redir_index > 0x3f) {
245 PrintError("ioapic %u: Invalid redirection table entry %x\n", ioapic->ioapic_id.id, (uint32_t)redir_index);
249 PrintDebug("ioapic %u: Writing to hi of pin %d\n", ioapic->ioapic_id.val, redir_index);
250 ioapic->redir_tbl[redir_index].hi = op_val;
252 PrintDebug("ioapic %u: Writing to lo of pin %d\n", ioapic->ioapic_id.id, redir_index);
253 op_val &= REDIR_LO_MASK;
254 ioapic->redir_tbl[redir_index].lo &= ~REDIR_LO_MASK;
255 ioapic->redir_tbl[redir_index].lo |= op_val;
265 static int ioapic_raise_irq(struct v3_vm_info * vm, void * private_data, int irq) {
266 struct vm_device * dev = (struct vm_device *)private_data;
267 struct io_apic_state * ioapic = (struct io_apic_state *)(dev->private_data);
268 struct redir_tbl_entry * irq_entry = NULL;
271 PrintDebug("ioapic %u: IRQ out of range of IO APIC\n", ioapic->ioapic_id.id);
275 irq_entry = &(ioapic->redir_tbl[irq]);
277 if (irq_entry->mask == 0) {
279 PrintDebug("ioapic %u: IOAPIC Signalling APIC to raise INTR %d\n", ioapic->ioapic_id.id, irq_entry->vec);
282 // the format of the redirection table entry is just slightly
283 // different than that of the lapic's cmd register, which is the other
284 // way an IPI is initiated. So we will translate
286 struct int_cmd_reg icr;
288 icr.val = irq_entry->val;
291 icr.trig_mode=irq_entry->trig_mode;
293 icr.dst_shorthand=0; // no shorthand
296 PrintDebug("io apic %u: raising irq %u on ICC bus.\n",
297 ioapic->ioapic_id.id, irq);
298 v3_icc_send_ipi(ioapic->icc_bus, ioapic->ioapic_id.id,icr.val, irq);
304 /* I don't know if we can do anything here.... */
305 static int ioapic_lower_irq(struct v3_vm_info * vm, void * private_data, int irq) {
309 static struct intr_router_ops router_ops = {
310 .raise_intr = ioapic_raise_irq,
311 .lower_intr = ioapic_lower_irq,
317 static int io_apic_free(struct vm_device * dev) {
318 // struct guest_info * info = dev->vm;
324 static struct v3_device_ops dev_ops = {
325 .free = io_apic_free,
333 static int ioapic_init(struct v3_vm_info * vm, v3_cfg_tree_t * cfg) {
334 struct vm_device * icc_bus = v3_find_dev(vm, v3_cfg_val(cfg, "bus"));
335 char * dev_id = v3_cfg_val(cfg, "ID");
338 PrintError("ioapic: Could not locate ICC BUS device (%s)\n", v3_cfg_val(cfg, "bus"));
342 PrintDebug("ioapic: Creating IO APIC\n");
344 struct io_apic_state * ioapic = (struct io_apic_state *)V3_Malloc(sizeof(struct io_apic_state));
346 ioapic->icc_bus = icc_bus;
348 struct vm_device * dev = v3_allocate_device(dev_id, &dev_ops, ioapic);
351 if (v3_attach_device(vm, dev) == -1) {
352 PrintError("ioapic: Could not attach device %s\n", dev_id);
357 v3_register_intr_router(vm, &router_ops, dev);
359 init_ioapic_state(ioapic,vm->num_cores);
361 v3_icc_register_ioapic(vm,icc_bus,ioapic->ioapic_id.id);
363 v3_hook_full_mem(vm, V3_MEM_CORE_ANY, ioapic->base_addr, ioapic->base_addr + PAGE_SIZE_4KB,
364 ioapic_read, ioapic_write, dev);
370 device_register("IOAPIC", ioapic_init)