data_fifo.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef _DATA_FIFO_H_
#define _DATA_FIFO_H_
 
#include <stddef.h>
#include <stdint.h>
#include <zephyr/kernel.h>
 
/* The queue elements hold a pointer to a memory block in a slab and the
 * number of bytes written to that block.
 */
struct data_fifo_msgq {
        void *block_ptr;
        size_t size;
};
 
struct data_fifo {
        char *msgq_buffer;
        char *slab_buffer;
        struct k_mem_slab mem_slab;
        struct k_msgq msgq;
        uint32_t elements_max;
        size_t block_size_max;
        bool initialized;
};
 
#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};  \
        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}
 
int data_fifo_pointer_first_vacant_get(struct data_fifo *data_fifo, void **data,
                                       k_timeout_t timeout);
 
int data_fifo_block_lock(struct data_fifo *data_fifo, void **data, size_t size);
 
int data_fifo_pointer_last_filled_get(struct data_fifo *data_fifo, void **data, size_t *size,
                                      k_timeout_t timeout);
 
void data_fifo_block_free(struct data_fifo *data_fifo, void *data);
 
int data_fifo_num_used_get(struct data_fifo *data_fifo, uint32_t *alloced_num,
                           uint32_t *locked_num);
 
int data_fifo_empty(struct data_fifo *data_fifo);
 
int data_fifo_uninit(struct data_fifo *data_fifo);
 
int data_fifo_init(struct data_fifo *data_fifo);
 
bool data_fifo_state(struct data_fifo *data_fifo);
 
#endif /* _DATA_FIFO_H_ */