cqe.h

Go to the documentation of this file.

/*
 * SPDX-Copyright: Copyright (c) 2022 Intel Corporation
 * SPDX-FileCopyrightText: Copyright (c) 2026 Infineon Technologies AG,
 * or an affiliate of Infineon Technologies AG.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
 
#ifndef ZEPHYR_INCLUDE_RTIO_CQE_H_
#define ZEPHYR_INCLUDE_RTIO_CQE_H_
 
#include <stdint.h>
#include <string.h>
#include <zephyr/sys/mpsc_lockfree.h>
#include <zephyr/sys/iterable_sections.h>
 
#ifdef __cplusplus
extern "C" {
#endif



#define RTIO_CQE_FLAG_MEMPOOL_BUFFER BIT(0)
 
#define RTIO_CQE_FLAG_GET(flags) FIELD_GET(GENMASK(7, 0), (flags))

#define RTIO_CQE_FLAG_MEMPOOL_GET_BLK_IDX(flags) FIELD_GET(GENMASK(19, 8), (flags))

#define RTIO_CQE_FLAG_MEMPOOL_GET_BLK_CNT(flags) FIELD_GET(GENMASK(31, 20), (flags))

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


struct rtio_cqe {
        struct mpsc_node q;
 
        int32_t result; 
        void *userdata; 
        uint32_t flags; 
};
 
/* Private structures and functions used for the pool of cqe structures */
 
struct rtio_cqe_pool {
        struct mpsc free_q;
        const uint16_t pool_size;
        uint16_t pool_free;
        struct rtio_cqe *pool;
};
 
 
static inline struct rtio_cqe *rtio_cqe_pool_alloc(struct rtio_cqe_pool *pool)
{
        struct mpsc_node *node = mpsc_pop(&pool->free_q);
 
        if (node == NULL) {
                return NULL;
        }
 
        struct rtio_cqe *cqe = CONTAINER_OF(node, struct rtio_cqe, q);
 
        memset(cqe, 0, sizeof(struct rtio_cqe));
 
        pool->pool_free--;
 
        return cqe;
}
 
static inline void rtio_cqe_pool_free(struct rtio_cqe_pool *pool, struct rtio_cqe *cqe)
{
        mpsc_push(&pool->free_q, &cqe->q);
 
        pool->pool_free++;
}
 
/* Do not try and reformat the macros */
/* clang-format off */
 
#define Z_RTIO_CQE_POOL_DEFINE(name, sz)                        \
        static struct rtio_cqe CONCAT(_cqe_pool_, name)[sz];    \
        STRUCT_SECTION_ITERABLE(rtio_cqe_pool, name) = {        \
                .free_q = MPSC_INIT((name.free_q)),     \
                .pool_size = sz,                                \
                .pool_free = sz,                                \
                .pool = CONCAT(_cqe_pool_, name),               \
        }
 
/* clang-format on */
 

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_RTIO_CQE_H_ */