virtio.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Antmicro <www.antmicro.com>
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_VIRTIO_VIRTIO_H_
#define ZEPHYR_VIRTIO_VIRTIO_H_
#include <zephyr/device.h>
#include "virtio/virtqueue.h"
 
#ifdef __cplusplus
extern "C" {
#endif


typedef uint16_t (*virtio_enumerate_queues)(
        uint16_t queue_idx, uint16_t max_queue_size, void *opaque
);


typedef struct virtq *(*virtio_api_get_virtqueue)(const struct device *dev, uint16_t queue_idx);

typedef void (*virtio_api_notify_virtqueue)(const struct device *dev, uint16_t queue_idx);

typedef void *(*virtio_api_get_device_specific_config)(const struct device *dev);

typedef bool (*virtio_api_read_device_feature_bit)(const struct device *dev, int bit);

typedef int (*virtio_api_write_driver_feature_bit)(const struct device *dev, int bit, bool value);

typedef int (*virtio_api_commit_feature_bits)(const struct device *dev);

typedef int (*virtio_api_init_virtqueues)(
        const struct device *dev, uint16_t num_queues, virtio_enumerate_queues cb, void *opaque
);

typedef void (*virtio_api_finalize_init)(const struct device *dev);

__subsystem struct virtio_driver_api {
        virtio_api_get_virtqueue get_virtqueue;
        virtio_api_notify_virtqueue notify_virtqueue;
        virtio_api_get_device_specific_config get_device_specific_config;
        virtio_api_read_device_feature_bit read_device_feature_bit;
        virtio_api_write_driver_feature_bit write_driver_feature_bit;
        virtio_api_commit_feature_bits commit_feature_bits;
        virtio_api_init_virtqueues init_virtqueues;
        virtio_api_finalize_init finalize_init;
};


static inline struct virtq *virtio_get_virtqueue(const struct device *dev, uint16_t queue_idx)
{
        return DEVICE_API_GET(virtio, dev)->get_virtqueue(dev, queue_idx);
}

static inline void virtio_notify_virtqueue(const struct device *dev, uint16_t queue_idx)
{
        DEVICE_API_GET(virtio, dev)->notify_virtqueue(dev, queue_idx);
}

static inline void *virtio_get_device_specific_config(const struct device *dev)
{
        return DEVICE_API_GET(virtio, dev)->get_device_specific_config(dev);
}

static inline bool virtio_read_device_feature_bit(const struct device *dev, int bit)
{
        return DEVICE_API_GET(virtio, dev)->read_device_feature_bit(dev, bit);
}

static inline int virtio_write_driver_feature_bit(const struct device *dev, int bit, bool value)
{
        return DEVICE_API_GET(virtio, dev)->write_driver_feature_bit(dev, bit, value);
}

static inline int virtio_commit_feature_bits(const struct device *dev)
{
        return DEVICE_API_GET(virtio, dev)->commit_feature_bits(dev);
}

static inline int virtio_init_virtqueues(
        const struct device *dev, uint16_t num_queues, virtio_enumerate_queues cb, void *opaque)
{
        return DEVICE_API_GET(virtio, dev)->init_virtqueues(dev, num_queues, cb, opaque);
}

static inline void virtio_finalize_init(const struct device *dev)
{
        DEVICE_API_GET(virtio, dev)->finalize_init(dev);
}

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_VIRTIO_VIRTIO_H_ */