Memfault Firmware SDK 1.11.0 (Build 9315)

Author: Memfault Inc

CHANGELOG.md

@@ -6,6 +6,72 @@ 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.11.0] - 2024-08-07
+
+### :boom: Breaking Changes
+
+- Add support for namespacing
+  [Session Metrics](https://docs.memfault.com/docs/mcu/metrics-api#session-metrics)
+  to support duplicate key names across heartbeats and sessions (eg
+  `heartbeat.cpu_temp` and `session.cpu_temp`). This requires a change to how
+  Session Metrics keys are set:
+
+  - Before: `MEMFAULT_METRIC_SET_SIGNED(cpu_temp, 25)` (only 1 metric key
+    `cpu_temp` supported across heartbeats/sessions)
+  - After:
+    - `MEMFAULT_METRIC_SET_SIGNED(cpu_temp, 25)` for setting
+      `heartbeat.cpu_temp`
+    - `MEMFAULT_METRIC_SESSION_SET_SIGNED(cpu_temp, session, 25)` for setting
+      `session.cpu_temp`
+
+### :chart_with_upwards_trend: Improvements
+
+- General:
+
+  - Fix a :bug: in reboot tracking classification when calling
+    `memfault_reboot_tracking_boot()` with a `bootup_info` parameter containing
+    an unexpected type of reboot reason (or no reboot reason) after a previously
+    recorded expected reason. This results in
+    ["Expected Reboots"](components/include/memfault/core/reboot_reason_types.h#L33)
+    recorded using `MEMFAULT_REBOOT_MARK_RESET_IMMINENT()` to be incorrectly
+    flagged as an "Unexpected Reboot" and causes an incorrect
+    `operational_crashfree_hours` metric getting reported and a lower Stability
+    score.
+
+  - Cleanup comment to old packetizer API
+
+  - Add `-fdebug-prefix-map` to FreeRTOS QEMU example
+
+- ESP-IDF:
+
+  - Improved the CLI results when running the `post_chunks` test command (used
+    to trigger an upload to Memfault) to be more informative, for example:
+
+    ```bash
+    esp32> post_chunks
+    I (12593) mflt: Data posted successfully, 262285 bytes sent
+    esp32> post_chunks
+    I (204093) mflt: No new data found
+    ```
+
+- Zephyr
+
+  - Update samples to use the newly-released Zephyr v3.7.0 🥳
+
+  - Add explanatory output to Memfault `test busfault|hardfault` shell commands
+    when Trusted Firmware-M (TF-M) is in use
+
+  - The RTC-based implementation of
+    [`memfault_platform_time_get_current()`](ports/zephyr/common/memfault_platform_system_time.c)
+    used a define named `RTC`, which conflicts with the STM32 HAL definition
+    [here](https://github.com/zephyrproject-rtos/hal_stm32/blob/f1317150eac951fdd8259337a47cbbc4c2e6d335/stm32cube/stm32h7xx/soc/stm32h7b3xxq.h#L2441-L2442).
+    Rename the define to `MFLT_RTC_NODE` to avoid the conflict.
+
+- nRF-Connect SDK:
+
+  - Fix a compilation error when building NCS v2.7.0 with the latest Memfault
+    firmware SDK (v1.10.1, the previous SDK release).
+
 ## [1.10.1] - 2024-07-24
 
 ### :chart_with_upwards_trend: Improvements

VERSION

@@ -1,3 +1,3 @@
-BUILD ID: 9081
-GIT COMMIT: 5183b73f74
-VERSION: 1.10.1
+BUILD ID: 9315
+GIT COMMIT: 2d67818dc2
+VERSION: 1.11.0

components/core/src/memfault_ram_reboot_info_tracking.c

@@ -128,19 +128,19 @@ static void prv_record_reboot_reason(eMemfaultRebootReason reboot_reg_reason,
 }
 
 static bool prv_get_unexpected_reboot_occurred(void) {
-  // Check prior_stored_reason, reboot is unexpected if prior reason is set and in error range or
-  // unknown
+  // Use prior_stored_reason as source of reboot reason. Fallback to reboot_reg_reason if
+  // prior_stored_reason is not set
+  eMemfaultRebootReason reboot_reason;
   if (s_reboot_reason_data.prior_stored_reason !=
       (eMemfaultRebootReason)MEMFAULT_REBOOT_REASON_NOT_SET) {
-    if (s_reboot_reason_data.prior_stored_reason == kMfltRebootReason_Unknown ||
-        s_reboot_reason_data.prior_stored_reason >= kMfltRebootReason_UnknownError) {
-      return true;
-    }
+    reboot_reason = s_reboot_reason_data.prior_stored_reason;
+  } else {
+    reboot_reason = s_reboot_reason_data.reboot_reg_reason;
   }
 
-  // Check reboot_reg_reason second, reboot is unexpected if in error range or unknown
-  return (s_reboot_reason_data.reboot_reg_reason == kMfltRebootReason_Unknown ||
-          s_reboot_reason_data.reboot_reg_reason >= kMfltRebootReason_UnknownError);
+  // Check if selected reboot_reason is unexpected if in error range or unknown
+  return (reboot_reason == kMfltRebootReason_Unknown ||
+          reboot_reason >= kMfltRebootReason_UnknownError);
 }
 
 static void prv_record_reboot_event(eMemfaultRebootReason reboot_reason,

components/include/memfault/core/data_packetizer.h

@@ -44,8 +44,8 @@ typedef enum {
   kMemfaultPacketizerStatus_EndOfChunk,
 
   //! Indicates there is more data to be received for the chunk. This will _only_ be returned
-  //! as a value if multi packet chunking has been enabled by a call to
-  //! memfault_packetizer_enable_multi_packet_chunks()
+  //! as a value if multi packet chunking has been enabled by setting the boolean option
+  //! enable_multi_packet_chunk to true in the packetizer config (sPacketizerConfig)
   kMemfaultPacketizerStatus_MoreDataForChunk,
 } eMemfaultPacketizerStatus;
 

components/include/memfault/metrics/ids_impl.h

@@ -5,6 +5,9 @@
 //! Copyright (c) Memfault, Inc.
 //! See License.txt for details
 //!
+//! Copyright (c) Memfault, Inc.
+//! See License.txt for details
+//!
 //! NOTE: The internals of the metric APIs make use of "X-Macros" to enable more flexibility
 //! improving and extending the internal implementation without impacting the externally facing API
 
@@ -14,53 +17,36 @@ extern "C" {
 
 #include "memfault/config.h"
 
-#define MEMFAULT_METRICS_SESSION_TIMER_NAME(key_name) mflt_session_timer_##key_name
-
-//! Generate extern const char * declarations for all IDs (used in key names):
-#define MEMFAULT_METRICS_KEY_DEFINE_(key_name) \
-  extern const char *const g_memfault_metrics_id_##key_name;
-
-#define MEMFAULT_METRICS_KEY_DEFINE_WITH_RANGE(key_name, value_type, _min, _max) \
-  MEMFAULT_METRICS_KEY_DEFINE(key_name, value_type)
-
-#define MEMFAULT_METRICS_STRING_KEY_DEFINE(key_name, max_length) \
-  MEMFAULT_METRICS_KEY_DEFINE(key_name, _)
-
-#define MEMFAULT_METRICS_STRING_KEY_DEFINE_WITH_SESSION(key_name, max_length, session_name) \
-  MEMFAULT_METRICS_KEY_DEFINE(key_name, _)
+// Clear any potential issues from transitive dependencies in these files by
+// including them one time, with stubs for the macros we need to define. This
+// set up any multiple-include guards, and we can safely include the x-macro
+// definitions later.
+
+#define MEMFAULT_METRICS_KEY_DEFINE(...)
+#define MEMFAULT_METRICS_KEY_DEFINE_WITH_RANGE(...)
+#define MEMFAULT_METRICS_STRING_KEY_DEFINE(...)
+#define MEMFAULT_METRICS_STRING_KEY_DEFINE_WITH_SESSION(...)
+#define MEMFAULT_METRICS_SESSION_KEY_DEFINE(...)
+#define MEMFAULT_METRICS_KEY_DEFINE_WITH_SESSION(...)
+#define MEMFAULT_METRICS_KEY_DEFINE_WITH_RANGE_AND_SESSION(...)
+#define MEMFAULT_METRICS_KEY_DEFINE_WITH_SCALE_VALUE(...)
+#define MEMFAULT_METRICS_KEY_DEFINE_WITH_SESSION_AND_SCALE_VALUE(...)
 
-#define MEMFAULT_METRICS_SESSION_KEY_DEFINE(key_name) \
-  MEMFAULT_METRICS_KEY_DEFINE(MEMFAULT_METRICS_SESSION_TIMER_NAME(key_name), _)
-
-#define MEMFAULT_METRICS_KEY_DEFINE_WITH_SESSION(key_name, value_type, session_name) \
-  MEMFAULT_METRICS_KEY_DEFINE(key_name, value_type)
-
-#define MEMFAULT_METRICS_KEY_DEFINE_WITH_RANGE_AND_SESSION(key_name, value_type, min_value, \
-                                                           max_value, session_name)         \
-  MEMFAULT_METRICS_KEY_DEFINE(key_name, value_type)
-
-#define MEMFAULT_METRICS_KEY_DEFINE_WITH_SCALE_VALUE(key_name, value_type, scale_value) \
-  MEMFAULT_METRICS_KEY_DEFINE(key_name, value_type)
-
-#define MEMFAULT_METRICS_KEY_DEFINE_WITH_SESSION_AND_SCALE_VALUE(key_name, value_type,     \
-                                                                 session_key, scale_value) \
-  MEMFAULT_METRICS_KEY_DEFINE(key_name, value_type)
-
-#define MEMFAULT_METRICS_KEY_DEFINE(key_name, value_type) MEMFAULT_METRICS_KEY_DEFINE_(key_name)
 #include "memfault/metrics/heartbeat_config.def"
 #include MEMFAULT_METRICS_USER_HEARTBEAT_DEFS_FILE
+
 #undef MEMFAULT_METRICS_KEY_DEFINE
 #undef MEMFAULT_METRICS_KEY_DEFINE_WITH_RANGE
 #undef MEMFAULT_METRICS_STRING_KEY_DEFINE
 #undef MEMFAULT_METRICS_STRING_KEY_DEFINE_WITH_SESSION
 #undef MEMFAULT_METRICS_SESSION_KEY_DEFINE
 #undef MEMFAULT_METRICS_KEY_DEFINE_WITH_SESSION
 #undef MEMFAULT_METRICS_KEY_DEFINE_WITH_RANGE_AND_SESSION
-#undef MEMFAULT_METRICS_KEY_DEFINE_
 #undef MEMFAULT_METRICS_KEY_DEFINE_WITH_SCALE_VALUE
 #undef MEMFAULT_METRICS_KEY_DEFINE_WITH_SESSION_AND_SCALE_VALUE
 
-#define MEMFAULT_METRICS_KEY_DEFINE_(key_name) kMfltMetricsIndex_##key_name,
+#define MEMFAULT_METRICS_KEY_DEFINE_(session_name, key_name) \
+  kMfltMetricsIndex_##session_name##__##key_name,
 
 //! Generate an enum for all IDs (used for indexing into values)
 #define MEMFAULT_METRICS_KEY_DEFINE_WITH_RANGE(key_name, value_type, min_value, max_value) \
@@ -70,26 +56,29 @@ extern "C" {
   MEMFAULT_METRICS_KEY_DEFINE(key_name, _)
 
 #define MEMFAULT_METRICS_STRING_KEY_DEFINE_WITH_SESSION(key_name, max_length, session_name) \
-  MEMFAULT_METRICS_KEY_DEFINE(key_name, _)
+  MEMFAULT_METRICS_KEY_DEFINE_(session_name, key_name)
 
-#define MEMFAULT_METRICS_SESSION_KEY_DEFINE(key_name) \
-  MEMFAULT_METRICS_KEY_DEFINE(MEMFAULT_METRICS_SESSION_TIMER_NAME(key_name), _)
+//! Sessions have the following built-in keys:
+//! - "<session name>__MemfaultSdkMetric_IntervalMs"
+#define MEMFAULT_METRICS_SESSION_KEY_DEFINE(session_name) \
+  kMfltMetricsIndex_##session_name##__##MemfaultSdkMetric_IntervalMs,
 
 #define MEMFAULT_METRICS_KEY_DEFINE_WITH_SESSION(key_name, value_type, session_name) \
-  MEMFAULT_METRICS_KEY_DEFINE(key_name, value_type)
+  MEMFAULT_METRICS_KEY_DEFINE_(session_name, key_name)
 
 #define MEMFAULT_METRICS_KEY_DEFINE_WITH_RANGE_AND_SESSION(key_name, value_type, min_value, \
                                                            max_value, session_name)         \
-  MEMFAULT_METRICS_KEY_DEFINE(key_name, value_type)
+  MEMFAULT_METRICS_KEY_DEFINE_(session_name, key_name)
 
 #define MEMFAULT_METRICS_KEY_DEFINE_WITH_SCALE_VALUE(key_name, value_type, scale_value) \
   MEMFAULT_METRICS_KEY_DEFINE(key_name, value_type)
 
 #define MEMFAULT_METRICS_KEY_DEFINE_WITH_SESSION_AND_SCALE_VALUE(key_name, value_type,     \
                                                                  session_key, scale_value) \
-  MEMFAULT_METRICS_KEY_DEFINE(key_name, value_type)
+  MEMFAULT_METRICS_KEY_DEFINE_(session_key, key_name)
 
-#define MEMFAULT_METRICS_KEY_DEFINE(key_name, value_type) MEMFAULT_METRICS_KEY_DEFINE_(key_name)
+#define MEMFAULT_METRICS_KEY_DEFINE(key_name, value_type) \
+  MEMFAULT_METRICS_KEY_DEFINE_(heartbeat, key_name)
 
 typedef enum MfltMetricsIndex {
 #include "memfault/metrics/heartbeat_config.def"
@@ -103,17 +92,19 @@ typedef enum MfltMetricsIndex {
 #undef MEMFAULT_METRICS_KEY_DEFINE_WITH_RANGE_AND_SESSION
 #undef MEMFAULT_METRICS_KEY_DEFINE_WITH_SCALE_VALUE
 #undef MEMFAULT_METRICS_KEY_DEFINE_WITH_SESSION_AND_SCALE_VALUE
-} eMfltMetricsIndex;
+} eMfltMetricsIndexV2;
+typedef eMfltMetricsIndexV2 eMfltMetricsIndex;
 
 #define MEMFAULT_METRICS_SESSION_KEY_DEFINE(key_name) kMfltMetricsSessionKey_##key_name,
 #define MEMFAULT_METRICS_KEY_DEFINE(key_name, value_type)
 #define MEMFAULT_METRICS_KEY_DEFINE_WITH_RANGE(key_name, value_type, min_value, max_value)
 #define MEMFAULT_METRICS_STRING_KEY_DEFINE(key_name, max_length)
+#define MEMFAULT_METRICS_KEY_DEFINE_WITH_SCALE_VALUE(key_name, value_type, scale_value)
+
 #define MEMFAULT_METRICS_STRING_KEY_DEFINE_WITH_SESSION(key_name, max_length, session_key)
 #define MEMFAULT_METRICS_KEY_DEFINE_WITH_SESSION(key_name, value_type, session_name)
 #define MEMFAULT_METRICS_KEY_DEFINE_WITH_RANGE_AND_SESSION(key_name, value_type, min_value, \
                                                            max_value, session_name)
-#define MEMFAULT_METRICS_KEY_DEFINE_WITH_SCALE_VALUE(key_name, value_type, scale_value)
 
 #define MEMFAULT_METRICS_KEY_DEFINE_WITH_SESSION_AND_SCALE_VALUE(key_name, value_type, \
                                                                  session_key, scale_value)
@@ -149,10 +140,11 @@ typedef struct {
 
 #define MEMFAULT_METRICS_SESSION_KEY(key_name) kMfltMetricsSessionKey_##key_name
 
-#define _MEMFAULT_METRICS_ID_CREATE(id) \
-  { kMfltMetricsIndex_##id }
+#define _MEMFAULT_METRICS_ID_CREATE(id, session_name) \
+  { kMfltMetricsIndex_##session_name##__##id }
 
-#define _MEMFAULT_METRICS_ID(id) ((MemfaultMetricId){ kMfltMetricsIndex_##id })
+#define _MEMFAULT_METRICS_ID(id, session_name) \
+  ((MemfaultMetricId){ kMfltMetricsIndex_##session_name##__##id })
 
 #ifdef __cplusplus
 }

components/include/memfault/metrics/metrics.h

@@ -129,11 +129,20 @@ typedef enum MemfaultMetricValueType {
 //! when the modem is powered off.
 #define MEMFAULT_METRICS_SESSION_KEY_DEFINE(key_name) MEMFAULT_METRICS_KEY_DEFINE_TRAP_()
 
-//! Uses a metric key. Before you can use a key, it should defined using MEMFAULT_METRICS_KEY_DEFINE
-//! in memfault_metrics_heartbeat_config.def.
+//! Use a Heartbeat metric key. Before you can use a key, it should defined using
+//! MEMFAULT_METRICS_KEY_DEFINE in memfault_metrics_heartbeat_config.def.
 //! @param key_name The name of the key, without quotes, as defined using
 //! MEMFAULT_METRICS_KEY_DEFINE.
-#define MEMFAULT_METRICS_KEY(key_name) _MEMFAULT_METRICS_ID(key_name)
+#define MEMFAULT_METRICS_KEY(key_name) _MEMFAULT_METRICS_ID(key_name, heartbeat)
+
+//! Use a Session metric key. Before you can use a key, it should defined using
+//! MEMFAULT_METRICS_KEY_DEFINE_WITH_SESSION etc in memfault_metrics_heartbeat_config.def.
+//! @param key_name The name of the key, without quotes, as defined using
+//! MEMFAULT_METRICS_KEY_DEFINE_WITH_SESSION etc
+//! @param session_key The name of the session, without quotes, as defined using
+//! MEMFAULT_METRICS_SESSION_KEY_DEFINE
+#define MEMFAULT_METRICS_KEY_WITH_SESSION(key_name, session_key) \
+  _MEMFAULT_METRICS_ID(key_name, session_key)
 
 typedef struct MemfaultMetricsBootInfo {
   //! The number of times the system has rebooted unexpectedly since reporting the last heartbeat
@@ -220,6 +229,23 @@ int memfault_metrics_heartbeat_add(MemfaultMetricId key, int32_t amount);
 #define MEMFAULT_METRIC_ADD(key_name, amount) \
   memfault_metrics_heartbeat_add(MEMFAULT_METRICS_KEY(key_name), (amount))
 
+//! Alternate API for Session metrics
+#define MEMFAULT_METRIC_SESSION_SET_SIGNED(key_name, session_key, signed_value)                   \
+  memfault_metrics_heartbeat_set_signed(MEMFAULT_METRICS_KEY_WITH_SESSION(key_name, session_key), \
+                                        (signed_value))
+#define MEMFAULT_METRIC_SESSION_SET_UNSIGNED(key_name, session_key, unsigned_value) \
+  memfault_metrics_heartbeat_set_unsigned(                                          \
+    MEMFAULT_METRICS_KEY_WITH_SESSION(key_name, session_key), (unsigned_value))
+#define MEMFAULT_METRIC_SESSION_SET_STRING(key_name, session_key, value)                          \
+  memfault_metrics_heartbeat_set_string(MEMFAULT_METRICS_KEY_WITH_SESSION(key_name, session_key), \
+                                        (value))
+#define MEMFAULT_METRIC_SESSION_TIMER_START(key_name, session_key) \
+  memfault_metrics_heartbeat_timer_start(MEMFAULT_METRICS_KEY_WITH_SESSION(key_name, session_key))
+#define MEMFAULT_METRIC_SESSION_TIMER_STOP(key_name, session_key) \
+  memfault_metrics_heartbeat_timer_stop(MEMFAULT_METRICS_KEY_WITH_SESSION(key_name, session_key))
+#define MEMFAULT_METRIC_SESSION_ADD(key_name, session_key, amount) \
+  memfault_metrics_heartbeat_add(MEMFAULT_METRICS_KEY_WITH_SESSION(key_name, session_key), (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 = 10, .patch = 1 }
-#define MEMFAULT_SDK_VERSION_STR "1.10.1"
+#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 11, .patch = 0 }
+#define MEMFAULT_SDK_VERSION_STR "1.11.0"
 
 #ifdef __cplusplus
 }