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  * Driver type enumeration
  61  */
  62 enum pmd_type {
  63         PMD_VDEV = 0,
  64         PMD_PDEV = 1,
  65 };
  66
  67 /**
  68  * A structure describing a device driver.
  69  */
  70 struct rte_driver {
  71         TAILQ_ENTRY(rte_driver) next;  /**< Next in list. */
  72         enum pmd_type type;                /**< PMD Driver type */
  73         const char *name;                   /**< Driver name. */
  74         rte_dev_init_t *init;              /**< Device init. function. */
  75 };
  76
  77 /**
  78  * Register a device driver.
  79  *
  80  * @param driver
  81  *   A pointer to a rte_dev structure describing the driver
  82  *   to be registered.
  83  */
  84 void rte_eal_driver_register(struct rte_driver *driver);
  85
  86 /**
  87  * Unregister a device driver.
  88  *
  89  * @param driver
  90  *   A pointer to a rte_dev structure describing the driver
  91  *   to be unregistered.
  92  */
  93 void rte_eal_driver_unregister(struct rte_driver *driver);
  94
  95 /**
  96  * Initalize all the registered drivers in this process
  97  */
  98 int rte_eal_dev_init(void);
  99
 100 #define PMD_REGISTER_DRIVER(d)\
 101 void devinitfn_ ##d(void);\
 102 void __attribute__((constructor, used)) devinitfn_ ##d(void)\
 103 {\
 104         rte_eal_driver_register(&d);\
 105 }
 106
 107 #ifdef __cplusplus
 108 }
 109 #endif
 110
 111 #endif /* _RTE_VDEV_H_ */