Memfault Firmware SDK 1.2.0 (Build 3361)

Author: Memfault Inc

CHANGES.md

@@ -1,3 +1,20 @@
+### Changes between Memfault SDK 1.1.3 and 1.2.0 - Aug 30, 2023
+
+#### :chart_with_upwards_trend: Improvements
+
+- ESP-IDF:
+  - Eliminate several build warnings for our example app
+- FreeRTOS:
+  - Fix a build error in our QEMU example when building on macOS
+- nRF Connect SDK:
+  - Enable mcuboot & NCS 1.4 with our example apps
+- Silicon Labs:
+  - Add a demo CLI component for the emblib port. Check out our [Simplicity Studio example app](https://github.com/memfault/simplicity-studio-example) for usage
+  - Fix a build warning in emblib port flash storage (MSC) module
+- Zephyr:
+  - Fix a :bug: when building with LOG_MODE_DEFERRED that prevent log messages from flushing during a coredump
+  - Fix a :bug: 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.
+
 ### Changes between Memfault SDK 1.1.2 and 1.1.3 - Aug 8, 2023
 
 #### :chart_with_upwards_trend: Improvements

VERSION

@@ -1,2 +1,2 @@
-BUILD ID: 3171
-GIT COMMIT: cd928ad15
+BUILD ID: 3361
+GIT COMMIT: d427c1e05

components/include/memfault/version.h

@@ -19,8 +19,8 @@ typedef struct {
   uint8_t patch;
 } sMfltSdkVersion;
 
-#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 1, .patch = 3 }
-#define MEMFAULT_SDK_VERSION_STR "1.1.3"
+#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 2, .patch = 0 }
+#define MEMFAULT_SDK_VERSION_STR "1.2.0"
 
 #ifdef __cplusplus
 }

examples/esp32/apps/memfault_demo_app/main/console_example_main.c

@@ -47,7 +47,13 @@ static const char *TAG = "example";
 static void initialize_filesystem() {
   static wl_handle_t wl_handle;
   const esp_vfs_fat_mount_config_t mount_config = {.max_files = 4, .format_if_mount_failed = true};
-  esp_err_t err = esp_vfs_fat_spiflash_mount(MOUNT_PATH, "storage", &mount_config, &wl_handle);
+  esp_err_t err =
+  #if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 0, 0)
+    esp_vfs_fat_spiflash_mount_rw_wl
+  #else
+    esp_vfs_fat_spiflash_mount
+  #endif
+    (MOUNT_PATH, "storage", &mount_config, &wl_handle);
   if (err != ESP_OK) {
     ESP_LOGE(TAG, "Failed to mount FATFS (%s)", esp_err_to_name(err));
     return;
@@ -74,10 +80,17 @@ static void initialize_console() {
   setvbuf(stdin, NULL, _IONBF, 0);
   setvbuf(stdout, NULL, _IONBF, 0);
 
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 3, 0)
+  /* Minicom, screen, idf_monitor send CR when ENTER key is pressed */
+  esp_vfs_dev_uart_port_set_rx_line_endings(CONFIG_ESP_CONSOLE_UART_NUM, ESP_LINE_ENDINGS_CR);
+  /* Move the caret to the beginning of the next line on '\n' */
+  esp_vfs_dev_uart_port_set_tx_line_endings(CONFIG_ESP_CONSOLE_UART_NUM, ESP_LINE_ENDINGS_CRLF);
+#else
   /* Minicom, screen, idf_monitor send CR when ENTER key is pressed */
   esp_vfs_dev_uart_set_rx_line_endings(ESP_LINE_ENDINGS_CR);
   /* Move the caret to the beginning of the next line on '\n' */
   esp_vfs_dev_uart_set_tx_line_endings(ESP_LINE_ENDINGS_CRLF);
+#endif
 
   /* Install UART driver for interrupt-driven reads and writes */
   ESP_ERROR_CHECK(uart_driver_install(CONFIG_CONSOLE_UART_NUM, 256, 0, 0, NULL, 0));

examples/freertos/Makefile

@@ -4,6 +4,14 @@ MAKEFLAGS=--warn-undefined-variables
 # Default to a silent build. Run make with --trace for a verbose build.
 .SILENT:
 
+
+# Mac and Linux stat have different options required, set them up here
+ifeq ($(shell uname), Darwin)
+  STAT = "stat -f '%z'"
+else
+  STAT = "stat -c '%s'"
+endif
+
 BOARD ?= qemu_mps2_an385
 BOARD_DIR := boards/$(BOARD)
 
@@ -128,7 +136,7 @@ $(ELF).uncompressed: $(OBJS)
 $(ELF): $(ELF).uncompressed
 	echo -n 'Compressing debug info... '
 	$(OBJCOPY) --compress-debug-sections $^ $@
-	echo From $$(stat --printf="%s" $^) to $$(stat --printf="%s" $@) bytes
+	echo From $$("$(STAT)" $^) to $$("$(STAT)" $@) bytes
 
 -include $(OBJS:.o=.d)
 

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

@@ -36,6 +36,9 @@ CONFIG_SHELL_LOG_BACKEND=n
 CONFIG_LOG_MODE_IMMEDIATE=y
 # Enable DBG log level
 CONFIG_MEMFAULT_LOG_LEVEL_DBG=y
+# Disable logging of printk, to improve 'mflt export' performance under deferred
+# logging mode.
+CONFIG_LOG_PRINTK=n
 
 # Enable capture of recent logs as part of a coredump
 CONFIG_MEMFAULT_LOGGING_ENABLE=y

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

@@ -5,13 +5,17 @@
 //!
 //! Example console main
 
-#include <drivers/hwinfo.h>
-#include <logging/log.h>
+// clang-format off
+#include "memfault/ports/zephyr/include_compatibility.h"
+
+#include MEMFAULT_ZEPHYR_INCLUDE(drivers/hwinfo.h)
+#include MEMFAULT_ZEPHYR_INCLUDE(logging/log.h)
 #include <memfault/components.h>
 #include <memfault_ncs.h>
 #include <stdio.h>
 
 #include "memfault/ports/watchdog.h"
+// clang-format on
 
 LOG_MODULE_REGISTER(main, LOG_LEVEL_INF);
 

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

@@ -102,6 +102,15 @@ else() # nRF Connect SDK Version >= 1.8.0
   endif()
 endif()
 
+if (${NCS_VERSION_MAJOR}.${NCS_VERSION_MINOR}.${NCS_VERSION_PATCH} GREATER_EQUAL 2.4.0)
+  # In Zephyr v3.4 release, FLASH_MAP and STREAM_FLASH must be specified manually
+  #  https://github.com/zephyrproject-rtos/zephyr/commit/c3bfe7a6baf7e47d8ad70e38ffdea313f3ec62ce
+  #
+  # These are required for NCS >= 2.4
+  set(CONFIG_FLASH_MAP y CACHE INTERNAL "")
+  set(CONFIG_STREAM_FLASH y CACHE INTERNAL "")
+endif()
+
 # Required for app to compile against nRF Connect SDK <= v1.2
 # Must be included after updating Kconfig settings in CMake Cache above
 if(DEFINED ENV{MEMFAULT_INCLUDE_ZEPHYR_BOILERPLATE})

examples/nrf-connect-sdk/nrf9160/memfault_demo_app/README.md

@@ -12,18 +12,18 @@ https://goto.memfault.com/create-key/nrf91
 ## Compiling
 
 You can compile for any board supported by the nRF Connect SDK. For example,
-targetting the nRF52 PDK would look like:
+targeting the nRF91 PDK would look like:
 
 ```bash
 $ west init -l memfault_demo_app
 $ west update
 # Replace ${YOUR_PROJECT_KEY} with the Project Key from https://mflt.io/project-key
-$ west build -b nrf9160dk_nrf9160ns memfault_demo_app -- -DCONFIG_MEMFAULT_NCS_PROJECT_KEY=\"${YOUR_PROJECT_KEY}\"
+$ west build -b nrf9160dk_nrf9160_ns memfault_demo_app -- -DCONFIG_MEMFAULT_NCS_PROJECT_KEY=\"${YOUR_PROJECT_KEY}\"
 ...
 [181/181] Linking C executable zephyr/zephyr.elf
 ```
 
-Note that the board argument (`-b`) for the nRF9160DK has changed across releases -- if you are targetting nRF Connect SDK <= 1.6, use, `-b nrf9160_pca10090ns`
+Note that the board argument (`-b`) for the nRF9160DK has changed across releases -- if you are targeting nRF Connect SDK <= 1.6, use, `-b nrf9160_pca10090ns`. Also, you may want to target a version of the DK by passing `-b <board>@<revision>`, for example `[email protected]`, in order to use [specific hardware](https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/zephyr/boards/arm/nrf9160dk_nrf9160/doc/index.html#additional-hardware-in-v0-14-0).
 
 ## Testing the Integration
 

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

@@ -31,6 +31,10 @@ CONFIG_LOG_BACKEND_UART=y
 # Enable capture of recent logs as part of a coredump
 CONFIG_MEMFAULT_LOGGING_ENABLE=y
 
+# Disable logging of printk, to improve 'mflt export' performance under deferred
+# logging mode.
+CONFIG_LOG_PRINTK=n
+
 # Enable Bootloader so OTA updates can be performed
 CONFIG_BOOTLOADER_MCUBOOT=y
 CONFIG_MCUBOOT_IMG_MANAGER=y
@@ -42,6 +46,8 @@ CONFIG_DFU_TARGET_MCUBOOT=y
 CONFIG_IMG_MANAGER=y
 CONFIG_FLASH=y
 CONFIG_IMG_ERASE_PROGRESSIVELY=y
+# NB: CONFIG_FLASH_MAP=y & CONFIG_STREAM_FLASH=y are required for v2.4 and set dynamically in
+# ./CMakeLists.txt
 
 # For Memfault FOTA, we will use the FOTA_DOWNLOAD API's
 # from the nRF Connect SDK which depends on the DOWNLOAD_CLIENT