9af81ce8d0
* Furi: optional message in furi_crash and furi_halt * Consistent furi_crash use * UnitTests: crash instead of assert * furi: check: fixed macro for default arg * unit_tests: fixed crashes everywhere * lib: infrared: fixed PVS warnings * furi: eliminated __FURI_ASSERT_MESSAGE_FLAG * Furi: update check.h docs * Furi: add check.h usage note * Docs: grammar --------- Co-authored-by: hedger <hedger@nanode.su>
109 lines
3.3 KiB
C
109 lines
3.3 KiB
C
/**
|
|
* @file check.h
|
|
*
|
|
* Furi crash and assert functions.
|
|
*
|
|
* The main problem with crashing is that you can't do anything without disturbing registers,
|
|
* and if you disturb registers, you won't be able to see the correct register values in the debugger.
|
|
*
|
|
* Current solution works around it by passing the message through r12 and doing some magic with registers in crash function.
|
|
* r0-r10 are stored in the ram2 on crash routine start and restored at the end.
|
|
* The only register that is going to be lost is r11.
|
|
*
|
|
*/
|
|
#pragma once
|
|
|
|
#include <m-core.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#define FURI_NORETURN [[noreturn]]
|
|
#else
|
|
#include <stdnoreturn.h>
|
|
#define FURI_NORETURN noreturn
|
|
#endif
|
|
|
|
// Flags instead of pointers will save ~4 bytes on furi_assert and furi_check calls.
|
|
#define __FURI_ASSERT_MESSAGE_FLAG (0x01)
|
|
#define __FURI_CHECK_MESSAGE_FLAG (0x02)
|
|
|
|
/** Crash system */
|
|
FURI_NORETURN void __furi_crash_implementation();
|
|
|
|
/** Halt system */
|
|
FURI_NORETURN void __furi_halt_implementation();
|
|
|
|
/** Crash system with message. Show message after reboot. */
|
|
#define __furi_crash(message) \
|
|
do { \
|
|
register const void* r12 asm("r12") = (void*)message; \
|
|
asm volatile("sukima%=:" : : "r"(r12)); \
|
|
__furi_crash_implementation(); \
|
|
} while(0)
|
|
|
|
/** Crash system
|
|
*
|
|
* @param optional message (const char*)
|
|
*/
|
|
#define furi_crash(...) M_APPLY(__furi_crash, M_IF_EMPTY(__VA_ARGS__)((NULL), (__VA_ARGS__)))
|
|
|
|
/** Halt system with message. */
|
|
#define __furi_halt(message) \
|
|
do { \
|
|
register const void* r12 asm("r12") = (void*)message; \
|
|
asm volatile("sukima%=:" : : "r"(r12)); \
|
|
__furi_halt_implementation(); \
|
|
} while(0)
|
|
|
|
/** Halt system
|
|
*
|
|
* @param optional message (const char*)
|
|
*/
|
|
#define furi_halt(...) M_APPLY(__furi_halt, M_IF_EMPTY(__VA_ARGS__)((NULL), (__VA_ARGS__)))
|
|
|
|
/** Check condition and crash if check failed */
|
|
#define __furi_check(__e, __m) \
|
|
do { \
|
|
if(!(__e)) { \
|
|
__furi_crash(__m); \
|
|
} \
|
|
} while(0)
|
|
|
|
/** Check condition and crash if failed
|
|
*
|
|
* @param condition to check
|
|
* @param optional message (const char*)
|
|
*/
|
|
#define furi_check(...) \
|
|
M_APPLY(__furi_check, M_DEFAULT_ARGS(2, (__FURI_CHECK_MESSAGE_FLAG), __VA_ARGS__))
|
|
|
|
/** Only in debug build: Assert condition and crash if assert failed */
|
|
#ifdef FURI_DEBUG
|
|
#define __furi_assert(__e, __m) \
|
|
do { \
|
|
if(!(__e)) { \
|
|
__furi_crash(__m); \
|
|
} \
|
|
} while(0)
|
|
#else
|
|
#define __furi_assert(__e, __m) \
|
|
do { \
|
|
((void)(__e)); \
|
|
((void)(__m)); \
|
|
} while(0)
|
|
#endif
|
|
|
|
/** Assert condition and crash if failed
|
|
*
|
|
* @warning only will do check if firmware compiled in debug mode
|
|
*
|
|
* @param condition to check
|
|
* @param optional message (const char*)
|
|
*/
|
|
#define furi_assert(...) \
|
|
M_APPLY(__furi_assert, M_DEFAULT_ARGS(2, (__FURI_ASSERT_MESSAGE_FLAG), __VA_ARGS__))
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|