Memfault Firmware SDK 1.9.1 (Build 7915)

Author: Memfault Inc

CHANGELOG.md

@@ -6,6 +6,31 @@ 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.1] - 2024-05-21
+
+### :chart_with_upwards_trend: Improvements
+
+- ESP-IDF:
+
+  - Fix an issue with the Memfault ESP-IDF integration to support the newly
+    released ESP-IDF v5.1.4.
+
+- Zephyr:
+
+  - Add support for tracking ESP32 reboots in `.rtc_noinit` section. This
+    improves tracking of the OTA [Reboot Reason](https://mflt.io/reboot-reasons)
+    when the device reboots after an OTA update.
+
+  - Fix compilation warnings when
+    `CONFIG_MEMFAULT_COREDUMP_FULL_THREAD_STACKS=y` is enabled. Thanks to @fouge
+    for providing this fix in
+    [#70](https://github.com/memfault/memfault-firmware-sdk/pull/70) 🎉!
+
+- General:
+
+  - Extend [`eclipse_patch.py`](scripts/eclipse_patch.py) to support adding the
+    Memfault SDK files to an STM32Cube IDE project.
+
 ## [1.9.0] - 2024-05-10
 
 ### :chart_with_upwards_trend: Improvements

VERSION

@@ -1,3 +1,3 @@
-BUILD ID: 7848
-GIT COMMIT: e5e934d26b
-VERSION: 1.9.0
+BUILD ID: 7915
+GIT COMMIT: 435dc7c1d8
+VERSION: 1.9.1

components/include/memfault/version.h

@@ -19,8 +19,8 @@ typedef struct {
   uint8_t patch;
 } sMfltSdkVersion;
 
-#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 9, .patch = 0 }
-#define MEMFAULT_SDK_VERSION_STR "1.9.0"
+#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 9, .patch = 1 }
+#define MEMFAULT_SDK_VERSION_STR "1.9.1"
 
 #ifdef __cplusplus
 }

ports/esp_idf/memfault/CMakeLists.txt

@@ -291,10 +291,14 @@ endif()
 #   Much more flexibility in debug information collected (e.g. all RAM, just the current stack trace, select stacks and variables)
 #   Data can be posted directly from device to Memfault cloud for deduplication and analysis
 #
-# Note: in ESP-IDF v5.3.0, the core dump handler function was renamed from esp_core_dump_to_flash to esp_core_dump_write
 set(panic_handler_args "")
 if (DEFINED ENV{IDF_VERSION})
-  if ($ENV{IDF_VERSION} VERSION_GREATER_EQUAL "5.3.0")
+  # In ESP-IDF v5.3.0, the core dump handler function was renamed from
+  # esp_core_dump_to_flash to esp_core_dump_write. It was backported to v5.2.2.
+  if ($ENV{IDF_VERSION} VERSION_GREATER_EQUAL "5.2.2")
+    list(APPEND panic_handler_args "-Wl,--wrap=esp_core_dump_write")
+  # Backported to v5.1.4
+  elseif(($ENV{IDF_VERSION} VERSION_GREATER_EQUAL "5.1.4") AND ($ENV{IDF_VERSION} VERSION_LESS "5.2.0"))
     list(APPEND panic_handler_args "-Wl,--wrap=esp_core_dump_write")
   else()
     list(APPEND panic_handler_args "-Wl,--wrap=esp_core_dump_to_flash")

ports/esp_idf/memfault/common/memfault_fault_handler.c

@@ -95,9 +95,11 @@ void memfault_fault_handling_assert_extra(void *pc, void *lr, sMemfaultAssertInf
 //! later backported to the 4.2 branch in v4.2.3. Support that change with a
 //! version check (see static assert below for verifying the signature is
 //! correct).
-//! The signature also changed in esp-idf v5.3.0.
+//! The signature changed in esp-idf v5.3.0, back ported to v5.1.4 + v5.2.2.
 #if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 2, 3)
-  #if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 3, 0)
+  #if (ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 2, 2)) || \
+    ((ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 1, 4)) &&  \
+     (ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 2, 0)))
 void __wrap_esp_core_dump_write(panic_info_t *info) {
   #else
 void __wrap_esp_core_dump_to_flash(panic_info_t *info) {
@@ -253,7 +255,9 @@ void __wrap_esp_core_dump_to_flash(XtExcFrame *fp) {
 
 // Ensure the substituted function signature matches the original function
 _Static_assert(__builtin_types_compatible_p(
-#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 3, 0)
+#if (ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 2, 2)) || \
+  ((ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 1, 4)) &&  \
+   (ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 2, 0)))
                  __typeof__(&esp_core_dump_write), __typeof__(&__wrap_esp_core_dump_write)),
 #else
                  __typeof__(&esp_core_dump_to_flash), __typeof__(&__wrap_esp_core_dump_to_flash)),

ports/zephyr/Kconfig

@@ -381,6 +381,14 @@ config MEMFAULT_REBOOT_REASON_GET_CUSTOM
         User of SDK must provide their own implementation of memfault_reboot_reason_get()
         when disabled
 
+config MEMFAULT_REBOOT_TRACKING_REGION
+       string "Memfault Reboot Tracking Region"
+       default ".rtc_noinit" if SOC_FAMILY_ESP32
+       default ".noinit.mflt_reboot_info"
+        help
+         The region in memory where the reboot tracking information will be stored.
+         This region should be marked as NOINIT in the linker script.
+
 config MEMFAULT_CLEAR_RESET_REG
        bool "Whether or not to clear bits in MCU reset reason register"
        default y

ports/zephyr/common/memfault_platform_core.c

@@ -97,7 +97,7 @@ void assert_post_action(const char *file, unsigned int line)
 // On boot-up, log out any information collected as to why the
 // reset took place
 
-MEMFAULT_PUT_IN_SECTION(".noinit.mflt_reboot_info")
+MEMFAULT_PUT_IN_SECTION(CONFIG_MEMFAULT_REBOOT_TRACKING_REGION)
 static uint8_t s_reboot_tracking[MEMFAULT_REBOOT_TRACKING_REGION_SIZE];
 
 static uint8_t s_event_storage[CONFIG_MEMFAULT_EVENT_STORAGE_SIZE];

ports/zephyr/common/memfault_zephyr_ram_regions.c

@@ -191,7 +191,7 @@ size_t memfault_zephyr_get_task_regions(sMfltCoredumpRegion *regions, size_t num
     // region, so we might be duplicating it here; it's a little wasteful, but
     // it's good to always prioritize the currently running stack, in case the
     // coredump is truncated due to lack of space.
-#if !CONFIG_MEMFAULT_COREDUMP_FULL_THREAD_STACKS
+#if !defined(CONFIG_MEMFAULT_COREDUMP_FULL_THREAD_STACKS)
     if ((uintptr_t)_kernel.cpus[0].current == (uintptr_t)thread) {
       // when collecting partial stacks, thread context is only valid when task
       // is _not_ running so we skip collecting it. just update the watermark
@@ -217,16 +217,15 @@ size_t memfault_zephyr_get_task_regions(sMfltCoredumpRegion *regions, size_t num
       ;
 
 #if defined(CONFIG_THREAD_STACK_INFO)
+  #if defined(CONFIG_MEMFAULT_COREDUMP_FULL_THREAD_STACKS)
+    // Capture the entire stack for this thread
+    size_t stack_size_to_collect = thread->stack_info.size;
+    sp = (void *)thread->stack_info.start;
+  #else
     // We know where the top of the stack is. Use that information to shrink
     // the area we need to collect if less than CONFIG_MEMFAULT_COREDUMP_STACK_SIZE_TO_COLLECT
     // is in use
     const uint32_t stack_top = thread->stack_info.start + thread->stack_info.size;
-
-  #if CONFIG_MEMFAULT_COREDUMP_FULL_THREAD_STACKS
-    // Capture the entire stack for this thread
-    size_t stack_size_to_collect = thread->stack_info.size;
-    sp = thread->stack_info.start;
-  #else
     size_t stack_size_to_collect =
       MEMFAULT_MIN(stack_top - (uint32_t)sp, CONFIG_MEMFAULT_COREDUMP_STACK_SIZE_TO_COLLECT);
   #endif

scripts/eclipse_patch.py

@@ -80,6 +80,25 @@ def get_file_element(file_name, virtual_dir, common_prefix, parent_dir, path_typ
     return generate_link_element(name, path, path_type=path_type)
 
 
+def generate_st_linker_option():
+    ele = ET.fromstring(  # noqa: S314
+        """
+<option IS_BUILTIN_EMPTY="false" IS_VALUE_EMPTY="false" id="com.st.stm32cube.ide.mcu.gnu.managedbuild.tool.c.linker.option.otherflags" superClass="com.st.stm32cube.ide.mcu.gnu.managedbuild.tool.c.linker.option.otherflags" valueType="stringList">
+\t\t\t\t\t\t\t\t\t</option>
+"""
+    )
+    ele.tail = "\n\t\t\t\t\t\t\t\t"
+    return ele
+
+
+def generate_st_build_id_flag():
+    ele = ET.fromstring(  # noqa: S314
+        """<listOptionValue builtIn="false" value="-Wl,--build-id" />"""
+    )
+    ele.tail = "\n\t\t\t\t\t\t\t\tq"
+    return ele
+
+
 def recursive_glob_backport(dir_glob):
     # Find first directory wildcard and walk the tree from there
     glob_root = dir_glob.split("/*")[0]
@@ -272,6 +291,8 @@ def _find_include_nodes(option):
             "ilg.gnuarmeclipse.managedbuild.cross.option.c.compiler.include.paths",
             # this is the element id used by NXP's MCUXpresso IDE
             "gnu.c.compiler.option.include.paths",
+            # Element used by ST's STM32Cube IDE for include path enumeration
+            "com.st.stm32cube.ide.mcu.gnu.managedbuild.tool.c.compiler.option.includepaths",
         ))
 
     memfault_sdk_include_paths = [
@@ -294,12 +315,54 @@ def _find_include_nodes(option):
             ele.tail = tail
             include_option.append(ele)
 
+    #
+    # Add GNU build id to STM32Cube IDE based projects
+    #
+
+    def _find_st_linker_tools(tool):
+        return tool.get("id", "").startswith(
+            # Element used by ST's STM32Cube IDE for linker arguments
+            "com.st.stm32cube.ide.mcu.gnu.managedbuild.tool.c.linker",
+        )
+
+    def _find_st_linker_options(option):
+        return option.get("id", "").startswith(
+            "com.st.stm32cube.ide.mcu.gnu.managedbuild.tool.c.linker.option.otherflags"
+        )
+
+    def _find_st_build_id_linker_flag(option):
+        return "--build-id" in option.get("value", "")
+
+    tools = root.findall(".//tool")
+    linker_tools = filter(_find_st_linker_tools, tools)
+    for linker_tool in linker_tools:
+        all_linker_options = linker_tool.findall(".//option")
+
+        linker_options = filter(_find_st_linker_options, all_linker_options)
+        if len(list(linker_options)) != 0:
+            continue
+
+        ele = generate_st_linker_option()
+        linker_tool.insert(0, ele)
+
+        # reload all linker options and now add the flag itself
+        linker_options = filter(_find_st_linker_options, linker_tool.findall(".//option"))
+        for linker_option in linker_options:
+            linker_flags = filter(
+                _find_st_build_id_linker_flag, linker_option.findall(".//listOptionValue")
+            )
+            if len(list(linker_flags)) != 0:
+                continue
+            ele = generate_st_build_id_flag()
+            linker_option.insert(0, ele)
+
     #
     # Add GNU build id generation for all build configurations:
     #
 
     def _find_linker_flags(option):
         return option.get("id", "").startswith(
+            # Element used by Dialog's Smart Snippets Studio IDE
             "ilg.gnuarmeclipse.managedbuild.cross.option.c.linker.other"
         ) and option.get("name", "").startswith("Other linker flags")