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 #define RTE_DEV_TO_VDEV_CONST(ptr) \
29 container_of(ptr, const struct rte_vdev_device, device)
31 static inline const char *
32 rte_vdev_device_name(const struct rte_vdev_device *dev)
34 if (dev && dev->device.name)
35 return dev->device.name;
39 static inline const char *
40 rte_vdev_device_args(const struct rte_vdev_device *dev)
42 if (dev && dev->device.devargs)
43 return dev->device.devargs->args;
47 /** Double linked list of virtual device drivers. */
48 TAILQ_HEAD(vdev_driver_list, rte_vdev_driver);
51 * Probe function called for each virtual device driver once.
53 typedef int (rte_vdev_probe_t)(struct rte_vdev_device *dev);
56 * Remove function called for each virtual device driver once.
58 typedef int (rte_vdev_remove_t)(struct rte_vdev_device *dev);
61 * A virtual device driver abstraction.
63 struct rte_vdev_driver {
64 TAILQ_ENTRY(rte_vdev_driver) next; /**< Next in list. */
65 struct rte_driver driver; /**< Inherited general driver. */
66 rte_vdev_probe_t *probe; /**< Virtual device probe function. */
67 rte_vdev_remove_t *remove; /**< Virtual device remove function. */
71 * Register a virtual device driver.
74 * A pointer to a rte_vdev_driver structure describing the driver
77 void rte_vdev_register(struct rte_vdev_driver *driver);
80 * Unregister a virtual device driver.
83 * A pointer to a rte_vdev_driver structure describing the driver
86 void rte_vdev_unregister(struct rte_vdev_driver *driver);
88 #define RTE_PMD_REGISTER_VDEV(nm, vdrv)\
89 RTE_INIT(vdrvinitfn_ ##vdrv);\
90 static const char *vdrvinit_ ## nm ## _alias;\
91 static void vdrvinitfn_ ##vdrv(void)\
93 (vdrv).driver.name = RTE_STR(nm);\
94 (vdrv).driver.alias = vdrvinit_ ## nm ## _alias;\
95 rte_vdev_register(&vdrv);\
97 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
99 #define RTE_PMD_REGISTER_ALIAS(nm, alias)\
100 static const char *vdrvinit_ ## nm ## _alias = RTE_STR(alias)
102 typedef void (*rte_vdev_scan_callback)(void *user_arg);
105 * Add a callback to be called on vdev scan
106 * before reading the devargs list.
108 * This function cannot be called in a scan callback
109 * because of deadlock.
112 * The function to be called which can update the devargs list.
114 * An opaque pointer passed to callback.
116 * 0 on success, negative on error
119 rte_vdev_add_custom_scan(rte_vdev_scan_callback callback, void *user_arg);
122 * Remove a registered scan callback.
124 * This function cannot be called in a scan callback
125 * because of deadlock.
128 * The registered function to be removed.
130 * The associated opaque pointer or (void*)-1 for any.
135 rte_vdev_remove_custom_scan(rte_vdev_scan_callback callback, void *user_arg);
138 * Initialize a driver specified by name.
141 * The pointer to a driver name to be initialized.
143 * The pointer to arguments used by driver initialization.
145 * 0 on success, negative on error
147 int rte_vdev_init(const char *name, const char *args);
150 * Uninitalize a driver specified by name.
153 * The pointer to a driver name to be initialized.
155 * 0 on success, negative on error
157 int rte_vdev_uninit(const char *name);