esp_ringbuf.h File Reference

#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include "esp_err.h"
#include "kernel/vsf_kernel.h"

Go to the source code of this file.

Data Structures
struct	StaticRingbuffer_t

Macros
#define	__VSF_ESPIDF_FREERTOS_TYPES_DEFINED__
#define	pdTRUE   ((BaseType_t)1)
#define	pdFALSE   ((BaseType_t)0)
#define	pdPASS   pdTRUE
#define	pdFAIL   pdFALSE
#define	portMAX_DELAY   ((TickType_t)-1)
#define	__VSF_FREERTOS_QUEUESET_TYPES_DEFINED__

Typedefs
typedef long	BaseType_t
typedef unsigned long	UBaseType_t
typedef vsf_systimer_tick_t	TickType_t
typedef void *	QueueSetHandle_t
typedef void *	QueueSetMemberHandle_t
typedef struct __vsf_espidf_ringbuf *	RingbufHandle_t

Enumerations
enum	RingbufferType_t {   RINGBUF_TYPE_NOSPLIT = 0 ,   RINGBUF_TYPE_ALLOWSPLIT = 1 ,   RINGBUF_TYPE_BYTEBUF = 2 }

Functions
RingbufHandle_t	xRingbufferCreate (size_t buffer_size, RingbufferType_t type)
void	vRingbufferDelete (RingbufHandle_t handle)
BaseType_t	xRingbufferSend (RingbufHandle_t handle, const void *data, size_t data_size, TickType_t ticks_to_wait)
void *	xRingbufferReceive (RingbufHandle_t handle, size_t *item_size, TickType_t ticks_to_wait)
void *	xRingbufferReceiveUpTo (RingbufHandle_t handle, size_t *item_size, TickType_t ticks_to_wait, size_t wanted_size)
void	vRingbufferReturnItem (RingbufHandle_t handle, void *item)
BaseType_t	xRingbufferReceiveSplit (RingbufHandle_t handle, void **ppvHeadItem, void **ppvTailItem, size_t *pxHeadItemSize, size_t *pxTailItemSize, TickType_t ticks_to_wait)
size_t	xRingbufferGetCurFreeSize (RingbufHandle_t handle)
size_t	xRingbufferGetCurFilledSize (RingbufHandle_t handle)
size_t	xRingbufferGetMaxItemSize (RingbufHandle_t handle)
RingbufHandle_t	xRingbufferCreateNoSplit (size_t xItemSize, size_t xItemNum)
BaseType_t	xRingbufferSendFromISR (RingbufHandle_t handle, const void *data, size_t data_size, BaseType_t *pxHigherPriorityTaskWoken)
void *	xRingbufferReceiveFromISR (RingbufHandle_t handle, size_t *item_size, BaseType_t *pxHigherPriorityTaskWoken)
void *	xRingbufferReceiveUpToFromISR (RingbufHandle_t handle, size_t *item_size, size_t wanted_size, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xRingbufferReceiveSplitFromISR (RingbufHandle_t handle, void **ppvHeadItem, void **ppvTailItem, size_t *pxHeadItemSize, size_t *pxTailItemSize, BaseType_t *pxHigherPriorityTaskWoken)
void	vRingbufferReturnItemFromISR (RingbufHandle_t handle, void *item, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xRingbufferSendAcquire (RingbufHandle_t handle, void **ppvItem, size_t xItemSize, TickType_t ticks_to_wait)
BaseType_t	xRingbufferSendComplete (RingbufHandle_t handle, void *pvItem)
esp_err_t	vRingbufferReset (RingbufHandle_t handle)
void	vRingbufferGetInfo (RingbufHandle_t handle, UBaseType_t *uxFree, UBaseType_t *uxRead, UBaseType_t *uxWrite, UBaseType_t *uxAcquire, UBaseType_t *uxItemsWaiting)
void	xRingbufferPrintInfo (RingbufHandle_t handle)
RingbufHandle_t	xRingbufferCreateWithCaps (size_t buffer_size, RingbufferType_t type, UBaseType_t uxMemoryCaps)
RingbufHandle_t	xRingbufferCreateStatic (size_t buffer_size, RingbufferType_t type, uint8_t *pucRingbufferStorage, StaticRingbuffer_t *pxStaticRingbuffer)
BaseType_t	xRingbufferGetStaticBuffer (RingbufHandle_t handle, uint8_t **ppucRingbufferStorage, StaticRingbuffer_t **ppxStaticRingbuffer)
void	vRingbufferDeleteWithCaps (RingbufHandle_t handle)
BaseType_t	xRingbufferAddToQueueSetRead (RingbufHandle_t handle, QueueSetHandle_t xQueueSet)
BaseType_t	xRingbufferRemoveFromQueueSetRead (RingbufHandle_t handle, QueueSetHandle_t xQueueSet)

Macro Definition Documentation

__VSF_ESPIDF_FREERTOS_TYPES_DEFINED__

#define __VSF_ESPIDF_FREERTOS_TYPES_DEFINED__

pdTRUE

#define pdTRUE   ((BaseType_t)1)

pdFALSE

#define pdFALSE   ((BaseType_t)0)

pdPASS

#define pdPASS   pdTRUE

pdFAIL

#define pdFAIL   pdFALSE

portMAX_DELAY

#define portMAX_DELAY   ((TickType_t)-1)

__VSF_FREERTOS_QUEUESET_TYPES_DEFINED__

#define __VSF_FREERTOS_QUEUESET_TYPES_DEFINED__

Typedef Documentation

BaseType_t

typedef long BaseType_t

FreeRTOS portable signed word.

UBaseType_t

typedef unsigned long UBaseType_t

FreeRTOS unsigned signed word.

TickType_t

typedef vsf_systimer_tick_t TickType_t

FreeRTOS tick counter type.

QueueSetHandle_t

typedef void* QueueSetHandle_t

QueueSetMemberHandle_t

typedef void* QueueSetMemberHandle_t

RingbufHandle_t

typedef struct __vsf_espidf_ringbuf* RingbufHandle_t

Enumeration Type Documentation

RingbufferType_t

enum RingbufferType_t

Enumerator
RINGBUF_TYPE_NOSPLIT	Item-oriented, no split at wrap
RINGBUF_TYPE_ALLOWSPLIT	Item-oriented, may wrap
RINGBUF_TYPE_BYTEBUF	Pure byte stream

Function Documentation

xRingbufferCreate()

RingbufHandle_t xRingbufferCreate	(	size_t	buffer_size,
		RingbufferType_t	type
	)

vRingbufferDelete()

void vRingbufferDelete

(

RingbufHandle_t

handle

)

xRingbufferSend()

BaseType_t xRingbufferSend	(	RingbufHandle_t	handle,
		const void *	data,
		size_t	data_size,
		TickType_t	ticks_to_wait
	)

xRingbufferReceive()

void * xRingbufferReceive	(	RingbufHandle_t	handle,
		size_t *	item_size,
		TickType_t	ticks_to_wait
	)

xRingbufferReceiveUpTo()

void * xRingbufferReceiveUpTo	(	RingbufHandle_t	handle,
		size_t *	item_size,
		TickType_t	ticks_to_wait,
		size_t	wanted_size
	)

vRingbufferReturnItem()

void vRingbufferReturnItem	(	RingbufHandle_t	handle,
		void *	item
	)

xRingbufferReceiveSplit()

BaseType_t xRingbufferReceiveSplit	(	RingbufHandle_t	handle,
		void **	ppvHeadItem,
		void **	ppvTailItem,
		size_t *	pxHeadItemSize,
		size_t *	pxTailItemSize,
		TickType_t	ticks_to_wait
	)

xRingbufferGetCurFreeSize()

size_t xRingbufferGetCurFreeSize

(

RingbufHandle_t

handle

)

xRingbufferGetCurFilledSize()

size_t xRingbufferGetCurFilledSize

(

RingbufHandle_t

handle

)

xRingbufferGetMaxItemSize()

size_t xRingbufferGetMaxItemSize

(

RingbufHandle_t

handle

)

xRingbufferCreateNoSplit()

RingbufHandle_t xRingbufferCreateNoSplit	(	size_t	xItemSize,
		size_t	xItemNum
	)

xRingbufferSendFromISR()

BaseType_t xRingbufferSendFromISR	(	RingbufHandle_t	handle,
		const void *	data,
		size_t	data_size,
		BaseType_t *	pxHigherPriorityTaskWoken
	)

xRingbufferReceiveFromISR()

void * xRingbufferReceiveFromISR	(	RingbufHandle_t	handle,
		size_t *	item_size,
		BaseType_t *	pxHigherPriorityTaskWoken
	)

xRingbufferReceiveUpToFromISR()

void * xRingbufferReceiveUpToFromISR	(	RingbufHandle_t	handle,
		size_t *	item_size,
		size_t	wanted_size,
		BaseType_t *	pxHigherPriorityTaskWoken
	)

xRingbufferReceiveSplitFromISR()

BaseType_t xRingbufferReceiveSplitFromISR	(	RingbufHandle_t	handle,
		void **	ppvHeadItem,
		void **	ppvTailItem,
		size_t *	pxHeadItemSize,
		size_t *	pxTailItemSize,
		BaseType_t *	pxHigherPriorityTaskWoken
	)

vRingbufferReturnItemFromISR()

void vRingbufferReturnItemFromISR	(	RingbufHandle_t	handle,
		void *	item,
		BaseType_t *	pxHigherPriorityTaskWoken
	)

xRingbufferSendAcquire()

BaseType_t xRingbufferSendAcquire	(	RingbufHandle_t	handle,
		void **	ppvItem,
		size_t	xItemSize,
		TickType_t	ticks_to_wait
	)

xRingbufferSendComplete()

BaseType_t xRingbufferSendComplete	(	RingbufHandle_t	handle,
		void *	pvItem
	)

vRingbufferReset()

esp_err_t vRingbufferReset

(

RingbufHandle_t

handle

)

vRingbufferGetInfo()

void vRingbufferGetInfo	(	RingbufHandle_t	handle,
		UBaseType_t *	uxFree,
		UBaseType_t *	uxRead,
		UBaseType_t *	uxWrite,
		UBaseType_t *	uxAcquire,
		UBaseType_t *	uxItemsWaiting
	)

xRingbufferPrintInfo()

void xRingbufferPrintInfo

(

RingbufHandle_t

handle

)

xRingbufferCreateWithCaps()

RingbufHandle_t xRingbufferCreateWithCaps	(	size_t	buffer_size,
		RingbufferType_t	type,
		UBaseType_t	uxMemoryCaps
	)

xRingbufferCreateStatic()

RingbufHandle_t xRingbufferCreateStatic	(	size_t	buffer_size,
		RingbufferType_t	type,
		uint8_t *	pucRingbufferStorage,
		StaticRingbuffer_t *	pxStaticRingbuffer
	)

xRingbufferGetStaticBuffer()

BaseType_t xRingbufferGetStaticBuffer	(	RingbufHandle_t	handle,
		uint8_t **	ppucRingbufferStorage,
		StaticRingbuffer_t **	ppxStaticRingbuffer
	)

vRingbufferDeleteWithCaps()

void vRingbufferDeleteWithCaps

(

RingbufHandle_t

handle

)

xRingbufferAddToQueueSetRead()

BaseType_t xRingbufferAddToQueueSetRead	(	RingbufHandle_t	handle,
		QueueSetHandle_t	xQueueSet
	)

xRingbufferRemoveFromQueueSetRead()

BaseType_t xRingbufferRemoveFromQueueSetRead	(	RingbufHandle_t	handle,
		QueueSetHandle_t	xQueueSet
	)