f78b12e570284aa8291f4ca1add24937fd107403vboxsync/****************************************************************************
f78b12e570284aa8291f4ca1add24937fd107403vboxsync*
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* Realmode X86 Emulator Library
f78b12e570284aa8291f4ca1add24937fd107403vboxsync*
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* Copyright (C) 1996-1999 SciTech Software, Inc.
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* Copyright (C) David Mosberger-Tang
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* Copyright (C) 1999 Egbert Eich
f78b12e570284aa8291f4ca1add24937fd107403vboxsync*
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* ========================================================================
f78b12e570284aa8291f4ca1add24937fd107403vboxsync*
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* Permission to use, copy, modify, distribute, and sell this software and
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* its documentation for any purpose is hereby granted without fee,
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* provided that the above copyright notice appear in all copies and that
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* both that copyright notice and this permission notice appear in
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* supporting documentation, and that the name of the authors not be used
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* in advertising or publicity pertaining to distribution of the software
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* without specific, written prior permission. The authors makes no
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* representations about the suitability of this software for any purpose.
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* It is provided "as is" without express or implied warranty.
f78b12e570284aa8291f4ca1add24937fd107403vboxsync*
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* THE AUTHORS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* PERFORMANCE OF THIS SOFTWARE.
f78b12e570284aa8291f4ca1add24937fd107403vboxsync*
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* ========================================================================
f78b12e570284aa8291f4ca1add24937fd107403vboxsync*
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* Language: ANSI C
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* Environment: Any
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* Developer: Kendall Bennett
f78b12e570284aa8291f4ca1add24937fd107403vboxsync*
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* Description: Header file for public specific functions.
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* Any application linking against us should only
f78b12e570284aa8291f4ca1add24937fd107403vboxsync* include this header
f78b12e570284aa8291f4ca1add24937fd107403vboxsync*
f78b12e570284aa8291f4ca1add24937fd107403vboxsync****************************************************************************/
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#ifndef __X86EMU_X86EMU_H
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define __X86EMU_X86EMU_H
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#ifdef SCITECH
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#include "scitech.h"
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define X86API _ASMAPI
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define X86APIP _ASMAPIP
f78b12e570284aa8291f4ca1add24937fd107403vboxsynctypedef int X86EMU_pioAddr;
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#else
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#include "x86emu/types.h"
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define X86API
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define X86APIP *
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#endif
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#include "x86emu/regs.h"
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsync/*---------------------- Macros and type definitions ----------------------*/
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#ifdef PACK
f78b12e570284aa8291f4ca1add24937fd107403vboxsync# pragma PACK /* Don't pack structs with function pointers! */
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#endif
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsync/****************************************************************************
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncREMARKS:
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncData structure containing ponters to programmed I/O functions used by the
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncemulator. This is used so that the user program can hook all programmed
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncI/O for the emulator to handled as necessary by the user program. By
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncdefault the emulator contains simple functions that do not do access the
f78b12e570284aa8291f4ca1add24937fd107403vboxsynchardware in any way. To allow the emualtor access the hardware, you will
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncneed to override the programmed I/O functions using the X86EMU_setupPioFuncs
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncfunction.
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncHEADER:
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncx86emu.h
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncMEMBERS:
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncinb - Function to read a byte from an I/O port
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncinw - Function to read a word from an I/O port
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncinl - Function to read a dword from an I/O port
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncoutb - Function to write a byte to an I/O port
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncoutw - Function to write a word to an I/O port
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncoutl - Function to write a dword to an I/O port
f78b12e570284aa8291f4ca1add24937fd107403vboxsync****************************************************************************/
f78b12e570284aa8291f4ca1add24937fd107403vboxsynctypedef struct {
f78b12e570284aa8291f4ca1add24937fd107403vboxsync u8 (X86APIP inb)(X86EMU_pioAddr addr);
f78b12e570284aa8291f4ca1add24937fd107403vboxsync u16 (X86APIP inw)(X86EMU_pioAddr addr);
f78b12e570284aa8291f4ca1add24937fd107403vboxsync u32 (X86APIP inl)(X86EMU_pioAddr addr);
f78b12e570284aa8291f4ca1add24937fd107403vboxsync void (X86APIP outb)(X86EMU_pioAddr addr, u8 val);
f78b12e570284aa8291f4ca1add24937fd107403vboxsync void (X86APIP outw)(X86EMU_pioAddr addr, u16 val);
f78b12e570284aa8291f4ca1add24937fd107403vboxsync void (X86APIP outl)(X86EMU_pioAddr addr, u32 val);
f78b12e570284aa8291f4ca1add24937fd107403vboxsync } X86EMU_pioFuncs;
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsync/****************************************************************************
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncREMARKS:
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncData structure containing ponters to memory access functions used by the
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncemulator. This is used so that the user program can hook all memory
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncaccess functions as necessary for the emulator. By default the emulator
f78b12e570284aa8291f4ca1add24937fd107403vboxsynccontains simple functions that only access the internal memory of the
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncemulator. If you need specialised functions to handle access to different
f78b12e570284aa8291f4ca1add24937fd107403vboxsynctypes of memory (ie: hardware framebuffer accesses and BIOS memory access
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncetc), you will need to override this using the X86EMU_setupMemFuncs
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncfunction.
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncHEADER:
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncx86emu.h
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncMEMBERS:
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncrdb - Function to read a byte from an address
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncrdw - Function to read a word from an address
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncrdl - Function to read a dword from an address
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncwrb - Function to write a byte to an address
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncwrw - Function to write a word to an address
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncwrl - Function to write a dword to an address
f78b12e570284aa8291f4ca1add24937fd107403vboxsync****************************************************************************/
f78b12e570284aa8291f4ca1add24937fd107403vboxsynctypedef struct {
f78b12e570284aa8291f4ca1add24937fd107403vboxsync u8 (X86APIP rdb)(u32 addr);
f78b12e570284aa8291f4ca1add24937fd107403vboxsync u16 (X86APIP rdw)(u32 addr);
f78b12e570284aa8291f4ca1add24937fd107403vboxsync u32 (X86APIP rdl)(u32 addr);
f78b12e570284aa8291f4ca1add24937fd107403vboxsync void (X86APIP wrb)(u32 addr, u8 val);
f78b12e570284aa8291f4ca1add24937fd107403vboxsync void (X86APIP wrw)(u32 addr, u16 val);
f78b12e570284aa8291f4ca1add24937fd107403vboxsync void (X86APIP wrl)(u32 addr, u32 val);
f78b12e570284aa8291f4ca1add24937fd107403vboxsync } X86EMU_memFuncs;
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsync/****************************************************************************
f78b12e570284aa8291f4ca1add24937fd107403vboxsync Here are the default memory read and write
f78b12e570284aa8291f4ca1add24937fd107403vboxsync function in case they are needed as fallbacks.
f78b12e570284aa8291f4ca1add24937fd107403vboxsync***************************************************************************/
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncextern u8 X86API rdb(u32 addr);
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncextern u16 X86API rdw(u32 addr);
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncextern u32 X86API rdl(u32 addr);
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncextern void X86API wrb(u32 addr, u8 val);
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncextern void X86API wrw(u32 addr, u16 val);
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncextern void X86API wrl(u32 addr, u32 val);
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#ifdef END_PACK
f78b12e570284aa8291f4ca1add24937fd107403vboxsync# pragma END_PACK
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#endif
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsync/*--------------------- type definitions -----------------------------------*/
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsynctypedef void (X86APIP X86EMU_intrFuncs)(int num);
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncextern X86EMU_intrFuncs _X86EMU_intrTab[256];
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsync/*-------------------------- Function Prototypes --------------------------*/
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#ifdef __cplusplus
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncextern "C" { /* Use "C" linkage when in C++ mode */
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#endif
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncvoid X86EMU_setupMemFuncs(X86EMU_memFuncs *funcs);
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncvoid X86EMU_setupPioFuncs(X86EMU_pioFuncs *funcs);
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncvoid X86EMU_setupIntrFuncs(X86EMU_intrFuncs funcs[]);
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncvoid X86EMU_prepareForInt(int num);
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsync/* decode.c */
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncvoid X86EMU_exec(void);
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncvoid X86EMU_halt_sys(void);
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#ifdef DEBUG
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define HALT_SYS() \
f78b12e570284aa8291f4ca1add24937fd107403vboxsync printk("halt_sys: file %s, line %d\n", __FILE__, __LINE__), \
f78b12e570284aa8291f4ca1add24937fd107403vboxsync X86EMU_halt_sys()
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#else
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define HALT_SYS() X86EMU_halt_sys()
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#endif
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsync/* Debug options */
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define DEBUG_DECODE_F 0x000001 /* print decoded instruction */
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define DEBUG_TRACE_F 0x000002 /* dump regs before/after execution */
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define DEBUG_STEP_F 0x000004
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define DEBUG_DISASSEMBLE_F 0x000008
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define DEBUG_BREAK_F 0x000010
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define DEBUG_SVC_F 0x000020
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define DEBUG_SAVE_IP_CS_F 0x000040
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define DEBUG_FS_F 0x000080
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define DEBUG_PROC_F 0x000100
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define DEBUG_SYSINT_F 0x000200 /* bios system interrupts. */
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define DEBUG_TRACECALL_F 0x000400
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define DEBUG_INSTRUMENT_F 0x000800
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define DEBUG_MEM_TRACE_F 0x001000
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define DEBUG_IO_TRACE_F 0x002000
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define DEBUG_TRACECALL_REGS_F 0x004000
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define DEBUG_DECODE_NOPRINT_F 0x008000
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define DEBUG_EXIT 0x010000
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#define DEBUG_SYS_F (DEBUG_SVC_F|DEBUG_FS_F|DEBUG_PROC_F)
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncvoid X86EMU_trace_regs(void);
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncvoid X86EMU_trace_xregs(void);
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncvoid X86EMU_dump_memory(u16 seg, u16 off, u32 amt);
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncint X86EMU_trace_on(void);
f78b12e570284aa8291f4ca1add24937fd107403vboxsyncint X86EMU_trace_off(void);
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#ifdef __cplusplus
f78b12e570284aa8291f4ca1add24937fd107403vboxsync} /* End of "C" linkage for C++ */
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#endif
f78b12e570284aa8291f4ca1add24937fd107403vboxsync
f78b12e570284aa8291f4ca1add24937fd107403vboxsync#endif /* __X86EMU_X86EMU_H */