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
  55 /**
  56  * Type of generic device
  57  */
  58 enum rte_devtype {
  59         RTE_DEVTYPE_WHITELISTED_PCI,
  60         RTE_DEVTYPE_BLACKLISTED_PCI,
  61         RTE_DEVTYPE_VIRTUAL,
  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         union {
  80                 /** Used if type is RTE_DEVTYPE_*_PCI. */
  81                 struct {
  82                         /** PCI location. */
  83                         struct rte_pci_addr addr;
  84                 } pci;
  85                 /** Used if type is RTE_DEVTYPE_VIRTUAL. */
  86                 struct {
  87                         /** Driver name. */
  88                         char drv_name[32];
  89                 } virtual;
  90         };
  91 #define RTE_DEVARGS_LEN 256
  92         char args[RTE_DEVARGS_LEN]; /**< Arguments string as given by user. */
  93 };
  94
  95 /** user device double-linked queue type definition */
  96 TAILQ_HEAD(rte_devargs_list, rte_devargs);
  97
  98 /** Global list of user devices */
  99 extern struct rte_devargs_list devargs_list;
 100
 101 /**
 102  * Add a device to the user device list
 103  *
 104  * For PCI devices, the format of arguments string is "PCI_ADDR" or
 105  * "PCI_ADDR,key=val,key2=val2,...". Examples: "08:00.1", "0000:5:00.0",
 106  * "04:00.0,arg=val".
 107  *
 108  * For virtual devices, the format of arguments string is "DRIVER_NAME*"
 109  * or "DRIVER_NAME*,key=val,key2=val2,...". Examples: "eth_ring",
 110  * "eth_ring0", "eth_pmdAnything,arg=0:arg2=1". The validity of the
 111  * driver name is not checked by this function, it is done when probing
 112  * the drivers.
 113  *
 114  * @param devtype
 115  *   The type of the device.
 116  * @param devargs_list
 117  *   The arguments as given by the user.
 118  *
 119  * @return
 120  *   - 0 on success
 121  *   - A negative value on error
 122  */
 123 int rte_eal_devargs_add(enum rte_devtype devtype, const char *devargs_str);
 124
 125 /**
 126  * Count the number of user devices of a specified type
 127  *
 128  * @param devtype
 129  *   The type of the devices to counted.
 130  *
 131  * @return
 132  *   The number of devices.
 133  */
 134 unsigned int
 135 rte_eal_devargs_type_count(enum rte_devtype devtype);
 136
 137 /**
 138  * This function dumps the list of user device and their arguments.
 139  *
 140  * @param f
 141  *   A pointer to a file for output
 142  */
 143 void rte_eal_devargs_dump(FILE *f);
 144
 145 #ifdef __cplusplus
 146 }
 147 #endif
 148
 149 #endif /* _RTE_DEVARGS_H_ */