x11include/xorg-server-1.8.0/x86emu.h

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