DPDK
24.11.0-rc1
|
Go to the source code of this file.
Data Structures | |
struct | rte_mem_resource |
struct | rte_dev_iterator |
Macros | |
#define | RTE_PMD_REGISTER_KMOD_DEP(name, str) |
Typedefs | |
typedef int(* | rte_dev_cmp_t) (const struct rte_device *dev, const void *data) |
typedef void *(* | rte_dev_iterate_t) (const void *start, const char *devstr, const struct rte_dev_iterator *it) |
Enumerations | |
enum | rte_dev_event_type { RTE_DEV_EVENT_ADD, RTE_DEV_EVENT_REMOVE, RTE_DEV_EVENT_MAX } |
enum | rte_dev_policy |
Functions | |
const char * | rte_driver_name (const struct rte_driver *driver) |
const struct rte_bus * | rte_dev_bus (const struct rte_device *dev) |
const char * | rte_dev_bus_info (const struct rte_device *dev) |
const struct rte_devargs * | rte_dev_devargs (const struct rte_device *dev) |
const struct rte_driver * | rte_dev_driver (const struct rte_device *dev) |
const char * | rte_dev_name (const struct rte_device *dev) |
int | rte_dev_numa_node (const struct rte_device *dev) |
int | rte_dev_is_probed (const struct rte_device *dev) |
int | rte_eal_hotplug_add (const char *busname, const char *devname, const char *drvargs) |
int | rte_dev_probe (const char *devargs) |
int | rte_eal_hotplug_remove (const char *busname, const char *devname) |
int | rte_dev_remove (struct rte_device *dev) |
int | rte_dev_iterator_init (struct rte_dev_iterator *it, const char *str) |
struct rte_device * | rte_dev_iterator_next (struct rte_dev_iterator *it) |
int | rte_dev_event_callback_register (const char *device_name, rte_dev_event_cb_fn cb_fn, void *cb_arg) |
int | rte_dev_event_callback_unregister (const char *device_name, rte_dev_event_cb_fn cb_fn, void *cb_arg) |
void | rte_dev_event_callback_process (const char *device_name, enum rte_dev_event_type event) |
int | rte_dev_event_monitor_start (void) |
int | rte_dev_event_monitor_stop (void) |
int | rte_dev_hotplug_handle_enable (void) |
int | rte_dev_hotplug_handle_disable (void) |
int | rte_dev_dma_map (struct rte_device *dev, void *addr, uint64_t iova, size_t len) |
int | rte_dev_dma_unmap (struct rte_device *dev, void *addr, uint64_t iova, size_t len) |
RTE PMD Registration Interface
This file manages the list of device drivers.
Definition in file rte_dev.h.
#define RTE_PMD_REGISTER_KMOD_DEP | ( | name, | |
str | |||
) |
Advertise the list of kernel modules required to run this driver
This string lists the kernel modules required for the devices associated to a PMD. The format of each line of the string is: "<device-pattern> <kmod-expression>".
The possible formats for the device pattern are: "*" all devices supported by this driver "pci:*" all PCI devices supported by this driver "pci:v8086:d*:sv*:sd*" all PCI devices supported by this driver whose vendor id is 0x8086.
The format of the kernel modules list is a parenthesized expression containing logical-and (&) and logical-or (|).
The device pattern and the kmod expression are separated by a space.
Example:
typedef int(* rte_dev_cmp_t) (const struct rte_device *dev, const void *data) |
Device comparison function.
This type of function is used to compare an rte_device with arbitrary data.
dev | Device handle. |
data | Data to compare against. The type of this parameter is determined by the kind of comparison performed by the function. |
typedef void*(* rte_dev_iterate_t) (const void *start, const char *devstr, const struct rte_dev_iterator *it) |
Device iteration function.
Find the next device matching properties passed in parameters. The function takes an additional start
parameter, that is used as starting context when relevant.
The function returns the current element in the iteration. This return value will potentially be used as a start parameter in subsequent calls to the function.
The additional iterator parameter is only there if a specific implementation needs additional context. It must not be modified by the iteration function itself.
start | Starting iteration context. |
devstr | Device description string. |
it | Device iterator. |
enum rte_dev_event_type |
enum rte_dev_policy |
const char* rte_driver_name | ( | const struct rte_driver * | driver | ) |
Retrieve a driver name.
driver | A pointer to a driver structure. |
const struct rte_bus* rte_dev_bus | ( | const struct rte_device * | dev | ) |
Retrieve a device bus.
dev | A pointer to a device structure. |
const char* rte_dev_bus_info | ( | const struct rte_device * | dev | ) |
Retrieve bus specific information for a device.
dev | A pointer to a device structure. |
const struct rte_devargs* rte_dev_devargs | ( | const struct rte_device * | dev | ) |
Retrieve a device arguments.
dev | A pointer to a device structure. |
const struct rte_driver* rte_dev_driver | ( | const struct rte_device * | dev | ) |
Retrieve a device driver.
dev | A pointer to a device structure. |
const char* rte_dev_name | ( | const struct rte_device * | dev | ) |
Retrieve a device name.
dev | A pointer to a device structure. |
int rte_dev_numa_node | ( | const struct rte_device * | dev | ) |
Retrieve a device numa node.
dev | A pointer to a device structure. |
int rte_dev_is_probed | ( | const struct rte_device * | dev | ) |
Query status of a device.
dev | Generic device pointer. |
int rte_eal_hotplug_add | ( | const char * | busname, |
const char * | devname, | ||
const char * | drvargs | ||
) |
Hotplug add a given device to a specific bus.
In multi-process, it will request other processes to add the same device. A failure, in any process, will rollback the action
busname | The bus name the device is added to. |
devname | The device name. Based on this device name, eal will identify a driver capable of handling it and pass it to the driver probing function. |
drvargs | Device arguments to be passed to the driver. |
int rte_dev_probe | ( | const char * | devargs | ) |
Add matching devices.
In multi-process, it will request other processes to add the same device. A failure, in any process, will rollback the action
devargs | Device arguments including bus, class and driver properties. |
int rte_eal_hotplug_remove | ( | const char * | busname, |
const char * | devname | ||
) |
Hotplug remove a given device from a specific bus.
In multi-process, it will request other processes to remove the same device. A failure, in any process, will rollback the action
busname | The bus name the device is removed from. |
devname | The device name being removed. |
int rte_dev_remove | ( | struct rte_device * | dev | ) |
Remove one device.
In multi-process, it will request other processes to remove the same device. A failure, in any process, will rollback the action
dev | Data structure of the device to remove. |
int rte_dev_iterator_init | ( | struct rte_dev_iterator * | it, |
const char * | str | ||
) |
Initializes a device iterator.
This iterator allows accessing a list of devices matching a criteria. The device matching is made among all buses and classes currently registered, filtered by the device description given as parameter.
This function will not allocate any memory. It is safe to stop the iteration at any moment and let the iterator go out of context.
it | Device iterator handle. |
str | Device description string. |
struct rte_device* rte_dev_iterator_next | ( | struct rte_dev_iterator * | it | ) |
Iterates on a device iterator.
Generates a new rte_device handle corresponding to the next element in the list described in comprehension by the iterator.
The next object is returned, and the iterator is updated.
it | Device iterator handle. |
int rte_dev_event_callback_register | ( | const char * | device_name, |
rte_dev_event_cb_fn | cb_fn, | ||
void * | cb_arg | ||
) |
It registers the callback for the specific device. Multiple callbacks can be registered at the same time.
device_name | The device name, that is the param name of the struct rte_device, null value means for all devices. |
cb_fn | callback address. |
cb_arg | address of parameter for callback. |
int rte_dev_event_callback_unregister | ( | const char * | device_name, |
rte_dev_event_cb_fn | cb_fn, | ||
void * | cb_arg | ||
) |
It unregisters the callback according to the specified device.
device_name | The device name, that is the param name of the struct rte_device, null value means for all devices and their callbacks. |
cb_fn | callback address. |
cb_arg | address of parameter for callback, (void *)-1 means to remove all registered which has the same callback address. |
void rte_dev_event_callback_process | ( | const char * | device_name, |
enum rte_dev_event_type | event | ||
) |
Executes all the user application registered callbacks for the specific device.
device_name | The device name. |
event | the device event type. |
int rte_dev_event_monitor_start | ( | void | ) |
Start the device event monitoring.
int rte_dev_event_monitor_stop | ( | void | ) |
Stop the device event monitoring.
int rte_dev_hotplug_handle_enable | ( | void | ) |
Enable hotplug handling for devices.
int rte_dev_hotplug_handle_disable | ( | void | ) |
Disable hotplug handling for devices.
int rte_dev_dma_map | ( | struct rte_device * | dev, |
void * | addr, | ||
uint64_t | iova, | ||
size_t | len | ||
) |
Device level DMA map function. After a successful call, the memory segment will be mapped to the given device.
dev | Device pointer. |
addr | Virtual address to map. |
iova | IOVA address to map. |
len | Length of the memory segment being mapped. |
int rte_dev_dma_unmap | ( | struct rte_device * | dev, |
void * | addr, | ||
uint64_t | iova, | ||
size_t | len | ||
) |
Device level DMA unmap function. After a successful call, the memory segment will no longer be accessible by the given device.
dev | Device pointer. |
addr | Virtual address to unmap. |
iova | IOVA address to unmap. |
len | Length of the memory segment being mapped. |