Commit | Line | Data |
---|---|---|
a09e091a JB |
1 | /**************************************************************************** |
2 | * | |
3 | * Realmode X86 Emulator Library | |
4 | * | |
5 | * Copyright (C) 1996-1999 SciTech Software, Inc. | |
6 | * Copyright (C) David Mosberger-Tang | |
7 | * Copyright (C) 1999 Egbert Eich | |
8 | * | |
9 | * ======================================================================== | |
10 | * | |
11 | * Permission to use, copy, modify, distribute, and sell this software and | |
12 | * its documentation for any purpose is hereby granted without fee, | |
13 | * provided that the above copyright notice appear in all copies and that | |
14 | * both that copyright notice and this permission notice appear in | |
15 | * supporting documentation, and that the name of the authors not be used | |
16 | * in advertising or publicity pertaining to distribution of the software | |
17 | * without specific, written prior permission. The authors makes no | |
18 | * representations about the suitability of this software for any purpose. | |
19 | * It is provided "as is" without express or implied warranty. | |
20 | * | |
21 | * THE AUTHORS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, | |
22 | * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO | |
23 | * EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR | |
24 | * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF | |
25 | * USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR | |
26 | * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR | |
27 | * PERFORMANCE OF THIS SOFTWARE. | |
28 | * | |
29 | * ======================================================================== | |
30 | * | |
31 | * Language: ANSI C | |
32 | * Environment: Any | |
33 | * Developer: Kendall Bennett | |
34 | * | |
35 | * Description: Header file for x86 register definitions. | |
36 | * | |
37 | ****************************************************************************/ | |
38 | ||
39 | #ifndef __X86EMU_REGS_H | |
40 | #define __X86EMU_REGS_H | |
41 | ||
42 | /*---------------------- Macros and type definitions ----------------------*/ | |
43 | ||
44 | #ifdef PACK | |
45 | #pragma PACK | |
46 | #endif | |
47 | ||
48 | /* | |
49 | * General EAX, EBX, ECX, EDX type registers. Note that for | |
50 | * portability, and speed, the issue of byte swapping is not addressed | |
51 | * in the registers. All registers are stored in the default format | |
52 | * available on the host machine. The only critical issue is that the | |
53 | * registers should line up EXACTLY in the same manner as they do in | |
54 | * the 386. That is: | |
55 | * | |
56 | * EAX & 0xff === AL | |
57 | * EAX & 0xffff == AX | |
58 | * | |
59 | * etc. The result is that alot of the calculations can then be | |
60 | * done using the native instruction set fully. | |
61 | */ | |
62 | ||
63 | #ifdef __BIG_ENDIAN__ | |
64 | ||
65 | typedef struct { | |
66 | u32 e_reg; | |
67 | } I32_reg_t; | |
68 | ||
69 | typedef struct { | |
70 | u16 filler0, x_reg; | |
71 | } I16_reg_t; | |
72 | ||
73 | typedef struct { | |
74 | u8 filler0, filler1, h_reg, l_reg; | |
75 | } I8_reg_t; | |
76 | ||
77 | #else /* !__BIG_ENDIAN__ */ | |
78 | ||
79 | typedef struct { | |
80 | u32 e_reg; | |
81 | } I32_reg_t; | |
82 | ||
83 | typedef struct { | |
84 | u16 x_reg; | |
85 | } I16_reg_t; | |
86 | ||
87 | typedef struct { | |
88 | u8 l_reg, h_reg; | |
89 | } I8_reg_t; | |
90 | ||
91 | #endif /* BIG_ENDIAN */ | |
92 | ||
93 | typedef union { | |
94 | I32_reg_t I32_reg; | |
95 | I16_reg_t I16_reg; | |
96 | I8_reg_t I8_reg; | |
97 | } i386_general_register; | |
98 | ||
99 | struct i386_general_regs { | |
100 | i386_general_register A, B, C, D; | |
101 | }; | |
102 | ||
103 | typedef struct i386_general_regs Gen_reg_t; | |
104 | ||
105 | struct i386_special_regs { | |
106 | i386_general_register SP, BP, SI, DI, IP; | |
107 | u32 FLAGS; | |
108 | }; | |
109 | ||
110 | /* | |
111 | * Segment registers here represent the 16 bit quantities | |
112 | * CS, DS, ES, SS. | |
113 | */ | |
114 | ||
115 | #if defined(__sun) && defined(CS) /* avoid conflicts with Solaris sys/regset.h */ | |
116 | # undef CS | |
117 | # undef DS | |
118 | # undef SS | |
119 | # undef ES | |
120 | # undef FS | |
121 | # undef GS | |
122 | #endif | |
123 | ||
124 | struct i386_segment_regs { | |
125 | u16 CS, DS, SS, ES, FS, GS; | |
126 | }; | |
127 | ||
128 | /* 8 bit registers */ | |
129 | #define R_AH gen.A.I8_reg.h_reg | |
130 | #define R_AL gen.A.I8_reg.l_reg | |
131 | #define R_BH gen.B.I8_reg.h_reg | |
132 | #define R_BL gen.B.I8_reg.l_reg | |
133 | #define R_CH gen.C.I8_reg.h_reg | |
134 | #define R_CL gen.C.I8_reg.l_reg | |
135 | #define R_DH gen.D.I8_reg.h_reg | |
136 | #define R_DL gen.D.I8_reg.l_reg | |
137 | ||
138 | /* 16 bit registers */ | |
139 | #define R_AX gen.A.I16_reg.x_reg | |
140 | #define R_BX gen.B.I16_reg.x_reg | |
141 | #define R_CX gen.C.I16_reg.x_reg | |
142 | #define R_DX gen.D.I16_reg.x_reg | |
143 | ||
144 | /* 32 bit extended registers */ | |
145 | #define R_EAX gen.A.I32_reg.e_reg | |
146 | #define R_EBX gen.B.I32_reg.e_reg | |
147 | #define R_ECX gen.C.I32_reg.e_reg | |
148 | #define R_EDX gen.D.I32_reg.e_reg | |
149 | ||
150 | /* special registers */ | |
151 | #define R_SP spc.SP.I16_reg.x_reg | |
152 | #define R_BP spc.BP.I16_reg.x_reg | |
153 | #define R_SI spc.SI.I16_reg.x_reg | |
154 | #define R_DI spc.DI.I16_reg.x_reg | |
155 | #define R_IP spc.IP.I16_reg.x_reg | |
156 | #define R_FLG spc.FLAGS | |
157 | ||
158 | /* special registers */ | |
159 | #define R_SP spc.SP.I16_reg.x_reg | |
160 | #define R_BP spc.BP.I16_reg.x_reg | |
161 | #define R_SI spc.SI.I16_reg.x_reg | |
162 | #define R_DI spc.DI.I16_reg.x_reg | |
163 | #define R_IP spc.IP.I16_reg.x_reg | |
164 | #define R_FLG spc.FLAGS | |
165 | ||
166 | /* special registers */ | |
167 | #define R_ESP spc.SP.I32_reg.e_reg | |
168 | #define R_EBP spc.BP.I32_reg.e_reg | |
169 | #define R_ESI spc.SI.I32_reg.e_reg | |
170 | #define R_EDI spc.DI.I32_reg.e_reg | |
171 | #define R_EIP spc.IP.I32_reg.e_reg | |
172 | #define R_EFLG spc.FLAGS | |
173 | ||
174 | /* segment registers */ | |
175 | #define R_CS seg.CS | |
176 | #define R_DS seg.DS | |
177 | #define R_SS seg.SS | |
178 | #define R_ES seg.ES | |
179 | #define R_FS seg.FS | |
180 | #define R_GS seg.GS | |
181 | ||
182 | /* flag conditions */ | |
183 | #define FB_CF 0x0001 /* CARRY flag */ | |
184 | #define FB_PF 0x0004 /* PARITY flag */ | |
185 | #define FB_AF 0x0010 /* AUX flag */ | |
186 | #define FB_ZF 0x0040 /* ZERO flag */ | |
187 | #define FB_SF 0x0080 /* SIGN flag */ | |
188 | #define FB_TF 0x0100 /* TRAP flag */ | |
189 | #define FB_IF 0x0200 /* INTERRUPT ENABLE flag */ | |
190 | #define FB_DF 0x0400 /* DIR flag */ | |
191 | #define FB_OF 0x0800 /* OVERFLOW flag */ | |
192 | ||
193 | /* 80286 and above always have bit#1 set */ | |
194 | #define F_ALWAYS_ON (0x0002) /* flag bits always on */ | |
195 | ||
196 | /* | |
197 | * Define a mask for only those flag bits we will ever pass back | |
198 | * (via PUSHF) | |
199 | */ | |
200 | #define F_MSK (FB_CF|FB_PF|FB_AF|FB_ZF|FB_SF|FB_TF|FB_IF|FB_DF|FB_OF) | |
201 | ||
202 | /* following bits masked in to a 16bit quantity */ | |
203 | ||
204 | #define F_CF 0x0001 /* CARRY flag */ | |
205 | #define F_PF 0x0004 /* PARITY flag */ | |
206 | #define F_AF 0x0010 /* AUX flag */ | |
207 | #define F_ZF 0x0040 /* ZERO flag */ | |
208 | #define F_SF 0x0080 /* SIGN flag */ | |
209 | #define F_TF 0x0100 /* TRAP flag */ | |
210 | #define F_IF 0x0200 /* INTERRUPT ENABLE flag */ | |
211 | #define F_DF 0x0400 /* DIR flag */ | |
212 | #define F_OF 0x0800 /* OVERFLOW flag */ | |
213 | ||
214 | #define TOGGLE_FLAG(flag) (M.x86.R_FLG ^= (flag)) | |
215 | #define SET_FLAG(flag) (M.x86.R_FLG |= (flag)) | |
216 | #define CLEAR_FLAG(flag) (M.x86.R_FLG &= ~(flag)) | |
217 | #define ACCESS_FLAG(flag) (M.x86.R_FLG & (flag)) | |
218 | #define CLEARALL_FLAG(m) (M.x86.R_FLG = 0) | |
219 | ||
220 | #define CONDITIONAL_SET_FLAG(COND,FLAG) \ | |
221 | if (COND) SET_FLAG(FLAG); else CLEAR_FLAG(FLAG) | |
222 | ||
223 | #define F_PF_CALC 0x010000 /* PARITY flag has been calced */ | |
224 | #define F_ZF_CALC 0x020000 /* ZERO flag has been calced */ | |
225 | #define F_SF_CALC 0x040000 /* SIGN flag has been calced */ | |
226 | ||
227 | #define F_ALL_CALC 0xff0000 /* All have been calced */ | |
228 | ||
229 | /* | |
230 | * Emulator machine state. | |
231 | * Segment usage control. | |
232 | */ | |
233 | #define SYSMODE_SEG_DS_SS 0x00000001 | |
234 | #define SYSMODE_SEGOVR_CS 0x00000002 | |
235 | #define SYSMODE_SEGOVR_DS 0x00000004 | |
236 | #define SYSMODE_SEGOVR_ES 0x00000008 | |
237 | #define SYSMODE_SEGOVR_FS 0x00000010 | |
238 | #define SYSMODE_SEGOVR_GS 0x00000020 | |
239 | #define SYSMODE_SEGOVR_SS 0x00000040 | |
240 | #define SYSMODE_PREFIX_REPE 0x00000080 | |
241 | #define SYSMODE_PREFIX_REPNE 0x00000100 | |
242 | #define SYSMODE_PREFIX_DATA 0x00000200 | |
243 | #define SYSMODE_PREFIX_ADDR 0x00000400 | |
244 | #define SYSMODE_INTR_PENDING 0x10000000 | |
245 | #define SYSMODE_EXTRN_INTR 0x20000000 | |
246 | #define SYSMODE_HALTED 0x40000000 | |
247 | ||
248 | #define SYSMODE_SEGMASK (SYSMODE_SEG_DS_SS | \ | |
249 | SYSMODE_SEGOVR_CS | \ | |
250 | SYSMODE_SEGOVR_DS | \ | |
251 | SYSMODE_SEGOVR_ES | \ | |
252 | SYSMODE_SEGOVR_FS | \ | |
253 | SYSMODE_SEGOVR_GS | \ | |
254 | SYSMODE_SEGOVR_SS) | |
255 | #define SYSMODE_CLRMASK (SYSMODE_SEG_DS_SS | \ | |
256 | SYSMODE_SEGOVR_CS | \ | |
257 | SYSMODE_SEGOVR_DS | \ | |
258 | SYSMODE_SEGOVR_ES | \ | |
259 | SYSMODE_SEGOVR_FS | \ | |
260 | SYSMODE_SEGOVR_GS | \ | |
261 | SYSMODE_SEGOVR_SS | \ | |
262 | SYSMODE_PREFIX_DATA | \ | |
263 | SYSMODE_PREFIX_ADDR) | |
264 | ||
265 | #define INTR_SYNCH 0x1 | |
266 | #define INTR_ASYNCH 0x2 | |
267 | #define INTR_HALTED 0x4 | |
268 | ||
269 | typedef struct { | |
270 | struct i386_general_regs gen; | |
271 | struct i386_special_regs spc; | |
272 | struct i386_segment_regs seg; | |
273 | /* | |
274 | * MODE contains information on: | |
275 | * REPE prefix 2 bits repe,repne | |
276 | * SEGMENT overrides 5 bits normal,DS,SS,CS,ES | |
277 | * Delayed flag set 3 bits (zero, signed, parity) | |
278 | * reserved 6 bits | |
279 | * interrupt # 8 bits instruction raised interrupt | |
280 | * BIOS video segregs 4 bits | |
281 | * Interrupt Pending 1 bits | |
282 | * Extern interrupt 1 bits | |
283 | * Halted 1 bits | |
284 | */ | |
285 | u32 mode; | |
286 | volatile int intr; /* mask of pending interrupts */ | |
287 | int debug; | |
288 | #ifdef DEBUG | |
289 | int check; | |
290 | u16 saved_ip; | |
291 | u16 saved_cs; | |
292 | int enc_pos; | |
293 | int enc_str_pos; | |
294 | char decode_buf[32]; /* encoded byte stream */ | |
295 | char decoded_buf[256]; /* disassembled strings */ | |
296 | #endif | |
297 | u8 intno; | |
298 | u8 __pad[3]; | |
299 | } X86EMU_regs; | |
300 | ||
301 | /**************************************************************************** | |
302 | REMARKS: | |
303 | Structure maintaining the emulator machine state. | |
304 | ||
305 | MEMBERS: | |
306 | mem_base - Base real mode memory for the emulator | |
307 | mem_size - Size of the real mode memory block for the emulator | |
308 | private - private data pointer | |
309 | x86 - X86 registers | |
310 | ****************************************************************************/ | |
311 | typedef struct { | |
312 | unsigned long mem_base; | |
313 | unsigned long mem_size; | |
314 | void *private; | |
315 | X86EMU_regs x86; | |
316 | } X86EMU_sysEnv; | |
317 | ||
318 | #ifdef END_PACK | |
319 | #pragma END_PACK | |
320 | #endif | |
321 | ||
322 | /*----------------------------- Global Variables --------------------------*/ | |
323 | ||
324 | #ifdef __cplusplus | |
325 | extern "C" { /* Use "C" linkage when in C++ mode */ | |
326 | #endif | |
327 | ||
328 | /* Global emulator machine state. | |
329 | * | |
330 | * We keep it global to avoid pointer dereferences in the code for speed. | |
331 | */ | |
332 | ||
333 | extern X86EMU_sysEnv _X86EMU_env; | |
334 | #define M _X86EMU_env | |
335 | ||
336 | /*-------------------------- Function Prototypes --------------------------*/ | |
337 | ||
338 | /* Function to log information at runtime */ | |
339 | ||
340 | void printk(const char *fmt, ...); | |
341 | ||
342 | #ifdef __cplusplus | |
343 | } /* End of "C" linkage for C++ */ | |
344 | #endif | |
345 | #endif /* __X86EMU_REGS_H */ |