Memfault Firmware SDK 1.4.3 (Build 4437)

Author: Memfault Inc

CHANGES.md

@@ -1,5 +1,77 @@
 # Memfault Firmware SDK Changelog
 
+## [1.4.3] - 2023-11-08
+
+### :rocket: New Features
+
+- General:
+
+  - Add a new streamlined Metrics setter API:
+
+    - `MEMFAULT_HEARTBEAT_SET_SIGNED(key_name, signed_value)`
+    - `MEMFAULT_HEARTBEAT_SET_UNSIGNED(key_name, unsigned_value)`
+    - `MEMFAULT_HEARTBEAT_SET_STRING(key_name, value)`
+    - `MEMFAULT_HEARTBEAT_TIMER_START(key_name)`
+    - `MEMFAULT_HEARTBEAT_TIMER_STOP(key_name)`
+    - `MEMFAULT_HEARTBEAT_ADD(key_name, amount)`
+
+    These APIs can be used in place of the original APIs:
+
+    - `memfault_metrics_heartbeat_set_signed(MEMFAULT_METRICS_KEY(key_name), signed_value)`
+    - `memfault_metrics_heartbeat_set_unsigned(MEMFAULT_METRICS_KEY(key_name), unsigned_value)`
+    - `memfault_metrics_heartbeat_set_string(MEMFAULT_METRICS_KEY(key_name), value)`
+    - `memfault_metrics_heartbeat_timer_start(MEMFAULT_METRICS_KEY(key_name))`
+    - `memfault_metrics_heartbeat_timer_stop(MEMFAULT_METRICS_KEY(key_name))`
+    - `memfault_metrics_heartbeat_add(MEMFAULT_METRICS_KEY(key_name), amount)`
+
+    Saving some typing!
+
+  - Add the ability to compute FreeRTOS task stack high watermarks when storing
+    coredumps. This is useful only if the entire RAM (`.data` + `.bss`) cannot
+    be saved in the coredump. The feature is opt-in with the config flag
+    `#define MEMFAULT_COREDUMP_COMPUTE_THREAD_STACK_USAGE 1`.
+
+  - Add a `heartbeat` command to the [core demo cli](components/demo). This
+    behaves the same as the commands of the same name already present in the
+    Zephyr + ESP-IDF port.
+
+  - Add a `test_cassert` command to the core demo cli. This command executes a C
+    stdlib `<assert.h>``assert(0)` call. For platforms that do not implement a
+    `assert()` handler, a config flag `MEMFAULT_DEMO_DISABLE_CASSERT` can be
+    defined to `0` to disable the command.
+
+- ESP-IDF:
+
+  - Add a new out-of-box metric, `wifi_ap_oui`, which will record the associated
+    AP's Organizationally Unique Identifier (OUI) in the Memfault heartbeat.
+
+### :chart_with_upwards_trend: Improvements
+
+- General:
+
+  - Disable a warning emitted by the ARM C Compiler v5
+    (`#188-D: enumerated type mixed with another type`) when initializing a
+    structure in
+    [`components/core/src/memfault_log.c`:314](https://github.com/memfault/memfault-firmware-sdk/blob/1.4.3/components/core/src/memfault_log.c#L313).
+
+  - Improve the quality of Assert backtraces when using the ARM C Compiler v5.
+    Certain frames in the assert call stack were missing link register
+    inforation, due to compiler optimizations based on the `noreturn` and
+    unreachable compiler hints. These hints have been removed for `armcc`, which
+    should permit full stack unwinding for Assert coredumps generated from
+    builds on that toolchain.
+
+  - Perform an update of the timer when calling the
+    `memfault_metrics_heartbeat_timer_read()` debug function. Fixes
+    [#65](https://github.com/memfault/memfault-firmware-sdk/pull/65). Thanks to
+    @LuskeyNoah for providing this fix!
+
+- ESP-IDF:
+
+  - Fix a missing piece enabling the "zero-config" integration (originally added
+    in `1.4.0`)- the `memfault_platform_port.h` file was still incorrectly
+    required. This is now fixed.
+
 ## [1.4.2] - 2023-11-02
 
 ### :chart_with_upwards_trend: Improvements
@@ -80,7 +152,7 @@
 
   - Add a new Kconfig flag, `MEMFAULT_COREDUMP_STORAGE_MAX_SIZE`, which can be
     used to set the Memfault SDK's built-in
-    [ESP-IDF coredump storage implementation](sdk/embedded/ports/esp_idf/memfault/common/memfault_platform_coredump.c)
+    [ESP-IDF coredump storage implementation](https://github.com/memfault/memfault-firmware-sdk/blob/master/ports/esp_idf/memfault/common/memfault_platform_coredump.c)
     to artificially limit the maximum coredump storage size. This is useful for
     situations where the default `memfault_platform_coredump_get_regions()`
     function is still desirable, but the coredump maximum size needs to be

VERSION

@@ -1,3 +1,3 @@
-BUILD ID: 4292
-GIT COMMIT: 7f46de743
-VERSION: 1.4.2
+BUILD ID: 4437
+GIT COMMIT: 3453c1402
+VERSION: 1.4.3

components/core/src/memfault_log.c

@@ -314,10 +314,21 @@ void memfault_log_export_logs(void) {
       #pragma diag_push
       #pragma diag_remark 190
     #endif
+    #if defined(__CC_ARM)
+      #pragma push
+      // This armcc diagnostic is technically violating the C standard, which
+      // _explicitly_ requires enums to be type-equivalent to ints. See ISO/IEC
+      // 9899:TC3 6.2.5.16, and specifically 6.4.4.3, which states: "An
+      // identifier declared as an enumeration constant has type int."
+      #pragma diag_suppress 188  // enumerated type mixed with another type
+    #endif
     sMemfaultLog log = {0};
     #if defined(__TI_ARM__)
       #pragma diag_pop
     #endif
+    #if defined(__CC_ARM)
+      #pragma pop
+    #endif
 
     const bool log_found = memfault_log_read(&log);
     if (!log_found) {

components/demo/src/memfault_demo_shell_commands.c

@@ -47,6 +47,11 @@ int memfault_demo_cli_cmd_heartbeat_dump(MEMFAULT_UNUSED int argc, MEMFAULT_UNUS
   return 0;
 }
 
+int memfault_demo_cli_cmd_heartbeat(MEMFAULT_UNUSED int argc, MEMFAULT_UNUSED char *argv[]) {
+  memfault_metrics_heartbeat_debug_trigger();
+  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,
@@ -58,11 +63,13 @@ static const sMemfaultShellCommand s_memfault_shell_commands[] = {
   {"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"},
+  {"heartbeat", memfault_demo_cli_cmd_heartbeat, "Trigger a heartbeat"},
   //
   // Test commands for validating SDK functionality: https://mflt.io/mcu-test-commands
   //
 
   {"test_assert", memfault_demo_cli_cmd_assert, "Trigger memfault assert"},
+  {"test_cassert", memfault_demo_cli_cmd_cassert, "Trigger C assert"},
 
 #if MEMFAULT_COMPILER_ARM_CORTEX_M
   {"test_busfault", memfault_demo_cli_cmd_busfault, "Trigger a busfault"},

components/demo/src/panics/memfault_demo_panics.c

@@ -22,6 +22,13 @@
 #include "memfault/panics/platform/coredump.h"
 #include "memfault_demo_cli_aux_private.h"
 
+// Allow opting out of the cassert demo. Some platforms may not have a libc
+// assert implementation.
+#if !defined(MEMFAULT_DEMO_DISABLE_CASSERT)
+  #include <assert.h>
+  #define MEMFAULT_DEMO_DISABLE_CASSERT 0
+#endif
+
 MEMFAULT_NO_OPT
 static void do_some_work_base(char *argv[]) {
   // An assert that is guaranteed to fail. We perform
@@ -131,6 +138,18 @@ int memfault_demo_cli_cmd_assert(int argc, char *argv[]) {
   return -1;
 }
 
+int memfault_demo_cli_cmd_cassert(int argc, char *argv[]) {
+  (void)argc, (void)argv;
+
+#if MEMFAULT_DEMO_DISABLE_CASSERT
+  MEMFAULT_LOG_ERROR("C assert demo disabled");
+#else
+  assert(0);
+#endif
+
+  return -1;
+}
+
 #if MEMFAULT_COMPILER_ARM_CORTEX_M
 
 int memfault_demo_cli_cmd_hardfault(MEMFAULT_UNUSED int argc, MEMFAULT_UNUSED char *argv[]) {

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

@@ -33,9 +33,10 @@ int memfault_platform_boot(void);
 //! Invoked after memfault fault handling has run.
 //!
 //! The platform should do any final cleanup and reboot the system
-#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
+#if defined(__ICCARM__) || defined(__CC_ARM)
+//! IAR and armcc will optimize away link register stores from callsites, which
+//! makes it impossible for a reliable backtrace to be resolved, so for those
+//! compilers don't apply the NORETURN attribute
 #else
 MEMFAULT_NORETURN
 #endif

components/include/memfault/demo/cli.h

@@ -57,6 +57,9 @@ int memfault_demo_cli_cmd_prefetchabort(int argc, char *argv[]);
 //! Command which will generate an assert
 int memfault_demo_cli_cmd_assert(int argc, char *argv[]);
 
+//! Command which will generate a libc assert()
+int memfault_demo_cli_cmd_cassert(int argc, char *argv[]);
+
 //! Command to exercise the MEMFAULT_TRACE_EVENT API, capturing a
 //! Trace Event with the error reason set to "MemfaultDemoCli_Error".
 int memfault_demo_cli_cmd_trace_event_capture(int argc, char *argv[]);
@@ -114,6 +117,9 @@ 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[]);
 
+//! Trigger a heartbeat
+int memfault_demo_cli_cmd_heartbeat(int argc, char *argv[]);
+
 #ifdef __cplusplus
 }
 #endif

components/include/memfault/metrics/metrics.h

@@ -171,6 +171,20 @@ int memfault_metrics_heartbeat_timer_stop(MemfaultMetricId key);
 //! @note The metric must be of type kMemfaultMetricType_Unsigned or kMemfaultMetricType_Signed
 int memfault_metrics_heartbeat_add(MemfaultMetricId key, int32_t amount);
 
+//! Alternate API that includes the 'MEMFAULT_METRICS_KEY()' expansion
+#define MEMFAULT_HEARTBEAT_SET_SIGNED(key_name, signed_value) \
+  memfault_metrics_heartbeat_set_signed(MEMFAULT_METRICS_KEY(key_name), signed_value)
+#define MEMFAULT_HEARTBEAT_SET_UNSIGNED(key_name, unsigned_value) \
+  memfault_metrics_heartbeat_set_unsigned(MEMFAULT_METRICS_KEY(key_name), unsigned_value)
+#define MEMFAULT_HEARTBEAT_SET_STRING(key_name, value) \
+  memfault_metrics_heartbeat_set_string(MEMFAULT_METRICS_KEY(key_name), value)
+#define MEMFAULT_HEARTBEAT_TIMER_START(key_name) \
+  memfault_metrics_heartbeat_timer_start(MEMFAULT_METRICS_KEY(key_name))
+#define MEMFAULT_HEARTBEAT_TIMER_STOP(key_name) \
+  memfault_metrics_heartbeat_timer_stop(MEMFAULT_METRICS_KEY(key_name))
+#define MEMFAULT_HEARTBEAT_ADD(key_name, amount) \
+  memfault_metrics_heartbeat_add(MEMFAULT_METRICS_KEY(key_name), amount)
+
 //! For debugging purposes: prints the current heartbeat values using
 //! MEMFAULT_LOG_DEBUG(). Before printing, any active timer values are computed.
 //! Other metrics will print the current values. This can be called from the

components/include/memfault/version.h

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

components/metrics/src/memfault_metrics.c

@@ -728,6 +728,7 @@ int memfault_metrics_heartbeat_timer_read(MemfaultMetricId key, uint32_t *read_v
   memfault_lock();
   {
     union MemfaultMetricValue *value;
+    prv_find_timer_metric_and_update(key, kMemfaultTimerOp_ForceValueUpdate);
     rv = prv_find_key_of_type(key, kMemfaultMetricType_Timer, &value);
     if (rv == 0) {
       *read_val = value->u32;