1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2014 6WIND S.A.
5 #ifndef _RTE_DEVARGS_H_
6 #define _RTE_DEVARGS_H_
11 * RTE devargs: list of devices and their user arguments
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.
24 #include <sys/queue.h>
25 #include <rte_compat.h>
29 * Type of generic device
32 RTE_DEVTYPE_WHITELISTED_PCI,
33 RTE_DEVTYPE_BLACKLISTED_PCI,
38 * Structure that stores a device given by the user with its arguments
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.
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
49 TAILQ_ENTRY(rte_devargs) next;
50 /** Type of device. */
51 enum rte_devtype type;
53 enum rte_dev_policy policy;
54 /** Name of the device. */
55 char name[RTE_DEV_NAME_MAX_LEN];
58 /** Arguments string as given by user or "" for no argument. */
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. */
71 * Parse a devargs string.
73 * For PCI devices, the format of arguments string is "PCI_ADDR" or
74 * "PCI_ADDR,key=val,key2=val2,...". Examples: "08:00.1", "0000:5:00.0",
77 * For virtual devices, the format of arguments string is "DRIVER_NAME*"
78 * or "DRIVER_NAME*,key=val,key2=val2,...". Examples: "net_ring",
79 * "net_ring0", "net_pmdAnything,arg=0:arg2=1".
81 * The function parses the arguments string to get driver name and driver
85 * The arguments as given by the user.
87 * The pointer to the string to store parsed driver name.
89 * The pointer to the string to store parsed driver arguments.
93 * - A negative value on error
96 int rte_eal_parse_devargs_str(const char *devargs_str,
97 char **drvname, char **drvargs);
100 * Parse a device string.
102 * Verify that a bus is capable of handling the device passed
103 * in argument. Store which bus will handle the device, its name
104 * and the eventual device parameters.
108 * bus:device_identifier,arg1=val1,arg2=val2
110 * where "bus:" is the bus name followed by any character separator.
111 * The bus name is optional. If no bus name is specified, each bus
112 * will attempt to recognize the device identifier. The first one
113 * to succeed will be used.
117 * pci:0000:05.00.0,arg=val
122 * The devargs structure holding the device information.
125 * String describing a device.
129 * - Negative errno on error.
133 rte_devargs_parse(struct rte_devargs *da, const char *dev);
136 * Parse a device string.
138 * Verify that a bus is capable of handling the device passed
139 * in argument. Store which bus will handle the device, its name
140 * and the eventual device parameters.
142 * The device string is built with a printf-like syntax.
146 * bus:device_identifier,arg1=val1,arg2=val2
148 * where "bus:" is the bus name followed by any character separator.
149 * The bus name is optional. If no bus name is specified, each bus
150 * will attempt to recognize the device identifier. The first one
151 * to succeed will be used.
155 * pci:0000:05.00.0,arg=val
160 * The devargs structure holding the device information.
162 * Format string describing a device.
166 * - Negative errno on error.
170 rte_devargs_parsef(struct rte_devargs *da,
171 const char *format, ...)
172 __attribute__((format(printf, 2, 0)));
175 * Insert an rte_devargs in the global list.
178 * The devargs structure to insert.
182 * - Negative on error.
186 rte_devargs_insert(struct rte_devargs *da);
189 * Add a device to the user device list
190 * See rte_devargs_parse() for details.
193 * The type of the device.
195 * The arguments as given by the user.
199 * - A negative value on error
202 int rte_devargs_add(enum rte_devtype devtype, const char *devargs_str);
206 * Add a device to the user device list
207 * See rte_devargs_parse() for details.
210 * The type of the device.
212 * The arguments as given by the user.
216 * - A negative value on error
219 int rte_eal_devargs_add(enum rte_devtype devtype, const char *devargs_str);
222 * Remove a device from the user device list.
223 * Its resources are freed.
224 * If the devargs cannot be found, nothing happens.
227 * bus name of the devargs to remove.
230 * device name of the devargs to remove.
235 * >0 if the devargs was not within the user device list.
238 int rte_devargs_remove(const char *busname,
239 const char *devname);
242 * Count the number of user devices of a specified type
245 * The type of the devices to counted.
248 * The number of devices.
252 rte_devargs_type_count(enum rte_devtype devtype);
256 * Count the number of user devices of a specified type
259 * The type of the devices to counted.
262 * The number of devices.
266 rte_eal_devargs_type_count(enum rte_devtype devtype);
269 * This function dumps the list of user device and their arguments.
272 * A pointer to a file for output
275 void rte_devargs_dump(FILE *f);
279 * This function dumps the list of user device and their arguments.
282 * A pointer to a file for output
285 void rte_eal_devargs_dump(FILE *f);
288 * Find next rte_devargs matching the provided bus name.
291 * Limit the iteration to devargs related to buses
292 * matching this name.
293 * Will return any next rte_devargs if NULL.
296 * Starting iteration point. The iteration will start at
297 * the first rte_devargs if NULL.
300 * Next rte_devargs entry matching the requested bus,
301 * NULL if there is none.
305 rte_devargs_next(const char *busname, const struct rte_devargs *start);
308 * Iterate over all rte_devargs for a specific bus.
310 #define RTE_EAL_DEVARGS_FOREACH(busname, da) \
311 for (da = rte_devargs_next(busname, NULL); \
313 da = rte_devargs_next(busname, da)) \
319 #endif /* _RTE_DEVARGS_H_ */