subsys: fs: bm_zms: remove bm_zms_register

* Removes `bm_zms_register` and moves the event
  handler configuration into `bm_zms_fs_config`.

* Renames the `bm_zms_cb_t` type to `bm_zms_evt_handler_t`.

Signed-off-by: Mirko Covizzi <mirko.covizzi@nordicsemi.no>

Author: MirkoCovizzi

doc/nrf-bm/release_notes/release_notes_changelog.rst

@@ -125,7 +125,6 @@ Libraries
 
    * Updated:
 
-     * The :c:func:`bm_zms_register` function to return ``-EFAULT`` instead of ``-EINVAL`` when the input parameters are ``NULL``.
      * The :c:func:`bm_zms_mount` function to return ``-EFAULT`` when the input parameter ``fs`` is ``NULL``.
      * The :c:func:`bm_zms_clear` function to return ``-EFAULT`` when the input parameter ``fs`` is ``NULL``.
      * The :c:func:`bm_zms_write` function to return ``-EFAULT`` when the input parameter ``fs`` is ``NULL``.
@@ -145,6 +144,8 @@ Libraries
      * The ``CONFIG_BM_ZMS_MAX_USERS`` Kconfig option.
        Now the library expects at most one callback for each instance of the struct :c:struct:`bm_zms_fs`.
      * The ``bm_zms_init_flags.cb_registred`` member as it was not used anymore.
+     * The ``bm_zms_register`` function.
+       The event handler configuration is now done with the struct :c:struct:`bm_zms_fs_config`.
 
 * :ref:`lib_peer_manager` library:
 

include/bm/fs/bm_zms.h

@@ -76,7 +76,7 @@ struct bm_zms_init_flags {
  *
  * @param evt The event.
  */
-typedef void (*bm_zms_cb_t)(struct bm_zms_evt const *evt);
+typedef void (*bm_zms_evt_handler_t)(struct bm_zms_evt const *evt);
 
 /** Zephyr Memory Storage file system structure */
 struct bm_zms_fs {
@@ -106,8 +106,8 @@ struct bm_zms_fs {
 	struct bm_storage zms_bm_storage;
 	/** Number of writes currently handled by the storage system. */
 	atomic_t ongoing_writes;
-	/** User callback for propagating events. */
-	bm_zms_cb_t user_cb;
+	/** Event handler for propagating events. */
+	bm_zms_evt_handler_t evt_handler;
 #if CONFIG_BM_ZMS_LOOKUP_CACHE
 	/** Lookup table used to cache ATE addresses of written IDs. */
 	uint64_t lookup_cache[CONFIG_BM_ZMS_LOOKUP_CACHE_SIZE];
@@ -124,6 +124,8 @@ struct bm_zms_fs_config {
 	uint32_t sector_size;
 	/** Number of sectors in the file system. */
 	uint32_t sector_count;
+	/** Event handler for propagating events. */
+	bm_zms_evt_handler_t evt_handler;
 };
 
 /**
@@ -136,17 +138,6 @@ struct bm_zms_fs_config {
  * @{
  */
 
-/**
- * @brief Register a callback to BM_ZMS for handling events.
- *
- * @param fs Pointer to the file system structure.
- * @param cb Pointer to the event handler callback.
- *
- * @retval 0 on success.
- * @retval -EFAULT if @p fs or @p cb are NULL.
- */
-int bm_zms_register(struct bm_zms_fs *fs, bm_zms_cb_t cb);
-
 /**
  * @brief Mount a BM_ZMS file system.
  *

lib/bluetooth/peer_manager/modules/peer_data_storage.c

@@ -345,16 +345,11 @@ uint32_t pds_init(void)
 	/* Check for re-initialization if debugging. */
 	__ASSERT_NO_MSG(!module_initialized);
 
-	err = bm_zms_register(&fs, bm_zms_evt_handler);
-	if (err) {
-		LOG_ERR("Could not initialize NVM storage. bm_zms_register() returned %d.", err);
-		return NRF_ERROR_INTERNAL;
-	}
-
 	struct bm_zms_fs_config config = {
 		.offset = PEER_MANAGER_PARTITION_OFFSET,
 		.sector_size = CONFIG_PM_BM_ZMS_SECTOR_SIZE,
 		.sector_count = (PEER_MANAGER_PARTITION_SIZE / CONFIG_PM_BM_ZMS_SECTOR_SIZE),
+		.evt_handler = bm_zms_evt_handler,
 	};
 
 	err = bm_zms_mount(&fs, &config);

samples/subsys/fs/bm_zms/src/main.c

@@ -154,16 +154,11 @@ int main(void)
 		longarray[n] = n;
 	}
 
-	rc = bm_zms_register(&fs, bm_zms_sample_handler);
-	if (rc) {
-		LOG_ERR("Something is wrong %u", rc);
-		goto idle;
-	}
-
 	struct bm_zms_fs_config config = {
 		.offset = BM_ZMS_PARTITION_OFFSET,
 		.sector_size = CONFIG_APP_BM_ZMS_SECTOR_SIZE,
 		.sector_count = (BM_ZMS_PARTITION_SIZE / CONFIG_APP_BM_ZMS_SECTOR_SIZE),
+		.evt_handler = bm_zms_sample_handler
 	};
 
 	for (i = 0; i < CONFIG_APP_BM_ZMS_ITERATIONS_MAX; i++) {

subsys/fs/bm_zms/bm_zms.c

@@ -94,8 +94,8 @@ static void event_prepare(struct bm_zms_evt *evt)
 
 static void event_send(struct bm_zms_evt const *const evt, struct bm_zms_fs *fs)
 {
-	if (fs->user_cb != NULL) {
-		fs->user_cb(evt);
+	if (fs->evt_handler != NULL) {
+		fs->evt_handler(evt);
 	}
 }
 
@@ -185,7 +185,7 @@ static void queue_process(void)
 				/* bm_zms needs to be reinitialized after clearing */
 				cur_op.fs->init_flags.initialized = false;
 				cur_op.fs->init_flags.initializing = false;
-				cur_op.fs->user_cb = NULL;
+				cur_op.fs->evt_handler = NULL;
 				cur_op.op_completed = true;
 				result = 0;
 			} else {
@@ -320,17 +320,6 @@ static void zms_event_handler(struct bm_storage_evt *p_evt)
 	}
 }
 
-int bm_zms_register(struct bm_zms_fs *fs, bm_zms_cb_t cb)
-{
-	if (!fs || !cb) {
-		return -EFAULT;
-	}
-
-	fs->user_cb = cb;
-
-	return 0;
-}
-
 #ifdef CONFIG_BM_ZMS_LOOKUP_CACHE
 
 static inline size_t zms_lookup_cache_pos(uint32_t id)
@@ -2009,6 +1998,7 @@ int bm_zms_mount(struct bm_zms_fs *fs, const struct bm_zms_fs_config *config)
 	fs->offset = config->offset;
 	fs->sector_size = config->sector_size;
 	fs->sector_count = config->sector_count;
+	fs->evt_handler = config->evt_handler;
 
 	/* Initialize BM Storage */
 

tests/subsys/fs/bm_zms/src/main.c

@@ -31,6 +31,26 @@ struct bm_zms_fixture {
 };
 static bool nvm_is_full;
 
+void bm_zms_test_handler(struct bm_zms_evt const *evt)
+{
+	if (evt->evt_type == BM_ZMS_EVT_MOUNT) {
+		zassert_true(evt->result == 0, "bm_zms_mount call failure: %d",
+			     evt->result);
+	} else if ((evt->evt_type == BM_ZMS_EVT_WRITE) || (evt->evt_type == BM_ZMS_EVT_DELETE)) {
+		if (evt->result == 0) {
+			return;
+		}
+		if (evt->result == -ENOSPC) {
+			nvm_is_full = true;
+			return;
+		}
+		printf("BM_ZMS Error received %d\n", evt->result);
+	} else if (evt->evt_type == BM_ZMS_EVT_CLEAR) {
+		zassert_true(evt->result == 0, "bm_zms_clear call failure: %d",
+			     evt->result);
+	}
+}
+
 static void *setup(void)
 {
 	static struct bm_zms_fixture fixture;
@@ -39,6 +59,7 @@ static void *setup(void)
 	fixture.config.offset = TEST_PARTITION_START;
 	fixture.config.sector_size = SECTOR_SIZE;
 	fixture.config.sector_count = TEST_SECTOR_COUNT;
+	fixture.config.evt_handler = bm_zms_test_handler;
 
 	return &fixture;
 }
@@ -91,42 +112,8 @@ static void wait_for_init(struct bm_zms_fs *fs)
 	}
 }
 
-void bm_zms_test_handler(struct bm_zms_evt const *evt)
-{
-	if (evt->evt_type == BM_ZMS_EVT_MOUNT) {
-		zassert_true(evt->result == 0, "bm_zms_mount call failure: %d",
-			     evt->result);
-	} else if ((evt->evt_type == BM_ZMS_EVT_WRITE) || (evt->evt_type == BM_ZMS_EVT_DELETE)) {
-		if (evt->result == 0) {
-			return;
-		}
-		if (evt->result == -ENOSPC) {
-			nvm_is_full = true;
-			return;
-		}
-		printf("BM_ZMS Error received %d\n", evt->result);
-	} else if (evt->evt_type == BM_ZMS_EVT_CLEAR) {
-		zassert_true(evt->result == 0, "bm_zms_clear call failure: %d",
-			     evt->result);
-	}
-}
-
 ZTEST_SUITE(bm_zms, NULL, setup, before, after, NULL);
 
-ZTEST_F(bm_zms, test_bm_zms_register)
-{
-	int err;
-
-	err = bm_zms_register(NULL, &bm_zms_test_handler);
-	zassert_true(err == -EFAULT, "bm_zms_register unexpected failure");
-
-	err = bm_zms_register(&fixture->fs, NULL);
-	zassert_true(err == -EFAULT, "bm_zms_register unexpected failure");
-
-	err = bm_zms_register(&fixture->fs, &bm_zms_test_handler);
-	zassert_true(err == 0, "bm_zms_register call failure");
-}
-
 ZTEST_F(bm_zms, test_bm_zms_mount)
 {
 	int err;
@@ -166,9 +153,6 @@ ZTEST_F(bm_zms, test_bm_zms_write)
 {
 	int err;
 
-	err = bm_zms_register(&fixture->fs, &bm_zms_test_handler);
-	zassert_true(err == 0, "bm_zms_register call failure");
-
 	err = bm_zms_mount(&fixture->fs, &fixture->config);
 	zassert_true(err == 0, "zms_mount call failure: %d", err);
 	execute_long_pattern_write(TEST_DATA_ID, &fixture->fs);
@@ -186,9 +170,6 @@ ZTEST_F(bm_zms, test_zms_gc)
 
 	fixture->fs.sector_count = 2;
 
-	err = bm_zms_register(&fixture->fs, &bm_zms_test_handler);
-	zassert_true(err == 0, "bm_zms_register call failure");
-
 	err = bm_zms_mount(&fixture->fs, &fixture->config);
 	wait_for_init(&fixture->fs);
 	zassert_true(err == 0, "zms_mount call failure: %d", err);
@@ -287,9 +268,6 @@ ZTEST_F(bm_zms, test_zms_gc_3sectors)
 
 	fixture->config.sector_count = 3;
 
-	err = bm_zms_register(&fixture->fs, &bm_zms_test_handler);
-	zassert_true(err == 0, "bm_zms_register call failure err %x", err);
-
 	err = bm_zms_mount(&fixture->fs, &fixture->config);
 	wait_for_init(&fixture->fs);
 	zassert_true(err == 0, "bm_zms_mount call failure err %d", err);
@@ -363,9 +341,6 @@ ZTEST_F(bm_zms, test_zms_full_sector)
 
 	fixture->fs.sector_count = 3;
 
-	err = bm_zms_register(&fixture->fs, &bm_zms_test_handler);
-	zassert_true(err == 0, "bm_zms_register call failure");
-
 	err = bm_zms_mount(&fixture->fs, &fixture->config);
 	wait_for_init(&fixture->fs);
 	zassert_true(err == 0, "bm_zms_mount call failure");
@@ -419,9 +394,6 @@ ZTEST_F(bm_zms, test_delete)
 
 	fixture->fs.sector_count = 3;
 
-	err = bm_zms_register(&fixture->fs, &bm_zms_test_handler);
-	zassert_true(err == 0, "bm_zms_register call failure");
-
 	err = bm_zms_mount(&fixture->fs, &fixture->config);
 	wait_for_init(&fixture->fs);
 	zassert_true(err == 0, "bm_zms_mount call failure");
@@ -494,9 +466,6 @@ ZTEST_F(bm_zms, test_zms_cache_init)
 
 	/* Test cache initialization when the store is empty */
 
-	err = bm_zms_register(&fixture->fs, &bm_zms_test_handler);
-	zassert_true(err == 0, "bm_zms_register call failure");
-
 	fixture->fs.sector_count = 3;
 	err = bm_zms_mount(&fixture->fs, &fixture->config);
 	wait_for_init(&fixture->fs);
@@ -543,9 +512,6 @@ ZTEST_F(bm_zms, test_zms_cache_collission)
 	int err;
 	uint16_t data;
 
-	err = bm_zms_register(&fixture->fs, &bm_zms_test_handler);
-	zassert_true(err == 0, "bm_zms_register call failure");
-
 	fixture->fs.sector_count = 4;
 	err = bm_zms_mount(&fixture->fs, &fixture->config);
 	wait_for_init(&fixture->fs);
@@ -576,9 +542,6 @@ ZTEST_F(bm_zms, test_zms_cache_gc)
 	size_t num;
 	uint16_t data = 0;
 
-	err = bm_zms_register(&fixture->fs, &bm_zms_test_handler);
-	zassert_true(err == 0, "bm_zms_register call failure");
-
 	fixture->config.sector_count = 3;
 	err = bm_zms_mount(&fixture->fs, &fixture->config);
 	wait_for_init(&fixture->fs);
@@ -633,9 +596,6 @@ ZTEST_F(bm_zms, test_zms_cache_hash_quality)
 	uint32_t id;
 	uint16_t data;
 
-	err = bm_zms_register(&fixture->fs, &bm_zms_test_handler);
-	zassert_true(err == 0, "bm_zms_register call failure");
-
 	err = bm_zms_mount(&fixture->fs, &fixture->config);
 	wait_for_init(&fixture->fs);
 	zassert_true(err == 0, "bm_zms_mount call failure");
@@ -661,8 +621,6 @@ ZTEST_F(bm_zms, test_zms_cache_hash_quality)
 	err = bm_zms_clear(&fixture->fs);
 	zassert_true(err == 0, "bm_zms_clear call failure");
 
-	err = bm_zms_register(&fixture->fs, &bm_zms_test_handler);
-	zassert_true(err == 0, "bm_zms_register call failure");
 	err = bm_zms_mount(&fixture->fs, &fixture->config);
 	wait_for_init(&fixture->fs);
 	zassert_true(err == 0, "bm_zms_mount call failure");