dbb470ea7a
- Introduce a new Kconfig to enable mempool in RTIO - Introduce a new RTIO_DEFINE_WITH_MEMPOOL to allocate an RTIO context with an associated memory pool. - Add a new sqe read function rtio_sqe_read_with_pool() for memory pool enabled RTIO contexts - Allow IODevs to allocate only the memory they need via rtio_sqe_rx_buf() - Allow the consumer to get the allocated buffer via rtio_cqe_get_mempool_buffer() - Consumers need to release the buffer via rtio_release_buffer() when processing is complete. Signed-off-by: Yuval Peress <peress@google.com>
157 lines
3.8 KiB
C
157 lines
3.8 KiB
C
/*
|
|
* Copyright (c) 2022 Intel Corporation.
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#include "rtio_executor_common.h"
|
|
#include <zephyr/rtio/rtio_executor_simple.h>
|
|
#include <zephyr/rtio/rtio.h>
|
|
#include <zephyr/kernel.h>
|
|
|
|
#include <zephyr/logging/log.h>
|
|
LOG_MODULE_REGISTER(rtio_executor_simple, CONFIG_RTIO_LOG_LEVEL);
|
|
|
|
|
|
/**
|
|
* @brief Submit submissions to simple executor
|
|
*
|
|
* The simple executor provides no concurrency instead
|
|
* execution each submission chain one after the next.
|
|
*
|
|
* @param r RTIO context
|
|
*
|
|
* @retval 0 Always succeeds
|
|
*/
|
|
int rtio_simple_submit(struct rtio *r)
|
|
{
|
|
struct rtio_simple_executor *exc = (struct rtio_simple_executor *)r->executor;
|
|
|
|
/* Task is already running */
|
|
if (exc->task.sqe != NULL) {
|
|
return 0;
|
|
}
|
|
|
|
struct rtio_sqe *sqe = rtio_spsc_consume(r->sq);
|
|
|
|
if (sqe == NULL) {
|
|
return 0;
|
|
}
|
|
|
|
/* Some validation on the sqe to ensure no programming errors were
|
|
* made so assumptions in ok and err are valid.
|
|
*/
|
|
#ifdef CONFIG_ASSERT
|
|
__ASSERT(sqe != NULL, "Expected a valid sqe on submit call");
|
|
|
|
bool transaction = sqe->flags & RTIO_SQE_TRANSACTION;
|
|
bool chained = sqe->flags & RTIO_SQE_CHAINED;
|
|
|
|
if (transaction || chained) {
|
|
struct rtio_sqe *next = rtio_spsc_next(r->sq, sqe);
|
|
|
|
__ASSERT(next != NULL,
|
|
"sqe %p flagged as transaction (%d) or chained (%d) without subsequent sqe in queue",
|
|
sqe, transaction, chained);
|
|
}
|
|
__ASSERT(!(chained && transaction),
|
|
"sqe %p flagged as both being transaction and chained, only one is allowed",
|
|
sqe);
|
|
#endif
|
|
|
|
exc->task.sqe = sqe;
|
|
exc->task.r = r;
|
|
|
|
rtio_executor_submit(&exc->task);
|
|
|
|
return 0;
|
|
}
|
|
|
|
/**
|
|
* @brief Callback from an iodev describing success
|
|
*/
|
|
void rtio_simple_ok(struct rtio_iodev_sqe *iodev_sqe, int result)
|
|
{
|
|
struct rtio *r = iodev_sqe->r;
|
|
const struct rtio_sqe *sqe = iodev_sqe->sqe;
|
|
bool transaction;
|
|
|
|
#ifdef CONFIG_ASSERT
|
|
struct rtio_simple_executor *exc =
|
|
(struct rtio_simple_executor *)r->executor;
|
|
|
|
__ASSERT_NO_MSG(iodev_sqe == &exc->task);
|
|
#endif
|
|
|
|
do {
|
|
/* Capture the sqe information */
|
|
void *userdata = sqe->userdata;
|
|
uint32_t flags = rtio_cqe_compute_flags(iodev_sqe);
|
|
|
|
transaction = sqe->flags & RTIO_SQE_TRANSACTION;
|
|
|
|
/* Release the sqe */
|
|
rtio_spsc_release(r->sq);
|
|
|
|
/* Submit the completion event */
|
|
rtio_cqe_submit(r, result, userdata, flags);
|
|
|
|
if (transaction) {
|
|
/* sqe was a transaction, get the next one */
|
|
sqe = rtio_spsc_consume(r->sq);
|
|
__ASSERT_NO_MSG(sqe != NULL);
|
|
}
|
|
|
|
} while (transaction);
|
|
|
|
iodev_sqe->sqe = NULL;
|
|
rtio_simple_submit(r);
|
|
}
|
|
|
|
/**
|
|
* @brief Callback from an iodev describing error
|
|
*
|
|
* Some assumptions are made and should have been validated on rtio_submit
|
|
* - a sqe marked as chained or transaction has a next sqe
|
|
* - a sqe is marked either chained or transaction but not both
|
|
*/
|
|
void rtio_simple_err(struct rtio_iodev_sqe *iodev_sqe, int result)
|
|
{
|
|
const struct rtio_sqe *sqe = iodev_sqe->sqe;
|
|
struct rtio *r = iodev_sqe->r;
|
|
void *userdata = sqe->userdata;
|
|
uint32_t flags = rtio_cqe_compute_flags(iodev_sqe);
|
|
bool chained = sqe->flags & RTIO_SQE_CHAINED;
|
|
bool transaction = sqe->flags & RTIO_SQE_TRANSACTION;
|
|
|
|
#ifdef CONFIG_ASSERT
|
|
struct rtio_simple_executor *exc =
|
|
(struct rtio_simple_executor *)r->executor;
|
|
|
|
__ASSERT_NO_MSG(iodev_sqe == &exc->task);
|
|
#endif
|
|
|
|
rtio_spsc_release(r->sq);
|
|
iodev_sqe->sqe = NULL;
|
|
if (!transaction) {
|
|
rtio_cqe_submit(r, result, userdata, flags);
|
|
}
|
|
while (chained | transaction) {
|
|
sqe = rtio_spsc_consume(r->sq);
|
|
chained = sqe->flags & RTIO_SQE_CHAINED;
|
|
transaction = sqe->flags & RTIO_SQE_TRANSACTION;
|
|
userdata = sqe->userdata;
|
|
rtio_spsc_release(r->sq);
|
|
|
|
if (!transaction) {
|
|
rtio_cqe_submit(r, result, userdata, flags);
|
|
} else {
|
|
rtio_cqe_submit(r, -ECANCELED, userdata, flags);
|
|
}
|
|
}
|
|
|
|
iodev_sqe->sqe = rtio_spsc_consume(r->sq);
|
|
if (iodev_sqe->sqe != NULL) {
|
|
rtio_executor_submit(iodev_sqe);
|
|
}
|
|
}
|