Merge branch 'docs/add_pin_layout_diagram_and_notes' into 'master'

docs: update user-guide-devkitm-1.rst Closes DOC-3495 See merge request espressif/esp-idf!19517
espressif · Aug 18, 2022 · a93ba27 · a93ba27
2 parents e2d488c + f5f66b9
commit a93ba27
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 13 deletions.
diff --git a/docs/_static/ESP32_DevKitM-1_pinlayout.png b/docs/_static/ESP32_DevKitM-1_pinlayout.png
diff --git a/docs/en/hw-reference/esp32/user-guide-devkitm-1.rst b/docs/en/hw-reference/esp32/user-guide-devkitm-1.rst
@@ -168,7 +168,7 @@ The table below provides the Name and Function of pins on both sides of the boar
 
    * - No.
      - Name
-     - Type
+     - Type [1]_
      - Function
    * - 1
      - GND
@@ -237,23 +237,23 @@ The table below provides the Name and Function of pins on both sides of the boar
    * - 17
      - IO12
      - I/O
-     - GPIO12, ADC2_CH5, TOUCH5, RTC_GPIO15, MTDI, HSPIQ, HS2_DATA2, SD_DATA2, EMAC_TXD3
+     - GPIO12, ADC2_CH5, TOUCH5, RTC_GPIO15, MTDI [2]_, HSPIQ, HS2_DATA2, SD_DATA2, EMAC_TXD3
    * - 18
      - IO13
      - I/O
      - GPIO13, ADC2_CH4, TOUCH4, RTC_GPIO14, MTCK, HSPID, HS2_DATA3, SD_DATA3, EMAC_RX_ER
    * - 19
      - IO15
      - I/O
-     - GPIO15, ADC2_CH3, TOUCH3, RTC_GPIO13, MTDO, HSPICS0, HS2_CMD, SD_CMD, EMAC_RXD3
+     - GPIO15, ADC2_CH3, TOUCH3, RTC_GPIO13, MTDO [2]_, HSPICS0, HS2_CMD, SD_CMD, EMAC_RXD3
    * - 20
      - IO2
      - I/O
-     - GPIO2, ADC2_CH2, TOUCH2, RTC_GPIO12, HSPIWP, HS2_DATA0, SD_DATA0
+     - GPIO2 [2]_, ADC2_CH2, TOUCH2, RTC_GPIO12, HSPIWP, HS2_DATA0, SD_DATA0
    * - 21
      - IO0
      - I/O
-     - GPIO0, ADC2_CH1, TOUCH1, RTC_GPIO11, CLK_OUT1, EMAC_TX_CLK
+     - GPIO0 [2]_, ADC2_CH1, TOUCH1, RTC_GPIO11, CLK_OUT1, EMAC_TX_CLK
    * - 22
      - IO4
      - I/O
@@ -269,7 +269,7 @@ The table below provides the Name and Function of pins on both sides of the boar
    * - 25
      - IO5
      - I/O
-     - GPIO5, HS1_DATA6, VSPICS0, EMAC_RX_CLK
+     - GPIO5 [2]_, HS1_DATA6, VSPICS0, EMAC_RX_CLK
    * - 26
      - IO18
      - I/O
@@ -299,6 +299,19 @@ The table below provides the Name and Function of pins on both sides of the boar
      - I/O
      - GPIO3, U0RXD, CLK_OUT2
 
+.. [1] P: Power supply; I: Input; O: Output.
+.. [2] MTDI, GPIO0, GPIO2, MTDO, and GPIO5 are strapping pins. These pins are used to control several chip functions depending on binary voltage values applied to the pins during chip power-up or system reset. For description and application of the strapping pins, please refer to `ESP32 Datasheet`_ > Section *Strapping Pins*.
+
+Pin Layout
+^^^^^^^^^^^
+
+.. figure:: ../../../_static/ESP32_DevKitM-1_pinlayout.png
+    :align: center
+    :scale: 43%
+    :alt: ESP32-DevKitM-1 (click to enlarge)
+    :figclass: align-center
+
+    ESP32-DevKitM-1 (click to enlarge)
 
 Hardware Revision Details
 ============================

diff --git a/docs/zh_CN/hw-reference/esp32/user-guide-devkitm-1.rst b/docs/zh_CN/hw-reference/esp32/user-guide-devkitm-1.rst
@@ -168,7 +168,7 @@ ESP32-DevKitM-1 的主要组件和连接方式如下图所示。
 
    * - 编号
      - 名称 
-     - 类型
+     - 类型 [1]_
      - 功能     
    * - 1
      - GND 
@@ -237,23 +237,23 @@ ESP32-DevKitM-1 的主要组件和连接方式如下图所示。
    * - 17
      - IO12 
      - I/O 
-     - GPIO12, ADC2_CH5, TOUCH5, RTC_GPIO15, MTDI, HSPIQ, HS2_DATA2, SD_DATA2, EMAC_TXD3       
+     - GPIO12, ADC2_CH5, TOUCH5, RTC_GPIO15, MTDI [2]_, HSPIQ, HS2_DATA2, SD_DATA2, EMAC_TXD3       
    * - 18
      - IO13 
      - I/O 
      - GPIO13, ADC2_CH4, TOUCH4, RTC_GPIO14, MTCK, HSPID, HS2_DATA3, SD_DATA3, EMAC_RX_ER      
    * - 19
      - IO15 
      - I/O 
-     - GPIO15, ADC2_CH3, TOUCH3, RTC_GPIO13, MTDO, HSPICS0, HS2_CMD, SD_CMD, EMAC_RXD3      
+     - GPIO15, ADC2_CH3, TOUCH3, RTC_GPIO13, MTDO [2]_, HSPICS0, HS2_CMD, SD_CMD, EMAC_RXD3      
    * - 20
      - IO2 
      - I/O 
-     - GPIO2, ADC2_CH2, TOUCH2, RTC_GPIO12, HSPIWP, HS2_DATA0, SD_DATA0      
+     - GPIO2 [2]_, ADC2_CH2, TOUCH2, RTC_GPIO12, HSPIWP, HS2_DATA0, SD_DATA0      
    * - 21
      - IO0 
      - I/O 
-     - GPIO0, ADC2_CH1, TOUCH1, RTC_GPIO11, CLK_OUT1, EMAC_TX_CLK      
+     - GPIO0 [2]_, ADC2_CH1, TOUCH1, RTC_GPIO11, CLK_OUT1, EMAC_TX_CLK      
    * - 22
      - IO4 
      - I/O 
@@ -269,7 +269,7 @@ ESP32-DevKitM-1 的主要组件和连接方式如下图所示。
    * - 25
      - IO5 
      - I/O 
-     - GPIO5, HS1_DATA6, VSPICS0, EMAC_RX_CLK      
+     - GPIO5 [2]_, HS1_DATA6, VSPICS0, EMAC_RX_CLK      
    * - 26
      - IO18 
      - I/O 
@@ -297,8 +297,23 @@ ESP32-DevKitM-1 的主要组件和连接方式如下图所示。
    * - 32
      - RXD0 
      - I/O 
-     - GPIO3, U0RXD, CLK_OUT2     
+     - GPIO3, U0RXD, CLK_OUT2
 
+.. [1] P：电源；I：输入；O：输出。
+.. [2] MTDI、GPIO0、GPIO2、MTDO 和 GPIO5 为 Strapping 管脚。在芯片上电和系统复位过程中，Strapping 管脚根据管脚的二进制电压值控制芯片功能。Strapping 管脚的具体描述和应用，请参考 `《ESP32 技术规格书》`_ > 章节 Strapping 管脚。
+
+管脚布局
+^^^^^^^^
+
+ESP32-DevKitM-1 的主要组件和连接方式如下图所示。
+
+.. figure:: ../../../_static/ESP32_DevKitM-1_pinlayout.png
+    :align: center
+    :scale: 43%
+    :alt: ESP32-DevKitM-1 （点击放大）
+    :figclass: align-center
+
+    ESP32-DevKitM-1 （点击放大）
 
 硬件修订历史
 ===============