4 * Copyright(c) 2014 6WIND S.A.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
40 * RTE PMD Driver Registration Interface
42 * This file manages the list of device drivers.
50 #include <sys/queue.h>
52 #include <rte_config.h>
55 __attribute__((format(printf, 2, 0)))
57 rte_pmd_debug_trace(const char *func_name, const char *fmt, ...)
63 char buffer[vsnprintf(NULL, 0, fmt, ap) + 1];
68 vsnprintf(buffer, sizeof(buffer), fmt, ap);
71 rte_log(RTE_LOG_ERR, RTE_LOGTYPE_PMD, "%s: %s", func_name, buffer);
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.
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__)
84 #define RTE_PMD_DEBUG_TRACE(...) (void)0
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"); \
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"); \
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"); \
110 #define RTE_FUNC_PTR_OR_RET(func) do { \
111 if ((func) == NULL) { \
112 RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
120 enum rte_kernel_driver {
121 RTE_KDRV_UNKNOWN = 0,
124 RTE_KDRV_UIO_GENERIC,
132 enum rte_dev_policy {
138 * A generic memory resource representation.
140 struct rte_mem_resource {
141 uint64_t phys_addr; /**< Physical address, 0 if not resource. */
142 uint64_t len; /**< Length of the resource. */
143 void *addr; /**< Virtual address, NULL when not mapped. */
147 * A structure describing a device driver.
150 TAILQ_ENTRY(rte_driver) next; /**< Next in list. */
151 const char *name; /**< Driver name. */
152 const char *alias; /**< Driver alias. */
156 * Internal identifier length
157 * Sufficiently large to allow for UUID or PCI address
159 #define RTE_DEV_NAME_MAX_LEN 64
162 * A structure describing a generic device.
165 TAILQ_ENTRY(rte_device) next; /**< Next device */
166 const char *name; /**< Device name */
167 const struct rte_driver *driver;/**< Associated driver */
168 int numa_node; /**< NUMA node connection */
169 struct rte_devargs *devargs; /**< Device user arguments */
173 * Initialize a driver specified by name.
176 * The pointer to a driver name to be initialized.
178 * The pointer to arguments used by driver initialization.
180 * 0 on success, negative on error
182 int rte_vdev_init(const char *name, const char *args);
185 * Uninitalize a driver specified by name.
188 * The pointer to a driver name to be initialized.
190 * 0 on success, negative on error
192 int rte_vdev_uninit(const char *name);
195 * Attach a device to a registered driver.
198 * The device name, that refers to a pci device (or some private
199 * way of designating a vdev device). Based on this device name, eal
200 * will identify a driver capable of handling it and pass it to the
201 * driver probing function.
203 * Device arguments to be passed to the driver.
205 * 0 on success, negative on error.
207 int rte_eal_dev_attach(const char *name, const char *devargs);
210 * Detach a device from its driver.
213 * A pointer to a rte_device structure.
215 * 0 on success, negative on error.
217 int rte_eal_dev_detach(struct rte_device *dev);
221 * @b EXPERIMENTAL: this API may change without prior notice
223 * Hotplug add a given device to a specific bus.
226 * The bus name the device is added to.
228 * The device name. Based on this device name, eal will identify a driver
229 * capable of handling it and pass it to the driver probing function.
231 * Device arguments to be passed to the driver.
233 * 0 on success, negative on error.
235 int rte_eal_hotplug_add(const char *busname, const char *devname,
236 const char *devargs);
240 * @b EXPERIMENTAL: this API may change without prior notice
242 * Hotplug remove a given device from a specific bus.
245 * The bus name the device is removed from.
247 * The device name being removed.
249 * 0 on success, negative on error.
251 int rte_eal_hotplug_remove(const char *busname, const char *devname);
254 * Device comparison function.
256 * This type of function is used to compare an rte_device with arbitrary
263 * Data to compare against. The type of this parameter is determined by
264 * the kind of comparison performed by the function.
267 * 0 if the device matches the data.
268 * !0 if the device does not match.
269 * <0 if ordering is possible and the device is lower than the data.
270 * >0 if ordering is possible and the device is greater than the data.
272 typedef int (*rte_dev_cmp_t)(const struct rte_device *dev, const void *data);
274 #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]
276 #define RTE_PMD_EXPORT_NAME(name, idx) \
277 static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
278 __attribute__((used)) = RTE_STR(name)
280 #define DRV_EXP_TAG(name, tag) __##name##_##tag
282 #define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
283 static const char DRV_EXP_TAG(name, pci_tbl_export)[] __attribute__((used)) = \
286 #define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
287 static const char DRV_EXP_TAG(name, param_string_export)[] \
288 __attribute__((used)) = str
291 * Advertise the list of kernel modules required to run this driver
293 * This string lists the kernel modules required for the devices
294 * associated to a PMD. The format of each line of the string is:
295 * "<device-pattern> <kmod-expression>".
297 * The possible formats for the device pattern are:
298 * "*" all devices supported by this driver
299 * "pci:*" all PCI devices supported by this driver
300 * "pci:v8086:d*:sv*:sd*" all PCI devices supported by this driver
301 * whose vendor id is 0x8086.
303 * The format of the kernel modules list is a parenthesed expression
304 * containing logical-and (&) and logical-or (|).
306 * The device pattern and the kmod expression are separated by a space.
309 * - "* igb_uio | uio_pci_generic | vfio"
311 #define RTE_PMD_REGISTER_KMOD_DEP(name, str) \
312 static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
313 __attribute__((used)) = str
319 #endif /* _RTE_VDEV_H_ */