Memfault Firmware SDK 0.31.5 (Build 481181)

Author: Memfault Inc

CHANGES.md

@@ -1,3 +1,27 @@
+### Changes between Memfault SDK 0.31.5 and SDK 0.31.4 - July 22, 2022
+
+#### :chart_with_upwards_trend: Improvements
+
+- Zephyr port: enable proper backtraces for Zephyr `__ASSERT()` macro on
+  aarch32/cortex_m. Prior to this fix, crashes from `__ASSERT()` triggering
+  would show an incorrect PC/LR for the active thread.
+
+- Support for pre-release nRF Connect SDK v2.0.99 and Zephyr > v3.1:
+  - Upcoming nRF Connect SDK and Zephyr releases removed logging v1. Add build
+    support for these changes, and keep backwards compatibility for previous nRF
+    Connect SDK/Zephyr releases
+  - Correct an issue in the Memfault logging v2 backend, when the system was
+    invoked from an ISR context. This could happen due to a recent change, in
+    Memfault SDK v0.31.1, where the Zephyr fatal informational logs were output
+    from `memfault_platform_reboot()` by default. It did not impact the
+    collected backtrace, but it would show a nuisance `__ASSERT()` in the
+    console output, if `CONFIG_ASSERT=y`.
+
+#### :house: Internal
+
+- Fix a compilation issue in the Dialog example app from the removal of
+  `memfault_demo_cli_cmd_print_chunk()` in Memfault SDK release v0.31.4.
+
 ### Changes between Memfault SDK 0.31.4 and SDK 0.31.3 - July 19, 2022
 
 #### :chart_with_upwards_trend: Improvements

VERSION

@@ -1,2 +1,2 @@
-BUILD ID: 478452
-GIT COMMIT: 56592ceef
+BUILD ID: 481181
+GIT COMMIT: 95031d142

components/include/memfault/version.h

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

examples/dialog/da145xx/apps/memfault_demo_app/Eclipse/.project

@@ -169,11 +169,6 @@
 			<type>1</type>
 			<locationURI>PARENT-6-PROJECT_LOC/components/demo/src/panics/memfault_demo_cli_aux.c</locationURI>
 		</link>
-		<link>
-			<name>memfault_components/memfault_demo_cli_print_chunk.c</name>
-			<type>1</type>
-			<locationURI>PARENT-6-PROJECT_LOC/components/demo/src/memfault_demo_cli_print_chunk.c</locationURI>
-		</link>
 		<link>
 			<name>memfault_components/memfault_demo_cli_trace_event.c</name>
 			<type>1</type>

ports/zephyr/Kconfig

@@ -290,6 +290,15 @@ config MEMFAULT_INIT_LEVEL_POST_KERNEL
          Set the Memfault initialization SYS_INIT priority level to
          "POST_KERNEL". Default is "APPLICATION".
 
+config MEMFAULT_CATCH_ZEPHYR_ASSERT
+        bool "Support backtrace through Zephyr __ASSERT() calls"
+        default y
+        help
+         When enabled, Memfault will support proper backtraces when a Zephyr
+         __ASSERT() trips. If disabled (i.e. user needs a custom implementation
+         of assert_post_action()), backtraces will not be correctly captured
+         from __ASSERT() macro call sites, unless assert_post_action() contains
+         a MEMFAULT_ASSERT() invocation.
 rsource "ncs/Kconfig"
 
 endif # MEMFAULT

ports/zephyr/common/memfault_demo_cli.c

@@ -6,17 +6,11 @@
 //! @brief
 //! Adds a basic set of commands for interacting with Memfault SDK
 
-#include "memfault/demo/cli.h"
-
 #include <shell/shell.h>
 
-#include "memfault/core/data_export.h"
-#include "memfault/core/debug_log.h"
-#include "memfault/core/platform/core.h"
-#include "memfault/core/reboot_tracking.h"
-#include "memfault/core/trace_event.h"
-#include "memfault/metrics/metrics.h"
+#include "memfault/components.h"
 #include "memfault/ports/zephyr/http.h"
+#include "zephyr_release_specific_headers.h"
 
 static int prv_clear_core_cmd(const struct shell *shell, size_t argc, char **argv) {
   return memfault_demo_cli_cmd_clear_core(argc, argv);
@@ -30,6 +24,14 @@ static int prv_crash_example(const struct shell *shell, size_t argc, char **argv
   return memfault_demo_cli_cmd_crash(argc, argv);
 }
 
+static int prv_zephyr_assert_example(const struct shell *shell, size_t argc, char **argv) {
+#if !CONFIG_ASSERT
+  MEMFAULT_LOG_WARN("CONFIG_ASSERT was disabled in the build, this command will have no effect");
+#endif
+  __ASSERT(0, "test assert");
+  return 0;
+}
+
 static int prv_test_log(const struct shell *shell, size_t argc, char **argv) {
   return memfault_demo_cli_cmd_test_log(argc, argv);
 }
@@ -48,7 +50,8 @@ static int prv_hang_example(const struct shell *shell, size_t argc, char **argv)
 #else
   MEMFAULT_LOG_DEBUG("Hanging system and waiting for watchdog!");
 #endif
-  while (1) { }
+  while (1) {
+  }
   return -1;
 }
 
@@ -102,7 +105,8 @@ static bool prv_handle_download_complete(void *user_ctx) {
 }
 #endif /* CONFIG_MEMFAULT_HTTP_ENABLE */
 
-static int prv_check_and_fetch_ota_payload_cmd(const struct shell *shell, size_t argc, char **argv) {
+static int prv_check_and_fetch_ota_payload_cmd(const struct shell *shell, size_t argc,
+                                               char **argv) {
 #if defined(CONFIG_MEMFAULT_HTTP_ENABLE)
   uint8_t working_buf[256];
 
@@ -147,25 +151,30 @@ static int prv_trigger_heartbeat(const struct shell *shell, size_t argc, char **
 static int prv_test_reboot(const struct shell *shell, size_t argc, char **argv) {
   memfault_reboot_tracking_mark_reset_imminent(kMfltRebootReason_UserReset, NULL);
   memfault_platform_reboot();
-  return 0; // should be unreachable
+  return 0;  // should be unreachable
 }
 
 SHELL_STATIC_SUBCMD_SET_CREATE(
-    sub_memfault_cmds,
-    SHELL_CMD(reboot, NULL, "trigger a reboot and record it using memfault", prv_test_reboot),
-    SHELL_CMD(get_core, NULL, "gets the core", prv_get_core_cmd),
-    SHELL_CMD(clear_core, NULL, "clear the core", prv_clear_core_cmd),
-    SHELL_CMD(crash, NULL, "trigger a crash", prv_crash_example),
-    SHELL_CMD(test_log, NULL, "Writes test logs to log buffer", prv_test_log),
-    SHELL_CMD(trigger_logs, NULL, "Trigger capture of current log buffer contents", prv_trigger_logs),
-    SHELL_CMD(hang, NULL, "trigger a hang to test watchdog functionality", prv_hang_example),
-    SHELL_CMD(export, NULL, "dump chunks collected by Memfault SDK using https://mflt.io/chunk-data-export", prv_chunk_data_export),
-    SHELL_CMD(trace, NULL, "Capture an example trace event", prv_example_trace_event_capture),
-    SHELL_CMD(get_device_info, NULL, "display device information", prv_get_device_info),
-    SHELL_CMD(post_chunks, NULL, "Post Memfault data to cloud", prv_post_data),
-    SHELL_CMD(trigger_heartbeat, NULL, "Trigger an immediate capture of all heartbeat metrics", prv_trigger_heartbeat),
-    SHELL_CMD(get_latest_release, NULL, "checks to see if new ota payload is available", prv_check_and_fetch_ota_payload_cmd),
-    SHELL_SUBCMD_SET_END /* Array terminated. */
+  sub_memfault_cmds,
+  SHELL_CMD(reboot, NULL, "trigger a reboot and record it using memfault", prv_test_reboot),
+  SHELL_CMD(get_core, NULL, "gets the core", prv_get_core_cmd),
+  SHELL_CMD(clear_core, NULL, "clear the core", prv_clear_core_cmd),
+  SHELL_CMD(crash, NULL, "trigger a crash", prv_crash_example),
+  SHELL_CMD(zephyr_assert, NULL, "trigger a zephyr __ASSERT", prv_zephyr_assert_example),
+  SHELL_CMD(test_log, NULL, "Writes test logs to log buffer", prv_test_log),
+  SHELL_CMD(trigger_logs, NULL, "Trigger capture of current log buffer contents", prv_trigger_logs),
+  SHELL_CMD(hang, NULL, "trigger a hang to test watchdog functionality", prv_hang_example),
+  SHELL_CMD(export, NULL,
+            "dump chunks collected by Memfault SDK using https://mflt.io/chunk-data-export",
+            prv_chunk_data_export),
+  SHELL_CMD(trace, NULL, "Capture an example trace event", prv_example_trace_event_capture),
+  SHELL_CMD(get_device_info, NULL, "display device information", prv_get_device_info),
+  SHELL_CMD(post_chunks, NULL, "Post Memfault data to cloud", prv_post_data),
+  SHELL_CMD(trigger_heartbeat, NULL, "Trigger an immediate capture of all heartbeat metrics",
+            prv_trigger_heartbeat),
+  SHELL_CMD(get_latest_release, NULL, "checks to see if new ota payload is available",
+            prv_check_and_fetch_ota_payload_cmd),
+  SHELL_SUBCMD_SET_END /* Array terminated. */
 );
 
 SHELL_CMD_REGISTER(mflt, &sub_memfault_cmds, "Memfault Test Commands", NULL);

ports/zephyr/common/memfault_logging.c

@@ -66,9 +66,16 @@ static void prv_log_process(const struct log_backend *const backend, union log_m
 
 static void prv_log_dropped(const struct log_backend *const backend, uint32_t cnt);
 const struct log_backend_api log_backend_mflt_api = {
-#if MEMFAULT_ZEPHYR_VERSION_GT(2, 5)
+// The CONFIG_LOG2/1 options were removed after the 3.1 release series, so we no
+// longer can use them to assign the correct backend. Luckily there's only one
+// log type now, so it can just be set directly.
+#if MEMFAULT_ZEPHYR_VERSION_GT(3, 1)
+  .process          = prv_log_process,
+#elif MEMFAULT_ZEPHYR_VERSION_GT(2, 5)
   .process          = IS_ENABLED(CONFIG_LOG2) ? prv_log_process : NULL,
 #endif
+
+// Old-style logging backend API
 #if !MEMFAULT_ZEPHYR_VERSION_GT(3, 1)
   .put              = IS_ENABLED(CONFIG_LOG_IMMEDIATE) ? NULL : prv_log_put,
   .put_sync_string  = IS_ENABLED(CONFIG_LOG_IMMEDIATE) ? prv_log_put_sync_string : NULL,
@@ -86,6 +93,12 @@ LOG_BACKEND_DEFINE(log_backend_mflt, log_backend_mflt_api, true);
 
 // Tie Memfault's log function to the Zephyr buffer sender. This is *the* connection to Memfault.
 static int prv_log_out(uint8_t *data, size_t length, void *ctx) {
+  if (memfault_arch_is_inside_isr()) {
+    // In synchronous mode, logging can occur from ISRs. The zephyr fault handlers are chatty so
+    // don't save info while in an ISR to avoid wrapping over the info we are collecting.
+    return (int) length;
+  }
+
   // Note: Context should always be populated. If it is not, flag the log as an _Error
   const eMemfaultPlatformLogLevel log_level = ctx != NULL ? *(eMemfaultPlatformLogLevel*)ctx :
                                                             kMemfaultPlatformLogLevel_Error;

ports/zephyr/common/memfault_platform_core.c

@@ -8,14 +8,9 @@
 #include <init.h>
 #include <soc.h>
 
-#include "memfault/core/build_info.h"
-#include "memfault/core/compiler.h"
-#include "memfault/core/event_storage.h"
-#include "memfault/core/reboot_tracking.h"
-#include "memfault/core/trace_event.h"
-#include "memfault/panics/coredump.h"
+#include "memfault/components.h"
 #include "memfault/ports/reboot_reason.h"
-#include "memfault/ports/zephyr/version.h"
+#include "zephyr_release_specific_headers.h"
 
 #if !MEMFAULT_ZEPHYR_VERSION_GT(2, 5)
 
@@ -55,6 +50,23 @@ uint64_t memfault_platform_get_time_since_boot_ms(void) {
   return k_uptime_get();
 }
 
+//! Provide a strong implementation of assert_post_action for Zephyr's built-in
+//! __ASSERT() macro.
+#if CONFIG_MEMFAULT_CATCH_ZEPHYR_ASSERT
+#ifdef CONFIG_ASSERT_NO_FILE_INFO
+void assert_post_action(void)
+#else
+void assert_post_action(const char *file, unsigned int line)
+#endif
+{
+#ifndef CONFIG_ASSERT_NO_FILE_INFO
+  ARG_UNUSED(file);
+  ARG_UNUSED(line);
+#endif
+  MEMFAULT_ASSERT(0);
+}
+#endif
+
 // On boot-up, log out any information collected as to why the
 // reset took place
 

ports/zephyr/v1.14/zephyr_release_specific_headers.h

@@ -12,8 +12,9 @@
 extern "C" {
 #endif
 
-#include <misc/reboot.h>
+#include <misc/__assert.h>
 #include <misc/printk.h>
+#include <misc/reboot.h>
 
 #ifdef __cplusplus
 }

ports/zephyr/v2.0/zephyr_release_specific_headers.h

@@ -12,8 +12,9 @@
 extern "C" {
 #endif
 
-#include <power/reboot.h>
 #include <misc/printk.h>
+#include <power/reboot.h>
+#include <sys/__assert.h>
 
 #ifdef __cplusplus
 }