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 <sys/queue.h>
  50
  51 /** Double linked list of device drivers. */
  52 TAILQ_HEAD(rte_driver_list, rte_driver);
  53
  54 /**
  55  * Initialization function called for each device driver once.
  56  */
  57 typedef int (rte_dev_init_t)(const char *name, const char *args);
  58
  59 /**
  60  * Uninitilization function called for each device driver once.
  61  */
  62 typedef int (rte_dev_uninit_t)(const char *name);
  63
  64 /**
  65  * Driver type enumeration
  66  */
  67 enum pmd_type {
  68         PMD_VDEV = 0,
  69         PMD_PDEV = 1,
  70 };
  71
  72 /**
  73  * A structure describing a device driver.
  74  */
  75 struct rte_driver {
  76         TAILQ_ENTRY(rte_driver) next;  /**< Next in list. */
  77         enum pmd_type type;                /**< PMD Driver type */
  78         const char *name;                   /**< Driver name. */
  79         rte_dev_init_t *init;              /**< Device init. function. */
  80         rte_dev_uninit_t *uninit;          /**< Device uninit. function. */
  81 };
  82
  83 /**
  84  * Register a device driver.
  85  *
  86  * @param driver
  87  *   A pointer to a rte_dev structure describing the driver
  88  *   to be registered.
  89  */
  90 void rte_eal_driver_register(struct rte_driver *driver);
  91
  92 /**
  93  * Unregister a device driver.
  94  *
  95  * @param driver
  96  *   A pointer to a rte_dev structure describing the driver
  97  *   to be unregistered.
  98  */
  99 void rte_eal_driver_unregister(struct rte_driver *driver);
 100
 101 /**
 102  * Initalize all the registered drivers in this process
 103  */
 104 int rte_eal_dev_init(void);
 105
 106 /**
 107  * Initialize a driver specified by name.
 108  *
 109  * @param name
 110  *   The pointer to a driver name to be initialized.
 111  * @param args
 112  *   The pointer to arguments used by driver initialization.
 113  * @return
 114  *  0 on success, negative on error
 115  */
 116 int rte_eal_vdev_init(const char *name, const char *args);
 117
 118 /**
 119  * Uninitalize a driver specified by name.
 120  *
 121  * @param name
 122  *   The pointer to a driver name to be initialized.
 123  * @return
 124  *  0 on success, negative on error
 125  */
 126 int rte_eal_vdev_uninit(const char *name);
 127
 128 #define PMD_REGISTER_DRIVER(d)\
 129 void devinitfn_ ##d(void);\
 130 void __attribute__((constructor, used)) devinitfn_ ##d(void)\
 131 {\
 132         rte_eal_driver_register(&d);\
 133 }
 134
 135 #ifdef __cplusplus
 136 }
 137 #endif
 138
 139 #endif /* _RTE_VDEV_H_ */