no-OS
Functions
circular_buffer.h File Reference

Circular buffer library header. More...

#include <stdint.h>
Include dependency graph for circular_buffer.h:

Go to the source code of this file.

Functions

int32_t cb_init (struct circular_buffer **desc, uint32_t size)
 
int32_t cb_remove (struct circular_buffer *desc)
 
int32_t cb_size (struct circular_buffer *desc, uint32_t *size)
 
int32_t cb_write (struct circular_buffer *desc, const void *data, uint32_t nb_elements)
 
int32_t cb_read (struct circular_buffer *desc, void *data, uint32_t nb_elements)
 
int32_t cb_prepare_async_write (struct circular_buffer *desc, uint32_t raw_size_to_write, void **write_buff, uint32_t *raw_size_avilable)
 
int32_t cb_end_async_write (struct circular_buffer *desc)
 
int32_t cb_prepare_async_read (struct circular_buffer *desc, uint32_t raw_size_to_read, void **read_buff, uint32_t *raw_size_avilable)
 
int32_t cb_end_async_read (struct circular_buffer *desc)
 

Detailed Description

Circular buffer library header.

Author
Mihail Chindris (mihai.nosp@m.l.ch.nosp@m.indri.nosp@m.s@an.nosp@m.alog..nosp@m.com)

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Function Documentation

◆ cb_end_async_read()

int32_t cb_end_async_read ( struct circular_buffer *  desc)

◆ cb_end_async_write()

int32_t cb_end_async_write ( struct circular_buffer *  desc)

◆ cb_init()

int32_t cb_init ( struct circular_buffer **  desc,
uint32_t  size 
)

◆ cb_prepare_async_read()

int32_t cb_prepare_async_read ( struct circular_buffer *  desc,
uint32_t  raw_size_to_read,
void **  read_buff,
uint32_t *  raw_size_avilable 
)

◆ cb_prepare_async_write()

int32_t cb_prepare_async_write ( struct circular_buffer *  desc,
uint32_t  raw_size_to_write,
void **  write_buff,
uint32_t *  raw_size_avilable 
)

◆ cb_read()

int32_t cb_read ( struct circular_buffer *  desc,
void *  data,
uint32_t  nb_elements 
)

◆ cb_remove()

int32_t cb_remove ( struct circular_buffer *  desc)
Here is the caller graph for this function:

◆ cb_size()

int32_t cb_size ( struct circular_buffer *  desc,
uint32_t *  size 
)

◆ cb_write()

int32_t cb_write ( struct circular_buffer *  desc,
const void *  data,
uint32_t  nb_elements 
)