TwlIPL/include/sysmenu/sysmenu_lib/common/sysmenu_work.h

/*---------------------------------------------------------------------------*
  Project:  TwlIPL
  File:     sysmenu_work.c

  Copyright 2007 Nintendo.  All rights reserved.

  These coded instructions, statements, and computer programs contain
  proprietary information of Nintendo of America Inc. and/or Nintendo
  Company Ltd., and are protected by Federal copyright law.  They may
  not be disclosed to third parties or copied or duplicated in any form,
  in whole or in part, without the prior written consent of Nintendo.

  $Date::            $
  $Rev$
  $Author$
 *---------------------------------------------------------------------------*/

#ifndef	__SYSMENU_WORK_H__
#define	__SYSMENU_WORK_H__

#include <twl.h>
#include <twl/nam.h>
#include <sysmenu/types.h>
#include <sysmenu/memorymap.h>
#include <sysmenu/reloc_info/common/reloc_info.h>
#include <firm/gcd/blowfish.h>

#ifdef __cplusplus
extern "C" {
#endif

// define data ------------------------------------
typedef enum SYSMCloneBootMode {
    SYSM_CLONE_BOOT_MODE = 1,
    SYSM_OTHER_BOOT_MODE = 2
}
SYSMCloneBootMode;

typedef enum CardDataReadState {
	CARD_READ_SUCCESS = 0,
    CARD_READ_TIME_OUT,
    CARD_READ_PULLED_OUT_ERROR,
    CARD_READ_BUFFER_OVERRUN_ERROR,
    CARD_READ_MODE_ERROR,
    CARD_READ_BUSY,
    CARD_READ_UNEXPECTED_ERROR
}
CardDataReadState;

// WRAM経由でカードデータを読み込む場合に使用
typedef struct CardReadParam {
	u32					src;
    u32					dest;
	u32					size;
}CardReadParam;

//----------------------------------------------------------------------
//　ROMエミュレーション情報
//----------------------------------------------------------------------
#define SYSM_ROMEMU_INFO_SIZE			0x20		// ROMエミュレーションデータサイズ
#define SYSM_ROMEMU_INFO_MAGIC_CODE		0x444c5754  // "TWLD"の文字列

// ISデバッガROMエミュレーション情報
typedef struct SYSMRomEmuInfo {
	// マジックコード（SYSM_ROMEMU_INFO_MAGIC_CODEの固定値）
	u32			magic_code;
	// フラグ類
	u32			isEnableSlot1 : 1;
	u32			isEnableSlot2 : 1;
	u32			bootSlotNo : 2;
	u32			isEnableExMainMemory : 1;
	u32			isBootMachineSettings : 1;
	u32			isBootSpecifiedNANDApp : 1;
	u32			isTlfRom : 1;

	u32			isForceNTRMode : 1;
	u32			isForceBannerViewMode : 1;
	u32			:0;
	// isBootSpecifiedNANDAppで起動するアプリのTitleID
	u64			titleID;
	// 予約
	u8			rsv[ 0x10 ];
}
SYSMRomEmuInfo;


//----------------------------------------------------------------------
//　SYSMワーク
//----------------------------------------------------------------------
// SYSM共有ワーク構造体
typedef struct SYSM_work {
	Relocate_Info		romRelocateInfo[RELOCATE_INFO_NUM];	// ROM再配置情報（arm9,arm7それぞれltdとflxで最大4つ）
	struct {
		struct {
			vu32		isARM9Start :1;					// ARM9スタートフラグ
			vu32		isHotStart :1;					// Hot/Coldスタート判定
			vu32		isValidLauncherParam :1;		// ランチャーパラメータ有効
			vu32		isValidTSD :1;					// NITRO設定データ無効フラグ
			vu32		isLogoSkip :1;					// ロゴデモスキップ
            vu32		isHeaderLoadCompleted :1;		// アプリヘッダロード完了？
			vu32		isLoadFinished :1;				// アプリロード完了？
			vu32		isLoadSucceeded :1;				// アプリロード成功？
			vu32		isCardBoot :1;					// カードブートか？
			vu32		isResetRTC :1;					// RTCリセット発生
			vu32		isNANDFatalError :1;			// NANDFATALエラー発生
			vu32		:0;
		}common;
        struct {
            vu16		isExistCard :1;					// 有効なNTR/TWLカードが存在するか？
			vu16		isInspectCard :1;				// 検査カードか？
			vu16		isOnDebugger :1;				// デバッガ動作か？
			vu16		isEnableHotSW :1;				// 活線挿抜有効？
			vu16		isLoadRomEmuOnly :1;			// ROMエミュレーション情報のみロード
			vu16		isCardLoadCompleted :1;			// カードからデータロード完了？
   			vu16		isValidCardBanner :1;			// バナーデータ更新？
			vu16		is1stCardChecked :1;			// カードデータの1stチェック完了？
            vu16		isCardGameMode :1;				// カードがゲームモードに遷移したか？
            vu16		isFinalized :1;					// HOTSW終了処理完了
            vu16		:0;
            vu8			isCardStateChanged;				// カード状態更新フラグ
            vu8			isBusyHotSW;					// 活線挿抜処理中？
            vu8			isKeyTableLoadReady;			// Key Tableのロード準備完了？
        }hotsw;
	}flags; // 9B

    OSLockWord			lockCardRsc ATTRIBUTE_ALIGN(8);	// カードリソース排他制御用
	OSLockWord			lockHotSW;						// カードリソース排他制御用
	u32					appCardID;						// カードID
	OSBootType			appBootType;					// ブート種別
	u32					gameCommondParam;				// NTRのゲームコマンドパラメータ(NTRのROMヘッダのゲームコマンドパラメータに上書きする)
	u8					cloneBootMode;
    
	CardReadParam		cardReadParam;					// カードリードパラメータ
	u32					romHeaderNTR[HW_CARD_ROM_HEADER_SIZE/sizeof(u32)];  // NTR-ROMヘッダ一時バッファ
    
	LauncherParam		launcherParam;
	SYSMRomEmuInfo		romEmuInfo;
	RTCRawData			Rtc1stData;						// RTC初回ロード値 8byte
	
	BOOL				isDeveloperAESMode;				// 開発用セキュリティか？（製品版でFALSE）
	void				*addr_AESregion[2];				// AES暗号化領域の格納アドレス
	u32					size_AESregion[2];				// AES暗号化領域のサイズ
	u8					keyAES[AES_KEY_SIZE];			// 開発版AES暗号化領域の復号に使用するKEY（に使うタイトルネーム）
	u8					idAES[GAME_CODE_MAX];			// 製品版AES暗号化領域の復号に使用するID（に使うゲームコード）
	u8					seedAES[AES_KEY_SIZE];			// 製品版AES暗号化領域の復号に使用するSEED
	u8					counterAES[2][AES_BLOCK_SIZE];	// AES暗号化領域の復号に使用するカウンタ初期値
	
	// NTR-IPL2のレガシー　最終的には消すと思う
	BOOL				enableCardNormalOnly;
	u8					rtcStatus;
}SYSM_work;

typedef struct SYSM_work2 {
	SVCHMACSHA1Context hmac_sha1_context;
	TitleProperty		bootTitleProperty;
	char 				bootContentPath[ FS_ENTRY_LONGNAME_MAX ];
}SYSM_work2;

// NTRにおける仕様を継承する必要のあるワーク
typedef struct SDKBootCheckInfo{
	u32 nCardID;					// NORMALカードID				// SDKではここだけ見ているっぽい　※最終的にはランチャーでここにカードIDをセットする
	u32 sCardID;					// SECUREカードID
	u16 cardHeaderCrc16;			// カードヘッダCRC16
	u16 cardSecureCrc16;			// カードSECURE領域CRC16
	s16 cardHeaderError;			// カードヘッダエラー
	s16 disableEncryptedCardData;	// カードSECURE領域暗号化データ無効
	
	u16 sysromCrc16;				// システムROMのCRC16
	s16 enableCardNormalOnly;		// カードNORMALモードのみ有効
	s16 isOnDebugger;				// デバッガ上で動作中か
	s8  rtcError;					// RTCエラー
	u8  rtcStatus1;					// RTCステータス1
	
}SDKBootCheckInfo;


// ARM9からARM7にWRAM経由で引き渡す鍵情報ワーク
typedef struct DeliverBROM9Key {
	BLOWFISH_CTX	ds_blowfish;
//	u8              aes_key[ AES_KEY_SIZE ];
}DeliverBROM9Key;


//----------------------------------------------------------------------
//　SYSM共有ワーク領域のアドレス獲得
//----------------------------------------------------------------------
// SYSMランチャーパラメータアドレスの取得（※ライブラリ向け。ARM9側はSYSM_GetLauncherParamを使用して下さい。）
#define SYSMi_GetLauncherParamAddr()			( (LauncherParam *)HW_PARAM_LAUNCH_PARAM )

// SYSM共有ワークの取得
#define SYSMi_GetWork()						( (SYSM_work *)HW_TWL_SHARED_RESERVED )
#define SYSMi_GetWork2()					( (SYSM_work2 *)HW_MAIN_MEM_SHARED )

// SDKブートチェック（アプリ起動時にカードIDをセットする必要がある。）
#define SYSMi_GetSDKBootCheckInfo()			( (SDKBootCheckInfo *)HW_BOOT_CHECK_INFO_BUF )
#define SYSMi_GetSDKBootCheckInfoForNTR()	( (SDKBootCheckInfo *)0x027ffc00 )

// NANDファームがロードしてくれているマイコンフリーレジスタ値の取得
#define SYSMi_GetMCUFreeRegisterValue()		( *(vu8 *)HW_RESET_PARAMETER_BUF )

// ROMヘッダワークの取得
#define SYSM_GetAppRomHeader()				( (ROM_Header_Short *)SYSM_APP_ROM_HEADER_BUF )
#define SYSM_GetCardRomHeader()				SYSM_GetAppRomHeader()

// ARM9から引き渡す鍵情報ワークの取得
#ifdef SDK_ARM9
#define GetDeliverBROM9KeyAddr()			( (DeliverBROM9Key *)HW_WRAM_0 )
#else
#define GetDeliverBROM9KeyAddr()			( (DeliverBROM9Key *)HW_WRAM_0_LTD )
#endif

// ISデバッガ上で動作しているか？
static inline BOOL SYSM_IsRunOnDebugger( void )
{
#ifdef SYSMENU_DEBUGGER_BUILD
	return SYSMi_GetWork()->flags.hotsw.isOnDebugger;
#else
	return FALSE;
#endif
}



#ifdef __cplusplus
}
#endif

#endif // __SYSMENU_WORK_H__