4 * Copyright 2014 6WIND S.A.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
16 * * Neither the name of 6WIND S.A nor the names of its contributors
17 * may be used to endorse or promote products derived from this
18 * software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 #ifndef _RTE_DEVARGS_H_
34 #define _RTE_DEVARGS_H_
39 * RTE devargs: list of devices and their user arguments
41 * This file stores a list of devices and their arguments given by
42 * the user when a DPDK application is started. These devices can be PCI
43 * devices or virtual devices. These devices are stored at startup in a
44 * list of rte_devargs structures.
52 #include <sys/queue.h>
56 * Type of generic device
59 RTE_DEVTYPE_UNDEFINED,
60 RTE_DEVTYPE_WHITELISTED,
61 RTE_DEVTYPE_BLACKLISTED,
65 * Structure that stores a device given by the user with its arguments
67 * A user device is a physical or a virtual device given by the user to
68 * the DPDK application at startup through command line arguments.
70 * The structure stores the configuration of the device, its PCI
71 * identifier if it's a PCI device or the driver name if it's a virtual
76 TAILQ_ENTRY(rte_devargs) next;
77 /** Type of device. */
78 enum rte_devtype type;
79 /** Bus handle for the device. */
81 /** Name of the device. */
82 char name[RTE_DEV_NAME_MAX_LEN];
83 /** Arguments string as given by user or "" for no argument. */
87 /** user device double-linked queue type definition */
88 TAILQ_HEAD(rte_devargs_list, rte_devargs);
90 /** Global list of user devices */
91 extern struct rte_devargs_list devargs_list;
94 * Parse a devargs string.
96 * For PCI devices, the format of arguments string is "PCI_ADDR" or
97 * "PCI_ADDR,key=val,key2=val2,...". Examples: "08:00.1", "0000:5:00.0",
100 * For virtual devices, the format of arguments string is "DRIVER_NAME*"
101 * or "DRIVER_NAME*,key=val,key2=val2,...". Examples: "net_ring",
102 * "net_ring0", "net_pmdAnything,arg=0:arg2=1".
104 * The function parses the arguments string to get driver name and driver
108 * The arguments as given by the user.
110 * The pointer to the string to store parsed driver name.
112 * The pointer to the string to store parsed driver arguments.
116 * - A negative value on error
118 int rte_eal_parse_devargs_str(const char *devargs_str,
119 char **drvname, char **drvargs);
122 * Parse a device string.
124 * Verify that a bus is capable of handling the device passed
125 * in argument. Store which bus will handle the device, its name
126 * and the eventual device parameters.
129 * The device declaration string.
131 * The devargs structure holding the device information.
135 * - Negative errno on error.
138 rte_eal_devargs_parse(const char *dev,
139 struct rte_devargs *da);
142 * Add a device to the user device list
144 * For PCI devices, the format of arguments string is "PCI_ADDR" or
145 * "PCI_ADDR,key=val,key2=val2,...". Examples: "08:00.1", "0000:5:00.0",
148 * For virtual devices, the format of arguments string is "DRIVER_NAME*"
149 * or "DRIVER_NAME*,key=val,key2=val2,...". Examples: "net_ring",
150 * "net_ring0", "net_pmdAnything,arg=0:arg2=1". The validity of the
151 * driver name is not checked by this function, it is done when probing
155 * The type of the device.
157 * The arguments as given by the user.
161 * - A negative value on error
163 int rte_eal_devargs_add(enum rte_devtype devtype, const char *devargs_str);
166 * Remove a device from the user device list.
167 * Its resources are freed.
168 * If the devargs cannot be found, nothing happens.
171 * bus name of the devargs to remove.
174 * device name of the devargs to remove.
179 * >0 if the devargs was not within the user device list.
181 int rte_eal_devargs_remove(const char *busname, const char *devname);
184 * Count the number of user devices of a specified type
187 * The type of the devices to counted.
190 * The number of devices.
193 rte_eal_devargs_type_count(enum rte_devtype devtype);
196 * This function dumps the list of user device and their arguments.
199 * A pointer to a file for output
201 void rte_eal_devargs_dump(FILE *f);
207 #endif /* _RTE_DEVARGS_H_ */