rte_bus.h File Reference

#include <stdio.h>
#include <sys/queue.h>
#include <rte_log.h>
#include <rte_dev.h>

Go to the source code of this file.

Data Structures
struct	rte_bus_conf
struct	rte_bus

Macros
#define	RTE_REGISTER_BUS(nm, bus)

Typedefs
typedef int(*	rte_bus_scan_t )(void)
typedef int(*	rte_bus_probe_t )(void)
typedef struct rte_device *(*	rte_bus_find_device_t )(const struct rte_device *start, rte_dev_cmp_t cmp, const void *data)
typedef int(*	rte_bus_plug_t )(struct rte_device *dev)
typedef int(*	rte_bus_unplug_t )(struct rte_device *dev)
typedef int(*	rte_bus_parse_t )(const char *name, void *addr)
typedef enum rte_iova_mode(*	rte_bus_get_iommu_class_t )(void)
typedef int(*	rte_bus_cmp_t )(const struct rte_bus *bus, const void *data)

Enumerations
enum	rte_iova_mode
enum	rte_bus_scan_mode

Functions
	TAILQ_HEAD (rte_bus_list, rte_bus)
void	rte_bus_register (struct rte_bus *bus)
void	rte_bus_unregister (struct rte_bus *bus)
int	rte_bus_scan (void)
int	rte_bus_probe (void)
void	rte_bus_dump (FILE *f)
struct rte_bus *	rte_bus_find (const struct rte_bus *start, rte_bus_cmp_t cmp, const void *data)
struct rte_bus *	rte_bus_find_by_device (const struct rte_device *dev)
struct rte_bus *	rte_bus_find_by_name (const char *busname)
enum rte_iova_mode	rte_bus_get_iommu_class (void)

Detailed Description

DPDK device bus interface

This file exposes API and interfaces for bus abstraction over the devices and drivers in EAL.

Definition in file rte_bus.h.

Macro Definition Documentation

#define RTE_REGISTER_BUS	(		nm,
			bus
	)

Value:

RTE_INIT_PRIO(businitfn_ ##nm, BUS); \
static void businitfn_ ##nm(void) \
{\
        (bus).name = RTE_STR(nm);\
        rte_bus_register(&bus); \
}

Helper for Bus registration. The constructor has higher priority than PMD constructors.

Definition at line 327 of file rte_bus.h.

Typedef Documentation

typedef int(* rte_bus_scan_t)(void)

Bus specific scan for devices attached on the bus. For each bus object, the scan would be responsible for finding devices and adding them to its private device list.

A bus should mandatorily implement this method.

Returns

0 for successful scan <0 for unsuccessful scan with error value

Definition at line 84 of file rte_bus.h.

typedef int(* rte_bus_probe_t)(void)

Implementation specific probe function which is responsible for linking devices on that bus with applicable drivers.

This is called while iterating over each registered bus.

Returns

0 for successful probe !0 for any error while probing

Definition at line 96 of file rte_bus.h.

typedef struct rte_device*(* rte_bus_find_device_t)(const struct rte_device *start, rte_dev_cmp_t cmp, const void *data)

Device iterator to find a device on a bus.

This function returns an rte_device if one of those held by the bus matches the data passed as parameter.

If the comparison function returns zero this function should stop iterating over any more devices. To continue a search the device of a previous search can be passed via the start parameter.

Parameters

cmp	Comparison function.
data	Data to compare each device against.
start	starting point for the iteration

Returns

The first device matching the data, NULL if none exists.

Definition at line 121 of file rte_bus.h.

typedef int(* rte_bus_plug_t)(struct rte_device *dev)

Implementation specific probe function which is responsible for linking devices on that bus with applicable drivers.

Parameters

dev	Device pointer that was returned by a previous call to find_device.

Returns

0 on success. !0 on error.

Definition at line 135 of file rte_bus.h.

typedef int(* rte_bus_unplug_t)(struct rte_device *dev)

Implementation specific remove function which is responsible for unlinking devices on that bus from assigned driver.

Parameters

dev	Device pointer that was returned by a previous call to find_device.

Returns

0 on success. !0 on error.

Definition at line 148 of file rte_bus.h.

typedef int(* rte_bus_parse_t)(const char *name, void *addr)

Bus specific parsing function. Validates the syntax used in the textual representation of a device, If the syntax is valid and addr is not NULL, writes the bus-specific device representation to addr.

Parameters

[in]	name	device textual description
[out]	addr	device information location address, into which parsed info should be written. If NULL, nothing should be written, which is not an error.

Returns

0 if parsing was successful. !0 for any error.

Definition at line 168 of file rte_bus.h.

typedef enum rte_iova_mode(* rte_bus_get_iommu_class_t)(void)

Get common iommu class of the all the devices on the bus. The bus may check that those devices are attached to iommu driver. If no devices are attached to the bus. The bus may return with don't care (_DC) value. Otherwise, The bus will return appropriate _pa or _va iova mode.

Returns

enum rte_iova_mode value.

Definition at line 197 of file rte_bus.h.

typedef int(* rte_bus_cmp_t)(const struct rte_bus *bus, const void *data)

Bus comparison function.

Parameters

bus	Bus under test.
data	Data to compare against.

Returns

0 if the bus matches the data. !0 if the bus does not match. <0 if ordering is possible and the bus is lower than the data. >0 if ordering is possible and the bus is greater than the data.

Definition at line 276 of file rte_bus.h.

Enumeration Type Documentation

enum rte_iova_mode

IOVA mapping mode.

IOVA mapping mode is iommu programming mode of a device. That device (for example: IOMMU backed DMA device) based on rte_iova_mode will generate physical or virtual address.

Definition at line 67 of file rte_bus.h.

enum rte_bus_scan_mode

Bus scan policies

Definition at line 173 of file rte_bus.h.

Function Documentation

TAILQ_HEAD	(	rte_bus_list	,
		rte_bus
	)

Double linked list of buses

void rte_bus_register

(

struct rte_bus *

bus

)

Register a Bus handler.

Parameters

bus	A pointer to a rte_bus structure describing the bus to be registered.

void rte_bus_unregister

(

struct rte_bus *

bus

)

Unregister a Bus handler.

Parameters

bus	A pointer to a rte_bus structure describing the bus to be unregistered.

int rte_bus_scan

(

void

)

Scan all the buses.

Returns

0 in case of success in scanning all buses !0 in case of failure to scan

int rte_bus_probe

(

void

)

For each device on the buses, perform a driver 'match' and call the driver-specific probe for device initialization.

Returns

0 for successful match/probe !0 otherwise

void rte_bus_dump

(

FILE *

f

)

Dump information of all the buses registered with EAL.

Parameters

f	A valid and open output stream handle

struct rte_bus* rte_bus_find ( const struct rte_bus *  start, rte_bus_cmp_t  cmp, const void *  data  )

read

Bus iterator to find a particular bus.

This function compares each registered bus to find one that matches the data passed as parameter.

If the comparison function returns zero this function will stop iterating over any more buses. To continue a search the bus of a previous search can be passed via the start parameter.

Parameters

start	Starting point for the iteration.
cmp	Comparison function.
data	Data to pass to comparison function.

Returns

A pointer to a rte_bus structure or NULL in case no bus matches

struct rte_bus* rte_bus_find_by_device ( const struct rte_device *  dev )

read

Find the registered bus for a particular device.

Examples:

examples/ethtool/lib/rte_ethtool.c, examples/ip_pipeline/kni.c, and examples/kni/main.c.

struct rte_bus* rte_bus_find_by_name ( const char *  busname )

read

Find the registered bus for a given name.

enum rte_iova_mode rte_bus_get_iommu_class

(

void

)

Get the common iommu class of devices bound on to buses available in the system. The default mode is PA.

Returns

enum rte_iova_mode value.