lib/librte_eal/common/eal_common_bus.c

   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 #include <stdio.h>
  35 #include <string.h>
  36 #include <sys/queue.h>
  37
  38 #include <rte_bus.h>
  39
  40 #include "eal_private.h"
  41
  42 struct rte_bus_list rte_bus_list =
  43         TAILQ_HEAD_INITIALIZER(rte_bus_list);
  44
  45 void
  46 rte_bus_register(struct rte_bus *bus)
  47 {
  48         RTE_VERIFY(bus);
  49         RTE_VERIFY(bus->name && strlen(bus->name));
  50         /* A bus should mandatorily have the scan implemented */
  51         RTE_VERIFY(bus->scan);
  52         RTE_VERIFY(bus->probe);
  53
  54         TAILQ_INSERT_TAIL(&rte_bus_list, bus, next);
  55         RTE_LOG(DEBUG, EAL, "Registered [%s] bus.\n", bus->name);
  56 }
  57
  58 void
  59 rte_bus_unregister(struct rte_bus *bus)
  60 {
  61         TAILQ_REMOVE(&rte_bus_list, bus, next);
  62         RTE_LOG(DEBUG, EAL, "Unregistered [%s] bus.\n", bus->name);
  63 }
  64
  65 /* Scan all the buses for registered devices */
  66 int
  67 rte_bus_scan(void)
  68 {
  69         int ret;
  70         struct rte_bus *bus = NULL;
  71
  72         TAILQ_FOREACH(bus, &rte_bus_list, next) {
  73                 ret = bus->scan();
  74                 if (ret) {
  75                         RTE_LOG(ERR, EAL, "Scan for (%s) bus failed.\n",
  76                                 bus->name);
  77                         return ret;
  78                 }
  79         }
  80
  81         return 0;
  82 }
  83
  84 /* Probe all devices of all buses */
  85 int
  86 rte_bus_probe(void)
  87 {
  88         int ret;
  89         struct rte_bus *bus;
  90
  91         TAILQ_FOREACH(bus, &rte_bus_list, next) {
  92                 ret = bus->probe();
  93                 if (ret) {
  94                         RTE_LOG(ERR, EAL, "Bus (%s) probe failed.\n",
  95                                 bus->name);
  96                         return ret;
  97                 }
  98         }
  99
 100         return 0;
 101 }
 102
 103 /* Dump information of a single bus */
 104 static int
 105 bus_dump_one(FILE *f, struct rte_bus *bus)
 106 {
 107         int ret;
 108
 109         /* For now, dump only the bus name */
 110         ret = fprintf(f, " %s\n", bus->name);
 111
 112         /* Error in case of inability in writing to stream */
 113         if (ret < 0)
 114                 return ret;
 115
 116         return 0;
 117 }
 118
 119 void
 120 rte_bus_dump(FILE *f)
 121 {
 122         int ret;
 123         struct rte_bus *bus;
 124
 125         TAILQ_FOREACH(bus, &rte_bus_list, next) {
 126                 ret = bus_dump_one(f, bus);
 127                 if (ret) {
 128                         RTE_LOG(ERR, EAL, "Unable to write to stream (%d)\n",
 129                                 ret);
 130                         break;
 131                 }
 132         }
 133 }