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. */
62 /** user device double-linked queue type definition */
63 TAILQ_HEAD(rte_devargs_list, rte_devargs);
65 /** Global list of user devices */
66 extern struct rte_devargs_list devargs_list;
69 * Parse a devargs string.
71 * For PCI devices, the format of arguments string is "PCI_ADDR" or
72 * "PCI_ADDR,key=val,key2=val2,...". Examples: "08:00.1", "0000:5:00.0",
75 * For virtual devices, the format of arguments string is "DRIVER_NAME*"
76 * or "DRIVER_NAME*,key=val,key2=val2,...". Examples: "net_ring",
77 * "net_ring0", "net_pmdAnything,arg=0:arg2=1".
79 * The function parses the arguments string to get driver name and driver
83 * The arguments as given by the user.
85 * The pointer to the string to store parsed driver name.
87 * The pointer to the string to store parsed driver arguments.
91 * - A negative value on error
93 int rte_eal_parse_devargs_str(const char *devargs_str,
94 char **drvname, char **drvargs);
97 * Parse a device string.
99 * Verify that a bus is capable of handling the device passed
100 * in argument. Store which bus will handle the device, its name
101 * and the eventual device parameters.
104 * The device declaration string.
106 * The devargs structure holding the device information.
110 * - Negative errno on error.
112 int __rte_experimental
113 rte_eal_devargs_parse(const char *dev,
114 struct rte_devargs *da);
117 * Insert an rte_devargs in the global list.
120 * The devargs structure to insert.
124 * - Negative on error.
126 int __rte_experimental
127 rte_eal_devargs_insert(struct rte_devargs *da);
130 * Add a device to the user device list
132 * For PCI devices, the format of arguments string is "PCI_ADDR" or
133 * "PCI_ADDR,key=val,key2=val2,...". Examples: "08:00.1", "0000:5:00.0",
136 * For virtual devices, the format of arguments string is "DRIVER_NAME*"
137 * or "DRIVER_NAME*,key=val,key2=val2,...". Examples: "net_ring",
138 * "net_ring0", "net_pmdAnything,arg=0:arg2=1". The validity of the
139 * driver name is not checked by this function, it is done when probing
143 * The type of the device.
145 * The arguments as given by the user.
149 * - A negative value on error
151 int rte_eal_devargs_add(enum rte_devtype devtype, const char *devargs_str);
154 * Remove a device from the user device list.
155 * Its resources are freed.
156 * If the devargs cannot be found, nothing happens.
159 * bus name of the devargs to remove.
162 * device name of the devargs to remove.
167 * >0 if the devargs was not within the user device list.
169 int __rte_experimental rte_eal_devargs_remove(const char *busname,
170 const char *devname);
173 * Count the number of user devices of a specified type
176 * The type of the devices to counted.
179 * The number of devices.
182 rte_eal_devargs_type_count(enum rte_devtype devtype);
185 * This function dumps the list of user device and their arguments.
188 * A pointer to a file for output
190 void rte_eal_devargs_dump(FILE *f);
196 #endif /* _RTE_DEVARGS_H_ */