mirror of
https://github.com/rvtr/ctr_firmware.git
synced 2025-10-31 07:51:08 -04:00
adf90ea104
git-svn-id: file:///Volumes/Transfer/gigaleak_20231201/2020-09-30%20-%20paladin.7z/paladin/ctr_firmware@57 b871894f-2f95-9b40-918c-086798483c85
333 lines
11 KiB
C
333 lines
11 KiB
C
/*---------------------------------------------------------------------------*
|
|
Project: CtrFirm - include -
|
|
File: misc.h
|
|
|
|
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:: $
|
|
$Rev$
|
|
$Author$
|
|
*---------------------------------------------------------------------------*/
|
|
#ifndef CTR_MISC_H_
|
|
#define CTR_MISC_H_
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#ifndef SDK_WIN32
|
|
//#include <ctr/os/common/printf.h>
|
|
#endif
|
|
|
|
//--------------------------------------------------------------------------------
|
|
// C++用マクロ
|
|
//
|
|
#ifdef __cplusplus
|
|
#define SDK_IFDEFCPP extern "C" {
|
|
#define SDK_ENDIFCPP }
|
|
#else
|
|
#define SDK_IFDEFCPP
|
|
#define SDK_ENDIFCPP
|
|
#endif
|
|
|
|
//--------------------------------------------------------------------------------
|
|
// Assert
|
|
//
|
|
#ifdef SDK_DEBUG
|
|
#ifndef SDK_ASSERT
|
|
#define SDK_ASSERT(exp) \
|
|
(void) ((exp) || (OSi_Panic(__FILE__, __LINE__, "Failed assertion " #exp), 0))
|
|
#endif
|
|
#else // SDK_DEBUG
|
|
#ifndef SDK_ASSERT
|
|
#define SDK_ASSERT(exp) ((void) 0)
|
|
#endif
|
|
#endif // SDK_DEBUG
|
|
|
|
/* コンパイル時チェック */
|
|
#define SDK_COMPILER_ASSERT(expr) \
|
|
extern void sdk_compiler_assert ## __LINE__ ( char is[(expr) ? +1 : -1] )
|
|
|
|
//--------------------------------------------------------------------------------
|
|
// Assert message
|
|
//
|
|
#ifdef SDK_DEBUG
|
|
#ifndef SDK_ASSERTMSG
|
|
#define SDK_ASSERTMSG(exp, ...) \
|
|
(void) ((exp) || (OSi_Panic(__FILE__, __LINE__, __VA_ARGS__), 0))
|
|
#endif
|
|
#ifndef SDK_TASSERTMSG
|
|
#define SDK_TASSERTMSG(exp, ...) \
|
|
(void) ((exp) || (OSi_TPanic(__FILE__, __LINE__, __VA_ARGS__), 0))
|
|
#endif
|
|
#else // SDK_DEBUG
|
|
#ifndef SDK_ASSERTMSG
|
|
#define SDK_ASSERTMSG(exp, ...) ((void) 0)
|
|
#endif
|
|
#ifndef SDK_TASSERTMSG
|
|
#define SDK_TASSERTMSG(exp, ...) ((void) 0)
|
|
#endif
|
|
#endif // SDK_DEBUG
|
|
|
|
//--------------------------------------------------------------------------------
|
|
// Assert value
|
|
//
|
|
#ifdef SDK_DEBUG
|
|
#ifndef SDK_ASSERT_INT
|
|
#define SDK_ASSERT_INT(exp, value) \
|
|
(void) ((exp) || (OSi_Panic(__FILE__, __LINE__, "Failed assertion %s : %s = %p", #exp, #value, value), 0))
|
|
#endif
|
|
#else // SDK_DEBUG
|
|
#ifndef SDK_ASSERT_INT
|
|
#define SDK_ASSERT_INT(exp, value) ((void) 0)
|
|
#endif
|
|
#endif // SDK_DEBUG
|
|
|
|
//--------------------------------------------------------------------------------
|
|
// Warning
|
|
//
|
|
#ifdef SDK_DEBUG
|
|
#ifndef SDK_WARNING
|
|
#define SDK_WARNING(exp, ...) \
|
|
(void) ((exp) || (OSi_Warning(__FILE__, __LINE__, __VA_ARGS__), 0))
|
|
#endif
|
|
#ifndef SDK_TWARNING
|
|
#define SDK_TWARNING(exp, ...) \
|
|
(void) ((exp) || (OSi_TWarning(__FILE__, __LINE__, __VA_ARGS__), 0))
|
|
#endif
|
|
#else // SDK_DEBUG
|
|
#ifndef SDK_WARNING
|
|
#define SDK_WARNING(exp, ...) ((void) 0)
|
|
#endif
|
|
#ifndef SDK_TWARNING
|
|
#define SDK_TWARNING(exp, ...) ((void) 0)
|
|
#endif
|
|
#endif // SDK_DEBUG
|
|
|
|
//--------------------------------------------------------------------------------
|
|
// NULL Assert
|
|
//
|
|
#ifdef SDK_DEBUG
|
|
#ifndef SDK_NULL_ASSERT
|
|
#define SDK_NULL_ASSERT(exp) \
|
|
(void) (((exp) != NULL) || (OSi_Panic(__FILE__, __LINE__, "Pointer must not be NULL ("#exp")"), 0))
|
|
#endif
|
|
#else // SDK_DEBUG
|
|
#ifndef SDK_NULL_ASSERT
|
|
#define SDK_NULL_ASSERT(exp) ((void) 0)
|
|
#endif
|
|
#endif // SDK_DEBUG
|
|
|
|
//--------------------------------------------------------------------------------
|
|
// Check Pointer
|
|
//
|
|
#ifdef SDK_DEBUG
|
|
#ifndef SDK_IS_VALID_POINTER
|
|
#define SDK_IS_VALID_POINTER(exp) ( (0x01000000 <= ((u32)(exp))) && (((u32)(exp)) < 0x10000000) )
|
|
//#define SDK_IS_VALID_POINTER(exp) ((exp) != NULL)
|
|
#endif
|
|
#else // SDK_DEBUG
|
|
#ifndef SDK_IS_VALID_POINTER
|
|
#define SDK_IS_VALID_POINTER(exp) (TRUE)
|
|
#endif
|
|
#endif // SDK_DEBUG
|
|
|
|
//--------------------------------------------------------------------------------
|
|
// Pointer Assert
|
|
//
|
|
#ifdef SDK_DEBUG
|
|
#ifndef SDK_POINTER_ASSERT
|
|
#define SDK_POINTER_ASSERT(exp) \
|
|
(void) (SDK_IS_VALID_POINTER(exp) || (OSi_Panic(__FILE__, __LINE__, "%s(=%p) is not valid pointer", #exp, (exp)), 0))
|
|
#endif
|
|
#else // SDK_DEBUG
|
|
#ifndef SDK_POINTER_ASSERT
|
|
#define SDK_POINTER_ASSERT(exp) ((void) 0)
|
|
#endif
|
|
#endif // SDK_DEBUG
|
|
|
|
//--------------------------------------------------------------------------------
|
|
// Pointer or NULL Assert
|
|
//
|
|
#ifdef SDK_DEBUG
|
|
#ifndef SDK_POINTER_OR_NULL_ASSERT
|
|
#define SDK_POINTER_OR_NULL_ASSERT(exp) \
|
|
(void) (((exp) == NULL) || SDK_IS_VALID_POINTER(exp) || (OSi_Panic(__FILE__, __LINE__, "%s(=%p) must be NULL or valid pointer", #exp, (exp)), 0))
|
|
#endif
|
|
#else // SDK_DEBUG
|
|
#ifndef SDK_POINTER_OR_NULL_ASSERT
|
|
#define SDK_POINTER_OR_NULL_ASSERT(exp) ((void) 0)
|
|
#endif
|
|
#endif // SDK_DEBUG
|
|
|
|
//--------------------------------------------------------------------------------
|
|
// Min Assert
|
|
//
|
|
#ifdef SDK_DEBUG
|
|
#ifndef SDK_MIN_ASSERT
|
|
#define SDK_MIN_ASSERT(exp, min) \
|
|
(void) (((exp) >= (min)) || \
|
|
(OSi_Panic(__FILE__, __LINE__, #exp " is out of bounds(%d)\n%d <= "#exp" not satisfied.", exp, min), 0))
|
|
#endif
|
|
#else // SDK_DEBUG
|
|
#ifndef SDK_MIN_ASSERT
|
|
#define SDK_MIN_ASSERT(exp, min) ((void) 0)
|
|
#endif
|
|
#endif // SDK_DEBUG
|
|
|
|
//--------------------------------------------------------------------------------
|
|
// Max Assert
|
|
//
|
|
#ifdef SDK_DEBUG
|
|
#ifndef SDK_MAX_ASSERT
|
|
#define SDK_MAX_ASSERT(exp, max) \
|
|
(void) (((exp) <= (max)) || \
|
|
(OSi_Panic(__FILE__, __LINE__, #exp " is out of bounds(%d)\n"#exp" <= %d not satisfied.", exp, max), 0))
|
|
#endif
|
|
#else // SDK_DEBUG
|
|
#ifndef SDK_MAX_ASSERT
|
|
#define SDK_MAX_ASSERT(exp, max) ((void) 0)
|
|
#endif
|
|
#endif // SDK_DEBUG
|
|
|
|
//--------------------------------------------------------------------------------
|
|
// Min Max Assert
|
|
//
|
|
#ifdef SDK_DEBUG
|
|
#ifndef SDK_MINMAX_ASSERT
|
|
#define SDK_MINMAX_ASSERT(exp, min, max) \
|
|
(void) (((exp) >= (min) && (exp) <= (max)) || \
|
|
(OSi_Panic(__FILE__, __LINE__, #exp " is out of bounds(%d)\n%d <= "#exp" <= %d not satisfied.", exp, min, max), 0))
|
|
#endif
|
|
#else // SDK_DEBUG
|
|
#ifndef SDK_MINMAX_ASSERT
|
|
#define SDK_MINMAX_ASSERT(exp, min, max) ((void) 0)
|
|
#endif
|
|
#endif // SDK_DEBUG
|
|
|
|
//--------------------------------------------------------------------------------
|
|
// Fatal error
|
|
//
|
|
#ifdef SDK_DEBUG
|
|
#ifndef SDK_FATAL_ERROR
|
|
#define SDK_FATAL_ERROR(...) \
|
|
(void) (OSi_Panic(__FILE__, __LINE__, "Fatal Error\n"__VA_ARGS__), 0)
|
|
#endif
|
|
#ifndef SDK_TFATAL_ERROR
|
|
#define SDK_TFATAL_ERROR(...) \
|
|
(void) (OSi_TPanic(__FILE__, __LINE__, "Fatal Error\n"__VA_ARGS__), 0)
|
|
#endif
|
|
#else // SDK_DEBUG
|
|
#ifndef SDK_FATAL_ERROR
|
|
#define SDK_FATAL_ERROR(...) ((void) 0)
|
|
#endif
|
|
#ifndef SDK_TFATAL_ERROR
|
|
#define SDK_TFATAL_ERROR(...) ((void) 0)
|
|
#endif
|
|
#endif // SDK_DEBUG
|
|
|
|
//--------------------------------------------------------------------------------
|
|
// Internal error
|
|
//
|
|
#ifdef SDK_DEBUG
|
|
#ifndef SDK_INTERNAL_ERROR
|
|
#define SDK_INTERNAL_ERROR(...) \
|
|
(void) (OSi_Panic(__FILE__, __LINE__, "SDK Internal error\nPlease e-mail to nintendo\n" __VA_ARGS__), 0)
|
|
#endif
|
|
#ifndef SDK_TINTERNAL_ERROR
|
|
#define SDK_TINTERNAL_ERROR(...) \
|
|
(void) (OSi_TPanic(__FILE__, __LINE__, "SDK Internal error\nPlease e-mail to nintendo\n" __VA_ARGS__), 0)
|
|
#endif
|
|
#else // SDK_DEBUG
|
|
#ifndef SDK_INTERNAL_ERROR
|
|
#define SDK_INTERNAL_ERROR(...) ((void) 0)
|
|
#endif
|
|
#ifndef SDK_TINTERNAL_ERROR
|
|
#define SDK_TINTERNAL_ERROR(...) ((void) 0)
|
|
#endif
|
|
#endif // SDK_DEBUG
|
|
|
|
//--------------------------------------------------------------------------------
|
|
// Alignment error(4 bytes)
|
|
//
|
|
#ifdef SDK_DEBUG
|
|
#ifndef SDK_ALIGN4_ASSERT
|
|
#define SDK_ALIGN4_ASSERT(exp) \
|
|
(void) ((((u32)(exp) & 3) == 0) || (OSi_Panic(__FILE__, __LINE__, "Alignment Error(0x%08x)\n"#exp" must be aligned to 4 bytes boundary.", exp), 0))
|
|
#endif
|
|
#else // SDK_DEBUG
|
|
#ifndef SDK_ALIGN4_ASSERT
|
|
#define SDK_ALIGN4_ASSERT(exp) ((void) 0)
|
|
#endif
|
|
#endif // SDK_DEBUG
|
|
|
|
//--------------------------------------------------------------------------------
|
|
// Alignment error(2 bytes)
|
|
//
|
|
#ifdef SDK_DEBUG
|
|
#ifndef SDK_ALIGN2_ASSERT
|
|
#define SDK_ALIGN2_ASSERT(exp) \
|
|
(void) ((((u32)(exp) & 1) == 0) || (OSi_Panic(__FILE__, __LINE__, "Alignment Error(0x%08x)\n"#exp" must be aligned to 2 bytes boundary.", exp), 0))
|
|
#endif
|
|
#else // SDK_DEBUG
|
|
#ifndef SDK_ALIGN2_ASSERT
|
|
#define SDK_ALIGN2_ASSERT(exp) ((void) 0)
|
|
#endif
|
|
#endif // SDK_DEBUG
|
|
|
|
#if 0
|
|
// ** this block is moved to section.h **
|
|
//
|
|
//--------------------------------------------------------------------------------
|
|
// section definition for LCF
|
|
#if defined(SDK_CW) || defined(SDK_RX) || defined(__MWERKS__)
|
|
#ifdef SDK_ARM9
|
|
#pragma define_section ITCM ".itcm" abs32 RWX
|
|
#pragma define_section DTCM ".dtcm" abs32 RWX
|
|
#else
|
|
#pragma define_section WRAM ".wram" abs32 RWX
|
|
#endif
|
|
#pragma define_section PARENT ".parent" abs32 RWX
|
|
#pragma define_section VERSION ".version" abs32 RWX
|
|
#elif defined(SDK_PRODG)
|
|
#endif
|
|
#endif
|
|
|
|
//--------------------------------------------------------------------------------
|
|
// macros for linker
|
|
|
|
// specify force-link.
|
|
void OSi_ReferSymbol(void *symbol);
|
|
#define SDK_REFER_SYMBOL(symbol) OSi_ReferSymbol((void*)(symbol))
|
|
|
|
// for embedding middleware version string in VERSION section.
|
|
#define SDK_MIDDLEWARE_STRING(vender, module) "[SDK+" vender ":" module "]"
|
|
#define SDK_DEFINE_MIDDLEWARE(id, vender, module) static char id [] = SDK_MIDDLEWARE_STRING(vender, module)
|
|
#define SDK_USING_MIDDLEWARE(id) SDK_REFER_SYMBOL(id)
|
|
|
|
//--------------------------------------------------------------------------------
|
|
// macros for obsolete functions
|
|
|
|
#define OSi_AbortByUnsupportedRegister(regname, file, line) (OSi_TPanic(file, line, " I/O register \"%s\" is unsupported on this platform!", regname), 0)
|
|
#define OS_UNSUPPORTED_REGADDR(reg) OSi_AbortByUnsupportedRegister(#reg, __FILE__, __LINE__)
|
|
#define OS_UNSUPPORTED_REG8(reg) *(REGType8*)OSi_AbortByUnsupportedRegister(#reg, __FILE__, __LINE__)
|
|
#define OS_UNSUPPORTED_REG16(reg) *(REGType16*)OSi_AbortByUnsupportedRegister(#reg, __FILE__, __LINE__)
|
|
#define OS_UNSUPPORTED_REG32(reg) *(REGType32*)OSi_AbortByUnsupportedRegister(#reg, __FILE__, __LINE__)
|
|
#define OS_UNSUPPORTED_REG64(reg) *(REGType64*)OSi_AbortByUnsupportedRegister(#reg, __FILE__, __LINE__)
|
|
|
|
|
|
//--------------------------------------------------------------------------------
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
|
|
/* CTR_MISC_H_ */
|
|
#endif
|