Palacios Public Git Repository

To checkout Palacios execute

  git clone http://v3vee.org/palacios/palacios.web/palacios.git
This will give you the master branch. You probably want the devel branch or one of the release branches. To switch to the devel branch, simply execute
  cd palacios
  git checkout --track -b devel origin/devel
The other branches are similar.


Merge branch 'devel' of newskysaw.cs.northwestern.edu:/home/palacios/palacios into...
[palacios.git] / palacios / src / devices / 8254.c
index fd9ab38..1a44399 100644 (file)
  * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
  */
 
-#include <devices/8254.h>
+
 #include <palacios/vmm.h>
+#include <palacios/vmm_dev_mgr.h>
 #include <palacios/vmm_time.h>
 #include <palacios/vmm_util.h>
 #include <palacios/vmm_intr.h>
+#include <palacios/vmm_config.h>
+#include <palacios/vmm_io.h>
 
 
-
-#ifndef DEBUG_PIT
+#ifndef V3_CONFIG_DEBUG_PIT
 #undef PrintDebug
 #define PrintDebug(fmt, args...)
 #endif
 #define CHANNEL1_PORT 0x41
 #define CHANNEL2_PORT 0x42
 #define COMMAND_PORT 0x43
+#define SPEAKER_PORT 0x61
 
 
 #define PIT_INTR_NUM 0
+#define PIT_SPEAKER_GATE 0x01
 
 /* The order of these typedefs is important because the numerical values correspond to the 
  * values coming from the io ports
  */
 typedef enum {NOT_RUNNING, PENDING, RUNNING} channel_run_state_t;
 typedef enum {NOT_WAITING, WAITING_LOBYTE, WAITING_HIBYTE} channel_access_state_t;
-typedef enum {LATCH_COUNT, LOBYTE_ONLY, HIBYTE_ONLY, LOBYTE_HIBYTE} channel_access_mode_t;
-typedef enum {IRQ_ON_TERM_CNT, ONE_SHOT, RATE_GEN, SQR_WAVE, SW_STROBE, HW_STROBE} channel_op_mode_t;
+typedef enum {LATCH_COUNT = 0, LOBYTE_ONLY = 1, HIBYTE_ONLY = 2, LOBYTE_HIBYTE = 3} channel_access_mode_t;
+typedef enum {IRQ_ON_TERM_CNT = 0, ONE_SHOT = 1, RATE_GEN = 2, SQR_WAVE = 3, SW_STROBE = 4, HW_STROBE = 5} channel_op_mode_t;
 
 
 struct channel {
@@ -83,10 +87,14 @@ struct pit {
     ullong_t pit_counter;
     ullong_t pit_reload;
 
+    struct v3_timer * timer;
+
+    struct v3_vm_info * vm;
 
     struct channel ch_0;
     struct channel ch_1;
     struct channel ch_2;
+    uint8_t speaker;
 };
 
 
@@ -121,11 +129,12 @@ struct pit_rdb_status_word {
  * This should call out to handle_SQR_WAVE_tics, etc... 
  */
 // Returns true if the the output signal changed state
-static int handle_crystal_tics(struct vm_device * dev, struct channel * ch, uint_t oscillations) {
+static int handle_crystal_tics(struct pit * pit, struct channel * ch, uint_t oscillations) {
     uint_t channel_cycles = 0;
     uint_t output_changed = 0;
   
-    // PrintDebug("8254 PIT: %d crystal tics\n", oscillations);
+    //    PrintDebug("8254 PIT (channel %d): %d crystal tics\n", 
+    //        ch - pit->ch0, oscillations);
     if (ch->run_state == PENDING) {
        oscillations--;
        ch->counter = ch->reload_value;
@@ -150,14 +159,14 @@ static int handle_crystal_tics(struct vm_device * dev, struct channel * ch, uint
 
     if (ch->counter > oscillations) {
        ch->counter -= oscillations;
+       //PrintDebug("8254 PIT: Counter at %u after %u oscillations.\n", 
+       //   (unsigned int)ch->counter, oscillations);
        return output_changed;
     } else {
        ushort_t reload_val = ch->reload_value; 
 
-       // TODO: Check this....
-       // Is this correct???
-       if (reload_val == 0) {
-           reload_val = 1;
+       if ((ch->op_mode == SW_STROBE) || (ch->op_mode == IRQ_ON_TERM_CNT)) {
+           reload_val = 0xffff;
        }
 
        oscillations -= ch->counter;
@@ -168,27 +177,43 @@ static int handle_crystal_tics(struct vm_device * dev, struct channel * ch, uint
            reload_val -= reload_val % 2;
        }
 
+       // TODO: Check this....
+       // Is this correct???
+       if (reload_val == 0) {
+           reload_val = 1;
+       }
+
        channel_cycles += oscillations / reload_val;
        oscillations = oscillations % reload_val;
 
        ch->counter = reload_val - oscillations;
+       //      PrintDebug("8254 PIT: Counter reset to %u.\n", 
+       //   (unsigned int)ch->counter);
+
     }
 
-    //  PrintDebug("8254 PIT: Channel Cycles: %d\n", channel_cycles);
+    //PrintDebug("8254 PIT: Channel %ld (mode = %u) Cycles: %d\n", 
+              //(ch - &pit->ch_0), ch->op_mode, channel_cycles);
   
-
-
     switch (ch->op_mode) {
        case IRQ_ON_TERM_CNT:
-           if ((channel_cycles > 0) && (ch->output_pin == 0)) {
-               ch->output_pin = 1; 
-               output_changed = 1;
+           if (channel_cycles > 0) {
+               if (ch->output_pin == 0) {
+                   ch->output_pin = 1; 
+                   output_changed = 1;
+               } else {
+                  // PrintDebug("8254: Output not changed in TERM_CNT mode.\n");
+               }
            }
            break;
        case ONE_SHOT:
-           if ((channel_cycles > 0) && (ch->output_pin == 0)) {
-               ch->output_pin = 1; 
-               output_changed = 1;
+           if (channel_cycles > 0) {
+               if ((ch->output_pin == 0)) {
+                   ch->output_pin = 1; 
+                   output_changed = 1;
+               } else {
+                   // PrintDebug("8254: Output not changed in ONE_SHOT mode.\n");
+               }
            }
            break;
        case RATE_GEN:
@@ -204,11 +229,19 @@ static int handle_crystal_tics(struct vm_device * dev, struct channel * ch, uint
                output_changed = 1;
            }
 
+
            break;
        case SW_STROBE:
-           return -1;
+
+           if (channel_cycles > 0) {
+               if (ch->output_pin == 1) {
+                   ch->output_pin = 0;
+                   output_changed = 1;
+               }
+           }
            break;
        case HW_STROBE:
+           PrintError("Hardware strobe not implemented\n");
            return -1;
            break;
        default:
@@ -219,10 +252,10 @@ static int handle_crystal_tics(struct vm_device * dev, struct channel * ch, uint
 }
                                
 
+#include <palacios/vm_guest.h>
 
-static void pit_update_time(ullong_t cpu_cycles, ullong_t cpu_freq, void * private_data) {
-    struct vm_device * dev = (struct vm_device *)private_data;
-    struct pit * state = (struct pit *)dev->private_data;
+static void pit_update_timer(struct guest_info * info, ullong_t cpu_cycles, ullong_t cpu_freq, void * private_data) {
+    struct pit * state = (struct pit *)private_data;
     //  ullong_t tmp_ctr = state->pit_counter;
     ullong_t tmp_cycles;
     uint_t oscillations = 0;
@@ -280,25 +313,24 @@ static void pit_update_time(ullong_t cpu_cycles, ullong_t cpu_freq, void * priva
        // update counter with remainder (mod reload)
        state->pit_counter = state->pit_reload - cpu_cycles;    
 
-       //PrintDebug("8254 PIT: Handling %d crystal tics\n", oscillations);
-       if (handle_crystal_tics(dev, &(state->ch_0), oscillations) == 1) {
-           // raise interrupt
-           PrintDebug("8254 PIT: Injecting Timer interrupt to guest\n");
-           v3_raise_irq(dev->vm, 0);
-       }
-
-       //handle_crystal_tics(dev, &(state->ch_1), oscillations);
-       //handle_crystal_tics(dev, &(state->ch_2), oscillations);
-    }
-  
+       if (oscillations) {
+           //    PrintDebug("8254 PIT: Handling %d crystal tics\n", oscillations);
 
+           if (handle_crystal_tics(state, &(state->ch_0), oscillations) == 1) {
+               // raise interrupt
+               PrintDebug("8254 PIT: Injecting Timer interrupt to guest (run_state = %d)\n",
+                          state->ch_0.run_state);
+               v3_raise_irq(info->vm_info, 0);
+           }
 
+           //handle_crystal_tics(state, &(state->ch_1), oscillations);
+           handle_crystal_tics(state, &(state->ch_2), oscillations);
+       }
+    }
  
     return;
 }
 
-
-
 /* This should call out to handle_SQR_WAVE_write, etc...
  */
 static int handle_channel_write(struct channel * ch, char val) {
@@ -337,6 +369,7 @@ static int handle_channel_write(struct channel * ch, char val) {
            PrintDebug("8254 PIT: Channel Run State=%d\n", ch->run_state);
            break;
        default:
+           PrintError("Invalid Access state\n");
            return -1;
     }
     
@@ -354,7 +387,11 @@ static int handle_channel_write(struct channel * ch, char val) {
        case SQR_WAVE:
            ch->output_pin = 1;
            break;
+       case SW_STROBE:
+           ch->output_pin = 1;
+           break;
        default:
+           PrintError("Invalid OP_MODE: %d\n", ch->op_mode);
            return -1;
            break;
     }
@@ -389,16 +426,37 @@ static int handle_channel_read(struct channel * ch, char * val) {
 
 }
 
+static int handle_speaker_read(uint8_t *speaker, struct channel * ch, char * val) {
+    *val = *speaker;
 
+    if ((*speaker & PIT_SPEAKER_GATE)) {
+       *val |= (ch->output_pin << 5);
+    }
+    
+    return 0;
+}
 
-
+static int handle_speaker_write(uint8_t *speaker, struct channel * ch, char val) {
+    *speaker = (val & ~0x20);
+    return 0;
+}
 
 static int handle_channel_cmd(struct channel * ch, struct pit_cmd_word cmd) {
-    ch->op_mode = cmd.op_mode;
-    ch->access_mode = cmd.access_mode;
 
+    if (cmd.op_mode != ch->op_mode) {
+       PrintDebug("8254 PIT: Changing channel from op mode %d to op mode %d.\n", 
+                  ch->op_mode, cmd.op_mode);
+    }
 
+    if (cmd.access_mode != 0) {
+      ch->op_mode = cmd.op_mode;
+    }
 
+    if (cmd.access_mode != ch->access_mode) {
+       PrintDebug("8254 PIT: Changing channel from access mode %d to access mode %d.\n", 
+                  ch->access_mode, cmd.access_mode);
+    }
+    ch->access_mode = cmd.access_mode;
 
     switch (cmd.access_mode) {
        case LATCH_COUNT:
@@ -430,7 +488,11 @@ static int handle_channel_cmd(struct channel * ch, struct pit_cmd_word cmd) {
        case SQR_WAVE:
            ch->output_pin = 1;
            break;
+       case SW_STROBE:
+           ch->output_pin = 1;
+           break;
        default:
+           PrintError("Invalid OP_MODE: %d\n", cmd.op_mode);
            return -1;
     }
 
@@ -441,8 +503,8 @@ static int handle_channel_cmd(struct channel * ch, struct pit_cmd_word cmd) {
 
 
 
-static int pit_read_channel(ushort_t port, void * dst, uint_t length, struct vm_device * dev) {
-    struct pit * state = (struct pit *)dev->private_data;
+static int pit_read_channel(struct guest_info * core, ushort_t port, void * dst, uint_t length, void * priv_data) {
+    struct pit * state = (struct pit *)priv_data;
     char * val = (char *)dst;
 
     if (length != 1) {
@@ -455,16 +517,25 @@ static int pit_read_channel(ushort_t port, void * dst, uint_t length, struct vm_
     switch (port) {
        case CHANNEL0_PORT: 
            if (handle_channel_read(&(state->ch_0), val) == -1) {
+               PrintError("CHANNEL0 read error\n");
                return -1;
            }
            break;
        case CHANNEL1_PORT:
            if (handle_channel_read(&(state->ch_1), val) == -1) {
+               PrintError("CHANNEL1 read error\n");
                return -1;
            }
            break;
        case CHANNEL2_PORT:
            if (handle_channel_read(&(state->ch_2), val) == -1) {
+               PrintError("CHANNEL2 read error\n");
+               return -1;
+           }
+           break;
+       case SPEAKER_PORT:
+           if (handle_speaker_read(&state->speaker, &(state->ch_2), val) == -1) {
+               PrintError("SPEAKER read error\n");
                return -1;
            }
            break;
@@ -478,8 +549,8 @@ static int pit_read_channel(ushort_t port, void * dst, uint_t length, struct vm_
 
 
 
-static int pit_write_channel(ushort_t port, void * src, uint_t length, struct vm_device * dev) {
-    struct pit * state = (struct pit *)dev->private_data;
+static int pit_write_channel(struct guest_info * core, ushort_t port, void * src, uint_t length, void * priv_data) {
+    struct pit * state = (struct pit *)priv_data;
     char val = *(char *)src;
 
     if (length != 1) {
@@ -493,16 +564,25 @@ static int pit_write_channel(ushort_t port, void * src, uint_t length, struct vm
     switch (port) {
        case CHANNEL0_PORT:
            if (handle_channel_write(&(state->ch_0), val) == -1) {
+               PrintError("CHANNEL0 write error\n");
                return -1;
            } 
            break;
        case CHANNEL1_PORT:
            if (handle_channel_write(&(state->ch_1), val) == -1) {
+               PrintError("CHANNEL1 write error\n");
                return -1;
            }
            break;
        case CHANNEL2_PORT:
            if (handle_channel_write(&(state->ch_2), val) == -1) {
+               PrintError("CHANNEL2 write error\n");   
+               return -1;
+           }
+           break;
+       case SPEAKER_PORT:
+           if (handle_speaker_write(&state->speaker, &(state->ch_2), val) == -1) {
+               PrintError("SPEAKER write error\n");
                return -1;
            }
            break;
@@ -517,8 +597,8 @@ static int pit_write_channel(ushort_t port, void * src, uint_t length, struct vm
 
 
 
-static int pit_write_command(ushort_t port, void * src, uint_t length, struct vm_device * dev) {
-    struct pit * state = (struct pit *)dev->private_data;
+static int pit_write_command(struct guest_info * core, ushort_t port, void * src, uint_t length, void * priv_data) {
+    struct pit * state = (struct pit *)priv_data;
     struct pit_cmd_word * cmd = (struct pit_cmd_word *)src;
 
     PrintDebug("8254 PIT: Write to PIT Command port\n");
@@ -531,21 +611,25 @@ static int pit_write_command(ushort_t port, void * src, uint_t length, struct vm
     switch (cmd->channel) {
        case 0:
            if (handle_channel_cmd(&(state->ch_0), *cmd) == -1) {
+               PrintError("CHANNEL0 command error\n");
                return -1;
            }
            break;
        case 1:
            if (handle_channel_cmd(&(state->ch_1), *cmd) == -1) {
+               PrintError("CHANNEL1 command error\n");
                return -1;
            }
            break;
        case 2:
            if (handle_channel_cmd(&(state->ch_2), *cmd) == -1) {
+               PrintError("CHANNEL2 command error\n");
                return -1;
            }
            break;
        case 3:
            // Read Back command
+           PrintError("Read back command not implemented\n");
            return -1;
            break;
        default:
@@ -559,8 +643,8 @@ static int pit_write_command(ushort_t port, void * src, uint_t length, struct vm
 
 
 
-static struct vm_timer_ops timer_ops = {
-    .update_time = pit_update_time,
+static struct v3_timer_ops timer_ops = {
+    .update_timer = pit_update_timer,
 };
 
 
@@ -583,67 +667,132 @@ static void init_channel(struct channel * ch) {
 }
 
 
-static int pit_init(struct vm_device * dev) {
-    struct pit * state = (struct pit *)dev->private_data;
-    uint_t cpu_khz = V3_CPU_KHZ();
-    ullong_t reload_val = (ullong_t)cpu_khz * 1000;
 
-    v3_dev_hook_io(dev, CHANNEL0_PORT, &pit_read_channel, &pit_write_channel);
-    v3_dev_hook_io(dev, CHANNEL1_PORT, &pit_read_channel, &pit_write_channel);
-    v3_dev_hook_io(dev, CHANNEL2_PORT, &pit_read_channel, &pit_write_channel);
-    v3_dev_hook_io(dev, COMMAND_PORT, NULL, &pit_write_command);
 
-#ifdef DEBUG_PIT
-    PrintDebug("8254 PIT: OSC_HZ=%d, reload_val=", OSC_HZ);
-    PrintTraceLL(reload_val);
-    PrintDebug("\n");
+static int pit_free(void * private_data) {
+    struct pit * state = (struct pit *)private_data;
+    struct guest_info * info = &(state->vm->cores[0]);
+
+
+    if (state->timer) {
+       v3_remove_timer(info, state->timer);
+    }
+    V3_Free(state);
+    return 0;
+}
+
+#ifdef V3_CONFIG_CHECKPOINT
+static int pit_save(struct v3_chkpt_ctx * ctx, void * private_data) {
+    struct pit * pit_state = (struct pit *)private_data; 
+
+    V3_CHKPT_STD_SAVE(ctx, pit_state->pit_counter);
+    V3_CHKPT_STD_SAVE(ctx, pit_state->pit_reload);
+    V3_CHKPT_STD_SAVE(ctx, pit_state->ch_0);
+    V3_CHKPT_STD_SAVE(ctx, pit_state->ch_1);
+    V3_CHKPT_STD_SAVE(ctx, pit_state->ch_2);
+    V3_CHKPT_STD_SAVE(ctx, pit_state->speaker);
+    
+    return 0;
+}
+
+static int pit_load(struct v3_chkpt_ctx * ctx, void * private_data) {
+    struct pit * pit_state = (struct pit *)private_data;
+
+    V3_CHKPT_STD_LOAD(ctx, pit_state->pit_counter);
+    V3_CHKPT_STD_LOAD(ctx, pit_state->pit_reload);
+    V3_CHKPT_STD_LOAD(ctx, pit_state->ch_0);
+    V3_CHKPT_STD_LOAD(ctx, pit_state->ch_1);
+    V3_CHKPT_STD_LOAD(ctx, pit_state->ch_2);
+    V3_CHKPT_STD_LOAD(ctx, pit_state->speaker);
+
+    return 0;
+}
 #endif
 
-    v3_add_timer(dev->vm, &timer_ops, dev);
+static struct v3_device_ops dev_ops = {
+    .free = (int (*)(void *))pit_free,
+#ifdef V3_CONFIG_CHECKPOINT
+    .save = pit_save,
+    .load = pit_load,
+#endif
+};
 
-    // Get cpu frequency and calculate the global pit oscilattor counter/cycle
+#include <palacios/vm_guest.h>
 
-    do_divll(reload_val, OSC_HZ);
-    state->pit_counter = reload_val;
-    state->pit_reload = reload_val;
+static int pit_init(struct v3_vm_info * vm, v3_cfg_tree_t * cfg) {
+    struct pit * pit_state = NULL;
+    struct vm_device * dev = NULL;
+    char * dev_id = v3_cfg_val(cfg, "ID");
+    int ret = 0;
 
+    // PIT is only usable in non-multicore environments
+    // just hardcode the core context
+    struct guest_info * info = &(vm->cores[0]);
 
+    uint_t cpu_khz = info->time_state.guest_cpu_freq;
+    ullong_t reload_val = (ullong_t)cpu_khz * 1000;
 
-    init_channel(&(state->ch_0));
-    init_channel(&(state->ch_1));
-    init_channel(&(state->ch_2));
+    pit_state = (struct pit *)V3_Malloc(sizeof(struct pit));
 
-#ifdef DEBUG_PIT
-    PrintDebug("8254 PIT: CPU MHZ=%d -- pit count=", cpu_khz / 1000);
-    PrintTraceLL(state->pit_counter);
+    V3_ASSERT(pit_state != NULL);
+    pit_state->speaker = 0;
+    pit_state->vm = vm;
+
+    dev = v3_add_device(vm, dev_id, &dev_ops, pit_state);
+
+    if (dev == NULL) {
+       PrintError("Could not attach device %s\n", dev_id);
+       V3_Free(pit_state);
+       return -1;
+    }
+
+    ret |= v3_dev_hook_io(dev, CHANNEL0_PORT, &pit_read_channel, &pit_write_channel);
+    ret |= v3_dev_hook_io(dev, CHANNEL1_PORT, &pit_read_channel, &pit_write_channel);
+    ret |= v3_dev_hook_io(dev, CHANNEL2_PORT, &pit_read_channel, &pit_write_channel);
+    ret |= v3_dev_hook_io(dev, COMMAND_PORT, NULL, &pit_write_command);
+    ret |= v3_dev_hook_io(dev, SPEAKER_PORT, &pit_read_channel, &pit_write_channel);
+
+    if (ret != 0) {
+       PrintError("8254 PIT: Failed to hook IO ports\n");
+       v3_remove_device(dev);
+       return -1;
+    }
+
+#ifdef V3_CONFIG_DEBUG_PIT
+    PrintDebug("8254 PIT: OSC_HZ=%d, reload_val=", OSC_HZ);
+    //PrintTrace(reload_val);
     PrintDebug("\n");
 #endif
 
-    return 0;
-}
+    
 
-static int pit_deinit(struct vm_device * dev) {
+    pit_state->timer = v3_add_timer(info, &timer_ops, pit_state);
 
-    return 0;
-}
+    if (pit_state->timer == NULL) {
+       v3_remove_device(dev);
+       return -1;
+    }
 
+    // Get cpu frequency and calculate the global pit oscilattor counter/cycle
 
-static struct vm_device_ops dev_ops = {
-    .init = pit_init,
-    .deinit = pit_deinit,
-    .reset = NULL,
-    .start = NULL,
-    .stop = NULL,
+    do_divll(reload_val, OSC_HZ);
+    pit_state->pit_counter = reload_val;
+    pit_state->pit_reload = reload_val;
 
-};
 
+    init_channel(&(pit_state->ch_0));
+    init_channel(&(pit_state->ch_1));
+    init_channel(&(pit_state->ch_2));
 
-struct vm_device * v3_create_pit() {
-    struct pit * pit_state = NULL;
-    pit_state = (struct pit *)V3_Malloc(sizeof(struct pit));
-    V3_ASSERT(pit_state != NULL);
+#ifdef V3_CONFIG_DEBUG_PIT
+    PrintDebug("8254 PIT: CPU MHZ=%d -- pit count=", cpu_khz / 1000);
+    //PrintTraceLL(pit_state->pit_counter);
+    PrintDebug("\n");
+#endif
 
-    struct vm_device * dev = v3_create_device("PIT", &dev_ops, pit_state);
-  
-    return dev;
+    return 0;
 }
+
+
+device_register("8254_PIT", pit_init);