RTIO CQE Flags

RTIO CQE Flags . More...

Macros
#define	RTIO_CQE_FLAG_MEMPOOL_BUFFER   BIT(0)
	The entry's buffer was allocated from the RTIO's mempool.
#define	RTIO_CQE_FLAG_GET(flags)
#define	RTIO_CQE_FLAG_MEMPOOL_GET_BLK_IDX(flags)
	Get the block index of a mempool flags.
#define	RTIO_CQE_FLAG_MEMPOOL_GET_BLK_CNT(flags)
	Get the block count of a mempool flags.
#define	RTIO_CQE_FLAG_PREP_MEMPOOL(blk_idx, blk_cnt)
	Prepare CQE flags for a mempool read.

Detailed Description

RTIO CQE Flags .

Macro Definition Documentation

RTIO_CQE_FLAG_GET

#define RTIO_CQE_FLAG_GET

(

flags

)

#include <zephyr/rtio/rtio.h>

Value:

FIELD_GET(GENMASK(7, 0), (flags))

RTIO_CQE_FLAG_MEMPOOL_BUFFER

#define RTIO_CQE_FLAG_MEMPOOL_BUFFER   BIT(0)

#include <zephyr/rtio/rtio.h>

The entry's buffer was allocated from the RTIO's mempool.

If this bit is set, the buffer was allocated from the memory pool and should be recycled as soon as the application is done with it.

RTIO_CQE_FLAG_MEMPOOL_GET_BLK_CNT

#define RTIO_CQE_FLAG_MEMPOOL_GET_BLK_CNT

(

flags

)

#include <zephyr/rtio/rtio.h>

Value:

FIELD_GET(GENMASK(31, 20), (flags))

Get the block count of a mempool flags.

Parameters

flags

The CQE flags value

Returns

The block count portion of the flags field.

RTIO_CQE_FLAG_MEMPOOL_GET_BLK_IDX

#define RTIO_CQE_FLAG_MEMPOOL_GET_BLK_IDX

(

flags

)

#include <zephyr/rtio/rtio.h>

Value:

FIELD_GET(GENMASK(19, 8), (flags))

Get the block index of a mempool flags.

Parameters

flags

The CQE flags value

Returns

The block index portion of the flags field.

RTIO_CQE_FLAG_PREP_MEMPOOL

#define RTIO_CQE_FLAG_PREP_MEMPOOL	(		blk_idx,
			blk_cnt )

#include <zephyr/rtio/rtio.h>

Value:

        (FIELD_PREP(GENMASK(7, 0), RTIO_CQE_FLAG_MEMPOOL_BUFFER) |                                 \
         FIELD_PREP(GENMASK(19, 8), blk_idx) | FIELD_PREP(GENMASK(31, 20), blk_cnt))

Prepare CQE flags for a mempool read.

Parameters

blk_idx	The mempool block index
blk_cnt	The mempool block count

Returns

A shifted and masked value that can be added to the flags field with an OR operator.