tests/flash_api: Test for flash_mmap API call

Simple tests for flash_mmap API calls.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>

Author: de-nordic

tests/drivers/flash_api/src/main.c

@@ -20,12 +20,16 @@ static struct {
 	int ret;
 	/* Some size */
 	uint64_t size;
+	/* Device mmap test values */
+	void *mmap_base;
+	ssize_t mmap_size;
+	uint32_t mmap_flags;
 } simulated_values = {
 	.ret = 0,
 	.size = 0,
 };
 
-/*** Device definition atd == API Test Dev ***/
+/*** Device definition of API pseudo functions **/
 static int some_get_size(const struct device *dev, uint64_t *size)
 {
 	__ASSERT_NO_MSG(dev != NULL);
@@ -42,21 +46,53 @@ static int enotsup_get_size(const struct device *dev, uint64_t *size)
 	return -ENOTSUP;
 }
 
+static int some_mmap(const struct device *dev, void **base, uint64_t *size,
+		     uint32_t flags)
+{
+	__ASSERT_NO_MSG(dev != NULL);
+
+	if (flags != simulated_values.mmap_flags) {
+		return -EINVAL;
+	}
+
+	if (base == NULL || size == NULL) {
+		return -EINVAL;
+	}
+
+	*base = simulated_values.mmap_base;
+	*size = simulated_values.mmap_size;
+
+	return 0;
+}
+
+static int enotsup_mmap(const struct device *dev, void **base, uint64_t *size,
+			uint32_t flags)
+{
+	ARG_UNUSED(dev);
+	ARG_UNUSED(base);
+	ARG_UNUSED(size);
+	ARG_UNUSED(flags);
+
+	return 0;
+}
+
 /** Device objects **/
 /* The device state, just to make it "ready" device */
 static struct device_state some_dev_state = {
 	.init_res = 0,
 	.initialized = 1,
 };
 
-/* Device with get_size */
-static DEVICE_API(flash, size_fun_api) = {
+/* Device with implemented api calls */
+static DEVICE_API(flash, some_fun_api) = {
 	.get_size = some_get_size,
+	.mmap = some_mmap,
 };
-const static struct device size_fun_dev = {
-	"get_size",
+
+const static struct device some_fun_dev = {
+	"some_fun",
 	NULL,
-	&size_fun_api,
+	&some_fun_api,
 	&some_dev_state,
 };
 
@@ -72,6 +108,7 @@ const static struct device no_fun_dev = {
 /* Device with get_size implemented but returning -ENOTSUP */
 static DEVICE_API(flash, enotsup_fun_api) = {
 	.get_size = enotsup_get_size,
+	.mmap = enotsup_mmap,
 };
 static struct device enotsup_fun_dev = {
 	"enotsup",
@@ -85,14 +122,53 @@ ZTEST(flash_api, test_get_size)
 	uint64_t size = 0;
 
 	simulated_values.size = 45;
-	zassert_ok(flash_get_size(&size_fun_dev, &size), "Expected success");
+	zassert_ok(flash_get_size(&some_fun_dev, &size), "Expected success");
 	zassert_equal(size, simulated_values.size, "Size mismatch");
 	simulated_values.size = 46;
-	zassert_ok(flash_get_size(&size_fun_dev, &size), "Expected success");
+	zassert_ok(flash_get_size(&some_fun_dev, &size), "Expected success");
 	zassert_equal(size, simulated_values.size, "Size mismatch");
 	zassert_equal(flash_get_size(&no_fun_dev, &size), -ENOSYS);
 
 	zassert_equal(flash_get_size(&enotsup_fun_dev, &size), -ENOTSUP);
 }
 
+
+ZTEST(flash_api, test_flash_mmap)
+{
+	void *base = NULL;
+	uint64_t size = 0;
+
+	simulated_values.mmap_size = 40;
+	/* Just need some pointer */
+	simulated_values.mmap_base = (void *)&simulated_values;
+	/* 0 for error tests */
+	simulated_values.mmap_flags = 0;
+
+	zassert_equal(flash_mmap(&some_fun_dev, NULL, NULL, 0), -EINVAL);
+	zassert_equal(flash_mmap(&some_fun_dev, &base, NULL, 0), -EINVAL);
+	zassert_equal(flash_mmap(&some_fun_dev, NULL, &size, 0), -EINVAL);
+	zassert_equal(flash_mmap(&some_fun_dev, &base, &size, FLASH_MMAP_F_READ), -EINVAL);
+	zassert_equal(flash_mmap(&some_fun_dev, &base, &size, FLASH_MMAP_F_WRITE), -EINVAL);
+	zassert_equal(flash_mmap(&some_fun_dev, &base, &size,
+		      FLASH_MMAP_F_READ | FLASH_MMAP_F_WRITE), -EINVAL);
+
+	simulated_values.mmap_flags = FLASH_MMAP_F_READ;
+	zassert_equal(flash_mmap(&some_fun_dev, &base, &size, FLASH_MMAP_F_WRITE), -EINVAL);
+
+	simulated_values.mmap_flags = FLASH_MMAP_F_WRITE;
+	zassert_equal(flash_mmap(&some_fun_dev, &base, &size, FLASH_MMAP_F_READ), -EINVAL);
+
+	zassert_equal(flash_get_size(&enotsup_fun_dev, &size), -ENOTSUP);
+
+	/* After all failures the base and size are expected to be not modified */
+	zassert_equal(base, NULL);
+	zassert_equal(size, 0);
+
+	simulated_values.mmap_flags = FLASH_MMAP_F_READ;
+	zassert_ok(flash_mmap(&some_fun_dev, &base, &size, FLASH_MMAP_F_READ));
+	/* Expected values to be read by API and updated */
+	zassert_equal(base, simulated_values.mmap_base);
+	zassert_equal(size, simulated_values.mmap_size);
+}
+
 ZTEST_SUITE(flash_api, NULL, NULL, NULL, NULL, NULL);

tests/drivers/flash_api/testcase.yaml

@@ -17,5 +17,9 @@ tests:
       - driver
       - flash
       - userspace
+    platform_allow:
+      - nrf52840dk/nrf52840
+    integration_platforms:
+      - nrf52840dk/nrf52840
     extra_configs:
       - CONFIG_USERSPACE=y