reactos/subsystems/ntvdm/dos/dos32krnl/dos.h

   1 /*
   2  * COPYRIGHT:       GPL - See COPYING in the top level directory
   3  * PROJECT:         ReactOS Virtual DOS Machine
   4  * FILE:            dos/dos32krnl/dos.h
   5  * PURPOSE:         DOS32 Kernel
   6  * PROGRAMMERS:     Aleksandar Andrejevic <theflash AT sdf DOT lonestar DOT org>
   7  */
   8
   9 #ifndef _DOS_H_
  10 #define _DOS_H_
  11
  12 /* INCLUDES *******************************************************************/
  13
  14 #include "ntvdm.h"
  15
  16 /**/ #include "int32.h" /**/
  17
  18 /* DEFINES ********************************************************************/
  19
  20 //
  21 // We are DOS 5.00 (reported by INT 21h, AH=30h)
  22 //    and DOS 5.50 (reported by INT 21h, AX=3306h) for Windows NT Compatibility
  23 //
  24 #define DOS_VERSION     MAKEWORD(5, 00)
  25 #define NTDOS_VERSION   MAKEWORD(5, 50)
  26
  27 #define DOS_CONFIG_PATH L"%SystemRoot%\\system32\\CONFIG.NT"
  28 #define DOS_COMMAND_INTERPRETER L"%SystemRoot%\\system32\\COMMAND.COM /k %SystemRoot%\\system32\\AUTOEXEC.NT"
  29 #define FIRST_MCB_SEGMENT 0x1000
  30 #define USER_MEMORY_SIZE (0x9FFE - FIRST_MCB_SEGMENT)
  31 #define SYSTEM_PSP 0x08
  32 #define SYSTEM_ENV_BLOCK 0x800
  33
  34 #define INVALID_DOS_HANDLE  0xFFFF
  35 #define DOS_INPUT_HANDLE    0
  36 #define DOS_OUTPUT_HANDLE   1
  37 #define DOS_ERROR_HANDLE    2
  38
  39 #define DOS_SFT_SIZE 255
  40 #define SEGMENT_TO_MCB(seg) ((PDOS_MCB)((ULONG_PTR)BaseAddress + TO_LINEAR((seg), 0)))
  41 #define SEGMENT_TO_PSP(seg) ((PDOS_PSP)((ULONG_PTR)BaseAddress + TO_LINEAR((seg), 0)))
  42 #define UMB_START_SEGMENT 0xC000
  43 #define UMB_END_SEGMENT 0xDFFF
  44 #define DOS_ALLOC_HIGH 0x40
  45 #define DOS_ALLOC_HIGH_LOW 0x80
  46 #define DOS_CMDLINE_LENGTH 127
  47 #define DOS_DIR_LENGTH 64
  48 #define NUM_DRIVES ('Z' - 'A' + 1)
  49 #define DOS_CHAR_ATTRIBUTE 0x07
  50 #define DOS_PROGRAM_NAME_TAG 0x0001
  51
  52 enum DOS_ALLOC_STRATEGY
  53 {
  54     DOS_ALLOC_FIRST_FIT,
  55     DOS_ALLOC_BEST_FIT,
  56     DOS_ALLOC_LAST_FIT
  57 };
  58
  59 typedef enum
  60 {
  61     DOS_LOAD_AND_EXECUTE = 0x00,
  62     DOS_LOAD_ONLY = 0x01,
  63     DOS_LOAD_OVERLAY = 0x03
  64 } DOS_EXEC_TYPE;
  65
  66 #pragma pack(push, 1)
  67
  68 typedef struct _DOS_MCB
  69 {
  70     CHAR BlockType;
  71     WORD OwnerPsp;
  72     WORD Size;
  73     BYTE Unused[3];
  74     CHAR Name[8];
  75 } DOS_MCB, *PDOS_MCB;
  76
  77 typedef struct _DOS_FCB
  78 {
  79     BYTE DriveNumber;
  80     CHAR FileName[8];
  81     CHAR FileExt[3];
  82     WORD BlockNumber;
  83     WORD RecordSize;
  84     DWORD FileSize;
  85     WORD LastWriteDate;
  86     WORD LastWriteTime;
  87     BYTE Reserved[8];
  88     BYTE BlockRecord;
  89     BYTE RecordNumber[3];
  90 } DOS_FCB, *PDOS_FCB;
  91
  92 typedef struct _DOS_PSP
  93 {
  94     BYTE Exit[2];
  95     WORD LastParagraph;
  96     BYTE Reserved0[6];
  97     DWORD TerminateAddress;
  98     DWORD BreakAddress;
  99     DWORD CriticalAddress;
 100     WORD ParentPsp;
 101     BYTE HandleTable[20];
 102     WORD EnvBlock;
 103     DWORD LastStack;
 104     WORD HandleTableSize;
 105     DWORD HandleTablePtr;
 106     DWORD PreviousPsp;
 107     DWORD Reserved1;
 108     WORD DosVersion;
 109     BYTE Reserved2[14];
 110     BYTE FarCall[3];
 111     BYTE Reserved3[9];
 112     DOS_FCB Fcb;
 113     BYTE CommandLineSize;
 114     CHAR CommandLine[DOS_CMDLINE_LENGTH];
 115 } DOS_PSP, *PDOS_PSP;
 116
 117 typedef struct _DOS_INPUT_BUFFER
 118 {
 119     BYTE MaxLength;
 120     BYTE Length;
 121     CHAR Buffer[ANYSIZE_ARRAY];
 122 } DOS_INPUT_BUFFER, *PDOS_INPUT_BUFFER;
 123
 124 typedef struct _DOS_DRIVER_HEADER
 125 {
 126     DWORD NextDriver;
 127     WORD Attributes;
 128     WORD StrategyEntry;
 129     WORD InterruptEntry;
 130     CHAR DeviceName[8];
 131 } DOS_DRIVER_HEADER, *PDOS_DRIVER_HEADER;
 132
 133 typedef struct _DOS_FIND_FILE_BLOCK
 134 {
 135     CHAR DriveLetter;
 136     CHAR Pattern[11];
 137     UCHAR AttribMask;
 138     DWORD Unused;
 139     HANDLE SearchHandle;
 140
 141     /* The following part of the structure is documented */
 142     UCHAR Attributes;
 143     WORD FileTime;
 144     WORD FileDate;
 145     DWORD FileSize;
 146     CHAR FileName[13];
 147 } DOS_FIND_FILE_BLOCK, *PDOS_FIND_FILE_BLOCK;
 148
 149 typedef struct _DOS_EXEC_PARAM_BLOCK
 150 {
 151     /* Input variables */
 152     WORD Environment;
 153     DWORD CommandLine;
 154     DWORD FirstFcb;
 155     DWORD SecondFcb;
 156
 157     /* Output variables */
 158     DWORD StackLocation;
 159     DWORD EntryPoint;
 160 } DOS_EXEC_PARAM_BLOCK, *PDOS_EXEC_PARAM_BLOCK;
 161
 162 #pragma pack(pop)
 163
 164 extern BOOLEAN DoEcho;
 165
 166 /* FUNCTIONS ******************************************************************/
 167
 168 extern CALLBACK16 DosContext;
 169 #define RegisterDosInt32(IntNumber, IntHandler) \
 170 do { \
 171     DosContext.NextOffset += RegisterInt32(MAKELONG(DosContext.NextOffset,   \
 172                                                     DosContext.Segment),     \
 173                                            (IntNumber), (IntHandler), NULL); \
 174 } while(0);
 175
 176 /*
 177  * DOS BIOS Functions
 178  * See bios.c
 179  */
 180 CHAR DosReadCharacter(WORD FileHandle);
 181 BOOLEAN DosCheckInput(VOID);
 182 VOID DosPrintCharacter(WORD FileHandle, CHAR Character);
 183
 184 BOOLEAN DosBIOSInitialize(VOID);
 185
 186
 187 /*
 188  * DOS Kernel Functions
 189  * See dos.c
 190  */
 191 BOOL IsConsoleHandle(HANDLE hHandle);
 192 WORD DosOpenHandle(HANDLE Handle);
 193 HANDLE DosGetRealHandle(WORD DosHandle);
 194
 195 WORD DosCreateFile(LPWORD Handle, LPCSTR FilePath, WORD CreationFlags, WORD Attributes);
 196 WORD DosOpenFile(LPWORD Handle, LPCSTR FilePath, BYTE AccessShareModes);
 197 WORD DosReadFile(WORD FileHandle, LPVOID Buffer, WORD Count, LPWORD BytesRead);
 198 WORD DosWriteFile(WORD FileHandle, LPVOID Buffer, WORD Count, LPWORD BytesWritten);
 199 WORD DosSeekFile(WORD FileHandle, LONG Offset, BYTE Origin, LPDWORD NewOffset);
 200 BOOL DosFlushFileBuffers(WORD FileHandle);
 201
 202 VOID DosInitializePsp(WORD PspSegment, LPCSTR CommandLine, WORD ProgramSize, WORD Environment);
 203 DWORD DosLoadExecutable(
 204     IN DOS_EXEC_TYPE LoadType,
 205     IN LPCSTR ExecutablePath,
 206     IN LPCSTR CommandLine,
 207     IN PVOID Environment,
 208     OUT PDWORD StackLocation OPTIONAL,
 209     OUT PDWORD EntryPoint OPTIONAL
 210 );
 211 WORD DosCreateProcess(
 212     DOS_EXEC_TYPE LoadType,
 213     LPCSTR ProgramName,
 214     PDOS_EXEC_PARAM_BLOCK Parameters
 215 );
 216 DWORD DosStartProcess(IN LPCSTR ExecutablePath,
 217                       IN LPCSTR CommandLine,
 218                       IN PVOID Environment);
 219 VOID DosTerminateProcess(WORD Psp, BYTE ReturnCode);
 220 BOOLEAN DosHandleIoctl(BYTE ControlCode, WORD FileHandle);
 221
 222 VOID WINAPI DosInt20h(LPWORD Stack);
 223 VOID WINAPI DosInt21h(LPWORD Stack);
 224 VOID WINAPI DosBreakInterrupt(LPWORD Stack);
 225 VOID WINAPI DosInt2Fh(LPWORD Stack);
 226
 227 BOOLEAN DosKRNLInitialize(VOID);
 228
 229 #endif // _DOS_H_
 230
 231 /* EOF */