Memfault Firmware SDK 1.8.1 (Build 7582)

Author: Memfault Inc

CHANGELOG.md

@@ -6,6 +6,64 @@ 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.8.1] - 2024-04-24
+
+### :chart_with_upwards_trend: Improvements
+
+- General:
+
+  - A new platform function, `memfault_platform_metrics_connectivity_boot()`,
+    can be enabled to be called from the Memfault SDK `metrics_boot()` function
+    after the metrics subsystem is initialized. This platform function is used
+    for setting any initial state information for Connectivity metrics, and has
+    default implementations for ESP-IDF (WiFi) and nRF9160 (LTE) devices.
+
+- ESP-IDF:
+
+  - Add a new Kconfig setting,
+    `CONFIG_MEMFAULT_COREDUMP_STORAGE_WRITE_OFFSET_SECTORS`, which can be used
+    to set an offset into the coredump storage area where coredumps are written.
+    The full partition will still be erased, but coredumps will be written
+    starting at the sector offset selected with this setting. The skipped sector
+    will remain at the erased value, `0xff` for all bytes.
+
+- Zephyr:
+
+  - Added a built-in weakly defined implementation of
+    `memfault_platform_get_device_info()`, which provides:
+
+    - `.device_serial` : A default device serial based on the SOC's unique ID
+      registers, via the
+      [`hwinfo` subsystem](https://docs.zephyrproject.org/3.6.0/hardware/peripherals/hwinfo.html).
+      This is the default device serial when `CONFIG_HWINFO=y`. If
+      `CONFIG_HWINFO=n`, the fallback device serial is
+      `CONFIG_SOC "-testserial"`.
+    - `.software_type` : Configurable with
+      `CONFIG_MEMFAULT_BUILTIN_DEVICE_INFO_SOFTWARE_TYPE`, defaults to `"app"`
+    - `.software_version` : Configurable with
+      `CONFIG_MEMFAULT_BUILTIN_DEVICE_INFO_SOFTWARE_VERSION`. Defaults to an
+      identifier based on the `VERSION` file in the application, using the
+      Zephyr
+      [Application Version](https://docs.zephyrproject.org/3.6.0/build/version/index.html)
+      feature, or `"0.0.0"` if unavailable.
+    - `.hardware_version` : Configurable with
+      `CONFIG_MEMFAULT_BUILTIN_DEVICE_INFO_HARDWARE_VERSION`. Defaults to an
+      identifier based on `CONFIG_BOARD` and `CONFIG_BOARD_REVISION` (if set).
+
+  - Add a new Zephyr example app for the
+    [ST NUCLEO-WBA55CG board](https://docs.zephyrproject.org/3.6.0/boards/st/nucleo_wba55cg/doc/nucleo_wba55cg.html),
+    under [`examples/zephyr/nucleo_wba55cg`](examples/zephyr/nucleo_wba55cg).
+    This example demonstrates the Memfault SDK integration on the NUCLEO-WBA55CG
+    board.
+
+- nRF-Connect SDK:
+
+  - Add [Connected Time Vital](https://mflt.io/connectivity-metrics)
+    out-of-the-box for nRF9160 projects, tracking modem connected time. This is
+    controlled with the Kconfig
+    `CONFIG_MEMFAULT_NRF_CONNECTIVITY_CONNECTED_TIME_NRF91X`, enabled by
+    default.
+
 ## [1.8.0] - 2024-04-17
 
 ### :chart_with_upwards_trend: Improvements

VERSION

@@ -1,3 +1,3 @@
-BUILD ID: 7456
-GIT COMMIT: 69ebc0be9a
-VERSION: 1.8.0
+BUILD ID: 7582
+GIT COMMIT: ece044b45b
+VERSION: 1.8.1

components/include/memfault/core/reboot_reason_types.h

@@ -108,6 +108,18 @@ typedef enum MfltResetReason {
   // executing from a fault handler.
   kMfltRebootReason_Lockup = 0x9401,
 
+  // A reset triggered due to a security violation
+  kMfltRebootReason_SecurityViolation = 0x9402,
+
+  // A reset triggered due to a parity error (i.e. memory integrity check)
+  kMfltRebootReason_ParityError = 0x9403,
+
+  // A reset triggered due to a temperature error
+  kMfltRebootReason_Temperature = 0x9404,
+
+  // A reset due to some other hardware error
+  kMfltRebootReason_Hardware = 0x9405,
+
 //
 // User Defined Unexpected Resets
 //

components/include/memfault/default_config.h

@@ -653,6 +653,16 @@ extern "C" {
   #define MEMFAULT_PLATFORM_FREERTOS_TCB_SIZE 100
 #endif
 
+//
+// Platform-specific metrics configuration options
+//
+
+//! Enable this flag to cause metrics_boot() to call a platform-implemented
+//! memfault_platform_metrics_connectivity_boot() function
+#ifndef MEMFAULT_PLATFORM_METRICS_CONNECTIVITY_BOOT
+  #define MEMFAULT_PLATFORM_METRICS_CONNECTIVITY_BOOT 0
+#endif
+
 #ifdef __cplusplus
 }
 #endif

components/include/memfault/metrics/platform/connectivity.h

@@ -0,0 +1,30 @@
+#pragma once
+
+//! @file
+//!
+//! Copyright (c) Memfault, Inc.
+//! See License.txt for details
+//!
+//! Copyright (c) Memfault, Inc.
+//! See License.txt for details
+//!
+//! @brief
+//! Optional platform-specific boot function for initializing connectivity metrics.
+
+#include <stdbool.h>
+#include <stdint.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+//! The platform must implement this function. It is called during boot to initialize
+//! platform-specific connectivity metrics.
+//!
+//! For example, this function may register handlers for connectivity events, which when
+//! received, the handlers will mark the begin and end of connection periods.
+void memfault_platform_metrics_connectivity_boot(void);
+
+#ifdef __cplusplus
+}
+#endif

components/include/memfault/version.h

@@ -19,8 +19,8 @@ typedef struct {
   uint8_t patch;
 } sMfltSdkVersion;
 
-#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 8, .patch = 0 }
-#define MEMFAULT_SDK_VERSION_STR "1.8.0"
+#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 8, .patch = 1 }
+#define MEMFAULT_SDK_VERSION_STR "1.8.1"
 
 #ifdef __cplusplus
 }

components/metrics/src/memfault_metrics.c

@@ -20,6 +20,7 @@
 #include "memfault/core/serializer_helper.h"
 #include "memfault/metrics/battery.h"
 #include "memfault/metrics/metrics.h"
+#include "memfault/metrics/platform/connectivity.h"
 #include "memfault/metrics/platform/overrides.h"
 #include "memfault/metrics/platform/timer.h"
 #include "memfault/metrics/reliability.h"
@@ -1272,5 +1273,9 @@ int memfault_metrics_boot(const sMemfaultEventStorageImpl *storage_impl,
     return rv;
   }
 
+#if MEMFAULT_PLATFORM_METRICS_CONNECTIVITY_BOOT
+  memfault_platform_metrics_connectivity_boot();
+#endif
+
   return 0;
 }

examples/zephyr/nucleo_wba55cg/.gitignore

@@ -0,0 +1,6 @@
+/.west
+/bootloader
+/build
+/modules
+/tools
+/zephyr

examples/zephyr/nucleo_wba55cg/README.md

@@ -0,0 +1,43 @@
+## Memfault Zephyr `nucleo_wba55cg` Example Application
+
+This folder contains an example integration of the Memfault SDK using the port
+provided in `ports/zephyr`
+
+The demo was tested using the
+[ST NUCLEO-WBA55CG board](https://docs.zephyrproject.org/3.6.0/boards/st/nucleo_wba55cg/doc/nucleo_wba55cg.html).
+
+### Prerequisite
+
+We assume you already have a working Zephyr toolchain installed locally.
+Step-by-step instructions can be found in the
+[Zephyr Documentation](https://docs.zephyrproject.org/2.5.0/getting_started/index.html#build-hello-world).
+
+### Setup
+
+From a Zephyr-enabled shell environment (`west` tool is available), initialize
+the workspace:
+
+```bash
+west init -l memfault_demo_app
+west update
+west blobs fetch stm32
+```
+
+### Building
+
+```bash
+west build --board nucleo_wba55cg memfault_demo_app
+[...]
+[271/271] Linking C executable zephyr/zephyr.elf
+```
+
+### Flashing
+
+The build can be flashed on the development board using `west flash` ( See
+Zephyr
+["Building, Flashing, & Debugging" documentation](https://docs.zephyrproject.org/3.6.0/guides/west/build-flash-debug.html?highlight=building%20flashing#flashing-west-flash))
+
+The default runner is `STM32_Programmer_CLI`, which must be available on `PATH`
+when running `west flash`. `STM32_Programmer_CLI` is installed
+[standalone](https://www.st.com/en/development-tools/stm32cubeprog.html) or from
+the STM32CubeIDE installation.

examples/zephyr/nucleo_wba55cg/memfault_demo_app/CMakeLists.txt

@@ -0,0 +1,7 @@
+cmake_minimum_required(VERSION 3.13.1)
+
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+project(memfault_demo_app)
+
+zephyr_include_directories(config)
+target_sources(app PRIVATE src/main.c)