rte_bus_vdev.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2016 RehiveTech. All rights reserved.
 */

#ifndef RTE_VDEV_H
#define RTE_VDEV_H

#ifdef __cplusplus
extern "C" {
#endif

#include <rte_dev.h>
#include <rte_devargs.h>

struct rte_vdev_device {
    RTE_TAILQ_ENTRY(rte_vdev_device) next;      
    struct rte_device device;               
};

#define RTE_DEV_TO_VDEV(ptr) \
    container_of(ptr, struct rte_vdev_device, device)

#define RTE_DEV_TO_VDEV_CONST(ptr) \
    container_of(ptr, const struct rte_vdev_device, device)

#define RTE_ETH_DEV_TO_VDEV(eth_dev)    RTE_DEV_TO_VDEV((eth_dev)->device)

static inline const char *
rte_vdev_device_name(const struct rte_vdev_device *dev)
{
    if (dev && dev->device.name)
        return dev->device.name;
    return NULL;
}

static inline const char *
rte_vdev_device_args(const struct rte_vdev_device *dev)
{
    if (dev && dev->device.devargs)
        return dev->device.devargs->args;
    return "";
}

RTE_TAILQ_HEAD(vdev_driver_list, rte_vdev_driver);

typedef int (rte_vdev_probe_t)(struct rte_vdev_device *dev);

typedef int (rte_vdev_remove_t)(struct rte_vdev_device *dev);

typedef int (rte_vdev_dma_map_t)(struct rte_vdev_device *dev, void *addr,
                uint64_t iova, size_t len);

typedef int (rte_vdev_dma_unmap_t)(struct rte_vdev_device *dev, void *addr,
                  uint64_t iova, size_t len);

struct rte_vdev_driver {
    RTE_TAILQ_ENTRY(rte_vdev_driver) next; 
    struct rte_driver driver;        
    rte_vdev_probe_t *probe;         
    rte_vdev_remove_t *remove;       
    rte_vdev_dma_map_t *dma_map;     
    rte_vdev_dma_unmap_t *dma_unmap; 
    uint32_t drv_flags;              
};

#define RTE_VDEV_DRV_NEED_IOVA_AS_VA 0x0001

void rte_vdev_register(struct rte_vdev_driver *driver);

void rte_vdev_unregister(struct rte_vdev_driver *driver);

#define RTE_PMD_REGISTER_VDEV(nm, vdrv)\
static const char *vdrvinit_ ## nm ## _alias;\
RTE_INIT(vdrvinitfn_ ##vdrv)\
{\
    (vdrv).driver.name = RTE_STR(nm);\
    (vdrv).driver.alias = vdrvinit_ ## nm ## _alias;\
    rte_vdev_register(&vdrv);\
} \
RTE_PMD_EXPORT_NAME(nm, __COUNTER__)

#define RTE_PMD_REGISTER_ALIAS(nm, alias)\
static const char *vdrvinit_ ## nm ## _alias = RTE_STR(alias)

typedef void (*rte_vdev_scan_callback)(void *user_arg);

int
rte_vdev_add_custom_scan(rte_vdev_scan_callback callback, void *user_arg);

int
rte_vdev_remove_custom_scan(rte_vdev_scan_callback callback, void *user_arg);

int rte_vdev_init(const char *name, const char *args);

int rte_vdev_uninit(const char *name);

#ifdef __cplusplus
}
#endif

#endif