Add MicroMod-WB5MMG / Sasquatch-WB5MMG variants, plus secure boot, plus secure firmware update

Author: GrumpyOldPizza

README.md

@@ -11,12 +11,20 @@ ArduinoCore-stm32wb is targeted at ultra low power scenarios, sensor hubs, with
  * [Firefly-STM32WB55CG](https://www.tindie.com/products/TleraCorp/firefly-ble-development-board)
  * [Katydid-STM32WB55CG](https://www.tindie.com/products/tleracorp/katydid-wearable-ble-sensor-board)
 
+### Sparkfun
+ * [MicroMod-STM32WB5MMG](https://www.sparkfun.com/products/21438)
+
 ### STMicroelectronics
  * [NUCLEO-WB55RG](https://www.st.com/content/st_com/en/products/evaluation-tools/product-evaluation-tools/stm32-nucleo-expansion-boards/p-nucleo-wb55.html)
 
 
 ## Installing
 
+ The Arduino Core for STM32WB does use Secure Boot / Secure Firmware Update. To do so, a special bootloader is installed the first time a sketch is uploaded. To change the bootloader to a newer version, or to switch security settings between `None` and `Signature & Encryption` the STM32WB board has to be reset by toggle the RESET button while holding down the BOOT button, and then uploading a sketch with the new boot code or settings.
+
+ PLEASE ALWAYS WHEN UGRADING, TOGGLE THE RESET BUTTON WHILE HOLDING DOWN THE BOOT BUTTON BEFORE UPLOADING THE FIRST SKETCH.
+
+
 ### Board Manager
 
  1. [Download and install the Arduino IDE](https://www.arduino.cc/en/Main/Software) (at least version v1.8.13)
@@ -60,11 +68,15 @@ ArduinoCore-stm32wb is targeted at ultra low power scenarios, sensor hubs, with
 
 ## BLE / Wireless stack firmware installation
 
- STM32WB uses encrypted/signed firmware images for the BLE stack. Please flash the `FWUpdate` sketch under the `STM32WB` examples before using BLE. The update will take up few seconds/minutes. During that time the LED will stay on, while the serial monitor will say disconnected. When done the LED will blink if the update was succesful, or simply be turned off if an error was encountered. The serial monitor should pop up again and report back the newly updated firmware versions. The `FWInfo` sketch can be used to verify what version is installed. At this time it should report back 1.10.0 for the BLE stack.
+ STM32WB uses a signed/encrypted firmware image for the BLE stack. Please flash the `FWUpdate` sketch under the `STM32WB` examples before using BLE. The update will take up few seconds/minutes. During that time the LED will stay on, while the serial monitor will say disconnected. When done the LED will blink if the update was succesful, or simply be turned off if an error was encountered. The serial monitor should pop up again and report back the newly updated firmware versions. The `FWInfo` sketch can be used to verify what version is installed. At this time it should report back 1.14.2 for the BLE stack.
+
+## Secure Boot / Secure Firmware Update / BLE OTA
+
+ STM32WB can use a signed/encrypted firmware image for the Arduino application/sketche. With the `Export compiled Binary` entry in the `Sketch` menu 5 files are exported. The *.dfu file is used for secure firmware update via USB/DFU, while the *.ota file is use BLE/OTA. This can be used/tested with either the "ST BLE Toolbox" application for Android/iOS (the file might have to be renamed to fit ST's naming conventions), or with the supplied `stm32wb-ota.py` python3 script (requires `python3` and `bleak`). USB/DFU uses signature/encryption, while BLE/OTA uses signature/encryption/compression.
 
-## Recovering from a faulty sketch for Tlera Corp Boards
+## Recovering from a faulty sketch for Tlera Corp / Sparkfun Boards
 
- Sometimes a faulty sketch can render the normal USB Serial based integration into the Arduindo IDE not working. In this case plugin the STM32WB board and toggle the RESET button while holding down the BOOT button and program a known to be working sketch to go ack to a working USB Serial setup.
+ Sometimes a faulty sketch can render the normal USB DUF based integration into the Arduindo IDE not working. In this case plugin the STM32WB board and toggle the RESET button while holding down the BOOT button and program a known to be working sketch to go back to a working USB DFU setup.
 
 ## Credits
 

boards.txt

@@ -133,9 +133,11 @@ int CDC::read(uint8_t *buffer, size_t size) {
 }
 
 void CDC::flush() {
-    if (k_task_is_in_progress()) {
+    if (!armv7m_core_is_in_interrupt()) {
         while (m_tx_busy) {
-            k_sem_acquire(&m_sem, K_TIMEOUT_FOREVER);
+            if (k_sem_acquire(&m_sem, K_TIMEOUT_FOREVER) != K_NO_ERROR) {
+                break;
+            }
         }
     }
 }
@@ -145,11 +147,10 @@ size_t CDC::write(const uint8_t data) {
 }
 
 size_t CDC::write(const uint8_t *buffer, size_t size) {
-    k_task_t *self = nullptr;
     uint32_t tx_read, tx_write, tx_write_next, tx_count, tx_size;
     uint8_t tx_lock;
     size_t count;
-    
+      
     if (!m_enabled) {
         return 0;
     }
@@ -160,10 +161,6 @@ size_t CDC::write(const uint8_t *buffer, size_t size) {
 
     count = 0;
 
-    if (k_task_is_in_progress()) {
-        self = k_task_self();
-    }
-    
     tx_lock = __armv7m_atomic_swapb(&m_tx_lock, 1);
 
     do {
@@ -182,7 +179,7 @@ size_t CDC::write(const uint8_t *buffer, size_t size) {
             }
 
             if (tx_size == 0) {
-                if (m_nonblocking || !self) {
+                if (m_nonblocking || armv7m_core_is_in_interrupt()) {
                     goto finish;
                 }
 
@@ -217,7 +214,9 @@ size_t CDC::write(const uint8_t *buffer, size_t size) {
                 }
 
                 if (m_tx_busy) {
-                    k_sem_acquire(&m_sem, K_TIMEOUT_FOREVER);
+                    if (k_sem_acquire(&m_sem, K_TIMEOUT_FOREVER) != K_NO_ERROR) {
+                        goto finish;
+                    }
                 }
             }
         } while (tx_size == 0);

cores/arduino/CDC.cpp

@@ -32,7 +32,8 @@
 
 class Callback {
 public:
-    Callback() : m_callback(nullptr), m_context(nullptr) {  }
+  // Callback() : m_callback(nullptr), m_context(nullptr) {  }
+    Callback() = default;
     Callback(void (*function)(void)) : m_callback((void (*)(void*))function), m_context(nullptr) { }
     Callback(const Callback &other) : m_callback(other.m_callback), m_context(other.m_context) { }
 

cores/arduino/Callback.h

@@ -10,19 +10,20 @@ OBJCOPY  = $(TOOLS)/bin/arm-none-eabi-objcopy
 CFLAGS   = -c -g3 -Os $(WARNINGS) -std=gnu11 -ffast-math -ffunction-sections -fdata-sections -nostdlib -MMD $(EXTRAS) $(DEFINES) $(INCLUDES)
 CXXFLAGS = -c -g3 -Os $(WARNINGS) -std=gnu++11 -ffast-math -ffunction-sections -fdata-sections -fno-threadsafe-statics -nostdlib -fno-use-cxa-atexit -fno-rtti -fno-exceptions -MMD $(EXTRAS) $(DEFINES) $(INCLUDES)
 ASFLAGS  = -c -g -x assembler-with-cpp $(EXTRAS) $(DEFINES) $(INCLUDES)
-LDFLAGS  = -g -Os $(EXTRAS) -Wl,--gc-sections,--no-undefined -T../../system/STM32WBxx/LdScripts/STM32WB55xx_FLASH.ld --specs=nano.specs --specs=nosys.specs -Wl,--defsym=__RTC_EPOCH__=$(shell date +"%s")
-#LDFLAGS  = -g -Os $(EXTRAS) -Wl,--gc-sections,--no-undefined -T../../system/STM32WBxx/LinkScripts/STM32WB55xx_FLASH.ld --specs=nano.specs --specs=nosys.specs
+#LDFLAGS  = -g -Os $(EXTRAS) -Wl,--gc-sections,--no-undefined -T../../system/STM32WBxx/LdScripts/STM32WB55xx_FLASH.ld --specs=nano.specs --specs=nosys.specs -Wl,--defsym=__RTC_EPOCH__=$(shell date +"%s")
+LDFLAGS  = -g -Os $(EXTRAS) -Wl,--gc-sections,--no-undefined -T../../system/STM32WBxx/LdScripts/STM32WB55xx_COMPOSITE.ld --specs=nano.specs -Wl,--defsym=__RTC_EPOCH__=$(shell date +"%s")
 WARNINGS = -Wall -Wextra
-EXTRAS   = -mcpu=cortex-m4 -march=armv7e-m+fp -mthumb -mabi=aapcs -mfpu=fpv4-sp-d16 -mfloat-abi=hard
-DEFINES  = -DSTM32WB55xx -D__SYSTEM_CORE_CLOCK__=64000000 -DDOSFS_SDCARD=0 -DDOSFS_SFLASH=0 -DARDUINO_MAKEFILE
+EXTRAS   = -mcpu=cortex-m4 -march=armv7e-m+fp -mthumb -mabi=aapcs -mfpu=fpv4-sp-d16 -mfloat-abi=hard -falign-functions=6
+#DEFINES  = -DSTM32WB55xx -D__SYSTEM_CORE_CLOCK__=64000000 -DSTORAGE_TYPE=2 -DARDUINO_MAKEFILE
+DEFINES  = -DSTM32WB55xx -D__SYSTEM_CORE_CLOCK__=64000000 -DSTORAGE_TYPE=0 -DARDUINO_MAKEFILE -DUSB_VID=0x1209 -DUSB_PID=0x6677 -DUSB_MANUFACTURER="\"Sparkfun\"" -DUSB_PRODUCT="\"MicroMod-WB5MMG\"" -DUSB_TYPE=1
 EPOCH    = $(shell date +"%s")
 
 INCLUDES = \
 	-I../../system/CMSIS/Core/Include \
 	-I../../system/CMSIS/Device/ST/STM32WBxx/Include \
 	-I../../system/CMSIS/RTOS2/Include \
 	-I../../system/STM32WBxx/Include \
-	-I../../variants/Firefly-WB55CG \
+	-I../../variants/MicroMod-WB5MMG \
 	-I../../libraries/BLE/src \
 	-I../../libraries/DOSFS/src \
 	-I../../libraries/EEPROM/src \
@@ -36,6 +37,7 @@ INCLUDES = \
 	-I../../libraries/SPI/src \
 	-I../../libraries/STM32WB/src \
 	-I../../libraries/TimerMillis/src \
+	-I../../libraries/USBStorage/src \
 	-I../../libraries/Wire/src \
 	-I.
 SRCS = \
@@ -52,8 +54,9 @@ SRCS = \
 	../../libraries/SPI/src/SPI.cpp \
 	../../libraries/STM32WB/src/STM32WB.cpp \
 	../../libraries/TimerMillis/src/TimerMillis.cpp \
+	../../libraries/USBStorage/src/USBStorage.cpp \
 	../../libraries/Wire/src/Wire.cpp \
-	../../variants/Firefly-WB55CG/variant.cpp \
+	../../variants/MicroMod-WB5MMG/variant.cpp \
 	avr/dtostrf.c \
 	avr/eeprom.c \
 	Callback.cpp \
@@ -75,11 +78,10 @@ SRCS = \
 	delay.c \
 	hooks.c \
 	itoa.c \
-	main.cpp \
 	new.cpp \
 	syscalls_stm32wb.c \
 	wiring.c \
-	wiring_analog.c \
+	wiring_analog.cpp \
 	wiring_digital.c \
 	wiring_pulse.c \
 	wiring_shift.c
@@ -98,8 +100,9 @@ OBJS = \
 	../../libraries/SPI/src/SPI.o \
 	../../libraries/STM32WB/src/STM32WB.o \
 	../../libraries/TimerMillis/src/TimerMillis.o \
+	../../libraries/USBStorage/src/USBStorage.o \
 	../../libraries/Wire/src/Wire.o \
-	../../variants/Firefly-WB55CG/variant.o \
+	../../variants/MicroMod-WB5MMG/variant.o \
 	avr/dtostrf.o \
 	avr/eeprom.o \
 	Callback.o \
@@ -121,7 +124,6 @@ OBJS = \
 	delay.o \
 	hooks.o \
 	itoa.o \
-	main.o \
 	new.o \
 	syscalls_stm32wb.o \
 	wiring.o \
@@ -141,12 +143,18 @@ all:: flash.elf flash.bin
 %.o: %.S
 	$(CC) $(ASFLAGS) -c $< -o $@
 
-flash.elf: $(OBJS) ../../system/STM32WBxx/Lib/libstm32wb55xx.a
-	$(CC) $(LDFLAGS) $(OBJS) -L../../system/STM32WBxx/Lib -lstm32wb55xx -lm -lc -lgcc -lstm32wb55xx -o flash.elf
+libarduino.a:: $(OBJS)
+	$(AR) rcs $@ $^
+
+flash.elf: main.o libarduino.a ../../system/STM32WBxx/Source/_out/stm32wb55xx/stm32wb_boot.o ../../system/STM32WBxx/Lib/libstm32wb55xx.a
+	$(CC) $(LDFLAGS) main.o ../../system/STM32WBxx/Source/_out/stm32wb55xx/stm32wb_boot.o -Wl,--gc-sections,--no-undefined,-Map=flash.map -Wl,--start-group -L. -larduino -L../../system/STM32WBxx/Lib -lstm32wb55xx -lm -lc -Wl,--end-group -o flash.elf
+#	$(CC) $(LDFLAGS) main.o ../../system/STM32WBxx/Source/_out/stm32wb55xx/stm32wb_boot.o -Wl,--gc-sections,--no-undefined,-Map=flash.map -Wl,--start-group -L. -larduino -L../../system/STM32WBxx/Lib -lstm32wb55xx_debug -lm -lc -Wl,--end-group -o flash.elf
+#	$(CC) $(LDFLAGS) main.o -Wl,--gc-sections,--no-undefined,-Map=flash.map -Wl,--start-group -L. -larduino -L../../system/STM32WBxx/Lib -lstm32wb55xx_debug -lm -lc -Wl,--end-group -o flash.elf
+#	../../tools/linux/elfsign -u eafee6d0-b575-4412-aeb4-c30ecb0d3c6e -v 1209 -p 6675 -e ../../libraries/STM32WB/keys/aes128_key.bin -s ../../libraries/STM32WB/keys/ecc256_key.pem -b flash.bin -d flash.dfu -o flash.ota -x flash.hex flash.elf flash.elf
+	../../tools/linux/elfsign -u eafee6d0-b575-4412-aeb4-c30ecb0d3c6e -v 1209 -p 6675 -b flash.bin -d flash.dfu -o flash.ota -x flash.hex flash.elf flash.elf
+#	../../tools/linux/elfsign -u 07fcdd24-aa7d-4bd5-93b1-9923e90c457c -v 1209 -p 6675 -b flash.bin -d flash.dfu -o flash.ota -x flash.hex flash.elf flash.elf
 
-flash.bin: flash.elf
-	$(OBJCOPY) -O binary flash.elf flash.bin
 clean::
-	rm -f flash.elf flash.bin *~ *.o *.d $(OBJS)
+	rm -f flash.elf flash.bin flash.dfu flash.ota flash.hex flash.map libarduino.a *~ *.o *.d main.o $(OBJS)
 
 -include $(OBJS:.o=.d)

cores/arduino/Makefile

@@ -36,40 +36,42 @@ class USBDeviceClass
     USBDeviceClass();
 
     // USB Device API
-    bool begin();
-    void end();
-    void start();
-    void stop();
-    void wakeup();
-
-    bool attached();
-    bool connected();
-    bool suspended();
-
-    void onAttach(void(*callback)(void));
-    void onAttach(Callback callback);
-    void onDetach(void(*callback)(void));
-    void onDetach(Callback callback);
-    void onConnect(void(*callback)(void));
-    void onConnect(Callback callback);
-    void onSuspend(void(*callback)(void));
-    void onSuspend(Callback callback);
-    void onResume(void(*callback)(void));
-    void onResume(Callback callback);
+    static bool begin();
+    static void end();
+    static void start();
+    static void stop();
+    static void wakeup();
+
+    static bool attached();
+    static bool connected();
+    static bool suspended();
+
+    static void onAttach(void(*callback)(void));
+    static void onAttach(Callback callback);
+    static void onDetach(void(*callback)(void));
+    static void onDetach(Callback callback);
+    static void onConnect(void(*callback)(void));
+    static void onConnect(Callback callback);
+    static void onSuspend(void(*callback)(void));
+    static void onSuspend(Callback callback);
+    static void onResume(void(*callback)(void));
+    static void onResume(Callback callback);
 
 private:
-    volatile uint32_t m_events;
+    static struct USBDeviceCallbacks {
+        volatile uint32_t events;
 
-    Callback m_attach_callback;
-    Callback m_detach_callback;
-    Callback m_connect_callback;
-    Callback m_suspend_callback;
-    Callback m_resume_callback;
-
-    k_work_t m_work;
+        Callback attach_callback;
+        Callback detach_callback;
+        Callback connect_callback;
+        Callback suspend_callback;
+        Callback resume_callback;
+        
+        k_work_t work;
+    } m_callbacks;
 
-    static void eventCallback(class USBDeviceClass *self, uint32_t events);
-    static void notifyRoutine(class USBDeviceClass *self);
+    static void eventCallback(void *context, uint32_t events);
+    static void notifyRoutine(void *context);
 };
 
 extern USBDeviceClass USBDevice;