lib/librte_eal/common/include/rte_bus.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2016 NXP
   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 NXP 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_BUS_H_
  35 #define _RTE_BUS_H_
  36
  37 /**
  38  * @file
  39  *
  40  * DPDK device bus interface
  41  *
  42  * This file exposes API and interfaces for bus abstraction
  43  * over the devices and drivers in EAL.
  44  */
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 #include <stdio.h>
  51 #include <sys/queue.h>
  52
  53 #include <rte_log.h>
  54 #include <rte_dev.h>
  55
  56 /** Double linked list of buses */
  57 TAILQ_HEAD(rte_bus_list, rte_bus);
  58
  59 /**
  60  * Bus specific scan for devices attached on the bus.
  61  * For each bus object, the scan would be reponsible for finding devices and
  62  * adding them to its private device list.
  63  *
  64  * A bus should mandatorily implement this method.
  65  *
  66  * @return
  67  *      0 for successful scan
  68  *      <0 for unsuccessful scan with error value
  69  */
  70 typedef int (*rte_bus_scan_t)(void);
  71
  72 /**
  73  * A structure describing a generic bus.
  74  */
  75 struct rte_bus {
  76         TAILQ_ENTRY(rte_bus) next;   /**< Next bus object in linked list */
  77         const char *name;            /**< Name of the bus */
  78         rte_bus_scan_t scan;         /**< Scan for devices attached to bus */
  79 };
  80
  81 /**
  82  * Register a Bus handler.
  83  *
  84  * @param bus
  85  *   A pointer to a rte_bus structure describing the bus
  86  *   to be registered.
  87  */
  88 void rte_bus_register(struct rte_bus *bus);
  89
  90 /**
  91  * Unregister a Bus handler.
  92  *
  93  * @param bus
  94  *   A pointer to a rte_bus structure describing the bus
  95  *   to be unregistered.
  96  */
  97 void rte_bus_unregister(struct rte_bus *bus);
  98
  99 /**
 100  * Scan all the buses.
 101  *
 102  * @return
 103  *   0 in case of success in scanning all buses
 104  *  !0 in case of failure to scan
 105  */
 106 int rte_bus_scan(void);
 107
 108 /**
 109  * Dump information of all the buses registered with EAL.
 110  *
 111  * @param f
 112  *       A valid and open output stream handle
 113  *
 114  * @return
 115  *       0 in case of success
 116  *      !0 in case there is error in opening the output stream
 117  */
 118 void rte_bus_dump(FILE *f);
 119
 120 /**
 121  * Helper for Bus registration.
 122  * The constructor has higher priority than PMD constructors.
 123  */
 124 #define RTE_REGISTER_BUS(nm, bus) \
 125 static void __attribute__((constructor(101), used)) businitfn_ ##nm(void) \
 126 {\
 127         (bus).name = RTE_STR(nm);\
 128         rte_bus_register(&bus); \
 129 }
 130
 131 #ifdef __cplusplus
 132 }
 133 #endif
 134
 135 #endif /* _RTE_BUS_H */