lib/fast486/common.h

   1 /*
   2  * Fast486 386/486 CPU Emulation Library
   3  * common.h
   4  *
   5  * Copyright (C) 2013 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 _COMMON_H_
  23 #define _COMMON_H_
  24
  25 #pragma once
  26
  27 /* DEFINES ********************************************************************/
  28
  29 #define SIGN_FLAG_BYTE  0x80
  30 #define SIGN_FLAG_WORD  0x8000
  31 #define SIGN_FLAG_LONG  0x80000000
  32 #define REAL_MODE_FLAGS_MASK 0x17FD5
  33 #define PROT_MODE_FLAGS_MASK 0x10DD5
  34
  35 /* Block size for string operations */
  36 #define STRING_BLOCK_SIZE 4096
  37
  38 #define GET_SEGMENT_RPL(s)          ((s) & 3)
  39 #define GET_SEGMENT_INDEX(s)        ((s) & 0xFFF8)
  40 #define EXCEPTION_HAS_ERROR_CODE(x) (((x) == 8) || ((x) >= 10 && (x) <= 14))
  41
  42 #define NO_LOCK_PREFIX() if (State->PrefixFlags & FAST486_PREFIX_LOCK)\
  43 {\
  44     Fast486Exception(State, FAST486_EXCEPTION_UD);\
  45     return FALSE;\
  46 }
  47 #define TOGGLE_OPSIZE(x) if (State->PrefixFlags & FAST486_PREFIX_OPSIZE)\
  48 {\
  49     x = !x;\
  50 }
  51 #define TOGGLE_ADSIZE(x) if (State->PrefixFlags & FAST486_PREFIX_ADSIZE)\
  52 {\
  53     x = !x;\
  54 }
  55 #define SWAP(x, y) { (x) ^= (y); (y) ^= (x); (x) ^= (y); }
  56
  57 #define PAGE_ALIGN(x)   ((x) & 0xFFFFF000)
  58 #define PAGE_OFFSET(x)  ((x) & 0x00000FFF)
  59
  60 #ifndef PAGE_SIZE
  61 #define PAGE_SIZE   4096
  62 #endif
  63
  64 typedef struct _FAST486_MOD_REG_RM
  65 {
  66     FAST486_GEN_REGS Register;
  67     BOOLEAN Memory;
  68     union
  69     {
  70         FAST486_GEN_REGS SecondRegister;
  71         ULONG MemoryAddress;
  72     };
  73 } FAST486_MOD_REG_RM, *PFAST486_MOD_REG_RM;
  74
  75 #pragma pack(push, 1)
  76
  77 typedef union _FAST486_PAGE_DIR
  78 {
  79     struct
  80     {
  81         ULONG Present       : 1;
  82         ULONG Writeable     : 1;
  83         ULONG Usermode      : 1;
  84         ULONG WriteThrough  : 1;
  85         ULONG NoCache       : 1;
  86         ULONG Accessed      : 1;
  87         ULONG AlwaysZero    : 1;
  88         ULONG Size          : 1;
  89         ULONG Unused        : 4;
  90         ULONG TableAddress  : 20;
  91     };
  92     ULONG Value;
  93 } FAST486_PAGE_DIR, *PFAST486_PAGE_DIR;
  94
  95 typedef union _FAST486_PAGE_TABLE
  96 {
  97     struct
  98     {
  99         ULONG Present       : 1;
 100         ULONG Writeable     : 1;
 101         ULONG Usermode      : 1;
 102         ULONG WriteThrough  : 1;
 103         ULONG NoCache       : 1;
 104         ULONG Accessed      : 1;
 105         ULONG Dirty         : 1;
 106         ULONG AlwaysZero    : 1;
 107         ULONG Global        : 1;
 108         ULONG Unused        : 3;
 109         ULONG Address       : 20;
 110     };
 111     ULONG Value;
 112 } FAST486_PAGE_TABLE, *PFAST486_PAGE_TABLE;
 113
 114 #pragma pack(pop)
 115
 116 /* FUNCTIONS ******************************************************************/
 117
 118 BOOLEAN
 119 Fast486ReadMemory
 120 (
 121     PFAST486_STATE State,
 122     FAST486_SEG_REGS SegmentReg,
 123     ULONG Offset,
 124     BOOLEAN InstFetch,
 125     PVOID Buffer,
 126     ULONG Size
 127 );
 128
 129 BOOLEAN
 130 Fast486WriteMemory
 131 (
 132     PFAST486_STATE State,
 133     FAST486_SEG_REGS SegmentReg,
 134     ULONG Offset,
 135     PVOID Buffer,
 136     ULONG Size
 137 );
 138
 139 BOOLEAN
 140 Fast486InterruptInternal
 141 (
 142     PFAST486_STATE State,
 143     USHORT SegmentSelector,
 144     ULONG Offset,
 145     BOOLEAN InterruptGate
 146 );
 147
 148 VOID
 149 FASTCALL
 150 Fast486ExceptionWithErrorCode
 151 (
 152     PFAST486_STATE State,
 153     FAST486_EXCEPTIONS ExceptionCode,
 154     ULONG ErrorCode
 155 );
 156
 157 /* INLINED FUNCTIONS **********************************************************/
 158
 159 /* static */ FORCEINLINE
 160 INT
 161 Fast486GetCurrentPrivLevel(PFAST486_STATE State)
 162 {
 163     return GET_SEGMENT_RPL(State->SegmentRegs[FAST486_REG_CS].Selector);
 164 }
 165
 166 #include "common.inl"
 167
 168 #endif // _COMMON_H_
 169
 170 /* EOF */