bus: add scanning
[dpdk.git] / 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
53         TAILQ_INSERT_TAIL(&rte_bus_list, bus, next);
54         RTE_LOG(DEBUG, EAL, "Registered [%s] bus.\n", bus->name);
55 }
56
57 void
58 rte_bus_unregister(struct rte_bus *bus)
59 {
60         TAILQ_REMOVE(&rte_bus_list, bus, next);
61         RTE_LOG(DEBUG, EAL, "Unregistered [%s] bus.\n", bus->name);
62 }
63
64 /* Scan all the buses for registered devices */
65 int
66 rte_bus_scan(void)
67 {
68         int ret;
69         struct rte_bus *bus = NULL;
70
71         TAILQ_FOREACH(bus, &rte_bus_list, next) {
72                 ret = bus->scan();
73                 if (ret) {
74                         RTE_LOG(ERR, EAL, "Scan for (%s) bus failed.\n",
75                                 bus->name);
76                         return ret;
77                 }
78         }
79
80         return 0;
81 }
82
83 /* Dump information of a single bus */
84 static int
85 bus_dump_one(FILE *f, struct rte_bus *bus)
86 {
87         int ret;
88
89         /* For now, dump only the bus name */
90         ret = fprintf(f, " %s\n", bus->name);
91
92         /* Error in case of inability in writing to stream */
93         if (ret < 0)
94                 return ret;
95
96         return 0;
97 }
98
99 void
100 rte_bus_dump(FILE *f)
101 {
102         int ret;
103         struct rte_bus *bus;
104
105         TAILQ_FOREACH(bus, &rte_bus_list, next) {
106                 ret = bus_dump_one(f, bus);
107                 if (ret) {
108                         RTE_LOG(ERR, EAL, "Unable to write to stream (%d)\n",
109                                 ret);
110                         break;
111                 }
112         }
113 }