Memfault Firmware SDK 1.9.3 (Build 8266)

Memfault Inc · Memfault Inc · commit a41aef842128 · 2024-06-10T19:45:25.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,43 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.9.3] - 2024-06-10
+
+### :chart_with_upwards_trend: Improvements
+
+- ESP-IDF:
+
+  - The default Device Info Software Version (Kconfig
+    `CONFIG_MEMFAULT_DEVICE_INFO_SOFTWARE_VERSION`) has been updated to `0.0.0`
+    from `1.0.0-dev` for the built-in Device Info implementation. See
+    `menuconfig` or
+    [`ports/esp_idf/memfault/Kconfig`](ports/esp_idf/memfault/Kconfig) for
+    details. This should only affect users who are using the default value for
+    that Kconfig.
+
+  - Fix a bug when `CONFIG_MEMFAULT_LWIP_METRICS=y` that may cause invalid
+    metric values. LwIP stats by default are only 16-bits wide and this can
+    cause underflow when calculating heartbeat values. This fix forces
+    `LWIP_STATS_LARGE=1` to make LwIP use 32-bit counters.
+
+  - Add a feature to the [esp32 example app](examples/esp32) to enable
+    overriding the Memfault server URLs (ex: for a proxy).
+
+  - Improve docs and comments in example app
+
+- General:
+
+  - Updated the default exception handler name for Memory Management exceptions
+    from `MemoryManagement_Handler` to `MemManage_Handler` (set by
+    `MEMFAULT_EXC_HANDLER_MEMORY_MANAGEMENT` in
+    [`default_config.h`](components/include/memfault/default_config.h) when not
+    overridden by the user). This aligns with the more recent CMSIS naming
+    convention for exception handlers. A backwards-compatible implementation is
+    included to avoid breaking users relying on the previous default.
+
+  - Add [`libcurl`-based samples](examples/libcurl) for posting chunks to Memfault and
+    checking for latest OTA release.
+
 ## [1.9.2] - 2024-05-29
 
 ### :chart_with_upwards_trend: Improvements
diff --git a/VERSION b/VERSION
@@ -1,3 +1,3 @@
-BUILD ID: 8056
-GIT COMMIT: 398b8ca5a7
-VERSION: 1.9.2
+BUILD ID: 8266
+GIT COMMIT: 10085ffa3f
+VERSION: 1.9.3
diff --git a/components/include/memfault/default_config.h b/components/include/memfault/default_config.h
@@ -425,7 +425,7 @@ extern "C" {
 #endif
 
 #ifndef MEMFAULT_EXC_HANDLER_MEMORY_MANAGEMENT
-  #define MEMFAULT_EXC_HANDLER_MEMORY_MANAGEMENT MemoryManagement_Handler
+  #define MEMFAULT_EXC_HANDLER_MEMORY_MANAGEMENT MemManage_Handler
 #endif
 
 #ifndef MEMFAULT_EXC_HANDLER_BUS_FAULT
diff --git a/components/include/memfault/version.h b/components/include/memfault/version.h
@@ -19,8 +19,8 @@ typedef struct {
   uint8_t patch;
 } sMfltSdkVersion;
 
-#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 9, .patch = 2 }
-#define MEMFAULT_SDK_VERSION_STR "1.9.2"
+#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 9, .patch = 3 }
+#define MEMFAULT_SDK_VERSION_STR "1.9.3"
 
 #ifdef __cplusplus
 }
diff --git a/components/panics/src/memfault_fault_handling_arm.c b/components/panics/src/memfault_fault_handling_arm.c
@@ -260,6 +260,17 @@ void MEMFAULT_EXC_HANDLER_MEMORY_MANAGEMENT(void) {
   ALIGN
 }
 
+//! MemoryManagement_Handler() is the previous default name, supported for
+//! backwards compatibility
+#if !defined(MEMFAULT_DISABLE_OLD_MEMMANAGE_HANDLER)
+MEMFAULT_NAKED_FUNC void MemoryManagement_Handler(void) {
+  ldr r0, =0x9200 // kMfltRebootReason_MemFault
+  ldr r1, =memfault_fault_handling_shim
+  bx r1
+  ALIGN
+}
+#endif
+
 MEMFAULT_NAKED_FUNC
 void MEMFAULT_EXC_HANDLER_BUS_FAULT(void) {
   ldr r0, =0x9100 // kMfltRebootReason_BusFault
@@ -319,6 +330,12 @@ MEMFAULT_NAKED_FUNC void MEMFAULT_EXC_HANDLER_MEMORY_MANAGEMENT(void) {
   __asm(" mov r0, #0x9200 \n"  // kMfltRebootReason_MemFault
         " b memfault_fault_handling_shim \n");
 }
+    #if !defined(MEMFAULT_DISABLE_OLD_MEMMANAGE_HANDLER)
+MEMFAULT_NAKED_FUNC void MemoryManagement_Handler(void) {
+  __asm(" mov r0, #0x9200 \n"  // kMfltRebootReason_MemFault
+        " b memfault_fault_handling_shim \n");
+}
+    #endif
 
 MEMFAULT_NAKED_FUNC void MEMFAULT_EXC_HANDLER_BUS_FAULT(void) {
   __asm(" mov r0, #0x9100 \n"  // kMfltRebootReason_BusFault
@@ -397,6 +414,13 @@ MEMFAULT_NAKED_FUNC void MEMFAULT_EXC_HANDLER_MEMORY_MANAGEMENT(void) {
   MEMFAULT_HARDFAULT_HANDLING_ASM(kMfltRebootReason_MemFault);
 }
 
+    #if !defined(MEMFAULT_DISABLE_OLD_MEMMANAGE_HANDLER)
+MEMFAULT_NAKED_FUNC void MemoryManagement_Handler(void);
+MEMFAULT_NAKED_FUNC void MemoryManagement_Handler(void) {
+  MEMFAULT_HARDFAULT_HANDLING_ASM(kMfltRebootReason_MemFault);
+}
+    #endif
+
 MEMFAULT_NAKED_FUNC void MEMFAULT_EXC_HANDLER_BUS_FAULT(void) {
   MEMFAULT_HARDFAULT_HANDLING_ASM(kMfltRebootReason_BusFault);
 }
@@ -470,6 +494,13 @@ MEMFAULT_NAKED_FUNC void MEMFAULT_EXC_HANDLER_MEMORY_MANAGEMENT(void) {
   MEMFAULT_HARDFAULT_HANDLING_ASM(kMfltRebootReason_MemFault);
 }
 
+    #if !defined(MEMFAULT_DISABLE_OLD_MEMMANAGE_HANDLER)
+MEMFAULT_NAKED_FUNC void MemoryManagement_Handler(void);
+MEMFAULT_NAKED_FUNC void MemoryManagement_Handler(void) {
+  MEMFAULT_HARDFAULT_HANDLING_ASM(kMfltRebootReason_MemFault);
+}
+    #endif
+
 MEMFAULT_NAKED_FUNC void MEMFAULT_EXC_HANDLER_BUS_FAULT(void) {
   MEMFAULT_HARDFAULT_HANDLING_ASM(kMfltRebootReason_BusFault);
 }
diff --git a/examples/esp32/README.md b/examples/esp32/README.md
@@ -55,12 +55,12 @@ We assume you have a working setup for the
 ### Adding Memfault to the ESP-IDF SDK
 
 1. Delete the dummy esp-idf directory (if present) and clone a copy of the
-   v5.0.2 SDK.
+   v5.2.1 SDK.
 
    ```bash
    cd examples/esp32/
    rm -rf esp-idf
-   git clone -b v5.0.2 --recursive https://github.com/espressif/esp-idf.git esp-idf
+   git clone -b v5.2.1 --recursive https://github.com/espressif/esp-idf.git esp-idf
    cd esp-idf
    export IDF_TOOLS_PATH=$(pwd)
    # you may need to install the sdk tools by running ./install.sh here
diff --git a/examples/esp32/apps/memfault_demo_app/main/main.c b/examples/esp32/apps/memfault_demo_app/main/main.c
@@ -467,6 +467,20 @@ void app_main() {
     g_mflt_http_client_config.api_key = project_key;
   }
 
+  // Load chunks + device URLs from NVS too, only for esp_idf >=4
+  #if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 0, 0)
+  // Need to persist for the lifetime of the program
+  static char chunks_url[128] = { 0 };
+  static char device_url[128] = { 0 };
+  size_t chunks_url_len = sizeof(chunks_url);
+  size_t device_url_len = sizeof(device_url);
+  if ((settings_get(kSettingsChunksUrl, chunks_url, &chunks_url_len) == 0) &&
+      (settings_get(kSettingsDeviceUrl, device_url, &device_url_len) == 0)) {
+    g_mflt_http_client_config.chunks_api.host = (chunks_url_len > 1) ? chunks_url : NULL;
+    g_mflt_http_client_config.device_api.host = (device_url_len > 1) ? device_url : NULL;
+  }
+  #endif
+
   #if MEMFAULT_COMPACT_LOG_ENABLE
   MEMFAULT_COMPACT_LOG_SAVE(kMemfaultPlatformLogLevel_Info, "This is a compact log example");
   #endif
diff --git a/examples/esp32/apps/memfault_demo_app/main/ota_session_metrics.c b/examples/esp32/apps/memfault_demo_app/main/ota_session_metrics.c
@@ -57,7 +57,10 @@ int __wrap_mbedtls_net_recv(void *ctx, unsigned char *buf, size_t len) {
   return rv;
 }
 
-// This API was added in ESP-IDF v4.3.6, add a stub for earlier versions.
+// This API was added in ESP-IDF v4.3.6, v4.4.6, v5.0.4, and v5.1.1. Add a stub for versions
+// < v4.3.6. For simplicity, projects with versions > v4.3.6 but less than the patch the API was
+// added in for the corresponding minor version are not supported with this check. There will be a
+// build error due to a missing definition for the API.
 // https://github.com/espressif/esp32-wifi-lib/blob/release/v4.4/esp32/libnet80211.a
 #if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(4, 3, 6)
 esp_err_t esp_wifi_sta_get_rssi(int *rssi) {
diff --git a/examples/esp32/apps/memfault_demo_app/main/settings.c b/examples/esp32/apps/memfault_demo_app/main/settings.c
@@ -72,6 +72,20 @@ static const struct {
       .i32 = 500,
     },
   },
+  [kSettingsChunksUrl] = {
+    kSettingsTypeString,
+    "chunks_url",
+    {
+      .str = MEMFAULT_HTTP_CHUNKS_API_HOST,
+    },
+  },
+  [kSettingsDeviceUrl] = {
+    kSettingsTypeString,
+    "device_url",
+    {
+      .str = MEMFAULT_HTTP_DEVICE_API_HOST,
+    },
+  },
 };
 
 static bool prv_settings_key_is_valid(enum settings_key key) {
diff --git a/examples/esp32/apps/memfault_demo_app/main/settings.h b/examples/esp32/apps/memfault_demo_app/main/settings.h
@@ -17,6 +17,8 @@ enum settings_key {
   kSettingsProjectKey,
   kSettingsLedBrightness,
   kSettingsLedBlinkIntervalMs,
+  kSettingsChunksUrl,
+  kSettingsDeviceUrl,
 };
 
 #if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 0, 0)
diff --git a/examples/libcurl/README.md b/examples/libcurl/README.md
@@ -0,0 +1,6 @@
+# Memfault `libcurl` Samples
+
+This folder contains sample applications demonstrating how to interact with the
+Memfault Device API using `libcurl`.
+
+See the individual files for usage instructions.
diff --git a/examples/libcurl/get_latest.c b/examples/libcurl/get_latest.c
@@ -0,0 +1,167 @@
+//! @file
+//!
+//! Copyright (c) Memfault, Inc.
+//! See License.txt for details
+//!
+//! Example code that uses libcurl to fetch the latest release for an example
+//! device.
+//!
+//! Compiling: In Memfault UI, navigate to Settings->General Settings and
+//!  Copy/Paste "Project API Key" into PROJECT_KEY below:
+//!
+//!  $ gcc get_latest.c -lcurl -lssl -lcrypto -Wall -DMEMFAULT_PROJECT_KEY=\"PROJECT_KEY\"
+//!
+//! NOTE: Requires libcurl and libopenssl. On Debian, 'sudo apt install -y libcurl4-openssl-dev'
+//!
+//!  Usage:
+//!  $ ./a.out <device_serial> <hardware_version> <software_type> <current_version>
+//!
+//! NOTE: The device_serial, hardware_version, software_type, and
+//! current_version are mandatory, and must be valid for the test device. When
+//! testing cohort release activation, make sure the device_serial is present in
+//! the test cohort.
+
+#define _GNU_SOURCE  // for asprintf
+#include <assert.h>
+#include <curl/curl.h>
+#include <openssl/err.h>
+#include <openssl/ssl.h>
+#include <stdbool.h>
+#include <stdint.h>
+#include <stdio.h>
+
+#include "../../components/include/memfault/http/root_certs.h"
+
+#ifndef MEMFAULT_PROJECT_KEY
+  #error "MEMFAULT_PROJECT_KEY definition required"
+#endif
+
+//! Provide the CA cert from openssl directly as an in-memory cert, instead of
+//! retrieving from the default system certificate store.
+//!
+//! This strategy is adapted from the example here:
+//! https://github.com/curl/curl/blob/master/docs/examples/cacertinmem.c
+static CURLcode prv_install_root_certs(CURL *curl, void *sslctx, void *param) {
+  CURLcode rv = CURLE_ABORTED_BY_CALLBACK;
+
+  static const char mypem[] = MEMFAULT_ROOT_CERTS_DIGICERT_GLOBAL_ROOT_G2;
+
+  BIO *cbio = BIO_new_mem_buf(mypem, sizeof(mypem));
+  X509_STORE *cts = SSL_CTX_get_cert_store((SSL_CTX *)sslctx);
+  int i;
+  STACK_OF(X509_INFO) * inf;
+  (void)curl;
+  (void)param;
+
+  if (!cts || !cbio) {
+    return rv;
+  }
+
+  inf = PEM_X509_INFO_read_bio(cbio, NULL, NULL, NULL);
+
+  if (!inf) {
+    BIO_free(cbio);
+    return rv;
+  }
+
+  for (i = 0; i < sk_X509_INFO_num(inf); i++) {
+    X509_INFO *itmp = sk_X509_INFO_value(inf, i);
+    if (itmp->x509) {
+      X509_STORE_add_cert(cts, itmp->x509);
+    }
+    if (itmp->crl) {
+      X509_STORE_add_crl(cts, itmp->crl);
+    }
+  }
+
+  sk_X509_INFO_pop_free(inf, X509_INFO_free);
+  BIO_free(cbio);
+
+  rv = CURLE_OK;
+  return rv;
+}
+
+static int prv_get_latest_release(const char *device_serial, const char *hardware_version,
+                                  const char *software_type, const char *current_version,
+                                  bool verbose) {
+  CURLcode ret;
+  CURL *hnd;
+  struct curl_slist *slist1;
+
+  slist1 = NULL;
+  slist1 = curl_slist_append(slist1, "Memfault-Project-Key:" MEMFAULT_PROJECT_KEY);
+
+  hnd = curl_easy_init();
+
+  char *device_serial_ = curl_easy_escape(hnd, device_serial, 0);
+  char *hardware_version_ = curl_easy_escape(hnd, hardware_version, 0);
+  char *software_type_ = curl_easy_escape(hnd, software_type, 0);
+  char *current_version_ = curl_easy_escape(hnd, current_version, 0);
+
+  char *url;
+  int rv = asprintf(&url,
+                    "https://device.memfault.com/api/v0/releases/latest/url"
+                    "?device_serial=%s&hardware_version=%s&software_type=%s&current_version=%s",
+                    device_serial_, hardware_version_, software_type_, current_version_);
+  curl_free(device_serial_);
+  curl_free(hardware_version_);
+  curl_free(software_type_);
+  curl_free(current_version_);
+  assert(rv >= 0);
+  curl_easy_setopt(hnd, CURLOPT_URL, url);
+  free(url);
+
+  curl_easy_setopt(hnd, CURLOPT_NOPROGRESS, 1L);
+  curl_easy_setopt(hnd, CURLOPT_USERAGENT, "curl/8.5.0");
+  curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, slist1);
+  curl_easy_setopt(hnd, CURLOPT_MAXREDIRS, 50L);
+  curl_easy_setopt(hnd, CURLOPT_HTTP_VERSION, (long)CURL_HTTP_VERSION_2TLS);
+  curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
+  curl_easy_setopt(hnd, CURLOPT_TCP_KEEPALIVE, 1L);
+
+  /* Turn off the default CA locations, otherwise libcurl loads CA
+   * certificates from the locations that were detected/specified at
+   * build-time
+   */
+  curl_easy_setopt(hnd, CURLOPT_CAINFO, NULL);
+  curl_easy_setopt(hnd, CURLOPT_CAPATH, NULL);
+
+  curl_easy_setopt(hnd, CURLOPT_SSL_VERIFYPEER, 1L);
+  curl_easy_setopt(hnd, CURLOPT_SSL_VERIFYHOST, 1L);
+  curl_easy_setopt(hnd, CURLOPT_SSLCERTTYPE, "PEM");
+  curl_easy_setopt(hnd, CURLOPT_SSL_CTX_FUNCTION, prv_install_root_certs);
+
+  if (verbose) {
+    curl_easy_setopt(hnd, CURLOPT_VERBOSE, 1L);
+  }
+
+  ret = curl_easy_perform(hnd);
+
+  curl_easy_cleanup(hnd);
+  hnd = NULL;
+  curl_slist_free_all(slist1);
+  slist1 = NULL;
+
+  return (int)ret;
+}
+
+int main(int argc, char *argv[]) {
+  if (argc < 5) {
+    printf("Usage: %s <device_serial> <hardware_version> <software_type> <current_version>\n",
+           argv[0]);
+    return 1;
+  }
+
+  const char *device_serial = argv[1];
+  const char *hardware_version = argv[2];
+  const char *software_type = argv[3];
+  const char *current_version = argv[4];
+
+  int rv = prv_get_latest_release(device_serial, hardware_version, software_type, current_version,
+                                  true /* verbose */);
+  if (rv != 0) {
+    printf("ERROR: Get latest release failed, rv=%d\n", rv);
+  } else {
+    printf("\n\nSuccess!\n\n");
+  }
+}
diff --git a/examples/libcurl/post_chunks.c b/examples/libcurl/post_chunks.c
diff --git a/ports/dialog/da1469x/fault-handlers.patch b/ports/dialog/da1469x/fault-handlers.patch
diff --git a/ports/esp_idf/memfault/CMakeLists.txt b/ports/esp_idf/memfault/CMakeLists.txt
diff --git a/ports/esp_idf/memfault/Kconfig b/ports/esp_idf/memfault/Kconfig

Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,8 @@ typedef struct {`
`19`	`19`	`uint8_t patch;`
`20`	`20`	`} sMfltSdkVersion;`
`21`	`21`
`22`		`-#define MEMFAULT_SDK_VERSION { .major = 1, .minor = 9, .patch = 2 }`
`23`		`-#define MEMFAULT_SDK_VERSION_STR "1.9.2"`
	`22`	`+#define MEMFAULT_SDK_VERSION { .major = 1, .minor = 9, .patch = 3 }`
	`23`	`+#define MEMFAULT_SDK_VERSION_STR "1.9.3"`
`24`	`24`
`25`	`25`	`#ifdef __cplusplus`
`26`	`26`	`}`