eal: move kernel driver enum out of PCI header
[dpdk.git] / lib / librte_eal / common / include / rte_dev.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2014 6WIND S.A.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of 6WIND S.A. nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #ifndef _RTE_DEV_H_
35 #define _RTE_DEV_H_
36
37 /**
38  * @file
39  *
40  * RTE PMD Driver Registration Interface
41  *
42  * This file manages the list of device drivers.
43  */
44
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48
49 #include <stdio.h>
50 #include <sys/queue.h>
51
52 #include <rte_config.h>
53 #include <rte_log.h>
54
55 __attribute__((format(printf, 2, 0)))
56 static inline void
57 rte_pmd_debug_trace(const char *func_name, const char *fmt, ...)
58 {
59         va_list ap;
60
61         va_start(ap, fmt);
62
63         char buffer[vsnprintf(NULL, 0, fmt, ap) + 1];
64
65         va_end(ap);
66
67         va_start(ap, fmt);
68         vsnprintf(buffer, sizeof(buffer), fmt, ap);
69         va_end(ap);
70
71         rte_log(RTE_LOG_ERR, RTE_LOGTYPE_PMD, "%s: %s", func_name, buffer);
72 }
73
74 /*
75  * Enable RTE_PMD_DEBUG_TRACE() when at least one component relying on the
76  * RTE_*_RET() macros defined below is compiled in debug mode.
77  */
78 #if defined(RTE_LIBRTE_ETHDEV_DEBUG) || \
79         defined(RTE_LIBRTE_CRYPTODEV_DEBUG) || \
80         defined(RTE_LIBRTE_EVENTDEV_DEBUG)
81 #define RTE_PMD_DEBUG_TRACE(...) \
82         rte_pmd_debug_trace(__func__, __VA_ARGS__)
83 #else
84 #define RTE_PMD_DEBUG_TRACE(...) (void)0
85 #endif
86
87 /* Macros for checking for restricting functions to primary instance only */
88 #define RTE_PROC_PRIMARY_OR_ERR_RET(retval) do { \
89         if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
90                 RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
91                 return retval; \
92         } \
93 } while (0)
94
95 #define RTE_PROC_PRIMARY_OR_RET() do { \
96         if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
97                 RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
98                 return; \
99         } \
100 } while (0)
101
102 /* Macros to check for invalid function pointers */
103 #define RTE_FUNC_PTR_OR_ERR_RET(func, retval) do { \
104         if ((func) == NULL) { \
105                 RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
106                 return retval; \
107         } \
108 } while (0)
109
110 #define RTE_FUNC_PTR_OR_RET(func) do { \
111         if ((func) == NULL) { \
112                 RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
113                 return; \
114         } \
115 } while (0)
116
117 /**
118  * Device driver.
119  */
120 enum rte_kernel_driver {
121         RTE_KDRV_UNKNOWN = 0,
122         RTE_KDRV_IGB_UIO,
123         RTE_KDRV_VFIO,
124         RTE_KDRV_UIO_GENERIC,
125         RTE_KDRV_NIC_UIO,
126         RTE_KDRV_NONE,
127 };
128
129 /**
130  * A generic memory resource representation.
131  */
132 struct rte_mem_resource {
133         uint64_t phys_addr; /**< Physical address, 0 if not resource. */
134         uint64_t len;       /**< Length of the resource. */
135         void *addr;         /**< Virtual address, NULL when not mapped. */
136 };
137
138 /**
139  * A structure describing a device driver.
140  */
141 struct rte_driver {
142         TAILQ_ENTRY(rte_driver) next;  /**< Next in list. */
143         const char *name;                   /**< Driver name. */
144         const char *alias;              /**< Driver alias. */
145 };
146
147 #define RTE_DEV_NAME_MAX_LEN (32)
148
149 /**
150  * A structure describing a generic device.
151  */
152 struct rte_device {
153         TAILQ_ENTRY(rte_device) next; /**< Next device */
154         const char *name;             /**< Device name */
155         const struct rte_driver *driver;/**< Associated driver */
156         int numa_node;                /**< NUMA node connection */
157         struct rte_devargs *devargs;  /**< Device user arguments */
158 };
159
160 /**
161  * Initialize a driver specified by name.
162  *
163  * @param name
164  *   The pointer to a driver name to be initialized.
165  * @param args
166  *   The pointer to arguments used by driver initialization.
167  * @return
168  *  0 on success, negative on error
169  */
170 int rte_vdev_init(const char *name, const char *args);
171
172 /**
173  * Uninitalize a driver specified by name.
174  *
175  * @param name
176  *   The pointer to a driver name to be initialized.
177  * @return
178  *  0 on success, negative on error
179  */
180 int rte_vdev_uninit(const char *name);
181
182 /**
183  * Attach a device to a registered driver.
184  *
185  * @param name
186  *   The device name, that refers to a pci device (or some private
187  *   way of designating a vdev device). Based on this device name, eal
188  *   will identify a driver capable of handling it and pass it to the
189  *   driver probing function.
190  * @param devargs
191  *   Device arguments to be passed to the driver.
192  * @return
193  *   0 on success, negative on error.
194  */
195 int rte_eal_dev_attach(const char *name, const char *devargs);
196
197 /**
198  * Detach a device from its driver.
199  *
200  * @param dev
201  *   A pointer to a rte_device structure.
202  * @return
203  *   0 on success, negative on error.
204  */
205 int rte_eal_dev_detach(struct rte_device *dev);
206
207 /**
208  * @warning
209  * @b EXPERIMENTAL: this API may change without prior notice
210  *
211  * Hotplug add a given device to a specific bus.
212  *
213  * @param busname
214  *   The bus name the device is added to.
215  * @param devname
216  *   The device name. Based on this device name, eal will identify a driver
217  *   capable of handling it and pass it to the driver probing function.
218  * @param devargs
219  *   Device arguments to be passed to the driver.
220  * @return
221  *   0 on success, negative on error.
222  */
223 int rte_eal_hotplug_add(const char *busname, const char *devname,
224                         const char *devargs);
225
226 /**
227  * @warning
228  * @b EXPERIMENTAL: this API may change without prior notice
229  *
230  * Hotplug remove a given device from a specific bus.
231  *
232  * @param busname
233  *   The bus name the device is removed from.
234  * @param devname
235  *   The device name being removed.
236  * @return
237  *   0 on success, negative on error.
238  */
239 int rte_eal_hotplug_remove(const char *busname, const char *devname);
240
241 /**
242  * Device comparison function.
243  *
244  * This type of function is used to compare an rte_device with arbitrary
245  * data.
246  *
247  * @param dev
248  *   Device handle.
249  *
250  * @param data
251  *   Data to compare against. The type of this parameter is determined by
252  *   the kind of comparison performed by the function.
253  *
254  * @return
255  *   0 if the device matches the data.
256  *   !0 if the device does not match.
257  *   <0 if ordering is possible and the device is lower than the data.
258  *   >0 if ordering is possible and the device is greater than the data.
259  */
260 typedef int (*rte_dev_cmp_t)(const struct rte_device *dev, const void *data);
261
262 #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]
263
264 #define RTE_PMD_EXPORT_NAME(name, idx) \
265 static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
266 __attribute__((used)) = RTE_STR(name)
267
268 #define DRV_EXP_TAG(name, tag) __##name##_##tag
269
270 #define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
271 static const char DRV_EXP_TAG(name, pci_tbl_export)[] __attribute__((used)) = \
272 RTE_STR(table)
273
274 #define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
275 static const char DRV_EXP_TAG(name, param_string_export)[] \
276 __attribute__((used)) = str
277
278 /**
279  * Advertise the list of kernel modules required to run this driver
280  *
281  * This string lists the kernel modules required for the devices
282  * associated to a PMD. The format of each line of the string is:
283  * "<device-pattern> <kmod-expression>".
284  *
285  * The possible formats for the device pattern are:
286  *   "*"                     all devices supported by this driver
287  *   "pci:*"                 all PCI devices supported by this driver
288  *   "pci:v8086:d*:sv*:sd*"  all PCI devices supported by this driver
289  *                           whose vendor id is 0x8086.
290  *
291  * The format of the kernel modules list is a parenthesed expression
292  * containing logical-and (&) and logical-or (|).
293  *
294  * The device pattern and the kmod expression are separated by a space.
295  *
296  * Example:
297  * - "* igb_uio | uio_pci_generic | vfio"
298  */
299 #define RTE_PMD_REGISTER_KMOD_DEP(name, str) \
300 static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
301 __attribute__((used)) = str
302
303 #ifdef __cplusplus
304 }
305 #endif
306
307 #endif /* _RTE_VDEV_H_ */