【经验分享】OTA bootloader swap与Rollback功能

小恩GG

【经验分享】OTAbootloader swap与Rollback功能

一 文档介绍

   官方RT1060 SDK 代码提供了ota_bootloader, 可以供客户实现代码的在线升级，RT10xx OTA bootloader主要功能有两个：

1. 在flash里面实现ISP下载代码到外部flash

2. 提供API给用户，实现不同APP的 swap与rollback

   之前分享了几篇经验分享，详细讲解了使用ISP下载代码的情况：

【经验分享】RT1060OTA bootloader ISP配套APP

【经验分享】RT1060OTA BL ISP下载带SDRAM app

本篇文章主要讲解OTA的memory结构，相关常用API，swap/roll back功能，并且下载APP1,APP2到不同的区域，利用uart输入字符去选择具体的swap运行APP2,还是roll back为APP1运行。

二 ota bootloader原理

2.1 OTA boot loader分区情况

图1

上述分区情况是在外部QSPI flash，大小8Mbyte的情况下。

OTA bootloader: RT SDK ota bootloader 代码

Boot meta 0: 包含了三个partition的起始地址，大小等信息, ISP的外设信息.

Boot meta 1: 包含了三个partition的起始地址，大小等信息.，ISP的外设信息.

Swap meta 0: Bootloader根据meta中的数据进行swap操作

Swap meta 1: Bootloader根据meta中的数据进行swap操作

Partition 1: APP1存放位置

Partition 2: APP2存放位置

Scratch part: APP1 backup位置， 0X60441000前面足够放APP1并且是整数倍sector大小的空间位置。

User data: 用户数据

2.2 swap 和rollback原理

图2

   Partition1和partition2的APP需要带有满足bootloader的ota_header, bootloader 会对APP进行CRC校验，通过才会boot，否则会进入ISP。

  调用API获取partition2的信息，将需要更新的image放到partition2中，这个image必须要具有合法的header，否则不能swap。

   Swap先将partition2scratch位置擦除，然后把partition1的代码写到scratch中，擦除partition1位置，并且将partition2代码写到Partition1位置。

    Rollback， 重新运行之前的APP1，擦除partition2位置，把partition1代码写回partition2位置， 擦除partition1位置，拷贝parition2 scratch位置的代码写到partition1.

2.3 boot meta 和 swap meta

boot_meta 0adddr: 0x0x6003c000 size: 0x0x0000020c

boot_meta 1adddr: 0x0x6003d000 size: 0x0x0000020c

2.3.1 Boot meta

OTA bootloader可以从两个地址获取boot Meta数据，当两个地址存放的meta都是合法时（tag要为('B', 'L', 'M', 'T') // 0x42, 0x4c,0x4d, 0x54），bootloader选择version大的meta。如果两个地方都没有合法的meta在，bootloader会将default的bootmeta值烧写到第一个地址处。

Bootmeta中包含了三个partition的起始地址，大小等信息。SDK demo可以通过调用Bootloader的API找到partition的信息，从而进行image的烧写。

另外boot meta还包含了ISP的peripheral，启动后跳转到APP的等待时间等信息（默认5s）。具体参见如下结构体：

1. //!@brief Partition information table definitions
   
2. typedef struct
   
3. {
   
4.     uint32_t start;        //!< Start address of the partition
   
5.     uint32_t size;         //!< Size of the partition
   
6.     uint32_t image_state;  //!< Active/ReadyForTest/UnderTest
   
7.     uint32_t attribute;    //!< Partition Attribute - Defined for futher use
   
8.     uint32_t reserved[12]; //!< Reserved for future use
   
9. } partition_t;
   
10. 
    
11. //!@brief Bootloader meta data structure
    
12. typedef struct
    
13. {
    
14.     struct
    
15.     {
    
16.         uint32_t wdTimeout;
    
17.         uint32_t periphDetectTimeout;
    
18.         uint32_t enabledPeripherals;
    
19.         uint32_t reserved[12];
    
20.     } features;
    
21. 
    
22.     partition_t partition[kPartition_Max];
    
23.     uint32_t meta_version;
    
24.     uint32_t patition_entries;
    
25.     uint32_t reserved0;
    
26.     uint32_t tag;
    
27. } bootloader_meta_t;

复制代码

2.3.2 swap meta

  OTA bootloader 会从两个地方获取swap meta，如果都非法的话，bootloader会设置一个default值用于进入ISP，这个值最终会写到meta 0对应的地址中（0x6003e000）。如果两个都合法，bootloader会选择version大的meta。

Bootloader根据meta中的数据进行swap操作，某些情况下，reset后meta中的数据会动态修改。主要的行为体现在swap_type这个变量中.

Swap_type的说明如下：

• kSwapType_ReadyForTest ：reset后进行swap
  
  

修改meta中的swap_type为kSwapType_Test.

再次reset后，由于meta中的swap type为kSwapType_Test.Bootloader根据kSwapType_Test.的操作规则进行一次rollback。

2． kSwapType_Test： reset后进行rollback

    这个参数仅供bootloader内部使用，作用就是进行image的rollback

3． kSwapType_Rollback

    Bootloader会在meta中写入kSwapType_Test，reset后bootloader按照kSwapType_Test进行操作

4． kSwapType_Permanent

    Reset后修改meta为kSwapType_Permanent，永远从partition1 boot

结构体如下：

1. //!@brief Swap progress definitions
   
2. typedef struct
   
3. {
   
4.     uint32_t swap_offset;    //!< Current swap offset
   
5.     uint32_t scratch_size;   //!< The scratch area size during current swapping
   
6.     uint32_t swap_status;    // 1 : A -> B scratch,  2 : B -> A
   
7.     uint32_t remaining_size; //!< Remaining size to be swapped
   
8. } swap_progress_t;
   
9. 
   
10. typedef struct
    
11. {
    
12.     uint32_t size;
    
13.     uint32_t active_flag;
    
14. } image_info_t;
    
15. 
    
16. //!@brief Swap meta information, used for the swapping operation
    
17. typedef struct
    
18. {
    
19.     image_info_t image_info[2]; //!< Image info table
    
20. #if !defined(BL_FEATURE_HARDWARE_SWAP_SUPPORTED) || (BL_FEATURE_HARDWARE_SWAP_SUPPORTED == 0)
    
21.     swap_progress_t swap_progress; //!< Swap progress
    
22. #endif
    
23.     uint32_t swap_type;    //!< Swap type
    
24.     uint32_t copy_status;  //!< Copy status
    
25.     uint32_t confirm_info; //!< Confirm Information
    
26.     uint32_t meta_version; //!< Meta version
    
27.     uint32_t reserved[7];  //!< Reserved for future use
    
28.     uint32_t tag;          //!< Swap meta tag
    
29. } swap_meta_t;//!@brief Swap progress definitions
    
30. typedef struct
    
31. {
    
32.     uint32_t swap_offset;    //!< Current swap offset
    
33.     uint32_t scratch_size;   //!< The scratch area size during current swapping
    
34.     uint32_t swap_status;    // 1 : A -> B scratch,  2 : B -> A
    
35.     uint32_t remaining_size; //!< Remaining size to be swapped
    
36. } swap_progress_t;
    
37. 
    
38. typedef struct
    
39. {
    
40.     uint32_t size;
    
41.     uint32_t active_flag;
    
42. } image_info_t;
    
43. 
    
44. //!@brief Swap meta information, used for the swapping operation
    
45. typedef struct
    
46. {
    
47.     image_info_t image_info[2]; //!< Image info table
    
48. #if !defined(BL_FEATURE_HARDWARE_SWAP_SUPPORTED) || (BL_FEATURE_HARDWARE_SWAP_SUPPORTED == 0)
    
49.     swap_progress_t swap_progress; //!< Swap progress
    
50. #endif
    
51.     uint32_t swap_type;    //!< Swap type
    
52.     uint32_t copy_status;  //!< Copy status
    
53.     uint32_t confirm_info; //!< Confirm Information
    
54.     uint32_t meta_version; //!< Meta version
    
55.     uint32_t reserved[7];  //!< Reserved for future use
    
56.     uint32_t tag;          //!< Swap meta tag
    
57. } swap_meta_t;

复制代码

2.4 常用API

     Bootloader对外提供API进行操作。SDK常用的API如下

2.4.1 update_image_state

更新swap meta中的数据，更新之前会校验partition1中image的合法性，如果没有合法的image，swap meta中的数据不会更新，返回failure

2.4.2 get_update_partition_info

获取partition的信息，从而指定需要更新的image的写入地址

2.4.3 get_image_state

获取当前bootimage的状态

None/permanent – 表示image不会再swap

UnderTest – 表示reset后会进行rollback操作

三 操作步骤与实现

  本次操作，准备两个APP：APP1(起始地址0X60040000)和APP2(起始地址0X60240000) bin文件， 分别使用ISP USB HID下载到partition1和partition2, 第一次上电，默认运行APP1，然后通过APP1里面的串口选择实现swap 和rollback功能。

3.1 APP准备

实现代码如下：

1. int main(void)
   
2. {
   
3.     char ch;
   
4.     status_t status;
   
5.     /* Board pin init */
   
6.     BOARD_InitPins();
   
7.     BOARD_InitBootClocks();
   
8.     /* Update the core clock */
   
9.     SystemCoreClockUpdate();
   
10.     BOARD_InitDebugConsole();
    
11. 
    
12.     PRINTF("\r\n------------------hello world + led blinky demo 2.------------------\r\n");
    
13. 
    
14.     PRINTF("\r\nOTA bootloader test...\r\n"
    
15.         "1 - ReadyForTest\r\n"
    
16.         "3 - kSwapType_Permanent\r\n"
    
17.         "4 - kSwapType_Rollback\r\n"
    
18.         "5 - show image state\r\n"
    
19.             "6 - led blinking for 5times\r\n"
    
20.         "r - NVIC reset\r\n");
    
21.     // show swap state in swap meta
    
22.     get_image_swap_state();
    
23.     /* Set systick reload value to generate 1ms interrupt */
    
24.     if (SysTick_Config(SystemCoreClock / 1000U))
    
25.     {
    
26.         while (1)
    
27.         {
    
28.         }
    
29.     }
    
30. 
    
31. 
    
32. 
    
33.     while(1)
    
34.     {
    
35.         ch = GETCHAR();
    
36.         switch(ch)
    
37.         {
    
38.           case '1':
    
39.             status = bl_update_image_state(kSwapType_ReadyForTest);
    
40.             PRINTF("update_image_state to kSwapType_ReadyForTest status: %i\n", status);
    
41.             if (status != 0)
    
42.                PRINTF("update_image_state(kSwapType_ReadyForTest): failed\n");
    
43.             else
    
44.                NVIC_SystemReset();
    
45.             break;
    
46. 
    
47.           case '3':
    
48.             status = bl_update_image_state(kSwapType_Permanent);
    
49.             PRINTF("update_image_state to kSwapType_Permanent status: %i\n", status);
    
50.             if (status != 0)
    
51.                PRINTF("update_image_state(kSwapType_Permanent): failed\n");
    
52.             else
    
53.                NVIC_SystemReset();
    
54.             break;
    
55. 
    
56.           case '4':
    
57.             status = bl_update_image_state(4); // current API code in SDK does not include enumerate data for this, use 4 instead
    
58.             PRINTF("update_image_state to kSwapType_Rollback status: %i\n", status);
    
59.             if (status != 0)
    
60.                PRINTF("update_image_state(kSwapType_Rollback): failed\n");
    
61.             else
    
62.                NVIC_SystemReset();
    
63.             break;
    
64. 
    
65.           case '5':
    
66.               // show swap state in swap meta
    
67.               get_image_swap_state();
    
68.               break;
    
69.           case '6':
    
70.                   Led_blink10times();
    
71.                   break;
    
72. 
    
73.           case 'r':
    
74.                NVIC_SystemReset();
    
75.               break;
    
76. 
    
77.         }
    
78.     }
    
79. 
    
80. }

复制代码

准备的APP需要注意添加正确的ota_header在前0X400位置，否则不能boot或者不能实现swap。

1. const boot_image_header_t ota_header = {
   
2.     .tag           = IMG_HDR_TAG,
   
3.     .load_addr     = ((uint32_t)&ota_header) + BL_IMG_HEADER_SIZE,
   
4.     .image_type    = IMG_TYPE_XIP,
   
5.     .image_size    = 0,
   
6.     .algorithm     = IMG_CHK_ALG_CRC32,
   
7.     .header_size   = BL_IMG_HEADER_SIZE,
   
8.     .image_version = 0,
   
9.     .checksum      = {0xFFFFFFFF},
   
10. };

复制代码

给出一个正确的样本：

图3

这里注意的是，之前的经验分享添加的ota_header只能实现APP1的boot，不能实现swap功能，是因为没有添加正确的image size和checksum值。

所以本文给出一个小软件image_header_padding.exe，可以将输入不带ota_header自动添加正确带有image大小和crc值的前0X400头部。

3.2 操作步骤

准备好的不带ota_header的APP1 evkmimxrt1060_APP1_0X60040400.bin, APP2 image evkmimxrt1060_APP2_0X60240400.bin，blhost.exe，image_header_padding.exe放到一个文件夹下面，APP1,APP2几乎一样，只是打印的结果一个是版本1，一个是版本2：

hello world + led blinky demo 1

hello world + led blinky demo 2

运行如下bat的命令：

1. image_header_padding.exe evkmimxrt1060_APP1_0X60040400.bin 0x60040400
   
2. sleep 20
   
3. 
   
4. blhost.exe -t 50000 -u 0x15a2,0x0073 -j -- get-property 1 0
   
5. sleep 20
   
6. 
   
7. blhost.exe -u -t 1000000 -- flash-erase-region 0x6003c000 0x4000
   
8. sleep 50
   
9. 
   
10. blhost -u -t 5000 -- flash-erase-region 0x60040000 0x10000
    
11. sleep 50
    
12. 
    
13. blhost -u -t 5000 -- write-memory 0x60040000 boot_img_crc32.bin
    
14. sleep 100
    
15. 
    
16. image_header_padding.exe evkmimxrt1060_APP2_0X60240400.bin 0x60040400
    
17. sleep 20
    
18. 
    
19. blhost -u -t 5000 -- flash-erase-region 0x60240000 0x10000
    
20. sleep 50
    
21. 
    
22. blhost -u -t 5000 -- flash-erase-region 0x6043b000 0x10000
    
23. sleep 50
    
24. 
    
25. blhost -u -t 5000 -- write-memory 0x60240000 boot_img_crc32.bin
    
26. sleep 100
    
27. 
    
28. pause

复制代码

主要功能是生成APP1对应带头的image，擦除partition1位置，写入APP1。 生成APP2对应带头的image，擦除partition2和scratch位置，写入APP2。

运行bat在下载ota_bootloader并且复位5秒内，运行ISP连接：

blhost.exe -t 50000 -u 0x15a2,0x0073 -j --get-property 1 0

ota_bootloader可以直接通过IDE下载到0X60000000开始的bootloader区域。

3.3 测试结果

图4

从测试结果可以看到，第一次boot了APP1，imagestate: none

输入1，进行swap,可以发现APP2运行，image state: underTest

输入3, 选择permenant，复位后可以发现，运行的依旧是APP2， image state： permenant

输入4， 选择rollback，复位后可以看到运行APP1，image states：none

自此，完成了swap以及rollback功能的准确运行。

另外输入6，可以查看带有SDRAM的led blinky功能可以准确工作，再一次验证了之前ota_bootloader添加DCD的运行准确。

测试log

1. 
   
2. C:\KerryPC\IMXRTCode\Question\RT1060\bootloader\AN12604\kerry\OTAtest>image_header_padding.exe evkmimxrt1060_APP1_0X60040400.bin 0x60040400
   
3. loadAddress=60040400
   
4. The new boot image has been generated!
   
5. 
   
6. C:\KerryPC\IMXRTCode\Question\RT1060\bootloader\AN12604\kerry\OTAtest>sleep 20
   
7. 
   
8. C:\KerryPC\IMXRTCode\Question\RT1060\bootloader\AN12604\kerry\OTAtest>blhost.exe -t 50000 -u 0x15a2,0x0073 -j -- get-property 1 0
   
9. {
   
10.    "command" : "get-property",
    
11.    "response" : [ 1258424320 ],
    
12.    "status" : {
    
13.       "description" : "0 (0x0) Success.",
    
14.       "value" : 0
    
15.    }
    
16. }
    
17. 
    
18. C:\KerryPC\IMXRTCode\Question\RT1060\bootloader\AN12604\kerry\OTAtest>sleep 20
    
19. 
    
20. C:\KerryPC\IMXRTCode\Question\RT1060\bootloader\AN12604\kerry\OTAtest>blhost.exe -u -t 1000000 -- flash-erase-region 0x6003c000 0x4000
    
21. Inject command 'flash-erase-region'
    
22. Successful generic response to command 'flash-erase-region'
    
23. Response status = 0 (0x0) Success.
    
24. 
    
25. C:\KerryPC\IMXRTCode\Question\RT1060\bootloader\AN12604\kerry\OTAtest>sleep 50
    
26. 
    
27. C:\KerryPC\IMXRTCode\Question\RT1060\bootloader\AN12604\kerry\OTAtest>blhost -u -t 5000 -- flash-erase-region 0x60040000 0x10000
    
28. Inject command 'flash-erase-region'
    
29. Successful generic response to command 'flash-erase-region'
    
30. Response status = 0 (0x0) Success.
    
31. 
    
32. C:\KerryPC\IMXRTCode\Question\RT1060\bootloader\AN12604\kerry\OTAtest>sleep 50
    
33. 
    
34. C:\KerryPC\IMXRTCode\Question\RT1060\bootloader\AN12604\kerry\OTAtest>blhost -u -t 5000 -- write-memory 0x60040000 boot_img_crc32.bin
    
35. Inject command 'write-memory'
    
36. Preparing to send 21516 (0x540c) bytes to the target.
    
37. Successful generic response to command 'write-memory'
    
38. (1/1)100% Completed!
    
39. Successful generic response to command 'write-memory'
    
40. Response status = 0 (0x0) Success.
    
41. Wrote 21516 of 21516 bytes.
    
42. 
    
43. C:\KerryPC\IMXRTCode\Question\RT1060\bootloader\AN12604\kerry\OTAtest>sleep 100
    
44. 
    
45. C:\KerryPC\IMXRTCode\Question\RT1060\bootloader\AN12604\kerry\OTAtest>image_header_padding.exe evkmimxrt1060_APP2_0X60240400.bin 0x60040400
    
46. loadAddress=60040400
    
47. The new boot image has been generated!
    
48. 
    
49. C:\KerryPC\IMXRTCode\Question\RT1060\bootloader\AN12604\kerry\OTAtest>sleep 20
    
50. 
    
51. C:\KerryPC\IMXRTCode\Question\RT1060\bootloader\AN12604\kerry\OTAtest>blhost -u -t 5000 -- flash-erase-region 0x60240000 0x10000
    
52. Inject command 'flash-erase-region'
    
53. Successful generic response to command 'flash-erase-region'
    
54. Response status = 0 (0x0) Success.
    
55. 
    
56. C:\KerryPC\IMXRTCode\Question\RT1060\bootloader\AN12604\kerry\OTAtest>sleep 50
    
57. 
    
58. C:\KerryPC\IMXRTCode\Question\RT1060\bootloader\AN12604\kerry\OTAtest>blhost -u -t 5000 -- flash-erase-region 0x6043b000 0x10000
    
59. Inject command 'flash-erase-region'
    
60. Successful generic response to command 'flash-erase-region'
    
61. Response status = 0 (0x0) Success.
    
62. 
    
63. C:\KerryPC\IMXRTCode\Question\RT1060\bootloader\AN12604\kerry\OTAtest>sleep 50
    
64. 
    
65. C:\KerryPC\IMXRTCode\Question\RT1060\bootloader\AN12604\kerry\OTAtest>blhost -u -t 5000 -- write-memory 0x60240000 boot_img_crc32.bin
    
66. Inject command 'write-memory'
    
67. Preparing to send 21516 (0x540c) bytes to the target.
    
68. Successful generic response to command 'write-memory'
    
69. (1/1)100% Completed!
    
70. Successful generic response to command 'write-memory'
    
71. Response status = 0 (0x0) Success.
    
72. Wrote 21516 of 21516 bytes.
    
73. 
    
74. C:\KerryPC\IMXRTCode\Question\RT1060\bootloader\AN12604\kerry\OTAtest>sleep 100

复制代码

evkmimxrt1060_APP1_0X60040000.zip (663.21 KB, 下载次数: 43)

2021-7-19 17:23 上传

点击文件名下载附件

evkmimxrt1060_ota_bootloader_dcd_uart.zip (2.39 MB, 下载次数: 47)

2021-7-19 17:23 上传

点击文件名下载附件

OTAtest.zip (85.94 KB, 下载次数: 36)

2021-7-19 17:23 上传

点击文件名下载附件

阅读全文

l3142600073

牛x！学习学习

NXP管管

l3142600073 发表于 2021-7-19 19:33
日天牛逼

这、、、、、

waterkingchen

写得真详细，不错。
不过这里还是有一个问题。
App1，App2最好是不要规定地址。开发完成后，发给用户不知道那个版本是那个地址。
如何解决这个问题？拷贝到SDRAM运行？？

小恩GG

waterkingchen 发表于 2021-7-20 11:30
写得真详细，不错。
不过这里还是有一个问题。
App1，App2最好是不要规定地址。开发完成后，发给用户不知道 ...

                if (bl_get_update_partition_info(&update_partition) != kStatus_Success)
                {
                    /* Could not get update partition info */
                    PRINTF("Could not get update partition info\r\n");
                    response.status_code = HTTPSRV_CODE_INTERNAL_ERROR;
                }
                else if ((stored = store_update_image(mpr_ctx, update_partition.start, update_partition.size)) <= 0)
                {
                    /* Error during upload */
                    PRINTF("Error during upload\r\n");
                    response.status_code = HTTPSRV_CODE_INTERNAL_ERROR;
                }
通过get_update_partition_info 获取partition的信息，从而指定需要更新的image的写入地址
对于你自己的APP，你正常生成bin文件即可。
具体你可以参考下lwip_httypssrv_ota_enet这个代码，里面有自生直接更新代码的例子，APP带有写flash的功能。

waterkingchen

小恩GG 发表于 2021-7-20 13:42
if (bl_get_update_partition_info(&update_partition) != kStatus_Success)
           ...

这样就完美。

茗轩孤月

有没有研究IAP更新APP呢，我写了一个，下载到板子，死机，查了好久，还是没找到问题所在

小恩GG

茗轩孤月 发表于 2021-8-27 08:04
有没有研究IAP更新APP呢，我写了一个，下载到板子，死机，查了好久，还是没找到问题所在 ...

下载到板子死机，首先你要确认你的APP是能够准确跑起来的，比如，如果你直接把你的APP下载到目标地址，可以使用MCUbootUtility下载进对应flash地址，你是否能够成功boot起来？
如果能够成功boot，那么你就要查看你死机的情况下，读出来你的APP是否下载完整了？是否还有残缺，这样就可以定位到你的IAP下载代码了。
所以，还是需要先做一个问题定位，然后进一步查看出错点。
如果还有问题，欢迎发问题贴交流。

eefocus_3892993

大佬有个问题请教一下，就是APP2交换过去以后，他的加载、运行地址和APP1所在地址并不匹配，APP2交换过去以后为什么可以运行呢？

fengyun2018

eefocus_3892993 发表于 2023-8-29 17:04
大佬有个问题请教一下，就是APP2交换过去以后，他的加载、运行地址和APP1所在地址并不匹配，APP2交换过去以 ...

看这个0x400AC078就知道了