reactos/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_LDT_SIGNATURE       0x02
  79 #define FAST486_TASK_GATE_SIGNATURE 0x05
  80 #define FAST486_IDT_INT_GATE        0x06
  81 #define FAST486_IDT_TRAP_GATE       0x07
  82 #define FAST486_TSS_SIGNATURE       0x09
  83 #define FAST486_BUSY_TSS_SIGNATURE  0x0B
  84 #define FAST486_CALL_GATE_SIGNATURE 0x0C
  85 #define FAST486_IDT_INT_GATE_32     0x0E
  86 #define FAST486_IDT_TRAP_GATE_32    0x0F
  87
  88 #define FAST486_PREFIX_SEG      (1 << 0)
  89 #define FAST486_PREFIX_OPSIZE   (1 << 1)
  90 #define FAST486_PREFIX_ADSIZE   (1 << 2)
  91 #define FAST486_PREFIX_LOCK     (1 << 3)
  92 #define FAST486_PREFIX_REPNZ    (1 << 4)
  93 #define FAST486_PREFIX_REP      (1 << 5)
  94
  95 #define FAST486_FPU_DEFAULT_CONTROL 0x037F
  96
  97 #define FAST486_PAGE_SIZE 4096
  98 #define FAST486_CACHE_SIZE 32
  99
 100 /*
 101  * These are condiciones sine quibus non that should be respected, because
 102  * otherwise when fetching DWORDs you would read extra garbage bytes
 103  * (by reading outside of the prefetch buffer). The prefetch cache must
 104  * also not cross a page boundary.
 105  */
 106 C_ASSERT((FAST486_CACHE_SIZE >= sizeof(DWORD))
 107          && (FAST486_CACHE_SIZE <= FAST486_PAGE_SIZE));
 108
 109 struct _FAST486_STATE;
 110 typedef struct _FAST486_STATE FAST486_STATE, *PFAST486_STATE;
 111
 112 typedef enum _FAST486_GEN_REGS
 113 {
 114     FAST486_REG_EAX,
 115     FAST486_REG_ECX,
 116     FAST486_REG_EDX,
 117     FAST486_REG_EBX,
 118     FAST486_REG_ESP,
 119     FAST486_REG_EBP,
 120     FAST486_REG_ESI,
 121     FAST486_REG_EDI
 122 } FAST486_GEN_REGS, *PFAST486_GEN_REGS;
 123
 124 typedef enum _FAST486_SEG_REGS
 125 {
 126     FAST486_REG_ES,
 127     FAST486_REG_CS,
 128     FAST486_REG_SS,
 129     FAST486_REG_DS,
 130     FAST486_REG_FS,
 131     FAST486_REG_GS
 132 } FAST486_SEG_REGS, *PFAST486_SEG_REGS;
 133
 134 typedef enum _FAST486_CTRL_REGS
 135 {
 136     FAST486_REG_CR0 = 0,
 137     FAST486_REG_CR2 = 1,
 138     FAST486_REG_CR3 = 2,
 139 } FAST486_CTRL_REGS, *PFAST486_CTRL_REGS;
 140
 141 typedef enum _FAST486_DBG_REGS
 142 {
 143     FAST486_REG_DR0 = 0,
 144     FAST486_REG_DR1 = 1,
 145     FAST486_REG_DR2 = 2,
 146     FAST486_REG_DR3 = 3,
 147     FAST486_REG_DR4 = 4,
 148     FAST486_REG_DR5 = 5,
 149     FAST486_REG_DR6 = 4, // alias to DR4
 150     FAST486_REG_DR7 = 5  // alias to DR5
 151 } FAST486_DBG_REGS, *PFAST486_DBG_REGS;
 152
 153 typedef enum _FAST486_EXCEPTIONS
 154 {
 155     FAST486_EXCEPTION_DE = 0x00,
 156     FAST486_EXCEPTION_DB = 0x01,
 157     FAST486_EXCEPTION_BP = 0x03,
 158     FAST486_EXCEPTION_OF = 0x04,
 159     FAST486_EXCEPTION_BR = 0x05,
 160     FAST486_EXCEPTION_UD = 0x06,
 161     FAST486_EXCEPTION_NM = 0x07,
 162     FAST486_EXCEPTION_DF = 0x08,
 163     FAST486_EXCEPTION_TS = 0x0A,
 164     FAST486_EXCEPTION_NP = 0x0B,
 165     FAST486_EXCEPTION_SS = 0x0C,
 166     FAST486_EXCEPTION_GP = 0x0D,
 167     FAST486_EXCEPTION_PF = 0x0E,
 168     FAST486_EXCEPTION_MF = 0x10,
 169     FAST486_EXCEPTION_AC = 0x11,
 170     FAST486_EXCEPTION_MC = 0x12
 171 } FAST486_EXCEPTIONS, *PFAST486_EXCEPTIONS;
 172
 173 typedef
 174 VOID
 175 (NTAPI *FAST486_MEM_READ_PROC)
 176 (
 177     PFAST486_STATE State,
 178     ULONG Address,
 179     PVOID Buffer,
 180     ULONG Size
 181 );
 182
 183 typedef
 184 VOID
 185 (NTAPI *FAST486_MEM_WRITE_PROC)
 186 (
 187     PFAST486_STATE State,
 188     ULONG Address,
 189     PVOID Buffer,
 190     ULONG Size
 191 );
 192
 193 typedef
 194 VOID
 195 (NTAPI *FAST486_IO_READ_PROC)
 196 (
 197     PFAST486_STATE State,
 198     USHORT Port,
 199     PVOID Buffer,
 200     ULONG DataCount,
 201     UCHAR DataSize
 202 );
 203
 204 typedef
 205 VOID
 206 (NTAPI *FAST486_IO_WRITE_PROC)
 207 (
 208     PFAST486_STATE State,
 209     USHORT Port,
 210     PVOID Buffer,
 211     ULONG DataCount,
 212     UCHAR DataSize
 213 );
 214
 215 typedef
 216 VOID
 217 (NTAPI *FAST486_BOP_PROC)
 218 (
 219     PFAST486_STATE State,
 220     UCHAR BopCode
 221 );
 222
 223 typedef
 224 UCHAR
 225 (NTAPI *FAST486_INT_ACK_PROC)
 226 (
 227     PFAST486_STATE State
 228 );
 229
 230 typedef union _FAST486_REG
 231 {
 232     union
 233     {
 234         struct
 235         {
 236             UCHAR LowByte;
 237             UCHAR HighByte;
 238         };
 239         USHORT LowWord;
 240     };
 241     ULONG Long;
 242 } FAST486_REG, *PFAST486_REG;
 243
 244 typedef struct _FAST486_SEG_REG
 245 {
 246     USHORT Selector;
 247
 248     /* Descriptor cache */
 249     ULONG Accessed      : 1;
 250     ULONG ReadWrite     : 1;
 251     ULONG DirConf       : 1;
 252     ULONG Executable    : 1;
 253     ULONG SystemType    : 1;
 254     ULONG Rpl           : 2;
 255     ULONG Dpl           : 2;
 256     ULONG Present       : 1;
 257     ULONG Size          : 1;
 258     ULONG Limit;
 259     ULONG Base;
 260 } FAST486_SEG_REG, *PFAST486_SEG_REG;
 261
 262 typedef struct _FAST486_LDT_REG
 263 {
 264     USHORT Selector;
 265     ULONG Base;
 266     ULONG Limit;
 267 } FAST486_LDT_REG, *PFAST486_LDT_REG;
 268
 269 typedef struct _FAST486_TASK_REG
 270 {
 271     USHORT Selector;
 272     ULONG Base;
 273     ULONG Limit;
 274 } FAST486_TASK_REG, *PFAST486_TASK_REG;
 275
 276 #include <pshpack1.h>
 277
 278 typedef struct
 279 {
 280     ULONG Limit         : 16;
 281     ULONG Base          : 16;
 282     ULONG BaseMid       : 8;
 283     ULONG Accessed      : 1;
 284     ULONG ReadWrite     : 1;
 285     ULONG DirConf       : 1;
 286     ULONG Executable    : 1;
 287     ULONG SystemType    : 1;
 288     ULONG Dpl           : 2;
 289     ULONG Present       : 1;
 290     ULONG LimitHigh     : 4;
 291     ULONG Avl           : 1;
 292     ULONG Reserved      : 1;
 293     ULONG Size          : 1;
 294     ULONG Granularity   : 1;
 295     ULONG BaseHigh      : 8;
 296 } FAST486_GDT_ENTRY, *PFAST486_GDT_ENTRY;
 297
 298 /* Verify the structure size */
 299 C_ASSERT(sizeof(FAST486_GDT_ENTRY) == sizeof(ULONGLONG));
 300
 301 typedef struct
 302 {
 303     ULONG Limit         : 16;
 304     ULONG Base          : 16;
 305     ULONG BaseMid       : 8;
 306     ULONG Signature     : 5;
 307     ULONG Dpl           : 2;
 308     ULONG Present       : 1;
 309     ULONG LimitHigh     : 4;
 310     ULONG Avl           : 1;
 311     ULONG Reserved      : 2;
 312     ULONG Granularity   : 1;
 313     ULONG BaseHigh      : 8;
 314 } FAST486_SYSTEM_DESCRIPTOR, *PFAST486_SYSTEM_DESCRIPTOR;
 315
 316 /* Verify the structure size */
 317 C_ASSERT(sizeof(FAST486_SYSTEM_DESCRIPTOR) == sizeof(ULONGLONG));
 318
 319 typedef struct
 320 {
 321     ULONG Offset : 16;
 322     ULONG Selector : 16;
 323     ULONG ParamCount : 5;
 324     ULONG Reserved : 3;
 325     ULONG Type : 4;
 326     ULONG SystemType : 1;
 327     ULONG Dpl : 2;
 328     ULONG Present : 1;
 329     ULONG OffsetHigh : 16;
 330 } FAST486_CALL_GATE, *PFAST486_CALL_GATE;
 331
 332 /* Verify the structure size */
 333 C_ASSERT(sizeof(FAST486_CALL_GATE) == sizeof(ULONGLONG));
 334
 335 typedef struct
 336 {
 337     ULONG Offset        : 16;
 338     ULONG Selector      : 16;
 339     ULONG Zero          : 8;
 340     ULONG Type          : 4;
 341     ULONG Storage       : 1;
 342     ULONG Dpl           : 2;
 343     ULONG Present       : 1;
 344     ULONG OffsetHigh    : 16;
 345 } FAST486_IDT_ENTRY, *PFAST486_IDT_ENTRY;
 346
 347 /* Verify the structure size */
 348 C_ASSERT(sizeof(FAST486_IDT_ENTRY) == sizeof(ULONGLONG));
 349
 350 #include <poppack.h>
 351
 352 typedef struct _FAST486_TABLE_REG
 353 {
 354     USHORT Size;
 355     ULONG Address;
 356 } FAST486_TABLE_REG, *PFAST486_TABLE_REG;
 357
 358 typedef union _FAST486_FLAGS_REG
 359 {
 360     USHORT LowWord;
 361     ULONG Long;
 362
 363     struct
 364     {
 365         ULONG Cf        : 1;
 366         ULONG AlwaysSet : 1;
 367         ULONG Pf        : 1;
 368         ULONG Reserved0 : 1;
 369         ULONG Af        : 1;
 370         ULONG Reserved1 : 1;
 371         ULONG Zf        : 1;
 372         ULONG Sf        : 1;
 373         ULONG Tf        : 1;
 374         ULONG If        : 1;
 375         ULONG Df        : 1;
 376         ULONG Of        : 1;
 377         ULONG Iopl      : 2;
 378         ULONG Nt        : 1;
 379         ULONG Reserved2 : 1;
 380         ULONG Rf        : 1;
 381         ULONG Vm        : 1;
 382         ULONG Ac        : 1;
 383
 384         // ULONG Reserved : 13;
 385     };
 386 } FAST486_FLAGS_REG, *PFAST486_FLAGS_REG;
 387
 388 typedef struct _FAST486_TSS
 389 {
 390     ULONG Link;
 391     ULONG Esp0;
 392     ULONG Ss0;
 393     ULONG Esp1;
 394     ULONG Ss1;
 395     ULONG Esp2;
 396     ULONG Ss2;
 397     ULONG Cr3;
 398     ULONG Eip;
 399     ULONG Eflags;
 400     ULONG Eax;
 401     ULONG Ecx;
 402     ULONG Edx;
 403     ULONG Ebx;
 404     ULONG Esp;
 405     ULONG Ebp;
 406     ULONG Esi;
 407     ULONG Edi;
 408     ULONG Es;
 409     ULONG Cs;
 410     ULONG Ss;
 411     ULONG Ds;
 412     ULONG Fs;
 413     ULONG Gs;
 414     ULONG Ldtr;
 415     ULONG IopbOffset;
 416 } FAST486_TSS, *PFAST486_TSS;
 417
 418 typedef struct _FAST486_FPU_DATA_REG
 419 {
 420     ULONGLONG Mantissa;
 421     USHORT Exponent;
 422     UCHAR Sign;
 423 } FAST486_FPU_DATA_REG, *PFAST486_FPU_DATA_REG;
 424
 425 typedef union _FAST486_FPU_STATUS_REG
 426 {
 427     USHORT Value;
 428
 429     struct
 430     {
 431         ULONG Ie : 1;
 432         ULONG De : 1;
 433         ULONG Ze : 1;
 434         ULONG Oe : 1;
 435         ULONG Ue : 1;
 436         ULONG Pe : 1;
 437         ULONG Sf : 1;
 438         ULONG Es : 1;
 439         ULONG Code0 : 1;
 440         ULONG Code1 : 1;
 441         ULONG Code2 : 1;
 442         ULONG Top : 3;
 443         ULONG Code3 : 1;
 444         ULONG Busy : 1;
 445     };
 446 } FAST486_FPU_STATUS_REG, *PFAST486_FPU_STATUS_REG;
 447
 448 typedef union _FAST486_FPU_CONTROL_REG
 449 {
 450     USHORT Value;
 451
 452     struct
 453     {
 454         ULONG Im : 1;
 455         ULONG Dm : 1;
 456         ULONG Zm : 1;
 457         ULONG Om : 1;
 458         ULONG Um : 1;
 459         ULONG Pm : 1;
 460         ULONG Reserved : 2;
 461         ULONG Pc : 2;
 462         ULONG Rc : 2;
 463         ULONG Inf : 1;
 464         // ULONG Reserved1 : 3;
 465     };
 466 } FAST486_FPU_CONTROL_REG, *PFAST486_FPU_CONTROL_REG;
 467
 468 struct _FAST486_STATE
 469 {
 470     FAST486_MEM_READ_PROC MemReadCallback;
 471     FAST486_MEM_WRITE_PROC MemWriteCallback;
 472     FAST486_IO_READ_PROC IoReadCallback;
 473     FAST486_IO_WRITE_PROC IoWriteCallback;
 474     FAST486_BOP_PROC BopCallback;
 475     FAST486_INT_ACK_PROC IntAckCallback;
 476     FAST486_REG GeneralRegs[FAST486_NUM_GEN_REGS];
 477     FAST486_SEG_REG SegmentRegs[FAST486_NUM_SEG_REGS];
 478     FAST486_REG InstPtr, SavedInstPtr;
 479     FAST486_FLAGS_REG Flags;
 480     FAST486_TABLE_REG Gdtr, Idtr;
 481     FAST486_LDT_REG Ldtr;
 482     FAST486_TASK_REG TaskReg;
 483     UCHAR Cpl;
 484     ULONG ControlRegisters[FAST486_NUM_CTRL_REGS];
 485     ULONG DebugRegisters[FAST486_NUM_DBG_REGS];
 486     ULONG ExceptionCount;
 487     ULONG PrefixFlags;
 488     FAST486_SEG_REGS SegmentOverride;
 489     BOOLEAN Halted;
 490     BOOLEAN IntSignaled;
 491     BOOLEAN DoNotInterrupt;
 492     PULONG Tlb;
 493 #ifndef FAST486_NO_PREFETCH
 494     BOOLEAN PrefetchValid;
 495     ULONG PrefetchAddress;
 496     UCHAR PrefetchCache[FAST486_CACHE_SIZE];
 497 #endif
 498 #ifndef FAST486_NO_FPU
 499     FAST486_FPU_DATA_REG FpuRegisters[FAST486_NUM_FPU_REGS];
 500     FAST486_FPU_STATUS_REG FpuStatus;
 501     FAST486_FPU_CONTROL_REG FpuControl;
 502     USHORT FpuTag;
 503 #endif
 504 };
 505
 506 /* FUNCTIONS ******************************************************************/
 507
 508 VOID
 509 NTAPI
 510 Fast486Initialize(PFAST486_STATE         State,
 511                   FAST486_MEM_READ_PROC  MemReadCallback,
 512                   FAST486_MEM_WRITE_PROC MemWriteCallback,
 513                   FAST486_IO_READ_PROC   IoReadCallback,
 514                   FAST486_IO_WRITE_PROC  IoWriteCallback,
 515                   FAST486_BOP_PROC       BopCallback,
 516                   FAST486_INT_ACK_PROC   IntAckCallback,
 517                   PULONG                 Tlb);
 518
 519 VOID
 520 NTAPI
 521 Fast486Reset(PFAST486_STATE State);
 522
 523 VOID
 524 NTAPI
 525 Fast486Continue(PFAST486_STATE State);
 526
 527 VOID
 528 NTAPI
 529 Fast486StepInto(PFAST486_STATE State);
 530
 531 VOID
 532 NTAPI
 533 Fast486StepOver(PFAST486_STATE State);
 534
 535 VOID
 536 NTAPI
 537 Fast486StepOut(PFAST486_STATE State);
 538
 539 VOID
 540 NTAPI
 541 Fast486DumpState(PFAST486_STATE State);
 542
 543 VOID
 544 NTAPI
 545 Fast486InterruptSignal(PFAST486_STATE State);
 546
 547 VOID
 548 NTAPI
 549 Fast486ExecuteAt(PFAST486_STATE State, USHORT Segment, ULONG Offset);
 550
 551 VOID
 552 NTAPI
 553 Fast486SetStack(PFAST486_STATE State, USHORT Segment, ULONG Offset);
 554
 555 VOID
 556 NTAPI
 557 Fast486SetSegment
 558 (
 559     PFAST486_STATE State,
 560     FAST486_SEG_REGS Segment,
 561     USHORT Selector
 562 );
 563
 564 #endif // _FAST486_H_
 565
 566 /* EOF */