no_os_circular_buffer.h File Reference

Circular buffer library header. More...

#include <stdint.h>

Include dependency graph for no_os_circular_buffer.h:

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)

Copyright

Copyright 2020(c) Analog Devices, Inc.

SPDX-License-Identifier: BSD-3-Clause

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

)

no_os_cb_end_async_write()

int32_t no_os_cb_end_async_write

(

struct no_os_circular_buffer *

desc

)

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 )

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 )

no_os_cb_read()

int32_t no_os_cb_read	(	struct no_os_circular_buffer *	desc,
		void *	data,
		uint32_t	nb_elements )

no_os_cb_remove()

int32_t no_os_cb_remove

(

struct no_os_circular_buffer *

desc

)

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 )