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