m2mb API docs  37.00.006.0
m2mb API sets documentation
m2mb_ati.h
Go to the documentation of this file.
1 /* $version: 372317T2_R1 */
2 /*===============================================================================================*/
3 /* >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<< */
23 #ifndef M2M_M2MB_ATI_API_H
24 #define M2M_M2MB_ATI_API_H
25 
26 
27 /* Global declarations ==========================================================================*/
28 
29 
30 /* Global typedefs ==============================================================================*/
31 
32 typedef HANDLE M2MB_ATI_HANDLE;
33 
39 typedef enum
40 {
41  M2MB_RX_DATA_EVT = 0x01,
42  M2MB_STATE_IDLE_EVT = 0x02,
43  M2MB_STATE_RUNNING_EVT = 0x04,
44  M2MB_STATE_CMD_MODE_EVT = 0x08,
45  M2MB_STATE_ONLINE_MODE_EVT = 0x10
46 } M2MB_ATI_EVENTS_E;
47 
54 typedef void ( *m2mb_ati_callback )( M2MB_ATI_HANDLE h, M2MB_ATI_EVENTS_E ati_event, UINT16 resp_size, void *resp_struct, void *userdata );
55 
56 /* Global functions =============================================================================*/
57 
58 /*-----------------------------------------------------------------------------------------------*/
107 /*-----------------------------------------------------------------------------------------------*/
108 M2MB_RESULT_E m2mb_ati_init( M2MB_ATI_HANDLE *pHandle, INT16 atInstance, m2mb_ati_callback callback, void *userdata );
109 
110 /*-----------------------------------------------------------------------------------------------*/
145 /*-----------------------------------------------------------------------------------------------*/
146 M2MB_RESULT_E m2mb_ati_deinit( M2MB_ATI_HANDLE handle );
147 
148 
149 /*-----------------------------------------------------------------------------------------------*/
189 /*-----------------------------------------------------------------------------------------------*/
190 M2MB_RESULT_E m2mb_ati_send_cmd( M2MB_ATI_HANDLE handle, void *buf, SIZE_T nbyte );
191 
192 /*-----------------------------------------------------------------------------------------------*/
230 /*-----------------------------------------------------------------------------------------------*/
231 SSIZE_T m2mb_ati_rcv_resp( M2MB_ATI_HANDLE handle, void *buf, SIZE_T nbyte );
232 
233 #endif
234 
M2MB_STATE_IDLE_EVT
Definition: m2mb_ati.h:42
M2MB_STATE_CMD_MODE_EVT
Definition: m2mb_ati.h:44
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:43
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:54
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:39
M2MB_STATE_ONLINE_MODE_EVT
Definition: m2mb_ati.h:45
M2MB_RX_DATA_EVT
Definition: m2mb_ati.h:41
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.