[FAST486]
[reactos.git] / lib / fast486 / fast486.c
index 7ec2534..28b8381 100644 (file)
@@ -21,8 +21,6 @@
 
 /* INCLUDES *******************************************************************/
 
-// #define WIN32_NO_STATUS
-// #define _INC_WINDOWS
 #include <windef.h>
 
 // #define NDEBUG
@@ -57,32 +55,15 @@ Fast486ExecutionControl(PFAST486_STATE State, INT Command)
     do
     {
         /* Check if this is a new instruction */
-        if (State->PrefixFlags == 0)
-        {
-            State->SavedInstPtr = State->InstPtr;
-
-            /* Check if interrupts are enabled and there is an interrupt pending */
-            if (State->Flags.If && State->HardwareInt)
-            {
-                FAST486_IDT_ENTRY IdtEntry;
-
-                /* Get the interrupt vector */
-                if (Fast486GetIntVector(State, State->PendingIntNum, &IdtEntry))
-                {
-                    /* Perform the interrupt */
-                    Fast486InterruptInternal(State,
-                                             IdtEntry.Selector,
-                                             MAKELONG(IdtEntry.Offset, IdtEntry.OffsetHigh),
-                                             IdtEntry.Type);
-                }
-
-                /* Clear the interrupt pending flag */
-                State->HardwareInt = FALSE;
-            }
-        }
+        if (State->PrefixFlags == 0) State->SavedInstPtr = State->InstPtr;
 
         /* Perform an instruction fetch */
-        if (!Fast486FetchByte(State, &Opcode)) continue;
+        if (!Fast486FetchByte(State, &Opcode))
+        {
+            /* Exception occurred */
+            State->PrefixFlags = 0;
+            continue;
+        }
 
         // TODO: Check for CALL/RET to update ProcedureCallCount.
 
@@ -97,16 +78,49 @@ Fast486ExecutionControl(PFAST486_STATE State, INT Command)
             Fast486Exception(State, FAST486_EXCEPTION_UD);
         }
 
-        if (Fast486OpcodeHandlers[Opcode] != Fast486OpcodePrefix)
-        {
-            /* A non-prefix opcode has been executed, reset the prefix flags */
-            State->PrefixFlags = 0;
-        }
-        else
+        if (Fast486OpcodeHandlers[Opcode] == Fast486OpcodePrefix)
         {
             /* This is a prefix, go to the next instruction immediately */
             continue;
         }
+
+        /* A non-prefix opcode has been executed, reset the prefix flags */
+        State->PrefixFlags = 0;
+
+        /*
+         * Check if there is an interrupt to execute, or a hardware interrupt signal
+         * while interrupts are enabled.
+         */
+        if (State->IntStatus == FAST486_INT_EXECUTE)
+        {
+            FAST486_IDT_ENTRY IdtEntry;
+
+            /* Get the interrupt vector */
+            if (Fast486GetIntVector(State, State->PendingIntNum, &IdtEntry))
+            {
+                /* Perform the interrupt */
+                Fast486InterruptInternal(State,
+                                         IdtEntry.Selector,
+                                         MAKELONG(IdtEntry.Offset, IdtEntry.OffsetHigh),
+                                         IdtEntry.Type);
+
+                /* Restore the prefix flags, which would be set to OPSIZE for 32-bit real mode */
+                State->PrefixFlags = 0;
+            }
+
+            /* Clear the interrupt status */
+            State->IntStatus = FAST486_INT_NONE;
+        }
+        else if (State->Flags.If
+                 && (State->IntAckCallback != NULL)
+                 && (State->IntStatus == FAST486_INT_SIGNAL))
+        {
+            /* Acknowledge the interrupt to get the number */
+            State->PendingIntNum = State->IntAckCallback(State);
+
+            /* Set the interrupt status to execute on the next instruction */
+            State->IntStatus = FAST486_INT_EXECUTE;
+        }
     }
     while ((Command == FAST486_CONTINUE)
            || (Command == FAST486_STEP_OVER && ProcedureCallCount > 0)
@@ -114,38 +128,166 @@ Fast486ExecutionControl(PFAST486_STATE State, INT Command)
            || (Fast486OpcodeHandlers[Opcode] == Fast486OpcodePrefix));
 }
 
-/* PUBLIC FUNCTIONS ***********************************************************/
+/* DEFAULT CALLBACKS **********************************************************/
 
-VOID
+static VOID
 NTAPI
-Fast486Continue(PFAST486_STATE State)
+Fast486MemReadCallback(PFAST486_STATE State, ULONG Address, PVOID Buffer, ULONG Size)
 {
-    /* Call the internal function */
-    Fast486ExecutionControl(State, FAST486_CONTINUE);
+    UNREFERENCED_PARAMETER(State);
+
+    RtlMoveMemory(Buffer, (PVOID)Address, Size);
 }
 
-VOID
+static VOID
 NTAPI
-Fast486StepInto(PFAST486_STATE State)
+Fast486MemWriteCallback(PFAST486_STATE State, ULONG Address, PVOID Buffer, ULONG Size)
 {
-    /* Call the internal function */
-    Fast486ExecutionControl(State, FAST486_STEP_INTO);
+    UNREFERENCED_PARAMETER(State);
+
+    RtlMoveMemory((PVOID)Address, Buffer, Size);
+}
+
+static VOID
+NTAPI
+Fast486IoReadCallback(PFAST486_STATE State, ULONG Port, PVOID Buffer, ULONG DataCount, UCHAR DataSize)
+{
+    UNREFERENCED_PARAMETER(State);
+    UNREFERENCED_PARAMETER(Port);
+    UNREFERENCED_PARAMETER(Buffer);
+    UNREFERENCED_PARAMETER(DataCount);
+    UNREFERENCED_PARAMETER(DataSize);
+}
+
+static VOID
+NTAPI
+Fast486IoWriteCallback(PFAST486_STATE State, ULONG Port, PVOID Buffer, ULONG DataCount, UCHAR DataSize)
+{
+    UNREFERENCED_PARAMETER(State);
+    UNREFERENCED_PARAMETER(Port);
+    UNREFERENCED_PARAMETER(Buffer);
+    UNREFERENCED_PARAMETER(DataCount);
+    UNREFERENCED_PARAMETER(DataSize);
 }
 
+static VOID
+NTAPI
+Fast486IdleCallback(PFAST486_STATE State)
+{
+    UNREFERENCED_PARAMETER(State);
+}
+
+static VOID
+NTAPI
+Fast486BopCallback(PFAST486_STATE State, UCHAR BopCode)
+{
+    UNREFERENCED_PARAMETER(State);
+    UNREFERENCED_PARAMETER(BopCode);
+}
+
+static UCHAR
+NTAPI
+Fast486IntAckCallback(PFAST486_STATE State)
+{
+    UNREFERENCED_PARAMETER(State);
+
+    /* Return something... */
+    return 0;
+}
+
+/* PUBLIC FUNCTIONS ***********************************************************/
+
 VOID
 NTAPI
-Fast486StepOver(PFAST486_STATE State)
+Fast486Initialize(PFAST486_STATE         State,
+                  FAST486_MEM_READ_PROC  MemReadCallback,
+                  FAST486_MEM_WRITE_PROC MemWriteCallback,
+                  FAST486_IO_READ_PROC   IoReadCallback,
+                  FAST486_IO_WRITE_PROC  IoWriteCallback,
+                  FAST486_IDLE_PROC      IdleCallback,
+                  FAST486_BOP_PROC       BopCallback,
+                  FAST486_INT_ACK_PROC   IntAckCallback,
+                  PULONG                 Tlb)
 {
-    /* Call the internal function */
-    Fast486ExecutionControl(State, FAST486_STEP_OVER);
+    /* Set the callbacks (or use default ones if some are NULL) */
+    State->MemReadCallback  = (MemReadCallback  ? MemReadCallback  : Fast486MemReadCallback );
+    State->MemWriteCallback = (MemWriteCallback ? MemWriteCallback : Fast486MemWriteCallback);
+    State->IoReadCallback   = (IoReadCallback   ? IoReadCallback   : Fast486IoReadCallback  );
+    State->IoWriteCallback  = (IoWriteCallback  ? IoWriteCallback  : Fast486IoWriteCallback );
+    State->IdleCallback     = (IdleCallback     ? IdleCallback     : Fast486IdleCallback    );
+    State->BopCallback      = (BopCallback      ? BopCallback      : Fast486BopCallback     );
+    State->IntAckCallback   = (IntAckCallback   ? IntAckCallback   : Fast486IntAckCallback  );
+
+    /* Set the TLB (if given) */
+    State->Tlb = Tlb;
+
+    /* Reset the CPU */
+    Fast486Reset(State);
 }
 
 VOID
 NTAPI
-Fast486StepOut(PFAST486_STATE State)
+Fast486Reset(PFAST486_STATE State)
 {
-    /* Call the internal function */
-    Fast486ExecutionControl(State, FAST486_STEP_OUT);
+    FAST486_SEG_REGS i;
+
+    FAST486_MEM_READ_PROC  MemReadCallback  = State->MemReadCallback;
+    FAST486_MEM_WRITE_PROC MemWriteCallback = State->MemWriteCallback;
+    FAST486_IO_READ_PROC   IoReadCallback   = State->IoReadCallback;
+    FAST486_IO_WRITE_PROC  IoWriteCallback  = State->IoWriteCallback;
+    FAST486_IDLE_PROC      IdleCallback     = State->IdleCallback;
+    FAST486_BOP_PROC       BopCallback      = State->BopCallback;
+    FAST486_INT_ACK_PROC   IntAckCallback   = State->IntAckCallback;
+    PULONG                 Tlb              = State->Tlb;
+
+    /* Clear the entire structure */
+    RtlZeroMemory(State, sizeof(*State));
+
+    /* Initialize the registers */
+    State->Flags.AlwaysSet = 1;
+    State->InstPtr.LowWord = 0xFFF0;
+
+    /* Set the CPL to 0 */
+    State->Cpl = 0;
+
+    /* Initialize segments */
+    for (i = 0; i < FAST486_NUM_SEG_REGS; i++)
+    {
+        State->SegmentRegs[i].Selector = 0;
+        State->SegmentRegs[i].Base = 0;
+        State->SegmentRegs[i].Limit = 0xFFFF;
+        State->SegmentRegs[i].Present = TRUE;
+        State->SegmentRegs[i].ReadWrite = TRUE;
+        State->SegmentRegs[i].Executable = FALSE;
+        State->SegmentRegs[i].DirConf = FALSE;
+        State->SegmentRegs[i].SystemType = 1; // Segment descriptor
+        State->SegmentRegs[i].Dpl = 0;
+        State->SegmentRegs[i].Size = FALSE; // 16-bit
+    }
+
+    /* Initialize the code segment */
+    State->SegmentRegs[FAST486_REG_CS].Executable = TRUE;
+    State->SegmentRegs[FAST486_REG_CS].Selector = 0xF000;
+    State->SegmentRegs[FAST486_REG_CS].Base = 0xFFFF0000;
+
+    /* Initialize the IDT */
+    State->Idtr.Size = 0x3FF;
+    State->Idtr.Address = 0;
+
+#ifndef FAST486_NO_FPU
+    /* Initialize CR0 */
+    State->ControlRegisters[FAST486_REG_CR0] |= FAST486_CR0_ET;
+#endif
+
+    /* Restore the callbacks and TLB */
+    State->MemReadCallback  = MemReadCallback;
+    State->MemWriteCallback = MemWriteCallback;
+    State->IoReadCallback   = IoReadCallback;
+    State->IoWriteCallback  = IoWriteCallback;
+    State->IdleCallback     = IdleCallback;
+    State->BopCallback      = BopCallback;
+    State->IntAckCallback   = IntAckCallback;
+    State->Tlb              = Tlb;
 }
 
 VOID
@@ -198,7 +340,7 @@ Fast486DumpState(PFAST486_STATE State)
             State->SegmentRegs[FAST486_REG_GS].Base,
             State->SegmentRegs[FAST486_REG_GS].Limit,
             State->SegmentRegs[FAST486_REG_GS].Dpl);
-    DPRINT1("\nFlags: %08X (%s %s %s %s %s %s %s %s %s %s %s %s %s %s %s) Iopl: %u\n",
+    DPRINT1("\nFlags: %08X (%s %s %s %s %s %s %s %s %s %s %s %s) Iopl: %u\n",
             State->Flags.Long,
             State->Flags.Cf ? "CF" : "cf",
             State->Flags.Pf ? "PF" : "pf",
@@ -212,91 +354,72 @@ Fast486DumpState(PFAST486_STATE State)
             State->Flags.Nt ? "NT" : "nt",
             State->Flags.Rf ? "RF" : "rf",
             State->Flags.Vm ? "VM" : "vm",
-            State->Flags.Ac ? "AC" : "ac",
-            State->Flags.Vif ? "VIF" : "vif",
-            State->Flags.Vip ? "VIP" : "vip",
             State->Flags.Iopl);
     DPRINT1("\nControl Registers:\n"
-            "CR0 = %08X\tCR1 = %08X\tCR2 = %08X\tCR3 = %08X\n"
-            "CR4 = %08X\tCR5 = %08X\tCR6 = %08X\tCR7 = %08X\n",
+            "CR0 = %08X\tCR2 = %08X\tCR3 = %08X\n",
             State->ControlRegisters[FAST486_REG_CR0],
-            State->ControlRegisters[FAST486_REG_CR1],
             State->ControlRegisters[FAST486_REG_CR2],
-            State->ControlRegisters[FAST486_REG_CR3],
-            State->ControlRegisters[FAST486_REG_CR4],
-            State->ControlRegisters[FAST486_REG_CR5],
-            State->ControlRegisters[FAST486_REG_CR6],
-            State->ControlRegisters[FAST486_REG_CR7]);
+            State->ControlRegisters[FAST486_REG_CR3]);
     DPRINT1("\nDebug Registers:\n"
-            "DR0 = %08X\tDR1 = %08X\tDR2 = %08X\tDR3 = %08X\n"
-            "DR4 = %08X\tDR5 = %08X\tDR6 = %08X\tDR7 = %08X\n",
+            "DR0 = %08X\tDR1 = %08X\tDR2 = %08X\n"
+            "DR3 = %08X\tDR4 = %08X\tDR5 = %08X\n",
             State->DebugRegisters[FAST486_REG_DR0],
             State->DebugRegisters[FAST486_REG_DR1],
             State->DebugRegisters[FAST486_REG_DR2],
             State->DebugRegisters[FAST486_REG_DR3],
             State->DebugRegisters[FAST486_REG_DR4],
-            State->DebugRegisters[FAST486_REG_DR5],
-            State->DebugRegisters[FAST486_REG_DR6],
-            State->DebugRegisters[FAST486_REG_DR7]);
+            State->DebugRegisters[FAST486_REG_DR5]);
 }
 
 VOID
 NTAPI
-Fast486Reset(PFAST486_STATE State)
+Fast486Continue(PFAST486_STATE State)
 {
-    INT i;
-    FAST486_MEM_READ_PROC MemReadCallback = State->MemReadCallback;
-    FAST486_MEM_WRITE_PROC MemWriteCallback = State->MemWriteCallback;
-    FAST486_IO_READ_PROC IoReadCallback = State->IoReadCallback;
-    FAST486_IO_WRITE_PROC IoWriteCallback = State->IoWriteCallback;
-    FAST486_IDLE_PROC IdleCallback = State->IdleCallback;
-    FAST486_BOP_PROC BopCallback = State->BopCallback;
-
-    /* Clear the entire structure */
-    RtlZeroMemory(State, sizeof(*State));
-
-    /* Initialize the registers */
-    State->Flags.AlwaysSet = 1;
-    State->InstPtr.LowWord = 0xFFF0;
-
-    /* Initialize segments */
-    for (i = 0; i < FAST486_NUM_SEG_REGS; i++)
-    {
-        /* Set the selector, base and limit, other values don't apply in real mode */
-        State->SegmentRegs[i].Selector = 0;
-        State->SegmentRegs[i].Base = 0;
-        State->SegmentRegs[i].Limit = 0xFFFF;
-    }
-
-    /* Initialize the code segment */
-    State->SegmentRegs[FAST486_REG_CS].Selector = 0xF000;
-    State->SegmentRegs[FAST486_REG_CS].Base = 0xFFFF0000;
+    /* Call the internal function */
+    Fast486ExecutionControl(State, FAST486_CONTINUE);
+}
 
-    /* Initialize the IDT */
-    State->Idtr.Size = 0x3FF;
-    State->Idtr.Address = 0;
+VOID
+NTAPI
+Fast486StepInto(PFAST486_STATE State)
+{
+    /* Call the internal function */
+    Fast486ExecutionControl(State, FAST486_STEP_INTO);
+}
 
-    /* Initialize CR0 */
-    State->ControlRegisters[FAST486_REG_CR0] |= FAST486_CR0_ET;
+VOID
+NTAPI
+Fast486StepOver(PFAST486_STATE State)
+{
+    /* Call the internal function */
+    Fast486ExecutionControl(State, FAST486_STEP_OVER);
+}
 
-    /* Restore the callbacks */
-    State->MemReadCallback = MemReadCallback;
-    State->MemWriteCallback = MemWriteCallback;
-    State->IoReadCallback = IoReadCallback;
-    State->IoWriteCallback = IoWriteCallback;
-    State->IdleCallback = IdleCallback;
-    State->BopCallback = BopCallback;
+VOID
+NTAPI
+Fast486StepOut(PFAST486_STATE State)
+{
+    /* Call the internal function */
+    Fast486ExecutionControl(State, FAST486_STEP_OUT);
 }
 
 VOID
 NTAPI
 Fast486Interrupt(PFAST486_STATE State, UCHAR Number)
 {
-    /* Set the hardware interrupt flag */
-    State->HardwareInt = TRUE;
+    /* Set the interrupt status and the number */
+    State->IntStatus = FAST486_INT_EXECUTE;
     State->PendingIntNum = Number;
 }
 
+VOID
+NTAPI
+Fast486InterruptSignal(PFAST486_STATE State)
+{
+    /* Set the interrupt status */
+    State->IntStatus = FAST486_INT_SIGNAL;
+}
+
 VOID
 NTAPI
 Fast486ExecuteAt(PFAST486_STATE State, USHORT Segment, ULONG Offset)