+/*
+ * This file is part of the Palacios Virtual Machine Monitor developed
+ * by the V3VEE Project with funding from the United States National
+ * Science Foundation and the Department of Energy.
+ *
+ * The V3VEE Project is a joint project between Northwestern University
+ * and the University of New Mexico. You can find out more at
+ * http://www.v3vee.org
+ *
+ * Copyright (c) 2008, Peter Dinda <pdinda@northwestern.edu>
+ * Copyright (c) 2008, The V3VEE Project <http://www.v3vee.org>
+ * All rights reserved.
+ *
+ * Author: Peter Dinda <pdinda@northwestern.edu>
+ * Contributor: 2008, Jack Lange <jarusl@cs.northwestern.edu>
+ *
+ *
+ * This is free software. You are permitted to use,
+ * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
+ */
+
#include <devices/generic.h>
#include <palacios/vmm.h>
#include <palacios/vmm_types.h>
-#include <geekos/io.h>
+#include <palacios/vmm_list.h>
-#define GENERIC_DEBUG 1
-#if GENERIC_DEBUG
-#define GENERIC_DEBUG_PRINT(first, rest...) PrintDebug(first, ##rest)
-#else
-#define GENERIC_DEBUG_PRINT(first, rest...)
+#ifndef DEBUG_GENERIC
+#undef PrintDebug
+#define PrintDebug(fmt, args...)
#endif
#define MEM_HOOKS 0 // not yet implmented in device model
#define IRQ_HOOKS 0 // not yet implemented in device model
+
struct generic_internal {
- generic_port_range_type *port_ranges;
- uint_t num_port_ranges;
- generic_address_range_type *address_ranges;
- uint_t num_address_ranges;
- generic_irq_range_type *irq_ranges;
- uint_t num_irq_ranges;
+ struct list_head port_list;
+ uint_t num_port_ranges;
+ struct list_head mem_list;
+ uint_t num_mem_ranges;
+ struct list_head irq_list;
+ uint_t num_irq_ranges;
};
-
-
+struct port_range {
+ uint_t start;
+ uint_t end;
+ uint_t type;
+ struct list_head range_link;
+};
+struct mem_range {
+ void * start;
+ void * end;
+ uint_t type;
+ struct list_head range_link;
+};
+struct irq_range {
+ uint_t start;
+ uint_t end;
+ uint_t type;
+ struct list_head range_link;
+};
-int generic_reset_device(struct vm_device * dev)
-{
- GENERIC_DEBUG_PRINT("generic: reset device\n");
-
- return 0;
+static int generic_reset_device(struct vm_device * dev) {
+ PrintDebug("generic: reset device\n");
+ return 0;
}
-int generic_start_device(struct vm_device *dev)
-{
- GENERIC_DEBUG_PRINT("generic: start device\n");
- return 0;
+static int generic_start_device(struct vm_device * dev) {
+ PrintDebug("generic: start device\n");
+ return 0;
}
-int generic_stop_device(struct vm_device *dev)
-{
- GENERIC_DEBUG_PRINT("generic: stop device\n");
- return 0;
+static int generic_stop_device(struct vm_device * dev) {
+ PrintDebug("generic: stop device\n");
+ return 0;
}
-int generic_write_port(ushort_t port,
- void * src,
- uint_t length,
- struct vm_device * dev)
-{
- uint_t i;
+static int generic_write_port_passthrough(ushort_t port,
+ void * src,
+ uint_t length,
+ struct vm_device * dev) {
+ uint_t i;
+
+ PrintDebug("generic: writing 0x");
- GENERIC_DEBUG_PRINT("generic: writing 0x");
- for (i=0;i<length;i++) {
- GENERIC_DEBUG_PRINT("%x",((uchar_t*)src)[i]);
- }
- GENERIC_DEBUG_PRINT(" to port 0x%x ... ",port);
- for (i=0;i<length;i++) {
- Out_Byte(port,((uchar_t*)src)[i]);
- }
- GENERIC_DEBUG_PRINT(" done\n");
+ for (i = 0; i < length; i++) {
+ PrintDebug("%x", ((uchar_t*)src)[i]);
+ }
+
+ PrintDebug(" to port 0x%x ... ", port);
+
+
+ switch (length) {
+ case 1:
+ v3_outb(port,((uchar_t*)src)[0]);
+ break;
+ case 2:
+ v3_outw(port,((ushort_t*)src)[0]);
+ break;
+ case 4:
+ v3_outdw(port,((uint_t*)src)[0]);
+ break;
+ default:
+ for (i = 0; i < length; i++) {
+ v3_outb(port, ((uchar_t*)src)[i]);
+ }
+ } //switch length
+
+
+ PrintDebug(" done\n");
- return length;
+ return length;
}
-int generic_read_port(ushort_t port,
- void * src,
- uint_t length,
- struct vm_device * dev)
-{
- uint_t i;
-
- GENERIC_DEBUG_PRINT("generic: reading 0x%x bytes from port 0x%x ...",length,port);
- for (i=0;i<length;i++) {
- ((uchar_t*)src)[i] =In_Byte(port);
- }
- GENERIC_DEBUG_PRINT(" done ... read 0x");
- for (i=0;i<length;i++) {
- GENERIC_DEBUG_PRINT("%x",((uchar_t*)src)[i]);
- }
- GENERIC_DEBUG_PRINT("\n");
-
- return length;
+static int generic_read_port_passthrough(ushort_t port,
+ void * src,
+ uint_t length,
+ struct vm_device * dev) {
+ uint_t i;
+
+ PrintDebug("generic: reading 0x%x bytes from port 0x%x ...", length, port);
+
+
+ switch (length) {
+ case 1:
+ ((uchar_t*)src)[0] = v3_inb(port);
+ break;
+ case 2:
+ ((ushort_t*)src)[0] = v3_inw(port);
+ break;
+ case 4:
+ ((uint_t*)src)[0] = v3_indw(port);
+ break;
+ default:
+ for (i = 0; i < length; i++) {
+ ((uchar_t*)src)[i] = v3_inb(port);
+ }
+ }//switch length
+
+ PrintDebug(" done ... read 0x");
+
+ for (i = 0; i < length; i++) {
+ PrintDebug("%x", ((uchar_t*)src)[i]);
+ }
+
+ PrintDebug("\n");
+
+ return length;
}
+static int generic_write_port_ignore(ushort_t port,
+ void * src,
+ uint_t length,
+ struct vm_device * dev) {
+ uint_t i;
+ PrintDebug("generic: writing 0x");
-int generic_interrupt(uint_t irq,
- struct vm_device * dev)
-{
- PrintDebug("generic: interrupt 0x%x - injecting into VM\n",irq);
+ for (i = 0; i < length; i++) {
+ PrintDebug("%x", ((uchar_t*)src)[i]);
+ }
+
+ PrintDebug(" to port 0x%x ... ignored\n", port);
+
+ return length;
+}
+
+static int generic_read_port_ignore(ushort_t port,
+ void * src,
+ uint_t length,
+ struct vm_device * dev) {
- dev->vm->vm_ops.raise_irq(dev->vm,irq);
+ PrintDebug("generic: reading 0x%x bytes from port 0x%x ...", length, port);
- return 0;
+ memset((char*)src, 0, length);
+ PrintDebug(" ignored (return zeroed buffer)\n");
+ return length;
}
-int generic_init_device(struct vm_device * dev)
-{
- struct generic_internal *state = (struct generic_internal *) dev->private_data;
- uint_t i,j;
- GENERIC_DEBUG_PRINT("generic: init_device\n");
+static int generic_interrupt(uint_t irq, struct vm_device * dev) {
+ PrintDebug("generic: interrupt 0x%x - injecting into VM\n", irq);
- // Would read state here
+ v3_raise_irq(dev->vm, irq);
+
+ return 0;
+}
- generic_reset_device(dev);
- for (i=0;i<state->num_port_ranges;i++) {
- GENERIC_DEBUG_PRINT("generic: hooking ports 0x%x to 0x%x\n",state->port_ranges[i][0],state->port_ranges[i][1]);
-#if PORT_HOOKS
- for (j=state->port_ranges[i][0]; j<=state->port_ranges[i][1];j++) {
- if (dev_hook_io(dev, j, &generic_read_port, &generic_write_port)) {
- GENERIC_DEBUG_PRINT("generic: can't hook port 0x%x (already hooked?)\n",j);
- }
+static int generic_init_device(struct vm_device * dev) {
+ struct generic_internal * state = (struct generic_internal *)(dev->private_data);
+
+ PrintDebug("generic: init_device\n");
+ generic_reset_device(dev);
+
+
+ if (PORT_HOOKS) { // This is a runtime conditional on a #define
+ struct port_range * tmp = NULL;
+
+ list_for_each_entry(tmp, &(state->port_list), range_link) {
+ uint_t i = 0;
+
+ PrintDebug("generic: hooking ports 0x%x to 0x%x as %s\n",
+ tmp->start, tmp->end,
+ (tmp->type == GENERIC_PRINT_AND_PASSTHROUGH) ? "print-and-passthrough" : "print-and-ignore");
+
+ for (i = tmp->start; i <= tmp->end; i++) {
+ if (tmp->type == GENERIC_PRINT_AND_PASSTHROUGH) {
+
+ if (v3_dev_hook_io(dev, i, &generic_read_port_passthrough, &generic_write_port_passthrough)) {
+ PrintDebug("generic: can't hook port 0x%x (already hooked?)\n", i);
+ }
+
+ } else if (tmp->type == GENERIC_PRINT_AND_IGNORE) {
+
+ if (v3_dev_hook_io(dev, i, &generic_read_port_ignore, &generic_write_port_ignore)) {
+ PrintDebug("generic: can't hook port 0x%x (already hooked?)\n", i);
+ }
+ }
+ }
+
+ }
+ } else {
+ PrintDebug("generic: hooking ports not supported\n");
}
-#else
- GENERIC_DEBUG_PRINT("generic: hooking ports not supported\n");
-#endif
- }
- for (i=0;i<state->num_address_ranges;i++) {
- GENERIC_DEBUG_PRINT("generic: hooking addresses 0x%x to 0x%x\n",state->address_ranges[i][0],state->address_ranges[i][1]);
-#if MEM_HOOKS
- if (dev_hook_mem(dev, state->address_ranges[i][0],state->address_ranges[i][1])) {
- GENERIC_DEBUG_PRINT("generic: Can't hook addresses 0x%x to 0x%x (already hooked?)\n",
- state->address_ranges[i][0],state->address_ranges[i][1]);
+
+ if (MEM_HOOKS) { // This is a runtime conditional on a #define
+ struct mem_range * tmp;
+
+ list_for_each_entry(tmp, &(state->mem_list), range_link) {
+
+ PrintDebug("generic: hooking addresses 0x%p to 0x%p\n",
+ tmp->start, tmp->end);
+
+
+ if (v3_dev_hook_mem(dev, tmp->start, tmp->end)) {
+ PrintDebug("generic: Can't hook addresses 0x%p to 0x%p (already hooked?)\n",
+ tmp->start, tmp->end);
+ }
+ }
+ } else {
+ PrintDebug("generic: hooking addresses not supported\n");
}
-#else
- GENERIC_DEBUG_PRINT("generic: hooking addresses not supported\n");
-#endif
- }
- for (i=0;i<state->num_irq_ranges;i++) {
- GENERIC_DEBUG_PRINT("generic: hooking irqs 0x%x to 0x%x\n",state->irq_ranges[i][0],state->irq_ranges[i][1]);
-#if IRQ_HOOKS
- for (j=state->irq_ranges[i][0]; j<=state->irq_ranges[i][1];j++) {
- if (dev_hook_irq(dev, j, &generic_interrupt)) {
- GENERIC_DEBUG_PRINT("generic: can't hook irq 0x%x (already hooked?)\n",j);
- }
+
+
+ if (IRQ_HOOKS) { // This is a runtime conditional on a #define
+ struct irq_range * tmp;
+
+ list_for_each_entry(tmp, &(state->irq_list), range_link) {
+ uint_t i;
+
+ PrintDebug("generic: hooking irqs 0x%x to 0x%x\n",
+ tmp->start, tmp->end);
+
+ for (i = tmp->start; i <= tmp->end; i++) {
+ if (v3_dev_hook_irq(dev, i, &generic_interrupt)) {
+ PrintDebug("generic: can't hook irq 0x%x (already hooked?)\n", i);
+ }
+ }
+
+ }
+ } else {
+ PrintDebug("generic: hooking irqs not supported\n");
}
-#else
- GENERIC_DEBUG_PRINT("generic: hooking irqs not supported\n");
-#endif
- }
- return 0;
+
+
+ return 0;
}
-int generic_deinit_device(struct vm_device *dev)
-{
- struct generic_internal *state = (struct generic_internal *) dev->private_data;
- uint_t i,j;
+static int generic_deinit_device(struct vm_device * dev) {
+ struct generic_internal * state = (struct generic_internal *)(dev->private_data);
+
- GENERIC_DEBUG_PRINT("generic: deinit_device\n");
+ PrintDebug("generic: deinit_device\n");
- for (i=0;i<state->num_irq_ranges;i++) {
- GENERIC_DEBUG_PRINT("generic: unhooking irqs 0x%x to 0x%x\n",state->irq_ranges[i][0],state->irq_ranges[i][1]);
-#if IRQ_HOOKS
- for (j=state->irq_ranges[i][0]; j<=state->irq_ranges[i][1];j++) {
- if (dev_unhook_irq(dev, j)) {
- GENERIC_DEBUG_PRINT("generic: can't unhook irq 0x%x (already unhooked?)\n",j);
- }
+
+ if (IRQ_HOOKS) { // This is a runtime conditional on a #define
+ struct irq_range * tmp;
+ struct irq_range * cur;
+
+ list_for_each_entry_safe(cur, tmp, &(state->irq_list), range_link) {
+ uint_t i;
+
+ PrintDebug("generic: unhooking irqs 0x%x to 0x%x\n",
+ cur->start, cur->end);
+
+
+ for (i = cur->start; i <= cur->end; i++) {
+ if (v3_dev_unhook_irq(dev, i)) {
+ PrintDebug("generic: can't unhook irq 0x%x (already unhooked?)\n", i);
+ }
+ }
+
+ list_del(&(cur->range_link));
+ state->num_irq_ranges--;
+ V3_Free(cur);
+ }
+ } else {
+ PrintDebug("generic: unhooking irqs not supported\n");
}
-#else
- GENERIC_DEBUG_PRINT("generic: unhooking irqs not supported\n");
-#endif
- }
- for (i=0;i<state->num_address_ranges;i++) {
- GENERIC_DEBUG_PRINT("generic: unhooking addresses 0x%x to 0x%x\n",state->address_ranges[i][0],state->address_ranges[i][1]);
-#if MEM_HOOKS
- if (dev_unhook_mem(dev, state->address_ranges[i][0],state->address_ranges[i][1])) {
- GENERIC_DEBUG_PRINT("generic: Can't unhook addresses 0x%x to 0x%x (already unhooked?)\n",
- state->address_ranges[i][0],state->address_ranges[i][1]);
+ if (MEM_HOOKS) {
+ struct mem_range * tmp;
+ struct mem_range * cur;
+
+ list_for_each_entry_safe(cur, tmp, &(state->mem_list), range_link) {
+
+ PrintDebug("generic: unhooking addresses 0x%p to 0x%p\n",
+ cur->start, cur->end);
+
+ if (v3_dev_unhook_mem(dev, cur->start, cur->end)) {
+ PrintDebug("generic: Can't unhook addresses 0x%p to 0x%p (already unhooked?)\n",
+ cur->start, cur->end);
+ }
+
+ list_del(&(cur->range_link));
+ state->num_mem_ranges--;
+ V3_Free(cur);
+ }
+ } else {
+ PrintDebug("generic: unhooking addresses not supported\n");
}
-#else
- GENERIC_DEBUG_PRINT("generic: unhooking addresses not supported\n");
-#endif
- }
-
- for (i=0;i<state->num_port_ranges;i++) {
- GENERIC_DEBUG_PRINT("generic: unhooking ports 0x%x to 0x%x\n",state->port_ranges[i][0],state->port_ranges[i][1]);
-#if PORT_HOOKS
- for (j=state->port_ranges[i][0]; j<=state->port_ranges[i][1];j++) {
- if (dev_unhook_io(dev, j)) {
- GENERIC_DEBUG_PRINT("generic: can't unhook port 0x%x (already unhooked?)\n",j);
- }
+
+
+ if (PORT_HOOKS) {
+ struct port_range * tmp;
+ struct port_range * cur;
+
+ list_for_each_entry_safe(cur, tmp, &(state->port_list), range_link) {
+ uint_t i;
+
+ PrintDebug("generic: unhooking ports 0x%x to 0x%x\n",
+ cur->start, cur->end);
+
+ for (i = cur->start; i <= cur->end; i++) {
+ if (v3_dev_unhook_io(dev, i)) {
+ PrintDebug("generic: can't unhook port 0x%x (already unhooked?)\n", i);
+ }
+ }
+
+ list_del(&(cur->range_link));
+ state->num_port_ranges--;
+ V3_Free(cur);
+ }
+ } else {
+ PrintDebug("generic: unhooking ports not supported\n");
}
-#else
- GENERIC_DEBUG_PRINT("generic: unhooking ports not supported\n");
-#endif
- }
- generic_reset_device(dev);
- return 0;
+
+ generic_reset_device(dev);
+ return 0;
}
static struct vm_device_ops dev_ops = {
- .init = generic_init_device,
- .deinit = generic_deinit_device,
- .reset = generic_reset_device,
- .start = generic_start_device,
- .stop = generic_stop_device,
+ .init = generic_init_device,
+ .deinit = generic_deinit_device,
+ .reset = generic_reset_device,
+ .start = generic_start_device,
+ .stop = generic_stop_device,
};
-struct vm_device *create_generic(generic_port_range_type port_ranges[],
- uint_t num_port_ranges,
- generic_address_range_type address_ranges[],
- uint_t num_address_ranges,
- generic_irq_range_type irq_ranges[],
- uint_t num_irq_ranges)
-{
- struct generic_internal * generic_state = (struct generic_internal *)V3_Malloc(sizeof(struct generic_internal));
+int v3_generic_add_port_range(struct vm_device * dev, uint_t start, uint_t end, uint_t type) {
+ if (PORT_HOOKS) {
+ struct generic_internal * state = (struct generic_internal *)(dev->private_data);
- generic_state->num_port_ranges=num_port_ranges;
- if (num_port_ranges>0) {
- generic_state->port_ranges = V3_Malloc(sizeof(generic_address_range_type)*num_port_ranges);
- memcpy(generic_state->port_ranges,port_ranges,sizeof(generic_port_range_type)*num_port_ranges);
- } else {
- generic_state->port_ranges=NULL;
- }
+ struct port_range * range = (struct port_range *)V3_Malloc(sizeof(struct port_range));
+ range->start = start;
+ range->end = end;
+ range->type = type;
+
+
+ PrintDebug("generic: Adding Port Range: 0x%x to 0x%x as %s\n",
+ range->start, range->end,
+ (range->type == GENERIC_PRINT_AND_PASSTHROUGH) ? "print-and-passthrough" : "print-and-ignore");
+
+ list_add(&(range->range_link), &(state->port_list));
+ state->num_port_ranges++;
+ } else {
+ PrintDebug("generic: hooking IO ports not supported\n");
+ return -1;
+ }
- generic_state->num_address_ranges=num_address_ranges;
- if (num_address_ranges>0) {
- generic_state->address_ranges = V3_Malloc(sizeof(generic_address_range_type)*num_address_ranges);
- memcpy(generic_state->address_ranges,address_ranges,sizeof(generic_address_range_type)*num_address_ranges);
- } else {
- generic_state->address_ranges=NULL;
- }
- generic_state->num_irq_ranges=num_irq_ranges;
- if (num_irq_ranges>0) {
- generic_state->irq_ranges = V3_Malloc(sizeof(generic_address_range_type)*num_irq_ranges);
- memcpy(generic_state->irq_ranges,irq_ranges,sizeof(generic_irq_range_type)*num_port_ranges);
- } else {
- generic_state->irq_ranges=NULL;
- }
+ return 0;
+}
+int v3_generic_add_mem_range(struct vm_device * dev, void * start, void * end, uint_t type) {
- struct vm_device *device = create_device("GENERIC", &dev_ops, generic_state);
+ if (MEM_HOOKS) {
+ struct generic_internal * state = (struct generic_internal *)(dev->private_data);
+
+ struct mem_range * range = (struct mem_range *)V3_Malloc(sizeof(struct mem_range));
+ range->start = start;
+ range->end = end;
+ range->type = type;
+
+ list_add(&(range->range_link), &(state->port_list));
+ state->num_mem_ranges++;
+ } else {
+ PrintDebug("generic: hooking memory not supported\n");
+ return -1;
+ }
+
+ return 0;
+}
+
+
+int v3_generic_add_irq_range(struct vm_device * dev, uint_t start, uint_t end, uint_t type) {
+
+ if (IRQ_HOOKS) {
+ struct generic_internal * state = (struct generic_internal *)(dev->private_data);
+
+ struct irq_range * range = (struct irq_range *)V3_Malloc(sizeof(struct irq_range));
+ range->start = start;
+ range->end = end;
+ range->type = type;
+
+ list_add(&(range->range_link), &(state->port_list));
+ state->num_irq_ranges++;
+ } else {
+ PrintDebug("generic: hooking IRQs not supported\n");
+ return -1;
+ }
+
+ return 0;
+}
+
+
+
+struct vm_device * v3_create_generic() {
+ struct generic_internal * generic_state = (struct generic_internal *)V3_Malloc(sizeof(struct generic_internal));
+
+ generic_state->num_port_ranges = 0;
+ generic_state->num_mem_ranges = 0;
+ generic_state->num_irq_ranges = 0;
+
+ INIT_LIST_HEAD(&(generic_state->port_list));
+ INIT_LIST_HEAD(&(generic_state->mem_list));
+ INIT_LIST_HEAD(&(generic_state->irq_list));
+
+ struct vm_device * device = v3_create_device("GENERIC", &dev_ops, generic_state);
- return device;
+ return device;
}
