1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016 RehiveTech. All rights reserved.
18 #include <sys/queue.h>
20 #include <rte_devargs.h>
22 struct rte_vdev_device {
23 TAILQ_ENTRY(rte_vdev_device) next; /**< Next attached vdev */
24 struct rte_device device; /**< Inherit core device */
29 * Helper macro for drivers that need to convert to struct rte_vdev_device.
31 #define RTE_DEV_TO_VDEV(ptr) \
32 container_of(ptr, struct rte_vdev_device, device)
34 #define RTE_DEV_TO_VDEV_CONST(ptr) \
35 container_of(ptr, const struct rte_vdev_device, device)
37 static inline const char *
38 rte_vdev_device_name(const struct rte_vdev_device *dev)
40 if (dev && dev->device.name)
41 return dev->device.name;
45 static inline const char *
46 rte_vdev_device_args(const struct rte_vdev_device *dev)
48 if (dev && dev->device.devargs)
49 return dev->device.devargs->args;
53 /** Double linked list of virtual device drivers. */
54 TAILQ_HEAD(vdev_driver_list, rte_vdev_driver);
57 * Probe function called for each virtual device driver once.
59 typedef int (rte_vdev_probe_t)(struct rte_vdev_device *dev);
62 * Remove function called for each virtual device driver once.
64 typedef int (rte_vdev_remove_t)(struct rte_vdev_device *dev);
67 * Driver-specific DMA mapping. After a successful call the device
68 * will be able to read/write from/to this segment.
71 * Pointer to the Virtual device.
73 * Starting virtual address of memory to be mapped.
75 * Starting IOVA address of memory to be mapped.
77 * Length of memory segment being mapped.
80 * - Negative value and rte_errno is set otherwise.
82 typedef int (rte_vdev_dma_map_t)(struct rte_vdev_device *dev, void *addr,
83 uint64_t iova, size_t len);
86 * Driver-specific DMA un-mapping. After a successful call the device
87 * will not be able to read/write from/to this segment.
90 * Pointer to the Virtual device.
92 * Starting virtual address of memory to be unmapped.
94 * Starting IOVA address of memory to be unmapped.
96 * Length of memory segment being unmapped.
99 * - Negative value and rte_errno is set otherwise.
101 typedef int (rte_vdev_dma_unmap_t)(struct rte_vdev_device *dev, void *addr,
102 uint64_t iova, size_t len);
105 * A virtual device driver abstraction.
107 struct rte_vdev_driver {
108 TAILQ_ENTRY(rte_vdev_driver) next; /**< Next in list. */
109 struct rte_driver driver; /**< Inherited general driver. */
110 rte_vdev_probe_t *probe; /**< Virtual device probe function. */
111 rte_vdev_remove_t *remove; /**< Virtual device remove function. */
112 rte_vdev_dma_map_t *dma_map; /**< Virtual device DMA map function. */
113 rte_vdev_dma_unmap_t *dma_unmap; /**< Virtual device DMA unmap function. */
117 * Register a virtual device driver.
120 * A pointer to a rte_vdev_driver structure describing the driver
123 void rte_vdev_register(struct rte_vdev_driver *driver);
126 * Unregister a virtual device driver.
129 * A pointer to a rte_vdev_driver structure describing the driver
130 * to be unregistered.
132 void rte_vdev_unregister(struct rte_vdev_driver *driver);
134 #define RTE_PMD_REGISTER_VDEV(nm, vdrv)\
135 static const char *vdrvinit_ ## nm ## _alias;\
136 RTE_INIT(vdrvinitfn_ ##vdrv)\
138 (vdrv).driver.name = RTE_STR(nm);\
139 (vdrv).driver.alias = vdrvinit_ ## nm ## _alias;\
140 rte_vdev_register(&vdrv);\
142 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
144 #define RTE_PMD_REGISTER_ALIAS(nm, alias)\
145 static const char *vdrvinit_ ## nm ## _alias = RTE_STR(alias)
147 typedef void (*rte_vdev_scan_callback)(void *user_arg);
150 * Add a callback to be called on vdev scan
151 * before reading the devargs list.
153 * This function cannot be called in a scan callback
154 * because of deadlock.
157 * The function to be called which can update the devargs list.
159 * An opaque pointer passed to callback.
161 * 0 on success, negative on error
164 rte_vdev_add_custom_scan(rte_vdev_scan_callback callback, void *user_arg);
167 * Remove a registered scan callback.
169 * This function cannot be called in a scan callback
170 * because of deadlock.
173 * The registered function to be removed.
175 * The associated opaque pointer or (void*)-1 for any.
180 rte_vdev_remove_custom_scan(rte_vdev_scan_callback callback, void *user_arg);
183 * Initialize a driver specified by name.
186 * The pointer to a driver name to be initialized.
188 * The pointer to arguments used by driver initialization.
190 * 0 on success, negative on error
192 int rte_vdev_init(const char *name, const char *args);
195 * Uninitalize a driver specified by name.
198 * The pointer to a driver name to be uninitialized.
200 * 0 on success, negative on error
202 int rte_vdev_uninit(const char *name);