Memfault Firmware SDK 0.27.1 (Build 327008)

Memfault Inc · Memfault Inc · commit dde214596594 · 2021-10-11T18:52:27.000-04:00
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,3 +1,17 @@
+### Changes between Memfault SDK 0.27.1 and SDK 0.27.0 - Oct 11, 2021
+
+#### :chart_with_upwards_trend: Improvements
+
+- Extended mynewt RTOS port to capture coredumps via a
+  [`os_coredump_cb`](ports/mynewt/src/memfault_platform_port.c) implementation
+  when `MEMFAULT_COREDUMP_CB=1`
+
+#### :house: Internal
+
+- Fixed a few compiler warnings emitted when compiling with clang
+- Improved documentation for
+  [coredump config with nRF5 SDK](ports/nrf5_sdk/nrf5_coredump_regions.c)
+
 ### Changes between Memfault SDK 0.27.0 and SDK 0.26.1 - Oct 5, 2021
 
 #### :chart_with_upwards_trend: Improvements
diff --git a/VERSION b/VERSION
@@ -1,2 +1,2 @@
-BUILD ID: 325530
-GIT COMMIT: d622ced50
+BUILD ID: 327008
+GIT COMMIT: 0b4bb4c57
diff --git a/components/core/src/memfault_log.c b/components/core/src/memfault_log.c
@@ -322,7 +322,7 @@ static void prv_log_save(eMemfaultPlatformLogLevel level,
   memfault_lock();
   {
     sMfltCircularBuffer *circ_bufp = &s_memfault_ram_logger.circ_buffer;
-    const bool space_free = prv_try_free_space(circ_bufp, bytes_needed);
+    const bool space_free = prv_try_free_space(circ_bufp, (int)bytes_needed);
     if (space_free) {
         sMfltRamLogEntry entry = {
           .len = (uint8_t)truncated_log_len,
diff --git a/components/http/src/memfault_http_utils.c b/components/http/src/memfault_http_utils.c
@@ -262,7 +262,7 @@ static int prv_str_to_dec(const char *buf, size_t buf_len, int *value_out) {
   }
 
   *value_out = result;
-  return idx;
+  return (int)idx;
 }
 
 //! @return true if parsing was successful, false if a parse error occurred
@@ -456,7 +456,7 @@ static bool prv_find_first_occurrence(const char *line, size_t total_len,
 
 static bool prv_find_last_occurrence(const char *line, size_t total_len,
                                     char c, size_t *offset_out) {
-  for (int offset = total_len - 1; offset >= 0; offset--) {
+  for (int offset = (int)total_len - 1; offset >= 0; offset--) {
     if (line[offset] == c) {
       *offset_out = (size_t)offset;
       return true;
diff --git a/components/include/memfault/version.h b/components/include/memfault/version.h
@@ -19,7 +19,7 @@ typedef struct {
   uint8_t patch;
 } sMfltSdkVersion;
 
-#define MEMFAULT_SDK_VERSION   { .major = 0, .minor = 27, .patch = 0 }
+#define MEMFAULT_SDK_VERSION   { .major = 0, .minor = 27, .patch = 1 }
 
 #ifdef __cplusplus
 }
diff --git a/components/util/src/memfault_rle.c b/components/util/src/memfault_rle.c
@@ -26,7 +26,7 @@ static void prv_handle_rle_change(sMemfaultRleCtx *ctx) {
     .write_len = repeated_pattern ? 1 : ctx->seq_count,
   };
 
-  int32_t rle_size = repeated_pattern ? ctx->seq_count : -ctx->seq_count;
+  int32_t rle_size = (int)(repeated_pattern ? ctx->seq_count : -ctx->seq_count);
 
   ctx->write_info.header_len = memfault_encode_varint_si32(rle_size, &ctx->write_info.header[0]);
 
diff --git a/ports/mynewt/README.md b/ports/mynewt/README.md
@@ -23,9 +23,9 @@ section of your `syscfg.yml` file:
 
 ```yaml
 syscfg.vals:
-    [...]
-    MEMFAULT_COREDUMP_CB: 1
+[...]
     MEMFAULT_ENABLE: 1
+    MEMFAULT_COREDUMP_CB: 1
     OS_COREDUMP: 1
     OS_COREDUMP_CB: 1
 ```
diff --git a/ports/mynewt/pkg.yml b/ports/mynewt/pkg.yml
@@ -10,7 +10,6 @@ pkg.deps:
     - "@apache-mynewt-core/sys/flash_map"
     - "@apache-mynewt-core/hw/hal"
     - "@apache-mynewt-core/mgmt/imgmgr"
-    - "@apache-mynewt-core/util/memfault_sdk"
     - "@mcuboot/boot/bootutil"
 
 pkg.ign_dirs:
diff --git a/ports/mynewt/src/memfault_platform_flash_backed_coredump.c b/ports/mynewt/src/memfault_platform_flash_backed_coredump.c
@@ -17,7 +17,7 @@
 
 #include "memfault/components.h"
 
-
+#if MYNEWT_VAL(MEMFAULT_ENABLE)
 
 const sMfltCoredumpRegion *
 memfault_platform_coredump_get_regions(const sCoredumpCrashInfo *crash_info,
@@ -146,3 +146,5 @@ void memfault_platform_coredump_storage_clear(void) {
   const uint8_t clear_byte = 0x0;
   memfault_platform_coredump_storage_write(0, &clear_byte, sizeof(clear_byte));
 }
+
+#endif /* MYNEWT_VAL(MEMFAULT_ENABLE) */
diff --git a/ports/mynewt/src/memfault_platform_port.c b/ports/mynewt/src/memfault_platform_port.c
@@ -16,6 +16,8 @@
 #include "memfault/components.h"
 #include "memfault/ports/reboot_reason.h"
 
+#if MYNEWT_VAL(MEMFAULT_ENABLE)
+
 void memfault_platform_get_device_info(sMemfaultDeviceInfo *info) {
   *info = (sMemfaultDeviceInfo) {
     // Note: serial number will be recovered from route used when posting
@@ -165,3 +167,47 @@ void memfault_platform_reboot_tracking_boot(void) {
   memfault_reboot_reason_get(&reset_info);
   memfault_reboot_tracking_boot(s_reboot_tracking, &reset_info);
 }
+
+#if MYNEWT_VAL(MEMFAULT_COREDUMP_CB)
+
+
+static eMemfaultRebootReason s_reboot_reason = kMfltRebootReason_UnknownError;
+
+#if MYNEWT_VAL(MEMFAULT_ASSERT_CB)
+void os_assert_cb(void) {
+  s_reboot_reason = kMfltRebootReason_Assert;
+}
+#endif
+
+static eMemfaultRebootReason prv_resolve_reason_from_active_isr(void) {
+  // ARM Cortex-M have a standard set of exception numbers used for faults.
+  //
+  // The bottom byte of the XPSR register tells us which interrupt we are running from.
+  // See https://mflt.io/cortex-m-exc-numbering
+  uint32_t vect_active = __get_xPSR() & 0xff;
+  switch (vect_active) {
+    case 2:
+      return kMfltRebootReason_Nmi;
+    case 3:
+      return kMfltRebootReason_HardFault;
+    case 4:
+      return kMfltRebootReason_MemFault;
+    case 5:
+      return kMfltRebootReason_BusFault;
+    case 6:
+      return kMfltRebootReason_UsageFault;
+    default:
+      return kMfltRebootReason_HardFault;
+  }
+}
+
+void os_coredump_cb(void *tf) {
+  if (s_reboot_reason == kMfltRebootReason_UnknownError) {
+    s_reboot_reason = prv_resolve_reason_from_active_isr();
+  }
+
+  memfault_fault_handler(tf, s_reboot_reason);
+}
+#endif /* MYNEWT_VAL(MEMFAULT_COREDUMP_CB) */
+
+#endif /* MYNEWT_VAL(MEMFAULT_ENABLE) */
diff --git a/ports/mynewt/syscfg.yml b/ports/mynewt/syscfg.yml
@@ -1,4 +1,23 @@
 syscfg.defs:
+    MEMFAULT_ENABLE:
+        description: Enables Memfault SDK features
+        value: 0
+
+    MEMFAULT_COREDUMP_CB:
+        description: Enable custom memfault coredump handling cb
+        value: 0
+        restriction:
+            - 'OS_COREDUMP_CB if 1'
+
+    MEMFAULT_ASSERT_CB:
+        description: >
+            Enable custom assert handling callback to correctly capture that a reboot
+            was triggered via an assert.
+        value: 0
+        restriction:
+            - 'MEMFAULT_COREDUMP_CB if 1'
+            - 'OS_ASSERT_CB if 1'
+
     MEMFAULT_DEVICE_INFO_SOFTWARE_TYPE:
         description: A name to represent the firmware running on the MCU.
         value: '"app-fw"'
diff --git a/ports/nrf5_sdk/nrf5_coredump_regions.c b/ports/nrf5_sdk/nrf5_coredump_regions.c
@@ -11,8 +11,10 @@
 //!  declare their own regions to collect.
 //!
 //!  MEMFAULT_PLATFORM_COREDUMP_CAPTURE_STACK_ONLY (default = 1)
-//!   This mode will collect just the stack that was active at the time of crash
-//!   The regions to be captured by adding the following to the projects .ld file:
+//!   This mode will collect just the stack that was active at the time of
+//!   crash. To capture more data, set this to 0 in memfault_platform_config.h.
+//!   The regions to be captured are specified by adding the following to the
+//!   project's .ld file:
 //!
 //!     __MemfaultCoredumpRamStart = ORIGIN(RAM);
 //!     __MfltCoredumpRamEnd = ORIGIN(RAM) + LENGTH(RAM);
diff --git a/ports/nrf5_sdk/nrf5_coredump_storage.c b/ports/nrf5_sdk/nrf5_coredump_storage.c
@@ -3,8 +3,27 @@
 //! Copyright (c) Memfault, Inc.
 //! See License.txt for details
 //!
-//! Implements platform dependency functions required for saving coredumps
-//! to internal flash when using the NRF5 SDK.
+//! Implements platform dependency functions required for saving coredumps to
+//! internal flash when using the NRF5 SDK.
+//!
+//! To use, update your linker script (.ld file) to expose information about the
+//! location to use. For example, using a 256K region of the nRF52840 (1MB
+//! flash) would look something like this:
+//!
+//!   MEMORY
+//!   {
+//!     FLASH (rx) : ORIGIN = 0x26000, LENGTH = 0x7B000
+//!     MEMFAULT_CORES (rw) : ORIGIN = 0xA1000, LENGTH = 0x40000
+//!     /* Note: most production apps would have a bootloader somewhere in this range! */
+//!     RSVD (rwx) : ORIGIN = 0xE1000, LENGTH = 0x1F000
+//!     RAM (rwx) :  ORIGIN = 0x200057b8, LENGTH = 0x3a848
+//!   }
+//!
+//!   __MemfaultCoreStorageStart = ORIGIN(MEMFAULT_CORES);
+//!   __MemfaultCoreStorageEnd = ORIGIN(MEMFAULT_CORES) + LENGTH(MEMFAULT_CORES);
+//!
+//! See also nrf5_coredump_regions.c for information on which areas are captured
+//! during a coredump.
 
 #include "memfault/panics/coredump.h"
 
diff --git a/repository.yml b/repository.yml
@@ -9,6 +9,7 @@ repo.versions:
     "0.0.0": "master"
     "0-dev": "0.0.0"        # master
     "0.27.0": "0.27.0"      # native support for mynewt added
+    "0.27.1": "0.27.1"      # Added os_coredump_cb implementation for use with Memfault
 
 repo.newt_compatibility:
     # Allow all versions for 0.0.0.  This is a workaround to prevent a warning

Original file line number	Diff line number	Diff line change
`@@ -322,7 +322,7 @@ static void prv_log_save(eMemfaultPlatformLogLevel level,`
`322`	`322`	`memfault_lock();`
`323`	`323`	`{`
`324`	`324`	`sMfltCircularBuffer *circ_bufp = &s_memfault_ram_logger.circ_buffer;`
`325`		`- const bool space_free = prv_try_free_space(circ_bufp, bytes_needed);`
	`325`	`+ const bool space_free = prv_try_free_space(circ_bufp, (int)bytes_needed);`
`326`	`326`	`if (space_free) {`
`327`	`327`	`sMfltRamLogEntry entry = {`
`328`	`328`	`.len = (uint8_t)truncated_log_len,`
Original file line number	Diff line number	Diff line change
`@@ -262,7 +262,7 @@ static int prv_str_to_dec(const char buf, size_t buf_len, int value_out) {`
`262`	`262`	`}`
`263`	`263`
`264`	`264`	`*value_out = result;`
`265`		`- return idx;`
	`265`	`+ return (int)idx;`
`266`	`266`	`}`
`267`	`267`
`268`	`268`	`//! @return true if parsing was successful, false if a parse error occurred`
`@@ -456,7 +456,7 @@ static bool prv_find_first_occurrence(const char *line, size_t total_len,`
`456`	`456`
`457`	`457`	`static bool prv_find_last_occurrence(const char *line, size_t total_len,`
`458`	`458`	`char c, size_t *offset_out) {`
`459`		`- for (int offset = total_len - 1; offset >= 0; offset--) {`
	`459`	`+ for (int offset = (int)total_len - 1; offset >= 0; offset--) {`
`460`	`460`	`if (line[offset] == c) {`
`461`	`461`	`*offset_out = (size_t)offset;`
`462`	`462`	`return true;`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ typedef struct {`
`19`	`19`	`uint8_t patch;`
`20`	`20`	`} sMfltSdkVersion;`
`21`	`21`
`22`		`-#define MEMFAULT_SDK_VERSION { .major = 0, .minor = 27, .patch = 0 }`
	`22`	`+#define MEMFAULT_SDK_VERSION { .major = 0, .minor = 27, .patch = 1 }`
`23`	`23`
`24`	`24`	`#ifdef __cplusplus`
`25`	`25`	`}`