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  * A virtual device driver abstraction.
  48  */
  49 struct rte_vdev_driver {
  50         TAILQ_ENTRY(rte_vdev_driver) next; /**< Next in list. */
  51         struct rte_driver driver;          /**< Inherited general driver. */
  52 };
  53
  54 /**
  55  * Register a virtual device driver.
  56  *
  57  * @param driver
  58  *   A pointer to a rte_vdev_driver structure describing the driver
  59  *   to be registered.
  60  */
  61 void rte_eal_vdrv_register(struct rte_vdev_driver *driver);
  62
  63 /**
  64  * Unregister a virtual device driver.
  65  *
  66  * @param driver
  67  *   A pointer to a rte_vdev_driver structure describing the driver
  68  *   to be unregistered.
  69  */
  70 void rte_eal_vdrv_unregister(struct rte_vdev_driver *driver);
  71
  72 #define DRIVER_REGISTER_VDEV(nm, vdrv)\
  73 RTE_INIT(vdrvinitfn_ ##vdrv);\
  74 static void vdrvinitfn_ ##vdrv(void)\
  75 {\
  76         (vdrv).driver.name = RTE_STR(nm);\
  77         rte_eal_vdrv_register(&vdrv);\
  78 } \
  79 DRIVER_EXPORT_NAME(nm, __COUNTER__)
  80
  81 #ifdef __cplusplus
  82 }
  83 #endif
  84
  85 #endif