Memfault Firmware SDK 1.7.4 (Build 7065)

Author: Memfault Inc

CHANGELOG.md

@@ -6,6 +6,30 @@ 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.7.4] - 2024-03-26
+
+### :chart_with_upwards_trend: Improvements
+
+- nRF-Connect SDK:
+
+  - Update the Memfault SDK's nRF-Connect SDK
+    [example apps](examples/nrf-connect-sdk) to nRF-Connect SDK v2.6.0
+
+  - In the Memfault SDK [nRF9160 example app](examples/nrf-connect-sdk/nrf9160),
+    set the Kconfig flag `CONFIG_DOWNLOAD_CLIENT_HTTP_FRAG_SIZE_1024=y` in
+    `prj.conf` instead of via a conditional `CMakeLists.txt` expression. This
+    makes the setting more explicit for users that are referencing the sample
+    app.
+
+- ESP-IDF:
+
+  - Enable disabling the Memfault component by setting the `MEMFAULT_DISABLE=1`
+    environment variable in the build environment (ex:
+    `MEMFAULT_DISABLE=1 idf.py build`). This is useful in cases where the
+    Memfault component can not be n-selected in the application's root
+    `CMakeLists.txt` but needs to be conditionally excluded, for example when
+    building a reduced factory firmware image.
+
 ## [1.7.3] - 2024-03-19
 
 ### :chart_with_upwards_trend: Improvements
@@ -571,7 +595,7 @@ and this project adheres to
 
   - Improve the quality of Assert backtraces when using the ARM C Compiler v5.
     Certain frames in the assert call stack were missing link register
-    inforation, due to compiler optimizations based on the `noreturn` and
+    information, due to compiler optimizations based on the `noreturn` and
     unreachable compiler hints. These hints have been removed for `armcc`, which
     should permit full stack unwinding for Assert coredumps generated from
     builds on that toolchain.
@@ -1293,7 +1317,7 @@ are enough 🤞.
   - Add log capture during coredump to port
 
 - Demo CLI
-  - Add `mflt test loadaddr` command. This comamnd is used to test specific
+  - Add `mflt test loadaddr` command. This command is used to test specific
     faults due to protected regions
 
 #### :boom: Breaking Changes
@@ -1330,7 +1354,7 @@ are enough 🤞.
     with Kconfig
 
 - The [Heap Stats tracing component](https://mflt.io/mcu-heap-stats) has been
-  revamped to make more efficient usage of the bookeeping structure. Usage
+  revamped to make more efficient usage of the bookkeeping structure. Usage
   should be the same as before, but now should provide more data without
   significantly expanding the memory utilization.
 
@@ -1905,7 +1929,7 @@ Added clarifications around licensing in ports and examples folders. See
 
 - Update the STM32 QP/C example ([`examples/qp`](examples/qp)) to compile and
   run correctly now
-- Add intructions for exercising Memfault OTA in the ESP32 example, see the
+- Add instructions for exercising Memfault OTA in the ESP32 example, see the
   "Testing OTA" section in
   [`examples/esp32/README.md`](examples/esp32/README.md)
 - Update the Memfault HTTP client to URL-encode query params when checking for
@@ -2004,7 +2028,7 @@ Added clarifications around licensing in ports and examples folders. See
 
 - Updated
   [`modem_key_mgmt_exists`](ports/zephyr/ncs/src/memfault_nrf91_root_cert_storage.c)
-  API usage to be compatible with changes upcomming in nRF Connect SDK 1.8.
+  API usage to be compatible with changes upcoming in nRF Connect SDK 1.8.
 
 ### Changes between Memfault SDK 0.26.0 and SDK 0.25.0 - Sept 15, 2021
 
@@ -2202,7 +2226,7 @@ Added clarifications around licensing in ports and examples folders. See
 
 - Zephyr / nRF Connect SDK port:
   - Made periodic upload a named choice,
-    `MEMFAULT_HTTP_PERIODIC_UPLOAD_CONTEXT`, so the default can be overriden
+    `MEMFAULT_HTTP_PERIODIC_UPLOAD_CONTEXT`, so the default can be overridden
     from other Kconfig files.
   - Added prompt text for `MEMFAULT_HTTP_DEDICATED_WORKQUEUE_STACK_SIZE`
 
@@ -2423,7 +2447,7 @@ Added clarifications around licensing in ports and examples folders. See
 - Dialog DA1468x
   [QSPI coredump storage port](ports/dialog/da1468x/qspi_coredump_storage.c#L1)
   updates:
-  - default storage parition (`NVMS_LOG_PART`) can be overridden
+  - default storage partition (`NVMS_LOG_PART`) can be overridden
     `MEMFAULT_PLATFORM_COREDUMP_STORAGE_PARTITION`
   - Max space used within partition can be limited using
     `MEMFAULT_PLATFORM_COREDUMP_STORAGE_MAX_SIZE_BYTES`
@@ -2508,7 +2532,7 @@ Added clarifications around licensing in ports and examples folders. See
 #### :house: Internal
 
 - [Demo CLI Shell commands](components/demo/src/memfault_demo_shell_commands.c#L50)
-  are now defined as weak symbols so they can be overriden with a custom set.
+  are now defined as weak symbols so they can be overridden with a custom set.
 
 #### :boom: Breaking Changes
 
@@ -2848,8 +2872,8 @@ path needs to be updated to `examples`:
   [`ports/freertos/include/memfault/ports/freertos_coredump.h`](ports/freertos/include/memfault/ports/freertos_coredump.h)
 - Previously, if the Memfault event storage buffer was out of space, a "storage
   out of space" error would be printed every time. Now, an error message is
-  printed when the issue first happend and an info message is printed when space
-  is free again.
+  printed when the issue first happened and an info message is printed when
+  space is free again.
 - Added a reference software watchdog port for the STM32H7 series LPTIM
   peripheral. Users of the STM32 HAL can now compile in the reference port and
   the `MemfaultWatchdog_Handler`. The handler will save a coredump so the full
@@ -3062,7 +3086,7 @@ void record_temperature(void) {
 #### :chart_with_upwards_trend: Improvements
 
 - Fixed a :bug: that would cause the demo shell to get stuck if backspace
-  chracters were entered while no other characters had been entered.
+  characters were entered while no other characters had been entered.
 - Updated the [GDB chunk test utility](https://mflt.io/send-chunks-via-gdb) to
   automatically detect when the data export API is integrated and post-chunks to
   the cloud directly from GDB when the function is invoked.
@@ -3080,7 +3104,7 @@ void record_temperature(void) {
 
 #### :chart_with_upwards_trend: Improvements
 
-- Updated code to support compilations with `-Wunused-paramater`, GNU GCC's
+- Updated code to support compilations with `-Wunused-parameter`, GNU GCC's
   `-Wformat-signedness`, and Clang's `-Wno-missing-prototypes` &
   `-Wno-missing-variable-declarations`.
 - Updated unit test setup to compile with newly supported warnings treated as
@@ -3182,7 +3206,7 @@ void record_temperature(void) {
   also make use of two new APIs:
   - `memfault_build_info_dump()` can be called on boot to display the build that
     is running. This can be a useful way to sanity check that your debugger
-    succesfully flashed a new image.
+    successfully flashed a new image.
   - `memfault_build_info_read()` can be used to read the build id for your own
     use cases. For example you could append a portion of it to a debug version
     to make it unique.
@@ -3219,7 +3243,7 @@ void record_temperature(void) {
 
 - Added an assert used internally by the SDK which makes it easier to debug API
   misuse during bringup. The assert is enabled by default but can easily be
-  disabled or overriden. For more details see
+  disabled or overridden. For more details see
   [`memfault/core/sdk_assert.h`](components/include/memfault/core/sdk_assert.h#L6).
 - Added a default implementation of
   [`memfault_platform_halt_if_debugging()`](components/core/src/arch_arm_cortex_m.c#L20-L34)

VERSION

@@ -1,3 +1,3 @@
-BUILD ID: 6923
-GIT COMMIT: 47bd79f60f
-VERSION: 1.7.3
+BUILD ID: 7065
+GIT COMMIT: 3940f71502
+VERSION: 1.7.4

components/core/README.md

@@ -46,7 +46,7 @@ your project.
   touched by any firmware except for reboot tracking API functions. Reboot info
   can be pushed to the event storage for packetization to be sent to Memfault.
 
-# `memfault_trace_event_boot()`: not an allocation but connects a trace event context into the event storge allocation.
+# `memfault_trace_event_boot()`: not an allocation but connects a trace event context into the event storage allocation.
 
 - `memfault_log_boot()` to reserve storage for the logging module. The logging
   storage gets sent to Memfault as part of the core dump data if enabled.

components/core/src/memfault_build_id_private.h

@@ -58,7 +58,7 @@ MEMFAULT_STATIC_ASSERT(((offsetof(sMemfaultBuildIdStorage, type) == 0) &&
 extern MEMFAULT_BUILD_ID_QUALIFIER sMemfaultBuildIdStorage g_memfault_build_id;
 extern MEMFAULT_BUILD_ID_QUALIFIER uint8_t g_memfault_sdk_derived_build_id[];
 
-//! The layout of a Note section in an ELF. This is how Build Id information is layed out when
+//! The layout of a Note section in an ELF. This is how Build Id information is laid out when
 //! using kMemfaultBuildIdType_GnuBuildIdSha1
 typedef MEMFAULT_PACKED_STRUCT {
   uint32_t namesz;

components/demo/src/panics/memfault_demo_panics.c

@@ -162,7 +162,7 @@ int memfault_demo_cli_cmd_memmanage(MEMFAULT_UNUSED int argc, MEMFAULT_UNUSED ch
   //  System space, that is, for addresses 0xE0000000 and higher. System space is always marked as
   //  XN, Execute Never."
   //
-  // So we can trip a MemManage exception by simply attempting to execute any addresss >=
+  // So we can trip a MemManage exception by simply attempting to execute any address >=
   // 0xE000.0000
   void (*bad_func)(void) = (void (*)(void))0xEEEEDEAD;
   bad_func();
@@ -213,7 +213,7 @@ int memfault_demo_cli_cmd_dataabort(MEMFAULT_UNUSED int argc, MEMFAULT_UNUSED ch
 }
 
 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 >=
+  // We can trip a PrefetchAbort exception by simply attempting to execute any address >=
   // 0xE000.0000
   void (*bad_func)(void) = (void (*)(void))0xEEEEDEAD;
   bad_func();

components/include/memfault/core/compiler_gcc.h

@@ -83,7 +83,7 @@ extern "C" {
   // NB: OSX linker has slightly different placement syntax and requirements
   //
   // Notably,
-  // 1. Comma seperated where first item is top level section (i.e __DATA), i.e
+  // 1. Comma separated where first item is top level section (i.e __DATA), i.e
   //   __attribute__((section("__DATA," x)))
   // 2. total length of name must be between 1-16 characters
   //

components/include/memfault/core/custom_data_recording.h

@@ -99,7 +99,7 @@ typedef struct MemfaultCdrSourceImpl {
   //! @param data The buffer to populate with CDR data
   //! @param data_len The size of data to fill in the buffer
   //!
-  //! return true if read was succesful and buf was entirely filled, false otherwise
+  //! return true if read was successful and buf was entirely filled, false otherwise
   bool (*read_data_cb)(uint32_t offset, void *data, size_t data_len);
 
   //! Called once the recording has been processed
@@ -116,7 +116,7 @@ typedef struct MemfaultCdrSourceImpl {
 //! @note We recommend invoking this function at bootup and expect that the "impl" passed
 //! is of static or global scope
 //!
-//! @return true if registration was succesful or false if the storage was full. If false is
+//! @return true if registration was successful or false if the storage was full. If false is
 //! returned MEMFAULT_CDR_MAX_DATA_SOURCES needs to be increased.
 bool memfault_cdr_register_source(const sMemfaultCdrSourceImpl *impl);
 

components/include/memfault/core/errors.h

@@ -37,7 +37,7 @@ typedef enum MemfaultInternalReturnCode {
 //! A convenience macro for mapping a platform specific error code to a reserved range. For
 //! example, this could be used to map the error codes returned from calls to a MCUs flash driver
 //! implementation. This way, meaningful error information can still be surfaced for diagnostics.
-//! The goal here is to allow a way to avoid the following pattern where a userful error code
+//! The goal here is to allow a way to avoid the following pattern where a useful error code
 //! always gets mapped down to one value, i.e
 //!
 //! int rv = some_platform_specific_api()

components/include/memfault/core/log.h

@@ -193,7 +193,7 @@ void memfault_log_export_logs(void);
 //! Called as part of memfault_log_export() for every time a log message needs to be exported.
 //!
 //! @note This is a weak function that by default calls `memfault_platform_log_raw`. It can be
-//! overriden to change the formatting of the output, as well as where it is stored.
+//! overridden to change the formatting of the output, as well as where it is stored.
 extern void memfault_log_export_msg(eMemfaultPlatformLogLevel level, const char *msg,
                                     size_t msg_len);
 

components/include/memfault/core/platform/overrides.h

@@ -6,7 +6,7 @@
 //! See License.txt for details
 //!
 //! @brief
-//! Functions that can be optionally overriden by the user of the SDK.
+//! Functions that can be optionally overridden by the user of the SDK.
 //!
 //! Default "weak function" stub definitions are provided for each of these functions
 //! in the SDK itself