Merge branch 'docs/update_get-started' into 'master'

docs: updated gpio and sync up line numbers Closes DOC-3350 and DOC-3390 See merge request espressif/esp-idf!19959
espressif · Sep 9, 2022 · 3ca44d4 · 3ca44d4
2 parents c575dec + 49aaea7
commit 3ca44d4
Show file tree

Hide file tree

Showing 9 changed files with 119 additions and 118 deletions.
diff --git a/components/driver/include/driver/gpio.h b/components/driver/include/driver/gpio.h
@@ -93,8 +93,7 @@ esp_err_t gpio_set_intr_type(gpio_num_t gpio_num, gpio_int_type_t intr_type);
  * @note ESP32: Please do not use the interrupt of GPIO36 and GPIO39 when using ADC or Wi-Fi and Bluetooth with sleep mode enabled.
  *       Please refer to the comments of `adc1_get_raw`.
  *       Please refer to Section 3.11 of <a href="https://espressif.com/sites/default/files/documentation/eco_and_workarounds_for_bugs_in_esp32_en.pdf">ESP32 ECO and Workarounds for Bugs</a> for the description of this issue.
- *       As a workaround, call adc_power_acquire() in the app. This will result in higher power consumption (by ~1mA),
- *       but will remove the glitches on GPIO36 and GPIO39.
+
  *
  * @param  gpio_num GPIO number. If you want to enable an interrupt on e.g. GPIO16, gpio_num should be GPIO_NUM_16 (16);
  *

diff --git a/docs/en/api-reference/peripherals/adc_continuous.rst b/docs/en/api-reference/peripherals/adc_continuous.rst
@@ -200,6 +200,7 @@ Dmax    Maximum of the output ADC raw digital reading result, which is 2^bitwidt
 
 To do further calbration to convert the ADC raw result to voltage in mV, please refer to calibration doc :doc:`adc_calibration`.
 
+.. _hardware_limitations_adc_continuous:
 
 Hardware Limitations
 ^^^^^^^^^^^^^^^^^^^^

diff --git a/docs/en/api-reference/peripherals/adc_oneshot.rst b/docs/en/api-reference/peripherals/adc_oneshot.rst
@@ -143,6 +143,7 @@ Read Raw Result
     ESP_ERROR_CHECK(adc_oneshot_read(adc1_handle, EXAMPLE_ADC1_CHAN1, &adc_raw[0][1]));
     ESP_LOGI(TAG, "ADC%d Channel[%d] Raw Data: %d", ADC_UNIT_1 + 1, EXAMPLE_ADC1_CHAN1, adc_raw[0][1]);
 
+.. _hardware_limitations_adc_oneshot:
 
 Hardware Limitations
 ^^^^^^^^^^^^^^^^^^^^

diff --git a/docs/en/api-reference/peripherals/gpio.rst b/docs/en/api-reference/peripherals/gpio.rst
@@ -198,7 +198,8 @@ Overview
         - JTAG: GPIO12-15 are usually used for inline debug.
         - GPI: GPIO34-39 can only be set as input mode and do not have software-enabled pullup or pulldown functions.
         - TXD & RXD are usually used for flashing and debugging.
-        - ADC2: ADC2 pins cannot be used when Wi-Fi is used. So, if you are having trouble getting the value from an ADC2 GPIO while using Wi-Fi, you may consider using an ADC1 GPIO instead, which should solve your problem. For more details, please refer to `ADC limitations <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/peripherals/adc.html#adc-limitations>`_.
+        - ADC2: ADC2 pins cannot be used when Wi-Fi is used. So, if you are having trouble getting the value from an ADC2 GPIO while using Wi-Fi, you may consider using an ADC1 GPIO instead, which should solve your problem. For more details, please refer to :ref:`Hardware Limitations of ADC Continuous Mode <hardware_limitations_adc_continuous>` and :ref:`Hardware Limitations of ADC Oneshot Mode <hardware_limitations_adc_oneshot>`.
+        - Please do not use the interrupt of GPIO36 and GPIO39 when using ADC or Wi-Fi and Bluetooth with sleep mode enabled. Please refer to `ESP32 ECO and Workarounds for Bugs <https://espressif.com/sites/default/files/documentation/eco_and_workarounds_for_bugs_in_esp32_en.pdf>`_ > Section 3.11 for the detailed description of the issue.
 
 
 .. only:: esp32s2

diff --git a/docs/en/hw-reference/esp32/user-guide-devkitm-1.rst b/docs/en/hw-reference/esp32/user-guide-devkitm-1.rst
@@ -329,4 +329,4 @@ Related Documents
 * `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
 * `ESP Product Selector <https://products.espressif.com/#/product-selector?names=>`_
 
-For other design documentation for the board, please contact us at [email protected].
+For other design documentation for the board, please contact us at [email protected].
diff --git a/docs/zh_CN/api-guides/wifi.rst b/docs/zh_CN/api-guides/wifi.rst
@@ -9,7 +9,7 @@
 
 .. only:: esp32 or esp32s2 or esp32c3 or esp32s3
 
-    - 支持 4 个虚拟接口，即STA、AP、Sniffer 和 reserved。
+    - 支持 4 个虚拟接口，即 STA、AP、Sniffer 和 reserved。
     - 支持仅 station 模式、仅 AP 模式、station/AP 共存模式
     - 支持使用 IEEE 802.11b、IEEE 802.11g、IEEE 802.11n 和 API 配置协议模式
     - 支持 WPA/WPA2/WPA3/WPA2-企业版/WPA3-企业版/WAPI/WPS 和 DPP
@@ -1395,6 +1395,7 @@ Wi-Fi 国家/地区代码
      - 该 station 与 station 模式、WIFI_COUNTRY_POLICY_MANUAL 策略下使用的国家/地区信息相同。
        该 AP 与 AP 模式、WIFI_COUNTRY_POLICY_MANUAL 策略下使用的国家/地区信息相同。
 
+
 主信道
 *************************
 
@@ -1542,7 +1543,7 @@ AP 睡眠
          - iperf example
          - 15575346
 
-    使用 iperf example 测试吞吐量时，sdkconfig 是 :idf_file:` 示例/wifi/iperf/sdkconfig.defaults.esp32`。
+    使用 iperf example 测试吞吐量时，sdkconfig 是 :idf_file:`examples/wifi/iperf/sdkconfig.defaults.esp32`。
 
 .. only:: esp32s2
 
@@ -1586,7 +1587,7 @@ AP 睡眠
           - iperf example
           - 15575346
 
-    使用 iperf example 测试吞吐量时，sdkconfig 是 :idf_file:` 示例/wifi/iperf/sdkconfig.defaults.esp32s2`。
+    使用 iperf example 测试吞吐量时，sdkconfig 是 :idf_file:`examples/wifi/iperf/sdkconfig.defaults.esp32s2`。
 
 .. only:: esp32c3
 
@@ -1630,7 +1631,7 @@ AP 睡眠
           - iperf example
           - 15575346
 
-    使用 iperf example 测试吞吐量时，sdkconfig 是 :idf_file:` 示例/wifi/iperf/sdkconfig.defaults.esp32c3`。
+    使用 iperf example 测试吞吐量时，sdkconfig 是 :idf_file:`examples/wifi/iperf/sdkconfig.defaults.esp32c3`。
 
 .. only:: esp32s3
 
@@ -1674,7 +1675,7 @@ AP 睡眠
           - iperf example
           - 15575346
 
-    使用 iperf example 测试吞吐量时，sdkconfig 是 :idf_file:` 示例/wifi/iperf/sdkconfig.defaults.esp32s3`。
+    使用 iperf example 测试吞吐量时，sdkconfig 是 :idf_file:`examples/wifi/iperf/sdkconfig.defaults.esp32s3`。
 
 Wi-Fi 80211 数据包发送
 ---------------------------

diff --git a/docs/zh_CN/api-reference/peripherals/gpio.rst b/docs/zh_CN/api-reference/peripherals/gpio.rst
@@ -198,7 +198,8 @@ GPIO & RTC GPIO
         - JTAG：GPIO12-15 通常用于在线调试。
         - GPI：GPIO34-39 只能设置为输入模式，不具备软件使能的上拉或下拉功能。
         - TXD & RXD 通常用于烧录和调试。
-        - ADC2：使用 Wi-Fi 时不能使用 ADC2 管脚。因此，如果您在使用 Wi-Fi 时无法从 ADC2 GPIO 获取值，可以考虑使用 ADC1 GPIO 来解决该问题。更多详情请参考 `ADC 限制 <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/peripherals/adc.html#adc-limitations>`_。
+        - ADC2：使用 Wi-Fi 时不能使用 ADC2 管脚。因此，如果您在使用 Wi-Fi 时无法从 ADC2 GPIO 获取值，可以考虑使用 ADC1 GPIO 来解决该问题。更多详情请参考 :ref:`ADC 连续转换模式下的硬件限制 <hardware_limitations_adc_continuous>` 以及 :ref:`ADC 单次转换模式下的硬件限制<hardware_limitations_adc_oneshot>`。
+        - 使用 ADC 或睡眠模式下使用 Wi-Fi 和蓝牙时，请不要使用 GPIO36 和 GPIO39 的中断。有关问题的详细描述，请参考 `ESP32 ECO 和 Bug 解决方法 <https://espressif.com/sites/default/files/documentation/eco_and_workarounds_for_bugs_in_esp32_cn.pdf>`_ > 中的第 3.11 节。
 
 
 .. only:: esp32s2

diff --git a/docs/zh_CN/get-started/linux-macos-setup.rst b/docs/zh_CN/get-started/linux-macos-setup.rst
@@ -189,7 +189,6 @@ ESP-IDF 将下载至 ``~/esp/esp-idf``。
 
     可运行您电脑 Python 文件夹中的 ``Install Certificates.command`` 安装证书。了解更多信息，请参考 `安装 ESP-IDF 工具时出现的下载错误 <https://github.com/espressif/esp-idf/issues/4775>`_。
 
-
 下载工具备选方案
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
Original file line number	Diff line number	Diff line change
Expand Up		@@ -189,7 +189,6 @@ ESP-IDF 将下载至 ``~/esp/esp-idf``。

		可运行您电脑 Python 文件夹中的 ``Install Certificates.command`` 安装证书。了解更多信息，请参考 `安装 ESP-IDF 工具时出现的下载错误 <https://github.com/espressif/esp-idf/issues/4775>`_。


		下载工具备选方案
		~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down