mirror of
https://github.com/rvtr/TwlIPL.git
synced 2025-10-31 06:01:12 -04:00
ef98d823d7
git-svn-id: file:///Users/lillianskinner/Downloads/platinum/twl/TwlIPL/trunk@1010 b08762b0-b915-fc4b-9d8c-17b2551a87ff
551 lines
15 KiB
C
551 lines
15 KiB
C
/*---------------------------------------------------------------------------*
|
||
Project: TWL_RED_IPL -
|
||
File: loadWlanFirm.c
|
||
|
||
Copyright 2008 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:: 2008-02-15#$
|
||
$Rev: 677 $
|
||
$Author: sato_masaki $
|
||
*---------------------------------------------------------------------------*/
|
||
#include <twl.h>
|
||
#include <twl/nam.h>
|
||
#include <twl/os/common/format_rom.h>
|
||
#include <twl/lcfg.h>
|
||
|
||
#include <firm.h>
|
||
#include <sysmenu.h>
|
||
|
||
#include "nwm_common_private.h"
|
||
#include "nwm_arm9_private.h"
|
||
|
||
#include "loadWlanFirm.h"
|
||
|
||
/*
|
||
definitions
|
||
*/
|
||
|
||
/* LCFGの無線ファームバージョンをタイトルＩＤとしてそのまま使う場合 */
|
||
#define USE_LCFG_STRING 0
|
||
|
||
/* 無線FWダウンロード処理にかかる時間を計測する。 */
|
||
#define MEASURE_WIRELESS_INITTIME 0
|
||
|
||
/* 無線FW認証処理にかかる時間を計測する。 */
|
||
#define MEASURE_VERIFY_SIGN_TIME 0
|
||
|
||
/* ハッシュ比較の情報を出力する。 */
|
||
#define REPORT_HASH_COMPARISON 0
|
||
|
||
/* Index of public key for WLAN firm */
|
||
#define WLANFIRM_PUBKEY_INDEX 1
|
||
#define SIGN_LENGTH 128
|
||
|
||
#define SIGNHEAP_SIZE 0x01000
|
||
|
||
#define FWHEADER_SIZE 0x100
|
||
|
||
/*
|
||
internal variables
|
||
*/
|
||
static BOOL s_isHotStartWLFirm;
|
||
static volatile BOOL s_isFinished;
|
||
static u32* pNwmBuf;
|
||
static u8* pFwBuffer = 0;
|
||
#if (MEASURE_WIRELESS_INITTIME == 1)
|
||
static OSTick startTick = 0;
|
||
#endif
|
||
static OSMessageQueue mesq;
|
||
static OSMessage mesAry[1];
|
||
|
||
/*
|
||
internal functions
|
||
*/
|
||
static void InstallFirmCallback(void* arg);
|
||
static BOOL GetFirmwareFilepath(char *path);
|
||
static s32 ReadFirmwareHeader(char *path, u8 *buffer, s32 bufSize);
|
||
static s32 ReadFirmwareBinary(char *path, u32 offset, u8 *buffer, s32 bufSize);
|
||
static BOOL VerifyWlanfirmSignature(u8* buffer, u32 length);
|
||
static BOOL CheckHash(const u8* hash, const u8* buffer, u32 length);
|
||
#if (REPORT_HASH_COMPARISON == 1)
|
||
static void PrintDigest(u8 *digest);
|
||
#endif
|
||
|
||
|
||
void InstallFirmCallback(void* arg)
|
||
{
|
||
NWMCallback *cb = (NWMCallback*)arg;
|
||
WLANFirmResult result;
|
||
|
||
if (cb->retcode == NWM_RETCODE_SUCCESS) {
|
||
#if (MEASURE_WIRELESS_INITTIME == 1)
|
||
OS_TPrintf("[Wlan Firm] LoadTime=%dmsec\n", OS_TicksToMilliSeconds(OS_GetTick() - startTick));
|
||
#endif
|
||
OS_TPrintf("[Wlan Firm] Wlan firmware has been installed successfully!\n");
|
||
result = WLANFIRM_RESULT_SUCCESS;
|
||
} else { // in case of failure
|
||
OS_TPrintf("[Wlan Firm] FW download Timeout Error!\n");
|
||
result = WLANFIRM_RESULT_FAILURE;
|
||
}
|
||
|
||
if (pFwBuffer) {
|
||
SYSM_Free( pFwBuffer );
|
||
pFwBuffer = 0;
|
||
}
|
||
if (pNwmBuf)
|
||
{
|
||
NWM_End();
|
||
SYSM_Free( pNwmBuf );
|
||
pNwmBuf = 0;
|
||
}
|
||
/* メッセージキューにFWダウンロードの結果を通知 */
|
||
// [TODO:] queue溢れはありえないハズだけど、一応対策しておく予定。
|
||
(void)OS_SendMessage(&mesq, (OSMessage)result, OS_MESSAGE_NOBLOCK);
|
||
|
||
}
|
||
|
||
BOOL GetFirmwareFilepath(char *path)
|
||
{
|
||
u8 title[4] = { 'H','N','C','A' };
|
||
|
||
#if( USE_LCFG_STRING == 0 )
|
||
char *title0 = "HNCA";
|
||
#endif
|
||
u32 titleID_hi;
|
||
u32 titleID_lo;
|
||
u64 titleID = 0;
|
||
|
||
|
||
#if( USE_LCFG_STRING == 0 )
|
||
{
|
||
int i;
|
||
if( title[0] == 0 ) {
|
||
for( i = 0 ; i < 4 ; i++ ) {
|
||
title[i] = (u8)*title0++;
|
||
}
|
||
}
|
||
}
|
||
#endif
|
||
|
||
|
||
titleID_hi = (( 3 /* Nintendo */ << 16) | 8 /* CHANNEL_DATA_ONLY */ | 4 /* CHANNEL_CARD */ | 2 /* isLaunch */ | 1 /* isSystem */);
|
||
|
||
titleID_lo = ((u32)( title[0] ) & 0xff) << 24;
|
||
titleID_lo |= ((u32)( title[1] )& 0xff) << 16;
|
||
titleID_lo |= ((u32)( title[2] )& 0xff) << 8;
|
||
titleID_lo |= (u32)( title[3] ) & 0xff;
|
||
|
||
titleID = ((u64)(titleID_hi) << 32) | (u64)titleID_lo;
|
||
|
||
// OS_TPrintf( "[Wlan Firm] titleID = 0x%08x%08x\n", titleID_hi, titleID_lo);
|
||
|
||
if( NAM_OK == NAM_GetTitleBootContentPathFast(path, titleID) ) {
|
||
OS_TPrintf( "[Wlan Firm] File = %s\n", path);
|
||
}
|
||
else {
|
||
OS_TPrintf( "[Wlan Firm] Error: NAM_GetTitleBootContentPathFast titleID = 0x%08x0x%08x\n",titleID_hi, titleID_lo);
|
||
return FALSE;
|
||
}
|
||
|
||
return TRUE;
|
||
|
||
}
|
||
|
||
s32 ReadFirmwareHeader(char *path, u8 *buffer, s32 bufSize)
|
||
{
|
||
FSFile file[1];
|
||
s32 flen;
|
||
|
||
if (!FS_OpenFileEx(file, path, FS_FILEMODE_R)) {
|
||
OS_TWarning("FS_OpenFileEx(%s) failed.\n", path);
|
||
return -1;
|
||
}
|
||
|
||
if( FALSE == FS_SeekFile(file, sizeof(ROM_Header), FS_SEEK_SET) ) {
|
||
OS_TWarning("FS_SeekFile failed.\n");
|
||
return -1;
|
||
}
|
||
|
||
flen = FS_ReadFile(file, buffer, bufSize);
|
||
if( flen == -1 ) {
|
||
OS_TWarning("FS_ReadFile failed.\n");
|
||
return -1;
|
||
}
|
||
|
||
(void)FS_CloseFile(file);
|
||
|
||
return flen;
|
||
}
|
||
|
||
s32 ReadFirmwareBinary(char *path, u32 offset, u8 *buffer, s32 bufSize)
|
||
{
|
||
FSFile file[1];
|
||
s32 flen;
|
||
|
||
if (!FS_OpenFileEx(file, path, FS_FILEMODE_R)) {
|
||
OS_TWarning("FS_OpenFileEx(%s) failed.\n", path);
|
||
return -1;
|
||
}
|
||
|
||
if( FALSE == FS_SeekFile(file, (s32)(sizeof(ROM_Header) + offset), FS_SEEK_SET) ) {
|
||
OS_TWarning("FS_SeekFile failed.\n");
|
||
return -1;
|
||
}
|
||
|
||
flen = FS_ReadFile(file, buffer, bufSize);
|
||
if( flen == -1 ) {
|
||
OS_TWarning("FS_ReadFile failed.\n");
|
||
return -1;
|
||
}
|
||
|
||
(void)FS_CloseFile(file);
|
||
|
||
return flen;
|
||
}
|
||
|
||
BOOL VerifyWlanfirmSignature(u8* buffer, u32 length)
|
||
{
|
||
#pragma unused(length)
|
||
NWMFirmFileHeader *hdr = (NWMFirmFileHeader*)buffer;
|
||
u8 *pPubkey;
|
||
u8 *pSign;
|
||
u8 *txt;
|
||
u32 txtlen;
|
||
u8 txtDigest[SVC_SHA1_DIGEST_SIZE];
|
||
u8 signDigest[SVC_SHA1_DIGEST_SIZE];
|
||
SVCSHA1Context sctx;
|
||
SVCSignHeapContext rctx;
|
||
u8* signHeap;
|
||
#if (MEASURE_VERIFY_SIGN_TIME == 1)
|
||
OSTick vstart = OS_GetTick();
|
||
#endif
|
||
|
||
pPubkey = OSi_GetFromFirmAddr()->rsa_pubkey[WLANFIRM_PUBKEY_INDEX];
|
||
pSign = (u8*)((u32)buffer + (u32)hdr->soffset);
|
||
|
||
txt = buffer;
|
||
txtlen = (u32)hdr->soffset; /* 署名の直前までのLength */
|
||
|
||
/* calculate SHA-1 digest */
|
||
SVC_SHA1Init( &sctx );
|
||
SVC_SHA1Update( &sctx, (const void*)txt,txtlen);
|
||
SVC_SHA1GetHash( &sctx, txtDigest );
|
||
|
||
#if (REPORT_HASH_COMPARISON == 1)
|
||
OS_TPrintf("[Wlan Firm] Wlan Firm digest: ");
|
||
PrintDigest((u8*)txtDigest);
|
||
#endif
|
||
|
||
/* decrypt according to RSA security */
|
||
signHeap = SYSM_Alloc( SIGNHEAP_SIZE );
|
||
SVC_InitSignHeap( &rctx, signHeap, SIGNHEAP_SIZE);
|
||
|
||
MI_CpuClear8( signDigest, SVC_SHA1_DIGEST_SIZE );
|
||
|
||
if (FALSE == SVC_DecryptSign( &rctx, signDigest, (const void*)pSign, (const void*)pPubkey ))
|
||
{
|
||
OS_TPrintf("[Wlan Firm] Wlan Firmware authentication has failed.\n");
|
||
/* continue verifying process even though decryption fails
|
||
in the case of bonding option = 0x01 (support ARM9/ARM7) */
|
||
if (!( HWi_WSYS08_OP_OP0_MASK == SCFG_ReadBondingOption() ))
|
||
{
|
||
SYSM_Free(signHeap);
|
||
return FALSE;
|
||
}
|
||
OS_TPrintf("[Wlan Firm] But installation continues.\n");
|
||
}
|
||
|
||
SYSM_Free(signHeap);
|
||
|
||
#if (REPORT_HASH_COMPARISON == 1)
|
||
OS_TPrintf("[Wlan Firm] Decrypted digest: ");
|
||
PrintDigest((u8*)signDigest);
|
||
#endif
|
||
|
||
/*
|
||
skip comparing SHA1 digests in the case of bonding option = 0x01 (support ARM9/ARM7)
|
||
this restriction is for debugging TWL wireless firmware.
|
||
*/
|
||
if (!( HWi_WSYS08_OP_OP0_MASK == SCFG_ReadBondingOption() ))
|
||
{
|
||
/* verify digest */
|
||
if (FALSE == SVC_CompareSHA1( (const void*)txtDigest, (const void*)signDigest ))
|
||
{
|
||
return FALSE;
|
||
}
|
||
}
|
||
|
||
#if (MEASURE_VERIFY_SIGN_TIME == 1)
|
||
OS_TPrintf("[Wlan Firm] Verify signature Time=%dmsec\n", OS_TicksToMilliSeconds(OS_GetTick() - vstart));
|
||
#endif
|
||
|
||
return TRUE;
|
||
|
||
}
|
||
|
||
BOOL CheckHash(const u8* hash, const u8* buffer, u32 length)
|
||
{
|
||
u8 txtDigest[SVC_SHA1_DIGEST_SIZE];
|
||
SVCSHA1Context sctx;
|
||
#if (MEASURE_VERIFY_SIGN_TIME == 1)
|
||
OSTick vstart = OS_GetTick();
|
||
#endif
|
||
|
||
#if (REPORT_HASH_COMPARISON == 1)
|
||
OS_TPrintf("[Wlan Firm] Digest to compare: ");
|
||
PrintDigest((u8*)hash);
|
||
#endif
|
||
|
||
/* calculate SHA-1 digest */
|
||
SVC_SHA1Init( &sctx );
|
||
SVC_SHA1Update( &sctx, (const void*)buffer, length);
|
||
SVC_SHA1GetHash( &sctx, txtDigest );
|
||
|
||
#if (REPORT_HASH_COMPARISON == 1)
|
||
OS_TPrintf("[Wlan Firm] Calculated digest: ");
|
||
PrintDigest((u8*)txtDigest);
|
||
#endif
|
||
|
||
/* verify digest */
|
||
if (FALSE == SVC_CompareSHA1( (const void*)hash, (const void*)txtDigest ))
|
||
{
|
||
#if (MEASURE_VERIFY_SIGN_TIME == 1)
|
||
OS_TPrintf("[Wlan Firm] Verify digest Time=%dmsec\n", OS_TicksToMilliSeconds(OS_GetTick() - vstart));
|
||
#endif
|
||
return FALSE;
|
||
}
|
||
#if (MEASURE_VERIFY_SIGN_TIME == 1)
|
||
OS_TPrintf("[Wlan Firm] Verify digest Time=%dmsec\n", OS_TicksToMilliSeconds(OS_GetTick() - vstart));
|
||
#endif
|
||
return TRUE;
|
||
}
|
||
|
||
#if (REPORT_HASH_COMPARISON == 1)
|
||
void PrintDigest(u8 *digest)
|
||
{
|
||
int i;
|
||
|
||
for (i = 0; i < SVC_SHA1_DIGEST_SIZE; i++ )
|
||
{
|
||
OS_TPrintf("%02X ", digest[i]);
|
||
}
|
||
OS_TPrintf("\n");
|
||
}
|
||
#endif
|
||
|
||
|
||
BOOL InstallWlanFirmware( BOOL isHotStartWLFirm )
|
||
{
|
||
NWMRetCode err;
|
||
BOOL isColdStart;
|
||
|
||
s_isFinished = FALSE;
|
||
pNwmBuf = 0;
|
||
pFwBuffer = 0;
|
||
|
||
OS_InitMessageQueue(&mesq, mesAry, sizeof(mesAry)/sizeof(mesAry[0]));
|
||
|
||
/* HotStart/ColdStartのチェック */
|
||
|
||
s_isHotStartWLFirm = isHotStartWLFirm;
|
||
|
||
if (TRUE == isHotStartWLFirm )
|
||
{
|
||
u8 fwType;
|
||
|
||
isColdStart = FALSE;
|
||
|
||
// FWタイプが1のときのみData segmentの正当性をチェックする。
|
||
|
||
// [TODO:] TWL無線ドライバRC版のためのWorkaround
|
||
// その後のドライバは、Data segmentが廃止される。
|
||
// ドライバがバージョンアップされたら、この処理は削除する予定。
|
||
fwType = ((NWMFirmDataSegment *)NWM_PARAM_FWDATA_ADDRESS)->fwType;
|
||
|
||
// Check integrity of WLAN data segment
|
||
if (fwType == 1 && FALSE == NWMi_CheckFwDataIntegrity())
|
||
{
|
||
isColdStart = TRUE;
|
||
}
|
||
|
||
} else {
|
||
isColdStart = TRUE;
|
||
}
|
||
|
||
if (FALSE == isColdStart) // HOT START
|
||
{
|
||
pNwmBuf = SYSM_Alloc( NWM_SYSTEM_BUF_SIZE );
|
||
if (!pNwmBuf) {
|
||
OS_TWarning("Error: Couldn't allocate memory for NWM.\n");
|
||
goto instfirm_error;
|
||
}
|
||
|
||
#if (MEASURE_WIRELESS_INITTIME == 1)
|
||
startTick = OS_GetTick();
|
||
#endif
|
||
|
||
// HotStart
|
||
NWM_Init(pNwmBuf, NWM_SYSTEM_BUF_SIZE, 3); /* 3 -> DMA no. */
|
||
err = NWMi_InstallFirmware(InstallFirmCallback, NULL, 0, FALSE);
|
||
} else { // COLD START
|
||
s32 flen = 0;
|
||
char path[256];
|
||
u32 offset, length;
|
||
u8 hdrBuffer[FWHEADER_SIZE];
|
||
u8 *pHash = NULL;
|
||
u32 fwType;
|
||
|
||
// ColdStart
|
||
if (FALSE == GetFirmwareFilepath(path)) {
|
||
goto instfirm_error;
|
||
}
|
||
|
||
// Get WLAN Firmware type
|
||
fwType = ((NWMFirmDataSegment *)NWM_PARAM_FWDATA_ADDRESS)->fwType;
|
||
OS_TPrintf("[Wlan Firm] FWtype is %d\n", fwType);
|
||
|
||
// Read header of WLAN firm
|
||
flen = ReadFirmwareHeader(path, hdrBuffer, FWHEADER_SIZE);
|
||
|
||
if ( 0 >= flen )
|
||
{
|
||
OS_TPrintf("[Wlan Firm] Error: Couldn't read wlan firmware header.\n");
|
||
goto instfirm_error;
|
||
}
|
||
|
||
// Check signature data
|
||
if (FALSE == VerifyWlanfirmSignature(hdrBuffer, (u32)flen))
|
||
{
|
||
OS_TPrintf("[Wlan Firm] Error: This Wlan Firmware is quite illegal!\n");
|
||
OS_TPrintf("[Wlan Firm] It has never been installed.\n");
|
||
goto instfirm_error;
|
||
}
|
||
|
||
// Find corresponding FW image
|
||
offset = NWMi_GetFirmImageOffset(hdrBuffer, fwType);
|
||
length = NWMi_GetFirmImageLength(hdrBuffer, fwType);
|
||
|
||
if (offset == 0 || length == 0) {
|
||
OS_TPrintf("[Wlan Firm] Error: Couldn't get Firmware image.\n");
|
||
goto instfirm_error;
|
||
}
|
||
|
||
/* Allocate FW buffer from heap. */
|
||
pFwBuffer = SYSM_Alloc( length );
|
||
if (!pFwBuffer) {
|
||
OS_TWarning("[Wlan Firm] Error: Couldn't allocate memory for WlanFirmware.\n");
|
||
goto instfirm_error;
|
||
}
|
||
|
||
// Read FW image
|
||
flen = ReadFirmwareBinary(path, offset, pFwBuffer, (s32)length);
|
||
|
||
if ( 0 >= flen )
|
||
{
|
||
OS_TPrintf("[Wlan Firm] Error: Couldn't read wlan firmware.\n");
|
||
goto instfirm_error;
|
||
}
|
||
|
||
// Compare hashes
|
||
pHash = NWMi_GetFirmImageHashAddress(hdrBuffer, fwType);
|
||
if (pHash == NULL)
|
||
{
|
||
OS_TPrintf("[Wlan Firm] Error: Couldn't get hash of wlan firmware image.\n");
|
||
goto instfirm_error;
|
||
}
|
||
|
||
OS_TPrintf("[Wlan Firm] Check hash of firmware image.\n");
|
||
if (FALSE == CheckHash((const u8*)pHash, (const u8*)pFwBuffer, length))
|
||
{
|
||
OS_TPrintf("[Wlan Firm] Error: Hash data is illegal.\n");
|
||
goto instfirm_error;
|
||
}
|
||
|
||
pNwmBuf = SYSM_Alloc( NWM_SYSTEM_BUF_SIZE );
|
||
if (!pNwmBuf) {
|
||
OS_TWarning("Error: Couldn't allocate memory for NWM.\n");
|
||
goto instfirm_error;
|
||
}
|
||
|
||
// Start FW installation
|
||
NWM_Init(pNwmBuf, NWM_SYSTEM_BUF_SIZE, 3); /* 3 -> DMA no. */
|
||
|
||
#if (MEASURE_WIRELESS_INITTIME == 1)
|
||
startTick = OS_GetTick();
|
||
#endif
|
||
|
||
err = NWMi_InstallFirmware(InstallFirmCallback, pFwBuffer, (u32)flen, TRUE);
|
||
}
|
||
|
||
/*
|
||
無線ロード処理の完了は、IsWlanFirmwareInstalledでチェックする。
|
||
*/
|
||
|
||
return TRUE;
|
||
|
||
/* エラー処理 */
|
||
instfirm_error:
|
||
if (pFwBuffer)
|
||
{
|
||
SYSM_Free( pFwBuffer );
|
||
pFwBuffer = 0;
|
||
}
|
||
if (pNwmBuf)
|
||
{
|
||
NWM_End();
|
||
SYSM_Free( pNwmBuf );
|
||
pNwmBuf = 0;
|
||
}
|
||
|
||
// インストール開始すらできなかった時は、FATALエラー
|
||
s_isFinished = TRUE;
|
||
SYSM_SetFatalError( TRUE );
|
||
|
||
return FALSE;
|
||
}
|
||
|
||
BOOL GetWlanFirmwareInstallResult(WLANFirmResult *pResult);
|
||
BOOL GetWlanFirmwareInstallResult(WLANFirmResult *pResult)
|
||
{
|
||
OSMessage msg;
|
||
BOOL retval;
|
||
|
||
retval = OS_ReadMessage(&mesq, &msg, OS_MESSAGE_NOBLOCK);
|
||
|
||
*pResult = (WLANFirmResult)msg;
|
||
|
||
return retval;
|
||
}
|
||
|
||
|
||
// 無線ファームロード完了？
|
||
BOOL PollingInstallWlanFirmware( void )
|
||
{
|
||
if ( !s_isFinished ) {
|
||
WLANFirmResult result;
|
||
if( GetWlanFirmwareInstallResult( &result ) ) {
|
||
if( result != WLANFIRM_RESULT_SUCCESS ) {
|
||
// ロード失敗
|
||
if( !s_isHotStartWLFirm ) {
|
||
// ColdStartの無線ファームロードなら、FATALエラー
|
||
SYSM_SetFatalError( TRUE );
|
||
s_isFinished = TRUE;
|
||
}else {
|
||
// そうでない場合は、ColdStartロードで再度実行。
|
||
(void)InstallWlanFirmware( FALSE );
|
||
}
|
||
}
|
||
s_isFinished = TRUE;
|
||
}
|
||
}
|
||
return s_isFinished;
|
||
}
|
||
|
||
|