Memfault Firmware SDK 1.20.0 (Build 12555)

Author: Memfault Inc

CHANGELOG.md

@@ -6,6 +6,152 @@ 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.20.0] - 2025-02-06
+
+### 📈 Added
+
+- General:
+
+  - Make `memfault_reboot_reason_get()` and
+    `memfault_platform_metrics_timer_boot()` weakly defined in the
+    [platform templates](ports/templates) to make removing them optional when
+    first integrating
+
+  - Added a configuration option, `MEMFAULT_CRC16_BUILTIN`, that permits
+    disabling the built-in [crc16](components/util/src/memfault_crc16_ccitt.c)
+    implementation. The user should provide a compatible implementation of
+    `memfault_crc16_compute()`. For example, if the Zephyr CRC library is used,
+    a compatible implementation would be:
+
+    ```c
+    #include <zephyr/sys/crc.h>
+
+    uint16_t memfault_crc16_compute(uint16_t crc_initial_value, const void *data,
+                                    size_t data_len_bytes) {
+      return crc16_itu_t(crc_initial_value, data, data_len_bytes);
+    }
+    ```
+
+    A Zephyr Kconfig setting, `CONFIG_MEMFAULT_CRC16_BUILTIN`, is also provided
+    to control this option.
+
+    Thanks to [@JordanYates](https://github.com/JordanYates) for submitting this
+    feature request in
+    [#84](https://github.com/memfault/memfault-firmware-sdk/issues/84) !
+
+  - Added an example `daily_heartbeat` session to the
+    [FreeRTOS QEMU example](examples/freertos/src/metrics.c), which demonstrates
+    how to send a daily heartbeat session to Memfault. Daily Heartbeats are a
+    special category of Session Metrics, and can be used to track device
+    properties over a longer interval than heartbeat metrics.
+
+  - Added an optional field to the built-in
+    [FreeRTOS task stack usage metrics](ports/include/memfault/ports/freertos/thread_metrics.h),
+    `.get_task_handle`, which allows the user to provide a custom function to
+    get the task handle for a given thread name, instead of using the thread
+    name to identify the thread. This is useful in systems where there are
+    threads with ambiguous names. The
+    [ESP32 example app](examples/esp32/apps/memfault_demo_app/main/metrics.c) is
+    updated to use this feature for ESP-IDF <5.3, where on dual-core SOCs, the
+    per-core idle threads are both named `IDLE`.
+
+- nRF Connect SDK:
+
+  - Added a new Kconfig symbol `CONFIG_MEMFAULT_FOTA_HTTP_FRAG_SIZE` to enable
+    controlling the HTTP fragment size when using NCS >=2.9.9. Previously,
+    `CONFIG_DOWNLOAD_CLIENT_HTTP_FRAG_SIZE_1024=y` was required, but this option
+    was deprecated in NCS 2.9.9.
+
+  - Add built-in support for the `thermal_cpu_c` (CPU temperature) metric for
+    nRF5x chips (nRF52 and nRF54 app core supported). Use the Kconfig setting
+    `MEMFAULT_METRICS_CPU_TEMP` to disable the metric.
+
+- Zephyr
+
+  - Add a new Kconfig setting, `CONFIG_MEMFAULT_HTTP_CLIENT_TIMEOUT_MS`, which
+    controls the timeout for the Memfault HTTP client, used both for chunk
+    upload and OTA operations. The default timeout is 5 seconds. Connections
+    with poor latency may require a longer timeout to avoid premature
+    disconnection. Thanks to [@chirambaht](https://github.com/chirambaht) for
+    submitting this in
+    [#86](https://github.com/memfault/memfault-firmware-sdk/issues/86)!
+
+### 🐛 Fixed
+
+- ESP-IDF:
+
+  - Use the configuration `MEMFAULT_LOG_MAX_LINE_SAVE_LEN` to set the max length
+    of a log line when `CONFIG_MEMFAULT_LOG_USE_VPRINTF_HOOK=y`, which is the
+    default setting in ESP-IDF. Previously, the log line was arbitrarily
+    truncated in the Memfault vprintf hook before being saved to the Memfault
+    log buffer.
+
+- General:
+
+  - Remove the `MEMFAULT_PACKED` attribute for the `eMemfaultRebootReason`
+    declaration; this compiler extension is not supported on IAR EWARM's
+    compiler. Change the assembly shim to properly zero-extend the enum constant
+    to avoid ABI issues when invoking the C fault handling code.
+
+### 🛠️ Changed
+
+- General:
+
+  - Remove an extra underscore in the folder name when using the
+    [`eclipse_patch.py`](scripts/eclipse_patch.py) utility with a port name that
+    is one folder deep (e.g. `freertos`)
+
+  - Rename the `memfault_crc16_ccitt_compute()` function to
+    `memfault_crc16_compute()`. The CRC-16 algorithm used is canonically named
+    `CRC-16/XMODEM`, **not** `CRC-16/CCITT` (aka `CRC-16/KERMIT`). The file
+    implementing that function is left as `memfault_crc16_ccitt.c` for backwards
+    compatibility. Thanks to [@JordanYates](https://github.com/JordanYates) for
+    reporting this issue in
+    [#83](https://github.com/memfault/memfault-firmware-sdk/issues/83)!
+
+- Zephyr:
+
+  - Add a missing Kconfig dependency to `MEMFAULT_METRICS_THREADS`,
+    `INIT_STACKS`. Also add missing dependencies to the Kconfig option
+    `MEMFAULT_METRICS_DEFAULT_SET_ENABLE`:
+
+    - `INIT_STACKS`
+    - `THREAD_RUNTIME_STATS`
+    - `THREAD_STACK_INFO`
+
+    Thanks to [@JordanYates](https://github.com/JordanYates) for reporting this
+    problem in
+    [#86](https://github.com/memfault/memfault-firmware-sdk/issues/86) !
+
+  - Update the
+    [memfault_zephyr_port_post_data()/memfault_zephyr_port_post_data_return_size()](ports/zephyr/common/memfault_platform_http.c)
+    functions to only open the TLS socket if there is data ready to send, which
+    is otherwise wasteful, as the socket will be closed without sending any
+    Memfault data.
+
+  - Add an explicit module name, `memfault-firmware-sdk`, to the module
+    manifest. This avoids issues when the SDK is registered in a Zephyr manifest
+    under a directory name other than `memfault-firmware-sdk`. Thanks to
+    [@JordanYates](https://github.com/JordanYates) for reporting this issue in
+    [#81](https://github.com/memfault/memfault-firmware-sdk/issues/81)!
+
+  - Exclude unused stack space when capturing thread stacks, via the
+    `thread.stack_info.delta` property. This reduces the amount of coredump
+    storage used to capture thread stacks, especially when
+    `CONFIG_STACK_POINTER_RANDOM` or `CONFIG_THREAD_LOCAL_STORAGE` is enabled.
+    Thanks to [@JordanYates](https://github.com/JordanYates) for reporting this
+    issue in [#81](https://github.com/memfault/memfault-firmware-sdk/issues/85)!
+
+- nRF Connect SDK:
+
+  - Remove use of child and parent image functionality in the nRF9160 sample
+    app, and replace with sysbuild support. Child image support was deprecated
+    in NCS 2.7.0 in favor of sysbuild.
+
+  - Use the downloader library instead of the download client library when using
+    NCS >= 2.9.9. The download_client was recently deprecated in favor of the
+    downloader. Download client support is now in `memfault_fota_legacy.c`.
+
 ## [1.19.0] - 2025-01-10
 
 ### 📈 Added
@@ -2034,7 +2180,8 @@ earlier versions!
     call the normal `z_fatal_error` handler at the end of Memfault fault
     processing instead of rebooting the system. This is useful when user code
     needs to run within `k_sys_fatal_error_handler()` just prior to system
-    shutdown. Thanks to @JordanYates for the patch! Fixes
+    shutdown. Thanks to [@JordanYates](https://github.com/JordanYates) for the
+    patch! Fixes
     [#59](https://github.com/memfault/memfault-firmware-sdk/issues/59).
 
   - Add a timeout to the initial `send()` socket operation in
@@ -2205,7 +2352,8 @@ earlier versions!
   - Fix a 🐛 and warnings involving older Zephyr header paths. Resolves
     [#62](https://github.com/memfault/memfault-firmware-sdk/issues/62) and
     [#57](https://github.com/memfault/memfault-firmware-sdk/issues/57). Thanks
-    @JordanYates and @YHusain1 for reporting these issues.
+    [@JordanYates](https://github.com/JordanYates) and @YHusain1 for reporting
+    these issues.
 
 ### Changes between Memfault SDK 1.1.2 and 1.1.3 - Aug 8, 2023
 
@@ -2219,7 +2367,7 @@ earlier versions!
   override the default. For Zephyr, the Kconfig option
   `CONFIG_MEMFAULT_GNU_BUILD_ID_SOURCE_BUILTIN` can be used to override the
   builtin section specifier + linker fragment for the GNU build ID. Thanks to
-  @JordanYates for posting this change in
+  [@JordanYates](https://github.com/JordanYates) for posting this change in
   [#60](https://github.com/memfault/memfault-firmware-sdk/pull/60) 🎉
 - Improvements to the ARMv7-R exception handling when the supervisor processor
   mode is active
@@ -2245,7 +2393,7 @@ earlier versions!
 - Zephyr:
   - Fix a build error when `CONFIG_MEMFAULT_LOGGING=n`, see
     [#56](https://github.com/memfault/memfault-firmware-sdk/issues/56). Thanks
-    to @JordanYates for reporting this issue!
+    to [@JordanYates](https://github.com/JordanYates) for reporting this issue!
   - Fix a potential bug in the Memfault Log Backend when
     `CONFIG_LOG_MODE_IMMEDIATE=y` when flushing of fault logs during a crash
 

VERSION

@@ -1,3 +1,3 @@
-BUILD ID: 12144
-GIT COMMIT: 24d5bb4ea2
-VERSION: 1.19.0
+BUILD ID: 12555
+GIT COMMIT: 7fcaa50c87
+VERSION: 1.20.0

components/core/src/memfault_log.c

@@ -24,7 +24,7 @@
 #include "memfault/core/sdk_assert.h"
 #include "memfault/util/base64.h"
 #include "memfault/util/circular_buffer.h"
-#include "memfault/util/crc16_ccitt.h"
+#include "memfault/util/crc16.h"
 #include "memfault_log_private.h"
 
 #if MEMFAULT_LOG_DATA_SOURCE_ENABLED
@@ -63,9 +63,8 @@ static sMfltRamLogger s_memfault_ram_logger = {
 };
 
 static uint16_t prv_compute_log_region_crc16(void) {
-  return memfault_crc16_ccitt_compute(MEMFAULT_CRC16_CCITT_INITIAL_VALUE,
-                                      &s_memfault_ram_logger.region_info,
-                                      offsetof(sMfltLogStorageRegionInfo, crc16));
+  return memfault_crc16_compute(MEMFAULT_CRC16_INITIAL_VALUE, &s_memfault_ram_logger.region_info,
+                                offsetof(sMfltLogStorageRegionInfo, crc16));
 }
 
 uint32_t memfault_log_get_dropped_count(void) {

components/include/memfault/components.h

@@ -66,7 +66,7 @@
 #include "memfault/util/base64.h"
 #include "memfault/util/cbor.h"
 #include "memfault/util/circular_buffer.h"
-#include "memfault/util/crc16_ccitt.h"
+#include "memfault/util/crc16.h"
 #include "memfault/util/rle.h"
 #include "memfault/util/varint.h"
 #include "memfault/version.h"

components/include/memfault/core/reboot_reason_types.h

@@ -24,9 +24,7 @@ extern "C" {
 #undef MEMFAULT_EXPECTED_REBOOT_REASON_DEFINE
 #undef MEMFAULT_UNEXPECTED_REBOOT_REASON_DEFINE
 
-//! This enum must be packed to prevent compiler optimizations in instructions which load an
-//! eMemfaultRebootReason.
-typedef enum MEMFAULT_PACKED MfltResetReason {
+typedef enum MfltResetReason {
   // A reboot reason was not determined either by hardware or a previously marked reboot reason
   // This reason is classified as a crash when calculating the operational_crashfree_hours metric
   kMfltRebootReason_Unknown = 0x0000,
@@ -140,8 +138,6 @@ typedef enum MEMFAULT_PACKED MfltResetReason {
 
 } eMemfaultRebootReason;
 
-MEMFAULT_STATIC_ASSERT(sizeof(eMemfaultRebootReason) == 2, "Reboot reason enum must be 2 bytes");
-
 #if MEMFAULT_REBOOT_REASON_CUSTOM_ENABLE == 1
   // Ensure that the custom reboot reasons are within the expected range
   #define MEMFAULT_EXPECTED_REBOOT_REASON_DEFINE(name)                                            \

components/include/memfault/default_config.h

@@ -505,6 +505,13 @@ extern "C" {
 // Util Configuration Options
 //
 
+// Set this to 0 to disable the built-in CRC16 implementation. The platform will
+// need to provide a compatible implementation of memfault_crc16_compute(), as
+// defined in memfault/util/crc16.h.
+#ifndef MEMFAULT_CRC16_BUILTIN
+  #define MEMFAULT_CRC16_BUILTIN 1
+#endif
+
 // Enables the use of a (512 bytes) lookup table for CRC16 computation to improve performance
 //
 // For extremely constrained environments where a small amount of data is being sent anyway the

components/include/memfault/demo/cli.h

@@ -23,6 +23,8 @@ extern "C" {
 //! - 0: crash by MEMFAULT_ASSERT(0)
 //! - 1: crash by jumping to 0xbadcafe
 //! - 2: crash by unaligned memory store
+//! - 3: crash by MEMFAULT_ASSERT() deep in the callstack
+//! - 4: crash by MEMFAULT_SOFTWARE_WATCHDOG()
 int memfault_demo_cli_cmd_crash(int argc, char *argv[]);
 
 #if MEMFAULT_COMPILER_ARM_CORTEX_M

components/include/memfault/util/crc16_ccitt.h renamed to components/include/memfault/util/crc16.h

@@ -6,33 +6,30 @@
 //! See LICENSE for details
 //!
 //! @brief
-//! C Implementation of the CRC-16 CCITT (xmodem) polynomial:
+//! C Implementation of the CRC-16/XMODEM polynomial:
 //!   x^16 + x^12 + x^5 + 1 (0x1021)
 //! More details:
 //!   http://reveng.sourceforge.net/crc-catalogue/16.htm#crc.cat.crc-16-xmodem
 
 #include <stddef.h>
 #include <stdint.h>
 
-#define MEMFAULT_CRC16_CCITT_INITIAL_VALUE 0x0
+#define MEMFAULT_CRC16_INITIAL_VALUE 0x0
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-//! Computes the CRC16-CCITT value for the given sequence
+//! Computes the CRC-16/XMODEM value for the given sequence.
 //!
-//! The CRC is used in a wide spread of protocols (i.e HDLC, ISDN) and has a high probability of
-//! being able to detect errors when used like a checksum
-//!
-//! @param crc_initial_value Use MEMFAULT_CRC16_CCITT_INITIAL_VALUE when computing a new checksum
+//! @param crc_initial_value Use MEMFAULT_CRC16_INITIAL_VALUE when computing a new checksum
 //! over
 //!  the entire data set passed in. Use the current CRC16-CCITT value if computing over a data set
 //!  incrementally
 //! @param data The data to compute the crc over
 //! @param data_len_bytes the length of the data to compute the crc over, in bytes
-uint16_t memfault_crc16_ccitt_compute(uint16_t crc_initial_value, const void *data,
-                                      size_t data_len_bytes);
+uint16_t memfault_crc16_compute(uint16_t crc_initial_value, const void *data,
+                                size_t data_len_bytes);
 
 #ifdef __cplusplus
 }

components/include/memfault/version.h

@@ -20,8 +20,8 @@ typedef struct {
 } sMfltSdkVersion;
 
 #define MEMFAULT_SDK_VERSION \
-  { .major = 1, .minor = 19, .patch = 0 }
-#define MEMFAULT_SDK_VERSION_STR "1.19.0"
+  { .major = 1, .minor = 20, .patch = 0 }
+#define MEMFAULT_SDK_VERSION_STR "1.20.0"
 
 #ifdef __cplusplus
 }

components/panics/src/memfault_fault_handling_arm.c

@@ -382,7 +382,7 @@ MEMFAULT_NAKED_FUNC void MEMFAULT_EXC_HANDLER_WATCHDOG(void) {
                        "ldr r1, =%c0 \n"             \
                        "b memfault_fault_handler \n" \
                        :                             \
-                       : "i"((uint16_t)_x))
+                       : "i"((uint32_t)_x))
     #else
       #define MEMFAULT_HARDFAULT_HANDLING_ASM(_x)      \
         __asm volatile("mov r0, lr \n"                 \
@@ -403,7 +403,7 @@ MEMFAULT_NAKED_FUNC void MEMFAULT_EXC_HANDLER_WATCHDOG(void) {
                        "ldr r1, =%c0 \n"               \
                        "b memfault_fault_handler \n"   \
                        :                               \
-                       : "i"((uint16_t)_x))
+                       : "i"((uint32_t)_x))
     #endif
 
 MEMFAULT_NAKED_FUNC void MEMFAULT_EXC_HANDLER_HARD_FAULT(void) {

components/util/src/memfault_chunk_transport.c

@@ -24,7 +24,7 @@
 #include "memfault/core/compiler.h"
 #include "memfault/core/math.h"
 #include "memfault/util/chunk_transport.h"
-#include "memfault/util/crc16_ccitt.h"
+#include "memfault/util/crc16.h"
 #include "memfault/util/varint.h"
 
 typedef struct {
@@ -134,7 +134,7 @@ bool memfault_chunk_transport_get_next_chunk(sMfltChunkTransportCtx *ctx, void *
     uint8_t *msg_bufp = &chunk_msg[chunk_msg_start_offset];
     ctx->read_msg(ctx->read_offset, msg_bufp, bytes_to_read);
     ctx->crc16_incremental =
-      memfault_crc16_ccitt_compute(ctx->crc16_incremental, msg_bufp, bytes_to_read);
+      memfault_crc16_compute(ctx->crc16_incremental, msg_bufp, bytes_to_read);
     chunk_msg_start_offset += bytes_to_read;
   }
 
@@ -153,14 +153,17 @@ bool memfault_chunk_transport_get_next_chunk(sMfltChunkTransportCtx *ctx, void *
   if (buf_space_rem != 0) {
     // The encoded chunk consumes less space than the buffer provided. This can
     // happen when we reach the end of the underlying message being encoded
+    // before exhausting the provided buffer.
     //
-    // The Memfault backend allows for the last chunk in a message to exceed the
-    // size of the underlying message being sent. This can be useful for topologies
-    // that require sending chunks of a fixed size.
+    // Note: ONLY for cases where the message spans multiple chunks, the final
+    // chunk can be submitted to Memfault including the spare buffer space bytes
+    // (i.e. using a fixed payload size to Memfault), and the Memfault backend
+    // will discard the spare bytes. This is ONLY supported for multi-chunk
+    // messages; single-chunk messages must be submitted with the exact payload
+    // size as returned in *out_buf_len.
     //
-    // Scrub the remaining part of the buffer for this situation with a know pattern
-    // for debug purposes so it's easier to visually see the end of the chunk and to
-    // prevent unintentional data from being sent.
+    // Scrub the remaining part of the buffer for this situation with a known
+    // pattern for debug purposes.
     memset(&chunk_msg[bytes_written], 0xBA, buf_space_rem);
   }