图6.3.1.3 下载程序至开发板中
6.3.2 JTAG下载与调试
本小节的内容是参考乐鑫ESP-IDF编程指南的JTAG 调试章节。
ESP32-S3内置JTAG电路，因此无需额外芯片即可实现调试功能。通过简单地将USB线连接到其D+/D-引脚，即可轻松完成下载与调试操作。利用JTAG接口，开发人员能够运用开源工具OpenOCD对ESP32-S3进行调试。OpenOCD专为嵌入式系统开发和调试设计，可连接到目标硬件的调试接口（如JTAG或SWD），支持调试、固件烧写等硬件相关任务。根据乐鑫官方资料，JTAG下载提供两种方式：一种为直接利用内置的JTAG电路进行调试；另一种则是借助乐鑫官方推出的ESP-PROG调试器，它集成了自动下载固件、串口通信以及JTAG在线调试等多项功能。此外，在VS Code中安装OpenOCD时，它会自动为我们配置好所需环境，使得我们可以直接使用内置的JTAG电路和VS Code中的OpenOCD来下载与调试ESP32-S3芯片，进一步简化了开发流程。 1，前期准备
JTAG下载与调试之前，我们必须修改launch.json和settings.json这两个文件。其中launch.json文件用来配置调试器。
①：进入乐鑫官方提供的VS Code调试配置文件launch.json网址。在该网址下，有详细的说明指导我们如何根据使用JATG调试器或使用VS Code进行调试，来相应地修改launch.json的内容。由于我们选择使用VS Code进行调试，因此launch.json的修改内容如下。
{
"version": "0.2.0",
"configurations": [
{
"name": "GDB",
"type": "cppdbg",
"request": "launch",
"MIMode": "gdb",
"miDebuggerPath": "${command:espIdf.getXtensaGdb}",
"program": "${workspaceFolder}/build/${command:espIdf.getProjectName}.elf",
"windows": {
"program": "${workspaceFolder}\\build\\${command:espIdf.getProjectName}.elf"
},
"cwd": "${workspaceFolder}",
"environment": [{ "name": "PATH", "value": "${config:idf.customExtraPaths}" }],
"setupCommands": [
{ "text": "target remote :3333" },
{ "text": "set remote hardware-watchpoint-limit 2"},
{ "text": "mon reset halt" },
{ "text": "thb app_main" },
{ "text": "flushregs" }
],
"externalConsole": false,
"logging": {
"engineLogging": true
}
}
]
}
②：在settings.json文件下找到"idf.openOcdConfigs"配置选项，我们把该选项的内容修改为一下内容。
"idf.openOcdConfigs": [
"interface/ftdi/esp32_devkitj_v1.cfg",
"target/esp32.cfg"
],
修改为：
"idf.openOcdConfigs": [
"board/esp32s3-builtin.cfg",
],
到了这里，我们已经配置VS Code OpenOCD完成，下面作者来讲解使用JTAG下载与调试操作。
③：cpp_properties.json文件下添加以下红色内容，解决编译过程中总会出现某些文件无法找到头文件的错误信息提醒（有时会是警告）。
{
"configurations": [
{
"name": "ESP-IDF",
"includePath": [
"${config:idf.espIdfPath}/components/**",
"${config:idf.espIdfPathWin}/components/**",
"${config:idf.espAdfPath}/components/**",
"${config:idf.espAdfPathWin}/components/**",
"${config:idf.espAdfPathWin}/components/**",
"${workspaceFolder}/**"
],
"browse": {
"path": [
"${config:idf.espIdfPath}/components",
"${config:idf.espIdfPathWin}/components",
"${config:idf.espAdfPath}/components/**",
"${config:idf.espAdfPathWin}/components/**",
"${workspaceFolder}"
],
"limitSymbolsToIncludedHeaders": false
},
/* 解决 browse.path 中未找到包含文件 */
"configurationProvider": "ms-vscode.cmake-tools"
}
],
"version": 4
}
2，JTAG下载程序
JTAG下载程序流程如下：
使用USB线的Type-C接口连接DNESP32S2开发板左下角的USB口，并USB A口连接到电脑，使得电脑与开发板建立连接。
l 设置USB JTAG接口的端口号（电脑自动识别）。
l 选择“select flash Method”下载方式（五角星），这里我们选择JTAG下载。
l 点击“Full Clean”擦除工程（垃圾桶）。
l 点击“Build Project”编译工程（圆柱形）。
编译成功后，点击“Flash Device”下载程序至开发板中，此时，VS Code提示是否运行OpenOCD，如下图所示：
图6.3.2.1 运行OpenOCD
下载成功后，VS Code右下角提示如下信息。
图6.3.2.2 提示下载成功
3，JTAG调试
JTAG调试非常简单，先把代码下载至开发板，然后点击“运行与调试”，如下图所示：
图6.3.2.3 点击运行与调试
打开运行与调试界面如下图所示：
图6.3.2.4 点击运行调试
此时，系统执行到我们刚刚定义的断电处，如下图所示：
图6.3.2.5 调试效果
在上图中，右上角提供了用于调试代码的选项。由于这些功能在学习MDK时都有所涉及并经常使用，因此作者在此不再过多介绍这些调试选项。
4，调试方法
下面，作者简单介绍一下VS Code调试方法，例如变量怎么加载至监视，反汇编如何打开等实用操作。
变量监控：
打开调试时，选择某个变量右键选择“添加到监视”，如下图所示：
图6.3.2.6 变量添加到监视器中
此时，运行与调试界面显示该变量的当前数值，如下图所示：
图6.3.2.7 监视变量和监视CPU寄存器
在图6.3.2.6中，我们可以打开“反汇编视图”，用户可以查看程序的反汇编指令，理解程序的执行流程，以及分析程序的结构和逻辑，如下图所示：
图66.3.2.8 反汇视图查看函数地址
除了上述的调试方法，大家还需亲自动手实践，才能真正理解VS Code的调试流程。请注意，在使用VS Code对ESP32进行调试时，可能会遇到一些问题。例如，如果调试失败，可能是因为需要先使用JTAG接口下载程序才能进行调试。另外，调试结束后，有时需要重新编译代码才能再次成功调试。最后，调试过程中可能会出现不稳定的情况，如自动断开，这可能是由于VS Code的OpenOCD与ESP32-S3芯片内置的JTAG连接不稳定所致。为了解决这些问题，建议使用乐鑫官方的JTAG调试器。
6.4 原子工程的文件架构解析
在讲解正点原子ESP32工程架构之前，我们先了解一下乐鑫ESP32工程的工程架构，如下所示：
图6.4.1 乐鑫ESP32工程文件架构
从上图可以清晰地看出，除了components文件夹外，该工程架构与我们在6.1小节中新建的架构是一致的。components文件夹主要用于存放第三方驱动库和开发者编写的驱动库。然而，如果我们采用类似于乐鑫ESP32的工程架构进行开发，这可能会导致我们的工程架构变得相当混乱。因此，正点原子采取了一个不同的做法，将开发者编写的驱动文件整理到components文件夹下的BSP文件夹中。此外，我们还简化了CMakeLists.txt文件的管理，通过保留一个CMakeLists.txt文件，就能够加载多个驱动库，从而提高了工程的整洁性和可维护性。
下图是正点原子ESP32工程的架构。
图6.4.2 正点原子ESP32文件架构
从上图中我们可以清晰地观察到，正点原子将所有开发者编写的程序驱动都统一地放置在BSP文件夹下。为了对这些程序驱动实施高效的统一管理，它引入了一个CMakeLists.txt文件。这种做法的显著优势在于，当需要创建新的驱动文件时，我们无需像乐鑫ESP32工程那样，为每一个驱动代码都单独创建一个CMakeLists.txt文件。相反，我们只需使用一个CMakeLists.txt文件即可完成所有相关操作，极大地简化了整个开发流程。接下来，我们将深入探究我们提供的CMakeLists.txt文件，其代码内容如下：
① 源文件路径，指本目录下的所有代码驱动
set(src_dirs
IIC
LCD
LED
SPI
XL9555
KEY
24CXX
ADC
AP3216C
QMA6100P)
② 头文件路径，指本目录下的所有代码驱动
set(include_dirs
IIC
LCD
LED
SPI
XL9555
KEY
24CXX
ADC
AP3216C
QMA6100P)
③ 设置依赖库
set(requires
driver
fatfs
esp_adc
esp32-camera
newlib
esp_timer)
④ 注册组件到构建系统的函数
idf_component_register(SRC_DIRS ${src_dirs} INCLUDE_DIRS
${include_dirs} REQUIRES ${requires})
⑤ 设置特定组件编译选项的函数
component_compile_options(-ffast-math -O3 -Wno-error=format=-Wno-format)
-ffast-math: 允许编译器进行某些可能减少数学运算精度的优化，以提高性能。
-O3: 这是一个优化级别选项，指示编译器尽可能地进行高级优化以生成更高效的代码。
-Wno-error=format: 这将编译器关于格式字符串不匹配的警告从错误降级为警告。
-Wno-format: 这将完全禁用关于格式字符串的警告。
在开发过程中，④和⑤是固定不变的设定。而①和②的确定则依赖于项目所需的驱动文件数量。如果当前目录下缺少某个特定的驱动文件（例如LED驱动文件），但在CMakeLists.txt文件中却指定了需要编译该LED驱动文件，那么在系统编译时将会遇到以下错误：
图6.4.3 未发现LED驱动文件
此时，需要我们添加LED驱动文件，并且清除编译工程文件才能再一次编译工程。
③表示驱动程序需要依赖的库，例如CAMERA驱动程序，它依赖的是esp32-camera这一个摄像头驱动库。下图是CMakeLists.txt未添加依赖库的错误提示。
图6.4.4 未添加依赖库的提示错误（CAMERA驱动程序未添加依赖库）
6.5 基础工程配置
在第三章节中，我们得知正点原子是以ATK-MWS3S模组作为主控，该模组的设计参考了乐鑫的ESP32-S3-WOOD-1的N16R8型号，因此它与乐鑫产品可实现P2P兼容。然而，在6.1小节新建工程时，我们并未立刻适配这款模组的内部资源，例如时钟频率是否设定为240MHz、Flash配置是否为16MB，以及PSRAM的模式是否为OCT和8MB等。这些参数需要由开发者自行配置，否则我们的工程只能使用乐鑫的默认配置进行开发，这样模组便无法充分发挥其应有的性能。下面，作者将逐步引导读者进行基础工程的配置，确保其与正点原子发布的DNESP32S3开发板的主控模组内部资源相匹配。配置流程如下：
1，使用VS Code打开6.1小节新建的工程，并点击左下角齿轮（ESP-IDF: SDK Configuration Editor (menuconfig)）进去menuconfig菜单配置界面，如下图所示：
图6.5.1 进入menuconfig配置界面
关于menuconfig配置界面的具体内容，作者将在后续的章节中进行详细讲解。目前，我们的主要目标是配置与ATK-MWS3S模组相匹配的资源。
2，在上图“Search parameter”搜索框下输入“Flash”进去flash配置界面，配置内容如下所示：
图6.5.2 配置Flash资源
上图中的①“Flash SPI mode”支持四种不同的 SPI flash 访问模式，它们分别为DIO、DOUT、QIO 和 QOUT。下面我们来看一下这几种模式到底有哪些区别，这些模式的对比如下表所示：
可选项 | 模式名称 | 引脚 | 速度 |
QIO | Quad I/O | 地址和数据 4pins | 最快 |
QOUT | Quad Output | 数据 4pins | 约比 qio 模式下慢 15% |
DIO | Dual I/O | 地址和数据 2pins | 约比 qio 模式下慢 45% |
DOUT | Dual Output | 数据 2pins | 约比 qio 模式下慢 50% |
表6.5.1 四种SPI模式的对比
从上表可知，QIO模式的速率为最快，所以我们把基础工程的Flash SPI mode设置为QIO。
上图中的②“Flash SPI speed”提供了120、80、40和20MHz的配置选项。在选择具体速度时，我们需要考虑Flash和PSRAM的SPI接口共享情况。为了优化模组性能，我们最好将flash和PSRAM的SPI速率设置为一致，这样分时访问这两个存储设备时，就不必切换时钟频率了。鉴于PSRAM的SPI速率最高可设置为80MHz，因此我们将flash的SPI速率也设置为80MHz，以确保最佳性能。
上图的③是根据模组挂载的flash来确定的，这里我们选择16MB大小，是毫无争议的。
3，在搜索框中输入“Partition Table”来设置分区表。分区表的主要功能是将flash划分为多个功能各异的区域，包括存储启动文件、代码区域和文件系统区域等子分区，以满足不同的应用需求。后续章节将详细解释分区表的作用和配置方法。下图是基础工程分区表配置参数。
图6.5.3 配置分区表
上图中，我们选择“Custom partition table CSV”自定义分区表，然后设置分区表的名称为partitions-16MiB.csv。稍后我们会设置分区表各个子分区的管理大小。
4，在搜索框中输入“PSRAM”来设置PSRAM参数，配置参数如下图所示：
图6.5.4 设置PSRAM参数
上图的①选项是基于模组内部芯片的选择来确定的。为了正确配置，读者可以查阅《esp32-s3-wroom-1_wroom-1u_datasheet_cn》数据手册的第三页。在该页中，我们可以看到ESP32-S3-WROOM-1-N16R8模组所挂载的PSRAM使用的是Octal SPI模式。因此，在配置过程中，我们应该选择“Octal Mode PSRAM”这一选项。
上图的②选项选择最该的速率即可，并且与Flash SPI速率一致。
5，在搜索框中输入“CPU frequency”来设置CPU的时钟频率，如下图所示：
图6.5.5 配置CPU主频
6，在搜索框中输入“FreeRTOS”来配置系统节拍时钟（tick clock）的频率。默认情况下，“configTICK_RATE_HZ”的值为100，意味着节拍时钟的周期为10ms。因此，调用vTaskDelay(1000)将会导致延时10秒。为了提高定时精度和方便性，建议将该值设置为1000，这样节拍时钟的周期就变为1ms，从而使得vTaskDelay(1000)代表延时1秒。如下图所示：
图6.5.6 配置系统节拍时钟（tick clock）的频率
7，配置分区表各个子分区，我们按下“Ctrl+Shift+P”快捷键打开命令面板，并在搜索栏内输入“打开分区表编辑器”，按以下图配置各个分区的管理大小。
图6.5.7 设置分区表
首先我们按下“Add New Row”选项添加子分区条目，然后设置条目的类型、偏移和大小，最后按下“Save”选项保存退出。
至此，我们已经完成了工程配置，确保其与DNESP32S3开发板所搭载的ATK-MWS3S模组的内部资源相匹配。现在，我们可以利用这个工程在DNESP32S3开发板上进行开发工作。下面我们来看一下当前工程架构，如下图所示：
图6.5.8 正点原子ESP32S3基础工程架构
上图中的sdkconfig.old是之前的基础工程所使用的旧版系统配置文件，用于记录之前的配置信息。而当前的sdkconfig则是系统最新生成的系统配置文件，包含了最新的配置设置。此外，partitions-16MiB.csv是系统配置保存后自动生成的分区表文件，该文件可供用户查看，以便了解当前的分区配置情况。这些文件共同构成了ESP32开发环境的配置体系。
接下来，作者在app_main函数中编写了代码，以获取DNESP32S3开发板上ATK-MWS3S模组的内部资源信息。这些信息包括时钟频率、flash大小以及PSRAM大小等。具体的代码实现如下所示：
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "nvs_flash.h"
#include "esp_system.h"
#include "esp_chip_info.h"
#include "esp_psram.h"
#include "esp_flash.h"
/**
* @retval 无
*/
void app_main(void)
{
esp_err_t ret;
uint32_t flash_size;
esp_chip_info_t chip_info; /* 定义芯片信息结构体变量 */
ret = nvs_flash_init(); /* 初始化NVS */
if (ret == ESP_ERR_NVS_NO_FREE_PAGES
|| ret == ESP_ERR_NVS_NEW_VERSION_FOUND)
{
ESP_ERROR_CHECK(nvs_flash_erase());
ret = nvs_flash_init();
}
esp_flash_get_size(NULL, &flash_size); /* 获取FLASH大小 */
esp_chip_info(&chip_info);
printf("内核：cup数量%d\n",chip_info.cores); /* 获取CPU内核数并显示 */
/* 获取FLASH大小并显示 */
printf("FLASH size:%ld MB flash\n",flash_size / (1024 * 1024));
/* 获取PARAM大小并显示 */
printf("PSRAM size: %d bytes\n", esp_psram_get_size());
while(1)
{
printf("Hello-ESP32\r\n");
vTaskDelay(1000);
}
}
上述代码是获取DNESP32S3开发板上ATK-MWS3S模组的内部资源信息，并打印到监控器上。首先我们编译基础工程，然后下载至开发板中，最后打开监控器查看串口打印内容，如下图所示：
图6.5.9 打印内部资源信息
在以后的例程中，我们是以这个基础工程来延申扩展，所以本章节的内容非常重要，望读者好好理解。
0
/6 
工商网监
湘ICP备2023018690号
90
淘帖
0
