xref: /dpdk/lib/eventdev/eventdev_pmd.h (revision d007a7f39de3f17071acdefcd48b49e07306040f)
199a2dd95SBruce Richardson /* SPDX-License-Identifier: BSD-3-Clause
299a2dd95SBruce Richardson  * Copyright(c) 2016 Cavium, Inc
399a2dd95SBruce Richardson  */
499a2dd95SBruce Richardson 
599a2dd95SBruce Richardson #ifndef _RTE_EVENTDEV_PMD_H_
699a2dd95SBruce Richardson #define _RTE_EVENTDEV_PMD_H_
799a2dd95SBruce Richardson 
82c552933SBrian Dooley #ifdef __cplusplus
92c552933SBrian Dooley extern "C" {
102c552933SBrian Dooley #endif
112c552933SBrian Dooley 
1299a2dd95SBruce Richardson /** @file
1399a2dd95SBruce Richardson  * RTE Event PMD APIs
1499a2dd95SBruce Richardson  *
1599a2dd95SBruce Richardson  * @note
1699a2dd95SBruce Richardson  * These API are from event PMD only and user applications should not call
1799a2dd95SBruce Richardson  * them directly.
1899a2dd95SBruce Richardson  */
1999a2dd95SBruce Richardson 
2099a2dd95SBruce Richardson #include <string.h>
2199a2dd95SBruce Richardson 
2299a2dd95SBruce Richardson #include <rte_common.h>
2399a2dd95SBruce Richardson #include <rte_compat.h>
2499a2dd95SBruce Richardson #include <rte_config.h>
251acb7f54SDavid Marchand #include <dev_driver.h>
2699a2dd95SBruce Richardson #include <rte_log.h>
2799a2dd95SBruce Richardson #include <rte_malloc.h>
2899a2dd95SBruce Richardson #include <rte_mbuf.h>
2999a2dd95SBruce Richardson #include <rte_mbuf_dyn.h>
3099a2dd95SBruce Richardson 
3153548ad3SPavan Nikhilesh #include "event_timer_adapter_pmd.h"
3299a2dd95SBruce Richardson #include "rte_eventdev.h"
3399a2dd95SBruce Richardson 
3499a2dd95SBruce Richardson /* Logging Macros */
3599a2dd95SBruce Richardson #define RTE_EDEV_LOG_ERR(...) \
3699a2dd95SBruce Richardson 	RTE_LOG(ERR, EVENTDEV, \
3799a2dd95SBruce Richardson 		RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
3899a2dd95SBruce Richardson 			__func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
3999a2dd95SBruce Richardson 
4099a2dd95SBruce Richardson #ifdef RTE_LIBRTE_EVENTDEV_DEBUG
4199a2dd95SBruce Richardson #define RTE_EDEV_LOG_DEBUG(...) \
4299a2dd95SBruce Richardson 	RTE_LOG(DEBUG, EVENTDEV, \
4399a2dd95SBruce Richardson 		RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
4499a2dd95SBruce Richardson 			__func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
4599a2dd95SBruce Richardson #else
4699a2dd95SBruce Richardson #define RTE_EDEV_LOG_DEBUG(...) (void)0
4799a2dd95SBruce Richardson #endif
4899a2dd95SBruce Richardson 
4999a2dd95SBruce Richardson /* Macros to check for valid device */
5099a2dd95SBruce Richardson #define RTE_EVENTDEV_VALID_DEVID_OR_ERR_RET(dev_id, retval) do { \
5199a2dd95SBruce Richardson 	if (!rte_event_pmd_is_valid_dev((dev_id))) { \
5299a2dd95SBruce Richardson 		RTE_EDEV_LOG_ERR("Invalid dev_id=%d\n", dev_id); \
5399a2dd95SBruce Richardson 		return retval; \
5499a2dd95SBruce Richardson 	} \
5599a2dd95SBruce Richardson } while (0)
5699a2dd95SBruce Richardson 
5799a2dd95SBruce Richardson #define RTE_EVENTDEV_VALID_DEVID_OR_ERRNO_RET(dev_id, errno, retval) do { \
5899a2dd95SBruce Richardson 	if (!rte_event_pmd_is_valid_dev((dev_id))) { \
5999a2dd95SBruce Richardson 		RTE_EDEV_LOG_ERR("Invalid dev_id=%d\n", dev_id); \
6099a2dd95SBruce Richardson 		rte_errno = errno; \
6199a2dd95SBruce Richardson 		return retval; \
6299a2dd95SBruce Richardson 	} \
6399a2dd95SBruce Richardson } while (0)
6499a2dd95SBruce Richardson 
6599a2dd95SBruce Richardson #define RTE_EVENTDEV_VALID_DEVID_OR_RET(dev_id) do { \
6699a2dd95SBruce Richardson 	if (!rte_event_pmd_is_valid_dev((dev_id))) { \
6799a2dd95SBruce Richardson 		RTE_EDEV_LOG_ERR("Invalid dev_id=%d\n", dev_id); \
6899a2dd95SBruce Richardson 		return; \
6999a2dd95SBruce Richardson 	} \
7099a2dd95SBruce Richardson } while (0)
7199a2dd95SBruce Richardson 
7299a2dd95SBruce Richardson #define RTE_EVENT_ETH_RX_ADAPTER_SW_CAP                                        \
7399a2dd95SBruce Richardson 	((RTE_EVENT_ETH_RX_ADAPTER_CAP_OVERRIDE_FLOW_ID) |                     \
7499a2dd95SBruce Richardson 	 (RTE_EVENT_ETH_RX_ADAPTER_CAP_MULTI_EVENTQ) |                         \
7599a2dd95SBruce Richardson 	 (RTE_EVENT_ETH_RX_ADAPTER_CAP_EVENT_VECTOR))
7699a2dd95SBruce Richardson 
7799a2dd95SBruce Richardson #define RTE_EVENT_CRYPTO_ADAPTER_SW_CAP \
7899a2dd95SBruce Richardson 		RTE_EVENT_CRYPTO_ADAPTER_CAP_SESSION_PRIVATE_DATA
7999a2dd95SBruce Richardson 
8099a2dd95SBruce Richardson /**< Ethernet Rx adapter cap to return If the packet transfers from
8199a2dd95SBruce Richardson  * the ethdev to eventdev use a SW service function
8299a2dd95SBruce Richardson  */
8399a2dd95SBruce Richardson 
843d9d8adfSNaga Harish K S V #define RTE_EVENT_TIMER_ADAPTER_SW_CAP \
853d9d8adfSNaga Harish K S V 		RTE_EVENT_TIMER_ADAPTER_CAP_PERIODIC
863d9d8adfSNaga Harish K S V 
8799a2dd95SBruce Richardson #define RTE_EVENTDEV_DETACHED  (0)
8899a2dd95SBruce Richardson #define RTE_EVENTDEV_ATTACHED  (1)
8999a2dd95SBruce Richardson 
90295c053fSPavan Nikhilesh #define RTE_EVENTDEV_NAME_MAX_LEN (64)
91295c053fSPavan Nikhilesh /**< @internal Max length of name of event PMD */
92295c053fSPavan Nikhilesh 
9399a2dd95SBruce Richardson struct rte_eth_dev;
9499a2dd95SBruce Richardson 
9599a2dd95SBruce Richardson /** Global structure used for maintaining state of allocated event devices */
9699a2dd95SBruce Richardson struct rte_eventdev_global {
9799a2dd95SBruce Richardson 	uint8_t nb_devs;	/**< Number of devices found */
9899a2dd95SBruce Richardson };
9999a2dd95SBruce Richardson 
10099a2dd95SBruce Richardson /**
101295c053fSPavan Nikhilesh  * @internal
102295c053fSPavan Nikhilesh  * The data part, with no function pointers, associated with each device.
103295c053fSPavan Nikhilesh  *
104295c053fSPavan Nikhilesh  * This structure is safe to place in shared memory to be common among
105295c053fSPavan Nikhilesh  * different processes in a multi-process configuration.
106295c053fSPavan Nikhilesh  */
107295c053fSPavan Nikhilesh struct rte_eventdev_data {
108295c053fSPavan Nikhilesh 	int socket_id;
109295c053fSPavan Nikhilesh 	/**< Socket ID where memory is allocated */
110295c053fSPavan Nikhilesh 	uint8_t dev_id;
111295c053fSPavan Nikhilesh 	/**< Device ID for this instance */
112295c053fSPavan Nikhilesh 	uint8_t nb_queues;
113295c053fSPavan Nikhilesh 	/**< Number of event queues. */
114295c053fSPavan Nikhilesh 	uint8_t nb_ports;
115295c053fSPavan Nikhilesh 	/**< Number of event ports. */
116295c053fSPavan Nikhilesh 	void *ports[RTE_EVENT_MAX_PORTS_PER_DEV];
117295c053fSPavan Nikhilesh 	/**< Array of pointers to ports. */
118295c053fSPavan Nikhilesh 	struct rte_event_port_conf ports_cfg[RTE_EVENT_MAX_PORTS_PER_DEV];
119295c053fSPavan Nikhilesh 	/**< Array of port configuration structures. */
120295c053fSPavan Nikhilesh 	struct rte_event_queue_conf queues_cfg[RTE_EVENT_MAX_QUEUES_PER_DEV];
121295c053fSPavan Nikhilesh 	/**< Array of queue configuration structures. */
122*d007a7f3SPavan Nikhilesh 	uint16_t links_map[RTE_EVENT_MAX_PROFILES_PER_PORT]
123*d007a7f3SPavan Nikhilesh 			  [RTE_EVENT_MAX_PORTS_PER_DEV * RTE_EVENT_MAX_QUEUES_PER_DEV];
124295c053fSPavan Nikhilesh 	/**< Memory to store queues to port connections. */
125295c053fSPavan Nikhilesh 	void *dev_private;
126295c053fSPavan Nikhilesh 	/**< PMD-specific private data */
127295c053fSPavan Nikhilesh 	uint32_t event_dev_cap;
128295c053fSPavan Nikhilesh 	/**< Event device capabilities(RTE_EVENT_DEV_CAP_)*/
129295c053fSPavan Nikhilesh 	struct rte_event_dev_config dev_conf;
130295c053fSPavan Nikhilesh 	/**< Configuration applied to device. */
131295c053fSPavan Nikhilesh 	uint8_t service_inited;
132295c053fSPavan Nikhilesh 	/* Service initialization state */
133295c053fSPavan Nikhilesh 	uint32_t service_id;
134295c053fSPavan Nikhilesh 	/* Service ID*/
135295c053fSPavan Nikhilesh 	void *dev_stop_flush_arg;
136295c053fSPavan Nikhilesh 	/**< User-provided argument for event flush function */
137295c053fSPavan Nikhilesh 
138295c053fSPavan Nikhilesh 	uint8_t dev_started : 1;
139295c053fSPavan Nikhilesh 	/**< Device state: STARTED(1)/STOPPED(0) */
140295c053fSPavan Nikhilesh 
141295c053fSPavan Nikhilesh 	char name[RTE_EVENTDEV_NAME_MAX_LEN];
142295c053fSPavan Nikhilesh 	/**< Unique identifier name */
143295c053fSPavan Nikhilesh 
144295c053fSPavan Nikhilesh 	uint64_t reserved_64s[4]; /**< Reserved for future fields */
145295c053fSPavan Nikhilesh 	void *reserved_ptrs[4];	  /**< Reserved for future fields */
146295c053fSPavan Nikhilesh } __rte_cache_aligned;
147295c053fSPavan Nikhilesh 
148295c053fSPavan Nikhilesh /** @internal The data structure associated with each event device. */
149295c053fSPavan Nikhilesh struct rte_eventdev {
150295c053fSPavan Nikhilesh 	struct rte_eventdev_data *data;
151295c053fSPavan Nikhilesh 	/**< Pointer to device data */
152295c053fSPavan Nikhilesh 	struct eventdev_ops *dev_ops;
153295c053fSPavan Nikhilesh 	/**< Functions exported by PMD */
154295c053fSPavan Nikhilesh 	struct rte_device *dev;
155295c053fSPavan Nikhilesh 	/**< Device info. supplied by probing */
156295c053fSPavan Nikhilesh 
157295c053fSPavan Nikhilesh 	uint8_t attached : 1;
158295c053fSPavan Nikhilesh 	/**< Flag indicating the device is attached */
159295c053fSPavan Nikhilesh 
160295c053fSPavan Nikhilesh 	event_enqueue_t enqueue;
161295c053fSPavan Nikhilesh 	/**< Pointer to PMD enqueue function. */
162295c053fSPavan Nikhilesh 	event_enqueue_burst_t enqueue_burst;
163295c053fSPavan Nikhilesh 	/**< Pointer to PMD enqueue burst function. */
164295c053fSPavan Nikhilesh 	event_enqueue_burst_t enqueue_new_burst;
165295c053fSPavan Nikhilesh 	/**< Pointer to PMD enqueue burst function(op new variant) */
166295c053fSPavan Nikhilesh 	event_enqueue_burst_t enqueue_forward_burst;
167295c053fSPavan Nikhilesh 	/**< Pointer to PMD enqueue burst function(op forward variant) */
168295c053fSPavan Nikhilesh 	event_dequeue_t dequeue;
169295c053fSPavan Nikhilesh 	/**< Pointer to PMD dequeue function. */
170295c053fSPavan Nikhilesh 	event_dequeue_burst_t dequeue_burst;
171295c053fSPavan Nikhilesh 	/**< Pointer to PMD dequeue burst function. */
17254f17843SMattias Rönnblom 	event_maintain_t maintain;
17354f17843SMattias Rönnblom 	/**< Pointer to PMD port maintenance function. */
174295c053fSPavan Nikhilesh 	event_tx_adapter_enqueue_t txa_enqueue_same_dest;
175295c053fSPavan Nikhilesh 	/**< Pointer to PMD eth Tx adapter burst enqueue function with
176295c053fSPavan Nikhilesh 	 * events destined to same Eth port & Tx queue.
177295c053fSPavan Nikhilesh 	 */
178295c053fSPavan Nikhilesh 	event_tx_adapter_enqueue_t txa_enqueue;
179295c053fSPavan Nikhilesh 	/**< Pointer to PMD eth Tx adapter enqueue function. */
180295c053fSPavan Nikhilesh 	event_crypto_adapter_enqueue_t ca_enqueue;
18166a30a29SAmit Prakash Shukla 	/**< Pointer to PMD crypto adapter enqueue function. */
18266a30a29SAmit Prakash Shukla 	event_dma_adapter_enqueue_t dma_enqueue;
18366a30a29SAmit Prakash Shukla 	/**< Pointer to PMD DMA adapter enqueue function. */
184*d007a7f3SPavan Nikhilesh 	event_profile_switch_t profile_switch;
185*d007a7f3SPavan Nikhilesh 	/**< Pointer to PMD Event switch profile function. */
18666a30a29SAmit Prakash Shukla 
18766a30a29SAmit Prakash Shukla 	uint64_t reserved_64s[3]; /**< Reserved for future fields */
188295c053fSPavan Nikhilesh 	void *reserved_ptrs[3];	  /**< Reserved for future fields */
189295c053fSPavan Nikhilesh } __rte_cache_aligned;
190295c053fSPavan Nikhilesh 
191295c053fSPavan Nikhilesh extern struct rte_eventdev *rte_eventdevs;
192295c053fSPavan Nikhilesh /** @internal The pool of rte_eventdev structures. */
193295c053fSPavan Nikhilesh 
194295c053fSPavan Nikhilesh /**
19599a2dd95SBruce Richardson  * Get the rte_eventdev structure device pointer for the named device.
19699a2dd95SBruce Richardson  *
19799a2dd95SBruce Richardson  * @param name
19899a2dd95SBruce Richardson  *   device name to select the device structure.
19999a2dd95SBruce Richardson  *
20099a2dd95SBruce Richardson  * @return
20199a2dd95SBruce Richardson  *   - The rte_eventdev structure pointer for the given device ID.
20299a2dd95SBruce Richardson  */
20323d06e37SPavan Nikhilesh __rte_internal
20499a2dd95SBruce Richardson static inline struct rte_eventdev *
20599a2dd95SBruce Richardson rte_event_pmd_get_named_dev(const char *name)
20699a2dd95SBruce Richardson {
20799a2dd95SBruce Richardson 	struct rte_eventdev *dev;
20899a2dd95SBruce Richardson 	unsigned int i;
20999a2dd95SBruce Richardson 
21099a2dd95SBruce Richardson 	if (name == NULL)
21199a2dd95SBruce Richardson 		return NULL;
21299a2dd95SBruce Richardson 
21399a2dd95SBruce Richardson 	for (i = 0; i < RTE_EVENT_MAX_DEVS; i++) {
21499a2dd95SBruce Richardson 		dev = &rte_eventdevs[i];
21599a2dd95SBruce Richardson 		if ((dev->attached == RTE_EVENTDEV_ATTACHED) &&
21699a2dd95SBruce Richardson 				(strcmp(dev->data->name, name) == 0))
21799a2dd95SBruce Richardson 			return dev;
21899a2dd95SBruce Richardson 	}
21999a2dd95SBruce Richardson 
22099a2dd95SBruce Richardson 	return NULL;
22199a2dd95SBruce Richardson }
22299a2dd95SBruce Richardson 
22399a2dd95SBruce Richardson /**
22499a2dd95SBruce Richardson  * Validate if the event device index is valid attached event device.
22599a2dd95SBruce Richardson  *
22699a2dd95SBruce Richardson  * @param dev_id
22799a2dd95SBruce Richardson  *   Event device index.
22899a2dd95SBruce Richardson  *
22999a2dd95SBruce Richardson  * @return
23099a2dd95SBruce Richardson  *   - If the device index is valid (1) or not (0).
23199a2dd95SBruce Richardson  */
23223d06e37SPavan Nikhilesh __rte_internal
23399a2dd95SBruce Richardson static inline unsigned
23499a2dd95SBruce Richardson rte_event_pmd_is_valid_dev(uint8_t dev_id)
23599a2dd95SBruce Richardson {
23699a2dd95SBruce Richardson 	struct rte_eventdev *dev;
23799a2dd95SBruce Richardson 
23899a2dd95SBruce Richardson 	if (dev_id >= RTE_EVENT_MAX_DEVS)
23999a2dd95SBruce Richardson 		return 0;
24099a2dd95SBruce Richardson 
24199a2dd95SBruce Richardson 	dev = &rte_eventdevs[dev_id];
24299a2dd95SBruce Richardson 	if (dev->attached != RTE_EVENTDEV_ATTACHED)
24399a2dd95SBruce Richardson 		return 0;
24499a2dd95SBruce Richardson 	else
24599a2dd95SBruce Richardson 		return 1;
24699a2dd95SBruce Richardson }
24799a2dd95SBruce Richardson 
24899a2dd95SBruce Richardson /**
24999a2dd95SBruce Richardson  * Definitions of all functions exported by a driver through the
250b53d106dSSean Morrissey  * generic structure of type *event_dev_ops* supplied in the
25199a2dd95SBruce Richardson  * *rte_eventdev* structure associated with a device.
25299a2dd95SBruce Richardson  */
25399a2dd95SBruce Richardson 
25499a2dd95SBruce Richardson /**
25599a2dd95SBruce Richardson  * Get device information of a device.
25699a2dd95SBruce Richardson  *
25799a2dd95SBruce Richardson  * @param dev
25899a2dd95SBruce Richardson  *   Event device pointer
25999a2dd95SBruce Richardson  * @param dev_info
26099a2dd95SBruce Richardson  *   Event device information structure
26199a2dd95SBruce Richardson  */
26299a2dd95SBruce Richardson typedef void (*eventdev_info_get_t)(struct rte_eventdev *dev,
26399a2dd95SBruce Richardson 		struct rte_event_dev_info *dev_info);
26499a2dd95SBruce Richardson 
26599a2dd95SBruce Richardson /**
26699a2dd95SBruce Richardson  * Configure a device.
26799a2dd95SBruce Richardson  *
26899a2dd95SBruce Richardson  * @param dev
26999a2dd95SBruce Richardson  *   Event device pointer
27099a2dd95SBruce Richardson  *
27199a2dd95SBruce Richardson  * @return
27299a2dd95SBruce Richardson  *   Returns 0 on success
27399a2dd95SBruce Richardson  */
27499a2dd95SBruce Richardson typedef int (*eventdev_configure_t)(const struct rte_eventdev *dev);
27599a2dd95SBruce Richardson 
27699a2dd95SBruce Richardson /**
27799a2dd95SBruce Richardson  * Start a configured device.
27899a2dd95SBruce Richardson  *
27999a2dd95SBruce Richardson  * @param dev
28099a2dd95SBruce Richardson  *   Event device pointer
28199a2dd95SBruce Richardson  *
28299a2dd95SBruce Richardson  * @return
28399a2dd95SBruce Richardson  *   Returns 0 on success
28499a2dd95SBruce Richardson  */
28599a2dd95SBruce Richardson typedef int (*eventdev_start_t)(struct rte_eventdev *dev);
28699a2dd95SBruce Richardson 
28799a2dd95SBruce Richardson /**
28899a2dd95SBruce Richardson  * Stop a configured device.
28999a2dd95SBruce Richardson  *
29099a2dd95SBruce Richardson  * @param dev
29199a2dd95SBruce Richardson  *   Event device pointer
29299a2dd95SBruce Richardson  */
29399a2dd95SBruce Richardson typedef void (*eventdev_stop_t)(struct rte_eventdev *dev);
29499a2dd95SBruce Richardson 
29599a2dd95SBruce Richardson /**
29699a2dd95SBruce Richardson  * Close a configured device.
29799a2dd95SBruce Richardson  *
29899a2dd95SBruce Richardson  * @param dev
29999a2dd95SBruce Richardson  *   Event device pointer
30099a2dd95SBruce Richardson  *
30199a2dd95SBruce Richardson  * @return
30299a2dd95SBruce Richardson  * - 0 on success
30399a2dd95SBruce Richardson  * - (-EAGAIN) if can't close as device is busy
30499a2dd95SBruce Richardson  */
30599a2dd95SBruce Richardson typedef int (*eventdev_close_t)(struct rte_eventdev *dev);
30699a2dd95SBruce Richardson 
30799a2dd95SBruce Richardson /**
30899a2dd95SBruce Richardson  * Retrieve the default event queue configuration.
30999a2dd95SBruce Richardson  *
31099a2dd95SBruce Richardson  * @param dev
31199a2dd95SBruce Richardson  *   Event device pointer
31299a2dd95SBruce Richardson  * @param queue_id
31399a2dd95SBruce Richardson  *   Event queue index
31499a2dd95SBruce Richardson  * @param[out] queue_conf
31599a2dd95SBruce Richardson  *   Event queue configuration structure
31699a2dd95SBruce Richardson  */
31799a2dd95SBruce Richardson typedef void (*eventdev_queue_default_conf_get_t)(struct rte_eventdev *dev,
31899a2dd95SBruce Richardson 		uint8_t queue_id, struct rte_event_queue_conf *queue_conf);
31999a2dd95SBruce Richardson 
32099a2dd95SBruce Richardson /**
32199a2dd95SBruce Richardson  * Setup an event queue.
32299a2dd95SBruce Richardson  *
32399a2dd95SBruce Richardson  * @param dev
32499a2dd95SBruce Richardson  *   Event device pointer
32599a2dd95SBruce Richardson  * @param queue_id
32699a2dd95SBruce Richardson  *   Event queue index
32799a2dd95SBruce Richardson  * @param queue_conf
32899a2dd95SBruce Richardson  *   Event queue configuration structure
32999a2dd95SBruce Richardson  *
33099a2dd95SBruce Richardson  * @return
33199a2dd95SBruce Richardson  *   Returns 0 on success.
33299a2dd95SBruce Richardson  */
33399a2dd95SBruce Richardson typedef int (*eventdev_queue_setup_t)(struct rte_eventdev *dev,
33499a2dd95SBruce Richardson 		uint8_t queue_id,
33599a2dd95SBruce Richardson 		const struct rte_event_queue_conf *queue_conf);
33699a2dd95SBruce Richardson 
33799a2dd95SBruce Richardson /**
33899a2dd95SBruce Richardson  * Release resources allocated by given event queue.
33999a2dd95SBruce Richardson  *
34099a2dd95SBruce Richardson  * @param dev
34199a2dd95SBruce Richardson  *   Event device pointer
34299a2dd95SBruce Richardson  * @param queue_id
34399a2dd95SBruce Richardson  *   Event queue index
34499a2dd95SBruce Richardson  */
34599a2dd95SBruce Richardson typedef void (*eventdev_queue_release_t)(struct rte_eventdev *dev,
34699a2dd95SBruce Richardson 		uint8_t queue_id);
34799a2dd95SBruce Richardson 
34899a2dd95SBruce Richardson /**
34997b914f4SShijith Thotton  * Set an event queue attribute at runtime.
35097b914f4SShijith Thotton  *
35197b914f4SShijith Thotton  * @param dev
35297b914f4SShijith Thotton  *   Event device pointer
35397b914f4SShijith Thotton  * @param queue_id
35497b914f4SShijith Thotton  *   Event queue index
35597b914f4SShijith Thotton  * @param attr_id
35697b914f4SShijith Thotton  *   Event queue attribute id
35797b914f4SShijith Thotton  * @param attr_value
35897b914f4SShijith Thotton  *   Event queue attribute value
35997b914f4SShijith Thotton  *
36097b914f4SShijith Thotton  * @return
36197b914f4SShijith Thotton  *  - 0: Success.
36297b914f4SShijith Thotton  *  - <0: Error code on failure.
36397b914f4SShijith Thotton  */
36497b914f4SShijith Thotton typedef int (*eventdev_queue_attr_set_t)(struct rte_eventdev *dev,
36597b914f4SShijith Thotton 					 uint8_t queue_id, uint32_t attr_id,
36697b914f4SShijith Thotton 					 uint64_t attr_value);
36797b914f4SShijith Thotton 
36897b914f4SShijith Thotton /**
36999a2dd95SBruce Richardson  * Retrieve the default event port configuration.
37099a2dd95SBruce Richardson  *
37199a2dd95SBruce Richardson  * @param dev
37299a2dd95SBruce Richardson  *   Event device pointer
37399a2dd95SBruce Richardson  * @param port_id
37499a2dd95SBruce Richardson  *   Event port index
37599a2dd95SBruce Richardson  * @param[out] port_conf
37699a2dd95SBruce Richardson  *   Event port configuration structure
37799a2dd95SBruce Richardson  */
37899a2dd95SBruce Richardson typedef void (*eventdev_port_default_conf_get_t)(struct rte_eventdev *dev,
37999a2dd95SBruce Richardson 		uint8_t port_id, struct rte_event_port_conf *port_conf);
38099a2dd95SBruce Richardson 
38199a2dd95SBruce Richardson /**
38299a2dd95SBruce Richardson  * Setup an event port.
38399a2dd95SBruce Richardson  *
38499a2dd95SBruce Richardson  * @param dev
38599a2dd95SBruce Richardson  *   Event device pointer
38699a2dd95SBruce Richardson  * @param port_id
38799a2dd95SBruce Richardson  *   Event port index
38899a2dd95SBruce Richardson  * @param port_conf
38999a2dd95SBruce Richardson  *   Event port configuration structure
39099a2dd95SBruce Richardson  *
39199a2dd95SBruce Richardson  * @return
39299a2dd95SBruce Richardson  *   Returns 0 on success.
39399a2dd95SBruce Richardson  */
39499a2dd95SBruce Richardson typedef int (*eventdev_port_setup_t)(struct rte_eventdev *dev,
39599a2dd95SBruce Richardson 		uint8_t port_id,
39699a2dd95SBruce Richardson 		const struct rte_event_port_conf *port_conf);
39799a2dd95SBruce Richardson 
39899a2dd95SBruce Richardson /**
39999a2dd95SBruce Richardson  * Release memory resources allocated by given event port.
40099a2dd95SBruce Richardson  *
40199a2dd95SBruce Richardson  * @param port
40299a2dd95SBruce Richardson  *   Event port pointer
40399a2dd95SBruce Richardson  */
40499a2dd95SBruce Richardson typedef void (*eventdev_port_release_t)(void *port);
40599a2dd95SBruce Richardson 
40699a2dd95SBruce Richardson /**
4071ff23ce6SPavan Nikhilesh  * Quiesce any core specific resources consumed by the event port
4081ff23ce6SPavan Nikhilesh  *
4091ff23ce6SPavan Nikhilesh  * @param dev
4101ff23ce6SPavan Nikhilesh  *   Event device pointer.
4111ff23ce6SPavan Nikhilesh  * @param port
4121ff23ce6SPavan Nikhilesh  *   Event port pointer.
4131ff23ce6SPavan Nikhilesh  * @param flush_cb
4141ff23ce6SPavan Nikhilesh  *   User-provided event flush function.
4151ff23ce6SPavan Nikhilesh  * @param args
4161ff23ce6SPavan Nikhilesh  *   Arguments to be passed to the user-provided event flush function.
4171ff23ce6SPavan Nikhilesh  */
4181ff23ce6SPavan Nikhilesh typedef void (*eventdev_port_quiesce_t)(struct rte_eventdev *dev, void *port,
4191ff23ce6SPavan Nikhilesh 					rte_eventdev_port_flush_t flush_cb,
4201ff23ce6SPavan Nikhilesh 					void *args);
4211ff23ce6SPavan Nikhilesh 
4221ff23ce6SPavan Nikhilesh /**
42399a2dd95SBruce Richardson  * Link multiple source event queues to destination event port.
42499a2dd95SBruce Richardson  *
42599a2dd95SBruce Richardson  * @param dev
42699a2dd95SBruce Richardson  *   Event device pointer
42799a2dd95SBruce Richardson  * @param port
42899a2dd95SBruce Richardson  *   Event port pointer
42999a2dd95SBruce Richardson  * @param queues
43099a2dd95SBruce Richardson  *   Points to an array of *nb_links* event queues to be linked
43199a2dd95SBruce Richardson  *   to the event port.
43299a2dd95SBruce Richardson  * @param priorities
43399a2dd95SBruce Richardson  *   Points to an array of *nb_links* service priorities associated with each
43499a2dd95SBruce Richardson  *   event queue link to event port.
43599a2dd95SBruce Richardson  * @param nb_links
43699a2dd95SBruce Richardson  *   The number of links to establish
43799a2dd95SBruce Richardson  *
43899a2dd95SBruce Richardson  * @return
43999a2dd95SBruce Richardson  *   Returns 0 on success.
44099a2dd95SBruce Richardson  */
44199a2dd95SBruce Richardson typedef int (*eventdev_port_link_t)(struct rte_eventdev *dev, void *port,
44299a2dd95SBruce Richardson 		const uint8_t queues[], const uint8_t priorities[],
44399a2dd95SBruce Richardson 		uint16_t nb_links);
44499a2dd95SBruce Richardson 
44599a2dd95SBruce Richardson /**
446*d007a7f3SPavan Nikhilesh  * Link multiple source event queues associated with a link profile to a
447*d007a7f3SPavan Nikhilesh  * destination event port.
448*d007a7f3SPavan Nikhilesh  *
449*d007a7f3SPavan Nikhilesh  * @param dev
450*d007a7f3SPavan Nikhilesh  *   Event device pointer
451*d007a7f3SPavan Nikhilesh  * @param port
452*d007a7f3SPavan Nikhilesh  *   Event port pointer
453*d007a7f3SPavan Nikhilesh  * @param queues
454*d007a7f3SPavan Nikhilesh  *   Points to an array of *nb_links* event queues to be linked
455*d007a7f3SPavan Nikhilesh  *   to the event port.
456*d007a7f3SPavan Nikhilesh  * @param priorities
457*d007a7f3SPavan Nikhilesh  *   Points to an array of *nb_links* service priorities associated with each
458*d007a7f3SPavan Nikhilesh  *   event queue link to event port.
459*d007a7f3SPavan Nikhilesh  * @param nb_links
460*d007a7f3SPavan Nikhilesh  *   The number of links to establish.
461*d007a7f3SPavan Nikhilesh  * @param profile_id
462*d007a7f3SPavan Nikhilesh  *   The profile ID to associate the links.
463*d007a7f3SPavan Nikhilesh  *
464*d007a7f3SPavan Nikhilesh  * @return
465*d007a7f3SPavan Nikhilesh  *   Returns 0 on success.
466*d007a7f3SPavan Nikhilesh  */
467*d007a7f3SPavan Nikhilesh typedef int (*eventdev_port_link_profile_t)(struct rte_eventdev *dev, void *port,
468*d007a7f3SPavan Nikhilesh 					    const uint8_t queues[], const uint8_t priorities[],
469*d007a7f3SPavan Nikhilesh 					    uint16_t nb_links, uint8_t profile_id);
470*d007a7f3SPavan Nikhilesh 
471*d007a7f3SPavan Nikhilesh /**
47299a2dd95SBruce Richardson  * Unlink multiple source event queues from destination event port.
47399a2dd95SBruce Richardson  *
47499a2dd95SBruce Richardson  * @param dev
47599a2dd95SBruce Richardson  *   Event device pointer
47699a2dd95SBruce Richardson  * @param port
47799a2dd95SBruce Richardson  *   Event port pointer
47899a2dd95SBruce Richardson  * @param queues
47999a2dd95SBruce Richardson  *   An array of *nb_unlinks* event queues to be unlinked from the event port.
48099a2dd95SBruce Richardson  * @param nb_unlinks
48199a2dd95SBruce Richardson  *   The number of unlinks to establish
48299a2dd95SBruce Richardson  *
48399a2dd95SBruce Richardson  * @return
48499a2dd95SBruce Richardson  *   Returns 0 on success.
48599a2dd95SBruce Richardson  */
48699a2dd95SBruce Richardson typedef int (*eventdev_port_unlink_t)(struct rte_eventdev *dev, void *port,
48799a2dd95SBruce Richardson 		uint8_t queues[], uint16_t nb_unlinks);
48899a2dd95SBruce Richardson 
48999a2dd95SBruce Richardson /**
490*d007a7f3SPavan Nikhilesh  * Unlink multiple source event queues associated with a link profile from
491*d007a7f3SPavan Nikhilesh  * destination event port.
492*d007a7f3SPavan Nikhilesh  *
493*d007a7f3SPavan Nikhilesh  * @param dev
494*d007a7f3SPavan Nikhilesh  *   Event device pointer
495*d007a7f3SPavan Nikhilesh  * @param port
496*d007a7f3SPavan Nikhilesh  *   Event port pointer
497*d007a7f3SPavan Nikhilesh  * @param queues
498*d007a7f3SPavan Nikhilesh  *   An array of *nb_unlinks* event queues to be unlinked from the event port.
499*d007a7f3SPavan Nikhilesh  * @param nb_unlinks
500*d007a7f3SPavan Nikhilesh  *   The number of unlinks to establish
501*d007a7f3SPavan Nikhilesh  * @param profile_id
502*d007a7f3SPavan Nikhilesh  *   The profile ID of the associated links.
503*d007a7f3SPavan Nikhilesh  *
504*d007a7f3SPavan Nikhilesh  * @return
505*d007a7f3SPavan Nikhilesh  *   Returns 0 on success.
506*d007a7f3SPavan Nikhilesh  */
507*d007a7f3SPavan Nikhilesh typedef int (*eventdev_port_unlink_profile_t)(struct rte_eventdev *dev, void *port,
508*d007a7f3SPavan Nikhilesh 					      uint8_t queues[], uint16_t nb_unlinks,
509*d007a7f3SPavan Nikhilesh 					      uint8_t profile_id);
510*d007a7f3SPavan Nikhilesh 
511*d007a7f3SPavan Nikhilesh /**
51299a2dd95SBruce Richardson  * Unlinks in progress. Returns number of unlinks that the PMD is currently
51399a2dd95SBruce Richardson  * performing, but have not yet been completed.
51499a2dd95SBruce Richardson  *
51599a2dd95SBruce Richardson  * @param dev
51699a2dd95SBruce Richardson  *   Event device pointer
51799a2dd95SBruce Richardson  *
51899a2dd95SBruce Richardson  * @param port
51999a2dd95SBruce Richardson  *   Event port pointer
52099a2dd95SBruce Richardson  *
52199a2dd95SBruce Richardson  * @return
52299a2dd95SBruce Richardson  *   Returns the number of in-progress unlinks. Zero is returned if none are
52399a2dd95SBruce Richardson  *   in progress.
52499a2dd95SBruce Richardson  */
52599a2dd95SBruce Richardson typedef int (*eventdev_port_unlinks_in_progress_t)(struct rte_eventdev *dev,
52699a2dd95SBruce Richardson 		void *port);
52799a2dd95SBruce Richardson 
52899a2dd95SBruce Richardson /**
52999a2dd95SBruce Richardson  * Converts nanoseconds to *timeout_ticks* value for rte_event_dequeue()
53099a2dd95SBruce Richardson  *
53199a2dd95SBruce Richardson  * @param dev
53299a2dd95SBruce Richardson  *   Event device pointer
53399a2dd95SBruce Richardson  * @param ns
53499a2dd95SBruce Richardson  *   Wait time in nanosecond
53599a2dd95SBruce Richardson  * @param[out] timeout_ticks
53699a2dd95SBruce Richardson  *   Value for the *timeout_ticks* parameter in rte_event_dequeue() function
53799a2dd95SBruce Richardson  *
53899a2dd95SBruce Richardson  * @return
53999a2dd95SBruce Richardson  *   Returns 0 on success.
54099a2dd95SBruce Richardson  */
54199a2dd95SBruce Richardson typedef int (*eventdev_dequeue_timeout_ticks_t)(struct rte_eventdev *dev,
54299a2dd95SBruce Richardson 		uint64_t ns, uint64_t *timeout_ticks);
54399a2dd95SBruce Richardson 
54499a2dd95SBruce Richardson /**
54599a2dd95SBruce Richardson  * Dump internal information
54699a2dd95SBruce Richardson  *
54799a2dd95SBruce Richardson  * @param dev
54899a2dd95SBruce Richardson  *   Event device pointer
54999a2dd95SBruce Richardson  * @param f
55099a2dd95SBruce Richardson  *   A pointer to a file for output
55199a2dd95SBruce Richardson  */
55299a2dd95SBruce Richardson typedef void (*eventdev_dump_t)(struct rte_eventdev *dev, FILE *f);
55399a2dd95SBruce Richardson 
55499a2dd95SBruce Richardson /**
55599a2dd95SBruce Richardson  * Retrieve a set of statistics from device
55699a2dd95SBruce Richardson  *
55799a2dd95SBruce Richardson  * @param dev
55899a2dd95SBruce Richardson  *   Event device pointer
55999a2dd95SBruce Richardson  * @param mode
56099a2dd95SBruce Richardson  *   Level (device, port or queue)
56199a2dd95SBruce Richardson  * @param queue_port_id
56299a2dd95SBruce Richardson  *   Queue or port number depending on mode
56399a2dd95SBruce Richardson  * @param ids
56499a2dd95SBruce Richardson  *   The stat ids to retrieve
56599a2dd95SBruce Richardson  * @param values
56699a2dd95SBruce Richardson  *   The returned stat values
56799a2dd95SBruce Richardson  * @param n
56899a2dd95SBruce Richardson  *   The number of id values and entries in the values array
56999a2dd95SBruce Richardson  * @return
57099a2dd95SBruce Richardson  *   The number of stat values successfully filled into the values array
57199a2dd95SBruce Richardson  */
57299a2dd95SBruce Richardson typedef int (*eventdev_xstats_get_t)(const struct rte_eventdev *dev,
57399a2dd95SBruce Richardson 		enum rte_event_dev_xstats_mode mode, uint8_t queue_port_id,
5741bdfe4d7SPavan Nikhilesh 		const uint64_t ids[], uint64_t values[], unsigned int n);
57599a2dd95SBruce Richardson 
57699a2dd95SBruce Richardson /**
57799a2dd95SBruce Richardson  * Resets the statistic values in xstats for the device, based on mode.
57899a2dd95SBruce Richardson  */
57999a2dd95SBruce Richardson typedef int (*eventdev_xstats_reset_t)(struct rte_eventdev *dev,
58099a2dd95SBruce Richardson 		enum rte_event_dev_xstats_mode mode,
58199a2dd95SBruce Richardson 		int16_t queue_port_id,
5821bdfe4d7SPavan Nikhilesh 		const uint64_t ids[],
58399a2dd95SBruce Richardson 		uint32_t nb_ids);
58499a2dd95SBruce Richardson 
58599a2dd95SBruce Richardson /**
58699a2dd95SBruce Richardson  * Get names of extended stats of an event device
58799a2dd95SBruce Richardson  *
58899a2dd95SBruce Richardson  * @param dev
58999a2dd95SBruce Richardson  *   Event device pointer
59099a2dd95SBruce Richardson  * @param mode
59199a2dd95SBruce Richardson  *   Level (device, port or queue)
59299a2dd95SBruce Richardson  * @param queue_port_id
59399a2dd95SBruce Richardson  *   Queue or port number depending on mode
59499a2dd95SBruce Richardson  * @param xstats_names
59599a2dd95SBruce Richardson  *   Array of name values to be filled in
59699a2dd95SBruce Richardson  * @param ids
59799a2dd95SBruce Richardson  *   The stat ids to retrieve
59899a2dd95SBruce Richardson  * @param size
59999a2dd95SBruce Richardson  *   Number of values in the xstats_names array
60099a2dd95SBruce Richardson  * @return
60199a2dd95SBruce Richardson  *   When size >= the number of stats, return the number of stat values filled
60299a2dd95SBruce Richardson  *   into the array.
60399a2dd95SBruce Richardson  *   When size < the number of available stats, return the number of stats
60499a2dd95SBruce Richardson  *   values, and do not fill in any data into xstats_names.
60599a2dd95SBruce Richardson  */
60699a2dd95SBruce Richardson typedef int (*eventdev_xstats_get_names_t)(const struct rte_eventdev *dev,
60799a2dd95SBruce Richardson 		enum rte_event_dev_xstats_mode mode, uint8_t queue_port_id,
60899a2dd95SBruce Richardson 		struct rte_event_dev_xstats_name *xstats_names,
6091bdfe4d7SPavan Nikhilesh 		uint64_t *ids, unsigned int size);
61099a2dd95SBruce Richardson 
61199a2dd95SBruce Richardson /**
61299a2dd95SBruce Richardson  * Get value of one stats and optionally return its id
61399a2dd95SBruce Richardson  *
61499a2dd95SBruce Richardson  * @param dev
61599a2dd95SBruce Richardson  *   Event device pointer
61699a2dd95SBruce Richardson  * @param name
61799a2dd95SBruce Richardson  *   The name of the stat to retrieve
61899a2dd95SBruce Richardson  * @param id
61999a2dd95SBruce Richardson  *   Pointer to an unsigned int where we store the stat-id for future reference.
62099a2dd95SBruce Richardson  *   This pointer may be null if the id is not required.
62199a2dd95SBruce Richardson  * @return
62299a2dd95SBruce Richardson  *   The value of the stat, or (uint64_t)-1 if the stat is not found.
62399a2dd95SBruce Richardson  *   If the stat is not found, the id value will be returned as (unsigned)-1,
62499a2dd95SBruce Richardson  *   if id pointer is non-NULL
62599a2dd95SBruce Richardson  */
62699a2dd95SBruce Richardson typedef uint64_t (*eventdev_xstats_get_by_name)(const struct rte_eventdev *dev,
6271bdfe4d7SPavan Nikhilesh 		const char *name, uint64_t *id);
62899a2dd95SBruce Richardson 
62999a2dd95SBruce Richardson 
63099a2dd95SBruce Richardson /**
63199a2dd95SBruce Richardson  * Retrieve the event device's ethdev Rx adapter capabilities for the
63299a2dd95SBruce Richardson  * specified ethernet port
63399a2dd95SBruce Richardson  *
63499a2dd95SBruce Richardson  * @param dev
63599a2dd95SBruce Richardson  *   Event device pointer
63699a2dd95SBruce Richardson  *
63799a2dd95SBruce Richardson  * @param eth_dev
63899a2dd95SBruce Richardson  *   Ethernet device pointer
63999a2dd95SBruce Richardson  *
64099a2dd95SBruce Richardson  * @param[out] caps
64199a2dd95SBruce Richardson  *   A pointer to memory filled with Rx event adapter capabilities.
64299a2dd95SBruce Richardson  *
64399a2dd95SBruce Richardson  * @return
64499a2dd95SBruce Richardson  *   - 0: Success, driver provides Rx event adapter capabilities for the
64599a2dd95SBruce Richardson  *	ethernet device.
64699a2dd95SBruce Richardson  *   - <0: Error code returned by the driver function.
64799a2dd95SBruce Richardson  */
64899a2dd95SBruce Richardson typedef int (*eventdev_eth_rx_adapter_caps_get_t)
64999a2dd95SBruce Richardson 					(const struct rte_eventdev *dev,
65099a2dd95SBruce Richardson 					const struct rte_eth_dev *eth_dev,
65199a2dd95SBruce Richardson 					uint32_t *caps);
65299a2dd95SBruce Richardson 
65399a2dd95SBruce Richardson struct rte_event_eth_rx_adapter_queue_conf;
65499a2dd95SBruce Richardson 
65599a2dd95SBruce Richardson /**
65699a2dd95SBruce Richardson  * Retrieve the event device's timer adapter capabilities, as well as the ops
65799a2dd95SBruce Richardson  * structure that an event timer adapter should call through to enter the
65899a2dd95SBruce Richardson  * driver
65999a2dd95SBruce Richardson  *
66099a2dd95SBruce Richardson  * @param dev
66199a2dd95SBruce Richardson  *   Event device pointer
66299a2dd95SBruce Richardson  *
66399a2dd95SBruce Richardson  * @param flags
66499a2dd95SBruce Richardson  *   Flags that can be used to determine how to select an event timer
66599a2dd95SBruce Richardson  *   adapter ops structure
66699a2dd95SBruce Richardson  *
66799a2dd95SBruce Richardson  * @param[out] caps
66899a2dd95SBruce Richardson  *   A pointer to memory filled with Rx event adapter capabilities.
66999a2dd95SBruce Richardson  *
67099a2dd95SBruce Richardson  * @param[out] ops
67199a2dd95SBruce Richardson  *   A pointer to the ops pointer to set with the address of the desired ops
67299a2dd95SBruce Richardson  *   structure
67399a2dd95SBruce Richardson  *
67499a2dd95SBruce Richardson  * @return
67599a2dd95SBruce Richardson  *   - 0: Success, driver provides Rx event adapter capabilities for the
67699a2dd95SBruce Richardson  *	ethernet device.
67799a2dd95SBruce Richardson  *   - <0: Error code returned by the driver function.
67899a2dd95SBruce Richardson  */
67999a2dd95SBruce Richardson typedef int (*eventdev_timer_adapter_caps_get_t)(
68053548ad3SPavan Nikhilesh 	const struct rte_eventdev *dev, uint64_t flags, uint32_t *caps,
68153548ad3SPavan Nikhilesh 	const struct event_timer_adapter_ops **ops);
68299a2dd95SBruce Richardson 
68399a2dd95SBruce Richardson /**
68499a2dd95SBruce Richardson  * Add ethernet Rx queues to event device. This callback is invoked if
68599a2dd95SBruce Richardson  * the caps returned from rte_eventdev_eth_rx_adapter_caps_get(, eth_port_id)
68699a2dd95SBruce Richardson  * has RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT set.
68799a2dd95SBruce Richardson  *
68899a2dd95SBruce Richardson  * @param dev
68999a2dd95SBruce Richardson  *   Event device pointer
69099a2dd95SBruce Richardson  *
69199a2dd95SBruce Richardson  * @param eth_dev
69299a2dd95SBruce Richardson  *   Ethernet device pointer
69399a2dd95SBruce Richardson  *
69499a2dd95SBruce Richardson  * @param rx_queue_id
69599a2dd95SBruce Richardson  *   Ethernet device receive queue index
69699a2dd95SBruce Richardson  *
69799a2dd95SBruce Richardson  * @param queue_conf
69899a2dd95SBruce Richardson  *  Additional configuration structure
69999a2dd95SBruce Richardson 
70099a2dd95SBruce Richardson  * @return
70199a2dd95SBruce Richardson  *   - 0: Success, ethernet receive queue added successfully.
70299a2dd95SBruce Richardson  *   - <0: Error code returned by the driver function.
70399a2dd95SBruce Richardson  */
70499a2dd95SBruce Richardson typedef int (*eventdev_eth_rx_adapter_queue_add_t)(
70599a2dd95SBruce Richardson 		const struct rte_eventdev *dev,
70699a2dd95SBruce Richardson 		const struct rte_eth_dev *eth_dev,
70799a2dd95SBruce Richardson 		int32_t rx_queue_id,
70899a2dd95SBruce Richardson 		const struct rte_event_eth_rx_adapter_queue_conf *queue_conf);
70999a2dd95SBruce Richardson 
71099a2dd95SBruce Richardson /**
71199a2dd95SBruce Richardson  * Delete ethernet Rx queues from event device. This callback is invoked if
71299a2dd95SBruce Richardson  * the caps returned from eventdev_eth_rx_adapter_caps_get(, eth_port_id)
71399a2dd95SBruce Richardson  * has RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT set.
71499a2dd95SBruce Richardson  *
71599a2dd95SBruce Richardson  * @param dev
71699a2dd95SBruce Richardson  *   Event device pointer
71799a2dd95SBruce Richardson  *
71899a2dd95SBruce Richardson  * @param eth_dev
71999a2dd95SBruce Richardson  *   Ethernet device pointer
72099a2dd95SBruce Richardson  *
72199a2dd95SBruce Richardson  * @param rx_queue_id
72299a2dd95SBruce Richardson  *   Ethernet device receive queue index
72399a2dd95SBruce Richardson  *
72499a2dd95SBruce Richardson  * @return
72599a2dd95SBruce Richardson  *   - 0: Success, ethernet receive queue deleted successfully.
72699a2dd95SBruce Richardson  *   - <0: Error code returned by the driver function.
72799a2dd95SBruce Richardson  */
72899a2dd95SBruce Richardson typedef int (*eventdev_eth_rx_adapter_queue_del_t)
72999a2dd95SBruce Richardson 					(const struct rte_eventdev *dev,
73099a2dd95SBruce Richardson 					const struct rte_eth_dev *eth_dev,
73199a2dd95SBruce Richardson 					int32_t rx_queue_id);
73299a2dd95SBruce Richardson 
73399a2dd95SBruce Richardson /**
734da781e64SGanapati Kundapura  * Retrieve Rx adapter queue config information for the specified
735da781e64SGanapati Kundapura  * rx queue ID.
736da781e64SGanapati Kundapura  *
737da781e64SGanapati Kundapura  * @param dev
738da781e64SGanapati Kundapura  *  Event device pointer
739da781e64SGanapati Kundapura  *
740da781e64SGanapati Kundapura  * @param eth_dev
741da781e64SGanapati Kundapura  *  Ethernet device pointer
742da781e64SGanapati Kundapura  *
743da781e64SGanapati Kundapura  * @param rx_queue_id
744da781e64SGanapati Kundapura  *  Ethernet device receive queue index.
745da781e64SGanapati Kundapura  *
746da781e64SGanapati Kundapura  * @param[out] queue_conf
747da781e64SGanapati Kundapura  *  Pointer to rte_event_eth_rx_adapter_queue_conf structure
748da781e64SGanapati Kundapura  *
749da781e64SGanapati Kundapura  * @return
750da781e64SGanapati Kundapura  *  - 0: Success
751da781e64SGanapati Kundapura  *  - <0: Error code on failure.
752da781e64SGanapati Kundapura  */
753da781e64SGanapati Kundapura typedef int (*eventdev_eth_rx_adapter_queue_conf_get_t)
754da781e64SGanapati Kundapura 			(const struct rte_eventdev *dev,
755da781e64SGanapati Kundapura 			const struct rte_eth_dev *eth_dev,
756da781e64SGanapati Kundapura 			uint16_t rx_queue_id,
757da781e64SGanapati Kundapura 			struct rte_event_eth_rx_adapter_queue_conf *queue_conf);
758da781e64SGanapati Kundapura 
759da781e64SGanapati Kundapura /**
76099a2dd95SBruce Richardson  * Start ethernet Rx adapter. This callback is invoked if
76199a2dd95SBruce Richardson  * the caps returned from eventdev_eth_rx_adapter_caps_get(.., eth_port_id)
76299a2dd95SBruce Richardson  * has RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT set and Rx queues
76399a2dd95SBruce Richardson  * from eth_port_id have been added to the event device.
76499a2dd95SBruce Richardson  *
76599a2dd95SBruce Richardson  * @param dev
76699a2dd95SBruce Richardson  *   Event device pointer
76799a2dd95SBruce Richardson  *
76899a2dd95SBruce Richardson  * @param eth_dev
76999a2dd95SBruce Richardson  *   Ethernet device pointer
77099a2dd95SBruce Richardson  *
77199a2dd95SBruce Richardson  * @return
77299a2dd95SBruce Richardson  *   - 0: Success, ethernet Rx adapter started successfully.
77399a2dd95SBruce Richardson  *   - <0: Error code returned by the driver function.
77499a2dd95SBruce Richardson  */
77599a2dd95SBruce Richardson typedef int (*eventdev_eth_rx_adapter_start_t)
77699a2dd95SBruce Richardson 					(const struct rte_eventdev *dev,
77799a2dd95SBruce Richardson 					const struct rte_eth_dev *eth_dev);
77899a2dd95SBruce Richardson 
77999a2dd95SBruce Richardson /**
78099a2dd95SBruce Richardson  * Stop ethernet Rx adapter. This callback is invoked if
78199a2dd95SBruce Richardson  * the caps returned from eventdev_eth_rx_adapter_caps_get(..,eth_port_id)
78299a2dd95SBruce Richardson  * has RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT set and Rx queues
78399a2dd95SBruce Richardson  * from eth_port_id have been added to the event device.
78499a2dd95SBruce Richardson  *
78599a2dd95SBruce Richardson  * @param dev
78699a2dd95SBruce Richardson  *   Event device pointer
78799a2dd95SBruce Richardson  *
78899a2dd95SBruce Richardson  * @param eth_dev
78999a2dd95SBruce Richardson  *   Ethernet device pointer
79099a2dd95SBruce Richardson  *
79199a2dd95SBruce Richardson  * @return
79299a2dd95SBruce Richardson  *   - 0: Success, ethernet Rx adapter stopped successfully.
79399a2dd95SBruce Richardson  *   - <0: Error code returned by the driver function.
79499a2dd95SBruce Richardson  */
79599a2dd95SBruce Richardson typedef int (*eventdev_eth_rx_adapter_stop_t)
79699a2dd95SBruce Richardson 					(const struct rte_eventdev *dev,
79799a2dd95SBruce Richardson 					const struct rte_eth_dev *eth_dev);
79899a2dd95SBruce Richardson 
79999a2dd95SBruce Richardson struct rte_event_eth_rx_adapter_stats;
80099a2dd95SBruce Richardson 
80199a2dd95SBruce Richardson /**
80299a2dd95SBruce Richardson  * Retrieve ethernet Rx adapter statistics.
80399a2dd95SBruce Richardson  *
80499a2dd95SBruce Richardson  * @param dev
80599a2dd95SBruce Richardson  *   Event device pointer
80699a2dd95SBruce Richardson  *
80799a2dd95SBruce Richardson  * @param eth_dev
80899a2dd95SBruce Richardson  *   Ethernet device pointer
80999a2dd95SBruce Richardson  *
81099a2dd95SBruce Richardson  * @param[out] stats
81199a2dd95SBruce Richardson  *   Pointer to stats structure
81299a2dd95SBruce Richardson  *
81399a2dd95SBruce Richardson  * @return
81499a2dd95SBruce Richardson  *   Return 0 on success.
81599a2dd95SBruce Richardson  */
81699a2dd95SBruce Richardson 
81799a2dd95SBruce Richardson typedef int (*eventdev_eth_rx_adapter_stats_get)
81899a2dd95SBruce Richardson 			(const struct rte_eventdev *dev,
81999a2dd95SBruce Richardson 			const struct rte_eth_dev *eth_dev,
82099a2dd95SBruce Richardson 			struct rte_event_eth_rx_adapter_stats *stats);
82199a2dd95SBruce Richardson /**
82299a2dd95SBruce Richardson  * Reset ethernet Rx adapter statistics.
82399a2dd95SBruce Richardson  *
82499a2dd95SBruce Richardson  * @param dev
82599a2dd95SBruce Richardson  *   Event device pointer
82699a2dd95SBruce Richardson  *
82799a2dd95SBruce Richardson  * @param eth_dev
82899a2dd95SBruce Richardson  *   Ethernet device pointer
82999a2dd95SBruce Richardson  *
83099a2dd95SBruce Richardson  * @return
83199a2dd95SBruce Richardson  *   Return 0 on success.
83299a2dd95SBruce Richardson  */
83399a2dd95SBruce Richardson typedef int (*eventdev_eth_rx_adapter_stats_reset)
83499a2dd95SBruce Richardson 			(const struct rte_eventdev *dev,
83599a2dd95SBruce Richardson 			const struct rte_eth_dev *eth_dev);
836995b150cSNaga Harish K S V 
837995b150cSNaga Harish K S V struct rte_event_eth_rx_adapter_queue_stats;
838995b150cSNaga Harish K S V 
839995b150cSNaga Harish K S V /**
840995b150cSNaga Harish K S V  * Retrieve ethernet Rx adapter queue statistics.
841995b150cSNaga Harish K S V  *
842995b150cSNaga Harish K S V  * @param dev
843995b150cSNaga Harish K S V  *   Event device pointer
844995b150cSNaga Harish K S V  *
845995b150cSNaga Harish K S V  * @param eth_dev
846995b150cSNaga Harish K S V  *   Ethernet device pointer
847995b150cSNaga Harish K S V  *
848995b150cSNaga Harish K S V  * @param rx_queue_id
849995b150cSNaga Harish K S V  *  Ethernet device receive queue index.
850995b150cSNaga Harish K S V  *
851995b150cSNaga Harish K S V  * @param[out] q_stats
852995b150cSNaga Harish K S V  *   Pointer to queue stats structure
853995b150cSNaga Harish K S V  *
854995b150cSNaga Harish K S V  * @return
855995b150cSNaga Harish K S V  *   Return 0 on success.
856995b150cSNaga Harish K S V  */
857995b150cSNaga Harish K S V typedef int (*eventdev_eth_rx_adapter_q_stats_get)
858995b150cSNaga Harish K S V 			(const struct rte_eventdev *dev,
859995b150cSNaga Harish K S V 			 const struct rte_eth_dev *eth_dev,
860995b150cSNaga Harish K S V 			 uint16_t rx_queue_id,
861995b150cSNaga Harish K S V 			 struct rte_event_eth_rx_adapter_queue_stats *q_stats);
862995b150cSNaga Harish K S V 
863995b150cSNaga Harish K S V /**
864995b150cSNaga Harish K S V  * Reset ethernet Rx adapter queue statistics.
865995b150cSNaga Harish K S V  *
866995b150cSNaga Harish K S V  * @param dev
867995b150cSNaga Harish K S V  *   Event device pointer
868995b150cSNaga Harish K S V  *
869995b150cSNaga Harish K S V  * @param eth_dev
870995b150cSNaga Harish K S V  *   Ethernet device pointer
871995b150cSNaga Harish K S V  *
872995b150cSNaga Harish K S V  * @param rx_queue_id
873995b150cSNaga Harish K S V  *  Ethernet device receive queue index.
874995b150cSNaga Harish K S V  *
875995b150cSNaga Harish K S V  * @return
876995b150cSNaga Harish K S V  *   Return 0 on success.
877995b150cSNaga Harish K S V  */
878995b150cSNaga Harish K S V typedef int (*eventdev_eth_rx_adapter_q_stats_reset)
879995b150cSNaga Harish K S V 			(const struct rte_eventdev *dev,
880995b150cSNaga Harish K S V 			 const struct rte_eth_dev *eth_dev,
881995b150cSNaga Harish K S V 			 uint16_t rx_queue_id);
882995b150cSNaga Harish K S V 
88399a2dd95SBruce Richardson /**
88499a2dd95SBruce Richardson  * Start eventdev selftest.
88599a2dd95SBruce Richardson  *
88699a2dd95SBruce Richardson  * @return
88799a2dd95SBruce Richardson  *   Return 0 on success.
88899a2dd95SBruce Richardson  */
88999a2dd95SBruce Richardson typedef int (*eventdev_selftest)(void);
89099a2dd95SBruce Richardson 
89199a2dd95SBruce Richardson struct rte_event_eth_rx_adapter_vector_limits;
89299a2dd95SBruce Richardson /**
89399a2dd95SBruce Richardson  * Get event vector limits for a given event, ethernet device pair.
89499a2dd95SBruce Richardson  *
89599a2dd95SBruce Richardson  * @param dev
89699a2dd95SBruce Richardson  *   Event device pointer
89799a2dd95SBruce Richardson  *
89899a2dd95SBruce Richardson  * @param eth_dev
89999a2dd95SBruce Richardson  *   Ethernet device pointer
90099a2dd95SBruce Richardson  *
90199a2dd95SBruce Richardson  * @param[out] limits
90299a2dd95SBruce Richardson  *   Pointer to the limits structure to be filled.
90399a2dd95SBruce Richardson  *
90499a2dd95SBruce Richardson  * @return
90599a2dd95SBruce Richardson  *   - 0: Success.
90699a2dd95SBruce Richardson  *   - <0: Error code returned by the driver function.
90799a2dd95SBruce Richardson  */
90899a2dd95SBruce Richardson typedef int (*eventdev_eth_rx_adapter_vector_limits_get_t)(
90999a2dd95SBruce Richardson 	const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev,
91099a2dd95SBruce Richardson 	struct rte_event_eth_rx_adapter_vector_limits *limits);
91199a2dd95SBruce Richardson 
912a1793ee8SGanapati Kundapura /**
913a1793ee8SGanapati Kundapura  * Get Rx adapter instance ID for Rx queue
914a1793ee8SGanapati Kundapura  *
915a1793ee8SGanapati Kundapura  * @param eth_dev_id
916a1793ee8SGanapati Kundapura  *  Port identifier of ethernet device
917a1793ee8SGanapati Kundapura  *
918a1793ee8SGanapati Kundapura  * @param rx_queue_id
919a1793ee8SGanapati Kundapura  *  Ethernet device Rx queue index
920a1793ee8SGanapati Kundapura  *
921a1793ee8SGanapati Kundapura  * @param[out] rxa_inst_id
922a1793ee8SGanapati Kundapura  *  Pointer to Rx adapter instance identifier.
923a1793ee8SGanapati Kundapura  *  Contains valid Rx adapter instance ID when return value is 0
924a1793ee8SGanapati Kundapura  *
925a1793ee8SGanapati Kundapura  * @return
926a1793ee8SGanapati Kundapura  *   -  0: Success
927a1793ee8SGanapati Kundapura  *   - <0: Error code on failure
928a1793ee8SGanapati Kundapura  */
929a1793ee8SGanapati Kundapura typedef int (*eventdev_eth_rx_adapter_instance_get_t)
930a1793ee8SGanapati Kundapura 	(uint16_t eth_dev_id, uint16_t rx_queue_id, uint8_t *rxa_inst_id);
931a1793ee8SGanapati Kundapura 
93299a2dd95SBruce Richardson typedef uint32_t rte_event_pmd_selftest_seqn_t;
93399a2dd95SBruce Richardson extern int rte_event_pmd_selftest_seqn_dynfield_offset;
93499a2dd95SBruce Richardson 
93599a2dd95SBruce Richardson /**
93699a2dd95SBruce Richardson  * Read test sequence number from mbuf.
93799a2dd95SBruce Richardson  *
93899a2dd95SBruce Richardson  * @param mbuf Structure to read from.
93999a2dd95SBruce Richardson  * @return pointer to test sequence number.
94099a2dd95SBruce Richardson  */
94199a2dd95SBruce Richardson __rte_internal
94299a2dd95SBruce Richardson static inline rte_event_pmd_selftest_seqn_t *
94399a2dd95SBruce Richardson rte_event_pmd_selftest_seqn(struct rte_mbuf *mbuf)
94499a2dd95SBruce Richardson {
94599a2dd95SBruce Richardson 	return RTE_MBUF_DYNFIELD(mbuf,
94699a2dd95SBruce Richardson 		rte_event_pmd_selftest_seqn_dynfield_offset,
94799a2dd95SBruce Richardson 		rte_event_pmd_selftest_seqn_t *);
94899a2dd95SBruce Richardson }
94999a2dd95SBruce Richardson 
95099a2dd95SBruce Richardson struct rte_cryptodev;
951c1749bc5SVolodymyr Fialko struct rte_event_crypto_adapter_queue_conf;
95299a2dd95SBruce Richardson 
95399a2dd95SBruce Richardson /**
95499a2dd95SBruce Richardson  * This API may change without prior notice
95599a2dd95SBruce Richardson  *
95699a2dd95SBruce Richardson  * Retrieve the event device's crypto adapter capabilities for the
95799a2dd95SBruce Richardson  * specified cryptodev
95899a2dd95SBruce Richardson  *
95999a2dd95SBruce Richardson  * @param dev
96099a2dd95SBruce Richardson  *   Event device pointer
96199a2dd95SBruce Richardson  *
96299a2dd95SBruce Richardson  * @param cdev
96399a2dd95SBruce Richardson  *   cryptodev pointer
96499a2dd95SBruce Richardson  *
96599a2dd95SBruce Richardson  * @param[out] caps
96699a2dd95SBruce Richardson  *   A pointer to memory filled with event adapter capabilities.
96799a2dd95SBruce Richardson  *   It is expected to be pre-allocated & initialized by caller.
96899a2dd95SBruce Richardson  *
96999a2dd95SBruce Richardson  * @return
97099a2dd95SBruce Richardson  *   - 0: Success, driver provides event adapter capabilities for the
97199a2dd95SBruce Richardson  *	cryptodev.
97299a2dd95SBruce Richardson  *   - <0: Error code returned by the driver function.
97399a2dd95SBruce Richardson  */
97499a2dd95SBruce Richardson typedef int (*eventdev_crypto_adapter_caps_get_t)
97599a2dd95SBruce Richardson 					(const struct rte_eventdev *dev,
97699a2dd95SBruce Richardson 					 const struct rte_cryptodev *cdev,
97799a2dd95SBruce Richardson 					 uint32_t *caps);
97899a2dd95SBruce Richardson 
97999a2dd95SBruce Richardson /**
98099a2dd95SBruce Richardson  * This API may change without prior notice
98199a2dd95SBruce Richardson  *
98299a2dd95SBruce Richardson  * Add crypto queue pair to event device. This callback is invoked if
98399a2dd95SBruce Richardson  * the caps returned from rte_event_crypto_adapter_caps_get(, cdev_id)
98499a2dd95SBruce Richardson  * has RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_* set.
98599a2dd95SBruce Richardson  *
98699a2dd95SBruce Richardson  * @param dev
98799a2dd95SBruce Richardson  *   Event device pointer
98899a2dd95SBruce Richardson  *
98999a2dd95SBruce Richardson  * @param cdev
99099a2dd95SBruce Richardson  *   cryptodev pointer
99199a2dd95SBruce Richardson  *
99299a2dd95SBruce Richardson  * @param queue_pair_id
99399a2dd95SBruce Richardson  *   cryptodev queue pair identifier.
99499a2dd95SBruce Richardson  *
99599a2dd95SBruce Richardson  * @param event
99699a2dd95SBruce Richardson  *  Event information required for binding cryptodev queue pair to event queue.
99799a2dd95SBruce Richardson  *  This structure will have a valid value for only those HW PMDs supporting
99899a2dd95SBruce Richardson  *  @see RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_QP_EV_BIND capability.
99999a2dd95SBruce Richardson  *
100099a2dd95SBruce Richardson  * @return
100199a2dd95SBruce Richardson  *   - 0: Success, cryptodev queue pair added successfully.
100299a2dd95SBruce Richardson  *   - <0: Error code returned by the driver function.
100399a2dd95SBruce Richardson  */
1004c1749bc5SVolodymyr Fialko typedef int (*eventdev_crypto_adapter_queue_pair_add_t)(
1005c1749bc5SVolodymyr Fialko 		const struct rte_eventdev *dev,
100699a2dd95SBruce Richardson 		const struct rte_cryptodev *cdev,
100799a2dd95SBruce Richardson 		int32_t queue_pair_id,
1008c1749bc5SVolodymyr Fialko 		const struct rte_event_crypto_adapter_queue_conf *queue_conf);
100999a2dd95SBruce Richardson 
101099a2dd95SBruce Richardson 
101199a2dd95SBruce Richardson /**
101299a2dd95SBruce Richardson  * This API may change without prior notice
101399a2dd95SBruce Richardson  *
101499a2dd95SBruce Richardson  * Delete crypto queue pair to event device. This callback is invoked if
101599a2dd95SBruce Richardson  * the caps returned from rte_event_crypto_adapter_caps_get(, cdev_id)
101699a2dd95SBruce Richardson  * has RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_* set.
101799a2dd95SBruce Richardson  *
101899a2dd95SBruce Richardson  * @param dev
101999a2dd95SBruce Richardson  *   Event device pointer
102099a2dd95SBruce Richardson  *
102199a2dd95SBruce Richardson  * @param cdev
102299a2dd95SBruce Richardson  *   cryptodev pointer
102399a2dd95SBruce Richardson  *
102499a2dd95SBruce Richardson  * @param queue_pair_id
102599a2dd95SBruce Richardson  *   cryptodev queue pair identifier.
102699a2dd95SBruce Richardson  *
102799a2dd95SBruce Richardson  * @return
102899a2dd95SBruce Richardson  *   - 0: Success, cryptodev queue pair deleted successfully.
102999a2dd95SBruce Richardson  *   - <0: Error code returned by the driver function.
103099a2dd95SBruce Richardson  */
103199a2dd95SBruce Richardson typedef int (*eventdev_crypto_adapter_queue_pair_del_t)
103299a2dd95SBruce Richardson 					(const struct rte_eventdev *dev,
103399a2dd95SBruce Richardson 					 const struct rte_cryptodev *cdev,
103499a2dd95SBruce Richardson 					 int32_t queue_pair_id);
103599a2dd95SBruce Richardson 
103699a2dd95SBruce Richardson /**
103799a2dd95SBruce Richardson  * Start crypto adapter. This callback is invoked if
103899a2dd95SBruce Richardson  * the caps returned from rte_event_crypto_adapter_caps_get(.., cdev_id)
103999a2dd95SBruce Richardson  * has RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_* set and queue pairs
104099a2dd95SBruce Richardson  * from cdev_id have been added to the event device.
104199a2dd95SBruce Richardson  *
104299a2dd95SBruce Richardson  * @param dev
104399a2dd95SBruce Richardson  *   Event device pointer
104499a2dd95SBruce Richardson  *
104599a2dd95SBruce Richardson  * @param cdev
104699a2dd95SBruce Richardson  *   Crypto device pointer
104799a2dd95SBruce Richardson  *
104899a2dd95SBruce Richardson  * @return
104999a2dd95SBruce Richardson  *   - 0: Success, crypto adapter started successfully.
105099a2dd95SBruce Richardson  *   - <0: Error code returned by the driver function.
105199a2dd95SBruce Richardson  */
105299a2dd95SBruce Richardson typedef int (*eventdev_crypto_adapter_start_t)
105399a2dd95SBruce Richardson 					(const struct rte_eventdev *dev,
105499a2dd95SBruce Richardson 					 const struct rte_cryptodev *cdev);
105599a2dd95SBruce Richardson 
105699a2dd95SBruce Richardson /**
105799a2dd95SBruce Richardson  * Stop crypto adapter. This callback is invoked if
105899a2dd95SBruce Richardson  * the caps returned from rte_event_crypto_adapter_caps_get(.., cdev_id)
105999a2dd95SBruce Richardson  * has RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_* set and queue pairs
106099a2dd95SBruce Richardson  * from cdev_id have been added to the event device.
106199a2dd95SBruce Richardson  *
106299a2dd95SBruce Richardson  * @param dev
106399a2dd95SBruce Richardson  *   Event device pointer
106499a2dd95SBruce Richardson  *
106599a2dd95SBruce Richardson  * @param cdev
106699a2dd95SBruce Richardson  *   Crypto device pointer
106799a2dd95SBruce Richardson  *
106899a2dd95SBruce Richardson  * @return
106999a2dd95SBruce Richardson  *   - 0: Success, crypto adapter stopped successfully.
107099a2dd95SBruce Richardson  *   - <0: Error code returned by the driver function.
107199a2dd95SBruce Richardson  */
107299a2dd95SBruce Richardson typedef int (*eventdev_crypto_adapter_stop_t)
107399a2dd95SBruce Richardson 					(const struct rte_eventdev *dev,
107499a2dd95SBruce Richardson 					 const struct rte_cryptodev *cdev);
107599a2dd95SBruce Richardson 
107699a2dd95SBruce Richardson struct rte_event_crypto_adapter_stats;
107799a2dd95SBruce Richardson 
107899a2dd95SBruce Richardson /**
107999a2dd95SBruce Richardson  * Retrieve crypto adapter statistics.
108099a2dd95SBruce Richardson  *
108199a2dd95SBruce Richardson  * @param dev
108299a2dd95SBruce Richardson  *   Event device pointer
108399a2dd95SBruce Richardson  *
108499a2dd95SBruce Richardson  * @param cdev
108599a2dd95SBruce Richardson  *   Crypto device pointer
108699a2dd95SBruce Richardson  *
108799a2dd95SBruce Richardson  * @param[out] stats
108899a2dd95SBruce Richardson  *   Pointer to stats structure
108999a2dd95SBruce Richardson  *
109099a2dd95SBruce Richardson  * @return
109199a2dd95SBruce Richardson  *   Return 0 on success.
109299a2dd95SBruce Richardson  */
109399a2dd95SBruce Richardson 
109499a2dd95SBruce Richardson typedef int (*eventdev_crypto_adapter_stats_get)
109599a2dd95SBruce Richardson 			(const struct rte_eventdev *dev,
109699a2dd95SBruce Richardson 			 const struct rte_cryptodev *cdev,
109799a2dd95SBruce Richardson 			 struct rte_event_crypto_adapter_stats *stats);
109899a2dd95SBruce Richardson 
109999a2dd95SBruce Richardson /**
110099a2dd95SBruce Richardson  * Reset crypto adapter statistics.
110199a2dd95SBruce Richardson  *
110299a2dd95SBruce Richardson  * @param dev
110399a2dd95SBruce Richardson  *   Event device pointer
110499a2dd95SBruce Richardson  *
110599a2dd95SBruce Richardson  * @param cdev
110699a2dd95SBruce Richardson  *   Crypto device pointer
110799a2dd95SBruce Richardson  *
110899a2dd95SBruce Richardson  * @return
110999a2dd95SBruce Richardson  *   Return 0 on success.
111099a2dd95SBruce Richardson  */
111199a2dd95SBruce Richardson 
111299a2dd95SBruce Richardson typedef int (*eventdev_crypto_adapter_stats_reset)
111399a2dd95SBruce Richardson 			(const struct rte_eventdev *dev,
111499a2dd95SBruce Richardson 			 const struct rte_cryptodev *cdev);
111599a2dd95SBruce Richardson 
1116c1749bc5SVolodymyr Fialko struct rte_event_crypto_adapter_vector_limits;
1117c1749bc5SVolodymyr Fialko /**
1118c1749bc5SVolodymyr Fialko  * Get event vector limits for a given event, crypto device pair.
1119c1749bc5SVolodymyr Fialko  *
1120c1749bc5SVolodymyr Fialko  * @param dev
1121c1749bc5SVolodymyr Fialko  *   Event device pointer
1122c1749bc5SVolodymyr Fialko  *
1123c1749bc5SVolodymyr Fialko  * @param cdev
1124c1749bc5SVolodymyr Fialko  *   Crypto device pointer
1125c1749bc5SVolodymyr Fialko  *
1126c1749bc5SVolodymyr Fialko  * @param[out] limits
1127c1749bc5SVolodymyr Fialko  *   Pointer to the limits structure to be filled.
1128c1749bc5SVolodymyr Fialko  *
1129c1749bc5SVolodymyr Fialko  * @return
1130c1749bc5SVolodymyr Fialko  *   - 0: Success.
1131c1749bc5SVolodymyr Fialko  *   - <0: Error code returned by the driver function.
1132c1749bc5SVolodymyr Fialko  */
1133c1749bc5SVolodymyr Fialko typedef int (*eventdev_crypto_adapter_vector_limits_get_t)(
1134c1749bc5SVolodymyr Fialko 	const struct rte_eventdev *dev, const struct rte_cryptodev *cdev,
1135c1749bc5SVolodymyr Fialko 	struct rte_event_crypto_adapter_vector_limits *limits);
1136c1749bc5SVolodymyr Fialko 
113799a2dd95SBruce Richardson /**
113899a2dd95SBruce Richardson  * Retrieve the event device's eth Tx adapter capabilities.
113999a2dd95SBruce Richardson  *
114099a2dd95SBruce Richardson  * @param dev
114199a2dd95SBruce Richardson  *   Event device pointer
114299a2dd95SBruce Richardson  *
114399a2dd95SBruce Richardson  * @param eth_dev
114499a2dd95SBruce Richardson  *   Ethernet device pointer
114599a2dd95SBruce Richardson  *
114699a2dd95SBruce Richardson  * @param[out] caps
114799a2dd95SBruce Richardson  *   A pointer to memory filled with eth Tx adapter capabilities.
114899a2dd95SBruce Richardson  *
114999a2dd95SBruce Richardson  * @return
115099a2dd95SBruce Richardson  *   - 0: Success, driver provides eth Tx adapter capabilities
115199a2dd95SBruce Richardson  *   - <0: Error code returned by the driver function.
115299a2dd95SBruce Richardson  */
115399a2dd95SBruce Richardson typedef int (*eventdev_eth_tx_adapter_caps_get_t)
115499a2dd95SBruce Richardson 					(const struct rte_eventdev *dev,
115599a2dd95SBruce Richardson 					const struct rte_eth_dev *eth_dev,
115699a2dd95SBruce Richardson 					uint32_t *caps);
115799a2dd95SBruce Richardson 
115899a2dd95SBruce Richardson /**
115999a2dd95SBruce Richardson  * Create adapter callback.
116099a2dd95SBruce Richardson  *
116199a2dd95SBruce Richardson  * @param id
116299a2dd95SBruce Richardson  *   Adapter identifier
116399a2dd95SBruce Richardson  *
116499a2dd95SBruce Richardson  * @param dev
116599a2dd95SBruce Richardson  *   Event device pointer
116699a2dd95SBruce Richardson  *
116799a2dd95SBruce Richardson  * @return
116899a2dd95SBruce Richardson  *   - 0: Success.
116999a2dd95SBruce Richardson  *   - <0: Error code on failure.
117099a2dd95SBruce Richardson  */
117199a2dd95SBruce Richardson typedef int (*eventdev_eth_tx_adapter_create_t)(uint8_t id,
117299a2dd95SBruce Richardson 					const struct rte_eventdev *dev);
117399a2dd95SBruce Richardson 
117499a2dd95SBruce Richardson /**
117599a2dd95SBruce Richardson  * Free adapter callback.
117699a2dd95SBruce Richardson  *
117799a2dd95SBruce Richardson  * @param id
117899a2dd95SBruce Richardson  *   Adapter identifier
117999a2dd95SBruce Richardson  *
118099a2dd95SBruce Richardson  * @param dev
118199a2dd95SBruce Richardson  *   Event device pointer
118299a2dd95SBruce Richardson  *
118399a2dd95SBruce Richardson  * @return
118499a2dd95SBruce Richardson  *   - 0: Success.
118599a2dd95SBruce Richardson  *   - <0: Error code on failure.
118699a2dd95SBruce Richardson  */
118799a2dd95SBruce Richardson typedef int (*eventdev_eth_tx_adapter_free_t)(uint8_t id,
118899a2dd95SBruce Richardson 					const struct rte_eventdev *dev);
118999a2dd95SBruce Richardson 
119099a2dd95SBruce Richardson /**
119199a2dd95SBruce Richardson  * Add a Tx queue to the adapter.
119299a2dd95SBruce Richardson  * A queue value of -1 is used to indicate all
119399a2dd95SBruce Richardson  * queues within the device.
119499a2dd95SBruce Richardson  *
119599a2dd95SBruce Richardson  * @param id
119699a2dd95SBruce Richardson  *   Adapter identifier
119799a2dd95SBruce Richardson  *
119899a2dd95SBruce Richardson  * @param dev
119999a2dd95SBruce Richardson  *   Event device pointer
120099a2dd95SBruce Richardson  *
120199a2dd95SBruce Richardson  * @param eth_dev
120299a2dd95SBruce Richardson  *   Ethernet device pointer
120399a2dd95SBruce Richardson  *
120499a2dd95SBruce Richardson  * @param tx_queue_id
120599a2dd95SBruce Richardson  *   Transmit queue index
120699a2dd95SBruce Richardson  *
120799a2dd95SBruce Richardson  * @return
120899a2dd95SBruce Richardson  *   - 0: Success.
120999a2dd95SBruce Richardson  *   - <0: Error code on failure.
121099a2dd95SBruce Richardson  */
121199a2dd95SBruce Richardson typedef int (*eventdev_eth_tx_adapter_queue_add_t)(
121299a2dd95SBruce Richardson 					uint8_t id,
121399a2dd95SBruce Richardson 					const struct rte_eventdev *dev,
121499a2dd95SBruce Richardson 					const struct rte_eth_dev *eth_dev,
121599a2dd95SBruce Richardson 					int32_t tx_queue_id);
121699a2dd95SBruce Richardson 
121799a2dd95SBruce Richardson /**
121899a2dd95SBruce Richardson  * Delete a Tx queue from the adapter.
121999a2dd95SBruce Richardson  * A queue value of -1 is used to indicate all
122099a2dd95SBruce Richardson  * queues within the device, that have been added to this
122199a2dd95SBruce Richardson  * adapter.
122299a2dd95SBruce Richardson  *
122399a2dd95SBruce Richardson  * @param id
122499a2dd95SBruce Richardson  *   Adapter identifier
122599a2dd95SBruce Richardson  *
122699a2dd95SBruce Richardson  * @param dev
122799a2dd95SBruce Richardson  *   Event device pointer
122899a2dd95SBruce Richardson  *
122999a2dd95SBruce Richardson  * @param eth_dev
123099a2dd95SBruce Richardson  *   Ethernet device pointer
123199a2dd95SBruce Richardson  *
123299a2dd95SBruce Richardson  * @param tx_queue_id
123399a2dd95SBruce Richardson  *   Transmit queue index
123499a2dd95SBruce Richardson  *
123599a2dd95SBruce Richardson  * @return
123699a2dd95SBruce Richardson  *  - 0: Success, Queues deleted successfully.
123799a2dd95SBruce Richardson  *  - <0: Error code on failure.
123899a2dd95SBruce Richardson  */
123999a2dd95SBruce Richardson typedef int (*eventdev_eth_tx_adapter_queue_del_t)(
124099a2dd95SBruce Richardson 					uint8_t id,
124199a2dd95SBruce Richardson 					const struct rte_eventdev *dev,
124299a2dd95SBruce Richardson 					const struct rte_eth_dev *eth_dev,
124399a2dd95SBruce Richardson 					int32_t tx_queue_id);
124499a2dd95SBruce Richardson 
124599a2dd95SBruce Richardson /**
124699a2dd95SBruce Richardson  * Start the adapter.
124799a2dd95SBruce Richardson  *
124899a2dd95SBruce Richardson  * @param id
124999a2dd95SBruce Richardson  *   Adapter identifier
125099a2dd95SBruce Richardson  *
125199a2dd95SBruce Richardson  * @param dev
125299a2dd95SBruce Richardson  *   Event device pointer
125399a2dd95SBruce Richardson  *
125499a2dd95SBruce Richardson  * @return
125599a2dd95SBruce Richardson  *  - 0: Success, Adapter started correctly.
125699a2dd95SBruce Richardson  *  - <0: Error code on failure.
125799a2dd95SBruce Richardson  */
125899a2dd95SBruce Richardson typedef int (*eventdev_eth_tx_adapter_start_t)(uint8_t id,
125999a2dd95SBruce Richardson 					const struct rte_eventdev *dev);
126099a2dd95SBruce Richardson 
126199a2dd95SBruce Richardson /**
126299a2dd95SBruce Richardson  * Stop the adapter.
126399a2dd95SBruce Richardson  *
126499a2dd95SBruce Richardson  * @param id
126599a2dd95SBruce Richardson  *  Adapter identifier
126699a2dd95SBruce Richardson  *
126799a2dd95SBruce Richardson  * @param dev
126899a2dd95SBruce Richardson  *   Event device pointer
126999a2dd95SBruce Richardson  *
127099a2dd95SBruce Richardson  * @return
127199a2dd95SBruce Richardson  *  - 0: Success.
127299a2dd95SBruce Richardson  *  - <0: Error code on failure.
127399a2dd95SBruce Richardson  */
127499a2dd95SBruce Richardson typedef int (*eventdev_eth_tx_adapter_stop_t)(uint8_t id,
127599a2dd95SBruce Richardson 					const struct rte_eventdev *dev);
127699a2dd95SBruce Richardson 
127799a2dd95SBruce Richardson struct rte_event_eth_tx_adapter_stats;
127899a2dd95SBruce Richardson 
127999a2dd95SBruce Richardson /**
128099a2dd95SBruce Richardson  * Retrieve statistics for an adapter
128199a2dd95SBruce Richardson  *
128299a2dd95SBruce Richardson  * @param id
128399a2dd95SBruce Richardson  *  Adapter identifier
128499a2dd95SBruce Richardson  *
128599a2dd95SBruce Richardson  * @param dev
128699a2dd95SBruce Richardson  *   Event device pointer
128799a2dd95SBruce Richardson  *
128899a2dd95SBruce Richardson  * @param [out] stats
128999a2dd95SBruce Richardson  *  A pointer to structure used to retrieve statistics for an adapter
129099a2dd95SBruce Richardson  *
129199a2dd95SBruce Richardson  * @return
129299a2dd95SBruce Richardson  *  - 0: Success, statistics retrieved successfully.
129399a2dd95SBruce Richardson  *  - <0: Error code on failure.
129499a2dd95SBruce Richardson  */
129599a2dd95SBruce Richardson typedef int (*eventdev_eth_tx_adapter_stats_get_t)(
129699a2dd95SBruce Richardson 				uint8_t id,
129799a2dd95SBruce Richardson 				const struct rte_eventdev *dev,
129899a2dd95SBruce Richardson 				struct rte_event_eth_tx_adapter_stats *stats);
129999a2dd95SBruce Richardson 
130099a2dd95SBruce Richardson /**
130199a2dd95SBruce Richardson  * Reset statistics for an adapter
130299a2dd95SBruce Richardson  *
130399a2dd95SBruce Richardson  * @param id
130499a2dd95SBruce Richardson  *  Adapter identifier
130599a2dd95SBruce Richardson  *
130699a2dd95SBruce Richardson  * @param dev
130799a2dd95SBruce Richardson  *   Event device pointer
130899a2dd95SBruce Richardson  *
130999a2dd95SBruce Richardson  * @return
131099a2dd95SBruce Richardson  *  - 0: Success, statistics retrieved successfully.
131199a2dd95SBruce Richardson  *  - <0: Error code on failure.
131299a2dd95SBruce Richardson  */
131399a2dd95SBruce Richardson typedef int (*eventdev_eth_tx_adapter_stats_reset_t)(uint8_t id,
131499a2dd95SBruce Richardson 					const struct rte_eventdev *dev);
131599a2dd95SBruce Richardson 
1316b2963cbdSGanapati Kundapura /**
1317b2963cbdSGanapati Kundapura  * Get TX adapter instance ID for Tx queue
1318b2963cbdSGanapati Kundapura  *
1319b2963cbdSGanapati Kundapura  * @param eth_dev_id
1320b2963cbdSGanapati Kundapura  *  Port identifier of Ethernet device
1321b2963cbdSGanapati Kundapura  *
1322b2963cbdSGanapati Kundapura  * @param tx_queue_id
1323b2963cbdSGanapati Kundapura  *  Ethernet device Tx queue index
1324b2963cbdSGanapati Kundapura  *
1325b2963cbdSGanapati Kundapura  * @param[out] txa_inst_id
1326b2963cbdSGanapati Kundapura  *  Pointer to Tx adapter instance identifier
1327b2963cbdSGanapati Kundapura  *  Contains valid Tx adapter instance ID when return value is 0
1328b2963cbdSGanapati Kundapura  *
1329b2963cbdSGanapati Kundapura  * @return
1330b2963cbdSGanapati Kundapura  *  -  0: Success
1331b2963cbdSGanapati Kundapura  *  - <0: Error code on failure
1332b2963cbdSGanapati Kundapura  */
1333b2963cbdSGanapati Kundapura typedef int (*eventdev_eth_tx_adapter_instance_get_t)
1334b2963cbdSGanapati Kundapura 	(uint16_t eth_dev_id, uint16_t tx_queue_id, uint8_t *txa_inst_id);
1335b2963cbdSGanapati Kundapura 
13363c3328aeSNaga Harish K S V /**
13373c3328aeSNaga Harish K S V  * Start a Tx queue that is assigned to Tx adapter instance
13383c3328aeSNaga Harish K S V  *
13393c3328aeSNaga Harish K S V  * @param id
13403c3328aeSNaga Harish K S V  *  Adapter identifier
13413c3328aeSNaga Harish K S V  *
13423c3328aeSNaga Harish K S V  * @param eth_dev_id
13433c3328aeSNaga Harish K S V  *  Port identifier of Ethernet device
13443c3328aeSNaga Harish K S V  *
13453c3328aeSNaga Harish K S V  * @param tx_queue_id
13463c3328aeSNaga Harish K S V  *  Ethernet device Tx queue index
13473c3328aeSNaga Harish K S V  *
13483c3328aeSNaga Harish K S V  * @return
13493c3328aeSNaga Harish K S V  *  -  0: Success
13503c3328aeSNaga Harish K S V  *  - <0: Error code on failure
13513c3328aeSNaga Harish K S V  */
13523c3328aeSNaga Harish K S V typedef int (*eventdev_eth_tx_adapter_queue_start)
13533c3328aeSNaga Harish K S V 	(uint8_t id, uint16_t eth_dev_id, uint16_t tx_queue_id);
13543c3328aeSNaga Harish K S V 
13553c3328aeSNaga Harish K S V /**
13563c3328aeSNaga Harish K S V  * Stop a Tx queue that is assigned to Tx adapter instance
13573c3328aeSNaga Harish K S V  *
13583c3328aeSNaga Harish K S V  * @param id
13593c3328aeSNaga Harish K S V  *  Adapter identifier
13603c3328aeSNaga Harish K S V  *
13613c3328aeSNaga Harish K S V  * @param eth_dev_id
13623c3328aeSNaga Harish K S V  *  Port identifier of Ethernet device
13633c3328aeSNaga Harish K S V  *
13643c3328aeSNaga Harish K S V  * @param tx_queue_id
13653c3328aeSNaga Harish K S V  *  Ethernet device Tx queue index
13663c3328aeSNaga Harish K S V  *
13673c3328aeSNaga Harish K S V  * @return
13683c3328aeSNaga Harish K S V  *  -  0: Success
13693c3328aeSNaga Harish K S V  *  - <0: Error code on failure
13703c3328aeSNaga Harish K S V  */
13713c3328aeSNaga Harish K S V typedef int (*eventdev_eth_tx_adapter_queue_stop)
13723c3328aeSNaga Harish K S V 	(uint8_t id, uint16_t eth_dev_id, uint16_t tx_queue_id);
1373b2963cbdSGanapati Kundapura 
1374d986276fSPavan Nikhilesh #define eventdev_stop_flush_t rte_eventdev_stop_flush_t
1375d986276fSPavan Nikhilesh 
137666a30a29SAmit Prakash Shukla /**
137766a30a29SAmit Prakash Shukla  * Retrieve the event device's DMA adapter capabilities for the
137866a30a29SAmit Prakash Shukla  * specified DMA device
137966a30a29SAmit Prakash Shukla  *
138066a30a29SAmit Prakash Shukla  * @param dev
138166a30a29SAmit Prakash Shukla  *   Event device pointer
138266a30a29SAmit Prakash Shukla  *
138366a30a29SAmit Prakash Shukla  * @param dma_dev_id
138466a30a29SAmit Prakash Shukla  *   DMA device identifier
138566a30a29SAmit Prakash Shukla  *
138666a30a29SAmit Prakash Shukla  * @param[out] caps
138766a30a29SAmit Prakash Shukla  *   A pointer to memory filled with event adapter capabilities.
138866a30a29SAmit Prakash Shukla  *   It is expected to be pre-allocated & initialized by caller.
138966a30a29SAmit Prakash Shukla  *
139066a30a29SAmit Prakash Shukla  * @return
139166a30a29SAmit Prakash Shukla  *   - 0: Success, driver provides event adapter capabilities for the
139266a30a29SAmit Prakash Shukla  *	dmadev.
139366a30a29SAmit Prakash Shukla  *   - <0: Error code returned by the driver function.
139466a30a29SAmit Prakash Shukla  *
139566a30a29SAmit Prakash Shukla  */
139666a30a29SAmit Prakash Shukla typedef int (*eventdev_dma_adapter_caps_get_t)(const struct rte_eventdev *dev,
139766a30a29SAmit Prakash Shukla 					       const int16_t dma_dev_id, uint32_t *caps);
139866a30a29SAmit Prakash Shukla 
139966a30a29SAmit Prakash Shukla /**
140066a30a29SAmit Prakash Shukla  * Add DMA vchan queue to event device. This callback is invoked if
140166a30a29SAmit Prakash Shukla  * the caps returned from rte_event_dma_adapter_caps_get(, dmadev_id)
140266a30a29SAmit Prakash Shukla  * has RTE_EVENT_DMA_ADAPTER_CAP_INTERNAL_PORT_* set.
140366a30a29SAmit Prakash Shukla  *
140466a30a29SAmit Prakash Shukla  * @param dev
140566a30a29SAmit Prakash Shukla  *   Event device pointer
140666a30a29SAmit Prakash Shukla  *
140766a30a29SAmit Prakash Shukla  * @param dma_dev_id
140866a30a29SAmit Prakash Shukla  *   DMA device identifier
140966a30a29SAmit Prakash Shukla  *
141066a30a29SAmit Prakash Shukla  * @param vchan_id
141166a30a29SAmit Prakash Shukla  *   dmadev vchan queue identifier.
141266a30a29SAmit Prakash Shukla  *
141366a30a29SAmit Prakash Shukla  * @param event
141466a30a29SAmit Prakash Shukla  *   Event information required for binding dmadev vchan to event queue.
141566a30a29SAmit Prakash Shukla  *   This structure will have a valid value for only those HW PMDs supporting
141666a30a29SAmit Prakash Shukla  *   @see RTE_EVENT_DMA_ADAPTER_CAP_INTERNAL_PORT_VCHAN_EV_BIND capability.
141766a30a29SAmit Prakash Shukla  *
141866a30a29SAmit Prakash Shukla  * @return
141966a30a29SAmit Prakash Shukla  *   - 0: Success, dmadev vchan added successfully.
142066a30a29SAmit Prakash Shukla  *   - <0: Error code returned by the driver function.
142166a30a29SAmit Prakash Shukla  *
142266a30a29SAmit Prakash Shukla  */
142366a30a29SAmit Prakash Shukla typedef int (*eventdev_dma_adapter_vchan_add_t)(const struct rte_eventdev *dev,
142466a30a29SAmit Prakash Shukla 						const int16_t dma_dev_id,
142566a30a29SAmit Prakash Shukla 						uint16_t vchan_id,
142666a30a29SAmit Prakash Shukla 						const struct rte_event *event);
142766a30a29SAmit Prakash Shukla 
142866a30a29SAmit Prakash Shukla /**
142966a30a29SAmit Prakash Shukla  * Delete DMA vhcan to event device. This callback is invoked if
143066a30a29SAmit Prakash Shukla  * the caps returned from rte_event_dma_adapter_caps_get(, dmadev_id)
143166a30a29SAmit Prakash Shukla  * has RTE_EVENT_DMA_ADAPTER_CAP_INTERNAL_PORT_* set.
143266a30a29SAmit Prakash Shukla  *
143366a30a29SAmit Prakash Shukla  * @param dev
143466a30a29SAmit Prakash Shukla  *   Event device pointer
143566a30a29SAmit Prakash Shukla  *
143666a30a29SAmit Prakash Shukla  * @param dma_dev_id
143766a30a29SAmit Prakash Shukla  *   DMA device identifier
143866a30a29SAmit Prakash Shukla  *
143966a30a29SAmit Prakash Shukla  * @param vchan_id
144066a30a29SAmit Prakash Shukla  *   dmadev vchan identifier.
144166a30a29SAmit Prakash Shukla  *
144266a30a29SAmit Prakash Shukla  * @return
144366a30a29SAmit Prakash Shukla  *   - 0: Success, dmadev vchan deleted successfully.
144466a30a29SAmit Prakash Shukla  *   - <0: Error code returned by the driver function.
144566a30a29SAmit Prakash Shukla  *
144666a30a29SAmit Prakash Shukla  */
144766a30a29SAmit Prakash Shukla typedef int (*eventdev_dma_adapter_vchan_del_t)(const struct rte_eventdev *dev,
144866a30a29SAmit Prakash Shukla 						const int16_t dma_dev_id,
144966a30a29SAmit Prakash Shukla 						uint16_t vchan_id);
145066a30a29SAmit Prakash Shukla 
145166a30a29SAmit Prakash Shukla /**
145266a30a29SAmit Prakash Shukla  * Start DMA adapter. This callback is invoked if
145366a30a29SAmit Prakash Shukla  * the caps returned from rte_event_dma_adapter_caps_get(.., dmadev_id)
145466a30a29SAmit Prakash Shukla  * has RTE_EVENT_DMA_ADAPTER_CAP_INTERNAL_PORT_* set and vchan for dmadev_id
145566a30a29SAmit Prakash Shukla  * have been added to the event device.
145666a30a29SAmit Prakash Shukla  *
145766a30a29SAmit Prakash Shukla  * @param dev
145866a30a29SAmit Prakash Shukla  *   Event device pointer
145966a30a29SAmit Prakash Shukla  *
146066a30a29SAmit Prakash Shukla  * @param dma_dev_id
146166a30a29SAmit Prakash Shukla  *   DMA device identifier
146266a30a29SAmit Prakash Shukla  *
146366a30a29SAmit Prakash Shukla  * @return
146466a30a29SAmit Prakash Shukla  *   - 0: Success, DMA adapter started successfully.
146566a30a29SAmit Prakash Shukla  *   - <0: Error code returned by the driver function.
146666a30a29SAmit Prakash Shukla  */
146766a30a29SAmit Prakash Shukla typedef int (*eventdev_dma_adapter_start_t)(const struct rte_eventdev *dev,
146866a30a29SAmit Prakash Shukla 					    const int16_t dma_dev_id);
146966a30a29SAmit Prakash Shukla 
147066a30a29SAmit Prakash Shukla /**
147166a30a29SAmit Prakash Shukla  * Stop DMA adapter. This callback is invoked if
147266a30a29SAmit Prakash Shukla  * the caps returned from rte_event_dma_adapter_caps_get(.., dmadev_id)
147366a30a29SAmit Prakash Shukla  * has RTE_EVENT_DMA_ADAPTER_CAP_INTERNAL_PORT_* set and vchan for dmadev_id
147466a30a29SAmit Prakash Shukla  * have been added to the event device.
147566a30a29SAmit Prakash Shukla  *
147666a30a29SAmit Prakash Shukla  * @param dev
147766a30a29SAmit Prakash Shukla  *   Event device pointer
147866a30a29SAmit Prakash Shukla  *
147966a30a29SAmit Prakash Shukla  * @param dma_dev_id
148066a30a29SAmit Prakash Shukla  *   DMA device identifier
148166a30a29SAmit Prakash Shukla  *
148266a30a29SAmit Prakash Shukla  * @return
148366a30a29SAmit Prakash Shukla  *   - 0: Success, DMA adapter stopped successfully.
148466a30a29SAmit Prakash Shukla  *   - <0: Error code returned by the driver function.
148566a30a29SAmit Prakash Shukla  */
148666a30a29SAmit Prakash Shukla typedef int (*eventdev_dma_adapter_stop_t)(const struct rte_eventdev *dev,
148766a30a29SAmit Prakash Shukla 					   const int16_t dma_dev_id);
148866a30a29SAmit Prakash Shukla 
148966a30a29SAmit Prakash Shukla struct rte_event_dma_adapter_stats;
149066a30a29SAmit Prakash Shukla 
149166a30a29SAmit Prakash Shukla /**
149266a30a29SAmit Prakash Shukla  * Retrieve DMA adapter statistics.
149366a30a29SAmit Prakash Shukla  *
149466a30a29SAmit Prakash Shukla  * @param dev
149566a30a29SAmit Prakash Shukla  *   Event device pointer
149666a30a29SAmit Prakash Shukla  *
149766a30a29SAmit Prakash Shukla  * @param dma_dev_id
149866a30a29SAmit Prakash Shukla  *   DMA device identifier
149966a30a29SAmit Prakash Shukla  *
150066a30a29SAmit Prakash Shukla  * @param[out] stats
150166a30a29SAmit Prakash Shukla  *   Pointer to stats structure
150266a30a29SAmit Prakash Shukla  *
150366a30a29SAmit Prakash Shukla  * @return
150466a30a29SAmit Prakash Shukla  *   Return 0 on success.
150566a30a29SAmit Prakash Shukla  */
150666a30a29SAmit Prakash Shukla typedef int (*eventdev_dma_adapter_stats_get)(const struct rte_eventdev *dev,
150766a30a29SAmit Prakash Shukla 					      const int16_t dma_dev_id,
150866a30a29SAmit Prakash Shukla 					      struct rte_event_dma_adapter_stats *stats);
150966a30a29SAmit Prakash Shukla 
151066a30a29SAmit Prakash Shukla /**
151166a30a29SAmit Prakash Shukla  * Reset DMA adapter statistics.
151266a30a29SAmit Prakash Shukla  *
151366a30a29SAmit Prakash Shukla  * @param dev
151466a30a29SAmit Prakash Shukla  *   Event device pointer
151566a30a29SAmit Prakash Shukla  *
151666a30a29SAmit Prakash Shukla  * @param dma_dev_id
151766a30a29SAmit Prakash Shukla  *   DMA device identifier
151866a30a29SAmit Prakash Shukla  *
151966a30a29SAmit Prakash Shukla  * @return
152066a30a29SAmit Prakash Shukla  *   Return 0 on success.
152166a30a29SAmit Prakash Shukla  */
152266a30a29SAmit Prakash Shukla typedef int (*eventdev_dma_adapter_stats_reset)(const struct rte_eventdev *dev,
152366a30a29SAmit Prakash Shukla 						const int16_t dma_dev_id);
152466a30a29SAmit Prakash Shukla 
152566a30a29SAmit Prakash Shukla 
152699a2dd95SBruce Richardson /** Event device operations function pointer table */
152723d06e37SPavan Nikhilesh struct eventdev_ops {
152899a2dd95SBruce Richardson 	eventdev_info_get_t dev_infos_get;	/**< Get device info. */
152999a2dd95SBruce Richardson 	eventdev_configure_t dev_configure;	/**< Configure device. */
153099a2dd95SBruce Richardson 	eventdev_start_t dev_start;		/**< Start device. */
153199a2dd95SBruce Richardson 	eventdev_stop_t dev_stop;		/**< Stop device. */
153299a2dd95SBruce Richardson 	eventdev_close_t dev_close;		/**< Close device. */
153399a2dd95SBruce Richardson 
153499a2dd95SBruce Richardson 	eventdev_queue_default_conf_get_t queue_def_conf;
153599a2dd95SBruce Richardson 	/**< Get default queue configuration. */
153699a2dd95SBruce Richardson 	eventdev_queue_setup_t queue_setup;
153799a2dd95SBruce Richardson 	/**< Set up an event queue. */
153899a2dd95SBruce Richardson 	eventdev_queue_release_t queue_release;
153999a2dd95SBruce Richardson 	/**< Release an event queue. */
154097b914f4SShijith Thotton 	eventdev_queue_attr_set_t queue_attr_set;
154197b914f4SShijith Thotton 	/**< Set an event queue attribute. */
154299a2dd95SBruce Richardson 
154399a2dd95SBruce Richardson 	eventdev_port_default_conf_get_t port_def_conf;
154499a2dd95SBruce Richardson 	/**< Get default port configuration. */
154599a2dd95SBruce Richardson 	eventdev_port_setup_t port_setup;
154699a2dd95SBruce Richardson 	/**< Set up an event port. */
154799a2dd95SBruce Richardson 	eventdev_port_release_t port_release;
154899a2dd95SBruce Richardson 	/**< Release an event port. */
15491ff23ce6SPavan Nikhilesh 	eventdev_port_quiesce_t port_quiesce;
15501ff23ce6SPavan Nikhilesh 	/**< Quiesce an event port. */
155199a2dd95SBruce Richardson 
155299a2dd95SBruce Richardson 	eventdev_port_link_t port_link;
155399a2dd95SBruce Richardson 	/**< Link event queues to an event port. */
1554*d007a7f3SPavan Nikhilesh 	eventdev_port_link_profile_t port_link_profile;
1555*d007a7f3SPavan Nikhilesh 	/**< Link event queues associated with a profile to an event port. */
155699a2dd95SBruce Richardson 	eventdev_port_unlink_t port_unlink;
155799a2dd95SBruce Richardson 	/**< Unlink event queues from an event port. */
1558*d007a7f3SPavan Nikhilesh 	eventdev_port_unlink_profile_t port_unlink_profile;
1559*d007a7f3SPavan Nikhilesh 	/**< Unlink event queues associated with a profile from an event port. */
156099a2dd95SBruce Richardson 	eventdev_port_unlinks_in_progress_t port_unlinks_in_progress;
156199a2dd95SBruce Richardson 	/**< Unlinks in progress on an event port. */
156299a2dd95SBruce Richardson 	eventdev_dequeue_timeout_ticks_t timeout_ticks;
156399a2dd95SBruce Richardson 	/**< Converts ns to *timeout_ticks* value for rte_event_dequeue() */
156499a2dd95SBruce Richardson 	eventdev_dump_t dump;
156599a2dd95SBruce Richardson 	/* Dump internal information */
156699a2dd95SBruce Richardson 
156799a2dd95SBruce Richardson 	eventdev_xstats_get_t xstats_get;
156899a2dd95SBruce Richardson 	/**< Get extended device statistics. */
156999a2dd95SBruce Richardson 	eventdev_xstats_get_names_t xstats_get_names;
157099a2dd95SBruce Richardson 	/**< Get names of extended stats. */
157199a2dd95SBruce Richardson 	eventdev_xstats_get_by_name xstats_get_by_name;
157299a2dd95SBruce Richardson 	/**< Get one value by name. */
157399a2dd95SBruce Richardson 	eventdev_xstats_reset_t xstats_reset;
157499a2dd95SBruce Richardson 	/**< Reset the statistics values in xstats. */
157599a2dd95SBruce Richardson 
157699a2dd95SBruce Richardson 	eventdev_eth_rx_adapter_caps_get_t eth_rx_adapter_caps_get;
157799a2dd95SBruce Richardson 	/**< Get ethernet Rx adapter capabilities */
157899a2dd95SBruce Richardson 	eventdev_eth_rx_adapter_queue_add_t eth_rx_adapter_queue_add;
157999a2dd95SBruce Richardson 	/**< Add Rx queues to ethernet Rx adapter */
158099a2dd95SBruce Richardson 	eventdev_eth_rx_adapter_queue_del_t eth_rx_adapter_queue_del;
158199a2dd95SBruce Richardson 	/**< Delete Rx queues from ethernet Rx adapter */
1582da781e64SGanapati Kundapura 	eventdev_eth_rx_adapter_queue_conf_get_t eth_rx_adapter_queue_conf_get;
1583da781e64SGanapati Kundapura 	/**< Get Rx adapter queue info */
158499a2dd95SBruce Richardson 	eventdev_eth_rx_adapter_start_t eth_rx_adapter_start;
158599a2dd95SBruce Richardson 	/**< Start ethernet Rx adapter */
158699a2dd95SBruce Richardson 	eventdev_eth_rx_adapter_stop_t eth_rx_adapter_stop;
158799a2dd95SBruce Richardson 	/**< Stop ethernet Rx adapter */
158899a2dd95SBruce Richardson 	eventdev_eth_rx_adapter_stats_get eth_rx_adapter_stats_get;
158999a2dd95SBruce Richardson 	/**< Get ethernet Rx stats */
159099a2dd95SBruce Richardson 	eventdev_eth_rx_adapter_stats_reset eth_rx_adapter_stats_reset;
159199a2dd95SBruce Richardson 	/**< Reset ethernet Rx stats */
159299a2dd95SBruce Richardson 	eventdev_eth_rx_adapter_vector_limits_get_t
159399a2dd95SBruce Richardson 		eth_rx_adapter_vector_limits_get;
159499a2dd95SBruce Richardson 	/**< Get event vector limits for the Rx adapter */
1595a1793ee8SGanapati Kundapura 	eventdev_eth_rx_adapter_instance_get_t eth_rx_adapter_instance_get;
1596a1793ee8SGanapati Kundapura 	/**< Get Rx adapter instance ID for Rx queue */
159799a2dd95SBruce Richardson 
159899a2dd95SBruce Richardson 	eventdev_timer_adapter_caps_get_t timer_adapter_caps_get;
159999a2dd95SBruce Richardson 	/**< Get timer adapter capabilities */
160099a2dd95SBruce Richardson 
160199a2dd95SBruce Richardson 	eventdev_crypto_adapter_caps_get_t crypto_adapter_caps_get;
160299a2dd95SBruce Richardson 	/**< Get crypto adapter capabilities */
160399a2dd95SBruce Richardson 	eventdev_crypto_adapter_queue_pair_add_t crypto_adapter_queue_pair_add;
160499a2dd95SBruce Richardson 	/**< Add queue pair to crypto adapter */
160599a2dd95SBruce Richardson 	eventdev_crypto_adapter_queue_pair_del_t crypto_adapter_queue_pair_del;
160699a2dd95SBruce Richardson 	/**< Delete queue pair from crypto adapter */
160799a2dd95SBruce Richardson 	eventdev_crypto_adapter_start_t crypto_adapter_start;
160899a2dd95SBruce Richardson 	/**< Start crypto adapter */
160999a2dd95SBruce Richardson 	eventdev_crypto_adapter_stop_t crypto_adapter_stop;
161099a2dd95SBruce Richardson 	/**< Stop crypto adapter */
161199a2dd95SBruce Richardson 	eventdev_crypto_adapter_stats_get crypto_adapter_stats_get;
161299a2dd95SBruce Richardson 	/**< Get crypto stats */
161399a2dd95SBruce Richardson 	eventdev_crypto_adapter_stats_reset crypto_adapter_stats_reset;
161499a2dd95SBruce Richardson 	/**< Reset crypto stats */
1615c1749bc5SVolodymyr Fialko 	eventdev_crypto_adapter_vector_limits_get_t
1616c1749bc5SVolodymyr Fialko 		crypto_adapter_vector_limits_get;
1617c1749bc5SVolodymyr Fialko 	/**< Get event vector limits for the crypto adapter */
161899a2dd95SBruce Richardson 
1619995b150cSNaga Harish K S V 	eventdev_eth_rx_adapter_q_stats_get eth_rx_adapter_queue_stats_get;
1620995b150cSNaga Harish K S V 	/**< Get ethernet Rx queue stats */
1621995b150cSNaga Harish K S V 	eventdev_eth_rx_adapter_q_stats_reset eth_rx_adapter_queue_stats_reset;
1622995b150cSNaga Harish K S V 	/**< Reset ethernet Rx queue stats */
1623995b150cSNaga Harish K S V 
162499a2dd95SBruce Richardson 	eventdev_eth_tx_adapter_caps_get_t eth_tx_adapter_caps_get;
162599a2dd95SBruce Richardson 	/**< Get ethernet Tx adapter capabilities */
162699a2dd95SBruce Richardson 
162799a2dd95SBruce Richardson 	eventdev_eth_tx_adapter_create_t eth_tx_adapter_create;
162899a2dd95SBruce Richardson 	/**< Create adapter callback */
162999a2dd95SBruce Richardson 	eventdev_eth_tx_adapter_free_t eth_tx_adapter_free;
163099a2dd95SBruce Richardson 	/**< Free adapter callback */
163199a2dd95SBruce Richardson 	eventdev_eth_tx_adapter_queue_add_t eth_tx_adapter_queue_add;
163299a2dd95SBruce Richardson 	/**< Add Tx queues to the eth Tx adapter */
163399a2dd95SBruce Richardson 	eventdev_eth_tx_adapter_queue_del_t eth_tx_adapter_queue_del;
163499a2dd95SBruce Richardson 	/**< Delete Tx queues from the eth Tx adapter */
163599a2dd95SBruce Richardson 	eventdev_eth_tx_adapter_start_t eth_tx_adapter_start;
163699a2dd95SBruce Richardson 	/**< Start eth Tx adapter */
163799a2dd95SBruce Richardson 	eventdev_eth_tx_adapter_stop_t eth_tx_adapter_stop;
163899a2dd95SBruce Richardson 	/**< Stop eth Tx adapter */
163999a2dd95SBruce Richardson 	eventdev_eth_tx_adapter_stats_get_t eth_tx_adapter_stats_get;
164099a2dd95SBruce Richardson 	/**< Get eth Tx adapter statistics */
164199a2dd95SBruce Richardson 	eventdev_eth_tx_adapter_stats_reset_t eth_tx_adapter_stats_reset;
164299a2dd95SBruce Richardson 	/**< Reset eth Tx adapter statistics */
1643b2963cbdSGanapati Kundapura 	eventdev_eth_tx_adapter_instance_get_t eth_tx_adapter_instance_get;
1644b2963cbdSGanapati Kundapura 	/**< Get Tx adapter instance ID for Tx queue */
16453c3328aeSNaga Harish K S V 	eventdev_eth_tx_adapter_queue_start eth_tx_adapter_queue_start;
16463c3328aeSNaga Harish K S V 	/**< Start Tx queue assigned to Tx adapter instance */
16473c3328aeSNaga Harish K S V 	eventdev_eth_tx_adapter_queue_stop eth_tx_adapter_queue_stop;
16483c3328aeSNaga Harish K S V 	/**< Stop Tx queue assigned to Tx adapter instance */
164999a2dd95SBruce Richardson 
165066a30a29SAmit Prakash Shukla 	eventdev_dma_adapter_caps_get_t dma_adapter_caps_get;
165166a30a29SAmit Prakash Shukla 	/**< Get DMA adapter capabilities */
165266a30a29SAmit Prakash Shukla 	eventdev_dma_adapter_vchan_add_t dma_adapter_vchan_add;
165366a30a29SAmit Prakash Shukla 	/**< Add vchan queue to DMA adapter */
165466a30a29SAmit Prakash Shukla 	eventdev_dma_adapter_vchan_del_t dma_adapter_vchan_del;
165566a30a29SAmit Prakash Shukla 	/**< Delete vchan queue from DMA adapter */
165666a30a29SAmit Prakash Shukla 	eventdev_dma_adapter_start_t dma_adapter_start;
165766a30a29SAmit Prakash Shukla 	/**< Start DMA adapter */
165866a30a29SAmit Prakash Shukla 	eventdev_dma_adapter_stop_t dma_adapter_stop;
165966a30a29SAmit Prakash Shukla 	/**< Stop DMA adapter */
166066a30a29SAmit Prakash Shukla 	eventdev_dma_adapter_stats_get dma_adapter_stats_get;
166166a30a29SAmit Prakash Shukla 	/**< Get DMA stats */
166266a30a29SAmit Prakash Shukla 	eventdev_dma_adapter_stats_reset dma_adapter_stats_reset;
166366a30a29SAmit Prakash Shukla 	/**< Reset DMA stats */
166466a30a29SAmit Prakash Shukla 
166599a2dd95SBruce Richardson 	eventdev_selftest dev_selftest;
166699a2dd95SBruce Richardson 	/**< Start eventdev Selftest */
166799a2dd95SBruce Richardson 
166899a2dd95SBruce Richardson 	eventdev_stop_flush_t dev_stop_flush;
166999a2dd95SBruce Richardson 	/**< User-provided event flush function */
167099a2dd95SBruce Richardson };
167199a2dd95SBruce Richardson 
167299a2dd95SBruce Richardson /**
167399a2dd95SBruce Richardson  * Allocates a new eventdev slot for an event device and returns the pointer
167499a2dd95SBruce Richardson  * to that slot for the driver to use.
167599a2dd95SBruce Richardson  *
167699a2dd95SBruce Richardson  * @param name
167799a2dd95SBruce Richardson  *   Unique identifier name for each device
167899a2dd95SBruce Richardson  * @param socket_id
167999a2dd95SBruce Richardson  *   Socket to allocate resources on.
168099a2dd95SBruce Richardson  * @return
168199a2dd95SBruce Richardson  *   - Slot in the rte_dev_devices array for a new device;
168299a2dd95SBruce Richardson  */
168323d06e37SPavan Nikhilesh __rte_internal
168499a2dd95SBruce Richardson struct rte_eventdev *
168599a2dd95SBruce Richardson rte_event_pmd_allocate(const char *name, int socket_id);
168699a2dd95SBruce Richardson 
168799a2dd95SBruce Richardson /**
168899a2dd95SBruce Richardson  * Release the specified eventdev device.
168999a2dd95SBruce Richardson  *
169099a2dd95SBruce Richardson  * @param eventdev
169199a2dd95SBruce Richardson  * The *eventdev* pointer is the address of the *rte_eventdev* structure.
169299a2dd95SBruce Richardson  * @return
169399a2dd95SBruce Richardson  *   - 0 on success, negative on error
169499a2dd95SBruce Richardson  */
169523d06e37SPavan Nikhilesh __rte_internal
169699a2dd95SBruce Richardson int
169799a2dd95SBruce Richardson rte_event_pmd_release(struct rte_eventdev *eventdev);
169899a2dd95SBruce Richardson 
1699d35e6132SPavan Nikhilesh /**
1700d35e6132SPavan Nikhilesh  *
1701d35e6132SPavan Nikhilesh  * @internal
1702d35e6132SPavan Nikhilesh  * This is the last step of device probing.
1703d35e6132SPavan Nikhilesh  * It must be called after a port is allocated and initialized successfully.
1704d35e6132SPavan Nikhilesh  *
1705d35e6132SPavan Nikhilesh  * @param eventdev
1706d35e6132SPavan Nikhilesh  *  New event device.
1707d35e6132SPavan Nikhilesh  */
1708d35e6132SPavan Nikhilesh __rte_internal
1709d35e6132SPavan Nikhilesh void
1710d35e6132SPavan Nikhilesh event_dev_probing_finish(struct rte_eventdev *eventdev);
1711d35e6132SPavan Nikhilesh 
1712d35e6132SPavan Nikhilesh /**
1713d35e6132SPavan Nikhilesh  * Reset eventdevice fastpath APIs to dummy values.
1714d35e6132SPavan Nikhilesh  *
1715d35e6132SPavan Nikhilesh  * @param fp_ops
1716d35e6132SPavan Nikhilesh  * The *fp_ops* pointer to reset.
1717d35e6132SPavan Nikhilesh  */
1718d35e6132SPavan Nikhilesh __rte_internal
1719d35e6132SPavan Nikhilesh void
1720d35e6132SPavan Nikhilesh event_dev_fp_ops_reset(struct rte_event_fp_ops *fp_op);
1721d35e6132SPavan Nikhilesh 
1722d35e6132SPavan Nikhilesh /**
1723d35e6132SPavan Nikhilesh  * Set eventdevice fastpath APIs to event device values.
1724d35e6132SPavan Nikhilesh  *
1725d35e6132SPavan Nikhilesh  * @param fp_ops
1726d35e6132SPavan Nikhilesh  * The *fp_ops* pointer to set.
1727d35e6132SPavan Nikhilesh  */
1728d35e6132SPavan Nikhilesh __rte_internal
1729d35e6132SPavan Nikhilesh void
1730d35e6132SPavan Nikhilesh event_dev_fp_ops_set(struct rte_event_fp_ops *fp_ops,
1731d35e6132SPavan Nikhilesh 		     const struct rte_eventdev *dev);
1732d35e6132SPavan Nikhilesh 
17332c552933SBrian Dooley #ifdef __cplusplus
17342c552933SBrian Dooley }
17352c552933SBrian Dooley #endif
17362c552933SBrian Dooley 
173799a2dd95SBruce Richardson #endif /* _RTE_EVENTDEV_PMD_H_ */
1738