Memfault Firmware SDK 0.40.0 (Build 1523)

memfault · Feb 15, 2023 · fe20bf3 · fe20bf3
1 parent b315d88
commit fe20bf3
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 15 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,3 +1,14 @@
+### Changes between Memfault SDK 0.40.1 and SDK 0.39.1 - Feb 15, 2023
+
+#### :bomb: Breaking Changes
+
+- ESP-IDF:
+  - The Kconfig `CONFIG_MEMFAULT_AUTOMATIC_INIT` has been deprecated and is no
+    longer supported. Users of this Kconfig should refactor their application to
+    call `memfault_boot` during initialization. Use of this Kconfig now results
+    in a build error. For more information please see
+    https://docs.memfault.com/docs/mcu/esp32-guide#initializing-memfault
+
 ### Changes between Memfault SDK 0.39.1 and SDK 0.38.0 - Feb 3, 2023
 
 #### :rocket: New Features

diff --git a/VERSION b/VERSION
@@ -1,2 +1,2 @@
-BUILD ID: 1436
-GIT COMMIT: 38142ae37
+BUILD ID: 1523
+GIT COMMIT: e4c98a50b
diff --git a/components/include/memfault/version.h b/components/include/memfault/version.h
@@ -19,7 +19,7 @@ typedef struct {
   uint8_t patch;
 } sMfltSdkVersion;
 
-#define MEMFAULT_SDK_VERSION   { .major = 0, .minor = 39, .patch = 1 }
+#define MEMFAULT_SDK_VERSION   { .major = 0, .minor = 40, .patch = 0 }
 
 #ifdef __cplusplus
 }

diff --git a/ports/esp_idf/memfault/CMakeLists.txt b/ports/esp_idf/memfault/CMakeLists.txt
@@ -1,3 +1,12 @@
+if (CONFIG_MEMFAULT_AUTOMATIC_INIT)
+  message(FATAL_ERROR "CONFIG_MEMFAULT_AUTOMATIC_INIT has been deprecated.
+    Please complete the following steps:
+    1. Remove CONFIG_MEMFAULT_AUTOMATIC_INIT=y from sdkconfig.default if present
+    2. Delete your project's generated sdkconfig (be sure to save any in-progress changes)
+    3. Update your application to call memfault_boot during initialization
+    For more information please see https://docs.memfault.com/docs/mcu/esp32-guide")
+endif()
+
 set(MEMFAULT_SDK_ROOT ${CMAKE_CURRENT_LIST_DIR}/../../..)
 
 list(APPEND MEMFAULT_COMPONENTS core util panics demo http metrics)

diff --git a/ports/esp_idf/memfault/Kconfig b/ports/esp_idf/memfault/Kconfig
@@ -33,12 +33,12 @@ menu "Memfault"
             OTA slot can be used instead.
 
     config MEMFAULT_AUTOMATIC_INIT
-        bool "Automatically initialize the SDK when the system is booted"
-        default y
+        bool "[DEPRECATED] Automatically initialize the SDK when the system is booted"
+        default n
         help
-            By default, Memfault will automatically initialize the SDK
-            when the system is booted. This can be disabled if the user
-            wants to initialize the SDK manually.
+            By default, the user is required to initialize the SDK by calling
+            `memfault_boot`. This option is deprecated and not supported.
+            A build error will be generated when enabling this option.
 
     config MEMFAULT_HTTP_CLIENT_TIMEOUT_MS
         int "The HTTP client timeout in milliseconds"

diff --git a/ports/esp_idf/memfault/include/memfault/esp_port/core.h b/ports/esp_idf/memfault/include/memfault/esp_port/core.h
@@ -40,13 +40,7 @@ bool memfault_esp_port_data_available(void);
 //! @return true if the buffer was filled, false otherwise
 bool memfault_esp_port_get_chunk(void *buf, size_t *buf_len);
 
-//! Intializes the Memfault system, and should be called one time at boot.
-//!
-//! Note: by default this is called from the system initialization sequence-
-//! it's placed into the global constructor table during compilation, and
-//! executed by the esp-idf initialization code. Optionally it can instead be
-//! explictly called during application startup by setting
-//! 'CONFIG_MEMFAULT_AUTOMATIC_INIT=n' in the project Kconfig options.
+//! Intializes the Memfault system, and should be called one time by the application during boot.
 void memfault_boot(void);
 
 #ifdef __cplusplus