Memfault Firmware SDK 0.43.1 (Build 2030)

Author: Memfault Inc

CHANGES.md

@@ -1,3 +1,14 @@
+### Changes between Memfault SDK 0.43.1 and 0.43.0 - April 26, 2023
+
+#### :chart_with_upwards_trend: Improvements
+
+- Zephyr:
+
+  - The `z_NmiHandlerSet` function is renamed for the upcoming Zephyr 3.4.
+    Support the new name. Fixes
+    [#49](https://github.com/memfault/memfault-firmware-sdk/issues/49). Thanks
+    @mbolivar-nordic for filing this issue!
+
 ### Changes between Memfault SDK 0.43.0 and 0.42.1 - April 18, 2023
 
 #### :rocket: New Features

VERSION

@@ -1,2 +1,2 @@
-BUILD ID: 1963
-GIT COMMIT: bcb826788
+BUILD ID: 2030
+GIT COMMIT: 6bca4dee8

components/include/memfault/version.h

@@ -19,7 +19,7 @@ typedef struct {
   uint8_t patch;
 } sMfltSdkVersion;
 
-#define MEMFAULT_SDK_VERSION   { .major = 0, .minor = 43, .patch = 0 }
+#define MEMFAULT_SDK_VERSION   { .major = 0, .minor = 43, .patch = 1 }
 
 #ifdef __cplusplus
 }

examples/nrf-connect-sdk/nrf5/memfault_demo_app/CMakeLists.txt

@@ -2,6 +2,10 @@
 
 cmake_minimum_required(VERSION 3.20.0)
 
+# The default board for this example is the nrf52840dk_nrf52840, but can be
+# overridden by passing --board=<board> to west or -DBOARD=<board> to cmake
+set(BOARD nrf52840dk_nrf52840)
+
 find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
 project(fs_shell)
 

examples/nrf-connect-sdk/nrf5/memfault_demo_app/Kconfig

@@ -1,6 +1,10 @@
 
 menu "MEMFAULT_APP"
 
+# Set Memfault fw_version to the same as the mcuboot image version
+config MEMFAULT_NCS_FW_VERSION
+    default MCUBOOT_IMAGE_VERSION
+
 config MEMFAULT_APP_CAPTURE_ALL_RAM
     bool "Capture all RAM"
     help

examples/nrf-connect-sdk/nrf5/memfault_demo_app/prj.conf

@@ -22,7 +22,8 @@ CONFIG_MEMFAULT_NCS_DEVICE_ID_RUNTIME=y
 CONFIG_MEMFAULT_NCS_HW_VERSION="a"
 CONFIG_MEMFAULT_NCS_FW_TYPE="nrf52_example"
 CONFIG_MEMFAULT_NCS_FW_VERSION_STATIC=y
-CONFIG_MEMFAULT_NCS_FW_VERSION="0.0.1"
+# Note: MEMFAULT_NCS_FW_VERSION is set from this in the project Kconfig
+CONFIG_MCUBOOT_IMAGE_VERSION="0.0.1"
 
 # Enable and configure logging
 CONFIG_LOG=y

ports/zephyr/common/memfault_platform_coredump_regions.c

@@ -15,41 +15,30 @@
 #include "memfault/ports/zephyr/version.h"
 
 #if MEMFAULT_ZEPHYR_VERSION_GT(2, 1)
-#include <arch/arm/aarch32/cortex_m/cmsis.h>
+  #include <arch/arm/aarch32/cortex_m/cmsis.h>
 #else
-#include <arch/arm/cortex_m/cmsis.h>
+  #include <arch/arm/cortex_m/cmsis.h>
 #endif
 
 #include "memfault/core/compiler.h"
 #include "memfault/core/math.h"
 #include "memfault/ports/zephyr/coredump.h"
 
-static sMfltCoredumpRegion s_coredump_regions[
-    MEMFAULT_COREDUMP_MAX_TASK_REGIONS
-    + 2 /* active stack(s) */
-    + 1 /* _kernel variable */
-    + 1 /* s_task_watermarks */
-    + 1 /* s_task_tcbs */
-#if CONFIG_MEMFAULT_COREDUMP_COLLECT_DATA_REGIONS
-    + 1
-#endif
-#if CONFIG_MEMFAULT_COREDUMP_COLLECT_BSS_REGIONS
-    + 1
-#endif
-    ];
-
-MEMFAULT_WEAK
-const sMfltCoredumpRegion *memfault_platform_coredump_get_regions(
-    const sCoredumpCrashInfo *crash_info, size_t *num_regions) {
+size_t memfault_zephyr_coredump_get_regions(const sCoredumpCrashInfo *crash_info,
+                                            sMfltCoredumpRegion *regions, size_t num_regions) {
+  // Check that regions is valid and has enough space to store all required regions
+  if (regions == NULL || num_regions < MEMFAULT_ZEPHYR_COREDUMP_REGIONS) {
+    return 0;
+  }
 
   const bool msp_was_active = (crash_info->exception_reg_state->exc_return & (1 << 2)) == 0;
-  int region_idx = 0;
+  size_t region_idx = 0;
 
   size_t stack_size_to_collect = memfault_platform_sanitize_address_range(
-        crash_info->stack_address, CONFIG_MEMFAULT_COREDUMP_STACK_SIZE_TO_COLLECT);
+    crash_info->stack_address, CONFIG_MEMFAULT_COREDUMP_STACK_SIZE_TO_COLLECT);
 
-  s_coredump_regions[region_idx] = MEMFAULT_COREDUMP_MEMORY_REGION_INIT(
-      crash_info->stack_address, stack_size_to_collect);
+  regions[region_idx] =
+    MEMFAULT_COREDUMP_MEMORY_REGION_INIT(crash_info->stack_address, stack_size_to_collect);
   region_idx++;
 
   if (msp_was_active) {
@@ -60,19 +49,15 @@ const sMfltCoredumpRegion *memfault_platform_coredump_get_regions(
     // exception frame that will have been stacked on it as well
     const uint32_t extra_stack_bytes = 128;
     stack_size_to_collect = memfault_platform_sanitize_address_range(
-        psp, CONFIG_MEMFAULT_COREDUMP_STACK_SIZE_TO_COLLECT + extra_stack_bytes);
-    s_coredump_regions[region_idx] = MEMFAULT_COREDUMP_MEMORY_REGION_INIT(
-        psp, stack_size_to_collect);
+      psp, CONFIG_MEMFAULT_COREDUMP_STACK_SIZE_TO_COLLECT + extra_stack_bytes);
+    regions[region_idx] = MEMFAULT_COREDUMP_MEMORY_REGION_INIT(psp, stack_size_to_collect);
     region_idx++;
   }
 
-  s_coredump_regions[region_idx] = MEMFAULT_COREDUMP_MEMORY_REGION_INIT(
-      &_kernel, sizeof(_kernel));
+  regions[region_idx] = MEMFAULT_COREDUMP_MEMORY_REGION_INIT(&_kernel, sizeof(_kernel));
   region_idx++;
 
-  region_idx += memfault_zephyr_get_task_regions(
-      &s_coredump_regions[region_idx],
-      MEMFAULT_ARRAY_SIZE(s_coredump_regions) - region_idx);
+  region_idx += memfault_zephyr_get_task_regions(&regions[region_idx], num_regions - region_idx);
 
   //
   // Now that we have captured all the task state, we will
@@ -81,15 +66,22 @@ const sMfltCoredumpRegion *memfault_platform_coredump_get_regions(
   //
 
 #if CONFIG_MEMFAULT_COREDUMP_COLLECT_DATA_REGIONS
-  region_idx +=  memfault_zephyr_get_data_regions(
-      &s_coredump_regions[region_idx], MEMFAULT_ARRAY_SIZE(s_coredump_regions) - region_idx);
+  region_idx += memfault_zephyr_get_data_regions(&regions[region_idx], num_regions - region_idx);
 #endif
 
 #if CONFIG_MEMFAULT_COREDUMP_COLLECT_BSS_REGIONS
-  region_idx +=  memfault_zephyr_get_bss_regions(
-      &s_coredump_regions[region_idx], MEMFAULT_ARRAY_SIZE(s_coredump_regions) - region_idx);
+  region_idx += memfault_zephyr_get_bss_regions(&regions[region_idx], num_regions - region_idx);
 #endif
 
-  *num_regions = region_idx;
+  return region_idx;
+}
+
+MEMFAULT_WEAK
+const sMfltCoredumpRegion *memfault_platform_coredump_get_regions(
+  const sCoredumpCrashInfo *crash_info, size_t *num_regions) {
+  static sMfltCoredumpRegion s_coredump_regions[MEMFAULT_ZEPHYR_COREDUMP_REGIONS];
+
+  *num_regions = memfault_zephyr_coredump_get_regions(crash_info, s_coredump_regions,
+                                                      MEMFAULT_ARRAY_SIZE(s_coredump_regions));
   return &s_coredump_regions[0];
 }

ports/zephyr/include/memfault/ports/zephyr/coredump.h

@@ -17,10 +17,31 @@ extern "C" {
 //! For each task, we will collect the TCB and the portion of the stack where context is saved
 #define MEMFAULT_COREDUMP_MAX_TASK_REGIONS (CONFIG_MEMFAULT_COREDUMP_MAX_TRACKED_TASKS * 2)
 
-//! Helper to collect minimal RAM needed for backtraces of non-running FreeRTOS tasks
+//! Define base number of regions to collect (active stack(s)[2] + _kernel[1] + s_task_watermarks[1]
+//! + s_task_tcbs[1])
+#define MEMFAULT_ZEPHYR_BASE_COREDUMP_REGIONS (5)
+
+//! Define the total regions to collect
+#define MEMFAULT_ZEPHYR_COREDUMP_REGIONS                                        \
+  (MEMFAULT_ZEPHYR_BASE_COREDUMP_REGIONS + MEMFAULT_COREDUMP_MAX_TASK_REGIONS + \
+   IS_ENABLED(CONFIG_MEMFAULT_COREDUMP_COLLECT_BSS_REGIONS) +                   \
+   IS_ENABLED(CONFIG_MEMFAULT_COREDUMP_COLLECT_DATA_REGIONS))
+
+//! Helper to collect regions required to decode Zephyr state
+//!
+//! These regions include the active task, the kernel state, other tasks in the system,
+//! and bss/data regions if enabled.
+//!
+//! @param crash_info Contains info regarding the location and state of the crash
+//! @param regions Pointer to save region info into
+//! @param num_regions The number of entries in the 'regions' array
+size_t memfault_zephyr_coredump_get_regions(const sCoredumpCrashInfo *crash_info,
+                                            sMfltCoredumpRegion *regions, size_t num_regions);
+
+//! Helper to collect minimal RAM needed for backtraces of non-running Zephyr tasks
 //!
 //! @param[out] regions Populated with the regions that need to be collected in order
-//!  for task and stack state to be recovered for non-running FreeRTOS tasks
+//!  for task and stack state to be recovered for non-running Zephyr tasks
 //! @param[in] num_regions The number of entries in the 'regions' array
 //!
 //! @return The number of entries that were populated in the 'regions' argument. Will always

ports/zephyr/v2.4/memfault_fault_handler.c

@@ -18,6 +18,17 @@
 #include "memfault/panics/arch/arm/cortex_m.h"
 #include "memfault/panics/coredump.h"
 #include "memfault/panics/fault_handling.h"
+#include "memfault/ports/zephyr/version.h"
+
+// Starting in v3.4, the handler set function was renamed and the declaration
+// added to a public header
+#if MEMFAULT_ZEPHYR_VERSION_GT(3, 3)
+  #include <arch/arm/aarch32/nmi.h>
+  #define MEMFAULT_ZEPHYR_NMI_HANDLER_SET z_arm_nmi_set_handler
+#else
+  #define MEMFAULT_ZEPHYR_NMI_HANDLER_SET z_NmiHandlerSet
+extern void MEMFAULT_ZEPHYR_NMI_HANDLER_SET(void (*pHandler)(void));
+#endif  // MEMFAULT_ZEPHYR_VERSION_GT(3, 3)
 
 // By default, the Zephyr NMI handler is an infinite loop. Instead
 // let's register the Memfault Exception Handler
@@ -28,8 +39,7 @@
 // Since we don't use the arguments we match anything with () to avoid
 // compiler warnings and share the same bootup logic
 static int prv_install_nmi_handler() {
-  extern void z_NmiHandlerSet(void (*pHandler)(void));
-  z_NmiHandlerSet(MEMFAULT_EXC_HANDLER_NMI);
+  MEMFAULT_ZEPHYR_NMI_HANDLER_SET(MEMFAULT_EXC_HANDLER_NMI);
   return 0;
 }
 

tests/makefiles/Makefile_memfault_printf_attribute.mk

@@ -1,3 +1,9 @@
+# Add a file to create dummy TARGET_LIB
+# We don't actually call anything from this lib so just add
+# the current source
+SRC_FILES = \
+  $(MFLT_TEST_SRC_DIR)/test_memfault_printf_attribute.cpp
+
 TEST_SRC_FILES = \
   $(MFLT_TEST_SRC_DIR)/test_memfault_printf_attribute.cpp \
   $(MOCK_AND_FAKE_SRC_FILES)