no_os_circular_buffer.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef _NO_OS_CIRCULAR_BUFFER_H_
#define _NO_OS_CIRCULAR_BUFFER_H_
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
 
#include <stdint.h>
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
 
struct no_os_cb_ptr {
    uint32_t    idx;
    uint32_t    spin_count;
    bool        async_started;
    uint32_t    async_size;
};
 
struct no_os_circular_buffer {
    uint32_t    size;
    int8_t      *buff;
    struct no_os_cb_ptr write;
    struct no_os_cb_ptr read;
};
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
 
int32_t no_os_cb_init(struct no_os_circular_buffer **desc, uint32_t size);
/* Configure cb structure with given parameters without memory allocation */
int32_t no_os_cb_cfg(struct no_os_circular_buffer *desc, int8_t *buf,
             uint32_t size);
int32_t no_os_cb_remove(struct no_os_circular_buffer *desc);
int32_t no_os_cb_size(struct no_os_circular_buffer *desc, uint32_t *size);
 
int32_t no_os_cb_write(struct no_os_circular_buffer *desc, const void *data,
               uint32_t nb_elements);
int32_t no_os_cb_read(struct no_os_circular_buffer *desc, void *data,
              uint32_t nb_elements);
 
int32_t no_os_cb_prepare_async_write(struct no_os_circular_buffer *desc,
                     uint32_t raw_size_to_write,
                     void **write_buff,
                     uint32_t *raw_size_avilable);
int32_t no_os_cb_end_async_write(struct no_os_circular_buffer *desc);
 
int32_t no_os_cb_prepare_async_read(struct no_os_circular_buffer *desc,
                    uint32_t raw_size_to_read,
                    void **read_buff,
                    uint32_t *raw_size_avilable);
int32_t no_os_cb_end_async_read(struct no_os_circular_buffer *desc);
 
#endif //_NO_OS_CIRCULAR_BUFFER_H_