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 enum
  65 {
  66     EMULATOR_EXCEPTION_DIVISION_BY_ZERO,
  67     EMULATOR_EXCEPTION_DEBUG,
  68     EMULATOR_EXCEPTION_NMI,
  69     EMULATOR_EXCEPTION_BREAKPOINT,
  70     EMULATOR_EXCEPTION_OVERFLOW,
  71     EMULATOR_EXCEPTION_BOUND,
  72     EMULATOR_EXCEPTION_INVALID_OPCODE,
  73     EMULATOR_EXCEPTION_NO_FPU,
  74     EMULATOR_EXCEPTION_DOUBLE_FAULT,
  75     EMULATOR_EXCEPTION_FPU_SEGMENT,
  76     EMULATOR_EXCEPTION_INVALID_TSS,
  77     EMULATOR_EXCEPTION_NO_SEGMENT,
  78     EMULATOR_EXCEPTION_STACK_SEGMENT,
  79     EMULATOR_EXCEPTION_GPF,
  80     EMULATOR_EXCEPTION_PAGE_FAULT
  81 };
  82
  83 extern FAST486_STATE EmulatorContext;
  84 extern LPVOID  BaseAddress;
  85 extern BOOLEAN VdmRunning;
  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 UCHAR WINAPI EmulatorIntAcknowledge
 106 (
 107     PFAST486_STATE State
 108 );
 109
 110 VOID EmulatorException(BYTE ExceptionNumber, LPWORD Stack);
 111
 112 BOOLEAN EmulatorInitialize(HANDLE ConsoleInput, HANDLE ConsoleOutput);
 113 VOID EmulatorExecute(WORD Segment, WORD Offset);
 114 VOID EmulatorInterrupt(BYTE Number);
 115 VOID EmulatorInterruptSignal(VOID);
 116 VOID EmulatorStep(VOID);
 117 VOID EmulatorCleanup(VOID);
 118 VOID EmulatorSetA20(BOOLEAN Enabled);
 119
 120 #endif // _EMULATOR_H_
 121
 122 /* EOF */