Memfault Firmware SDK 0.33.1 (Build 503780)

Author: Memfault Inc

CHANGES.md

@@ -1,3 +1,33 @@
+### Changes between Memfault SDK 0.33.0 and SDK 0.33.1 - Aug 26, 2022
+
+#### :chart_with_upwards_trend: Improvements
+
+- Fix a :bug: in the heap stats component (#32), thanks @christophgreen for
+  reporting it!
+- Zephyr port updates:
+  - add support for the newly namespaced Zephyr include path in upcoming Zephyr
+    v3.2 (`#include <zephyr.h>` → `#include <zephyr/zephyr.h>`). The includes
+    were moved
+    [prior to v3.1](https://github.com/zephyrproject-rtos/zephyr/commit/53ef68d4598b2f9005c5da3fc0b860ca1999d350)
+    of Zephyr, but v3.2
+    [changes the backwards compatibility support to opt-in](https://github.com/zephyrproject-rtos/zephyr/commit/1ec0c6f5308937dc8e77acc2567d6f53cdd7a74e).
+    The Memfault SDK is now updated to support both.
+  - fix Zephyr Memfault log capture to have the correct prefix in the decoded
+    output when using LOG2 - previously all log lines regardless of level would
+    have an `E` prefix (regression introduced in Memfault SDK version 0.32.0)
+  - fix Zephyr Memfault log capture when in `CONFIG_LOG_MODE_IMMEDIATE` and
+    using LOG2 to capture the full log line instead of each logged character as
+    a separate line.
+
+#### :house: Internal
+
+- Zephyr port folder for `v2.x` migrated to `common`, now that Zephyr v1.14
+  support has been removed (done in v0.32.0 of the Memfault SDK)
+- Update README's for the example projects to match the new demo shell command
+  structure (`crash 1` → `test_hardfault`, etc).
+- Tidy up nrf9160 example app Kconfig setup
+- Fix parallel unit test invocation
+
 ### Changes between Memfault SDK 0.33.0 and SDK 0.32.2 - Aug 18, 2022
 
 #### :chart_with_upwards_trend: Improvements

VERSION

@@ -1,2 +1,2 @@
-BUILD ID: 497178
-GIT COMMIT: 3f51dc76a
+BUILD ID: 503780
+GIT COMMIT: ef36b85f7

components/core/src/memfault_heap_stats.c

@@ -93,7 +93,7 @@ void memfault_heap_stats_free(const void *ptr) {
 
     // if the pointer exists in the tracked stats, mark it as freed
     for (size_t i = 0; i < MEMFAULT_ARRAY_SIZE(g_memfault_heap_stats_pool); i++) {
-      if (g_memfault_heap_stats_pool[i].ptr == ptr) {
+      if ((g_memfault_heap_stats_pool[i].ptr == ptr) && g_memfault_heap_stats_pool[i].info.in_use) {
         g_memfault_heap_stats_pool[i].info.in_use = 0;
         break;
       }

components/demo/src/memfault_demo_shell.c

@@ -145,8 +145,9 @@ static bool prv_should_ignore_eol_char(char c) {
   }
 
   //
-  // First end of line character detected. We will use this character as our EOL delimiter and
-  // ignore the opposite character when we see it in the future.
+  // Check to see if we have encountered our first newline character since the shell was booted
+  // (either a CR ('\r') or LF ('\n')). Once found, we will use this character as our EOL delimiter
+  // and ignore the opposite character if we see it in the future.
   //
 
   if (c == '\r') {

components/include/memfault/version.h

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

examples/mbed/README.md

@@ -122,11 +122,11 @@ is used as serial number. You can change this to match your requirements (see
 
 ### Causing a crash
 
-Command `crash 1` will trigger a hard fault due to a bad instruction fetch at a
+Command `test_hardfault` will trigger a hard fault due to a bad instruction fetch at a
 non-existing address, `0xbadcafe`.
 
 ```
-mflt> crash 1
+mflt> test_hardfault
 ... etc ...
 ```
 

examples/nrf-connect-sdk/nrf5/README.md

@@ -34,27 +34,44 @@ The console has several Memfault test commands available:
 
 ```bash
 uart:~$ mflt help
-mflt - Memfault Test Commands
 Subcommands:
-  reboot              :trigger a reboot and record it using memfault
-  get_core            :gets the core
-  clear_core          :clear the core
-  crash               :trigger a crash
-  test_log            :Writes test logs to log buffer
-  trigger_logs        :Trigger capture of current log buffer contents
-  hang                :trigger a hang to test watchdog functionality
+  clear_core          :clear coredump collected
   export              :dump chunks collected by Memfault SDK using
                        https://mflt.io/chunk-data-export
-  trace               :Capture an example trace event
+  get_core            :check if coredump is stored and present
   get_device_info     :display device information
+  get_latest_release  :checks to see if new ota payload is available
+  post_chunks         :Post Memfault data to cloud
+  test                :commands to verify memfault data collection
+                       (https://mflt.io/mcu-test-commands)
   post_chunks         :Post Memfault data to cloud
-  trigger_heartbeat   :Trigger an immediate capture of all heartbeat metrics
   get_latest_release  :checks to see if new ota payload is available
 ```
 
+The `mflt test` subgroup contains commands for testing Memfault functionality:
+
+```bash
+uart:~$ mflt test help
+test - commands to verify memfault data collection
+       (https://mflt.io/mcu-test-commands)
+Subcommands:
+  assert       :trigger memfault assert
+  busfault     :trigger a busfault
+  hang         :trigger a hang
+  hardfault    :trigger a hardfault
+  memmanage    :trigger a memory management fault
+  usagefault   :trigger a usage fault
+  zassert      :trigger a zephyr assert
+  reboot       :trigger a reboot and record it using memfault
+  heartbeat    :trigger an immediate capture of all heartbeat metrics
+  log_capture  :trigger capture of current log buffer contents
+  logs         :writes test logs to log buffer
+  trace        :capture an example trace event
+```
+
 For example, to test the coredump functionality:
 
-1. run `mflt crash` and wait for the board to reset
+1. run `mflt test hardfault` and wait for the board to reset
 2. run `mflt get_core` to confirm the coredump was saved
 3. run `mflt export` to print out the base-64 chunks:
 

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

@@ -6,12 +6,6 @@ if(DEFINED ENV{MEMFAULT_ZEPHYR_EXTRA_MODULE_INCLUDE})
   list(APPEND ZEPHYR_EXTRA_MODULES $ENV{ZEPHYR_BASE}/../modules/memfault-firmware-sdk/ports)
 endif()
 
-# Required for app to compile against nRF Connect SDK <= v1.2
-if(DEFINED ENV{MEMFAULT_INCLUDE_ZEPHYR_BOILERPLATE})
-  include($ENV{ZEPHYR_BASE}/cmake/app/boilerplate.cmake NO_POLICY_SCOPE)
-  include($ENV{ZEPHYR_BASE}/../nrf/cmake/boilerplate.cmake)
-endif()
-
 # Starting in nRF Connect SDK >= 1.3, versions are exposed in
 # a CMake package:
 #   https://github.com/nrfconnect/sdk-nrf/blob/master/share/ncs-package/cmake/NcsConfig.cmake
@@ -20,65 +14,93 @@ endif()
 # which is not something that can be achieved with Zephyr today
 find_package(Ncs HINTS $ENV{ZEPHYR_BASE}/../nrf)
 
-# Conditionally set Kconfig variables based on nRF Connect SDK version
+if (NOT NCS_VERSION_MAJOR)
+  # Note: If we cannot resolve the NCS version, assume we are using 1.2.x which is the oldest
+  # version Memfault has been tested against
+  set(NCS_VERSION_MAJOR 1)
+  set(NCS_VERSION_MINOR 2)
+  set(NCS_VERSION_PATCH 0)
+endif()
+
+# Below we conditionally set Kconfig variables based on nRF Connect SDK version
 # (since setting non-existent variables result in a build time error which
 # would break compiling older builds)
 #
 # Zephyrs Kconfig extension pulls variables via the "CMake variable cache"
 # so we set the ones we need here using that:
-#   https://docs.zephyrproject.org/latest/guides/build/kconfig/setting.html#the-initial-configuration
-if (NCS_VERSION_MAJOR)
-  if (${NCS_VERSION_MAJOR} LESS_EQUAL 1 AND ${NCS_VERSION_MINOR} LESS 5 )
-    # Legacy name for CONFIG_DEBUG_THREAD_INFO needed for nRF Connect version <= 1.5
-    # due to the version of Zephyr included (pre v2.5)
-    set(CONFIG_OPENOCD_SUPPORT n CACHE INTERNAL "")
-  elseif (${NCS_VERSION_MAJOR} LESS_EQUAL 1 AND ${NCS_VERSION_MINOR} LESS 6 )
-    # Required for logging to work from crash, deprecated in Zephyr included in NCS 1.6
-    set(CONFIG_LOG_IMMEDIATE y CACHE INTERNAL "")
-  elseif (${NCS_VERSION_MAJOR} LESS_EQUAL 1 AND ${NCS_VERSION_MINOR} GREATER_EQUAL 6 )
-    set(CONFIG_MEMFAULT_NCS_PROVISION_CERTIFICATES n CACHE INTERNAL "")
-    set(CONFIG_MEMFAULT_NCS_DEVICE_ID_RUNTIME y CACHE INTERNAL "")
-
-    set(CONFIG_NEWLIB_LIBC y CACHE INTERNAL "")
-  endif()
+#   https://docs.zephyrproject.org/latest/build/kconfig/setting.html#the-initial-configuration
+
+if (${NCS_VERSION_MAJOR}.${NCS_VERSION_MINOR}.${NCS_VERSION_PATCH} VERSION_LESS 1.3)
+else() # nRF Connect SDK Version >= 1.3.0
+  # We cannot set for NCS <= 1.2 because on older versions of zephyr the argument was not
+  # directly user-configurable (no prompt in Kconfig)
+  set(CONFIG_SHELL_LOG_BACKEND n CACHE INTERNAL "")
+endif()
 
+if (${NCS_VERSION_MAJOR}.${NCS_VERSION_MINOR}.${NCS_VERSION_PATCH} VERSION_LESS 1.5)
+  # Legacy name for CONFIG_DEBUG_THREAD_INFO needed for nRF Connect version <= 1.5
+  # due to the version of Zephyr included (pre v2.5)
+  set(CONFIG_OPENOCD_SUPPORT y CACHE INTERNAL "")
+else() # nRF Connect SDK Version >= 1.5.0
   # Enable Memfault FOTA Support
   #
-  # We enable conditionally because prior to NCS < 1.4 a small patch (https://mflt.io/nrf-fota) was
+  # We enable conditionally because prior to NCS < 1.5 a small patch (https://mflt.io/nrf-fota) was
   # needed in order for things to work
-  if (${NCS_VERSION_MAJOR}.${NCS_VERSION_MINOR}.${NCS_VERSION_PATCH} GREATER_EQUAL 1.5.0)
-    set(CONFIG_MEMFAULT_FOTA y CACHE INTERNAL "")
-    set(CONFIG_DOWNLOAD_CLIENT_MAX_FILENAME_SIZE 400 CACHE INTERNAL "")
-    set(CONFIG_DOWNLOAD_CLIENT_STACK_SIZE 1600 CACHE INTERNAL "")
-
-    # Note: Can optionally be changed to =y to implement
-    # a custom event handler for FOTA events
-    # CONFIG_MEMFAULT_FOTA_DOWNLOAD_CALLBACK_CUSTOM=n
+  set(CONFIG_MEMFAULT_FOTA y CACHE INTERNAL "")
+  set(CONFIG_DOWNLOAD_CLIENT_MAX_FILENAME_SIZE 400 CACHE INTERNAL "")
+  set(CONFIG_DOWNLOAD_CLIENT_STACK_SIZE 1600 CACHE INTERNAL "")
+
+  # Note: Can optionally be changed to =y to implement
+  # a custom event handler for FOTA events
+  # CONFIG_MEMFAULT_FOTA_DOWNLOAD_CALLBACK_CUSTOM=n
+endif()
+
+
+if (${NCS_VERSION_MAJOR}.${NCS_VERSION_MINOR}.${NCS_VERSION_PATCH} VERSION_LESS 1.6.0)
+  # Required for logging to work from crash but deprecated in Zephyr included in NCS 1.6
+  set(CONFIG_LOG_IMMEDIATE y CACHE INTERNAL "")
+
+  # NCS 1.6 was the first one which introduced setting the project key via
+  # Kconfig. Look for this argument and remap to a regular compiler definition
+  # that gets picked up in memfault_demo_app/src/main.c
+  if (CONFIG_MEMFAULT_NCS_PROJECT_KEY)
+    add_compile_definitions(MEMFAULT_NCS_PROJECT_KEY=${CONFIG_MEMFAULT_NCS_PROJECT_KEY})
+    unset(CONFIG_MEMFAULT_NCS_PROJECT_KEY CACHE)
   endif()
+else() # nRF Connect SDK Version >= 1.6.0
+  set(CONFIG_MEMFAULT_NCS_PROVISION_CERTIFICATES n CACHE INTERNAL "")
+  set(CONFIG_MEMFAULT_NCS_DEVICE_ID_RUNTIME y CACHE INTERNAL "")
+  set(CONFIG_NEWLIB_LIBC y CACHE INTERNAL "")
+endif()
 
+if (${NCS_VERSION_MAJOR}.${NCS_VERSION_MINOR}.${NCS_VERSION_PATCH} VERSION_LESS 1.7.99)
   # These were removed in NCS 1.8.0, but are needed prior to that. Enable them
   # if NCS version <1.7.99 (.99 patch version is used for the next revision's
   # development series)
-  if (${NCS_VERSION_MAJOR}.${NCS_VERSION_MINOR}.${NCS_VERSION_PATCH} VERSION_LESS 1.7.99)
-    set(CONFIG_BSD_LIBRARY y CACHE INTERNAL "")
-    set(CONFIG_BSD_LIBRARY_SYS_INIT n CACHE INTERNAL "")
-    # ^ Note: CONFIG_BSD_ were renamed to _NRF_MODEM_ in
-    # nRF Connect SDK v1.5. We use the legacy names for now
-    # so this app can continue to compile on older targets
-    #
-    # CONFIG_NRF_MODEM_LIB
-    # CONFIG_NRF_MODEM_LIB_SYS_INIT
-
-    # For nRF Connect SDK v1.5 default value changed here
-    set(CONFIG_AT_CMD_SYS_INIT n CACHE INTERNAL "")
-  else() # nRF Connect SDK Version >= 1.8.0
-    # in v1.8+, use the modem_info library to get the IMEI for device_serial
-    set(CONFIG_MEMFAULT_NCS_DEVICE_ID_RUNTIME y CACHE INTERNAL "")
-    set(CONFIG_MODEM_INFO y CACHE INTERNAL "")
-
-    # Use SPM instead of TFM for Secure Firmware as TFM does not (yet) support forwarding of fault handlers
-    set(CONFIG_BUILD_WITH_TFM n CACHE INTERNAL "")
-  endif()
+  set(CONFIG_BSD_LIBRARY y CACHE INTERNAL "")
+  set(CONFIG_BSD_LIBRARY_SYS_INIT n CACHE INTERNAL "")
+  # ^ Note: CONFIG_BSD_ were renamed to _NRF_MODEM_ in
+  # nRF Connect SDK v1.5. We use the legacy names here
+  # so the app can continue to compile on older targets
+  #
+  # CONFIG_NRF_MODEM_LIB
+  # CONFIG_NRF_MODEM_LIB_SYS_INIT
+
+  # For nRF Connect SDK v1.5 default value changed here
+  set(CONFIG_AT_CMD_SYS_INIT n CACHE INTERNAL "")
+else() # nRF Connect SDK Version >= 1.8.0
+  # in v1.8+, use the modem_info library to get the IMEI for device_serial
+  set(CONFIG_MODEM_INFO y CACHE INTERNAL "")
+
+  # Use SPM instead of TFM for Secure Firmware as TFM does not (yet) support forwarding of fault handlers
+  set(CONFIG_BUILD_WITH_TFM n 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})
+  include($ENV{ZEPHYR_BASE}/cmake/app/boilerplate.cmake NO_POLICY_SCOPE)
+  include($ENV{ZEPHYR_BASE}/../nrf/cmake/boilerplate.cmake)
 endif()
 
 find_package(Zephyr HINTS $ENV{ZEPHYR_BASE})

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

@@ -27,9 +27,6 @@ CONFIG_MEMFAULT_HTTP_PERIODIC_UPLOAD=y
 # Required for logging backends to work as expected
 CONFIG_LOG=y
 CONFIG_LOG_BACKEND_UART=y
-# Disable the shell log backend. Rely on the configured backend instead (RTT,
-# UART, etc.)
-CONFIG_SHELL_LOG_BACKEND=n
 
 # Enable capture of recent logs as part of a coredump
 CONFIG_MEMFAULT_LOGGING_ENABLE=y

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

@@ -95,8 +95,12 @@ static char s_device_serial[IMEI_LEN + 1 /* '\0' */] = "unknown";
 
 static char s_fw_version[16] = "1.0.0-dev";
 
+#ifndef MEMFAULT_NCS_PROJECT_KEY
+#define MEMFAULT_NCS_PROJECT_KEY "<YOUR PROJECT KEY HERE>"
+#endif
+
 sMfltHttpClientConfig g_mflt_http_client_config = {
-  .api_key = "<YOUR PROJECT KEY HERE>",
+  .api_key = MEMFAULT_NCS_PROJECT_KEY,
 };
 
 void memfault_platform_get_device_info(sMemfaultDeviceInfo *info) {