When we are converting from one sample rate to another, we do have to
[wine] / dlls / winedos / dosexe.h
1 /*
2  * DOS EXE loader
3  *
4  * Copyright 1998 Ove Kåven
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 #ifndef __WINE_DOSEXE_H
22 #define __WINE_DOSEXE_H
23
24 #include <stdarg.h>
25
26 #include "windef.h"
27 #include "wine/windef16.h"
28 #include "winbase.h"
29 #include "winnt.h"     /* for PCONTEXT */
30 #include "wincon.h"    /* for MOUSE_EVENT_RECORD */
31 #include "miscemu.h"
32
33 #define MAX_DOS_DRIVES  26
34
35 struct _DOSEVENT;
36
37 /* amount of space reserved for relay stack */
38 #define DOSVM_RELAY_DATA_SIZE 4096
39
40 /* various real-mode code stubs */
41 struct DPMI_segments
42 {
43     WORD wrap_seg;
44     WORD xms_seg;
45     WORD dpmi_seg;
46     WORD dpmi_sel;
47     WORD int48_sel;
48     WORD int16_sel;
49     WORD relay_code_sel;
50     WORD relay_data_sel;
51 };
52
53 /* 48-bit segmented pointers for DOS DPMI32 */
54 typedef struct {
55   WORD  selector;
56   DWORD offset;
57 } SEGPTR48, FARPROC48;
58
59 #define DOSCONF_MEM_HIGH        0x0001
60 #define DOSCONF_MEM_UMB         0x0002
61 #define DOSCONF_NUMLOCK         0x0004
62 #define DOSCONF_KEYB_CONV       0x0008
63
64 typedef struct {
65     char lastdrive;
66     int brk_flag;
67     int files;
68     int stacks_nr;
69     int stacks_sz;
70     int buf;
71     int buf2;
72     int fcbs;
73     int flags;
74     char *shell;
75     char *country;
76 } DOSCONF;
77
78 typedef void (*DOSRELAY)(CONTEXT86*,void*);
79 typedef void (WINAPI *RMCBPROC)(CONTEXT86*);
80 typedef void (WINAPI *INTPROC)(CONTEXT86*);
81
82 #define DOS_PRIORITY_REALTIME 0  /* IRQ0 */
83 #define DOS_PRIORITY_KEYBOARD 1  /* IRQ1 */
84 #define DOS_PRIORITY_VGA      2  /* IRQ9 */
85 #define DOS_PRIORITY_MOUSE    5  /* IRQ12 */
86 #define DOS_PRIORITY_SERIAL   10 /* IRQ4 */
87
88 extern WORD DOSVM_psp;     /* psp of current DOS task */
89 extern WORD DOSVM_retval;  /* return value of previous DOS task */
90 extern struct DPMI_segments *DOSVM_dpmi_segments;
91
92 #if defined(linux) && defined(__i386__) && defined(HAVE_SYS_VM86_H)
93 # define MZ_SUPPORTED
94 #endif /* linux-i386 */
95
96 /*
97  * Declare some CONTEXT86.EFlags bits.
98  * IF_MASK is only pushed into real mode stack.
99  */
100 #define V86_FLAG 0x00020000
101 #define IF_MASK  0x00000200
102 #define VIF_MASK 0x00080000
103 #define VIP_MASK 0x00100000
104
105 #define ADD_LOWORD(dw,val)  ((dw) = ((dw) & 0xffff0000) | LOWORD((DWORD)(dw)+(val)))
106
107 #define PTR_REAL_TO_LIN(seg,off) ((void*)(((unsigned int)(seg) << 4) + LOWORD(off)))
108
109 /* NOTE: Interrupts might get called from four modes: real mode, 16-bit,
110  *       32-bit segmented (DPMI32) and 32-bit linear (via DeviceIoControl).
111  *       For automatic conversion of pointer
112  *       parameters, interrupt handlers should use CTX_SEG_OFF_TO_LIN with
113  *       the contents of a segment register as second and the contents of
114  *       a *32-bit* general register as third parameter, e.g.
115  *          CTX_SEG_OFF_TO_LIN( context, DS_reg(context), EDX_reg(context) )
116  *       This will generate a linear pointer in all three cases:
117  *         Real-Mode:   Seg*16 + LOWORD(Offset)
118  *         16-bit:      convert (Seg, LOWORD(Offset)) to linear
119  *         32-bit segmented: convert (Seg, Offset) to linear
120  *         32-bit linear:    use Offset as linear address (DeviceIoControl!)
121  *
122  *       Real-mode is recognized by checking the V86 bit in the flags register,
123  *       32-bit linear mode is recognized by checking whether 'seg' is
124  *       a system selector (0 counts also as 32-bit segment) and 32-bit
125  *       segmented mode is recognized by checking whether 'seg' is 32-bit
126  *       selector which is neither system selector nor zero.
127  */
128 #define CTX_SEG_OFF_TO_LIN(context,seg,off) \
129     (ISV86(context) ? PTR_REAL_TO_LIN((seg),(off)) : wine_ldt_get_ptr((seg),(off)))
130
131 #define INT_BARF(context,num) \
132     ERR( "int%x: unknown/not implemented parameters:\n" \
133                      "int%x: AX %04x, BX %04x, CX %04x, DX %04x, " \
134                      "SI %04x, DI %04x, DS %04x, ES %04x\n", \
135              (num), (num), LOWORD((context)->Eax), LOWORD((context)->Ebx), \
136              LOWORD((context)->Ecx), LOWORD((context)->Edx), LOWORD((context)->Esi), \
137              LOWORD((context)->Edi), (WORD)(context)->SegDs, (WORD)(context)->SegEs )
138
139 /* pushing on stack in 16 bit needs segment wrap around */
140 #define PUSH_WORD16(context,val) \
141     *((WORD*)CTX_SEG_OFF_TO_LIN((context), \
142         (context)->SegSs, ADD_LOWORD( context->Esp, -2 ) )) = (val)
143
144 /* Macros for easier access to i386 context registers */
145
146 #define AX_reg(context)      ((WORD)(context)->Eax)
147 #define BX_reg(context)      ((WORD)(context)->Ebx)
148 #define CX_reg(context)      ((WORD)(context)->Ecx)
149 #define DX_reg(context)      ((WORD)(context)->Edx)
150 #define SI_reg(context)      ((WORD)(context)->Esi)
151 #define DI_reg(context)      ((WORD)(context)->Edi)
152
153 #define AL_reg(context)      ((BYTE)(context)->Eax)
154 #define AH_reg(context)      ((BYTE)((context)->Eax >> 8))
155 #define BL_reg(context)      ((BYTE)(context)->Ebx)
156 #define BH_reg(context)      ((BYTE)((context)->Ebx >> 8))
157 #define CL_reg(context)      ((BYTE)(context)->Ecx)
158 #define CH_reg(context)      ((BYTE)((context)->Ecx >> 8))
159 #define DL_reg(context)      ((BYTE)(context)->Edx)
160 #define DH_reg(context)      ((BYTE)((context)->Edx >> 8))
161
162 #define SET_CFLAG(context)   ((context)->EFlags |= 0x0001)
163 #define RESET_CFLAG(context) ((context)->EFlags &= ~0x0001)
164 #define SET_ZFLAG(context)   ((context)->EFlags |= 0x0040)
165 #define RESET_ZFLAG(context) ((context)->EFlags &= ~0x0040)
166 #define ISV86(context)       ((context)->EFlags & 0x00020000)
167
168 #define SET_AX(context,val)  ((void)((context)->Eax = ((context)->Eax & ~0xffff) | (WORD)(val)))
169 #define SET_BX(context,val)  ((void)((context)->Ebx = ((context)->Ebx & ~0xffff) | (WORD)(val)))
170 #define SET_CX(context,val)  ((void)((context)->Ecx = ((context)->Ecx & ~0xffff) | (WORD)(val)))
171 #define SET_DX(context,val)  ((void)((context)->Edx = ((context)->Edx & ~0xffff) | (WORD)(val)))
172 #define SET_SI(context,val)  ((void)((context)->Esi = ((context)->Esi & ~0xffff) | (WORD)(val)))
173 #define SET_DI(context,val)  ((void)((context)->Edi = ((context)->Edi & ~0xffff) | (WORD)(val)))
174
175 #define SET_AL(context,val)  ((void)((context)->Eax = ((context)->Eax & ~0xff) | (BYTE)(val)))
176 #define SET_BL(context,val)  ((void)((context)->Ebx = ((context)->Ebx & ~0xff) | (BYTE)(val)))
177 #define SET_CL(context,val)  ((void)((context)->Ecx = ((context)->Ecx & ~0xff) | (BYTE)(val)))
178 #define SET_DL(context,val)  ((void)((context)->Edx = ((context)->Edx & ~0xff) | (BYTE)(val)))
179
180 #define SET_AH(context,val)  ((void)((context)->Eax = ((context)->Eax & ~0xff00) | (((BYTE)(val)) << 8)))
181 #define SET_BH(context,val)  ((void)((context)->Ebx = ((context)->Ebx & ~0xff00) | (((BYTE)(val)) << 8)))
182 #define SET_CH(context,val)  ((void)((context)->Ecx = ((context)->Ecx & ~0xff00) | (((BYTE)(val)) << 8)))
183 #define SET_DH(context,val)  ((void)((context)->Edx = ((context)->Edx & ~0xff00) | (((BYTE)(val)) << 8)))
184
185 /* module.c */
186 extern void WINAPI MZ_LoadImage( LPCSTR filename, HANDLE hFile );
187 extern BOOL WINAPI MZ_Exec( CONTEXT86 *context, LPCSTR filename, BYTE func, LPVOID paramblk );
188 extern void WINAPI MZ_Exit( CONTEXT86 *context, BOOL cs_psp, WORD retval );
189 extern BOOL WINAPI MZ_Current( void );
190 extern void WINAPI MZ_AllocDPMITask( void );
191 extern void WINAPI MZ_RunInThread( PAPCFUNC proc, ULONG_PTR arg );
192 extern BOOL DOSVM_IsWin16(void);
193
194 /* dosvm.c */
195 extern void DOSVM_SendQueuedEvents( CONTEXT86 * );
196 extern void WINAPI DOSVM_AcknowledgeIRQ( CONTEXT86 * );
197 extern INT WINAPI DOSVM_Enter( CONTEXT86 *context );
198 extern void WINAPI DOSVM_Wait( CONTEXT86 * );
199 extern DWORD WINAPI DOSVM_Loop( HANDLE hThread );
200 extern void WINAPI DOSVM_QueueEvent( INT irq, INT priority, DOSRELAY relay, LPVOID data );
201 extern void WINAPI DOSVM_PIC_ioport_out( WORD port, BYTE val );
202 extern void WINAPI DOSVM_SetTimer( UINT ticks );
203 extern UINT WINAPI DOSVM_GetTimer( void );
204 extern BIOSDATA   *DOSVM_BiosData( void );
205
206 /* devices.c */
207 extern void DOSDEV_InstallDOSDevices(void);
208 extern DWORD DOSDEV_Console(void);
209 extern DWORD DOSDEV_FindCharDevice(char*name);
210 extern int DOSDEV_Peek(DWORD dev, BYTE*data);
211 extern int DOSDEV_Read(DWORD dev, DWORD buf, int buflen);
212 extern int DOSDEV_Write(DWORD dev, DWORD buf, int buflen, int verify);
213 extern int DOSDEV_IoctlRead(DWORD dev, DWORD buf, int buflen);
214 extern int DOSDEV_IoctlWrite(DWORD dev, DWORD buf, int buflen);
215 extern void DOSDEV_SetSharingRetry(WORD delay, WORD count);
216 extern SEGPTR DOSDEV_GetLOL(BOOL v86);
217
218 /* dma.c */
219 extern int DMA_Transfer(int channel,int reqlength,void* buffer);
220 extern void DMA_ioport_out( WORD port, BYTE val );
221 extern BYTE DMA_ioport_in( WORD port );
222
223 /* dosaspi.c */
224 void WINAPI DOSVM_ASPIHandler(CONTEXT86*);
225
226 /* dosconf.c */
227 DOSCONF *DOSCONF_GetConfig( void );
228
229 /* fpu.c */
230 extern void WINAPI DOSVM_Int34Handler(CONTEXT86*);
231 extern void WINAPI DOSVM_Int35Handler(CONTEXT86*);
232 extern void WINAPI DOSVM_Int36Handler(CONTEXT86*);
233 extern void WINAPI DOSVM_Int37Handler(CONTEXT86*);
234 extern void WINAPI DOSVM_Int38Handler(CONTEXT86*);
235 extern void WINAPI DOSVM_Int39Handler(CONTEXT86*);
236 extern void WINAPI DOSVM_Int3aHandler(CONTEXT86*);
237 extern void WINAPI DOSVM_Int3bHandler(CONTEXT86*);
238 extern void WINAPI DOSVM_Int3cHandler(CONTEXT86*);
239 extern void WINAPI DOSVM_Int3dHandler(CONTEXT86*);
240 extern void WINAPI DOSVM_Int3eHandler(CONTEXT86*);
241
242 /* himem.c */
243 extern void DOSVM_InitSegments(void);
244 extern LPVOID DOSVM_AllocUMB(DWORD);
245 extern LPVOID DOSVM_AllocCodeUMB(DWORD, WORD *, WORD *);
246 extern LPVOID DOSVM_AllocDataUMB(DWORD, WORD *, WORD *);
247
248 /* int09.c */
249 extern void WINAPI DOSVM_Int09Handler(CONTEXT86*);
250 extern void WINAPI DOSVM_Int09SendScan(BYTE scan,BYTE ascii);
251 extern BYTE WINAPI DOSVM_Int09ReadScan(BYTE*ascii);
252
253 /* int10.c */
254 extern void WINAPI DOSVM_Int10Handler(CONTEXT86*);
255 extern void WINAPI DOSVM_PutChar(BYTE ascii);
256
257 /* int11.c */
258 extern void WINAPI DOSVM_Int11Handler(CONTEXT86*);
259
260 /* int12.c */
261 extern void WINAPI DOSVM_Int12Handler(CONTEXT86*);
262
263 /* int13.c */
264 extern void WINAPI DOSVM_Int13Handler(CONTEXT86*);
265
266 /* int15.c */
267 extern void WINAPI DOSVM_Int15Handler(CONTEXT86*);
268
269 /* int1a.c */
270 extern void WINAPI DOSVM_Int1aHandler(CONTEXT86*);
271
272 /* int16.c */
273 extern void WINAPI DOSVM_Int16Handler(CONTEXT86*);
274 extern BOOL WINAPI DOSVM_Int16ReadChar( BYTE *, BYTE *, CONTEXT86 * );
275 extern int WINAPI DOSVM_Int16AddChar(BYTE ascii,BYTE scan);
276
277 /* int17.c */
278 extern void WINAPI DOSVM_Int17Handler(CONTEXT86*);
279
280 /* int19.c */
281 extern void WINAPI DOSVM_Int19Handler(CONTEXT86*);
282
283 /* int20.c */
284 extern void WINAPI DOSVM_Int20Handler(CONTEXT86*);
285
286 /* int21.c */
287 extern void WINAPI DOSVM_Int21Handler(CONTEXT86*);
288
289 /* int25.c */
290 BOOL DOSVM_RawRead( BYTE, DWORD, DWORD, BYTE *, BOOL );
291 void WINAPI DOSVM_Int25Handler( CONTEXT86 * );
292
293 /* int26.c */
294 BOOL DOSVM_RawWrite( BYTE, DWORD, DWORD, BYTE *, BOOL );
295 void WINAPI DOSVM_Int26Handler( CONTEXT86 * );
296
297 /* int29.c */
298 extern void WINAPI DOSVM_Int29Handler(CONTEXT86*);
299
300 /* int2a.c */
301 extern void WINAPI DOSVM_Int2aHandler(CONTEXT86*);
302
303 /* int2f.c */
304 extern void WINAPI DOSVM_Int2fHandler(CONTEXT86*);
305
306 /* int31.c */
307 extern void WINAPI DOSVM_Int31Handler(CONTEXT86*);
308 extern void WINAPI DOSVM_RawModeSwitchHandler(CONTEXT86*);
309 extern BOOL DOSVM_IsDos32(void);
310 extern FARPROC16 WINAPI DPMI_AllocInternalRMCB(RMCBPROC);
311 extern void WINAPI DPMI_FreeInternalRMCB(FARPROC16);
312 extern int DPMI_CallRMProc(CONTEXT86*,LPWORD,int,int);
313 extern BOOL DOSVM_CheckWrappers(CONTEXT86*);
314
315 /* int33.c */
316 extern void WINAPI DOSVM_Int33Handler(CONTEXT86*);
317 extern void WINAPI DOSVM_Int33Message(UINT,WPARAM,LPARAM);
318 extern void WINAPI DOSVM_Int33Console(MOUSE_EVENT_RECORD*);
319
320 /* int41.c */
321 extern void WINAPI DOSVM_Int41Handler(CONTEXT86*);
322
323 /* int4b.c */
324 extern void WINAPI DOSVM_Int4bHandler(CONTEXT86*);
325
326 /* int5c.c */
327 extern void WINAPI DOSVM_Int5cHandler(CONTEXT86*);
328
329 /* int67.c */
330 extern void WINAPI DOSVM_Int67Handler(CONTEXT86*);
331 extern void WINAPI EMS_Ioctl_Handler(CONTEXT86*);
332
333 /* interrupts.c */
334 extern void WINAPI DOSVM_CallBuiltinHandler( CONTEXT86 *, BYTE );
335 extern void WINAPI DOSVM_EmulateInterruptPM( CONTEXT86 *, BYTE );
336 extern BOOL WINAPI DOSVM_EmulateInterruptRM( CONTEXT86 *, BYTE );
337 extern FARPROC16   DOSVM_GetPMHandler16( BYTE );
338 extern FARPROC48   DOSVM_GetPMHandler48( BYTE );
339 extern FARPROC16   DOSVM_GetRMHandler( BYTE );
340 extern void        DOSVM_HardwareInterruptPM( CONTEXT86 *, BYTE );
341 extern void        DOSVM_HardwareInterruptRM( CONTEXT86 *, BYTE );
342 extern void        DOSVM_SetPMHandler16( BYTE, FARPROC16 );
343 extern void        DOSVM_SetPMHandler48( BYTE, FARPROC48 );
344 extern void        DOSVM_SetRMHandler( BYTE, FARPROC16 );
345
346 /* relay.c */
347 void DOSVM_RelayHandler( CONTEXT86 * );
348 void DOSVM_BuildCallFrame( CONTEXT86 *, DOSRELAY, LPVOID );
349
350 /* soundblaster.c */
351 extern void SB_ioport_out( WORD port, BYTE val );
352 extern BYTE SB_ioport_in( WORD port );
353
354 /* ppdev.c */
355 extern BOOL IO_pp_outp(int port, DWORD* res);
356 extern int IO_pp_inp(int port, DWORD* res);
357 extern char IO_pp_init(void);
358
359 /* timer.c */
360 extern void WINAPI DOSVM_Int08Handler(CONTEXT86*);
361
362 /* xms.c */
363 extern void WINAPI XMS_Handler(CONTEXT86*);
364
365 #endif /* __WINE_DOSEXE_H */