feat(wifi): Add vendor ie API description

internal: 45cf72a6
This commit is contained in:
Espressif Systems
2017-08-30 18:38:36 +08:00
parent 854acab56c
commit 802390060e

View File

@ -832,6 +832,18 @@ typedef enum {
VND_IE_TYPE_NUM,
} vendor_ie_type;
/**
* @brief Vendor IE received callback.
*
* @param vendor_ie_type type : type of vendor IE.
* @param const uint8 sa[6] : source address of the packet.
* @param uint8 *vendor_ie : pointer of vendor IE.
* @param sint32 rssi : signal strength.
*
* @return null
*/
typedef void (*vendor_ie_recv_cb_t)(vendor_ie_type type, const uint8 sa[6], const uint8 *vnd_ie, sint32 rssi);
/**
* @brief Set Vendor IE of ESP8266.
*
@ -852,6 +864,25 @@ typedef enum {
*/
bool wifi_set_vnd_ie(bool enable, vendor_ie_type type, uint8_t idx, uint8_t *vnd_ie);
/**
* @brief Register vendor IE received callback.
*
* @param vendor_ie_recv_cb_t cb : callback
*
* @return 0 : succeed
* @return -1 : fail
*/
sint32 wifi_register_vnd_ie_recv_cb(vendor_ie_recv_cb_t cb);
/**
* @brief Unregister vendor IE received callback.
*
* @param null
*
* @return null
*/
void wifi_unregister_vnd_ie_recv_cb(void);
/**
* @}
*/