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_WHITELISTED_PCI,
60 RTE_DEVTYPE_BLACKLISTED_PCI,
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;
80 /** Used if type is RTE_DEVTYPE_*_PCI. */
83 struct rte_pci_addr addr;
85 /** Used if type is RTE_DEVTYPE_VIRTUAL. */
91 /** Arguments string as given by user or "" for no argument. */
95 /** user device double-linked queue type definition */
96 TAILQ_HEAD(rte_devargs_list, rte_devargs);
98 /** Global list of user devices */
99 extern struct rte_devargs_list devargs_list;
102 * Parse a devargs string.
104 * For PCI devices, the format of arguments string is "PCI_ADDR" or
105 * "PCI_ADDR,key=val,key2=val2,...". Examples: "08:00.1", "0000:5:00.0",
108 * For virtual devices, the format of arguments string is "DRIVER_NAME*"
109 * or "DRIVER_NAME*,key=val,key2=val2,...". Examples: "eth_ring",
110 * "eth_ring0", "eth_pmdAnything,arg=0:arg2=1".
112 * The function parses the arguments string to get driver name and driver
116 * The arguments as given by the user.
118 * The pointer to the string to store parsed driver name.
120 * The pointer to the string to store parsed driver arguments.
124 * - A negative value on error
126 int rte_eal_parse_devargs_str(const char *devargs_str,
127 char **drvname, char **drvargs);
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: "eth_ring",
138 * "eth_ring0", "eth_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 * Count the number of user devices of a specified type
157 * The type of the devices to counted.
160 * The number of devices.
163 rte_eal_devargs_type_count(enum rte_devtype devtype);
166 * This function dumps the list of user device and their arguments.
169 * A pointer to a file for output
171 void rte_eal_devargs_dump(FILE *f);
177 #endif /* _RTE_DEVARGS_H_ */