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"); \
118 * A generic memory resource representation.
120 struct rte_mem_resource {
121 uint64_t phys_addr; /**< Physical address, 0 if not resource. */
122 uint64_t len; /**< Length of the resource. */
123 void *addr; /**< Virtual address, NULL when not mapped. */
126 /** Double linked list of device drivers. */
127 TAILQ_HEAD(rte_driver_list, rte_driver);
128 /** Double linked list of devices. */
129 TAILQ_HEAD(rte_device_list, rte_device);
131 /* Forward declaration */
135 * A structure describing a generic device.
138 TAILQ_ENTRY(rte_device) next; /**< Next device */
139 struct rte_driver *driver; /**< Associated driver */
140 int numa_node; /**< NUMA node connection */
141 struct rte_devargs *devargs; /**< Device user arguments */
145 * Insert a device detected by a bus scanning.
148 * A pointer to a rte_device structure describing the detected device.
150 void rte_eal_device_insert(struct rte_device *dev);
153 * Remove a device (e.g. when being unplugged).
156 * A pointer to a rte_device structure describing the device to be removed.
158 void rte_eal_device_remove(struct rte_device *dev);
161 * A structure describing a device driver.
164 TAILQ_ENTRY(rte_driver) next; /**< Next in list. */
165 const char *name; /**< Driver name. */
166 const char *alias; /**< Driver alias. */
170 * Register a device driver.
173 * A pointer to a rte_dev structure describing the driver
176 void rte_eal_driver_register(struct rte_driver *driver);
179 * Unregister a device driver.
182 * A pointer to a rte_dev structure describing the driver
183 * to be unregistered.
185 void rte_eal_driver_unregister(struct rte_driver *driver);
188 * Initalize all the registered drivers in this process
190 int rte_eal_dev_init(void);
193 * Initialize a driver specified by name.
196 * The pointer to a driver name to be initialized.
198 * The pointer to arguments used by driver initialization.
200 * 0 on success, negative on error
202 int rte_eal_vdev_init(const char *name, const char *args);
205 * Uninitalize a driver specified by name.
208 * The pointer to a driver name to be initialized.
210 * 0 on success, negative on error
212 int rte_eal_vdev_uninit(const char *name);
215 * Attach a device to a registered driver.
218 * The device name, that refers to a pci device (or some private
219 * way of designating a vdev device). Based on this device name, eal
220 * will identify a driver capable of handling it and pass it to the
221 * driver probing function.
223 * Device arguments to be passed to the driver.
225 * 0 on success, negative on error.
227 int rte_eal_dev_attach(const char *name, const char *devargs);
230 * Detach a device from its driver.
233 * Same description as for rte_eal_dev_attach().
234 * Here, eal will call the driver detaching function.
236 * 0 on success, negative on error.
238 int rte_eal_dev_detach(const char *name);
240 #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]
242 #define RTE_PMD_EXPORT_NAME(name, idx) \
243 static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
244 __attribute__((used)) = RTE_STR(name)
246 #define DRV_EXP_TAG(name, tag) __##name##_##tag
248 #define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
249 static const char DRV_EXP_TAG(name, pci_tbl_export)[] __attribute__((used)) = \
252 #define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
253 static const char DRV_EXP_TAG(name, param_string_export)[] \
254 __attribute__((used)) = str
260 #endif /* _RTE_VDEV_H_ */