esp_wifi.h

/*
 * ESPRSSIF MIT License
 *
 * Copyright (c) 2015 <ESPRESSIF SYSTEMS (SHANGHAI) PTE LTD>
 *
 * Permission is hereby granted for use on ESPRESSIF SYSTEMS ESP8266 only, in which case,
 * it is 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.
 *
 */

#ifndef __ESP_WIFI_H__
#define __ESP_WIFI_H__

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    NULL_MODE = 0,      
    STATION_MODE,       
    SOFTAP_MODE,        
    STATIONAP_MODE,     
    MAX_MODE
} WIFI_MODE;

typedef enum {
    AUTH_OPEN = 0,      
    AUTH_WEP,           
    AUTH_WPA_PSK,       
    AUTH_WPA2_PSK,      
    AUTH_WPA_WPA2_PSK,  
    AUTH_MAX
} AUTH_MODE;

WIFI_MODE wifi_get_opmode(void);

WIFI_MODE wifi_get_opmode_default(void);

bool wifi_set_opmode(WIFI_MODE opmode);

bool wifi_set_opmode_current(WIFI_MODE opmode);

typedef enum {
    STATION_IF = 0, 
    SOFTAP_IF,      
    MAX_IF
} WIFI_INTERFACE;

struct ip_info {
    struct ip_addr ip;      
    struct ip_addr netmask; 
    struct ip_addr gw;      
};

bool wifi_get_ip_info(WIFI_INTERFACE if_index, struct ip_info *info);

bool wifi_set_ip_info(WIFI_INTERFACE if_index, struct ip_info *info);

bool wifi_get_macaddr(WIFI_INTERFACE if_index, uint8 *macaddr);

bool wifi_set_macaddr(WIFI_INTERFACE if_index, uint8 *macaddr);

void wifi_status_led_install(uint8 gpio_id, uint32 gpio_name, uint8 gpio_func);

void wifi_status_led_uninstall(void);

typedef enum {
    PHY_MODE_11B    = 1,    
    PHY_MODE_11G    = 2,    
    PHY_MODE_11N    = 3     
} WIFI_PHY_MODE;

WIFI_PHY_MODE wifi_get_phy_mode(void);

bool wifi_set_phy_mode(WIFI_PHY_MODE mode);

typedef enum {
    EVENT_STAMODE_SCAN_DONE = 0,        
    EVENT_STAMODE_CONNECTED,            
    EVENT_STAMODE_DISCONNECTED,         
    EVENT_STAMODE_AUTHMODE_CHANGE,      
    EVENT_STAMODE_GOT_IP,               
    EVENT_STAMODE_DHCP_TIMEOUT,         
    EVENT_SOFTAPMODE_STACONNECTED,      
    EVENT_SOFTAPMODE_STADISCONNECTED,   
    EVENT_SOFTAPMODE_PROBEREQRECVED,    
    EVENT_MAX
} SYSTEM_EVENT;

enum {
    REASON_UNSPECIFIED              = 1,
    REASON_AUTH_EXPIRE              = 2,
    REASON_AUTH_LEAVE               = 3,
    REASON_ASSOC_EXPIRE             = 4,
    REASON_ASSOC_TOOMANY            = 5,
    REASON_NOT_AUTHED               = 6,
    REASON_NOT_ASSOCED              = 7,
    REASON_ASSOC_LEAVE              = 8,
    REASON_ASSOC_NOT_AUTHED         = 9,
    REASON_DISASSOC_PWRCAP_BAD      = 10,
    REASON_DISASSOC_SUPCHAN_BAD     = 11,
    REASON_IE_INVALID               = 13,
    REASON_MIC_FAILURE              = 14,
    REASON_4WAY_HANDSHAKE_TIMEOUT   = 15,
    REASON_GROUP_KEY_UPDATE_TIMEOUT = 16,
    REASON_IE_IN_4WAY_DIFFERS       = 17,
    REASON_GROUP_CIPHER_INVALID     = 18,
    REASON_PAIRWISE_CIPHER_INVALID  = 19,
    REASON_AKMP_INVALID             = 20,
    REASON_UNSUPP_RSN_IE_VERSION    = 21,
    REASON_INVALID_RSN_IE_CAP       = 22,
    REASON_802_1X_AUTH_FAILED       = 23,
    REASON_CIPHER_SUITE_REJECTED    = 24,

    REASON_BEACON_TIMEOUT           = 200,
    REASON_NO_AP_FOUND              = 201,
    REASON_AUTH_FAIL                = 202,
    REASON_ASSOC_FAIL               = 203,
    REASON_HANDSHAKE_TIMEOUT        = 204,
};

typedef struct {
    uint32 status;          
    struct bss_info *bss;   
} Event_StaMode_ScanDone_t;

typedef struct {
    uint8 ssid[32];         
    uint8 ssid_len;         
    uint8 bssid[6];         
    uint8 channel;          
} Event_StaMode_Connected_t;

typedef struct {
    uint8 ssid[32];         
    uint8 ssid_len;         
    uint8 bssid[6];         
    uint8 reason;           
} Event_StaMode_Disconnected_t;

typedef struct {
    uint8 old_mode;         
    uint8 new_mode;         
} Event_StaMode_AuthMode_Change_t;

typedef struct {
    struct ip_addr ip;      
    struct ip_addr mask;    
    struct ip_addr gw;      
} Event_StaMode_Got_IP_t;

typedef struct {
    uint8 mac[6];           
    uint8 aid;              
} Event_SoftAPMode_StaConnected_t;

typedef struct {
    uint8 mac[6];           
    uint8 aid;              
} Event_SoftAPMode_StaDisconnected_t;

typedef struct {
    int rssi;               
    uint8 mac[6];           
} Event_SoftAPMode_ProbeReqRecved_t;

typedef union {
    Event_StaMode_ScanDone_t            scan_done;          
    Event_StaMode_Connected_t           connected;          
    Event_StaMode_Disconnected_t        disconnected;       
    Event_StaMode_AuthMode_Change_t     auth_change;        
    Event_StaMode_Got_IP_t              got_ip;             
    Event_SoftAPMode_StaConnected_t     sta_connected;      
    Event_SoftAPMode_StaDisconnected_t  sta_disconnected;   
    Event_SoftAPMode_ProbeReqRecved_t   ap_probereqrecved;  
} Event_Info_u;

typedef struct _esp_event {
    SYSTEM_EVENT event_id;      
    Event_Info_u event_info;    
} System_Event_t;

typedef void (* wifi_event_handler_cb_t)(System_Event_t *event);

bool wifi_set_event_handler_cb(wifi_event_handler_cb_t cb);

typedef void (*freedom_outside_cb_t)(uint8 status);

sint32 wifi_register_send_pkt_freedom_cb(freedom_outside_cb_t cb);

void wifi_unregister_send_pkt_freedom_cb(void);

sint32 wifi_send_pkt_freedom(uint8 *buf, uint16 len, bool sys_seq);

sint32 wifi_rfid_locp_recv_open(void);

void wifi_rfid_locp_recv_close(void);

typedef void (*rfid_locp_cb_t)(uint8 *frm, int len, sint8 rssi);

sint32 wifi_register_rfid_locp_recv_cb(rfid_locp_cb_t cb);

void wifi_unregister_rfid_locp_recv_cb(void);

typedef enum {
    NONE_SLEEP_T    = 0,
    LIGHT_SLEEP_T,
    MODEM_SLEEP_T
} sleep_type;

bool wifi_set_sleep_type(sleep_type type);

sleep_type wifi_get_sleep_type(void);

void wifi_fpm_open(void);

void wifi_fpm_close(void);

void wifi_fpm_do_wakeup(void);

typedef void (*fpm_wakeup_cb)(void);

void wifi_fpm_set_wakeup_cb(fpm_wakeup_cb cb);

sint8 wifi_fpm_do_sleep(uint32 sleep_time_in_us);

void wifi_fpm_set_sleep_type(sleep_type type);

sleep_type wifi_fpm_get_sleep_type(void);

enum FIXED_RATE {
    PHY_RATE_48       = 0x8,
    PHY_RATE_24       = 0x9,
    PHY_RATE_12       = 0xA,
    PHY_RATE_6        = 0xB,
    PHY_RATE_54       = 0xC,
    PHY_RATE_36       = 0xD,
    PHY_RATE_18       = 0xE,
    PHY_RATE_9        = 0xF
};

#define FIXED_RATE_MASK_NONE    0x00
#define FIXED_RATE_MASK_STA     0x01
#define FIXED_RATE_MASK_AP      0x02
#define FIXED_RATE_MASK_ALL     0x03

sint32 wifi_set_user_fixed_rate(uint8 enable_mask, uint8 rate);

int wifi_get_user_fixed_rate(uint8 *enable_mask, uint8 *rate);

enum support_rate {
    RATE_11B5M  = 0,
    RATE_11B11M = 1,
    RATE_11B1M  = 2,
    RATE_11B2M  = 3,
    RATE_11G6M  = 4,
    RATE_11G12M = 5,
    RATE_11G24M = 6,
    RATE_11G48M = 7,
    RATE_11G54M = 8,
    RATE_11G9M  = 9,
    RATE_11G18M = 10,
    RATE_11G36M = 11
};

sint32 wifi_set_user_sup_rate(uint8 min, uint8 max);

enum RATE_11B_ID {
    RATE_11B_B11M   = 0,
    RATE_11B_B5M    = 1,
    RATE_11B_B2M    = 2,
    RATE_11B_B1M    = 3
};

enum RATE_11G_ID {
    RATE_11G_G54M   = 0,
    RATE_11G_G48M   = 1,
    RATE_11G_G36M   = 2,
    RATE_11G_G24M   = 3,
    RATE_11G_G18M   = 4,
    RATE_11G_G12M   = 5,
    RATE_11G_G9M    = 6,
    RATE_11G_G6M    = 7,
    RATE_11G_B5M    = 8,
    RATE_11G_B2M    = 9,
    RATE_11G_B1M    = 10
};

enum RATE_11N_ID {
    RATE_11N_MCS7S  = 0,
    RATE_11N_MCS7   = 1,
    RATE_11N_MCS6   = 2,
    RATE_11N_MCS5   = 3,
    RATE_11N_MCS4   = 4,
    RATE_11N_MCS3   = 5,
    RATE_11N_MCS2   = 6,
    RATE_11N_MCS1   = 7,
    RATE_11N_MCS0   = 8,
    RATE_11N_B5M    = 9,
    RATE_11N_B2M    = 10,
    RATE_11N_B1M    = 11
};

#define RC_LIMIT_11B        0
#define RC_LIMIT_11G        1
#define RC_LIMIT_11N        2
#define RC_LIMIT_P2P_11G    3
#define RC_LIMIT_P2P_11N    4
#define RC_LIMIT_NUM        5

#define LIMIT_RATE_MASK_NONE    0x00
#define LIMIT_RATE_MASK_STA     0x01
#define LIMIT_RATE_MASK_AP      0x02
#define LIMIT_RATE_MASK_ALL     0x03

bool wifi_set_user_rate_limit(uint8 mode, uint8 ifidx, uint8 max, uint8 min);

uint8 wifi_get_user_limit_rate_mask(void);

bool wifi_set_user_limit_rate_mask(uint8 enable_mask);

typedef enum {
    USER_IE_BEACON = 0,
    USER_IE_PROBE_REQ,
    USER_IE_PROBE_RESP,
    USER_IE_ASSOC_REQ,
    USER_IE_ASSOC_RESP,
    USER_IE_MAX
} user_ie_type;

typedef void (*user_ie_manufacturer_recv_cb_t)(user_ie_type type, const uint8 sa[6], const uint8 m_oui[3], uint8 *ie, uint8 ie_len, sint32 rssi);

bool wifi_set_user_ie(bool enable, uint8 *m_oui, user_ie_type type, uint8 *user_ie, uint8 len);

sint32 wifi_register_user_ie_manufacturer_recv_cb(user_ie_manufacturer_recv_cb_t cb);

void wifi_unregister_user_ie_manufacturer_recv_cb(void);

typedef void (* wifi_promiscuous_cb_t)(uint8 *buf, uint16 len);

void wifi_set_promiscuous_rx_cb(wifi_promiscuous_cb_t cb);

uint8 wifi_get_channel(void);

bool wifi_set_channel(uint8 channel);

bool wifi_promiscuous_set_mac(const uint8_t *address);

void wifi_promiscuous_enable(uint8 promiscuous);

#ifdef __cplusplus
}
#endif

#endif