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_pci.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         RTE_STD_C11
  81         union {
  82                 /** Used if type is RTE_DEVTYPE_*_PCI. */
  83                 struct {
  84                         /** PCI location. */
  85                         struct rte_pci_addr addr;
  86                 } pci;
  87                 /** Used if type is RTE_DEVTYPE_VIRTUAL. */
  88                 struct {
  89                         /** Driver name. */
  90                         char drv_name[RTE_DEV_NAME_MAX_LEN];
  91                 } virt;
  92         };
  93         /** Bus handle for the device. */
  94         struct rte_bus *bus;
  95         /** Arguments string as given by user or "" for no argument. */
  96         char *args;
  97 };
  98
  99 /** user device double-linked queue type definition */
 100 TAILQ_HEAD(rte_devargs_list, rte_devargs);
 101
 102 /** Global list of user devices */
 103 extern struct rte_devargs_list devargs_list;
 104
 105 /**
 106  * Parse a devargs string.
 107  *
 108  * For PCI devices, the format of arguments string is "PCI_ADDR" or
 109  * "PCI_ADDR,key=val,key2=val2,...". Examples: "08:00.1", "0000:5:00.0",
 110  * "04:00.0,arg=val".
 111  *
 112  * For virtual devices, the format of arguments string is "DRIVER_NAME*"
 113  * or "DRIVER_NAME*,key=val,key2=val2,...". Examples: "net_ring",
 114  * "net_ring0", "net_pmdAnything,arg=0:arg2=1".
 115  *
 116  * The function parses the arguments string to get driver name and driver
 117  * arguments.
 118  *
 119  * @param devargs_str
 120  *   The arguments as given by the user.
 121  * @param drvname
 122  *   The pointer to the string to store parsed driver name.
 123  * @param drvargs
 124  *   The pointer to the string to store parsed driver arguments.
 125  *
 126  * @return
 127  *   - 0 on success
 128  *   - A negative value on error
 129  */
 130 int rte_eal_parse_devargs_str(const char *devargs_str,
 131                                 char **drvname, char **drvargs);
 132
 133 /**
 134  * Add a device to the user device list
 135  *
 136  * For PCI devices, the format of arguments string is "PCI_ADDR" or
 137  * "PCI_ADDR,key=val,key2=val2,...". Examples: "08:00.1", "0000:5:00.0",
 138  * "04:00.0,arg=val".
 139  *
 140  * For virtual devices, the format of arguments string is "DRIVER_NAME*"
 141  * or "DRIVER_NAME*,key=val,key2=val2,...". Examples: "net_ring",
 142  * "net_ring0", "net_pmdAnything,arg=0:arg2=1". The validity of the
 143  * driver name is not checked by this function, it is done when probing
 144  * the drivers.
 145  *
 146  * @param devtype
 147  *   The type of the device.
 148  * @param devargs_str
 149  *   The arguments as given by the user.
 150  *
 151  * @return
 152  *   - 0 on success
 153  *   - A negative value on error
 154  */
 155 int rte_eal_devargs_add(enum rte_devtype devtype, const char *devargs_str);
 156
 157 /**
 158  * Count the number of user devices of a specified type
 159  *
 160  * @param devtype
 161  *   The type of the devices to counted.
 162  *
 163  * @return
 164  *   The number of devices.
 165  */
 166 unsigned int
 167 rte_eal_devargs_type_count(enum rte_devtype devtype);
 168
 169 /**
 170  * This function dumps the list of user device and their arguments.
 171  *
 172  * @param f
 173  *   A pointer to a file for output
 174  */
 175 void rte_eal_devargs_dump(FILE *f);
 176
 177 #ifdef __cplusplus
 178 }
 179 #endif
 180
 181 #endif /* _RTE_DEVARGS_H_ */