m2mb_net.h

Go to the documentation of this file.

/* $version: 252422_R1  */ 
/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef  M2M_M2MB_NET_API_H
#define  M2M_M2MB_NET_API_H
 
 
/* Global declarations ==========================================================================*/
 
#define M2MB_NET_BSR_IDLE_TMR_MIN    1    /* min BSR timer value in seconds */
#define M2MB_NET_BSR_IDLE_TMR_MAX    1800 /* max BSR timer value in seconds - 30 min */
 
/* Global typedefs ==============================================================================*/
 
typedef HANDLE M2MB_NET_HANDLE;
 
typedef enum
{
  M2MB_NET_SUCCESS,
  M2MB_NET_GENERIC_FAILURE
} M2MB_NET_ERRNO_E;
 
/* see ETSI TS 27.007 V14 - commands +CREG, +CGREG and +CEREG */
typedef enum
{
  M2MB_NET_RAT_UNKNOWN = -1,
  M2MB_NET_RAT_GSM,
  M2MB_NET_RAT_GSM_Compact,
  M2MB_NET_RAT_UTRAN,
  M2MB_NET_RAT_GSM_wEGPRS,
  M2MB_NET_RAT_UTRAN_wHSDPA,
  M2MB_NET_RAT_UTRAN_wHSUPA,
  M2MB_NET_RAT_UTRAN_wHSDPAandHSUPA,
  M2MB_NET_RAT_EUTRAN,
  M2MB_NET_RAT_EC_GSM_IoT,
  M2MB_NET_RAT_EUTRAN_NB_S1
} M2MB_NET_RAT_E;
 
typedef enum
{
  M2MB_NET_STAT_NOT_REGISTERED,
  M2MB_NET_STAT_REGISTERED_HOME,
  M2MB_NET_STAT_SEARCHING,
  M2MB_NET_STAT_REGISTRATION_DENIED,
  M2MB_NET_STAT_UNKNOWN,
  M2MB_NET_STAT_REGISTERED_ROAMING
} M2MB_NET_STAT_E;
 
typedef enum
{
  M2MB_NET_AVAILABILITY_UNKNOWN,
  M2MB_NET_AVAILABILITY_AVAILABLE,
  M2MB_NET_AVAILABILITY_CURRENT,
  M2MB_NET_AVAILABILITY_FORBIDDEN
} M2MB_NET_AVAILABILITY_E;
 
typedef enum
{
  M2MB_NET_NULL_RESP,
  M2MB_NET_GET_SIGNAL_INFO_RESP,
  M2MB_NET_GET_BER_RESP,
  M2MB_NET_GET_CURRENT_OPERATOR_INFO_RESP,
  M2MB_NET_GET_CURRENT_CELL_LIST_RESP,
  M2MB_NET_GET_AVAILABLE_NW_LIST_RESP,
  M2MB_NET_GET_REG_STATUS_INFO_RESP,
  M2MB_NET_REG_STATUS_IND,                 /* Network registration state change indication */
  M2MB_NET_GET_EDRX_INFO_RESP,
  M2MB_NET_SET_EDRX_INFO_RESP,
  M2MB_NET_ENABLE_IND_RESP,
  M2MB_NET_GET_MODE_PREFERENCE_RESP,       /* Network Mode Preference Get response */
  M2MB_NET_SET_MODE_PREFERENCE_RESP,       /* Network Mode Preference Set response */
  M2MB_NET_MODE_PREFERENCE_IND,            /* Network Mode Preference indication */
  M2MB_NET_LAST
} M2MB_NET_IND_E;
 
typedef enum
{
  M2MB_NET_DUMMY,
  M2MB_NET_SET_ENABLE_IND_ASYNC,
  M2MB_NET_GET_ENABLE_IND_ASYNC
} M2MB_NET_ACTION_E;
 
typedef enum
{
  M2MB_NET_RESP_SET_NONE,
  M2MB_NET_RESP_SET_FULL,
  M2MB_NET_RESP_SET_SUBSET1,
  M2MB_NET_RESP_SET_SUBSET2,
  M2MB_NET_RESP_SET_SUBSET3,
  M2MB_NET_RESP_SET_SUBSET4,
  M2MB_NET_RESP_SET_SUBSET5
} M2MB_NET_RESP_SET_E;
 
typedef enum
{
  M2MB_NET_LTE_HANDOVER_SERVING,
  M2MB_NET_LTE_HANDOVER_INTRA_FREQ,
  M2MB_NET_LTE_HANDOVER_INTER_FREQ,
} M2MB_NET_LTE_HANDOVER_E;
 
typedef enum
{
  M2MB_NET_SRV_DOMAIN_NO_SRV,
  M2MB_NET_SRV_DOMAIN_CS_ONLY,
  M2MB_NET_SRV_DOMAIN_PS_ONLY,
  M2MB_NET_SRV_DOMAIN_CS_PS,
  M2MB_NET_SRV_DOMAIN_CAMPED
} M2MB_NET_SRV_DOMAIN_E;
 
typedef enum
{
  M2MB_NET_CELL_TYPE_SERVING,
  M2MB_NET_CELL_TYPE_NEIGHBOR
} M2MB_NET_CELL_TYPE_E;
 
typedef enum
{
  M2MB_NET_ACC_TECH_TYPE_NO_SRV,
  M2MB_NET_ACC_TECH_TYPE_CDMA_1X,
  M2MB_NET_ACC_TECH_TYPE_CDMA_1XEVDO,
  M2MB_NET_ACC_TECH_TYPE_AMPS,
  M2MB_NET_ACC_TECH_TYPE_GSM,
  M2MB_NET_ACC_TECH_TYPE_UMTS,
  M2MB_NET_ACC_TECH_TYPE_WLAN,
  M2MB_NET_ACC_TECH_TYPE_GPS,
  M2MB_NET_ACC_TECH_TYPE_LTE,
  M2MB_NET_ACC_TECH_TYPE_TDSCDMA,
  M2MB_NET_ACC_TECH_TYPE_LTE_M1,
  M2MB_NET_ACC_TECH_TYPE_LTE_NB1,
  M2MB_NET_ACC_TECH_TYPE_MAX
} M2MB_NET_ACC_TECH_TYPE_E;
 
typedef enum
{
  M2MB_NET_ERR_OK,
  M2MB_NET_ERR_UNKNOWN
} M2MB_NET_ERR_CAUSE_E;
 
typedef enum
{
  M2MB_NET_ENABLE_IND_ASYNC_DISABLED,
  M2MB_NET_ENABLE_IND_ASYNC_ENABLED
} M2MB_NET_ENABLE_IND_ASYNC_E;
 
typedef enum
{
  M2MB_NET_SELECTED_WIRELESS_UNKNOWN = -1,
  M2MB_NET_SELECTED_WIRELESS_GERAN = 12,
  M2MB_NET_SELECTED_WIRELESS_UTRAN = 22,
  M2MB_NET_SELECTED_WIRELESS_GERAN_UTRAN_EUTRAN = 25,
  M2MB_NET_SELECTED_WIRELESS_EUTRAN = 28,
  M2MB_NET_SELECTED_WIRELESS_GERAN_UTRAN = 29,
  M2MB_NET_SELECTED_WIRELESS_GERAN_EUTRAN = 30,
  M2MB_NET_SELECTED_WIRELESS_UTRAN_EUTRAN = 31
} M2MB_NET_SELECTED_WIRELESS_NETWORK_E;
 
typedef enum
{
  M2MB_NET_LTE_CIOT_PREFERENCE_UNKNOWN = -1,
  M2MB_NET_LTE_CIOT_PREFERENCE_CAT_M1 = 0,        /* CAT-M exclusive */
  M2MB_NET_LTE_CIOT_PREFERENCE_NB_IOT = 1,        /* NB-IoT exclusive */
  M2MB_NET_LTE_CIOT_PREFERENCE_CAT_M1_NB_IOT = 2, /* Both CAT-M and NB-IoT, CAT-M preferred */
  M2MB_NET_LTE_CIOT_PREFERENCE_NB_IOT_CAT_M1 = 3  /* Both CAT-M and NB-IoT, NB-IoT preferred */
} M2MB_NET_LTE_CIOT_PREFERENCE_E;
 
typedef enum
{
  M2MB_NET_PRIORITY_UNKNOWN = -1,             /* Unknown priority */
  M2MB_NET_PRIORITY_4G = 0,                   /* 4G priority */
  M2MB_NET_PRIORITY_2G = 1,                   /* 2G priority */
} M2MB_NET_PRIORITY_E;
 
typedef enum M2MB_NET_BSR_CFG_TAG
{
  M2MB_NET_BSR_SET_IDLE_TMR = 0,
  M2MB_NET_BSR_GET_IDLE_TMR = 1
} M2MB_NET_BSR_CFG_E;
 
typedef struct
{
  M2MB_NET_ERR_CAUSE_E err;
} M2MB_NET_ERR_CAUSE_T;
 
typedef struct
{
  M2MB_NET_ERR_CAUSE_E err;
  M2MB_RESULT_E response;
} M2MB_NET_GENERIC_RESP_T;
 
typedef struct
{
  M2MB_NET_ERR_CAUSE_E err;
  M2MB_NET_STAT_E stat;             /* Network status */
  M2MB_NET_RAT_E rat;               /* Radio Access Technology */
  M2MB_NET_SRV_DOMAIN_E srvDomain;
  UINT16 areaCode;                  /* LAC or TAC, depending on the current RAT */
  UINT32 cellID;
} M2MB_NET_REG_STATUS_T;
 
typedef struct
{
  M2MB_NET_ERR_CAUSE_E err;
  M2MB_NET_ACC_TECH_TYPE_E acc_tech;
  UINT8 edrx;
  UINT8 enabled;
} M2MB_NET_GET_EDRX_INFO_RESP_T;
 
typedef struct
{
  INT16 ecio;
} M2MB_NET_SIGNAL_INFO_UTRAN_T;
 
typedef struct
{
  INT8 rsrq;   /* Reference Signal Received Quality */
  INT16 rsrp;  /* Reference Signal Received Power */
  INT16 snr;
} M2MB_NET_SIGNAL_INFO_EUTRAN_T;
 
typedef struct
{
  M2MB_NET_ERR_CAUSE_E err;
  M2MB_NET_RAT_E rat;
  INT8 rssi;  /* Received signal strength indication */
  UINT16 sigInfo_size;
  void *sigInfo;
} M2MB_NET_GET_SIGNAL_INFO_RESP_T;
 
typedef struct
{
  M2MB_NET_ERR_CAUSE_E err;
  M2MB_NET_RAT_E rat;
  INT16 ber;  /* Bit error rate */
} M2MB_NET_GET_BER_RESP_T;
 
typedef struct
{
  INT32 nARFCN;
  INT32 nBSIC;
  INT32 nSignalStrength;
} M2M_T_NETWORK_CELL_NEIGHBOR_T;
 
typedef struct
{
  UINT32 cell_id; /* Cell ID (0xFFFFFFFF indicates cell ID information is not present) */
  UINT16 mcc;     /* Mobile country code */
  UINT16 mnc;     /* Mobile network code */
  UINT16 lac;     /* Location area code */
  UINT16 arfcn;   /* Absolute RF channel number */
  UINT8 bsic;     /* Base station identity code */
  UINT32 timing_advance; /* Measured delay (in bit periods; 1 bit period = 48/13 microsecond) of 
                            an access burst transmission on the RACH or PRACH to the expected signal 
                            from an MS at zero distance under static channel conditions.
                            (0xFFFFFFFF indicates timing advance information is not present */
  UINT16 rx_lev;  /* Serving cell Rx measurement. Values range between 0 and 63, which is 
                     mapped to a measured signal level: 
                     - Rxlev 0 is a signal strength less than -110 dBm,
                     - Rxlev 1 is -110 dBm to -109 dBm,
                     - Rxlev 2 is -109 dBm to -108 dBm,
                     - ....                           ,
                     - Rxlev 62 is -49 dBm to -48 dBm,
                     - Rxlev 63 is greater than -48 dBm */
} M2MB_NET_CELL_GERAN_FULL_T;
 
typedef struct
{
  UINT32 cell_id;
  UINT16 lac;
  UINT16 arfcn;
  UINT8 bsic;
  UINT16 rx_lev;
} M2MB_NET_CELL_GERAN_SUBSET1_T;
 
typedef struct
{
  UINT16 arfcn;
  UINT8 bsic;
  UINT16 rx_lev;
  INT16 srxlev;  /* Cell selection Rx level */
} M2MB_NET_CELL_GERAN_SUBSET2_T;
 
typedef union
{
  M2MB_NET_CELL_GERAN_FULL_T full;
  M2MB_NET_CELL_GERAN_SUBSET1_T subset1;
  M2MB_NET_CELL_GERAN_SUBSET2_T subset2;
} M2MB_NET_CELL_GERAN_U;
 
typedef struct
{
  UINT32 cell_id;
  UINT16 mcc;
  UINT16 mnc;
  UINT16 lac;
  UINT16 uarfcn;
  UINT16 psc;
  INT16 rscp;
  INT16 ecio;
} M2MB_NET_CELL_UTRAN_FULL_T;
 
typedef struct
{
  UINT16 uarfcn;
  UINT16 psc;
  INT16 rscp;
  INT16 ecio;
  INT16 srxlev; /* Cell selection Rx level */
} M2MB_NET_CELL_UTRAN_SUBSET1_T;
 
typedef union
{
  M2MB_NET_CELL_UTRAN_FULL_T full;
  M2MB_NET_CELL_UTRAN_SUBSET1_T subset1;
} M2MB_NET_CELL_UTRAN_U;
 
typedef struct
{
  M2MB_NET_LTE_HANDOVER_E lteType;
  UINT32 cell_id;
  UINT16 mcc;
  UINT16 mnc;
  UINT16 tac;
  UINT16 earfcn;
  UINT16 pci;
  INT16 rsrq;
  INT16 rsrp;
  INT16 rx_lev;
  INT16 srxlev;  /* Cell selection Rx level */
} M2MB_NET_CELL_EUTRAN_FULL_T;
 
typedef struct
{
  M2MB_NET_LTE_HANDOVER_E lteType;
  UINT16 earfcn;
  UINT16 pci;
  INT16 rsrq;
  INT16 rsrp;
  INT16 rx_lev;
  INT16 srxlev;  /* Cell selection Rx level */
} M2MB_NET_CELL_EUTRAN_SUBSET1_T;
 
typedef union
{
  M2MB_NET_CELL_EUTRAN_FULL_T full;
  M2MB_NET_CELL_EUTRAN_SUBSET1_T subset1;
} M2MB_NET_CELL_EUTRAN_U;
 
typedef struct M2MB_NET_CELL_NEIGHBOR_T
{
  M2MB_NET_CELL_TYPE_E cellType;
  M2MB_NET_RAT_E cellRat;
  M2MB_NET_RESP_SET_E respSet;
  UINT16 cell_size;
  void *cell;
  struct M2MB_NET_CELL_NEIGHBOR_T *next;
  BOOLEAN lte_ue_in_idle; /* Radio Status */
} M2MB_NET_CELL_NEIGHBOR_T;
 
typedef struct
{
  M2MB_NET_ERR_CAUSE_E err;
  UINT16 neighbors_size;
  M2MB_NET_CELL_NEIGHBOR_T *neighbors;
} M2MB_NET_GET_CURRENT_CELL_LIST_RESP_T;
 
typedef struct
{
  M2MB_NET_ERR_CAUSE_E err;
  UINT16 mcc;
  UINT16 mnc;
  M2MB_NET_RAT_E rat;  /* Radio Access Technology */
} M2MB_NET_GET_CURRENT_OPERATOR_INFO_RESP_T;
 
typedef struct M2MB_NET_DESCRIPTION_T
{
  UINT16 mcc;
  UINT16 mnc;
  M2MB_NET_AVAILABILITY_E networkAv;
  M2MB_NET_RAT_E rat;
  struct M2MB_NET_DESCRIPTION_T *next;
} M2MB_NET_DESCRIPTION_T;
 
typedef struct
{
  M2MB_NET_ERR_CAUSE_E err;
  UINT16 availableNetworks_size;
  M2MB_NET_DESCRIPTION_T *availableNetworks;
} M2MB_NET_GET_AVAILABLE_NW_LIST_RESP_T;
 
typedef struct
{
  M2MB_NET_SELECTED_WIRELESS_NETWORK_E selectedWirelessNetwork;
  M2MB_NET_LTE_CIOT_PREFERENCE_E lte_ciot_preference;
  M2MB_NET_PRIORITY_E priority;
} M2MB_NET_SELECTED_WIRELESS_NETWORK_RESP_T;
 
typedef M2MB_NET_SELECTED_WIRELESS_NETWORK_RESP_T M2MB_NET_MODE_PREFERENCE_T;
 
typedef struct
{
  M2MB_NET_ERR_CAUSE_E       err;             /* error status */
  M2MB_NET_MODE_PREFERENCE_T mode_preference; /* mode preference */
} M2MB_NET_MODE_PREFERENCE_STATUS_T;
 
typedef void ( *m2mb_net_ind_callback )( M2MB_NET_HANDLE h, M2MB_NET_IND_E net_event, UINT16 resp_size,
                                         void *resp_struct, void *userdata );
 
/* Global functions =============================================================================*/
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_net_init( M2MB_NET_HANDLE *h, m2mb_net_ind_callback callback, void *userdata );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_net_deinit( M2MB_NET_HANDLE h );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_net_conf( M2MB_NET_HANDLE h, UINT8 argc, ... );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_net_enable_ind( M2MB_NET_HANDLE h, M2MB_NET_IND_E ind, UINT8 enable );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_net_get_signal_info( M2MB_NET_HANDLE h );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_net_get_ber( M2MB_NET_HANDLE h );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_net_get_wireless_network_selection( M2MB_NET_HANDLE h, M2MB_NET_SELECTED_WIRELESS_NETWORK_RESP_T* resp );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_net_get_mode_preference( M2MB_NET_HANDLE h );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_net_get_current_operator_info( M2MB_NET_HANDLE h );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_net_get_current_cell_list( M2MB_NET_HANDLE h );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_net_get_available_nw_list( M2MB_NET_HANDLE h );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_net_get_reg_status_info( M2MB_NET_HANDLE h );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_net_get_edrx_info( M2MB_NET_HANDLE h, M2MB_NET_ACC_TECH_TYPE_E acc_tech );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_net_set_edrx_info( M2MB_NET_HANDLE h, M2MB_NET_ACC_TECH_TYPE_E acc_tech,
                                      UINT8 edrx, UINT8 enabled );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_net_bsr_config( M2MB_NET_HANDLE h, M2MB_NET_BSR_CFG_E request, ... );
 
#endif