- build_docs
script:
- cd docs
+ - doxygen
+ # If not building master branch, and there are Doxygen warnings, print them and bail out
+ - test "${CI_BUILD_REF_NAME}" = "master" || test $(cat doxygen-warning-log.txt | wc -l) -eq 0 || ( echo "Doxygen pass had some warnings:" && cat doxygen-warning-log.txt && false )
- make html
artifacts:
paths:
/** @brief vhci_host_callback
* used for vhci call host function to notify what host need to do
- *
- * notify_host_send_available: notify host can send packet to controller
- * notify_host_recv: notify host that controller has packet send to host
*/
typedef struct vhci_host_callback {
- void (*notify_host_send_available)(void);
- int (*notify_host_recv)(uint8_t *data, uint16_t len);
+ void (*notify_host_send_available)(void); /*!< callback used to notify that the host can send packet to controller */
+ int (*notify_host_recv)(uint8_t *data, uint16_t len); /*!< callback used to notify that the controller has a packet to send to the host*/
} vhci_host_callback_t;
/** @brief API_vhci_host_check_send_available
#define GPIO_IS_VALID_GPIO(gpio_num) ((gpio_num < GPIO_PIN_COUNT && GPIO_PIN_MUX_REG[gpio_num] != 0)) //to decide whether it is a valid GPIO number
#define GPIO_IS_VALID_OUTPUT_GPIO(gpio_num) ((GPIO_IS_VALID_GPIO(gpio_num)) && (gpio_num < 34)) //to decide whether it can be a valid GPIO number of output mode
+/**
+ * @brief Pullup/pulldown information for a single GPIO pad
+ */
typedef struct {
uint32_t reg; /*!< Register to modify to enable or disable pullups or pulldowns */
uint32_t pu; /*!< Bit to set or clear in the above register to enable or disable the pullup, respectively */
GPIO_PULLDOWN_ENABLE = 0x1, /*!< Enable GPIO pull-down resistor */
} gpio_pulldown_t;
+/**
+ * @brief Configuration parameters of GPIO pad for gpio_config function
+ */
typedef struct {
uint64_t pin_bit_mask; /*!< GPIO pin: set with bit mask, each bit maps to a GPIO */
gpio_mode_t mode; /*!< GPIO mode: set input/output mode */
LEDC_TIMER_15_BIT = 15, /*!< LEDC PWM depth 15Bit */
} ledc_timer_bit_t;
+/**
+ * @brief Configuration parameters of LEDC channel for ledc_channel_config function
+ */
typedef struct {
int gpio_num; /*!< the LEDC output gpio_num, if you want to use gpio16, gpio_num = 16*/
ledc_mode_t speed_mode; /*!< LEDC speed speed_mode, high-speed mode or low-speed mode*/
uint32_t duty; /*!< LEDC channel duty, the duty range is [0, (2**bit_num) - 1], */
} ledc_channel_config_t;
+/**
+ * @brief Configuration parameters of LEDC Timer timer for ledc_timer_config function
+ */
typedef struct {
ledc_mode_t speed_mode; /*!< LEDC speed speed_mode, high-speed mode or low-speed mode*/
ledc_timer_bit_t bit_num; /*!< LEDC channel duty depth*/
#include "freertos/ringbuf.h"\r
#include <esp_types.h>\r
\r
-#define UART_FIFO_LEN (128) /*< Length of the hardware FIFO buffers */\r
-#define UART_INTR_MASK 0x1ff\r
-#define UART_LINE_INV_MASK (0x3f << 19)\r
-#define UART_BITRATE_MAX 5000000\r
-#define UART_PIN_NO_CHANGE (-1)\r
+#define UART_FIFO_LEN (128) /*!< Length of the hardware FIFO buffers */\r
+#define UART_INTR_MASK 0x1ff /*!< mask of all UART interrupts */\r
+#define UART_LINE_INV_MASK (0x3f << 19) /*!< TBD */\r
+#define UART_BITRATE_MAX 5000000 /*!< Max bit rate supported by UART */\r
+#define UART_PIN_NO_CHANGE (-1) /*!< Constant for uart_set_pin function which indicates that UART pin should not be changed */\r
\r
#define UART_INVERSE_DISABLE (0x0) /*!< Disable UART signal inverse*/\r
#define UART_INVERSE_RXD (UART_RXD_INV_M) /*!< UART RXD input inverse*/\r
#define UART_INVERSE_TXD (UART_TXD_INV_M) /*!< UART TXD output inverse*/\r
#define UART_INVERSE_RTS (UART_RTS_INV_M) /*!< UART RTS output inverse*/\r
\r
+/**\r
+ * @brief UART word length constants\r
+ */\r
typedef enum {\r
UART_DATA_5_BITS = 0x0, /*!< word length: 5bits*/\r
UART_DATA_6_BITS = 0x1, /*!< word length: 6bits*/\r
UART_DATA_BITS_MAX = 0X4,\r
} uart_word_length_t;\r
\r
+/**\r
+ * @brief UART stop bits number\r
+ */\r
typedef enum {\r
UART_STOP_BITS_1 = 0x1, /*!< stop bit: 1bit*/\r
UART_STOP_BITS_1_5 = 0x2, /*!< stop bit: 1.5bits*/\r
UART_STOP_BITS_MAX = 0x4,\r
} uart_stop_bits_t;\r
\r
+/**\r
+ * @brief UART peripheral number\r
+ */\r
typedef enum {\r
UART_NUM_0 = 0x0, /*!< UART base address 0x3ff40000*/\r
UART_NUM_1 = 0x1, /*!< UART base address 0x3ff50000*/\r
UART_NUM_MAX,\r
} uart_port_t;\r
\r
+/**\r
+ * @brief UART parity constants\r
+ */\r
typedef enum {\r
UART_PARITY_DISABLE = 0x0, /*!< Disable UART parity*/\r
UART_PARITY_EVEN = 0x2, /*!< Enable UART even parity*/\r
UART_PARITY_ODD = 0x3 /*!< Enable UART odd parity*/\r
} uart_parity_t;\r
\r
+/**\r
+ * @brief UART hardware flow control modes\r
+ */\r
typedef enum {\r
UART_HW_FLOWCTRL_DISABLE = 0x0, /*!< disable hardware flow control*/\r
UART_HW_FLOWCTRL_RTS = 0x1, /*!< enable RX hardware flow control (rts)*/\r
UART_HW_FLOWCTRL_MAX = 0x4,\r
} uart_hw_flowcontrol_t;\r
\r
+/**\r
+ * @brief UART configuration parameters for uart_param_config function\r
+ */\r
typedef struct {\r
int baud_rate; /*!< UART baudrate*/\r
uart_word_length_t data_bits; /*!< UART byte size*/\r
uint8_t rx_flow_ctrl_thresh ; /*!< UART HW RTS threshold*/\r
} uart_config_t;\r
\r
+/**\r
+ * @brief UART interrupt configuration parameters for uart_intr_config function\r
+ */\r
typedef struct {\r
uint32_t intr_enable_mask; /*!< UART interrupt enable mask, choose from UART_XXXX_INT_ENA_M under UART_INT_ENA_REG(i), connect with bit-or operator*/\r
uint8_t rx_timeout_thresh; /*!< UART timeout interrupt threshold(unit: time of sending one byte)*/\r
uint8_t rxfifo_full_thresh; /*!< UART RX full interrupt threshold.*/\r
} uart_intr_config_t;\r
\r
+/**\r
+ * @brief UART event types used in the ringbuffer\r
+ */\r
typedef enum {\r
UART_DATA, /*!< UART data event*/\r
UART_BREAK, /*!< UART break event*/\r
UART_EVENT_MAX, /*!< UART event max index*/\r
} uart_event_type_t;\r
\r
+/**\r
+ * @brief Event structure used in UART event queue\r
+ */\r
typedef struct {\r
uart_event_type_t type; /*!< UART event type */\r
size_t size; /*!< UART data size for UART_DATA event*/\r
* @brief Set UART data bits.\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param data_bit UART data bits\r
*\r
* @return\r
* @brief Get UART data bits.\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param data_bit Pointer to accept value of UART data bits.\r
*\r
* @return\r
* @brief Set UART stop bits.\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param bit_num UART stop bits\r
*\r
* @return\r
* @brief Set UART stop bits.\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param stop_bit Pointer to accept value of UART stop bits.\r
*\r
* @return\r
* @brief Set UART parity.\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param parity_mode the enum of uart parity configuration\r
*\r
* @return\r
* @brief Get UART parity mode.\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param parity_mode Pointer to accept value of UART parity mode.\r
*\r
* @return\r
* @brief Set UART baud rate.\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param baud_rate UART baud-rate.\r
*\r
* @return\r
* @brief Get UART bit-rate.\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param baudrate Pointer to accept value of UART baud rate\r
*\r
* @return\r
* @brief Set UART line inverse mode\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
- * @param Inverse_mask Choose the wires that need to be inversed.\r
- *\r
- * (inverse_mask should be chosen from UART_INVERSE_RXD/UART_INVERSE_TXD/UART_INVERSE_RTS/UART_INVERSE_CTS, combine with OR-OPERATION)\r
+ * @param inverse_mask Choose the wires that need to be inversed.\r
+ * Inverse_mask should be chosen from UART_INVERSE_RXD/UART_INVERSE_TXD/UART_INVERSE_RTS/UART_INVERSE_CTS, combine with OR operation.\r
*\r
* @return\r
* - ESP_OK Success\r
* @brief Set hardware flow control.\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param flow_ctrl Hardware flow control mode\r
- *\r
- * @param rx_thresh Threshold of Hardware RX flow control(0 ~ UART_FIFO_LEN)\r
- *\r
- * Only when UART_HW_FLOWCTRL_RTS is set , will the rx_thresh value be set.\r
+ * @param rx_thresh Threshold of Hardware RX flow control(0 ~ UART_FIFO_LEN).\r
+ * Only when UART_HW_FLOWCTRL_RTS is set, will the rx_thresh value be set.\r
*\r
* @return\r
* - ESP_OK Success\r
* @brief Get hardware flow control mode\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param flow_ctrl Option for different flow control mode.\r
*\r
* @return\r
* @brief Clear UART interrupt status\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param clr_mask Bit mask of the status that to be cleared.\r
- *\r
- * (enable_mask should be chosen from the fields of register UART_INT_CLR_REG)\r
+ * enable_mask should be chosen from the fields of register UART_INT_CLR_REG.\r
*\r
* @return\r
* - ESP_OK Success\r
* @brief Set UART interrupt enable\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param enable_mask Bit mask of the enable bits.\r
- *\r
- * (enable_mask should be chosen from the fields of register UART_INT_ENA_REG)\r
+ * enable_mask should be chosen from the fields of register UART_INT_ENA_REG.\r
*\r
* @return\r
* - ESP_OK Success\r
* @brief Clear UART interrupt enable bits\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param disable_mask Bit mask of the disable bits.\r
- *\r
- * (disable_mask should be chosen from the fields of register UART_INT_ENA_REG)\r
+ * disable_mask should be chosen from the fields of register UART_INT_ENA_REG.\r
*\r
* @return\r
* - ESP_OK Success\r
* @brief Enable UART TX interrupt(RX_FULL & RX_TIMEOUT INTERRUPT)\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param enable 1: enable; 0: disable\r
- *\r
* @param thresh Threshold of TX interrupt, 0 ~ UART_FIFO_LEN\r
*\r
* @return\r
esp_err_t uart_enable_tx_intr(uart_port_t uart_num, int enable, int thresh);\r
\r
/**\r
-* @brief register UART interrupt handler(ISR).\r
-* @note\r
- * UART ISR handler will be attached to the same CPU core that this function is running on.\r
- * Users should know that which CPU is running and then pick a INUM that is not used by system.\r
- * We can find the information of INUM and interrupt level in soc.h.\r
+ * @brief register UART interrupt handler(ISR).\r
*\r
- * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @note UART ISR handler will be attached to the same CPU core that this function is running on.\r
+ * Users should know that which CPU is running and then pick a INUM that is not used by system.\r
+ * We can find the information of INUM and interrupt level in soc.h.\r
*\r
- * @param uart_intr_num UART interrupt number,check the info in soc.h, and please refer to core-isa.h for more details\r
+ * @attention The ISR handler function MUST be defined with attribution of "IRAM_ATTR" for now.\r
*\r
+ * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_intr_num UART interrupt number,check the info in soc.h, and please refer to core-isa.h for more details\r
* @param fn Interrupt handler function.\r
- * @attention\r
- * The ISR handler function MUST be defined with attribution of "IRAM_ATTR" for now.\r
* @param arg parameter for handler function\r
*\r
* @return\r
/**\r
* @brief Set UART pin number\r
*\r
- * @note\r
- * Internal signal can be output to multiple GPIO pads\r
- * Only one GPIO pad can connect with input signal\r
+ * @note Internal signal can be output to multiple GPIO pads.\r
+ * Only one GPIO pad can connect with input signal.\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param tx_io_num UART TX pin GPIO number, if set to UART_PIN_NO_CHANGE, use the current pin.\r
- *\r
* @param rx_io_num UART RX pin GPIO number, if set to UART_PIN_NO_CHANGE, use the current pin.\r
- *\r
* @param rts_io_num UART RTS pin GPIO number, if set to UART_PIN_NO_CHANGE, use the current pin.\r
- *\r
* @param cts_io_num UART CTS pin GPIO number, if set to UART_PIN_NO_CHANGE, use the current pin.\r
*\r
* @return\r
* UART rx hardware flow control should not be set.\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param level 1: RTS output low(active); 0: RTS output high(block)\r
*\r
* @return\r
* @brief UART set DTR level (before inverse)\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param level 1: DTR output low; 0: DTR output high\r
*\r
* @return\r
* @brief UART parameter configure\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param uart_config UART parameter settings\r
*\r
* @return\r
* @brief UART interrupt configure\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param intr_conf UART interrupt settings\r
*\r
* @return\r
/**\r
* @brief Install UART driver.\r
*\r
- * UART ISR handler will be attached to the same CPU core that this function is running on.\r
- * Users should know that which CPU is running and then pick a INUM that is not used by system.\r
- * We can find the information of INUM and interrupt level in soc.h.\r
+ * UART ISR handler will be attached to the same CPU core that this function is running on.\r
+ * Users should know that which CPU is running and then pick a INUM that is not used by system.\r
+ * We can find the information of INUM and interrupt level in soc.h.\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param rx_buffer_size UART RX ring buffer size\r
- *\r
* @param tx_buffer_size UART TX ring buffer size.\r
- *\r
- * If set to zero, driver will not use TX buffer, TX function will block task until all data have been sent out..\r
- *\r
+ * If set to zero, driver will not use TX buffer, TX function will block task until all data have been sent out..\r
* @param queue_size UART event queue size/depth.\r
- *\r
* @param uart_intr_num UART interrupt number,check the info in soc.h, and please refer to core-isa.h for more details\r
- *\r
* @param uart_queue UART event queue handle, if set NULL, driver will not use an event queue.\r
*\r
* @return\r
* @brief Wait UART TX FIFO empty\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param ticks_to_wait Timeout, count in RTOS ticks\r
*\r
* @return\r
esp_err_t uart_wait_tx_done(uart_port_t uart_num, TickType_t ticks_to_wait);\r
\r
/**\r
- * @brief Send data to the UART port from a given buffer and length,\r
- * This function will not wait for the space in TX FIFO, just fill the TX FIFO and return when the FIFO is full.\r
- * @note\r
- * This function should only be used when UART TX buffer is not enabled.\r
+ * @brief Send data to the UART port from a given buffer and length.\r
+ * \r
+ * This function will not wait for the space in TX FIFO, just fill the TX FIFO and return when the FIFO is full.\r
+ * @note This function should only be used when UART TX buffer is not enabled.\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param buffer data buffer address\r
- *\r
* @param len data length to send\r
*\r
* @return\r
/**\r
* @brief Send data to the UART port from a given buffer and length,\r
*\r
- * If parameter tx_buffer_size is set to zero:\r
- * This function will not return until all the data have been sent out, or at least pushed into TX FIFO.\r
+ * If parameter tx_buffer_size is set to zero:\r
+ * This function will not return until all the data have been sent out, or at least pushed into TX FIFO.\r
*\r
- * Otherwise, if tx_buffer_size > 0, this function will return after copying all the data to tx ringbuffer,\r
- * then, UART ISR will move data from ring buffer to TX FIFO gradually.\r
+ * Otherwise, if tx_buffer_size > 0, this function will return after copying all the data to tx ringbuffer,\r
+ * then, UART ISR will move data from ring buffer to TX FIFO gradually.\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param src data buffer address\r
- *\r
* @param size data length to send\r
*\r
* @return\r
/**\r
* @brief Send data to the UART port from a given buffer and length,\r
*\r
- * If parameter tx_buffer_size is set to zero:\r
- * This function will not return until all the data and the break signal have been sent out.\r
- * After all data send out, send a break signal.\r
+ * If parameter tx_buffer_size is set to zero:\r
+ * This function will not return until all the data and the break signal have been sent out.\r
+ * After all data send out, send a break signal.\r
*\r
- * Otherwise, if tx_buffer_size > 0, this function will return after copying all the data to tx ringbuffer,\r
- * then, UART ISR will move data from ring buffer to TX FIFO gradually.\r
- * After all data send out, send a break signal.\r
+ * Otherwise, if tx_buffer_size > 0, this function will return after copying all the data to tx ringbuffer,\r
+ * then, UART ISR will move data from ring buffer to TX FIFO gradually.\r
+ * After all data send out, send a break signal.\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param src data buffer address\r
- *\r
* @param size data length to send\r
- *\r
* @param brk_len break signal length (unit: time of one data bit at current_baudrate)\r
*\r
* @return\r
* @brief UART read bytes from UART buffer\r
*\r
* @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
* @param buf pointer to the buffer.\r
- *\r
* @param length data length\r
- *\r
* @param ticks_to_wait sTimeout, count in RTOS ticks\r
*\r
* @return\r
#define ESP_ERR_WIFI_PASSWORD (ESP_ERR_WIFI_BASE + 10) /*!< Passord is invalid */
#define ESP_ERR_WIFI_TIMEOUT (ESP_ERR_WIFI_BASE + 11) /*!< Timeout error */
+/**
+ * @brief WiFi stack configuration parameters passed to esp_wifi_init call.
+ */
typedef struct {
system_event_handler_t event_handler; /**< WiFi event handler */
} wifi_init_config_t;
* will post station connected event to this queue. If the queue is not initialized, WiFi
* will not post any events
*
- * @param wifi_init_config_t *config : provide WiFi init configuration
+ * @param config provide WiFi init configuration
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NO_MEM : out of memory
- * - others : refer to error code esp_err.h
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NO_MEM: out of memory
+ * - others: refer to error code esp_err.h
*/
esp_err_t esp_wifi_init(wifi_init_config_t *config);
*
* @attention 1. This API should be called if you want to remove WiFi driver from the system
*
- * @return ESP_OK : succeed
+ * @return ESP_OK: succeed
*/
esp_err_t esp_wifi_deinit(void);
* Set the WiFi operating mode as station, soft-AP or station+soft-AP,
* The default mode is soft-AP mode.
*
- * @param wifi_mode_t mode : WiFi operating modes:
+ * @param mode WiFi operating mode
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_ARG : invalid argument
- * - others : refer to error code in esp_err.h
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_ARG: invalid argument
+ * - others: refer to error code in esp_err.h
*/
esp_err_t esp_wifi_set_mode(wifi_mode_t mode);
/**
* @brief Get current operating mode of WiFi
*
- * @param wifi_mode_t *mode : store current WiFi mode
+ * @param[out] mode store current WiFi mode
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_ARG : invalid argument
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_ARG: invalid argument
*/
esp_err_t esp_wifi_get_mode(wifi_mode_t *mode);
* If mode is WIFI_MODE_AP, it create soft-AP control block and start soft-AP
* If mode is WIFI_MODE_APSTA, it create soft-AP and station control block and start soft-AP and station
*
- * @param null
- *
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_ARG : invalid argument
- * - ESP_ERR_WIFI_NO_MEM : out of memory
- * - ESP_ERR_WIFI_CONN : WiFi internal error, station or soft-AP control block wrong
- * - ESP_ERR_WIFI_FAIL : other WiFi internal errors
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_ARG: invalid argument
+ * - ESP_ERR_WIFI_NO_MEM: out of memory
+ * - ESP_ERR_WIFI_CONN: WiFi internal error, station or soft-AP control block wrong
+ * - ESP_ERR_WIFI_FAIL: other WiFi internal errors
*/
esp_err_t esp_wifi_start(void);
/**
* @brief Stop WiFi
- If mode is WIFI_MODE_STA, it stop station and free station control block
+ * If mode is WIFI_MODE_STA, it stop station and free station control block
* If mode is WIFI_MODE_AP, it stop soft-AP and free soft-AP control block
* If mode is WIFI_MODE_APSTA, it stop station/soft-AP and free station/soft-AP control block
*
- * @param null
- *
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
*/
esp_err_t esp_wifi_stop(void);
* @attention 1. This API only impact WIFI_MODE_STA or WIFI_MODE_APSTA mode
* @attention 2. If the ESP32 is connected to an AP, call esp_wifi_disconnect to disconnect.
*
- * @param null
- *
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_NOT_START : WiFi is not started by esp_wifi_start
- * - ESP_ERR_WIFI_CONN : WiFi internal error, station or soft-AP control block wrong
- * - ESP_ERR_WIFI_SSID : SSID of AP which station connects is invalid
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_NOT_START: WiFi is not started by esp_wifi_start
+ * - ESP_ERR_WIFI_CONN: WiFi internal error, station or soft-AP control block wrong
+ * - ESP_ERR_WIFI_SSID: SSID of AP which station connects is invalid
*/
esp_err_t esp_wifi_connect(void);
/**
* @brief Disconnect the ESP32 WiFi station from the AP.
*
- * @param null
- *
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_NOT_START : WiFi is not started by esp_wifi_start
- * - ESP_ERR_WIFI_FAIL : other WiFi internal errors
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_NOT_START: WiFi is not started by esp_wifi_start
+ * - ESP_ERR_WIFI_FAIL: other WiFi internal errors
*/
esp_err_t esp_wifi_disconnect(void);
/**
* @brief Currently this API is just an stub API
*
- * @param null
- *
+
* @return
- * - ESP_OK : succeed
- * - others : fail
+ * - ESP_OK: succeed
+ * - others: fail
*/
esp_err_t esp_wifi_clear_fast_connect(void);
/**
* @brief deauthenticate all stations or associated id equals to aid
*
- * @param uint16_t aid : when aid is 0, deauthenticate all stations, otherwise deauthenticate station whose associated id is aid
+ * @param aid when aid is 0, deauthenticate all stations, otherwise deauthenticate station whose associated id is aid
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_NOT_START : WiFi is not started by esp_wifi_start
- * - ESP_ERR_WIFI_ARG : invalid argument
- * - ESP_ERR_WIFI_MODE : WiFi mode is wrong
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_NOT_START: WiFi is not started by esp_wifi_start
+ * - ESP_ERR_WIFI_ARG: invalid argument
+ * - ESP_ERR_WIFI_MODE: WiFi mode is wrong
*/
esp_err_t esp_wifi_deauth_sta(uint16_t aid);
* will be freed in esp_wifi_get_ap_list, so generally, call esp_wifi_get_ap_list to cause
* the memory to be freed once the scan is done
*
- * @param struct scan_config *config : configuration of scanning
- * @param bool block : if block is true, this API will block the caller until the scan is done, otherwise
+ * @param config configuration of scanning
+ * @param block if block is true, this API will block the caller until the scan is done, otherwise
* it will return immediately
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_NOT_START : WiFi is not started by esp_wifi_start
- * - ESP_ERR_WIFI_TIMEOUT : blocking scan is timeout
- * - others : refer to error code in esp_err.h
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_NOT_START: WiFi is not started by esp_wifi_start
+ * - ESP_ERR_WIFI_TIMEOUT: blocking scan is timeout
+ * - others: refer to error code in esp_err.h
*/
-esp_err_t esp_wifi_scan_start(wifi_scan_config_t *conf, bool block);
+esp_err_t esp_wifi_scan_start(wifi_scan_config_t *config, bool block);
/**
* @brief Stop the scan in process
*
- * @param null
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_NOT_START : WiFi is not started by esp_wifi_start
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_NOT_START: WiFi is not started by esp_wifi_start
*/
esp_err_t esp_wifi_scan_stop(void);
/**
* @brief Get number of APs found in last scan
*
- * @param uint16_t *number : store number of APIs found in last scan
+ * @param[out] number store number of APIs found in last scan
*
- * @attention This API can only be called when the scan is completed, otherwise it may get wrong value
+ * @attention This API can only be called when the scan is completed, otherwise it may get wrong value.
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_NOT_START : WiFi is not started by esp_wifi_start
- * - ESP_ERR_WIFI_ARG : invalid argument
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_NOT_START: WiFi is not started by esp_wifi_start
+ * - ESP_ERR_WIFI_ARG: invalid argument
*/
esp_err_t esp_wifi_scan_get_ap_num(uint16_t *number);
/**
* @brief Get AP list found in last scan
*
- * @param uint16_t *number : as input param, it stores max AP number ap_records can hold, as output param, it store
- the actual AP number this API returns
- * @param wifi_ap_record_t *ap_records: wifi_ap_record_t array to hold the found APs
+ * @param[inout] number As input param, it stores max AP number ap_records can hold.
+ * As output param, it receives the actual AP number this API returns.
+ * @param ap_records wifi_ap_record_t array to hold the found APs
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_NOT_START : WiFi is not started by esp_wifi_start
- * - ESP_ERR_WIFI_ARG : invalid argument
- * - ESP_ERR_WIFI_NO_MEM : out of memory
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_NOT_START: WiFi is not started by esp_wifi_start
+ * - ESP_ERR_WIFI_ARG: invalid argument
+ * - ESP_ERR_WIFI_NO_MEM: out of memory
*/
esp_err_t esp_wifi_scan_get_ap_records(uint16_t *number, wifi_ap_record_t *ap_records);
/**
- * @brief Get information of AP associated with ESP32 station
+ * @brief Get information of AP which the ESP32 station is associated with
*
- * @param wifi_ap_record_t *ap_info: the wifi_ap_record_t to hold station assocated AP
+ * @param ap_info the wifi_ap_record_t to hold AP information
*
* @return
- * - ESP_OK : succeed
- * - others : fail
+ * - ESP_OK: succeed
+ * - others: fail
*/
esp_err_t esp_wifi_sta_get_ap_info(wifi_ap_record_t *ap_info);
/**
* @brief Set current power save type
*
- * @param wifi_ps_type_t type : power save type
+ * @param type power save type
*
- * @return ESP_ERR_WIFI_NOT_SUPPORT : not support yet
+ * @return ESP_ERR_WIFI_NOT_SUPPORT: not supported yet
*/
esp_err_t esp_wifi_set_ps(wifi_ps_type_t type);
/**
* @brief Get current power save type
*
- * @param wifi_ps_type_t *type : store current power save type
+ * @param[out] type: store current power save type
*
- * @return ESP_ERR_WIFI_NOT_SUPPORT : not support yet
+ * @return ESP_ERR_WIFI_NOT_SUPPORT: not supported yet
*/
esp_err_t esp_wifi_get_ps(wifi_ps_type_t *type);
*
* @attention Currently we only support 802.11b or 802.11bg or 802.11bgn mode
*
- * @param wifi_interface_t ifx : interfaces
- * @param uint8_t protocol : WiFi protocol bitmap
+ * @param ifx interfaces
+ * @param protocol_bitmap WiFi protocol bitmap
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_IF : invalid interface
- * - others : refer to erro code in esp_err.h
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_IF: invalid interface
+ * - others: refer to error codes in esp_err.h
*/
esp_err_t esp_wifi_set_protocol(wifi_interface_t ifx, uint8_t protocol_bitmap);
/**
- * @brief Get the current protocol bitmap of specified ifx
+ * @brief Get the current protocol bitmap of the specified interface
*
- * @param wifi_interface_t ifx : interfaces
- * @param uint8_t protocol : store current WiFi protocol bitmap of interface ifx
+ * @param ifx interface
+ * @param[out] protocol_bitmap store current WiFi protocol bitmap of interface ifx
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_IF : invalid interface
- * - ESP_ERR_WIFI_ARG : invalid argument
- * - others : refer to error code in esp_err.h
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_IF: invalid interface
+ * - ESP_ERR_WIFI_ARG: invalid argument
+ * - others: refer to error codes in esp_err.h
*/
esp_err_t esp_wifi_get_protocol(wifi_interface_t ifx, uint8_t *protocol_bitmap);
/**
* @brief Set the bandwidth of ESP32 specified interface
*
- * @attention 1. API return false if try to configure a interface that is not enable
+ * @attention 1. API return false if try to configure an interface that is not enabled
* @attention 2. WIFI_BW_HT40 is supported only when the interface support 11N
*
- * @param wifi_interface_t ifx : interface to be configured
- * @param wifi_bandwidth_t bw : bandwidth
+ * @param ifx interface to be configured
+ * @param bw bandwidth
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_IF : invalid interface
- * - ESP_ERR_WIFI_ARG : invalid argument
- * - others : refer to error code in esp_err.h
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_IF: invalid interface
+ * - ESP_ERR_WIFI_ARG: invalid argument
+ * - others: refer to error codes in esp_err.h
*/
esp_err_t esp_wifi_set_bandwidth(wifi_interface_t ifx, wifi_bandwidth_t bw);
*
* @attention 1. API return false if try to get a interface that is not enable
*
- * @param wifi_interface_t ifx : interface to be configured
- * @param wifi_bandwidth_t *bw : store bandwidth of interface ifx
+ * @param ifx interface to be configured
+ * @param[out] bw store bandwidth of interface ifx
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_IF : invalid interface
- * - ESP_ERR_WIFI_ARG : invalid argument
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_IF: invalid interface
+ * - ESP_ERR_WIFI_ARG: invalid argument
*/
esp_err_t esp_wifi_get_bandwidth(wifi_interface_t ifx, wifi_bandwidth_t *bw);
/**
- * @brief Set primary/second channel of ESP32
+ * @brief Set primary/secondary channel of ESP32
*
* @attention 1. This is a special API for sniffer
*
- * @param uint8_t primary : for HT20, primary is the channel number, for HT40, primary is the primary channel
- * @param wifi_second_chan_t second : for HT20, second is ignored, for HT40, second is the second channel
+ * @param primary for HT20, primary is the channel number, for HT40, primary is the primary channel
+ * @param second for HT20, second is ignored, for HT40, second is the second channel
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_IF : invalid interface
- * - ESP_ERR_WIFI_ARG : invalid argument
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_IF: invalid interface
+ * - ESP_ERR_WIFI_ARG: invalid argument
*/
esp_err_t esp_wifi_set_channel(uint8_t primary, wifi_second_chan_t second);
/**
- * @brief Get the primary/second channel of ESP32
+ * @brief Get the primary/secondary channel of ESP32
*
* @attention 1. API return false if try to get a interface that is not enable
*
- * @param uint8_t *primary : store current primary channel
- * @param wifi_second_chan_t *second : store current second channel
+ * @param primary store current primary channel
+ * @param[out] second store current second channel
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_ARG : invalid argument
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_ARG: invalid argument
*/
esp_err_t esp_wifi_get_channel(uint8_t *primary, wifi_second_chan_t *second);
* @brief Set country code
* The default value is WIFI_COUNTRY_CN
*
- * @param wifi_country_t country : country type
+ * @param country country type
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_ARG : invalid argument
- * - others : refer to error code in esp_err.h
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_ARG: invalid argument
+ * - others: refer to error code in esp_err.h
*/
esp_err_t esp_wifi_set_country(wifi_country_t country);
/**
* @brief Get country code
*
- * @param wifi_country_t country : store current country
+ * @param country store current country
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_ARG : invalid argument
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_ARG: invalid argument
*/
esp_err_t esp_wifi_get_country(wifi_country_t *country);
*
* @attention 1. This API can only be called when the interface is disabled
* @attention 2. ESP32 soft-AP and station have different MAC addresses, do not set them to be the same.
- * - The bit0 of the first byte of ESP32 MAC address can not be 1. For example, the MAC address
+ * @attention 3. The bit 0 of the first byte of ESP32 MAC address can not be 1. For example, the MAC address
* can set to be "1a:XX:XX:XX:XX:XX", but can not be "15:XX:XX:XX:XX:XX".
*
- * @param wifi_interface_t ifx : interface
- * @param uint8 mac[6]: the MAC address.
+ * @param ifx interface
+ * @param mac the MAC address
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_ARG : invalid argument
- * - ESP_ERR_WIFI_IF : invalid interface
- * - ESP_ERR_WIFI_MAC : invalid mac address
- * - ESP_ERR_WIFI_MODE : WiFi mode is wrong
- * - others : refer to error code in esp_err.h
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_ARG: invalid argument
+ * - ESP_ERR_WIFI_IF: invalid interface
+ * - ESP_ERR_WIFI_MAC: invalid mac address
+ * - ESP_ERR_WIFI_MODE: WiFi mode is wrong
+ * - others: refer to error codes in esp_err.h
*/
esp_err_t esp_wifi_set_mac(wifi_interface_t ifx, uint8_t mac[6]);
/**
* @brief Get mac of specified interface
*
- * @param uint8_t mac[6] : store mac of this interface ifx
+ * @param ifx interface
+ * @param[out] mac store mac of the interface ifx
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_ARG : invalid argument
- * - ESP_ERR_WIFI_IF : invalid interface
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_ARG: invalid argument
+ * - ESP_ERR_WIFI_IF: invalid interface
*/
esp_err_t esp_wifi_get_mac(wifi_interface_t ifx, uint8_t mac[6]);
/**
* @brief The RX callback function in the promiscuous mode.
*
- * Each time a packet is received, the callback function will be called.
+ * Each time a packet is received, the callback function will be called.
*
- * @param void *buf : the data received
- * @param uint16_t len : data length
+ * @param buf the data received
+ * @param len data length
*
* @return none
*/
/**
* @brief Register the RX callback function in the promiscuous mode.
*
- * Each time a packet is received, the registered callback function will be called.
+ * Each time a packet is received, the registered callback function will be called.
*
- * @param wifi_promiscuous_cb_t cb : callback
+ * @param cb callback
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
*/
esp_err_t esp_wifi_set_promiscuous_rx_cb(wifi_promiscuous_cb_t cb);
/**
* @brief Enable the promiscuous mode.
*
- * @param bool promiscuous : false - disable / true - enable
+ * @param en false - disable, true - enable
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
*/
esp_err_t esp_wifi_set_promiscuous(bool en);
/**
* @brief Get the promiscuous mode.
*
- * @param bool *enable : store the current status of promiscuous mode
+ * @param[out] en store the current status of promiscuous mode
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_ARG : invalid argument
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_ARG: invalid argument
*/
esp_err_t esp_wifi_get_promiscuous(bool *en);
* @attention 3. ESP32 is limited to only one channel, so when in the soft-AP+station mode, the soft-AP will adjust its channel automatically to be the same as
* the channel of the ESP32 station.
*
- * @param wifi_interface_t ifx : interface
- * @param wifi_config_t *conf : station or soft-AP configuration
+ * @param ifx interface
+ * @param conf station or soft-AP configuration
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_ARG : invalid argument
- * - ESP_ERR_WIFI_IF : invalid interface
- * - ESP_ERR_WIFI_MODE : invalid mode
- * - ESP_ERR_WIFI_PASSWORD : invalid password
- * - ESP_ERR_WIFI_NVS : WiFi internal NVS error
- * - others : refer to the erro code in esp_err.h
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_ARG: invalid argument
+ * - ESP_ERR_WIFI_IF: invalid interface
+ * - ESP_ERR_WIFI_MODE: invalid mode
+ * - ESP_ERR_WIFI_PASSWORD: invalid password
+ * - ESP_ERR_WIFI_NVS: WiFi internal NVS error
+ * - others: refer to the erro code in esp_err.h
*/
esp_err_t esp_wifi_set_config(wifi_interface_t ifx, wifi_config_t *conf);
/**
* @brief Get configuration of specified interface
*
- * @param wifi_interface_t ifx : interface
- * @param wifi_config_t *conf : station or soft-AP configuration
+ * @param ifx interface
+ * @param[out] conf station or soft-AP configuration
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_ARG : invalid argument
- * - ESP_ERR_WIFI_IF : invalid interface
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_ARG: invalid argument
+ * - ESP_ERR_WIFI_IF: invalid interface
*/
esp_err_t esp_wifi_get_config(wifi_interface_t ifx, wifi_config_t *conf);
*
* @attention SSC only API
*
- * @param wifi_sta_list_t *sta: station list
+ * @param[out] sta station list
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_ARG : invalid argument
- * - ESP_ERR_WIFI_MODE : WiFi mode is wrong
- * - ESP_ERR_WIFI_CONN : WiFi internal error, the station/soft-AP control block is invalid
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_ARG: invalid argument
+ * - ESP_ERR_WIFI_MODE: WiFi mode is wrong
+ * - ESP_ERR_WIFI_CONN: WiFi internal error, the station/soft-AP control block is invalid
*/
esp_err_t esp_wifi_ap_get_sta_list(wifi_sta_list_t *sta);
*
* @attention 1. The default value is WIFI_STORAGE_FLASH
*
- * @param wifi_storage_t storage : storage type
+ * @param storage : storage type
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_ARG : invalid argument
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_ARG: invalid argument
*/
esp_err_t esp_wifi_set_storage(wifi_storage_t storage);
* @brief Set auto connect
* The default value is true
*
- * @param bool en : true - enable auto connect / false - disable auto connect
+ * @param en : true - enable auto connect / false - disable auto connect
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_MODE : WiFi internal error, the station/soft-AP control block is invalid
- * - others : refer to error code in esp_err.h
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_MODE: WiFi internal error, the station/soft-AP control block is invalid
+ * - others: refer to error code in esp_err.h
*/
esp_err_t esp_wifi_set_auto_connect(bool en);
/**
* @brief Get the auto connect flag
*
- * @param bool *en : store current auto connect configuration
+ * @param[out] en store current auto connect configuration
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_ARG : invalid argument
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_ARG: invalid argument
*/
esp_err_t esp_wifi_get_auto_connect(bool *en);
/**
* @brief Set vendor specific element
*
- * @param bool enable : enable or not
- * @param wifi_vendor_ie_type_t type : 0 - WIFI_VND_IE_TYPE_BEACON
- * 1 - WIFI_VND_IE_TYPE_PROBE_REQ
- * 2 - WIFI_VND_IE_TYPE_PROBE_RESP
- * 3 - WIFI_VND_IE_TYPE_ASSOC_REQ
- * 4 - WIFI_VND_IE_TYPE_ASSOC_RESP
- * @param wifi_vendor_ie_id_t idx : 0 - WIFI_VND_IE_ID_0
- 1 - WIFI_VND_IE_ID_1
- * @param uint8_t *vnd_ie : pointer to a vendor specific element
+ * @param enable enable or not
+ * @param type information element type
+ * @param idx information element index
+ * @param vnd_ie pointer to a vendor specific element
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
- * - ESP_ERR_WIFI_ARG : invalid argument
- * - ESP_ERR_WIFI_NO_MEM : out of memory
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
+ * - ESP_ERR_WIFI_ARG: invalid argument
+ * - ESP_ERR_WIFI_NO_MEM: out of memory
*/
esp_err_t esp_wifi_set_vendor_ie(bool enable, wifi_vendor_ie_type_t type, wifi_vendor_ie_id_t idx, uint8_t *vnd_ie);
/**
* @brief Define function pointer for vendor specific element callback
- * @param void *ctx : reserved
- * @param wifi_vendor_ie_type_t type : 0 - WIFI_VND_IE_TYPE_BEACON
- * 1 - WIFI_VND_IE_TYPE_PROBE_REQ
- * 2 - WIFI_VND_IE_TYPE_PROBE_RESP
- * 3 - WIFI_VND_IE_TYPE_ASSOC_REQ
- * 4 - WIFI_VND_IE_TYPE_ASSOC_RESP
- * @param const uint8_t sa[6] : source address
- * @param const uint8_t *vnd_ie : pointer to a vendor specific element
- * @param int rssi : received signal strength indication
+ * @param ctx reserved
+ * @param type information element type
+ * @param sa source address
+ * @param vnd_ie pointer to a vendor specific element
+ * @param rssi received signal strength indication
*/
typedef void (*esp_vendor_ie_cb_t) (void *ctx, wifi_vendor_ie_type_t type, const uint8_t sa[6], const uint8_t *vnd_ie, int rssi);
/**
* @brief Set vendor specific element callback
*
- * @param esp_vendor_ie_cb_t cb : callback function
- * @param void *ctx : reserved
+ * @param cb callback function
+ * @param ctx reserved
*
* @return
- * - ESP_OK : succeed
- * - ESP_ERR_WIFI_NOT_INIT : WiFi is not initialized by eps_wifi_init
+ * - ESP_OK: succeed
+ * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
*/
esp_err_t esp_wifi_set_vendor_ie_cb(esp_vendor_ie_cb_t cb, void *ctx);
*/
esp_err_t nvs_open(const char* name, nvs_open_mode open_mode, nvs_handle *out_handle);
+/**@{*/
/**
- * @brief nvs_set_X - set value for given key
+ * @brief set value for given key
*
* This family of functions set value for the key, given its name. Note that
* actual storage will not be updated until nvs_commit function is called.
* implementation, but is guaranteed to be at least
* 16 characters. Shouldn't be empty.
* @param[in] value The value to set.
- * @param[in] length For nvs_set_blob: length of binary value to set, in bytes.
*
* @return
* - ESP_OK if value was set successfully
esp_err_t nvs_set_i64 (nvs_handle handle, const char* key, int64_t value);
esp_err_t nvs_set_u64 (nvs_handle handle, const char* key, uint64_t value);
esp_err_t nvs_set_str (nvs_handle handle, const char* key, const char* value);
+/**@}*/
+
+/**
+ * @brief set variable length binary value for given key
+ *
+ * This family of functions set value for the key, given its name. Note that
+ * actual storage will not be updated until nvs_commit function is called.
+ *
+ * @param[in] handle Handle obtained from nvs_open function.
+ * Handles that were opened read only cannot be used.
+ * @param[in] key Key name. Maximal length is determined by the underlying
+ * implementation, but is guaranteed to be at least
+ * 16 characters. Shouldn't be empty.
+ * @param[in] value The value to set.
+ * @param[in] length length of binary value to set, in bytes.
+ *
+ * @return
+ * - ESP_OK if value was set successfully
+ * - ESP_ERR_NVS_INVALID_HANDLE if handle has been closed or is NULL
+ * - ESP_ERR_NVS_READ_ONLY if storage handle was opened as read only
+ * - ESP_ERR_NVS_INVALID_NAME if key name doesn't satisfy constraints
+ * - ESP_ERR_NVS_NOT_ENOUGH_SPACE if there is not enough space in the
+ * underlying storage to save the value
+ * - ESP_ERR_NVS_REMOVE_FAILED if the value wasn't updated because flash
+ * write operation has failed. The value was written however, and
+ * update will be finished after re-initialization of nvs, provided that
+ * flash operation doesn't fail again.
+ */
esp_err_t nvs_set_blob(nvs_handle handle, const char* key, const void* value, size_t length);
+/**@{*/
/**
- * @brief nvs_get_X - get value for given key
+ * @brief get value for given key
*
* These functions retrieve value for the key, given its name. If key does not
* exist, or the requested variable type doesn't match the type which was used
*
* All functions expect out_value to be a pointer to an already allocated variable
* of the given type.
- * Additionally, nvs_get_str and nvs_get_blob support WinAPI-style length queries.
+ *
+ * \code{c}
+ * // Example of using nvs_get_i32:
+ * int32_t max_buffer_size = 4096; // default value
+ * esp_err_t err = nvs_get_i32(my_handle, "max_buffer_size", &max_buffer_size);
+ * assert(err == ESP_OK || err == ESP_ERR_NVS_NOT_FOUND);
+ * // if ESP_ERR_NVS_NOT_FOUND was returned, max_buffer_size will still
+ * // have its default value.
+ *
+ * \endcode
+ *
+ * @param[in] handle Handle obtained from nvs_open function.
+ * @param[in] key Key name. Maximal length is determined by the underlying
+ * implementation, but is guaranteed to be at least
+ * 16 characters. Shouldn't be empty.
+ * @param out_value Pointer to the output value.
+ * May be NULL for nvs_get_str and nvs_get_blob, in this
+ * case required length will be returned in length argument.
+ *
+ * @return
+ * - ESP_OK if the value was retrieved successfully
+ * - ESP_ERR_NVS_NOT_FOUND if the requested key doesn't exist
+ * - ESP_ERR_NVS_INVALID_HANDLE if handle has been closed or is NULL
+ * - ESP_ERR_NVS_INVALID_NAME if key name doesn't satisfy constraints
+ * - ESP_ERR_NVS_INVALID_LENGTH if length is not sufficient to store data
+ */
+esp_err_t nvs_get_i8 (nvs_handle handle, const char* key, int8_t* out_value);
+esp_err_t nvs_get_u8 (nvs_handle handle, const char* key, uint8_t* out_value);
+esp_err_t nvs_get_i16 (nvs_handle handle, const char* key, int16_t* out_value);
+esp_err_t nvs_get_u16 (nvs_handle handle, const char* key, uint16_t* out_value);
+esp_err_t nvs_get_i32 (nvs_handle handle, const char* key, int32_t* out_value);
+esp_err_t nvs_get_u32 (nvs_handle handle, const char* key, uint32_t* out_value);
+esp_err_t nvs_get_i64 (nvs_handle handle, const char* key, int64_t* out_value);
+esp_err_t nvs_get_u64 (nvs_handle handle, const char* key, uint64_t* out_value);
+/**@}*/
+
+/**
+ * @brief get value for given key
+ *
+ * These functions retrieve value for the key, given its name. If key does not
+ * exist, or the requested variable type doesn't match the type which was used
+ * when setting a value, an error is returned.
+ *
+ * In case of any error, out_value is not modified.
+ *
+ * All functions expect out_value to be a pointer to an already allocated variable
+ * of the given type.
+ *
+ * nvs_get_str and nvs_get_blob functions support WinAPI-style length queries.
* To get the size necessary to store the value, call nvs_get_str or nvs_get_blob
* with zero out_value and non-zero pointer to length. Variable pointed to
* by length argument will be set to the required length. For nvs_get_str,
* nvs_get/set_blob used for arbitrary data structures.
*
* \code{c}
- * // Example of using nvs_get_i32:
- * int32_t max_buffer_size = 4096; // default value
- * esp_err_t err = nvs_get_i32(my_handle, "max_buffer_size", &max_buffer_size);
- * assert(err == ESP_OK || err == ESP_ERR_NVS_NOT_FOUND);
- * // if ESP_ERR_NVS_NOT_FOUND was returned, max_buffer_size will still
- * // have its default value.
- *
* // Example (without error checking) of using nvs_get_str to get a string into dynamic array:
* size_t required_size;
* nvs_get_str(my_handle, "server_name", NULL, &required_size);
* @param out_value Pointer to the output value.
* May be NULL for nvs_get_str and nvs_get_blob, in this
* case required length will be returned in length argument.
- * @param[inout] length For nvs_get_str and nvs_get_blob, non-zero pointer
- * to the variable holding the length of out_value.
+ * @param[inout] length A non-zero pointer to the variable holding the length of out_value.
* In case out_value a zero, will be set to the length
* required to hold the value. In case out_value is not
* zero, will be set to the actual length of the value
* - ESP_ERR_NVS_INVALID_NAME if key name doesn't satisfy constraints
* - ESP_ERR_NVS_INVALID_LENGTH if length is not sufficient to store data
*/
-esp_err_t nvs_get_i8 (nvs_handle handle, const char* key, int8_t* out_value);
-esp_err_t nvs_get_u8 (nvs_handle handle, const char* key, uint8_t* out_value);
-esp_err_t nvs_get_i16 (nvs_handle handle, const char* key, int16_t* out_value);
-esp_err_t nvs_get_u16 (nvs_handle handle, const char* key, uint16_t* out_value);
-esp_err_t nvs_get_i32 (nvs_handle handle, const char* key, int32_t* out_value);
-esp_err_t nvs_get_u32 (nvs_handle handle, const char* key, uint32_t* out_value);
-esp_err_t nvs_get_i64 (nvs_handle handle, const char* key, int64_t* out_value);
-esp_err_t nvs_get_u64 (nvs_handle handle, const char* key, uint64_t* out_value);
+/**@{*/
esp_err_t nvs_get_str (nvs_handle handle, const char* key, char* out_value, size_t* length);
esp_err_t nvs_get_blob(nvs_handle handle, const char* key, void* out_value, size_t* length);
+/**@}*/
/**
* @brief Erase key-value pair with given key name.
extern "C" {
#endif
+/**
+ * @file esp_partition.h
+ * @brief Partition APIs
+ */
+
+
+/**
+ * @brief Partition type
+ * @note Keep this enum in sync with PartitionDefinition class gen_esp32part.py
+ */
typedef enum {
- ESP_PARTITION_TYPE_APP = 0x00,
- ESP_PARTITION_TYPE_DATA = 0x01,
- ESP_PARTITION_TYPE_FILESYSTEM = 0x02,
+ ESP_PARTITION_TYPE_APP = 0x00, //!< Application partition type
+ ESP_PARTITION_TYPE_DATA = 0x01, //!< Data partition type
} esp_partition_type_t;
+/**
+ * @brief Partition subtype
+ * @note Keep this enum in sync with PartitionDefinition class gen_esp32part.py
+ */
typedef enum {
- ESP_PARTITION_SUBTYPE_APP_FACTORY = 0x00,
- ESP_PARTITION_SUBTYPE_APP_OTA_MIN = 0x10,
- ESP_PARTITION_SUBTYPE_APP_OTA_0 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 0,
- ESP_PARTITION_SUBTYPE_APP_OTA_1 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 1,
- ESP_PARTITION_SUBTYPE_APP_OTA_2 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 2,
- ESP_PARTITION_SUBTYPE_APP_OTA_3 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 3,
- ESP_PARTITION_SUBTYPE_APP_OTA_4 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 4,
- ESP_PARTITION_SUBTYPE_APP_OTA_5 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 5,
- ESP_PARTITION_SUBTYPE_APP_OTA_6 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 6,
- ESP_PARTITION_SUBTYPE_APP_OTA_7 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 7,
- ESP_PARTITION_SUBTYPE_APP_OTA_8 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 8,
- ESP_PARTITION_SUBTYPE_APP_OTA_9 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 9,
- ESP_PARTITION_SUBTYPE_APP_OTA_10 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 10,
- ESP_PARTITION_SUBTYPE_APP_OTA_11 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 11,
- ESP_PARTITION_SUBTYPE_APP_OTA_12 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 12,
- ESP_PARTITION_SUBTYPE_APP_OTA_13 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 13,
- ESP_PARTITION_SUBTYPE_APP_OTA_14 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 14,
- ESP_PARTITION_SUBTYPE_APP_OTA_15 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 15,
- ESP_PARTITION_SUBTYPE_APP_OTA_MAX = 15,
- ESP_PARTITION_SUBTYPE_APP_TEST = 0x20,
-
- ESP_PARTITION_SUBTYPE_DATA_OTA = 0x00,
- ESP_PARTITION_SUBTYPE_DATA_RF = 0x01,
- ESP_PARTITION_SUBTYPE_DATA_NVS = 0x02,
-
- ESP_PARTITION_SUBTYPE_FILESYSTEM_ESPHTTPD = 0x00,
- ESP_PARTITION_SUBTYPE_FILESYSTEM_FAT = 0x01,
- ESP_PARTITION_SUBTYPE_FILESYSTEM_SPIFFS = 0x02,
-
- ESP_PARTITION_SUBTYPE_ANY = 0xff,
+ ESP_PARTITION_SUBTYPE_APP_FACTORY = 0x00, //!< Factory application partition
+ ESP_PARTITION_SUBTYPE_APP_OTA_MIN = 0x10, //!< Base for OTA partition subtypes
+ ESP_PARTITION_SUBTYPE_APP_OTA_0 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 0, //!< OTA partition 0
+ ESP_PARTITION_SUBTYPE_APP_OTA_1 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 1, //!< OTA partition 1
+ ESP_PARTITION_SUBTYPE_APP_OTA_2 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 2, //!< OTA partition 2
+ ESP_PARTITION_SUBTYPE_APP_OTA_3 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 3, //!< OTA partition 3
+ ESP_PARTITION_SUBTYPE_APP_OTA_4 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 4, //!< OTA partition 4
+ ESP_PARTITION_SUBTYPE_APP_OTA_5 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 5, //!< OTA partition 5
+ ESP_PARTITION_SUBTYPE_APP_OTA_6 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 6, //!< OTA partition 6
+ ESP_PARTITION_SUBTYPE_APP_OTA_7 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 7, //!< OTA partition 7
+ ESP_PARTITION_SUBTYPE_APP_OTA_8 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 8, //!< OTA partition 8
+ ESP_PARTITION_SUBTYPE_APP_OTA_9 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 9, //!< OTA partition 9
+ ESP_PARTITION_SUBTYPE_APP_OTA_10 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 10,//!< OTA partition 10
+ ESP_PARTITION_SUBTYPE_APP_OTA_11 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 11,//!< OTA partition 11
+ ESP_PARTITION_SUBTYPE_APP_OTA_12 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 12,//!< OTA partition 12
+ ESP_PARTITION_SUBTYPE_APP_OTA_13 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 13,//!< OTA partition 13
+ ESP_PARTITION_SUBTYPE_APP_OTA_14 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 14,//!< OTA partition 14
+ ESP_PARTITION_SUBTYPE_APP_OTA_15 = ESP_PARTITION_SUBTYPE_APP_OTA_MIN + 15,//!< OTA partition 15
+ ESP_PARTITION_SUBTYPE_APP_OTA_MAX = 15, //!< Max subtype of OTA partition
+ ESP_PARTITION_SUBTYPE_APP_TEST = 0x20, //!< Test application partition
+
+ ESP_PARTITION_SUBTYPE_DATA_OTA = 0x00, //!< OTA selection partition
+ ESP_PARTITION_SUBTYPE_DATA_PHY = 0x01, //!< PHY init data partition
+ ESP_PARTITION_SUBTYPE_DATA_NVS = 0x02, //!< NVS partition
+
+ ESP_PARTITION_SUBTYPE_DATA_ESPHTTPD = 0x80, //!< ESPHTTPD partition
+ ESP_PARTITION_SUBTYPE_DATA_FAT = 0x81, //!< FAT partition
+ ESP_PARTITION_SUBTYPE_DATA_SPIFFS = 0x82, //!< SPIFFS partition
+
+ ESP_PARTITION_SUBTYPE_ANY = 0xff, //!< Used to search for partitions with any subtype
} esp_partition_subtype_t;
+/**
+ * @brief Convenience macro to get esp_partition_subtype_t value for the i-th OTA partition
+ */
#define ESP_PARTITION_SUBTYPE_OTA(i) ((esp_partition_subtype_t)(ESP_PARTITION_SUBTYPE_APP_OTA_MIN + ((i) & 0xf)))
-
+/**
+ * @brief Opaque partition iterator type
+ */
typedef struct esp_partition_iterator_opaque_* esp_partition_iterator_t;
+/**
+ * @brief partition information structure
+ */
typedef struct {
- esp_partition_type_t type;
- esp_partition_subtype_t subtype;
- uint32_t address;
- uint32_t size;
- char label[17];
- bool encrypted;
+ esp_partition_type_t type; /*!< partition type (app/data) */
+ esp_partition_subtype_t subtype; /*!< partition subtype */
+ uint32_t address; /*!< starting address of the partition in flash */
+ uint32_t size; /*!< size of the partition, in bytes */
+ char label[17]; /*!< partition label, zero-terminated ASCII string */
+ bool encrypted; /*!< flag is set to true if partition is encrypted */
} esp_partition_t;
/**
/**
* @brief Erase a range of flash sectors
*
- * @param uint32_t start_address : Address where erase operation has to start.
+ * @param start_address Address where erase operation has to start.
* Must be 4kB-aligned
- * @param uint32_t size : Size of erased range, in bytes. Must be divisible by 4kB.
+ * @param size Size of erased range, in bytes. Must be divisible by 4kB.
*
* @return esp_err_t
*/
-esp_err_t spi_flash_erase_range(size_t start_addr, size_t size);
+esp_err_t spi_flash_erase_range(size_t start_address, size_t size);
/**
* flags member to ESP_VFS_FLAG_CONTEXT_PTR and provide the context pointer
* to esp_vfs_register function.
* If the implementation doesn't use this extra argument, populate the
- * members without _p suffix and set flags memeber to ESP_VFS_FLAG_DEFAULT.
+ * members without _p suffix and set flags member to ESP_VFS_FLAG_DEFAULT.
*
* If the FS driver doesn't provide some of the functions, set corresponding
* members to NULL.
*/
typedef struct
{
- int fd_offset;
- int flags;
+ int fd_offset; /*!< file descriptor offset, determined by the FS driver */
+ int flags; /*!< ESP_VFS_FLAG_CONTEXT_PTR or ESP_VFS_FLAG_DEFAULT */
union {
size_t (*write_p)(void* p, int fd, const void * data, size_t size);
size_t (*write)(int fd, const void * data, size_t size);
* These functions are to be used in newlib syscall table. They will be called by
* newlib when it needs to use any of the syscalls.
*/
-
+/**@{*/
ssize_t esp_vfs_write(struct _reent *r, int fd, const void * data, size_t size);
off_t esp_vfs_lseek(struct _reent *r, int fd, off_t size, int mode);
ssize_t esp_vfs_read(struct _reent *r, int fd, void * dst, size_t size);
int esp_vfs_link(struct _reent *r, const char* n1, const char* n2);
int esp_vfs_unlink(struct _reent *r, const char *path);
int esp_vfs_rename(struct _reent *r, const char *src, const char *dst);
-
+/**@}*/
#ifdef __cplusplus
GENERATE_HTML = NO
HAVE_DOT = NO
GENERATE_LATEX = NO
-GENERATE_MAN = NO
+GENERATE_MAN = YES
GENERATE_RTF = NO
-QUIET = YES
WARN_LOGFILE = "doxygen-warning-log.txt"
projects / esp-idf / commitdiff