Memfault Firmware SDK 1.11.5 (Build 10200)

Author: Memfault Inc

CHANGELOG.md

@@ -166,6 +166,6 @@ the top for build & test coverage status of the `master` branch.
 ## License
 
 Unless specifically indicated otherwise in a file, all memfault-firmware-sdk
-files are all licensed under the [Memfault License](/License.txt). (A few files
-in the [examples](/examples) and [ports](/ports) directory are licensed
-differently based on vendor requirements.)
+files are all licensed under the [Memfault License](/LICENSE). (A few files in
+the [examples](/examples) and [ports](/ports) directory are licensed differently
+based on vendor requirements.)

License.txt renamed to LICENSE

@@ -1,3 +1,3 @@
-BUILD ID: local
-GIT COMMIT: a3e5d59615c
-VERSION: 1.11.4
+BUILD ID: 10200
+GIT COMMIT: 432492ab6b
+VERSION: 1.11.5

README.md

@@ -1,7 +1,7 @@
 //! @file
 //!
 //! Copyright (c) Memfault, Inc.
-//! See License.txt for details
+//! See LICENSE for details
 
 #include <stdint.h>
 

VERSION

@@ -1,7 +1,7 @@
 //! @file
 //!
 //! Copyright (c) Memfault, Inc.
-//! See License.txt for details
+//! See LICENSE for details
 //!
 
 #include <string.h>

components/core/src/arch_arm_cortex_m.c

@@ -1,7 +1,7 @@
 //! @file
 //!
 //! Copyright (c) Memfault, Inc.
-//! See License.txt for details
+//! See LICENSE for details
 //!
 //! @brief
 //! See header for more details
@@ -13,6 +13,37 @@
 #include "memfault/core/build_info.h"
 #include "memfault_build_id_private.h"
 
+// OS version information
+#if defined(MEMFAULT_OS_VERSION_NAME) ^ defined(MEMFAULT_OS_VERSION_STRING)
+  #error "MEMFAULT_OS_VERSION_NAME and MEMFAULT_OS_VERSION_STRING must be both defined or undefined"
+#elif !(defined(MEMFAULT_OS_VERSION_NAME) && defined(MEMFAULT_OS_VERSION_STRING))
+  #if defined(__ZEPHYR__)
+    // Either Zephyr or NCS. We can then rely on the GNU __has_include extension to
+    // be available.
+    #if __has_include("ncs_version.h")
+      #include "ncs_version.h"
+      #define MEMFAULT_OS_VERSION_NAME "ncs"
+      #define MEMFAULT_OS_VERSION_STRING NCS_VERSION_STRING
+    #else
+      // This is Zephyr's version.h file, since Memfault's is namespaced as
+      // "memfault/version.h".
+      #include <version.h>
+      #define MEMFAULT_OS_VERSION_NAME "zephyr"
+      #define MEMFAULT_OS_VERSION_STRING KERNEL_VERSION_STRING
+    #endif /* __has_include("ncs_version.h") */
+
+  #elif defined(ESP_PLATFORM)
+    // ESP-IDF, use the command-line defined IDF_VER string
+    #define MEMFAULT_OS_VERSION_NAME "esp-idf"
+    #define MEMFAULT_OS_VERSION_STRING IDF_VER
+  #else
+    // No OS version information available
+    #define MEMFAULT_OS_VERSION_NAME ""
+    #define MEMFAULT_OS_VERSION_STRING ""
+  #endif /* defined(__ZEPHYR__) */
+#endif   /* defined(MEMFAULT_OS_VERSION_NAME) ^ defined(MEMFAULT_OS_VERSION_STRING) \
+          */
+
 #if MEMFAULT_USE_GNU_BUILD_ID
 
 // Note: This variable is emitted by the linker script
@@ -24,6 +55,10 @@ MEMFAULT_BUILD_ID_QUALIFIER sMemfaultBuildIdStorage g_memfault_build_id = {
   .short_len = MEMFAULT_EVENT_INCLUDED_BUILD_ID_SIZE_BYTES,
   .storage = MEMFAULT_GNU_BUILD_ID_SYMBOL,
   .sdk_version = MEMFAULT_SDK_VERSION,
+  .os_version = {
+    .name = MEMFAULT_OS_VERSION_NAME,
+    .version = MEMFAULT_OS_VERSION_STRING,
+  },
 };
 #else
 
@@ -38,5 +73,9 @@ MEMFAULT_BUILD_ID_QUALIFIER sMemfaultBuildIdStorage g_memfault_build_id = {
   .short_len = MEMFAULT_EVENT_INCLUDED_BUILD_ID_SIZE_BYTES,
   .storage = g_memfault_sdk_derived_build_id,
   .sdk_version = MEMFAULT_SDK_VERSION,
+  .os_version = {
+    .name = MEMFAULT_OS_VERSION_NAME,
+    .version = MEMFAULT_OS_VERSION_STRING,
+  },
 };
 #endif

components/core/src/memfault_batched_events.c

@@ -3,7 +3,7 @@
 //! @file
 //!
 //! Copyright (c) Memfault, Inc.
-//! See License.txt for details
+//! See LICENSE for details
 //!
 //! @brief
 //! Internal file that should never be included by a consumer of the SDK. See
@@ -33,6 +33,11 @@ typedef enum {
   kMemfaultBuildIdType_MemfaultBuildIdSha1 = 3,
 } eMemfaultBuildIdType;
 
+typedef struct {
+  const char *name;
+  const char *version;
+} sMfltOsVersion;
+
 typedef struct {
   uint8_t type;  // eMemfaultBuildIdType
   uint8_t len;
@@ -41,6 +46,7 @@ typedef struct {
   uint8_t rsvd;
   const void *storage;
   const sMfltSdkVersion sdk_version;
+  const sMfltOsVersion os_version;
 } sMemfaultBuildIdStorage;
 
 MEMFAULT_STATIC_ASSERT(((offsetof(sMemfaultBuildIdStorage, type) == 0) &&

components/core/src/memfault_build_id.c

@@ -1,7 +1,7 @@
 //! @file
 //!
 //! Copyright (c) Memfault, Inc.
-//! See License.txt for details
+//! See LICENSE for details
 
 #include <stdarg.h>
 #include <stdio.h>

components/core/src/memfault_build_id_private.h

@@ -1,7 +1,7 @@
 //! @file
 //!
 //! Copyright (c) Memfault, Inc.
-//! See License.txt for details
+//! See LICENSE for details
 //!
 //! @brief