DPDK  17.08.2
rte_vdev.h
1 /*-
2  * BSD LICENSE
3  *
4  * Copyright(c) 2016 RehiveTech. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in
14  * the documentation and/or other materials provided with the
15  * distribution.
16  * * Neither the name of RehiveTech nor the names of its
17  * contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef RTE_VDEV_H
34 #define RTE_VDEV_H
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
40 #include <sys/queue.h>
41 #include <rte_dev.h>
42 #include <rte_devargs.h>
43 
44 struct rte_vdev_device {
45  TAILQ_ENTRY(rte_vdev_device) next;
46  struct rte_device device;
47 };
48 
53 #define RTE_DEV_TO_VDEV(ptr) \
54  container_of(ptr, struct rte_vdev_device, device)
55 
56 static inline const char *
57 rte_vdev_device_name(const struct rte_vdev_device *dev)
58 {
59  if (dev && dev->device.name)
60  return dev->device.name;
61  return NULL;
62 }
63 
64 static inline const char *
65 rte_vdev_device_args(const struct rte_vdev_device *dev)
66 {
67  if (dev && dev->device.devargs)
68  return dev->device.devargs->args;
69  return "";
70 }
71 
73 TAILQ_HEAD(vdev_driver_list, rte_vdev_driver);
74 
78 typedef int (rte_vdev_probe_t)(struct rte_vdev_device *dev);
79 
83 typedef int (rte_vdev_remove_t)(struct rte_vdev_device *dev);
84 
89  TAILQ_ENTRY(rte_vdev_driver) next;
90  struct rte_driver driver;
91  rte_vdev_probe_t *probe;
92  rte_vdev_remove_t *remove;
93 };
94 
102 void rte_vdev_register(struct rte_vdev_driver *driver);
103 
111 void rte_vdev_unregister(struct rte_vdev_driver *driver);
112 
113 #define RTE_PMD_REGISTER_VDEV(nm, vdrv)\
114 RTE_INIT(vdrvinitfn_ ##vdrv);\
115 static const char *vdrvinit_ ## nm ## _alias;\
116 static void vdrvinitfn_ ##vdrv(void)\
117 {\
118  (vdrv).driver.name = RTE_STR(nm);\
119  (vdrv).driver.alias = vdrvinit_ ## nm ## _alias;\
120  rte_vdev_register(&vdrv);\
121 } \
122 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
123 
124 #define RTE_PMD_REGISTER_ALIAS(nm, alias)\
125 static const char *vdrvinit_ ## nm ## _alias = RTE_STR(alias)
126 
127 #ifdef __cplusplus
128 }
129 #endif
130 
131 #endif