Memfault Firmware SDK 0.27.3 (Build 347225)

Author: Memfault Inc

CHANGES.md

@@ -1,3 +1,21 @@
+### Changes between Memfault SDK 0.27.3 and SDK 0.27.2 - Nov 22, 2021
+
+#### :chart_with_upwards_trend: Improvements
+
+- Fix a build error for the Nordic Connect SDK v1.7.99 development version
+- Correct an error in header file include order in the Mynewt port
+- Update the esp32 and zephyr examples to use `1.0.0-dev` instead of
+  `1.0.0+<6 digits of build id>` for the version specifier. Build id is no
+  longer required for symbol file reconciliation and the `+` character is a
+  reserved character for URI schemes; this impacted OTA release requests. See
+  this document for
+  [Memfault's recommended versioning strategy](https://docs.memfault.com/docs/platform/software-version-hardware-version/#software-version)
+- Add a reboot reason port for the STM32F7xx family.
+
+#### :house: Internal
+
+- Re-run python `black` and `isort` formatters on python code
+
 ### Changes between Memfault SDK 0.27.2 and SDK 0.27.1 - Nov 5, 2021
 
 #### :chart_with_upwards_trend: Improvements

VERSION

@@ -1,2 +1,2 @@
-BUILD ID: 338784
-GIT COMMIT: a8d871a22
+BUILD ID: 347225
+GIT COMMIT: 3f66c9c5e

components/include/memfault/version.h

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

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

@@ -8,9 +8,7 @@
 
 #include <stdio.h>
 
-#include "memfault/core/build_info.h"
-#include "memfault/core/math.h"
-#include "memfault/core/platform/device_info.h"
+#include "memfault/components.h"
 
 #include "esp_system.h"
 
@@ -29,7 +27,6 @@
 #endif
 
 static char s_device_serial[32];
-static char s_fw_version[16] = MEMFAULT_ESP32_MAIN_FIRMWARE_VERSION "+";
 
 // NOTE: Some versions of the esp-idf use locking when reading mac info
 // so this isn't safe to call from an interrupt
@@ -52,23 +49,13 @@ static void prv_get_device_serial(char *buf, size_t buf_len) {
 
 void memfault_platform_device_info_boot(void) {
   prv_get_device_serial(s_device_serial, sizeof(s_device_serial));
-
-  const size_t version_len = strlen(s_fw_version);
-
-  // We will use 6 characters of the build id to make our versions unique and
-  // identifiable between releases
-  const size_t build_id_chars = 6 + 1 /* '\0' */;
-  const size_t build_id_num_chars =
-      MEMFAULT_MIN(build_id_chars, sizeof(s_fw_version) - version_len - 1);
-
-  memfault_build_id_get_string(&s_fw_version[version_len], build_id_num_chars);
 }
 
 void memfault_platform_get_device_info(struct MemfaultDeviceInfo *info) {
   *info = (struct MemfaultDeviceInfo) {
     .device_serial = s_device_serial,
     .hardware_version = MEMFAULT_ESP32_HW_REVISION,
-    .software_version = s_fw_version,
+    .software_version = MEMFAULT_ESP32_MAIN_FIRMWARE_VERSION "-dev",
     .software_type = MEMFAULT_ESP32_SOFTWARE_TYPE,
   };
 }

examples/zephyr/apps/memfault_demo_app/src/main.c

@@ -17,28 +17,11 @@ sMfltHttpClientConfig g_mflt_http_client_config = {
   .api_key = "<YOUR PROJECT KEY HERE>",
 };
 
-static char s_fw_version[16]="1.0.0+";
-
 void memfault_platform_get_device_info(sMemfaultDeviceInfo *info) {
-  static bool s_init = false;
-
-  if (!s_init) {
-    const size_t version_len = strlen(s_fw_version);
-    // We will use 6 characters of the build id to make our versions unique and
-    // identifiable between releases
-    const size_t build_id_chars = 6 + 1 /* '\0' */;
-
-    const size_t build_id_num_chars =
-        MEMFAULT_MIN(build_id_chars, sizeof(s_fw_version) - version_len - 1);
-
-    memfault_build_id_get_string(&s_fw_version[version_len], build_id_num_chars);
-    s_init = true;
-  }
-
   *info = (sMemfaultDeviceInfo) {
     .device_serial = "DEMOSERIAL",
     .software_type = "zephyr-app",
-    .software_version = s_fw_version,
+    .software_version = "1.0.0-dev",
     .hardware_version = CONFIG_BOARD,
   };
 }

ports/mynewt/src/memfault_platform_port.c

@@ -6,13 +6,16 @@
 //! A port of Memfault dependency functions to mynewt targets
 
 #include <stdbool.h>
+#include <syscfg/syscfg.h>
+
+//! Keep os.h above bsp.h; some bsp definitions require the MYNEWT_VAL definition
+#include "os/os.h"
 
 #include "bsp/bsp.h"
 #include "hal/hal_bsp.h"
 #include "hal/hal_system.h"
 #include "memfault/components.h"
 #include "memfault/ports/reboot_reason.h"
-#include "os/os.h"
 #include "sysinit/sysinit.h"
 
 #if MYNEWT_VAL(MEMFAULT_ENABLE)

ports/stm32cube/f7/rcc_reboot_tracking.c

@@ -0,0 +1,89 @@
+//! @file
+//!
+//! Copyright (c) Memfault, Inc.
+//! See License.txt for details
+//!
+//! A port for recovering reset reason information by reading the "Reset and
+//! Clock Control" (RCC)'s "Control & Status Register" (CSR).
+//!
+//! More details can be found in the "RCC clock control & status register
+//! (RCC_CSR)" section of the STM32F7 family reference manual.
+
+#include "memfault/components.h"
+#include "stm32f769xx.h"
+#include "stm32f7xx_hal.h"
+
+#if MEMFAULT_ENABLE_REBOOT_DIAG_DUMP
+#define MEMFAULT_PRINT_RESET_INFO(...) MEMFAULT_LOG_INFO(__VA_ARGS__)
+#else
+#define MEMFAULT_PRINT_RESET_INFO(...)
+#endif
+
+//! Mappings come from "5.3.21 RCC clock control & status register (RCC_CSR)" of
+//! the ST "RM0410" Reference Manual for (STM32F76xxx and STM32F77xxx).
+typedef enum ResetSource {
+  kResetSource_PwrPor = (RCC_CSR_PORRSTF_Msk),
+  kResetSource_Pin = (RCC_CSR_PINRSTF_Msk),
+  kResetSource_PwrBor = (RCC_CSR_BORRSTF_Msk),
+  kResetSource_Software = (RCC_CSR_SFTRSTF_Msk),
+  kResetSource_Wwdg = (RCC_CSR_WWDGRSTF_Msk),
+  kResetSource_Iwdg = (RCC_CSR_IWDGRSTF_Msk),
+  kResetSource_LowPwr = (RCC_CSR_LPWRRSTF_Msk),
+} eResetSource;
+
+void memfault_reboot_reason_get(sResetBootupInfo *info) {
+  const uint32_t reset_cause = RCC->CSR;
+
+  eMemfaultRebootReason reset_reason = kMfltRebootReason_Unknown;
+
+  MEMFAULT_PRINT_RESET_INFO("Reset Reason, RCC_CSR=0x%" PRIx32, reset_cause);
+  MEMFAULT_PRINT_RESET_INFO("Reset Causes: ");
+
+  const uint32_t reset_mask_all =
+    (RCC_CSR_BORRSTF_Msk | RCC_CSR_PINRSTF_Msk | RCC_CSR_PORRSTF_Msk | RCC_CSR_SFTRSTF_Msk |
+     RCC_CSR_IWDGRSTF_Msk | RCC_CSR_WWDGRSTF_Msk | RCC_CSR_LPWRRSTF_Msk);
+
+  switch (reset_cause & reset_mask_all) {
+    case kResetSource_PwrPor:
+      MEMFAULT_PRINT_RESET_INFO(" Power on Reset");
+      reset_reason = kMfltRebootReason_PowerOnReset;
+      break;
+    case kResetSource_Pin:
+      MEMFAULT_PRINT_RESET_INFO(" Pin Reset");
+      reset_reason = kMfltRebootReason_PinReset;
+      break;
+    case kResetSource_PwrBor:
+      MEMFAULT_PRINT_RESET_INFO(" Brown out");
+      reset_reason = kMfltRebootReason_BrownOutReset;
+      break;
+    case kResetSource_Software:
+      MEMFAULT_PRINT_RESET_INFO(" Software");
+      reset_reason = kMfltRebootReason_SoftwareReset;
+      break;
+    case kResetSource_Wwdg:
+      MEMFAULT_PRINT_RESET_INFO(" Window Watchdog");
+      reset_reason = kMfltRebootReason_HardwareWatchdog;
+      break;
+    case kResetSource_Iwdg:
+      MEMFAULT_PRINT_RESET_INFO(" Independent Watchdog");
+      reset_reason = kMfltRebootReason_HardwareWatchdog;
+      break;
+    case kResetSource_LowPwr:
+      MEMFAULT_PRINT_RESET_INFO(" Low power management");
+      reset_reason = kMfltRebootReason_LowPower;
+      break;
+    default:
+      MEMFAULT_PRINT_RESET_INFO(" Unknown");
+      break;
+  }
+
+#if MEMFAULT_REBOOT_REASON_CLEAR
+  // we have read the reset information so clear the bits (since they are sticky across reboots)
+  __HAL_RCC_CLEAR_RESET_FLAGS();
+#endif
+
+  *info = (sResetBootupInfo){
+    .reset_reason_reg = reset_cause,
+    .reset_reason = reset_reason,
+  };
+}

ports/zephyr/common/memfault_zephyr_ram_regions.c

@@ -143,14 +143,7 @@ size_t memfault_zephyr_get_data_regions(sMfltCoredumpRegion *regions, size_t num
 
   // Linker variables defined in linker.ld in Zephyr RTOS
   // Data region name changed in v2.7 of the kernel
-  //
-  // Note: the nrf-connect fork of zephyr did not pick up this change in either
-  // the 2.6.99 or the later version selected in the nrf-connect v1.8 release,
-  // so we'll use the old naming scheme there. This may break in the future if
-  // Nordic picks up the change!
-  // https://github.com/zephyrproject-rtos/zephyr/commit/65a2de84a9d5c535167951bf1cf610c4f7967ea5
-  // https://github.com/zephyrproject-rtos/zephyr/pull/37938
-#if MEMFAULT_ZEPHYR_VERSION_GT(2, 6) && !CONFIG_MEMFAULT_NRF_CONNECT_SDK
+#if MEMFAULT_ZEPHYR_VERSION_GT(2, 6)
 #define ZEPHYR_DATA_REGION_START __data_region_start
 #define ZEPHYR_DATA_REGION_END __data_region_end
 #else

tasks/__init__.py

@@ -62,7 +62,7 @@ def fw_sdk_unit_test(ctx, coverage=False, rule="", test_filter=None, test_dir=SD
     ]
 )
 def build_all_demos(ctx):
-    """ Builds all demo apps (for CI purposes) """
+    """Builds all demo apps (for CI purposes)"""
     pass