subsystems/ntvdm/emulator.h

   1 /*
   2  * COPYRIGHT:       GPL - See COPYING in the top level directory
   3  * PROJECT:         ReactOS Virtual DOS Machine
   4  * FILE:            emulator.h
   5  * PURPOSE:         Minimal x86 machine emulator for the VDM (header file)
   6  * PROGRAMMERS:     Aleksandar Andrejevic <theflash AT sdf DOT lonestar DOT org>
   7  */
   8
   9 #ifndef _EMULATOR_H_
  10 #define _EMULATOR_H_
  11
  12 /* INCLUDES *******************************************************************/
  13
  14 #include "ntvdm.h"
  15 #include <fast486.h>
  16
  17 /* DEFINES ********************************************************************/
  18
  19 /* FLAGS */
  20 #define EMULATOR_FLAG_CF (1 << 0)
  21 #define EMULATOR_FLAG_PF (1 << 2)
  22 #define EMULATOR_FLAG_AF (1 << 4)
  23 #define EMULATOR_FLAG_ZF (1 << 6)
  24 #define EMULATOR_FLAG_SF (1 << 7)
  25 #define EMULATOR_FLAG_TF (1 << 8)
  26 #define EMULATOR_FLAG_IF (1 << 9)
  27 #define EMULATOR_FLAG_DF (1 << 10)
  28 #define EMULATOR_FLAG_OF (1 << 11)
  29 #define EMULATOR_FLAG_NT (1 << 14)
  30 #define EMULATOR_FLAG_RF (1 << 16)
  31 #define EMULATOR_FLAG_VM (1 << 17)
  32 #define EMULATOR_FLAG_AC (1 << 18)
  33 #define EMULATOR_FLAG_VIF (1 << 19)
  34 #define EMULATOR_FLAG_VIP (1 << 20)
  35 #define EMULATOR_FLAG_ID (1 << 21)
  36
  37 /* Common definitions */
  38 #define EMULATOR_BOP            0xC4C4
  39 #define EMULATOR_INT_BOP        0xFF
  40 #define EMULATOR_MAX_BOP_NUM    0xFF + 1
  41
  42 #define STACK_COUNTER   0
  43 #define STACK_INT_NUM   1
  44 #define STACK_IP        2
  45 #define STACK_CS        3
  46 #define STACK_FLAGS     4
  47
  48 enum
  49 {
  50     EMULATOR_EXCEPTION_DIVISION_BY_ZERO,
  51     EMULATOR_EXCEPTION_DEBUG,
  52     EMULATOR_EXCEPTION_NMI,
  53     EMULATOR_EXCEPTION_BREAKPOINT,
  54     EMULATOR_EXCEPTION_OVERFLOW,
  55     EMULATOR_EXCEPTION_BOUND,
  56     EMULATOR_EXCEPTION_INVALID_OPCODE,
  57     EMULATOR_EXCEPTION_NO_FPU,
  58     EMULATOR_EXCEPTION_DOUBLE_FAULT,
  59     EMULATOR_EXCEPTION_FPU_SEGMENT,
  60     EMULATOR_EXCEPTION_INVALID_TSS,
  61     EMULATOR_EXCEPTION_NO_SEGMENT,
  62     EMULATOR_EXCEPTION_STACK_SEGMENT,
  63     EMULATOR_EXCEPTION_GPF,
  64     EMULATOR_EXCEPTION_PAGE_FAULT
  65 };
  66
  67 enum
  68 {
  69     EMULATOR_REG_AX,
  70     EMULATOR_REG_CX,
  71     EMULATOR_REG_DX,
  72     EMULATOR_REG_BX,
  73     EMULATOR_REG_SP,
  74     EMULATOR_REG_BP,
  75     EMULATOR_REG_SI,
  76     EMULATOR_REG_DI,
  77     EMULATOR_REG_ES,
  78     EMULATOR_REG_CS,
  79     EMULATOR_REG_SS,
  80     EMULATOR_REG_DS,
  81     EMULATOR_REG_FS,
  82     EMULATOR_REG_GS
  83 };
  84
  85 extern FAST486_STATE EmulatorContext;
  86
  87 /* FUNCTIONS ******************************************************************/
  88
  89 VOID WINAPI EmulatorReadMemory
  90 (
  91     PFAST486_STATE State,
  92     ULONG Address,
  93     PVOID Buffer,
  94     ULONG Size
  95 );
  96
  97 VOID WINAPI EmulatorWriteMemory
  98 (
  99     PFAST486_STATE State,
 100     ULONG Address,
 101     PVOID Buffer,
 102     ULONG Size
 103 );
 104
 105 VOID WINAPI EmulatorReadIo
 106 (
 107     PFAST486_STATE State,
 108     ULONG Port,
 109     PVOID Buffer,
 110     ULONG DataCount,
 111     UCHAR DataSize
 112 );
 113
 114 VOID WINAPI EmulatorWriteIo
 115 (
 116     PFAST486_STATE State,
 117     ULONG Port,
 118     PVOID Buffer,
 119     ULONG DataCount,
 120     UCHAR DataSize
 121 );
 122
 123 VOID WINAPI EmulatorBiosOperation
 124 (
 125     PFAST486_STATE State,
 126     UCHAR BopCode
 127 );
 128
 129 UCHAR WINAPI EmulatorIntAcknowledge
 130 (
 131     PFAST486_STATE State
 132 );
 133
 134 BOOLEAN EmulatorInitialize(VOID);
 135 VOID EmulatorSetStack(WORD Segment, DWORD Offset);
 136 VOID EmulatorExecute(WORD Segment, WORD Offset);
 137 VOID EmulatorInterrupt(BYTE Number);
 138 VOID EmulatorInterruptSignal(VOID);
 139 ULONG EmulatorGetRegister(ULONG Register);
 140 ULONG EmulatorGetProgramCounter(VOID);
 141 VOID EmulatorSetRegister(ULONG Register, ULONG Value);
 142 BOOLEAN EmulatorGetFlag(ULONG Flag);
 143 VOID EmulatorSetFlag(ULONG Flag);
 144 VOID EmulatorClearFlag(ULONG Flag);
 145 VOID EmulatorStep(VOID);
 146 VOID EmulatorCleanup(VOID);
 147 VOID EmulatorSetA20(BOOLEAN Enabled);
 148
 149 #endif // _EMULATOR_H_
 150
 151 /* EOF */