eal/arm64: fix poly64/128 compilation with GCC < 4.9
[dpdk.git] / lib / librte_eal / common / include / rte_devargs.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright 2014 6WIND S.A.
5  *
6  *   Redistribution and use in source and binary forms, with or without
7  *   modification, are permitted provided that the following conditions
8  *   are met:
9  *
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
15  *       distribution.
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.
19  *
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.
31  */
32
33 #ifndef _RTE_DEVARGS_H_
34 #define _RTE_DEVARGS_H_
35
36 /**
37  * @file
38  *
39  * RTE devargs: list of devices and their user arguments
40  *
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.
45  */
46
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50
51 #include <stdio.h>
52 #include <sys/queue.h>
53 #include <rte_bus.h>
54
55 /**
56  * Type of generic device
57  */
58 enum rte_devtype {
59         RTE_DEVTYPE_WHITELISTED_PCI,
60         RTE_DEVTYPE_BLACKLISTED_PCI,
61         RTE_DEVTYPE_VIRTUAL,
62 };
63
64 /**
65  * Structure that stores a device given by the user with its arguments
66  *
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.
69  *
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
72  * device.
73  */
74 struct rte_devargs {
75         /** Next in list. */
76         TAILQ_ENTRY(rte_devargs) next;
77         /** Type of device. */
78         enum rte_devtype type;
79         /** Device policy. */
80         enum rte_dev_policy policy;
81         /** Bus handle for the device. */
82         struct rte_bus *bus;
83         /** Name of the device. */
84         char name[RTE_DEV_NAME_MAX_LEN];
85         /** Arguments string as given by user or "" for no argument. */
86         char *args;
87 };
88
89 /** user device double-linked queue type definition */
90 TAILQ_HEAD(rte_devargs_list, rte_devargs);
91
92 /** Global list of user devices */
93 extern struct rte_devargs_list devargs_list;
94
95 /**
96  * Parse a devargs string.
97  *
98  * For PCI devices, the format of arguments string is "PCI_ADDR" or
99  * "PCI_ADDR,key=val,key2=val2,...". Examples: "08:00.1", "0000:5:00.0",
100  * "04:00.0,arg=val".
101  *
102  * For virtual devices, the format of arguments string is "DRIVER_NAME*"
103  * or "DRIVER_NAME*,key=val,key2=val2,...". Examples: "net_ring",
104  * "net_ring0", "net_pmdAnything,arg=0:arg2=1".
105  *
106  * The function parses the arguments string to get driver name and driver
107  * arguments.
108  *
109  * @param devargs_str
110  *   The arguments as given by the user.
111  * @param drvname
112  *   The pointer to the string to store parsed driver name.
113  * @param drvargs
114  *   The pointer to the string to store parsed driver arguments.
115  *
116  * @return
117  *   - 0 on success
118  *   - A negative value on error
119  */
120 int rte_eal_parse_devargs_str(const char *devargs_str,
121                                 char **drvname, char **drvargs);
122
123 /**
124  * Parse a device string.
125  *
126  * Verify that a bus is capable of handling the device passed
127  * in argument. Store which bus will handle the device, its name
128  * and the eventual device parameters.
129  *
130  * @param dev
131  *   The device declaration string.
132  * @param da
133  *   The devargs structure holding the device information.
134  *
135  * @return
136  *   - 0 on success.
137  *   - Negative errno on error.
138  */
139 int
140 rte_eal_devargs_parse(const char *dev,
141                       struct rte_devargs *da);
142
143 /**
144  * Insert an rte_devargs in the global list.
145  *
146  * @param da
147  *  The devargs structure to insert.
148  *
149  * @return
150  *   - 0 on success
151  *   - Negative on error.
152  */
153 int
154 rte_eal_devargs_insert(struct rte_devargs *da);
155
156 /**
157  * Add a device to the user device list
158  *
159  * For PCI devices, the format of arguments string is "PCI_ADDR" or
160  * "PCI_ADDR,key=val,key2=val2,...". Examples: "08:00.1", "0000:5:00.0",
161  * "04:00.0,arg=val".
162  *
163  * For virtual devices, the format of arguments string is "DRIVER_NAME*"
164  * or "DRIVER_NAME*,key=val,key2=val2,...". Examples: "net_ring",
165  * "net_ring0", "net_pmdAnything,arg=0:arg2=1". The validity of the
166  * driver name is not checked by this function, it is done when probing
167  * the drivers.
168  *
169  * @param devtype
170  *   The type of the device.
171  * @param devargs_str
172  *   The arguments as given by the user.
173  *
174  * @return
175  *   - 0 on success
176  *   - A negative value on error
177  */
178 int rte_eal_devargs_add(enum rte_devtype devtype, const char *devargs_str);
179
180 /**
181  * Remove a device from the user device list.
182  * Its resources are freed.
183  * If the devargs cannot be found, nothing happens.
184  *
185  * @param busname
186  *   bus name of the devargs to remove.
187  *
188  * @param devname
189  *   device name of the devargs to remove.
190  *
191  * @return
192  *   0 on success.
193  *   <0 on error.
194  *   >0 if the devargs was not within the user device list.
195  */
196 int rte_eal_devargs_remove(const char *busname, const char *devname);
197
198 /**
199  * Count the number of user devices of a specified type
200  *
201  * @param devtype
202  *   The type of the devices to counted.
203  *
204  * @return
205  *   The number of devices.
206  */
207 unsigned int
208 rte_eal_devargs_type_count(enum rte_devtype devtype);
209
210 /**
211  * This function dumps the list of user device and their arguments.
212  *
213  * @param f
214  *   A pointer to a file for output
215  */
216 void rte_eal_devargs_dump(FILE *f);
217
218 #ifdef __cplusplus
219 }
220 #endif
221
222 #endif /* _RTE_DEVARGS_H_ */