Memfault Firmware SDK 0.27.2 (Build 338784)

Memfault Inc · Memfault Inc · commit 06da39b2c09d · 2021-11-08T17:27:02.000-05:00
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,3 +1,26 @@
+### Changes between Memfault SDK 0.27.2 and SDK 0.27.1 - Nov 5, 2021
+
+#### :chart_with_upwards_trend: Improvements
+
+- The Mynewt integration now supports the Memfault demo shell via
+  `mflt_shell_init()`, see the [Mynewt port README.md](ports/mynewt/README.md)
+  for details. Huge thanks to @t3zeng for providing this implementation!
+- Add support for ESP-IDF v4.3.1. This update should fix the bootlooping issue
+  seen when using the port with v4.3.1+ of ESP-IDF.
+- Add support for `LOG2` deferred mode on zephyr. This should fix bootloops when
+  enabling `LOG2`.
+- Fix flipped args passed from `MEMFAULT_ASSERT_RECORD()` to
+  `MEMFAULT_ASSERT_EXTRA_AND_REASON()` (regression in v0.23.0). This affected
+  the `_extra` additional context value passed via this macro.
+- Fix a typo in
+  [`ports/esp_idf/memfault/common/memfault_platform_http_client.c`](ports/esp_idf/memfault/common/memfault_platform_http_client.c)
+  which caused the OTA example to always return "OTA Update Available" when the
+  current version is already the latest.
+
+#### :house: Internal
+
+- Updated list of sample apps in (`examples/README.md`)[examples/README.md]
+
 ### Changes between Memfault SDK 0.27.1 and SDK 0.27.0 - Oct 11, 2021
 
 #### :chart_with_upwards_trend: Improvements
diff --git a/VERSION b/VERSION
@@ -1,2 +1,2 @@
-BUILD ID: 327008
-GIT COMMIT: 0b4bb4c57
+BUILD ID: 338784
+GIT COMMIT: a8d871a22
diff --git a/components/include/memfault/core/compiler_gcc.h b/components/include/memfault/core/compiler_gcc.h
@@ -17,7 +17,10 @@ extern "C" {
 
 #define MEMFAULT_PACKED __attribute__((packed))
 #define MEMFAULT_PACKED_STRUCT struct MEMFAULT_PACKED
+//! MEMFAULT_NORETURN is only intended to be overridden in unit tests, if needed
+#if !defined(MEMFAULT_NORETURN)
 #define MEMFAULT_NORETURN __attribute__((noreturn))
+#endif
 #define MEMFAULT_NAKED_FUNC __attribute__((naked))
 #define MEMFAULT_UNREACHABLE __builtin_unreachable()
 #if defined(__clang__)
diff --git a/components/include/memfault/panics/assert.h b/components/include/memfault/panics/assert.h
@@ -42,7 +42,7 @@ extern "C" {
   } while (0)
 
 #define MEMFAULT_ASSERT_RECORD(_extra) \
-  MEMFAULT_ASSERT_EXTRA_AND_REASON(kMfltRebootReason_Assert, _extra)
+  MEMFAULT_ASSERT_EXTRA_AND_REASON(_extra, kMfltRebootReason_Assert)
 
 #define MEMFAULT_ASSERT_EXTRA(exp, _extra) \
   do {                                     \
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 = 1 }
+#define MEMFAULT_SDK_VERSION   { .major = 0, .minor = 27, .patch = 2 }
 
 #ifdef __cplusplus
 }
diff --git a/examples/README.md b/examples/README.md
@@ -12,6 +12,10 @@ Memfault SDK:
   (STM32F407G-DISC1)
 - WICED SDK / Cypress BCM943364WCD1
 - Zephyr / STMicroelectronics STM32L4 series (B-L475E-IOT01A Discovery kit)
+- Amazon FreeRTOS / Cypress PSoC 64 MCU (CY8CKIT-064S0S2-4343W)
+- Dialog DA145xx and DA1469x
+- Espressif ESP-IDF / ESP32 (ESP-WROVER-KIT)
+- nRF Connect SDK / Nordic nRF9160 (PCA10090)
 
 ## Using the Demo Application
 
diff --git a/ports/esp_idf/memfault/common/memfault_platform_http_client.c b/ports/esp_idf/memfault/common/memfault_platform_http_client.c
@@ -142,7 +142,7 @@ static int prv_build_latest_release_url(char *buf, size_t buf_len) {
   sMemfaultDeviceInfo device_info;
   memfault_platform_get_device_info(&device_info);
   return snprintf(buf, buf_len,
-                  "%s://%s/api/v0/releases/latest/url?device_serial=%s&hardware_version=%s&software_type=%s&software_version=%s",
+                  "%s://%s/api/v0/releases/latest/url?device_serial=%s&hardware_version=%s&software_type=%s&current_version=%s",
                   MEMFAULT_HTTP_GET_SCHEME(),
                   MEMFAULT_HTTP_GET_DEVICE_API_HOST(),
                   device_info.device_serial,
diff --git a/ports/esp_idf/memfault/common/memfault_platform_metrics.c b/ports/esp_idf/memfault/common/memfault_platform_metrics.c
@@ -42,6 +42,12 @@ bool memfault_platform_metrics_timer_boot(uint32_t period_sec,
     .name = "mflt"
   };
 
+  // Ignore return value; this function should be safe to call multiple times
+  // during system init, but needs to called before we create any timers.
+  // See implementation here (may change by esp-idf version!):
+  // https://github.com/espressif/esp-idf/blob/master/components/esp_timer/src/esp_timer.c#L431-L460
+  (void)esp_timer_init();
+
   esp_timer_handle_t periodic_timer;
   ESP_ERROR_CHECK(esp_timer_create(&periodic_timer_args, &periodic_timer));
 
diff --git a/ports/mynewt/README.md b/ports/mynewt/README.md
@@ -70,3 +70,12 @@ And add the following **after** the `.text` in your targets linker script:
         KEEP(*(.note.gnu.build-id))
     } > FLASH
 ```
+
+## Enabling Memfault Demo Shell Commands
+
+The Memfault demo shell commands can be included in the mynewt shell (useful for
+testing various Memfault features). To enable:
+
+1. set `MEMFAULT_CLI: 1` in the target's `syscfg.yml`.
+2. enable the shell commands by calling `mflt_shell_init()` at the appropriate
+   point in the application initialization (eg after `sysinit()`).
diff --git a/ports/mynewt/include/memfault_shell.h b/ports/mynewt/include/memfault_shell.h
@@ -0,0 +1,16 @@
+#pragma once
+
+//! @file
+//!
+//! Copyright (c) Memfault, Inc.
+//! See License.txt for details
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+int mflt_shell_init(void);
+
+#ifdef __cplusplus
+}
+#endif
diff --git a/ports/mynewt/pkg.yml b/ports/mynewt/pkg.yml
@@ -15,6 +15,7 @@ pkg.deps:
 pkg.ign_dirs:
 pkg.include_dirs:
     - "../../components/include"
+    - "../../components/log/include"
     - "../include"
 pkg.src_dirs:
     - "src"
diff --git a/ports/mynewt/src/memfault_platform_port.c b/ports/mynewt/src/memfault_platform_port.c
@@ -10,11 +10,10 @@
 #include "bsp/bsp.h"
 #include "hal/hal_bsp.h"
 #include "hal/hal_system.h"
-#include "os/os.h"
-#include "sysinit/sysinit.h"
-
 #include "memfault/components.h"
 #include "memfault/ports/reboot_reason.h"
+#include "os/os.h"
+#include "sysinit/sysinit.h"
 
 #if MYNEWT_VAL(MEMFAULT_ENABLE)
 
diff --git a/ports/mynewt/src/memfault_shell.c b/ports/mynewt/src/memfault_shell.c
@@ -0,0 +1,176 @@
+//! @file
+//!
+//! Copyright (c) Memfault, Inc.
+//! See License.txt for details
+//!
+//! Integrate the Memfault demo shell with the mynewt console
+
+#include "memfault_shell.h"
+
+#include <errno.h>
+#include <string.h>
+
+#include "console/console.h"
+#include "hal/hal_gpio.h"
+#include "memfault/components.h"
+#include "os/mynewt.h"
+
+#if MYNEWT_VAL(MEMFAULT_CLI)
+#include "parse/parse.h"
+#include "shell/shell.h"
+
+#if MYNEWT_VAL(BSP_NRF52) || MYNEWT_VAL(BSP_NRF52840)
+#include <mcu/nrf52_hal.h>
+#elif MYNEWT_VAL(BSP_NRF51)
+#include <mcu/nrf51_hal.h>
+#elif MYNEWT_VAL(BSP_NRF5340)
+#include <mcu/nrf5340_hal.h>
+#elif MYNEWT_VAL(BSP_NRF5340_NET)
+#include <mcu/nrf5340_net_hal.h>
+#elif MYNEWT_VAL(BSP_APOLLO2)
+#include <mcu/SYSTEM_APOLLO2.h>
+#else
+#error "Unsupported arch"
+#endif
+
+static int mflt_shell_cmd(int argc, char **argv);
+
+static struct shell_cmd mflt_shell_cmd_struct = {
+  .sc_cmd = "mflt",
+  .sc_cmd_func = mflt_shell_cmd,
+};
+
+static int mflt_shell_err_unknown_arg(char *cmd_name) {
+  console_printf("Error: unknown argument \"%s\"\n", cmd_name);
+  return SYS_EINVAL;
+}
+
+static int mflt_shell_help(void) {
+  console_printf("%s cmd\n", mflt_shell_cmd_struct.sc_cmd);
+  console_printf("cmd:\n");
+  console_printf("\tlogging - Tests memfault logging api\n");
+  console_printf(
+    "\tcoredump_storage - Runs a sanity test to confirm coredump port is working as expected\n");
+  console_printf("\theartbeat - Triggers an immediate heartbeat capture (instead of waiting for "
+                 "timer to expire\n");
+  console_printf("\ttrace - Test trace event\n");
+  console_printf("\treboot - Trigger a user initiated reboot and confirm reason is persisted\n");
+  console_printf("\tassert - Triggers memfault assert where a coredump should be captured\n");
+  console_printf("\tfault - Triggers memfault fault where a coredump should be captured \n");
+  console_printf("\thang - Triggers memfault hang where a coredump should be captured \n");
+  console_printf("\texport - Dump Memfault data collected to console\n");
+
+  return SYS_EOK;
+}
+
+//
+// Test Platform Ports
+//
+
+static int test_logging(int argc, char *argv[]) {
+  MEMFAULT_LOG_DEBUG("Debug log!");
+  MEMFAULT_LOG_INFO("Info log!");
+  MEMFAULT_LOG_WARN("Warning log!");
+  MEMFAULT_LOG_ERROR("Error log!");
+  return 0;
+}
+
+// Runs a sanity test to confirm coredump port is working as expected
+static int test_coredump_storage(int argc, char *argv[]) {
+  // Note: Coredump saving runs from an ISR prior to reboot so should
+  // be safe to call with interrupts disabled.
+  int sr;
+  __HAL_DISABLE_INTERRUPTS(sr);
+  memfault_coredump_storage_debug_test_begin();
+  __HAL_ENABLE_INTERRUPTS(sr);
+
+  memfault_coredump_storage_debug_test_finish();
+  return 0;
+}
+
+//
+// Test core SDK functionality
+//
+
+// Triggers an immediate heartbeat capture (instead of waiting for timer
+// to expire)
+static int test_heartbeat(int argc, char *argv[]) {
+  memfault_metrics_heartbeat_debug_trigger();
+  return 0;
+}
+
+static int test_trace(int argc, char *argv[]) {
+  MEMFAULT_TRACE_EVENT_WITH_LOG(Unknown, "A test error trace!");
+  return 0;
+}
+
+//! Trigger a user initiated reboot and confirm reason is persisted
+static int test_reboot(int argc, char *argv[]) {
+  // memfault_reboot_tracking_mark_reset_imminent(kMfltRebootReason_UserReset, NULL);
+  memfault_platform_reboot();
+}
+
+//
+// Test different crash types where a coredump should be captured
+//
+
+static int test_assert(int argc, char *argv[]) {
+  MEMFAULT_ASSERT(0);
+  return -1;  // should never get here
+}
+
+static int test_fault(int argc, char *argv[]) {
+  void (*bad_func)(void) = (void *)0xEEEEDEAD;
+  bad_func();
+  return -1;  // should never get here
+}
+
+static int test_hang(int argc, char *argv[]) {
+  while (1) {
+  }
+  return -1;  // should never get here
+}
+
+// Dump Memfault data collected to console
+static int test_export(int argc, char *argv[]) {
+  memfault_data_export_dump_chunks();
+  return 0;
+}
+
+static int mflt_shell_cmd(int argc, char **argv) {
+  if (argc < 2) {
+    return mflt_shell_help();
+  }
+
+  struct subcommand {
+    const char *name;
+    int (*func)(int argc, char **argv);
+  };
+  static const struct subcommand subcommands[] = {
+    { "logging", test_logging },
+    { "coredump_storage", test_coredump_storage },
+    { "heartbeat", test_heartbeat },
+    { "trace", test_trace },
+    { "reboot", test_reboot },
+    { "assert", test_assert },
+    { "fault", test_fault },
+    { "hang", test_hang },
+    { "export", test_export },
+  };
+
+  for (int i = 0; i < sizeof(subcommands) / sizeof(subcommands[0]); i++) {
+    if (strcmp(argv[1], subcommands[i].name) == 0) {
+      return subcommands[i].func(argc - 1, argv + 1);
+    }
+  }
+
+  return mflt_shell_err_unknown_arg(argv[1]);
+}
+
+int mflt_shell_init(void) {
+  int rc = shell_cmd_register(&mflt_shell_cmd_struct);
+  SYSINIT_PANIC_ASSERT(rc == 0);
+
+  return rc;
+}
+#endif
diff --git a/ports/mynewt/syscfg.yml b/ports/mynewt/syscfg.yml
@@ -3,6 +3,12 @@ syscfg.defs:
         description: Enables Memfault SDK features
         value: 0
 
+    MEMFAULT_CLI:
+        description: Enables Memfault CLI test commands
+        value: 0
+        restriction:
+            - 'MEMFAULT_ENABLE if 1'
+
     MEMFAULT_COREDUMP_CB:
         description: Enable custom memfault coredump handling cb
         value: 0
diff --git a/ports/zephyr/common/memfault_logging.c b/ports/zephyr/common/memfault_logging.c
diff --git a/ports/zephyr/common/memfault_zephyr_ram_regions.c b/ports/zephyr/common/memfault_zephyr_ram_regions.c
diff --git a/tests/makefiles/Makefile_assert.mk b/tests/makefiles/Makefile_assert.mk
diff --git a/tests/src/test_assert.cpp b/tests/src/test_assert.cpp

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 = 1 }`
	`22`	`+#define MEMFAULT_SDK_VERSION { .major = 0, .minor = 27, .patch = 2 }`
`23`	`23`
`24`	`24`	`#ifdef __cplusplus`
`25`	`25`	`}`