mirror of
https://github.com/espressif/ESP8266_RTOS_SDK.git
synced 2025-05-31 15:41:02 +08:00
docs(doxygen): Fix header files which is not doxygen style
This commit is contained in:
dongheng
@ -20,13 +20,13 @@
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/** \defgroup System_Sleep_APIs System Sleep APIs
|
||||
* @brief System Sleep APIs
|
||||
*/
|
||||
typedef enum {
|
||||
WIFI_NONE_SLEEP_T = 0,
|
||||
WIFI_LIGHT_SLEEP_T,
|
||||
WIFI_MODEM_SLEEP_T
|
||||
} wifi_sleep_type_t;
|
||||
|
||||
/** @addtogroup System_Sleep_APIs
|
||||
* @{
|
||||
*/
|
||||
typedef void (*fpm_wakeup_cb)(void);
|
||||
|
||||
/**
|
||||
* @brief Set the chip to deep-sleep mode.
|
||||
@ -40,7 +40,7 @@ extern "C" {
|
||||
* up, connect a GPIO to pin RST, the chip will wake up by a falling-edge
|
||||
* on pin RST
|
||||
*
|
||||
* @param uint32 time_in_us : deep-sleep time, unit: microsecond
|
||||
* @param time_in_us deep-sleep time, unit: microsecond
|
||||
*
|
||||
* @return null
|
||||
*/
|
||||
@ -53,55 +53,26 @@ void esp_deep_sleep(uint32_t time_in_us);
|
||||
*
|
||||
* If this API is not called, default to be esp_deep_sleep_set_rf_option(1).
|
||||
*
|
||||
* @param uint8 option :
|
||||
* @param 0 : Radio calibration after the deep-sleep wakeup is decided by byte
|
||||
* 108 of esp_init_data_default.bin (0~127byte).
|
||||
* @param 1 : Radio calibration will be done after the deep-sleep wakeup. This
|
||||
* will lead to stronger current.
|
||||
* @param 2 : Radio calibration will not be done after the deep-sleep wakeup.
|
||||
* This will lead to weaker current.
|
||||
* @param 4 : Disable radio calibration after the deep-sleep wakeup (the same
|
||||
* as modem-sleep). This will lead to the weakest current, but the device
|
||||
* can't receive or transmit data after waking up.
|
||||
* @param option radio option
|
||||
* 0 : Radio calibration after the deep-sleep wakeup is decided by byte
|
||||
* 108 of esp_init_data_default.bin (0~127byte).
|
||||
* 1 : Radio calibration will be done after the deep-sleep wakeup. This
|
||||
* will lead to stronger current.
|
||||
* 2 : Radio calibration will not be done after the deep-sleep wakeup.
|
||||
* This will lead to weaker current.
|
||||
* 4 : Disable radio calibration after the deep-sleep wakeup (the same
|
||||
* as modem-sleep). This will lead to the weakest current, but the device
|
||||
* can't receive or transmit data after waking up.
|
||||
*
|
||||
* @return null
|
||||
*/
|
||||
void esp_deep_sleep_set_rf_option(uint8_t option);
|
||||
|
||||
/** \defgroup WiFi_Sleep_Type_APIs Sleep Type APIs
|
||||
* @brief WiFi Sleep APIs
|
||||
*/
|
||||
|
||||
/** @addtogroup WiFi_Sleep_Type_APIs
|
||||
* @{
|
||||
*/
|
||||
|
||||
typedef enum {
|
||||
WIFI_NONE_SLEEP_T = 0,
|
||||
WIFI_LIGHT_SLEEP_T,
|
||||
WIFI_MODEM_SLEEP_T
|
||||
} wifi_sleep_type_t;
|
||||
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
|
||||
|
||||
/** \defgroup WiFi_Force_Sleep_APIs Force Sleep APIs
|
||||
* @brief WiFi Force Sleep APIs
|
||||
*/
|
||||
|
||||
/** @addtogroup WiFi_Force_Sleep_APIs
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Enable force sleep function.
|
||||
*
|
||||
* @attention Force sleep function is disabled by default.
|
||||
*
|
||||
* @param null
|
||||
*
|
||||
* @return null
|
||||
*/
|
||||
void esp_wifi_fpm_open(void);
|
||||
@ -109,8 +80,6 @@ void esp_wifi_fpm_open(void);
|
||||
/**
|
||||
* @brief Disable force sleep function.
|
||||
*
|
||||
* @param null
|
||||
*
|
||||
* @return null
|
||||
*/
|
||||
void esp_wifi_fpm_close(void);
|
||||
@ -122,14 +91,10 @@ void esp_wifi_fpm_close(void);
|
||||
* is enabled, after calling wifi_fpm_open.
|
||||
* This API can not be called after calling wifi_fpm_close.
|
||||
*
|
||||
* @param null
|
||||
*
|
||||
* @return null
|
||||
*/
|
||||
void esp_wifi_fpm_do_wakeup(void);
|
||||
|
||||
typedef void (*fpm_wakeup_cb)(void);
|
||||
|
||||
/**
|
||||
* @brief Set a callback of waken up from force sleep because of time out.
|
||||
*
|
||||
@ -141,7 +106,7 @@ typedef void (*fpm_wakeup_cb)(void);
|
||||
* @attention 3. fpm_wakeup_cb_func will not be called if woke up by wifi_fpm_do_wakeup
|
||||
* from MODEM_SLEEP_T type force sleep.
|
||||
*
|
||||
* @param void (*fpm_wakeup_cb_func)(void) : callback of waken up
|
||||
* @param cb callback of waken up
|
||||
*
|
||||
* @return null
|
||||
*/
|
||||
@ -157,11 +122,11 @@ void esp_wifi_fpm_set_wakeup_cb(fpm_wakeup_cb cb);
|
||||
* in the system idle task. Please do not call other WiFi related function right
|
||||
* after calling this API.
|
||||
*
|
||||
* @param uint32 sleep_time_in_us : sleep time, ESP8266 will wake up automatically
|
||||
* when time out. Unit: us. Range: 10000 ~ 268435455(0xFFFFFFF).
|
||||
* - If sleep_time_in_us is 0xFFFFFFF, the ESP8266 will sleep till
|
||||
* - if wifi_fpm_set_sleep_type is set to be LIGHT_SLEEP_T, ESP8266 can wake up by GPIO.
|
||||
* - if wifi_fpm_set_sleep_type is set to be MODEM_SLEEP_T, ESP8266 can wake up by wifi_fpm_do_wakeup.
|
||||
* @param sleep_time_in_us sleep time, ESP8266 will wake up automatically
|
||||
* when time out. Unit: us. Range: 10000 ~ 268435455(0xFFFFFFF).
|
||||
* - If sleep_time_in_us is 0xFFFFFFF, the ESP8266 will sleep till
|
||||
* - if wifi_fpm_set_sleep_type is set to be LIGHT_SLEEP_T, ESP8266 can wake up by GPIO.
|
||||
* - if wifi_fpm_set_sleep_type is set to be MODEM_SLEEP_T, ESP8266 can wake up by wifi_fpm_do_wakeup.
|
||||
*
|
||||
* @return ESP_OK, setting succeed;
|
||||
* @return ESP_ERR_WIFI_FPM_MODE, fail to sleep, force sleep function is not enabled.
|
||||
@ -175,7 +140,7 @@ esp_err_t esp_wifi_fpm_do_sleep(uint32_t sleep_time_in_us);
|
||||
*
|
||||
* @attention This API can only be called before wifi_fpm_open.
|
||||
*
|
||||
* @param wifi_sleep_type_t type : sleep type
|
||||
* @param type sleep type
|
||||
*
|
||||
* @return null
|
||||
*/
|
||||
@ -184,8 +149,6 @@ void esp_wifi_fpm_set_sleep_type(wifi_sleep_type_t type);
|
||||
/**
|
||||
* @brief Get sleep type of force sleep function.
|
||||
*
|
||||
* @param null
|
||||
*
|
||||
* @return sleep type
|
||||
*/
|
||||
wifi_sleep_type_t esp_wifi_fpm_get_sleep_type(void);
|
||||
@ -200,10 +163,11 @@ wifi_sleep_type_t esp_wifi_fpm_get_sleep_type(void);
|
||||
* • If the GPIO is still in the wakeup status, the EP8266 will enter modem-sleep mode instead;
|
||||
* • If the GPIO is NOT in the wakeup status, the ESP8266 will enter light-sleep mode
|
||||
*
|
||||
* @param uint32_t gpio_num: GPIO number, range: [0, 15].
|
||||
* gpio_int_type_t intr_status: status of GPIO interrupt to trigger the wakeup process.
|
||||
* - if esp_wifi_fpm_set_sleep_type is set to be LIGHT_SLEEP_T, ESP8266 can wake up by GPIO.
|
||||
* - if esp_wifi_fpm_set_sleep_type is set to be MODEM_SLEEP_T, ESP8266 can wake up by esp_wifi_fpm_do_wakeup.
|
||||
* @param gpio_num GPIO number, range: [0, 15].
|
||||
* gpio_int_type_t intr_status: status of GPIO interrupt to trigger the wakeup process.
|
||||
* - if esp_wifi_fpm_set_sleep_type is set to be LIGHT_SLEEP_T, ESP8266 can wake up by GPIO.
|
||||
* - if esp_wifi_fpm_set_sleep_type is set to be MODEM_SLEEP_T, ESP8266 can wake up by esp_wifi_fpm_do_wakeup.
|
||||
* @param intr_status GPIO interrupt type
|
||||
*
|
||||
* @return null
|
||||
*/
|
||||
@ -211,17 +175,9 @@ void esp_wifi_enable_gpio_wakeup(uint32_t gpio_num, gpio_int_type_t intr_status)
|
||||
|
||||
/**
|
||||
* @brief Disable the function that the GPIO can wake the ESP8266 up from light-sleep mode.
|
||||
*
|
||||
* @param null
|
||||
*
|
||||
* @return null
|
||||
*/
|
||||
void esp_wifi_disable_gpio_wakeup(void);
|
||||
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
Reference in New Issue
Block a user