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_UNDEFINED,
  60         RTE_DEVTYPE_WHITELISTED,
  61         RTE_DEVTYPE_BLACKLISTED,
  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         /** Bus handle for the device. */
  80         struct rte_bus *bus;
  81         /** Name of the device. */
  82         char name[RTE_DEV_NAME_MAX_LEN];
  83         /** Arguments string as given by user or "" for no argument. */
  84         char *args;
  85 };
  86
  87 /** user device double-linked queue type definition */
  88 TAILQ_HEAD(rte_devargs_list, rte_devargs);
  89
  90 /** Global list of user devices */
  91 extern struct rte_devargs_list devargs_list;
  92
  93 /**
  94  * Parse a devargs string.
  95  *
  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",
  98  * "04:00.0,arg=val".
  99  *
 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".
 103  *
 104  * The function parses the arguments string to get driver name and driver
 105  * arguments.
 106  *
 107  * @param devargs_str
 108  *   The arguments as given by the user.
 109  * @param drvname
 110  *   The pointer to the string to store parsed driver name.
 111  * @param drvargs
 112  *   The pointer to the string to store parsed driver arguments.
 113  *
 114  * @return
 115  *   - 0 on success
 116  *   - A negative value on error
 117  */
 118 int rte_eal_parse_devargs_str(const char *devargs_str,
 119                                 char **drvname, char **drvargs);
 120
 121 /**
 122  * Parse a device string.
 123  *
 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.
 127  *
 128  * @param dev
 129  *   The device declaration string.
 130  * @param da
 131  *   The devargs structure holding the device information.
 132  *
 133  * @return
 134  *   - 0 on success.
 135  *   - Negative errno on error.
 136  */
 137 int
 138 rte_eal_devargs_parse(const char *dev,
 139                       struct rte_devargs *da);
 140
 141 /**
 142  * Insert an rte_devargs in the global list.
 143  *
 144  * @param da
 145  *  The devargs structure to insert.
 146  *
 147  * @return
 148  *   - 0 on success
 149  *   - Negative on error.
 150  */
 151 int
 152 rte_eal_devargs_insert(struct rte_devargs *da);
 153
 154 /**
 155  * Add a device to the user device list
 156  *
 157  * For PCI devices, the format of arguments string is "PCI_ADDR" or
 158  * "PCI_ADDR,key=val,key2=val2,...". Examples: "08:00.1", "0000:5:00.0",
 159  * "04:00.0,arg=val".
 160  *
 161  * For virtual devices, the format of arguments string is "DRIVER_NAME*"
 162  * or "DRIVER_NAME*,key=val,key2=val2,...". Examples: "net_ring",
 163  * "net_ring0", "net_pmdAnything,arg=0:arg2=1". The validity of the
 164  * driver name is not checked by this function, it is done when probing
 165  * the drivers.
 166  *
 167  * @param devtype
 168  *   The type of the device.
 169  * @param devargs_str
 170  *   The arguments as given by the user.
 171  *
 172  * @return
 173  *   - 0 on success
 174  *   - A negative value on error
 175  */
 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 int rte_eal_devargs_remove(const char *busname, const char *devname);
 195
 196 /**
 197  * Count the number of user devices of a specified type
 198  *
 199  * @param devtype
 200  *   The type of the devices to counted.
 201  *
 202  * @return
 203  *   The number of devices.
 204  */
 205 unsigned int
 206 rte_eal_devargs_type_count(enum rte_devtype devtype);
 207
 208 /**
 209  * This function dumps the list of user device and their arguments.
 210  *
 211  * @param f
 212  *   A pointer to a file for output
 213  */
 214 void rte_eal_devargs_dump(FILE *f);
 215
 216 #ifdef __cplusplus
 217 }
 218 #endif
 219
 220 #endif /* _RTE_DEVARGS_H_ */