Memfault Firmware SDK 0.43.0 (Build 1963)

Author: Memfault Inc

CHANGES.md

@@ -1,3 +1,22 @@
+### Changes between Memfault SDK 0.43.0 and 0.42.1 - April 18, 2023
+
+#### :rocket: New Features
+
+- Add coredump support for Cortex-R chips (ARMv7-R)
+
+#### :chart_with_upwards_trend: Improvements
+
+- Add a QEMU-based FreeRTOS example project, find it under
+  [examples/freertos](examples/freertos)
+- Switch `printf` function attribute to use `__printf__`, to avoid collision
+  with user code that redefines the `printf` token
+
+- Zephyr:
+
+  - Compute thread stack high watermark values on-target when capturing a
+    coredump. This enables showing high watermark information in the Memfault
+    coredump analysis view without capturing the full stack for a thread
+
 ### Changes between Memfault SDK 0.42.1 and 0.42.0 - April 4, 2023
 
 #### :chart_with_upwards_trend: Improvements

VERSION

@@ -1,2 +1,2 @@
-BUILD ID: 1866
-GIT COMMIT: 96e2f7fa4
+BUILD ID: 1963
+GIT COMMIT: bcb826788

components/core/src/arch_arm_cortex_m.c

@@ -9,7 +9,7 @@
 #include "memfault/core/compiler.h"
 #include "memfault/core/platform/core.h"
 
-#if MEMFAULT_COMPILER_ARM
+#if MEMFAULT_COMPILER_ARM_CORTEX_M
 
 bool memfault_arch_is_inside_isr(void) {
   // We query the "Interrupt Control State Register" to determine
@@ -43,4 +43,4 @@ void memfault_platform_halt_if_debugging(void) {
   MEMFAULT_BREAKPOINT(77);
 }
 
-#endif /* MEMFAULT_COMPILER_ARM */
+#endif /* MEMFAULT_COMPILER_ARM_CORTEX_M */

components/core/src/memfault_log.c

@@ -306,7 +306,19 @@ void memfault_log_export_log(sMemfaultLog *log) {
 
 void memfault_log_export_logs(void) {
   while (1) {
+    // the TI ARM compiler warns about enumerated type mismatch in this
+    // zero-initializer, but we depend on the C99 spec (vs. the gcc extension,
+    // empty brace {}), so suppress the diagnostic here. Clang throws an invalid
+    // -Wmissing-field-initializers warning if we just cast, unfortunately.
+    #if defined(__TI_ARM__)
+      #pragma diag_push
+      #pragma diag_remark 190
+    #endif
     sMemfaultLog log = {0};
+    #if defined(__TI_ARM__)
+      #pragma diag_pop
+    #endif
+
     const bool log_found = memfault_log_read(&log);
     if (!log_found) {
       break;

components/core/src/memfault_ram_reboot_info_tracking.c

@@ -115,11 +115,11 @@ static bool prv_read_reset_info(sMfltResetReasonInfo *info) {
 //! @param reboot_reg_reason New reboot reason from this boot
 //! @param prior_stored_reason Prior reboot reason stored in s_mflt_reboot_info
 static void prv_record_reboot_reason(eMemfaultRebootReason reboot_reg_reason,
-                                     eMemfaultRebootReason prior_stored_reason) {
+                                     uint32_t prior_stored_reason) {
   s_reboot_reason_data.reboot_reg_reason = reboot_reg_reason;
 
   if (prior_stored_reason != (eMemfaultRebootReason)MEMFAULT_REBOOT_REASON_NOT_SET) {
-    s_reboot_reason_data.prior_stored_reason = prior_stored_reason;
+    s_reboot_reason_data.prior_stored_reason = (eMemfaultRebootReason)prior_stored_reason;
   } else {
     s_reboot_reason_data.prior_stored_reason = reboot_reg_reason;
   }

components/demo/src/memfault_demo_shell_commands.c

@@ -6,15 +6,14 @@
 //! @brief
 //! Command definitions for the minimal shell/console implementation.
 
-#include "memfault/demo/shell_commands.h"
-
 #include <stddef.h>
 
 #include "memfault/core/compiler.h"
 #include "memfault/core/data_export.h"
 #include "memfault/core/debug_log.h"
 #include "memfault/core/math.h"
 #include "memfault/demo/cli.h"
+#include "memfault/demo/shell_commands.h"
 
 static int prv_panics_component_required(void) {
   MEMFAULT_LOG_RAW("Disabled. panics component integration required");
@@ -44,28 +43,37 @@ int memfault_demo_cli_cmd_export(MEMFAULT_UNUSED int argc, MEMFAULT_UNUSED char
 
 static const sMemfaultShellCommand s_memfault_shell_commands[] = {
   {"clear_core", memfault_demo_cli_cmd_clear_core, "Clear an existing coredump"},
-  {"drain_chunks",  memfault_demo_drain_chunk_data, "Flushes queued Memfault data. To upload data see https://mflt.io/posting-chunks-with-gdb"},
-  {"export", memfault_demo_cli_cmd_export, "Export base64-encoded chunks. To upload data see https://mflt.io/chunk-data-export"},
+  {"drain_chunks", memfault_demo_drain_chunk_data,
+   "Flushes queued Memfault data. To upload data see https://mflt.io/posting-chunks-with-gdb"},
+  {"export", memfault_demo_cli_cmd_export,
+   "Export base64-encoded chunks. To upload data see https://mflt.io/chunk-data-export"},
   {"get_core", memfault_demo_cli_cmd_get_core, "Get coredump info"},
   {"get_device_info", memfault_demo_cli_cmd_get_device_info, "Get device info"},
 
   //
   // Test commands for validating SDK functionality: https://mflt.io/mcu-test-commands
   //
 
-  {"test_assert",  memfault_demo_cli_cmd_assert, "Trigger memfault assert"},
+  {"test_assert", memfault_demo_cli_cmd_assert, "Trigger memfault assert"},
+
+#if MEMFAULT_COMPILER_ARM_CORTEX_M
+  {"test_busfault", memfault_demo_cli_cmd_busfault, "Trigger a busfault"},
+  {"test_hardfault", memfault_demo_cli_cmd_hardfault, "Trigger a hardfault"},
+  {"test_memmanage", memfault_demo_cli_cmd_memmanage, "Trigger a memory management fault"},
+  {"test_usagefault", memfault_demo_cli_cmd_usagefault, "Trigger a usage fault"},
+#endif
 
-#if MEMFAULT_COMPILER_ARM
-  {"test_busfault",  memfault_demo_cli_cmd_busfault, "Trigger a busfault"},
-  {"test_hardfault",  memfault_demo_cli_cmd_hardfault, "Trigger a hardfault"},
-  {"test_memmanage",  memfault_demo_cli_cmd_memmanage, "Trigger a memory management fault"},
-  {"test_usagefault",  memfault_demo_cli_cmd_usagefault, "Trigger a usage fault"},
+#if MEMFAULT_COMPILER_ARM_V7_A_R
+  {"test_dataabort", memfault_demo_cli_cmd_dataabort, "Trigger a data abort"},
+  {"test_prefetchabort", memfault_demo_cli_cmd_prefetchabort, "Trigger a prefetch abort"},
 #endif
 
   {"test_log", memfault_demo_cli_cmd_test_log, "Writes test logs to log buffer"},
-  {"test_log_capture",  memfault_demo_cli_cmd_trigger_logs, "Trigger capture of current log buffer contents"},
-  {"test_reboot",  memfault_demo_cli_cmd_system_reboot, "Force system reset and track it with a trace event"},
-  {"test_trace",  memfault_demo_cli_cmd_trace_event_capture, "Capture an example trace event"},
+  {"test_log_capture", memfault_demo_cli_cmd_trigger_logs,
+   "Trigger capture of current log buffer contents"},
+  {"test_reboot", memfault_demo_cli_cmd_system_reboot,
+   "Force system reset and track it with a trace event"},
+  {"test_trace", memfault_demo_cli_cmd_trace_event_capture, "Capture an example trace event"},
 
   {"help", memfault_shell_help_handler, "Lists all commands"},
 };

components/demo/src/panics/memfault_demo_panics.c

@@ -121,7 +121,7 @@ int memfault_demo_cli_cmd_assert(int argc, char *argv[]) {
   }
 }
 
-#if MEMFAULT_COMPILER_ARM
+#if MEMFAULT_COMPILER_ARM_CORTEX_M
 
 int memfault_demo_cli_cmd_hardfault(MEMFAULT_UNUSED int argc, MEMFAULT_UNUSED char *argv[]) {
   memfault_arch_disable_configurable_faults();
@@ -178,4 +178,25 @@ int memfault_demo_cli_loadaddr(int argc, char *argv[]) {
   return 0;
 }
 
-#endif /* MEMFAULT_COMPILER_ARM */
+#endif  // MEMFAULT_COMPILER_ARM_CORTEX_M
+
+#if MEMFAULT_COMPILER_ARM_V7_A_R
+
+int memfault_demo_cli_cmd_dataabort(MEMFAULT_UNUSED int argc, MEMFAULT_UNUSED char *argv[]) {
+  // try to write to a read-only address
+  volatile int explode = *(int *)0xFFFFFFFF;
+
+  return explode | 1;
+}
+
+int memfault_demo_cli_cmd_prefetchabort(MEMFAULT_UNUSED int argc, MEMFAULT_UNUSED char *argv[]) {
+  // We can trip a PrefetchAbort exception by simply attempting to execute any addresss >=
+  // 0xE000.0000
+  void (*bad_func)(void) = (void (*)(void))0xEEEEDEAD;
+  bad_func();
+
+  // We should never get here -- platforms PrefetchAbort handler should be tripped
+  return -1;
+}
+
+#endif  // MEMFAULT_COMPILER_ARM_V7_A_R

components/include/memfault/core/compiler.h

@@ -21,31 +21,44 @@ extern "C" {
 // (i.e MEMFAULT_STATIC_STRLEN("abcd") == 4)
 #define MEMFAULT_STATIC_STRLEN(s) (sizeof(s) - 1)
 
-// A convenience macro that can be checked to see if the current compiler being used targets an
-// ARM-based architecture
+// Convenience macros for distinguishing ARM variants
 #if defined(__arm__) || defined(__ICCARM__) || defined(__TI_ARM__)
-#define MEMFAULT_COMPILER_ARM 1
+  #define MEMFAULT_COMPILER_ARM 1
 #else
-#define MEMFAULT_COMPILER_ARM 0
+  #define MEMFAULT_COMPILER_ARM 0
+#endif
+
+// Check for ARMv7-A/R target architecture
+#if MEMFAULT_COMPILER_ARM
+  #if defined(__ARM_ARCH_7R__) || defined(__ARM_ARCH_7A__)
+    #define MEMFAULT_COMPILER_ARM_V7_A_R 1
+  #else
+    #define MEMFAULT_COMPILER_ARM_V7_A_R 0
+  #endif
+
+  // If not Cortex-A/R, select Cortex-M family
+  #define MEMFAULT_COMPILER_ARM_CORTEX_M !MEMFAULT_COMPILER_ARM_V7_A_R
+#else
+  #define MEMFAULT_COMPILER_ARM_V7_A_R 0
+  #define MEMFAULT_COMPILER_ARM_CORTEX_M 0
 #endif
 
 //
 // Pick up compiler specific macro definitions
 //
 
 #if defined(__CC_ARM)
-#include "compiler_armcc.h"
+  #include "compiler_armcc.h"
 #elif defined(__TI_ARM__)
-#include "compiler_ti_arm.h"
+  #include "compiler_ti_arm.h"
 #elif defined(__GNUC__) || defined(__clang__)
-#include "compiler_gcc.h"
+  #include "compiler_gcc.h"
 #elif defined(__ICCARM__)
-#include "compiler_iar.h"
+  #include "compiler_iar.h"
 #else
-#  error "New compiler to add support for!"
+  #error "New compiler to add support for!"
 #endif
 
-
 #ifdef __cplusplus
 }
 #endif

components/include/memfault/core/compiler_gcc.h

@@ -37,7 +37,7 @@ extern "C" {
 #define MEMFAULT_UNUSED __attribute__((unused))
 #define MEMFAULT_USED __attribute__((used))
 #define MEMFAULT_WEAK __attribute__((weak))
-#define MEMFAULT_PRINTF_LIKE_FUNC(a, b) __attribute__ ((format (printf, a, b)))
+#define MEMFAULT_PRINTF_LIKE_FUNC(a, b) __attribute__ ((format (__printf__, a, b)))
 
 //! From https://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html,
 //!  If x is 0, the result is undefined.

components/include/memfault/core/compiler_ti_arm.h

@@ -30,7 +30,7 @@ extern "C" {
 #define MEMFAULT_UNUSED __attribute__((unused))
 #define MEMFAULT_USED __attribute__((used))
 #define MEMFAULT_WEAK __attribute__((weak))
-#define MEMFAULT_PRINTF_LIKE_FUNC(a, b) __attribute__ ((format (printf, a, b)))
+#define MEMFAULT_PRINTF_LIKE_FUNC(a, b) __attribute__ ((format (__printf__, a, b)))
 
 #define MEMFAULT_CLZ(a) ((a == 0) ? 32UL : (uint32_t)__clz(a))