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  * A structure describing a generic bus.
  61  */
  62 struct rte_bus {
  63         TAILQ_ENTRY(rte_bus) next;   /**< Next bus object in linked list */
  64         const char *name;            /**< Name of the bus */
  65 };
  66
  67 /**
  68  * Register a Bus handler.
  69  *
  70  * @param bus
  71  *   A pointer to a rte_bus structure describing the bus
  72  *   to be registered.
  73  */
  74 void rte_bus_register(struct rte_bus *bus);
  75
  76 /**
  77  * Unregister a Bus handler.
  78  *
  79  * @param bus
  80  *   A pointer to a rte_bus structure describing the bus
  81  *   to be unregistered.
  82  */
  83 void rte_bus_unregister(struct rte_bus *bus);
  84
  85 /**
  86  * Dump information of all the buses registered with EAL.
  87  *
  88  * @param f
  89  *       A valid and open output stream handle
  90  *
  91  * @return
  92  *       0 in case of success
  93  *      !0 in case there is error in opening the output stream
  94  */
  95 void rte_bus_dump(FILE *f);
  96
  97 /**
  98  * Helper for Bus registration.
  99  * The constructor has higher priority than PMD constructors.
 100  */
 101 #define RTE_REGISTER_BUS(nm, bus) \
 102 static void __attribute__((constructor(101), used)) businitfn_ ##nm(void) \
 103 {\
 104         (bus).name = RTE_STR(nm);\
 105         rte_bus_register(&bus); \
 106 }
 107
 108 #ifdef __cplusplus
 109 }
 110 #endif
 111
 112 #endif /* _RTE_BUS_H */