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 /** Bus handle for the device. */
56 /** Name of the device. */
57 char name[RTE_DEV_NAME_MAX_LEN];
58 /** Arguments string as given by user or "" for no argument. */
63 * Parse a devargs string.
65 * For PCI devices, the format of arguments string is "PCI_ADDR" or
66 * "PCI_ADDR,key=val,key2=val2,...". Examples: "08:00.1", "0000:5:00.0",
69 * For virtual devices, the format of arguments string is "DRIVER_NAME*"
70 * or "DRIVER_NAME*,key=val,key2=val2,...". Examples: "net_ring",
71 * "net_ring0", "net_pmdAnything,arg=0:arg2=1".
73 * The function parses the arguments string to get driver name and driver
77 * The arguments as given by the user.
79 * The pointer to the string to store parsed driver name.
81 * The pointer to the string to store parsed driver arguments.
85 * - A negative value on error
87 int rte_eal_parse_devargs_str(const char *devargs_str,
88 char **drvname, char **drvargs);
91 * Parse a device string.
93 * Verify that a bus is capable of handling the device passed
94 * in argument. Store which bus will handle the device, its name
95 * and the eventual device parameters.
97 * The device string is built with a printf-like syntax.
100 * The devargs structure holding the device information.
102 * Format string describing a device.
106 * - Negative errno on error.
108 int __rte_experimental
109 rte_eal_devargs_parse(struct rte_devargs *da,
110 const char *format, ...)
111 __attribute__((format(printf, 2, 0)));
114 * Insert an rte_devargs in the global list.
117 * The devargs structure to insert.
121 * - Negative on error.
123 int __rte_experimental
124 rte_eal_devargs_insert(struct rte_devargs *da);
127 * Add a device to the user device list
129 * For PCI devices, the format of arguments string is "PCI_ADDR" or
130 * "PCI_ADDR,key=val,key2=val2,...". Examples: "08:00.1", "0000:5:00.0",
133 * For virtual devices, the format of arguments string is "DRIVER_NAME*"
134 * or "DRIVER_NAME*,key=val,key2=val2,...". Examples: "net_ring",
135 * "net_ring0", "net_pmdAnything,arg=0:arg2=1". The validity of the
136 * driver name is not checked by this function, it is done when probing
140 * The type of the device.
142 * The arguments as given by the user.
146 * - A negative value on error
148 int rte_eal_devargs_add(enum rte_devtype devtype, const char *devargs_str);
151 * Remove a device from the user device list.
152 * Its resources are freed.
153 * If the devargs cannot be found, nothing happens.
156 * bus name of the devargs to remove.
159 * device name of the devargs to remove.
164 * >0 if the devargs was not within the user device list.
166 int __rte_experimental rte_eal_devargs_remove(const char *busname,
167 const char *devname);
170 * Count the number of user devices of a specified type
173 * The type of the devices to counted.
176 * The number of devices.
179 rte_eal_devargs_type_count(enum rte_devtype devtype);
182 * This function dumps the list of user device and their arguments.
185 * A pointer to a file for output
187 void rte_eal_devargs_dump(FILE *f);
190 * Find next rte_devargs matching the provided bus name.
193 * Limit the iteration to devargs related to buses
194 * matching this name.
195 * Will return any next rte_devargs if NULL.
198 * Starting iteration point. The iteration will start at
199 * the first rte_devargs if NULL.
202 * Next rte_devargs entry matching the requested bus,
203 * NULL if there is none.
207 rte_eal_devargs_next(const char *busname, const struct rte_devargs *start);
210 * Iterate over all rte_devargs for a specific bus.
212 #define RTE_EAL_DEVARGS_FOREACH(busname, da) \
213 for (da = rte_eal_devargs_next(busname, NULL); \
215 da = rte_eal_devargs_next(busname, da)) \
221 #endif /* _RTE_DEVARGS_H_ */