WE310F5  39.00.000
m2mb_system_reset.h
Go to the documentation of this file.
1 /*===============================================================================================*/
2 /* >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<< */
23 #ifndef M2M_M2MB_SYSTEM_RESET_H
24 #define M2M_M2MB_SYSTEM_RESET_H
25 
42 /*-----------------------------------------------------------------------------------------------*/
43 
48 /*-----------------------------------------------------------------------------------------------*/
49 
50 /* Global defines ==========================================================================*/
51 #define M2MB_ERR_LOG_MAX_FILE_NAME_LEN 50
52 #define M2MB_ERR_LOG_MAX_THREAD_NAME_LEN 20
53 
54 /* Global typedefs ==============================================================================*/
55 
64 typedef enum
65 {
66  M2MB_SYSTEM_BOOT_REASON_PON_COLD_BOOT,
67  M2MB_SYSTEM_BOOT_REASON_WATCHDOG_BOOT,
68  M2MB_SYSTEM_BOOT_REASON_SW_BOOT,
69  M2MB_SYSTEM_BOOT_REASON_EXCEPTION_HARD_FAULT,
70  M2MB_SYSTEM_BOOT_REASON_EXCEPTION_MEM_FAULT,
71  M2MB_SYSTEM_BOOT_REASON_EXCEPTION_USAGE_FAULT,
72  M2MB_SYSTEM_BOOT_REASON_EXCEPTION_BUS_FAULT,
73  M2MB_SYSTEM_BOOT_REASON_STANDBY_BOOT,
74  M2MB_SYSTEM_BOOT_REASON_UNKNOWN_BOOT,
75  M2MB_SYSTEM_BOOT_REASON_SIZE_ENUM = 0x7FFFFFFF /* Size enum to 32 bits. */
76 } M2MB_SYSTEM_RESET_RESON_T;
77 
86 typedef struct M2MB_SYSTEM_EXCEPTION_INFO
87 {
88  M2MB_SYSTEM_RESET_RESON_T reason;
89  UINT32 reg[16];
90  UINT32 stk_reg[30];
91  UINT8 file_name[M2MB_ERR_LOG_MAX_FILE_NAME_LEN];
92  UINT32 line_no;
93  UINT8 thread_name[M2MB_ERR_LOG_MAX_THREAD_NAME_LEN];
94 } M2MB_SYSTEM_EXCEPTION_INFO_T;
95 
96 /* Global functions =============================================================================*/
97 
98 /*-----------------------------------------------------------------------------------------------*/
122 /*-----------------------------------------------------------------------------------------------*/
123 VOID m2mb_system_reset( VOID );
124 
125 /*-----------------------------------------------------------------------------------------------*/
151 /*-----------------------------------------------------------------------------------------------*/
152 M2MB_STATUS_T m2mb_get_boot_reason(M2MB_SYSTEM_RESET_RESON_T *reason);
153 
154 /*-----------------------------------------------------------------------------------------------*/
186 /*-----------------------------------------------------------------------------------------------*/
187 M2MB_STATUS_T m2mb_get_exception_info(M2MB_SYSTEM_EXCEPTION_INFO_T *excptionInfo);
188 
189 /*-----------------------------------------------------------------------------------------------*/
216 /*-----------------------------------------------------------------------------------------------*/
217 VOID m2mb_wdog_enable( VOID );
218 
219 /*-----------------------------------------------------------------------------------------------*/
244 /*-----------------------------------------------------------------------------------------------*/
245 VOID m2mb_wdog_disable( VOID );
246 
247 /*-----------------------------------------------------------------------------------------------*/
276 /*-----------------------------------------------------------------------------------------------*/
277 UINT32 m2mb_wdog_is_enable( VOID );
278 
279 /*-----------------------------------------------------------------------------------------------*/
305 /*-----------------------------------------------------------------------------------------------*/
306 VOID m2mb_wdog_kick( VOID );
307 
311 /*-----------------------------------------------------------------------------------------------*/
312 
313 #endif /* M2M_M2MB_SYSTEM_RESET_H */
M2MB_SYSTEM_EXCEPTION_INFO::reason
M2MB_SYSTEM_RESET_RESON_T reason
Definition: m2mb_system_reset.h:88
UINT8
unsigned char UINT8
Definition: m2mb_types.h:86
m2mb_wdog_enable
VOID m2mb_wdog_enable(VOID)
To enable watchdog.
M2MB_ERR_LOG_MAX_FILE_NAME_LEN
#define M2MB_ERR_LOG_MAX_FILE_NAME_LEN
Definition: m2mb_system_reset.h:51
M2MB_SYSTEM_RESET_RESON_T
M2MB_SYSTEM_RESET_RESON_T
Enum defining different boot reason.
Definition: m2mb_system_reset.h:64
M2MB_SYSTEM_EXCEPTION_INFO::thread_name
UINT8 thread_name[M2MB_ERR_LOG_MAX_THREAD_NAME_LEN]
Definition: m2mb_system_reset.h:93
m2mb_wdog_is_enable
UINT32 m2mb_wdog_is_enable(VOID)
To find whether the watchdog is enabled or not.
m2mb_system_reset
VOID m2mb_system_reset(VOID)
System Reset API.
M2MB_STATUS_T
INT32 M2MB_STATUS_T
Definition: m2mb_status.h:97
M2MB_ERR_LOG_MAX_THREAD_NAME_LEN
#define M2MB_ERR_LOG_MAX_THREAD_NAME_LEN
Definition: m2mb_system_reset.h:52
M2MB_SYSTEM_EXCEPTION_INFO::file_name
UINT8 file_name[M2MB_ERR_LOG_MAX_FILE_NAME_LEN]
Definition: m2mb_system_reset.h:91
M2MB_SYSTEM_EXCEPTION_INFO
Structure defining details of exception information.
Definition: m2mb_system_reset.h:86
VOID
void VOID
Definition: m2mb_types.h:74
m2mb_wdog_kick
VOID m2mb_wdog_kick(VOID)
To reset the watchdog.
m2mb_get_boot_reason
M2MB_STATUS_T m2mb_get_boot_reason(M2MB_SYSTEM_RESET_RESON_T *reason)
Boot reason.
m2mb_get_exception_info
M2MB_STATUS_T m2mb_get_exception_info(M2MB_SYSTEM_EXCEPTION_INFO_T *excptionInfo)
To get the details on exception.
UINT32
unsigned long int UINT32
Definition: m2mb_types.h:88
m2mb_wdog_disable
VOID m2mb_wdog_disable(VOID)
To disable watchdog.
M2MB_SYSTEM_EXCEPTION_INFO_T
struct M2MB_SYSTEM_EXCEPTION_INFO M2MB_SYSTEM_EXCEPTION_INFO_T
Structure defining details of exception information.