Explorar o código

uart driver docs: Remove references to setting interrupt number

Closes #185 https://github.com/espressif/esp-idf/issues/185
Angus Gratton %!s(int64=9) %!d(string=hai) anos
pai
achega
4db4e28b6e
Modificáronse 1 ficheiros con 0 adicións e 3 borrados
  1. 0 3
      components/driver/include/driver/uart.h

+ 0 - 3
components/driver/include/driver/uart.h

@@ -469,8 +469,6 @@ esp_err_t uart_intr_config(uart_port_t uart_num, const uart_intr_config_t *intr_
  * @brief Install UART driver.
  * @brief Install UART driver.
  *
  *
  * UART ISR handler will be attached to the same CPU core that this function is running on.
  * UART ISR handler will be attached to the same CPU core that this function is running on.
- * 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.
  *
  *
  * @param uart_num 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, rx_buffer_size should be greater than UART_FIFO_LEN.
  * @param rx_buffer_size UART RX ring buffer size, rx_buffer_size should be greater than UART_FIFO_LEN.
@@ -644,7 +642,6 @@ esp_err_t uart_enable_pattern_det_intr(uart_port_t uart_num, char pattern_chr, u
  * @code{c}
  * @code{c}
  * //1. Setup UART
  * //1. Setup UART
  * #include "freertos/queue.h"
  * #include "freertos/queue.h"
- * #define UART_INTR_NUM 17                                //choose one interrupt number from soc.h
  * //a. Set UART parameter
  * //a. Set UART parameter
  * int uart_num = 0;                                       //uart port number
  * int uart_num = 0;                                       //uart port number
  * uart_config_t uart_config = {
  * uart_config_t uart_config = {