wlan_if.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024, Texas Instruments Incorporated
 * All rights reserved.
 *
 * 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.
 */
#ifndef USER_INTEFACE_WLAN_IF_H_
#define USER_INTEFACE_WLAN_IF_H_

#include "osi_kernel.h"
/*****************************************************************************/
/* TYPES DEFINITIONS                                                         */
/*****************************************************************************/

#ifndef NULL
#define NULL        (0)
#endif

#ifndef FALSE
#define FALSE       (0)
#endif

#ifndef TRUE
#define TRUE        (!FALSE)
#endif
#define DEVICE_ON (1)
#define DEVICE_OFF (0)
#define WLAN_WAIT_FOREVER               (0xFFFFFFFF)
#define WLAN_NO_WAIT                    (0x00000000)
#define WLAN_MAX_SCAN_COUNT                (20)
#define WLAN_BSSID_LENGTH                   (6)
#define WLAN_SSID_MAX_LENGTH                (32)
#define WLAN_DOT11_MAX_SUPPORTED_RATES      (32)
#define WLAN_DOT11_HT_CAPABILITIES_ELE_LEN  (26)
#define WLAN_DOT11_ERP_ELE_LEN              (1)
#define WLAN_MAX_BEACON_BODY_LENGTH         (700)
#define WLAN_DOT11_MAX_RSNE_SIZE            (257)
#define WLAN_DOT11_MAX_BEACON_BODY_LENGTH   (700)
#define WLAN_DOT11_MAX_WPSIE_SIZE           (350)

#define WLAN_LEN_OF_IE_HEADER               (2)

#define MAC_ADDRESS_LEN (6)
#define WLAN_MAX_MAC_ADDRESSES (4)

/* WLAN Disconnect Reason Codes */
#define WLAN_DISCONNECT_UNSPECIFIED                                         (1)
#define WLAN_DISCONNECT_AUTH_NO_LONGER_VALID                                (2)
#define WLAN_DISCONNECT_DEAUTH_SENDING_STA_LEAVING                          (3)
#define WLAN_DISCONNECT_INACTIVITY                                          (4)
#define WLAN_DISCONNECT_TOO_MANY_STA                                        (5)
#define WLAN_DISCONNECT_FRAME_FROM_NONAUTH_STA                              (6)
#define WLAN_DISCONNECT_FRAME_FROM_NONASSOC_STA                             (7)
#define WLAN_DISCONNECT_DISS_SENDING_STA_LEAVING                            (8)
#define WLAN_DISCONNECT_STA_NOT_AUTH                                        (9)
#define WLAN_DISCONNECT_POWER_CAPABILITY_INVALID                            (10)
#define WLAN_DISCONNECT_SUPPORTED_CHANNELS_INVALID                          (11)
#define WLAN_DISCONNECT_INVALID_IE                                          (13)
#define WLAN_DISCONNECT_MIC_FAILURE                                         (14)
#define WLAN_DISCONNECT_FOURWAY_HANDSHAKE_TIMEOUT                           (15)
#define WLAN_DISCONNECT_GROUPKEY_HANDSHAKE_TIMEOUT                          (16)
#define WLAN_DISCONNECT_REASSOC_INVALID_IE                                  (17)
#define WLAN_DISCONNECT_INVALID_GROUP_CIPHER                                (18)
#define WLAN_DISCONNECT_INVALID_PAIRWISE_CIPHER                             (19)
#define WLAN_DISCONNECT_INVALID_AKMP                                        (20)
#define WLAN_DISCONNECT_UNSUPPORTED_RSN_VERSION                             (21)
#define WLAN_DISCONNECT_INVALID_RSN_CAPABILITIES                            (22)
#define WLAN_DISCONNECT_IEEE_802_1X_AUTHENTICATION_FAILED                   (23)
#define WLAN_DISCONNECT_CIPHER_SUITE_REJECTED                               (24)
#define WLAN_DISCONNECT_DISASSOC_QOS                                        (32)
#define WLAN_DISCONNECT_DISASSOC_QOS_BANDWIDTH                              (33)
#define WLAN_DISCONNECT_DISASSOC_EXCESSIVE_ACK_PENDING                      (34)
#define WLAN_DISCONNECT_DISASSOC_TXOP_LIMIT                                 (35)
#define WLAN_DISCONNECT_STA_LEAVING                                         (36)
#define WLAN_DISCONNECT_STA_DECLINED                                        (37)
#define WLAN_DISCONNECT_STA_UNKNOWN_BA                                      (38)
#define WLAN_DISCONNECT_STA_TIMEOUT                                         (39)
#define WLAN_DISCONNECT_STA_UNSUPPORTED_CIPHER_SUITE                        (40)
#define WLAN_DISCONNECT_ROAMING_TRIGGER_NONE                                (100)
#define WLAN_DISCONNECT_ROAMING_TRIGGER_LOW_TX_RATE                         (104)
#define WLAN_DISCONNECT_ROAMING_TRIGGER_LOW_SNR                             (105)
#define WLAN_DISCONNECT_ROAMING_TRIGGER_LOW_QUALITY                         (106)
#define WLAN_DISCONNECT_ROAMING_TRIGGER_TSPEC_REJECTED                      (107)
#define WLAN_DISCONNECT_ROAMING_TRIGGER_MAX_TX_RETRIES                      (108)
#define WLAN_DISCONNECT_ROAMING_TRIGGER_BSS_LOSS                            (109)
#define WLAN_DISCONNECT_ROAMING_TRIGGER_BSS_LOSS_DUE_TO_MAX_TX_RETRY        (110)
#define WLAN_DISCONNECT_ROAMING_TRIGGER_SWITCH_CHANNEL                      (111)
#define WLAN_DISCONNECT_ROAMING_TRIGGER_AP_DISCONNECT                       (112)
#define WLAN_DISCONNECT_ROAMING_TRIGGER_SECURITY_ATTACK                     (113)
#define WLAN_DISCONNECT_USER_INITIATED                                      (200)
#define WLAN_DISCONNECT_AUTH_TIMEOUT                                        (202)
#define WLAN_DISCONNECT_ASSOC_TIMEOUT                                       (203)
#define WLAN_DISCONNECT_SECURITY_FAILURE                                    (204)
#define WLAN_DISCONNECT_WHILE_CONNNECTING                                   (208)
#define WLAN_DISCONNECT_MISSING_CERT                                        (209)
#define WLAN_DISCONNECT_CERTIFICATE_EXPIRED                                 (210)

#define WLAN_SEC_TYPE_OPEN                                                        (0)
#define WLAN_SEC_TYPE_WEP                                                         (1)
#define WLAN_SEC_TYPE_WPA                                                         (2) /* deprecated */
#define WLAN_SEC_TYPE_WPA_WPA2                                                    (2)
#define WLAN_SEC_TYPE_WPS_PBC                                                     (3)
#define WLAN_SEC_TYPE_WPS_PIN                                                     (4)
#define WLAN_SEC_TYPE_WPA_ENT                                                     (5)
#define WLAN_SEC_TYPE_P2P_PBC                                                     (6)
#define WLAN_SEC_TYPE_P2P_PIN_KEYPAD                                              (7)
#define WLAN_SEC_TYPE_P2P_PIN_DISPLAY                                             (8)
#define WLAN_SEC_TYPE_P2P_PIN_AUTO                                                (9) /* NOT Supported yet */
#define WLAN_SEC_TYPE_WEP_SHARED                                                  (10)
#define WLAN_SEC_TYPE_WPA2_PLUS                                                   (11) /* Support to WPA2 WPA2+PMF (Protected Managmant Frame) networks */
#define WLAN_SEC_TYPE_WPA3                                                        (12) /* Support WPA3 only networks */
#define WLAN_SEC_TYPE_WPA_PMK                                                     (15)
#define WLAN_SEC_TYPE_WPA2_WPA3                                                   (16) /*transition mode WPA2 WPA2+PMF WPA3 */

/* AP access List Macros */
#define WLAN_AP_ACCESS_LIST_MODE_DISABLED         0
#define WLAN_AP_ACCESS_LIST_MODE_DENY_LIST        1
#define WLAN_AP_ACCESS_LIST_MODE_ALLOW_LIST       2
#define WLAN_AP_ACCESS_LIST_UPDATE_RAM_FLASH      0
#define WLAN_AP_ACCESS_LIST_UPDATE_RAM_ONLY       1
#define WLAN_MAX_ACCESS_LIST_STATIONS             16
#define WLAN_AP_ACCESS_LIST_WILDCARD_LEN          6


/* Scan results security information */

#define SL_WLAN_SCAN_RESULT_SEC_TYPE_MASK              0x7
#define SL_WLAN_SCAN_RESULT_SEC_TYPE_POSITION          8

#define SL_WLAN_SCAN_RESULT_GROUP_CIPHER_MASK          0xf
#define SL_WLAN_SCAN_RESULT_GROUP_CIPHER_POSITION      0

#define SL_WLAN_SCAN_RESULT_UNICAST_CIPHER_MASK        0xf
#define SL_WLAN_SCAN_RESULT_UNICAST_CIPHER_POSITION    4

#define SL_WLAN_SCAN_RESULT_KEY_MGMT_MASK              0x3
#define SL_WLAN_SCAN_RESULT_KEY_MGMT_POSITION          11


#define WLAN_SCAN_RESULT_GROUP_CIPHER(SecurityInfo)              (SecurityInfo & 0xF)   /* Possible values: NONE,TKIP,CCMP */
#define WLAN_SCAN_RESULT_UNICAST_CIPHER_BITMAP(SecurityInfo)     ((SecurityInfo & 0xF0) >> 4 ) /* Possible values: NONE,WEP40,WEP104,TKIP,CCMP*/
#define WLAN_SCAN_RESULT_HIDDEN_SSID(SecurityInfo)               (SecurityInfo & 0x2000 ) >> 13 /* Possible values: TRUE/FALSE */
#define WLAN_SCAN_RESULT_KEY_MGMT_SUITES_BITMAP(SecurityInfo)    (SecurityInfo & 0x1800 ) >> 11  /* Possible values: OPEN, PSK*/
#define WLAN_SCAN_RESULT_SEC_TYPE_BITMAP(SecurityInfo)           ((SecurityInfo & (SL_WLAN_SCAN_RESULT_SEC_TYPE_MASK << SL_WLAN_SCAN_RESULT_SEC_TYPE_POSITION)) >> SL_WLAN_SCAN_RESULT_SEC_TYPE_POSITION)  /* Possible values: SL_WLAN_SECURITY_TYPE_BITMAP_OPEN, SL_WLAN_SECURITY_TYPE_BITMAP_WEP, SL_WLAN_SECURITY_TYPE_BITMAP_WPA, SL_WLAN_SECURITY_TYPE_BITMAP_WPA2, 0x6 (mix mode) SL_WLAN_SECURITY_TYPE_BITMAP_WPA | SL_WLAN_SECURITY_TYPE_BITMAP_WPA2 */
#define WLAN_SCAN_RESULT_PMF_ENABLE(SecurityInfo)                ((SecurityInfo & 0x4000  ) >> 14)  /* Possible values: TRUE/FALSE */
#define WLAN_SCAN_RESULT_PMF_REQUIRED(SecurityInfo)              ((SecurityInfo & 0x8000  ) >> 15)  /* Possible values: TRUE/FALSE */

#define WLAN_BEACON_MAX_SIZE    450


/*****************************************************************************/
/* STRUCTURE DEFINITIONS                                                     */
/*****************************************************************************/
typedef struct
{
    uint8_t       Ssid[WLAN_SSID_MAX_LENGTH];
    uint8_t       Bssid[WLAN_BSSID_LENGTH];
    uint8_t       SsidLen;
    int8_t        Rssi;
    uint16_t      SecurityInfo;
    uint8_t       Channel;
}WlanNetworkEntry_t;

typedef struct
{
    uint8_t       Ssid[WLAN_SSID_MAX_LENGTH];
    uint8_t       Bssid[WLAN_BSSID_LENGTH];
    uint8_t       SsidLen;
    int8_t        Rssi;
    uint16_t      SecurityInfo;
    uint8_t       Channel;

    uint16_t      mRatesLen;
    uint8_t       mRates[WLAN_DOT11_MAX_SUPPORTED_RATES + WLAN_LEN_OF_IE_HEADER];

    uint16_t      HtCapabilitiesLen;     // HT capabilities IE were received
    uint8_t       HtCapabilitiesIe[WLAN_DOT11_HT_CAPABILITIES_ELE_LEN + WLAN_LEN_OF_IE_HEADER];   /* HT capabilities IE unparsed */

    uint16_t      erpIeLen;     // HT capabilities IE were received
    uint8_t       erpIe[WLAN_DOT11_ERP_ELE_LEN + WLAN_LEN_OF_IE_HEADER];;
    Bool_e        mErpPresent;
    uint8_t       mUseProtection; //erp capabilities
    uint8_t/*EPreamble*/    mBarkerPreambleMode; //erp capabilities

    uint8_t       rsnIeLen;//the len includes the header
    uint8_t       rsnIeData[WLAN_DOT11_MAX_RSNE_SIZE + WLAN_LEN_OF_IE_HEADER];

    uint8_t       wpaIeLen;
    uint8_t       wpaIeData[WLAN_DOT11_MAX_RSNE_SIZE + WLAN_LEN_OF_IE_HEADER];

    uint16_t      wpsLen;
    uint8_t       wpsIeData[WLAN_DOT11_MAX_WPSIE_SIZE + WLAN_LEN_OF_IE_HEADER];
    Bool_e        wpsPresent;

    uint16_t      beaconInterval;
    uint16_t      capabilities;

}WlanNetworkEntryExtended_t;

typedef struct
{
    /* Sec Type */
    uint8_t   Type;
    /* Sec Key */
    int8_t*   Key;
    /* Key Length */
    uint8_t   KeyLen;
}WlanSecParams_t;

typedef struct WpsParams
{
    /* WPS UUID */
    const uint8_t *uuid;
    /* WPS device name */
    const char *deviceName;
    /* WPS manufacturer */
    const char *manufacturer;
    /* WPS model name */
    const char *modelName;
    /* WPS model number */
    const char *modelNumber;
    /* WPS serial number */
    const char *serialNumber;
    /* WPS device type */
    const uint8_t *deviceType;
    /* WPS os version */
    const uint8_t *osVersion;
    /* WPS config methods */
    const char *configMethods;
}WpsParams_t;

typedef struct P2pParams
{
    /* P2P Listen Channel */
    uint8_t listenChannel;
    /* P2P Listen Reg Class */
    uint8_t listenReg;
    /* P2P Operational Channel */
    uint8_t operChannel;
    /* P2P Operational Reg Class */
    uint8_t operReg;
    /* P2P GO Intent [0 - 15] */
    uint8_t goIntent;
    /* P2P SSID postfix */
    char *p2pSsidPostfix;

    uint32_t reserved;
}P2pParams_t;

typedef struct RoleUpApCmd
{   /* Ap's SSID */
    uint8_t *ssid;
    /* Determine if AP has hidden SSID */
    uint8_t hidden;
    /* 802.11 WLAN channel [1-12] */
    uint8_t channel;
    /* The AP's TX power */
    uint8_t tx_pow;
    /* Limits the number of stations that the AP's has */
    uint8_t sta_limit;
    /* Security parameters - Security Type and Password */
    WlanSecParams_t secParams;
    /* Set regulatory Domain */
    uint8_t countryDomain[3];
    /* Set AP to start as autonomous P2P Group Owner */
    uint8_t p2p_aGO; //TRUE/FALSE
    /* AP WPS enabled/disabled */
    Bool_e wpsDisabled; //TRUE/FALSE
    /* Set WPS parameters */
    WpsParams_t wpsParams;
    /* P2P enabled/disabled */
    Bool_e p2pDeviceEnabled; //TRUE/FALSE
    /* Set P2P Params */
    P2pParams_t P2pParams;
}RoleUpApCmd_t;

typedef struct
{
    /* Event to wake up on */
    uint8_t WakeUpEvent;
    /* number of DTIMs */
    uint8_t ListenInterval;
} WlanLongSleepInterval;

typedef struct __PACKED__
{
    uint8_t enableVal;
    uint8_t padding[3];
}CalibratorSetTransmitOmiParams_t;


typedef struct __PACKED__
{
    uint8_t enableVal;
    uint8_t padding[3];
}CalibratorSetPowerHeaderParams_t;

typedef struct __PACKED__
{
    uint8_t index;
    uint32_t value;
    uint8_t padding[3];
}CalibratorSetPsmParams_t;

typedef struct __PACKED__
{
    uint8_t enableVal;
    uint8_t padding[3];
}CalibratorSetUplinkMuDataParams_t;

typedef struct __PACKED__
{
    uint8_t rateVal;
    uint8_t padding[3];
}CalibratorSetMcsRateParams_t;

typedef struct __PACKED__
{
    uint8_t enableVal;
    uint8_t padding[3];
}CalibratorOperationModeControlParams_t;

typedef struct __PACKED__
{
    uint8_t enableVal;
    uint8_t padding[3];
}CalibratorUplinkMuParams_t;

typedef struct __PACKED__
{
    uint8_t value;
    uint8_t padding[3];
}CalibratorGiLtfModeParams_t;

typedef struct __PACKED__
{
    uint8_t beaconRssi;
    uint8_t padding[3];
}CalibratorBeaconRssiParams_t;

typedef struct __PACKED__
{
    uint8_t overEnable;
    uint8_t bw;
    uint8_t preamble;
    uint8_t rate;
    uint8_t dcm;
    uint8_t txPower;
    uint8_t giLTF;
    uint8_t padding;
}CalibratorRateOverrideParams_t;

typedef struct __PACKED__
{
    uint32_t receivedTotalPacketsNumber;
    uint32_t receivedFcsErrorPacketsNumber;
    uint32_t receivedAddressMismatchPacketsNumber;
    uint32_t receivedGoodPackets;
    int16_t  averageDataCtrlRssi;
    int16_t  averageDataCtrlSNR;
}CalibratorGetRxParams_t;

typedef struct __PACKED__
{
    uint8_t channel;
    uint8_t band;
    uint8_t bandwidth;
}CalibratorChannelTuneParams_t;

typedef struct __PACKED__
{
    uint32_t    bitmask;
    uint8_t     preambleType;
    uint8_t     phyRate;
    int8_t      txPower;
    uint8_t     GI_LTF_Type;
    uint8_t     DCM;
    uint16_t    startLength;
    uint16_t    endLength;
    uint32_t    delay;
    uint8_t     packetMode;
    uint16_t    numberOfPackets;
    uint8_t     dataMode;
    uint8_t     dataConstValue;
    uint8_t     enableCCA;
    uint8_t     bssColor;
    uint16_t    SU_ER_Bandwidth;
    uint8_t     partialAID;
    uint8_t     srcAddr[MAC_ADDRESS_LEN];
    uint8_t     dstAddr[MAC_ADDRESS_LEN];
    uint8_t     nominalPacketExtension;
    uint8_t     feedbackStatus;
    uint16_t    aid;
    uint8_t     groupId;
    uint8_t     ltfMode;
    uint8_t     heLtfNum;
    uint8_t     preFecPaddingFactor;
    uint16_t    commonInfoLen;
    uint16_t    ruAlloc;
    uint8_t     ulBw;
    uint8_t     startsStsNum;
    uint8_t     tbAutoMode;
    uint8_t     disamb;
    uint8_t     padding[1];
}CalibratorStartTxParams_t;


typedef struct __PACKED__
{
    uint8_t mode;
    int8_t offset;
    int8_t output_power;
}CalibratorStartTxToneParams_t;

typedef struct  __PACKED__
{
    uint16_t io_id;
    uint8_t  direction;
    uint8_t  state;
}CalibratorSetIoCfgParams_t;

typedef struct  __PACKED__
{
    uint16_t io_id;
    uint8_t  direction;
    uint8_t  value;
}CalibratorGetIoCfgParams_t;

typedef struct __PACKED__
{
    uint8_t     ackEnable;
    uint8_t     macAddress[MAC_ADDRESS_LEN];
    uint16_t    aid;
    uint8_t     preambleType;
    uint8_t     rate;
    uint8_t     padding;
}CalibratorStartRxParams_t;

typedef struct
{
    uint8_t calibratorAction;
    void    *calibratorCommandParams;
}CalibratorCommandWrapper_t;

/*****************************************************************************/
/* EVENTS DEFINITIONS                                                        */
/*****************************************************************************/
typedef enum
{
    WLAN_EVENT_CONNECT = 1,
    WLAN_EVENT_DISCONNECT,
    WLAN_EVENT_SCAN_RESULT,
    WLAN_EVENT_ADD_PEER,
    WLAN_EVENT_REMOVE_PEER,
    WLAN_EVENT_CONNECTING,
    WLAN_EVENT_ACTION_FRAME_RX,
    WLAN_EVENT_ASSOCIATED,
    WLAN_EVENT_AP_EXT_WPS_SETTING_FAILED,
    WLAN_EVENT_BLE_ENABLED,
    WLAN_EVENT_CS_FINISH,
    WLAN_EVENT_ROC_DONE,
    WLAN_EVENT_CROC_DONE,
    WLAN_EVENT_SEND_ACTION_DONE,
    WLAN_EVENT_EXTENDED_SCAN_RESULT,
    WLAN_EVENT_MAX = 0xFFFF
} WlanEventId_e;

typedef struct
{
    uint8_t     SsidLen;
    uint8_t     SsidName[WLAN_SSID_MAX_LENGTH];
    uint8_t     Bssid[WLAN_BSSID_LENGTH];
    uint8_t     Channel;
} WlanEventConnect_t;

typedef struct
{
    uint8_t     SsidLen;
    uint8_t     SsidName[WLAN_SSID_MAX_LENGTH];
    uint8_t     Bssid[WLAN_BSSID_LENGTH];
} WlanEventConnecting_t;


typedef struct
{
    uint8_t                 SsidLen;
    uint8_t                 SsidName[WLAN_SSID_MAX_LENGTH];
    uint8_t                 Bssid[WLAN_BSSID_LENGTH];
    int16_t                 ReasonCode;
} WlanEventDisconnect_t;

typedef struct
{
    uint32_t           NetworkListResultLen;
    WlanNetworkEntry_t NetworkListResult[WLAN_MAX_SCAN_COUNT];

} WlanEventScanResult_t;

typedef struct
{
    uint32_t           NetworkListResultLen;
    WlanNetworkEntryExtended_t NetworkListResult[WLAN_MAX_SCAN_COUNT];

}WlanEventExtendedScanResult_t;

typedef struct
{
    uint8_t   Mac[6];
    uint8_t   Padding[2];
}WlanEventSTAAdded_t, WlanEventSTARemoved_t;

typedef struct
{
    uint8* frame;//(struct ieee80211_mgmt *)
    uint32 frame_len;
    uint32 dataRate;
    int32  rssi_signal;
    int32  rx_freq;
}WlanEvenWfdMgmtFrame_t;

typedef union
{
    /* STA Role */
    WlanEventConnect_t                    Connect; /* WLAN_EVENT_CONNECT */
    WlanEventConnecting_t                 Connecting; /* WLAN_EVENT_CONNECTING */
    WlanEventDisconnect_t                 Disconnect; /* WLAN_EVENT_DISCONNECT */
    WlanEventScanResult_t                 ScanResult; /* WLAN_EVENT_SCAN_RESULT */
    WlanEventExtendedScanResult_t*        pExtendedScanResult; /* WLAN_EVENT_EXTENDED_SCAN_RESULT */
    uint8                                 newChannel; /* WLAN_EVENT_CS_FINISH */

    /* AP Role */
    WlanEventSTAAdded_t         AddPeer; /* WLAN_EVENT_ADD_PEER */
    WlanEventSTARemoved_t    RemovePeer; /* WLAN_EVENT_REMOVE_PEER */
    WlanEvenWfdMgmtFrame_t   WfdActionFrame;/* WLAN_EVENT_ACTION_FRAME_RX - this event will be triggered only if defined WlanExternalApp_t*/
    int8_t                  wpsFailCode; /* WLAN_EVENT_AP_EXT_WPS_SETTING_FAILED - reason code arrives from supplicant */
    int32_t                 bleEnableStatus;
} WlanEventData_u;

typedef struct
{
    WlanEventId_e        Id;
    WlanEventData_u    Data;

} WlanEvent_t;

/* Host Event handler Callback*/
typedef void (* WlanEventHandlerCB_t)(WlanEvent_t * pWlanEvent);

/*****************************************************************************/
/* OTHER DEFINITIONS                                                         */
/*****************************************************************************/
typedef enum
{
    WLAN_MAC_OFFSET_ROLE_STA,
    WLAN_MAC_OFFSET_ROLE_BLE,
    WLAN_MAC_OFFSET_ROLE_DEVICE,
    WLAN_MAC_OFFSET_ROLE_AP,
    WLAN_MAC_OFFSET_ROLE_P2P_GO = WLAN_MAC_OFFSET_ROLE_AP,
}WlanMacAddOffset_e;

//this is also roleTypes must to be same numbers as in :RoleType_e
typedef enum
{
    WLAN_ROLE_STA                    , /* 0  */
    WLAN_ROLE_IBSS                   , /* 1  */
    WLAN_ROLE_AP                     , /* 2  */
    WLAN_ROLE_DEVICE                 , /* 3  */
    WLAN_ROLE_P2P_CL                 , /* 4  */
    WLAN_ROLE_P2P_GO                 , /* 5  */
    WLAN_ROLE_RESERVED
}WlanRole_e;

typedef enum
{
    WLAN_STATION_AUTO_PS_MODE,
    WLAN_STATION_ACTIVE_MODE,
    WLAN_STATION_POWER_SAVE_MODE,
    WLAN_STATION_NUM_OF_MODES
}WlanPowerSave_e;

typedef enum
{
    POWER_MANAGEMENT_ALWAYS_ACTIVE_MODE,
    POWER_MANAGEMENT_POWER_DOWN_MODE,
    POWER_MANAGEMENT_ELP_MODE,
    POWER_MANAGEMENT_NUM_OF_MODES
} WlanPowerManagement_e;

typedef enum
{
    WAKE_UP_EVENT_BEACON    = 0x01, /* Wake on every Beacon */
    WAKE_UP_EVENT_DTIM      = 0x02, /* Wake on every DTIM */
    WAKE_UP_EVENT_N_DTIM    = 0x04, /* Wake every Nth DTIM */
    WAKE_UP_EVENT_LIMIT     = WAKE_UP_EVENT_N_DTIM,
}WlanWakeUpEvent_e;

typedef struct
{
    /* Saved the configured role bitmap - each bit indicates specific role */
    uint32_t             hostConfiguredRolesBitmap;
    /* Saved the event handler Callback function */
    WlanEventHandlerCB_t eventHandlerCB;
    /* Saved the device current power save mode */
    WlanPowerSave_e      devicePowerSaveMode;
} StartRoleApps_t;

#define WLAN_MAX_SCAN_SSID 5
typedef struct
{
    uint8_t ssidLen;
    uint8_t pSsid[WLAN_SSID_MAX_LENGTH];
    uint8_t mHidden;// 1 = SSID_TYPE_HIDDEN, 0 = SSID_TYPE_PUBLIC
    uint8_t padding[2];
}scan_ssid_t;

//Taken from dot11CommonRadioApi.h
typedef enum
{
  BAND_SEL_ONLY_2_4GHZ,
  BAND_SEL_ONLY_5GHZ,
  BAND_SEL_BOTH
} WlanBandCfg_e;

typedef struct
{
    scan_ssid_t ssidLst[WLAN_MAX_SCAN_SSID];
    WlanBandCfg_e Band; //added 0  - 2.4, 1 = 5G , 2 = Both
    uint8_t extWpsMode;
}scanCommon_t;
typedef enum
{
    WLAN_SET_MACADDRESS,
    WLAN_SET_POWER_SAVE,
    WLAN_SET_POWER_MANAGEMENT,
    WLAN_SET_LSI,
    WLAN_SET_CALIBRATOR_POWER_MODE,
    WLAN_SET_CALIBRATOR_CHANNEL_TUNE,
    WLAN_SET_CALIBRATOR_TX_START,
    WLAN_SET_CALIBRATOR_TX_TONE_START,
    WLAN_SET_CALIBRATOR_TX_STOP,
    WLAN_SET_CALIBRATOR_START_RX,
    WLAN_SET_CALIBRATOR_STOP_RX,
    WLAN_SET_CALIBRATOR_TX_PARAMS,
    WLAN_SET_CALIBRATOR_TB_TX_PARAMS,
    WLAN_SET_CALIBRATOR_RATE_OVERRIDE,
    WLAN_SET_CALIBRATOR_GI_LTF,
    WLAN_SET_CALIBRATOR_UPLINK_MU,
    WLAN_SET_CALIBRATOR_OPERATION_MODE_CONTROL,
    WLAN_SET_CALIBRATOR_SWITCH_ANT,
    WLAN_SET_CALIBRATOR_MCS_RATE,
    WLAN_SET_CALIBRATOR_UPLINK_MU_DATA,
    WLAN_SET_CALIBRATOR_PSM,
    WLAN_SET_CALIBRATOR_UPLINK_POWER_HEADER,
    WLAN_SET_CALIBRATOR_TRANSMIT_OSI,
    WLAN_SET_CALIBRATOR_MANUAL_CALIBRATION,
    WLAN_SET_CALIBRATOR_SET_IO_CFG,
    WLAN_SET_CALIBRATOR_BLE_ENABLE,
    WLAN_SET_RESET_COUNTERS,
    WLAN_SET_ANTENNA_SELECT,
    WLAN_SET_VENDOR_IE,
    WLAN_SET_TX_CTRL,
    WLAN_SET_EXTERNAL,
    WLAN_SET_EXT_P2P_BUILD_ACTION_FRAME,
    WLAN_SET_EXT_OFFCHANNEL_ROC,
    WLAN_SET_EXT_OFFCHANNEL_SEND_RAW_ACTION,
    WLAN_SET_EXT_WPS_SESSION,
    WLAN_EXTENDED_SCAN_RESULTS,
    WLAN_SET_BLE_ENABLE,
} WlanSet_e;

typedef enum
{
    WLAN_GET_MACADDRESS,
    WLAN_GET_POWER_SAVE,
    WLAN_GET_CALIBRATOR_TX_PARAMS,
    WLAN_GET_CALIBRATOR_RX_STATS,
    WLAN_GET_CALIBRATOR_GET_IO_CFG,
    WLAN_GET_ANTENNA_SELECT,
    WLAN_GET_RSSI,
    WLAN_GET_FWVERSION,
    WLAN_GET_DEVICE_INFO,
    WLAN_GET_CALIBRATOR_BEACON_RSSI,
    WLAN_GET_COUNTERS,
    WLAN_GET_CONNECTION_KEY_MANAGEMENT,
    WLAN_GET_EXTERNAL,
} WlanGet_e;

typedef struct
{
    WlanRole_e roleType;
    unsigned char pMacAddress[6];
}WlanMacAddress_t;

typedef struct
{
    uint16 major_version;
    uint16 minor_version;
    uint16 api_version;
    uint16 build_version;

    uint8 phy_version[6];
    uint8 pad[2];
} WlanFWVersions_t;

typedef struct __PACKED__
{
    uint8      role_id;
    uint8      pad[3];
    uint32     missed_beacons;
    uint8      snr_data;
    uint8      snr_beacon;
    int8       rssi_data;
    int8       rssi_beacon;
} WlanBeaconRssi_t;


typedef enum
{
    CALIBRATOR_ACTION_SET_POWER_MODE,
    CALIBRATOR_ACTION_CHANNEL_TUNE,
    CALIBRATOR_ACTION_TX_START,
    CALIBRATOR_ACTION_TX_STOP,
    CALIBRATOR_ACTION_TX_TONE_START,
    CALIBRATOR_ACTION_START_RX,
    CALIBRATOR_ACTION_STOP_RX,
    CALIBRATOR_ACTION_GET_RX_STATS,
    CALIBRATOR_ACTION_SET_TX_PARAMS,
    CALIBRATOR_ACTION_GET_TX_PARAMS,
    CALIBRATOR_ACTION_SET_TB_TX_PARAMS,
    CALIBRATOR_ACTION_RATE_OVERRIDE,
    CALIBRATOR_ACTION_GET_BEACON_RSSI,
    CALIBRATOR_ACTION_SET_GI_LTF,
    CALIBRATOR_ACTION_SET_UPLINK_MU,
    CALIBRATOR_ACTION_SET_OPERATION_MODE_CONTROL,
    CALIBRATOR_ACTION_SET_MCS_RATE,
    CALIBRATOR_ACTION_SET_UPLINK_MU_DATA,
    CALIBRATOR_ACTION_SET_PSM,
    CALIBRATOR_ACTION_SET_UPLINK_POWER_HEADER,
    CALIBRATOR_ACTION_SET_TRANSMIT_OMI,
    CALIBRATOR_ACTION_MANUAL_CALIBRATION,
    CALIBRATOR_ACTION_SWITCH_ANT,
    CALIBRATOR_ACTION_SET_IO_CFG,
    CALIBRATOR_ACTION_GET_IO_CFG,
    CALIBRATOR_ACTION__BLE_ENABLE

} CalibratorAction_e;

typedef enum
{
    PLT_OFF,
    PLT_ON
} CalibratorPowerModes_e;

typedef enum {
    CALIBRATOR_SET_TX_PREAMBLE_TYPE_BIT,
    CALIBRATOR_SET_TX_PHY_RATE_BIT,
    CALIBRATOR_SET_TX_TX_POWER_BIT,
    CALIBRATOR_SET_TX_GI_LTF_TYPE_BIT,
    CALIBRATOR_SET_TX_DCM_BIT,
    CALIBRATOR_SET_TX_LENGTH_BIT,
    CALIBRATOR_SET_TX_DELAY_BIT,
    CALIBRATOR_SET_TX_PACKET_MODE_BIT,
    CALIBRATOR_SET_TX_NUMBER_OF_PACKETS_BIT,
    CALIBRATOR_SET_TX_DATA_MODE_BIT,
    CALIBRATOR_SET_TX_DATA_CONST_VALUE_BIT,
    CALIBRATOR_SET_TX_ENABLE_CCA_BIT,
    CALIBRATOR_SET_TX_BSS_COLOR_BIT,
    CALIBRATOR_SET_TX_SU_ER_BANDWIDTH_BIT,
    CALIBRATOR_SET_TX_PARTIAL_AID_BIT,
    CALIBRATOR_SET_TX_SRC_ADDR_BIT,
    CALIBRATOR_SET_TX_DST_ADDR_BIT,
    CALIBRATOR_SET_TX_NOMINAL_PACKET_EXTENSION_BIT,
    CALIBRATOR_SET_TX_FEEDBACK_STATUS_BIT,
    CALIBRATOR_SET_TX_AID_BIT,
    CALIBRATOR_SET_TX_GROUP_ID_BIT,
    CALIBRATOR_SET_TX_LTF_MODE_BIT,
    CALIBRATOR_SET_TX_HE_LTF_NUM_BIT,
    CALIBRATOR_SET_TX_PRE_FEC_PADDING_FACTOR_BIT,
    CALIBRATOR_SET_TX_COMMON_INFO_LEN_BIT,
    CALIBRATOR_SET_TX_RU_ALLOC_BIT,
    CALIBRATOR_SET_TX_UL_BW_BIT,
    CALIBRATOR_SET_TX_STARTS_STS_NUM_BIT,
    CALIBRATOR_SET_TX_TB_AUTO_MODE_BIT,
    CALIBRATOR_SET_TX_TB_DISAMB_MODE_BIT
}CalibratorSetTxBits_e;

typedef struct
{
    /* Threshold of transition between TCP thread and TRANSPORT thread */
    uint32_t TxSendPaceThresh;
    /* Tx-Send pacing threshold */
    uint32_t TxSendPaceTimeoutMsec;
    /* Indicate if run schedualer after TX Complete */
    uint32_t TransmitQOnTxComplete ;
} WlanCtrlBlk_t;

typedef struct
{

    uint32_t    counters_timeLastReset_Ms;
    uint32_t    counters_timeLastUpdate_Ms;


    //configured tx rate, not actual !!!
    uint32_t    txRate;

    //entrance to the stack after LWIP
    uint32_t    link_tx_dbgStackTimeFirstPacket_Ms;
    uint32_t    link_tx_dbgStackTimeLastPacket_Ms;
    uint32_t    link_tx_dbgStackEntrNumByteSent ;
    uint32_t    link_tx_dbgStackEntNumPktsXfered ;

    //transport - before sending to the FW
    uint32_t    link_tx_dbgTimeFirstPacket_Ms;
    uint32_t    link_tx_dbgTimeLastPacket_Ms ;
    uint32_t    link_tx_dbgNumPktsSent       ;
    uint32_t    link_tx_dbgNumBytesSent      ;
    uint32_t    link_tx_dbgNumPktsBusy       ;
    uint32_t    link_tx_dbgNumPktsAcBusy     ;
    uint32_t    link_tx_dbgNumPktsXfered     ;
    uint32_t    link_tx_dbgNumPktsSuccess    ;
    uint32_t    link_tx_dbgNumPktsError      ;


   //transport -after Tx complete
    uint32_t    link_tx_dbgNumTxCmplt        ;
    uint32_t    link_tx_dbgNumTxCmpltOk      ;
    uint32_t    link_tx_dbgNumTxCmpltError   ;
    uint32_t    link_tx_dbgNumTxCmpltOkBytes ;
    uint32_t    link_tx_dbgNumTxCmpltFailBytes;


    uint32_t      rxRate;
    /* the number of frames that the NIC receives without errors */
    uint32_t      rxstat_RecvOk;
    /* the number of bytes in directed packets that are received without errors */
    uint32_t      rxstat_DirectedBytesRecv;
    /* the number of directed packets that are received without errors */
    uint32_t     rxstat_DirectedFramesRecv;
    /* the number of bytes in multicast/functional packets that are received without errors */
    uint32_t      rxstat_MulticastBytesRecv;
    /* the number of multicast/functional packets that are received without errors */
    uint32_t      rxstat_MulticastFramesRecv;
    /* the number of bytes in broadcast packets that are received without errors. */
    uint32_t      rxstat_BroadcastBytesRecv;
    /* the number of broadcast packets that are received without errors. */
    uint32_t      rxstat_BroadcastFramesRecv;

    uint32_t      link_rx_recvFromWlan;
    uint32_t      link_rx_recvBytesFromWlan;
    uint32_t      link_rx_sendToUwd;
    uint32_t      link_rx_sendToDataDispatcher;
    uint32_t      link_rx_discardWrongHlid;
    uint32_t      link_rx_discardHlidClose;
    uint32_t      link_rx_discardBaEvent;
    uint32_t      link_rx_discardUnknownClass;
}dbg_cntr_trnspt_t;


typedef struct
{
    WlanRole_e          inp_role;
    dbg_cntr_trnspt_t   out_Param;
}dbg_counters_get_t;

typedef struct
{
    //mac_address[0] --- for STA role
    //mac_address[1] --- for BLE Role
    //mac_address[2] ---- for P2P
    //mac_address[3] ----- for AP or STA-2
    uint8_t   mac_address[WLAN_MAX_MAC_ADDRESSES][MAC_ADDRESS_LEN];//efuse mac address
    uint8_t   struct_is_updateed; //means that this global was update form BTL
    uint8_t   fuse_rom_structure_version;
    uint8_t   device_part_number;
    uint8_t   boot_rom_version;
    uint8_t   pg_version;
    uint8_t   metal_version;
    uint8_t   disable_5g;
    uint8_t   disable_6g;
    uint8_t   disable_ble;
    uint64_t  udi;
}device_info_t;

typedef struct
{
    WlanRole_e  role_type;
    uint16_t    length;
    uint8_t     data[WLAN_BEACON_MAX_SIZE];
}wlanSetVendorInfo_t;


typedef struct
{
    uint8_t enable;
    uint8_t peerMac[MAC_ADDRESS_LEN];
    uint8_t wpsMethod; // 0 - PBC, 1 - PIN
    unsigned char *pin;
}wlanSetExtWpsSession_t;


typedef enum wlan_p2p_action_frame_type {
    WLAN_P2P_GO_NEG_REQ = 0,
    WLAN_P2P_GO_NEG_RESP = 1,
    WLAN_P2P_GO_NEG_CONF = 2,
    WLAN_P2P_INVITATION_REQ = 3,
    WLAN_P2P_INVITATION_RESP = 4,
    WLAN_P2P_DEV_DISC_REQ = 5,
    WLAN_P2P_DEV_DISC_RESP = 6,
    WLAN_P2P_PROV_DISC_REQ = 7,
    WLAN_P2P_PROV_DISC_RESP = 8
}WlanP2pActionFrameType_t;


typedef enum wlan_p2p_status_code {// this enum need to be the same as this one :p2p_status_code
    WLAN_P2P_SC_SUCCESS = 0,
    WLAN_P2P_SC_FAIL_INFO_CURRENTLY_UNAVAILABLE = 1,
    WLAN_P2P_SC_FAIL_INCOMPATIBLE_PARAMS = 2,
    WLAN_P2P_SC_FAIL_LIMIT_REACHED = 3,
    WLAN_P2P_SC_FAIL_INVALID_PARAMS = 4,
    WLAN_P2P_SC_FAIL_UNABLE_TO_ACCOMMODATE = 5,
    WLAN_P2P_SC_FAIL_PREV_PROTOCOL_ERROR = 6,
    WLAN_P2P_SC_FAIL_NO_COMMON_CHANNELS = 7,
    WLAN_P2P_SC_FAIL_UNKNOWN_GROUP = 8,
    WLAN_P2P_SC_FAIL_BOTH_GO_INTENT_15 = 9,
    WLAN_P2P_SC_FAIL_INCOMPATIBLE_PROV_METHOD = 10,
    WLAN_P2P_SC_FAIL_REJECTED_BY_USER = 11,
    WLAN_P2P_SC_SUCCESS_DEFERRED = 12,
}WlanP2pStatusCode_t;


typedef struct {
    uint8_t*  device_address;
    uint8_t   connection_capability;
    uint32_t  session_id;
    uint32_t  advertisement_id;
    uint8_t*  session_mac;
    uint8_t*  adv_mac;
    uint8_t*  persist_ssid;
    uint32_t  persist_ssid_len;
    uint8_t   dialog_token;
} WlanPeer_t;

typedef struct
{
    uint8_t      dialog_token;
    uint8_t*     p2p_device_addr;
    uint8_t*     oper_ssid; // 32 char+ null
    uint32_t     oper_ssid_len;
}WlanGOPeer_t;


typedef struct
 {
     WlanRole_e                 roleId;
     uint8_t                    msgType; /*see : wlan_p2p_action_frame_type*/
     uint8_t                    status; /*see WlanP2pStatusCode_t*/
     uint8_t                    provDiscReqSa[6];
     uint8_t*                   provDiscReqData;
     size_t                     provDiscReqLen;
     int32_t                    provDiscReqRxFreq;
 }WlanProvDiscResp_t;

 typedef struct
 {
     WlanRole_e   roleId;
     uint8_t      msgType; /*see : wlan_p2p_action_frame_type*/
 }WlanProvDiscReq_t;

typedef union
{

    WlanProvDiscReq_t  ProvDiscReq;
    WlanProvDiscResp_t ProvDiscResp;

}WlanActionParam_t;

typedef struct
{
    WlanP2pActionFrameType_t      msgType;
    WlanActionParam_t             actionParam;
}WlanBuildActionBuffer_t;

typedef struct
{
    uint32_t         enableROC;
    uint32_t         channel;
    uint8_t*         countryDomain;
}WlanROCExt_t;

typedef struct
{
    uint8_t* pBuff; // buf is allocate by the stack, expected to be freed by the app
    uint32_t bufLen;
} WlanActionBuff_t;

typedef struct
{
    uint8_t            apDst[MAC_ADDRESS_LEN];              // Destination address
    WlanActionBuff_t   actionBuff;          // the action data
}WlanActionTxExt_t;

typedef struct
{
    uint8_t extWps;
    uint8_t extP2P;
    uint8_t extWpsDone;
}WlanExternalApp_t;
/*****************************************************************************/
/* Data path CB function                                                     */
/*****************************************************************************/
typedef void (* WlanNetworkDataRecvCB_t)(WlanRole_e role_id,uint8_t *input,uint32_t input_len);


/*****************************************************************************/
/* USER API                                                                  */
/*****************************************************************************/
int ctrlCmdFw_EnableBLECmd(void);

int ctrlCmdFw_SetBdAddrCmd(const unsigned char *pBdAddr);

int Wlan_Start(WlanEventHandlerCB_t eventHandlerCB);

int Wlan_Stop(void);

int Wlan_RoleUp(WlanRole_e roleType, void * params, unsigned long int timeout);


int Wlan_RoleDown(WlanRole_e roleType, unsigned long int timeout);

int Wlan_Connect(const signed char *pName, const int NameLen,
                        const unsigned char *pMacAddr, char SecType, const char *pPass,
                        const char PassLen);

int Wlan_Disconnect();

int Wlan_Scan(WlanRole_e role, void* params,const unsigned char ScanResultsSize);

int Wlan_Get(WlanGet_e wlanGetType, void *params);

int Wlan_Set(WlanSet_e wlanSetType, void *params);


int Wlan_EtherPacketSend(WlanRole_e role, uint8_t *inbuf, uint32_t inbuf_len,uint32_t flags);


int Wlan_EtherPacketRecvRegisterCallback(WlanRole_e role, WlanNetworkDataRecvCB_t cb);


#endif /* USER_INTEFACE_WLAN_IF_H_ */