sys_ringq API

Data Structures
struct	sys_ringq
	A structure to represent a ringq queue. More...

Macros
#define	SYS_RINGQ_DEFINE(name, item_size, item_capacity)
	Define and initialize a ring queue.

Functions
static void	sys_ringq_init (struct sys_ringq *ringq, uint8_t *data, size_t data_size, size_t item_size)
	Initialize a ringq queue.
static void	sys_ringq_reset (struct sys_ringq *ringq)
	Reset ringq queue state to its initial state.
static bool	sys_ringq_empty (const struct sys_ringq *ringq)
	Determine if a sys_ringq is empty.
static bool	sys_ringq_full (const struct sys_ringq *ringq)
	Determine if a sys_ringq is full.
static size_t	sys_ringq_space (const struct sys_ringq *ringq)
	Determine free space in a ringq queue.
static size_t	sys_ringq_capacity (const struct sys_ringq *ringq)
	Return ringq queue capacity.
static size_t	sys_ringq_size (const struct sys_ringq *ringq)
	Determine size of available data in a ringq queue.
static int	sys_ringq_put (struct sys_ringq *ringq, const void *element)
	Write (copy) data to a ringq queue.
static int	sys_ringq_get (struct sys_ringq *ringq, void *element)
	Read data from a sys_ringq queue.
static int	sys_ringq_peek (struct sys_ringq *ringq, void *data)
	Peek first element from a sys_ringq queue.

Detailed Description

Macro Definition Documentation

SYS_RINGQ_DEFINE

#define SYS_RINGQ_DEFINE	(		name,
			item_size,
			item_capacity )

#include <zephyr/sys/ringq.h>

Value:

static uint8_t __noinit CONCAT(_ringq_data_, name)[item_size * item_capacity];          \
struct sys_ringq name = SYS_RINGQ_INIT(CONCAT(_ringq_data_, name), item_size, item_capacity)

Define and initialize a ring queue.

This macro establishes a sys_ringq queue of a fixed size.

Parameters

name	Name of the ringq instance.
item_size	Size of each ringq element (in bytes).
item_capacity	capacity (in number of elements).

Function Documentation

sys_ringq_capacity()

size_t sys_ringq_capacity ( const struct sys_ringq * ringq )

inlinestatic

#include <zephyr/sys/ringq.h>

Return ringq queue capacity.

Parameters

ringq

Address of sys_ringq struct.

Returns

sys_ringq capacity in number of elements.

sys_ringq_empty()

bool sys_ringq_empty ( const struct sys_ringq * ringq )

inlinestatic

#include <zephyr/sys/ringq.h>

Determine if a sys_ringq is empty.

Parameters

ringq

Address of sys_ringq struct.

Returns

true if the sys_ringq is empty, else false.

sys_ringq_full()

bool sys_ringq_full ( const struct sys_ringq * ringq )

inlinestatic

#include <zephyr/sys/ringq.h>

Determine if a sys_ringq is full.

Parameters

ringq

Address of sys_ringq struct.

Returns

true if the sys_ringq is full, else false.

sys_ringq_get()

int sys_ringq_get ( struct sys_ringq * ringq, void * element )

inlinestatic

#include <zephyr/sys/ringq.h>

Read data from a sys_ringq queue.

This routine reads data from a ringq queue buf.

Parameters

ringq	Address of the sys_ringq struct.
element	Address of the output buffer.

Return values

0	if successful, -ENODATA if the ringq is empty.

sys_ringq_init()

void sys_ringq_init ( struct sys_ringq * ringq, uint8_t * data, size_t data_size, size_t item_size )

inlinestatic

#include <zephyr/sys/ringq.h>

Initialize a ringq queue.

This routine initializes a ringq queue.

Parameters

ringq	Address of sys_ringq struct.
data	ringq sys_ringq data area.
data_size	Size of the ringq data area (in bytes).
item_size	Size of each ringq element (in bytes).

Note

data_size should be a multiple of item_size. If not, it will be adjusted to the nearest lower multiple of item_size.

sys_ringq_peek()

int sys_ringq_peek ( struct sys_ringq * ringq, void * data )

inlinestatic

#include <zephyr/sys/ringq.h>

Peek first element from a sys_ringq queue.

Parameters

ringq	Address of sys_ringq struct.
data	Address of the output buffer.

Return values

0	if successful, -ENODATA if the ringq is empty.

sys_ringq_put()

int sys_ringq_put ( struct sys_ringq * ringq, const void * element )

inlinestatic

#include <zephyr/sys/ringq.h>

Write (copy) data to a ringq queue.

This routine writes data to a ringq queue queue.

Parameters

ringq	Address of sys_ringq queue.
element	Address of item.

Return values

0	if successful, -ENOSPC if there is no space in the ringq.

sys_ringq_reset()

void sys_ringq_reset ( struct sys_ringq * ringq )

inlinestatic

#include <zephyr/sys/ringq.h>

Reset ringq queue state to its initial state.

Parameters

ringq

Address of sys_ringq struct.

sys_ringq_size()

size_t sys_ringq_size ( const struct sys_ringq * ringq )

inlinestatic

#include <zephyr/sys/ringq.h>

Determine size of available data in a ringq queue.

Parameters

ringq

Address of sys_ringq struct.

Returns

sys_ringq size in number of elements.

sys_ringq_space()

size_t sys_ringq_space ( const struct sys_ringq * ringq )

inlinestatic

#include <zephyr/sys/ringq.h>

Determine free space in a ringq queue.

Parameters

ringq

Address of ringq queue.

Returns

ringq queue free space in number of elements.