Memfault Firmware SDK 1.13.0 (Build 10617)

Author: Memfault Inc

CHANGELOG.md

@@ -6,6 +6,55 @@ 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.13.0] - 2024-10-07
+
+### 📈 Added
+
+- FreeRTOS:
+
+  - The SDK now has a config to control whether to split CPU usage per core when
+    building for a multi-core device. Enable this setting by adding
+    `#define MEMFAULT_FREERTOS_RUNTIME_STATS_MULTI_CORE_SPLIT 1` to
+    `memfault_platform_config.h`. This setting is disabled by default.
+
+- ESP-IDF:
+  - Added a Kconfig, `CONFIG_MEMFAULT_FREERTOS_RUNTIME_STATS_MULTI_CORE_SPLIT`,
+    to control `MEMFAULT_FREERTOS_RUNTIME_STATS_MULTI_CORE_SPLIT`. This Kconfig
+    is enabled by default for multi-core devices.
+
+### 🛠️ Changed
+
+- FreeRTOS:
+
+  - Changed previous idle task run time percent metrics to measure CPU usage
+    (i.e. the complement of the idle task run time)
+  - Renamed the following metrics:
+    - Single-Core + Multi-Core Default:
+      - `idle_task_run_time_percent` -> `cpu_usage_pct`
+    - Multi-Core Split:
+      - `idle0_task_run_time_percent` -> `cpu_usage_pct`
+      - `idle1_task_run_time_percent` -> `cpu1_usage_pct`
+
+- ESP-IDF:
+
+  - Unknown or unclassified reboot reason codes returned by `get_reset_reason()`
+    are now correctly recorded as `kMfltRebootReason_Unknown` instead of
+    `kMfltRebootReason_UnknownError` (`UnknownError` is reserved for an
+    "unexpected" reboot path, where `Unknown` is used when the reboot reason
+    cannot be determined).
+
+### 🚩 Deprecated
+
+Support for the following vendor platform versions is deprecated in this
+release, and will be removed in the following release:
+
+- ESP-IDF < `v4.4` (Jan 26, 2022)
+- Zephyr < `v2.7.0` (Oct 16, 2021)
+- nRF-Connect SDK < `v1.9.2` (Jul 14, 2022)
+
+Please [contact us]([email protected]) if you need support for earlier
+versions!
+
 ## [1.12.0] - 2024-09-25
 
 ### 📈 Added
@@ -79,6 +128,17 @@ and this project adheres to
 
 ### 📈 Added
 
+- General:
+
+  - Add two new core metrics, `MemfaultSdkMetric_os_name` and
+    `MemfaultSdkMetric_os_version`. These are string metrics that map to the OS
+    / platform name and version string respectively, and are included in the the
+    ELF at build time, and processed out-of-band by Memfault for NCS, Zephyr,
+    and ESP-IDF. They **are not** ever transmitted over the air (no bandwidth
+    impact). For example, for Zephyr these metric string values would be
+    `zephyr` and `3.7.0` for a project on Zephyr v3.7.0. These metrics are
+    attributes by default and will not be counted towards attribute quotas.
+
 - Zephyr:
 
   - Add the following built-in WiFi metrics for Zephyr devices, enabled by
@@ -162,17 +222,6 @@ and this project adheres to
 
 ### 📈 Improvements
 
-- General:
-
-  - Add two new core metrics, `MemfaultSdkMetric_os_name` and
-    `MemfaultSdkMetric_os_version`. These are string metrics that map to the OS
-    / platform name and version string respectively, and are included in the the
-    ELF at build time, and processed out-of-band by Memfault for NCS, Zephyr,
-    and ESP-IDF. They **are not** ever transmitted over the air (no bandwidth
-    impact). For example, for Zephyr these metric string values would be
-    `zephyr` and `3.7.0` for a project on Zephyr v3.7.0. These metrics are
-    attributes by default and will not be counted towards attribute quotas.
-
 - ESP-IDF:
 
   - Fix a minor issue where MEMFAULT_LOG_x() macros (MEMFAULT_LOG_ERROR() etc )

VERSION

@@ -1,3 +1,3 @@
-BUILD ID: 10351
-GIT COMMIT: 1d3c51cd48
-VERSION: 1.12.0
+BUILD ID: 10617
+GIT COMMIT: edc2beda42
+VERSION: 1.13.0

components/include/memfault/version.h

@@ -20,8 +20,8 @@ typedef struct {
 } sMfltSdkVersion;
 
 #define MEMFAULT_SDK_VERSION \
-  { .major = 1, .minor = 12, .patch = 0 }
-#define MEMFAULT_SDK_VERSION_STR "1.12.0"
+  { .major = 1, .minor = 13, .patch = 0 }
+#define MEMFAULT_SDK_VERSION_STR "1.13.0"
 
 #ifdef __cplusplus
 }

examples/freertos/Makefile

@@ -130,6 +130,7 @@ CFLAGS += \
     -Og \
     -MD \
     -fdebug-prefix-map="$(shell pwd)"=. \
+    -DBOARD=\"$(BOARD)\" \
     $(ARCH_CFLAGS) \
 
 # Enable the self test by default

examples/freertos/src/console.c

@@ -4,6 +4,7 @@
 //! See LICENSE for details
 
 #include <stdio.h>
+#include <stdlib.h>
 #include <unistd.h>
 
 #include "FreeRTOS.h"
@@ -108,6 +109,23 @@ static int prv_session(int argc, char *argv[]) {
   return 0;
 }
 
+static int prv_spin_cpu(int argc, char *argv[]) {
+  uint32_t cycle_count = UINT32_MAX;
+  if (argc > 1) {
+    char *end = NULL;
+    cycle_count = strtoul(argv[1], &end, 10);
+    if (end == argv[1]) {
+      MEMFAULT_LOG_RAW("Invalid cycle count");
+      cycle_count = UINT32_MAX;
+    }
+  }
+
+  MEMFAULT_LOG_RAW("Spinning CPU for %lu cycles", cycle_count);
+  for (uint32_t i = 0; i < cycle_count; i++) { }
+  MEMFAULT_LOG_RAW("Spinning completed, check cpu_usage_pct");
+  return 0;
+}
+
 static const sMemfaultShellCommand s_freertos_example_shell_extension_list[] = {
   {
     .command = "freertos_vassert",
@@ -129,6 +147,11 @@ static const sMemfaultShellCommand s_freertos_example_shell_extension_list[] = {
     .handler = prv_session,
     .help = "Execute a test metrics session named 'cli'",
   },
+  {
+    .command = "spin_cpu",
+    .handler = prv_spin_cpu,
+    .help = "Spin CPU to increase cpu_usage_pct metric",
+  },
 };
 #endif
 

examples/freertos/src/memfault/memfault_platform_port.c

@@ -26,7 +26,7 @@ static const char *s_log_prefix = "MFLT";
 void memfault_platform_get_device_info(sMemfaultDeviceInfo *info) {
   *info = (sMemfaultDeviceInfo){
     .device_serial = "freertos-example",
-    .hardware_version = "qemu-mps2-an385",
+    .hardware_version = BOARD,
     .software_type = "qemu-app",
     .software_version = "1.0.0",
   };

ports/esp_idf/memfault/Kconfig

@@ -175,11 +175,20 @@ endif
         default y
         select FREERTOS_GENERATE_RUN_TIME_STATS
         help
-            Collects the idle thread runtime metric as a percentage of total runtime.
+            Collects the CPU usage as a percentage of total runtime.
             This metric is only available when using esp_timer for runtime stats to
             avoid issues with counter overflow. Note for FreeRTOS versions < 10.2.0
             this will be a no-op.
 
+    config MEMFAULT_FREERTOS_RUNTIME_STATS_MULTI_CORE_SPLIT
+        bool "Enables per-core cpu_usage_pct metrics for multi-core targets"
+        default y
+        depends on MEMFAULT_FREERTOS_TASK_RUNTIME_STATS
+        depends on SOC_CPU_CORES_NUM > 1
+        help
+            When enabled, collects a separate measure of each CPU core usage as
+            cpu_usage_pct for cpu0 and cpu1_usage_pct for cpu1
+
     config MEMFAULT_MBEDTLS_METRICS
         bool "Collect metrics from mbedTLS"
         default y

ports/esp_idf/memfault/common/memfault_platform_core.c

@@ -100,9 +100,12 @@ static void prv_record_reboot_reason(void) {
       reboot_reason = kMfltRebootReason_BrownOutReset;
       break;
     case ESP_RST_PANIC:
-    default:
       reboot_reason = kMfltRebootReason_UnknownError;
       break;
+    case ESP_RST_UNKNOWN:
+    default:
+      reboot_reason = kMfltRebootReason_Unknown;
+      break;
   }
   #endif
 #endif

ports/esp_idf/memfault/config/memfault_esp_idf_port_config.h

@@ -72,6 +72,14 @@ extern "C" {
 // so it's redundant to save them in the Memfault SDK as well.
 #define MEMFAULT_SDK_LOG_SAVE_DISABLE 1
 
+// Kconfiglib will set this symbol to y even if SOC_CPU_CORES_NUM is not defined in older esp-idf
+// versions. Instead, use the FreeRTOS-SMP configNUM_CORES to determine support
+#if defined(CONFIG_MEMFAULT_FREERTOS_RUNTIME_STATS_MULTI_CORE_SPLIT)
+  #if defined(configNUM_CORES) && configNUM_CORES > 1
+    #define MEMFAULT_FREERTOS_RUNTIME_STATS_MULTI_CORE_SPLIT 1
+  #endif
+#endif
+
 // Pick up any user configuration overrides. This should be kept at the bottom
 // of this file
 #if CONFIG_MEMFAULT_USER_CONFIG_SILENT_FAIL

ports/freertos/config/memfault_metrics_heartbeat_freertos_config.def

@@ -3,11 +3,13 @@
 // This definition is used to track if this file has been included yet
 #define MEMFAULT_METRICS_HEARTBEAT_FREERTOS_CONFIG_DEF 1
 
-#if MEMFAULT_FREERTOS_RUN_TIME_STATS_MULTI_CORE
-    MEMFAULT_METRICS_KEY_DEFINE(idle0_task_run_time_percent, kMemfaultMetricType_Unsigned)
-    MEMFAULT_METRICS_KEY_DEFINE(idle1_task_run_time_percent, kMemfaultMetricType_Unsigned)
-#elif MEMFAULT_FREERTOS_RUN_TIME_STATS_SINGLE_CORE
-    MEMFAULT_METRICS_KEY_DEFINE(idle_task_run_time_percent, kMemfaultMetricType_Unsigned)
+#define CPU_USAGE_PCT_SCALE_VALUE (100)
+
+MEMFAULT_METRICS_KEY_DEFINE_WITH_SCALE_VALUE(cpu_usage_pct, kMemfaultMetricType_Unsigned,
+                                             CPU_USAGE_PCT_SCALE_VALUE)
+#if MEMFAULT_FREERTOS_RUNTIME_STATS_MULTI_CORE_SPLIT
+MEMFAULT_METRICS_KEY_DEFINE_WITH_SCALE_VALUE(cpu1_usage_pct, kMemfaultMetricType_Unsigned,
+                                             CPU_USAGE_PCT_SCALE_VALUE)
 #endif
 
 #if MEMFAULT_FREERTOS_COLLECT_TIMER_STACK_FREE_BYTES