rtio_executor_concurrent.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Intel Corporation.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef ZEPHYR_INCLUDE_RTIO_RTIO_EXECUTOR_CONCURRENT_H_
#define ZEPHYR_INCLUDE_RTIO_RTIO_EXECUTOR_CONCURRENT_H_
 
#include <zephyr/rtio/rtio.h>
#include <zephyr/kernel.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
int rtio_concurrent_submit(struct rtio *r);
 
void rtio_concurrent_ok(struct rtio *r, const struct rtio_sqe *sqe, int result);
 
void rtio_concurrent_err(struct rtio *r, const struct rtio_sqe *sqe, int result);
 
struct rtio_concurrent_executor {
        struct rtio_executor ctx;
 
        /* Lock around the queues */
        struct k_spinlock lock;
 
        /* Task ring position and count */
        uint16_t task_in, task_out, task_mask;
 
        /* First pending sqe to start when a task becomes available */
        struct rtio_sqe *pending_sqe;
 
        /* Last sqe seen from the most recent submit */
        struct rtio_sqe *last_sqe;
 
        /* Array of task statuses */
        uint8_t *task_status;
 
        /* Array of struct rtio_sqe *'s one per task' */
        struct rtio_sqe **task_cur;
};
 
static const struct rtio_executor_api z_rtio_concurrent_api = {
        .submit = rtio_concurrent_submit,
        .ok = rtio_concurrent_ok,
        .err = rtio_concurrent_err
};
 
#define RTIO_EXECUTOR_CONCURRENT_DEFINE(name, concurrency)                                         \
        static struct rtio_sqe *_task_cur_##name[(concurrency)];                                   \
        uint8_t _task_status_##name[(concurrency)];                                                \
        static struct rtio_concurrent_executor name = {                                            \
                .ctx = { .api = &z_rtio_concurrent_api },                                          \
                .task_in = 0,                                                                      \
                .task_out = 0,                                                                     \
                .task_mask = (concurrency)-1,                                                      \
                .pending_sqe = NULL,                                                               \
                .last_sqe = NULL,                                                                  \
                .task_status = _task_status_##name,                                                \
                .task_cur = _task_cur_##name,                                                      \
        };
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* ZEPHYR_INCLUDE_RTIO_RTIO_EXECUTOR_CONCURRENT_H_ */