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 /** Double linked list of device drivers. */
 127 TAILQ_HEAD(rte_driver_list, rte_driver);
 128 /** Double linked list of devices. */
 129 TAILQ_HEAD(rte_device_list, rte_device);
 130
 131 /* Forward declaration */
 132 struct rte_driver;
 133
 134 /**
 135  * A structure describing a generic device.
 136  */
 137 struct rte_device {
 138         TAILQ_ENTRY(rte_device) next; /**< Next device */
 139         const char *name;             /**< Device name */
 140         const struct rte_driver *driver;/**< Associated driver */
 141         int numa_node;                /**< NUMA node connection */
 142         struct rte_devargs *devargs;  /**< Device user arguments */
 143 };
 144
 145 /**
 146  * Insert a device detected by a bus scanning.
 147  *
 148  * @param dev
 149  *   A pointer to a rte_device structure describing the detected device.
 150  */
 151 void rte_eal_device_insert(struct rte_device *dev);
 152
 153 /**
 154  * Remove a device (e.g. when being unplugged).
 155  *
 156  * @param dev
 157  *   A pointer to a rte_device structure describing the device to be removed.
 158  */
 159 void rte_eal_device_remove(struct rte_device *dev);
 160
 161 /**
 162  * A structure describing a device driver.
 163  */
 164 struct rte_driver {
 165         TAILQ_ENTRY(rte_driver) next;  /**< Next in list. */
 166         const char *name;                   /**< Driver name. */
 167         const char *alias;              /**< Driver alias. */
 168 };
 169
 170 /**
 171  * Register a device driver.
 172  *
 173  * @param driver
 174  *   A pointer to a rte_dev structure describing the driver
 175  *   to be registered.
 176  */
 177 void rte_eal_driver_register(struct rte_driver *driver);
 178
 179 /**
 180  * Unregister a device driver.
 181  *
 182  * @param driver
 183  *   A pointer to a rte_dev structure describing the driver
 184  *   to be unregistered.
 185  */
 186 void rte_eal_driver_unregister(struct rte_driver *driver);
 187
 188 /**
 189  * Initialize a driver specified by name.
 190  *
 191  * @param name
 192  *   The pointer to a driver name to be initialized.
 193  * @param args
 194  *   The pointer to arguments used by driver initialization.
 195  * @return
 196  *  0 on success, negative on error
 197  */
 198 int rte_eal_vdev_init(const char *name, const char *args);
 199
 200 /**
 201  * Uninitalize a driver specified by name.
 202  *
 203  * @param name
 204  *   The pointer to a driver name to be initialized.
 205  * @return
 206  *  0 on success, negative on error
 207  */
 208 int rte_eal_vdev_uninit(const char *name);
 209
 210 /**
 211  * Attach a device to a registered driver.
 212  *
 213  * @param name
 214  *   The device name, that refers to a pci device (or some private
 215  *   way of designating a vdev device). Based on this device name, eal
 216  *   will identify a driver capable of handling it and pass it to the
 217  *   driver probing function.
 218  * @param devargs
 219  *   Device arguments to be passed to the driver.
 220  * @return
 221  *   0 on success, negative on error.
 222  */
 223 int rte_eal_dev_attach(const char *name, const char *devargs);
 224
 225 /**
 226  * Detach a device from its driver.
 227  *
 228  * @param name
 229  *   Same description as for rte_eal_dev_attach().
 230  *   Here, eal will call the driver detaching function.
 231  * @return
 232  *   0 on success, negative on error.
 233  */
 234 int rte_eal_dev_detach(const char *name);
 235
 236 #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]
 237
 238 #define RTE_PMD_EXPORT_NAME(name, idx) \
 239 static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
 240 __attribute__((used)) = RTE_STR(name)
 241
 242 #define DRV_EXP_TAG(name, tag) __##name##_##tag
 243
 244 #define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
 245 static const char DRV_EXP_TAG(name, pci_tbl_export)[] __attribute__((used)) = \
 246 RTE_STR(table)
 247
 248 #define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
 249 static const char DRV_EXP_TAG(name, param_string_export)[] \
 250 __attribute__((used)) = str
 251
 252 /**
 253  * Advertise the list of kernel modules required to run this driver
 254  *
 255  * This string lists the kernel modules required for the devices
 256  * associated to a PMD. The format of each line of the string is:
 257  * "<device-pattern> <kmod-expression>".
 258  *
 259  * The possible formats for the device pattern are:
 260  *   "*"                     all devices supported by this driver
 261  *   "pci:*"                 all PCI devices supported by this driver
 262  *   "pci:v8086:d*:sv*:sd*"  all PCI devices supported by this driver
 263  *                           whose vendor id is 0x8086.
 264  *
 265  * The format of the kernel modules list is a parenthesed expression
 266  * containing logical-and (&) and logical-or (|).
 267  *
 268  * The device pattern and the kmod expression are separated by a space.
 269  *
 270  * Example:
 271  * - "* igb_uio | uio_pci_generic | vfio"
 272  */
 273 #define RTE_PMD_REGISTER_KMOD_DEP(name, str) \
 274 static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
 275 __attribute__((used)) = str
 276
 277 #ifdef __cplusplus
 278 }
 279 #endif
 280
 281 #endif /* _RTE_VDEV_H_ */