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>
54 __attribute__((format(printf, 2, 0)))
56 rte_pmd_debug_trace(const char *func_name, const char *fmt, ...)
62 char buffer[vsnprintf(NULL, 0, fmt, ap) + 1];
67 vsnprintf(buffer, sizeof(buffer), fmt, ap);
70 rte_log(RTE_LOG_ERR, RTE_LOGTYPE_PMD, "%s: %s", func_name, buffer);
73 /* Macros for checking for restricting functions to primary instance only */
74 #define RTE_PROC_PRIMARY_OR_ERR_RET(retval) do { \
75 if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
76 RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
81 #define RTE_PROC_PRIMARY_OR_RET() do { \
82 if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
83 RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
88 /* Macros to check for invalid function pointers */
89 #define RTE_FUNC_PTR_OR_ERR_RET(func, retval) do { \
90 if ((func) == NULL) { \
91 RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
96 #define RTE_FUNC_PTR_OR_RET(func) do { \
97 if ((func) == NULL) { \
98 RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
104 * A generic memory resource representation.
106 struct rte_mem_resource {
107 uint64_t phys_addr; /**< Physical address, 0 if not resource. */
108 uint64_t len; /**< Length of the resource. */
109 void *addr; /**< Virtual address, NULL when not mapped. */
112 /** Double linked list of device drivers. */
113 TAILQ_HEAD(rte_driver_list, rte_driver);
114 /** Double linked list of devices. */
115 TAILQ_HEAD(rte_device_list, rte_device);
117 /* Forward declaration */
121 * A structure describing a generic device.
124 TAILQ_ENTRY(rte_device) next; /**< Next device */
125 const char *name; /**< Device name */
126 const struct rte_driver *driver;/**< Associated driver */
127 int numa_node; /**< NUMA node connection */
128 struct rte_devargs *devargs; /**< Device user arguments */
132 * Insert a device detected by a bus scanning.
135 * A pointer to a rte_device structure describing the detected device.
137 void rte_eal_device_insert(struct rte_device *dev);
140 * Remove a device (e.g. when being unplugged).
143 * A pointer to a rte_device structure describing the device to be removed.
145 void rte_eal_device_remove(struct rte_device *dev);
148 * A structure describing a device driver.
151 TAILQ_ENTRY(rte_driver) next; /**< Next in list. */
152 const char *name; /**< Driver name. */
153 const char *alias; /**< Driver alias. */
157 * Register a device driver.
160 * A pointer to a rte_dev structure describing the driver
163 void rte_eal_driver_register(struct rte_driver *driver);
166 * Unregister a device driver.
169 * A pointer to a rte_dev structure describing the driver
170 * to be unregistered.
172 void rte_eal_driver_unregister(struct rte_driver *driver);
175 * Initialize a driver specified by name.
178 * The pointer to a driver name to be initialized.
180 * The pointer to arguments used by driver initialization.
182 * 0 on success, negative on error
184 int rte_eal_vdev_init(const char *name, const char *args);
187 * Uninitalize a driver specified by name.
190 * The pointer to a driver name to be initialized.
192 * 0 on success, negative on error
194 int rte_eal_vdev_uninit(const char *name);
197 * Attach a device to a registered driver.
200 * The device name, that refers to a pci device (or some private
201 * way of designating a vdev device). Based on this device name, eal
202 * will identify a driver capable of handling it and pass it to the
203 * driver probing function.
205 * Device arguments to be passed to the driver.
207 * 0 on success, negative on error.
209 int rte_eal_dev_attach(const char *name, const char *devargs);
212 * Detach a device from its driver.
215 * Same description as for rte_eal_dev_attach().
216 * Here, eal will call the driver detaching function.
218 * 0 on success, negative on error.
220 int rte_eal_dev_detach(const char *name);
222 #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]
224 #define RTE_PMD_EXPORT_NAME(name, idx) \
225 static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
226 __attribute__((used)) = RTE_STR(name)
228 #define DRV_EXP_TAG(name, tag) __##name##_##tag
230 #define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
231 static const char DRV_EXP_TAG(name, pci_tbl_export)[] __attribute__((used)) = \
234 #define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
235 static const char DRV_EXP_TAG(name, param_string_export)[] \
236 __attribute__((used)) = str
239 * Advertise the list of kernel modules required to run this driver
241 * This string lists the kernel modules required for the devices
242 * associated to a PMD. The format of each line of the string is:
243 * "<device-pattern> <kmod-expression>".
245 * The possible formats for the device pattern are:
246 * "*" all devices supported by this driver
247 * "pci:*" all PCI devices supported by this driver
248 * "pci:v8086:d*:sv*:sd*" all PCI devices supported by this driver
249 * whose vendor id is 0x8086.
251 * The format of the kernel modules list is a parenthesed expression
252 * containing logical-and (&) and logical-or (|).
254 * The device pattern and the kmod expression are separated by a space.
257 * - "* igb_uio | uio_pci_generic | vfio"
259 #define RTE_PMD_REGISTER_KMOD_DEP(name, str) \
260 static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
261 __attribute__((used)) = str
267 #endif /* _RTE_VDEV_H_ */