SFU - Second Stage Bootloader for MKR Boards with MKRMEM Shield

libraries/SFU/examples/SFU_LoadBinary/SFU_LoadBinary.ino

@@ -0,0 +1,63 @@
+/**************************************************************************************
+ * INCLUDE
+ **************************************************************************************/
+
+#include <Arduino_MKRMEM.h>
+
+/**************************************************************************************
+ * CONSTANTS
+ **************************************************************************************/
+
+static uint8_t const BINARY[] =
+{
+  #include "Binary.h"
+};
+
+/**************************************************************************************
+ * SETUP/LOOP
+ **************************************************************************************/
+
+void setup() {
+  Serial.begin(9600);
+
+  unsigned long const start = millis();
+  for(unsigned long now = millis(); !Serial && ((now - start) < 5000); now = millis()) { };
+
+  flash.begin();
+
+  Serial.print("Mounting ... ");
+  if(SPIFFS_OK != filesystem.mount()) {
+    Serial.println("mount() failed with error code "); Serial.println(filesystem.err()); return;
+  }
+  Serial.println("OK");
+
+
+  Serial.print("Checking ... ");
+  if(SPIFFS_OK != filesystem.check()) {
+    Serial.println("check() failed with error code "); Serial.println(filesystem.err()); return;
+  }
+  Serial.println("OK");
+
+
+  Serial.print("Writing \"UPDATE.BIN\" ... ");
+  File file = filesystem.open("UPDATE.BIN", CREATE | READ_WRITE| TRUNCATE);
+
+  int const bytes_to_write = sizeof(BINARY);
+  int const bytes_written = file.write((void *)BINARY, bytes_to_write);
+
+  if(bytes_written != bytes_to_write) {
+    Serial.println("write() failed with error code "); Serial.println(filesystem.err()); return;
+  } else {
+    Serial.print("OK (");
+    Serial.print(bytes_written);
+    Serial.println(" bytes written)");
+  }
+
+  Serial.print("Unmounting ... ");
+  filesystem.unmount();
+  Serial.println("OK");
+}
+
+void loop() {
+
+}

libraries/SFU/examples/SFU_Usage/SFU_Usage.ino

@@ -0,0 +1,54 @@
+/*
+ Usage
+ This example demonstrates how to use the SAMD SFU library to update a 
+ sketch on any Arduino MKR board connected to a MKRMEM Shield. This sketch
+ prints out the date and time the sketch was compiled.
+
+ Steps to update sketch via MKRMEM shield:
+
+ 1) Upload this sketch or another sketch that includes the SFU library
+    via #include <SFU.h>
+
+ 2) Update the sketch as desired. For this example the sketch prints out
+    the compiled date and time so no updates are needed.
+
+ 3) In the IDE select: Sketch -> Export compiled Binary
+
+ 4) Open the location of the sketch and convert the .bin file to a C byte array.
+      cat SKETCH.bin | xxd --include > Binary.h
+
+ 5) Copy Binary.h file from the sketch's folder to the SFU_LoadBinary sketch
+    and load it to the MKRMEM via SFU_LoadBinary sketch.
+*/
+
+/*
+ Include the SFU library 
+
+ This will add some code to the sketch before setup() is called
+ to check if UPDATE.bin is present on the flash chip of the MKRMEM
+ shield. If this theck is positive the file is used to update the sketch
+ running on the board. After this UPDATE.BIN is deleted from the flash.
+*/
+
+#include <SFU.h>
+
+void setup() {
+  Serial.begin(9600);
+  while(!Serial) { }
+
+  // wait a bit
+  delay(1000);
+
+  String message;
+  message += "Sketch compile date and time: ";
+  message += __DATE__;
+  message += " ";
+  message += __TIME__;
+
+  // print out the sketch compile date and time on the serial port
+  Serial.println(message);
+}
+
+void loop() {
+  // add you own code here
+}

libraries/SFU/extras/SFUBoot/SFUBoot.ino

@@ -0,0 +1,115 @@
+/*
+  Copyright (c) 2020 Arduino LLC.  All right reserved.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+  See the GNU Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+
+/**************************************************************************************
+ * INCLUDE
+ **************************************************************************************/
+
+#include <FlashStorage.h>
+#include <Arduino_MKRMEM.h>
+
+/**************************************************************************************
+ * DEFINE
+ **************************************************************************************/
+
+#define SFU_START    0x2000
+#define SFU_SIZE     0x8000
+
+#define SKETCH_START (uint32_t*)(SFU_START + SFU_SIZE)
+
+/**************************************************************************************
+ * GLOBAL CONSTANTS
+ **************************************************************************************/
+
+static char const UPDATE_FILE_NAME[] = "UPDATE.BIN";
+
+/**************************************************************************************
+ * GLOBAL VARIABLES
+ **************************************************************************************/
+
+FlashClass mcu_flash;
+
+/**************************************************************************************
+ * FUNCTION DECLARATION
+ **************************************************************************************/
+
+extern "C" void __libc_init_array(void);
+
+/**************************************************************************************
+ * MAIN
+ **************************************************************************************/
+
+int main()
+{
+  init();
+
+  __libc_init_array();
+
+  delay(1);
+
+  /* Initialize W25Q16DV flash chip found on Arduino MKRMEM Shield */
+  flash.begin();
+
+  /* Mount and verify filesystem */
+  if ((SPIFFS_OK == filesystem.mount()) && (SPIFFS_OK == filesystem.check()))
+  {
+    /* Open update file */
+    filesystem.clearerr();
+    File file = filesystem.open(UPDATE_FILE_NAME, READ_ONLY);
+    if(SPIFFS_OK == filesystem.err())
+    { 
+      bool update_success = false;
+      /* Determine the size of the update file */
+      int file_size = file.lseek(0, END);
+      if (file_size > SFU_SIZE)
+      {
+        /* Skip the SFU section */
+        file.lseek(SFU_SIZE, START);
+        file_size -= SFU_SIZE;
+
+        /* Erase the MCU flash */
+        uint32_t flash_address = (uint32_t)SKETCH_START;
+        mcu_flash.erase((void*)flash_address, file_size);
+
+        /* Write the MCU flash */
+        uint8_t buffer[512];
+        for (int b = 0; b < file_size; b += sizeof(buffer))
+        {
+          file.read(buffer, sizeof(buffer));
+          mcu_flash.write((void*)flash_address, buffer, sizeof(buffer));
+          flash_address += sizeof(buffer);
+        }
+        update_success = true;
+      }
+      file.close();
+      if (update_success) { filesystem.remove(UPDATE_FILE_NAME); }
+      filesystem.unmount();
+    }
+  }
+
+  /* Jump to the sketch */
+  __set_MSP(*SKETCH_START);
+
+  /* Reset vector table address */
+  SCB->VTOR = ((uint32_t)(SKETCH_START) & SCB_VTOR_TBLOFF_Msk);
+
+  /* Address of Reset_Handler is written by the linker at the beginning of the .text section (see linker script) */
+  uint32_t resetHandlerAddress = (uint32_t) * (SKETCH_START + 1);
+  /* Jump to reset handler */
+  asm("bx %0"::"r"(resetHandlerAddress));
+}

libraries/SFU/extras/SFUBoot/build.sh

@@ -0,0 +1,31 @@
+#!/bin/sh -x
+
+ARDUINO=arduino
+SKETCH_NAME="SFUBoot.ino"
+SKETCH="$PWD/$SKETCH_NAME"
+BUILD_PATH="$PWD/build"
+OUTPUT_PATH="../../src/boot"
+
+if [[ "$OSTYPE" == "darwin"* ]]; then
+	ARDUINO="/Applications/Arduino.app/Contents/MacOS/Arduino"
+fi
+
+buildSFUBootSketch() {
+	BOARD=$1
+	DESTINATION=$2
+
+	$ARDUINO --verify --board $BOARD --preserve-temp-files --pref build.path="$BUILD_PATH" $SKETCH
+	cat "$BUILD_PATH/$SKETCH_NAME.bin" | xxd -include > $DESTINATION
+	rm -rf "$BUILD_PATH"
+}
+
+mkdir -p "$OUTPUT_PATH"
+
+buildSFUBootSketch "arduino:samd:mkrzero" "$OUTPUT_PATH/mkrzero.h"
+buildSFUBootSketch "arduino:samd:mkr1000" "$OUTPUT_PATH/mkr1000.h"
+buildSFUBootSketch "arduino:samd:mkrwifi1010" "$OUTPUT_PATH/mkrwifi1010.h"
+buildSFUBootSketch "arduino:samd:mkrgsm1400" "$OUTPUT_PATH/mkrgsm1400.h"
+buildSFUBootSketch "arduino:samd:mkrnb1500" "$OUTPUT_PATH/mkrnb1500.h"
+buildSFUBootSketch "arduino:samd:mkrvidor4000" "$OUTPUT_PATH/mkrvidor4000.h"
+buildSFUBootSketch "arduino:samd:mkrwan1310" "$OUTPUT_PATH/mkrwan1310.h"
+buildSFUBootSketch "arduino:samd:mkrfox1200" "$OUTPUT_PATH/mkrfox1200.h"

libraries/SFU/keywords.txt

@@ -0,0 +1,17 @@
+#######################################
+# Syntax Coloring Map For SDU
+#######################################
+
+#######################################
+# Datatypes (KEYWORD1)
+#######################################
+
+SFU	KEYWORD1
+
+#######################################
+# Methods and Functions (KEYWORD2)
+#######################################
+
+#######################################
+# Constants (LITERAL1)
+#######################################

libraries/SFU/library.properties

@@ -0,0 +1,9 @@
+name=SFU
+version=1.0.0
+author=Arduino
+maintainer=Arduino <info@arduino.cc>
+sentence=Update the sketch on your board from a Arduino MKRMEM Shield.
+paragraph=Requires a Arduino MKRMEM Shield.
+category=Other
+url=https://www.arduino.cc/en/Reference/SFU
+architectures=samd

libraries/SFU/src/SFU.cpp

@@ -0,0 +1,44 @@
+/*
+  Copyright (c) 2020 Arduino LLC.  All right reserved.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+  See the GNU Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+
+#include <Arduino.h>
+
+#include "SFU.h"
+
+__attribute__ ((section(".sketch_boot")))
+unsigned char SFU_BOOT[0x8000] = {
+#if defined(ARDUINO_SAMD_MKRZERO)
+  #include "boot/mkrzero.h"
+#elif defined(ARDUINO_SAMD_MKR1000)
+  #include "boot/mkr1000.h"
+#elif defined(ARDUINO_SAMD_MKRWIFI1010)
+  #include "boot/mkrwifi1010.h"
+#elif defined(ARDUINO_SAMD_MKRGSM1400)
+  #include "boot/mkrgsm1400.h"
+#elif defined(ARDUINO_SAMD_MKRNB1500)
+  #include "boot/mkrnb1500.h"
+#elif defined(ARDUINO_SAMD_MKRVIDOR4000)
+  #include "boot/mkrvidor4000.h"
+#elif defined(ARDUINO_SAMD_MKRWAN1310)
+  #include "boot/mkrwan1310.h"
+#elif defined(ARDUINO_SAMD_MKRFOX1200)
+  #include "boot/mkrfox1200.h"
+#else
+  #error "Unsupported board!"
+#endif
+};

libraries/SFU/src/SFU.h

@@ -0,0 +1,24 @@
+/*
+  Copyright (c) 2020 Arduino LLC.  All right reserved.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+  See the GNU Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+
+#ifndef _SFU_H_INCLUDED
+#define _SFU_H_INCLUDED
+
+/* Nothing to do */
+
+#endif /* _SFU_H_INCLUDED */