/*	
 *	clipm69.h
 *
 *	P/ECE M6809 Emulator
 *
 *	CLiP - Common Library for P/ECE
 *	Copyright (C) 2001-2004 Naoyuki Sawa
 *
 *	* Wed Feb 11 17:45:00 JST 2004 Naoyuki Sawa
 *	- 作成開始。
 */
#ifndef __CLIP_M69_H__
#define __CLIP_M69_H__

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

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

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

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

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

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

#ifdef M6809_TRACE
#define M6809TRACE	TRACE
#else /*M6809_TRACE*/
#define M6809TRACE	1 ? ((void)0) : TRACE
#endif /*M6809_TRACE*/

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

typedef struct _M6809 M6809;

/*
 *	M6809コア外部関数の型定義
 */
typedef unsigned char M6809READPROC (M6809* m6809, unsigned short addr);
typedef          void M6809WRITEPROC(M6809* m6809, unsigned short addr, unsigned char data);

/*
 *	M6809コア
 */
/*typedef*/ struct _M6809 {
	/*===== レジスタ =====*/
	unsigned char cc;		/* + 0, 1 */
	unsigned char dp;		/* + 1, 1 */
	unsigned short d;		/* + 2, 2 */
	unsigned short x;		/* + 4, 2 */
	unsigned short y;		/* + 6, 2 */
	unsigned short u;		/* + 8, 2 */
	unsigned short s;		/* +10, 2 */
	unsigned short pc;		/* +12, 2 */
	/*===== 内部状態 =====*/
	unsigned char pending;		/* +14, 1 */
	unsigned char wait;		/* +15, 1 */
	int cycle;			/* +16, 4 */
	/*===== 外部関数 =====*/
	M6809READPROC* read;		/* +20, 4 */
	M6809WRITEPROC* write;		/* +24, 4 */
} /*M6809*/;				/* =28    */

/* M6809.pending */
#define M6809_FIRQ_PENDING	(1 << 0)	/* FIRQが保留中 (優先度高) */
#define M6809_IRQ_PENDING	(1 << 1)	/* IRQ が保留中 (優先度低) */

/*
 *	リセット・割り込みベクタ
 */
#define M6809_RESET_VECTOR	0xfffe		/* Reset (#RESET) */
#define M6809_NMI_VECTOR	0xfffc		/* Non-Maskable Interrupt (#NMI) */
#define M6809_SWI_VECTOR	0xfffa		/* Software Interrupt (SWI) */
#define M6809_IRQ_VECTOR	0xfff8		/* Interrupt Request (#IRQ) */
#define M6809_FIRQ_VECTOR	0xfff6		/* Fast Interrupt Request (#FIRQ) */
#define M6809_SWI2_VECTOR	0xfff4		/* Software Interrupt 2 (SWI2) */
#define M6809_SWI3_VECTOR	0xfff2		/* Software Interrupt 3 (SWI3) */
#define M6809_RESERVED_VECTOR	0xfff0		/* Reserved */

/*
 *	インストラクション関数宣言
 */
typedef                  void M6809OPPROC (M6809* m6809, int code, int arg);
#define M6809FN_(OP, FN) void m6809op_##FN(M6809* m6809, int code, int arg);	/* 宣言用 */
#include "m6809/list.h" /* [m6809.xls]List */
M6809FN_("10_INHERENT" , 10_INHERENT )
M6809FN_("11_INHERENT" , 11_INHERENT )
M6809FN_("ERR_INHERENT", ERR_INHERENT)
#undef  M6809FN_
#define M6809FN_(    FN) void m6809op_##FN(M6809* m6809, int code, int arg)	/* 定義用 */

/*
 *	オペコードマップ・インストラクション名テーブル
 */
typedef struct _M6809OP {
	M6809OPPROC* proc;	/* + 0, 4 */
	unsigned char addr;	/* + 4, 1 */
	unsigned char cycle;	/* + 5, 1 */
	unsigned short name;	/* + 6, 2 m6809_op_name_table[]内の文字列へのオフセットです */
} M6809OP;			/* = 8    */
#define M6809OP_(CODE, MNEMONIC, ADDRMODE, FUNCTYPE, CYCLE, NAME)	{ m6809op_##MNEMONIC##_##FUNCTYPE, M6809_##ADDRMODE, CYCLE, 0x##NAME },
extern const M6809OP m6809_op_table[256/*XX*/];		/* opcode = XX */
extern const M6809OP m6809_op_table_10[256/*XX*/];	/* opcode = 10XX */
extern const M6809OP m6809_op_table_11[256/*XX*/];	/* opcode = 11XX */
extern const char m6809_op_name_table[];	/* インストラクション名テーブル */

/***** M6809OP.addr *****/
/*==== operand bytes=0 ====*/
#define M6809_INHERENT		0
/*==== operand bytes=1 ====*/
#define M6809_IMMEDIATE1	1
#define M6809_DIRECT		2
#define M6809_RELATIVE1		3
/*==== operand bytes=2 ====*/
#define M6809_IMMEDIATE2	4
#define M6809_EXTENDED		5
#define M6809_RELATIVE2		6
/*==== operand bytes=? ====*/
#define M6809_INDEXED		7

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

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

/* 保留されているマスク可能割り込みを検査し、条件が整っていたら割り込みを実行します。
 * CC(I,F)またはPENDINGが変化する可能性のある処理を行った後に、必ず呼び出してください。
 */
void m6809_check_pending(M6809* m6809);

/* 割り込みを実行します。
 */
void m6809_int(M6809* m6809, int vector, int entire);

/* 割り込みから復帰します。
 */
void m6809_rti(M6809* m6809);

/* 1命令または1プレバイトをフェッチ、実行します。
 */
void m6809_one(M6809* m6809, const M6809OP op_table[/*256*/]);

/* インデクスアドレッシングを処理します。
 */
int m6809_indexed(M6809* m6809);

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

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

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

/* マスク不可割り込み(NMI)リクエストを発行します。
 * [in]
 *	m6809		M6809構造体。
 * [note]
 *	* いちばん優先度が高い割り込みリクエストです。
 *	* マスク不可能割り込みリクエストは、即座に受け付けられます。
 *	* CC(E)をセットして全レジスタを退避し、CC(I,F)両方をセット(=禁止)します。
 */
void m6809_nmi(M6809* m6809);

/* マスク可能高速割り込み(FIRQ)リクエストを発行します。
 * [in]
 *	m6809		M6809構造体。
 * [note]
 *	* NMIよりも優先度が低く、IRQよりも優先度が高い割り込みリクエストです。
 *	* CC(F)がセットされていたら、割り込みリクエストは保留されます。
 *	  CC(F)がクリアされたときに、割り込み処理を実行します。
 *	* CC(E)をクリアして{PC,CC}を退避し、CC(I,F)両方をセット(=禁止)します。
 */
void m6809_firq(M6809* m6809);

/* マスク可能割り込み(IRQ)リクエストを発行します。
 * [in]
 *	m6809		M6809構造体。
 * [note]
 *	* いちばん優先度が低い割り込みリクエストです。
 *	* CC(I)がセットされていたら、割り込みリクエストは保留されます。
 *	  CC(I)がクリアされたときに、割り込み処理を実行します。
 *	* CC(E)をセットして全レジスタを退避し、CC(I)だけをセット(=禁止)します。
 */
void m6809_irq(M6809* m6809);

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

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

#endif /*__CLIP_M69_H__*/
