wlan.h

/*
 * wlan.h - CC31xx/CC32xx Host Driver Implementation
 *
 * Copyright (C) 2015 Texas Instruments Incorporated - https://www.ti.com/ 
 * 
 * 
 *  Redistribution and use in source and binary forms, with or without 
 *  modification, are permitted provided that the following conditions 
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright 
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the 
 *    documentation and/or other materials provided with the   
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
*/

/*****************************************************************************/
/* Include files                                                             */
/*****************************************************************************/
#include "simplelink.h"
    
#ifndef __WLAN_H__
#define    __WLAN_H__




#ifdef    __cplusplus
extern "C" {
#endif


/*****************************************************************************/
/* Macro declarations                                                        */
/*****************************************************************************/

#define SL_BSSID_LENGTH           (6)
#define MAXIMAL_SSID_LENGTH       (32)

#define NUM_OF_RATE_INDEXES       (20)
#define SIZE_OF_RSSI_HISTOGRAM    (6)
 
/* WLAN Disconnect Reason Codes */
#define  SL_WLAN_DISCONNECT_UNSPECIFIED_REASON                             (1)
#define  SL_WLAN_DISCONNECT_PREV_AUTH_NOT_VALID                            (2)
#define  SL_WLAN_DISCONNECT_DEAUTH_LEAVING                                 (3)
#define  SL_WLAN_DISCONNECT_DISASSOC_DUE_TO_INACTIVITY                     (4)
#define  SL_WLAN_DISCONNECT_DISASSOC_AP_BUSY                               (5)
#define  SL_WLAN_DISCONNECT_CLASS2_FRAME_FROM_NONAUTH_STA                  (6)
#define  SL_WLAN_DISCONNECT_CLASS3_FRAME_FROM_NONASSOC_STA                 (7)
#define  SL_WLAN_DISCONNECT_DISASSOC_STA_HAS_LEFT                          (8)
#define  SL_WLAN_DISCONNECT_STA_REQ_ASSOC_WITHOUT_AUTH                     (9)
#define  SL_WLAN_DISCONNECT_PWR_CAPABILITY_NOT_VALID                       (10)
#define  SL_WLAN_DISCONNECT_SUPPORTED_CHANNEL_NOT_VALID                    (11)
#define  SL_WLAN_DISCONNECT_INVALID_IE                                     (13)
#define  SL_WLAN_DISCONNECT_MIC_FAILURE                                    (14)
#define  SL_WLAN_DISCONNECT_4WAY_HANDSHAKE_TIMEOUT                         (15)
#define  SL_WLAN_DISCONNECT_GROUP_KEY_UPDATE_TIMEOUT                       (16)
#define  SL_WLAN_DISCONNECT_IE_IN_4WAY_DIFFERS                             (17)
#define  SL_WLAN_DISCONNECT_GROUP_CIPHER_NOT_VALID                         (18)
#define  SL_WLAN_DISCONNECT_PAIRWISE_CIPHER_NOT_VALID                      (19)
#define  SL_WLAN_DISCONNECT_AKMP_NOT_VALID                                 (20)
#define  SL_WLAN_DISCONNECT_UNSUPPORTED_RSN_IE_VERSION                     (21)
#define  SL_WLAN_DISCONNECT_INVALID_RSN_IE_CAPAB                           (22)
#define  SL_WLAN_DISCONNECT_IEEE_802_1X_AUTH_FAILED                        (23)
#define  SL_WLAN_DISCONNECT_CIPHER_SUITE_REJECTED                          (24)
#define  SL_WLAN_DISCONNECT_DISASSOC_LOW_ACK                               (34)
#define  SL_WLAN_DISCONNECT_ROAMING_TRIGGER_NONE                           (100)                             
#define  SL_WLAN_DISCONNECT_ROAMING_TRIGGER_LOW_TX_RATE                    (104)         
#define  SL_WLAN_DISCONNECT_ROAMING_TRIGGER_LOW_SNR                        (105)               
#define  SL_WLAN_DISCONNECT_ROAMING_TRIGGER_LOW_QUALITY                    (106)               
#define  SL_WLAN_DISCONNECT_ROAMING_TRIGGER_TSPEC_REJECTED                 (107)        
#define  SL_WLAN_DISCONNECT_ROAMING_TRIGGER_MAX_TX_RETRIES                 (108)         
#define  SL_WLAN_DISCONNECT_ROAMING_TRIGGER_BSS_LOSS                       (109)         
#define  SL_WLAN_DISCONNECT_ROAMING_TRIGGER_BSS_LOSS_DUE_TO_MAX_TX_RETRY   (110)
#define  SL_WLAN_DISCONNECT_ROAMING_TRIGGER_SWITCH_CHANNEL                 (111)         
#define  SL_WLAN_DISCONNECT_ROAMING_TRIGGER_AP_DISCONNECT                  (112)               
#define  SL_WLAN_DISCONNECT_ROAMING_TRIGGER_SECURITY_ATTACK                (113)         
#define  SL_WLAN_DISCONNECT_USER_INITIATED_DISCONNECTION                   (200)


/* Wlan error codes */
#define  SL_ERROR_KEY_ERROR                                                                             (-3)
#define  SL_ERROR_INVALID_ROLE                                                                          (-71)
#define  SL_ERROR_INVALID_SECURITY_TYPE                                                                 (-84)
#define  SL_ERROR_PASSPHRASE_TOO_LONG                                                                   (-85)
#define  SL_ERROR_WPS_NO_PIN_OR_WRONG_PIN_LEN                                                            (-87)
#define  SL_ERROR_EAP_WRONG_METHOD                                                                      (-88)
#define  SL_ERROR_PASSWORD_ERROR                                                                        (-89)
#define  SL_ERROR_EAP_ANONYMOUS_LEN_ERROR                                                               (-90)
#define  SL_ERROR_SSID_LEN_ERROR                                                                        (-91)
#define  SL_ERROR_USER_ID_LEN_ERROR                                                                     (-92)
#define  SL_ERROR_ILLEGAL_WEP_KEY_INDEX                                                                 (-95)
#define  SL_ERROR_INVALID_DWELL_TIME_VALUES                                                                (-96)
#define  SL_ERROR_INVALID_POLICY_TYPE                                                                   (-97)
#define  SL_ERROR_PM_POLICY_INVALID_OPTION                                                              (-98)
#define  SL_ERROR_PM_POLICY_INVALID_PARAMS                                                              (-99)
#define  SL_ERROR_WIFI_ALREADY_DISCONNECTED                                                             (-129)
#define  SL_ERROR_WIFI_NOT_CONNECTED                                                                    (-59)



#define SL_SEC_TYPE_OPEN                                                                                (0)
#define SL_SEC_TYPE_WEP                                                                                 (1)
#define SL_SEC_TYPE_WPA                                                                                 (2) /* deprecated */
#define SL_SEC_TYPE_WPA_WPA2                                                                            (2)
#define SL_SEC_TYPE_WPS_PBC                                                                             (3)
#define SL_SEC_TYPE_WPS_PIN                                                                             (4)
#define SL_SEC_TYPE_WPA_ENT                                                                             (5)
#define SL_SEC_TYPE_P2P_PBC                                                                             (6)
#define SL_SEC_TYPE_P2P_PIN_KEYPAD                                                                        (7)
#define SL_SEC_TYPE_P2P_PIN_DISPLAY                                                                        (8)
#define SL_SEC_TYPE_P2P_PIN_AUTO                                                                        (9) /* NOT Supported yet */


  
#define SL_SCAN_SEC_TYPE_OPEN                                                                           (0)
#define SL_SCAN_SEC_TYPE_WEP                                                                            (1)
#define SL_SCAN_SEC_TYPE_WPA                                                                            (2) 
#define SL_SCAN_SEC_TYPE_WPA2                                                                           (3)

  
#define TLS                                (0x1)
#define MSCHAP                             (0x0)
#define PSK                                (0x2) 
#define TTLS                               (0x10)
#define PEAP0                              (0x20)
#define PEAP1                              (0x40)
#define FAST                               (0x80)

#define FAST_AUTH_PROVISIONING             (0x02)
#define FAST_UNAUTH_PROVISIONING           (0x01)
#define FAST_NO_PROVISIONING               (0x00)

#define EAPMETHOD_PHASE2_SHIFT             (8)
#define EAPMETHOD_PAIRWISE_CIPHER_SHIFT    (19)
#define EAPMETHOD_GROUP_CIPHER_SHIFT       (27)

#define WPA_CIPHER_CCMP                    (0x1) 
#define WPA_CIPHER_TKIP                    (0x2)
#define CC31XX_DEFAULT_CIPHER              (WPA_CIPHER_CCMP | WPA_CIPHER_TKIP)

#define EAPMETHOD(phase1,phase2,pairwise_cipher,group_cipher) \
((phase1) | \
 ((phase2) << EAPMETHOD_PHASE2_SHIFT ) |\
 ((_u32)(pairwise_cipher) << EAPMETHOD_PAIRWISE_CIPHER_SHIFT ) |\
 ((_u32)(group_cipher) << EAPMETHOD_GROUP_CIPHER_SHIFT ))

/*                                                            phase1  phase2                     pairwise_cipher         group_cipher         */
#define SL_ENT_EAP_METHOD_TLS                       EAPMETHOD(TLS   , 0                        , CC31XX_DEFAULT_CIPHER , CC31XX_DEFAULT_CIPHER)
#define SL_ENT_EAP_METHOD_TTLS_TLS                  EAPMETHOD(TTLS  , TLS                      , CC31XX_DEFAULT_CIPHER , CC31XX_DEFAULT_CIPHER)
#define SL_ENT_EAP_METHOD_TTLS_MSCHAPv2             EAPMETHOD(TTLS  , MSCHAP                   , CC31XX_DEFAULT_CIPHER , CC31XX_DEFAULT_CIPHER)
#define SL_ENT_EAP_METHOD_TTLS_PSK                  EAPMETHOD(TTLS  , PSK                      , CC31XX_DEFAULT_CIPHER , CC31XX_DEFAULT_CIPHER)
#define SL_ENT_EAP_METHOD_PEAP0_TLS                 EAPMETHOD(PEAP0 , TLS                      , CC31XX_DEFAULT_CIPHER , CC31XX_DEFAULT_CIPHER)
#define SL_ENT_EAP_METHOD_PEAP0_MSCHAPv2            EAPMETHOD(PEAP0 , MSCHAP                   , CC31XX_DEFAULT_CIPHER , CC31XX_DEFAULT_CIPHER) 
#define SL_ENT_EAP_METHOD_PEAP0_PSK                 EAPMETHOD(PEAP0 , PSK                      , CC31XX_DEFAULT_CIPHER , CC31XX_DEFAULT_CIPHER)
#define SL_ENT_EAP_METHOD_PEAP1_TLS                 EAPMETHOD(PEAP1 , TLS                      , CC31XX_DEFAULT_CIPHER , CC31XX_DEFAULT_CIPHER)
#define SL_ENT_EAP_METHOD_PEAP1_MSCHAPv2            EAPMETHOD(PEAP1 , MSCHAP                   , CC31XX_DEFAULT_CIPHER , CC31XX_DEFAULT_CIPHER) 
#define SL_ENT_EAP_METHOD_PEAP1_PSK                 EAPMETHOD(PEAP1 , PSK                      , CC31XX_DEFAULT_CIPHER , CC31XX_DEFAULT_CIPHER)
#define SL_ENT_EAP_METHOD_FAST_AUTH_PROVISIONING    EAPMETHOD(FAST  , FAST_AUTH_PROVISIONING   , CC31XX_DEFAULT_CIPHER , CC31XX_DEFAULT_CIPHER)
#define SL_ENT_EAP_METHOD_FAST_UNAUTH_PROVISIONING  EAPMETHOD(FAST  , FAST_UNAUTH_PROVISIONING , CC31XX_DEFAULT_CIPHER , CC31XX_DEFAULT_CIPHER)
#define SL_ENT_EAP_METHOD_FAST_NO_PROVISIONING      EAPMETHOD(FAST  , FAST_NO_PROVISIONING     , CC31XX_DEFAULT_CIPHER , CC31XX_DEFAULT_CIPHER)
 
#define SL_LONG_PREAMBLE                   (0)
#define SL_SHORT_PREAMBLE                   (1)

#define SL_RAW_RF_TX_PARAMS_CHANNEL_SHIFT  (0)
#define SL_RAW_RF_TX_PARAMS_RATE_SHIFT     (6)
#define SL_RAW_RF_TX_PARAMS_POWER_SHIFT    (11)
#define SL_RAW_RF_TX_PARAMS_PREAMBLE_SHIFT (15)

#define SL_RAW_RF_TX_PARAMS(chan,rate,power,preamble) \
    ((chan << SL_RAW_RF_TX_PARAMS_CHANNEL_SHIFT) | \
    (rate << SL_RAW_RF_TX_PARAMS_RATE_SHIFT) | \
    (power << SL_RAW_RF_TX_PARAMS_POWER_SHIFT) | \
    (preamble << SL_RAW_RF_TX_PARAMS_PREAMBLE_SHIFT))


/* wlan config application IDs */
#define SL_WLAN_CFG_AP_ID                    (0)
#define SL_WLAN_CFG_GENERAL_PARAM_ID         (1)
#define SL_WLAN_CFG_P2P_PARAM_ID              (2)

/* wlan AP Config set/get options */
#define WLAN_AP_OPT_SSID                     (0)
#define WLAN_AP_OPT_CHANNEL                  (3)
#define WLAN_AP_OPT_HIDDEN_SSID              (4)
#define WLAN_AP_OPT_SECURITY_TYPE            (6)
#define WLAN_AP_OPT_PASSWORD                 (7)
#define WLAN_GENERAL_PARAM_OPT_COUNTRY_CODE  (9)
#define WLAN_GENERAL_PARAM_OPT_STA_TX_POWER  (10)
#define WLAN_GENERAL_PARAM_OPT_AP_TX_POWER   (11)

#define WLAN_P2P_OPT_DEV_NAME                (12)
#define WLAN_P2P_OPT_DEV_TYPE                (13)
#define WLAN_P2P_OPT_CHANNEL_N_REGS             (14)
#define WLAN_GENERAL_PARAM_OPT_INFO_ELEMENT  (16)
#define WLAN_GENERAL_PARAM_OPT_SCAN_PARAMS   (18)      /* change the scan channels and RSSI threshold using this configuration option */

/* SmartConfig CIPHER options */
#define SMART_CONFIG_CIPHER_SFLASH           (0)      /* password is not delivered by the application. The Simple Manager should */
                                                      /* check if the keys are stored in the Flash.                              */
#define SMART_CONFIG_CIPHER_AES              (1)      /* AES (other types are not supported)                                     */
#define SMART_CONFIG_CIPHER_NONE             (0xFF)   /* do not check in the flash                                               */


#define SL_POLICY_CONNECTION                 (0x10)
#define SL_POLICY_SCAN                       (0x20)
#define SL_POLICY_PM                         (0x30)
#define SL_POLICY_P2P                         (0x40)

#define VAL_2_MASK(position,value)           ((1 & (value))<<(position))
#define MASK_2_VAL(position,mask)            (((1 << position) & (mask)) >> (position))

#define SL_CONNECTION_POLICY(Auto,Fast,Open,anyP2P,autoSmartConfig)                (VAL_2_MASK(0,Auto) | VAL_2_MASK(1,Fast) | VAL_2_MASK(2,Open) | VAL_2_MASK(3,anyP2P) | VAL_2_MASK(4,autoSmartConfig))
#define SL_SCAN_POLICY_EN(policy)            (MASK_2_VAL(0,policy))
#define SL_SCAN_POLICY(Enable)               (VAL_2_MASK(0,Enable))


#define SL_NORMAL_POLICY                    (0)
#define SL_LOW_LATENCY_POLICY               (1)
#define SL_LOW_POWER_POLICY                 (2)
#define SL_ALWAYS_ON_POLICY                 (3)
#define SL_LONG_SLEEP_INTERVAL_POLICY        (4)

#define SL_P2P_ROLE_NEGOTIATE                (3)
#define SL_P2P_ROLE_GROUP_OWNER             (15)
#define SL_P2P_ROLE_CLIENT                    (0)

#define SL_P2P_NEG_INITIATOR_ACTIVE            (0)
#define SL_P2P_NEG_INITIATOR_PASSIVE        (1)
#define SL_P2P_NEG_INITIATOR_RAND_BACKOFF   (2)

#define POLICY_VAL_2_OPTIONS(position,mask,policy)    ((mask & policy) << position )

#define SL_P2P_POLICY(p2pNegType,p2pNegInitiator)   (POLICY_VAL_2_OPTIONS(0,0xF,(p2pNegType > SL_P2P_ROLE_GROUP_OWNER ? SL_P2P_ROLE_GROUP_OWNER : p2pNegType)) | \
                                                     POLICY_VAL_2_OPTIONS(4,0x1,(p2pNegType > SL_P2P_ROLE_GROUP_OWNER ? 1:0)) | \
                                                     POLICY_VAL_2_OPTIONS(5,0x3, p2pNegInitiator))


/* Info elements */

#define INFO_ELEMENT_DEFAULT_ID              (0) /* 221 will be used */

/* info element size is up to 252 bytes (+ 3 bytes of OUI). */
#define INFO_ELEMENT_MAX_SIZE                (252)

/* For AP - the total length of all info elements is 300 bytes (for example - 4 info elements of 75 bytes each) */
#define INFO_ELEMENT_MAX_TOTAL_LENGTH_AP     (300)
/* For P2P - the total length of all info elements is 150 bytes (for example - 4 info elements of 40 bytes each) */
#define INFO_ELEMENT_MAX_TOTAL_LENGTH_P2P_GO (160)

#define INFO_ELEMENT_AP_ROLE                 (0)
#define INFO_ELEMENT_P2P_GO_ROLE             (1)

/* we support up to 4 info elements per Role. */
#define MAX_PRIVATE_INFO_ELEMENTS_SUPPROTED  (4)

#define INFO_ELEMENT_DEFAULT_OUI_0           (0x08)
#define INFO_ELEMENT_DEFAULT_OUI_1           (0x00)
#define INFO_ELEMENT_DEFAULT_OUI_2           (0x28)

#define INFO_ELEMENT_DEFAULT_OUI             (0x000000)  /* 08, 00, 28 will be used */




/**************************************************
For backward compatability (version 1.0.0.10)
**************************************************/
#define SL_DISCONNECT_UNSPECIFIED_REASON                                                            SL_WLAN_DISCONNECT_UNSPECIFIED_REASON                                                   
#define SL_PREVIOUS_AUTHENTICATION_NO_LONGER_VALID                                                  SL_WLAN_DISCONNECT_PREV_AUTH_NOT_VALID                                     
#define SL_DEAUTHENTICATED_BECAUSE_SENDING_STATION_IS_LEAVING                                       SL_WLAN_DISCONNECT_DEAUTH_LEAVING                
#define SL_DISASSOCIATED_DUE_TO_INACTIVITY                                                          SL_WLAN_DISCONNECT_DISASSOC_DUE_TO_INACTIVITY                     
#define SL_DISASSOCIATED_BECAUSE_AP_IS_UNABLE_TO_HANDLE_ALL_CURRENTLY_ASSOCIATED_STATIONS           SL_WLAN_DISCONNECT_DISASSOC_AP_BUSY   
#define SL_CLASS_2_FRAME_RECEIVED_FROM_NONAUTHENTICATED_STATION                                     SL_WLAN_DISCONNECT_CLASS2_FRAME_FROM_NONAUTH_STA      
#define SL_CLASS_3_FRAME_RECEIVED_FROM_NONASSOCIATED_STATION                                        SL_WLAN_DISCONNECT_CLASS3_FRAME_FROM_NONASSOC_STA
#define SL_DISASSOCIATED_BECAUSE_SENDING_STATION_IS_LEAVING_BSS                                     SL_WLAN_DISCONNECT_DISASSOC_STA_HAS_LEFT
#define SL_STATION_REQUESTING_ASSOCIATION_IS_NOT_AUTHENTICATED_WITH_RESPONDING_STATION              SL_WLAN_DISCONNECT_STA_REQ_ASSOC_WITHOUT_AUTH
#define SL_DISASSOCIATED_BECAUSE_THE_INFORMATION_IN_THE_POWER_CAPABILITY_ELEMENT_IS_UNACCEPTABLE    SL_WLAN_DISCONNECT_PWR_CAPABILITY_NOT_VALID
#define SL_DISASSOCIATED_BECAUSE_THE_INFORMATION_IN_THE_SUPPORTED_CHANNELS_ELEMENT_IS_UNACCEPTABLE  SL_WLAN_DISCONNECT_SUPPORTED_CHANNEL_NOT_VALID
#define SL_INVALID_INFORMATION_ELEMENT                                                              SL_WLAN_DISCONNECT_INVALID_IE
#define SL_MESSAGE_INTEGRITY_CODE_MIC_FAILURE                                                       SL_WLAN_DISCONNECT_MIC_FAILURE
#define SL_FOUR_WAY_HANDSHAKE_TIMEOUT                                                               SL_WLAN_DISCONNECT_4WAY_HANDSHAKE_TIMEOUT
#define SL_GROUP_KEY_HANDSHAKE_TIMEOUT                                                              SL_WLAN_DISCONNECT_GROUP_KEY_UPDATE_TIMEOUT 
#define SL_RE_ASSOCIATION_REQUEST_PROBE_RESPONSE_BEACON_FRAME                                       SL_WLAN_DISCONNECT_IE_IN_4WAY_DIFFERS
#define SL_INVALID_GROUP_CIPHER                                                                     SL_WLAN_DISCONNECT_GROUP_CIPHER_NOT_VALID    
#define SL_INVALID_PAIRWISE_CIPHER                                                                  SL_WLAN_DISCONNECT_PAIRWISE_CIPHER_NOT_VALID
#define SL_INVALID_AKMP                                                                             SL_WLAN_DISCONNECT_AKMP_NOT_VALID
#define SL_UNSUPPORTED_RSN_INFORMATION_ELEMENT_VERSION                                              SL_WLAN_DISCONNECT_UNSUPPORTED_RSN_IE_VERSION
#define SL_INVALID_RSN_INFORMATION_ELEMENT_CAPABILITIES                                             SL_WLAN_DISCONNECT_INVALID_RSN_IE_CAPAB
#define SL_IEEE_802_1X_AUTHENTICATION_FAILED                                                        SL_WLAN_DISCONNECT_IEEE_802_1X_AUTH_FAILED
#define SL_CIPHER_SUITE_REJECTED_BECAUSE_OF_THE_SECURITY_POLICY                                     SL_WLAN_DISCONNECT_CIPHER_SUITE_REJECTED
#define SL_USER_INITIATED_DISCONNECTION                                                             SL_WLAN_DISCONNECT_USER_INITIATED_DISCONNECTION


#define SL_DISCONNECT_RESERVED_0    (0)
#define SL_DISCONNECT_RESERVED_1    (12)
#define SL_DISCONNECT_RESERVED_2    (26)
#define SL_DISCONNECT_RESERVED_3    (27)
#define SL_DISCONNECT_RESERVED_4    (28)
#define SL_DISCONNECT_RESERVED_5    (29)
#define SL_DISCONNECT_RESERVED_6    (30)
#define SL_DISCONNECT_RESERVED_7    (31)
#define SL_DISCONNECT_RESERVED_8    (32)

/******************************
End of backward compatability.
*******************************/



/*****************************************************************************/
/* Structure/Enum declarations                                               */
/*****************************************************************************/

typedef enum
{
    RATE_1M         = 1,
    RATE_2M         = 2,
    RATE_5_5M       = 3,
    RATE_11M        = 4,
    RATE_6M         = 6,
    RATE_9M         = 7,
    RATE_12M        = 8,
    RATE_18M        = 9,
    RATE_24M        = 10,
    RATE_36M        = 11,
    RATE_48M        = 12,
    RATE_54M        = 13,
    RATE_MCS_0      = 14,
    RATE_MCS_1      = 15,
    RATE_MCS_2      = 16,
    RATE_MCS_3      = 17,
    RATE_MCS_4      = 18,
    RATE_MCS_5      = 19,
    RATE_MCS_6      = 20,
    RATE_MCS_7      = 21,
    MAX_NUM_RATES   = 0xFF
}SlRateIndex_e;

typedef enum {
    DEV_PW_DEFAULT=0,
    DEV_PW_PIN_KEYPAD=1,
    DEV_PW_PUSH_BUTTON=4,
    DEV_PW_PIN_DISPLAY=5
} sl_p2p_dev_password_method;


typedef struct
{
  _u32    status;
  _u32    ssid_len;
  _u8     ssid[32];
  _u32    private_token_len;
  _u8     private_token[32];
}slSmartConfigStartAsyncResponse_t;

typedef struct
{
  _u16    status;
  _u16    padding;
}slSmartConfigStopAsyncResponse_t;

typedef struct
{
  _u16    status;
  _u16    padding;
}slWlanConnFailureAsyncResponse_t;

typedef struct
{
  _u8     connection_type;/* 0-STA,3-P2P_CL */
  _u8     ssid_len;
  _u8     ssid_name[32];
  _u8     go_peer_device_name_len;
  _u8     go_peer_device_name[32];
  _u8     bssid[6];
  _u8     reason_code;
  _u8     padding[2];
} slWlanConnectAsyncResponse_t;

typedef struct
{
  _u8     go_peer_device_name[32];
  _u8     mac[6];
  _u8     go_peer_device_name_len;
  _u8     wps_dev_password_id;
  _u8     own_ssid[32];/* relevant for event sta-connected only */
  _u8     own_ssid_len;/* relevant for event sta-connected only */
  _u8     padding[3];
}slPeerInfoAsyncResponse_t;


typedef union
{
  slSmartConfigStartAsyncResponse_t        smartConfigStartResponse; /*SL_WLAN_SMART_CONFIG_COMPLETE_EVENT*/
  slSmartConfigStopAsyncResponse_t         smartConfigStopResponse;  /*SL_WLAN_SMART_CONFIG_STOP_EVENT */
  slPeerInfoAsyncResponse_t                APModeStaConnected;       /* SL_WLAN_STA_CONNECTED_EVENT - relevant only in AP mode - holds information regarding a new STA connection */   
  slPeerInfoAsyncResponse_t                APModestaDisconnected;    /* SL_WLAN_STA_DISCONNECTED_EVENT - relevant only in AP mode - holds information regarding a STA disconnection */ 
  slWlanConnectAsyncResponse_t             STAandP2PModeWlanConnected;   /* SL_WLAN_CONNECT_EVENT - relevant only in STA and P2P mode - holds information regarding a new connection */
  slWlanConnectAsyncResponse_t             STAandP2PModeDisconnected;   /* SL_WLAN_DISCONNECT_EVENT - relevant only in STA and P2P mode - holds information regarding a disconnection */
  slPeerInfoAsyncResponse_t                P2PModeDevFound;             /* SL_WLAN_P2P_DEV_FOUND_EVENT - relevant only in P2P mode */
  slPeerInfoAsyncResponse_t                P2PModeNegReqReceived;       /* SL_WLAN_P2P_NEG_REQ_RECEIVED_EVENT - relevant only in P2P mode */
  slWlanConnFailureAsyncResponse_t         P2PModewlanConnectionFailure;   /* SL_WLAN_CONNECTION_FAILED_EVENT - relevant only in P2P mode */

} SlWlanEventData_u;

typedef struct
{
   _u32     Event;
   SlWlanEventData_u        EventData;
} SlWlanEvent_t;


typedef struct 
{
    _u32  ReceivedValidPacketsNumber;                     /* sum of the packets that been received OK (include filtered) */
    _u32  ReceivedFcsErrorPacketsNumber;                  /* sum of the packets that been dropped due to FCS error */ 
    _u32  ReceivedAddressMismatchPacketsNumber;           /* sum of the packets that been received but filtered out by one of the HW filters */
    _i16  AvarageDataCtrlRssi;                            /* average RSSI for all valid data packets received */
    _i16  AvarageMgMntRssi;                               /* average RSSI for all valid management packets received */
    _u16  RateHistogram[NUM_OF_RATE_INDEXES];             /* rate histogram for all valid packets received */
    _u16  RssiHistogram[SIZE_OF_RSSI_HISTOGRAM];          /* RSSI histogram from -40 until -87 (all below and above\n RSSI will appear in the first and last cells */
    _u32  StartTimeStamp;                                 /* the time stamp started collecting the statistics in uSec */
    _u32  GetTimeStamp;                                   /* the time stamp called the get statistics command */
}SlGetRxStatResponse_t;


typedef struct
{
    _u8 ssid[MAXIMAL_SSID_LENGTH];
    _u8 ssid_len;
    _u8 sec_type;
    _u8 bssid[SL_BSSID_LENGTH];
    _i8 rssi;
    _i8 reserved[3];
}Sl_WlanNetworkEntry_t;

 
typedef struct 
{
    _u8   Type;
    _i8*  Key;
    _u8   KeyLen;
}SlSecParams_t;
 
typedef struct 
{
    _i8*  User;
    _u8   UserLen;
    _i8*  AnonUser;
    _u8   AnonUserLen;
    _u8   CertIndex;  /* not supported */
    _u32  EapMethod;
}SlSecParamsExt_t;

typedef struct 
{
    _i8   User[32];
    _u8   UserLen;
    _i8   AnonUser[32];
    _u8   AnonUserLen;
    _u8   CertIndex;  /* not supported */
    _u32  EapMethod;
}SlGetSecParamsExt_t;

typedef enum
{
    ROLE_STA       =   0,
    ROLE_UNKNOWN   =   1,
    ROLE_AP        =   2,
    ROLE_P2P     =     3,
    ROLE_STA_ERR =    -1,    /* Failure to load MAC/PHY in STA role */
    ROLE_AP_ERR  =    -2,    /* Failure to load MAC/PHY in AP role */
    ROLE_P2P_ERR =    -3,    /* Failure to load MAC/PHY in P2P role */
    INIT_CALIB_FAIL = -4     /* Failure of calibration */
}SlWlanMode_e;


typedef struct
{
    _u32   G_Channels_mask;
    _i32   rssiThershold;
}slWlanScanParamCommand_t;


typedef struct 
{
    _u8   id;
    _u8   oui[3];
    _u16  length;
    _u8   data[252];
} sl_protocol_InfoElement_t;

typedef struct 
{
    _u8                       index;  /* 0 - MAX_PRIVATE_INFO_ELEMENTS_SUPPROTED */
    _u8                       role;   /* bit0: AP = 0, GO = 1                    */
    sl_protocol_InfoElement_t   ie;
} sl_protocol_WlanSetInfoElement_t;


/*****************************************************************************/
/* Function prototypes                                                                       */
/*****************************************************************************/


#if _SL_INCLUDE_FUNC(sl_WlanConnect)
_i16 sl_WlanConnect(const _i8*  pName,const  _i16 NameLen,const _u8 *pMacAddr,const SlSecParams_t* pSecParams ,const SlSecParamsExt_t* pSecExtParams);
#endif

#if _SL_INCLUDE_FUNC(sl_WlanDisconnect)
_i16 sl_WlanDisconnect(void);
#endif

#if _SL_INCLUDE_FUNC(sl_WlanProfileAdd)
_i16 sl_WlanProfileAdd(const _i8*  pName,const  _i16 NameLen,const _u8 *pMacAddr,const SlSecParams_t* pSecParams ,const SlSecParamsExt_t* pSecExtParams,const _u32 Priority,const _u32  Options);
#endif

#if _SL_INCLUDE_FUNC(sl_WlanProfileGet)
_i16 sl_WlanProfileGet(const _i16 Index,_i8*  pName, _i16 *pNameLen, _u8 *pMacAddr, SlSecParams_t* pSecParams, SlGetSecParamsExt_t* pSecExtParams, _u32 *pPriority);
#endif

#if _SL_INCLUDE_FUNC(sl_WlanProfileDel)
_i16 sl_WlanProfileDel(const _i16 Index);
#endif

#if _SL_INCLUDE_FUNC(sl_WlanPolicySet)
_i16 sl_WlanPolicySet(const _u8 Type , const _u8 Policy, _u8 *pVal,const _u8 ValLen);
#endif

#if _SL_INCLUDE_FUNC(sl_WlanPolicyGet)
_i16 sl_WlanPolicyGet(const _u8 Type , _u8 Policy,_u8 *pVal,_u8 *pValLen);
#endif

#if _SL_INCLUDE_FUNC(sl_WlanGetNetworkList)
_i16 sl_WlanGetNetworkList(const _u8 Index,const  _u8 Count, Sl_WlanNetworkEntry_t *pEntries);
#endif

#if _SL_INCLUDE_FUNC(sl_WlanRxStatStart)
_i16 sl_WlanRxStatStart(void);
#endif


#if _SL_INCLUDE_FUNC(sl_WlanRxStatStop)
_i16 sl_WlanRxStatStop(void);
#endif


#if _SL_INCLUDE_FUNC(sl_WlanRxStatGet)
_i16 sl_WlanRxStatGet(SlGetRxStatResponse_t *pRxStat,const _u32 Flags);
#endif


#if _SL_INCLUDE_FUNC(sl_WlanSmartConfigStop)
_i16 sl_WlanSmartConfigStop(void);
#endif

#if _SL_INCLUDE_FUNC(sl_WlanSmartConfigStart)
_i16 sl_WlanSmartConfigStart(const _u32    groupIdBitmask,
                             const _u8    cipher,
                             const _u8    publicKeyLen,
                             const _u8    group1KeyLen,
                             const _u8    group2KeyLen,
                             const _u8*    publicKey,
                             const _u8*    group1Key,
                             const _u8*    group2Key);
#endif


#if _SL_INCLUDE_FUNC(sl_WlanSetMode)
_i16 sl_WlanSetMode(const _u8    mode);
#endif


#if _SL_INCLUDE_FUNC(sl_WlanSet)
_i16 sl_WlanSet(const _u16 ConfigId ,const _u16 ConfigOpt,const _u16 ConfigLen,const  _u8 *pValues);
#endif

#if _SL_INCLUDE_FUNC(sl_WlanGet)
_i16 sl_WlanGet(const _u16 ConfigId, _u16 *pConfigOpt,_u16 *pConfigLen, _u8 *pValues);
#endif

#ifdef  __cplusplus
}
#endif /*  __cplusplus */

#endif    /*  __WLAN_H__ */