feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

driver: fix header file warnings for Doxygen.

Browse Source
This commit is contained in:
Wangjialin
2016-11-16 01:31:02 +08:00
parent a8a51a2786
commit d7599ab16d
3 changed files with 122 additions and 115 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
components/driver/include/driver/gpio.h
View File

@@ -314,7 +314,7 @@ esp_err_t gpio_set_pull_mode(gpio_num_t gpio_num, gpio_pull_mode_t pull);
* *
* @param gpio_num GPIO number. * @param gpio_num GPIO number.
* *
* @param intr_type GPIO wake-up type. Only GPIO_INTR_LOW_LEVEL\GPIO_INTR_HIGH_LEVEL can be used. * @param intr_type GPIO wake-up type. Only GPIO_INTR_LOW_LEVEL or GPIO_INTR_HIGH_LEVEL can be used.
* *
* @return * @return
* - ESP_OK Success * - ESP_OK Success

2
components/driver/include/driver/ledc.h
View File

@@ -150,6 +150,8 @@ esp_err_t ledc_update_duty(ledc_mode_t speed_mode, ledc_channel_t channel);
* *
* @param channel LEDC channel(0-7), select from ledc_channel_t * @param channel LEDC channel(0-7), select from ledc_channel_t
* *
* @param idle_level Set output idle level after LEDC stops.
*
* @return * @return
* - ESP_OK Success * - ESP_OK Success
* - ESP_ERR_INVALID_ARG Parameter error * - ESP_ERR_INVALID_ARG Parameter error

95
components/driver/include/driver/uart.h
View File

@@ -115,7 +115,7 @@ typedef struct {
/** /**
* @brief Set UART data bits. * @brief Set UART data bits.
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param data_bit UART data bits * @param data_bit UART data bits
* *
@@ -128,7 +128,9 @@ esp_err_t uart_set_word_length(uart_port_t uart_num, uart_word_length_t data_bit
/** /**
* @brief Get UART data bits. * @brief Get UART data bits.
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
*
* @param data_bit Pointer to accept value of UART data bits.
* *
* @return * @return
* - ESP_FAIL Parameter error * - ESP_FAIL Parameter error
@@ -139,7 +141,7 @@ esp_err_t uart_get_word_length(uart_port_t uart_num, uart_word_length_t* data_bi
/** /**
* @brief Set UART stop bits. * @brief Set UART stop bits.
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param bit_num UART stop bits * @param bit_num UART stop bits
* *
@@ -147,12 +149,14 @@ esp_err_t uart_get_word_length(uart_port_t uart_num, uart_word_length_t* data_bi
* - ESP_OK Success * - ESP_OK Success
* - ESP_FAIL Fail * - ESP_FAIL Fail
*/ */
esp_err_t uart_set_stop_bits(uart_port_t uart_no, uart_stop_bits_t bit_num); esp_err_t uart_set_stop_bits(uart_port_t uart_num, uart_stop_bits_t bit_num);
/** /**
* @brief Set UART stop bits. * @brief Set UART stop bits.
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
*
* @param stop_bit Pointer to accept value of UART stop bits.
* *
* @return * @return
* - ESP_FAIL Parameter error * - ESP_FAIL Parameter error
@@ -163,7 +167,7 @@ esp_err_t uart_get_stop_bits(uart_port_t uart_num, uart_stop_bits_t* stop_bit);
/** /**
* @brief Set UART parity. * @brief Set UART parity.
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param parity_mode the enum of uart parity configuration * @param parity_mode the enum of uart parity configuration
* *
@@ -171,12 +175,14 @@ esp_err_t uart_get_stop_bits(uart_port_t uart_num, uart_stop_bits_t* stop_bit);
* - ESP_FAIL Parameter error * - ESP_FAIL Parameter error
* - ESP_OK Success * - ESP_OK Success
*/ */
esp_err_t uart_set_parity(uart_port_t uart_no, uart_parity_t parity_mode); esp_err_t uart_set_parity(uart_port_t uart_num, uart_parity_t parity_mode);
/** /**
* @brief Get UART parity mode. * @brief Get UART parity mode.
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
*
* @param parity_mode Pointer to accept value of UART parity mode.
* *
* @return * @return
* - ESP_FAIL Parameter error * - ESP_FAIL Parameter error
@@ -188,7 +194,7 @@ esp_err_t uart_get_parity(uart_port_t uart_num, uart_parity_t* parity_mode);
/** /**
* @brief Set UART baud rate. * @brief Set UART baud rate.
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param baud_rate UART baud-rate. * @param baud_rate UART baud-rate.
* *
@@ -196,12 +202,14 @@ esp_err_t uart_get_parity(uart_port_t uart_num, uart_parity_t* parity_mode);
* - ESP_FAIL Parameter error * - ESP_FAIL Parameter error
* - ESP_OK Success * - ESP_OK Success
*/ */
esp_err_t uart_set_baudrate(uart_port_t uart_no, uint32_t baud_rate); esp_err_t uart_set_baudrate(uart_port_t uart_num, uint32_t baud_rate);
/** /**
* @brief Get UART bit-rate. * @brief Get UART bit-rate.
* *
* @param uart_no: UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
*
* @param baudrate Pointer to accept value of UART baud rate
* *
* @return * @return
* - ESP_FAIL Parameter error * - ESP_FAIL Parameter error
@@ -213,9 +221,9 @@ esp_err_t uart_get_baudrate(uart_port_t uart_num, uint32_t* baudrate);
/** /**
* @brief Set UART line inverse mode * @brief Set UART line inverse mode
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param inverse_mask Choose the wires that need to be inversed. * @param Inverse_mask Choose the wires that need to be inversed.
* *
* (inverse_mask should be chosen from UART_INVERSE_RXD/UART_INVERSE_TXD/UART_INVERSE_RTS/UART_INVERSE_CTS, combine with OR-OPERATION) * (inverse_mask should be chosen from UART_INVERSE_RXD/UART_INVERSE_TXD/UART_INVERSE_RTS/UART_INVERSE_CTS, combine with OR-OPERATION)
* *
@@ -223,12 +231,12 @@ esp_err_t uart_get_baudrate(uart_port_t uart_num, uint32_t* baudrate);
* - ESP_OK Success * - ESP_OK Success
* - ESP_FAIL Parameter error * - ESP_FAIL Parameter error
*/ */
esp_err_t uart_set_line_inverse(uart_port_t uart_no, uint32_t inverse_mask); esp_err_t uart_set_line_inverse(uart_port_t uart_num, uint32_t inverse_mask);
/** /**
* @brief Set hardware flow control. * @brief Set hardware flow control.
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param flow_ctrl Hardware flow control mode * @param flow_ctrl Hardware flow control mode
* *
@@ -240,12 +248,14 @@ esp_err_t uart_set_line_inverse(uart_port_t uart_no, uint32_t inverse_mask);
* - ESP_OK Success * - ESP_OK Success
* - ESP_FAIL Parameter error * - ESP_FAIL Parameter error
*/ */
esp_err_t uart_set_hw_flow_ctrl(uart_port_t uart_no, uart_hw_flowcontrol_t flow_ctrl, uint8_t rx_thresh); esp_err_t uart_set_hw_flow_ctrl(uart_port_t uart_num, uart_hw_flowcontrol_t flow_ctrl, uint8_t rx_thresh);
/** /**
* @brief Get hardware flow control mode * @brief Get hardware flow control mode
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
*
* @param flow_ctrl Option for different flow control mode.
* *
* @return * @return
* - ESP_FAIL Parameter error * - ESP_FAIL Parameter error
@@ -256,7 +266,7 @@ esp_err_t uart_get_hw_flow_ctrl(uart_port_t uart_num, uart_hw_flowcontrol_t* flo
/** /**
* @brief Clear UART interrupt status * @brief Clear UART interrupt status
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param clr_mask Bit mask of the status that to be cleared. * @param clr_mask Bit mask of the status that to be cleared.
* *
@@ -271,7 +281,7 @@ esp_err_t uart_clear_intr_status(uart_port_t uart_num, uint32_t clr_mask);
/** /**
* @brief Set UART interrupt enable * @brief Set UART interrupt enable
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param enable_mask Bit mask of the enable bits. * @param enable_mask Bit mask of the enable bits.
* *
@@ -286,7 +296,7 @@ esp_err_t uart_enable_intr_mask(uart_port_t uart_num, uint32_t enable_mask);
/** /**
* @brief Clear UART interrupt enable bits * @brief Clear UART interrupt enable bits
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param disable_mask Bit mask of the disable bits. * @param disable_mask Bit mask of the disable bits.
* *
@@ -302,7 +312,7 @@ esp_err_t uart_disable_intr_mask(uart_port_t uart_num, uint32_t disable_mask);
/** /**
* @brief Enable UART RX interrupt(RX_FULL & RX_TIMEOUT INTERRUPT) * @brief Enable UART RX interrupt(RX_FULL & RX_TIMEOUT INTERRUPT)
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @return * @return
* - ESP_OK Success * - ESP_OK Success
@@ -313,7 +323,7 @@ esp_err_t uart_enable_rx_intr(uart_port_t uart_num);
/** /**
* @brief Disable UART RX interrupt(RX_FULL & RX_TIMEOUT INTERRUPT) * @brief Disable UART RX interrupt(RX_FULL & RX_TIMEOUT INTERRUPT)
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @return * @return
* - ESP_OK Success * - ESP_OK Success
@@ -324,7 +334,7 @@ esp_err_t uart_disable_rx_intr(uart_port_t uart_num);
/** /**
* @brief Disable UART TX interrupt(RX_FULL & RX_TIMEOUT INTERRUPT) * @brief Disable UART TX interrupt(RX_FULL & RX_TIMEOUT INTERRUPT)
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @return * @return
* - ESP_OK Success * - ESP_OK Success
@@ -335,7 +345,7 @@ esp_err_t uart_disable_tx_intr(uart_port_t uart_num);
/** /**
* @brief Enable UART TX interrupt(RX_FULL & RX_TIMEOUT INTERRUPT) * @brief Enable UART TX interrupt(RX_FULL & RX_TIMEOUT INTERRUPT)
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param enable 1: enable; 0: disable * @param enable 1: enable; 0: disable
* *
@@ -354,8 +364,7 @@ esp_err_t uart_enable_tx_intr(uart_port_t uart_num, int enable, int thresh);
* Users should know that which CPU is running and then pick a INUM that is not used by system. * Users should know that which CPU is running and then pick a INUM that is not used by system.
* We can find the information of INUM and interrupt level in soc.h. * We can find the information of INUM and interrupt level in soc.h.
* *
* * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param uart_intr_num UART interrupt number,check the info in soc.h, and please refer to core-isa.h for more details * @param uart_intr_num UART interrupt number,check the info in soc.h, and please refer to core-isa.h for more details
* *
@@ -377,7 +386,7 @@ esp_err_t uart_isr_register(uart_port_t uart_num, uint8_t uart_intr_num, void (*
* Internal signal can be output to multiple GPIO pads * Internal signal can be output to multiple GPIO pads
* Only one GPIO pad can connect with input signal * Only one GPIO pad can connect with input signal
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param tx_io_num UART TX pin GPIO number, if set to UART_PIN_NO_CHANGE, use the current pin. * @param tx_io_num UART TX pin GPIO number, if set to UART_PIN_NO_CHANGE, use the current pin.
* *
@@ -397,7 +406,7 @@ esp_err_t uart_set_pin(uart_port_t uart_num, int tx_io_num, int rx_io_num, int r
* @brief UART set RTS level (before inverse) * @brief UART set RTS level (before inverse)
* UART rx hardware flow control should not be set. * UART rx hardware flow control should not be set.
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param level 1: RTS output low(active); 0: RTS output high(block) * @param level 1: RTS output low(active); 0: RTS output high(block)
* *
@@ -410,7 +419,7 @@ esp_err_t uart_set_rts(uart_port_t uart_num, int level);
/** /**
* @brief UART set DTR level (before inverse) * @brief UART set DTR level (before inverse)
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param level 1: DTR output low; 0: DTR output high * @param level 1: DTR output low; 0: DTR output high
* *
@@ -423,7 +432,7 @@ esp_err_t uart_set_dtr(uart_port_t uart_num, int level);
/** /**
* @brief UART parameter configure * @brief UART parameter configure
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param uart_config UART parameter settings * @param uart_config UART parameter settings
* *
@@ -436,7 +445,7 @@ esp_err_t uart_param_config(uart_port_t uart_num, const uart_config_t *uart_conf
/** /**
* @brief UART interrupt configure * @brief UART interrupt configure
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param intr_conf UART interrupt settings * @param intr_conf UART interrupt settings
* *
@@ -453,7 +462,7 @@ esp_err_t uart_intr_config(uart_port_t uart_num, const uart_intr_config_t *intr_
* Users should know that which CPU is running and then pick a INUM that is not used by system. * Users should know that which CPU is running and then pick a INUM that is not used by system.
* We can find the information of INUM and interrupt level in soc.h. * We can find the information of INUM and interrupt level in soc.h.
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param rx_buffer_size UART RX ring buffer size * @param rx_buffer_size UART RX ring buffer size
* *
@@ -476,7 +485,7 @@ esp_err_t uart_driver_install(uart_port_t uart_num, int rx_buffer_size, int tx_b
/** /**
* @brief Uninstall UART driver. * @brief Uninstall UART driver.
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @return * @return
* - ESP_OK Success * - ESP_OK Success
@@ -487,7 +496,7 @@ esp_err_t uart_driver_delete(uart_port_t uart_num);
/** /**
* @brief Wait UART TX FIFO empty * @brief Wait UART TX FIFO empty
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param ticks_to_wait Timeout, count in RTOS ticks * @param ticks_to_wait Timeout, count in RTOS ticks
* *
@@ -504,8 +513,7 @@ esp_err_t uart_wait_tx_done(uart_port_t uart_num, TickType_t ticks_to_wait);
* @note * @note
* This function should only be used when UART TX buffer is not enabled. * This function should only be used when UART TX buffer is not enabled.
* *
* * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param buffer data buffer address * @param buffer data buffer address
* *
@@ -515,7 +523,7 @@ esp_err_t uart_wait_tx_done(uart_port_t uart_num, TickType_t ticks_to_wait);
* - (-1) Parameter error * - (-1) Parameter error
* - OTHERS(>=0) The number of data that pushed to the TX FIFO * - OTHERS(>=0) The number of data that pushed to the TX FIFO
*/ */
int uart_tx_chars(uart_port_t uart_no, const char* buffer, uint32_t len); int uart_tx_chars(uart_port_t uart_num, const char* buffer, uint32_t len);
/** /**
* @brief Send data to the UART port from a given buffer and length, * @brief Send data to the UART port from a given buffer and length,
@@ -526,7 +534,7 @@ int uart_tx_chars(uart_port_t uart_no, const char* buffer, uint32_t len);
* Otherwise, if tx_buffer_size > 0, this function will return after copying all the data to tx ringbuffer, * Otherwise, if tx_buffer_size > 0, this function will return after copying all the data to tx ringbuffer,
* then, UART ISR will move data from ring buffer to TX FIFO gradually. * then, UART ISR will move data from ring buffer to TX FIFO gradually.
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param src data buffer address * @param src data buffer address
* *
@@ -549,15 +557,13 @@ int uart_write_bytes(uart_port_t uart_num, const char* src, size_t size);
* then, UART ISR will move data from ring buffer to TX FIFO gradually. * then, UART ISR will move data from ring buffer to TX FIFO gradually.
* After all data send out, send a break signal. * After all data send out, send a break signal.
* *
* * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
*
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param src data buffer address * @param src data buffer address
* *
* @param size data length to send * @param size data length to send
* *
* @param brk_len break signal length (unit: one bit's time@current_baudrate) * @param brk_len break signal length (unit: time of one data bit at current_baudrate)
* *
* @return * @return
* - (-1) Parameter error * - (-1) Parameter error
@@ -569,7 +575,7 @@ int uart_write_bytes_with_break(uart_port_t uart_num, const char* src, size_t si
/** /**
* @brief UART read bytes from UART buffer * @brief UART read bytes from UART buffer
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @param buf pointer to the buffer. * @param buf pointer to the buffer.
* *
@@ -577,7 +583,6 @@ int uart_write_bytes_with_break(uart_port_t uart_num, const char* src, size_t si
* *
* @param ticks_to_wait sTimeout, count in RTOS ticks * @param ticks_to_wait sTimeout, count in RTOS ticks
* *
*
* @return * @return
* - (-1) Error * - (-1) Error
* - Others return a char data from uart fifo. * - Others return a char data from uart fifo.
@@ -587,7 +592,7 @@ int uart_read_bytes(uart_port_t uart_num, uint8_t* buf, uint32_t length, TickTyp
/** /**
* @brief UART ring buffer flush * @brief UART ring buffer flush
* *
* @param uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2 * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
* *
* @return * @return
* - ESP_OK Success * - ESP_OK Success