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