Memfault Firmware SDK 1.3.4 (Build 3914)

Author: Memfault Inc

CHANGES.md

@@ -1,5 +1,31 @@
 # Memfault Firmware SDK Changelog
 
+## [1.3.4] - 2023-10-12
+
+### :chart_with_upwards_trend: Improvements
+
+- ESP-IDF:
+
+  - Add a missing dependency to the `memfault` component, `esp_https_ota`. It's
+    only linked into the target project if the `memfault_esp_port_ota_update()`
+    API is used. This was previously an implicit dependency from the `common`
+    component dependencies, when building `memfault` into an ESP-IDF
+    component-style project. This change fixes building for non-component-style
+    ESP-IDF projects, where the default component dependencies might not be
+    included.
+
+  - Multiple changes to the
+    [`examples/esp32`](examples/esp32/apps/memfault_demo_app) sample project:
+
+    - Add a new `coredump_size` shell command, which prints out the maximum
+      coredump size and the available coredump storage capacity.
+    - Add new `settings_[get|set]` shell commands, and enable setting the LED
+      brightness and blink interval to NVS. This is intended as a minor
+      quality-of-life change for internal Memfault users of the example app.
+
+- Fix a build error in the public unit tests, caused by the recent addition of
+  the `-fanalyzer` flag to the unit test compilation options.
+
 ## 1.3.3 - Oct 10, 2023
 
 ### :chart_with_upwards_trend: Improvements

VERSION

@@ -1,3 +1,3 @@
-BUILD ID: 3838
-GIT COMMIT: 86077d06f
-VERSION: 1.3.3
+BUILD ID: 3914
+GIT COMMIT: 18179b7fb
+VERSION: 1.3.4

components/include/memfault/version.h

@@ -19,8 +19,8 @@ typedef struct {
   uint8_t patch;
 } sMfltSdkVersion;
 
-#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 3, .patch = 3 }
-#define MEMFAULT_SDK_VERSION_STR "1.3.3"
+#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 3, .patch = 4 }
+#define MEMFAULT_SDK_VERSION_STR "1.3.4"
 
 #ifdef __cplusplus
 }

components/metrics/src/memfault_metrics.c

@@ -479,6 +479,13 @@ typedef enum {
 static bool prv_update_timer_metric(const sMemfaultMetricValueInfo *value_info,
                                     eMemfaultTimerOp op) {
   sMemfaultMetricValueMetadata *meta_datap = value_info->meta_datap;
+#if defined(MEMFAULT_UNITTEST)
+  // It's a programming error if we reach this point and meta_datap is NULL. It
+  // should always be valid for a timer metric class. Use c stdlib assert to
+  // prevent the static analyzer from triggering below.
+  #include <assert.h>
+  assert(meta_datap != NULL);
+#endif
   const bool timer_running = meta_datap->is_running;
 
   // The timer is not running _and_ we received a Start request

examples/esp32/README.md

@@ -240,6 +240,18 @@ occupied. Typically coredumps are cleared once they have been posted to the
 memfault cloud by using the `memfault_platform_coredump_storage_clear` function.
 You can invoke this command from the cli by running `clear_core`.
 
+### Checking coredump storage capacity
+
+Memfault coredumps will be written to the `coredump` partition by default. Use
+the `coredump_size` command to see the computed maximum coredump size, and the
+available storage capacity:
+
+```bash
+esp32> coredump_size
+coredump storage capacity: 262144B
+coredump size required: 456988B
+```
+
 ### Testing OTA
 
 The following steps can be used to exercise OTA functionality:

examples/esp32/apps/memfault_demo_app/main/CMakeLists.txt

@@ -4,6 +4,7 @@ list(APPEND
    cmd_system.c
    console_example_main.c
    led.c
+   settings.c
 )
 
 if (CONFIG_APP_MEMFAULT_TRANSPORT_HTTP)

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

@@ -14,6 +14,7 @@
 #include "esp_log.h"
 #include "freertos/FreeRTOS.h"
 #include "freertos/semphr.h"
+#include "memfault/components.h"
 #include "sdkconfig.h"
 
 //! cause the task watchdog to fire by deadlocking the example task
@@ -26,16 +27,31 @@ static int test_task_watchdog(int argc, char** argv) {
   return 0;
 }
 
-static void register_test_task_watchdog(void) {
-  const esp_console_cmd_t cmd = {
+static int prv_coredump_size(int argc, char** argv) {
+  (void)argc, (void)argv;
+
+  sMfltCoredumpStorageInfo storage_info = {0};
+  memfault_platform_coredump_storage_get_info(&storage_info);
+  const size_t size_needed = memfault_coredump_storage_compute_size_required();
+  printf("coredump storage capacity: %zuB\n", storage_info.size);
+  printf("coredump size required: %zuB\n", size_needed);
+  return 0;
+}
+
+void register_app(void) {
+  const esp_console_cmd_t test_watchdog_cmd = {
     .command = "test_task_watchdog",
     .help = "Demonstrate the task watchdog tripping on a deadlock",
     .hint = NULL,
     .func = &test_task_watchdog,
   };
-  ESP_ERROR_CHECK(esp_console_cmd_register(&cmd));
-}
+  ESP_ERROR_CHECK(esp_console_cmd_register(&test_watchdog_cmd));
 
-void register_app(void) {
-  register_test_task_watchdog();
+  const esp_console_cmd_t coredump_size_cmd = {
+    .command = "coredump_size",
+    .help = "Print the coredump storage capacity and the capacity required",
+    .hint = NULL,
+    .func = &prv_coredump_size,
+  };
+  ESP_ERROR_CHECK(esp_console_cmd_register(&coredump_size_cmd));
 }

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

@@ -16,8 +16,7 @@
 #include "esp_wifi.h"
 #include "freertos/FreeRTOS.h"
 #include "freertos/event_groups.h"
-#include "nvs.h"
-#include "nvs_flash.h"
+#include "settings.h"
 
 // enable for more verbose debug logs
 #define LOG_LOCAL_LEVEL ESP_LOG_DEBUG
@@ -180,71 +179,23 @@ static int connect(int argc, char **argv) {
   return 0;
 }
 
-static esp_err_t prv_open_nvs(nvs_handle_t* nvs_handle) {
-  // Initialize NVS
-  esp_err_t err = nvs_flash_init();
-  if (err == ESP_ERR_NVS_NO_FREE_PAGES || err == ESP_ERR_NVS_NEW_VERSION_FOUND) {
-    // NVS partition was truncated and needs to be erased
-    // Retry nvs_flash_init
-    ESP_ERROR_CHECK(nvs_flash_erase());
-    err = nvs_flash_init();
-  }
-  ESP_ERROR_CHECK(err);
-
-  // Open
-  err = nvs_open("storage", NVS_READWRITE, nvs_handle);
-  if (err != ESP_OK) {
-    ESP_LOGE(__func__, "Error (%s) opening NVS handle!", esp_err_to_name(err));
-    return err;
-  }
-
-  return ESP_OK;
-}
-
 //! Since the creds are set via cli, we can safely assume there's no null bytes
 //! in the password, despite being theoretically permissible by the spec
 static void prv_save_wifi_creds(const char* ssid, const char* password) {
-  // Initialize NVS
-  nvs_handle_t nvs_handle;
-  esp_err_t err = prv_open_nvs(&nvs_handle);
+  // length arg is ignored for string-type settings
+  esp_err_t err = settings_set(kSettingsWifiSsid, ssid, 0);
   if (err != ESP_OK) {
-    ESP_LOGE(__func__, "Error (%s) opening NVS handle!", esp_err_to_name(err));
-    return;
+    ESP_LOGE(__func__, "Error (%s) writing ssid to NVS!", esp_err_to_name(err));
   }
-
-  ESP_LOGD(__func__, "Opened NVS handle");
-
-  // Write
-  err = nvs_set_str(nvs_handle, "wifi_ssid", ssid);
+  err = settings_set(kSettingsWifiPassword, password, 0);
   if (err != ESP_OK) {
-    ESP_LOGE(__func__, "Error (%s) writing ssid to NVS!", esp_err_to_name(err));
-  } else {
-    ESP_LOGD(__func__, "Wrote ssid to NVS");
+    ESP_LOGE(__func__, "Error (%s) writing password to NVS!", esp_err_to_name(err));
   }
-  err = nvs_set_str(nvs_handle, "wifi_password", password);
   if (err == ESP_OK) {
-    if (err != ESP_OK) {
-      ESP_LOGE(__func__, "Error (%s) writing password to NVS!", esp_err_to_name(err));
-    } else {
-      ESP_LOGD(__func__, "Wrote password to NVS");
-    }
-  }
-
-  // Commit written value.
-  // After setting any values, nvs_commit() must be called to ensure changes are written
-  // to flash storage. Implementations may write to storage at other times,
-  // but this is not guaranteed.
-  err = nvs_commit(nvs_handle);
-  if (err != ESP_OK) {
-    ESP_LOGE(__func__, "Error (%s) committing NVS!", esp_err_to_name(err));
-  } else {
     ESP_LOGD(__func__, "Successfully saved new wifi creds");
     strncpy(s_wifi_ssid, ssid, sizeof(s_wifi_ssid) - 1);
     strncpy(s_wifi_pass, password, sizeof(s_wifi_pass) - 1);
   }
-
-  // Close
-  nvs_close(nvs_handle);
 }
 
 //! Return ssid + password pointers, or NULL if not found
@@ -260,41 +211,23 @@ void wifi_load_creds(char** ssid, char** password) {
   *ssid = NULL;
   *password = NULL;
 
-  // Initialize NVS
-  nvs_handle_t nvs_handle;
-  esp_err_t err = prv_open_nvs(&nvs_handle);
-  if (err != ESP_OK) {
-    ESP_LOGE(__func__, "Error (%s) opening NVS handle!", esp_err_to_name(err));
-    return;
-  }
-
-  ESP_LOGD(__func__, "Opened NVS handle");
-
-  // Read
   ESP_LOGD(__func__, "Reading wifi creds ... ");
   size_t len = sizeof(s_wifi_ssid);
-  err = nvs_get_str(nvs_handle, "wifi_ssid", s_wifi_ssid, &len);
-  if (err == ESP_OK) {
-    ESP_LOGD(__func__, "ssid size: %d", len);
-  } else {
+  esp_err_t err = settings_get(kSettingsWifiSsid, s_wifi_ssid, &len);
+  if (err != ESP_OK) {
     ESP_LOGE(__func__, "failed reading ssid");
-    goto close;
+    return;
   }
 
   len = sizeof(s_wifi_pass);
-  err = nvs_get_str(nvs_handle, "wifi_password", s_wifi_pass, &len);
-  if (err == ESP_OK) {
-    ESP_LOGD(__func__, "pw size: %d", len);
-  } else {
+  err = settings_get(kSettingsWifiPassword, s_wifi_pass, &len);
+  if (err != ESP_OK) {
     ESP_LOGE(__func__, "failed reading pw");
-    goto close;
+    return;
   }
 
   *ssid = s_wifi_ssid;
   *password = s_wifi_pass;
-
-close:
-  nvs_close(nvs_handle);
 }
 
 // argtable3 requires this data structure to be valid through the entire command
@@ -353,29 +286,8 @@ __attribute__((access(write_only, 1, 2))) int wifi_get_project_key(char* project
              MEMFAULT_PROJECT_KEY_LEN + 1);
     return 1;
   }
-
-  // Initialize NVS
-  nvs_handle_t nvs_handle;
-  esp_err_t err = prv_open_nvs(&nvs_handle);
-  if (err != ESP_OK) {
-    ESP_LOGE(__func__, "Error (%s) opening NVS handle!", esp_err_to_name(err));
-    return err;
-  }
-
-  ESP_LOGD(__func__, "Opened NVS handle");
-
-  // load the project key, if it exists
-  size_t len = project_key_len + 1;
-  err = nvs_get_str(nvs_handle, "project_key", project_key, &len);
-  if (err == ESP_OK) {
-    ESP_LOGD(__func__, "project key size: %d", len);
-  } else {
-    ESP_LOGE(__func__, "failed reading project key %d", err);
-  }
-
-  nvs_close(nvs_handle);
-
-  return err;
+  size_t len = project_key_len;
+  return settings_get(kSettingsProjectKey, project_key, &len);
 }
 
 __attribute__((access(read_only, 1, 2))) static esp_err_t prv_set_project_key(
@@ -384,39 +296,7 @@ __attribute__((access(read_only, 1, 2))) static esp_err_t prv_set_project_key(
   assert((project_key_len == MEMFAULT_PROJECT_KEY_LEN) &&
          (strlen(project_key) == MEMFAULT_PROJECT_KEY_LEN));
 
-  // Initialize NVS
-  nvs_handle_t nvs_handle;
-  esp_err_t err = prv_open_nvs(&nvs_handle);
-  if (err != ESP_OK) {
-    ESP_LOGE(__func__, "Error (%s) opening NVS handle!", esp_err_to_name(err));
-    return err;
-  }
-
-  ESP_LOGD(__func__, "Opened NVS handle");
-
-  // Write
-  err = nvs_set_str(nvs_handle, "project_key", project_key);
-  if (err != ESP_OK) {
-    ESP_LOGE(__func__, "Error (%s) writing project key to NVS!", esp_err_to_name(err));
-  } else {
-    ESP_LOGD(__func__, "Wrote project key to NVS");
-  }
-
-  // Commit written value.
-  // After setting any values, nvs_commit() must be called to ensure changes are written
-  // to flash storage. Implementations may write to storage at other times,
-  // but this is not guaranteed.
-  err = nvs_commit(nvs_handle);
-  if (err != ESP_OK) {
-    ESP_LOGE(__func__, "Error (%s) committing NVS!", esp_err_to_name(err));
-  } else {
-    ESP_LOGD(__func__, "Successfully saved new project key");
-  }
-
-  // Close
-  nvs_close(nvs_handle);
-
-  return err;
+  return settings_set(kSettingsProjectKey, project_key, project_key_len);
 }
 
 static int project_key_set(int argc, char** argv) {

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

@@ -33,6 +33,7 @@
 #include "memfault/esp_port/version.h"
 #include "nvs.h"
 #include "nvs_flash.h"
+#include "settings.h"
 
 static const char *TAG = "example";
 
@@ -363,6 +364,7 @@ void app_main() {
   register_system();
   register_wifi();
   register_app();
+  settings_register_shell_commands();
 
   // Attempt to load project key from nvs
   static char project_key[MEMFAULT_PROJECT_KEY_LEN + 1] = {0};