lib/librte_eal/common/include/rte_dev.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2014 6WIND S.A.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of 6WIND S.A. nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _RTE_DEV_H_
  35 #define _RTE_DEV_H_
  36
  37 /**
  38  * @file
  39  *
  40  * RTE PMD Driver Registration Interface
  41  *
  42  * This file manages the list of device drivers.
  43  */
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 #include <stdio.h>
  50 #include <sys/queue.h>
  51
  52 #include <rte_config.h>
  53 #include <rte_compat.h>
  54 #include <rte_log.h>
  55
  56 __attribute__((format(printf, 2, 0)))
  57 static inline void
  58 rte_pmd_debug_trace(const char *func_name, const char *fmt, ...)
  59 {
  60         va_list ap;
  61
  62         va_start(ap, fmt);
  63
  64         char buffer[vsnprintf(NULL, 0, fmt, ap) + 1];
  65
  66         va_end(ap);
  67
  68         va_start(ap, fmt);
  69         vsnprintf(buffer, sizeof(buffer), fmt, ap);
  70         va_end(ap);
  71
  72         rte_log(RTE_LOG_ERR, RTE_LOGTYPE_PMD, "%s: %s", func_name, buffer);
  73 }
  74
  75 /*
  76  * Enable RTE_PMD_DEBUG_TRACE() when at least one component relying on the
  77  * RTE_*_RET() macros defined below is compiled in debug mode.
  78  */
  79 #if defined(RTE_LIBRTE_ETHDEV_DEBUG) || \
  80         defined(RTE_LIBRTE_CRYPTODEV_DEBUG) || \
  81         defined(RTE_LIBRTE_EVENTDEV_DEBUG)
  82 #define RTE_PMD_DEBUG_TRACE(...) \
  83         rte_pmd_debug_trace(__func__, __VA_ARGS__)
  84 #else
  85 #define RTE_PMD_DEBUG_TRACE(...) (void)0
  86 #endif
  87
  88 /* Macros for checking for restricting functions to primary instance only */
  89 #define RTE_PROC_PRIMARY_OR_ERR_RET(retval) do { \
  90         if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
  91                 RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
  92                 return retval; \
  93         } \
  94 } while (0)
  95
  96 #define RTE_PROC_PRIMARY_OR_RET() do { \
  97         if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
  98                 RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
  99                 return; \
 100         } \
 101 } while (0)
 102
 103 /* Macros to check for invalid function pointers */
 104 #define RTE_FUNC_PTR_OR_ERR_RET(func, retval) do { \
 105         if ((func) == NULL) { \
 106                 RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
 107                 return retval; \
 108         } \
 109 } while (0)
 110
 111 #define RTE_FUNC_PTR_OR_RET(func) do { \
 112         if ((func) == NULL) { \
 113                 RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
 114                 return; \
 115         } \
 116 } while (0)
 117
 118 /**
 119  * Device driver.
 120  */
 121 enum rte_kernel_driver {
 122         RTE_KDRV_UNKNOWN = 0,
 123         RTE_KDRV_IGB_UIO,
 124         RTE_KDRV_VFIO,
 125         RTE_KDRV_UIO_GENERIC,
 126         RTE_KDRV_NIC_UIO,
 127         RTE_KDRV_NONE,
 128 };
 129
 130 /**
 131  * Device policies.
 132  */
 133 enum rte_dev_policy {
 134         RTE_DEV_WHITELISTED,
 135         RTE_DEV_BLACKLISTED,
 136 };
 137
 138 /**
 139  * A generic memory resource representation.
 140  */
 141 struct rte_mem_resource {
 142         uint64_t phys_addr; /**< Physical address, 0 if not resource. */
 143         uint64_t len;       /**< Length of the resource. */
 144         void *addr;         /**< Virtual address, NULL when not mapped. */
 145 };
 146
 147 /**
 148  * A structure describing a device driver.
 149  */
 150 struct rte_driver {
 151         TAILQ_ENTRY(rte_driver) next;  /**< Next in list. */
 152         const char *name;                   /**< Driver name. */
 153         const char *alias;              /**< Driver alias. */
 154 };
 155
 156 /*
 157  * Internal identifier length
 158  * Sufficiently large to allow for UUID or PCI address
 159  */
 160 #define RTE_DEV_NAME_MAX_LEN 64
 161
 162 /**
 163  * A structure describing a generic device.
 164  */
 165 struct rte_device {
 166         TAILQ_ENTRY(rte_device) next; /**< Next device */
 167         const char *name;             /**< Device name */
 168         const struct rte_driver *driver;/**< Associated driver */
 169         int numa_node;                /**< NUMA node connection */
 170         struct rte_devargs *devargs;  /**< Device user arguments */
 171 };
 172
 173 /**
 174  * Attach a device to a registered driver.
 175  *
 176  * @param name
 177  *   The device name, that refers to a pci device (or some private
 178  *   way of designating a vdev device). Based on this device name, eal
 179  *   will identify a driver capable of handling it and pass it to the
 180  *   driver probing function.
 181  * @param devargs
 182  *   Device arguments to be passed to the driver.
 183  * @return
 184  *   0 on success, negative on error.
 185  */
 186 int rte_eal_dev_attach(const char *name, const char *devargs);
 187
 188 /**
 189  * Detach a device from its driver.
 190  *
 191  * @param dev
 192  *   A pointer to a rte_device structure.
 193  * @return
 194  *   0 on success, negative on error.
 195  */
 196 int rte_eal_dev_detach(struct rte_device *dev);
 197
 198 /**
 199  * @warning
 200  * @b EXPERIMENTAL: this API may change without prior notice
 201  *
 202  * Hotplug add a given device to a specific bus.
 203  *
 204  * @param busname
 205  *   The bus name the device is added to.
 206  * @param devname
 207  *   The device name. Based on this device name, eal will identify a driver
 208  *   capable of handling it and pass it to the driver probing function.
 209  * @param devargs
 210  *   Device arguments to be passed to the driver.
 211  * @return
 212  *   0 on success, negative on error.
 213  */
 214 int __rte_experimental rte_eal_hotplug_add(const char *busname, const char *devname,
 215                         const char *devargs);
 216
 217 /**
 218  * @warning
 219  * @b EXPERIMENTAL: this API may change without prior notice
 220  *
 221  * Hotplug remove a given device from a specific bus.
 222  *
 223  * @param busname
 224  *   The bus name the device is removed from.
 225  * @param devname
 226  *   The device name being removed.
 227  * @return
 228  *   0 on success, negative on error.
 229  */
 230 int __rte_experimental rte_eal_hotplug_remove(const char *busname,
 231                                           const char *devname);
 232
 233 /**
 234  * Device comparison function.
 235  *
 236  * This type of function is used to compare an rte_device with arbitrary
 237  * data.
 238  *
 239  * @param dev
 240  *   Device handle.
 241  *
 242  * @param data
 243  *   Data to compare against. The type of this parameter is determined by
 244  *   the kind of comparison performed by the function.
 245  *
 246  * @return
 247  *   0 if the device matches the data.
 248  *   !0 if the device does not match.
 249  *   <0 if ordering is possible and the device is lower than the data.
 250  *   >0 if ordering is possible and the device is greater than the data.
 251  */
 252 typedef int (*rte_dev_cmp_t)(const struct rte_device *dev, const void *data);
 253
 254 #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]
 255
 256 #define RTE_PMD_EXPORT_NAME(name, idx) \
 257 static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
 258 __attribute__((used)) = RTE_STR(name)
 259
 260 #define DRV_EXP_TAG(name, tag) __##name##_##tag
 261
 262 #define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
 263 static const char DRV_EXP_TAG(name, pci_tbl_export)[] __attribute__((used)) = \
 264 RTE_STR(table)
 265
 266 #define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
 267 static const char DRV_EXP_TAG(name, param_string_export)[] \
 268 __attribute__((used)) = str
 269
 270 /**
 271  * Advertise the list of kernel modules required to run this driver
 272  *
 273  * This string lists the kernel modules required for the devices
 274  * associated to a PMD. The format of each line of the string is:
 275  * "<device-pattern> <kmod-expression>".
 276  *
 277  * The possible formats for the device pattern are:
 278  *   "*"                     all devices supported by this driver
 279  *   "pci:*"                 all PCI devices supported by this driver
 280  *   "pci:v8086:d*:sv*:sd*"  all PCI devices supported by this driver
 281  *                           whose vendor id is 0x8086.
 282  *
 283  * The format of the kernel modules list is a parenthesed expression
 284  * containing logical-and (&) and logical-or (|).
 285  *
 286  * The device pattern and the kmod expression are separated by a space.
 287  *
 288  * Example:
 289  * - "* igb_uio | uio_pci_generic | vfio"
 290  */
 291 #define RTE_PMD_REGISTER_KMOD_DEP(name, str) \
 292 static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
 293 __attribute__((used)) = str
 294
 295 #ifdef __cplusplus
 296 }
 297 #endif
 298
 299 #endif /* _RTE_DEV_H_ */