1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016 RehiveTech. All rights reserved.
12 #include <sys/queue.h>
14 #include <rte_devargs.h>
16 struct rte_vdev_device {
17 TAILQ_ENTRY(rte_vdev_device) next; /**< Next attached vdev */
18 struct rte_device device; /**< Inherit core device */
23 * Helper macro for drivers that need to convert to struct rte_vdev_device.
25 #define RTE_DEV_TO_VDEV(ptr) \
26 container_of(ptr, struct rte_vdev_device, device)
28 static inline const char *
29 rte_vdev_device_name(const struct rte_vdev_device *dev)
31 if (dev && dev->device.name)
32 return dev->device.name;
36 static inline const char *
37 rte_vdev_device_args(const struct rte_vdev_device *dev)
39 if (dev && dev->device.devargs)
40 return dev->device.devargs->args;
44 /** Double linked list of virtual device drivers. */
45 TAILQ_HEAD(vdev_driver_list, rte_vdev_driver);
48 * Probe function called for each virtual device driver once.
50 typedef int (rte_vdev_probe_t)(struct rte_vdev_device *dev);
53 * Remove function called for each virtual device driver once.
55 typedef int (rte_vdev_remove_t)(struct rte_vdev_device *dev);
58 * A virtual device driver abstraction.
60 struct rte_vdev_driver {
61 TAILQ_ENTRY(rte_vdev_driver) next; /**< Next in list. */
62 struct rte_driver driver; /**< Inherited general driver. */
63 rte_vdev_probe_t *probe; /**< Virtual device probe function. */
64 rte_vdev_remove_t *remove; /**< Virtual device remove function. */
68 * Register a virtual device driver.
71 * A pointer to a rte_vdev_driver structure describing the driver
74 void rte_vdev_register(struct rte_vdev_driver *driver);
77 * Unregister a virtual device driver.
80 * A pointer to a rte_vdev_driver structure describing the driver
83 void rte_vdev_unregister(struct rte_vdev_driver *driver);
85 #define RTE_PMD_REGISTER_VDEV(nm, vdrv)\
86 RTE_INIT(vdrvinitfn_ ##vdrv);\
87 static const char *vdrvinit_ ## nm ## _alias;\
88 static void vdrvinitfn_ ##vdrv(void)\
90 (vdrv).driver.name = RTE_STR(nm);\
91 (vdrv).driver.alias = vdrvinit_ ## nm ## _alias;\
92 rte_vdev_register(&vdrv);\
94 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
96 #define RTE_PMD_REGISTER_ALIAS(nm, alias)\
97 static const char *vdrvinit_ ## nm ## _alias = RTE_STR(alias)
99 typedef void (*rte_vdev_scan_callback)(void *user_arg);
102 * Add a callback to be called on vdev scan
103 * before reading the devargs list.
105 * This function cannot be called in a scan callback
106 * because of deadlock.
109 * The function to be called which can update the devargs list.
111 * An opaque pointer passed to callback.
113 * 0 on success, negative on error
116 rte_vdev_add_custom_scan(rte_vdev_scan_callback callback, void *user_arg);
119 * Remove a registered scan callback.
121 * This function cannot be called in a scan callback
122 * because of deadlock.
125 * The registered function to be removed.
127 * The associated opaque pointer or (void*)-1 for any.
132 rte_vdev_remove_custom_scan(rte_vdev_scan_callback callback, void *user_arg);
135 * Initialize a driver specified by name.
138 * The pointer to a driver name to be initialized.
140 * The pointer to arguments used by driver initialization.
142 * 0 on success, negative on error
144 int rte_vdev_init(const char *name, const char *args);
147 * Uninitalize a driver specified by name.
150 * The pointer to a driver name to be initialized.
152 * 0 on success, negative on error
154 int rte_vdev_uninit(const char *name);