csk_wifi.h

Go to the documentation of this file.

/*
 * SPDX-License-Identifier: Apache-2.0
 */
 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define CSK_WIFI_SSID_LEN       32
#define CSK_WIFI_BSSID_LEN      17
#define CSK_WIFI_PWD_LEN        64
 
#define CSK_WIFI_STATUS_STA_CONNECTED       0
#define CSK_WIFI_STATUS_STA_DISCONNECTED    2
#define CSK_WIFI_STATUS_STA_UNKNOWN         3
 
/* TODO: Add WIFI state machine transition diagram */
 
typedef enum {
    CSK_WIFI_AUTH_OPEN = 0,         /* Authenticate mode : open */
    CSK_WIFI_AUTH_WEP,              /* Authenticate mode : WEP */
    CSK_WIFI_AUTH_WPA_PSK,          /* Authenticate mode : WPA_PSK */
    CSK_WIFI_AUTH_WPA2_PSK,         /* Authenticate mode : WPA2_PSK */
    CSK_WIFI_AUTH_WPA_WPA2_PSK,     /* Authenticate mode : WPA_WPA2_PSK */
    CSK_WIFI_AUTH_WPA2_ENTERPRISE,  /* Authenticate mode : WPA2_ENTERPRISE */
    CSK_WIFI_AUTH_WPA3_PSK,         /* Authenticate mode : WPA3_PSK */
    CSK_WIFI_AUTH_WPA2_WPA3_PSK,    /* Authenticate mode : WPA2_WPA3_PSK */
    CSK_WIFI_AUTH_MAX ,             /* Authenticate mode : WAPI_PSK */
} csk_wifi_encryption_mode_t;
 
typedef enum {
        CSK_WIFI_BW_HT20 = 0,           /* Bandwidth is HT20(20M) */
        CSK_WIFI_BW_HT40,               /* Bandwidth is HT40(40M) */
} csk_wifi_bandwidth_t;
 
typedef struct {
    char ssid[CSK_WIFI_SSID_LEN+1];                 /* Target AP SSID */
    char pwd[CSK_WIFI_PWD_LEN+1];                   /* Target AP Password */
    char bssid[CSK_WIFI_BSSID_LEN+1];               /* Target AP bssid (MAC address) */
    uint8_t channel;                                /* Target AP channel */
    int rssi;                                       /* Target AP rssi */
    csk_wifi_encryption_mode_t encryption_mode;     /* Target AP encryption mode */
} csk_wifi_sta_config_t;
 
typedef struct {
    char ssid[CSK_WIFI_SSID_LEN+1];                 /* WiFi SoftAP SSID */
    char pwd[CSK_WIFI_PWD_LEN+1];                   /* WiFi SoftAP Password */
    csk_wifi_encryption_mode_t encryption_mode;     /* WiFi SoftAP encryption mode */
    csk_wifi_bandwidth_t bandwidth;                 /* WiFi SoftAP bandwidth */
    uint8_t channel;                                /* WiFi SoftAP channel */
    uint8_t max_connections;                        /* Maximum number of stations allowed to connect in */
    bool ssid_hidden;                               /* SSID hidden */
} csk_wifi_softap_config_t;
 
typedef struct {
    char ssid[CSK_WIFI_SSID_LEN+1];                 /* Neighboring AP SSID */
    char bssid[CSK_WIFI_BSSID_LEN+1];               /* Neighboring AP BSSID */
    int rssi;                                       /* Neighboring AP rssi */
    uint8_t channel;                                /* Neighboring AP channel */
    csk_wifi_encryption_mode_t encryption_mode;     /* Neighboring AP encryption mode */
} csk_wifi_scan_info_t;
 
typedef enum {
    CSK_WIFI_SUCCESS,                   /* WIFI operation successful */
    CSK_WIFI_ERR_STA_FAILED,            /* Unknown Station exception, will be raised in Station mode. TODO: remove it */
    CSK_WIFI_ERR_AP_FAILED,             /* Unknown SoftAP exception, will be raised in SoftAP mode. TODO: remove it */
    CSK_WIFI_ERR_AP_NOT_FOUND,          /* AP ssid not found, will be raised in Station mode */
    CSK_WIFI_ERR_INVALID_PASSWORD,      /* Invalid WIFI password, will be raised in Station mode */
    CSK_WIFI_ERR_SCAN_FAILED,           /* WiFi scan neighboring AP devices failed */
} csk_wifi_result_t;                    /* WIFI API result type */
 
typedef enum {
    CSK_WIFI_EVT_STA_CONNECTED =        BIT(0),     /* WIFI-Station connected event bit */
    CSK_WIFI_EVT_STA_DISCONNECTED =     BIT(1),     /* WIFI-Station disconnected event bit */
    CSK_WIFI_EVT_AP_STARTED =           BIT(2),     /* WIFI-SoftAP stared event bit */
    CSK_WIFI_EVT_AP_STOPPED =           BIT(3),     /* WIFI-SoftAP stopped event bit */
    CSK_WIFI_EVT_AP_STACONNECTED =      BIT(4),     /* WIFI-SoftAP station connected event bit */
    CSK_WIFI_EVT_AP_STADISCONNECTED =   BIT(5),     /* WIFI-SoftAP station disconnected event bit */
    CSK_WIFI_EVT_SCAN_DONE =            BIT(6),     /* WIFI-SoftAP scan done event bit */
    CSK_WIFI_EVT_STA_CONNECTING =       BIT(7),     /* WIFI-Station connecting event bit */
} csk_wifi_event_t;
 
typedef void(*wifi_event_cb_t) (csk_wifi_event_t event, void *event_data, uint32_t event_data_len, void *arg);
 
typedef struct csk_wifi_event_cb {
    sys_snode_t node;
 
    wifi_event_cb_t handler;
 
    uint32_t events;
 
    void *event_data;
 
    uint32_t event_data_len;
 
    void *arg;
} csk_wifi_event_cb_t;
 
int csk_wifi_init(void);
 
int csk_wifi_deinit(void);
 
int csk_wifi_add_callback(csk_wifi_event_cb_t *wifi_event_cb);
 
int csk_wifi_remove_callback(csk_wifi_event_cb_t *wifi_event_cb);
 
int csk_wifi_scan_ap(csk_wifi_scan_info_t **ap_info, csk_wifi_result_t *result, k_timeout_t timeout);
 
#ifdef CONFIG_CSK_WIFI_STATION
int csk_wifi_sta_connect(csk_wifi_sta_config_t *sta_config, csk_wifi_result_t *result, k_timeout_t timeout);
 
int csk_wifi_sta_disconnect(csk_wifi_result_t *result, k_timeout_t timeout);
 
int csk_wifi_sta_get_status(void);
 
#endif
 
#ifdef CONFIG_CSK_WIFI_SOFTAP
int csk_wifi_ap_start(const csk_wifi_softap_config_t *ap_config, csk_wifi_result_t *result, k_timeout_t timeout);
 
int csk_wifi_ap_stop(csk_wifi_result_t *result, k_timeout_t timeout);
#endif
 
#ifdef __cplusplus
}
#endif