From 70c336963b787e0d797156330bab328fe2613f89 Mon Sep 17 00:00:00 2001 From: Wang Fang Date: Tue, 28 Dec 2021 18:33:18 +0800 Subject: [PATCH] doc: update usb pins and provide a note in api-reference/uart Closes https://github.com/espressif/esp-idf/issues/8811 Signed-off-by: Ivan Grokhotkov --- docs/en/api-guides/usb-serial-jtag-console.rst | 7 +++++-- docs/en/api-reference/peripherals/uart.rst | 1 + 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/en/api-guides/usb-serial-jtag-console.rst b/docs/en/api-guides/usb-serial-jtag-console.rst index e3b7b2b592..5f741dadfa 100644 --- a/docs/en/api-guides/usb-serial-jtag-console.rst +++ b/docs/en/api-guides/usb-serial-jtag-console.rst @@ -13,14 +13,17 @@ Note that, in contrast with the USB OTG peripheral found in some Espressif chips Hardware Requirements ===================== +{IDF_TARGET_USB_DP_GPIO:default="Not Updated!",esp32c3="19",esp32s3="20"} +{IDF_TARGET_USB_DM_GPIO:default="Not Updated!",esp32c3="18",esp32s3="19"} + Connect {IDF_TARGET_NAME} to the USB port as follows: +------+-------------+ | GPIO | USB | +======+=============+ -| 19 | D+ (green) | +| {IDF_TARGET_USB_DP_GPIO} | D+ (green) | +------+-------------+ -| 18 | D- (white) | +| {IDF_TARGET_USB_DM_GPIO} | D- (white) | +------+-------------+ | GND | GND (black) | +------+-------------+ diff --git a/docs/en/api-reference/peripherals/uart.rst b/docs/en/api-reference/peripherals/uart.rst index 57016cedbe..4b606745f2 100644 --- a/docs/en/api-reference/peripherals/uart.rst +++ b/docs/en/api-reference/peripherals/uart.rst @@ -62,6 +62,7 @@ Call the function :cpp:func:`uart_param_config` and pass to it a :cpp:type:`uart // Configure UART parameters ESP_ERROR_CHECK(uart_param_config(uart_num, &uart_config)); +For more information on how to configure the hardware flow control options, please refer to :example:`peripherals/uart/uart_echo`. Multiple Steps """"""""""""""