mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
3d85e81be2
1. Update documentation for WPA3 Enterprise and WPA3 Enterprise 192-bit mode 2. Update documentation for WPA3 OWE and OWE transition mode 3. Update documentation related to SAE PK, SAE PWE and Transition Disable 4. Update documnetation for wifi connect API 5. Fix config paramter information for wifi scan start 6. Fix documentation related to scan threshold config setting 7. Replace ESP_ERR_WIFI_ARG error code as ESP_ERR_INVALID_ARG 8. Update documentation for 802.11R Fast transition 9. Fix sta connecting with wpa security in enterprise mode
306 lines
8.3 KiB
C
306 lines
8.3 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2017-2021 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#ifndef __ESP_MESH_INTERNAL_H__
|
|
#define __ESP_MESH_INTERNAL_H__
|
|
|
|
#include "esp_err.h"
|
|
#include "esp_mesh.h"
|
|
#include "esp_wifi.h"
|
|
#include "esp_wifi_types.h"
|
|
#include "esp_private/wifi.h"
|
|
#include "esp_wifi_crypto_types.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*******************************************************
|
|
* Constants
|
|
*******************************************************/
|
|
|
|
/*******************************************************
|
|
* Structures
|
|
*******************************************************/
|
|
typedef struct {
|
|
int scan; /**< minimum scan times before being a root, default:10 */
|
|
int vote; /**< max vote times in self-healing, default:1000 */
|
|
int fail; /**< parent selection fail times, if the scan times reach this value,
|
|
device will disconnect with associated children and join self-healing. default:60 */
|
|
int monitor_ie; /**< acceptable times of parent networking IE change before update its own networking IE. default:3 */
|
|
} mesh_attempts_t;
|
|
|
|
typedef struct {
|
|
int duration_ms; /* parent weak RSSI monitor duration, if the RSSI continues to be weak during this duration_ms,
|
|
device will search for a new parent. */
|
|
int cnx_rssi; /* RSSI threshold for keeping a good connection with parent.
|
|
If set a value greater than -120 dBm, a timer will be armed to monitor parent RSSI at a period time of duration_ms. */
|
|
int select_rssi; /* RSSI threshold for parent selection. It should be a value greater than switch_rssi. */
|
|
int switch_rssi; /* Disassociate with current parent and switch to a new parent when the RSSI is greater than this set threshold. */
|
|
int backoff_rssi; /* RSSI threshold for connecting to the root */
|
|
} mesh_switch_parent_t;
|
|
|
|
typedef struct {
|
|
int high;
|
|
int medium;
|
|
int low;
|
|
} mesh_rssi_threshold_t;
|
|
|
|
/**
|
|
* @brief Mesh networking IE
|
|
*/
|
|
typedef struct {
|
|
/**< mesh networking IE head */
|
|
uint8_t eid; /**< element ID */
|
|
uint8_t len; /**< element length */
|
|
uint8_t oui[3]; /**< organization identifier */
|
|
/**< mesh networking IE content */
|
|
uint8_t type; /** ESP defined IE type */
|
|
uint8_t encrypted : 1; /**< whether mesh networking IE is encrypted */
|
|
uint8_t version : 7; /**< mesh networking IE version */
|
|
/**< content */
|
|
uint8_t mesh_type; /**< mesh device type */
|
|
uint8_t mesh_id[6]; /**< mesh ID */
|
|
uint8_t layer_cap; /**< max layer */
|
|
uint8_t layer; /**< current layer */
|
|
uint8_t assoc_cap; /**< max connections of mesh AP */
|
|
uint8_t assoc; /**< current connections */
|
|
uint8_t leaf_cap; /**< leaf capacity */
|
|
uint8_t leaf_assoc; /**< the number of current connected leaf */
|
|
uint16_t root_cap; /**< root capacity */
|
|
uint16_t self_cap; /**< self capacity */
|
|
uint16_t layer2_cap; /**< layer2 capacity */
|
|
uint16_t scan_ap_num; /**< the number of scanning APs */
|
|
int8_t rssi; /**< RSSI of the parent */
|
|
int8_t router_rssi; /**< RSSI of the router */
|
|
uint8_t flag; /**< flag of networking */
|
|
uint8_t rc_addr[6]; /**< root address */
|
|
int8_t rc_rssi; /**< root RSSI */
|
|
uint8_t vote_addr[6]; /**< voter address */
|
|
int8_t vote_rssi; /**< vote RSSI of the router */
|
|
uint8_t vote_ttl; /**< vote ttl */
|
|
uint16_t votes; /**< votes */
|
|
uint16_t my_votes; /**< my votes */
|
|
uint8_t reason; /**< reason */
|
|
uint8_t child[6]; /**< child address */
|
|
uint8_t toDS; /**< toDS state */
|
|
} __attribute__((packed)) mesh_assoc_t;
|
|
|
|
typedef struct {
|
|
uint16_t layer_cap;
|
|
uint16_t layer;
|
|
} mesh_chain_layer_t;
|
|
|
|
typedef struct {
|
|
mesh_assoc_t tree;
|
|
mesh_chain_layer_t chain;
|
|
} __attribute__((packed)) mesh_chain_assoc_t;
|
|
|
|
/* mesh max connections */
|
|
#define MESH_MAX_CONNECTIONS (10)
|
|
|
|
/**
|
|
* @brief Mesh PS duties
|
|
*/
|
|
typedef struct {
|
|
uint8_t device;
|
|
uint8_t parent;
|
|
struct {
|
|
bool used;
|
|
uint8_t duty;
|
|
uint8_t mac[6];
|
|
} child[MESH_MAX_CONNECTIONS];
|
|
} esp_mesh_ps_duties_t;
|
|
|
|
/*******************************************************
|
|
* Function Definitions
|
|
*******************************************************/
|
|
/**
|
|
* @brief Set mesh softAP beacon interval
|
|
*
|
|
* @param[in] interval beacon interval (msecs) (100 msecs ~ 60000 msecs)
|
|
*
|
|
* @return
|
|
* - ESP_OK
|
|
* - ESP_FAIL
|
|
* - ESP_ERR_INVALID_ARG
|
|
*/
|
|
esp_err_t esp_mesh_set_beacon_interval(int interval_ms);
|
|
|
|
/**
|
|
* @brief Get mesh softAP beacon interval
|
|
*
|
|
* @param[out] interval beacon interval (msecs)
|
|
*
|
|
* @return
|
|
* - ESP_OK
|
|
*/
|
|
esp_err_t esp_mesh_get_beacon_interval(int *interval_ms);
|
|
|
|
/**
|
|
* @brief Set attempts for mesh self-organized networking
|
|
*
|
|
* @param[in] attempts
|
|
*
|
|
* @return
|
|
* - ESP_OK
|
|
* - ESP_FAIL
|
|
*/
|
|
esp_err_t esp_mesh_set_attempts(mesh_attempts_t *attempts);
|
|
|
|
/**
|
|
* @brief Get attempts for mesh self-organized networking
|
|
*
|
|
* @param[out] attempts
|
|
*
|
|
* @return
|
|
* - ESP_OK
|
|
* - ESP_ERR_MESH_ARGUMENT
|
|
*/
|
|
esp_err_t esp_mesh_get_attempts(mesh_attempts_t *attempts);
|
|
|
|
/**
|
|
* @brief Set parameters for parent switch
|
|
*
|
|
* @param[in] paras parameters for parent switch
|
|
*
|
|
* @return
|
|
* - ESP_OK
|
|
* - ESP_ERR_MESH_ARGUMENT
|
|
*/
|
|
esp_err_t esp_mesh_set_switch_parent_paras(mesh_switch_parent_t *paras);
|
|
|
|
/**
|
|
* @brief Get parameters for parent switch
|
|
*
|
|
* @param[out] paras parameters for parent switch
|
|
*
|
|
* @return
|
|
* - ESP_OK
|
|
* - ESP_ERR_MESH_ARGUMENT
|
|
*/
|
|
esp_err_t esp_mesh_get_switch_parent_paras(mesh_switch_parent_t *paras);
|
|
|
|
/**
|
|
* @brief Set RSSI threshold
|
|
* - The default high RSSI threshold value is -78 dBm.
|
|
* - The default medium RSSI threshold value is -82 dBm.
|
|
* - The default low RSSI threshold value is -85 dBm.
|
|
*
|
|
* @param[in] threshold RSSI threshold
|
|
*
|
|
* @return
|
|
* - ESP_OK
|
|
* - ESP_ERR_MESH_ARGUMENT
|
|
*/
|
|
esp_err_t esp_mesh_set_rssi_threshold(const mesh_rssi_threshold_t *threshold);
|
|
|
|
/**
|
|
* @brief Get RSSI threshold
|
|
*
|
|
* @param[out] threshold RSSI threshold
|
|
*
|
|
* @return
|
|
* - ESP_OK
|
|
* - ESP_ERR_MESH_ARGUMENT
|
|
*/
|
|
esp_err_t esp_mesh_get_rssi_threshold(mesh_rssi_threshold_t *threshold);
|
|
|
|
/**
|
|
* @brief Enable the minimum rate to 6 Mbps
|
|
*
|
|
* @attention This API shall be called before Wi-Fi is started.
|
|
*
|
|
* @param[in] is_6m enable or not
|
|
*
|
|
* @return
|
|
* - ESP_OK
|
|
*/
|
|
esp_err_t esp_mesh_set_6m_rate(bool is_6m);
|
|
|
|
/**
|
|
* @brief Print the number of txQ waiting
|
|
*
|
|
* @return
|
|
* - ESP_OK
|
|
* - ESP_FAIL
|
|
*/
|
|
esp_err_t esp_mesh_print_txQ_waiting(void);
|
|
|
|
/**
|
|
* @brief Print the number of rxQ waiting
|
|
*
|
|
* @return
|
|
* - ESP_OK
|
|
* - ESP_FAIL
|
|
*/
|
|
esp_err_t esp_mesh_print_rxQ_waiting(void);
|
|
|
|
/**
|
|
* @brief Set passive scan time
|
|
*
|
|
* @param[in] interval_ms passive scan time (msecs)
|
|
*
|
|
* @return
|
|
* - ESP_OK
|
|
* - ESP_FAIL
|
|
* - ESP_ERR_ARGUMENT
|
|
*/
|
|
esp_err_t esp_mesh_set_passive_scan_time(int time_ms);
|
|
|
|
/**
|
|
* @brief Get passive scan time
|
|
*
|
|
* @return interval_ms passive scan time (msecs)
|
|
*/
|
|
int esp_mesh_get_passive_scan_time(void);
|
|
|
|
/**
|
|
* @brief Set announce interval
|
|
* - The default short interval is 500 milliseconds.
|
|
* - The default long interval is 3000 milliseconds.
|
|
*
|
|
* @param[in] short_ms shall be greater than the default value
|
|
* @param[in] long_ms shall be greater than the default value
|
|
*
|
|
* @return
|
|
* - ESP_OK
|
|
*/
|
|
esp_err_t esp_mesh_set_announce_interval(int short_ms, int long_ms);
|
|
|
|
/**
|
|
* @brief Get announce interval
|
|
*
|
|
* @param[out] short_ms short interval
|
|
* @param[out] long_ms long interval
|
|
*
|
|
* @return
|
|
* - ESP_OK
|
|
*/
|
|
esp_err_t esp_mesh_get_announce_interval(int *short_ms, int *long_ms);
|
|
|
|
/**
|
|
* @brief Get the running duties of device, parent and children
|
|
*
|
|
* @return
|
|
* - ESP_OK
|
|
*/
|
|
esp_err_t esp_mesh_ps_get_duties(esp_mesh_ps_duties_t* ps_duties);
|
|
|
|
/**
|
|
* @brief Enable mesh print scan result
|
|
*
|
|
* @param[in] enable enable or not
|
|
*
|
|
* @return
|
|
* - ESP_OK
|
|
*/
|
|
esp_err_t esp_mesh_print_scan_result(bool enable);
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif /* __ESP_MESH_INTERNAL_H__ */
|