subsystems/ntvdm/ntvdm.h

   1 /*
   2  * COPYRIGHT:       GPL - See COPYING in the top level directory
   3  * PROJECT:         ReactOS Virtual DOS Machine
   4  * FILE:            ntvdm.h
   5  * PURPOSE:         Header file to define commonly used stuff
   6  * PROGRAMMERS:     Aleksandar Andrejevic <theflash AT sdf DOT lonestar DOT org>
   7  */
   8
   9 /* INCLUDES *******************************************************************/
  10
  11 #include <windows.h>
  12 #include <tchar.h>
  13 #include <stdio.h>
  14 #include <conio.h>
  15 #include <assert.h>
  16 #include <stdarg.h>
  17
  18 /* DEFINES ********************************************************************/
  19
  20 #define TO_LINEAR(seg, off) (((seg) << 4) + (off))
  21 #define MAX_SEGMENT 0xFFFF
  22 #define MAX_OFFSET 0xFFFF
  23 #define MAX_ADDRESS TO_LINEAR(MAX_SEGMENT, MAX_OFFSET)
  24 #define ROM_AREA_START 0xC0000
  25 #define ROM_AREA_END 0xFFFFF
  26 #define BIOS_PIC_MASTER_INT 0x08
  27 #define BIOS_PIC_SLAVE_INT 0x70
  28 #define BIOS_SEGMENT 0xF000
  29 #define VIDEO_BIOS_INTERRUPT 0x10
  30 #define SPECIAL_INT_NUM 0xFF
  31 #define SEGMENT_TO_MCB(seg) ((PDOS_MCB)((ULONG_PTR)BaseAddress + TO_LINEAR((seg), 0)))
  32 #define SEGMENT_TO_PSP(seg) ((PDOS_PSP)((ULONG_PTR)BaseAddress + TO_LINEAR((seg), 0)))
  33
  34 /* DOS constants */
  35 #define DOS_VERSION 0x0600
  36 #define DOS_CONFIG_PATH L"%SystemRoot%\\system32\\CONFIG.NT"
  37 #define DOS_COMMAND_INTERPRETER L"%SystemRoot%\\system32\\COMMAND.COM /k %SystemRoot%\\system32\\AUTOEXEC.NT"
  38 #define FIRST_MCB_SEGMENT 0x1000
  39 #define USER_MEMORY_SIZE 0x8FFFF
  40 #define SYSTEM_PSP 0x08
  41 #define SYSTEM_ENV_BLOCK 0x800
  42
  43 /* System console constants */
  44 #define CONSOLE_FONT_HEIGHT 8
  45 #define CONSOLE_VIDEO_MEM_START 0xB8000
  46 #define CONSOLE_VIDEO_MEM_END 0xBFFFF
  47
  48 /* Programmable interval timer (PIT) */
  49 #define PIT_CHANNELS 3
  50 #define PIT_BASE_FREQUENCY 1193182LL
  51 #define PIT_DATA_PORT(x) (0x40 + (x))
  52 #define PIT_COMMAND_PORT 0x43
  53
  54 /* Programmable interrupt controller (PIC) */
  55 #define PIC_MASTER_CMD 0x20
  56 #define PIC_MASTER_DATA 0x21
  57 #define PIC_SLAVE_CMD 0xA0
  58 #define PIC_SLAVE_DATA 0xA1
  59 #define PIC_ICW1 0x10
  60 #define PIC_ICW1_ICW4 (1 << 0)
  61 #define PIC_ICW1_SINGLE (1 << 1)
  62 #define PIC_ICW4_8086 (1 << 0)
  63 #define PIC_ICW4_AEOI (1 << 1)
  64 #define PIC_OCW2_NUM_MASK 0x07
  65 #define PIC_OCW2_EOI (1 << 5)
  66 #define PIC_OCW2_SL (1 << 6)
  67 #define PIC_OCW3 (1 << 3)
  68 #define PIC_OCW3_READ_ISR 0x0B
  69
  70 /* 8042 PS/2 controller */
  71 #define KEYBOARD_BUFFER_SIZE 32
  72 #define PS2_DATA_PORT 0x60
  73 #define PS2_CONTROL_PORT 0x64
  74
  75 #define EMULATOR_FLAG_CF (1 << 0)
  76 #define EMULATOR_FLAG_PF (1 << 2)
  77 #define EMULATOR_FLAG_AF (1 << 4)
  78 #define EMULATOR_FLAG_ZF (1 << 6)
  79 #define EMULATOR_FLAG_SF (1 << 7)
  80 #define EMULATOR_FLAG_TF (1 << 8)
  81 #define EMULATOR_FLAG_IF (1 << 9)
  82 #define EMULATOR_FLAG_DF (1 << 10)
  83 #define EMULATOR_FLAG_OF (1 << 11)
  84 #define EMULATOR_FLAG_NT (1 << 14)
  85 #define EMULATOR_FLAG_RF (1 << 16)
  86 #define EMULATOR_FLAG_VM (1 << 17)
  87 #define EMULATOR_FLAG_AC (1 << 18)
  88 #define EMULATOR_FLAG_VIF (1 << 19)
  89 #define EMULATOR_FLAG_VIP (1 << 20)
  90 #define EMULATOR_FLAG_ID (1 << 21)
  91
  92 typedef enum
  93 {
  94     EMULATOR_REG_AX,
  95     EMULATOR_REG_CX,
  96     EMULATOR_REG_DX,
  97     EMULATOR_REG_BX,
  98     EMULATOR_REG_SI,
  99     EMULATOR_REG_DI,
 100     EMULATOR_REG_SP,
 101     EMULATOR_REG_BP,
 102     EMULATOR_REG_CS,
 103     EMULATOR_REG_SS,
 104     EMULATOR_REG_DS,
 105     EMULATOR_REG_ES,
 106     EMULATOR_REG_FS,
 107     EMULATOR_REG_GS
 108 } EMULATOR_REGISTER;
 109
 110 #pragma pack(push, 1)
 111
 112 typedef struct _DOS_MCB
 113 {
 114     CHAR BlockType;
 115     WORD OwnerPsp;
 116     WORD Size;
 117     BYTE Unused[3];
 118     CHAR Name[8];
 119 } DOS_MCB, *PDOS_MCB;
 120
 121 typedef struct _DOS_FCB
 122 {
 123     BYTE DriveNumber;
 124     CHAR FileName[8];
 125     CHAR FileExt[3];
 126     WORD BlockNumber;
 127     WORD RecordSize;
 128     DWORD FileSize;
 129     WORD LastWriteDate;
 130     WORD LastWriteTime;
 131     BYTE Reserved[8];
 132     BYTE BlockRecord;
 133     BYTE RecordNumber[3];
 134 } DOS_FCB, *PDOS_FCB;
 135
 136 typedef struct _DOS_PSP
 137 {
 138     BYTE Exit[2];
 139     WORD MemSize;
 140     BYTE Reserved0[6];
 141     DWORD TerminateAddress;
 142     DWORD BreakAddress;
 143     DWORD CriticalAddress;
 144     WORD ParentPsp;
 145     BYTE HandleTable[20];
 146     WORD EnvBlock;
 147     DWORD LastStack;
 148     WORD HandleTableSize;
 149     DWORD HandleTablePtr;
 150     DWORD PreviousPsp;
 151     DWORD Reserved1;
 152     WORD DosVersion;
 153     BYTE Reserved2[14];
 154     BYTE FarCall[3];
 155     BYTE Reserved3[9];
 156     DOS_FCB Fcb;
 157     BYTE CommandLineSize;
 158     CHAR CommandLine[127];
 159 } DOS_PSP, *PDOS_PSP;
 160
 161 typedef struct _DOS_SFT_ENTRY
 162 {
 163     WORD ReferenceCount;
 164     WORD Mode;
 165     BYTE Attribute;
 166     WORD DeviceInfo;
 167     DWORD DriveParamBlock;
 168     WORD FirstCluster;
 169     WORD FileTime;
 170     WORD FileDate;
 171     DWORD FileSize;
 172     DWORD CurrentOffset;
 173     WORD LastClusterAccessed;
 174     DWORD DirEntSector;
 175     BYTE DirEntryIndex;
 176     CHAR FileName[11];
 177     BYTE Reserved0[6];
 178     WORD OwnerPsp;
 179     BYTE Reserved1[8];
 180 } DOS_SFT_ENTRY, *PDOS_SFT_ENTRY;
 181
 182 typedef struct _DOS_SFT
 183 {
 184     DWORD NextTablePtr;
 185     WORD FileCount;
 186     DOS_SFT_ENTRY Entry[ANYSIZE_ARRAY];
 187 } DOS_SFT, *PDOS_SFT;
 188
 189 typedef struct _DOS_INPUT_BUFFER
 190 {
 191     BYTE MaxLength, Length;
 192     CHAR Buffer[ANYSIZE_ARRAY];
 193 } DOS_INPUT_BUFFER, *PDOS_INPUT_BUFFER;
 194
 195 #pragma pack(pop)
 196
 197 /* FUNCTIONS ******************************************************************/
 198
 199 extern LPVOID BaseAddress;
 200 extern BOOLEAN VdmRunning;
 201 extern LPCWSTR ExceptionName[];
 202
 203 VOID DisplayMessage(LPCWSTR Format, ...);
 204 BOOLEAN BiosInitialize();
 205 VOID BiosUpdateConsole(ULONG StartAddress, ULONG EndAddress);
 206 VOID BiosPrintCharacter(CHAR Character, BYTE Attribute);
 207 BOOLEAN DosInitialize();
 208 WORD DosAllocateMemory(WORD Size);
 209 BOOLEAN DosFreeMemory(WORD Segment);
 210 WORD DosResizeMemory(WORD Segment, WORD NewSize);
 211 BOOLEAN DosCreateProcess(LPCSTR CommandLine, WORD EnvBlock);
 212 VOID DosInt20h(WORD CodeSegment);
 213 VOID DosInt21h(WORD CodeSegment);
 214 VOID DosBreakInterrupt();
 215 VOID BiosVideoService();
 216 VOID BiosHandleIrq(BYTE IrqNumber);
 217 BYTE PicReadCommand(BYTE Port);
 218 VOID PicWriteCommand(BYTE Port, BYTE Value);
 219 BYTE PicReadData(BYTE Port);
 220 VOID PicWriteData(BYTE Port, BYTE Value);
 221 VOID PicInterruptRequest(BYTE Number);
 222 VOID PitInitialize();
 223 VOID PitWriteCommand(BYTE Value);
 224 BYTE PitReadData(BYTE Channel);
 225 VOID PitWriteData(BYTE Channel, BYTE Value);
 226 VOID PitDecrementCount();
 227 VOID CheckForInputEvents();
 228 VOID EmulatorSetStack(WORD Segment, WORD Offset);
 229 VOID EmulatorExecute(WORD Segment, WORD Offset);
 230 VOID EmulatorInterrupt(BYTE Number);
 231 ULONG EmulatorGetRegister(ULONG Register);
 232 VOID EmulatorSetRegister(ULONG Register, ULONG Value);
 233 VOID EmulatorSetFlag(ULONG Flag);
 234 VOID EmulatorClearFlag(ULONG Flag);
 235 BOOLEAN EmulatorGetFlag(ULONG Flag);
 236 BOOLEAN EmulatorInitialize();
 237 VOID EmulatorStep();
 238 VOID EmulatorCleanup();
 239
 240 /* EOF */