rtio.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_DRIVERS_I2C_RTIO_H_
#define ZEPHYR_DRIVERS_I2C_RTIO_H_
 
#include <zephyr/kernel.h>
#include <zephyr/drivers/i2c.h>
#include <zephyr/rtio/rtio.h>
 
#ifdef __cplusplus
extern "C" {
#endif

struct i2c_rtio {
        struct k_sem lock;
        struct k_spinlock slock;
        struct rtio *r;
        struct mpsc io_q;
        struct rtio_iodev iodev;
        struct rtio_iodev_sqe *txn_head;
        struct rtio_iodev_sqe *txn_curr;
        struct i2c_dt_spec dt_spec;
};

#define I2C_RTIO_DEFINE(_name, _sq_sz, _cq_sz)          \
        RTIO_DEFINE(CONCAT(_name, _r), _sq_sz, _cq_sz); \
        static struct i2c_rtio _name = {                \
                .r = &CONCAT(_name, _r),                \
        };

typedef bool (*i2c_rtio_cb_run_sync_start_async)(const struct device *dev, int *status);

struct rtio_sqe *i2c_rtio_copy(struct rtio *r, struct rtio_iodev *iodev, const struct i2c_msg *msgs,
                               uint8_t num_msgs);

void i2c_rtio_init(struct i2c_rtio *ctx, const struct device *dev);

bool i2c_rtio_complete(struct i2c_rtio *ctx, int status);

bool i2c_rtio_submit(struct i2c_rtio *ctx, struct rtio_iodev_sqe *iodev_sqe);

int i2c_rtio_configure(struct i2c_rtio *ctx, uint32_t i2c_config);

int i2c_rtio_transfer(struct i2c_rtio *ctx, struct i2c_msg *msgs, uint8_t num_msgs, uint16_t addr);

int i2c_rtio_recover(struct i2c_rtio *ctx);

static inline bool i2c_rtio_run_sync_start_async(const struct device *dev, struct i2c_rtio *ctx,
                                                 i2c_rtio_cb_run_sync_start_async cb)
{
        int status;
 
        __ASSERT_NO_MSG(cb != NULL);
 
        while (!cb(dev, &status)) {
                if (!i2c_rtio_complete(ctx, status)) {
                        return false;
                }
        }
 
        return true;
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_DRVIERS_I2C_RTIO_H_ */