net: lib: nrf_cloud: Add optional P-GPS data partition

Add a Kconfig choice for CONFIG_NRF_CLOUD_PGPS_STORAGE. Allow for
three choices: a new dedicated P-GPS subsystem partition, the older
reuse of the MCUboot secondary partition, or a custom option.

Add a new partition manager configuration for P-GPS which is used if
CONFIG_NRF_CLOUD_PGPS_STORAGE_PARTITION is enabled.

Enable P-GPS partition by default if CONFIG_BUILD_S1_VARIANT is enabled.

This defines new Kconfig symbols CONFIG_NRF_CLOUD_PGPS_PARTITION_ALIGN
and CONFIG_NRF_CLOUD_PGPS_PARTITION_SIZE. Any application-specified
values passed to the nrf_cloud_pgps_init() function are overridden with
either the dedicated P-GPS partition location or the MCUboot secondary
location, if CONFIG_NRF_CLOUD_PGPS_STORAGE_CUSTOM is not defined.

CONFIG_NRF_CLOUD_PGPS_PARTITION_ALIGN accesses the device tree to look
up the flash page size, and use that for aligning the P-GPS partition.

Add BUILD_ASSERT to ensure partition size is large enough based on the
configured number of predictions.

Pass any prediction found during initialization with the PGPS_EVT_READY
event, so callers can process injections sooner.

Signed-off-by: Pete Skeggs <[email protected]>

Author: plskeggs

subsys/net/lib/nrf_cloud/Kconfig.nrf_cloud_pgps

@@ -72,7 +72,7 @@ choice NRF_CLOUD_PGPS_TRANSPORT
 	default NRF_CLOUD_PGPS_TRANSPORT_NONE
 
 config NRF_CLOUD_PGPS_TRANSPORT_NONE
-	bool "No transport"
+	bool "Application-provided transport"
 	help
 	  Enabling this option will make the nRF Cloud P-GPS library not request
 	  data from nRF Cloud when its APIs are called. This will instead let
@@ -93,4 +93,59 @@ config NRF_CLOUD_PGPS_SOCKET_RETRIES
 	help
 	  This sets the maximum number of times to retry a download.
 
+choice NRF_CLOUD_PGPS_STORAGE
+	prompt "nRF Cloud P-GPS persistent storage location"
+	default NRF_CLOUD_PGPS_STORAGE_PARTITION if BUILD_S1_VARIANT
+	default NRF_CLOUD_PGPS_STORAGE_MCUBOOT_SECONDARY if BOARD_THINGY91_NRF9160_NS
+	help
+	  The P-GPS subsystem requires a contiguous section of flash memory in
+	  which to store predictions. The amount required is 2048 bytes times
+	  the number of predictions set by NRF_CLOUD_PGPS_NUM_PREDICTIONS.
+	  If mcuboot DFU is enabled, default to NRF_CLOUD_PGPS_STORAGE_PARTITION.
+	  Otherwise, P-GPS will prevent a successful mcuboot update, causing it
+	  to revert to the previous image.
+
+config NRF_CLOUD_PGPS_STORAGE_PARTITION
+	bool "Define P-GPS subsystem flash partition"
+	select PM_SINGLE_IMAGE if !SPM
+	help
+	  If set, allocates flash for storing predictions.
+
+config NRF_CLOUD_PGPS_STORAGE_MCUBOOT_SECONDARY
+	bool "Reuse MCUboot secondary partition for P-GPS storage"
+	depends on BOOTLOADER_MCUBOOT
+	depends on IMG_MANAGER
+	depends on !BUILD_S1_VARIANT
+	help
+	  If set, use the secondary MCUboot partition to also store P-GPS data.
+	  Note that when a FOTA job executes, this data will be lost and will
+	  have to be downloaded again after the FOTA job is complete. This is
+	  not compatible with FOTA updates of MUCboot itself, which is possible
+	  when SECURE_BOOT and BUILD_S1_VARIANT are enabled.
+
+config NRF_CLOUD_PGPS_STORAGE_CUSTOM
+	bool "Use application-provided location and size in flash"
+	help
+	  The application is responsible for providing the location in flash
+	  in which to store P-GPS data.  The location must be aligned to a
+	  flash page boundary (4096 bytes), and the size must be at least 2048
+	  bytes times NRF_COUND_PGPS_NUM_PREDICTIONS.
+
+endchoice # NRF_CLOUD_PGPS_STORAGE
+
+if NRF_CLOUD_PGPS_STORAGE_PARTITION
+
+config NRF_CLOUD_PGPS_PARTITION_SIZE
+	int "Size of flash partition for P-GPS data storage"
+	default 86016
+	help
+	  This must be >= NRF_CLOUD_PGPS_NUM_PREDICTIONS times 2048, which is
+	  the nRF9160 flash page size.
+
+config NRF_CLOUD_PGPS_PARTITION_ALIGN
+	hex "Align P-GPS partition to flash block boundary"
+	default $(dt_node_int_prop_hex,$(DT_CHOSEN_ZEPHYR_FLASH),erase-block-size)
+
+endif # NRF_CLOUD_PGPS_STORAGE_PARTITION
+
 endif # NRF_CLOUD_PGPS

subsys/net/lib/nrf_cloud/src/nrf_cloud_agps.c

@@ -219,9 +219,10 @@ int nrf_cloud_agps_request(const struct nrf_modem_gnss_agps_data_frame *request)
 
 int nrf_cloud_agps_request_all(void)
 {
+	const uint32_t mask = IS_ENABLED(CONFIG_NRF_CLOUD_PGPS) ? 0u : 0xFFFFFFFFu;
 	struct nrf_modem_gnss_agps_data_frame request = {
-		.sv_mask_ephe = 0xFFFFFFFF,
-		.sv_mask_alm = 0xFFFFFFFF,
+		.sv_mask_ephe = mask,
+		.sv_mask_alm = mask,
 		.data_flags =
 			NRF_MODEM_GNSS_AGPS_GPS_UTC_REQUEST |
 			NRF_MODEM_GNSS_AGPS_KLOBUCHAR_REQUEST |

subsys/net/lib/nrf_cloud/src/nrf_cloud_pgps.c

@@ -18,6 +18,7 @@
 #include <settings/settings.h>
 #include <sys/reboot.h>
 #include <logging/log_ctrl.h>
+#include <pm_config.h>
 
 #include <logging/log.h>
 
@@ -1341,6 +1342,7 @@ static int consume_pgps_data(uint8_t pnum, const char *buf, size_t buf_len)
 				if (evt_handler) {
 					struct nrf_cloud_pgps_event evt = {
 						.type = PGPS_EVT_READY,
+						.prediction = NULL
 					};
 
 					evt_handler(&evt);
@@ -1480,8 +1482,25 @@ int nrf_cloud_pgps_init(struct nrf_cloud_pgps_init_param *param)
 		.type = PGPS_EVT_INIT,
 	};
 
+#if defined(CONFIG_NRF_CLOUD_PGPS_STORAGE_PARTITION)
+	BUILD_ASSERT(CONFIG_NRF_CLOUD_PGPS_PARTITION_SIZE >=
+		 (CONFIG_NRF_CLOUD_PGPS_NUM_PREDICTIONS * BLOCK_SIZE),
+		 "P-GPS partition size is too small");
+	if (param->storage_base || param->storage_size) {
+		LOG_WRN("Overriding P-GPS storage with P-GPS partition");
+	}
+	param->storage_base = PM_PGPS_ADDRESS;
+	param->storage_size = PM_PGPS_SIZE;
+#elif defined(CONFIG_NRF_CLOUD_PGPS_STORAGE_MCUBOOT_SECONDARY)
+	if (param->storage_base || param->storage_size) {
+		LOG_WRN("Overriding P-GPS storage with MCUboot secondary partition");
+	}
+	param->storage_base = PM_MCUBOOT_SECONDARY_ADDRESS;
+	param->storage_size = PM_MCUBOOT_SECONDARY_SIZE;
+#endif
+
 	__ASSERT(param != NULL, "param must be provided");
-	__ASSERT(param->storage_base != 0, "storage must be provided");
+	__ASSERT(param->storage_base != 0u, "P-GPS flash storage must be provided");
 	__ASSERT((param->storage_size >= (NUM_BLOCKS * BLOCK_SIZE)),
 		 "insufficient storage provided; need at least %u bytes",
 		 (NUM_BLOCKS * BLOCK_SIZE));
@@ -1558,20 +1577,20 @@ int nrf_cloud_pgps_init(struct nrf_cloud_pgps_init_param *param)
 		num_valid = validate_stored_predictions(&gps_day, &gps_time_of_day);
 	}
 
-	struct nrf_cloud_pgps_prediction *test_prediction;
+	struct nrf_cloud_pgps_prediction *found_prediction = NULL;
 	int pnum = -1;
 
 	LOG_DBG("num_valid:%u, count:%u", num_valid, count);
 	if (num_valid) {
 		LOG_INF("Checking if P-GPS data is expired...");
-		err = nrf_cloud_pgps_find_prediction(&test_prediction);
+		err = nrf_cloud_pgps_find_prediction(&found_prediction);
 		if (err == -ETIMEDOUT) {
 			LOG_WRN("Predictions expired. Requesting predictions...");
 			num_valid = 0;
 		} else if (err >= 0) {
 			LOG_INF("Found valid prediction, day:%u, time:%u",
-				test_prediction->time.date_day,
-				test_prediction->time.time_full_s);
+				found_prediction->time.date_day,
+				found_prediction->time.time_full_s);
 			pnum = err;
 		}
 	}
@@ -1620,7 +1639,7 @@ int nrf_cloud_pgps_init(struct nrf_cloud_pgps_init_param *param)
 		LOG_INF("P-GPS data is up to date.");
 		if (evt_handler) {
 			evt.type = PGPS_EVT_READY;
-
+			evt.prediction = found_prediction;
 			evt_handler(&evt);
 		}
 		err = 0;

subsys/partition_manager/CMakeLists.txt

@@ -93,6 +93,9 @@ if (CONFIG_MEMFAULT_NCS_INTERNAL_FLASH_BACKED_COREDUMP)
   ncs_add_partition_manager_config(pm.yml.memfault)
 endif()
 
+if(CONFIG_NRF_CLOUD_PGPS_STORAGE_PARTITION)
+  ncs_add_partition_manager_config(pm.yml.pgps)
+endif()
 
 # We are using partition manager if we are a child image or if we are
 # the root image and the 'partition_manager' target exists.

subsys/partition_manager/pm.yml.pgps

@@ -0,0 +1,6 @@
+#include <autoconf.h>
+
+pgps:
+  placement: {before: [tfm_storage, end]}
+  size: CONFIG_NRF_CLOUD_PGPS_PARTITION_SIZE
+  align: {start: CONFIG_NRF_CLOUD_PGPS_PARTITION_ALIGN}