Memfault Firmware SDK 1.7.3 (Build 6923)

Memfault Inc · Memfault Inc · commit 12832aaeade7 · 2024-03-19T23:50:27.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,29 @@ 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.7.3] - 2024-03-19
+
+### :chart_with_upwards_trend: Improvements
+
+- Zephyr:
+
+  - Add new Kconfig flags for the following Memfault Core Metrics:
+
+    - `MEMFAULT_METRICS_SYNC_SUCCESS` (default=y)
+    - `MEMFAULT_METRICS_MEMFAULT_SYNC_SUCCESS` (default=y)
+    - `MEMFAULT_METRICS_CONNECTIVITY_CONNECTED_TIME` (default=y)
+    - `MEMFAULT_METRICS_BATTERY_ENABLE` (default=n)
+
+    Additionally, a Kconfig flag `MEMFAULT_BATTERY_METRICS_BOOT_ON_SYSTEM_INIT`
+    will enable auto-initialization of battery metrics on system init (requires
+    `memfault_platform_get_stateofcharge()` to be implemented).
+
+    See https://mflt.io/core-metrics for more information on Core Metrics.
+
+- ESP-IDF:
+
+  - Add preliminary support for the upcoming ESP-IDF v5.3.0 release.
+
 ## [1.7.2] - 2024-03-09
 
 ### :chart_with_upwards_trend: Improvements
diff --git a/VERSION b/VERSION
@@ -1,3 +1,3 @@
-BUILD ID: 6714
-GIT COMMIT: 1d29e68571
-VERSION: 1.7.2
+BUILD ID: 6923
+GIT COMMIT: 47bd79f60f
+VERSION: 1.7.3
diff --git a/components/include/memfault/http/http_client.h b/components/include/memfault/http/http_client.h
@@ -46,11 +46,12 @@ typedef struct MfltHttpClientConfig {
   //! Route used to get information from the Memfault cloud pertaining to a device in your fleet.
   //! For example, the latest firmware release available.
   sMemfaultHttpApi device_api;
-  //! Callback for fetching device info for the OTA'ing device. Typically this callback can be left
-  //! unset, but if the request is on behalf of a downstream device, can be substituted with the
-  //! downstream device's information. The function signature is the same as
-  //! memfault_platform_get_device_info(). If NULL, memfault_platform_get_device_info() will be
-  //! used.
+  //! Callback for fetching device info, used when uploading chunks and
+  //! performing OTA checks. Typically this callback can be left unset, but if
+  //! the request is on behalf of a downstream device, can be substituted with
+  //! the downstream device's information. The function signature is the same as
+  //! memfault_platform_get_device_info(). If unset (the default),
+  //! memfault_platform_get_device_info() will be used.
   void (*get_device_info)(sMemfaultDeviceInfo *info);
 } sMfltHttpClientConfig;
 
diff --git a/components/include/memfault/version.h b/components/include/memfault/version.h
@@ -19,8 +19,8 @@ typedef struct {
   uint8_t patch;
 } sMfltSdkVersion;
 
-#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 7, .patch = 2 }
-#define MEMFAULT_SDK_VERSION_STR "1.7.2"
+#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 7, .patch = 3 }
+#define MEMFAULT_SDK_VERSION_STR "1.7.3"
 
 #ifdef __cplusplus
 }
diff --git a/components/panics/src/memfault_coredump.c b/components/panics/src/memfault_coredump.c
@@ -5,6 +5,9 @@
 //!
 //! @brief
 //! Logic for saving a coredump to backing storage and reading it out
+//!
+//! See https://mflt.io/mcu-coredump-format for a tabular view of the
+//! Memfault coredump format
 
 #include <stdbool.h>
 #include <string.h>
diff --git a/examples/esp32/apps/memfault_demo_app/CMakeLists.txt b/examples/esp32/apps/memfault_demo_app/CMakeLists.txt
@@ -29,6 +29,12 @@ include(${memfault_firmare_sdk_dir}/ports/esp_idf/memfault.cmake)
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(${PROJECT_NAME})
 
+# Enable a compilation error if any deprecated APIs are used. This helps detect
+# bleeding edge changes in the ESP-IDF.
+if (IDF_VERSION_MAJOR VERSION_GREATER_EQUAL 5)
+  idf_build_set_property(COMPILE_OPTIONS "-Werror=deprecated-declarations" APPEND)
+endif()
+
 # Check for invalid partition table configurations
 if (
   CONFIG_APP_MEMFAULT_TRANSPORT_HTTP AND
diff --git a/examples/esp32/apps/memfault_demo_app/main/main.c b/examples/esp32/apps/memfault_demo_app/main/main.c
@@ -35,6 +35,10 @@
 #include "nvs_flash.h"
 #include "settings.h"
 
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 3, 0)
+  #include "driver/uart_vfs.h"
+#endif
+
 // Conditionally enable the logging tag variable only when it's used
 #if defined(CONFIG_STORE_HISTORY) || defined(CONFIG_HEAP_USE_HOOKS)
 static const char *TAG = "main";
@@ -86,7 +90,13 @@ static void initialize_console() {
   setvbuf(stdin, NULL, _IONBF, 0);
   setvbuf(stdout, NULL, _IONBF, 0);
 
-#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 3, 0)
+  // These APIs vary depending on ESP-IDF version.
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 3, 0)
+  /* Minicom, screen, idf_monitor send CR when ENTER key is pressed */
+  uart_vfs_dev_port_set_rx_line_endings(CONFIG_ESP_CONSOLE_UART_NUM, ESP_LINE_ENDINGS_CR);
+  /* Move the caret to the beginning of the next line on '\n' */
+  uart_vfs_dev_port_set_tx_line_endings(CONFIG_ESP_CONSOLE_UART_NUM, ESP_LINE_ENDINGS_CRLF);
+#elif ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 3, 0)
   /* Minicom, screen, idf_monitor send CR when ENTER key is pressed */
   esp_vfs_dev_uart_port_set_rx_line_endings(CONFIG_ESP_CONSOLE_UART_NUM, ESP_LINE_ENDINGS_CR);
   /* Move the caret to the beginning of the next line on '\n' */
@@ -102,7 +112,11 @@ static void initialize_console() {
   ESP_ERROR_CHECK(uart_driver_install(CONFIG_CONSOLE_UART_NUM, 256, 0, 0, NULL, 0));
 
   /* Tell VFS to use UART driver */
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 3, 0)
+  uart_vfs_dev_use_driver(CONFIG_CONSOLE_UART_NUM);
+#else
   esp_vfs_dev_uart_use_driver(CONFIG_CONSOLE_UART_NUM);
+#endif
 
   /* Initialize the console */
   esp_console_config_t console_config = {
@@ -173,7 +187,7 @@ static void prv_memfault_ota(void) {
 
   int rv = memfault_esp_port_ota_update(&handler);
 
-  #if MEMFAULT_METRICS_SYNC_SUCCESS
+  #if defined(CONFIG_MEMFAULT_METRICS_SYNC_SUCCESS)
   // Record the OTA check result using the built-in sync success metric
   if (rv == 0 || rv == 1) {
     memfault_metrics_connectivity_record_sync_success();
diff --git a/examples/esp32/apps/memfault_demo_app/main/memfault/memfault_platform_config.h b/examples/esp32/apps/memfault_demo_app/main/memfault/memfault_platform_config.h
@@ -9,6 +9,3 @@
 //! Default configuration settings can be found in "memfault/config.h"
 
 #define MEMFAULT_TASK_WATCHDOG_ENABLE 1
-
-// Enable the sync_successful metric
-#define MEMFAULT_METRICS_SYNC_SUCCESS 1
diff --git a/ports/esp_idf/memfault/CMakeLists.txt b/ports/esp_idf/memfault/CMakeLists.txt
@@ -257,7 +257,22 @@ endif()
 #   FreeRTOS task list is walked server side instead of on device (so you can get crash data even if the lists are corrupted)
 #   Much more flexibility in debug information collected (e.g. all RAM, just the current stack trace, select stacks and variables)
 #   Data can be posted directly from device to Memfault cloud for deduplication and analysis
-target_link_libraries(${this_component} INTERFACE "-Wl,--wrap=esp_core_dump_to_flash -Wl,--wrap=esp_core_dump_init -Wl,--wrap=esp_core_dump_image_get")
+#
+# Note: in ESP-IDF v5.3.0, the core dump handler function was renamed from esp_core_dump_to_flash to esp_core_dump_write
+set(panic_handler_args "")
+if (DEFINED ENV{IDF_VERSION})
+  if ($ENV{IDF_VERSION} VERSION_GREATER_EQUAL "5.3.0")
+    list(APPEND panic_handler_args "-Wl,--wrap=esp_core_dump_write")
+  else()
+    list(APPEND panic_handler_args "-Wl,--wrap=esp_core_dump_to_flash")
+  endif()
+endif()
+list(
+  APPEND panic_handler_args
+  "-Wl,--wrap=esp_core_dump_init"
+  "-Wl,--wrap=esp_core_dump_image_get"
+)
+target_link_libraries(${this_component} INTERFACE "${panic_handler_args}")
 
 # Wrap panic_abort to intercept assert()/abort() calls. Note that support for
 # this was added in ESP-IDF v4.2; earlier versions are intercepted with the
diff --git a/ports/esp_idf/memfault/Kconfig b/ports/esp_idf/memfault/Kconfig
@@ -174,12 +174,34 @@ endif
         help
             Collects Memfault metrics for basic heap utilization.
 
-    config MEMFAULT_SYNC_MEMFAULT_METRICS
-        bool "Enable sync_memfault_successful metric"
-        default y
-        help
-            Collects Memfault metrics for the number of successful and failed
-            syncs to the Memfault cloud.
+    config MEMFAULT_METRICS_SYNC_SUCCESS
+            bool "Enable collection of sync success metrics"
+            default y
+            help
+             Memfault user-defined sync success metric component. More information
+             at https://mflt.io/core-metrics .
+
+    config MEMFAULT_METRICS_MEMFAULT_SYNC_SUCCESS
+            bool "Enable collection of memfault sync success metrics"
+            default y
+            help
+             Collects Memfault metrics for the number of successful and failed
+             syncs to the Memfault cloud. More information at
+             https://mflt.io/core-metrics .
+
+    config MEMFAULT_METRICS_CONNECTIVITY_CONNECTED_TIME
+            bool "Enable collection of memfault connectivity time metrics"
+            default y
+            help
+             Memfault connectivity time metric component. More information at
+             https://mflt.io/core-metrics .
+
+    config MEMFAULT_METRICS_BATTERY_ENABLE
+           bool "Enable collection of battery metrics"
+           default n
+           help
+             Memfault battery metric component. More information at
+             https://mflt.io/core-metrics .
 
     config MEMFAULT_ASSERT_ON_ALLOC_FAILURE
         bool "Assert on allocation failure"
diff --git a/ports/esp_idf/memfault/common/memfault_fault_handler.c b/ports/esp_idf/memfault/common/memfault_fault_handler.c
@@ -7,17 +7,23 @@
 
 #include <stdlib.h>
 
+#include "memfault/esp_port/version.h"
+// keep the version.h include above, to support ESP-IDF < v4
+
 #include "esp_attr.h"
 #include "esp_core_dump.h"
 #include "esp_err.h"
 #ifdef __XTENSA__
-  #include "freertos/xtensa_api.h"
+  #if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 2, 0)
+    #include "xtensa_api.h"
+  #else
+    #include "freertos/xtensa_api.h"
+  #endif
   #include "memfault/panics/arch/xtensa/xtensa.h"
 #elif __riscv
   #include "memfault/panics/arch/riscv/riscv.h"
   #include "riscv/rvruntime-frames.h"
 #endif
-#include "memfault/esp_port/version.h"
 #include "memfault/panics/coredump.h"
 #include "memfault/panics/fault_handling.h"
 
@@ -88,9 +94,14 @@ void memfault_fault_handling_assert_extra(void *pc, void *lr, sMemfaultAssertInf
 //! @note The signature for the wrapped function changed in esp-idf v4.3+, then
 //! later backported to the 4.2 branch in v4.2.3. Support that change with a
 //! version check (see static assert below for verifying the signature is
-//! correct)
+//! correct).
+//! The signature also changed in esp-idf v5.3.0.
 #if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 2, 3)
+  #if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 3, 0)
+void __wrap_esp_core_dump_write(panic_info_t *info) {
+  #else
 void __wrap_esp_core_dump_to_flash(panic_info_t *info) {
+  #endif
   #ifdef __XTENSA__
   XtExcFrame *fp = (void *)info->frame;
   #elif __riscv
@@ -241,6 +252,10 @@ void __wrap_esp_core_dump_to_flash(XtExcFrame *fp) {
 }
 
 // Ensure the substituted function signature matches the original function
-_Static_assert(__builtin_types_compatible_p(__typeof__(&esp_core_dump_to_flash),
-                                            __typeof__(&__wrap_esp_core_dump_to_flash)),
+_Static_assert(__builtin_types_compatible_p(
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 3, 0)
+                 __typeof__(&esp_core_dump_write), __typeof__(&__wrap_esp_core_dump_write)),
+#else
+                 __typeof__(&esp_core_dump_to_flash), __typeof__(&__wrap_esp_core_dump_to_flash)),
+#endif
                "Error: core dump handler is not compatible with esp-idf's default implementation");
diff --git a/ports/esp_idf/memfault/common/memfault_platform_http_client.c b/ports/esp_idf/memfault/common/memfault_platform_http_client.c
@@ -419,7 +419,13 @@ bool memfault_esp_port_netif_connected(void) {
   #if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 1, 0)
   // iterate over all netifs and check if any of them are connected
   esp_netif_t *netif = NULL;
-  while ((netif = esp_netif_next(netif)) != NULL) {
+  while ((netif =
+    #if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 2, 0)
+            esp_netif_next_unsafe
+    #else
+            esp_netif_next
+    #endif
+          (netif)) != NULL) {
     if (!esp_netif_is_netif_up(netif)) {
       continue;
     }
@@ -463,7 +469,7 @@ int memfault_esp_port_http_client_post_data(void) {
     MEMFAULT_LOG_INFO("No new data found");
   } else {
     MEMFAULT_LOG_INFO("Result: %d", (int)rv);
-  #if defined(CONFIG_MEMFAULT_SYNC_MEMFAULT_METRICS)
+  #if defined(CONFIG_MEMFAULT_METRICS_MEMFAULT_SYNC_SUCCESS)
     if (rv == 0) {
       memfault_metrics_connectivity_record_memfault_sync_success();
     } else {
diff --git a/ports/esp_idf/memfault/config/memfault_esp_idf_port_config.h b/ports/esp_idf/memfault/config/memfault_esp_idf_port_config.h
@@ -17,10 +17,22 @@ extern "C" {
 
 #include "sdkconfig.h"
 
-#if defined(CONFIG_MEMFAULT_SYNC_MEMFAULT_METRICS)
+#if defined(CONFIG_MEMFAULT_METRICS_SYNC_SUCCESS)
+  #define MEMFAULT_METRICS_SYNC_SUCCESS 1
+#endif
+
+#if defined(CONFIG_MEMFAULT_METRICS_MEMFAULT_SYNC_SUCCESS)
   #define MEMFAULT_METRICS_MEMFAULT_SYNC_SUCCESS 1
 #endif
 
+#if defined(CONFIG_MEMFAULT_METRICS_CONNECTIVITY_CONNECTED_TIME)
+  #define MEMFAULT_METRICS_CONNECTIVITY_CONNECTED_TIME 1
+#endif
+
+#if defined(CONFIG_MEMFAULT_METRICS_BATTERY)
+  #define MEMFAULT_METRICS_BATTERY_ENABLE 1
+#endif
+
 #if defined(CONFIG_MEMFAULT_CLI_SELF_TEST)
   #define MEMFAULT_DEMO_CLI_SELF_TEST 1
   #define MEMFAULT_SELF_TEST_COREDUMP_STORAGE_DISABLE_MSG \
diff --git a/ports/freertos/src/memfault_sdk_metrics_freertos.c b/ports/freertos/src/memfault_sdk_metrics_freertos.c
@@ -13,6 +13,7 @@
 #ifdef MEMFAULT_USE_ESP32_FREERTOS_INCLUDE
   #include "freertos/FreeRTOS.h"
   #include "freertos/task.h"
+  #include "memfault/esp_port/version.h"
 #else
   #include "FreeRTOS.h"
   #include "task.h"
@@ -76,7 +77,17 @@ static configRUN_TIME_COUNTER_TYPE prv_get_total_runtime(void) {
 
 #if MEMFAULT_FREERTOS_RUN_TIME_STATS_MULTI_CORE
 static configRUN_TIME_COUNTER_TYPE prv_get_idle_counter_for_core(uint32_t core) {
-  TaskHandle_t idle_task_handle = xTaskGetIdleTaskHandleForCPU(core);
+  TaskHandle_t idle_task_handle =
+  #ifdef MEMFAULT_USE_ESP32_FREERTOS_INCLUDE
+    #if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 3, 0)
+    xTaskGetIdleTaskHandleForCore(core)
+    #else
+    xTaskGetIdleTaskHandleForCPU(core)
+    #endif
+  #else
+    xTaskGetIdleTaskHandleForCPU(core)
+  #endif
+    ;
   TaskStatus_t idle_task_status;
 
   // This could be a bit cleaner if we could use `ulTaskGetRunTimeCounter`, but that API
diff --git a/ports/zephyr/Kconfig b/ports/zephyr/Kconfig
@@ -397,13 +397,42 @@ config MEMFAULT_FS_BYTES_FREE_VFS_PATH
          The path to the virtual filesystem mount point to collect free space
          metrics for, omitting the leading '/'.
 
-config MEMFAULT_SYNC_MEMFAULT_METRICS
-        bool "Enable sync_memfault_successful metric"
+config MEMFAULT_METRICS_SYNC_SUCCESS
+        bool "Enable collection of sync success metrics"
+        default y
+        help
+         Memfault user-defined sync success metric component. More information
+         at https://mflt.io/core-metrics .
+
+config MEMFAULT_METRICS_MEMFAULT_SYNC_SUCCESS
+        bool "Enable collection of memfault sync success metrics"
         default y
         depends on MEMFAULT_HTTP_ENABLE
         help
          Collects Memfault metrics for the number of successful and failed
-         syncs to the Memfault cloud.
+         syncs to the Memfault cloud. More information at
+         https://mflt.io/core-metrics .
+
+config MEMFAULT_METRICS_CONNECTIVITY_CONNECTED_TIME
+        bool "Enable collection of memfault connectivity time metrics"
+        default y
+        help
+         Memfault connectivity time metric component. More information at
+         https://mflt.io/core-metrics .
+
+config MEMFAULT_METRICS_BATTERY_ENABLE
+       bool "Enable collection of battery metrics"
+       default n
+       help
+         Memfault battery metric component. More information at
+         https://mflt.io/core-metrics .
+
+config MEMFAULT_BATTERY_METRICS_BOOT_ON_SYSTEM_INIT
+       bool "Auto initialize battery metrics on system init"
+       default y
+       depends on MEMFAULT_METRICS_BATTERY_ENABLE
+       help
+        Automatically initialize the battery metric subsystem on bootup
 
 config MEMFAULT_METRICS_TCP_IP
         bool "Enable collection of TCP/IP metrics"
diff --git a/ports/zephyr/common/memfault_platform_core.c b/ports/zephyr/common/memfault_platform_core.c
diff --git a/ports/zephyr/common/memfault_platform_http.c b/ports/zephyr/common/memfault_platform_http.c
diff --git a/ports/zephyr/config/memfault_zephyr_platform_config.h b/ports/zephyr/config/memfault_zephyr_platform_config.h

Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,8 @@ typedef struct {`
`19`	`19`	`uint8_t patch;`
`20`	`20`	`} sMfltSdkVersion;`
`21`	`21`
`22`		`-#define MEMFAULT_SDK_VERSION { .major = 1, .minor = 7, .patch = 2 }`
`23`		`-#define MEMFAULT_SDK_VERSION_STR "1.7.2"`
	`22`	`+#define MEMFAULT_SDK_VERSION { .major = 1, .minor = 7, .patch = 3 }`
	`23`	`+#define MEMFAULT_SDK_VERSION_STR "1.7.3"`
`24`	`24`
`25`	`25`	`#ifdef __cplusplus`
`26`	`26`	`}`