# 配置 ESP-WROVER-KIT 上的 JTAG 接口

[English]

所有版本的 ESP-WROVER-KIT 开发板都内置了 JTAG 调试功能，要使其正常工作，还需要设置相关跳帽或 DIP 开关来启用 JTAG 功能，并配置 USB 驱动程序。具体步骤请参考以下说明。

## 配置硬件

- 根据 ESP-WROVER-KIT 开发板 文档中所描述的信息，设置 JP8 便可以启用 JTAG 功能。

- 检查 ESP32 上用于 JTAG 通信的引脚是否被接到了其它硬件上，这可能会影响 JTAG 的工作。

  > ESP32 管脚和 JTAG 接口信号
  > ESP32 管脚 | JTAG 信号
  > --- | ---
  > MTDO / GPIO15 | TDO
  > MTDI / GPIO12 | TDI
  > MTCK / GPIO13 | TCK
  > MTMS / GPIO14 | TMS
  > GND | GND

## 配置 USB 驱动

安装和配置 USB 驱动，这样 OpenOCD 才能够与 ESP-WROVER-KIT 板上的 JTAG 接口通信，并且使用 UART 接口上传待烧写的镜像文件。请根据你的操作系统按照以下步骤进行安装配置。

备注

ESP-WROVER-KIT 使用了 FT2232 芯片实现了 JTAG 适配器，所以以下说明同样适用于其他基于 FT2232 的 JTAG 适配器。

### Windows

1. 使用标准 USB A/micro USB B 线将 ESP-WROVER-KIT 与计算机相连接，并打开开发板的电源。

2. 等待 Windows 识别出 ESP-WROVER-KIT 并且为其安装驱动。如果驱动没有被自动安装，请前往 官网 下载并手动安装。

3. 访问 https://github.com/espressif/esp-win-usb-drivers/releases 下载 ESP-WROVER-KIT 驱动程序。解压驱动程序文件并 安装驱动程序。这会更改 Dual RS232-HS (Interface 0) 的驱动程序。

4. 现在，ESP-WROVER-KIT 的 JTAG 接口应该可以被 OpenOCD 使用了，想要进一步设置调试环境，请前往 运行 OpenOCD 章节。

备注

如果驱动程序安装失败或 OpenOCD 无法运行，尝试以下步骤手动更改驱动程序。否则，可以跳过以下步骤。

### Windows - 手动更改驱动程序

1. 从 https://zadig.akeo.ie/ 下载 Zadig 工具 (Zadig_X.X.exe) 并运行。

2. 在 Zadig 工具中进入 Options，选中 List All Devices。

3. 检查设备列表，其中应该包含两条与 ESP-WROVER-KIT 相关的条目： Dual RS232-HS (Interface 0) 和 Dual RS232-HS (Interface 1)。驱动的名字应为 FTDIBUS (vxxxx) 并且 USB ID 为：0403 6010。

   在 Zadig 工具中配置 JTAG USB 驱动

4. 第一个设备 (Dual RS232-HS (Interface 0)) 连接到了 ESP32 的 JTAG 端口，此设备原来的 FTDIBUS (vxxxx) 驱动程序需替换为 WinUSB (v6xxxxx)。为此，请选择 Dual RS232-HS(Interface 0) 并将驱动程序重新安装为 WinUSB (v6xxxxx)，见上图。

备注

请勿更改第二个设备 Dual RS232-HS (Interface 1) 的驱动，它被连接到 ESP32 的串口 (UART)，用于上传应用程序映像给 ESP32 进行烧写。

### Linux

1. 使用标准 USB A/micro USB B 线将 ESP-WROVER-KIT 与计算机相连接，并打开开发板电源。

2. 打开终端，输入 `ls -l /dev/ttyUSB*` 命令检查操作系统是否能够识别开发板的 USB 端口。类似识别结果如下：

       user-name@computer-name:~/esp$ ls -l /dev/ttyUSB*
       crw-rw---- 1 root dialout 188, 0 Jul 10 19:04 /dev/ttyUSB0
       crw-rw---- 1 root dialout 188, 1 Jul 10 19:04 /dev/ttyUSB1

3. 设置 OpenOCD 所支持 USB 设备的访问权限，请将 udev 规则文件 复制到 `/etc/udev/rules.d` 目录中。

4. 注销并重新登录 Linux 系统，然后重新插拔开发板电源使之前的改动生效。在终端再次输入 `ls -l /dev/ttyUSB*` 命令进行验证，查看这两个设备的组所有者是否已经从 `dialout` 更改为 `plugdev`:

       user-name@computer-name:~/esp$ ls -l /dev/ttyUSB*
       crw-rw-r-- 1 root plugdev 188, 0 Jul 10 19:07 /dev/ttyUSB0
       crw-rw-r-- 1 root plugdev 188, 1 Jul 10 19:07 /dev/ttyUSB1

   如果看到类似的输出结果，并且你也是 `plugdev` 组的成员， 那么设置工作就完成了。

   具有较低编号的 `/dev/ttyUSBn` 接口用于 JTAG 通信，另一路接口被连接到 ESP32 的串口 (UART)，用于上传应用程序映像给 ESP32 进行烧写。

现在，ESP-WROVER-KIT 的 JTAG 接口应该可以被 OpenOCD 使用了，想要进一步设置调试环境，请前往 运行 OpenOCD 章节。

### MacOS

在 macOS 上，同时使用 FT2232 的 JTAG 接口和串口还需另外进行其它操作。当操作系统加载 FTDI 串口驱动的时候，它会对 FT2232 芯片的两个通道做相同的操作。但是，这两个通道中只有一个是被用作串口，而另一个用于 JTAG，如果操作系统已经为用于 JTAG 的通道加载了 FTDI 串口驱动的话，OpenOCD 将无法连接到芯片。有两个方法可以解决这个问题：

1. 在启动 OpenOCD 之前手动卸载 FTDI 串口驱动程序，然后启动 OpenOCD，再加载串口驱动程序。

2. 修改 FTDI 驱动程序的配置，使其不会为 FT2232 芯片的通道 A 进行自我加载，该通道用于 ESP-WROVER-KIT 板上的 JTAG 通道。

#### 手动卸载驱动程序

1. 从 FTDI 官网 安装驱动。

2. 使用 USB 线连接 ESP-WROVER-KIT。

3. 卸载串口驱动

       sudo kextunload -b com.FTDI.driver.FTDIUSBSerialDriver

   有时，你可能还需要卸载苹果的 FTDI 驱动:

   - macOS < 10.15:

         sudo kextunload -b com.apple.driver.AppleUSBFTDI

   - macOS 10.15:

         sudo kextunload -b com.apple.DriverKit-AppleUSBFTDI

   警告

   对于 FTDI 驱动，如果使用串口的通道不正确，则可能会导致内核崩溃。ESP-WROVER-KIT 将通道 A 用于 JTAG，通道 B 用于串口。

4. 运行 OpenOCD:

       .. include:: esp32.inc
           :start-after: run-openocd
           :end-before: ---

5. 在另一个终端窗口，再一次加载 FTDI 串口驱动:

       sudo kextload -b com.FTDI.driver.FTDIUSBSerialDriver

备注

如果你需要重启 OpenOCD，则无需再次卸载 FTDI 驱动程序，只需停止 OpenOCD 并再次启动它。只有在重新连接 ESP-WROVER-KIT 或者切换了电源的情况下才需要再次卸载驱动。

你也可以根据自身需求，将此过程包装进 shell 脚本中。

#### 修改 FTDI 驱动

简而言之，这种方法需要修改 FTDI 驱动程序的配置文件，这样可以防止为 FT2232H 的通道 B 自动加载串口驱动。

备注

其他开发板可能将通道 A 用于 JTAG，因此请谨慎使用此选项。

警告

此方法还需要操作系统禁止对驱动进行签名验证，因此可能无法被所有的用户所接受。

1. 使用文本编辑器打开 FTDI 驱动的配置文件（注意 `sudo`）:

       sudo nano /Library/Extensions/FTDIUSBSerialDriver.kext/Contents/Info.plist

2. 找到并删除以下几行:

       <key>FT2232H_B</key>
       <dict>
           <key>CFBundleIdentifier</key>
           <string>com.FTDI.driver.FTDIUSBSerialDriver</string>
           <key>IOClass</key>
           <string>FTDIUSBSerialDriver</string>
           <key>IOProviderClass</key>
           <string>IOUSBInterface</string>
           <key>bConfigurationValue</key>
           <integer>1</integer>
           <key>bInterfaceNumber</key>
           <integer>1</integer>
           <key>bcdDevice</key>
           <integer>1792</integer>
           <key>idProduct</key>
           <integer>24592</integer>
           <key>idVendor</key>
           <integer>1027</integer>
       </dict>

3. 保存并关闭文件。

4. 禁用驱动的签名认证：

   1. 点击苹果的 logo，选择 “Restart...”

   2. 重启后当听到响铃时，立即按下键盘上的 CMD+R 组合键

   3. 进入恢复模式后，打开终端

   4. 运行命令:

          csrutil enable --without kext

   5. 再一次重启系统。

完成这些步骤后，就可以同时使用串口和 JTAG 接口了。

想要进一步设置调试环境，请前往 运行 OpenOCD 章节。

此文档对您有帮助吗？

- 反馈已收到，谢谢！
- 如果您有其他意见，欢迎填写乐鑫文档反馈表。

- 我们重视您的反馈。
- 您可以填写乐鑫文档反馈表告诉我们如何改进该文档。