YTM32的Flash应用答疑-详解禁用调试端口功能

Introduction
Principles
Practice & Examples
Demo #1 禁用JTAG/SWD端口
Demo #2 恢复JTAG/SWD端口
Conclusion

Introduction

绝大多数MCU产品在开发完成即将进入量产环节前，为了防止存放在芯片内部flash的程序被意外地篡改，通常会通过禁用下载调试端口，例如Arm核心的处理器使用的JTAG/SWD端口，以此实现读保护的效果。但是，使用禁用调试下载端口的功能时，一定要在应用程序中留一把“钥匙”，在必要的时候，可以通过其它的手段，例如通过UART串口发送一条命令，能够再恢复调试下载端口。

这就好比，锁上门不让未授权的人进屋子，但如果外面的人敲敲门，屋里面的人认识敲门的人，再把门打开，外面的人就可以进屋了。

Principles

各家MCU厂商对禁用调试端口的功能类似，需要将上锁和解锁的配置存放在一块掉电不丢失的存储空间中，以确保每次启动芯片时能自动生效。

以国产云途半导体设计发售的YTM32B1MD14微控制器（Arm Cortex-M33内核）为例，禁用和恢复JTAG/SWD端口的配置位于CUS_NVR区域中，这是一块映射到flash存储器的区域。如图x所示。

其中，禁用JTAG/SWD端口的相关寄存器（存放在flash中），如下：

#define EMF_CUS_NVR_BASE_ADDR            0x10000400

/* for MD. */
#define EFM_CUS_NVR_CUS_KEY_VALUE_ADDR   0x10000400
#define EFM_CUS_NVR_DISABLE_JTAG_ADDR    0x10000408
#define EFM_CUS_NVR_EFM_PROT0_ADDR       0x10000410
#define EFM_CUS_NVR_EFM_PROT1_ADDR       0x10000418

#define EFM_CUS_NVR_TAG_VALUE            0x5A5A5A5A

需要通过EFM模块（Embedded Flash Module）执行特定的操作flash的命令，才能实现执行写入配置码或擦除配置的操作。在附件中源码工程的EFM模块驱动中，有对应的 API 可用：

uint32_t EFM_EraseNVR(EFM_Type * base, uint32_t addr);
uint32_t EFM_ProgramNVR(EFM_Type * base, uint32_t addr, uint32_t * pdata);
uint32_t EFM_ReadNVR(EFM_Type * base, uint32_t addr, uint32_t * pdata);

Practice & Examples

编写用例，演示和验证禁用和恢复YTM32B1MD14微控制器JTAG/SWD端口的功能。样例工程中，使用UART串口同上位机通信，开发者可以通过串口调试终端（例如Tera Term）同微控制器交互，执行上锁和解锁的操作。然后通过JLink调试器尝试连接微控制器内核进行调试的方式，验证调试端口是否可用。

Demo #1 禁用`JTAG/SWD`端口

运行用例：

复位程序后，当串口调试终端问询 enable the disable jtag feature in cus nvr ? [Y/N]. 时，输入Y，则执行上锁操作。
可以继续运行，看到从CUS_NVR中读到的EFM_CUS_NVR_DISABLE_JTAG_ADDR地址位置的值已经被配置为TAG值。如图x所示。

此时，配置操作尚未生效，从图x中可以，看到，调试器还能识别到处理器内核。

复位后生效。芯片中的ROM会在硬件复位过程中自动读CUS_NVR并配置电路。

在图x中可以看到，在程序中执行复位命令复位芯片后，再在Keil的调试配置对话框中单击Scan按钮，扫描调试器连接的处理器内核，已经找不到之前已经连接在调试总线上的内核了。

此时，验证锁定调试端口成功。

其中关键代码在于向CUS_NVR写数：

    printf("enable the disable jtag feature in cus nvr ? [Y/N].\r\n");
    ch = getchar();
    if ('Y' == ch) /* setup the cus_nvr. */
    {
        printf("yes.\r\n");
        /* erase the cus_nvr. */
        EFM_EraseNVR(BOARD_EFM_PORT, EMF_CUS_NVR_BASE_ADDR);
        
        /* program with new values. */
        uint32_t nvr_data[2];
        nvr_data[0] = EFM_CUS_NVR_TAG_VALUE;
        nvr_data[1] = EFM_CUS_NVR_TAG_VALUE;
        EFM_ProgramNVR(BOARD_EFM_PORT, EFM_CUS_NVR_DISABLE_JTAG_ADDR, nvr_data);
        
        /* need to reset to take affect. */
    }

Demo #2 恢复`JTAG/SWD`端口

运行用例：

复位程序后，当串口调试终端问询 release the disable jtag feature in cus nvr ? [Y/N]. 时，输入Y，则执行解锁操作。
可以继续运行，看到从CUS_NVR中读到的EFM_CUS_NVR_DISABLE_JTAG_ADDR地址位置的值已经被还原成全0xFF，如图x所示。

此时，不用复位，就能够立即生效。重新扫描一下处理器内核，可以识别。验证成功。

其中，关键代码在于擦除CUS_NVR的预先配置，恢复成全0xFF：

    printf("release the disable jtag feature in cus nvr ? [Y/N].\r\n");
    ch = getchar();
    if ('Y' == ch) /* setup the cus_nvr. */
    {
        printf("yes.\r\n");
        /* erase the cus_nvr. */
        EFM_EraseNVR(BOARD_EFM_PORT, EMF_CUS_NVR_BASE_ADDR);
    }