lib/librte_eal/common/include/rte_vdev.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2016 RehiveTech. All rights reserved.
   5  *
   6  *   Redistribution and use in source and binary forms, with or without
   7  *   modification, are permitted provided that the following conditions
   8  *   are met:
   9  *
  10  *     * Redistributions of source code must retain the above copyright
  11  *       notice, this list of conditions and the following disclaimer.
  12  *     * Redistributions in binary form must reproduce the above copyright
  13  *       notice, this list of conditions and the following disclaimer in
  14  *       the documentation and/or other materials provided with the
  15  *       distribution.
  16  *     * Neither the name of RehiveTech nor the names of its
  17  *       contributors may be used to endorse or promote products derived
  18  *       from this software without specific prior written permission.
  19  *
  20  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 #ifndef RTE_VDEV_H
  34 #define RTE_VDEV_H
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 #include <sys/queue.h>
  41 #include <rte_dev.h>
  42
  43 /** Double linked list of virtual device drivers. */
  44 TAILQ_HEAD(vdev_driver_list, rte_vdev_driver);
  45
  46 /**
  47  * Probe function called for each virtual device driver once.
  48  */
  49 typedef int (rte_vdev_probe_t)(const char *name, const char *args);
  50
  51 /**
  52  * Remove function called for each virtual device driver once.
  53  */
  54 typedef int (rte_vdev_remove_t)(const char *name);
  55
  56 /**
  57  * A virtual device driver abstraction.
  58  */
  59 struct rte_vdev_driver {
  60         TAILQ_ENTRY(rte_vdev_driver) next; /**< Next in list. */
  61         struct rte_driver driver;      /**< Inherited general driver. */
  62         rte_vdev_probe_t *probe;       /**< Virtual device probe function. */
  63         rte_vdev_remove_t *remove;     /**< Virtual device remove function. */
  64 };
  65
  66 /**
  67  * Register a virtual device driver.
  68  *
  69  * @param driver
  70  *   A pointer to a rte_vdev_driver structure describing the driver
  71  *   to be registered.
  72  */
  73 void rte_eal_vdrv_register(struct rte_vdev_driver *driver);
  74
  75 /**
  76  * Unregister a virtual device driver.
  77  *
  78  * @param driver
  79  *   A pointer to a rte_vdev_driver structure describing the driver
  80  *   to be unregistered.
  81  */
  82 void rte_eal_vdrv_unregister(struct rte_vdev_driver *driver);
  83
  84 #define DRIVER_REGISTER_VDEV(nm, vdrv)\
  85 RTE_INIT(vdrvinitfn_ ##vdrv);\
  86 static void vdrvinitfn_ ##vdrv(void)\
  87 {\
  88         (vdrv).driver.name = RTE_STR(nm);\
  89         rte_eal_vdrv_register(&vdrv);\
  90 } \
  91 DRIVER_EXPORT_NAME(nm, __COUNTER__)
  92
  93 #ifdef __cplusplus
  94 }
  95 #endif
  96
  97 #endif