diff --git a/include/data_fifo.h b/include/data_fifo.h index ea5b33bb3ff5..e6a323e1d4b2 100644 --- a/include/data_fifo.h +++ b/include/data_fifo.h @@ -43,14 +43,14 @@ struct data_fifo { #define DATA_FIFO_DEFINE(name, elements_max_in, block_size_max_in) \ char __aligned(WB_UP(1)) \ - _msgq_buffer_##name[(elements_max_in) * sizeof(struct data_fifo_msgq)] = { 0 }; \ + _msgq_buffer_##name[(elements_max_in) * sizeof(struct data_fifo_msgq)] = {0}; \ char __aligned(WB_UP(1)) \ - _slab_buffer_##name[(elements_max_in) * (block_size_max_in)] = { 0 }; \ - struct data_fifo name = { .msgq_buffer = _msgq_buffer_##name, \ - .slab_buffer = _slab_buffer_##name, \ - .block_size_max = block_size_max_in, \ - .elements_max = elements_max_in, \ - .initialized = false } + _slab_buffer_##name[(elements_max_in) * (block_size_max_in)] = {0}; \ + struct data_fifo name = {.msgq_buffer = _msgq_buffer_##name, \ + .slab_buffer = _slab_buffer_##name, \ + .block_size_max = block_size_max_in, \ + .elements_max = elements_max_in, \ + .initialized = false} /** * @brief Get pointer to the first vacant block in slab. @@ -150,6 +150,18 @@ int data_fifo_num_used_get(struct data_fifo *data_fifo, uint32_t *alloced_num, */ int data_fifo_empty(struct data_fifo *data_fifo); +/** + * @brief Deinitialise the data_fifo. + * + * @note The fifo is emptied first, so it is the users responsibility to release any data items it + * has queued. The internal slab and message buffer are not released. + * + * @param data_fifo Pointer to the data_fifo structure. + * + * @retval 0 if success, error otherwise. + */ +int data_fifo_deinit(struct data_fifo *data_fifo); + /** * @brief Initialise the data_fifo. * diff --git a/lib/data_fifo/data_fifo.c b/lib/data_fifo/data_fifo.c index a3f77be96f9d..1c1b7dc3299c 100644 --- a/lib/data_fifo/data_fifo.c +++ b/lib/data_fifo/data_fifo.c @@ -167,6 +167,22 @@ int data_fifo_empty(struct data_fifo *data_fifo) return 0; } +int data_fifo_deinit(struct data_fifo *data_fifo) +{ + __ASSERT_NO_MSG(data_fifo != NULL); + __ASSERT_NO_MSG(data_fifo->initialized); + int ret; + + ret = data_fifo_empty(data_fifo); + if (ret) { + return ret; + } + + data_fifo->initialized = false; + + return 0; +} + int data_fifo_init(struct data_fifo *data_fifo) { __ASSERT_NO_MSG(data_fifo != NULL); diff --git a/tests/lib/data_fifo/src/main.c b/tests/lib/data_fifo/src/main.c index 885cb8ad36c1..9bb6d20bc870 100644 --- a/tests/lib/data_fifo/src/main.c +++ b/tests/lib/data_fifo/src/main.c @@ -31,6 +31,21 @@ static void internal_test_remaining_elements(struct data_fifo *data_fifo, uint32 num_locked, line); } +ZTEST(suite_data_fifo, test_data_fifo_deinit_ok) +{ + DATA_FIFO_DEFINE(data_fifo, 8, 128); + + int ret; + + ret = data_fifo_init(&data_fifo); + zassert_equal(ret, 0, "init did not return 0"); + zassert_equal(data_fifo->initialized, true, "init did not set initialise flag"); + + ret = data_fifo_deinit(&data_fifo); + zassert_equal(ret, 0, "deinit did not return 0"); + zassert_equal(data_fifo->initialized, false, "deinit did not reset initialise flag"); +} + ZTEST(suite_data_fifo, test_data_fifo_init_ok) { DATA_FIFO_DEFINE(data_fifo, 8, 128); @@ -61,7 +76,7 @@ ZTEST(suite_data_fifo, test_data_fifo_data_put_get_ok) data_ptr[2] = 0xa3; data_ptr[3] = 0xa4; data_ptr[4] = 0xa5; - uint8_t data_1[DATA_SIZE] = { 0xa1, 0xa2, 0xa3, 0xa4, 0xa5 }; + uint8_t data_1[DATA_SIZE] = {0xa1, 0xa2, 0xa3, 0xa4, 0xa5}; internal_test_remaining_elements(&data_fifo, 1, 0, __LINE__); @@ -79,7 +94,7 @@ ZTEST(suite_data_fifo, test_data_fifo_data_put_get_ok) data_ptr[3] = 0xb4; data_ptr[4] = 0xb5; data_ptr[5] = 0xb6; - uint8_t data_2[DATA_SIZE + 1] = { 0xb1, 0xb2, 0xb3, 0xb4, 0xb5, 0xb6 }; + uint8_t data_2[DATA_SIZE + 1] = {0xb1, 0xb2, 0xb3, 0xb4, 0xb5, 0xb6}; internal_test_remaining_elements(&data_fifo, 2, 1, __LINE__);