Memfault Firmware SDK 1.9.4 (Build 8676)

Author: Memfault Inc

CHANGELOG.md

@@ -6,6 +6,50 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.9.4] - 2024-07-01
+
+### :chart_with_upwards_trend: Improvements
+
+- Zephyr:
+
+  - Updated the Memfault fault handler to support deprecated exception info
+    structure coming in Zephyr v3.7.0. This change is backward compatible with
+    older Zephyr versions.
+
+  - By default, include the `zephyr.meta` build metadata in the output ELF file
+    as an unallocated section. This provides a list of module SHAs, useful when
+    reconstructing the dependencies used to build a particular ELF file. This
+    feature is controlled with `CONFIG_MEMFAULT_BUILD_META_IN_ELF`.
+
+  - Add a new Kconfig option, `CONFIG_MEMFAULT_USE_MEMFAULT_BUILD_ID`, which
+    will apply a [Memfault Build ID](https://mflt.io/symbol-file-build-ids)
+    instead of a GNU Build ID when enabled. It defaults to enabled when
+    `CONFIG_BOOTLOADER_ESP_IDF` is enabled- this applies to ESP32 boards that
+    are using the ESP-IDF bootloader, instead of an MCUBoot bootloader. MCUBoot
+    bootable images are compatible with the standard GNU Build IDs.
+
+  - Add a new API, `memfault_zephyr_fota_download_callback()`, to the Zephyr
+    FOTA implementation to allow users to write their own callback that is
+    invoked when the download of a OTA payload is complete. The default download
+    callback will mark the new image as pending, set a firmware update reboot
+    reason, and reboot the system. Custom callbacks may, for example, be used to
+    perform application-specific system shutdown procedures, or allow the FOTA
+    update call to return to the calling context so a testing framework could
+    mark the operation successful. Users can override the default callback with
+    their own implementation using a new Kconfig option
+    `CONFIG_MEMFAULT_ZEPHYR_FOTA_DOWNLOAD_CALLBACK_CUSTOM`.
+
+- ESP-IDF:
+
+  - Add a periodic HTTP upload task. This feature starts a task dedicated to
+    posting any available Memfault data via HTTPS. Enable with
+    `CONFIG_MEMFAULT_HTTP_PERIODIC_UPLOAD=y`.
+
+- General:
+
+  - Add 2 new QEMU targets for the FreeRTOS QEMU example, for Cortex-M4F and
+    Cortex-M33. The targets can be found [here](examples/freertos/boards/)
+
 ## [1.9.3] - 2024-06-10
 
 ### :chart_with_upwards_trend: Improvements
@@ -40,8 +84,8 @@ and this project adheres to
     convention for exception handlers. A backwards-compatible implementation is
     included to avoid breaking users relying on the previous default.
 
-  - Add [`libcurl`-based samples](examples/libcurl) for posting chunks to Memfault and
-    checking for latest OTA release.
+  - Add [`libcurl`-based samples](examples/libcurl) for posting chunks to
+    Memfault and checking for latest OTA release.
 
 ## [1.9.2] - 2024-05-29
 

VERSION

@@ -1,3 +1,3 @@
-BUILD ID: 8266
-GIT COMMIT: 10085ffa3f
-VERSION: 1.9.3
+BUILD ID: 8676
+GIT COMMIT: 69ac2e1558
+VERSION: 1.9.4

components/include/memfault/version.h

@@ -19,8 +19,8 @@ typedef struct {
   uint8_t patch;
 } sMfltSdkVersion;
 
-#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 9, .patch = 3 }
-#define MEMFAULT_SDK_VERSION_STR "1.9.3"
+#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 9, .patch = 4 }
+#define MEMFAULT_SDK_VERSION_STR "1.9.4"
 
 #ifdef __cplusplus
 }

examples/esp32/apps/memfault_demo_app/main/Kconfig.projbuild

@@ -33,6 +33,7 @@ choice APP_MEMFAULT_TRANSPORT
     config APP_MEMFAULT_TRANSPORT_MQTT
         bool "MQTT"
         select MQTT_PROTOCOL_5
+        depends on !MEMFAULT_HTTP_PERIODIC_UPLOAD
 endchoice
 
 if APP_MEMFAULT_TRANSPORT_MQTT

examples/esp32/apps/memfault_demo_app/main/main.c

@@ -127,7 +127,7 @@ static void initialize_console() {
     .max_cmdline_args = 8,
     .max_cmdline_length = 256,
 #if CONFIG_LOG_COLORS
-    .hint_color = atoi(LOG_COLOR_CYAN)
+    .hint_color = atoi(LOG_COLOR_CYAN),
 #endif
   };
   ESP_ERROR_CHECK(esp_console_init(&console_config));
@@ -253,44 +253,30 @@ void memfault_esp_port_wifi_autojoin(void) {
 
   #endif  // CONFIG_MEMFAULT_APP_WIFI_AUTOJOIN
 
-// Periodically post any Memfault data that has not yet been posted.
-static void prv_poster_task(void *args) {
-  const uint32_t interval_sec = 60;
-  const TickType_t delay_ms = (1000 * interval_sec) / portTICK_PERIOD_MS;
+// // Periodically post any Memfault data that has not yet been posted.
+static void prv_ota_task(void *args) {
   const TickType_t ota_check_interval = pdMS_TO_TICKS(60 * 60 * 1000);
-  // initial OTA check is immediately on boot
-  TickType_t ota_last_check_time = xTaskGetTickCount() - ota_check_interval;
 
-  app_memfault_transport_init();
-
-  MEMFAULT_LOG_INFO("Data poster task up and running every %" PRIu32 "s.", interval_sec);
+  MEMFAULT_LOG_INFO("OTA task up and running every %" PRIu32 "s.", ota_check_interval);
 
   while (true) {
     // count the number of times this task has run
     MEMFAULT_METRIC_ADD(PosterTaskNumSchedules, 1);
     // attempt to autojoin wifi, if configured
+  #if defined(CONFIG_MEMFAULT_APP_WIFI_AUTOJOIN)
     memfault_esp_port_wifi_autojoin();
+  #endif
 
-    // if connected, post any memfault data
+    // Wait until connected to check for OTA
     if (memfault_esp_port_wifi_connected()) {
-      MEMFAULT_LOG_DEBUG("Checking for memfault data to send");
-      int err = app_memfault_transport_send_chunks();
-      // if the check-in succeeded, set green, otherwise clear.
-      // gives a quick eyeball check that the app is alive and well
-      led_set_color((err == 0) ? kLedColor_Green : kLedColor_Red);
-
-      // Check for OTA hourly
-      if ((xTaskGetTickCount() - ota_last_check_time) >= ota_check_interval) {
-        prv_memfault_ota();
-        ota_last_check_time = xTaskGetTickCount();
-      }
+      prv_memfault_ota();
     } else {
       // Set LED to red
       led_set_color(kLedColor_Red);
     }
 
     // sleep
-    vTaskDelay(delay_ms);
+    vTaskDelay(ota_check_interval);
   }
 }
 
@@ -447,10 +433,10 @@ void app_main() {
 #if defined(CONFIG_MEMFAULT)
   prv_initialize_task_watchdog();
 
-  // We need another task to post data since we block waiting for user
+  // We need another task to check for OTA since we block waiting for user
   // input in this task.
   const portBASE_TYPE res =
-    xTaskCreate(prv_poster_task, "poster", ESP_TASK_MAIN_STACK, NULL, ESP_TASK_MAIN_PRIO, NULL);
+    xTaskCreate(prv_ota_task, "ota", ESP_TASK_MAIN_STACK, NULL, ESP_TASK_MAIN_PRIO, NULL);
   assert(res == pdTRUE);
 
   // Register the app commands

examples/esp32/apps/memfault_demo_app/sdkconfig.mqtt

@@ -1,2 +1,3 @@
 CONFIG_APP_MEMFAULT_TRANSPORT_MQTT=y
+CONFIG_MEMFAULT_HTTP_PERIODIC_UPLOAD=n
 CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions_example_mqtt.csv"

examples/freertos/Makefile

@@ -4,15 +4,17 @@ MAKEFLAGS=--warn-undefined-variables
 # Default to a silent build. Run make with --trace for a verbose build.
 .SILENT:
 
-
 # Mac and Linux stat have different options required, set them up here
 ifeq ($(shell uname), Darwin)
-  STAT = "stat -f '%z'"
+    STAT = "stat -f '%z'"
 else
-  STAT = "stat -c '%s'"
+    STAT = "stat -c '%s'"
 endif
 
 BOARD ?= qemu_mps2_an385
+
+$(info Building for $(BOARD))
+
 BOARD_DIR := boards/$(BOARD)
 
 BUILD_DIR := build/$(BOARD)
@@ -53,25 +55,24 @@ endif
 include $(BOARD_DIR)/Makefile
 
 # Gather list of FreeRTOS sources
-FREERTOS_SRCS = \
-	$(FREERTOS_DIR)/tasks.c \
-	$(FREERTOS_DIR)/queue.c \
-	$(FREERTOS_DIR)/list.c \
-	$(FREERTOS_DIR)/timers.c \
-	$(FREERTOS_DIR)/portable/GCC/$(FREERTOS_PORT)/port.c \
-	$(FREERTOS_DIR)/portable/MemMang/heap_4.c \
+FREERTOS_SRCS += \
+    $(FREERTOS_DIR)/tasks.c \
+    $(FREERTOS_DIR)/queue.c \
+    $(FREERTOS_DIR)/list.c \
+    $(FREERTOS_DIR)/timers.c \
+    $(FREERTOS_DIR)/portable/MemMang/heap_4.c \
 
 # Add application sources
 SRCS += \
-	src/main.c \
-	src/compact_log.cpp \
-	src/console.c \
-	src/heap_task.c \
-	src/metrics.c \
-	src/memfault/memfault_platform_port.c \
-	$(BOARD_DIR)/startup.c \
-	$(BOARD_DIR)/memfault_platform_impl.c \
-	$(FREERTOS_SRCS) \
+    src/main.c \
+    src/compact_log.cpp \
+    src/console.c \
+    src/heap_task.c \
+    src/metrics.c \
+    src/memfault/memfault_platform_port.c \
+    $(BOARD_DIR)/startup.c \
+    $(BOARD_DIR)/memfault_platform_impl.c \
+    $(FREERTOS_SRCS) \
 
 # Use Memfault SDK worker to gather initial Memfault SDK sources and include dirs
 MEMFAULT_SDK_ROOT := ../..
@@ -85,34 +86,33 @@ CFLAGS += $(foreach each, $(MEMFAULT_COMPONENTS), -DMEMFAULT_COMPONENT_$(each)_)
 # Intentionally using a wildcard to trap any new features added- it's nice to
 # have them enabled in this example app.
 SRCS += \
-	$(MEMFAULT_COMPONENTS_SRCS) \
-	$(wildcard $(MEMFAULT_SDK_ROOT)/ports/freertos/src/*.c) \
-		$(MEMFAULT_SDK_ROOT)/ports/panics/src/memfault_platform_ram_backed_coredump.c \
+    $(MEMFAULT_COMPONENTS_SRCS) \
+    $(wildcard $(MEMFAULT_SDK_ROOT)/ports/freertos/src/*.c) \
+        $(MEMFAULT_SDK_ROOT)/ports/panics/src/memfault_platform_ram_backed_coredump.c \
 
 # Fixup build path for objects of the Memfault SDK, all build output kept within build/
 OBJS := $(subst $(MEMFAULT_SDK_ROOT),memfault-firmware-sdk,$(SRCS:%=$(BUILD_DIR)/%.o))
 
 INCLUDE_PATHS += \
-  -I$(FREERTOS_DIR)/include \
-  -I. \
-  -Isrc \
-  -Isrc/memfault \
-  -I$(MEMFAULT_COMPONENTS_INC_FOLDERS) \
-  -I$(MEMFAULT_SDK_ROOT)/ports/include \
-  -I$(MEMFAULT_SDK_ROOT) \
-  -I$(FREERTOS_DIR)/portable/GCC/$(FREERTOS_PORT) \
+    -I$(FREERTOS_DIR)/include \
+    -I. \
+    -Isrc \
+    -Isrc/memfault \
+    -I$(MEMFAULT_COMPONENTS_INC_FOLDERS) \
+    -I$(MEMFAULT_SDK_ROOT)/ports/include \
+    -I$(MEMFAULT_SDK_ROOT) \
+    -I$(FREERTOS_DIR)/portable/GCC/$(FREERTOS_PORT) \
 
 # generic (non-arch-specific) CFLAGS
 CFLAGS += \
-	-nostartfiles \
-	-mthumb \
-	-mcpu=cortex-m3 \
-	-Werror \
-	-Wall \
-	-Wextra \
-	-ggdb3 \
-	-Og \
-	-MD \
+    -nostartfiles \
+    -Werror \
+    -Wall \
+    -Wextra \
+    -ggdb3 \
+    -Og \
+    -MD \
+    $(ARCH_CFLAGS) \
 
 # Enable the self test by default
 MEMFAULT_DEMO_CLI_SELF_TEST ?= 1
@@ -121,14 +121,14 @@ CFLAGS += -DMEMFAULT_DEMO_CLI_SELF_TEST=$(MEMFAULT_DEMO_CLI_SELF_TEST)
 LINKER_SCRIPT = $(BOARD_DIR)/linker.ld
 
 LDFLAGS += \
-	-Wl,-T$(LINKER_SCRIPT) \
-	-Wl,--gc-sections \
-	--specs=nano.specs \
-	--specs=rdimon.specs \
-	-Wl,-lc \
-	-Wl,-lrdimon \
-	-Wl,-Map=$(BUILD_DIR)/main.map \
-	-Wl,--build-id \
+    -Wl,-T$(LINKER_SCRIPT) \
+    -Wl,--gc-sections \
+    --specs=nano.specs \
+    --specs=rdimon.specs \
+    -Wl,-lc \
+    -Wl,-lrdimon \
+    -Wl,-Map=$(BUILD_DIR)/main.map \
+    -Wl,--build-id \
 
 .PHONY: all
 all: $(ELF)
@@ -142,11 +142,11 @@ $(SRCS): $(FREERTOS_DIR)/.clonedone
 # If CFLAGS differ from last build, rebuild all files
 RAW_CFLAGS := $(CFLAGS) $(LDFLAGS)
 CFLAGS_STALE = \
-  $(shell \
-    if ! (echo "$(RAW_CFLAGS)" | diff -q $(BUILD_DIR)/cflags - > /dev/null 2>&1); then \
-      echo CFLAGS_STALE; \
-    fi \
-   )
+    $(shell \
+        if ! (echo "$(RAW_CFLAGS)" | diff -q $(BUILD_DIR)/cflags - > /dev/null 2>&1); then \
+            echo CFLAGS_STALE; \
+        fi \
+    )
 .PHONY: CFLAGS_STALE
 $(BUILD_DIR)/cflags: $(CFLAGS_STALE) Makefile
 	mkdir -p $(dir $@)

examples/freertos/boards/qemu_mps2_an385/Makefile

@@ -3,6 +3,13 @@
 FREERTOS_PORT = ARM_CM3
 MEMFAULT_ARCH = arm
 
+ARCH_CFLAGS += \
+    -mthumb \
+    -mcpu=cortex-m3 \
+
+FREERTOS_SRCS += \
+    $(FREERTOS_DIR)/portable/GCC/$(FREERTOS_PORT)/port.c \
+
 ATTACH_DEBUGGER = -s -S
 RUN_COMMAND = qemu-system-arm -machine mps2-an385 -monitor null -semihosting \
         --semihosting-config enable=on,target=native \

examples/freertos/boards/qemu_mps2_an386/Makefile

@@ -0,0 +1,27 @@
+# Board-specific build/debug properties
+
+FREERTOS_PORT = ARM_CM4F
+MEMFAULT_ARCH = arm
+
+ARCH_CFLAGS += \
+    -mthumb \
+    -mcpu=cortex-m4 \
+    -mfloat-abi=hard \
+    -mfpu=fpv4-sp-d16 \
+    -DconfigENABLE_FPU=1 \
+
+FREERTOS_SRCS += \
+    $(FREERTOS_DIR)/portable/GCC/$(FREERTOS_PORT)/port.c \
+
+ATTACH_DEBUGGER = -s -S
+RUN_COMMAND = qemu-system-arm -machine mps2-an386 -monitor null -semihosting \
+        --semihosting-config enable=on,target=native \
+        -kernel $(ELF) \
+        -serial stdio -nographic \
+
+DEBUG_COMMAND = $(RUN_COMMAND) $(ATTACH_DEBUGGER)
+
+# Permit overriding the gdb executable
+GDB ?= gdb
+GDB_COMMAND = \
+    $(GDB) --ex 'target extended-remote :1234' $(ELF)