]>
Commit | Line | Data |
---|---|---|
11fdf7f2 TL |
1 | /* SPDX-License-Identifier: BSD-3-Clause |
2 | * Copyright 2014 6WIND S.A. | |
3 | */ | |
4 | ||
5 | #ifndef _RTE_DEVARGS_H_ | |
6 | #define _RTE_DEVARGS_H_ | |
7 | ||
8 | /** | |
9 | * @file | |
10 | * | |
11 | * RTE devargs: list of devices and their user arguments | |
12 | * | |
13 | * This file stores a list of devices and their arguments given by | |
14 | * the user when a DPDK application is started. These devices can be PCI | |
15 | * devices or virtual devices. These devices are stored at startup in a | |
16 | * list of rte_devargs structures. | |
17 | */ | |
18 | ||
19 | #ifdef __cplusplus | |
20 | extern "C" { | |
21 | #endif | |
22 | ||
23 | #include <stdio.h> | |
24 | #include <sys/queue.h> | |
25 | #include <rte_compat.h> | |
26 | #include <rte_bus.h> | |
27 | ||
28 | /** | |
29 | * Type of generic device | |
30 | */ | |
31 | enum rte_devtype { | |
32 | RTE_DEVTYPE_WHITELISTED_PCI, | |
33 | RTE_DEVTYPE_BLACKLISTED_PCI, | |
34 | RTE_DEVTYPE_VIRTUAL, | |
35 | }; | |
36 | ||
37 | /** | |
38 | * Structure that stores a device given by the user with its arguments | |
39 | * | |
40 | * A user device is a physical or a virtual device given by the user to | |
41 | * the DPDK application at startup through command line arguments. | |
42 | * | |
43 | * The structure stores the configuration of the device, its PCI | |
44 | * identifier if it's a PCI device or the driver name if it's a virtual | |
45 | * device. | |
46 | */ | |
47 | struct rte_devargs { | |
48 | /** Next in list. */ | |
49 | TAILQ_ENTRY(rte_devargs) next; | |
50 | /** Type of device. */ | |
51 | enum rte_devtype type; | |
52 | /** Device policy. */ | |
53 | enum rte_dev_policy policy; | |
54 | /** Name of the device. */ | |
55 | char name[RTE_DEV_NAME_MAX_LEN]; | |
56 | RTE_STD_C11 | |
57 | union { | |
58 | /** Arguments string as given by user or "" for no argument. */ | |
59 | char *args; | |
60 | const char *drv_str; | |
61 | }; | |
62 | struct rte_bus *bus; /**< bus handle. */ | |
63 | struct rte_class *cls; /**< class handle. */ | |
64 | const char *bus_str; /**< bus-related part of device string. */ | |
65 | const char *cls_str; /**< class-related part of device string. */ | |
66 | const char *data; /**< Device string storage. */ | |
67 | }; | |
68 | ||
11fdf7f2 TL |
69 | /** |
70 | * Parse a device string. | |
71 | * | |
72 | * Verify that a bus is capable of handling the device passed | |
73 | * in argument. Store which bus will handle the device, its name | |
74 | * and the eventual device parameters. | |
75 | * | |
76 | * The syntax is: | |
77 | * | |
78 | * bus:device_identifier,arg1=val1,arg2=val2 | |
79 | * | |
80 | * where "bus:" is the bus name followed by any character separator. | |
81 | * The bus name is optional. If no bus name is specified, each bus | |
82 | * will attempt to recognize the device identifier. The first one | |
83 | * to succeed will be used. | |
84 | * | |
85 | * Examples: | |
86 | * | |
87 | * pci:0000:05.00.0,arg=val | |
88 | * 05.00.0,arg=val | |
89 | * vdev:net_ring0 | |
90 | * | |
91 | * @param da | |
92 | * The devargs structure holding the device information. | |
93 | * | |
94 | * @param dev | |
95 | * String describing a device. | |
96 | * | |
97 | * @return | |
98 | * - 0 on success. | |
99 | * - Negative errno on error. | |
100 | */ | |
11fdf7f2 TL |
101 | int |
102 | rte_devargs_parse(struct rte_devargs *da, const char *dev); | |
103 | ||
104 | /** | |
105 | * Parse a device string. | |
106 | * | |
107 | * Verify that a bus is capable of handling the device passed | |
108 | * in argument. Store which bus will handle the device, its name | |
109 | * and the eventual device parameters. | |
110 | * | |
111 | * The device string is built with a printf-like syntax. | |
112 | * | |
113 | * The syntax is: | |
114 | * | |
115 | * bus:device_identifier,arg1=val1,arg2=val2 | |
116 | * | |
117 | * where "bus:" is the bus name followed by any character separator. | |
118 | * The bus name is optional. If no bus name is specified, each bus | |
119 | * will attempt to recognize the device identifier. The first one | |
120 | * to succeed will be used. | |
121 | * | |
122 | * Examples: | |
123 | * | |
124 | * pci:0000:05.00.0,arg=val | |
125 | * 05.00.0,arg=val | |
126 | * vdev:net_ring0 | |
127 | * | |
128 | * @param da | |
129 | * The devargs structure holding the device information. | |
130 | * @param format | |
131 | * Format string describing a device. | |
132 | * | |
133 | * @return | |
134 | * - 0 on success. | |
135 | * - Negative errno on error. | |
136 | */ | |
11fdf7f2 TL |
137 | int |
138 | rte_devargs_parsef(struct rte_devargs *da, | |
139 | const char *format, ...) | |
140 | __attribute__((format(printf, 2, 0))); | |
141 | ||
142 | /** | |
143 | * Insert an rte_devargs in the global list. | |
144 | * | |
145 | * @param da | |
146 | * The devargs structure to insert. | |
9f95a23c TL |
147 | * If a devargs for the same device is already inserted, |
148 | * it will be updated and returned. It means *da pointer can change. | |
11fdf7f2 TL |
149 | * |
150 | * @return | |
151 | * - 0 on success | |
152 | * - Negative on error. | |
153 | */ | |
154 | __rte_experimental | |
155 | int | |
9f95a23c | 156 | rte_devargs_insert(struct rte_devargs **da); |
11fdf7f2 TL |
157 | |
158 | /** | |
159 | * Add a device to the user device list | |
160 | * See rte_devargs_parse() for details. | |
161 | * | |
162 | * @param devtype | |
163 | * The type of the device. | |
164 | * @param devargs_str | |
165 | * The arguments as given by the user. | |
166 | * | |
167 | * @return | |
168 | * - 0 on success | |
169 | * - A negative value on error | |
170 | */ | |
11fdf7f2 TL |
171 | int rte_devargs_add(enum rte_devtype devtype, const char *devargs_str); |
172 | ||
11fdf7f2 TL |
173 | /** |
174 | * Remove a device from the user device list. | |
175 | * Its resources are freed. | |
176 | * If the devargs cannot be found, nothing happens. | |
177 | * | |
9f95a23c TL |
178 | * @param devargs |
179 | * The instance or a copy of devargs to remove. | |
11fdf7f2 TL |
180 | * |
181 | * @return | |
182 | * 0 on success. | |
183 | * <0 on error. | |
184 | * >0 if the devargs was not within the user device list. | |
185 | */ | |
186 | __rte_experimental | |
9f95a23c | 187 | int rte_devargs_remove(struct rte_devargs *devargs); |
11fdf7f2 TL |
188 | |
189 | /** | |
190 | * Count the number of user devices of a specified type | |
191 | * | |
192 | * @param devtype | |
193 | * The type of the devices to counted. | |
194 | * | |
195 | * @return | |
196 | * The number of devices. | |
197 | */ | |
11fdf7f2 TL |
198 | unsigned int |
199 | rte_devargs_type_count(enum rte_devtype devtype); | |
200 | ||
11fdf7f2 TL |
201 | /** |
202 | * This function dumps the list of user device and their arguments. | |
203 | * | |
204 | * @param f | |
205 | * A pointer to a file for output | |
206 | */ | |
11fdf7f2 TL |
207 | void rte_devargs_dump(FILE *f); |
208 | ||
11fdf7f2 TL |
209 | /** |
210 | * Find next rte_devargs matching the provided bus name. | |
211 | * | |
212 | * @param busname | |
213 | * Limit the iteration to devargs related to buses | |
214 | * matching this name. | |
215 | * Will return any next rte_devargs if NULL. | |
216 | * | |
217 | * @param start | |
218 | * Starting iteration point. The iteration will start at | |
219 | * the first rte_devargs if NULL. | |
220 | * | |
221 | * @return | |
222 | * Next rte_devargs entry matching the requested bus, | |
223 | * NULL if there is none. | |
224 | */ | |
11fdf7f2 TL |
225 | struct rte_devargs * |
226 | rte_devargs_next(const char *busname, const struct rte_devargs *start); | |
227 | ||
228 | /** | |
229 | * Iterate over all rte_devargs for a specific bus. | |
230 | */ | |
231 | #define RTE_EAL_DEVARGS_FOREACH(busname, da) \ | |
232 | for (da = rte_devargs_next(busname, NULL); \ | |
233 | da != NULL; \ | |
234 | da = rte_devargs_next(busname, da)) \ | |
235 | ||
236 | #ifdef __cplusplus | |
237 | } | |
238 | #endif | |
239 | ||
240 | #endif /* _RTE_DEVARGS_H_ */ |