Cpu.h

Go to the documentation of this file.

//===-- temu-c/Cpu.h - CPU Interfaces ---------------------------*- C++ -*-===//
//
// T-EMU: The Terma Emulator
// (c) Terma 2015
// Authors: Mattias Holm <maho (at) terma.com>
//
//===----------------------------------------------------------------------===//

#ifndef TEMU_CPU_H
#define TEMU_CPU_H

#ifdef __cplusplus
extern "C" {
#endif

#include "temu-c/Support/Objsys.h"
#include "temu-c/Models/Power.h"
#include <stdint.h>

typedef enum {
  teCS_Nominal, 
  teCS_Halted,  
  teCS_Idling,  
} temu_CpuState;


typedef enum {
  teCER_Normal = 0, 
  teCER_Trap = 2,   
  teCER_Halt,   
  teCER_Event,  
  teCER_Break,  
  teCER_WatchR, 
  teCER_WatchW, 
  teCER_Early,  
  teCER_Panic,  
} temu_CpuExitReason;

// ATC flags
#define TEMU_ATC_FETCH 1
#define TEMU_ATC_READ  (1 << 1)
#define TEMU_ATC_WRITE (1 << 2)
#define TEMU_ATC_USER  (1 << 3)
#define TEMU_ATC_SUPER (1 << 4)
#define TEMU_ATC_HYPER (1 << 5)

// Some types for querying CPU info

typedef enum {
  teEN_Little,  // Always little endian
  teEN_Big,     // Always big endian
  teEN_Dynamic, // Can switch at runtime
} temu_Endian;


typedef struct {
  const char *ArchName;
  const char *ModelName;

  unsigned VASize; // Virtual address size in bits
  unsigned PASize; // Physical address size in bits
  unsigned VATypeSize; // Virtual address type size in bytes
  unsigned PATypeSize; // Physical address type size in bytes (i.e. 8 for 36 bit PA)

  unsigned GPRCount; // GPR register count
  unsigned FPRCount; // FPR register count

  temu_Endian InstructionEndianess;
  temu_Endian DataEndianess;

  unsigned NumInstructionSets;
} temu_CpuInfo;

// Named struct type here keeps libclang happy

typedef struct temu_CpuIface {
  void          (*reset)(void *Cpu, int ResetType);
  temu_CpuExitReason (*run)(void *Cpu, uint64_t Cycles);
  temu_CpuExitReason (*runUntil)(void *Cpu, uint64_t Cycles);
  temu_CpuExitReason (*step)(void *Cpu, uint64_t Steps);
  temu_CpuExitReason (*stepUntil)(void *Cpu, uint64_t Steps, uint64_t Cycles);

  void __attribute__((noreturn)) (*raiseTrap)(void *Obj, int Trap);
  void (*enterIdleMode)(void *Obj);
  void __attribute__((noreturn)) (*exitEmuCore)(void *Cpu, temu_CpuExitReason Reason);

  uint64_t      (*getFreq)(void *Cpu);
  int64_t       (*getCycles)(void *Cpu);
  int64_t       (*getSteps)(void *Cpu);
  temu_CpuState (*getState)(void *Cpu);
  void          (*setPc)(void *Cpu, uint64_t Pc);
  uint64_t      (*getPc)(void *Cpu);
  void          (*setGpr)(void *Cpu, int Reg, uint64_t Value);
  uint64_t      (*getGpr)(void *Cpu, unsigned Reg);
  void          (*setFpr32)(void *Cpu, unsigned Reg, uint32_t Value);
  uint32_t      (*getFpr32)(void *Cpu, unsigned Reg);
  void          (*setFpr64)(void *Cpu, unsigned Reg, uint64_t Value);
  uint64_t      (*getFpr64)(void *Cpu, unsigned Reg);
  void          (*setSpr)(void *Cpu, unsigned Reg, uint64_t Value);
  uint64_t      (*getSpr)(void *Cpu, unsigned Reg);
  int           (*getRegId)(void *Cpu, const char *RegName);
  const char*   (*getRegName)(void *Cpu, int RegId);
  uint32_t      (*assemble)(void *Cpu, const char *AsmStr);
  char*         (*disassemble)(void *Cpu, uint32_t Instr);
  void          (*enableTraps)(void *Cpu);
  void          (*disableTraps)(void *Cpu);
  void          (*invalidateAtc)(void *Obj, uint64_t Addr, uint64_t Pages,
                                 uint32_t Flags);

  uint64_t      (*translateAddress)(void *Cpu, uint64_t Va, uint32_t *Flags);

  temu_PowerState (*getPowerState)(void *Cpu);
  void (*setPowerState)(void *Cpu, temu_PowerState Ps);

  void (*enableTrapEvents)(void *Cpu);
  void (*disableTrapEvents)(void *Cpu);

  void (*enableErrorModeEvents)(void *Cpu);
  void (*disableErrorModeEvents)(void *Cpu);

  void* (*getMachine)(void *Cpu);
  void (*raiseTrapNoJmp)(void *Cpu, int Trap);

  const char* (*getTrapName)(void *Cpu, int Trap);

  const temu_CpuInfo* (*getCPUInfo)(void *Cpu); // Experimental

  int (*wakeUp)(void *Cpu); 

  void (*forceEarlyExit)(void *Cpu); 
} temu_CpuIface;
#define TEMU_CPU_IFACE_TYPE "CpuIface"
TEMU_IFACE_REFERENCE_TYPE(temu_Cpu);

typedef struct {
  uint32_t TrapId;
} temu_TrapEventInfo;

typedef struct {
  uint32_t OldMode;
  uint32_t NewMode;
} temu_ModeSwitchInfo;

#ifdef __cplusplus
}
#endif

#endif /* ! TEMU_CPU_H */