// Copyright (C) 2003 Dolphin Project.

// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, version 2.0.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License 2.0 for more details.

// A copy of the GPL 2.0 should have been included with the program.
// If not, see http://www.gnu.org/licenses/

// Official SVN repository and contact information can be found at
// http://code.google.com/p/dolphin-emu/
// Gekko related unions, structs, ...
//

#ifndef _GEKKO_H
#define _GEKKO_H

#include "Common.h"


// --- Gekko Instruction ---


union UGeckoInstruction
{
	u32 hex;

	UGeckoInstruction(u32 _hex)	{ hex = _hex;}
	UGeckoInstruction()			{ hex = 0;}

	struct
	{
		u32 Rc		:	1;
		u32 SUBOP10	:	10;
		u32 RB		:	5;
		u32 RA		:	5;
		u32 RD		:	5;
		u32 OPCD	:	6;
	}; // changed
	struct
	{
		signed SIMM_16	:	16;
		u32 			:	5;
		u32 TO			:	5;
		u32 OPCD_2		:	6;
	};
	struct
	{
		u32 Rc_2	:	1;
		u32			:	10;
		u32 		:	5;
		u32 		:	5;
		u32 RS		:	5;
		u32 OPCD_3	:	6;
	};
	struct
	{
		u32 UIMM	:	16;
		u32 		:	5;
		u32 		:	5;
		u32 OPCD_4	:	6;
	};
	struct
	{
		u32 LK		:	1;
		u32 AA		:	1;
		u32 LI		:	24;
		u32 OPCD_5	:	6;
	};
	struct
	{     
		u32 LK_2	:	1;
		u32 AA_2	:	1;
		u32 BD		:	14;
		u32 BI		:	5;
		u32 BO		:	5;
		u32 OPCD_6	:	6;
	};
	struct
	{
		u32 LK_3	:	1;
		u32			:	10;
		u32			:	5;
		u32 BI_2	:	5;
		u32 BO_2	:	5;
		u32 OPCD_7	:	6;
	};
	struct
	{
		u32			:	11;
		u32 RB_2	:	5;
		u32 RA_2	:	5;
		u32 L		:	1;
		u32 		:	1;
		u32 CRFD	:	3;
		u32 OPCD_8	:	6;
	};
	struct
	{
		signed  SIMM_16_2	:	16;
		u32 RA_3	:	5;
		u32 L_2		:	1;
		u32			:	1;
		u32 CRFD_2	:	3;
		u32 OPCD_9	:	6;
	};
	struct
	{     
		u32 UIMM_2	:	16;
		u32 RA_4	:	5;
		u32 L_3		:	1;
		u32 dummy2	:	1;
		u32 CRFD_3	:	3;
		u32 OPCD_A	:	6;
	};
	struct
	{
		u32			:	1;
		u32 SUBOP10_2:	10;
		u32 RB_5	:	5;
		u32 RA_5	:	5;
		u32 L_4		:	1;
		u32 dummy3	:	1;
		u32 CRFD_4	:	3;
		u32 OPCD_B	:	6;
	};
	struct
	{
		u32			:	16;
		u32 SR		:	4;
		u32 		:	1;
		u32 RS_2	:	5;
		u32 OPCD_C	:	6;
	};

	// Table 59
	struct
	{
		u32 Rc_4	:	1;
		u32 SUBOP5	:	5;
		u32 RC		:	5;
		u32			:	5;
		u32 RA_6	:	5;
		u32 RD_2	:	5;
		u32 OPCD_D	:	6;
	};

	struct
	{	u32			:	10;
		u32 OE		:	1;
		u32 SPR		:	10;
		u32			:	11;
	};
	struct
	{
		u32			:	10;
		u32 OE_3	:	1;
		u32 SPRU	:	5;
		u32 SPRL	:	5;
		u32			:	11;
	};

	// rlwinmx
	struct
	{
		u32 Rc_3	:	1;
		u32 ME		:	5;
		u32 MB		:	5;
		u32 SH		:	5;
		u32			:	16;
	};

	// crxor
	struct 
	{
		u32			:	11;
		u32 CRBB	:	5;
		u32 CRBA	:	5;
		u32 CRBD	:	5;		
		u32			:	6;
	};

	// mftb
	struct 
	{
		u32			:	11;
		u32 TBR		:	10;
		u32			:	11;
	};

	struct 
	{
		u32			:	11;
		u32 TBRU	:	5;
		u32 TBRL	:	5;
		u32			:	11;
	};

	struct 
	{
		u32			:	18;
		u32 CRFS	:	3;
		u32 		:	2;
		u32 CRFD_5	:	3;
		u32			:	6;
	};

	// float
	struct 
	{
		u32			:	12;
		u32 CRM		:	8;
		u32			:	1;
		u32 FD		:	5;
		u32			:	6;
	};
	struct 
	{
		u32			:	6;
		u32 FC		:	5;
		u32 FB		:	5;
		u32 FA		:	5;
		u32 FS		:	5;
		u32			:	6;
	};
	struct 
	{
		u32 OFS		:	16;
		u32			:	16;
	};
	struct
	{
		u32			:   17;
		u32 FM		:   8;
		u32			:   7;
	};

	// paired
	struct 
	{
		u32			:	7;
		u32 Ix		:	3;
		u32 Wx		:	1;
		u32			:	1;
		u32 I		:   3;
		u32 W		:   1;
		u32			:	16;
	};

	struct 
	{
		signed	SIMM_12	:	12;
		u32				:	20;
	};

	struct 
	{
		u32 dummyX	:   11;
		u32 NB		: 5;
	};
};


//
// --- Gekko Special Registers ---
//


// GQR Register
union UGQR
{
	u32 Hex;
	struct 
	{
		u32	ST_TYPE		: 3;
		u32				: 5;
		u32	ST_SCALE	: 6;
		u32				: 2;
		u32	LD_TYPE		: 3;
		u32				: 5;
		u32	LD_SCALE	: 6;
		u32				: 2;
	};

	UGQR(u32 _hex) { Hex = _hex; }
	UGQR()		{Hex = 0;  }
};

// FPU Register
union UFPR
{
	u64	as_u64;
	s64	as_s64;
	double	d;
	u32	as_u32[2];
	s32	as_s32[2];
	float	f[2];
};

#define XER_CA_MASK 0x20000000
// XER
union UReg_XER
{
	struct 
	{
		u32 BYTE_COUNT	: 7;
		u32				: 22;
		u32 CA			: 1;
		u32 OV			: 1;
		u32 SO			: 1;
	};
	u32 Hex;

	UReg_XER(u32 _hex) { Hex = _hex; }
	UReg_XER()		{ Hex = 0; }	
};

// Machine State Register
union UReg_MSR
{
	struct
	{
		u32 LE		:	1;
		u32 RI		:	1;
		u32 PM		:	1;
		u32 		:	1; // res28
		u32 DR		:	1;
		u32 IR		:	1;
		u32 IP		:	1;
		u32 		:	1; // res24
		u32 FE1		:	1;
		u32 BE	 	:	1;
		u32 SE  	:	1;
		u32 FE0		:	1;
		u32 MCHECK	:	1;
		u32 FP		:	1;
		u32 PR		:	1;
		u32 EE		:	1;
		u32 ILE		:	1;
		u32			:	1; // res14
		u32 POW		:	1;
		u32 res		:	13;
	};
	u32 Hex;

	UReg_MSR(u32 _hex) { Hex = _hex; }
	UReg_MSR()		{ Hex = 0; }	
};

// Floating Point Status and Control Register
union UReg_FPSCR
{
	struct
	{
		u32 RN		:	2;
		u32 NI		:	1;
		u32 XE		:	1;
		u32 ZE		:	1;
		u32 UE		:	1;
		u32 OE		:	1;
		u32 VE		:	1;
		u32 VXCVI	:	1;
		u32 VXSQRT	:	1;
		u32 VXSOFT	:	1;
		u32			:	1;
		u32 FPRF	:	5;
		u32 FI		:	1;
		u32 FR		:	1;
		u32 VXVC	:	1;
		u32 VXIMZ	:	1;
		u32 VXZDZ	:	1;
		u32 VXIDI	:	1;
		u32 VXISI	:	1;
		u32 VXSNAN	:	1;
		u32 XX		:	1;
		u32 ZX		:	1;
		u32 UX		:	1;
		u32 OX		:	1;
		u32 VX		:	1;
		u32 FEX		:	1;
		u32 FX		:	1;
	};
	u32 Hex;

	UReg_FPSCR(u32 _hex)	{ Hex = _hex; }
	UReg_FPSCR()		{ Hex = 0;}
};

// Hardware Implementation-Dependent Register 0
union UReg_HID0
{
	struct
	{
		u32 NOOPTI	:	1;
		u32			:	1;
		u32 BHT		:	1;
		u32 ABE		:	1;
		u32			:	1;
		u32 BTIC	:	1;
		u32 DCFA	:	1;
		u32 SGE		:	1;
		u32 IFEM	:	1;
		u32 SPD		:	1;
		u32 DCFI	:	1;
		u32 ICFI	:	1;
		u32 DLOCK	:	1;
		u32 ILOCK	:	1;
		u32 DCE		:	1;
		u32 ICE		:	1;
		u32 NHR		:	1;
		u32			:	3;
		u32 DPM		:	1;
		u32 SLEEP	:	1;
		u32 NAP		:	1;
		u32 DOZE	:	1;
		u32 PAR		:	1;
		u32 ECLK	:	1;
		u32			:	1;
		u32 BCLK	:	1;
		u32 EBD		:	1;
		u32 EBA		:	1;
		u32 DBP		:	1;
		u32 EMCP	:	1;
	};
	u32 Hex;
};

// Hardware Implementation-Dependent Register 2
union UReg_HID2
{
	struct
	{
		u32			:	16;
		u32 DQOMEE	:	1;
		u32 DCMEE	:	1;
		u32 DNCEE	:	1;
		u32 DCHEE	:	1;
		u32 DQOERR	:	1;
		u32 DCEMERR	:	1;
		u32 DNCERR	:	1;
		u32 DCHERR	:	1;
		u32 DMAQL	:	4;
		u32 LCE		:	1;
		u32 PSE		:	1;
		u32 WPE		:	1;
		u32 LSQE	:	1;
	};
	u32 Hex;

	UReg_HID2(u32 _hex)	{ Hex = _hex; }
	UReg_HID2()			{ Hex = 0; }
};

// Hardware Implementation-Dependent Register 4
union UReg_HID4
{
	struct
	{
		u32			:	20;
		u32 L2CFI	:	1;
		u32 L2MUM	:	1;
		u32 DBP		:	1;
		u32 LPE		:	1;
		u32 ST0		:	1;
		u32 SBE		:	1;
		u32			:	1;
		u32 BPD		:	2;
		u32 L2FM	:	2;
		u32			:	1;
	};
	u32 Hex;

	UReg_HID4(u32 _hex)	{ Hex = _hex; }
	UReg_HID4()			{ Hex = 0; }
};

// SPR1 - Page Table format
union UReg_SPR1
{
	u32 Hex;
	struct 
	{
		u32 htaborg  : 16;
		u32          : 7;
		u32 htabmask : 9;
	};
};



// Write Pipe Address Register
union UReg_WPAR
{
	struct
	{
		u32 BNE		: 1;
		u32			: 4;
		u32 GB_ADDR	: 27;
	};
	u32 Hex;

	UReg_WPAR(u32 _hex)	{ Hex = _hex; }
	UReg_WPAR()			{ Hex = 0; }
};

// Direct Memory Access Upper register
union UReg_DMAU
{
	struct
	{
		u32 DMA_LEN_U	:	5;
		u32 MEM_ADDR	:	27;		
	};
	u32 Hex;

	UReg_DMAU(u32 _hex)	{ Hex = _hex; }
	UReg_DMAU()			{ Hex = 0; }
};

// Direct Memory Access Lower (DMAL) register
union UReg_DMAL
{
	struct
	{
		u32 DMA_F		:	1;
		u32 DMA_T		:	1;
		u32 DMA_LEN_L	:	2;
		u32 DMA_LD		:	1;
		u32 LC_ADDR		:	27;		
	};
	u32 Hex;

	UReg_DMAL(u32 _hex)	{ Hex = _hex; }
	UReg_DMAL()			{ Hex = 0; }
};

union UReg_BAT_Up
{
	struct 
	{
		u32 VP			:   1;
		u32 VS			:   1;
		u32 BL			:	11; // Block length (aka block size mask)
		u32				:	4;
		u32 BEPI		:	15;		
	};
	u32 Hex;

	UReg_BAT_Up(u32 _hex)	{ Hex = _hex; }
	UReg_BAT_Up()		{ Hex = 0; }
};

union UReg_BAT_Lo
{
	struct 
	{
		u32 PP			:   2;
		u32				:   1;
		u32 WIMG		:	4;
		u32				:	10;
		u32 BRPN		:	15; // Physical Block Number
	};
	u32 Hex;

	UReg_BAT_Lo(u32 _hex)	{ Hex = _hex; }
	UReg_BAT_Lo()		{ Hex = 0; }
};

union UReg_PTE
{
	struct 
	{
		u64 API			:	6;
		u64 H			:	1;
		u64 VSID		:	24;
		u64 V			:	1;
		u64 PP			:	2;
		u64				:	1;
		u64 WIMG		:	4;
		u64 C			:	1;
		u64 R			:	1;
		u64				:   3;
		u64 RPN			:	20;

	};

	u64 Hex;
	u32 Hex32[2];
};


//
// --- Gekko Types and Defs ---
//


// quantize types
enum EQuantizeType
{
	QUANTIZE_FLOAT	=	0,
	QUANTIZE_U8		=	4,
	QUANTIZE_U16	=	5,
	QUANTIZE_S8		=	6,
	QUANTIZE_S16	=	7,
};

// branches
enum 
{
	BO_BRANCH_IF_CTR_0		=  2, // 3
	BO_DONT_DECREMENT_FLAG	=  4, // 2
	BO_BRANCH_IF_TRUE		=  8, // 1
	BO_DONT_CHECK_CONDITION	= 16, // 0
};

// Special purpose register indices
enum
{
	SPR_XER   =	1,
	SPR_LR    = 8,
	SPR_CTR   = 9,
	SPR_DSISR = 18,
	SPR_DAR	  = 19,
	SPR_DEC   = 22,
	SPR_SDR	  = 25,
	SPR_SRR0  = 26,
	SPR_SRR1  = 27,
	SPR_TL	  = 268,
	SPR_TU    = 269,
	SPR_TL_W  = 284,
	SPR_TU_W  = 285,
	SPR_PVR   = 287,
	SPR_SPRG0 = 272,
	SPR_SPRG1 = 273,
	SPR_SPRG2 = 274,
	SPR_SPRG3 = 275,
	SPR_EAR   = 282,
	SPR_IBAT0U  = 528,
	SPR_IBAT0L  = 529,
	SPR_IBAT1U  = 530,
	SPR_IBAT1L  = 531,
	SPR_IBAT2U  = 532,
	SPR_IBAT2L  = 533,
	SPR_IBAT3U  = 534,
	SPR_IBAT3L  = 535,
	SPR_DBAT0U  = 536,
	SPR_DBAT0L  = 537,
	SPR_DBAT1U  = 538,
	SPR_DBAT1L  = 539,
	SPR_DBAT2U  = 540,
	SPR_DBAT2L  = 541,
	SPR_DBAT3U  = 542,
	SPR_DBAT3L  = 543,
	SPR_GQR0  = 912,
	SPR_HID0  = 1008,
	SPR_HID1  = 1009,
	SPR_HID2  = 920,
	SPR_HID4  = 1011,
	SPR_WPAR  = 921,
	SPR_DMAU  = 922,
	SPR_DMAL  = 923,
	SPR_ECID_U = 924,
	SPR_ECID_M = 925,
	SPR_ECID_L = 926,
	SPR_L2CR  = 1017
};

// Exceptions
#define EXCEPTION_DECREMENTER			0x00000001
#define EXCEPTION_SYSCALL				0x00000002
#define EXCEPTION_EXTERNAL_INT			0x00000004
#define EXCEPTION_DSI					0x00000008
#define EXCEPTION_ISI					0x00000010
#define EXCEPTION_ALIGNMENT				0x00000020
#define EXCEPTION_FPU_UNAVAILABLE       0x00000040
#define EXCEPTION_PROGRAM				0x00000080

inline s32 SignExt16(s16 x) {return (s32)(s16)x;}
inline s32 SignExt26(u32 x) {return x & 0x2000000 ? (s32)(x | 0xFC000000) : (s32)(x);}

#endif

