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