include/reactos/libs/fast486/fast486.h

   1 /*
   2  * Fast486 386/486 CPU Emulation Library
   3  * fast486.h
   4  *
   5  * Copyright (C) 2014 Aleksandar Andrejevic <theflash AT sdf DOT lonestar DOT org>
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20  */
  21
  22 #ifndef _FAST486_H_
  23 #define _FAST486_H_
  24
  25 #pragma once
  26
  27 /* DEFINES ********************************************************************/
  28
  29 #ifndef FASTCALL
  30 #define FASTCALL __fastcall
  31 #endif
  32
  33 #define FAST486_NUM_GEN_REGS    8
  34 #define FAST486_NUM_SEG_REGS    6
  35 #define FAST486_NUM_CTRL_REGS   3
  36 #define FAST486_NUM_DBG_REGS    6
  37 #define FAST486_NUM_FPU_REGS    8
  38
  39 #define FAST486_CR0_PE  (1 << 0)
  40 #define FAST486_CR0_MP  (1 << 1)
  41 #define FAST486_CR0_EM  (1 << 2)
  42 #define FAST486_CR0_TS  (1 << 3)
  43 #define FAST486_CR0_ET  (1 << 4)
  44 #define FAST486_CR0_NE  (1 << 5)
  45 #define FAST486_CR0_WP  (1 << 16)
  46 #define FAST486_CR0_AM  (1 << 18)
  47 #define FAST486_CR0_NW  (1 << 29)
  48 #define FAST486_CR0_CD  (1 << 30)
  49 #define FAST486_CR0_PG  (1 << 31)
  50
  51 #define FAST486_DR4_B0 (1 << 0)
  52 #define FAST486_DR4_B1 (1 << 1)
  53 #define FAST486_DR4_B2 (1 << 2)
  54 #define FAST486_DR4_B3 (1 << 3)
  55 #define FAST486_DR4_BD (1 << 13)
  56 #define FAST486_DR4_BS (1 << 14)
  57 #define FAST486_DR4_BT (1 << 15)
  58
  59 #define FAST486_DR5_L0 (1 << 0)
  60 #define FAST486_DR5_G0 (1 << 1)
  61 #define FAST486_DR5_L1 (1 << 2)
  62 #define FAST486_DR5_G1 (1 << 3)
  63 #define FAST486_DR5_L2 (1 << 4)
  64 #define FAST486_DR5_G2 (1 << 5)
  65 #define FAST486_DR5_L3 (1 << 6)
  66 #define FAST486_DR5_G3 (1 << 7)
  67 #define FAST486_DR5_LE (1 << 8)
  68 #define FAST486_DR5_GE (1 << 9)
  69 #define FAST486_DR5_GD (1 << 13)
  70
  71 #define FAST486_DBG_BREAK_EXEC 0
  72 #define FAST486_DBG_BREAK_WRITE 1
  73 #define FAST486_DBG_BREAK_READWRITE 3
  74
  75 #define FAST486_DR4_RESERVED 0xFFFF1FF0
  76 #define FAST486_DR5_RESERVED 0x0000DC00
  77
  78 #define FAST486_IDT_TASK_GATE       0x5
  79 #define FAST486_IDT_INT_GATE        0x6
  80 #define FAST486_IDT_TRAP_GATE       0x7
  81 #define FAST486_IDT_INT_GATE_32     0xE
  82 #define FAST486_IDT_TRAP_GATE_32    0xF
  83
  84 #define FAST486_LDT_SIGNATURE 0x02
  85 #define FAST486_TSS_SIGNATURE 0x09
  86
  87 #define FAST486_PREFIX_SEG      (1 << 0)
  88 #define FAST486_PREFIX_OPSIZE   (1 << 1)
  89 #define FAST486_PREFIX_ADSIZE   (1 << 2)
  90 #define FAST486_PREFIX_LOCK     (1 << 3)
  91 #define FAST486_PREFIX_REPNZ    (1 << 4)
  92 #define FAST486_PREFIX_REP      (1 << 5)
  93
  94 #define FAST486_FPU_DEFAULT_CONTROL 0x037F
  95
  96 struct _FAST486_STATE;
  97 typedef struct _FAST486_STATE FAST486_STATE, *PFAST486_STATE;
  98
  99 typedef enum _FAST486_GEN_REGS
 100 {
 101     FAST486_REG_EAX,
 102     FAST486_REG_ECX,
 103     FAST486_REG_EDX,
 104     FAST486_REG_EBX,
 105     FAST486_REG_ESP,
 106     FAST486_REG_EBP,
 107     FAST486_REG_ESI,
 108     FAST486_REG_EDI
 109 } FAST486_GEN_REGS, *PFAST486_GEN_REGS;
 110
 111 typedef enum _FAST486_SEG_REGS
 112 {
 113     FAST486_REG_ES,
 114     FAST486_REG_CS,
 115     FAST486_REG_SS,
 116     FAST486_REG_DS,
 117     FAST486_REG_FS,
 118     FAST486_REG_GS
 119 } FAST486_SEG_REGS, *PFAST486_SEG_REGS;
 120
 121 typedef enum _FAST486_CTRL_REGS
 122 {
 123     FAST486_REG_CR0 = 0,
 124     FAST486_REG_CR2 = 1,
 125     FAST486_REG_CR3 = 2,
 126 } FAST486_CTRL_REGS, *PFAST486_CTRL_REGS;
 127
 128 typedef enum _FAST486_DBG_REGS
 129 {
 130     FAST486_REG_DR0 = 0,
 131     FAST486_REG_DR1 = 1,
 132     FAST486_REG_DR2 = 2,
 133     FAST486_REG_DR3 = 3,
 134     FAST486_REG_DR4 = 4,
 135     FAST486_REG_DR5 = 5,
 136     FAST486_REG_DR6 = 4, // alias to DR4
 137     FAST486_REG_DR7 = 5  // alias to DR5
 138 } FAST486_DBG_REGS, *PFAST486_DBG_REGS;
 139
 140 typedef enum _FAST486_EXCEPTIONS
 141 {
 142     FAST486_EXCEPTION_DE = 0x00,
 143     FAST486_EXCEPTION_DB = 0x01,
 144     FAST486_EXCEPTION_BP = 0x03,
 145     FAST486_EXCEPTION_OF = 0x04,
 146     FAST486_EXCEPTION_BR = 0x05,
 147     FAST486_EXCEPTION_UD = 0x06,
 148     FAST486_EXCEPTION_NM = 0x07,
 149     FAST486_EXCEPTION_DF = 0x08,
 150     FAST486_EXCEPTION_TS = 0x0A,
 151     FAST486_EXCEPTION_NP = 0x0B,
 152     FAST486_EXCEPTION_SS = 0x0C,
 153     FAST486_EXCEPTION_GP = 0x0D,
 154     FAST486_EXCEPTION_PF = 0x0E,
 155     FAST486_EXCEPTION_MF = 0x10,
 156     FAST486_EXCEPTION_AC = 0x11,
 157     FAST486_EXCEPTION_MC = 0x12
 158 } FAST486_EXCEPTIONS, *PFAST486_EXCEPTIONS;
 159
 160 typedef enum _FAST486_INT_STATUS
 161 {
 162     FAST486_INT_NONE = 0,
 163     FAST486_INT_EXECUTE = 1,
 164     FAST486_INT_SIGNAL = 2,
 165     FAST486_INT_DELAYED = 3
 166 } FAST486_INT_STATUS, *PFAST486_INT_STATUS;
 167
 168 typedef
 169 VOID
 170 (NTAPI *FAST486_MEM_READ_PROC)
 171 (
 172     PFAST486_STATE State,
 173     ULONG Address,
 174     PVOID Buffer,
 175     ULONG Size
 176 );
 177
 178 typedef
 179 VOID
 180 (NTAPI *FAST486_MEM_WRITE_PROC)
 181 (
 182     PFAST486_STATE State,
 183     ULONG Address,
 184     PVOID Buffer,
 185     ULONG Size
 186 );
 187
 188 typedef
 189 VOID
 190 (NTAPI *FAST486_IO_READ_PROC)
 191 (
 192     PFAST486_STATE State,
 193     ULONG Port,
 194     PVOID Buffer,
 195     ULONG DataCount,
 196     UCHAR DataSize
 197 );
 198
 199 typedef
 200 VOID
 201 (NTAPI *FAST486_IO_WRITE_PROC)
 202 (
 203     PFAST486_STATE State,
 204     ULONG Port,
 205     PVOID Buffer,
 206     ULONG DataCount,
 207     UCHAR DataSize
 208 );
 209
 210 typedef
 211 VOID
 212 (NTAPI *FAST486_BOP_PROC)
 213 (
 214     PFAST486_STATE State,
 215     UCHAR BopCode
 216 );
 217
 218 typedef
 219 UCHAR
 220 (NTAPI *FAST486_INT_ACK_PROC)
 221 (
 222     PFAST486_STATE State
 223 );
 224
 225 typedef union _FAST486_REG
 226 {
 227     union
 228     {
 229         struct
 230         {
 231             UCHAR LowByte;
 232             UCHAR HighByte;
 233         };
 234         USHORT LowWord;
 235     };
 236     ULONG Long;
 237 } FAST486_REG, *PFAST486_REG;
 238
 239 typedef struct _FAST486_SEG_REG
 240 {
 241     USHORT Selector;
 242
 243     /* Descriptor cache */
 244     ULONG Accessed      : 1;
 245     ULONG ReadWrite     : 1;
 246     ULONG DirConf       : 1;
 247     ULONG Executable    : 1;
 248     ULONG SystemType    : 1;
 249     ULONG Rpl           : 2;
 250     ULONG Dpl           : 2;
 251     ULONG Present       : 1;
 252     ULONG Size          : 1;
 253     ULONG Limit;
 254     ULONG Base;
 255 } FAST486_SEG_REG, *PFAST486_SEG_REG;
 256
 257 typedef struct _FAST486_LDT_REG
 258 {
 259     USHORT Selector;
 260     ULONG Base;
 261     ULONG Limit;
 262 } FAST486_LDT_REG, *PFAST486_LDT_REG;
 263
 264 typedef struct _FAST486_TASK_REG
 265 {
 266     USHORT Selector;
 267     ULONG Base;
 268     ULONG Limit;
 269     BOOLEAN Busy;
 270 } FAST486_TASK_REG, *PFAST486_TASK_REG;
 271
 272 #include <pshpack1.h>
 273
 274 typedef struct
 275 {
 276     ULONG Limit         : 16;
 277     ULONG Base          : 16;
 278     ULONG BaseMid       : 8;
 279     ULONG Accessed      : 1;
 280     ULONG ReadWrite     : 1;
 281     ULONG DirConf       : 1;
 282     ULONG Executable    : 1;
 283     ULONG SystemType    : 1;
 284     ULONG Dpl           : 2;
 285     ULONG Present       : 1;
 286     ULONG LimitHigh     : 4;
 287     ULONG Avl           : 1;
 288     ULONG Reserved      : 1;
 289     ULONG Size          : 1;
 290     ULONG Granularity   : 1;
 291     ULONG BaseHigh      : 8;
 292 } FAST486_GDT_ENTRY, *PFAST486_GDT_ENTRY;
 293
 294 /* Verify the structure size */
 295 C_ASSERT(sizeof(FAST486_GDT_ENTRY) == sizeof(ULONGLONG));
 296
 297 typedef struct
 298 {
 299     ULONG Limit         : 16;
 300     ULONG Base          : 16;
 301     ULONG BaseMid       : 8;
 302     ULONG Signature     : 5;
 303     ULONG Dpl           : 2;
 304     ULONG Present       : 1;
 305     ULONG LimitHigh     : 4;
 306     ULONG Avl           : 1;
 307     ULONG Reserved      : 2;
 308     ULONG Granularity   : 1;
 309     ULONG BaseHigh      : 8;
 310 } FAST486_SYSTEM_DESCRIPTOR, *PFAST486_SYSTEM_DESCRIPTOR;
 311
 312 /* Verify the structure size */
 313 C_ASSERT(sizeof(FAST486_SYSTEM_DESCRIPTOR) == sizeof(ULONGLONG));
 314
 315 typedef struct
 316 {
 317     ULONG Offset : 16;
 318     ULONG Selector : 16;
 319     ULONG ParamCount : 5;
 320     ULONG Reserved : 3;
 321     ULONG Type : 4;
 322     ULONG SystemType : 1;
 323     ULONG Dpl : 2;
 324     ULONG Present : 1;
 325     ULONG OffsetHigh : 16;
 326 } FAST486_CALL_GATE, *PFAST486_CALL_GATE;
 327
 328 /* Verify the structure size */
 329 C_ASSERT(sizeof(FAST486_CALL_GATE) == sizeof(ULONGLONG));
 330
 331 typedef struct
 332 {
 333     ULONG Offset        : 16;
 334     ULONG Selector      : 16;
 335     ULONG Zero          : 8;
 336     ULONG Type          : 4;
 337     ULONG Storage       : 1;
 338     ULONG Dpl           : 2;
 339     ULONG Present       : 1;
 340     ULONG OffsetHigh    : 16;
 341 } FAST486_IDT_ENTRY, *PFAST486_IDT_ENTRY;
 342
 343 /* Verify the structure size */
 344 C_ASSERT(sizeof(FAST486_IDT_ENTRY) == sizeof(ULONGLONG));
 345
 346 #include <poppack.h>
 347
 348 typedef struct _FAST486_TABLE_REG
 349 {
 350     USHORT Size;
 351     ULONG Address;
 352 } FAST486_TABLE_REG, *PFAST486_TABLE_REG;
 353
 354 typedef union _FAST486_FLAGS_REG
 355 {
 356     USHORT LowWord;
 357     ULONG Long;
 358
 359     struct
 360     {
 361         ULONG Cf        : 1;
 362         ULONG AlwaysSet : 1;
 363         ULONG Pf        : 1;
 364         ULONG Reserved0 : 1;
 365         ULONG Af        : 1;
 366         ULONG Reserved1 : 1;
 367         ULONG Zf        : 1;
 368         ULONG Sf        : 1;
 369         ULONG Tf        : 1;
 370         ULONG If        : 1;
 371         ULONG Df        : 1;
 372         ULONG Of        : 1;
 373         ULONG Iopl      : 2;
 374         ULONG Nt        : 1;
 375         ULONG Reserved2 : 1;
 376         ULONG Rf        : 1;
 377         ULONG Vm        : 1;
 378         ULONG Ac        : 1;
 379
 380         // ULONG Reserved : 13;
 381     };
 382 } FAST486_FLAGS_REG, *PFAST486_FLAGS_REG;
 383
 384 typedef struct _FAST486_TSS
 385 {
 386     ULONG Link;
 387     ULONG Esp0;
 388     ULONG Ss0;
 389     ULONG Esp1;
 390     ULONG Ss1;
 391     ULONG Esp2;
 392     ULONG Ss2;
 393     ULONG Cr3;
 394     ULONG Eip;
 395     ULONG Eflags;
 396     ULONG Eax;
 397     ULONG Ecx;
 398     ULONG Edx;
 399     ULONG Ebx;
 400     ULONG Esp;
 401     ULONG Ebp;
 402     ULONG Esi;
 403     ULONG Edi;
 404     ULONG Es;
 405     ULONG Cs;
 406     ULONG Ss;
 407     ULONG Ds;
 408     ULONG Fs;
 409     ULONG Gs;
 410     ULONG Ldtr;
 411     ULONG IopbOffset;
 412 } FAST486_TSS, *PFAST486_TSS;
 413
 414 typedef struct _FAST486_FPU_DATA_REG
 415 {
 416     ULONGLONG Mantissa;
 417     USHORT Exponent;
 418     UCHAR Sign;
 419 } FAST486_FPU_DATA_REG, *PFAST486_FPU_DATA_REG;
 420
 421 typedef union _FAST486_FPU_STATUS_REG
 422 {
 423     USHORT Value;
 424
 425     struct
 426     {
 427         ULONG Ie : 1;
 428         ULONG De : 1;
 429         ULONG Ze : 1;
 430         ULONG Oe : 1;
 431         ULONG Ue : 1;
 432         ULONG Pe : 1;
 433         ULONG Sf : 1;
 434         ULONG Es : 1;
 435         ULONG Code0 : 1;
 436         ULONG Code1 : 1;
 437         ULONG Code2 : 1;
 438         ULONG Top : 3;
 439         ULONG Code3 : 1;
 440         ULONG Busy : 1;
 441     };
 442 } FAST486_FPU_STATUS_REG, *PFAST486_FPU_STATUS_REG;
 443
 444 typedef union _FAST486_FPU_CONTROL_REG
 445 {
 446     USHORT Value;
 447
 448     struct
 449     {
 450         ULONG Im : 1;
 451         ULONG Dm : 1;
 452         ULONG Zm : 1;
 453         ULONG Om : 1;
 454         ULONG Um : 1;
 455         ULONG Pm : 1;
 456         ULONG Reserved : 2;
 457         ULONG Pc : 2;
 458         ULONG Rc : 2;
 459         ULONG Inf : 1;
 460         // ULONG Reserved1 : 3;
 461     };
 462 } FAST486_FPU_CONTROL_REG, *PFAST486_FPU_CONTROL_REG;
 463
 464 struct _FAST486_STATE
 465 {
 466     FAST486_MEM_READ_PROC MemReadCallback;
 467     FAST486_MEM_WRITE_PROC MemWriteCallback;
 468     FAST486_IO_READ_PROC IoReadCallback;
 469     FAST486_IO_WRITE_PROC IoWriteCallback;
 470     FAST486_BOP_PROC BopCallback;
 471     FAST486_INT_ACK_PROC IntAckCallback;
 472     FAST486_REG GeneralRegs[FAST486_NUM_GEN_REGS];
 473     FAST486_SEG_REG SegmentRegs[FAST486_NUM_SEG_REGS];
 474     FAST486_REG InstPtr, SavedInstPtr;
 475     FAST486_FLAGS_REG Flags;
 476     FAST486_TABLE_REG Gdtr, Idtr;
 477     FAST486_LDT_REG Ldtr;
 478     FAST486_TASK_REG TaskReg;
 479     UCHAR Cpl;
 480     ULONG ControlRegisters[FAST486_NUM_CTRL_REGS];
 481     ULONG DebugRegisters[FAST486_NUM_DBG_REGS];
 482     ULONG ExceptionCount;
 483     ULONG PrefixFlags;
 484     FAST486_SEG_REGS SegmentOverride;
 485     BOOLEAN Halted;
 486     FAST486_INT_STATUS IntStatus;
 487     UCHAR PendingIntNum;
 488     PULONG Tlb;
 489 #ifndef FAST486_NO_FPU
 490     FAST486_FPU_DATA_REG FpuRegisters[FAST486_NUM_FPU_REGS];
 491     FAST486_FPU_STATUS_REG FpuStatus;
 492     FAST486_FPU_CONTROL_REG FpuControl;
 493     USHORT FpuTag;
 494 #endif
 495 };
 496
 497 /* FUNCTIONS ******************************************************************/
 498
 499 VOID
 500 NTAPI
 501 Fast486Initialize(PFAST486_STATE         State,
 502                   FAST486_MEM_READ_PROC  MemReadCallback,
 503                   FAST486_MEM_WRITE_PROC MemWriteCallback,
 504                   FAST486_IO_READ_PROC   IoReadCallback,
 505                   FAST486_IO_WRITE_PROC  IoWriteCallback,
 506                   FAST486_BOP_PROC       BopCallback,
 507                   FAST486_INT_ACK_PROC   IntAckCallback,
 508                   PULONG                 Tlb);
 509
 510 VOID
 511 NTAPI
 512 Fast486Reset(PFAST486_STATE State);
 513
 514 VOID
 515 NTAPI
 516 Fast486Continue(PFAST486_STATE State);
 517
 518 VOID
 519 NTAPI
 520 Fast486StepInto(PFAST486_STATE State);
 521
 522 VOID
 523 NTAPI
 524 Fast486StepOver(PFAST486_STATE State);
 525
 526 VOID
 527 NTAPI
 528 Fast486StepOut(PFAST486_STATE State);
 529
 530 VOID
 531 NTAPI
 532 Fast486DumpState(PFAST486_STATE State);
 533
 534 VOID
 535 NTAPI
 536 Fast486Interrupt(PFAST486_STATE State, UCHAR Number);
 537
 538 VOID
 539 NTAPI
 540 Fast486InterruptSignal(PFAST486_STATE State);
 541
 542 VOID
 543 NTAPI
 544 Fast486ExecuteAt(PFAST486_STATE State, USHORT Segment, ULONG Offset);
 545
 546 VOID
 547 NTAPI
 548 Fast486SetStack(PFAST486_STATE State, USHORT Segment, ULONG Offset);
 549
 550 VOID
 551 NTAPI
 552 Fast486SetSegment
 553 (
 554     PFAST486_STATE State,
 555     FAST486_SEG_REGS Segment,
 556     USHORT Selector
 557 );
 558
 559 #endif // _FAST486_H_
 560
 561 /* EOF */