rt-thread_esp-hosted/host/control_lib/include/ctrl_api.h

/*
 * Espressif Systems Wireless LAN device driver
 *
 * Copyright (C) 2015-2022 Espressif Systems (Shanghai) PTE LTD
 * SPDX-License-Identifier: GPL-2.0-only OR Apache-2.0
 */

/** prevent recursive inclusion **/
#ifndef __CTRL_API_H
#define __CTRL_API_H

#include <stdbool.h>
#include "esp_hosted_config.pb-c.h"

#define SUCCESS                              0
#define FAILURE                              -1

#define MAC_SIZE_BYTES                       6
#define SSID_LENGTH                          33
#define MAX_MAC_STR_SIZE                     18
#define BSSID_STR_SIZE                       MAX_MAC_STR_SIZE
#define PASSWORD_LENGTH                      65
#define STATUS_LENGTH                        14
#define VENDOR_OUI_BUF                       3

#define CALLBACK_SET_SUCCESS                 0
#define CALLBACK_AVAILABLE                   0
#define CALLBACK_NOT_REGISTERED              -1
#define MSG_ID_OUT_OF_ORDER                  -2

/* If request is already being served and
 * another request is pending, time period for
 * which new request will wait in seconds
 * */
#define WAIT_TIME_B2B_CTRL_REQ               5
#define DEFAULT_CTRL_RESP_TIMEOUT            30
#define DEFAULT_CTRL_RESP_AP_SCAN_TIMEOUT    (60*3)
#define DEFAULT_CTRL_RESP_CONNECT_AP_TIMEOUT (15*3)

#ifndef MAC2STR
#define MAC2STR(a) (a)[0], (a)[1], (a)[2], (a)[3], (a)[4], (a)[5]
#define MACSTR "%02x:%02x:%02x:%02x:%02x:%02x"
#endif

#define SUCCESS_STR                          "success"
#define FAILURE_STR                          "failure"
#define NOT_CONNECTED_STR                    "not_connected"

/*---- Control structures ----*/

enum {
    CTRL_ERR_NOT_CONNECTED = 1,
    CTRL_ERR_NO_AP_FOUND,
    CTRL_ERR_INVALID_PASSWORD,
    CTRL_ERR_INVALID_ARGUMENT,
    CTRL_ERR_OUT_OF_RANGE,
    CTRL_ERR_MEMORY_FAILURE,
    CTRL_ERR_UNSUPPORTED_MSG,
    CTRL_ERR_INCORRECT_ARG,
    CTRL_ERR_PROTOBUF_ENCODE,
    CTRL_ERR_PROTOBUF_DECODE,
    CTRL_ERR_SET_ASYNC_CB,
    CTRL_ERR_TRANSPORT_SEND,
    CTRL_ERR_REQUEST_TIMEOUT,
    CTRL_ERR_REQ_IN_PROG,
    OUT_OF_RANGE
};


typedef enum {

    CTRL_MSGTYPE_INVALID = CTRL_MSG_TYPE__MsgType_Invalid,
    CTRL_REQ = CTRL_MSG_TYPE__Req,
    CTRL_RESP = CTRL_MSG_TYPE__Resp,
    CTRL_EVENT = CTRL_MSG_TYPE__Event,
    CTRL_MSGTYPE_MAX = CTRL_MSG_TYPE__MsgType_Max,

} AppMsgType_e;

typedef enum {

    CTRL_MSGID_INVALID = CTRL_MSG_ID__MsgId_Invalid,
    /*
     ** Request Msgs *
     */
    CTRL_REQ_BASE                      = CTRL_MSG_ID__Req_Base,
    CTRL_REQ_GET_MAC_ADDR              = CTRL_MSG_ID__Req_GetMACAddress, //0x65
    CTRL_REQ_SET_MAC_ADDR              = CTRL_MSG_ID__Req_SetMacAddress, //0x66
    CTRL_REQ_GET_WIFI_MODE             = CTRL_MSG_ID__Req_GetWifiMode,   //0x67
    CTRL_REQ_SET_WIFI_MODE             = CTRL_MSG_ID__Req_SetWifiMode,   //0x68

    CTRL_REQ_GET_AP_SCAN_LIST          = CTRL_MSG_ID__Req_GetAPScanList, //0x69
    CTRL_REQ_GET_AP_CONFIG             = CTRL_MSG_ID__Req_GetAPConfig,   //0x6a
    CTRL_REQ_CONNECT_AP                = CTRL_MSG_ID__Req_ConnectAP,     //0x6b
    CTRL_REQ_DISCONNECT_AP             = CTRL_MSG_ID__Req_DisconnectAP,  //0x6c

    CTRL_REQ_GET_SOFTAP_CONFIG         = CTRL_MSG_ID__Req_GetSoftAPConfig,            //0x6d
    CTRL_REQ_SET_SOFTAP_VND_IE         = CTRL_MSG_ID__Req_SetSoftAPVendorSpecificIE,  //0x6e
    CTRL_REQ_START_SOFTAP              = CTRL_MSG_ID__Req_StartSoftAP,                //0x6f
    CTRL_REQ_GET_SOFTAP_CONN_STA_LIST  = CTRL_MSG_ID__Req_GetSoftAPConnectedSTAList,  //0x70
    CTRL_REQ_STOP_SOFTAP               = CTRL_MSG_ID__Req_StopSoftAP,                 //0x71

    CTRL_REQ_SET_PS_MODE               = CTRL_MSG_ID__Req_SetPowerSaveMode,   //0x72
    CTRL_REQ_GET_PS_MODE               = CTRL_MSG_ID__Req_GetPowerSaveMode,   //0x73

    CTRL_REQ_OTA_BEGIN                 = CTRL_MSG_ID__Req_OTABegin,           //0x74
    CTRL_REQ_OTA_WRITE                 = CTRL_MSG_ID__Req_OTAWrite,           //0x75
    CTRL_REQ_OTA_END                   = CTRL_MSG_ID__Req_OTAEnd,             //0x76

    CTRL_REQ_SET_WIFI_MAX_TX_POWER     = CTRL_MSG_ID__Req_SetWifiMaxTxPower,  //0x77
    CTRL_REQ_GET_WIFI_CURR_TX_POWER    = CTRL_MSG_ID__Req_GetWifiCurrTxPower, //0x78

    CTRL_REQ_CONFIG_HEARTBEAT          = CTRL_MSG_ID__Req_ConfigHeartbeat,    //0x79
    CTRL_REQ_ENABLE_DISABLE            = CTRL_MSG_ID__Req_EnableDisable,      //0x7a

    CTRL_REQ_GET_FW_VERSION            = CTRL_MSG_ID__Req_GetFwVersion,       //0x7b
    /*
     * Add new control path command response before Req_Max
     * and update Req_Max
     */
    CTRL_REQ_MAX = CTRL_MSG_ID__Req_Max,
    /*
     ** Response Msgs *
     */
    CTRL_RESP_BASE                     = CTRL_MSG_ID__Resp_Base,
    CTRL_RESP_GET_MAC_ADDR             = CTRL_MSG_ID__Resp_GetMACAddress,  //0x65 -> 0xc9
    CTRL_RESP_SET_MAC_ADDRESS          = CTRL_MSG_ID__Resp_SetMacAddress,  //0x66 -> 0xca
    CTRL_RESP_GET_WIFI_MODE            = CTRL_MSG_ID__Resp_GetWifiMode,    //0x67 -> 0xcb
    CTRL_RESP_SET_WIFI_MODE            = CTRL_MSG_ID__Resp_SetWifiMode,    //0x68 -> 0xcc

    CTRL_RESP_GET_AP_SCAN_LIST         = CTRL_MSG_ID__Resp_GetAPScanList,  //0x69 -> 0xcd
    CTRL_RESP_GET_AP_CONFIG            = CTRL_MSG_ID__Resp_GetAPConfig,    //0x6a -> 0xce
    CTRL_RESP_CONNECT_AP               = CTRL_MSG_ID__Resp_ConnectAP,      //0x6b -> 0xdf
    CTRL_RESP_DISCONNECT_AP            = CTRL_MSG_ID__Resp_DisconnectAP,   //0x6c -> 0xd0

    CTRL_RESP_GET_SOFTAP_CONFIG        = CTRL_MSG_ID__Resp_GetSoftAPConfig,           //0x6d -> 0xd1
    CTRL_RESP_SET_SOFTAP_VND_IE        = CTRL_MSG_ID__Resp_SetSoftAPVendorSpecificIE, //0x6e -> 0xd2
    CTRL_RESP_START_SOFTAP             = CTRL_MSG_ID__Resp_StartSoftAP,               //0x6f -> 0xd3
    CTRL_RESP_GET_SOFTAP_CONN_STA_LIST = CTRL_MSG_ID__Resp_GetSoftAPConnectedSTAList, //0x70 -> 0xd4
    CTRL_RESP_STOP_SOFTAP              = CTRL_MSG_ID__Resp_StopSoftAP,                //0x71 -> 0xd5

    CTRL_RESP_SET_PS_MODE              = CTRL_MSG_ID__Resp_SetPowerSaveMode, //0x72 -> 0xd6
    CTRL_RESP_GET_PS_MODE              = CTRL_MSG_ID__Resp_GetPowerSaveMode, //0x73 -> 0xd7

    CTRL_RESP_OTA_BEGIN                = CTRL_MSG_ID__Resp_OTABegin,         //0x74 -> 0xd8
    CTRL_RESP_OTA_WRITE                = CTRL_MSG_ID__Resp_OTAWrite,         //0x75 -> 0xd9
    CTRL_RESP_OTA_END                  = CTRL_MSG_ID__Resp_OTAEnd,           //0x76 -> 0xda

    CTRL_RESP_SET_WIFI_MAX_TX_POWER     = CTRL_MSG_ID__Resp_SetWifiMaxTxPower,  //0x77 -> 0xdb
    CTRL_RESP_GET_WIFI_CURR_TX_POWER    = CTRL_MSG_ID__Resp_GetWifiCurrTxPower, //0x78 -> 0xdc

    CTRL_RESP_CONFIG_HEARTBEAT          = CTRL_MSG_ID__Resp_ConfigHeartbeat,    //0x79 -> 0xdd
    CTRL_RESP_ENABLE_DISABLE            = CTRL_MSG_ID__Resp_EnableDisable,      //0x7a -> 0xde

    CTRL_RESP_GET_FW_VERSION            = CTRL_MSG_ID__Resp_GetFwVersion,       //0x7b -> 0xdf
    /*
     * Add new control path comm       and response before Resp_Max
     * and update Resp_Max
     */
    CTRL_RESP_MAX = CTRL_MSG_ID__Resp_Max,
    /*
     ** Events
     */
    CTRL_EVENT_BASE            = CTRL_MSG_ID__Event_Base,
    CTRL_EVENT_ESP_INIT        = CTRL_MSG_ID__Event_ESPInit,
    CTRL_EVENT_HEARTBEAT       = CTRL_MSG_ID__Event_Heartbeat,
    CTRL_EVENT_STATION_DISCONNECT_FROM_AP =
        CTRL_MSG_ID__Event_StationDisconnectFromAP,
    CTRL_EVENT_STATION_DISCONNECT_FROM_ESP_SOFTAP =
        CTRL_MSG_ID__Event_StationDisconnectFromESPSoftAP,
    CTRL_EVENT_STATION_CONNECTED_TO_AP =
        CTRL_MSG_ID__Event_StationConnectedToAP,
    CTRL_EVENT_STATION_CONNECTED_TO_ESP_SOFTAP =
        CTRL_MSG_ID__Event_StationConnectedToESPSoftAP,
    /*
     * Add new control path command notification before Event_Max
     * and update Event_Max
     */
    CTRL_EVENT_MAX = CTRL_MSG_ID__Event_Max,
} AppMsgId_e;

typedef enum {
    WIFI_MODE_NONE = CTRL__WIFI_MODE__NONE,
    WIFI_MODE_STA = CTRL__WIFI_MODE__STA,
    WIFI_MODE_AP = CTRL__WIFI_MODE__AP,
    WIFI_MODE_APSTA = CTRL__WIFI_MODE__APSTA,
    WIFI_MODE_MAX
} wifi_mode_e;

typedef enum {
    WIFI_AUTH_OPEN = CTRL__WIFI_SEC_PROT__Open,
    WIFI_AUTH_WEP = CTRL__WIFI_SEC_PROT__WEP,
    WIFI_AUTH_WPA_PSK = CTRL__WIFI_SEC_PROT__WPA_PSK,
    WIFI_AUTH_WPA2_PSK = CTRL__WIFI_SEC_PROT__WPA2_PSK,
    WIFI_AUTH_WPA_WPA2_PSK = CTRL__WIFI_SEC_PROT__WPA_WPA2_PSK,
    WIFI_AUTH_WPA2_ENTERPRISE = CTRL__WIFI_SEC_PROT__WPA2_ENTERPRISE,
    WIFI_AUTH_WPA3_PSK = CTRL__WIFI_SEC_PROT__WPA3_PSK,
    WIFI_AUTH_WPA2_WPA3_PSK = CTRL__WIFI_SEC_PROT__WPA2_WPA3_PSK,
    WIFI_AUTH_WAPI_PSK = CTRL__WIFI_SEC_PROT__WAPI_PSK,
    WIFI_AUTH_OWE = CTRL__WIFI_SEC_PROT__OWE,
    WIFI_AUTH_WPA3_ENT_192 = CTRL__WIFI_SEC_PROT__WPA3_ENT_192,
    WIFI_AUTH_WPA3_EXT_PSK = CTRL__WIFI_SEC_PROT__WPA3_EXT_PSK,
    WIFI_AUTH_WPA3_EXT_PSK_MIXED_MODE = CTRL__WIFI_SEC_PROT__WPA3_EXT_PSK_MIXED_MODE,
    WIFI_AUTH_DPP = CTRL__WIFI_SEC_PROT__DPP,
    WIFI_AUTH_MAX,
} wifi_auth_mode_e;

typedef enum {
    WIFI_BW_HT20 = CTRL__WIFI_BW__HT20,
    WIFI_BW_HT40 = CTRL__WIFI_BW__HT40,
} wifi_bandwidth_e;

typedef enum {
    WIFI_PS_MIN_MODEM = CTRL__WIFI_POWER_SAVE__MIN_MODEM,
    WIFI_PS_MAX_MODEM = CTRL__WIFI_POWER_SAVE__MAX_MODEM,
    WIFI_PS_INVALID,
} wifi_ps_type_e;

typedef enum {
    WIFI_VND_IE_TYPE_BEACON      = CTRL__VENDOR_IETYPE__Beacon,
    WIFI_VND_IE_TYPE_PROBE_REQ   = CTRL__VENDOR_IETYPE__Probe_req,
    WIFI_VND_IE_TYPE_PROBE_RESP  = CTRL__VENDOR_IETYPE__Probe_resp,
    WIFI_VND_IE_TYPE_ASSOC_REQ   = CTRL__VENDOR_IETYPE__Assoc_req,
    WIFI_VND_IE_TYPE_ASSOC_RESP  = CTRL__VENDOR_IETYPE__Assoc_resp,
} wifi_vendor_ie_type_e;

typedef enum {
    WIFI_VND_IE_ID_0 = CTRL__VENDOR_IEID__ID_0,
    WIFI_VND_IE_ID_1 = CTRL__VENDOR_IEID__ID_1,
} wifi_vendor_ie_id_e;


enum hosted_features_t {
    HOSTED_WIFI = HOSTED_FEATURE__Hosted_Wifi,
    HOSTED_BT = HOSTED_FEATURE__Hosted_Bluetooth,
};

typedef struct {
    /* Should be set to WIFI_VENDOR_IE_ELEMENT_ID (0xDD) */
    uint8_t element_id;
    /* Len of all bytes in the element data
     * following this field. Minimum 4 */
    uint8_t length;
    /* Vendor identifier (OUI) */
    uint8_t vendor_oui[VENDOR_OUI_BUF];
    /* Vendor-specific OUI type */
    uint8_t vendor_oui_type;
    /*length of payload field*/
    uint16_t payload_len;
    /* Payload. Length is equal to value in 'length' field, minus 4 */
    uint8_t* payload;

} vendor_ie_data_t;

typedef struct {
    uint8_t ssid[SSID_LENGTH];
    uint8_t bssid[BSSID_STR_SIZE];
    int rssi;
    int channel;
    int encryption_mode;
    wifi_bandwidth_e bandwidth;
    struct {
    uint32_t phy_11b: 1;                  /**< Bit: 0 flag to identify if 11b mode is enabled or not */
    uint32_t phy_11g: 1;                  /**< Bit: 1 flag to identify if 11g mode is enabled or not */
    uint32_t phy_11n: 1;                  /**< Bit: 2 flag to identify if 11n mode is enabled or not */
    uint32_t phy_lr: 1;                   /**< Bit: 3 flag to identify if low rate is enabled or not */
    uint32_t phy_11a: 1;                  /**< Bit: 4 flag to identify if 11ax mode is enabled or not */
    uint32_t phy_11ac: 1;                 /**< Bit: 5 flag to identify if 11ax mode is enabled or not */
    uint32_t phy_11ax: 1;                 /**< Bit: 6 flag to identify if 11ax mode is enabled or not */
    uint32_t wps: 1;                      /**< Bit: 7 flag to identify if WPS is supported or not */
    uint32_t ftm_responder: 1;            /**< Bit: 8 flag to identify if FTM is supported in responder mode */
    uint32_t ftm_initiator: 1;            /**< Bit: 9 flag to identify if FTM is supported in initiator mode */
    uint32_t reserved: 22;                /**< Bit: 10..31 reserved */
  } support;
} wifi_scanlist_t;

typedef struct {
    uint8_t bssid[BSSID_STR_SIZE];
    int rssi;
} wifi_connected_stations_list_t;

typedef struct {
    int mode;
    char mac[MAX_MAC_STR_SIZE];
} wifi_mac_t;

typedef struct {
    int mode;
} wifi_mode_t;

typedef struct {
    uint8_t ssid[SSID_LENGTH];
    uint8_t pwd[PASSWORD_LENGTH];
    uint8_t bssid[BSSID_STR_SIZE];
    bool is_wpa3_supported;
    int rssi;
    int channel;
    int encryption_mode;
    uint16_t listen_interval;
    char status[STATUS_LENGTH];
    char out_mac[MAX_MAC_STR_SIZE];
    int band_mode;
} wifi_ap_config_t;

typedef struct {
    uint8_t ssid[SSID_LENGTH];
    uint8_t pwd[PASSWORD_LENGTH];
    int channel;
    int encryption_mode;
    int max_connections;
    bool ssid_hidden;
    wifi_bandwidth_e bandwidth;
    char out_mac[MAX_MAC_STR_SIZE];
    int band_mode;
} softap_config_t;

typedef struct {
    int count;
    /* dynamic size */
    wifi_scanlist_t *out_list;
} wifi_ap_scan_list_t;

typedef struct {
    int count;
    /* dynamic list*/
    wifi_connected_stations_list_t *out_list;
} wifi_softap_conn_sta_list_t;

typedef struct {
    int ps_mode;
} wifi_power_save_t;

typedef struct {
    bool enable;
    wifi_vendor_ie_type_e type;
    wifi_vendor_ie_id_e idx;
    vendor_ie_data_t vnd_ie;
} wifi_softap_vendor_ie_t;

typedef struct {
    uint8_t *ota_data;
    uint32_t ota_data_len;
} ota_write_t;

typedef struct {
    int power;
} wifi_tx_power_t;

typedef struct {
    char project_name[3];
    uint8_t major_1;
    uint8_t major_2;
    uint8_t minor;
    uint8_t revision_patch_1;
    uint8_t revision_patch_2;
} fw_version_t;

typedef struct {
    HostedFeature feature;
    uint8_t enable;
} feature_enable_disable_t;

typedef struct {
    /* event */
    uint32_t hb_num;
    /* Req */
    uint8_t enable;
    uint32_t duration;
} event_heartbeat_t;

typedef struct {
    uint8_t ssid[SSID_LENGTH];
    uint32_t ssid_len;
    uint8_t bssid[BSSID_STR_SIZE];
    int channel;
    int authmode;
    int aid;
} event_sta_conn_t;

typedef struct {
    uint8_t ssid[SSID_LENGTH];
    uint32_t ssid_len;
    uint8_t bssid[BSSID_STR_SIZE];
    uint32_t reason;
    int32_t rssi;
} event_sta_disconn_t;

typedef struct {
    uint8_t mac[MAX_MAC_STR_SIZE];
    int32_t aid;
    int32_t is_mesh_child;
} event_softap_sta_conn_t;

typedef struct {
    uint8_t mac[MAX_MAC_STR_SIZE];
    int32_t aid;
    int32_t is_mesh_child;
    uint32_t reason;
} event_softap_sta_disconn_t;

typedef struct Ctrl_cmd_t {
    /* msg type could be 1. req 2. resp 3. notification */
    uint8_t msg_type;

    /* control path protobuf msg number */
    uint16_t msg_id;

    /* uid of request / response */
    int32_t uid;

    /* statusof response or notification */
    int32_t resp_event_status;

    union {
        wifi_mac_t                  wifi_mac;
        wifi_mode_t                 wifi_mode;

        wifi_ap_scan_list_t         wifi_ap_scan;
        wifi_ap_config_t            wifi_ap_config;

        softap_config_t             wifi_softap_config;
        wifi_softap_vendor_ie_t     wifi_softap_vendor_ie;
        wifi_softap_conn_sta_list_t wifi_softap_con_sta;

        wifi_power_save_t           wifi_ps;

        ota_write_t                 ota_write;

        feature_enable_disable_t    feat_ena_disable;

        wifi_tx_power_t             wifi_tx_power;

        fw_version_t                fw_version;

        event_heartbeat_t           e_heartbeat;

        event_sta_conn_t            e_sta_conn;
        event_sta_disconn_t         e_sta_disconn;
        event_softap_sta_conn_t     e_softap_sta_conn;
        event_softap_sta_disconn_t  e_softap_sta_disconn;
    }u;

    /* By default this callback is set to NULL.
     * When this callback is set by app while triggering request,
     * it will be automatically called asynchronously
     * by hosted control lib on receiving control response
     * in this case app will not be waiting for response.
     *
     * Whereas, when this is not set i.e. is NULL, it is understood
     * as synchronous response, and app after sending request,
     * will wait till getting a response
     */
    int (*ctrl_resp_cb)(struct Ctrl_cmd_t *data);

    /* Wait for timeout duration, if response not received,
     * it will send timeout response.
     * Default value for this time out is DEFAULT_CTRL_RESP_TIMEOUT */
    int cmd_timeout_sec;

    /* assign the data pointer to free by lower layer.
     * Ignored if assigned as NULL */
    void *free_buffer_handle;

    /* free handle to be registered
     * Ignored if assigned as NULL */
    void (*free_buffer_func)(void *free_buffer_handle);
} ctrl_cmd_t;


/* resp callback */
typedef int (*ctrl_resp_cb_t) (ctrl_cmd_t * resp);

/* event callback */
typedef int (*ctrl_event_cb_t) (ctrl_cmd_t * event);


/*---- Control API Function ----*/

/* This file contains hosted control library exposed APIs.
 * For detailed documentation, Please refer `../../../docs/common/ctrl_apis.md`
 *
 * As important note, application using these APIs, should clean
 *   1. allocated buffer within library are saved in `app_resp->free_buffer_handle`
 *   Please use `app_resp->free_buffer_func` for freeing them.
 *   2. Response `ctrl_cmd_t *app_resp` is also allocated from library,
 *   need to free using hosted_free() function.
 **/

/* Set control event callback
 *
 * when user sets event callback, user provided function pointer
 * will be registered with user function
 * If user does not register event callback,
 * events received from ESP32 will be dropped
 *
 * Inputs:
 * > event - Control Event ID from `AppMsgId_e`
 * > event_cb - NULL - resets event callback
 *              Function pointer - Registers event callback
 * Returns:
 * > MSG_ID_OUT_OF_ORDER - If event is not registered with hosted control lib
 * > CALLBACK_SET_SUCCESS - Callback is set successful
 **/
int set_event_callback(int event, ctrl_resp_cb_t event_cb);

/* Reset control event callback
 *
 * when user sets event callback, user provided function pointer
 * will be registered with user function
 * If user does not register event callback,
 * events received from ESP32 will be dropped
 *
 * Inputs:
 * > event - Control Event ID from `AppMsgId_e`
 *
 * Returns:
 * > MSG_ID_OUT_OF_ORDER - If event is not registered with hosted control lib
 * > CALLBACK_SET_SUCCESS - Callback is set successful
 **/
int reset_event_callback(int event);


/* Initialize hosted control library
 *
 * This is first step for application while using control path
 * This will allocate and instantiate hosted control library
 *
 * Returns:
 * > SUCCESS - 0
 * > FAILURE - -1
 **/
int init_hosted_control_lib(void);

/* De-initialize hosted control library
 *
 * This is last step for application while using control path
 * This will deallocate and cleanup hosted control library
 *
 * Returns:
 * > SUCCESS - 0
 * > FAILURE - -1
 **/
int deinit_hosted_control_lib(void);

/* Get the MAC address of station or softAP interface of ESP32 */
ctrl_cmd_t * wifi_get_mac(ctrl_cmd_t req);

/* Set MAC address of ESP32 interface for given wifi mode */
ctrl_cmd_t * wifi_set_mac(ctrl_cmd_t req);

/* Get Wi-Fi mode of ESP32 */
ctrl_cmd_t * wifi_get_mode(ctrl_cmd_t req);

/* Set the Wi-Fi mode of ESP32 */
ctrl_cmd_t * wifi_set_mode(ctrl_cmd_t req);

/* Set Wi-Fi power save mode of ESP32 */
ctrl_cmd_t * wifi_set_power_save_mode(ctrl_cmd_t req);

/* Get the Wi-Fi power save mode of ESP32 */
ctrl_cmd_t * wifi_get_power_save_mode(ctrl_cmd_t req);

/* Get list of available neighboring APs of ESP32 */
ctrl_cmd_t * wifi_ap_scan_list(ctrl_cmd_t req);

/* Get the AP config to which ESP32 station is connected */
ctrl_cmd_t * wifi_get_ap_config(ctrl_cmd_t req);

/* Set the AP config to which ESP32 station should connect to */
ctrl_cmd_t * wifi_connect_ap(ctrl_cmd_t req);

/* Disconnect ESP32 station from AP */
ctrl_cmd_t * wifi_disconnect_ap(ctrl_cmd_t req);

/* Set configuration of ESP32 softAP and start broadcasting */
ctrl_cmd_t * wifi_start_softap(ctrl_cmd_t req);

/* Get configuration of ESP32 softAP */
ctrl_cmd_t * wifi_get_softap_config(ctrl_cmd_t req);

/* Stop ESP32 softAP */
ctrl_cmd_t * wifi_stop_softap(ctrl_cmd_t req);

/* Get list of connected stations to ESP32 softAP */
ctrl_cmd_t * wifi_get_softap_connected_station_list(ctrl_cmd_t req);

/* Function set 802.11 Vendor-Specific Information Element.
 * It needs to get called before starting of ESP32 softAP */
ctrl_cmd_t * wifi_set_vendor_specific_ie(ctrl_cmd_t req);

/* Sets maximum WiFi transmitting power at ESP32 */
ctrl_cmd_t * wifi_set_max_tx_power(ctrl_cmd_t req);

/* Gets current WiFi transmiting power at ESP32 */
ctrl_cmd_t * wifi_get_curr_tx_power(ctrl_cmd_t req);

/* Configure heartbeat event. Be default heartbeat is not enabled.
 * To enable heartbeats, user need to use this API in addition
 * to setting event callback for heartbeat event */
ctrl_cmd_t * config_heartbeat(ctrl_cmd_t req);

/* Performs an OTA begin operation for ESP32 which erases and
 * prepares existing flash partition for new flash writing */
ctrl_cmd_t * ota_begin(ctrl_cmd_t req);

/* Performs an OTA write operation for ESP32, It writes bytes from `ota_data`
 * buffer with `ota_data_len` number of bytes to OTA partition in flash. Number
 * of bytes can be small than size of complete binary to be flashed. In that
 * case, this caller is expected to repeatedly call this function till
 * total size written equals size of complete binary */
ctrl_cmd_t * ota_write(ctrl_cmd_t req);

/* Performs an OTA end operation for ESP32, It validates written OTA image,
 * sets newly written OTA partition as boot partition for next boot,
 * Creates timer which reset ESP32 after 5 sec */
ctrl_cmd_t * ota_end(ctrl_cmd_t req);

/* Enable or disable specific feautures from hosted_features_t */
ctrl_cmd_t * feature_config(ctrl_cmd_t req);

/* Get FW Version */
ctrl_cmd_t * get_fw_version(ctrl_cmd_t req);

/* Get the interface up for interface `iface` */
int interface_up(int sockfd, char* iface);

/* Get the interface down for interface `iface` */
int interface_down(int sockfd, char* iface);

/* Set ethernet interface MAC address `mac` to interface `iface` */
int set_hw_addr(int sockfd, char* iface, char* mac);

/* Create an endpoint for communication */
int create_socket(int domain, int type, int protocol, int *sock);

/* Close an endpoint of the communication */
int close_socket(int sock);

#endif