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 <sys/queue.h>
  52 #include <rte_pci.h>
  53
  54 /**
  55  * Type of generic device
  56  */
  57 enum rte_devtype {
  58         RTE_DEVTYPE_WHITELISTED_PCI,
  59         RTE_DEVTYPE_BLACKLISTED_PCI,
  60         RTE_DEVTYPE_VIRTUAL,
  61 };
  62
  63 /**
  64  * Structure that stores a device given by the user with its arguments
  65  *
  66  * A user device is a physical or a virtual device given by the user to
  67  * the DPDK application at startup through command line arguments.
  68  *
  69  * The structure stores the configuration of the device, its PCI
  70  * identifier if it's a PCI device or the driver name if it's a virtual
  71  * device.
  72  */
  73 struct rte_devargs {
  74         /** Next in list. */
  75         TAILQ_ENTRY(rte_devargs) next;
  76         /** Type of device. */
  77         enum rte_devtype type;
  78         union {
  79                 /** Used if type is RTE_DEVTYPE_*_PCI. */
  80                 struct {
  81                         /** PCI location. */
  82                         struct rte_pci_addr addr;
  83                 } pci;
  84                 /** Used if type is RTE_DEVTYPE_VIRTUAL. */
  85                 struct {
  86                         /** Driver name. */
  87                         char drv_name[32];
  88                 } virtual;
  89         };
  90 #define RTE_DEVARGS_LEN 256
  91         char args[RTE_DEVARGS_LEN]; /**< Arguments string as given by user. */
  92 };
  93
  94 /** user device double-linked queue type definition */
  95 TAILQ_HEAD(rte_devargs_list, rte_devargs);
  96
  97 /** Global list of user devices */
  98 extern struct rte_devargs_list devargs_list;
  99
 100 /**
 101  * Add a device to the user device list
 102  *
 103  * For PCI devices, the format of arguments string is "PCI_ADDR" or
 104  * "PCI_ADDR,key=val,key2=val2,...". Examples: "08:00.1", "0000:5:00.0",
 105  * "04:00.0,arg=val".
 106  *
 107  * For virtual devices, the format of arguments string is "DRIVER_NAME*"
 108  * or "DRIVER_NAME*,key=val,key2=val2,...". Examples: "eth_ring",
 109  * "eth_ring0", "eth_pmdAnything,arg=0:arg2=1". The validity of the
 110  * driver name is not checked by this function, it is done when probing
 111  * the drivers.
 112  *
 113  * @param devtype
 114  *   The type of the device.
 115  * @param devargs_list
 116  *   The arguments as given by the user.
 117  *
 118  * @return
 119  *   - 0 on success
 120  *   - A negative value on error
 121  */
 122 int rte_eal_devargs_add(enum rte_devtype devtype, const char *devargs_str);
 123
 124 /**
 125  * Count the number of user devices of a specified type
 126  *
 127  * @param devtype
 128  *   The type of the devices to counted.
 129  *
 130  * @return
 131  *   The number of devices.
 132  */
 133 unsigned int
 134 rte_eal_devargs_type_count(enum rte_devtype devtype);
 135
 136 /**
 137  * This function dumps the list of user device and their arguments.
 138  */
 139 void rte_eal_devargs_dump(void);
 140
 141 #ifdef __cplusplus
 142 }
 143 #endif
 144
 145 #endif /* _RTE_DEVARGS_H_ */