Memfault Firmware SDK 1.0.0 (Build 2329)

Author: Memfault Inc

CHANGES.md

@@ -1,3 +1,27 @@
+### Changes between Memfault SDK 1.0.0 and 0.43.3 - June 1, 2023
+
+🎉🎉🎉
+
+The Memfault Firmware SDK is now version `1.0.0` as of this release! Note that
+this is just a procedural change, there are no breaking backwards-incompatible
+changes in this release. We forgot to update our major version back in 2019, but
+better late than never 😅! Hopefully the remaining 281,474,976,710,656 versions
+are enough 🤞.
+
+🎉🎉🎉
+
+#### :chart_with_upwards_trend: Improvements
+
+- Zephyr:
+
+  - Add a new built-in metric `FileSystem_BytesFree` for tracking VFS bytes
+    free. This is enabled automatically when `CONFIG_FILE_SYSTEM=y`. Use the
+    Kconfig option `MEMFAULT_FS_BYTES_FREE_VFS_PATH` to set the VFS mount point
+    to monitor utilization (default value is `/lfs1`). The Kconfig option
+    `MEMFAULT_FS_BYTES_FREE_METRIC` can be used to disable the metric.
+  - Update a few spots in the Zephyr demo CLI to use `shell_print` instead of
+    `MEMFAULT_LOG` for command usage errors
+
 ### Changes between Memfault SDK 0.43.3 and 0.43.2 - May 22, 2023
 
 #### :chart_with_upwards_trend: Improvements

VERSION

@@ -1,2 +1,2 @@
-BUILD ID: 2200
-GIT COMMIT: dd058e1ee
+BUILD ID: 2329
+GIT COMMIT: 03cc59b56

components/include/memfault/version.h

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

examples/nrf-connect-sdk/nrf9160/memfault_demo_app/boards/nrf9160dk_nrf9160_ns_0_14_0.overlay

@@ -0,0 +1,19 @@
+/* Device Tree overlay to enable auto-mounting littlefs in an internal
+   partition, via the Nordic Partition Manager system */
+
+/ {
+	fstab {
+		compatible = "zephyr,fstab";
+		lfs1: lfs1 {
+			compatible = "zephyr,fstab,littlefs";
+			mount-point = "/lfs1";
+			partition = <&storage_partition>;
+			automount;
+			read-size = <16>;
+			prog-size = <16>;
+			cache-size = <64>;
+			lookahead-size = <32>;
+			block-cycles = <512>;
+		};
+	};
+};

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

@@ -62,6 +62,11 @@ CONFIG_WATCHDOG=y
 # Enable Zephyr runtime asserts
 CONFIG_ASSERT=y
 
+# Enable littlefs on intern al flash, to demo the file system utilization metric
+CONFIG_FILE_SYSTEM=y
+CONFIG_FILE_SYSTEM_LITTLEFS=y
+CONFIG_FILE_SYSTEM_SHELL=y
+
 # Note: See ./CMakeLists.txt for additional Kconfig variables settings as not all variables can be
 # set in a single prj.conf for backward compatibility with older versions of the nRF Connect SDK /
 # Zephyr

ports/zephyr/Kconfig

@@ -324,6 +324,19 @@ config MEMFAULT_METRICS_DEFAULT_SET_ENABLE
         metrics collected, see ports/zephyr/config/memfault_metrics_heartbeat_zephyr_port_config.def
         When disabled, no default metrics will be collected.
 
+config MEMFAULT_FS_BYTES_FREE_METRIC
+        bool "Enable collection of a metric for the amount of free space on the filesystem"
+        default y
+        depends on FILE_SYSTEM
+
+config MEMFAULT_FS_BYTES_FREE_VFS_PATH
+        string "Path to the mount point to collect free space metrics for"
+        default "lfs1"
+        depends on FILE_SYSTEM && MEMFAULT_FS_BYTES_FREE_METRIC
+        help
+         The path to the virtual filesystem mount point to collect free space
+         metrics for, omitting the leading '/'.
+
 endif # MEMFAULT_METRICS
 
 config MEMFAULT_SOFTWARE_WATCHDOG_CUSTOM

ports/zephyr/common/memfault_demo_cli.c

@@ -149,7 +149,7 @@ static int prv_memfault_assert_example(const struct shell *shell, size_t argc, c
 
 static int prv_hang_example(const struct shell *shell, size_t argc, char **argv) {
 #if !CONFIG_WATCHDOG
-  MEMFAULT_LOG_WARN("No watchdog configured, this will hang forever");
+  shell_print(shell, "No watchdog configured, this will hang forever");
 #else
   MEMFAULT_LOG_DEBUG("Hanging system and waiting for watchdog!");
 #endif
@@ -188,7 +188,7 @@ static int prv_memmanage_example(const struct shell *shell, size_t argc, char **
 
 static int prv_zephyr_assert_example(const struct shell *shell, size_t argc, char **argv) {
 #if !CONFIG_ASSERT
-  MEMFAULT_LOG_WARN("CONFIG_ASSERT was disabled in the build, this command will have no effect");
+  shell_print(shell, "CONFIG_ASSERT was disabled in the build, this command will have no effect");
 #endif
   __ASSERT(0, "test assert");
   return 0;
@@ -204,7 +204,8 @@ static int prv_cli_cmd_double_free(const struct shell *shell, size_t argc, char
   (void)argv;
 
 #if !CONFIG_MEMFAULT_HEAP_STATS
-  MEMFAULT_LOG_WARN(
+  shell_print(
+    shell,
     "CONFIG_MEMFAULT_HEAP_STATS was disabled in the build, this command will have no effect");
 #else
   uint8_t *ptr = k_malloc(100);

ports/zephyr/common/memfault_platform_metrics.c

@@ -10,6 +10,10 @@
 #include "memfault/metrics/platform/timer.h"
 #include "memfault/ports/zephyr/version.h"
 
+#if CONFIG_MEMFAULT_FS_BYTES_FREE_METRIC
+#include <fs/fs.h>
+#endif
+
 static MemfaultPlatformTimerCallback *s_metrics_timer_callback;
 
 #if CONFIG_SYS_HEAP_RUNTIME_STATS
@@ -80,6 +84,19 @@ void memfault_metrics_heartbeat_collect_sdk_data(void) {
   memfault_metrics_heartbeat_set_unsigned(MEMFAULT_METRICS_KEY(Heap_BytesFree), stats.free_bytes);
 #endif /* defined(CONFIG_SYS_HEAP_RUNTIME_STATS) */
 
+#if CONFIG_MEMFAULT_FS_BYTES_FREE_METRIC
+  {
+    struct fs_statvfs fs_stats;
+    int retval = fs_statvfs("/" CONFIG_MEMFAULT_FS_BYTES_FREE_VFS_PATH, &fs_stats);
+    if (retval == 0) {
+      // compute free bytes
+      uint32_t bytes_free = fs_stats.f_frsize * fs_stats.f_bfree;
+      memfault_metrics_heartbeat_set_unsigned(MEMFAULT_METRICS_KEY(FileSystem_BytesFree),
+                                              bytes_free);
+    }
+  }
+#endif /* CONFIG_MEMFAULT_FS_BYTES_FREE_METRIC */
+
 #endif /* CONFIG_MEMFAULT_METRICS_DEFAULT_SET_ENABLE */
 }
 

ports/zephyr/config/memfault_metrics_heartbeat_zephyr_port_config.def

@@ -18,8 +18,12 @@ MEMFAULT_METRICS_KEY_DEFINE(AllTasksCpuUsage, kMemfaultMetricType_Unsigned)
 MEMFAULT_METRICS_KEY_DEFINE(Heap_BytesFree, kMemfaultMetricType_Unsigned)
 #endif
 
+#if CONFIG_MEMFAULT_FS_BYTES_FREE_METRIC
+MEMFAULT_METRICS_KEY_DEFINE(FileSystem_BytesFree, kMemfaultMetricType_Unsigned)
 #endif
 
+#endif  /* CONFIG_MEMFAULT_METRICS_DEFAULT_SET_ENABLE */
+
 #if CONFIG_MEMFAULT_METRICS_EXTRA_DEFS_FILE
 #include "memfault_metrics_heartbeat_extra.def"
 #endif