NXP EASY MCU boot loader

NXP官方 MCUBOOT的简化版C实现，砍掉了绝大部分功能，只保留串口下载功能。可以配合官方Win下的命令行工具blhost 或者 GUI工具Kinetis Flash Tool 来实现一个基于MCU串口的bootloader. 这套代码非常容易移植到任何MCU上。建议以后不要再推AN2295这种老古董了，统一迁移到 MCUBOOT上来。鉴于MCUBOOT 官方实现很复杂，故有此地

特色

基础实现和具体硬件完全解耦。只有2个.c .h文件:kptl.c mcuboot.c。除Systick中断外不使用任何中断。只使用串口轮训发送和接收数据。
所有与硬件相关的必要操作全部由回调函数显示。 kptl 和 mcuboot 本身没有任何硬件依赖。非常容易移植到任何ARM Cortex MCU上。kptl和mcuboot写的很小白，有C基础的都可以看的明白，容易改。

支持PART列表

PART	APP起始地址
K64	0x8000
KE02	0x8000
KE04	0xC00
KE15	0x8000
KE17	0x8000
LPC802	0x1000
LPC804	0x1000
KL26	0x8000
KE18F	0x8000
i.MXRT1021	0x40000
i.MXRT1052	0x40000
i.MXRT1062	0x40000
i.MXRT1064	0x40000
LPC51U68(支持UART和USB_HID两种boot loader)	0x8000

文件结构

nxp_easy_mcuboot
├─ Libraries - 存放所有库文件，bootloader源文件
│    ├─ drivers_k64 - NXP KinetisK64 驱动文件
│    ├─ drivers_lpc800  - NXP LPC800驱动文件
│    ├─ drivers_ke  - NXP Kinetis KE0xZ驱动文件
│    ├─ drivers_ke15  - NXP Kinetis KE1xZ和KE1xF驱动文件
│    ├─ drivers_lpc800  - NXP LPC800驱动文件
│    ├─ drivers_lpc800  - NXP LPC800驱动文件
│    ├─ drivers_kl  - NXP KL驱动文件
│    ├─ drivers_rt1021  - NXP i.MXRT102x驱动文件
│    ├─ drivers_rt1052  - NXP i.MXRT105x驱动文件
│    ├─ drivers_rt1062  - NXP i.MXRT106x驱动文件
│    ├─ startup - 所有MCU启动文件
│    └─ utilities - 存放bootloader源代码
├─ Project - example 工程
│    ├─ frdm_k64 基于FRDM-K64的 bootloader示例工程
│    ├─ frdm_ke02 基于FRDM-ke02的 bootloader示例工程
│    ├─ frdm_ke15 基于FRDM-ke15Z的 bootloader示例工程
│    ├─ frdm_ke17 基于FRDM-ke17Z的 bootloader示例工程
│    ├─ lpc802 基于LPC802的 bootloader示例工程
│    ├─ lpc804 基于LPC804的 bootloader示例工程
│    ├─ frdm_kl26 基于frdm_kl26的 bootloader示例工程
│    ├─ evk_imxrt1052_HyperFlash 基于evk_imxrt1052(HyperFlash)的 bootloader示例工程
│    ├─ evk_imxrt1052_QspiFlash 基于evk_imxrt1052(QSPIFlash)的 bootloader示例工程
│    ├─ evk_imxrt1021 基于evk_imxrt1021的 bootloader示例工程
│    ├─ evk_imxrt1062 基于evk_imxrt1062的 bootloader示例工程
│    └─ evk_imxrt1064 基于evk_imxrt1064的 bootloader示例工程
├─ pc_tool - PC工具
│    ├─ KinetisFlashTool.exe  GUI工具，直接使用这个下载程序
│    ├─ KinetisFlashTool.ini
│    ├─ blfwkdll.dll
│    └─ bootloader.log
└─ readme.md

示例

project 文件夹：

Project
├─ frdm_k64
│    ├─ frdm_k64_bl  - bootloader工程，Keil编译
│    └─ frdm_k64_example_app  - app示例工程
└─ lpc802
       ├─ lpc802_bl - bootloader工程，Keil编译
       └─ lpc802_example_app - app示例工程

下面以FRDM-K64为例子说明：

编译 frdm_k64_bl 工程，并使用JLINK下载到 FRDM-K64板子上。
打开KinetisFlashTool.exe 。再MCU复位后300ms内点击连接，连接成功后，上位机会显示MCU信息。
编译frdm_k64_example_app 得到 frdm_k64_example_app.hex文件，选择hex文件，点击"UPDATE"即开始升级

移植

bootloader本身只有4个文件: kptl.c kptl.h mcuboot.c, mcuboot.h.

kptl 负责MCUBOOT协议的基本实现，拆包封包等， mcuboot.c实现 bootloader的基本命令,依赖kptl.c。注意mcuboot.c已经砍掉了大部分官方完整版的命令实现，只保留用于串口下载的最基本命令如擦写编程flash, 获得芯片信息等等。

移植步骤

准备好的你的MCU：确保你已经熟悉了你的MCU。MCU 可以正常跑，串口收发功能已经调通并没有问题， Flash编程，擦写功能已经调通并没有问题。这些非常重要，串口收发和flash的编程功能是bootloader的基本操作。这些功能有bug将直接影响bootloader成功与否。
在工程中加入kptl.c 和 mcuboot.c 并且添加对应的include路径
在工程中定义全局结构： static mcuboot_t mcuboot;，针对i.MXRT平台，注意需要加上attribute((aligned(4))) 四个字节对齐的预编译命令，保证mcuboot结构体里的rx_pkt缓存区是4字节对齐的，因为RT的ROM API需要这样的字节对齐方式才可以正常运行；
在初始化必要的硬件资源后(串口和Flash肯定要初始化吧)。给mcuboot结构填写必要的参数和回调接口

具体需要实现的回调操作如下

需要实现的回调接口函数	说明
op_send	串口发送数据
op_reset	复位MCU
op_jump	MCU跳转到指定地址
op_complete	在bootloader 接收完完整的image后会回调这个函数，一般用于释放硬件资源，该关闭的外设关闭，中断该关的关，让mcu跳转app之前回到一个比较干净的状态
op_mem_erase	flash擦除
op_mem_write	flash编程
op_mem_read	flash读取，i.MXRT平台使用IP Command方式读取，这样在加密状态下也仅读取烧进去的密文，一方面可以方便做回读校验，一方面也不会泄露Flash明文数据

配置：

需要填入的配置	说明
cfg_flash_start	APP启动地址(示例中一般默认为0x1000(4K) 或者0x8000(32K)，RT平台建议为0x40000(256KB，HyperFlash的一个扇区大小))
cfg_flash_size	Flash 大小
cfg_flash_sector_size	flash sector 大小
cfg_ram_start	RAM起始地址。这个字段只是让上位机获取这个信息。移植阶段可以随便填
cfg_ram_size	RAM大小。这个字段只是让上位机获取这个信息。移植阶段可以随便填
cfg_device_id	例子中一般填了一个0x12345678而已。这个字段只是让上位机获取这个信息。移植阶段可以随便填
cfg_uuid	MCU唯一ID。这个字段只是让上位机获取这个信息。移植阶段可以随便填

例子：

/* config the mcuboot */
mcuboot.op_send = mcuboot_send;
mcuboot.op_reset = mcuboot_reset;
mcuboot.op_jump = mcuboot_jump;
mcuboot.op_complete = mcuboot_complete;

mcuboot.op_mem_erase = memory_erase;
mcuboot.op_mem_write = memory_write;
mcuboot.op_mem_read = memory_read;

mcuboot.cfg_flash_start = APPLICATION_BASE; 
mcuboot.cfg_flash_size = TARGET_FLASH_SIZE;
mcuboot.cfg_flash_sector_size = FLASH_GetSectorSize();
mcuboot.cfg_ram_start = 0x20000000;
mcuboot.cfg_ram_size = 128*1024;
mcuboot.cfg_device_id = 0x12345678;
mcuboot.cfg_uuid = GetUID();

mcuboot_init(&mcuboot);

在while1 中，轮训接受串口数据，接到一个byte就调用一次mcuboot_recv, 并轮训调用mcuboot_proc. 同时，可以通过Systick中断设置一个超时函数，超过多少秒后没有收到串口数据就尝试直接跳到app.(例子一般默认300MS)
```
while(1)
{
    if(UART_GetChar(HW_UART0, &c) == CH_OK)
    {
        mcuboot_recv(&mcuboot, &c, 1);
    }
    
    if(timeout_jump == 1)
    {
        mcuboot_jump(APPLICATION_BASE, 0, 0);
        timeout_jump = 0;
    }
    mcuboot_proc(&mcuboot);
}
```

其他一些注意的

Flash的操作实现很重要。一般flash都是块设备，有最小的擦除和编程单位(尤其是LPC, 最小擦除单位和最小编程单位都不一样，而且很大)。这就需要在实现memory_write函数的时候格外注意，该对齐的对齐，该补全的补全，没到最小编程单位的需要提取读出之前的数据并合并，超过最小编程单位的需要多次调用flash_program函数以保证全部写入；
针对i.MXRT平台，在bl_cfg.h里强烈建议定义一下MAX_PACKET_LEN，并把它配置成外部SPI Flash的page size，这样上位机会通过串口一次性下发对应大小的数据帧，MCU端则可以一次性的调用Page_Program API写入这一帧数据，最后一次剩下的数据可能会存在不满足一个Page的情况，MCU会只写入剩下的大小；
```
#define MAX_PACKET_LEN   (256)//Strongly recommend to use NorFlash page size
```
对于MCU复位的实现，直接调用 CMSIS库函数 NVIC_SystemReset即可；
最后跳转之前一般需要把外设全部反初始化，中断(包括SYsTick)该关的都要关掉,可以在mcuboot_complete中完成这些操作；
最后的跳转到用户app 。主要需要干三件事：重新设置PC,SP, 重新设置中断向量表的入口地址：SCB->VTOR。其中SP为Image的0-3字节，PC为image的4-7字节。可直接使用祖传函数：

void JumpToImage(uint32_t addr)
{
    static uint32_t sp, pc;
    uint32_t *vectorTable = (uint32_t*)addr;
    sp = vectorTable[0];
    pc = vectorTable[1];
    
    typedef void(*app_entry_t)(void);

    /* must be static, otherwise SP value will be lost */
    static app_entry_t s_application = 0;

    s_application = (app_entry_t)pc;

    // Change MSP and PSP
    __set_MSP(sp);
    __set_PSP(sp);
    
    SCB->VTOR = addr;
    
    // Jump to application
    s_application();

    // Should never reach here.
    __NOP();
}

APP工程不要忘记修改启动地址；
一些开发板(比如FRDM-KE02) 默认的板载openSDA K20调试器的USB转串口功能做的不好，无法有效识别PING开始命令，导致握手失败，需要更新最新的JLINK OPENSDA firmware才可以用固件下载： https://www.segger.com/products/debug-probes/j-link/models/other-j-links/opensda-sda-v2/

jicheng0622/nxp_easy_mcuboot

NXP EASY MCU boot loader

特色

支持PART列表

文件结构

示例

移植

移植步骤

其他一些注意的