Memfault Firmware SDK 1.11.2 (Build 9770)

Author: Memfault Inc

CHANGELOG.md

@@ -6,6 +6,71 @@ 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.2] - 2024-08-29
+
+### :chart_with_upwards_trend: Improvements
+
+- nRF-Connect SDK:
+
+  - Add support for the following reboot reasons on nRF series SOCs. These
+    reboot reasons are tracked as `kMfltRebootReason_DeepSleep`.
+
+    - `NRF_POWER_RESETREAS_OFF_MASK`
+    - `NRF_POWER_RESETREAS_NFC_MASK`
+    - `NRF_POWER_RESETREAS_CTRLAP_MASK`
+
+- Zephyr:
+
+  - Use `MEMFAULT_ASSERT_HALT_IF_DEBUGGING_ENABLED` to control whether coredumps
+    trigger a halt when a debugger is attached.
+
+  - Add a new Kconfig option, `CONFIG_MEMFAULT_RAM_BACKED_COREDUMP_REGION`, to
+    set the RAM region used for storing RAM-backed coredumps.
+
+  - Fix a :bug: when trying to communicate via HTTPS with Memfault on the
+    nRF91x. On the nRF91x, socket operations are offloaded to the nRF modem lib,
+    which does not currently support the socket option `TLS_CERT_NO_COPY`. In
+    v1.9.4, this socket option was applied when TLS was enabled
+    (`!g_mflt_http_client_config.disable_tls`) and Zephyr version was >=3.0.0
+    (when support for this socket option was added). Therefore, devices on SDK
+    versions >=1.9.4 and <1.11.2 trying to communicate with Memfault will run
+    into a no protocol support error (`ENOPROTOOPT`) in the nRF modem lib. Since
+    this option is only required to use the DER format,
+    `CONFIG_MEMFAULT_TLS_CERTS_USE_DER` now depends on the Zephyr-implemented
+    socket operations being used (`!NET_SOCKET_OFFLOAD`).
+
+  - Fix the build when using Zephyr 3.7.0 and leveraging the HTTP client and/or
+    ESP32 port. The Memfault HTTP client would fail to build due to the wrong
+    `crypto.h` header getting picked up in the build. Additionally, due to the
+    [removal of default support for mbedTLS hash algorithms in Zephyr](https://docs.zephyrproject.org/latest/releases/migration-guide-3.7.html#mbed-tls),
+    `CONFIG_MBEDTLS_SHA1` now must be enabled explicitly when using any of
+    Memfault's CA certificates. When using PEM and leveraging Zephyr's in-tree
+    mbedTLS and config file
+    (`CONFIG_MBEDTLS_BUILTIN=y && CONFIG_MBEDTLS_CFG_FILE="config-tls-generic.h"`),
+    `CONFIG_MBEDTLS_PEM_CERTIFICATE_FORMAT=y` is required for PEM certificate
+    support. To simplify certificate format selection, a new choice Kconfig
+    called `CONFIG_MEMFAULT_TLS_CERTS_FORMAT` has been added. Use the configs
+    `CONFIG_MEMFAULT_TLS_CERTS_USE_PEM` and `CONFIG_MEMFAULT_TLS_CERTS_USE_DER`
+    to choose the certificate format.`CONFIG_MEMFAULT_TLS_CERTS_USE_DER` is the
+    default choice config. Finally, the Kconfig `CONFIG_SOC_FAMILY_ESP32` is now
+    deprecated. References of this Kconfig now also check the new Kconfig
+    `CONFIG_SOC_FAMILY_ESPRESSIF_ESP32`. See
+    [Zephyr's 3.7 Migration guide](https://docs.zephyrproject.org/latest/releases/migration-guide-3.7.html)
+    for more details.
+
+- Dialog
+
+  - Add support to the existing DA145xx port for the DA14535 by adding the
+    correct memory region for `memfault_platform_sanitize_address_range()`.
+
+  - Fix several :bug:s in `memfault_reboot_reason_get()` and
+    `memfault_platform_reboot()` implementations in the DA146x port. In
+    `memfault_reboot_reason_get()`, the bit masks were incorrectly applied and a
+    block was missing to reset the reboot reason register if
+    `MEMFAULT_REBOOT_REASON_CLEAR` is set. In `memfault_platform_reboot()`, the
+    mechanism to reboot the system has been updated from
+    `hw_cpm_reboot_system()` to `SWRESET`.
+
 ## [1.11.1] - 2024-08-12
 
 ### :chart_with_upwards_trend: Improvements

VERSION

@@ -1,3 +1,3 @@
-BUILD ID: 9373
-GIT COMMIT: 4730bd7818
-VERSION: 1.11.1
+BUILD ID: 9770
+GIT COMMIT: ea6fadf472
+VERSION: 1.11.2

components/core/src/memfault_self_test.c

@@ -87,6 +87,7 @@ static bool is_field_valid(const char *str, eDeviceInfoField field) {
   // Max + 1 needed determine if we exceeded bounds before NULL found
   size_t len = memfault_strnlen(str, MEMFAULT_DEVICE_INFO_MAX_STRING_SIZE + 1);
   if ((len < 1) || (len > MEMFAULT_DEVICE_INFO_MAX_STRING_SIZE)) {
+    (void)s_device_info_field_names;  // Avoid unused variable warning when logging is disabled
     MEMFAULT_LOG_ERROR("Invalid length %zu for %s", len, s_device_info_field_names[field]);
     return false;
   }

components/include/memfault/version.h

@@ -19,8 +19,8 @@ typedef struct {
   uint8_t patch;
 } sMfltSdkVersion;
 
-#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 11, .patch = 1 }
-#define MEMFAULT_SDK_VERSION_STR "1.11.1"
+#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 11, .patch = 2 }
+#define MEMFAULT_SDK_VERSION_STR "1.11.2"
 
 #ifdef __cplusplus
 }

components/panics/src/memfault_fault_handling_riscv.c

@@ -45,7 +45,8 @@ void memfault_arch_fault_handling_assert(void *pc, void *lr, eMemfaultRebootReas
 
 // For non-esp-idf riscv implementations, provide a full assert handler and
 // other utilities.
-  #if defined(__ZEPHYR__) && defined(CONFIG_SOC_FAMILY_ESP32)
+  #if defined(__ZEPHYR__) && \
+    (defined(CONFIG_SOC_FAMILY_ESP32) || defined(CONFIG_SOC_FAMILY_ESPRESSIF_ESP32))
     #include <hal/cpu_hal.h>
     #include <zephyr/kernel.h>
 

components/panics/src/memfault_fault_handling_xtensa.c

@@ -41,14 +41,25 @@ void memfault_arch_fault_handling_assert(void *pc, void *lr, eMemfaultRebootReas
 }
 
 // For Zephyr Xtensa, provide an assert handler and other utilities.
-  #if defined(__ZEPHYR__) && defined(CONFIG_SOC_FAMILY_ESP32)
+// The Kconfig for the ESP32 family changed in v3.7.0. Support both Kconfigs
+  #if defined(__ZEPHYR__) && \
+    (defined(CONFIG_SOC_FAMILY_ESP32) || defined(CONFIG_SOC_FAMILY_ESPRESSIF_ESP32))
     #include <hal/cpu_hal.h>
     #include <zephyr/kernel.h>
 
+    #include "memfault/ports/zephyr/version.h"
+
 void memfault_platform_halt_if_debugging(void) {
+    // cpu_ll.h was deprecated in v3.7.0
+    #if MEMFAULT_ZEPHYR_VERSION_GT(3, 6)
+  if (esp_cpu_dbgr_is_attached()) {
+    MEMFAULT_BREAKPOINT();
+  }
+    #else
   if (cpu_ll_is_debugger_attached()) {
     MEMFAULT_BREAKPOINT();
   }
+    #endif
 }
 
 bool memfault_arch_is_inside_isr(void) {

examples/esp32/apps/memfault_demo_app/sdkconfig.defaults

@@ -50,3 +50,6 @@ CONFIG_MEMFAULT_COMPACT_LOG_ENABLE=y
 
 # Enable periodic upload thread for posting Memfault data
 CONFIG_MEMFAULT_HTTP_PERIODIC_UPLOAD=y
+
+# Support older ESP32-C3 variants
+CONFIG_ESP32C3_REV_MIN_2=y

examples/nrf-connect-sdk/nrf5/memfault_demo_app/CMakeLists.txt

@@ -2,9 +2,9 @@
 
 cmake_minimum_required(VERSION 3.20.0)
 
-# The default board for this example is the nrf52840dk_nrf52840, but can be
+# The default board for this example is the nrf52840dk/nrf52840, but can be
 # overridden by passing --board=<board> to west or -DBOARD=<board> to cmake
-set(BOARD nrf52840dk_nrf52840)
+set(BOARD nrf52840dk/nrf52840)
 
 find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
 project(fs_shell)

examples/nrf-connect-sdk/nrf5/memfault_demo_app/prj.conf

@@ -53,3 +53,7 @@ CONFIG_WATCHDOG=y
 
 # Enable Zephyr runtime asserts
 CONFIG_ASSERT=y
+
+# For testing poweroff mode, enable GPIO + poweroff subsystems
+CONFIG_GPIO=y
+CONFIG_POWEROFF=y

examples/nrf-connect-sdk/nrf5/memfault_demo_app/src/shell_commands.c

@@ -0,0 +1,53 @@
+//! @file
+//!
+//! Copyright (c) Memfault, Inc.
+//! See License.txt for details
+//!
+//! Shell commands
+
+#include <zephyr/drivers/gpio.h>
+#include <zephyr/kernel.h>
+// #include <zephyr/pm/device.h>
+#include <zephyr/logging/log.h>
+#include <zephyr/shell/shell.h>
+#include <zephyr/sys/poweroff.h>
+
+LOG_MODULE_REGISTER(appshell, LOG_LEVEL_INF);
+
+static const struct gpio_dt_spec sw0 = GPIO_DT_SPEC_GET(DT_ALIAS(sw0), gpios);
+
+// Define a simple shell command
+static int cmd_poweroff(const struct shell *shell, size_t argc, char **argv) {
+  LOG_INF("Powering off device");
+  /* configure sw0 as input, interrupt as level active to allow wake-up */
+  int rc = gpio_pin_configure_dt(&sw0, GPIO_INPUT);
+  if (rc < 0) {
+    LOG_ERR("Could not configure sw0 GPIO (%d)\n", rc);
+    return 0;
+  }
+
+  rc = gpio_pin_interrupt_configure_dt(&sw0, GPIO_INT_LEVEL_ACTIVE);
+  if (rc < 0) {
+    LOG_ERR("Could not configure sw0 GPIO interrupt (%d)\n", rc);
+    return 0;
+  }
+
+  LOG_INF("Entering system off; press sw0 to restart\n");
+
+  // rc = pm_device_action_run(cons, PM_DEVICE_ACTION_SUSPEND);
+  // if (rc < 0) {
+  // 	printf("Could not suspend console (%d)\n", rc);
+  // 	return 0;
+  // }
+
+  // if (IS_ENABLED(CONFIG_APP_RETENTION)) {
+  // 	/* Update the retained state */
+  // 	retained.off_count += 1;
+  // 	retained_update();
+  // }
+
+  sys_poweroff();
+  return 0;
+}
+
+SHELL_CMD_REGISTER(poweroff, NULL, "Power off the device", cmd_poweroff);