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_log.h>
  53
  54 __attribute__((format(printf, 2, 0)))
  55 static inline void
  56 rte_pmd_debug_trace(const char *func_name, const char *fmt, ...)
  57 {
  58         va_list ap;
  59
  60         va_start(ap, fmt);
  61
  62         char buffer[vsnprintf(NULL, 0, fmt, ap) + 1];
  63
  64         va_end(ap);
  65
  66         va_start(ap, fmt);
  67         vsnprintf(buffer, sizeof(buffer), fmt, ap);
  68         va_end(ap);
  69
  70         rte_log(RTE_LOG_ERR, RTE_LOGTYPE_PMD, "%s: %s", func_name, buffer);
  71 }
  72
  73 /*
  74  * Enable RTE_PMD_DEBUG_TRACE() when at least one component relying on the
  75  * RTE_*_RET() macros defined below is compiled in debug mode.
  76  */
  77 #if defined(RTE_LIBRTE_ETHDEV_DEBUG) || \
  78         defined(RTE_LIBRTE_CRYPTODEV_DEBUG) || \
  79         defined(RTE_LIBRTE_EVENTDEV_DEBUG)
  80 #define RTE_PMD_DEBUG_TRACE(...) \
  81         rte_pmd_debug_trace(__func__, __VA_ARGS__)
  82 #else
  83 #define RTE_PMD_DEBUG_TRACE(...) (void)0
  84 #endif
  85
  86 /* Macros for checking for restricting functions to primary instance only */
  87 #define RTE_PROC_PRIMARY_OR_ERR_RET(retval) do { \
  88         if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
  89                 RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
  90                 return retval; \
  91         } \
  92 } while (0)
  93
  94 #define RTE_PROC_PRIMARY_OR_RET() do { \
  95         if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
  96                 RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
  97                 return; \
  98         } \
  99 } while (0)
 100
 101 /* Macros to check for invalid function pointers */
 102 #define RTE_FUNC_PTR_OR_ERR_RET(func, retval) do { \
 103         if ((func) == NULL) { \
 104                 RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
 105                 return retval; \
 106         } \
 107 } while (0)
 108
 109 #define RTE_FUNC_PTR_OR_RET(func) do { \
 110         if ((func) == NULL) { \
 111                 RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
 112                 return; \
 113         } \
 114 } while (0)
 115
 116 /**
 117  * Device driver.
 118  */
 119 enum rte_kernel_driver {
 120         RTE_KDRV_UNKNOWN = 0,
 121         RTE_KDRV_IGB_UIO,
 122         RTE_KDRV_VFIO,
 123         RTE_KDRV_UIO_GENERIC,
 124         RTE_KDRV_NIC_UIO,
 125         RTE_KDRV_NONE,
 126 };
 127
 128 /**
 129  * Device policies.
 130  */
 131 enum rte_dev_policy {
 132         RTE_DEV_WHITELISTED,
 133         RTE_DEV_BLACKLISTED,
 134 };
 135
 136 /**
 137  * A generic memory resource representation.
 138  */
 139 struct rte_mem_resource {
 140         uint64_t phys_addr; /**< Physical address, 0 if not resource. */
 141         uint64_t len;       /**< Length of the resource. */
 142         void *addr;         /**< Virtual address, NULL when not mapped. */
 143 };
 144
 145 /**
 146  * A structure describing a device driver.
 147  */
 148 struct rte_driver {
 149         TAILQ_ENTRY(rte_driver) next;  /**< Next in list. */
 150         const char *name;                   /**< Driver name. */
 151         const char *alias;              /**< Driver alias. */
 152 };
 153
 154 /*
 155  * Internal identifier length
 156  * Sufficiently large to allow for UUID or PCI address
 157  */
 158 #define RTE_DEV_NAME_MAX_LEN 64
 159
 160 /**
 161  * A structure describing a generic device.
 162  */
 163 struct rte_device {
 164         TAILQ_ENTRY(rte_device) next; /**< Next device */
 165         const char *name;             /**< Device name */
 166         const struct rte_driver *driver;/**< Associated driver */
 167         int numa_node;                /**< NUMA node connection */
 168         struct rte_devargs *devargs;  /**< Device user arguments */
 169 };
 170
 171 /**
 172  * Initialize a driver specified by name.
 173  *
 174  * @param name
 175  *   The pointer to a driver name to be initialized.
 176  * @param args
 177  *   The pointer to arguments used by driver initialization.
 178  * @return
 179  *  0 on success, negative on error
 180  */
 181 int rte_vdev_init(const char *name, const char *args);
 182
 183 /**
 184  * Uninitalize a driver specified by name.
 185  *
 186  * @param name
 187  *   The pointer to a driver name to be initialized.
 188  * @return
 189  *  0 on success, negative on error
 190  */
 191 int rte_vdev_uninit(const char *name);
 192
 193 /**
 194  * Attach a device to a registered driver.
 195  *
 196  * @param name
 197  *   The device name, that refers to a pci device (or some private
 198  *   way of designating a vdev device). Based on this device name, eal
 199  *   will identify a driver capable of handling it and pass it to the
 200  *   driver probing function.
 201  * @param devargs
 202  *   Device arguments to be passed to the driver.
 203  * @return
 204  *   0 on success, negative on error.
 205  */
 206 int rte_eal_dev_attach(const char *name, const char *devargs);
 207
 208 /**
 209  * Detach a device from its driver.
 210  *
 211  * @param dev
 212  *   A pointer to a rte_device structure.
 213  * @return
 214  *   0 on success, negative on error.
 215  */
 216 int rte_eal_dev_detach(struct rte_device *dev);
 217
 218 /**
 219  * @warning
 220  * @b EXPERIMENTAL: this API may change without prior notice
 221  *
 222  * Hotplug add a given device to a specific bus.
 223  *
 224  * @param busname
 225  *   The bus name the device is added to.
 226  * @param devname
 227  *   The device name. Based on this device name, eal will identify a driver
 228  *   capable of handling it and pass it to the driver probing function.
 229  * @param devargs
 230  *   Device arguments to be passed to the driver.
 231  * @return
 232  *   0 on success, negative on error.
 233  */
 234 int rte_eal_hotplug_add(const char *busname, const char *devname,
 235                         const char *devargs);
 236
 237 /**
 238  * @warning
 239  * @b EXPERIMENTAL: this API may change without prior notice
 240  *
 241  * Hotplug remove a given device from a specific bus.
 242  *
 243  * @param busname
 244  *   The bus name the device is removed from.
 245  * @param devname
 246  *   The device name being removed.
 247  * @return
 248  *   0 on success, negative on error.
 249  */
 250 int rte_eal_hotplug_remove(const char *busname, const char *devname);
 251
 252 /**
 253  * Device comparison function.
 254  *
 255  * This type of function is used to compare an rte_device with arbitrary
 256  * data.
 257  *
 258  * @param dev
 259  *   Device handle.
 260  *
 261  * @param data
 262  *   Data to compare against. The type of this parameter is determined by
 263  *   the kind of comparison performed by the function.
 264  *
 265  * @return
 266  *   0 if the device matches the data.
 267  *   !0 if the device does not match.
 268  *   <0 if ordering is possible and the device is lower than the data.
 269  *   >0 if ordering is possible and the device is greater than the data.
 270  */
 271 typedef int (*rte_dev_cmp_t)(const struct rte_device *dev, const void *data);
 272
 273 #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]
 274
 275 #define RTE_PMD_EXPORT_NAME(name, idx) \
 276 static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
 277 __attribute__((used)) = RTE_STR(name)
 278
 279 #define DRV_EXP_TAG(name, tag) __##name##_##tag
 280
 281 #define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
 282 static const char DRV_EXP_TAG(name, pci_tbl_export)[] __attribute__((used)) = \
 283 RTE_STR(table)
 284
 285 #define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
 286 static const char DRV_EXP_TAG(name, param_string_export)[] \
 287 __attribute__((used)) = str
 288
 289 /**
 290  * Advertise the list of kernel modules required to run this driver
 291  *
 292  * This string lists the kernel modules required for the devices
 293  * associated to a PMD. The format of each line of the string is:
 294  * "<device-pattern> <kmod-expression>".
 295  *
 296  * The possible formats for the device pattern are:
 297  *   "*"                     all devices supported by this driver
 298  *   "pci:*"                 all PCI devices supported by this driver
 299  *   "pci:v8086:d*:sv*:sd*"  all PCI devices supported by this driver
 300  *                           whose vendor id is 0x8086.
 301  *
 302  * The format of the kernel modules list is a parenthesed expression
 303  * containing logical-and (&) and logical-or (|).
 304  *
 305  * The device pattern and the kmod expression are separated by a space.
 306  *
 307  * Example:
 308  * - "* igb_uio | uio_pci_generic | vfio"
 309  */
 310 #define RTE_PMD_REGISTER_KMOD_DEP(name, str) \
 311 static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
 312 __attribute__((used)) = str
 313
 314 #ifdef __cplusplus
 315 }
 316 #endif
 317
 318 #endif /* _RTE_VDEV_H_ */