src/devices/oprom/include/x86emu/x86emu.h

   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 public specific functions.
  36 *               Any application linking against us should only
  37 *               include this header
  38 *
  39 ****************************************************************************/
  40 /* $XFree86: xc/extras/x86emu/include/x86emu.h,v 1.2 2000/11/21 23:10:25 tsi Exp $ */
  41
  42 #ifndef __X86EMU_X86EMU_H
  43 #define __X86EMU_X86EMU_H
  44
  45 #include <stddef.h>
  46 #include <console/console.h>
  47 #if CONFIG_X86EMU_DEBUG
  48 #define DEBUG
  49 #endif
  50
  51 #include "types.h"
  52 #define X86API
  53 #define X86APIP *
  54 #include "regs.h"
  55
  56 /*---------------------- Macros and type definitions ----------------------*/
  57
  58 #pragma pack(1)
  59
  60 /****************************************************************************
  61 REMARKS:
  62 Data structure containing ponters to programmed I/O functions used by the
  63 emulator. This is used so that the user program can hook all programmed
  64 I/O for the emulator to handled as necessary by the user program. By
  65 default the emulator contains simple functions that do not do access the
  66 hardware in any way. To allow the emualtor access the hardware, you will
  67 need to override the programmed I/O functions using the X86EMU_setupPioFuncs
  68 function.
  69
  70 HEADER:
  71 x86emu.h
  72
  73 MEMBERS:
  74 inb             - Function to read a byte from an I/O port
  75 inw             - Function to read a word from an I/O port
  76 inl     - Function to read a dword from an I/O port
  77 outb    - Function to write a byte to an I/O port
  78 outw    - Function to write a word to an I/O port
  79 outl    - Function to write a dword to an I/O port
  80 ****************************************************************************/
  81 typedef struct {
  82         u8      (X86APIP inb)(X86EMU_pioAddr addr);
  83         u16     (X86APIP inw)(X86EMU_pioAddr addr);
  84         u32     (X86APIP inl)(X86EMU_pioAddr addr);
  85         void    (X86APIP outb)(X86EMU_pioAddr addr, u8 val);
  86         void    (X86APIP outw)(X86EMU_pioAddr addr, u16 val);
  87         void    (X86APIP outl)(X86EMU_pioAddr addr, u32 val);
  88         } X86EMU_pioFuncs;
  89
  90 /****************************************************************************
  91 REMARKS:
  92 Data structure containing ponters to memory access functions used by the
  93 emulator. This is used so that the user program can hook all memory
  94 access functions as necessary for the emulator. By default the emulator
  95 contains simple functions that only access the internal memory of the
  96 emulator. If you need specialised functions to handle access to different
  97 types of memory (ie: hardware framebuffer accesses and BIOS memory access
  98 etc), you will need to override this using the X86EMU_setupMemFuncs
  99 function.
 100
 101 HEADER:
 102 x86emu.h
 103
 104 MEMBERS:
 105 rdb             - Function to read a byte from an address
 106 rdw             - Function to read a word from an address
 107 rdl     - Function to read a dword from an address
 108 wrb             - Function to write a byte to an address
 109 wrw     - Function to write a word to an address
 110 wrl     - Function to write a dword to an address
 111 ****************************************************************************/
 112 typedef struct {
 113         u8      (X86APIP rdb)(u32 addr);
 114         u16     (X86APIP rdw)(u32 addr);
 115         u32     (X86APIP rdl)(u32 addr);
 116         void    (X86APIP wrb)(u32 addr, u8 val);
 117         void    (X86APIP wrw)(u32 addr, u16 val);
 118         void    (X86APIP wrl)(u32 addr, u32 val);
 119         } X86EMU_memFuncs;
 120
 121 /****************************************************************************
 122   Here are the default memory read and write
 123   function in case they are needed as fallbacks.
 124 ***************************************************************************/
 125 extern u8 X86API rdb(u32 addr);
 126 extern u16 X86API rdw(u32 addr);
 127 extern u32 X86API rdl(u32 addr);
 128 extern void X86API wrb(u32 addr, u8 val);
 129 extern void X86API wrw(u32 addr, u16 val);
 130 extern void X86API wrl(u32 addr, u32 val);
 131
 132 #pragma pack()
 133
 134 /*--------------------- type definitions -----------------------------------*/
 135
 136 typedef void (X86APIP X86EMU_intrFuncs)(int num);
 137 extern X86EMU_intrFuncs _X86EMU_intrTab[256];
 138
 139 /*-------------------------- Function Prototypes --------------------------*/
 140
 141 #ifdef  __cplusplus
 142 extern "C" {                                    /* Use "C" linkage when in C++ mode */
 143 #endif
 144
 145 void    X86EMU_setupMemFuncs(X86EMU_memFuncs *funcs);
 146 void    X86EMU_setupPioFuncs(X86EMU_pioFuncs *funcs);
 147 void    X86EMU_setupIntrFuncs(X86EMU_intrFuncs funcs[]);
 148 void    X86EMU_prepareForInt(int num);
 149
 150 void X86EMU_setMemBase(void *base, size_t size);
 151
 152 /* decode.c */
 153
 154 void    X86EMU_exec(void);
 155 void    X86EMU_halt_sys(void);
 156
 157 #if CONFIG_X86EMU_DEBUG
 158 #define HALT_SYS()      \
 159         printf("halt_sys: in %s\n", __func__);  \
 160         X86EMU_halt_sys();
 161 #else
 162 #define HALT_SYS()      X86EMU_halt_sys()
 163 #endif
 164
 165 /* Debug options */
 166
 167 #define DEBUG_DECODE_F          0x000001 /* print decoded instruction  */
 168 #define DEBUG_TRACE_F           0x000002 /* dump regs before/after execution */
 169 #define DEBUG_STEP_F            0x000004
 170 #define DEBUG_DISASSEMBLE_F     0x000008
 171 #define DEBUG_BREAK_F           0x000010
 172 #define DEBUG_SVC_F             0x000020
 173 #define DEBUG_FS_F              0x000080
 174 #define DEBUG_PROC_F            0x000100
 175 #define DEBUG_SYSINT_F          0x000200 /* bios system interrupts. */
 176 #define DEBUG_TRACECALL_F       0x000400
 177 #define DEBUG_INSTRUMENT_F      0x000800
 178 #define DEBUG_MEM_TRACE_F       0x001000
 179 #define DEBUG_IO_TRACE_F        0x002000
 180 #define DEBUG_TRACECALL_REGS_F  0x004000
 181 #define DEBUG_DECODE_NOPRINT_F  0x008000
 182 #define DEBUG_SAVE_IP_CS_F      0x010000
 183 #define DEBUG_TRACEJMP_F        0x020000
 184 #define DEBUG_TRACEJMP_REGS_F   0x040000
 185 #define DEBUG_SYS_F             (DEBUG_SVC_F|DEBUG_FS_F|DEBUG_PROC_F)
 186
 187 void    X86EMU_trace_regs(void);
 188 void    X86EMU_trace_xregs(void);
 189 void    X86EMU_dump_memory(u16 seg, u16 off, u32 amt);
 190 int     X86EMU_trace_on(void);
 191 int     X86EMU_trace_off(void);
 192
 193 #ifdef  __cplusplus
 194 }                                               /* End of "C" linkage for C++           */
 195 #endif
 196
 197 #endif /* __X86EMU_X86EMU_H */