lib/librte_eal/common/include/rte_devargs.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2014 6WIND S.A.
   3  */
   4
   5 #ifndef _RTE_DEVARGS_H_
   6 #define _RTE_DEVARGS_H_
   7
   8 /**
   9  * @file
  10  *
  11  * RTE devargs: list of devices and their user arguments
  12  *
  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.
  17  */
  18
  19 #ifdef __cplusplus
  20 extern "C" {
  21 #endif
  22
  23 #include <stdio.h>
  24 #include <sys/queue.h>
  25 #include <rte_compat.h>
  26 #include <rte_bus.h>
  27
  28 /**
  29  * Type of generic device
  30  */
  31 enum rte_devtype {
  32         RTE_DEVTYPE_WHITELISTED_PCI,
  33         RTE_DEVTYPE_BLACKLISTED_PCI,
  34         RTE_DEVTYPE_VIRTUAL,
  35 };
  36
  37 /**
  38  * Structure that stores a device given by the user with its arguments
  39  *
  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.
  42  *
  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
  45  * device.
  46  */
  47 struct rte_devargs {
  48         /** Next in list. */
  49         TAILQ_ENTRY(rte_devargs) next;
  50         /** Type of device. */
  51         enum rte_devtype type;
  52         /** Device policy. */
  53         enum rte_dev_policy policy;
  54         /** Bus handle for the device. */
  55         struct rte_bus *bus;
  56         /** Name of the device. */
  57         char name[RTE_DEV_NAME_MAX_LEN];
  58         /** Arguments string as given by user or "" for no argument. */
  59         char *args;
  60 };
  61
  62 /**
  63  * @deprecated
  64  * Parse a devargs string.
  65  *
  66  * For PCI devices, the format of arguments string is "PCI_ADDR" or
  67  * "PCI_ADDR,key=val,key2=val2,...". Examples: "08:00.1", "0000:5:00.0",
  68  * "04:00.0,arg=val".
  69  *
  70  * For virtual devices, the format of arguments string is "DRIVER_NAME*"
  71  * or "DRIVER_NAME*,key=val,key2=val2,...". Examples: "net_ring",
  72  * "net_ring0", "net_pmdAnything,arg=0:arg2=1".
  73  *
  74  * The function parses the arguments string to get driver name and driver
  75  * arguments.
  76  *
  77  * @param devargs_str
  78  *   The arguments as given by the user.
  79  * @param drvname
  80  *   The pointer to the string to store parsed driver name.
  81  * @param drvargs
  82  *   The pointer to the string to store parsed driver arguments.
  83  *
  84  * @return
  85  *   - 0 on success
  86  *   - A negative value on error
  87  */
  88 __rte_deprecated
  89 int rte_eal_parse_devargs_str(const char *devargs_str,
  90                                 char **drvname, char **drvargs);
  91
  92 /**
  93  * Parse a device string.
  94  *
  95  * Verify that a bus is capable of handling the device passed
  96  * in argument. Store which bus will handle the device, its name
  97  * and the eventual device parameters.
  98  *
  99  * The device string is built with a printf-like syntax.
 100  *
 101  * The syntax is:
 102  *
 103  *     bus:device_identifier,arg1=val1,arg2=val2
 104  *
 105  * where "bus:" is the bus name followed by any character separator.
 106  * The bus name is optional. If no bus name is specified, each bus
 107  * will attempt to recognize the device identifier. The first one
 108  * to succeed will be used.
 109  *
 110  * Examples:
 111  *
 112  *     pci:0000:05.00.0,arg=val
 113  *     05.00.0,arg=val
 114  *     vdev:net_ring0
 115  *
 116  * @param da
 117  *   The devargs structure holding the device information.
 118  * @param format
 119  *   Format string describing a device.
 120  *
 121  * @return
 122  *   - 0 on success.
 123  *   - Negative errno on error.
 124  */
 125 __rte_experimental
 126 int
 127 rte_devargs_parse(struct rte_devargs *da,
 128                   const char *format, ...)
 129 __attribute__((format(printf, 2, 0)));
 130
 131 /**
 132  * Insert an rte_devargs in the global list.
 133  *
 134  * @param da
 135  *  The devargs structure to insert.
 136  *
 137  * @return
 138  *   - 0 on success
 139  *   - Negative on error.
 140  */
 141 __rte_experimental
 142 int
 143 rte_devargs_insert(struct rte_devargs *da);
 144
 145 /**
 146  * Add a device to the user device list
 147  * See rte_devargs_parse() for details.
 148  *
 149  * @param devtype
 150  *   The type of the device.
 151  * @param devargs_str
 152  *   The arguments as given by the user.
 153  *
 154  * @return
 155  *   - 0 on success
 156  *   - A negative value on error
 157  */
 158 __rte_experimental
 159 int rte_devargs_add(enum rte_devtype devtype, const char *devargs_str);
 160
 161 /**
 162  * @deprecated
 163  * Add a device to the user device list
 164  * See rte_devargs_parse() for details.
 165  *
 166  * @param devtype
 167  *   The type of the device.
 168  * @param devargs_str
 169  *   The arguments as given by the user.
 170  *
 171  * @return
 172  *   - 0 on success
 173  *   - A negative value on error
 174  */
 175 __rte_deprecated
 176 int rte_eal_devargs_add(enum rte_devtype devtype, const char *devargs_str);
 177
 178 /**
 179  * Remove a device from the user device list.
 180  * Its resources are freed.
 181  * If the devargs cannot be found, nothing happens.
 182  *
 183  * @param busname
 184  *   bus name of the devargs to remove.
 185  *
 186  * @param devname
 187  *   device name of the devargs to remove.
 188  *
 189  * @return
 190  *   0 on success.
 191  *   <0 on error.
 192  *   >0 if the devargs was not within the user device list.
 193  */
 194 __rte_experimental
 195 int rte_devargs_remove(const char *busname,
 196                        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 __rte_experimental
 208 unsigned int
 209 rte_devargs_type_count(enum rte_devtype devtype);
 210
 211 /**
 212  * @deprecated
 213  * Count the number of user devices of a specified type
 214  *
 215  * @param devtype
 216  *   The type of the devices to counted.
 217  *
 218  * @return
 219  *   The number of devices.
 220  */
 221 __rte_deprecated
 222 unsigned int
 223 rte_eal_devargs_type_count(enum rte_devtype devtype);
 224
 225 /**
 226  * This function dumps the list of user device and their arguments.
 227  *
 228  * @param f
 229  *   A pointer to a file for output
 230  */
 231 __rte_experimental
 232 void rte_devargs_dump(FILE *f);
 233
 234 /**
 235  * @deprecated
 236  * This function dumps the list of user device and their arguments.
 237  *
 238  * @param f
 239  *   A pointer to a file for output
 240  */
 241 __rte_deprecated
 242 void rte_eal_devargs_dump(FILE *f);
 243
 244 /**
 245  * Find next rte_devargs matching the provided bus name.
 246  *
 247  * @param busname
 248  *   Limit the iteration to devargs related to buses
 249  *   matching this name.
 250  *   Will return any next rte_devargs if NULL.
 251  *
 252  * @param start
 253  *   Starting iteration point. The iteration will start at
 254  *   the first rte_devargs if NULL.
 255  *
 256  * @return
 257  *   Next rte_devargs entry matching the requested bus,
 258  *   NULL if there is none.
 259  */
 260 __rte_experimental
 261 struct rte_devargs *
 262 rte_devargs_next(const char *busname, const struct rte_devargs *start);
 263
 264 /**
 265  * Iterate over all rte_devargs for a specific bus.
 266  */
 267 #define RTE_EAL_DEVARGS_FOREACH(busname, da) \
 268         for (da = rte_devargs_next(busname, NULL); \
 269              da != NULL; \
 270              da = rte_devargs_next(busname, da)) \
 271
 272 #ifdef __cplusplus
 273 }
 274 #endif
 275
 276 #endif /* _RTE_DEVARGS_H_ */