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
   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 #define STACK_VAR_B     0
  38 #define STACK_VAR_A     1
  39 #define STACK_COUNTER   2
  40 #define STACK_INT_NUM   3
  41 #define STACK_IP        4
  42 #define STACK_CS        5
  43 #define STACK_FLAGS     6
  44
  45
  46 /* Basic Memory Management */
  47 #define TO_LINEAR(seg, off) (((seg) << 4) + (off))
  48 #define MAX_SEGMENT 0xFFFF
  49 #define MAX_OFFSET  0xFFFF
  50 #define MAX_ADDRESS 0x1000000 // 16 MB of RAM
  51
  52 #define FAR_POINTER(x)  \
  53     (PVOID)((ULONG_PTR)BaseAddress + TO_LINEAR(HIWORD(x), LOWORD(x)))
  54
  55 #define SEG_OFF_TO_PTR(seg, off)    \
  56     (PVOID)((ULONG_PTR)BaseAddress + TO_LINEAR((seg), (off)))
  57
  58
  59 /* BCD-Binary conversion */
  60 #define BINARY_TO_BCD(x) ((((x) / 1000) << 12) + (((x) / 100) << 8) + (((x) / 10) << 4) + ((x) % 10))
  61 #define BCD_TO_BINARY(x) (((x) >> 12) * 1000 + ((x) >> 8) * 100 + ((x) >> 4) * 10 + ((x) & 0x0F))
  62
  63
  64 /* System I/O ports */
  65 #define CONTROL_SYSTEM_PORT61H  0x61
  66
  67
  68 enum
  69 {
  70     EMULATOR_EXCEPTION_DIVISION_BY_ZERO,
  71     EMULATOR_EXCEPTION_DEBUG,
  72     EMULATOR_EXCEPTION_NMI,
  73     EMULATOR_EXCEPTION_BREAKPOINT,
  74     EMULATOR_EXCEPTION_OVERFLOW,
  75     EMULATOR_EXCEPTION_BOUND,
  76     EMULATOR_EXCEPTION_INVALID_OPCODE,
  77     EMULATOR_EXCEPTION_NO_FPU,
  78     EMULATOR_EXCEPTION_DOUBLE_FAULT,
  79     EMULATOR_EXCEPTION_FPU_SEGMENT,
  80     EMULATOR_EXCEPTION_INVALID_TSS,
  81     EMULATOR_EXCEPTION_NO_SEGMENT,
  82     EMULATOR_EXCEPTION_STACK_SEGMENT,
  83     EMULATOR_EXCEPTION_GPF,
  84     EMULATOR_EXCEPTION_PAGE_FAULT
  85 };
  86
  87 extern FAST486_STATE EmulatorContext;
  88 extern LPVOID  BaseAddress;
  89 extern BOOLEAN VdmRunning;
  90
  91 /* FUNCTIONS ******************************************************************/
  92
  93 VOID WINAPI EmulatorReadMemory
  94 (
  95     PFAST486_STATE State,
  96     ULONG Address,
  97     PVOID Buffer,
  98     ULONG Size
  99 );
 100
 101 VOID WINAPI EmulatorWriteMemory
 102 (
 103     PFAST486_STATE State,
 104     ULONG Address,
 105     PVOID Buffer,
 106     ULONG Size
 107 );
 108
 109 UCHAR WINAPI EmulatorIntAcknowledge
 110 (
 111     PFAST486_STATE State
 112 );
 113
 114 VOID EmulatorException(BYTE ExceptionNumber, LPWORD Stack);
 115
 116 BOOLEAN EmulatorInitialize(HANDLE ConsoleInput, HANDLE ConsoleOutput);
 117 VOID EmulatorExecute(WORD Segment, WORD Offset);
 118 VOID EmulatorInterrupt(BYTE Number);
 119 VOID EmulatorInterruptSignal(VOID);
 120 VOID EmulatorStep(VOID);
 121 VOID EmulatorSimulate(VOID);
 122 VOID EmulatorUnsimulate(VOID);
 123 VOID EmulatorCleanup(VOID);
 124 VOID EmulatorSetA20(BOOLEAN Enabled);
 125
 126 #endif // _EMULATOR_H_
 127
 128 /* EOF */