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.


Cleanup and sanity-checking of divide-by-zero and floating point use bugs (Coverity...
[palacios.git] / palacios / src / devices / 8254.c
index 7757691..69fe0e7 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 {
-  channel_access_mode_t access_mode;
-  channel_access_state_t access_state;
-  channel_run_state_t run_state;
+    channel_access_mode_t access_mode;
+    channel_access_state_t access_state;
+    channel_run_state_t run_state;
 
-  channel_op_mode_t op_mode;
+    channel_op_mode_t op_mode;
 
 
-  // Time til interrupt trigger 
+    // Time til interrupt trigger 
 
-  ushort_t counter;
-  ushort_t reload_value;
+    ushort_t counter;
+    ushort_t reload_value;
 
-  ushort_t latched_value;
+    ushort_t latched_value;
   
-  enum {NOTLATCHED, LATCHED} latch_state;
+    enum {NOTLATCHED, LATCHED} latch_state;
 
-  enum {LSB, MSB} read_state;
+    enum {LSB, MSB} read_state;
 
-  uint_t output_pin : 1;
-  uint_t gate_input_pin : 1;
+    uint_t output_pin : 1;
+    uint_t gate_input_pin : 1;
 };
 
 
 struct pit {
 
-  ullong_t pit_counter;
-  ullong_t pit_reload;
+    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;
+    struct channel ch_0;
+    struct channel ch_1;
+    struct channel ch_2;
+    uint8_t speaker;
 };
 
 
 struct pit_cmd_word {
-  uint_t bcd_mode    : 1;
-  uint_t op_mode     : 3;
-  uint_t access_mode : 2;
-  uint_t channel     : 2;
+    uint_t bcd_mode    : 1;
+    uint_t op_mode     : 3;
+    uint_t access_mode : 2;
+    uint_t channel     : 2;
 };
 
 struct pit_rdb_cmd_word {
-  uint_t rsvd         : 1; // SBZ
-  uint_t ch_0         : 1;
-  uint_t ch_1         : 1;
-  uint_t ch_2         : 1;
-  uint_t latch_status : 1;
-  uint_t latch_count  : 1;
-  uint_t readback_cmd : 2; // Must Be 0x3
+    uint_t rsvd         : 1; // SBZ
+    uint_t ch_0         : 1;
+    uint_t ch_1         : 1;
+    uint_t ch_2         : 1;
+    uint_t latch_status : 1;
+    uint_t latch_count  : 1;
+    uint_t readback_cmd : 2; // Must Be 0x3
 };
 
 struct pit_rdb_status_word {
-  uint_t bcd_mode     : 1;
-  uint_t op_mode      : 3;
-  uint_t access_mode  : 2;
-  uint_t null_count   : 1;
-  uint_t pin_state    : 1; 
+    uint_t bcd_mode     : 1;
+    uint_t op_mode      : 3;
+    uint_t access_mode  : 2;
+    uint_t null_count   : 1;
+    uint_t pin_state    : 1; 
 };
 
 
@@ -121,507 +129,765 @@ 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) {
-  uint_t channel_cycles = 0;
-  uint_t output_changed = 0;
+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);
-  if (ch->run_state == PENDING) {
-    oscillations--;
-    ch->counter = ch->reload_value;
+    //    PrintDebug(info->vm_info, info, "8254 PIT (channel %d): %d crystal tics\n", 
+    //        ch - pit->ch0, oscillations);
+    if (ch->run_state == PENDING) {
+       oscillations--;
+       ch->counter = ch->reload_value;
+
+       if (ch->op_mode == SQR_WAVE) {
+           ch->counter -= ch->counter % 2;
+       }
 
-    if (ch->op_mode == SQR_WAVE) {
-      ch->counter -= ch->counter % 2;
+       ch->run_state = RUNNING;
+    } else if (ch->run_state != RUNNING) {
+       return output_changed;
     }
 
-    ch->run_state = RUNNING;
-  } else if (ch->run_state != RUNNING) {
-    return output_changed;
-  }
-
-  /*
-  PrintDebug("8254 PIT: Channel Run State = %d, counter=", ch->run_state);
-  PrintTraceLL(ch->counter);
-  PrintDebug("\n");
-  */
-  if (ch->op_mode == SQR_WAVE) {
-    oscillations *= 2;
-  }
-
-  if (ch->counter > oscillations) {
-    ch->counter -= oscillations;
-    return output_changed;
-  } else {
-    ushort_t reload_val = ch->reload_value; 
-    oscillations -= ch->counter;
-    ch->counter = 0;
-    channel_cycles = 1;
-
-    
+    /*
+      PrintDebug(VM_NONE, VCORE_NONE, "8254 PIT: Channel Run State = %d, counter=", ch->run_state);
+      PrintTraceLL(ch->counter);
+      PrintDebug(VM_NONE, VCORE_NONE, "\n");
+    */
     if (ch->op_mode == SQR_WAVE) {
-      reload_val -= reload_val % 2;
+       oscillations *= 2;
     }
-    
-    channel_cycles += oscillations / reload_val;
-    oscillations = oscillations % reload_val;
 
-    ch->counter = reload_val - oscillations;
-  }
+    if (ch->counter > oscillations) {
+       ch->counter -= oscillations;
+       //PrintDebug(VM_NONE, VCORE_NONE, "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; 
 
-  //  PrintDebug("8254 PIT: Channel Cycles: %d\n", channel_cycles);
-  
+       if ((ch->op_mode == SW_STROBE) || (ch->op_mode == IRQ_ON_TERM_CNT)) {
+           reload_val = 0xffff;
+       }
 
+       oscillations -= ch->counter;
+       ch->counter = 0;
+       channel_cycles = 1;
 
-  switch (ch->op_mode) {
-  case IRQ_ON_TERM_CNT:
-    if ((channel_cycles > 0) && (ch->output_pin == 0)) {
-      ch->output_pin = 1; 
-      output_changed = 1;
-    }
-    break;
-  case ONE_SHOT:
-    if ((channel_cycles > 0) && (ch->output_pin == 0)) {
-      ch->output_pin = 1; 
-      output_changed = 1;
-    }
-    break;
-  case RATE_GEN:
-    // See the data sheet: we ignore the output pin cycle...
-    if (channel_cycles > 0) {
-      output_changed = 1;
-    }
-    break;
-  case SQR_WAVE:
-    ch->output_pin = (ch->output_pin + 1) % 2;
+       if (ch->op_mode == SQR_WAVE) {
+           reload_val -= reload_val % 2;
+       }
+
+       if (reload_val == 0) {
+           // This means the value is being set to 0x10000
+           // but due to the tick after the reload, it wraps
+           // down to 0xffff
+           reload_val = 0xffff;
+       }
+
+       channel_cycles += oscillations / reload_val;
+       oscillations = oscillations % reload_val;
+
+       ch->counter = reload_val - oscillations;
+       //      PrintDebug(VM_NONE, VCORE_NONE, "8254 PIT: Counter reset to %u.\n", 
+       //   (unsigned int)ch->counter);
 
-    if (ch->output_pin == 1) {
-      output_changed = 1;
     }
 
-    break;
-  case SW_STROBE:
-    return -1;
-    break;
-  case HW_STROBE:
-    return -1;
-    break;
-  default:
-    break;
-  }
+    //PrintDebug(VM_NONE, VCORE_NONE, "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) {
+               if (ch->output_pin == 0) {
+                   ch->output_pin = 1; 
+                   output_changed = 1;
+               } else {
+                  // PrintDebug(VM_NONE, VCORE_NONE, "8254: Output not changed in TERM_CNT mode.\n");
+               }
+           }
+           break;
+       case ONE_SHOT:
+           if (channel_cycles > 0) {
+               if ((ch->output_pin == 0)) {
+                   ch->output_pin = 1; 
+                   output_changed = 1;
+               } else {
+                   // PrintDebug(VM_NONE, VCORE_NONE, "8254: Output not changed in ONE_SHOT mode.\n");
+               }
+           }
+           break;
+       case RATE_GEN:
+           // See the data sheet: we ignore the output pin cycle...
+           if (channel_cycles > 0) {
+               output_changed = 1;
+           }
+           break;
+       case SQR_WAVE:
+           ch->output_pin = (ch->output_pin + 1) % 2;
+
+           if (ch->output_pin == 1) {
+               output_changed = 1;
+           }
+
+
+           break;
+       case SW_STROBE:
+
+           if (channel_cycles > 0) {
+               if (ch->output_pin == 1) {
+                   ch->output_pin = 0;
+                   output_changed = 1;
+               }
+           }
+           break;
+       case HW_STROBE:
+           PrintError(VM_NONE, VCORE_NONE, "Hardware strobe not implemented\n");
+           return -1;
+           break;
+       default:
+           break;
+    }
 
-  return output_changed;
+    return output_changed;
 }
                                
 
+#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;
-  //  ullong_t tmp_ctr = state->pit_counter;
-  ullong_t tmp_cycles;
-  uint_t oscillations = 0;
+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;
 
 
-  /*
-    PrintDebug("updating cpu_cycles=");
-    PrintTraceLL(cpu_cycles);
-    PrintDebug("\n");
-    
-    PrintDebug("pit_counter=");
-    PrintTraceLL(state->pit_counter);
-    PrintDebug("\n");
+    /*
+      PrintDebug(info->vm_info, info, "updating cpu_cycles=");
+      PrintTraceLL(cpu_cycles);
+      PrintDebug(info->vm_info, info, "\n");
     
-    PrintDebug("pit_reload=");
-    PrintTraceLL(state->pit_reload);
-    PrintDebug("\n");
-  */
-
-  if (state->pit_counter > cpu_cycles) {
-    // Easy...
-    state->pit_counter -= cpu_cycles;
-  } else {
+      PrintDebug(info->vm_info, info, "pit_counter=");
+      PrintTraceLL(state->pit_counter);
+      PrintDebug(info->vm_info, info, "\n");
     
-    // Take off the first part
-    cpu_cycles -= state->pit_counter;
-    state->pit_counter = 0;
-    oscillations = 1;
+      PrintDebug(info->vm_info, info, "pit_reload=");
+      PrintTraceLL(state->pit_reload);
+      PrintDebug(info->vm_info, info, "\n");
+    */
+
+    if (state->pit_counter > cpu_cycles) {
+       // Easy...
+       state->pit_counter -= cpu_cycles;
+    } else {
+       ushort_t reload_val = state->pit_reload;
+       // Take off the first part
+       cpu_cycles -= state->pit_counter;
+       state->pit_counter = 0;
+       oscillations = 1;
     
-    if (cpu_cycles > state->pit_reload) {
-      // how many full oscillations
-      tmp_cycles = cpu_cycles;
+       if (cpu_cycles > state->pit_reload) {
+           // how many full oscillations
+      
+           //PrintError(info->vm_info, info, "cpu_cycles = %p, reload = %p...\n", 
+           //   (void *)(addr_t)cpu_cycles, 
+           //   (void *)(addr_t)state->pit_reload);
 
-      cpu_cycles = do_divll(tmp_cycles, state->pit_reload);
+           // How do we check for a one shot....
+           if (reload_val == 0) {
+               reload_val = 1;
+           }
 
-      oscillations += tmp_cycles;
-    }
+           tmp_cycles = cpu_cycles;
 
-    // update counter with remainder (mod reload)
-    state->pit_counter = state->pit_reload - cpu_cycles;    
+      
+#ifdef __V3_64BIT__
+           cpu_cycles = tmp_cycles % reload_val;
+           tmp_cycles = tmp_cycles / reload_val;
+#else
+           cpu_cycles = do_divll(tmp_cycles, reload_val);
+#endif
+       
+           oscillations += tmp_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);
-    }
+       // update counter with remainder (mod reload)
+       state->pit_counter = state->pit_reload - cpu_cycles;    
 
-    //handle_crystal_tics(dev, &(state->ch_1), oscillations);
-    //handle_crystal_tics(dev, &(state->ch_2), oscillations);
-  }
-  
+       if (oscillations) {
+           //    PrintDebug(info->vm_info, info, "8254 PIT: Handling %d crystal tics\n", oscillations);
 
+           if (handle_crystal_tics(state, &(state->ch_0), oscillations) == 1) {
+               // raise interrupt
+               PrintDebug(info->vm_info, info, "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;
+    return;
 }
 
-
-
 /* This should call out to handle_SQR_WAVE_write, etc...
  */
 static int handle_channel_write(struct channel * ch, char val) {
 
     switch (ch->access_state) {      
-    case WAITING_HIBYTE:
-      {
-       ushort_t tmp_val = ((ushort_t)val) << 8;
-       ch->reload_value &= 0x00ff;
-       ch->reload_value |= tmp_val;
+       case WAITING_HIBYTE:
+           {
+               ushort_t tmp_val = ((ushort_t)val) << 8;
+               ch->reload_value &= 0x00ff;
+               ch->reload_value |= tmp_val;
        
 
-       if ((ch->op_mode != RATE_GEN) || (ch->run_state != RUNNING)){
-         ch->run_state = PENDING;  
-       }
+               if ((ch->op_mode != RATE_GEN) || (ch->run_state != RUNNING)){
+                   ch->run_state = PENDING;  
+               }
        
-       if (ch->access_mode == LOBYTE_HIBYTE) {
-         ch->access_state = WAITING_LOBYTE;
-       }
-
-       PrintDebug("8254 PIT: updated channel counter: %d\n", ch->reload_value);        
-       PrintDebug("8254 PIT: Channel Run State=%d\n", ch->run_state);
-       break;
-      }
-    case WAITING_LOBYTE:
-      ch->reload_value &= 0xff00;
-      ch->reload_value |= val;
+               if (ch->access_mode == LOBYTE_HIBYTE) {
+                   ch->access_state = WAITING_LOBYTE;
+               }
+
+               PrintDebug(VM_NONE, VCORE_NONE, "8254 PIT: updated channel counter: %d\n", ch->reload_value);   
+               PrintDebug(VM_NONE, VCORE_NONE, "8254 PIT: Channel Run State=%d\n", ch->run_state);
+               break;
+           }
+       case WAITING_LOBYTE:
+           ch->reload_value &= 0xff00;
+           ch->reload_value |= val;
       
-      if (ch->access_mode == LOBYTE_HIBYTE) {
-       ch->access_state = WAITING_HIBYTE;
-      } else if ((ch->op_mode != RATE_GEN) || (ch->run_state != RUNNING)) {
-       ch->run_state = PENDING;
-      }
+           if (ch->access_mode == LOBYTE_HIBYTE) {
+               ch->access_state = WAITING_HIBYTE;
+           } else if ((ch->op_mode != RATE_GEN) || (ch->run_state != RUNNING)) {
+               ch->run_state = PENDING;
+           }
       
-      PrintDebug("8254 PIT: updated channel counter: %d\n", ch->reload_value);
-      PrintDebug("8254 PIT: Channel Run State=%d\n", ch->run_state);
-      break;
-    default:
-      return -1;
+           PrintDebug(VM_NONE, VCORE_NONE, "8254 PIT: updated channel counter: %d\n", ch->reload_value);
+           PrintDebug(VM_NONE, VCORE_NONE, "8254 PIT: Channel Run State=%d\n", ch->run_state);
+           break;
+       default:
+           PrintError(VM_NONE, VCORE_NONE, "Invalid Access state\n");
+           return -1;
     }
     
 
     switch (ch->op_mode) {
-    case IRQ_ON_TERM_CNT:
-      ch->output_pin = 0;
-      break;
-    case ONE_SHOT:
-      ch->output_pin = 1;
-      break;
-    case RATE_GEN:
-      ch->output_pin = 1;
-      break;
-    case SQR_WAVE:
-      ch->output_pin = 1;
-      break;
-    default:
-      return -1;
-      break;
+       case IRQ_ON_TERM_CNT:
+           ch->output_pin = 0;
+           break;
+       case ONE_SHOT:
+           ch->output_pin = 1;
+           break;
+       case RATE_GEN:
+           ch->output_pin = 1;
+           break;
+       case SQR_WAVE:
+           ch->output_pin = 1;
+           break;
+       case SW_STROBE:
+           ch->output_pin = 1;
+           break;
+       default:
+           PrintError(VM_NONE, VCORE_NONE, "Invalid OP_MODE: %d\n", ch->op_mode);
+           return -1;
+           break;
     }
 
 
-  return 0;
+    return 0;
 }
 
 
 static int handle_channel_read(struct channel * ch, char * val) {
 
-  ushort_t * myval;
+    ushort_t * myval;
 
-  if (ch->latch_state == NOTLATCHED) { 
-    myval = &(ch->counter);
-  } else {
-    myval = &(ch->latched_value);
-  }
+    if (ch->latch_state == NOTLATCHED) { 
+       myval = &(ch->counter);
+    } else {
+       myval = &(ch->latched_value);
+    }
 
-  if (ch->read_state == LSB) { 
-    *val = ((char*)myval)[0];  // little endian
-    ch->read_state = MSB;
-  } else {
-    *val = ((char*)myval)[1];
-    ch->read_state = LSB;
-    if (ch->latch_state == LATCHED) { 
-      ch->latch_state = NOTLATCHED;
+    if (ch->read_state == LSB) { 
+       *val = ((char*)myval)[0];  // little endian
+       ch->read_state = MSB;
+    } else {
+       *val = ((char*)myval)[1];
+       ch->read_state = LSB;
+       if (ch->latch_state == LATCHED) { 
+           ch->latch_state = NOTLATCHED;
+       }
     }
-  }
 
-  return 0;
+    return 0;
 
 }
 
+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(VM_NONE, VCORE_NONE, "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(VM_NONE, VCORE_NONE, "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:
+           if (ch->latch_state == NOTLATCHED) { 
+               ch->latched_value = ch->counter;
+               ch->latch_state = LATCHED;
+           }
+           break;
+       case HIBYTE_ONLY:
+           ch->access_state = WAITING_HIBYTE;
+           break;
+       case LOBYTE_ONLY: 
+       case LOBYTE_HIBYTE:
+           ch->access_state = WAITING_LOBYTE;
+           break;
+    }
 
-  switch (cmd.access_mode) {
-  case LATCH_COUNT:
-    if (ch->latch_state == NOTLATCHED) { 
-      ch->latched_value = ch->counter;
-      ch->latch_state = LATCHED;
+
+    switch (cmd.op_mode) {
+       case IRQ_ON_TERM_CNT:
+           ch->output_pin = 0;
+           break;
+       case ONE_SHOT: 
+           ch->output_pin = 1;
+           break;
+       case RATE_GEN: 
+           ch->output_pin = 1;
+           break;
+       case SQR_WAVE:
+           ch->output_pin = 1;
+           break;
+       case SW_STROBE:
+           ch->output_pin = 1;
+           break;
+       default:
+           PrintError(VM_NONE, VCORE_NONE, "Invalid OP_MODE: %d\n", cmd.op_mode);
+           return -1;
     }
-    break;
-  case HIBYTE_ONLY:
-    ch->access_state = WAITING_HIBYTE;
-    break;
-  case LOBYTE_ONLY: 
-  case LOBYTE_HIBYTE:
-    ch->access_state = WAITING_LOBYTE;
-    break;
-  }
-
-
-  switch (cmd.op_mode) {
-  case IRQ_ON_TERM_CNT:
-    ch->output_pin = 0;
-    break;
-  case ONE_SHOT: 
-    ch->output_pin = 1;
-    break;
-  case RATE_GEN: 
-    ch->output_pin = 1;
-    break;
-  case SQR_WAVE:
-    ch->output_pin = 1;
-    break;
-  default:
-    return -1;
-  }
 
-  return 0;
+    return 0;
     
 }
 
 
 
 
-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;
-  char * val = (char *)dst;
-
-  if (length != 1) {
-    PrintError("8254 PIT: Invalid Read Write length \n");
-    return -1;
-  }
-
-  PrintDebug("8254 PIT: Read of PIT Channel %d\n", port - CHANNEL0_PORT);
+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;
 
-  switch (port) {
-  case CHANNEL0_PORT: 
-    if (handle_channel_read(&(state->ch_0), val) == -1) {
-      return -1;
-    }
-    break;
-  case CHANNEL1_PORT:
-    if (handle_channel_read(&(state->ch_1), val) == -1) {
-      return -1;
+    if (length != 1) {
+       PrintError(core->vm_info, core, "8254 PIT: Invalid Read Write length \n");
+       return -1;
     }
-    break;
-  case CHANNEL2_PORT:
-    if (handle_channel_read(&(state->ch_2), val) == -1) {
-      return -1;
+
+    PrintDebug(core->vm_info, core, "8254 PIT: Read of PIT Channel %d\n", port - CHANNEL0_PORT);
+
+    switch (port) {
+       case CHANNEL0_PORT: 
+           if (handle_channel_read(&(state->ch_0), val) == -1) {
+               PrintError(core->vm_info, core, "CHANNEL0 read error\n");
+               return -1;
+           }
+           break;
+       case CHANNEL1_PORT:
+           if (handle_channel_read(&(state->ch_1), val) == -1) {
+               PrintError(core->vm_info, core, "CHANNEL1 read error\n");
+               return -1;
+           }
+           break;
+       case CHANNEL2_PORT:
+           if (handle_channel_read(&(state->ch_2), val) == -1) {
+               PrintError(core->vm_info, core, "CHANNEL2 read error\n");
+               return -1;
+           }
+           break;
+       case SPEAKER_PORT:
+           if (handle_speaker_read(&state->speaker, &(state->ch_2), val) == -1) {
+               PrintError(core->vm_info, core, "SPEAKER read error\n");
+               return -1;
+           }
+           break;
+       default:
+           PrintError(core->vm_info, core, "8254 PIT: Read from invalid port (%d)\n", port);
+           return -1;
     }
-    break;
-  default:
-    PrintError("8254 PIT: Read from invalid port (%d)\n", port);
-    return -1;
-  }
 
-  return length;
+    return length;
 }
 
 
 
-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;
-  char val = *(char *)src;
+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) {
-    PrintError("8254 PIT: Invalid Write Length\n");
-    return -1;
-  }
-
-  PrintDebug("8254 PIT: Write to PIT Channel %d (%x)\n", port - CHANNEL0_PORT, *(char*)src);
-
-
-  switch (port) {
-  case CHANNEL0_PORT:
-    if (handle_channel_write(&(state->ch_0), val) == -1) {
-      return -1;
-    } 
-    break;
-  case CHANNEL1_PORT:
-    if (handle_channel_write(&(state->ch_1), val) == -1) {
-      return -1;
+    if (length != 1) {
+       PrintError(core->vm_info, core, "8254 PIT: Invalid Write Length\n");
+       return -1;
     }
-    break;
-  case CHANNEL2_PORT:
-    if (handle_channel_write(&(state->ch_2), val) == -1) {
-      return -1;
+
+    PrintDebug(core->vm_info, core, "8254 PIT: Write to PIT Channel %d (%x)\n", port - CHANNEL0_PORT, *(char*)src);
+
+
+    switch (port) {
+       case CHANNEL0_PORT:
+           if (handle_channel_write(&(state->ch_0), val) == -1) {
+               PrintError(core->vm_info, core, "CHANNEL0 write error\n");
+               return -1;
+           } 
+           break;
+       case CHANNEL1_PORT:
+           if (handle_channel_write(&(state->ch_1), val) == -1) {
+               PrintError(core->vm_info, core, "CHANNEL1 write error\n");
+               return -1;
+           }
+           break;
+       case CHANNEL2_PORT:
+           if (handle_channel_write(&(state->ch_2), val) == -1) {
+               PrintError(core->vm_info, core, "CHANNEL2 write error\n");      
+               return -1;
+           }
+           break;
+       case SPEAKER_PORT:
+           if (handle_speaker_write(&state->speaker, &(state->ch_2), val) == -1) {
+               PrintError(core->vm_info, core, "SPEAKER write error\n");
+               return -1;
+           }
+           break;
+       default:
+           PrintError(core->vm_info, core, "8254 PIT: Write to invalid port (%d)\n", port);
+           return -1;
     }
-    break;
-  default:
-    PrintError("8254 PIT: Write to invalid port (%d)\n", port);
-    return -1;
-  }
 
-  return length;
+    return length;
 }
 
 
 
 
-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;
-  struct pit_cmd_word * cmd = (struct pit_cmd_word *)src;
-
-  PrintDebug("8254 PIT: Write to PIT Command port\n");
-  PrintDebug("8254 PIT: Writing to channel %d (access_mode = %d, op_mode = %d)\n", cmd->channel, cmd->access_mode, cmd->op_mode);
-  if (length != 1) {
-    PrintError("8254 PIT: Write of Invalid length to command port\n");
-    return -1;
-  }
+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;
 
-  switch (cmd->channel) {
-  case 0:
-    if (handle_channel_cmd(&(state->ch_0), *cmd) == -1) {
-      return -1;
-    }
-    break;
-  case 1:
-    if (handle_channel_cmd(&(state->ch_1), *cmd) == -1) {
-      return -1;
+    PrintDebug(core->vm_info, core, "8254 PIT: Write to PIT Command port\n");
+    PrintDebug(core->vm_info, core, "8254 PIT: Writing to channel %d (access_mode = %d, op_mode = %d)\n", cmd->channel, cmd->access_mode, cmd->op_mode);
+    if (length != 1) {
+       PrintError(core->vm_info, core, "8254 PIT: Write of Invalid length to command port\n");
+       return -1;
     }
-    break;
-  case 2:
-    if (handle_channel_cmd(&(state->ch_2), *cmd) == -1) {
-      return -1;
+
+    switch (cmd->channel) {
+       case 0:
+           if (handle_channel_cmd(&(state->ch_0), *cmd) == -1) {
+               PrintError(core->vm_info, core, "CHANNEL0 command error\n");
+               return -1;
+           }
+           break;
+       case 1:
+           if (handle_channel_cmd(&(state->ch_1), *cmd) == -1) {
+               PrintError(core->vm_info, core, "CHANNEL1 command error\n");
+               return -1;
+           }
+           break;
+       case 2:
+           if (handle_channel_cmd(&(state->ch_2), *cmd) == -1) {
+               PrintError(core->vm_info, core, "CHANNEL2 command error\n");
+               return -1;
+           }
+           break;
+       case 3:
+           // Read Back command
+           PrintError(core->vm_info, core, "Read back command not implemented\n");
+           return -1;
+           break;
+       default:
+           break;
     }
-    break;
-  case 3:
-    // Read Back command
-    return -1;
-    break;
-  default:
-    break;
-  }
 
 
-  return length;
+    return length;
 }
 
 
 
 
-static struct vm_timer_ops timer_ops = {
-  .update_time = pit_update_time,
+static struct v3_timer_ops timer_ops = {
+    .update_timer = pit_update_timer,
 };
 
 
 static void init_channel(struct channel * ch) {
-  ch->run_state = NOT_RUNNING;
-  ch->access_state = NOT_WAITING;
-  ch->access_mode = 0;
-  ch->op_mode = 0;
+    ch->run_state = NOT_RUNNING;
+    ch->access_state = NOT_WAITING;
+    ch->access_mode = 0;
+    ch->op_mode = 0;
 
-  ch->counter = 0;
-  ch->reload_value = 0;
-  ch->output_pin = 0;
-  ch->gate_input_pin = 0;
+    ch->counter = 0;
+    ch->reload_value = 0;
+    ch->output_pin = 0;
+    ch->gate_input_pin = 0;
 
-  ch->latched_value = 0;
-  ch->latch_state = NOTLATCHED;
-  ch->read_state = LSB;
+    ch->latched_value = 0;
+    ch->latch_state = NOTLATCHED;
+    ch->read_state = LSB;
 
-  return;
+    return;
 }
 
 
-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;
 
-  dev_hook_io(dev, CHANNEL0_PORT, &pit_read_channel, &pit_write_channel);
-  dev_hook_io(dev, CHANNEL1_PORT, &pit_read_channel, &pit_write_channel);
-  dev_hook_io(dev, CHANNEL2_PORT, &pit_read_channel, &pit_write_channel);
-  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");
-#endif
+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;
+}
 
-  v3_add_timer(dev->vm, &timer_ops, dev);
+#ifdef V3_CONFIG_CHECKPOINT
 
-  // Get cpu frequency and calculate the global pit oscilattor counter/cycle
+#include <palacios/vmm_sprintf.h>
 
-  do_divll(reload_val, OSC_HZ);
-  state->pit_counter = reload_val;
-  state->pit_reload = reload_val;
+#define KEY_MAX 128
+#define MAKE_KEY(x) snprintf(key,KEY_MAX,"PIT_CH%d_%s",i,x)
 
+static int pit_save(struct v3_chkpt_ctx * ctx, void * private_data) {
+    struct pit * pit_state = (struct pit *)private_data; 
+    int i;
+    char key[KEY_MAX];
 
+    V3_CHKPT_SAVE(ctx, "PIT_COUNTER", pit_state->pit_counter,savefailout);
+    V3_CHKPT_SAVE(ctx, "PIT_RELOAD", pit_state->pit_reload,savefailout);
 
-  init_channel(&(state->ch_0));
-  init_channel(&(state->ch_1));
-  init_channel(&(state->ch_2));
+    for (i=0;i<3;i++) {
+      struct channel *c;
+      uint8_t pins;
 
-#ifdef DEBUG_PIT
-  PrintDebug("8254 PIT: CPU MHZ=%d -- pit count=", cpu_khz / 1000);
-  PrintTraceLL(state->pit_counter);
-  PrintDebug("\n");
-#endif
+      if (i==0) { 
+       c=&(pit_state->ch_0);
+      } else if (i==1) { 
+       c=&(pit_state->ch_1);
+      } else {
+       c=&(pit_state->ch_2);
+      }
+      
+      MAKE_KEY("ACCESS_MODE");
+      V3_CHKPT_SAVE(ctx, key, c->access_mode, savefailout);
+      MAKE_KEY("ACCESS_STATE");
+      V3_CHKPT_SAVE(ctx, key, c->access_state, savefailout);
+      MAKE_KEY("RUN_STATE");
+      V3_CHKPT_SAVE(ctx, key, c->run_state, savefailout);
+      MAKE_KEY("OP_MODE");
+      V3_CHKPT_SAVE(ctx, key, c->op_mode, savefailout);
+      MAKE_KEY("COUNTER");
+      V3_CHKPT_SAVE(ctx, key, c->counter, savefailout);
+      MAKE_KEY("RELOAD_VALUE");
+      V3_CHKPT_SAVE(ctx, key, c->reload_value, savefailout);
+
+      MAKE_KEY("LATCH_VALUE");
+      V3_CHKPT_SAVE(ctx, key, c->latched_value, savefailout);
+
+      MAKE_KEY("LATCH_STATE");
+      V3_CHKPT_SAVE(ctx, key, c->latch_state, savefailout);
+      MAKE_KEY("READ_STATE");
+      V3_CHKPT_SAVE(ctx, key, c->read_state, savefailout);
+      
+      pins = (c->output_pin) | (c->gate_input_pin << 1);
+      MAKE_KEY("PINS");
+      V3_CHKPT_SAVE(ctx, key, pins, savefailout);
+    }
+    
+    V3_CHKPT_SAVE(ctx, "PIT_SPEAKER", pit_state->speaker,savefailout);
+    
+    return 0;
 
-  return 0;
+ savefailout:
+    PrintError(VM_NONE, VCORE_NONE, "Failed to save pit\n");
+    return -1;
 }
 
-static int pit_deinit(struct vm_device * dev) {
+static int pit_load(struct v3_chkpt_ctx * ctx, void * private_data) {
+    struct pit * pit_state = (struct pit *)private_data;
+    int i;
+    char key[KEY_MAX];
 
-  return 0;
-}
+    V3_CHKPT_LOAD(ctx, "PIT_COUNTER", pit_state->pit_counter,loadfailout);
+    V3_CHKPT_LOAD(ctx, "PIT_RELOAD", pit_state->pit_reload,loadfailout);
+
+    for (i=0;i<3;i++) {
+      struct channel *c;
+      uint8_t pins;
+
+      if (i==0) { 
+       c=&(pit_state->ch_0);
+      } else if (i==1) { 
+       c=&(pit_state->ch_1);
+      } else {
+       c=&(pit_state->ch_2);
+      }
+      
+      MAKE_KEY("ACCESS_MODE");
+      V3_CHKPT_LOAD(ctx, key, c->access_mode, loadfailout);
+      MAKE_KEY("ACCESS_STATE");
+      V3_CHKPT_LOAD(ctx, key, c->access_state, loadfailout);
+      MAKE_KEY("RUN_STATE");
+      V3_CHKPT_LOAD(ctx, key, c->run_state, loadfailout);
+      MAKE_KEY("OP_MODE");
+      V3_CHKPT_LOAD(ctx, key, c->op_mode, loadfailout);
+      MAKE_KEY("COUNTER");
+      V3_CHKPT_LOAD(ctx, key, c->counter, loadfailout);
+      MAKE_KEY("RELOAD_VALUE");
+      V3_CHKPT_LOAD(ctx, key, c->reload_value, loadfailout);
+
+      MAKE_KEY("LATCH_VALUE");
+      V3_CHKPT_LOAD(ctx, key, c->latched_value, loadfailout);
+
+      MAKE_KEY("LATCH_STATE");
+      V3_CHKPT_LOAD(ctx, key, c->latch_state, loadfailout);
+      MAKE_KEY("READ_STATE");
+      V3_CHKPT_LOAD(ctx, key, c->read_state, loadfailout);
+      
+      pins = (c->output_pin) | (c->gate_input_pin << 1);
+      MAKE_KEY("PINS");
+      V3_CHKPT_LOAD(ctx, key, pins, loadfailout);
+    }
+    
+    V3_CHKPT_LOAD(ctx, "PIT_SPEAKER", pit_state->speaker,loadfailout);
 
+    return 0;
 
-static struct vm_device_ops dev_ops = {
-  .init = pit_init,
-  .deinit = pit_deinit,
-  .reset = NULL,
-  .start = NULL,
-  .stop = NULL,
+ loadfailout:
+    PrintError(VM_NONE, VCORE_NONE, "Failed to load pit\n");
+    return -1;
+}
+#endif
 
+static struct v3_device_ops dev_ops = {
+    .free = (int (*)(void *))pit_free,
+#ifdef V3_CONFIG_CHECKPOINT
+    .save = pit_save,
+    .load = pit_load,
+#endif
 };
 
+#include <palacios/vm_guest.h>
 
-struct vm_device * create_pit() {
-  struct pit * pit_state = NULL;
-  pit_state = (struct pit *)V3_Malloc(sizeof(struct pit));
-  V3_ASSERT(pit_state != NULL);
+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;
 
-  struct vm_device * dev = create_device("PIT", &dev_ops, pit_state);
-  
-  return dev;
+    // 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;
+
+    pit_state = (struct pit *)V3_Malloc(sizeof(struct pit));
+
+    if (!pit_state) {
+       PrintError(info->vm_info, info, "Cannot allocate in init\n");
+       return -1;
+    }
+
+    pit_state->speaker = 0;
+    pit_state->vm = vm;
+
+    dev = v3_add_device(vm, dev_id, &dev_ops, pit_state);
+
+    if (dev == NULL) {
+       PrintError(info->vm_info, info, "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(info->vm_info, info, "8254 PIT: Failed to hook IO ports\n");
+       v3_remove_device(dev);
+       return -1;
+    }
+
+#ifdef V3_CONFIG_DEBUG_PIT
+    PrintDebug(info->vm_info, info, "8254 PIT: OSC_HZ=%d, reload_val=", OSC_HZ);
+    //PrintTrace(reload_val);
+    PrintDebug(info->vm_info, info, "\n");
+#endif
+
+    
+
+    pit_state->timer = v3_add_timer(info, &timer_ops, pit_state);
+
+    if (pit_state->timer == NULL) {
+       v3_remove_device(dev);
+       return -1;
+    }
+
+    // Get cpu frequency and calculate the global pit oscilattor counter/cycle
+
+    do_divll(reload_val, OSC_HZ);   // this is a floor, but will be >=1 for any machine faster than 1.2 MHz
+    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));
+
+#ifdef V3_CONFIG_DEBUG_PIT
+    PrintDebug(info->vm_info, info, "8254 PIT: CPU MHZ=%d -- pit count=", cpu_khz / 1000);
+    //PrintTraceLL(pit_state->pit_counter);
+    PrintDebug(info->vm_info, info, "\n");
+#endif
+
+    return 0;
 }
+
+
+device_register("8254_PIT", pit_init);