rte_vdpa.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2018 Intel Corporation
 */

#ifndef _RTE_VDPA_H_
#define _RTE_VDPA_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdbool.h>

#include <rte_pci.h>
#include "rte_vhost.h"

#define MAX_VDPA_NAME_LEN 128

enum vdpa_addr_type {
    PCI_ADDR,
    VDPA_ADDR_MAX
};

struct rte_vdpa_dev_addr {
    enum vdpa_addr_type type;

    union {
        uint8_t __dummy[64];
        struct rte_pci_addr pci_addr;
    };
};

struct rte_vdpa_dev_ops {
    int (*get_queue_num)(int did, uint32_t *queue_num);

    int (*get_features)(int did, uint64_t *features);

    int (*get_protocol_features)(int did, uint64_t *protocol_features);

    int (*dev_conf)(int vid);
    int (*dev_close)(int vid);

    int (*set_vring_state)(int vid, int vring, int state);

    int (*set_features)(int vid);

    int (*migration_done)(int vid);

    int (*get_vfio_group_fd)(int vid);

    int (*get_vfio_device_fd)(int vid);

    int (*get_notify_area)(int vid, int qid,
            uint64_t *offset, uint64_t *size);

    void *reserved[5];
};

struct rte_vdpa_device {
    struct rte_vdpa_dev_addr addr;
    struct rte_vdpa_dev_ops *ops;
} __rte_cache_aligned;

__rte_experimental
int
rte_vdpa_register_device(struct rte_vdpa_dev_addr *addr,
        struct rte_vdpa_dev_ops *ops);

__rte_experimental
int
rte_vdpa_unregister_device(int did);

__rte_experimental
int
rte_vdpa_find_device_id(struct rte_vdpa_dev_addr *addr);

__rte_experimental
struct rte_vdpa_device *
rte_vdpa_get_device(int did);

__rte_experimental
int
rte_vdpa_get_device_num(void);

__rte_experimental
int
rte_vhost_host_notifier_ctrl(int vid, bool enable);

__rte_experimental
int
rte_vdpa_relay_vring_used(int vid, uint16_t qid, void *vring_m);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_VDPA_H_ */