modules: memfault: Improve support for custom device info

Adjust how CONFIG_MEMFAULT_DEVICE_INFO_BUILTIN is used to enable the
built-in implementation of memfault_platform_get_device_info(), so users
can more easily enable a custom version by setting
CONFIG_MEMFAULT_DEVICE_INFO_CUSTOM=y (no longer need to set placeholder
values for CONFIG_MEMFAULT_NCS_DEVICE_ID etc when custom device info is
selected).

Now it's possible to enable Memfault with less manual Kconfig settings
on short-range chips:

Before; we build with 'MEMFAULT_DEVICE_INFO_CUSTOM', but we still need
to set CONFIG_MEMFAULT_NCS_DEVICE_ID:

❯ west build --sysbuild --board nrf54l15dk/nrf54l15/cpuapp \
  --pristine=always \
  nrf/samples/bluetooth/peripheral_lbs \
  -- \
  -DCONFIG_SHELL=y \
  -DCONFIG_MEMFAULT=y \
  -DCONFIG_MEMFAULT_DEVICE_INFO_CUSTOM=y \
  -DCONFIG_HWINFO=y \
  -DCONFIG_MEMFAULT_NCS_DEVICE_ID=\"testserial\"

After, we can select 'CUSTOM' + 'HWINFO' to get a built-in device ID
from the Memfault SDK

❯ west build --sysbuild --board nrf54l15dk/nrf54l15/cpuapp \
  --pristine=always \
  nrf/samples/bluetooth/peripheral_lbs \
  -- \
  -DCONFIG_SHELL=y \
  -DCONFIG_MEMFAULT=y \
  -DCONFIG_MEMFAULT_NCS_DEVICE_INFO_CUSTOM=y \
  -DCONFIG_HWINFO=y  # HWINFO enables default Memfault device info

Device shell shows default values:

uart:~$ mflt get_device_info
I: S/N: nrf54l15-testserial
I: SW type: app
I: SW version: 3.0.99
I: HW version: nrf54l15dk

Rename these Kconfig options to better show they are in NCS, not the
Memfault module:

- MEMFAULT_DEVICE_INFO_BUILTIN -> MEMFAULT_NCS_DEVICE_INFO_BUILTIN
- MEMFAULT_DEVICE_INFO_CUSTOM -> MEMFAULT_NCS_DEVICE_INFO_CUSTOM

This is a breaking change (but will show up as a build error when
updating).

Signed-off-by: Noah Pendleton <[email protected]>

Author: noahp

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

@@ -750,7 +750,10 @@ Edge Impulse integration
 Memfault integration
 --------------------
 
-|no_changes_yet_note|
+* Updated:
+
+  * The ``CONFIG_MEMFAULT_DEVICE_INFO_CUSTOM`` Kconfig option has been renamed to :kconfig:option:`CONFIG_MEMFAULT_NCS_DEVICE_INFO_CUSTOM`.
+  * The ``CONFIG_MEMFAULT_DEVICE_INFO_BUILTIN`` Kconfig option has been renamed to :kconfig:option:`CONFIG_MEMFAULT_NCS_DEVICE_INFO_BUILTIN`.
 
 AVSystem integration
 --------------------

modules/memfault-firmware-sdk/Kconfig

@@ -20,7 +20,7 @@ config MEMFAULT_DEVICE_INFO_BUILTIN
 	help
 	  Use built-in Memfault Device Info implementation
 
-config MEMFAULT_DEVICE_INFO_CUSTOM
+config MEMFAULT_NCS_DEVICE_INFO_CUSTOM
 	bool "Custom user-defined Memfault Device Info implementation"
 	help
 	  Use custom user-defined Memfault Device Info implementation.
@@ -29,6 +29,8 @@ config MEMFAULT_DEVICE_INFO_CUSTOM
 
 endchoice
 
+if MEMFAULT_DEVICE_INFO_BUILTIN
+
 choice
 	prompt "Memfault device ID generation method"
 	default MEMFAULT_NCS_DEVICE_ID_IMEI if (BOARD_NRF9160DK_NRF9160_NS || BOARD_NRF9161DK_NRF9161_NS || BOARD_THINGY91_NRF9160_NS)
@@ -120,6 +122,8 @@ config MEMFAULT_NCS_FW_VERSION
 	 When using a statically configured firmware version, this value
 	 will be reported to Memfault
 
+endif  # MEMFAULT_DEVICE_INFO_BUILTIN
+
 config MEMFAULT_NCS_INIT_PRIORITY
 	int "Memfault initialization priority"
 	default 90

modules/memfault-firmware-sdk/memfault_integration.c

@@ -41,6 +41,18 @@ BUILD_ASSERT(sizeof(CONFIG_MEMFAULT_NCS_PROJECT_KEY) > 1,
 	"Memfault Project Key not configured. Please visit " MEMFAULT_URL " ");
 #endif
 
+extern void memfault_ncs_metrics_init(void);
+
+/* Memfault HTTP client configuration
+ *
+ * This symbol has public scope- it's used by the Memfault SDK when executing
+ * HTTP requests
+ */
+sMfltHttpClientConfig g_mflt_http_client_config = {
+	.api_key = CONFIG_MEMFAULT_NCS_PROJECT_KEY,
+};
+
+#if defined(CONFIG_MEMFAULT_DEVICE_INFO_BUILTIN)
 /* Firmware type check */
 BUILD_ASSERT(sizeof(CONFIG_MEMFAULT_NCS_FW_TYPE) > 1, "Firmware type must be configured");
 
@@ -63,13 +75,6 @@ BUILD_ASSERT(sizeof(CONFIG_MEMFAULT_NCS_FW_VERSION_STATIC) > 1,
 /* Hardware version check */
 BUILD_ASSERT(sizeof(CONFIG_MEMFAULT_NCS_HW_VERSION) > 1, "Hardware version must be configured");
 
-extern void memfault_ncs_metrics_init(void);
-
-sMfltHttpClientConfig g_mflt_http_client_config = {
-	.api_key = CONFIG_MEMFAULT_NCS_PROJECT_KEY,
-};
-
-#if defined(CONFIG_MEMFAULT_DEVICE_INFO_BUILTIN)
 void memfault_platform_get_device_info(sMemfaultDeviceInfo *info)
 {
 #if defined(CONFIG_MEMFAULT_NCS_FW_VERSION_AUTO)
@@ -98,6 +103,29 @@ void memfault_platform_get_device_info(sMemfaultDeviceInfo *info)
 		.hardware_version = CONFIG_MEMFAULT_NCS_HW_VERSION,
 	};
 }
+
+int memfault_ncs_device_id_set(const char *device_id, size_t len)
+{
+	if (!IS_ENABLED(CONFIG_MEMFAULT_NCS_DEVICE_ID_RUNTIME)) {
+		LOG_ERR("CONFIG_MEMFAULT_NCS_DEVICE_ID_RUNTIME is disabled");
+		return -ENOTSUP;
+	}
+
+	if (device_id == NULL) {
+		return -EINVAL;
+	}
+
+	if (len > (sizeof(device_serial) - 1)) {
+		LOG_ERR("Device ID is longer than CONFIG_MEMFAULT_NCS_DEVICE_ID_MAX_LEN");
+		LOG_WRN("The Memfault device ID will be truncated");
+	}
+
+	memcpy(device_serial, device_id, MIN(sizeof(device_serial) - 1, len));
+
+	device_serial[MIN(sizeof(device_serial) - 1, len)] = '\0';
+
+	return 0;
+}
 #endif /* defined(CONFIG_MEMFAULT_DEVICE_INFO_BUILTIN) */
 
 #if defined(CONFIG_MEMFAULT_NCS_DEVICE_ID_IMEI) || defined(CONFIG_MEMFAULT_NCS_DEVICE_ID_NET_MAC)
@@ -152,29 +180,6 @@ static int init(void)
 	return err;
 }
 
-int memfault_ncs_device_id_set(const char *device_id, size_t len)
-{
-	if (!IS_ENABLED(CONFIG_MEMFAULT_NCS_DEVICE_ID_RUNTIME)) {
-		LOG_ERR("CONFIG_MEMFAULT_NCS_DEVICE_ID_RUNTIME is disabled");
-		return -ENOTSUP;
-	}
-
-	if (device_id == NULL) {
-		return -EINVAL;
-	}
-
-	if (len > (sizeof(device_serial) - 1)) {
-		LOG_ERR("Device ID is longer than CONFIG_MEMFAULT_NCS_DEVICE_ID_MAX_LEN");
-		LOG_WRN("The Memfault device ID will be truncated");
-	}
-
-	memcpy(device_serial, device_id, MIN(sizeof(device_serial) - 1, len));
-
-	device_serial[MIN(sizeof(device_serial) - 1, len)] = '\0';
-
-	return 0;
-}
-
 #if defined(CONFIG_NRF_MODEM_LIB)
 NRF_MODEM_LIB_ON_INIT(memfault_ncs_init_hook, on_modem_lib_init, NULL);