Memfault Firmware SDK 1.4.2 (Build 4292)

Author: Memfault Inc

CHANGES.md

@@ -1,8 +1,20 @@
 # Memfault Firmware SDK Changelog
 
+## [1.4.2] - 2023-11-02
+
+### :chart_with_upwards_trend: Improvements
+
+- General:
+
+  - Improve the trace quality for asserts when using the IAR compiler and high
+    optimization settings (`-Oh`)
+  - Add demo CLI command to print the current values of heartbeat metrics. Try
+    this out in your demo CLI implementation or with the built-in CLI with
+    Zephyr!
+
 ## [1.4.1] - 2023-10-31
 
-#### :rocket: New Features
+### :rocket: New Features
 
 - ESP-IDF:
 
@@ -14,6 +26,8 @@
     - `heap_allocated_blocks_count`
     - `heap_min_free_bytes`
 
+### :chart_with_upwards_trend: Improvements
+
 - Zephyr:
 
   - Enable capturing [Memfault-style compact logs](https://mflt.io/compact-logs)
@@ -47,7 +61,7 @@
 
 ## [1.4.0] - 2023-10-23
 
-#### :rocket: New Features
+### :rocket: New Features
 
 - ESP-IDF:
 
@@ -174,7 +188,7 @@
     `__no_alloc` attribute to the compact log symbols, to have the IAR linker
     set the `NO_LOAD` attribute correctly on the compact log output section.
 
-#### :boom: Breaking Changes
+### :boom: Breaking Changes
 
 - ESP-IDF:
 

VERSION

@@ -1,3 +1,3 @@
-BUILD ID: 4232
-GIT COMMIT: 3f7cda509f
-VERSION: 1.4.1
+BUILD ID: 4292
+GIT COMMIT: 7f46de743
+VERSION: 1.4.2

components/demo/src/memfault_demo_shell_commands.c

@@ -14,6 +14,7 @@
 #include "memfault/core/math.h"
 #include "memfault/demo/cli.h"
 #include "memfault/demo/shell_commands.h"
+#include "memfault/metrics/metrics.h"
 
 static int prv_panics_component_required(void) {
   MEMFAULT_LOG_RAW("Disabled. panics component integration required");
@@ -41,6 +42,11 @@ int memfault_demo_cli_cmd_export(MEMFAULT_UNUSED int argc, MEMFAULT_UNUSED char
   return 0;
 }
 
+int memfault_demo_cli_cmd_heartbeat_dump(MEMFAULT_UNUSED int argc, MEMFAULT_UNUSED char *argv[]) {
+  memfault_metrics_heartbeat_debug_print();
+  return 0;
+}
+
 static const sMemfaultShellCommand s_memfault_shell_commands[] = {
   {"clear_core", memfault_demo_cli_cmd_clear_core, "Clear an existing coredump"},
   {"drain_chunks", memfault_demo_drain_chunk_data,
@@ -50,6 +56,8 @@ static const sMemfaultShellCommand s_memfault_shell_commands[] = {
   {"get_core", memfault_demo_cli_cmd_get_core, "Get coredump info"},
   {"get_device_info", memfault_demo_cli_cmd_get_device_info, "Get device info"},
   {"coredump_size", memfault_demo_cli_cmd_coredump_size, "Print the coredump storage capacity"},
+  {"heartbeat_dump", memfault_demo_cli_cmd_heartbeat_dump,
+   "Dump current Memfault metrics heartbeat state"},
   //
   // Test commands for validating SDK functionality: https://mflt.io/mcu-test-commands
   //

components/demo/src/panics/memfault_demo_panics.c

@@ -127,6 +127,8 @@ int memfault_demo_cli_cmd_assert(int argc, char *argv[]) {
   } else {
     MEMFAULT_ASSERT(0);
   }
+
+  return -1;
 }
 
 #if MEMFAULT_COMPILER_ARM_CORTEX_M

components/include/memfault/core/platform/core.h

@@ -33,7 +33,13 @@ int memfault_platform_boot(void);
 //! Invoked after memfault fault handling has run.
 //!
 //! The platform should do any final cleanup and reboot the system
-MEMFAULT_NORETURN void memfault_platform_reboot(void);
+#if defined(__ICCARM__)
+//! IAR will optimize away link register stores from callsites which makes it
+//! impossible for a reliable backtrace to be resolved so we don't use the NORETURN attribute
+#else
+MEMFAULT_NORETURN
+#endif
+void memfault_platform_reboot(void);
 
 //! Invoked after faults occur so the user can debug locally if a debugger is attached
 void memfault_platform_halt_if_debugging(void);

components/include/memfault/demo/cli.h

@@ -111,6 +111,9 @@ void user_transport_send_chunk_data(void *chunk_data, size_t chunk_data_len);
 //! manually via the Chunks Debug in the UI.
 int memfault_demo_cli_cmd_export(int argc, char *argv[]);
 
+//! Print current heartbeat metrics
+int memfault_demo_cli_cmd_heartbeat_dump(int argc, char *argv[]);
+
 #ifdef __cplusplus
 }
 #endif

components/include/memfault/panics/fault_handling.h

@@ -82,8 +82,8 @@ MEMFAULT_NAKED_FUNC void MEMFAULT_EXC_HANDLER_WATCHDOG(void);
 //! @param lr The return address
 //! @see MEMFAULT_ASSERT_RECORD
 //! @see MEMFAULT_ASSERT
-#if defined(__CC_ARM) || (defined(__clang__) && defined(__ti__))
-//! ARMCC and tiarmclang will optimize away link register stores from callsites which makes it
+#if defined(__CC_ARM) || defined(__ICCARM__) || (defined(__clang__) && defined(__ti__))
+//! ARMCC, IAR, and tiarmclang will optimize away link register stores from callsites which makes it
 //! impossible for a reliable backtrace to be resolved so we don't use the NORETURN attribute
 #else
 MEMFAULT_NORETURN
@@ -97,8 +97,8 @@ void memfault_fault_handling_assert(void *pc, void *lr);
 //! @param extra_info Additional information used by the assert handler
 //! @see MEMFAULT_ASSERT_RECORD
 //! @see MEMFAULT_ASSERT
-#if defined(__CC_ARM) || (defined(__clang__) && defined(__ti__))
-//! ARMCC and tiarmclang optimize away link register stores from callsites which makes it
+#if defined(__CC_ARM) || defined(__ICCARM__) || (defined(__clang__) && defined(__ti__))
+//! ARMCC, IAR, and tiarmclang optimize away link register stores from callsites which makes it
 //! impossible for a reliable backtrace to be resolved so we don't use the NORETURN attribute
 #else
 MEMFAULT_NORETURN

components/include/memfault/version.h

@@ -19,8 +19,8 @@ typedef struct {
   uint8_t patch;
 } sMfltSdkVersion;
 
-#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 4, .patch = 1 }
-#define MEMFAULT_SDK_VERSION_STR "1.4.1"
+#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 4, .patch = 2 }
+#define MEMFAULT_SDK_VERSION_STR "1.4.2"
 
 #ifdef __cplusplus
 }

examples/esp32/apps/memfault_demo_app/CMakeLists.txt

@@ -15,7 +15,12 @@ if(DEFINED IDF_VERSION_MAJOR)
   endif()
 endif()
 
+# Look for the Memfault SDK in a subdirectory first, when this app is used
+# standalone (not from within the Memfault SDK)
+get_filename_component(memfault_firmare_sdk_dir third-party/memfault-firmware-sdk ABSOLUTE)
+if(NOT EXISTS ${memfault_firmare_sdk_dir})
 get_filename_component(memfault_firmare_sdk_dir ../../../../ ABSOLUTE)
+endif()
 include(${memfault_firmare_sdk_dir}/ports/esp_idf/memfault.cmake)
 
 # NOTE: This include also applies global compiler options, make sure

ports/zephyr/common/memfault_demo_cli.c

@@ -157,6 +157,15 @@ static int prv_trigger_heartbeat(const struct shell *shell, size_t argc, char **
 #endif
 }
 
+static int prv_heartbeat_dump(const struct shell *shell, size_t argc, char **argv) {
+#if defined(CONFIG_MEMFAULT_METRICS)
+  memfault_metrics_heartbeat_debug_print();
+#else
+  shell_print(shell, "CONFIG_MEMFAULT_METRICS not enabled");
+#endif
+  return 0;
+}
+
 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();
@@ -280,6 +289,8 @@ SHELL_STATIC_SUBCMD_SET_CREATE(
             prv_check_and_fetch_ota_payload_cmd),
   SHELL_CMD(coredump_size, NULL, "print coredump computed size and storage capacity",
             prv_coredump_size),
+  SHELL_CMD(heartbeat_dump, NULL, "dump current Memfault metrics heartbeat state",
+            prv_heartbeat_dump),
   SHELL_CMD(post_chunks, NULL, "Post Memfault data to cloud", prv_post_data),
   SHELL_CMD(test, &sub_memfault_crash_cmds,
             "commands to verify memfault data collection (https://mflt.io/mcu-test-commands)",