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