Memfault Firmware SDK 0.37.1 (Build 1184)

Author: Memfault Inc

CHANGES.md

@@ -1,3 +1,19 @@
+### Changes between Memfault SDK 0.37.1 and SDK 0.37.0 - Jan 17, 2023
+
+#### :chart_with_upwards_trend: Improvements
+
+- FreeRTOS
+  - Add support for collecting truncated TCBs. This is particularly useful with
+    limited coredump space. Enable by defining
+    `MEMFAULT_PLATFORM_FREERTOS_TCB_SIZE` in `memfault_platform_config.h".
+- ESP-IDF
+  - Add support for esp32s2/s3 platforms to the esp32 example application
+
+#### :house: Internal
+
+- Fixup some documentation typos/errors
+- Add support for Python 3.10
+
 ### Changes between Memfault SDK 0.37.0 and SDK 0.36.1 - Dec 16, 2022
 
 #### :chart_with_upwards_trend: Improvements

VERSION

@@ -1,2 +1,2 @@
-BUILD ID: 971
-GIT COMMIT: fdf6fee86
+BUILD ID: 1184
+GIT COMMIT: b60ef08d3

components/include/memfault/core/log.h

@@ -56,7 +56,7 @@ void memfault_log_set_min_save_level(eMemfaultPlatformLogLevel min_log_level);
 //! For example, if your platform already has something like this
 //!
 //! #define YOUR_PLATFORM_LOG_ERROR(...)
-//!   my_platform_log_error(__VA_ARGS__)
+//!   your_platform_log_error(__VA_ARGS__)
 //!
 //! the error data could be automatically recorded by making the
 //! following modification

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

@@ -21,24 +21,25 @@ typedef struct MemfaultDeviceInfo {
   //! Regular expression defining valid device serials: ^[-a-zA-Z0-9_]+$
   const char *device_serial;
 
-  //! The "Software Type" is used to identify the separate pieces of software running on a given device. This can be
-  //! images running on different MCUs (i.e "main-mcu-app" & "bluetooth-mcu") or different images running on the same
-  //! MCU (i.e "main-mcu-bootloader" & "main-mcu-app").
-  //! To learn more, check out the documentation: https://mflt.io/34PyNGQ
+  //! The "Software Type" is used to identify the separate pieces of software running on a given
+  //! device. This can be images running on different MCUs (i.e "main-mcu-app" & "bluetooth-mcu") or
+  //! different images running on the same MCU (i.e "main-mcu-bootloader" & "main-mcu-app"). To
+  //! learn more, check out the documentation: https://mflt.io/34PyNGQ
   const char *software_type;
 
   //! Version of the currently running software.
   //! We recommend using Semantic Version V2 strings.
   const char *software_version;
 
-  //! Hardware version (sometimes also called "board revision") that the software is currently running on.
-  //! Regular expression defining valid hardware versions: ^[-a-zA-Z0-9_\.\+]+$
+  //! Hardware version (sometimes also called "board revision") that the software is currently
+  //! running on. Regular expression defining valid hardware versions: ^[-a-zA-Z0-9_\.\+]+$
   const char *hardware_version;
 } sMemfaultDeviceInfo;
 
 //! Invoked by memfault library to query the device information
 //!
 //! It's expected the strings returned will be valid for the lifetime of the application
+//! @note This function must be safe to call from an interrupt
 void memfault_platform_get_device_info(sMemfaultDeviceInfo *info);
 
 //! Allows caller to get a pointer to a unique version string
@@ -52,7 +53,7 @@ void memfault_platform_get_device_info(sMemfaultDeviceInfo *info);
 //! @return System version with suffix or null on error. For example,
 //! if the input version is "1.0.0" and the build id is "123456....", the string
 //! returned will be "1.0.0+123456"
-const char *memfault_create_unique_version_string(const char * const version);
+const char *memfault_create_unique_version_string(const char *const version);
 
 //! Convenience function to get a pointer to a previously created version string.
 const char *memfault_get_unique_version_string(void);

components/include/memfault/core/serializer_key_ids.h

@@ -33,7 +33,7 @@ typedef enum {
 typedef enum {
   kMemfaultEventType_Heartbeat = 1,
   kMemfaultEventType_Trace = 2,
-  kMemfaultEventType_LogError = 3,
+  // Deprecated: kMemfaultEventType_LogError = 3, use trace_with_log feature instead
   kMemfaultEventType_Logs = 4,
   kMemfaultEventType_Cdr = 5,
 } eMemfaultEventType;

components/include/memfault/default_config.h

@@ -545,6 +545,17 @@ extern "C" {
 #define MEMFAULT_PLATFORM_COREDUMP_STORAGE_REGIONS_CUSTOM 0
 #endif
 
+//! Override the size of TCB memory to collect set by the FreeRTOS port. Default
+//! behavior is to collect the entire TCB structure. This option is useful when using
+//! FreeRTOS and coredump space is limited. In certain configurations, such as using
+//! configUSE_NEWLIB_REENTRANT, FreeRTOS TCBs contain extra fields that are not required when
+//! decoding coredumps. Using this option can free up coredump space for other memory regions if
+//! needed. If `MEMFAULT_PLATFORM_FREERTOS_TCB_SIZE` is set to 0, a default value for the TCB size
+//! is used. Please see ports/freertos/src/memfault_freertos_ram_regions.c for more info
+#ifndef MEMFAULT_PLATFORM_FREERTOS_TCB_SIZE
+  #define MEMFAULT_PLATFORM_FREERTOS_TCB_SIZE 0
+#endif
+
 #ifdef __cplusplus
 }
 #endif

components/include/memfault/version.h

@@ -19,7 +19,7 @@ typedef struct {
   uint8_t patch;
 } sMfltSdkVersion;
 
-#define MEMFAULT_SDK_VERSION   { .major = 0, .minor = 37, .patch = 0 }
+#define MEMFAULT_SDK_VERSION   { .major = 0, .minor = 37, .patch = 1 }
 
 #ifdef __cplusplus
 }

examples/esp32/apps/memfault_demo_app/.gitignore

@@ -1,3 +1,5 @@
+/dependencies.lock
+/managed_components/
 /sdkconfig
 /sdkconfig.extra
 /sdkconfig.old

examples/esp32/apps/memfault_demo_app/CMakeLists.txt

@@ -5,6 +5,16 @@ cmake_minimum_required(VERSION 3.5)
 set(PROJECT_NAME memfault-esp32-demo-app)
 set(CMAKE_PROJECT_NAME ${PROJECT_NAME})
 
+include($ENV{IDF_PATH}/tools/cmake/version.cmake OPTIONAL)
+
+# This contains the implementation for the led_strip driver. In ESP-IDF v5 it
+# moved to a "managed component" and no longer needs to be manually added.
+if(DEFINED IDF_VERSION_MAJOR)
+  if(IDF_VERSION_MAJOR VERSION_LESS 5)
+    set(EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/led_strip)
+  endif()
+endif()
+
 get_filename_component(memfault_firmare_sdk_dir ../../../../ ABSOLUTE)
 include(${memfault_firmare_sdk_dir}/ports/esp_idf/memfault.cmake)