WL865E4-P  36.07.001
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 
36 /*-----------------------------------------------------------------------------------------------*/
37 
42 /*-----------------------------------------------------------------------------------------------*/
43 
44 /* Global declarations ==========================================================================*/
45 
46 /* Global typedefs ==============================================================================*/
47 
56 typedef enum
57 {
58  M2MB_SYSTEM_BOOT_REASON_PON_COLD_BOOT,
59  M2MB_SYSTEM_BOOT_REASON_WATCHDOG_BOOT,
60  M2MB_SYSTEM_BOOT_REASON_SW_BOOT,
61  M2MB_SYSTEM_BOOT_REASON_EXCEPTION_HARD_FAULT,
62  M2MB_SYSTEM_BOOT_REASON_EXCEPTION_MEM_FAULT,
63  M2MB_SYSTEM_BOOT_REASON_EXCEPTION_USAGE_FAULT,
64  M2MB_SYSTEM_BOOT_REASON_EXCEPTION_BUS_FAULT,
65  M2MB_SYSTEM_BOOT_REASON_UNKNOWN_BOOT,
66  M2MB_SYSTEM_BOOT_REASON_SIZE_ENUM = 0x7FFFFFFF /* Size enum to 32 bits. */
67 } M2MB_SYSTEM_RESET_RESON_T;
68 
77 typedef struct M2MB_SYSTEM_EXCEPTION_INFO
78 {
79  M2MB_SYSTEM_RESET_RESON_T reason;
80  UINT32 reg[16];
81 } M2MB_SYSTEM_EXCEPTION_INFO_T;
82 
83 /* Global functions =============================================================================*/
84 
85 /*-----------------------------------------------------------------------------------------------*/
109 /*-----------------------------------------------------------------------------------------------*/
110 VOID m2mb_system_reset( VOID );
111 
112 /*-----------------------------------------------------------------------------------------------*/
138 /*-----------------------------------------------------------------------------------------------*/
139 M2MB_STATUS_T m2mb_get_boot_reason(M2MB_SYSTEM_RESET_RESON_T *reason);
140 
141 /*-----------------------------------------------------------------------------------------------*/
173 /*-----------------------------------------------------------------------------------------------*/
174 M2MB_STATUS_T m2mb_get_exception_info(M2MB_SYSTEM_EXCEPTION_INFO_T *excptionInfo);
175 
176 /*-----------------------------------------------------------------------------------------------*/
203 /*-----------------------------------------------------------------------------------------------*/
204 VOID m2mb_wdog_enable( VOID );
205 
206 /*-----------------------------------------------------------------------------------------------*/
231 /*-----------------------------------------------------------------------------------------------*/
232 VOID m2mb_wdog_disable( VOID );
233 
234 /*-----------------------------------------------------------------------------------------------*/
263 /*-----------------------------------------------------------------------------------------------*/
264 UINT32 m2mb_wdog_is_enable( VOID );
265 
266 /*-----------------------------------------------------------------------------------------------*/
292 /*-----------------------------------------------------------------------------------------------*/
293 VOID m2mb_wdog_kick( VOID );
294 
298 /*-----------------------------------------------------------------------------------------------*/
299 
300 #endif /* M2M_M2MB_SYSTEM_RESET_H */
M2MB_SYSTEM_EXCEPTION_INFO_T
struct M2MB_SYSTEM_EXCEPTION_INFO M2MB_SYSTEM_EXCEPTION_INFO_T
Structure defining details of exception information.
m2mb_wdog_enable
VOID m2mb_wdog_enable(VOID)
To enable watchdog.
M2MB_STATUS_T
INT32 M2MB_STATUS_T
Definition: m2mb_status.h:95
M2MB_SYSTEM_EXCEPTION_INFO::reason
M2MB_SYSTEM_RESET_RESON_T reason
Definition: m2mb_system_reset.h:79
M2MB_SYSTEM_EXCEPTION_INFO
Structure defining details of exception information.
Definition: m2mb_system_reset.h:77
UINT32
unsigned long int UINT32
Definition: m2mb_types.h:85
m2mb_system_reset
VOID m2mb_system_reset(VOID)
System Reset API.
VOID
void VOID
Definition: m2mb_types.h:72
m2mb_wdog_is_enable
UINT32 m2mb_wdog_is_enable(VOID)
To find whether the watchdog is enabled or not.
m2mb_get_boot_reason
M2MB_STATUS_T m2mb_get_boot_reason(M2MB_SYSTEM_RESET_RESON_T *reason)
Boot reason.
M2MB_SYSTEM_RESET_RESON_T
M2MB_SYSTEM_RESET_RESON_T
Enum defining different boot reason.
Definition: m2mb_system_reset.h:56
m2mb_wdog_disable
VOID m2mb_wdog_disable(VOID)
To disable watchdog.
m2mb_wdog_kick
VOID m2mb_wdog_kick(VOID)
To reset the watchdog.
m2mb_get_exception_info
M2MB_STATUS_T m2mb_get_exception_info(M2MB_SYSTEM_EXCEPTION_INFO_T *excptionInfo)
To get the details on exception.