iot_wifi.h

Go to the documentation of this file.

/*
 * FreeRTOS WiFi V2.0.0
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */

#ifndef _AWS_WIFI_H_
#define _AWS_WIFI_H_

#include <stdint.h>

/* FreeRTOS include for BaseType_t. */
#include "portmacro.h"

/* Wi-Fi configuration includes. */
#include "aws_wifi_config.h"

#define IPV6_LENGTH                  4

#define WIFI_WPS_SUPPORTED           0x0001
#define WIFI_ENTERPRISE_SUPPORTED    0x0002
#define WIFI_P2P_SUPPORTED           0x0004
#define WIFI_TDLS_SUPPORTED          0x0008

typedef enum
{
    eWiFiSuccess = 0,      
    eWiFiFailure = 1,      
    eWiFiTimeout = 2,      
    eWiFiNotSupported = 3, 
} WIFIReturnCode_t;

typedef enum
{
    eWiFiSecurityOpen = 0,    
    eWiFiSecurityWEP,         
    eWiFiSecurityWPA,         
    eWiFiSecurityWPA2,        
    eWiFiSecurityWPA2_ent,    
    eWiFiSecurityWPA3,        
    eWiFiSecurityNotSupported 
} WIFISecurity_t;

typedef enum
{
    eWiFiModeStation = 0, 
    eWiFiModeAP,          
    eWiFiModeP2P,         
    eWiFiModeAPStation,   
    eWiFiModeNotSupported 
} WIFIDeviceMode_t;

typedef enum
{
    eWiFiPMNormal = 0,  
    eWiFiPMLowPower,    
    eWiFiPMAlwaysOn,    
    eWiFiPMNotSupported 
} WIFIPMMode_t;


typedef struct
{
    char cKey[ wificonfigMAX_WEPKEY_LEN ]; 
    uint8_t ucLength;                      
} WIFIWEPKey_t;

typedef struct
{
    char cPassphrase[ wificonfigMAX_PASSPHRASE_LEN ]; 
    uint8_t ucLength;                                 
} WIFIWPAPassphrase_t;

typedef struct
{
    uint8_t ucSSID[ wificonfigMAX_SSID_LEN ]; 
    uint8_t ucSSIDLength;                     
    WIFISecurity_t xSecurity;                 
    union
    {
        WIFIWEPKey_t xWEP[ wificonfigMAX_WEPKEYS ]; 
        WIFIWPAPassphrase_t xWPA;                   
    } xPassword;
    uint8_t ucDefaultWEPKeyIndex;                   
    uint8_t ucChannel;                              
} WIFINetworkParams_t;

typedef struct
{
    uint8_t ucSSID[ wificonfigMAX_SSID_LEN ]; 
    uint8_t ucSSIDLength;                     
    uint8_t ucChannel;                        
} WIFIScanConfig_t;

typedef struct
{
    uint8_t ucSSID[ wificonfigMAX_SSID_LEN ];   
    uint8_t ucSSIDLength;                       
    uint8_t ucBSSID[ wificonfigMAX_BSSID_LEN ]; 
    WIFISecurity_t xSecurity;                   
    int8_t cRSSI;                               
    uint8_t ucChannel;                          
} WIFIScanResult_t;

typedef struct
{
    uint8_t ucMAC[ wificonfigMAX_BSSID_LEN ]; 
} WIFIStationInfo_t;


typedef struct
{
    uint8_t ucSSID[ wificonfigMAX_SSID_LEN ];       
    uint8_t ucSSIDLength;                           
    uint8_t ucBSSID[ wificonfigMAX_BSSID_LEN ];     
    char cPassword[ wificonfigMAX_PASSPHRASE_LEN ]; 
    uint8_t ucPasswordLength;                       
    WIFISecurity_t xSecurity;                       
} WIFINetworkProfile_t;

typedef enum
{
    eWiFiIPAddressTypeV4,
    eWiFiIPAddressTypeV6,
    eWiFiIPAddressTypeNotSupported,
} WIFIIPAddressType_t;

typedef struct
{
    WIFIIPAddressType_t xType;         
    uint32_t ulAddress[ IPV6_LENGTH ]; 
} WIFIIPAddress_t;

typedef struct
{
    WIFIIPAddress_t xIPAddress; 
    WIFIIPAddress_t xNetMask;   
    WIFIIPAddress_t xGateway;   
    WIFIIPAddress_t xDns1;      
    WIFIIPAddress_t xDns2;      
} WIFIIPConfiguration_t;

typedef struct
{
    uint8_t ucSSID[ wificonfigMAX_SSID_LEN ];   
    uint8_t ucSSIDLength;                       
    uint8_t ucBSSID[ wificonfigMAX_BSSID_LEN ]; 
    WIFISecurity_t xSecurity;                   
    uint8_t ucChannel;                          
} WIFIConnectionInfo_t;

typedef enum
{
    eWiFiReasonUnspecified,           
    eWiFiReasonAPNotFound,            
    eWiFiReasonAuthExpired,           
    eWiFiReasonAuthLeaveBSS,          
    eWiFiReasonAuthFailed,            
    eWiFiReasonAssocExpired,          
    eWiFiReasonAssocTooMany,          
    eWiFiReasonAssocPowerCapBad,      
    eWiFiReasonAssocSupChanBad,       
    eWiFiReasonAssocFailed,           
    eWiFiReasonIEInvalid,             
    eWiFiReasonMICFailure,            
    eWiFiReason4WayTimeout,           
    eWiFiReason4WayIEDiffer,          
    eWiFiReason4WayFailed,            
    eWiFiReasonAKMPInvalid,           
    eWiFiReasonPairwiseCipherInvalid, 
    eWiFiReasonGroupCipherInvalid,    
    eWiFiReasonRSNVersionInvalid,     
    eWiFiReasonRSNCapInvalid,         
    eWiFiReasonGroupKeyUpdateTimeout, 
    eWiFiReasonCipherSuiteRejected,   
    eWiFiReason8021XAuthFailed,       
    eWiFiReasonBeaconTimeout,         
    eWiFiReasonLinkFailed,            
    eWiFiReasonDHCPExpired,           
    eWiFiReasonDHCPFailed,            
    eWiFiReasonMax
} WIFIReason_t;

typedef enum
{
    eWiFiEventReady,                 
    eWiFiEventScanDone,              
    eWiFiEventConnected,             
    eWiFiEventDisconnected,          
    eWiFiEventConnectionFailed,      
    eWiFiEventIPReady,               
    eWiFiEventAPStateChanged,        
    eWiFiEventAPStationConnected,    
    eWiFiEventAPStationDisconnected, 
    eWiFiEventWPSSuccess,            
    eWiFiEventWPSFailed,             
    eWiFiEventWPSTimeout,            
    eWiFiEventMax
} WIFIEventType_t;

typedef struct
{
    uint8_t dummy;
} WiFiEventInfoReady_t;

typedef struct
{
    WIFIScanResult_t * pxScanResults;
    uint16_t usNumScanResults;
} WiFiEventInfoScanDone_t;

typedef struct
{
    WIFIConnectionInfo_t xConnectionInfo;
} WiFiEventInfoConnected_t;

typedef struct
{
    WIFIReason_t xReason; 
} WiFiEventInfoDisconnected_t;

typedef struct
{
    WIFIReason_t xReason; 
} WiFiEventInfoConnectionFailed_t;

typedef struct
{
    WIFIIPAddress_t xIPAddress; 
} WiFiEventInfoIPReady_t;

typedef struct
{
    uint8_t ucState; 
} WiFiEventInfoAPStateChanged_t;

typedef struct
{
    uint8_t ucMac[ wificonfigMAX_BSSID_LEN ]; 
} WiFiEventInfoAPStationConnected_t;

typedef struct
{
    uint8_t ucMac[ wificonfigMAX_BSSID_LEN ]; 
    WIFIReason_t xReason;                     
} WiFiEventInfoAPStationDisconnected_t;

typedef struct
{
    uint8_t * pucData; 
    uint32_t ulLength; 
} WiFiEventInfoRxDone_t;

typedef struct
{
    uint8_t dummy;
} WiFiEventInfoTxDone_t;

typedef struct
{
    WIFIEventType_t xEventType;
    union
    {
        WiFiEventInfoReady_t xReady;
        WiFiEventInfoScanDone_t xScanDone;
        WiFiEventInfoConnected_t xConnected;
        WiFiEventInfoIPReady_t xIPReady;
        WiFiEventInfoDisconnected_t xDisconnected;
        WiFiEventInfoConnectionFailed_t xConnectionFailed;
        WiFiEventInfoAPStateChanged_t xAPStateChanged;
        WiFiEventInfoAPStationConnected_t xAPStationConnected;
        WiFiEventInfoAPStationDisconnected_t xAPStationDisconnected;
        WiFiEventInfoRxDone_t xRxDone;
        WiFiEventInfoTxDone_t xTxDone;
    } xInfo;
} WIFIEvent_t;


typedef struct
{
    uint32_t ulTxSuccessCount;  
    uint32_t ulTxRetryCount;    
    uint32_t ulTxFailCount;     
    uint32_t ulRxSuccessCount;  
    uint32_t ulRxCRCErrorCount; 
    uint32_t ulMICErrorCount;   
    int8_t cNoise;              
    uint16_t usPhyRate;         
    uint16_t usTxRate;          
    uint16_t usRxRate;          
    int8_t cRssi;               
    uint8_t ucBandwidth;        
    uint8_t ucIdleTimePer;      
} WIFIStatisticInfo_t;

typedef enum
{
    eWiFiBand2G = 0, 
    eWiFiBand5G,     
    eWiFiBandDual,   
    eWiFiBandMax     
} WIFIBand_t;

typedef enum
{
    eWiFiPhy11b = 0, 
    eWiFiPhy11g,     
    eWiFiPhy11n,     
    eWiFiPhy11ac,    
    eWiFiPhy11ax,    
    eWiFiPhyMax,     
} WIFIPhyMode_t;

typedef enum
{
    eWiFiBW20 = 0, 
    eWiFiBW40,     
    eWiFiBW80,     
    eWiFiBW160,    
    eWiFiBWMax     
} WIFIBandwidth_t;

typedef struct
{
    WIFIBand_t xBand;             
    WIFIPhyMode_t xPhyMode;       
    WIFIBandwidth_t xBandwidth;   
    uint32_t ulMaxAggr;           
    uint16_t usSupportedFeatures; 
} WIFICapabilityInfo_t;

typedef void (* WIFIEventHandler_t)( WIFIEvent_t * xEvent );

/* @[declare_wifi_wifi_on] */
WIFIReturnCode_t WIFI_On( void );
/* @[declare_wifi_wifi_on] */

/* @[declare_wifi_wifi_off] */
WIFIReturnCode_t WIFI_Off( void );
/* @[declare_wifi_wifi_off] */

/* @[declare_wifi_wifi_connectap] */
WIFIReturnCode_t WIFI_ConnectAP( const WIFINetworkParams_t * const pxNetworkParams );
/* @[declare_wifi_wifi_connectap] */

/* @[declare_wifi_wifi_disconnect] */
WIFIReturnCode_t WIFI_Disconnect( void );
/* @[declare_wifi_wifi_disconnect] */

/* @[declare_wifi_wifi_reset] */
WIFIReturnCode_t WIFI_Reset( void );
/* @[declare_wifi_wifi_reset] */

/* @[declare_wifi_wifi_setmode] */
WIFIReturnCode_t WIFI_SetMode( WIFIDeviceMode_t xDeviceMode );
/* @[declare_wifi_wifi_setmode] */

/* @[declare_wifi_wifi_getmode] */
WIFIReturnCode_t WIFI_GetMode( WIFIDeviceMode_t * pxDeviceMode );
/* @[declare_wifi_wifi_getmode] */

/* @[declare_wifi_wifi_networkadd] */
WIFIReturnCode_t WIFI_NetworkAdd( const WIFINetworkProfile_t * const pxNetworkProfile,
                                  uint16_t * pusIndex );
/* @[declare_wifi_wifi_networkadd] */


/* @[declare_wifi_wifi_networkget] */
WIFIReturnCode_t WIFI_NetworkGet( WIFINetworkProfile_t * pxNetworkProfile,
                                  uint16_t usIndex );
/* @[declare_wifi_wifi_networkget] */

/* @[declare_wifi_wifi_networkdelete] */
WIFIReturnCode_t WIFI_NetworkDelete( uint16_t usIndex );
/* @[declare_wifi_wifi_networkdelete] */

/* @[declare_wifi_wifi_ping] */
WIFIReturnCode_t WIFI_Ping( uint8_t * pucIPAddr,
                            uint16_t usCount,
                            uint32_t ulIntervalMS );
/* @[declare_wifi_wifi_ping] */

/* @[declare_wifi_wifi_getmac] */
WIFIReturnCode_t WIFI_GetMAC( uint8_t * pucMac );
/* @[declare_wifi_wifi_getmac] */

/* @[declare_wifi_wifi_gethostip] */
WIFIReturnCode_t WIFI_GetHostIP( char * pcHost,
                                 uint8_t * pucIPAddr );
/* @[declare_wifi_wifi_gethostip] */

/* @[declare_wifi_wifi_scan] */
WIFIReturnCode_t WIFI_Scan( WIFIScanResult_t * pxBuffer,
                            uint8_t ucNumNetworks );
/* @[declare_wifi_wifi_scan] */

/* @[declare_wifi_wifi_startap] */
WIFIReturnCode_t WIFI_StartAP( void );
/* @[declare_wifi_wifi_startap] */

/* @[declare_wifi_wifi_stopap] */
WIFIReturnCode_t WIFI_StopAP( void );
/* @[declare_wifi_wifi_stopap] */

/* @[declare_wifi_wifi_configureap] */
WIFIReturnCode_t WIFI_ConfigureAP( const WIFINetworkParams_t * const pxNetworkParams );
/* @[declare_wifi_wifi_configureap] */

/* @[declare_wifi_wifi_setpmmode] */
WIFIReturnCode_t WIFI_SetPMMode( WIFIPMMode_t xPMModeType,
                                 const void * pvOptionValue );
/* @[declare_wifi_wifi_setpmmode] */

/* @[declare_wifi_wifi_getpmmode] */
WIFIReturnCode_t WIFI_GetPMMode( WIFIPMMode_t * pxPMModeType,
                                 void * pvOptionValue );
/* @[declare_wifi_wifi_getpmmode] */


/* @[declare_wifi_registerevent] */
WIFIReturnCode_t WIFI_RegisterEvent( WIFIEventType_t xEventType,
                                     WIFIEventHandler_t xHandler );
/* @[declare_wifi_registerevent] */

/* @[declare_wifi_wifi_isconnected] */
BaseType_t WIFI_IsConnected( const WIFINetworkParams_t * pxNetworkParams );
/* @[declare_wifi_wifi_isconnected] */

WIFIReturnCode_t WIFI_StartScan( WIFIScanConfig_t * pxScanConfig );

WIFIReturnCode_t WIFI_GetScanResults( const WIFIScanResult_t ** pxBuffer,
                                      uint16_t * ucNumNetworks );

WIFIReturnCode_t WIFI_StartConnectAP( const WIFINetworkParams_t * pxNetworkParams );

WIFIReturnCode_t WIFI_StartDisconnect( void );

WIFIReturnCode_t WIFI_GetConnectionInfo( WIFIConnectionInfo_t * pxConnectionInfo );

WIFIReturnCode_t WIFI_GetIPInfo( WIFIIPConfiguration_t * pxIPInfo );

WIFIReturnCode_t WIFI_GetRSSI( int8_t * pcRSSI );

WIFIReturnCode_t WIFI_GetStationList( WIFIStationInfo_t * pxStationList,
                                      uint8_t * pcStationListSize );

WIFIReturnCode_t WIFI_StartDisconnectStation( uint8_t * pucMac );

WIFIReturnCode_t WIFI_SetMAC( uint8_t * pucMac );

WIFIReturnCode_t WIFI_SetCountryCode( const char * pcCountryCode );

WIFIReturnCode_t WIFI_GetCountryCode( char * pcCountryCode );

WIFIReturnCode_t WIFI_GetStatistic( WIFIStatisticInfo_t * pxStats );

WIFIReturnCode_t WIFI_GetCapability( WIFICapabilityInfo_t * pxCaps );

#endif /* _AWS_WIFI_H_ */