Merge pull request #14 from bcmi-labs/dfu_qspi

Add DFU support for loading images on external QSPI

Author: pennam

.gitignore

@@ -11,6 +11,6 @@ mbed_settings.py
 mbed_settings.pyc
 mbed_config.h
 *.hex
-*.pem
 mbed-os/*
+mbed-os/
 mcuboot/*

README.md

@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCwWzKpkTb6xQTJ
+R64n6Um8vpIT1wgVPMNJjWbGVmTENdfidbaLNXA4hrE+XXP1ESQvd7f+gxJXWjXn
+kZmKOqfTjWZbNbebHyVehxmpCQBLJTS9aapq+e1NC0bXOB4pHeNoprekXwBVedDz
+kDJhDFORCsdhEHbqJTRRnI/ZYnIv4W2ATfVwOHi3z+uEG4Q9jTfy9jPLH66wYCAW
+PZaKaM1NDRBlWiii1JaayntTGeuyPHAaJB34hr4uNm/pdsMzd84Psta56jbojCmV
+4jUQCtrwvKQXcEsVxnFlBQOPjx7I7j11sPId/PG5TdJ+NQTOMgXcFkSz+QXKG0ZX
+rMF2ExUVAgMBAAECggEAFolg/QhgpUU+Klatq84FLUiRNFXbY5NjRWf7hUcPE3/p
++befP0Tx9VdJGTYqFlw9ao97BNxNILqXfuM9YsvCHKfKN8eykfE1/lF3dwF+dxvn
+FHmHXKpZp+nUALbcK9b086+ych/t0/6ANE/uEDbaCwP8nKvU9nEQsYk3XMlW3EVV
+O+mKr/3+PauAskwEVGUjInVXLRrV+wukoTKcEgI3kecUlsfTgOWO4NVuElsGjHT2
+6XumzhJUXGwE/rf1evk1Fi+s+ViqMAnVyx0wdtC4grSRMMLtgZmBe4ooBSgP2U39
+xuB6JF1Ffs/P0X112U+DIE2tYuBrYE4ie+/lUTp1QQKBgQDaoCzJYS7we14EYS1f
+GYJ+84TMKotItcvPZhRW2nL73IeIuojt878YtLxIU+G3esGvPO6LJAuTGxYOaTP5
+guAmOyWiajmde1cIA5uPtrVpe6W0Y3YdOZaPr8LAvyYTS2HFqQFaqUMbRzVb3y6q
+tBKzaihuNhsKe0K+hUyE8SmupQKBgQDOgSoMf0JRn3W2ayN/Bra1OEiMM9oWwJrd
+0lPxYszHgGWKqsYnvaHNTNfqMUkcTGb+5tnspRE9ZFzE0l2epz+W+comfoeffOsa
+RHPWSW7lSz2jNsVCWsPqervXDidLdM+2lqp8gCU5cz9q0CNCFU/w6S11Jh1eyC6N
+kPNZL/jxsQKBgHihQrUG84Brga/G8uLzT2a+9To2C05eSQux1m0p8aH4x6vwyNcK
+1BlMuErsRbIYgMAxTanmhKBxpJTlBXGZ/hX6MsTP+eRkBtx8KRx+AtEmEYNcEfME
+MIgtwbbagabJxDPtEbs1g7qMauu7VKOJ4nuuioptPjRlWKmJIXSFIKulAoGBALR5
+dgJOBevH7Nxsbi1J9MwUUHMXrfZMhgxvESXZLxb8Q8IY1e1Ncec2zUzDnh25OBp2
+Lub+rD53RAxPvbo2eQC9dcqGsojUZ7QhNwuESgLi6w+FgognQynd8eRVXko34IC2
+1HDSnbXD3xy+otHSRndJkozbrrdzRBw9HjBIGM1BAoGAQMqGduiOMMuWzKunwFgB
+zvq8++chO80jZiwEsB98wMYbKnqVX8j39znKkRBl0bOsHuZNpyXYriESUKu7DjXf
+2vMNsQmYnREqrPuMRqcrYK7KIAQBF9AaDFqtCxgNdFpBU/XlfgNwoM/V3Uz3VsSW
+ImMyIlKBPW83511QcseW+jg=
+-----END PRIVATE KEY-----

assets/current-layout.png

@@ -20,8 +20,7 @@
 #include "LittleFileSystem.h"
 #endif
 
-#define ALL_IN_SD 1
-
+static bool BlockTableLoaded = false;
 static BlockTableData block_info[2];
 
 static void loadOTAData(void) {
@@ -92,7 +91,7 @@ static void loadOTAData(void) {
         block_info[SECONDARY_BLOCK_DEVICE].mbr_flag = 1;
 
         block_info[SCRATCH_BLOCK_DEVICE].storage_type = INTERNAL_FLASH_OFFSET;
-        block_info[SCRATCH_BLOCK_DEVICE].data_offset = 2;
+        block_info[SCRATCH_BLOCK_DEVICE].data_offset = MCUBOOT_SCRATCH_START_ADDR;
         block_info[SCRATCH_BLOCK_DEVICE].update_size = MCUBOOT_SCRATCH_SIZE;
         block_info[SCRATCH_BLOCK_DEVICE].raw_type = INTERNAL_FLASH_FLAG;
         block_info[SCRATCH_BLOCK_DEVICE].raw_flag = 1;
@@ -367,29 +366,31 @@ static void initBlockTable(void) {
  */
 mbed::BlockDevice* get_secondary_bd(void) {
 
-    initBlockTable();
+    if(!BlockTableLoaded) {
+        initBlockTable();
+        BlockTableLoaded = true;
+    }
 
     if(block_info[SECONDARY_BLOCK_DEVICE].raw_flag) {
         return block_info[SECONDARY_BLOCK_DEVICE].log_bd;
     } else {
         return block_info[SECONDARY_BLOCK_DEVICE].file_bd;
     }
-
-    BOOT_LOG_ERR("Cannot define secondary Blockdevice Instance");
-    return NULL;
 }
 
 
 mbed::BlockDevice* get_scratch_bd(void) {
 
+    if(!BlockTableLoaded) {
+        initBlockTable();
+        BlockTableLoaded = true;
+    }
+
     if(block_info[SCRATCH_BLOCK_DEVICE].raw_flag) {
         return block_info[SCRATCH_BLOCK_DEVICE].log_bd;;
     } else {
         return block_info[SCRATCH_BLOCK_DEVICE].file_bd;
     }
-
-    BOOT_LOG_ERR("Cannot define secondary Blockdevice Instance");
-    return NULL;
 }
 
 #endif

assets/nRF52840-mcuboot-map.png

@@ -12,7 +12,7 @@
 #endif
 
 #define BOOTLOADER_CONFIG_MAGIC   0xA0
-#define BOOTLOADER_VERSION        22
+#define BOOTLOADER_VERSION        0
 
 #define PORTENTA_USB_SPEED_HIGH   1
 #define PORTENTA_USB_SPEED_FULL   2

encrypt_keys.pem

@@ -30,8 +30,8 @@
 #define USBD_PID                      0x035B
 #define USBD_LANGID_STRING            0x409
 #define USBD_MANUFACTURER_STRING      "Arduino SA"
-#define USBD_PRODUCT_HS_STRING        "Envie H7 Bootloader"
-#define USBD_PRODUCT_FS_STRING        "Envie H7 Bootloader"
+#define USBD_PRODUCT_HS_STRING        "Portenta MCUBoot"
+#define USBD_PRODUCT_FS_STRING        "Portenta MCUBoot"
 #define USBD_CONFIGURATION_HS_STRING  "DFU Config"
 #define USBD_INTERFACE_HS_STRING      "DFU Interface"
 #define USBD_CONFIGURATION_FS_STRING  "DFU Config"

envie/ota.cpp

@@ -26,12 +26,13 @@
 #include "target_init.h"
 #include "QSPIFBlockDevice.h"
 #include "FlashSimBlockDevice.h"
+#include "flash_map_backend/secondary_bd.h"
 
 /* Private typedef ----------------------------------------------------------- */
 /* Private define ------------------------------------------------------------ */
-#define FLASH_DESC_STR      "@Internal Flash   /0x08000000/01*128Ka,15*128Kg"
-//#define OPTIONB_DESC_STR    "@Option Bits      /0x52002000/01*1Ka"
-#define QSPI_FLASH_DESC_STR "@External Flash   /0x90000000/4096*4Kg"
+#define FLASH_DESC_STR      "@Internal Flash  2MB   /0x08000000/01*128Ka,15*128Kg"
+//#define BOOTLOADER_DESC_STR    "@Option Bits      /0x52002000/01*1Ka"
+#define QSPI_FLASH_DESC_STR "@External Flash 16MB   /0x90000000/16*128Kg"
 
 #define FLASH_ERASE_TIME    (uint16_t)0
 #define FLASH_PROGRAM_TIME  (uint16_t)0
@@ -52,7 +53,7 @@ uint16_t Flash_If_DeInit(void);
 uint16_t Flash_If_GetStatus(uint32_t Add, uint8_t Cmd, uint8_t * buffer);
 
 FlashIAP flash;
-QSPIFBlockDevice qspi_flash(PD_11, PD_12, PF_7, PD_13, PF_10, PG_6, QSPIF_POLARITY_MODE_1, 40000000);
+mbed::BlockDevice* dfu_secondary_bd = get_secondary_bd();
 
 const uint32_t QSPIFLASH_BASE_ADDRESS   =  0x90000000;
 
@@ -74,8 +75,8 @@ bool Flash_If_Init_requested = false;
 
 void init_Memories() {
   flash.init();
-  qspi_flash.init();
-  snprintf(BOOTLOADER_DESC_STR, sizeof(BOOTLOADER_DESC_STR), "@Bootloader version %d /0x00000000/0*4Kg", BOOTLOADER_VERSION);
+  dfu_secondary_bd->init();
+  snprintf(BOOTLOADER_DESC_STR, sizeof(BOOTLOADER_DESC_STR), "@MCUBoot version %d /0x00000000/0*4Kg", BOOTLOADER_VERSION);
 }
 
 Thread writeThread(osPriorityHigh);
@@ -101,7 +102,7 @@ uint16_t Flash_If_Init(void)
 uint16_t Flash_If_DeInit(void)
 {
   flash.deinit();
-  qspi_flash.deinit();
+  dfu_secondary_bd->deinit();
   return 0;
 }
 
@@ -118,7 +119,7 @@ uint16_t Flash_If_Erase(uint32_t Add)
 {
   if (isExternalFlash(Add)) {
     Add -= QSPIFLASH_BASE_ADDRESS;
-    return qspi_flash.erase(Add, qspi_flash.get_erase_size(Add));
+    return dfu_secondary_bd->erase(Add, dfu_secondary_bd->get_erase_size(Add));
   } else {
     return flash.erase(Add, flash.get_sector_size(Add));
   }
@@ -147,10 +148,10 @@ uint16_t Flash_If_Write(uint8_t * src, uint8_t * dest, uint32_t Len)
 {
   if (isExternalFlash((uint32_t)dest)) {
     dest -= QSPIFLASH_BASE_ADDRESS;
-    if (Len < qspi_flash.get_erase_size(0)) {
-      Len = qspi_flash.get_erase_size(0);
+    if (Len < dfu_secondary_bd->get_erase_size(0)) {
+      Len = dfu_secondary_bd->get_erase_size(0);
     }
-    return qspi_flash.program(src, (uint32_t)dest, Len);
+    return dfu_secondary_bd->program(src, (uint32_t)dest, Len);
   } else {
     uint8_t* srcCopy = (uint8_t*)malloc(Len);
     memcpy(srcCopy, src, Len);
@@ -177,8 +178,7 @@ uint8_t *Flash_If_Read(uint8_t * src, uint8_t * dest, uint32_t Len)
 
   if (isExternalFlash((uint32_t)src)) {
     src -= QSPIFLASH_BASE_ADDRESS;
-
-    qspi_flash.read(dest, (uint32_t)src, Len);
+    dfu_secondary_bd->read(dest, (uint32_t)src, Len);
   } else {
     for (i = 0; i < Len; i++)
     {

envie/target_init.h

@@ -1 +1 @@
-https://github.com/bcmi-labs/mbed-os-h747/#217dd927510743655f7a609a7f3fb5b1834a806a
+https://github.com/bcmi-labs/mbed-os-h747/#aea3bc7eabf0063b5edc2f50348cfd4e6e24c17b

envie_dfu/usbd_desc.c

@@ -1 +1 @@
-https://github.com/bcmi-labs/mcuboot/#d46fa881317c3608b349028dd1c4f3fa2376c4bf
+https://github.com/bcmi-labs/mcuboot/#06b344015e753f6f9536a4019857a386259512ba

envie_dfu/usbd_dfu_flash.cpp

@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDTWNjk6BHDIpsg
+9RrlXp1Ty6+TuCf4jJiycdnFtly7eT3xSyQixLLxHcTyWdJbcqSYbPiYFysY7ny8
+Ob1iqWmzj4pXg7ZztEJXHE2fuAJvgeutat9RtYBnyE8jFb8xwrLCSnoViW3lVTrG
+cUSxZWISg/iH+48DnbvsF2f+dWbItEgYMRvPv0PtzqaKIjQswnGhr6ezJYaE6v9j
+tX/qX+4fiyRrCP1JW8pEQXn7szsb5W3PKE43EHP6QigJ/pC0jwz9W2fHj46sxxVt
+L31e43pAkzXf+UAMtmdSuQck3vseOcltUnrQ00TUr59mqYOnd0Z1ADzRSrfqLndF
+YG/xgdEhAgMBAAECggEAT4I6Potruzx2ncR39NhOWarkB6+dIe1KuL8KDU5YvpKT
+EgaRtp7HLtxjLkVKVOrhLxK3xwfYR83YkTsrm0VepZWXlurPJeInnvvf2/luuSJo
+VlpBX0zn3KNH2kwhHIhBlcRM/3MvK7qPnP4ZuJ8KcSrCwe2KVPLvMpdvoRPrsg8p
+lj8djsont+/8enzVkPmSs+w5pMd3r61ejRJyt2Nrm0lkHzETv0Upt43+1OLutUEm
+bwT5kdV/lq/n5npzBoqDjQH7qxowjwz2tGN+vIY+2m75MiScwMwxms+Jy93ueuem
+/Vkel7WtCV/Wss8gBHxmt+hfWD0ydEPBmJ5u1QHX0QKBgQDq97IgLNVN1mdFDz07
+tOn8TmmhOkt+Dkvq1uMOF8ct3NO6NzpKfFy09WrhqBDoXALf30tA30T7zBJJxwiL
+pIUNxAzt7f1RB1zgGw7J/at2shQhpPVG1Mk0WN1YHcxbbmB2dOR6OB4Jp66+sJkZ
+AXaskAIuIEngj06nChvlTFLYVQKBgQDmQ+KneG2wVeS+imIOuLVgYy51r/xdos/m
+bu22nRcVpTuu7wbE0pK71o0D2M1dvlbfDKmYyDlvOmSBYQmrjGTkLiuMycJMVgTR
+aL2PTDFdWsoXfVs5scZnKZFf5HKChZ5jv/Qvqm3uhpzNiXLvXyce+/rl85CfL91P
+/naAVH+RnQKBgCW1txq+10T0wgItXfB1KpBZrU444uDKPpjj//DFFCxiIoDiWDKY
+HvDT6mFo7b289qEjXxp8OsAGknDQxqhSsR/ydPjCl0Mn4Vn+PbNhSOF11xFHPi4t
+/FSwZmW78o5B+q1IOVr8IqX+CWeFRCzlNTygqBjrCbBGj6LzVmLIiws5AoGBAOD7
+GRyqFPpCojHtgauCm2zm20EPxxMx/dHXNpnDWQfEHtFoKAPs/oNbOQK2NMnQLI7Y
+j2iA0WU093hV+J3NmdI8rj5r71SogyKcJQI63syo5WYYDCcN5J1tRuYbjiqrJTuv
+FIXyDmEM024bStpI7S9f4iAFX5u5p5H+PYhbhx0dAoGBAOlj8Q45yaWlZerW8/jh
+Bx2zzieu3ybPg7zSy8v+dDqhck0MYrS5jU1jMOl0fHvTKbWKjbm9nqIeWeTMcJLB
+Fb6VyVF2PrwbPlOLVOs3uxcVUf8Z3GH8eDKlI/h9i2DgLAXA2GjQ7VwB19q53zxp
+cEjsBvtBtVD6R9DXt7iu6v3x
+-----END PRIVATE KEY-----

mbed-os.lib

@@ -26,7 +26,11 @@ void create_scratch_file(void) {
   int size=0;
 
   while(size < 128 * 1024) {
-    fwrite(buffer, 128, 1, fp);
+    int ret = fwrite(buffer, 128, 1, fp);
+    if(ret != 1) {
+      Serial.println("Error writing scratch file");
+      break;
+    }
     size += 128;
   }
 
@@ -39,7 +43,11 @@ void create_update_file(void) {
   int size=0;
 
   while(size < 768 * 1024) {
-    fwrite(buffer, 128, 1, fp);
+    int ret = fwrite(buffer, 128, 1, fp);
+    if(ret != 1) {
+      Serial.println("Error writing scratch file");
+      break;
+    }
     size += 128;
   }
 

mcuboot.lib

@@ -0,0 +1,141 @@
+#include "FlashIAP.h"
+#include "bootloader.h"
+
+#ifndef CORE_CM7  
+  #error Update the bootloader by uploading the sketch to the M7 core instead of the M4 core.
+#endif
+
+#define BOOTLOADER_ADDR   (0x8000000)
+mbed::FlashIAP flash;
+
+uint32_t bootloader_data_offset = 0x1F000;
+uint8_t* bootloader_data = (uint8_t*)(BOOTLOADER_ADDR + bootloader_data_offset);
+
+void setup() {  
+  Serial.begin(115200);
+  while (!Serial) {}
+
+  uint8_t currentBootloaderVersion = bootloader_data[1];
+  uint8_t availableBootloaderVersion = (mcuboot_bin + bootloader_data_offset)[1];
+
+  Serial.println("Magic Number (validation): " + String(bootloader_data[0], HEX));
+  Serial.println("Bootloader version: " + String(currentBootloaderVersion));
+  Serial.println("Clock source: " + getClockSource(bootloader_data[2]));
+  Serial.println("USB Speed: " + getUSBSpeed(bootloader_data[3]));
+  Serial.println("Has Ethernet: " + String(bootloader_data[4] == 1 ? "Yes" : "No"));
+  Serial.println("Has WiFi module: " + String(bootloader_data[5] == 1 ? "Yes" : "No"));
+  Serial.println("RAM size: " + String(bootloader_data[6]) + " MB");
+  Serial.println("QSPI size: " + String(bootloader_data[7]) + " MB");
+  Serial.println("Has Video output: " + String(bootloader_data[8] == 1 ? "Yes" : "No"));
+  Serial.println("Has Crypto chip: " + String(bootloader_data[9] == 1 ? "Yes" : "No"));
+
+  if (availableBootloaderVersion > currentBootloaderVersion) {
+    Serial.print("\nA new bootloader version is available: v" + String(availableBootloaderVersion));
+    Serial.println(" (Your version: v" + String(currentBootloaderVersion) + ")");
+    Serial.println("Do you want to update the bootloader? Y/[n]");
+  } else if(availableBootloaderVersion < currentBootloaderVersion){ 
+    Serial.println("\nA newer bootloader version is already installed: v" + String(currentBootloaderVersion));    
+    Serial.println("Do you want to downgrade the bootloader to v" + String(availableBootloaderVersion) + "? Y/[n]");
+  } else {
+    Serial.println("\nThe latest version of the bootloader is already installed (v" + String(currentBootloaderVersion) + ").");
+    Serial.println("Do you want to update the bootloader anyway? Y/[n]");
+  }
+  
+  bool confirmation = false;
+  while (confirmation == false) {
+    if (Serial.available()) {
+      char choice = Serial.read();
+      switch (choice) {
+        case 'y':
+        case 'Y':
+          applyUpdate(BOOTLOADER_ADDR);
+          confirmation = true;
+          break;
+        case 'n':
+        case 'N':
+          confirmation = true;
+          break;
+        default:
+          continue;
+      }
+    }
+  }
+}
+
+String getUSBSpeed(uint8_t flag) {
+  switch (flag){
+  case 1:
+    return "USB 2.0/Hi-Speed (480 Mbps)";
+  case 2:
+    return "USB 1.1/Full-Speed (12 Mbps)";
+  default:
+    return "N/A";
+  }
+}
+
+String getClockSource(uint8_t flag) {
+  switch (flag){
+  case 0x8:
+    return "External oscillator";
+  case 0x4:
+    return "External crystal";
+  case 0x2: 
+    return "Internal clock"; 
+  default:
+    return "N/A";
+  }
+}
+
+void applyUpdate(uint32_t address) {
+  long len = mcuboot_bin_len;
+
+  flash.init();
+
+  const uint32_t page_size = flash.get_page_size();
+  char *page_buffer = new char[page_size];
+  uint32_t addr = address;
+  uint32_t next_sector = addr + flash.get_sector_size(addr);
+  bool sector_erased = false;
+  size_t pages_flashed = 0;
+  uint32_t percent_done = 0;
+
+  while (true) {
+
+    if (page_size * pages_flashed > len) {
+      break;
+    }
+
+    // Erase this page if it hasn't been erased
+    if (!sector_erased) {
+      flash.erase(addr, flash.get_sector_size(addr));
+      sector_erased = true;
+    }
+
+    // Program page
+    flash.program(&mcuboot_bin[page_size * pages_flashed], addr, page_size);
+
+    addr += page_size;
+    if (addr >= next_sector) {
+      next_sector = addr + flash.get_sector_size(addr);
+      sector_erased = false;
+    }
+
+    if (++pages_flashed % 3 == 0) {
+      uint32_t percent_done_new = page_size * pages_flashed * 100 / len;
+      if (percent_done != percent_done_new) {
+        percent_done = percent_done_new;
+        Serial.println("Flashed " + String(percent_done) + "%");
+      }
+    }
+  }
+  Serial.println("Flashed 100%");
+
+  delete[] page_buffer;
+
+  flash.deinit();
+  Serial.println("Bootloader update complete. You may now disconnect the board.");
+}
+
+void loop() {
+  delay(1000);
+}