m2mb API docs  25.30.004.0
m2mb API sets documentation
m2mb_power.h
Go to the documentation of this file.
1 /* $version: 252203 */
2 /*===============================================================================================*/
3 /* >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<< */
25 #ifndef M2MB_POWER_H
26 #define M2MB_POWER_H
27 
35 /* Global declarations ==========================================================================*/
36 /* Global enums ==============================================================================*/
37 /* Global typedefs ==============================================================================*/
38 
43 typedef enum
44 {
45  M2MB_POWER_SYSHALT_EVT,
46  M2MB_POWER_DUMMY_EVT
47 } M2MB_POWER_EVT_E;
48 
53 typedef enum
54 {
55  M2MB_POWER_DO_RBT,
56  M2MB_POWER_DO_SHDN,
57 } M2MB_POWER_ACTION_E;
58 
63 typedef HANDLE M2MB_POWER_HANDLE;
64 
65 
72 typedef void ( *m2mb_power_ind_callback )( M2MB_POWER_HANDLE h, M2MB_POWER_EVT_E power_event, UINT16 resp_size, void *resp_struct, void *userdata );
73 /* Global functions =============================================================================*/
74 
75 /*-----------------------------------------------------------------------------------------------*/
108 /*-----------------------------------------------------------------------------------------------*/
109 M2MB_RESULT_E m2mb_power_init( M2MB_POWER_HANDLE *pHandle, m2mb_power_ind_callback callback, void *userdata );
110 
111 /*-----------------------------------------------------------------------------------------------*/
140 /*-----------------------------------------------------------------------------------------------*/
141 M2MB_RESULT_E m2mb_power_deinit( M2MB_POWER_HANDLE handle );
142 
143 /*-----------------------------------------------------------------------------------------------*/
175 /*-----------------------------------------------------------------------------------------------*/
176 M2MB_RESULT_E m2mb_power_reboot( M2MB_POWER_HANDLE handle );
177 
178 /*-----------------------------------------------------------------------------------------------*/
210 /*-----------------------------------------------------------------------------------------------*/
211 M2MB_RESULT_E m2mb_power_shutdown( M2MB_POWER_HANDLE handle );
212 
214 #endif // M2MB_POWER_H
M2MB_POWER_DO_SHDN
Definition: m2mb_power.h:56
M2MB_POWER_EVT_E
M2MB_POWER_EVT_E
Enumeration representing all power related events.
Definition: m2mb_power.h:43
M2MB_POWER_DO_RBT
Definition: m2mb_power.h:55
M2MB_POWER_ACTION_E
M2MB_POWER_ACTION_E
Enumeration representing all power related actions.
Definition: m2mb_power.h:53
M2MB_POWER_HANDLE
HANDLE M2MB_POWER_HANDLE
Generic handle type for power operations.
Definition: m2mb_power.h:63
m2mb_power_deinit
M2MB_RESULT_E m2mb_power_deinit(M2MB_POWER_HANDLE handle)
Deinitializes the power management system.
m2mb_power_init
M2MB_RESULT_E m2mb_power_init(M2MB_POWER_HANDLE *pHandle, m2mb_power_ind_callback callback, void *userdata)
Initializes the power system.
M2MB_POWER_DUMMY_EVT
Definition: m2mb_power.h:46
m2mb_power_ind_callback
void(* m2mb_power_ind_callback)(M2MB_POWER_HANDLE h, M2MB_POWER_EVT_E power_event, UINT16 resp_size, void *resp_struct, void *userdata)
Power events indication callback type.
Definition: m2mb_power.h:72
m2mb_power_shutdown
M2MB_RESULT_E m2mb_power_shutdown(M2MB_POWER_HANDLE handle)
Turns off the system.
m2mb_power_reboot
M2MB_RESULT_E m2mb_power_reboot(M2MB_POWER_HANDLE handle)
Restarts all the system.