rtio Struct Reference

An RTIO context containing what can be viewed as a pair of queues. More...

#include <zephyr/rtio/rtio.h>

Data Fields
atomic_t	cq_count
	Total number of completions.
atomic_t	xcqcnt
	Number of completions dropped because no CQE was available.
struct rtio_sqe_pool *	sqe_pool
	Submission queue object pool with free list.
struct rtio_cqe_pool *	cqe_pool
	Completion queue object pool with free list.
struct mpsc	sq
	Submission queue.
struct mpsc	cq
	Completion queue.

Detailed Description

An RTIO context containing what can be viewed as a pair of queues.

A queue for submissions (available and in queue to be produced) as well as a queue of completions (available and ready to be consumed).

The rtio executor along with any objects implementing the rtio_iodev interface are the consumers of submissions and producers of completions.

No work is started until rtio_submit() is called.

Field Documentation

cq

struct mpsc rtio::cq

Completion queue.

cq_count

atomic_t rtio::cq_count

Total number of completions.

cqe_pool

struct rtio_cqe_pool* rtio::cqe_pool

Completion queue object pool with free list.

sq

struct mpsc rtio::sq

Submission queue.

sqe_pool

struct rtio_sqe_pool* rtio::sqe_pool

Submission queue object pool with free list.

xcqcnt

atomic_t rtio::xcqcnt

Number of completions dropped because no CQE was available.

---

The documentation for this struct was generated from the following file:

• zephyr/rtio/rtio.h