6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
16 * * Neither the name of NXP nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 * DPDK device bus interface
41 * This file exposes API and interfaces for bus abstraction
42 * over the devices and drivers in EAL.
50 #include <sys/queue.h>
55 /** Double linked list of buses */
56 TAILQ_HEAD(rte_bus_list, rte_bus);
59 * Bus specific scan for devices attached on the bus.
60 * For each bus object, the scan would be responsible for finding devices and
61 * adding them to its private device list.
63 * A bus should mandatorily implement this method.
66 * 0 for successful scan
67 * <0 for unsuccessful scan with error value
69 typedef int (*rte_bus_scan_t)(void);
72 * Implementation specific probe function which is responsible for linking
73 * devices on that bus with applicable drivers.
75 * This is called while iterating over each registered bus.
78 * 0 for successful probe
79 * !0 for any error while probing
81 typedef int (*rte_bus_probe_t)(void);
84 * Device iterator to find a device on a bus.
86 * This function returns an rte_device if one of those held by the bus
87 * matches the data passed as parameter.
89 * If the comparison function returns zero this function should stop iterating
90 * over any more devices. To continue a search the device of a previous search
91 * can be passed via the start parameter.
94 * Comparison function.
97 * Data to compare each device against.
100 * starting point for the iteration
103 * The first device matching the data, NULL if none exists.
105 typedef struct rte_device *
106 (*rte_bus_find_device_t)(const struct rte_device *start, rte_dev_cmp_t cmp,
110 * Implementation specific probe function which is responsible for linking
111 * devices on that bus with applicable drivers.
114 * Device pointer that was returned by a previous call to find_device.
117 * Device declaration.
123 typedef int (*rte_bus_plug_t)(struct rte_device *dev,
124 const char *devargs);
127 * Implementation specific remove function which is responsible for unlinking
128 * devices on that bus from assigned driver.
131 * Device pointer that was returned by a previous call to find_device.
137 typedef int (*rte_bus_unplug_t)(struct rte_device *dev);
140 * Bus specific parsing function.
141 * Validates the syntax used in the textual representation of a device,
142 * If the syntax is valid and ``addr`` is not NULL, writes the bus-specific
143 * device representation to ``addr``.
146 * device textual description
149 * device information location address, into which parsed info
150 * should be written. If NULL, nothing should be written, which
154 * 0 if parsing was successful.
157 typedef int (*rte_bus_parse_t)(const char *name, void *addr);
162 enum rte_bus_scan_mode {
163 RTE_BUS_SCAN_UNDEFINED,
164 RTE_BUS_SCAN_WHITELIST,
165 RTE_BUS_SCAN_BLACKLIST,
169 * A structure used to configure bus operations.
171 struct rte_bus_conf {
172 enum rte_bus_scan_mode scan_mode; /**< Scan policy. */
176 * A structure describing a generic bus.
179 TAILQ_ENTRY(rte_bus) next; /**< Next bus object in linked list */
180 const char *name; /**< Name of the bus */
181 rte_bus_scan_t scan; /**< Scan for devices attached to bus */
182 rte_bus_probe_t probe; /**< Probe devices on bus */
183 rte_bus_find_device_t find_device; /**< Find a device on the bus */
184 rte_bus_plug_t plug; /**< Probe single device for drivers */
185 rte_bus_unplug_t unplug; /**< Remove single device from driver */
186 rte_bus_parse_t parse; /**< Parse a device name */
187 struct rte_bus_conf conf; /**< Bus configuration */
191 * Register a Bus handler.
194 * A pointer to a rte_bus structure describing the bus
197 void rte_bus_register(struct rte_bus *bus);
200 * Unregister a Bus handler.
203 * A pointer to a rte_bus structure describing the bus
204 * to be unregistered.
206 void rte_bus_unregister(struct rte_bus *bus);
209 * Scan all the buses.
212 * 0 in case of success in scanning all buses
213 * !0 in case of failure to scan
215 int rte_bus_scan(void);
218 * For each device on the buses, perform a driver 'match' and call the
219 * driver-specific probe for device initialization.
222 * 0 for successful match/probe
225 int rte_bus_probe(void);
228 * Dump information of all the buses registered with EAL.
231 * A valid and open output stream handle
233 void rte_bus_dump(FILE *f);
236 * Bus comparison function.
242 * Data to compare against.
245 * 0 if the bus matches the data.
246 * !0 if the bus does not match.
247 * <0 if ordering is possible and the bus is lower than the data.
248 * >0 if ordering is possible and the bus is greater than the data.
250 typedef int (*rte_bus_cmp_t)(const struct rte_bus *bus, const void *data);
253 * Bus iterator to find a particular bus.
255 * This function compares each registered bus to find one that matches
256 * the data passed as parameter.
258 * If the comparison function returns zero this function will stop iterating
259 * over any more buses. To continue a search the bus of a previous search can
260 * be passed via the start parameter.
263 * Starting point for the iteration.
266 * Comparison function.
269 * Data to pass to comparison function.
272 * A pointer to a rte_bus structure or NULL in case no bus matches
274 struct rte_bus *rte_bus_find(const struct rte_bus *start, rte_bus_cmp_t cmp,
278 * Find the registered bus for a particular device.
280 struct rte_bus *rte_bus_find_by_device(const struct rte_device *dev);
283 * Find the registered bus for a given name.
285 struct rte_bus *rte_bus_find_by_name(const char *busname);
288 * Helper for Bus registration.
289 * The constructor has higher priority than PMD constructors.
291 #define RTE_REGISTER_BUS(nm, bus) \
292 RTE_INIT_PRIO(businitfn_ ##nm, 101); \
293 static void businitfn_ ##nm(void) \
295 (bus).name = RTE_STR(nm);\
296 rte_bus_register(&bus); \
303 #endif /* _RTE_BUS_H */