2020-04-16 01:06:41 +01:00
/*
2020-07-03 10:31:22 +01:00
* utils . c
2020-04-16 01:06:41 +01:00
*
2020-07-06 01:10:07 +01:00
* Copyright ( c ) 2018 - 2020 , WerWolv .
2020-07-03 10:31:22 +01:00
* Copyright ( c ) 2020 , DarkMatterCore < pabloacurielz @ gmail . com > .
*
* This file is part of nxdumptool ( https : //github.com/DarkMatterCore/nxdumptool).
*
* nxdumptool is free software ; you can redistribute it and / or modify it
2020-04-16 01:06:41 +01:00
* under the terms and conditions of the GNU General Public License ,
* version 2 , as published by the Free Software Foundation .
*
2020-07-03 10:31:22 +01:00
* nxdumptool is distributed in the hope it will be useful , but WITHOUT
2020-04-16 01:06:41 +01:00
* ANY WARRANTY ; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE . See the GNU General Public License for
* more details .
*
* You should have received a copy of the GNU General Public License
* along with this program . If not , see < http : //www.gnu.org/licenses/>.
*/
2020-07-03 10:31:22 +01:00
# include "utils.h"
2020-04-15 21:50:07 +01:00
//#include "freetype_helper.h"
//#include "lvgl_helper.h"
2020-04-16 11:13:11 +01:00
# include "keys.h"
2020-04-15 21:50:07 +01:00
# include "gamecard.h"
2020-04-16 11:13:11 +01:00
# include "services.h"
2020-04-21 11:23:33 +01:00
# include "nca.h"
2020-05-05 16:22:16 +01:00
# include "usb.h"
2020-04-17 22:59:05 +01:00
# include "fatfs/ff.h"
2020-04-15 21:50:07 +01:00
/* Global variables. */
2020-05-03 00:40:50 +01:00
static bool g_resourcesInitialized = false ;
static Mutex g_resourcesMutex = 0 ;
static FsFileSystem * g_sdCardFileSystem = NULL ;
static FsStorage g_emmcBisSystemPartitionStorage = { 0 } ;
static FATFS * g_emmcBisSystemPartitionFatFsObj = NULL ;
static AppletType g_programAppletType = 0 ;
static bool g_homeButtonBlocked = false ;
static Mutex g_homeButtonMutex = 0 ;
2020-04-16 11:13:11 +01:00
static u8 g_customFirmwareType = UtilsCustomFirmwareType_Unknown ;
2020-04-15 21:50:07 +01:00
static AppletHookCookie g_systemOverclockCookie = { 0 } ;
static Mutex g_logfileMutex = 0 ;
/* Function prototypes. */
2020-07-06 01:10:07 +01:00
static u64 utilsHidKeysAllDown ( void ) ;
static u64 utilsHidKeysAllHeld ( void ) ;
2020-05-03 00:40:50 +01:00
static bool utilsMountEmmcBisSystemPartitionStorage ( void ) ;
static void utilsUnmountEmmcBisSystemPartitionStorage ( void ) ;
2020-04-16 11:13:11 +01:00
static void _utilsGetCustomFirmwareType ( void ) ;
2020-04-15 21:50:07 +01:00
static void utilsOverclockSystemAppletHook ( AppletHookType hook , void * param ) ;
2020-05-03 00:40:50 +01:00
bool utilsInitializeResources ( void )
{
mutexLock ( & g_resourcesMutex ) ;
bool ret = g_resourcesInitialized ;
if ( ret ) goto exit ;
2020-07-06 01:10:07 +01:00
/* Initialize needed services. */
2020-05-03 00:40:50 +01:00
if ( ! servicesInitialize ( ) )
{
LOGFILE ( " Failed to initialize needed services! " ) ;
goto exit ;
}
2020-07-06 01:10:07 +01:00
/* Initialize USB interface. */
2020-05-05 16:22:16 +01:00
if ( ! usbInitialize ( ) )
{
LOGFILE ( " Failed to initialize USB interface! " ) ;
goto exit ;
}
2020-07-06 01:10:07 +01:00
/* Load NCA keyset. */
2020-05-03 00:40:50 +01:00
if ( ! keysLoadNcaKeyset ( ) )
{
LOGFILE ( " Failed to load NCA keyset! " ) ;
goto exit ;
}
2020-07-06 01:10:07 +01:00
/* Allocate NCA crypto buffer. */
2020-05-03 00:40:50 +01:00
if ( ! ncaAllocateCryptoBuffer ( ) )
{
LOGFILE ( " Unable to allocate memory for NCA crypto buffer! " ) ;
goto exit ;
}
2020-07-06 01:10:07 +01:00
/* Initialize gamecard interface. */
2020-05-03 00:40:50 +01:00
if ( ! gamecardInitialize ( ) )
{
LOGFILE ( " Failed to initialize gamecard interface! " ) ;
goto exit ;
}
2020-07-06 01:10:07 +01:00
/* Retrieve SD card FsFileSystem element. */
2020-05-03 00:40:50 +01:00
if ( ! ( g_sdCardFileSystem = fsdevGetDeviceFileSystem ( " sdmc: " ) ) )
{
LOGFILE ( " fsdevGetDeviceFileSystem failed! " ) ;
goto exit ;
}
2020-07-06 01:10:07 +01:00
/* Mount eMMC BIS System partition. */
2020-05-03 00:40:50 +01:00
if ( ! utilsMountEmmcBisSystemPartitionStorage ( ) ) goto exit ;
2020-07-06 01:10:07 +01:00
/* Get applet type. */
2020-05-03 00:40:50 +01:00
g_programAppletType = appletGetAppletType ( ) ;
2020-07-06 01:10:07 +01:00
/* Disable screen dimming and auto sleep. */
2020-05-03 00:40:50 +01:00
appletSetMediaPlaybackState ( true ) ;
2020-07-06 01:10:07 +01:00
/* Retrieve custom firmware type. */
2020-05-03 00:40:50 +01:00
_utilsGetCustomFirmwareType ( ) ;
2020-07-06 01:10:07 +01:00
/* Overclock system. */
2020-05-03 00:40:50 +01:00
utilsOverclockSystem ( true ) ;
2020-07-06 01:10:07 +01:00
/* Setup an applet hook to change the hardware clocks after a system mode change (docked <-> undocked). */
2020-05-03 00:40:50 +01:00
appletHook ( & g_systemOverclockCookie , utilsOverclockSystemAppletHook , NULL ) ;
2020-07-06 01:10:07 +01:00
/* Initialize FreeType. */
2020-05-03 00:40:50 +01:00
//if (!freeTypeHelperInitialize()) return false;
2020-07-06 01:10:07 +01:00
/* Initialize LVGL. */
2020-05-03 00:40:50 +01:00
//if (!lvglHelperInitialize()) return false;
ret = g_resourcesInitialized = true ;
exit :
mutexUnlock ( & g_resourcesMutex ) ;
return ret ;
}
void utilsCloseResources ( void )
{
mutexLock ( & g_resourcesMutex ) ;
2020-07-06 01:10:07 +01:00
/* Free LVGL resources. */
2020-05-03 00:40:50 +01:00
//lvglHelperExit();
2020-07-06 01:10:07 +01:00
/* Free FreeType resources. */
2020-05-03 00:40:50 +01:00
//freeTypeHelperExit();
2020-07-06 01:10:07 +01:00
/* Unset our overclock applet hook. */
2020-05-03 00:40:50 +01:00
appletUnhook ( & g_systemOverclockCookie ) ;
2020-07-06 01:10:07 +01:00
/* Restore hardware clocks. */
2020-05-03 00:40:50 +01:00
utilsOverclockSystem ( false ) ;
2020-07-06 01:10:07 +01:00
/* Enable screen dimming and auto sleep. */
2020-05-03 00:40:50 +01:00
appletSetMediaPlaybackState ( false ) ;
2020-07-06 01:10:07 +01:00
/* Unblock HOME button presses. */
2020-05-03 00:40:50 +01:00
utilsChangeHomeButtonBlockStatus ( false ) ;
2020-07-06 01:10:07 +01:00
/* Unmount eMMC BIS System partition. */
2020-05-03 00:40:50 +01:00
utilsUnmountEmmcBisSystemPartitionStorage ( ) ;
2020-07-06 01:10:07 +01:00
/* Deinitialize gamecard interface. */
2020-05-03 00:40:50 +01:00
gamecardExit ( ) ;
2020-07-06 01:10:07 +01:00
/* Free NCA crypto buffer. */
2020-05-03 00:40:50 +01:00
ncaFreeCryptoBuffer ( ) ;
2020-07-06 01:10:07 +01:00
/* Close USB interface. */
2020-05-05 16:22:16 +01:00
usbExit ( ) ;
2020-07-06 01:10:07 +01:00
/* Close initialized services. */
2020-05-03 00:40:50 +01:00
servicesClose ( ) ;
g_resourcesInitialized = false ;
mutexUnlock ( & g_resourcesMutex ) ;
}
2020-04-17 22:59:05 +01:00
2020-07-06 01:10:07 +01:00
u64 utilsReadInput ( u8 input_type )
2020-04-15 21:50:07 +01:00
{
2020-07-06 01:10:07 +01:00
if ( input_type ! = UtilsInputType_Down & & input_type ! = UtilsInputType_Held ) return 0 ;
2020-04-15 21:50:07 +01:00
2020-07-06 01:10:07 +01:00
hidScanInput ( ) ;
2020-04-15 21:50:07 +01:00
2020-07-06 01:10:07 +01:00
return ( input_type = = UtilsInputType_Down ? utilsHidKeysAllDown ( ) : utilsHidKeysAllHeld ( ) ) ;
2020-04-15 21:50:07 +01:00
}
2020-07-06 01:10:07 +01:00
void utilsWaitForButtonPress ( u64 flag )
2020-04-15 21:50:07 +01:00
{
2020-07-06 01:10:07 +01:00
u64 keys_down = 0 ;
2020-04-15 21:50:07 +01:00
2020-07-06 01:10:07 +01:00
if ( ! flag )
{
/* Don't consider touch screen presses nor stick movement as button inputs. */
flag = ~ ( KEY_TOUCH | KEY_LSTICK_LEFT | KEY_LSTICK_RIGHT | KEY_LSTICK_UP | KEY_LSTICK_DOWN | KEY_RSTICK_LEFT | KEY_RSTICK_RIGHT | KEY_RSTICK_UP | KEY_RSTICK_DOWN ) ;
}
2020-04-15 21:50:07 +01:00
while ( appletMainLoop ( ) )
{
2020-07-06 01:10:07 +01:00
keys_down = utilsReadInput ( UtilsInputType_Down ) ;
2020-04-15 21:50:07 +01:00
if ( keys_down & flag ) break ;
}
}
void utilsWriteLogMessage ( const char * func_name , const char * fmt , . . . )
{
mutexLock ( & g_logfileMutex ) ;
va_list args ;
FILE * logfile = NULL ;
2020-05-04 19:15:03 +01:00
logfile = fopen ( LOGFILE_PATH , " a+ " ) ;
2020-04-15 21:50:07 +01:00
if ( ! logfile ) goto out ;
time_t now = time ( NULL ) ;
struct tm * ts = localtime ( & now ) ;
2020-04-16 01:06:41 +01:00
fprintf ( logfile , " %d/%d/%d %d:%02d:%02d -> %s: " , ts - > tm_year + 1900 , ts - > tm_mon + 1 , ts - > tm_mday , ts - > tm_hour , ts - > tm_min , ts - > tm_sec , func_name ) ;
2020-04-15 21:50:07 +01:00
va_start ( args , fmt ) ;
vfprintf ( logfile , fmt , args ) ;
va_end ( args ) ;
fprintf ( logfile , " \r \n " ) ;
fclose ( logfile ) ;
out :
mutexUnlock ( & g_logfileMutex ) ;
}
2020-05-05 19:04:23 +01:00
void utilsReplaceIllegalCharacters ( char * str , bool ascii_only )
2020-05-03 00:40:50 +01:00
{
size_t strsize = 0 ;
2020-04-16 11:13:11 +01:00
2020-05-03 00:40:50 +01:00
if ( ! str | | ! ( strsize = strlen ( str ) ) ) return ;
2020-04-15 21:50:07 +01:00
2020-05-03 00:40:50 +01:00
for ( size_t i = 0 ; i < strsize ; i + + )
2020-04-21 11:23:33 +01:00
{
2020-05-05 19:04:23 +01:00
if ( memchr ( " ?[]/ \\ =+<>:; \" ,*|^ " , str [ i ] , sizeof ( " ?[]/ \\ =+<>:; \" ,*|^ " ) - 1 ) | | str [ i ] < 0x20 | | ( ! ascii_only & & str [ i ] = = 0x7F ) | | ( ascii_only & & str [ i ] > = 0x7F ) ) str [ i ] = ' _ ' ;
2020-04-21 11:23:33 +01:00
}
2020-04-15 21:50:07 +01:00
}
2020-05-03 00:40:50 +01:00
void utilsTrimString ( char * str )
2020-04-15 21:50:07 +01:00
{
2020-05-03 00:40:50 +01:00
size_t strsize = 0 ;
char * start = NULL , * end = NULL ;
2020-04-15 21:50:07 +01:00
2020-05-03 00:40:50 +01:00
if ( ! str | | ! ( strsize = strlen ( str ) ) ) return ;
2020-04-15 21:50:07 +01:00
2020-05-03 00:40:50 +01:00
start = str ;
end = ( start + strsize ) ;
2020-04-15 21:50:07 +01:00
2020-05-03 00:40:50 +01:00
while ( - - end > = start )
{
if ( ! isspace ( ( unsigned char ) * end ) ) break ;
}
2020-04-17 22:59:05 +01:00
2020-05-03 00:40:50 +01:00
* ( + + end ) = ' \0 ' ;
2020-04-17 22:59:05 +01:00
2020-05-03 00:40:50 +01:00
while ( isspace ( ( unsigned char ) * start ) ) start + + ;
2020-04-21 11:23:33 +01:00
2020-05-03 00:40:50 +01:00
if ( start ! = str ) memmove ( str , start , end - start + 1 ) ;
2020-04-16 11:13:11 +01:00
}
2020-04-17 22:59:05 +01:00
void utilsGenerateHexStringFromData ( char * dst , size_t dst_size , const void * src , size_t src_size )
{
if ( ! src | | ! src_size | | ! dst | | dst_size < ( ( src_size * 2 ) + 1 ) ) return ;
size_t i , j ;
const u8 * src_u8 = ( const u8 * ) src ;
for ( i = 0 , j = 0 ; i < src_size ; i + + )
{
2020-04-19 23:44:22 +01:00
char h_nib = ( ( src_u8 [ i ] > > 4 ) & 0xF ) ;
char l_nib = ( src_u8 [ i ] & 0xF ) ;
2020-04-17 22:59:05 +01:00
2020-04-19 23:44:22 +01:00
dst [ j + + ] = ( h_nib + ( h_nib < 0xA ? 0x30 : 0x57 ) ) ;
dst [ j + + ] = ( l_nib + ( l_nib < 0xA ? 0x30 : 0x57 ) ) ;
2020-04-17 22:59:05 +01:00
}
dst [ j ] = ' \0 ' ;
}
2020-05-03 00:40:50 +01:00
bool utilsGetFreeSdCardSpace ( u64 * out )
2020-04-17 22:59:05 +01:00
{
2020-05-03 00:40:50 +01:00
return utilsGetFreeFileSystemSpace ( g_sdCardFileSystem , out ) ;
2020-04-17 22:59:05 +01:00
}
2020-05-03 00:40:50 +01:00
bool utilsGetFreeFileSystemSpace ( FsFileSystem * fs , u64 * out )
2020-04-16 11:13:11 +01:00
{
2020-05-03 00:40:50 +01:00
if ( ! fs | | ! out )
{
LOGFILE ( " Invalid parameters! " ) ;
return false ;
}
2020-04-16 11:13:11 +01:00
2020-05-03 00:40:50 +01:00
Result rc = fsFsGetFreeSpace ( fs , " / " , ( s64 * ) out ) ;
if ( R_FAILED ( rc ) )
2020-04-16 11:13:11 +01:00
{
2020-07-06 01:10:07 +01:00
LOGFILE ( " fsFsGetFreeSpace failed! (0x%08X). " , rc ) ;
2020-05-03 00:40:50 +01:00
return false ;
}
return true ;
}
bool utilsCheckIfFileExists ( const char * path )
{
if ( ! path | | ! strlen ( path ) ) return false ;
FILE * chkfile = fopen ( path , " rb " ) ;
if ( chkfile )
2020-04-16 11:13:11 +01:00
{
2020-05-03 00:40:50 +01:00
fclose ( chkfile ) ;
return true ;
2020-04-16 11:13:11 +01:00
}
2020-05-03 00:40:50 +01:00
return false ;
2020-04-16 11:13:11 +01:00
}
2020-05-03 00:40:50 +01:00
bool utilsCreateConcatenationFile ( const char * path )
2020-04-15 21:50:07 +01:00
{
2020-05-03 00:40:50 +01:00
Result rc = 0 ;
2020-04-15 21:50:07 +01:00
2020-05-03 00:40:50 +01:00
if ( ! path | | ! strlen ( path ) )
{
LOGFILE ( " Invalid parameters! " ) ;
return false ;
}
2020-04-15 21:50:07 +01:00
2020-07-06 01:10:07 +01:00
/* Safety check: remove any existant file/directory at the destination path. */
2020-05-03 00:40:50 +01:00
remove ( path ) ;
fsdevDeleteDirectoryRecursively ( path ) ;
/* Create ConcatenationFile */
2020-07-06 01:10:07 +01:00
/* If the call succeeds, the caller function will be able to operate on this file using stdio calls. */
2020-05-03 00:40:50 +01:00
rc = fsdevCreateFile ( path , 0 , FsCreateOption_BigFile ) ;
if ( R_FAILED ( rc ) )
{
2020-07-06 01:10:07 +01:00
LOGFILE ( " fsdevCreateFile failed for \" %s \" ! (0x%08X). " , path , rc ) ;
2020-05-03 00:40:50 +01:00
return false ;
}
return true ;
}
bool utilsAppletModeCheck ( void )
{
return ( g_programAppletType ! = AppletType_Application & & g_programAppletType ! = AppletType_SystemApplication ) ;
}
void utilsChangeHomeButtonBlockStatus ( bool block )
{
mutexLock ( & g_homeButtonMutex ) ;
2020-07-06 01:10:07 +01:00
/* Only change HOME button blocking status if we're running as a regular application or a system application, and if it's current blocking status is different than the requested one. */
2020-05-03 00:40:50 +01:00
if ( ! utilsAppletModeCheck ( ) & & block ! = g_homeButtonBlocked )
{
if ( block )
{
appletBeginBlockingHomeButtonShortAndLongPressed ( 0 ) ;
} else {
appletEndBlockingHomeButtonShortAndLongPressed ( ) ;
}
g_homeButtonBlocked = block ;
}
mutexUnlock ( & g_homeButtonMutex ) ;
}
u8 utilsGetCustomFirmwareType ( void )
{
return g_customFirmwareType ;
}
FsStorage * utilsGetEmmcBisSystemPartitionStorage ( void )
{
return & g_emmcBisSystemPartitionStorage ;
}
void utilsOverclockSystem ( bool overclock )
{
u32 cpuClkRate = ( ( overclock ? CPU_CLKRT_OVERCLOCKED : CPU_CLKRT_NORMAL ) * 1000000 ) ;
u32 memClkRate = ( ( overclock ? MEM_CLKRT_OVERCLOCKED : MEM_CLKRT_NORMAL ) * 1000000 ) ;
servicesChangeHardwareClockRates ( cpuClkRate , memClkRate ) ;
2020-04-15 21:50:07 +01:00
}
2020-04-17 22:59:05 +01:00
2020-07-06 01:10:07 +01:00
static u64 utilsHidKeysAllDown ( void )
{
u8 controller ;
u64 keys_down = 0 ;
for ( controller = 0 ; controller < ( u8 ) CONTROLLER_P1_AUTO ; controller + + ) keys_down | = hidKeysDown ( ( HidControllerID ) controller ) ;
return keys_down ;
}
static u64 utilsHidKeysAllHeld ( void )
{
u8 controller ;
u64 keys_held = 0 ;
for ( controller = 0 ; controller < ( u8 ) CONTROLLER_P1_AUTO ; controller + + ) keys_held | = hidKeysHeld ( ( HidControllerID ) controller ) ;
return keys_held ;
}
2020-04-17 22:59:05 +01:00
static bool utilsMountEmmcBisSystemPartitionStorage ( void )
{
Result rc = 0 ;
FRESULT fr = FR_OK ;
rc = fsOpenBisStorage ( & g_emmcBisSystemPartitionStorage , FsBisPartitionId_System ) ;
if ( R_FAILED ( rc ) )
{
2020-07-06 01:10:07 +01:00
LOGFILE ( " Failed to open eMMC BIS System partition storage! (0x%08X). " , rc ) ;
2020-04-17 22:59:05 +01:00
return false ;
}
2020-04-19 23:44:22 +01:00
g_emmcBisSystemPartitionFatFsObj = calloc ( 1 , sizeof ( FATFS ) ) ;
if ( ! g_emmcBisSystemPartitionFatFsObj )
2020-04-17 22:59:05 +01:00
{
2020-07-03 10:31:22 +01:00
LOGFILE ( " Unable to allocate memory for FatFs element! " ) ;
2020-04-17 22:59:05 +01:00
return false ;
}
2020-04-19 23:44:22 +01:00
fr = f_mount ( g_emmcBisSystemPartitionFatFsObj , BIS_SYSTEM_PARTITION_MOUNT_NAME , 1 ) ;
2020-04-17 22:59:05 +01:00
if ( fr ! = FR_OK )
{
2020-07-06 01:10:07 +01:00
LOGFILE ( " Failed to mount eMMC BIS System partition! (%u). " , fr ) ;
2020-04-17 22:59:05 +01:00
return false ;
}
return true ;
}
static void utilsUnmountEmmcBisSystemPartitionStorage ( void )
{
2020-04-19 23:44:22 +01:00
if ( g_emmcBisSystemPartitionFatFsObj )
2020-04-17 22:59:05 +01:00
{
f_unmount ( BIS_SYSTEM_PARTITION_MOUNT_NAME ) ;
2020-04-19 23:44:22 +01:00
free ( g_emmcBisSystemPartitionFatFsObj ) ;
g_emmcBisSystemPartitionFatFsObj = NULL ;
2020-04-17 22:59:05 +01:00
}
if ( serviceIsActive ( & ( g_emmcBisSystemPartitionStorage . s ) ) )
{
fsStorageClose ( & g_emmcBisSystemPartitionStorage ) ;
memset ( & g_emmcBisSystemPartitionStorage , 0 , sizeof ( FsStorage ) ) ;
}
}
2020-05-03 00:40:50 +01:00
static void _utilsGetCustomFirmwareType ( void )
{
bool tx_srv = servicesCheckRunningServiceByName ( " tx " ) ;
bool rnx_srv = servicesCheckRunningServiceByName ( " rnx " ) ;
g_customFirmwareType = ( rnx_srv ? UtilsCustomFirmwareType_ReiNX : ( tx_srv ? UtilsCustomFirmwareType_SXOS : UtilsCustomFirmwareType_Atmosphere ) ) ;
}
static void utilsOverclockSystemAppletHook ( AppletHookType hook , void * param )
{
( void ) param ;
if ( hook ! = AppletHookType_OnOperationMode & & hook ! = AppletHookType_OnPerformanceMode ) return ;
2020-07-06 01:10:07 +01:00
/* To do: read config here to actually know the value to use with utilsOverclockSystem. */
2020-05-03 00:40:50 +01:00
utilsOverclockSystem ( false ) ;
}