m2m_wifi.h

Go to the documentation of this file.

#ifndef __M2M_WIFI_H__
#define __M2M_WIFI_H__

/*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*
INCLUDES
*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*/

#include "common/include/nm_common.h"
#include "driver/include/m2m_types.h"
#include "driver/source/nmdrv.h"

/*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*
MACROS
*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*/
typedef enum {
    MANAGEMENT      = 0x00,    
    CONTROL         = 0x04,    
    DATA_BASICTYPE  = 0x08,    
    RESERVED        = 0x0C
}tenuWifiFrameType;


typedef enum {
    /* Sub-Types related to Management */
    ASSOC_REQ             = 0x00,  
    ASSOC_RSP             = 0x10,  
    REASSOC_REQ           = 0x20,  
    REASSOC_RSP           = 0x30,  
    PROBE_REQ             = 0x40,  
    PROBE_RSP             = 0x50,  
    BEACON                = 0x80,  
    ATIM                  = 0x90,  
    DISASOC               = 0xA0,  
    AUTH                  = 0xB0,  
    DEAUTH                = 0xC0,  
    ACTION                = 0xD0,  
    /* Sub-Types related to Control */
    PS_POLL               = 0xA4,  
    RTS                   = 0xB4,  
    CTS                   = 0xC4,  
    ACK                   = 0xD4,  
    CFEND                 = 0xE4,  
    CFEND_ACK             = 0xF4,  
    BLOCKACK_REQ          = 0x84,  
    BLOCKACK              = 0x94,  
    /* Sub-Types related to Data */
    DATA                  = 0x08,  
    DATA_ACK              = 0x18,  
    DATA_POLL             = 0x28,  
    DATA_POLL_ACK         = 0x38,  
    NULL_FRAME            = 0x48,  
    CFACK                 = 0x58,  
    CFPOLL                = 0x68,  
    CFPOLL_ACK            = 0x78,  
    QOS_DATA              = 0x88,  
    QOS_DATA_ACK          = 0x98,  
    QOS_DATA_POLL         = 0xA8,  
    QOS_DATA_POLL_ACK     = 0xB8,  
    QOS_NULL_FRAME        = 0xC8,  
    QOS_CFPOLL            = 0xE8,  
    QOS_CFPOLL_ACK        = 0xF8   
}tenuSubTypes;


typedef enum {
    ISSID               = 0,       
    ISUPRATES           = 1,       
    IFHPARMS            = 2,       
    IDSPARMS            = 3,       
    ICFPARMS            = 4,       
    ITIM                = 5,       
    IIBPARMS            = 6,       
    ICOUNTRY            = 7,       
    IEDCAPARAMS         = 12,      
    ITSPEC              = 13,      
    ITCLAS              = 14,      
    ISCHED              = 15,      
    ICTEXT              = 16,      
    IPOWERCONSTRAINT    = 32,      
    IPOWERCAPABILITY    = 33,      
    ITPCREQUEST         = 34,      
    ITPCREPORT          = 35,      
    ISUPCHANNEL         = 36,      
    ICHSWANNOUNC        = 37,      
    IMEASUREMENTREQUEST = 38,      
    IMEASUREMENTREPORT  = 39,      
    IQUIET              = 40,      
    IIBSSDFS            = 41,      
    IERPINFO            = 42,      
    ITSDELAY            = 43,      
    ITCLASPROCESS       = 44,      
    IHTCAP              = 45,      
    IQOSCAP             = 46,      
    IRSNELEMENT         = 48,      
    IEXSUPRATES         = 50,      
    IEXCHSWANNOUNC      = 60,      
    IHTOPERATION        = 61,      
    ISECCHOFF           = 62,      
    I2040COEX           = 72,      
    I2040INTOLCHREPORT  = 73,      
    IOBSSSCAN           = 74,      
    IEXTCAP             = 127,     
    IWMM                = 221,     
    IWPAELEMENT         = 221      
}tenuInfoElementId;

typedef enum{
    ESS            = 0x01,         
    IBSS           = 0x02,         
    POLLABLE       = 0x04,         
    POLLREQ        = 0x08,         
    PRIVACY        = 0x10,         
    SHORTPREAMBLE  = 0x20,         
    SHORTSLOT      = 0x400,        
    PBCC           = 0x40,         
    CHANNELAGILITY = 0x80,         
    SPECTRUM_MGMT  = 0x100,        
    DSSS_OFDM      = 0x2000        
}tenuWifiCapability;


typedef void (*tpfAppWifiCb) (uint8 u8MsgType, void * pvMsg);

typedef void (*tpfAppEthCb) (uint8 u8MsgType, void * pvMsg,void * pvCtrlBuf);

typedef void (*tpfAppMonCb) (tstrM2MWifiRxPacketInfo *pstrWifiRxPacket, uint8 * pu8Payload, uint16 u16PayloadSize);

typedef struct {
    tpfAppWifiCb pfAppWifiCb;      
    tpfAppEthCb  pfAppEthCb;       
    uint8 * au8ethRcvBuf;          
    uint16      u16ethRcvBufSize;      
} tstrEthInitParam;

typedef struct{
    uint16      u16DataSize;          
    uint16      u16RemainigDataSize;  
} tstrM2mIpCtrlBuf;


typedef struct {
    tpfAppWifiCb pfAppWifiCb;     
    tpfAppMonCb  pfAppMonCb;      
    tstrEthInitParam strEthInitParam ; 
        uint8        GainTableIndex;       
        uint8        __PAD24__[3];                 
} tstrWifiInitParam;


/*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*
FUNCTION PROTOTYPES
*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*/
#ifdef __cplusplus
     extern "C" {
#endif

NMI_API sint8  m2m_wifi_download_mode(void);

NMI_API sint8  m2m_wifi_init(tstrWifiInitParam * pWifiInitParam);

NMI_API sint8  m2m_wifi_deinit(void * arg);

sint8 m2m_wifi_init_hold(void);
sint8 m2m_wifi_init_start(tstrWifiInitParam * param);

sint8 m2m_wifi_reinit(tstrWifiInitParam * param);
sint8 m2m_wifi_reinit_hold(void);

sint8 m2m_wifi_reinit_start(tstrWifiInitParam * param);

NMI_API void m2m_wifi_yield(void);
NMI_API sint8 m2m_wifi_handle_events(void * arg);

NMI_API sint8 m2m_wifi_default_connect(void);

NMI_API sint8 m2m_wifi_connect(char *pcSsid, uint8 u8SsidLen, uint8 u8SecType, void *pvAuthInfo, uint16 u16Ch);

NMI_API sint8 m2m_wifi_connect_sc(char *pcSsid, uint8 u8SsidLen, uint8 u8SecType, void *pvAuthInfo, uint16 u16Ch, uint8 u8SaveCred);

NMI_API sint8 m2m_wifi_disconnect(void);

NMI_API sint8 m2m_wifi_start_provision_mode(tstrM2MAPConfig *pstrAPConfig, char *pcHttpServerDomainName, uint8 bEnableHttpRedirect);

NMI_API sint8 m2m_wifi_stop_provision_mode(void);

NMI_API sint8 m2m_wifi_get_connection_info(void);

NMI_API sint8 m2m_wifi_set_mac_address(uint8 au8MacAddress[6]);

NMI_API sint8 m2m_wifi_ble_set_gain_table(uint8 table_idx);
NMI_API sint8 m2m_wifi_wps(uint8 u8TriggerType,const char  *pcPinNumber);

NMI_API sint8 m2m_wifi_wps_disable(void);

NMI_API sint8 m2m_wifi_p2p(uint8 u8Channel);

NMI_API sint8 m2m_wifi_p2p_disconnect(void);

NMI_API sint8 m2m_wifi_enable_ap(CONST tstrM2MAPConfig* pstrM2MAPConfig);

NMI_API sint8 m2m_wifi_disable_ap(void);

NMI_API sint8 m2m_wifi_set_static_ip(tstrM2MIPConfig * pstrStaticIPConf);

NMI_API sint8 m2m_wifi_request_dhcp_client(void);

NMI_API sint8 m2m_wifi_request_dhcp_server(uint8* addr);

NMI_API sint8 m2m_wifi_enable_dhcp(uint8  u8DhcpEn );


NMI_API sint8 m2m_wifi_set_scan_options(tstrM2MScanOption* ptstrM2MScanOption);

NMI_API sint8 m2m_wifi_set_scan_region(uint16  ScanRegion);

NMI_API sint8 m2m_wifi_request_scan(uint8 ch);

sint8 m2m_wifi_request_scan_passive(uint8 ch);

NMI_API uint8 m2m_wifi_get_num_ap_found(void);

NMI_API sint8 m2m_wifi_req_scan_result(uint8 index);

NMI_API sint8 m2m_wifi_req_curr_rssi(void);

NMI_API sint8 m2m_wifi_req_restrict_ble(void);

NMI_API sint8 m2m_wifi_req_unrestrict_ble(void);

NMI_API sint8 m2m_wifi_get_otp_mac_address(uint8 *pu8MacAddr, uint8 * pu8IsValid);

NMI_API sint8 m2m_wifi_get_mac_address(uint8 *pu8MacAddr);

NMI_API sint8 m2m_wifi_set_sleep_mode(uint8 PsTyp, uint8 BcastEn);

NMI_API sint8 m2m_wifi_request_sleep(uint32 u32SlpReqTime);

NMI_API uint8 m2m_wifi_get_sleep_mode(void);

#if 0
/*
 * These two functions are for a mode in which two WINC ICs communicate with each other
 * via probe request and probe response frames. This mode is not supported in WINC fw.
 */
NMI_API sint8 m2m_wifi_req_client_ctrl(uint8 cmd);
NMI_API sint8 m2m_wifi_req_server_init(uint8 ch);
#endif

NMI_API sint8 m2m_wifi_set_device_name(uint8 *pu8DeviceName, uint8 u8DeviceNameLength);

NMI_API sint8 m2m_wifi_set_lsn_int(tstrM2mLsnInt *pstrM2mLsnInt);

NMI_API sint8 m2m_wifi_enable_monitoring_mode(tstrM2MWifiMonitorModeCtrl *pstrMtrCtrl, uint8 *pu8PayloadBuffer, 
                                           uint16 u16BufferSize, uint16 u16DataOffset);

NMI_API sint8 m2m_wifi_disable_monitoring_mode(void);

NMI_API sint8 m2m_wifi_send_wlan_pkt(uint8 *pu8WlanPacket, uint16 u16WlanHeaderLength, uint16 u16WlanPktSize);

NMI_API sint8 m2m_wifi_send_ethernet_pkt(uint8* pu8Packet,uint16 u16PacketSize);

NMI_API sint8 m2m_wifi_enable_sntp(uint8 bEnable);

NMI_API sint8 m2m_wifi_set_sytem_time(uint32 u32UTCSeconds);

NMI_API sint8 m2m_wifi_get_sytem_time(void);

NMI_API sint8 m2m_wifi_set_cust_InfoElement(uint8* pau8M2mCustInfoElement);

sint8 m2m_wifi_set_power_profile(uint8 u8PwrMode);

sint8 m2m_wifi_set_tx_power(uint8 u8TxPwrLevel);

sint8 m2m_wifi_enable_firmware_logs(uint8 u8Enable);
sint8 m2m_wifi_set_battery_voltage(uint16 u16BattVoltx100);

NMI_API sint8 m2m_wifi_ble_api_send(uint8* msg, uint32 len);


NMI_API sint8 m2m_wifi_enable_mac_mcast(uint8* pu8MulticastMacAddress, uint8 u8AddRemove);

NMI_API sint8 m2m_wifi_set_receive_buffer(void* pvBuffer,uint16 u16BufferLen);

uint32 m2m_wifi_get_chipId(void);
sint8 m2m_wifi_check_ota_rb(void);
sint8 m2m_wifi_get_firmware_version(tstrM2mRev *pstrRev);

NMI_API sint8 m2m_ota_get_firmware_version(tstrM2mRev *pstrRev);

sint8 m2m_wifi_prng_get_random_bytes(uint8 * pu8PrngBuff,uint16 u16PrngSize);

#ifdef __cplusplus
}
#endif
#endif /* __M2M_WIFI_H__ */