]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
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_log.h> | |
53 | ||
54 | __attribute__((format(printf, 2, 0))) | |
55 | static inline void | |
56 | rte_pmd_debug_trace(const char *func_name, const char *fmt, ...) | |
57 | { | |
58 | va_list ap; | |
59 | ||
60 | va_start(ap, fmt); | |
61 | ||
62 | char buffer[vsnprintf(NULL, 0, fmt, ap) + 1]; | |
63 | ||
64 | va_end(ap); | |
65 | ||
66 | va_start(ap, fmt); | |
67 | vsnprintf(buffer, sizeof(buffer), fmt, ap); | |
68 | va_end(ap); | |
69 | ||
70 | rte_log(RTE_LOG_ERR, RTE_LOGTYPE_PMD, "%s: %s", func_name, buffer); | |
71 | } | |
72 | ||
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"); \ | |
77 | return retval; \ | |
78 | } \ | |
79 | } while (0) | |
80 | ||
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"); \ | |
84 | return; \ | |
85 | } \ | |
86 | } while (0) | |
87 | ||
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"); \ | |
92 | return retval; \ | |
93 | } \ | |
94 | } while (0) | |
95 | ||
96 | #define RTE_FUNC_PTR_OR_RET(func) do { \ | |
97 | if ((func) == NULL) { \ | |
98 | RTE_PMD_DEBUG_TRACE("Function not supported\n"); \ | |
99 | return; \ | |
100 | } \ | |
101 | } while (0) | |
102 | ||
103 | /** | |
104 | * A generic memory resource representation. | |
105 | */ | |
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. */ | |
110 | }; | |
111 | ||
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); | |
116 | ||
117 | /* Forward declaration */ | |
118 | struct rte_driver; | |
119 | ||
120 | /** | |
121 | * A structure describing a generic device. | |
122 | */ | |
123 | struct rte_device { | |
124 | TAILQ_ENTRY(rte_device) next; /**< Next device */ | |
125 | struct rte_driver *driver; /**< Associated driver */ | |
126 | int numa_node; /**< NUMA node connection */ | |
127 | struct rte_devargs *devargs; /**< Device user arguments */ | |
128 | }; | |
129 | ||
130 | /** | |
131 | * Insert a device detected by a bus scanning. | |
132 | * | |
133 | * @param dev | |
134 | * A pointer to a rte_device structure describing the detected device. | |
135 | */ | |
136 | void rte_eal_device_insert(struct rte_device *dev); | |
137 | ||
138 | /** | |
139 | * Remove a device (e.g. when being unplugged). | |
140 | * | |
141 | * @param dev | |
142 | * A pointer to a rte_device structure describing the device to be removed. | |
143 | */ | |
144 | void rte_eal_device_remove(struct rte_device *dev); | |
145 | ||
146 | /** | |
147 | * A structure describing a device driver. | |
148 | */ | |
149 | struct rte_driver { | |
150 | TAILQ_ENTRY(rte_driver) next; /**< Next in list. */ | |
151 | const char *name; /**< Driver name. */ | |
152 | const char *alias; /**< Driver alias. */ | |
153 | }; | |
154 | ||
155 | /** | |
156 | * Register a device driver. | |
157 | * | |
158 | * @param driver | |
159 | * A pointer to a rte_dev structure describing the driver | |
160 | * to be registered. | |
161 | */ | |
162 | void rte_eal_driver_register(struct rte_driver *driver); | |
163 | ||
164 | /** | |
165 | * Unregister a device driver. | |
166 | * | |
167 | * @param driver | |
168 | * A pointer to a rte_dev structure describing the driver | |
169 | * to be unregistered. | |
170 | */ | |
171 | void rte_eal_driver_unregister(struct rte_driver *driver); | |
172 | ||
173 | /** | |
174 | * Initalize all the registered drivers in this process | |
175 | */ | |
176 | int rte_eal_dev_init(void); | |
177 | ||
178 | /** | |
179 | * Initialize a driver specified by name. | |
180 | * | |
181 | * @param name | |
182 | * The pointer to a driver name to be initialized. | |
183 | * @param args | |
184 | * The pointer to arguments used by driver initialization. | |
185 | * @return | |
186 | * 0 on success, negative on error | |
187 | */ | |
188 | int rte_eal_vdev_init(const char *name, const char *args); | |
189 | ||
190 | /** | |
191 | * Uninitalize a driver specified by name. | |
192 | * | |
193 | * @param name | |
194 | * The pointer to a driver name to be initialized. | |
195 | * @return | |
196 | * 0 on success, negative on error | |
197 | */ | |
198 | int rte_eal_vdev_uninit(const char *name); | |
199 | ||
200 | /** | |
201 | * Attach a device to a registered driver. | |
202 | * | |
203 | * @param name | |
204 | * The device name, that refers to a pci device (or some private | |
205 | * way of designating a vdev device). Based on this device name, eal | |
206 | * will identify a driver capable of handling it and pass it to the | |
207 | * driver probing function. | |
208 | * @param devargs | |
209 | * Device arguments to be passed to the driver. | |
210 | * @return | |
211 | * 0 on success, negative on error. | |
212 | */ | |
213 | int rte_eal_dev_attach(const char *name, const char *devargs); | |
214 | ||
215 | /** | |
216 | * Detach a device from its driver. | |
217 | * | |
218 | * @param name | |
219 | * Same description as for rte_eal_dev_attach(). | |
220 | * Here, eal will call the driver detaching function. | |
221 | * @return | |
222 | * 0 on success, negative on error. | |
223 | */ | |
224 | int rte_eal_dev_detach(const char *name); | |
225 | ||
226 | #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[] | |
227 | ||
228 | #define RTE_PMD_EXPORT_NAME(name, idx) \ | |
229 | static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \ | |
230 | __attribute__((used)) = RTE_STR(name) | |
231 | ||
232 | #define DRV_EXP_TAG(name, tag) __##name##_##tag | |
233 | ||
234 | #define RTE_PMD_REGISTER_PCI_TABLE(name, table) \ | |
235 | static const char DRV_EXP_TAG(name, pci_tbl_export)[] __attribute__((used)) = \ | |
236 | RTE_STR(table) | |
237 | ||
238 | #define RTE_PMD_REGISTER_PARAM_STRING(name, str) \ | |
239 | static const char DRV_EXP_TAG(name, param_string_export)[] \ | |
240 | __attribute__((used)) = str | |
241 | ||
242 | #ifdef __cplusplus | |
243 | } | |
244 | #endif | |
245 | ||
246 | #endif /* _RTE_VDEV_H_ */ |