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  * Implementation specific probe function which is responsible for linking
  74  * devices on that bus with applicable drivers.
  75  *
  76  * This is called while iterating over each registered bus.
  77  *
  78  * @return
  79  *      0 for successful probe
  80  *      !0 for any error while probing
  81  */
  82 typedef int (*rte_bus_probe_t)(void);
  83
  84 /**
  85  * A structure describing a generic bus.
  86  */
  87 struct rte_bus {
  88         TAILQ_ENTRY(rte_bus) next;   /**< Next bus object in linked list */
  89         const char *name;            /**< Name of the bus */
  90         rte_bus_scan_t scan;         /**< Scan for devices attached to bus */
  91         rte_bus_probe_t probe;       /**< Probe devices on bus */
  92 };
  93
  94 /**
  95  * Register a Bus handler.
  96  *
  97  * @param bus
  98  *   A pointer to a rte_bus structure describing the bus
  99  *   to be registered.
 100  */
 101 void rte_bus_register(struct rte_bus *bus);
 102
 103 /**
 104  * Unregister a Bus handler.
 105  *
 106  * @param bus
 107  *   A pointer to a rte_bus structure describing the bus
 108  *   to be unregistered.
 109  */
 110 void rte_bus_unregister(struct rte_bus *bus);
 111
 112 /**
 113  * Scan all the buses.
 114  *
 115  * @return
 116  *   0 in case of success in scanning all buses
 117  *  !0 in case of failure to scan
 118  */
 119 int rte_bus_scan(void);
 120
 121 /**
 122  * For each device on the buses, perform a driver 'match' and call the
 123  * driver-specific probe for device initialization.
 124  *
 125  * @return
 126  *       0 for successful match/probe
 127  *      !0 otherwise
 128  */
 129 int rte_bus_probe(void);
 130
 131 /**
 132  * Dump information of all the buses registered with EAL.
 133  *
 134  * @param f
 135  *       A valid and open output stream handle
 136  *
 137  * @return
 138  *       0 in case of success
 139  *      !0 in case there is error in opening the output stream
 140  */
 141 void rte_bus_dump(FILE *f);
 142
 143 /**
 144  * Helper for Bus registration.
 145  * The constructor has higher priority than PMD constructors.
 146  */
 147 #define RTE_REGISTER_BUS(nm, bus) \
 148 static void __attribute__((constructor(101), used)) businitfn_ ##nm(void) \
 149 {\
 150         (bus).name = RTE_STR(nm);\
 151         rte_bus_register(&bus); \
 152 }
 153
 154 #ifdef __cplusplus
 155 }
 156 #endif
 157
 158 #endif /* _RTE_BUS_H */