rte_eventdev_pmd.h File Reference

#include <string.h>
#include <rte_common.h>
#include <rte_config.h>
#include <rte_dev.h>
#include <rte_log.h>
#include <rte_malloc.h>
#include "rte_eventdev.h"
#include "rte_event_timer_adapter_pmd.h"

Go to the source code of this file.

Data Structures
struct	rte_eventdev_global
struct	rte_eventdev_ops

Macros
#define	RTE_EVENT_CRYPTO_ADAPTER_SW_CAP   RTE_EVENT_CRYPTO_ADAPTER_CAP_SESSION_PRIVATE_DATA

Typedefs
typedef void(*	eventdev_info_get_t) (struct rte_eventdev *dev, struct rte_event_dev_info *dev_info)
typedef int(*	eventdev_configure_t) (const struct rte_eventdev *dev)
typedef int(*	eventdev_start_t) (struct rte_eventdev *dev)
typedef void(*	eventdev_stop_t) (struct rte_eventdev *dev)
typedef int(*	eventdev_close_t) (struct rte_eventdev *dev)
typedef void(*	eventdev_queue_default_conf_get_t) (struct rte_eventdev *dev, uint8_t queue_id, struct rte_event_queue_conf *queue_conf)
typedef int(*	eventdev_queue_setup_t) (struct rte_eventdev *dev, uint8_t queue_id, const struct rte_event_queue_conf *queue_conf)
typedef void(*	eventdev_queue_release_t) (struct rte_eventdev *dev, uint8_t queue_id)
typedef void(*	eventdev_port_default_conf_get_t) (struct rte_eventdev *dev, uint8_t port_id, struct rte_event_port_conf *port_conf)
typedef int(*	eventdev_port_setup_t) (struct rte_eventdev *dev, uint8_t port_id, const struct rte_event_port_conf *port_conf)
typedef void(*	eventdev_port_release_t) (void *port)
typedef int(*	eventdev_port_link_t) (struct rte_eventdev *dev, void *port, const uint8_t queues[], const uint8_t priorities[], uint16_t nb_links)
typedef int(*	eventdev_port_unlink_t) (struct rte_eventdev *dev, void *port, uint8_t queues[], uint16_t nb_unlinks)
typedef int(*	eventdev_port_unlinks_in_progress_t) (struct rte_eventdev *dev, void *port)
typedef int(*	eventdev_dequeue_timeout_ticks_t) (struct rte_eventdev *dev, uint64_t ns, uint64_t *timeout_ticks)
typedef void(*	eventdev_dump_t) (struct rte_eventdev *dev, FILE *f)
typedef int(*	eventdev_xstats_get_t) (const struct rte_eventdev *dev, enum rte_event_dev_xstats_mode mode, uint8_t queue_port_id, const unsigned int ids[], uint64_t values[], unsigned int n)
typedef int(*	eventdev_xstats_reset_t) (struct rte_eventdev *dev, enum rte_event_dev_xstats_mode mode, int16_t queue_port_id, const uint32_t ids[], uint32_t nb_ids)
typedef int(*	eventdev_xstats_get_names_t) (const struct rte_eventdev *dev, enum rte_event_dev_xstats_mode mode, uint8_t queue_port_id, struct rte_event_dev_xstats_name *xstats_names, unsigned int *ids, unsigned int size)
typedef uint64_t(*	eventdev_xstats_get_by_name) (const struct rte_eventdev *dev, const char *name, unsigned int *id)
typedef int(*	eventdev_eth_rx_adapter_caps_get_t) (const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev, uint32_t *caps)
typedef int(*	eventdev_timer_adapter_caps_get_t) (const struct rte_eventdev *dev, uint64_t flags, uint32_t *caps, const struct rte_event_timer_adapter_ops **ops)
typedef int(*	eventdev_eth_rx_adapter_queue_add_t) (const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev, int32_t rx_queue_id, const struct rte_event_eth_rx_adapter_queue_conf *queue_conf)
typedef int(*	eventdev_eth_rx_adapter_queue_del_t) (const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev, int32_t rx_queue_id)
typedef int(*	eventdev_eth_rx_adapter_start_t) (const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev)
typedef int(*	eventdev_eth_rx_adapter_stop_t) (const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev)
typedef int(*	eventdev_eth_rx_adapter_stats_get) (const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev, struct rte_event_eth_rx_adapter_stats *stats)
typedef int(*	eventdev_eth_rx_adapter_stats_reset) (const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev)
typedef int(*	eventdev_selftest) (void)
typedef int(*	eventdev_crypto_adapter_caps_get_t) (const struct rte_eventdev *dev, const struct rte_cryptodev *cdev, uint32_t *caps)
typedef int(*	eventdev_crypto_adapter_queue_pair_add_t) (const struct rte_eventdev *dev, const struct rte_cryptodev *cdev, int32_t queue_pair_id, const struct rte_event *event)
typedef int(*	eventdev_crypto_adapter_queue_pair_del_t) (const struct rte_eventdev *dev, const struct rte_cryptodev *cdev, int32_t queue_pair_id)
typedef int(*	eventdev_crypto_adapter_start_t) (const struct rte_eventdev *dev, const struct rte_cryptodev *cdev)
typedef int(*	eventdev_crypto_adapter_stop_t) (const struct rte_eventdev *dev, const struct rte_cryptodev *cdev)
typedef int(*	eventdev_crypto_adapter_stats_get) (const struct rte_eventdev *dev, const struct rte_cryptodev *cdev, struct rte_event_crypto_adapter_stats *stats)
typedef int(*	eventdev_crypto_adapter_stats_reset) (const struct rte_eventdev *dev, const struct rte_cryptodev *cdev)
typedef int(*	eventdev_eth_tx_adapter_caps_get_t) (const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev, uint32_t *caps)
typedef int(*	eventdev_eth_tx_adapter_create_t) (uint8_t id, const struct rte_eventdev *dev)
typedef int(*	eventdev_eth_tx_adapter_free_t) (uint8_t id, const struct rte_eventdev *dev)
typedef int(*	eventdev_eth_tx_adapter_queue_add_t) (uint8_t id, const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev, int32_t tx_queue_id)
typedef int(*	eventdev_eth_tx_adapter_queue_del_t) (uint8_t id, const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev, int32_t tx_queue_id)
typedef int(*	eventdev_eth_tx_adapter_start_t) (uint8_t id, const struct rte_eventdev *dev)
typedef int(*	eventdev_eth_tx_adapter_stop_t) (uint8_t id, const struct rte_eventdev *dev)
typedef int(*	eventdev_eth_tx_adapter_stats_get_t) (uint8_t id, const struct rte_eventdev *dev, struct rte_event_eth_tx_adapter_stats *stats)
typedef int(*	eventdev_eth_tx_adapter_stats_reset_t) (uint8_t id, const struct rte_eventdev *dev)

Functions
static struct rte_eventdev *	rte_event_pmd_get_named_dev (const char *name)
static unsigned	rte_event_pmd_is_valid_dev (uint8_t dev_id)
struct rte_eventdev *	rte_event_pmd_allocate (const char *name, int socket_id)
int	rte_event_pmd_release (struct rte_eventdev *eventdev)

Detailed Description

RTE Event PMD APIs

Note

These API are from event PMD only and user applications should not call them directly.

Definition in file rte_eventdev_pmd.h.

Macro Definition Documentation

RTE_EVENT_CRYPTO_ADAPTER_SW_CAP

#define RTE_EVENT_CRYPTO_ADAPTER_SW_CAP   RTE_EVENT_CRYPTO_ADAPTER_CAP_SESSION_PRIVATE_DATA

Ethernet Rx adapter cap to return If the packet transfers from the ethdev to eventdev use a SW service function

Definition at line 77 of file rte_eventdev_pmd.h.

Typedef Documentation

eventdev_info_get_t

typedef void(* eventdev_info_get_t) (struct rte_eventdev *dev, struct rte_event_dev_info *dev_info)

Definitions of all functions exported by a driver through the generic structure of type event_dev_ops supplied in the rte_eventdev structure associated with a device. Get device information of a device.

Parameters

dev	Event device pointer
dev_info	Event device information structure

Definition at line 163 of file rte_eventdev_pmd.h.

eventdev_configure_t

typedef int(* eventdev_configure_t) (const struct rte_eventdev *dev)

Configure a device.

Parameters

dev	Event device pointer

Returns

Returns 0 on success

Definition at line 175 of file rte_eventdev_pmd.h.

eventdev_start_t

typedef int(* eventdev_start_t) (struct rte_eventdev *dev)

Start a configured device.

Parameters

dev	Event device pointer

Returns

Returns 0 on success

Definition at line 186 of file rte_eventdev_pmd.h.

eventdev_stop_t

typedef void(* eventdev_stop_t) (struct rte_eventdev *dev)

Stop a configured device.

Parameters

dev	Event device pointer

Definition at line 194 of file rte_eventdev_pmd.h.

eventdev_close_t

typedef int(* eventdev_close_t) (struct rte_eventdev *dev)

Close a configured device.

Parameters

dev	Event device pointer

Returns

• 0 on success
• (-EAGAIN) if can't close as device is busy

Definition at line 206 of file rte_eventdev_pmd.h.

eventdev_queue_default_conf_get_t

typedef void(* eventdev_queue_default_conf_get_t) (struct rte_eventdev *dev, uint8_t queue_id, struct rte_event_queue_conf *queue_conf)

Retrieve the default event queue configuration.

Parameters

	dev	Event device pointer
	queue_id	Event queue index
[out]	queue_conf	Event queue configuration structure

Definition at line 219 of file rte_eventdev_pmd.h.

eventdev_queue_setup_t

typedef int(* eventdev_queue_setup_t) (struct rte_eventdev *dev, uint8_t queue_id, const struct rte_event_queue_conf *queue_conf)

Setup an event queue.

Parameters

dev	Event device pointer
queue_id	Event queue index
queue_conf	Event queue configuration structure

Returns

Returns 0 on success.

Definition at line 235 of file rte_eventdev_pmd.h.

eventdev_queue_release_t

typedef void(* eventdev_queue_release_t) (struct rte_eventdev *dev, uint8_t queue_id)

Release resources allocated by given event queue.

Parameters

dev	Event device pointer
queue_id	Event queue index

Definition at line 248 of file rte_eventdev_pmd.h.

eventdev_port_default_conf_get_t

typedef void(* eventdev_port_default_conf_get_t) (struct rte_eventdev *dev, uint8_t port_id, struct rte_event_port_conf *port_conf)

Retrieve the default event port configuration.

Parameters

	dev	Event device pointer
	port_id	Event port index
[out]	port_conf	Event port configuration structure

Definition at line 262 of file rte_eventdev_pmd.h.

eventdev_port_setup_t

typedef int(* eventdev_port_setup_t) (struct rte_eventdev *dev, uint8_t port_id, const struct rte_event_port_conf *port_conf)

Setup an event port.

Parameters

dev	Event device pointer
port_id	Event port index
port_conf	Event port configuration structure

Returns

Returns 0 on success.

Definition at line 278 of file rte_eventdev_pmd.h.

eventdev_port_release_t

typedef void(* eventdev_port_release_t) (void *port)

Release memory resources allocated by given event port.

Parameters

port	Event port pointer

Definition at line 289 of file rte_eventdev_pmd.h.

eventdev_port_link_t

typedef int(* eventdev_port_link_t) (struct rte_eventdev *dev, void *port, const uint8_t queues[], const uint8_t priorities[], uint16_t nb_links)

Link multiple source event queues to destination event port.

Parameters

dev	Event device pointer
port	Event port pointer
link	Points to an array of nb_links event queues to be linked to the event port.
priorities	Points to an array of nb_links service priorities associated with each event queue link to event port.
nb_links	The number of links to establish

Returns

Returns 0 on success.

Definition at line 311 of file rte_eventdev_pmd.h.

eventdev_port_unlink_t

typedef int(* eventdev_port_unlink_t) (struct rte_eventdev *dev, void *port, uint8_t queues[], uint16_t nb_unlinks)

Unlink multiple source event queues from destination event port.

Parameters

dev	Event device pointer
port	Event port pointer
queues	An array of nb_unlinks event queues to be unlinked from the event port.
nb_unlinks	The number of unlinks to establish

Returns

Returns 0 on success.

Definition at line 331 of file rte_eventdev_pmd.h.

eventdev_port_unlinks_in_progress_t

typedef int(* eventdev_port_unlinks_in_progress_t) (struct rte_eventdev *dev, void *port)

Unlinks in progress. Returns number of unlinks that the PMD is currently performing, but have not yet been completed.

Parameters

dev	Event device pointer
port	Event port pointer

Returns

Returns the number of in-progress unlinks. Zero is returned if none are in progress.

Definition at line 348 of file rte_eventdev_pmd.h.

eventdev_dequeue_timeout_ticks_t

typedef int(* eventdev_dequeue_timeout_ticks_t) (struct rte_eventdev *dev, uint64_t ns, uint64_t *timeout_ticks)

Converts nanoseconds to timeout_ticks value for rte_event_dequeue()

Parameters

	dev	Event device pointer
	ns	Wait time in nanosecond
[out]	timeout_ticks	Value for the timeout_ticks parameter in rte_event_dequeue() function

Returns

Returns 0 on success.

Definition at line 365 of file rte_eventdev_pmd.h.

eventdev_dump_t

typedef void(* eventdev_dump_t) (struct rte_eventdev *dev, FILE *f)

Dump internal information

Parameters

dev	Event device pointer
f	A pointer to a file for output

Definition at line 377 of file rte_eventdev_pmd.h.

eventdev_xstats_get_t

typedef int(* eventdev_xstats_get_t) (const struct rte_eventdev *dev, enum rte_event_dev_xstats_mode mode, uint8_t queue_port_id, const unsigned int ids[], uint64_t values[], unsigned int n)

Retrieve a set of statistics from device

Parameters

dev	Event device pointer
ids	The stat ids to retrieve
values	The returned stat values
n	The number of id values and entries in the values array

Returns

The number of stat values successfully filled into the values array

Definition at line 393 of file rte_eventdev_pmd.h.

eventdev_xstats_reset_t

typedef int(* eventdev_xstats_reset_t) (struct rte_eventdev *dev, enum rte_event_dev_xstats_mode mode, int16_t queue_port_id, const uint32_t ids[], uint32_t nb_ids)

Resets the statistic values in xstats for the device, based on mode.

Definition at line 400 of file rte_eventdev_pmd.h.

eventdev_xstats_get_names_t

typedef int(* eventdev_xstats_get_names_t) (const struct rte_eventdev *dev, enum rte_event_dev_xstats_mode mode, uint8_t queue_port_id, struct rte_event_dev_xstats_name *xstats_names, unsigned int *ids, unsigned int size)

Get names of extended stats of an event device

Parameters

dev	Event device pointer
xstats_names	Array of name values to be filled in
size	Number of values in the xstats_names array

Returns

When size >= the number of stats, return the number of stat values filled into the array. When size < the number of available stats, return the number of stats values, and do not fill in any data into xstats_names.

Definition at line 421 of file rte_eventdev_pmd.h.

eventdev_xstats_get_by_name

typedef uint64_t(* eventdev_xstats_get_by_name) (const struct rte_eventdev *dev, const char *name, unsigned int *id)

Get value of one stats and optionally return its id

Parameters

dev	Event device pointer
name	The name of the stat to retrieve
id	Pointer to an unsigned int where we store the stat-id for future reference. This pointer may be null if the id is not required.

Returns

The value of the stat, or (uint64_t)-1 if the stat is not found. If the stat is not found, the id value will be returned as (unsigned)-1, if id pointer is non-NULL

Definition at line 441 of file rte_eventdev_pmd.h.

eventdev_eth_rx_adapter_caps_get_t

typedef int(* eventdev_eth_rx_adapter_caps_get_t) (const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev, uint32_t *caps)

Retrieve the event device's ethdev Rx adapter capabilities for the specified ethernet port

Parameters

	dev	Event device pointer
	eth_dev	Ethernet device pointer
[out]	caps	A pointer to memory filled with Rx event adapter capabilities.

Returns

• 0: Success, driver provides Rx event adapter capabilities for the ethernet device.
• <0: Error code returned by the driver function.

Definition at line 465 of file rte_eventdev_pmd.h.

eventdev_timer_adapter_caps_get_t

typedef int(* eventdev_timer_adapter_caps_get_t) (const struct rte_eventdev *dev, uint64_t flags, uint32_t *caps, const struct rte_event_timer_adapter_ops **ops)

Retrieve the event device's timer adapter capabilities, as well as the ops structure that an event timer adapter should call through to enter the driver

Parameters

	dev	Event device pointer
	flags	Flags that can be used to determine how to select an event timer adapter ops structure
[out]	caps	A pointer to memory filled with Rx event adapter capabilities.
[out]	ops	A pointer to the ops pointer to set with the address of the desired ops structure

Returns

• 0: Success, driver provides Rx event adapter capabilities for the ethernet device.
• <0: Error code returned by the driver function.

Definition at line 496 of file rte_eventdev_pmd.h.

eventdev_eth_rx_adapter_queue_add_t

typedef int(* eventdev_eth_rx_adapter_queue_add_t) (const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev, int32_t rx_queue_id, const struct rte_event_eth_rx_adapter_queue_conf *queue_conf)

Add ethernet Rx queues to event device. This callback is invoked if the caps returned from rte_eventdev_eth_rx_adapter_caps_get(, eth_port_id) has RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT set.

Parameters

dev	Event device pointer
eth_dev	Ethernet device pointer
rx_queue_id	Ethernet device receive queue index
queue_conf	Additional configuration structure

Returns

• 0: Success, ethernet receive queue added successfully.
• <0: Error code returned by the driver function.

Definition at line 524 of file rte_eventdev_pmd.h.

eventdev_eth_rx_adapter_queue_del_t

typedef int(* eventdev_eth_rx_adapter_queue_del_t) (const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev, int32_t rx_queue_id)

Delete ethernet Rx queues from event device. This callback is invoked if the caps returned from eventdev_eth_rx_adapter_caps_get(, eth_port_id) has RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT set.

Parameters

dev	Event device pointer
eth_dev	Ethernet device pointer
rx_queue_id	Ethernet device receive queue index

Returns

• 0: Success, ethernet receive queue deleted successfully.
• <0: Error code returned by the driver function.

Definition at line 550 of file rte_eventdev_pmd.h.

eventdev_eth_rx_adapter_start_t

typedef int(* eventdev_eth_rx_adapter_start_t) (const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev)

Start ethernet Rx adapter. This callback is invoked if the caps returned from eventdev_eth_rx_adapter_caps_get(.., eth_port_id) has RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT set and Rx queues from eth_port_id have been added to the event device.

Parameters

dev	Event device pointer
eth_dev	Ethernet device pointer

Returns

• 0: Success, ethernet Rx adapter started successfully.
• <0: Error code returned by the driver function.

Definition at line 571 of file rte_eventdev_pmd.h.

eventdev_eth_rx_adapter_stop_t

typedef int(* eventdev_eth_rx_adapter_stop_t) (const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev)

Stop ethernet Rx adapter. This callback is invoked if the caps returned from eventdev_eth_rx_adapter_caps_get(..,eth_port_id) has RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT set and Rx queues from eth_port_id have been added to the event device.

Parameters

dev	Event device pointer
eth_dev	Ethernet device pointer

Returns

• 0: Success, ethernet Rx adapter stopped successfully.
• <0: Error code returned by the driver function.

Definition at line 591 of file rte_eventdev_pmd.h.

eventdev_eth_rx_adapter_stats_get

typedef int(* eventdev_eth_rx_adapter_stats_get) (const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev, struct rte_event_eth_rx_adapter_stats *stats)

Retrieve ethernet Rx adapter statistics.

Parameters

	dev	Event device pointer
	eth_dev	Ethernet device pointer
[out]	stats	Pointer to stats structure

Returns

Return 0 on success.

Definition at line 613 of file rte_eventdev_pmd.h.

eventdev_eth_rx_adapter_stats_reset

typedef int(* eventdev_eth_rx_adapter_stats_reset) (const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev)

Reset ethernet Rx adapter statistics.

Parameters

dev	Event device pointer
eth_dev	Ethernet device pointer

Returns

Return 0 on success.

Definition at line 629 of file rte_eventdev_pmd.h.

eventdev_selftest

typedef int(* eventdev_selftest) (void)

Start eventdev selftest.

Returns

Return 0 on success.

Definition at line 637 of file rte_eventdev_pmd.h.

eventdev_crypto_adapter_caps_get_t

typedef int(* eventdev_crypto_adapter_caps_get_t) (const struct rte_eventdev *dev, const struct rte_cryptodev *cdev, uint32_t *caps)

This API may change without prior notice

Retrieve the event device's crypto adapter capabilities for the specified cryptodev

Parameters

	dev	Event device pointer
	cdev	cryptodev pointer
[out]	caps	A pointer to memory filled with event adapter capabilities. It is expected to be pre-allocated & initialized by caller.

Returns

• 0: Success, driver provides event adapter capabilities for the cryptodev.
• <0: Error code returned by the driver function.

Definition at line 665 of file rte_eventdev_pmd.h.

eventdev_crypto_adapter_queue_pair_add_t

typedef int(* eventdev_crypto_adapter_queue_pair_add_t) (const struct rte_eventdev *dev, const struct rte_cryptodev *cdev, int32_t queue_pair_id, const struct rte_event *event)

This API may change without prior notice

Add crypto queue pair to event device. This callback is invoked if the caps returned from rte_event_crypto_adapter_caps_get(, cdev_id) has RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_* set.

Parameters

dev	Event device pointer
cdev	cryptodev pointer
queue_pair_id	cryptodev queue pair identifier.
event	Event information required for binding cryptodev queue pair to event queue. This structure will have a valid value for only those HW PMDs supporting

See also

RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_QP_EV_BIND capability.

Returns

• 0: Success, cryptodev queue pair added successfully.
• <0: Error code returned by the driver function.

Definition at line 696 of file rte_eventdev_pmd.h.

eventdev_crypto_adapter_queue_pair_del_t

typedef int(* eventdev_crypto_adapter_queue_pair_del_t) (const struct rte_eventdev *dev, const struct rte_cryptodev *cdev, int32_t queue_pair_id)

This API may change without prior notice

Delete crypto queue pair to event device. This callback is invoked if the caps returned from rte_event_crypto_adapter_caps_get(, cdev_id) has RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_* set.

Parameters

dev	Event device pointer
cdev	cryptodev pointer
queue_pair_id	cryptodev queue pair identifier.

Returns

• 0: Success, cryptodev queue pair deleted successfully.
• <0: Error code returned by the driver function.

Definition at line 724 of file rte_eventdev_pmd.h.

eventdev_crypto_adapter_start_t

typedef int(* eventdev_crypto_adapter_start_t) (const struct rte_eventdev *dev, const struct rte_cryptodev *cdev)

Start crypto adapter. This callback is invoked if the caps returned from rte_event_crypto_adapter_caps_get(.., cdev_id) has RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_* set and queue pairs from cdev_id have been added to the event device.

Parameters

dev	Event device pointer
cdev	Crypto device pointer

Returns

• 0: Success, crypto adapter started successfully.
• <0: Error code returned by the driver function.

Definition at line 745 of file rte_eventdev_pmd.h.

eventdev_crypto_adapter_stop_t

typedef int(* eventdev_crypto_adapter_stop_t) (const struct rte_eventdev *dev, const struct rte_cryptodev *cdev)

Stop crypto adapter. This callback is invoked if the caps returned from rte_event_crypto_adapter_caps_get(.., cdev_id) has RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_* set and queue pairs from cdev_id have been added to the event device.

Parameters

dev	Event device pointer
cdev	Crypto device pointer

Returns

• 0: Success, crypto adapter stopped successfully.
• <0: Error code returned by the driver function.

Definition at line 765 of file rte_eventdev_pmd.h.

eventdev_crypto_adapter_stats_get

typedef int(* eventdev_crypto_adapter_stats_get) (const struct rte_eventdev *dev, const struct rte_cryptodev *cdev, struct rte_event_crypto_adapter_stats *stats)

Retrieve crypto adapter statistics.

Parameters

	dev	Event device pointer
	cdev	Crypto device pointer
[out]	stats	Pointer to stats structure

Returns

Return 0 on success.

Definition at line 787 of file rte_eventdev_pmd.h.

eventdev_crypto_adapter_stats_reset

typedef int(* eventdev_crypto_adapter_stats_reset) (const struct rte_eventdev *dev, const struct rte_cryptodev *cdev)

Reset crypto adapter statistics.

Parameters

dev	Event device pointer
cdev	Crypto device pointer

Returns

Return 0 on success.

Definition at line 805 of file rte_eventdev_pmd.h.

eventdev_eth_tx_adapter_caps_get_t

typedef int(* eventdev_eth_tx_adapter_caps_get_t) (const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev, uint32_t *caps)

Retrieve the event device's eth Tx adapter capabilities.

Parameters

	dev	Event device pointer
	eth_dev	Ethernet device pointer
[out]	caps	A pointer to memory filled with eth Tx adapter capabilities.

Returns

• 0: Success, driver provides eth Tx adapter capabilities
• <0: Error code returned by the driver function.

Definition at line 826 of file rte_eventdev_pmd.h.

eventdev_eth_tx_adapter_create_t

typedef int(* eventdev_eth_tx_adapter_create_t) (uint8_t id, const struct rte_eventdev *dev)

Create adapter callback.

Parameters

id	Adapter identifier
dev	Event device pointer

Returns

• 0: Success.
• <0: Error code on failure.

Definition at line 843 of file rte_eventdev_pmd.h.

eventdev_eth_tx_adapter_free_t

typedef int(* eventdev_eth_tx_adapter_free_t) (uint8_t id, const struct rte_eventdev *dev)

Free adapter callback.

Parameters

id	Adapter identifier
dev	Event device pointer

Returns

• 0: Success.
• <0: Error code on failure.

Definition at line 859 of file rte_eventdev_pmd.h.

eventdev_eth_tx_adapter_queue_add_t

typedef int(* eventdev_eth_tx_adapter_queue_add_t) (uint8_t id, const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev, int32_t tx_queue_id)

Add a Tx queue to the adapter. A queue value of -1 is used to indicate all queues within the device.

Parameters

id	Adapter identifier
dev	Event device pointer
eth_dev	Ethernet device pointer
tx_queue_id	Transmit queue index

Returns

• 0: Success.
• <0: Error code on failure.

Definition at line 883 of file rte_eventdev_pmd.h.

eventdev_eth_tx_adapter_queue_del_t

typedef int(* eventdev_eth_tx_adapter_queue_del_t) (uint8_t id, const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev, int32_t tx_queue_id)

Delete a Tx queue from the adapter. A queue value of -1 is used to indicate all queues within the device, that have been added to this adapter.

Parameters

id	Adapter identifier
dev	Event device pointer
eth_dev	Ethernet device pointer
tx_queue_id	Transmit queue index

Returns

• 0: Success, Queues deleted successfully.
• <0: Error code on failure.

Definition at line 911 of file rte_eventdev_pmd.h.

eventdev_eth_tx_adapter_start_t

typedef int(* eventdev_eth_tx_adapter_start_t) (uint8_t id, const struct rte_eventdev *dev)

Start the adapter.

Parameters

id	Adapter identifier
dev	Event device pointer

Returns

• 0: Success, Adapter started correctly.
• <0: Error code on failure.

Definition at line 930 of file rte_eventdev_pmd.h.

eventdev_eth_tx_adapter_stop_t

typedef int(* eventdev_eth_tx_adapter_stop_t) (uint8_t id, const struct rte_eventdev *dev)

Stop the adapter.

Parameters

id	Adapter identifier
dev	Event device pointer

Returns

• 0: Success.
• <0: Error code on failure.

Definition at line 946 of file rte_eventdev_pmd.h.

eventdev_eth_tx_adapter_stats_get_t

typedef int(* eventdev_eth_tx_adapter_stats_get_t) (uint8_t id, const struct rte_eventdev *dev, struct rte_event_eth_tx_adapter_stats *stats)

Retrieve statistics for an adapter

Parameters

	id	Adapter identifier
	dev	Event device pointer
[out]	stats	A pointer to structure used to retrieve statistics for an adapter

Returns

• 0: Success, statistics retrieved successfully.
• <0: Error code on failure.

Definition at line 967 of file rte_eventdev_pmd.h.

eventdev_eth_tx_adapter_stats_reset_t

typedef int(* eventdev_eth_tx_adapter_stats_reset_t) (uint8_t id, const struct rte_eventdev *dev)

Reset statistics for an adapter

Parameters

id	Adapter identifier
dev	Event device pointer

Returns

• 0: Success, statistics retrieved successfully.
• <0: Error code on failure.

Definition at line 985 of file rte_eventdev_pmd.h.

Function Documentation

rte_event_pmd_get_named_dev()

static struct rte_eventdev* rte_event_pmd_get_named_dev ( const char *  name )

static

The pool of rte_eventdev structures. Get the rte_eventdev structure device pointer for the named device.

Parameters

name	device name to select the device structure.

Returns

• The rte_eventdev structure pointer for the given device ID.

Definition at line 107 of file rte_eventdev_pmd.h.

rte_event_pmd_is_valid_dev()

static unsigned rte_event_pmd_is_valid_dev ( uint8_t  dev_id )

inlinestatic

Validate if the event device index is valid attached event device.

Parameters

dev_id

Event device index.

Returns

• If the device index is valid (1) or not (0).

Definition at line 135 of file rte_eventdev_pmd.h.

rte_event_pmd_allocate()

struct rte_eventdev* rte_event_pmd_allocate	(	const char *	name,
		int	socket_id
	)

Allocates a new eventdev slot for an event device and returns the pointer to that slot for the driver to use.

Parameters

name	Unique identifier name for each device
socket_id	Socket to allocate resources on.

Returns

• Slot in the rte_dev_devices array for a new device;

rte_event_pmd_release()

int rte_event_pmd_release

(

struct rte_eventdev *

eventdev

)

Release the specified eventdev device.

Parameters

eventdev

The eventdev pointer is the address of the rte_eventdev structure.

Returns

• 0 on success, negative on error