pandora: fix readme and pxml version

[picodrive.git] / cpu / fame / fame.h

/*****************************************************************************/\r
/* FAME Fast and Accurate Motorola 68000 Emulation Core                      */\r
/* (c) 2005 Oscar Orallo Pelaez                                              */\r
/* Version: 1.24                                                             */\r
/* Date: 08-20-2005                                                          */\r
/* See FAME.HTML for documentation and license information                   */\r
/*****************************************************************************/\r
\r
#ifndef __FAME_H__\r
#define __FAME_H__\r
\r
// uintptr_t\r
#include <stdlib.h>\r
#ifndef _MSC_VER\r
#include <stdint.h>\r
#endif\r
\r
#ifdef __cplusplus\r
extern "C" {\r
#endif\r
\r
// PicoDrive hacks\r
#define FAMEC_FETCHBITS 8\r
#define M68K_FETCHBANK1 (1 << FAMEC_FETCHBITS)\r
\r
//#define M68K_RUNNING    0x01\r
#define FM68K_HALTED     0x80\r
//#define M68K_WAITING    0x04\r
//#define M68K_DISABLE    0x20\r
//#define M68K_FAULTED    0x40\r
#define FM68K_EMULATE_GROUP_0  0x02\r
#define FM68K_EMULATE_TRACE    0x08\r
#define FM68K_DO_TRACE    0x10\r
\r
\r
/************************************/\r
/* General library defines          */\r
/************************************/\r
\r
#ifndef M68K_OK\r
    #define M68K_OK 0\r
#endif\r
#ifndef M68K_RUNNING\r
    #define M68K_RUNNING 1\r
#endif\r
#ifndef M68K_NO_SUP_ADDR_SPACE\r
    #define M68K_NO_SUP_ADDR_SPACE 2\r
#endif\r
#ifndef M68K_DOUBLE_BUS_FAULT\r
    #define M68K_DOUBLE_BUS_FAULT -1\r
#endif\r
#ifndef M68K_INV_REG\r
    #define M68K_INV_REG -1\r
#endif\r
\r
/* Hardware interrupt state */\r
\r
#ifndef M68K_IRQ_LEVEL_ERROR\r
    #define M68K_IRQ_LEVEL_ERROR -1\r
#endif\r
#ifndef M68K_IRQ_INV_PARAMS\r
    #define M68K_IRQ_INV_PARAMS -2\r
#endif\r
\r
/* Defines to specify hardware interrupt type */\r
\r
#ifndef M68K_AUTOVECTORED_IRQ\r
    #define M68K_AUTOVECTORED_IRQ -1\r
#endif\r
#ifndef M68K_SPURIOUS_IRQ\r
    #define M68K_SPURIOUS_IRQ -2\r
#endif\r
\r
#ifndef M68K_AUTO_LOWER_IRQ\r
	#define M68K_AUTO_LOWER_IRQ 1\r
#endif\r
#ifndef M68K_MANUAL_LOWER_IRQ\r
	#define M68K_MANUAL_LOWER_IRQ 0\r
#endif\r
\r
/* Defines to specify address space */\r
\r
#ifndef M68K_SUP_ADDR_SPACE\r
    #define M68K_SUP_ADDR_SPACE 0\r
#endif\r
#ifndef M68K_USER_ADDR_SPACE\r
    #define M68K_USER_ADDR_SPACE 2\r
#endif\r
#ifndef M68K_PROG_ADDR_SPACE\r
    #define M68K_PROG_ADDR_SPACE 0\r
#endif\r
#ifndef M68K_DATA_ADDR_SPACE\r
    #define M68K_DATA_ADDR_SPACE 1\r
#endif\r
\r
\r
/*******************/\r
/* Data definition */\r
/*******************/\r
\r
#include <pico/pico_port.h>\r
\r
/*\r
typedef unsigned char	u8;\r
typedef signed char	s8;\r
typedef unsigned short	u16;\r
typedef signed short	s16;\r
typedef unsigned int	u32;\r
typedef signed int	s32;\r
*/\r
\r
typedef union\r
{\r
	u8 B[4];\r
	s8 SB[4];\r
	u16 W[2];\r
	s16 SW[2];\r
	u32 D;\r
	s32 SD;\r
} famec_union32;\r
\r
/* M68K CPU CONTEXT */\r
typedef struct\r
{\r
	unsigned int   (*read_byte )(unsigned int a);\r
	unsigned int   (*read_word )(unsigned int a);\r
	unsigned int   (*read_long )(unsigned int a);\r
	void           (*write_byte)(unsigned int a,unsigned char  d);\r
	void           (*write_word)(unsigned int a,unsigned short d);\r
	void           (*write_long)(unsigned int a,unsigned int   d);\r
	void           (*reset_handler)(void);\r
	void           (*iack_handler)(unsigned level);\r
	famec_union32  dreg[8];\r
	famec_union32  areg[8];\r
	unsigned       asp;\r
	unsigned       pc;\r
	unsigned char  interrupts[8];\r
	unsigned short sr;\r
	unsigned short execinfo;\r
	// PD extension\r
	int            io_cycle_counter; // cycles left\r
\r
	unsigned int   Opcode;\r
	signed int     cycles_needed;\r
\r
	unsigned short *PC;\r
	uintptr_t      BasePC;\r
	unsigned int   flag_C;\r
	unsigned int   flag_V;\r
	unsigned int   flag_NotZ;\r
	unsigned int   flag_N;\r
	unsigned int   flag_X;\r
	unsigned int   flag_T;\r
	unsigned int   flag_S;\r
	unsigned int   flag_I;\r
\r
	unsigned char  not_polling;\r
	unsigned char  pad[3];\r
\r
	uintptr_t      Fetch[M68K_FETCHBANK1];\r
} M68K_CONTEXT;\r
\r
typedef enum\r
{\r
	fm68k_reason_emulate = 0,\r
	fm68k_reason_init,\r
	fm68k_reason_idle_install,\r
	fm68k_reason_idle_remove,\r
} fm68k_call_reason;\r
\r
/************************/\r
/* Function definition  */\r
/************************/\r
\r
/* General purpose functions */\r
void fm68k_init(void);\r
int  fm68k_reset(M68K_CONTEXT *ctx);\r
int  fm68k_emulate(M68K_CONTEXT *ctx, int n, fm68k_call_reason reason);\r
int  fm68k_would_interrupt(M68K_CONTEXT *ctx); // to be called from fm68k_emulate()\r
\r
u32 fm68k_get_pc(const M68K_CONTEXT *ctx);\r
\r
// PICODRIVE_HACK\r
int fm68k_idle_install(void);\r
int fm68k_idle_remove(void);\r
\r
#ifdef __cplusplus\r
}\r
#endif\r
\r
#endif\r