Memfault Firmware SDK 1.23.0 (Build 13619)

Author: Memfault Inc

.clang-format

@@ -1,28 +1,24 @@
-# Please keep each property in alphabetical order to help compare between the other .clang-format
-# files.
-# This file is used by code editor formatting plugins
 ---
 BasedOnStyle: Google
----
-Language: Cpp
 
 AlignArrayOfStructures: None
 AllowShortBlocksOnASingleLine: Empty
 AllowShortFunctionsOnASingleLine: Empty
 AlwaysBreakBeforeMultilineStrings: false
 AttributeMacros:
-  - 'MEMFAULT_PACKED'
-  - 'MEMFAULT_PACKED_STRUCT'
-  - 'MEMFAULT_NORETURN'
-  - 'MEMFAULT_NAKED_FUNC'
-  - 'MEMFAULT_UNREACHABLE'
-  - 'MEMFAULT_NO_OPT'
-  - 'MEMFAULT_ALIGNED'
-  - 'MEMFAULT_UNUSED'
-  - 'MEMFAULT_USED'
-  - 'MEMFAULT_WEAK'
-  - 'MEMFAULT_PRINTF_LIKE_FUNC'
-  - 'MEMFAULT_PUT_IN_SECTION'
+  - MEMFAULT_ALIGNED
+  - MEMFAULT_NAKED_FUNC
+  - MEMFAULT_NO_ALLOC
+  - MEMFAULT_NO_OPT
+  - MEMFAULT_NORETURN
+  - MEMFAULT_PACKED
+  - MEMFAULT_PACKED_STRUCT
+  - MEMFAULT_PRINTF_LIKE_FUNC
+  - MEMFAULT_PUT_IN_SECTION
+  - MEMFAULT_UNREACHABLE
+  - MEMFAULT_UNUSED
+  - MEMFAULT_USED
+  - MEMFAULT_WEAK
 BitFieldColonSpacing: None
 BreakBeforeBinaryOperators: None
 BreakBeforeTernaryOperators: false
@@ -32,17 +28,16 @@ Cpp11BracedListStyle: false
 DerivePointerAlignment: false
 FixNamespaceComments: false
 ForEachMacros:
-  - 'MEMFAULT_SHELL_FOR_EACH_COMMAND'
+  - MEMFAULT_SHELL_FOR_EACH_COMMAND
 IndentPPDirectives: BeforeHash
 IndentWidth: 2
 NamespaceIndentation: All
 NamespaceMacros:
-  - 'TEST_GROUP'
-  - 'TEST'
+  - TEST
+  - TEST_GROUP
 PointerAlignment: Right
 SpaceInEmptyBlock: true
 WhitespaceSensitiveMacros:
-  - 'MEMFAULT_ZEPHYR_INCLUDE'
-  - 'MEMFAULT_QUOTE'
-  - 'Pragma'
-...
+  - MEMFAULT_QUOTE
+  - MEMFAULT_ZEPHYR_INCLUDE
+  - Pragma

.cyignore

@@ -18,6 +18,7 @@ ports/nxp
 ports/particle
 ports/qp
 ports/s32sdk
+ports/silabs
 ports/stm32cube
 ports/templates
 ports/zephyr

CHANGELOG.md

@@ -6,6 +6,89 @@ 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.23.0] - 2024-04-16
+
+### 📈 Added
+
+- General:
+
+  - Improved support for run time tracking on FreeRTOS kernel version v11 and
+    later, by adding compile-time checks for possible configuration issues.
+
+  - Add reboot reason decoding for the NXP RW61x chip series, using the
+    `PMU.SYS_RST_STATUS` register to determine the reset reason. Add the file at
+    [`ports/nxp/rw61x/pmu_reboot_tracking.c`](ports/nxp/rw61x/pmu_reboot_tracking.c)
+    to your project to make use of it!
+
+  - Add reboot reason decoding for the SiLabs SiWx91x chip series. This
+    implementation supports `Power On Reset`, `Pin Reset`, and `Software Reset`
+    causes only. Please [reach out](mflt.io/support) if you are interested in
+    other reset reasons. Add the file at
+    [`sdk/embedded/ports/silabs/wiseconnect/siwx91x/siwx91x_reboot_tracking.c`](ports/silabs/wiseconnect/siwx91x/siwx91x_reboot_tracking.c)
+    to your project to make use of it.
+
+  - Add an
+    [implementation of `memfault_reboot_reason_get()`](ports/stm32cube/h5/rcc_reboot_tracking.c)
+    for the STM32H5xx series of MCUs, using the `RCC-RSR` register to determine
+    the reset reason. Add the file to your project to make use of it!
+
+- ESP-IDF:
+
+  - Add 2 new out-of-box metrics:
+
+    - `spi_flash_chip_id` : the 24-bit RDID value of the SPI flash chip, for
+      example `"c84017"` = GigaDevice GD25Q64 8MiB
+    - `esp_chip_revision` : the ESP32 chip and revision, for example
+      `esp32c6-0.0` or `esp32s3-0.2`
+
+  - For ESP-IDF v5.5 and later, enable `-ggdb3` by default for enhanced
+    debugging. This is controlled with the Kconfig `CONFIG_MEMFAULT_GGDB3`.
+
+  - Set the User-Agent to `MemfaultSDK/<version>` when sending HTTP requests to
+    Memfault.
+
+### 🛠️ Changed
+
+- General:
+
+  - Updated the internally used `clang-format` version to 20.1.0, latest at time
+    of writing. This resulted in a few minor format changes in the SDK.
+
+- Zephyr:
+
+  - Update the [Zephyr QEMU example](examples/zephyr/qemu) to use the latest
+    Zephyr version, v4.1.0.
+
+- nRF-Connect SDK:
+
+  - Update the [nRF-Connect SDK examples](examples/nrf-connect-sdk) to use the
+    latest nRF-Connect SDK version, v2.9.1.
+
+  - Update the [nRF91 example](examples/nrf-connect-sdk/nrf9160) to enable the
+    `DATETIME` subsystem, to tag SDK event and log data with timestamps once the
+    network connection is activated.
+
+- ESP-IDF:
+
+  - Update the `prv_panic_safe_putstr()` implementation to perform better on
+    modern ESP-IDF versions (>=4.4.0). This function is used to output local
+    prints during panic handling.
+
+  - Add a Kconfig `CONFIG_MEMFAULT_DATA_CHUNK_HANDLERS_CUSTOM` to allow
+    overriding `memfault_esp_port_data_available()` and
+    `memfault_esp_port_get_chunk()`. If other MCUs are forwarding data to an
+    ESP32 for transport, enable this option and provide definitions to handle
+    additional sources. By default, these functions only check the local device
+    for available chunks.
+
+### 🐛 Fixed
+
+- ESP-IDF:
+
+  - Correctly print the initial delay and period in seconds for the periodic
+    upload task. Previously, this info log print was using the value in
+    milliseconds.
+
 ## [1.22.0] - 2025-03-19
 
 ### 📈 Added
@@ -45,20 +128,12 @@ and this project adheres to
   - Log lines that are only a single `'\n'` character are no longer recorded in
     the Memfault Log Buffer.
 
-### 🚩 Deprecated
-
-### 🔥 Removed
-
-### 🐛 Fixed
-
 - Zephyr:
 
   - The `hwinfo`-based Reset Reason implementation did not clear the reset
     reason register after reading the data. Updated to properly call
     `hwinfo_clear_reset_cause()` after reading the reset reason.
 
-### 🔒 Security
-
 ## [1.21.1] - 2025-03-07
 
 ### 🐛 Fixed
@@ -344,7 +419,7 @@ and this project adheres to
     //!   memory_main_pct_max, kMemfaultMetricType_Unsigned,
     //!   CONFIG_MEMFAULT_METRICS_THREADS_MEMORY_SCALE_FACTOR
     //! )
-    #include "memfault/ports/zephyr/thread_metrics.h"
+    #include "memfault/ports/freertos/thread_metrics.h"
     MEMFAULT_METRICS_DEFINE_THREAD_METRICS (
       // monitor the main thread stack usage
       {

VERSION

@@ -1,3 +1,3 @@
-BUILD ID: 13216
-GIT COMMIT: fd0102e4c8
-VERSION: 1.22.0
+BUILD ID: 13619
+GIT COMMIT: 5cd404d7f3
+VERSION: 1.23.0

components/core/README.md

@@ -15,7 +15,7 @@ firmware and hardware versions (with fallbacks to hard-coded values, i.e.
 `"xyz-main"` as software type `"1.0.0"` as software version and `"xyz-proto"` as
 hardware version).
 
-[To learn more about the concepts software type, software version, hardware version, etc. take a look at this documentation](https://mflt.io/36NGGgi).
+[To learn more about the concepts of software type, software version, hardware version, etc. take a look at this documentation](https://mflt.io/36NGGgi).
 
 Please change `memfault_platform_device_info.c` in ways that makes sense for
 your project.
@@ -41,12 +41,15 @@ your project.
 
 ### Storage allocations
 
-- `memfault_events_storage_boot()` to reserve storage for events.
+- `memfault_events_storage_boot()` to reserve storage for events (reboots, trace
+  events, heartbeats)
+
 - `memfault_reboot_tracking_boot()` points to a memory region that is not
   touched by any firmware except for reboot tracking API functions. Reboot info
   can be pushed to the event storage for packetization to be sent to Memfault.
 
-# `memfault_trace_event_boot()`: not an allocation but connects a trace event context into the event storage allocation.
+- _`memfault_trace_event_boot()`_ not an allocation but connects a trace event
+  context into the event storage allocation.
 
 - `memfault_log_boot()` to reserve storage for the logging module. The logging
   storage gets sent to Memfault as part of the core dump data if enabled.

components/core/src/memfault_ram_reboot_info_tracking.c

@@ -41,6 +41,8 @@
 MEMFAULT_STATIC_ASSERT(sizeof(sMfltRebootInfo) == MEMFAULT_REBOOT_TRACKING_REGION_SIZE,
                        "struct doesn't match expected size");
 
+MEMFAULT_STATIC_ASSERT(sizeof(sMfltRebootInfo) % 4 == 0, "struct size must be multiple of 4");
+
 MEMFAULT_STATIC_ASSERT(sizeof(eMemfaultRebootReason) <=
                          sizeof(((sMfltRebootInfo){ 0 }).last_reboot_reason),
                        "enum does not fit within sMfltRebootInfo.last_reboot_reason");

components/include/memfault/core/compact_log_helpers.h

@@ -251,11 +251,10 @@ extern "C" {
 
   //! The metadata we track in the ELF for each compact log in the code.
   //! This is used to recover the original information
-  #define MEMFAULT_LOG_FMT_ELF_SECTION_ENTRY(format, ...)                  \
-    MEMFAULT_LOG_FMT_ELF_SECTION                                           \
-    MEMFAULT_NO_ALLOC                                                      \
-    static const char _memfault_log_fmt_ptr[] = MEMFAULT_EXPAND_AND_QUOTE( \
-      MEMFAULT_ARG_COUNT_UP_TO_32(__VA_ARGS__)) ";" __FILE__               \
+  #define MEMFAULT_LOG_FMT_ELF_SECTION_ENTRY(format, ...)                                    \
+    MEMFAULT_LOG_FMT_ELF_SECTION                                                             \
+    MEMFAULT_NO_ALLOC static const char _memfault_log_fmt_ptr[] = MEMFAULT_EXPAND_AND_QUOTE( \
+      MEMFAULT_ARG_COUNT_UP_TO_32(__VA_ARGS__)) ";" __FILE__                                 \
                                                 ";" MEMFAULT_EXPAND_AND_QUOTE(__LINE__) ";" format
 
   #define MEMFAULT_LOG_FMT_ELF_SECTION_ENTRY_PTR ((uint32_t)(uintptr_t)&_memfault_log_fmt_ptr[0])

components/include/memfault/core/log.h

@@ -211,14 +211,14 @@ extern void memfault_log_handle_saved_callback(void);
 //! Formats the provided string and saves it to backing storage
 //!
 //! @note: Should only be called via MEMFAULT_LOG_SAVE macro
-MEMFAULT_PRINTF_LIKE_FUNC(2, 3)
-void memfault_log_save(eMemfaultPlatformLogLevel level, const char *fmt, ...);
+MEMFAULT_PRINTF_LIKE_FUNC(2, 3) void memfault_log_save(eMemfaultPlatformLogLevel level,
+                                                       const char *fmt, ...);
 
 //! Formats the provided string from a variable argument list
 //!
 //! @note Prefer saving logs via MEMFAULT_LOG_SAVE() when possible
-MEMFAULT_PRINTF_LIKE_FUNC(2, 0)
-void memfault_vlog_save(eMemfaultPlatformLogLevel level, const char *fmt, va_list args);
+MEMFAULT_PRINTF_LIKE_FUNC(2, 0) void memfault_vlog_save(eMemfaultPlatformLogLevel level,
+                                                        const char *fmt, va_list args);
 
 //! Freezes the contents of the log buffer in preparation of uploading the logs to Memfault.
 //!

components/include/memfault/core/math.h

@@ -18,7 +18,7 @@ extern "C" {
 #define MEMFAULT_MAX(a, b) (((a) > (b)) ? (a) : (b))
 #define MEMFAULT_FLOOR(a, align) (((a) / (align)) * (align))
 #define MEMFAULT_ABS(a) (((a) < 0) ? -(a) : (a))
-#define MEMFAULT_CEIL_DIV(x, y) (((x) + (y)-1) / (y))
+#define MEMFAULT_CEIL_DIV(x, y) (((x) + (y) - 1) / (y))
 
 #ifdef __cplusplus
 }

components/include/memfault/core/platform/debug_log.h

@@ -33,8 +33,8 @@ typedef enum {
 //! @note it's expected that the implementation will terminate the log with a newline
 //! @note Even if there is no UART or RTT Console, it's worth considering adding a logging
 //! implementation that writes to RAM or flash which allows for post-mortem analysis
-MEMFAULT_PRINTF_LIKE_FUNC(2, 3)
-void memfault_platform_log(eMemfaultPlatformLogLevel level, const char *fmt, ...);
+MEMFAULT_PRINTF_LIKE_FUNC(2, 3) void memfault_platform_log(eMemfaultPlatformLogLevel level,
+                                                           const char *fmt, ...);
 
 //! Routine for printing a log line as-is, only appending a newline, but without suffixing or
 //! appending timestamps, log level info, etc. This is used for debug console-commands where