Memfault Firmware SDK 1.5.0 (Build 4793)

Author: Memfault Inc

CHANGELOG.md

@@ -1,5 +1,124 @@
 # Memfault Firmware SDK Changelog
 
+## [1.5.0] - 2023-11-29
+
+### :rocket: New Features
+
+- General:
+
+  - Added support for Session Metrics. These are similar to Heartbeat Metrics,
+    except they are set on an arbitrary session interval (not required to be
+    aligned to Heartbeat interval). Session metrics are useful for tracking
+    device operation sessions- for example, measuring properties for a BLE
+    connected stove top during a single cooking session. Session metrics
+    automatically include a "session duration" timer metric.
+
+    Session metrics must be defined using the new session-specific APIs, but are
+    set using the same `MEMFAULT_METRIC_SET_*` APIs as Heartbeat metrics.
+
+    See the
+    [`metrics.h` header file](components/include/memfault/metrics/metrics.h) for
+    usage details.
+
+  - New built in metrics for measuring the following properties:
+
+    - **crash-free hours**: enabled by default, generates `operational_hours`
+      and `operational_crashfree_hours` metrics, which are automatically
+      processed by Memfault
+
+    - **battery drop**: enabled with `#define MEMFAULT_METRICS_BATTERY_ENABLE 1`
+      in `memfault_platform_config.h`. See more information in the
+      [header file](components/include/memfault/metrics/battery.h) for how to
+      use the metric.
+
+    - **connectivity**: enabled with
+      `MEMFAULT_METRICS_SYNC_SUCCESS`/`MEMFAULT_METRICS_MEMFAULT_SYNC_SUCCESS`/`MEMFAULT_METRICS_CONNECTIVITY_CONNECTED_TIME`.
+      See more information in the
+      [header file](components/include/memfault/metrics/connectivity.h) for how
+      to use the metric.
+
+    These metrics are considered first-class metrics by Memfault, are exempt
+    from quota limits, and are automatically processed by Memfault.
+
+- Zephyr:
+
+  - By default, set the `sync_memfault_successful`/`sync_memfault_failure`
+    metrics for devices using Memfault's Zephyr HTTP chunk upload functionality.
+    This feature is controlled with the `CONFIG_MEMFAULT_SYNC_MEMFAULT_METRICS`
+    Kconfig flag.
+
+  - Automatically set captured timestamps for events for devices that either
+    implement the RTC subsystem, or use the Nordic `date_time` library. The
+    appropriate option is enabled by default based on which features are
+    available, and can be controlled with the Kconfig flags:
+    `CONFIG_MEMFAULT_SYSTEM_TIME_SOURCE_DATETIME` or
+    `CONFIG_MEMFAULT_SYSTEM_TIME_SOURCE_RTC`.
+
+- ESP-IDF:
+
+  - By default, set the `sync_memfault_successful`/`sync_memfault_failure`
+    metrics for devices using Memfault's ESP-IDF HTTP chunk upload
+    functionality. This feature is controlled with the
+    `CONFIG_MEMFAULT_SYNC_MEMFAULT_METRICS` Kconfig flag.
+
+### :chart_with_upwards_trend: Improvements
+
+- General:
+
+  - Add the ability to extend the Memfault Demo Shell command table with custom
+    commands. This is used in the [`examples/freertos`](examples/freertos) demo
+    project to add 2 new commands:
+
+    - `freertos_tasks` : print FreeRTOS task information, via `vTaskList()`
+    - `freertos_vassert` : trigger a `vAssertCalled` FreeRTOS assert, via
+      `configASSERT()`
+
+    The Shell extension API is documented in
+    [`components/include/memfault/demo/shell_commands.h`](components/include/memfault/demo/shell_commands.h),
+    and must be enabled by setting
+    `#define MEMFAULT_DEMO_SHELL_COMMAND_EXTENSIONS 1` in
+    `memfault_platform_config.h`.
+
+- Zephyr:
+
+  - Remove a warning in Zephyr 3.5+ where the `zephyr/random/rand32.h` header
+    was renamed to `zephyr/random/random.h`. This was reported in
+    [#66](https://github.com/memfault/memfault-firmware-sdk/issues/66)- thanks
+    to @nordicjm for reporting this!
+
+  - Add test commands for exercising Secure Faults in ARM TrustZone-enabled
+    chips:
+
+    - `mflt test badptr`
+    - `mflt test isr_badptr`
+
+    Note that non-TrustZone chips may not trigger a fault when running those
+    commands.
+
+- nRF-Connect SDK:
+
+  - Add the `CONFIG_AT_SHELL` setting to the
+    [`examples/nrf-connect-sdk/nrf9160`](nrf-connect-sdk/nrf9160) sample app.
+    This permits sending raw AT commands, useful for testing.
+
+  - Specific to nRF-Connect based apps using FOTA, add a warning if
+    `CONFIG_DOWNLOAD_CLIENT_HTTP_FRAG_SIZE > 1024`, which can sporadically error
+    out on nRF9160 devices (there is a limitation in the modem, see
+    `CONFIG_DOWNLOAD_CLIENT_HTTP_FRAG_SIZE_2048=y`) and DevZone note
+    [here](https://devzone.nordicsemi.com/f/nordic-q-a/68601/tls-2303-bytes-packet-limit/281107).
+
+  - Improve FOTA support for nRF-Connect SDK 2.4+, by improving the technique
+    used to find the correct Memfault server root cert. Memfault uses a fast CDN
+    to improve OTA payload delivery, which uses a different root cert than the
+    Memfault device server. Please contact [email protected] immediately if
+    you encounter any cert-related issues.
+
+### :boom: Breaking Changes
+
+- The metrics convenience API added in v1.4.3 (`MEMFAULT_HEARTBEAT_SET_*` and
+  others) have been renamed to `MEMFAULT_METRIC_SET_*`, to better support the
+  new Session Metric feature.
+
 ## [1.4.4] - 2023-11-13
 
 ### :chart_with_upwards_trend: Improvements
@@ -19,7 +138,7 @@
     with `0` bytes loaded into the output buffer and `*buf_len` set to `0`.
 
   - Update all example Metrics implementations to use the new API from v1.4.3
-    (eg `MEMFAULT_HEARTBEAT_SET_UNSIGNED` instead of
+    (eg `MEMFAULT_METRIC_SET_UNSIGNED` instead of
     `memfault_metrics_heartbeat_set_unsigned`).
 
   - Fix compilation for systems not integrating the
@@ -34,12 +153,12 @@
 
   - Add a new streamlined Metrics setter API:
 
-    - `MEMFAULT_HEARTBEAT_SET_SIGNED(key_name, signed_value)`
-    - `MEMFAULT_HEARTBEAT_SET_UNSIGNED(key_name, unsigned_value)`
-    - `MEMFAULT_HEARTBEAT_SET_STRING(key_name, value)`
-    - `MEMFAULT_HEARTBEAT_TIMER_START(key_name)`
-    - `MEMFAULT_HEARTBEAT_TIMER_STOP(key_name)`
-    - `MEMFAULT_HEARTBEAT_ADD(key_name, amount)`
+    - `MEMFAULT_METRIC_SET_SIGNED(key_name, signed_value)`
+    - `MEMFAULT_METRIC_SET_UNSIGNED(key_name, unsigned_value)`
+    - `MEMFAULT_METRIC_SET_STRING(key_name, value)`
+    - `MEMFAULT_METRIC_TIMER_START(key_name)`
+    - `MEMFAULT_METRIC_TIMER_STOP(key_name)`
+    - `MEMFAULT_METRIC_ADD(key_name, amount)`
 
     These APIs can be used in place of the original APIs:
 
@@ -71,6 +190,12 @@
   - Add a new out-of-box metric, `wifi_ap_oui`, which will record the associated
     AP's Organizationally Unique Identifier (OUI) in the Memfault heartbeat.
 
+- Zephyr:
+
+  - Organize the Memfault Coredump Kconfig settings under a
+    `Memfault Coredump Settings` submenu, for easier navigation when using
+    graphical Kconfig frontends like menuconfig.
+
 ### :chart_with_upwards_trend: Improvements
 
 - General:

License.txt

@@ -1,33 +1,31 @@
-Copyright (c) 2019 - Present, Memfault
-All rights reserved.
- 
-Redistribution and use in source and binary forms, with or without 
-modification, are permitted provided that the following conditions are met:
- 
-1. Redistributions of source code or in binary form must reproduce 
-the above copyright notice, this list of conditions and the following
-disclaimer in the documentation and/or other materials provided with the 
-distribution.
- 
-2. Neither the name of Memfault nor the names of its contributors may be 
-used to endorse or promote products derived from this software without 
-specific prior written permission.
- 
-3. This software, with or without modification, must only be used with
-the Memfault services and integrated with the Memfault server.
- 
-4. Any software provided in binary form under this license must not be 
-reverse engineered, decompiled, modified and/or disassembled.
- 
-THIS SOFTWARE IS PROVIDED BY MEMFAULT "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 
-INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, 
-NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
-SHALL MEMFAULT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
-PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
-OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
-WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
-ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 
-THE POSSIBILITY OF SUCH DAMAGE.
-
-
+Copyright (c) 2019 - Present, Memfault
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code or in binary form must reproduce
+the above copyright notice, this list of conditions and the following
+disclaimer in the documentation and/or other materials provided with the
+distribution.
+
+2. Neither the name of Memfault nor the names of its contributors may be
+used to endorse or promote products derived from this software without
+specific prior written permission.
+
+3. This software, with or without modification, must only be used with
+the Memfault services and integrated with the Memfault server.
+
+4. Any software provided in binary form under this license must not be
+reverse engineered, decompiled, modified and/or disassembled.
+
+THIS SOFTWARE IS PROVIDED BY MEMFAULT "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
+NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
+SHALL MEMFAULT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+THE POSSIBILITY OF SUCH DAMAGE.

VERSION

@@ -1,3 +1,3 @@
-BUILD ID: 4488
-GIT COMMIT: 7744b8176
-VERSION: 1.4.4
+BUILD ID: 4793
+GIT COMMIT: 06d69b79b
+VERSION: 1.5.0

components/demo/src/memfault_demo_shell.c

@@ -20,17 +20,33 @@
 #define MEMFAULT_SHELL_MAX_ARGS (16)
 #define MEMFAULT_SHELL_PROMPT "mflt> "
 
-#define MEMFAULT_SHELL_FOR_EACH_COMMAND(command) \
-  for (const sMemfaultShellCommand *command = g_memfault_shell_commands; \
-    command < &g_memfault_shell_commands[g_memfault_num_shell_commands]; \
-    ++command)
+#if defined(MEMFAULT_DEMO_SHELL_COMMAND_EXTENSIONS)
+  // When the extension list is enabled, iterate over both the core commands and
+  // the extension commands. This construct, despite being pretty intricate,
+  // saves about ~28 bytes of code space over running the iteration twice in a
+  // row, and keeps the iterator in one macro, instead of two.
+  #define MEMFAULT_SHELL_FOR_EACH_COMMAND(command)                                              \
+    const sMemfaultShellCommand *command = g_memfault_shell_commands;                           \
+    for (size_t i = 0; i < g_memfault_num_shell_commands + s_mflt_shell.num_extension_commands; \
+         ++i, command = (i < g_memfault_num_shell_commands)                                     \
+                          ? &g_memfault_shell_commands[i]                                       \
+                          : &s_mflt_shell.extension_commands[i - g_memfault_num_shell_commands])
+#else
+  #define MEMFAULT_SHELL_FOR_EACH_COMMAND(command)                         \
+    for (const sMemfaultShellCommand *command = g_memfault_shell_commands; \
+         command < &g_memfault_shell_commands[g_memfault_num_shell_commands]; ++command)
+#endif
 
 static struct MemfaultShellContext {
   int (*send_char)(char c);
   size_t rx_size;
   // the char we will ignore when received end-of-line sequences
   char eol_ignore_char;
   char rx_buffer[MEMFAULT_DEMO_SHELL_RX_BUFFER_SIZE];
+#if defined(MEMFAULT_DEMO_SHELL_COMMAND_EXTENSIONS)
+  const sMemfaultShellCommand *extension_commands;
+  size_t num_extension_commands;
+#endif
 } s_mflt_shell;
 
 static bool prv_booted(void) {
@@ -137,6 +153,14 @@ void memfault_demo_shell_boot(const sMemfaultShellImpl *impl) {
   prv_echo_str("\n" MEMFAULT_SHELL_PROMPT);
 }
 
+#if defined(MEMFAULT_DEMO_SHELL_COMMAND_EXTENSIONS)
+void memfault_shell_command_set_extensions(const sMemfaultShellCommand *const commands,
+                                           size_t num_commands) {
+  s_mflt_shell.extension_commands = commands;
+  s_mflt_shell.num_extension_commands = num_commands;
+}
+#endif
+
 //! Logic to deal with CR, LF, CRLF, or LFCR end-of-line (EOL) sequences
 //! @return true if the character should be ignored, false otherwise
 static bool prv_should_ignore_eol_char(char c) {

components/include/memfault/components.h

@@ -28,6 +28,7 @@
 #include "memfault/core/heap_stats.h"
 #include "memfault/core/log.h"
 #include "memfault/core/math.h"
+#include "memfault/core/platform/battery.h"
 #include "memfault/core/platform/core.h"
 #include "memfault/core/platform/crc32.h"
 #include "memfault/core/platform/debug_log.h"
@@ -49,9 +50,12 @@
 #include "memfault/http/platform/http_client.h"
 #include "memfault/http/root_certs.h"
 #include "memfault/http/utils.h"
+#include "memfault/metrics/battery.h"
+#include "memfault/metrics/connectivity.h"
 #include "memfault/metrics/metrics.h"
 #include "memfault/metrics/platform/overrides.h"
 #include "memfault/metrics/platform/timer.h"
+#include "memfault/metrics/reliability.h"
 #include "memfault/metrics/utils.h"
 #include "memfault/panics/assert.h"
 #include "memfault/panics/coredump.h"

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

@@ -0,0 +1,32 @@
+#pragma once
+
+//! @file
+//!
+//! Copyright (c) Memfault, Inc.
+//! See License.txt for details
+//!
+//! @brief
+//! Required dependency functions for the Memfault Battery Metrics component.
+
+#include <stdbool.h>
+#include <stdint.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+//! The platform must implement this function. It provides the current battery
+//! state of charge in percent (0-100%).
+//!
+//! @returns the current battery state of charge in percent (0-100%)
+uint32_t memfault_platform_get_stateofcharge(void);
+
+//! The platform must implement this function. The battery metrics
+//! implementation uses this to check if the battery is discharging.
+//!
+//! @return true if the system is discharging, false if it is not discharging
+bool memfault_platform_is_discharging(void);
+
+#ifdef __cplusplus
+}
+#endif

components/include/memfault/core/reboot_reason_types.h

@@ -14,8 +14,7 @@ extern "C" {
 
 typedef enum MfltResetReason {
   // A reboot reason was not determined either by hardware or a previously marked reboot reason
-  // This reason is classified as an unexpected reboot when used by the built-in metric
-  // MemfaultSdkMetric_UnexpectedRebootDidOccur
+  // This reason is classified as a crash when calculating the operational_crashfree_hours metric
   kMfltRebootReason_Unknown = 0x0000,
 
   //
@@ -70,6 +69,8 @@ typedef enum MfltResetReason {
 
   // A software reset triggered due to a dynamic memory (heap) allocation failure.
   kMfltRebootReason_OutOfMemory = 0x800A,
+  // A reset due to stack overflow
+  kMfltRebootReason_StackOverflow = 0x800B,
 
   // Resets from Arm Faults
   kMfltRebootReason_BusFault = 0x9100,

components/include/memfault/core/serializer_key_ids.h

@@ -41,6 +41,7 @@ typedef enum {
 //! EventInfo dictionary keys for events with type kMemfaultEventType_Heartbeat.
 typedef enum {
   kMemfaultHeartbeatInfoKey_Metrics = 1,
+  kMemfaultHeartbeatInfoKey_Session = 2,
 } eMemfaultHeartbeatInfoKey;
 
 //! EventInfo dictionary keys for events with type kMemfaultEventType_Trace.

components/include/memfault/default_config.h

@@ -296,6 +296,26 @@ extern "C" {
   "memfault_metrics_heartbeat_config.def"
 #endif
 
+//! Enable the sync_successful metric API
+#ifndef MEMFAULT_METRICS_SYNC_SUCCESS
+#define MEMFAULT_METRICS_SYNC_SUCCESS 0
+#endif
+
+//! Enable the sync_memfault_successful metric API
+#ifndef MEMFAULT_METRICS_MEMFAULT_SYNC_SUCCESS
+#define MEMFAULT_METRICS_MEMFAULT_SYNC_SUCCESS 0
+#endif
+
+//! Enable the connectivity_connected_time_ms metric API
+#ifndef MEMFAULT_METRICS_CONNECTIVITY_CONNECTED_TIME
+#define MEMFAULT_METRICS_CONNECTIVITY_CONNECTED_TIME 0
+#endif
+
+//! Enable the battery metrics API
+#ifndef MEMFAULT_METRICS_BATTERY_ENABLE
+#define MEMFAULT_METRICS_BATTERY_ENABLE 0
+#endif
+
 //
 // Panics Component Configs
 //