DPDK  17.05.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 
49 static inline const char *
50 rte_vdev_device_name(const struct rte_vdev_device *dev)
51 {
52  if (dev && dev->device.devargs)
53  return dev->device.devargs->virt.drv_name;
54  return NULL;
55 }
56 
57 static inline const char *
58 rte_vdev_device_args(const struct rte_vdev_device *dev)
59 {
60  if (dev && dev->device.devargs)
61  return dev->device.devargs->args;
62  return "";
63 }
64 
66 TAILQ_HEAD(vdev_driver_list, rte_vdev_driver);
67 
71 typedef int (rte_vdev_probe_t)(struct rte_vdev_device *dev);
72 
76 typedef int (rte_vdev_remove_t)(struct rte_vdev_device *dev);
77 
82  TAILQ_ENTRY(rte_vdev_driver) next;
83  struct rte_driver driver;
84  rte_vdev_probe_t *probe;
85  rte_vdev_remove_t *remove;
86 };
87 
95 void rte_vdev_register(struct rte_vdev_driver *driver);
96 
104 void rte_vdev_unregister(struct rte_vdev_driver *driver);
105 
106 #define RTE_PMD_REGISTER_VDEV(nm, vdrv)\
107 RTE_INIT(vdrvinitfn_ ##vdrv);\
108 static const char *vdrvinit_ ## nm ## _alias;\
109 static void vdrvinitfn_ ##vdrv(void)\
110 {\
111  (vdrv).driver.name = RTE_STR(nm);\
112  (vdrv).driver.alias = vdrvinit_ ## nm ## _alias;\
113  rte_vdev_register(&vdrv);\
114 } \
115 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
116 
117 #define RTE_PMD_REGISTER_ALIAS(nm, alias)\
118 static const char *vdrvinit_ ## nm ## _alias = RTE_STR(alias)
119 
120 #ifdef __cplusplus
121 }
122 #endif
123 
124 #endif