m2mb API docs  25.21.002
m2mb API sets documentation
m2mb_ati.h
Go to the documentation of this file.
1 /*===============================================================================================*/
2 /* >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<< */
22 #ifndef M2M_M2MB_ATI_API_H
23 #define M2M_M2MB_ATI_API_H
24 
25 
26 /* Global declarations ==========================================================================*/
27 
28 
29 /* Global typedefs ==============================================================================*/
30 
31 typedef HANDLE M2MB_ATI_HANDLE;
32 
38 typedef enum
39 {
40  M2MB_RX_DATA_EVT = 0x01,
41  M2MB_STATE_IDLE_EVT = 0x02,
42  M2MB_STATE_RUNNING_EVT = 0x04,
43  M2MB_STATE_CMD_MODE_EVT = 0x08,
44  M2MB_STATE_ONLINE_MODE_EVT = 0x10
45 } M2MB_ATI_EVENTS_E;
46 
53 typedef void ( *m2mb_ati_callback )( M2MB_ATI_HANDLE h, M2MB_ATI_EVENTS_E ati_event, UINT16 resp_size, void *resp_struct, void *userdata );
54 
55 /* Global functions =============================================================================*/
56 
57 /*-----------------------------------------------------------------------------------------------*/
104 /*-----------------------------------------------------------------------------------------------*/
105 M2MB_RESULT_E m2mb_ati_init( M2MB_ATI_HANDLE *pHandle, INT16 atInstance, m2mb_ati_callback callback, void *userdata );
106 
107 /*-----------------------------------------------------------------------------------------------*/
142 /*-----------------------------------------------------------------------------------------------*/
143 M2MB_RESULT_E m2mb_ati_deinit( M2MB_ATI_HANDLE handle );
144 
145 
146 /*-----------------------------------------------------------------------------------------------*/
186 /*-----------------------------------------------------------------------------------------------*/
187 M2MB_RESULT_E m2mb_ati_send_cmd( M2MB_ATI_HANDLE handle, void *buf, SIZE_T nbyte );
188 
189 /*-----------------------------------------------------------------------------------------------*/
227 /*-----------------------------------------------------------------------------------------------*/
228 SSIZE_T m2mb_ati_rcv_resp( M2MB_ATI_HANDLE handle, void *buf, SIZE_T nbyte );
229 
230 #endif
231 
M2MB_STATE_IDLE_EVT
Definition: m2mb_ati.h:41
M2MB_STATE_CMD_MODE_EVT
Definition: m2mb_ati.h:43
m2mb_ati_send_cmd
M2MB_RESULT_E m2mb_ati_send_cmd(M2MB_ATI_HANDLE handle, void *buf, SIZE_T nbyte)
m2mb_ati_send_cmd sends a command to an initialized ATI interface.
M2MB_STATE_RUNNING_EVT
Definition: m2mb_ati.h:42
m2mb_ati_callback
void(* m2mb_ati_callback)(M2MB_ATI_HANDLE h, M2MB_ATI_EVENTS_E ati_event, UINT16 resp_size, void *resp_struct, void *userdata)
Transmit and receive operation callback type.
Definition: m2mb_ati.h:53
m2mb_ati_deinit
M2MB_RESULT_E m2mb_ati_deinit(M2MB_ATI_HANDLE handle)
m2mb_ati_deinit deinitializes ATI interface for current client.
M2MB_ATI_EVENTS_E
M2MB_ATI_EVENTS_E
ATI event type.
Definition: m2mb_ati.h:38
M2MB_STATE_ONLINE_MODE_EVT
Definition: m2mb_ati.h:44
M2MB_RX_DATA_EVT
Definition: m2mb_ati.h:40
m2mb_ati_rcv_resp
SSIZE_T m2mb_ati_rcv_resp(M2MB_ATI_HANDLE handle, void *buf, SIZE_T nbyte)
m2mb_ati_rcv_resp receives data from an initialized ATI interface.
m2mb_ati_init
M2MB_RESULT_E m2mb_ati_init(M2MB_ATI_HANDLE *pHandle, INT16 atInstance, m2mb_ati_callback callback, void *userdata)
m2mb_ati_init initializes a ATI interface for current client.