/*	
 *	clipm65.h
 *
 *	P/ECE MOS6502 Emulator
 *
 *	CLiP - Common Library for P/ECE
 *	Copyright (C) 2001-2003 Naoyuki Sawa
 *
 *	* Sat Dec 07 12:00:00 JST 2003 Naoyuki Sawa
 *	- 作成開始。
 *	* Wed Nov 18 21:37:53 JST 2015 Naoyuki Sawa
 *	- 'extern "C" {'〜'}'で囲みました。.cppを含むWin32プロジェクトからもインクルード出来るようにするためです。
 */
#ifndef __CLIP_M65_H__
#define __CLIP_M65_H__

#ifdef  __cplusplus
extern "C" {
#endif//__cplusplus

/****************************************************************************
 *
 ****************************************************************************/

/* M6502_ASMシンボル定義を読み込みます。
 * M6502_ASMシンボルの未定義/定義によるC/アセンブラコードの切り替えは、
 * Cソースファイル(*.c)とアセンブラソースファイル(*.s)から参照するので、
 * 別のインクルードファイルに分けています。
 * (C言語特有の定義を含むインクルードファイルをそのままアセンブラソースに
 *  インクルードすると、アセンブルエラーになってしまうため。)
 */
#include "clipm65a.h"

/* このシンボルを定義すると、全ての命令実行をトレース出力します。
 * このシンボルを定義しなければ、各命令実行はトレース出力しません。
 * 全ての命令実行をトレースするととても遅くなるので、通常は定義しないでください。
 * なお、このシンボルを定義しても、全体のトレースON指示“TRACE_ON=1”がなければ、
 * トレース出力は行われません。
 */
//#define M6502_TRACE

/********** これ以降は書き換えないでください **********/

/* P/ECE以外ではアセンブラコードは使用できません。
 */
#ifndef PIECE
#undef M6502_ASM
#endif /*PIECE*/

/* アセンブラコードは全命令トレースに対応していないので、
 * アセンブラコード使用時は確実に全命令トレースをOFFにします。
 */
#ifdef M6502_ASM
#undef M6502_TRACE
#endif /*M6502_ASM*/ 

#ifdef M6502_TRACE
#define M6502TRACE	TRACE
#else /*M6502_TRACE*/
#define M6502TRACE	1 ? ((void)0) : TRACE
#endif /*M6502_TRACE*/

/****************************************************************************
 *
 ****************************************************************************/

typedef struct _M6502 M6502;

/*
 *	M6502コア外部関数の型定義
 */
typedef unsigned char M6502READPROC (M6502* m6502, unsigned short addr);
typedef          void M6502WRITEPROC(M6502* m6502, unsigned short addr, unsigned char data);

/*
 *	M6502コア
 */
/*typedef*/ struct _M6502 {
	/*===== レジスタ =====*/
	unsigned char a;		/* + 0, 1 */
	unsigned char x;		/* + 1, 1 */
	unsigned char y;		/* + 2, 1 */
	unsigned char resv1[1];		/* + 3, 1 */
	unsigned short pc;		/* + 4, 2 */
	unsigned char sp;		/* + 6, 1 */
	unsigned char psr;		/* + 7, 1 */
	/*===== 内部状態 =====*/
	int cycle;			/* + 8, 4 */
	unsigned char wait;		/* +12, 1 */
	unsigned char resv2[3];		/* +13, 3 */
	/*===== 外部関数 =====*/
	M6502READPROC* read;		/* +16, 4 */
	M6502WRITEPROC* write;		/* +20, 4 */
} /*M6502*/;				/* =24    */

/*
 *	インストラクション関数宣言
 */
typedef                  void M6502OPPROC (M6502* m6502, unsigned char code, unsigned short arg);
#define M6502FN_(OP, FN) void m6502op_##FN(M6502* m6502, unsigned char code, unsigned short arg);	/* 宣言用 */
#include "m6502/list.h" /* [m6502.xls]List!C6 */
M6502FN_("ERR_IMPLIED", ERR_IMPLIED)
#undef  M6502FN_
#define M6502FN_(    FN) void m6502op_##FN(M6502* m6502, unsigned char code, unsigned short arg)	/* 定義用 */

/*
 *	オペコードマップ・ニーモニックテーブル
 */
typedef struct _M6502OP {
	M6502OPPROC* proc;	/* + 0, 4 */
	unsigned char mode;	/* + 4, 1 */
	unsigned char cycle;	/* + 5, 1 */
	unsigned short name;	/* + 6, 2 m6502_op_name_table[]内の文字列へのオフセットです */
} M6502OP;			/* = 8    */
#define M6502OP_(CODE, PROC, ADDR_MODE, FUNC_TYPE, CYCLE, NAME)	{ m6502op_##PROC##_##FUNC_TYPE, M6502_##ADDR_MODE, CYCLE, 0x##NAME },
extern const M6502OP m6502_op_table[256/*opcode*/];
extern const char m6502_op_name_table[];	/* ニーモニックテーブル */

/***** M6502OP.mode *****/
/*==== bytes=1 ====*/
#define M6502_IMPLIED		 0
#define M6502_ACCUMULATOR	 1
/*==== bytes=2 ====*/
#define M6502_IMMEDIATE		 2
#define M6502_RELATIVE		 3
#define M6502_ZEROPAGE		 4
#define M6502_ZEROPAGE_X	 5
#define M6502_ZEROPAGE_Y	 6
#define M6502_INDIRECT_X	 7
#define M6502_INDIRECT_Y	 8
/*==== bytes=3 ====*/
#define M6502_ABSOLUTE		 9
#define M6502_ABSOLUTE_X	10
#define M6502_ABSOLUTE_Y	11
#define M6502_INDIRECT		12

/****************************************************************************
 *	内部関数
 ****************************************************************************/

/* M6502リセット時に設定される、M6502コア内蔵のメインメモリREAD/WRITEの外部関数です。
 * アプリケーションから直接呼び出すことはありません。
 */
unsigned char m6502_internal_read (M6502* m6502, unsigned short addr);
         void m6502_internal_write(M6502* m6502, unsigned short addr, unsigned char data);

/****************************************************************************
 *	アプリケーション用関数
 ****************************************************************************/

/* M6502をリセットします。
 * [in]
 *	m6502		M6502構造体。
 *	read		メインメモリREAD 外部関数 (NULL:コア内蔵関数を使用)
 *	write		メインメモリWRITE外部関数 (NULL:コア内蔵関数を使用)
 * [note]
 *	* read,writeにNULLを指定すると、コア内蔵の外部関数を使用します。
 *	  コア内蔵の外部関数は、次のような動作を行います。
 *	  ・READ	M6502構造体の直後に64KBのメインメモリが配置されていると仮定し、メインメモリを読み込みます。
 *	  ・WRITE	M6502構造体の直後に64KBのメインメモリが配置されていると仮定し、メインメモリに書き込みます。
 */
void m6502_reset(M6502* m6502, M6502READPROC* read, M6502WRITEPROC* write);

/* M6502を実行します。
 * [in]
 *	m6502		M6502構造体。
 *	cycle		実行サイクル数。
 * [note]
 *	* 実行サイクル数がcycleに達するか、またはWAIT状態になるまで実行します。
 *	  前者の場合、実際の実行サイクル数は、cycleよりも多くなる可能性があります。
 *	  後者の場合、実際の実行サイクル数は、cycleよりも少なくなる可能性があります。
 *	* この関数から戻ったとき、m6502->cycleに残り実行サイクル数が格納されています。
 *	  例えば cycle=100 で呼び出し、実際には 105 サイクル実行した場合、m6502->cycle=-5 となります。
 */
void m6502_run(M6502* m6502, int cycle);

/* マスク可能割り込みリクエストを発行します。
 * [in]
 *	m6502		M6502構造体。
 * [note]
 *	* 割り込みが禁止されていたら、割り込みリクエストは無視されます。
 *	  割り込みリクエストは保留されません。
 */
void m6502_int(M6502* m6502);

/* BRK命令を実行します。
 * [in]
 *	m6502		M6502構造体。
 * [note]
 *	* 内部使用です。
 *	  アプリケーションプログラムからは呼び出さないで下さい。
 */
void m6502_brk(M6502* m6502);

/* マスク不可割り込みリクエストを発行します。
 * [in]
 *	m6502		M6502構造体。
 */
void m6502_nmi(M6502* m6502);

/* 標準エラー出力に、レジスタダンプを行います。
 * [in]
 *	m6502		M6502構造体。
 */
void m6502_dump(M6502* m6502);

#ifdef PIECE
/* M6502を実行します。(スタック切替・高速版)
 * [in]
 *	m6502		M6502構造体。
 *	cycle		実行サイクル数。
 * [note]
 *	* m6502_run()との違いは、この関数の実行中のみ、スタックを0x0e00〜0x1000の高速RAMに切り換えることです。
 *	- 0x0e00〜0x1000は、P/ECEカーネルが同期的に高速RAMルーチンを転送して使用するエリアです。
 *	  例えば、pceLCDTrans()やpceFileWriteSct()等が、このエリアに高速RAMルーチンを転送します。
 *	  同期的に使用されるため、これらのAPIによって0x0e00〜0x1000が破壊されることを留意しておけば、
 *	  アプリケーションプログラムがこの領域を使うことも可能です。
 *	- m6502_run()の実装は、call使用回数が非常に多いため、スタックを高速RAMに移すことには意味があります。
 *	  m6502_run2()はスタックを0x1000に移した後、m6502_run()を呼び出し、スタックを元に戻して処理を返します。
 *	- スタックエリアは0x0e00〜0x1000の512バイトしかないので、m6502_run2()の使用には条件があります。
 *	  ・m6502_run()とそこから呼ばれる命令処理関数は、大きなスタックフレームを確保してはいけません。
 *	    各命令処理の実装を変更する場合は、注意してください。
 *	  ・m6502_run()から呼ばれる外部関数(READ/WRITE)では、大きなスタックフレームを確保してはいけません。
 *	  ・スタックをたくさん消費するような割り込みルーチンとの併用は不可です。
 *	    スタックが0x0e00〜0x1000に切り替わっているときに割り込みが発生すると、スタックがあふれる恐れがあるからです。
 *	  ・m6502_run2()を割り込みルーチン内で呼び出してはいけません。
 *	    前面で、pceLCDTrans()が0x0e00〜0x1000エリアを使用中である可能性があるからです。
 *	- 以上のような制約があるので、m6502_run2()の使用には充分な注意が必要です。
 *	  m6502_run()を使った場合に較べて、m6502_run2()を使った場合の効果は、約20%の高速化となります。
 */
void m6502_run2(M6502* m6502, int cycle);
#endif /*PIECE*/

#ifdef  __cplusplus
}//extern "C"
#endif//__cplusplus

#endif /*__CLIP_M65_H__*/
