#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"

Data Structures
struct	rte_eventdev_global
struct	rte_eventdev_ops

Macros
#define	RTE_EVENT_ETH_RX_ADAPTER_SW_CAP

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_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_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)

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)

Variables
struct rte_eventdev *	rte_eventdevs

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

#define RTE_EVENT_ETH_RX_ADAPTER_SW_CAP

Value:

((RTE_EVENT_ETH_RX_ADAPTER_CAP_OVERRIDE_FLOW_ID) | \

(RTE_EVENT_ETH_RX_ADAPTER_CAP_MULTI_EVENTQ))

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

Definition at line 68 of file rte_eventdev_pmd.h.

Typedef Documentation

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 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

Returns: Returns 0 on success

Definition at line 160 of file rte_eventdev_pmd.h.

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 172 of file rte_eventdev_pmd.h.

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 183 of file rte_eventdev_pmd.h.

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

Stop a configured device.

Parameters

dev	Event device pointer

Definition at line 191 of file rte_eventdev_pmd.h.

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 203 of file rte_eventdev_pmd.h.

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 216 of file rte_eventdev_pmd.h.

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 232 of file rte_eventdev_pmd.h.

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 245 of file rte_eventdev_pmd.h.

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 259 of file rte_eventdev_pmd.h.

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 275 of file rte_eventdev_pmd.h.

typedef void(* eventdev_port_release_t)(void *port)

Release memory resources allocated by given event port.

Parameters

port	Event port pointer

Definition at line 286 of file rte_eventdev_pmd.h.

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 308 of file rte_eventdev_pmd.h.

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 328 of file rte_eventdev_pmd.h.

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 345 of file rte_eventdev_pmd.h.

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 357 of file rte_eventdev_pmd.h.

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 373 of file rte_eventdev_pmd.h.

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 380 of file rte_eventdev_pmd.h.

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 401 of file rte_eventdev_pmd.h.

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 421 of file rte_eventdev_pmd.h.

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 445 of file rte_eventdev_pmd.h.

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 473 of file rte_eventdev_pmd.h.

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 499 of file rte_eventdev_pmd.h.

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 520 of file rte_eventdev_pmd.h.

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 540 of file rte_eventdev_pmd.h.

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 562 of file rte_eventdev_pmd.h.

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 578 of file rte_eventdev_pmd.h.

typedef int(* eventdev_selftest)(void)

Start eventdev selftest.

Returns: Return 0 on success.

Definition at line 586 of file rte_eventdev_pmd.h.

Function Documentation

static struct rte_eventdev* rte_event_pmd_get_named_dev ( const char * name )

staticread

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 101 of file rte_eventdev_pmd.h.

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 129 of file rte_eventdev_pmd.h.

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

read

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;

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

Variable Documentation

struct rte_eventdev* rte_eventdevs

Pointer to global event devices data structure.

Data Structures

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

Typedef Documentation

Function Documentation

Variable Documentation