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