-#include <devices/generic.h>
-#include <geekos/io.h>
+/*
+ * 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 <palacios/vmm.h>
#include <palacios/vmm_types.h>
+#include <palacios/vmm_list.h>
+#include <palacios/vmm_io.h>
+#include <palacios/vmm_dev_mgr.h>
-
-
-#define GENERIC_DEBUG 1
-
-#if GENERIC_DEBUG
-#define GENERIC_DEBUG_PRINT(first, rest...) do { SerialPrint(first, ## rest ); } while (0)
-#else
-#define GENERIC_DEBUG_PRINT(first, rest...)
+#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
-
-extern struct vmm_os_hooks *os_hooks;
-
-extern void SerialPrint(const char *format, ...);
-
-
+typedef enum {GENERIC_IGNORE,
+ GENERIC_PASSTHROUGH,
+ GENERIC_PRINT_AND_PASSTHROUGH,
+ GENERIC_PRINT_AND_IGNORE} generic_mode_t;
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;
};
-
-
-
+static int generic_write_port_passthrough(struct guest_info * core, uint16_t port, void * src,
+ uint_t length, void * priv_data) {
+ uint_t i;
-int generic_reset_device(struct vm_device * dev)
-{
- GENERIC_DEBUG_PRINT("generic: reset device\n");
-
- return 0;
+ switch (length) {
+ case 1:
+ v3_outb(port, ((uint8_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, ((uint8_t *)src)[i]);
+ }
+ }
+ return length;
}
+static int generic_write_port_print_and_passthrough(struct guest_info * core, uint16_t port, void * src,
+ uint_t length, void * priv_data) {
+ uint_t i;
+ int rc;
+ PrintDebug("generic: writing 0x");
+ for (i = 0; i < length; i++) {
+ PrintDebug("%x", ((uint8_t *)src)[i]);
+ }
+
+ PrintDebug(" to port 0x%x ... ", port);
+ rc=generic_write_port_passthrough(core,port,src,length,priv_data);
-int generic_start_device(struct vm_device *dev)
-{
- GENERIC_DEBUG_PRINT("generic: start device\n");
- return 0;
+ PrintDebug(" done\n");
+
+ return rc;
}
+static int generic_read_port_passthrough(struct guest_info * core, uint16_t port, void * src,
+ uint_t length, void * priv_data) {
+ uint_t i;
+
+ switch (length) {
+ case 1:
+ ((uint8_t *)src)[0] = v3_inb(port);
+ break;
+ case 2:
+ ((uint16_t *)src)[0] = v3_inw(port);
+ break;
+ case 4:
+ ((uint32_t *)src)[0] = v3_indw(port);
+ break;
+ default:
+ for (i = 0; i < length; i++) {
+ ((uint8_t *)src)[i] = v3_inb(port);
+ }
+ }
-int generic_stop_device(struct vm_device *dev)
-{
- GENERIC_DEBUG_PRINT("generic: stop device\n");
- return 0;
+ return length;
}
+static int generic_read_port_print_and_passthrough(struct guest_info * core, uint16_t port, void * src,
+ uint_t length, void * priv_data) {
+ uint_t i;
+ int rc;
+
+ PrintDebug("generic: reading 0x%x bytes from port 0x%x ...", length, port);
+ rc=generic_read_port_passthrough(core,port,src,length,priv_data);
-int generic_write_port(ushort_t port,
- void * src,
- uint_t length,
- struct vm_device * dev)
-{
- uint_t i;
+ PrintDebug(" done ... read 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");
-
- return length;
-}
+ for (i = 0; i < rc; i++) {
+ PrintDebug("%x", ((uint8_t *)src)[i]);
+ }
-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;
+ PrintDebug("\n");
+
+ return rc;
}
+static int generic_read_port_ignore(struct guest_info * core, uint16_t port, void * src,
+ uint_t length, void * priv_data) {
+
+ memset((uint8_t *)src, 0, length);
-int generic_interrupt(uint_t irq,
- struct vm_device * dev)
-{
- PrintDebug("generic: interrupt 0x%x - injecting into VM\n",irq);
+ return length;
+}
- dev->vm->vm_ops.raise_irq(dev->vm,irq,0);
+static int generic_read_port_print_and_ignore(struct guest_info * core, uint16_t port, void * src,
+ uint_t length, void * priv_data) {
+
+ PrintDebug("generic: reading 0x%x bytes from port 0x%x ...", length, port);
- return 0;
+ memset((uint8_t *)src, 0, length);
+ PrintDebug(" ignored (return zeroed buffer)\n");
+ return length;
}
+static int generic_write_port_ignore(struct guest_info * core, uint16_t port, void * src,
+ uint_t length, void * priv_data) {
-int generic_init_device(struct vm_device * dev)
-{
- struct generic_internal *state = (struct generic_internal *) dev->private_data;
- uint_t i,j;
+ return length;
+}
- GENERIC_DEBUG_PRINT("generic: init_device\n");
+static int generic_write_port_print_and_ignore(struct guest_info * core, uint16_t port, void * src,
+ uint_t length, void * priv_data) {
+ int i;
- // Would read state here
+ PrintDebug("generic: writing 0x%x bytes to port 0x%x ", length, port);
- generic_reset_device(dev);
+ memset((uint8_t *)src, 0, length);
+ PrintDebug(" ignored - data was: 0x");
- 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);
- }
+ for (i = 0; i < length; i++) {
+ PrintDebug("%x", ((uint8_t *)src)[i]);
}
-#else
- GENERIC_DEBUG_PRINT("generic: hooking ports not supported\n");
-#endif
+
+ PrintDebug("\n");
- }
+ return length;
+}
- 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]);
- }
-#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);
- }
- }
-#else
- GENERIC_DEBUG_PRINT("generic: hooking irqs not supported\n");
-#endif
- }
- return 0;
+static int generic_free(struct generic_internal * state) {
+ PrintDebug("generic: deinit_device\n");
+
+ V3_Free(state);
+ return 0;
}
-int generic_deinit_device(struct vm_device *dev)
-{
- struct generic_internal *state = (struct generic_internal *) dev->private_data;
- uint_t i,j;
- GENERIC_DEBUG_PRINT("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);
- }
- }
-#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]);
- }
-#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);
- }
- }
-#else
- GENERIC_DEBUG_PRINT("generic: unhooking ports not supported\n");
-#endif
+static struct v3_device_ops dev_ops = {
+ .free = (int (*)(void *))generic_free,
+};
- }
- generic_reset_device(dev);
- return 0;
-}
+static int add_port_range(struct vm_device * dev, uint_t start, uint_t end, generic_mode_t mode) {
+ uint_t i = 0;
+ 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_print_and_passthrough,
+ &generic_write_port_print_and_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_print_and_ignore,
+ &generic_write_port_print_and_ignore) == -1) {
+ PrintError("generic: can't hook port 0x%x (already hooked?)\n", i);
+ return -1;
+ }
+ } else if (mode == GENERIC_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_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;
+ }
+ }
+ }
+
+ 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 int generic_init(struct v3_vm_info * vm, v3_cfg_tree_t * cfg) {
+ struct generic_internal * state = NULL;
+ char * dev_id = v3_cfg_val(cfg, "ID");
+ v3_cfg_tree_t * port_cfg = v3_cfg_subtree(cfg, "ports");
-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 = os_hooks->malloc(sizeof(struct generic_internal));
+ state = (struct generic_internal *)V3_Malloc(sizeof(struct generic_internal));
- generic_state->num_port_ranges=num_port_ranges;
- if (num_port_ranges>0) {
- generic_state->port_ranges = os_hooks->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;
- }
+ if (state == NULL) {
+ PrintError("Could not allocate generic state\n");
+ return -1;
+ }
+
+ memset(state, 0, sizeof(struct generic_internal));
+
+ struct vm_device * dev = v3_add_device(vm, dev_id, &dev_ops, state);
- generic_state->num_address_ranges=num_address_ranges;
- if (num_address_ranges>0) {
- generic_state->address_ranges = os_hooks->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 = os_hooks->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;
- }
+ if (dev == NULL) {
+ PrintError("Could not attach device %s\n", dev_id);
+ V3_Free(state);
+ return -1;
+ }
+ PrintDebug("generic: init_device\n");
+
+ // 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 if (strcasecmp(mode_str, "passthrough") == 0) {
+ mode = GENERIC_PASSTHROUGH;
+ } else if (strcasecmp(mode_str, "ignore") == 0) {
+ mode = GENERIC_IGNORE;
+ } else {
+ PrintError("Invalid Mode %s\n", mode_str);
+ v3_remove_device(dev);
+ return -1;
+ }
+
+ if (add_port_range(dev, start, end, mode) == -1) {
+ PrintError("Could not add port range %d-%d\n", start, end);
+ v3_remove_device(dev);
+ return -1;
+ }
+
+ port_cfg = v3_cfg_next_branch(port_cfg);
+ }
- struct vm_device *device = create_device("GENERIC", &dev_ops, generic_state);
- return device;
+ return 0;
}
+
+device_register("GENERIC", generic_init)
