-/* (c) 2008, Peter Dinda <pdinda@northwestern.edu> */
-/* (c) 2008, The V3VEE Project <http://www.v3vee.org> */
+/*
+ * 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 <palacios/vmm_list.h>
+#include <palacios/vmm_io.h>
+#include <palacios/vmm_dev_mgr.h>
-
-
-#ifndef DEBUG_GENERIC
+#ifndef CONFIG_DEBUG_GENERIC
#undef PrintDebug
#define PrintDebug(fmt, args...)
#endif
-#define PORT_HOOKS 1
-#define MEM_HOOKS 0 // not yet implmented in device model
-#define IRQ_HOOKS 0 // not yet implemented in device model
-
+typedef enum {GENERIC_IGNORE,
+ GENERIC_PASSTHROUGH,
+ GENERIC_PRINT_AND_PASSTHROUGH,
+ GENERIC_PRINT_AND_IGNORE} generic_mode_t;
struct generic_internal {
- 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 list_head port_list;
+ uint_t num_port_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;
+struct port_range {
+ uint_t start;
+ uint_t end;
+ generic_mode_t mode;
+ struct list_head range_link;
};
-int generic_reset_device(struct vm_device * dev)
-{
- PrintDebug("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)
-{
- PrintDebug("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)
-{
- PrintDebug("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_passthrough(ushort_t port,
- void * src,
- uint_t length,
- struct vm_device * dev)
-{
- uint_t i;
-
- PrintDebug("generic: writing 0x");
-
- for (i = 0; i < length; i++) {
- PrintDebug("%x", ((uchar_t*)src)[i]);
- }
-
- PrintDebug(" to port 0x%x ... ", port);
-
-
- switch (length) {
- case 1:
+static int generic_write_port_passthrough(uint16_t port, void * src,
+ uint_t length, struct vm_device * dev) {
+ uint_t i;
- 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]);
+ PrintDebug("generic: writing 0x");
- break;
- default:
for (i = 0; i < length; i++) {
- v3_outb(port, ((uchar_t*)src)[i]);
+ PrintDebug("%x", ((uchar_t*)src)[i]);
}
- } //switch length
-
-
- PrintDebug(" done\n");
- return length;
-}
-
-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);
-
+ PrintDebug(" to port 0x%x ... ", 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;
-}
-
-int generic_write_port_ignore(ushort_t port,
- void * src,
- uint_t length,
- struct vm_device * dev)
-{
- uint_t i;
-
- PrintDebug("generic: writing 0x");
+ case 1:
+ v3_outb(port,((uchar_t*)src)[0]);
+ break;
+ case 2:
+ v3_outw(port,((uint16_t*)src)[0]);
+ break;
+ case 4:
+ v3_outdw(port,((uint32_t *)src)[0]);
+ break;
+ default:
+ for (i = 0; i < length; i++) {
+ v3_outb(port, ((uchar_t *)src)[i]);
+ }
+ }
- for (i = 0; i < length; i++) {
- PrintDebug("%x", ((uchar_t*)src)[i]);
- }
+ PrintDebug(" done\n");
- PrintDebug(" to port 0x%x ... ignored\n", port);
-
- return length;
+ return length;
}
-int generic_read_port_ignore(ushort_t port,
- void * src,
- uint_t length,
- struct vm_device * dev)
-{
+static int generic_read_port_passthrough(uint16_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);
-
- memset((char*)src, 0, length);
- PrintDebug(" ignored (return zeroed buffer)\n");
-
- return length;
-}
+ PrintDebug("generic: reading 0x%x bytes from port 0x%x ...", length, port);
-
-int generic_interrupt(uint_t irq, struct vm_device * dev) {
- PrintDebug("generic: interrupt 0x%x - injecting into VM\n", irq);
-
- dev->vm->vm_ops.raise_irq(dev->vm, irq);
-
- return 0;
-}
-
-
-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 %x\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 (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 (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);
- }
- }
- }
-
+ switch (length) {
+ case 1:
+ ((uchar_t*)src)[0] = v3_inb(port);
+ break;
+ case 2:
+ ((uint16_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);
+ }
}
- } else {
- PrintDebug("generic: hooking ports not supported\n");
- }
-
-
-
- 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(" done ... read 0x");
- PrintDebug("generic: hooking addresses 0x%x to 0x%x\n",
- tmp->start, tmp->end);
-
-
- if (dev_hook_mem(dev, tmp->start, tmp->end)) {
- PrintDebug("generic: Can't hook addresses 0x%x to 0x%x (already hooked?)\n",
- tmp->start, tmp->end);
- }
+ for (i = 0; i < length; i++) {
+ PrintDebug("%x", ((uchar_t*)src)[i]);
}
- } else {
- PrintDebug("generic: hooking addresses not supported\n");
- }
+ PrintDebug("\n");
+ return length;
+}
+static int generic_write_port_ignore(uint16_t port, void * src,
+ uint_t length, struct vm_device * dev) {
+ uint_t i;
- 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 (dev_hook_irq(dev, i, &generic_interrupt)) {
- PrintDebug("generic: can't hook irq 0x%x (already hooked?)\n", i);
- }
- }
+ PrintDebug("generic: writing 0x");
+ for (i = 0; i < length; i++) {
+ PrintDebug("%x", ((uchar_t*)src)[i]);
}
- } else {
- PrintDebug("generic: hooking irqs not supported\n");
- }
-
-
-
- return 0;
+
+ PrintDebug(" to port 0x%x ... ignored\n", port);
+
+ return length;
}
-int generic_deinit_device(struct vm_device * dev) {
- struct generic_internal * state = (struct generic_internal *)(dev->private_data);
-
-
- PrintDebug("generic: deinit_device\n");
-
+static int generic_read_port_ignore(uint16_t port, void * src,
+ uint_t length, struct vm_device * dev) {
- 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);
-
+ PrintDebug("generic: reading 0x%x bytes from port 0x%x ...", length, port);
- for (i = cur->start; i <= cur->end; i++) {
- if (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");
- }
+ memset((char*)src, 0, length);
+ PrintDebug(" ignored (return zeroed buffer)\n");
+ return length;
+}
- 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%x to 0x%x\n",
- cur->start, cur->end);
- if (dev_unhook_mem(dev, cur->start, cur->end)) {
- PrintDebug("generic: Can't unhook addresses 0x%x to 0x%x (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");
- }
-
- if (PORT_HOOKS) {
+static int generic_free(struct vm_device * dev) {
+ struct generic_internal * state = (struct generic_internal *)(dev->private_data);
struct port_range * tmp;
struct port_range * cur;
-
+
+ PrintDebug("generic: deinit_device\n");
+
list_for_each_entry_safe(cur, tmp, &(state->port_list), range_link) {
- uint_t i;
+ uint_t i;
- PrintDebug("generic: unhooking ports 0x%x to 0x%x\n",
+ PrintDebug("generic: unhooking ports 0x%x to 0x%x\n",
cur->start, cur->end);
-
- for (i = cur->start; i <= cur->end; i++) {
- if (dev_unhook_io(dev, i)) {
- PrintDebug("generic: can't unhook port 0x%x (already unhooked?)\n", i);
+
+ 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);
+ list_del(&(cur->range_link));
+ state->num_port_ranges--;
+ V3_Free(cur);
}
- } else {
- PrintDebug("generic: unhooking ports not supported\n");
- }
-
-
- 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,
+static struct v3_device_ops dev_ops = {
+ .free = generic_free,
+ .reset = generic_reset_device,
+ .start = generic_start_device,
+ .stop = generic_stop_device,
};
-int v3_generic_add_port_range(struct vm_device * dev, uint_t start, uint_t end, uint_t type) {
-
- if (PORT_HOOKS) {
+static int add_port_range(struct vm_device * dev, uint_t start, uint_t end, generic_mode_t mode) {
struct generic_internal * state = (struct generic_internal *)(dev->private_data);
-
struct port_range * range = (struct port_range *)V3_Malloc(sizeof(struct port_range));
+ uint_t i = 0;
+
range->start = start;
range->end = end;
- range->type = type;
-
+ range->mode = mode;
- PrintDebug("generic: Adding Port Range: 0x%x to 0x%x as %x\n",
- range->start, range->end,
- (range->type == GENERIC_PRINT_AND_PASSTHROUGH) ? "print-and-passthrough" : "print-and-ignore");
+ PrintDebug("generic: Adding Port Range: 0x%x to 0x%x as %s\n",
+ start, end,
+ (mode == GENERIC_PRINT_AND_PASSTHROUGH) ? "print-and-passthrough" : "print-and-ignore");
+ for (i = start; i <= end; i++) {
+ if (mode == GENERIC_PRINT_AND_PASSTHROUGH) {
+ if (v3_dev_hook_io(dev, i, &generic_read_port_passthrough, &generic_write_port_passthrough) == -1) {
+ PrintError("generic: can't hook port 0x%x (already hooked?)\n", i);
+ return -1;
+ }
+ } else if (mode == GENERIC_PRINT_AND_IGNORE) {
+ if (v3_dev_hook_io(dev, i, &generic_read_port_ignore, &generic_write_port_ignore) == -1) {
+ PrintError("generic: can't hook port 0x%x (already hooked?)\n", i);
+ return -1;
+ }
+ }
+ }
+
list_add(&(range->range_link), &(state->port_list));
state->num_port_ranges++;
- } else {
- PrintDebug("generic: hooking IO ports not supported\n");
- return -1;
- }
-
- return 0;
+
+ return 0;
}
-int v3_generic_add_mem_range(struct vm_device * dev, void * start, void * end, uint_t type) {
- 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) {
+static int generic_init(struct guest_info * vm, v3_cfg_tree_t * cfg) {
+ struct generic_internal * state = (struct generic_internal *)V3_Malloc(sizeof(struct generic_internal));
+ char * name = v3_cfg_val(cfg, "name");
- 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;
- }
+ v3_cfg_tree_t * port_cfg = v3_cfg_subtree(cfg, "ports");
- return 0;
-}
+ INIT_LIST_HEAD(&(state->port_list));
+ state->num_port_ranges = 0;
+
+ struct vm_device * dev = v3_allocate_device(name, &dev_ops, state);
-struct vm_device * 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;
+ if (v3_attach_device(vm, dev) == -1) {
+ PrintError("Could not attach device %s\n", name);
+ return -1;
+ }
- 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 = create_device("GENERIC", &dev_ops, generic_state);
+ PrintDebug("generic: init_device\n");
+ generic_reset_device(dev);
+
+ // scan port list....
+ while (port_cfg) {
+ uint16_t start = atox(v3_cfg_val(port_cfg, "start"));
+ uint16_t end = atox(v3_cfg_val(port_cfg, "end"));
+ char * mode_str = v3_cfg_val(port_cfg, "mode");
+ generic_mode_t mode = GENERIC_IGNORE;
+
+ if (strcasecmp(mode_str, "print_and_ignore") == 0) {
+ mode = GENERIC_PRINT_AND_IGNORE;
+ } else if (strcasecmp(mode_str, "print_and_passthrough") == 0) {
+ mode = GENERIC_PRINT_AND_PASSTHROUGH;
+ } else {
+ PrintError("Invalid Mode %s\n", mode_str);
+ return -1;
+ }
+
+ if (add_port_range(dev, start, end, mode) == -1) {
+ PrintError("Could not add port range %d-%d\n", start, end);
+ return -1;
+ }
- return device;
+ port_cfg = v3_cfg_next_branch(port_cfg);
+ }
+
+
+ return 0;
}
+
+device_register("GENERIC", generic_init)
