no-OS
Classes | Functions
no_os_circular_buffer.h File Reference

Circular buffer library header. More...

#include <stdint.h>
Include dependency graph for no_os_circular_buffer.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  no_os_cb_ptr
 Circular buffer pointer. More...
 
struct  no_os_circular_buffer
 Circular buffer descriptor. More...
 

Functions

int32_t no_os_cb_init (struct no_os_circular_buffer **desc, uint32_t size)
 
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)
 

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)

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

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 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

◆ no_os_cb_cfg()

int32_t no_os_cb_cfg ( struct no_os_circular_buffer desc,
int8_t *  buf,
uint32_t  size 
)

◆ no_os_cb_end_async_read()

int32_t no_os_cb_end_async_read ( struct no_os_circular_buffer desc)
Here is the caller graph for this function:

◆ no_os_cb_end_async_write()

int32_t no_os_cb_end_async_write ( struct no_os_circular_buffer desc)
Here is the caller graph for this function:

◆ no_os_cb_init()

int32_t no_os_cb_init ( struct no_os_circular_buffer **  desc,
uint32_t  size 
)

◆ no_os_cb_prepare_async_read()

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 
)
Here is the caller graph for this function:

◆ no_os_cb_prepare_async_write()

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 
)
Here is the caller graph for this function:

◆ no_os_cb_read()

int32_t no_os_cb_read ( struct no_os_circular_buffer desc,
void *  data,
uint32_t  nb_elements 
)
Here is the caller graph for this function:

◆ no_os_cb_remove()

int32_t no_os_cb_remove ( struct no_os_circular_buffer desc)
Here is the caller graph for this function:

◆ no_os_cb_size()

int32_t no_os_cb_size ( struct no_os_circular_buffer desc,
uint32_t *  size 
)

◆ no_os_cb_write()

int32_t no_os_cb_write ( struct no_os_circular_buffer desc,
const void *  data,
uint32_t  nb_elements 
)
Here is the caller graph for this function: