m2mb_ncm.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
/*-----------------------------------------------------------------------------------------------*/

/* Global declarations ==========================================================================*/
#ifndef  M2MB_NCM_API_H_
#define  M2MB_NCM_API_H_

/* Feature flags used in M2MB_NCM_STA_CFG_T */
#define M2MB_NCM_FLAG_KEEP_ALIVE ( 1 << 0 ) 
#define M2MB_NCM_FLAG_DYNAMIC_KEEP_ALIVE ( 1 << 1 ) 

#define M2MB_NCM_FLAG_ROAMING ( 1 << 2 ) 
#define M2MB_NCM_FLAG_WITH_STAT ( 1 << 3 ) 
#define M2MB_WPS_PIN_LENGTH 8
#define M2MB_SECURITY_KEY_LENGTH_MAX 64
/* Global typedefs ==============================================================================*/

typedef enum M2MB_NCM_CTX_STATES
{
    M2MB_NCM_STATE_NOT_INITIALISED,             
    M2MB_NCM_STATE_INITIALISED,                 
    M2MB_NCM_STATE_L2_DISCONNECTING,            
    M2MB_NCM_STATE_L2_DISCONNECTED,             
    M2MB_NCM_STATE_L2_CONCT_TO_KNOWN_AP,        
    M2MB_NCM_STATE_L2_SCAN_KNOWN_CHNL,   
    M2MB_NCM_STATE_L2_SCAN_SPECIFIC_CHNL,
    M2MB_NCM_STATE_L2_SCAN_ALL_CHNL,     
    M2MB_NCM_STATE_L2_CONNECTED,                        
    M2MB_NCM_STATE_L3_CONNECTED,                        
    M2MB_NCM_STATE_IDLE,                                        
    M2MB_NCM_STATE_L3_IP_FAIL,                          
} M2MB_NCM_CTX_STATES_E;

typedef enum
{
        M2MB_NCM_IPFLAG_V4_STATIC = (1 << 0),   
        M2MB_NCM_IPFLAG_V4_DHCP =       (1 << 1),       
        M2MB_NCM_IPFLAG_V6_AUTO =       (1 << 2),       
        M2MB_NCM_IPFLAG_V6_DHCP =       (1 << 3)        
}M2MB_NCM_IPFLAG_SETTING_E;

typedef enum
{
        M2MB_NCM_L2_DISASSOC_DONE,                              
        M2MB_NCM_L2_RESTART,                                    
        M2MB_NCM_L2_SCAN_DONE,                                  
        M2MB_NCM_L2_SCAN_FAIL,                                  
        M2MB_NCM_L2_CONNECT_FAIL,                               
        M2MB_NCM_L2_CONNECT_DONE,                               
        M2MB_NCM_L3_CONNECT_DONE,                               
        M2MB_NCM_L3_DISCONNECT,                                 
        M2MB_NCM_L3_CONNECT_FAIL,                               
        M2MB_NCM_L2_AP_START_DONE,                              
        M2MB_NCM_L3_AP_START_DONE,                              
        M2MB_NCM_L3_AP_START_FAIL,                              
        M2MB_NCM_L2_PNO_PROFILE_DONE,                   
        M2MB_NCM_AP_STOP_DONE,                                  
        M2MB_NCM_L3_AUTO_IP_DONE,                               
        M2MB_NCM_L3_NEW_IP_DONE,                                
        M2MB_NCM_L3_CLIENT_CONNECTED,                   
        M2MB_NCM_L3_CLIENT_DISCONNECTED                 
}M2MB_L2_L3_NCM_EVENTS_ID_E;

typedef enum 
{
    M2MB_NCM_CFG_OPCODE_AP_PROFILE,                
    M2MB_NCM_CFG_OPCODE_AP_CFG,                    
    M2MB_NCM_CFG_OPCODE_STA_PROFILE,       
    M2MB_NCM_CFG_OPCODE_STA_RETRY,                 
    M2MB_NCM_CFG_OPCODE_IP_CFG,                    
    M2MB_NCM_CFG_OPCODE_DNS_CFG,                   
    M2MB_NCM_CFG_OPCODE_DHCP_SERVER_CFG,   
    M2MB_NCM_CFG_OPCODE_STA_ROAMING,       
    M2MB_NCM_CFG_OPCODE_STAT_GET,                  
    M2MB_NCM_CFG_OPCODE_CLIENT_GET,        
    M2MB_NCM_CFG_OPCODE_INTERFACE_GET,     
    M2MB_NCM_CFG_OPCODE_STA_WPS_CFG,       
    M2MB_NCM_CFG_OPCODE_STA_POWER_SAVE_CFG,
    M2MB_NCM_AP_MODE_CONNECTED_STA_INFO,        
    M2MB_NCM_AP_MODE_DISCONNECTED_STA_INFO,     
    M2MB_NCM_MODE_L2_ONLY,      
}M2MB_NCM_CFG_OPCODE_E;

typedef enum
{
        M2MB_NCM_MODE_STATION, 
        M2MB_NCM_MODE_AP,          
        M2MB_NCM_MODE_BOTH     
}M2MB_NCM_INIT_MODE_E;
typedef struct M2MB_NCM_AP_PROFILE
{
    UINT8 ssid_Len; 
    UINT8 ssid[M2MB_WLAN_MAX_SSID_LEN + 1]; 
    UINT8 security_KeyLen;  
    UINT8 security_Key[M2MB_SECURITY_KEY_LENGTH_MAX + 1];       
        UINT8 channel;                  
    M2MB_WLAN_AUTH_TYPE_E      auth_Mode;          
    M2MB_WLAN_ENCRYPT_TYPE_E     encryption_Type;  
} M2MB_NCM_AP_PROFILE_T;

typedef struct M2MB_NCM_STA_CFG
{
    UINT32 featureFlag;         
    UINT32 keepAlivePeriod; 
        UINT32 listenInterval;  
        UINT16 scan_retry_count;
        UINT16 scan_retry_time_delay;
        UINT16 l3_retry_count;
        UINT16 l3_retry_time_delay;
        UINT16 l2_connect_count;
        UINT16 l2_connect_time_delay;
} M2MB_NCM_STA_CFG_T;

typedef struct M2MB_NCM_WPS_CFG
{
        UINT8 wps_flag;         
        UINT8 method;                   
        UINT8 pin[M2MB_WPS_PIN_LENGTH + 1];                     
}M2MB_NCM_WPS_CFG_T;

typedef struct M2MB_NCM_POWER_SAVE_CFG
{
        UINT8 enable;
        UINT8 dtim_policy;
    UINT16 idle_period;
    UINT16 ps_poll_num;
    UINT16 num_tx_to_wakeup;
}M2MB_NCM_POWER_SAVE_CFG_T;
typedef struct M2MB_NCM_AP_CFG
{
    UINT8               hiddenSsid;                     
    UINT16              beaconInterval;         
    UINT8               dtimPeriod;                     
        UINT8           wps_support;            
        UINT32          inactivity_ap_period; 
} M2MB_NCM_AP_CFG_T;

typedef struct M2MB_NCM_DHCP_SERVER_CFG
{
        UINT32 startIP;                                 
    UINT32 endIP;                                       
    UINT32 leaseTime;                           
}M2MB_NCM_DHCP_SERVER_CFG_T;

typedef struct M2MB_NCM_IP_CFG
{
    UINT8 ipFlag;                                                       
        M2MB_NWIF_IPV4_CONFIG_T *pIPv4Cfg;              
    M2MB_NWIF_IPV6_CONFIG_T *pIPv6Cfg;          
        INT8*  Hostname;                                                
    M2MB_NWIF_DNS_SERVER_LIST_T *pDNSList;      
} M2MB_NCM_IP_CFG_T;

typedef struct M2MB_NCM_IFCFG
{
        UINT8 device_id;                                                
        UINT8 mac_addr[6];                                              
        INT32 state;                                                    
        INT32 wstate;                                                   
        INT32 mode;                                                             
        UINT8 bssid_mac_addr[6];                                
        UINT8 ssid[33];                                                 
        INT32 channel;                                                  
        INT32 security;                                                 
        INT32 rssi;                                                             
        UINT32 ip_addr;                                                 
        UINT32 subnet_mask;                                             
        UINT32 gateway;                                                 
        UINT32 dns1;                                                    
        UINT32 dns2;                                                    
        UINT32 dns3;                                                    
}M2MB_NCM_IFCFG_T;
typedef struct M2MB_NCM_RETRY_CFG
{
    UINT32 fastScanIntervalInMs; 
    UINT32 fastScanDurationInMs; 
    UINT32 slowScanIntervalInMs; 
    UINT32 maxL3ConnectCnt;     
} M2MB_NCM_RETRY_CFG_T;

typedef struct M2MB_NCM_ROAMING_CFG
{
    UINT16 rssiLowThreshold;                    
    UINT16 rssiHighThreshold;                   
    UINT32 pollTime;                                    
    INT32  forceFgScan;                                 
    UINT32 homeDwellTimeInMs;                   
    UINT32 forceScanIntervalInMs;               
    UINT8  scanType;                                    
    UINT8  numChannels;                                 
    UINT16 channelList[1];                              
} M2MB_NCM_ROAMING_CFG_T;

typedef enum {
    M2MB_WLAN_NO_NETWORK_AVAIL              = 0x01,     
    M2MB_WLAN_LOST_LINK                     = 0x02,     
    M2MB_WLAN_DISCONNECT_CMD                = 0x03,     
    M2MB_WLAN_BSS_DISCONNECTED              = 0x04,     
    M2MB_WLAN_AUTH_FAILED                   = 0x05,     
    M2MB_WLAN_ASSOC_FAILED                  = 0x06,     
    M2MB_WLAN_NO_RESOURCES_AVAIL            = 0x07,     
    M2MB_WLAN_CSERV_DISCONNECT              = 0x08,     
    M2MB_WLAN_INVALID_PROFILE               = 0x0a,     
    M2MB_WLAN_DOT11H_CHANNEL_SWITCH         = 0x0b,     
    M2MB_WLAN_PROFILE_MISMATCH              = 0x0c,     
    M2MB_WLAN_CONNECTION_EVICTED            = 0x0d,     
    M2MB_WLAN_IBSS_MERGE                    = 0x0e,     
    M2MB_WLAN_EXCESS_TX_RETRY               = 0x0f,     
    M2MB_WLAN_SEC_HS_TO_RECV_M1             = 0x10,     
    M2MB_WLAN_SEC_HS_TO_RECV_M3             = 0x11,     
    M2MB_WLAN_TKIP_COUNTERMEASURES          = 0x12,     
    M2MB_WLAN_SCAN_FAIL                                         = 0x13,         
    M2MB_L3_FAIL                                                        = 0x14,         
} M2MB_DISASSOC_REASON_T;

typedef struct M2MB_NCM_DEVICE_STATS
{
    UINT32 ucastTxPkts;                  
    UINT32 ucastRxPkts;                  
    UINT32 mcastTxPkts;                  
    UINT32 mcastRxPkts;                  
    UINT32 bcastTxPkts;                  
    UINT32 bcastRxPkts;                  
    UINT32 ucastNonNullTxPkts;           
    UINT32 ucastNonNullRxPkts;           
    UINT32 ucastFilteredAcceptedTxPkts;  
    UINT32 ucastFilteredAcceptedRxPkts;  
    UINT32 mcastFilteredAcceptedTxPkts;  
    UINT32 mcastFilteredAcceptedRxPkts;  
    UINT32 bcastFilteredAcceptedTxPkts;  
    UINT32 bcastFilteredAcceptedRxPkts;  
    UINT32 ucastFilteredRejectedTxPkts;  
    UINT32 ucastFilteredRejectedRxPkts;  
    UINT32 mcastFilteredRejectedTxPkts;  
    UINT32 mcastFilteredRejectedRxPkts;  
    UINT32 bcastFilteredRejectedTxPkts;  
    UINT32 bcastFilteredRejectedRxPkts;  
    UINT32 nullTxPkts;                   
    UINT32 nullRxPkts;                   
    UINT32 qosNullTxPkts;                
    UINT32 qosNullRxPkts;                
    UINT32 psPollTxPkts;                 
    UINT32 psPollRxPkts;                 
    UINT32 txRetryCnt;                   
    UINT32 beaconMissCnt;                
    UINT32 beaconsReceivedCnt;           
    UINT32 beaconResyncSuccessCnt;       
    UINT32 beaconResyncFailureCnt;       
    UINT32 currEarlyWakeupAdjInMs;       
    UINT32 avgEarlyWakeupAdjInMs;        
    UINT32 earlyTerminationCnt;          
    UINT32 uapsdTriggerRxCnt;            
    UINT32 uapsdTriggerTxCnt;            
    UINT32 totalActiveTimeInMs;          
    UINT32 totalPowersaveTimeInMs;       
}M2MB_NCM_DEVICE_STATS_T;

typedef struct M2MB_NCM_CONNECTED_STA_INFO
{
    UINT8  macAddr[M2MB_WLAN_MAC_LEN];  
    UINT32 ipv4Addr;                                    
        UINT8  flag;                                            
}M2MB_NCM_CONNECTED_STA_INFO_T;

typedef union M2MB_NCM_CFG_PTR
{
    M2MB_NCM_AP_PROFILE_T *pAP;                         
    M2MB_NCM_STA_CFG_T *pSTACfg;                        
    M2MB_NCM_AP_CFG_T *pAPCfg;                          
    M2MB_NCM_IP_CFG_T *pIPCfg;                          
        M2MB_NCM_DHCP_SERVER_CFG_T *pDhcpSCfg;  
    M2MB_NCM_RETRY_CFG_T *pRtCfg;                       
    M2MB_NCM_ROAMING_CFG_T *pRCfg;                      
    M2MB_NCM_DEVICE_STATS_T *pStat;                     
    M2MB_NCM_CONNECTED_STA_INFO_T *pInfo;       
        M2MB_NCM_IFCFG_T *pIfCfg;                               
        M2MB_NCM_WPS_CFG_T *pWpsCfg;
        M2MB_NCM_POWER_SAVE_CFG_T *pPowerCfg;
}M2MB_NCM_CFG_PTR_T;



typedef VOID (* M2MB_NCM_CB_T)(UINT8 device_id, UINT8 event, INT32 status_code, VOID *cb_Ctx);
typedef VOID (* M2MB_NCM_SCAN_CB_T)(UINT8 device_id, UINT8 event_id, INT32 status, VOID *data);


/* Global functions =========================================================*/
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
UINT8 m2mb_ncm_init( UINT8 mode, UINT8 bandwidth, M2MB_NCM_CB_T cb, VOID *cb_ctx );

/*---------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_ncm_get_cfg( UINT8 handle, M2MB_NCM_CFG_OPCODE_E opCode, 
    M2MB_NCM_CFG_PTR_T *p );

/*-----------------------------------------------------------------------------------------------*/    
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_ncm_set_cfg( UINT8 handle, M2MB_NCM_CFG_OPCODE_E opCode, 
    M2MB_NCM_CFG_PTR_T *p );
    
/*-----------------------------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
INT32 m2mb_ncm_register_cb(UINT8 handle, M2MB_NCM_CB_T m2mb_ncm_cb, 
                                                                                                VOID *Ctx);
/*---------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_ncm_start( UINT8 handle );
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
INT32 m2mb_ncm_stop(UINT8 handle);
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
INT32 m2mb_ncm_deregister_cb(UINT8 handle);
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_ncm_deinit( UINT8 handle );
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
UINT32 m2mb_ncm_check_handle_init(UINT32 handle);
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
INT32 m2mb_ncm_get_state(UINT8 device_id);
/*---------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
INT32 m2mb_ncm_scan( UINT8 device_id, UINT8 *ssid, UINT8 no_of_channels, 
                                                                UINT8 *channel_list, UINT8 scan_type, UINT32 num_of_scan_entries,
                                                                M2MB_WLAN_BSS_SCAN_INFO_T *scanentries, M2MB_NCM_SCAN_CB_T m2m_ncm_scan_cb, VOID *usr_ctx );
/*----------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------*/

#endif