1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 Intel Corporation.
6 #ifndef _RTE_EVENT_ETH_RX_ADAPTER_
7 #define _RTE_EVENT_ETH_RX_ADAPTER_
12 * RTE Event Ethernet Rx Adapter
14 * An eventdev-based packet processing application enqueues/dequeues mbufs
15 * to/from the event device. Packet flow from the ethernet device to the event
16 * device can be accomplished using either HW or SW mechanisms depending on the
17 * platform and the particular combination of ethernet and event devices. The
18 * event ethernet Rx adapter provides common APIs to configure the packet flow
19 * from the ethernet devices to event devices across both these transfer
22 * The adapter uses a EAL service core function for SW based packet transfer
23 * and uses the eventdev PMD functions to configure HW based packet transfer
24 * between the ethernet device and the event device. For SW based packet
25 * transfer, if the mbuf does not have a timestamp set, the adapter adds a
26 * timestamp to the mbuf using rte_get_tsc_cycles(), this provides a more
27 * accurate timestamp as compared to if the application were to set the time
28 * stamp since it avoids event device schedule latency.
30 * The ethernet Rx event adapter's functions are:
31 * - rte_event_eth_rx_adapter_create_ext()
32 * - rte_event_eth_rx_adapter_create()
33 * - rte_event_eth_rx_adapter_free()
34 * - rte_event_eth_rx_adapter_queue_add()
35 * - rte_event_eth_rx_adapter_queue_del()
36 * - rte_event_eth_rx_adapter_start()
37 * - rte_event_eth_rx_adapter_stop()
38 * - rte_event_eth_rx_adapter_stats_get()
39 * - rte_event_eth_rx_adapter_stats_reset()
41 * The application creates an ethernet to event adapter using
42 * rte_event_eth_rx_adapter_create_ext() or rte_event_eth_rx_adapter_create()
44 * The adapter needs to know which ethernet rx queues to poll for mbufs as well
45 * as event device parameters such as the event queue identifier, event
46 * priority and scheduling type that the adapter should use when constructing
47 * events. The rte_event_eth_rx_adapter_queue_add() function is provided for
49 * The servicing weight parameter in the rte_event_eth_rx_adapter_queue_conf
50 * is applicable when the Rx adapter uses a service core function and is
51 * intended to provide application control of the frequency of polling ethernet
52 * device receive queues, for example, the application may want to poll higher
53 * priority queues with a higher frequency but at the same time not starve
54 * lower priority queues completely. If this parameter is zero and the receive
55 * interrupt is enabled when configuring the device, the receive queue is
56 * interrupt driven; else, the queue is assigned a servicing weight of one.
58 * The application can start/stop the adapter using the
59 * rte_event_eth_rx_adapter_start() and the rte_event_eth_rx_adapter_stop()
60 * functions. If the adapter uses a rte_service function, then the application
61 * is also required to assign a core to the service function and control the
62 * service core using the rte_service APIs. The
63 * rte_event_eth_rx_adapter_service_id_get() function can be used to retrieve
64 * the service function ID of the adapter in this case.
67 * 1) Interrupt driven receive queues are currently unimplemented.
68 * 2) Devices created after an instance of rte_event_eth_rx_adapter_create
69 * should be added to a new instance of the rx adapter.
78 #include <rte_service.h>
80 #include "rte_eventdev.h"
82 #define RTE_EVENT_ETH_RX_ADAPTER_MAX_INSTANCE 32
84 /* struct rte_event_eth_rx_adapter_queue_conf flags definitions */
85 #define RTE_EVENT_ETH_RX_ADAPTER_QUEUE_FLOW_ID_VALID 0x1
86 /**< This flag indicates the flow identifier is valid
87 * @see rte_event_eth_rx_adapter_queue_conf::rx_queue_flags
92 * @b EXPERIMENTAL: this API may change without prior notice
94 * Adapter configuration structure that the adapter configuration callback
95 * function is expected to fill out
96 * @see rte_event_eth_rx_adapter_conf_cb
98 struct rte_event_eth_rx_adapter_conf {
99 uint8_t event_port_id;
100 /**< Event port identifier, the adapter enqueues mbuf events to this
104 /**< The adapter can return early if it has processed at least
105 * max_nb_rx mbufs. This isn't treated as a requirement; batching may
106 * cause the adapter to process more than max_nb_rx mbufs.
112 * @b EXPERIMENTAL: this API may change without prior notice
114 * Function type used for adapter configuration callback. The callback is
115 * used to fill in members of the struct rte_event_eth_rx_adapter_conf, this
116 * callback is invoked when creating a SW service for packet transfer from
117 * ethdev queues to the event device. The SW service is created within the
118 * rte_event_eth_rx_adapter_queue_add() function if SW based packet transfers
119 * from ethdev queues to the event device are required.
122 * Adapter identifier.
125 * Event device identifier.
128 * Structure that needs to be populated by this callback.
131 * Argument to the callback. This is the same as the conf_arg passed to the
132 * rte_event_eth_rx_adapter_create_ext().
134 typedef int (*rte_event_eth_rx_adapter_conf_cb) (uint8_t id, uint8_t dev_id,
135 struct rte_event_eth_rx_adapter_conf *conf,
140 * @b EXPERIMENTAL: this API may change without prior notice
142 * Rx queue configuration structure
144 struct rte_event_eth_rx_adapter_queue_conf {
145 uint32_t rx_queue_flags;
146 /**< Flags for handling received packets
147 * @see RTE_EVENT_ETH_RX_ADAPTER_QUEUE_FLOW_ID_VALID
149 uint16_t servicing_weight;
150 /**< Relative polling frequency of ethernet receive queue when the
151 * adapter uses a service core function for ethernet to event device
152 * transfers. If it is set to zero, the Rx queue is interrupt driven
153 * (unless rx queue interrupts are not enabled for the ethernet
158 * The values from the following event fields will be used when
159 * queuing mbuf events:
160 * - event_queue_id: Targeted event queue ID for received packets.
161 * - event_priority: Event priority of packets from this Rx queue in
162 * the event queue relative to other events.
163 * - sched_type: Scheduling type for packets from this Rx queue.
164 * - flow_id: If the RTE_ETH_RX_EVENT_ADAPTER_QUEUE_FLOW_ID_VALID bit
165 * is set in rx_queue_flags, this flow_id is used for all
166 * packets received from this queue. Otherwise the flow ID
167 * is set to the RSS hash of the src and dst IPv4/6
170 * The event adapter sets ev.event_type to RTE_EVENT_TYPE_ETHDEV in the
177 * @b EXPERIMENTAL: this API may change without prior notice
179 * A structure used to retrieve statistics for an eth rx adapter instance.
181 struct rte_event_eth_rx_adapter_stats {
182 uint64_t rx_poll_count;
183 /**< Receive queue poll count */
185 /**< Received packet count */
186 uint64_t rx_enq_count;
187 /**< Eventdev enqueue count */
188 uint64_t rx_enq_retry;
189 /**< Eventdev enqueue retry count */
190 uint64_t rx_enq_start_ts;
191 /**< Rx enqueue start timestamp */
192 uint64_t rx_enq_block_cycles;
193 /**< Cycles for which the service is blocked by the event device,
194 * i.e, the service fails to enqueue to the event device.
196 uint64_t rx_enq_end_ts;
197 /**< Latest timestamp at which the service is unblocked
198 * by the event device. The start, end timestamps and
199 * block cycles can be used to compute the percentage of
200 * cycles the service is blocked by the event device.
206 * @b EXPERIMENTAL: this API may change without prior notice
208 * Create a new ethernet Rx event adapter with the specified identifier.
211 * The identifier of the ethernet Rx event adapter.
214 * The identifier of the device to configure.
217 * Callback function that fills in members of a
218 * struct rte_event_eth_rx_adapter_conf struct passed into
222 * Argument that is passed to the conf_cb function.
226 * - <0: Error code on failure
228 int rte_event_eth_rx_adapter_create_ext(uint8_t id, uint8_t dev_id,
229 rte_event_eth_rx_adapter_conf_cb conf_cb,
234 * @b EXPERIMENTAL: this API may change without prior notice
236 * Create a new ethernet Rx event adapter with the specified identifier.
237 * This function uses an internal configuration function that creates an event
238 * port. This default function reconfigures the event device with an
239 * additional event port and setups up the event port using the port_config
240 * parameter passed into this function. In case the application needs more
241 * control in configuration of the service, it should use the
242 * rte_event_eth_rx_adapter_create_ext() version.
245 * The identifier of the ethernet Rx event adapter.
248 * The identifier of the device to configure.
251 * Argument of type *rte_event_port_conf* that is passed to the conf_cb
256 * - <0: Error code on failure
258 int rte_event_eth_rx_adapter_create(uint8_t id, uint8_t dev_id,
259 struct rte_event_port_conf *port_config);
263 * @b EXPERIMENTAL: this API may change without prior notice
265 * Free an event adapter
268 * Adapter identifier.
272 * - <0: Error code on failure, If the adapter still has Rx queues
273 * added to it, the function returns -EBUSY.
275 int rte_event_eth_rx_adapter_free(uint8_t id);
279 * @b EXPERIMENTAL: this API may change without prior notice
281 * Add receive queue to an event adapter. After a queue has been
282 * added to the event adapter, the result of the application calling
283 * rte_eth_rx_burst(eth_dev_id, rx_queue_id, ..) is undefined.
286 * Adapter identifier.
289 * Port identifier of Ethernet device.
292 * Ethernet device receive queue index.
293 * If rx_queue_id is -1, then all Rx queues configured for
294 * the device are added. If the ethdev Rx queues can only be
295 * connected to a single event queue then rx_queue_id is
297 * @see RTE_EVENT_ETH_RX_ADAPTER_CAP_MULTI_EVENTQ
300 * Additional configuration structure of type *rte_event_eth_rx_adapter_conf*
303 * - 0: Success, Receive queue added correctly.
304 * - <0: Error code on failure.
305 * - (-EIO) device reconfiguration and restart error. The adapter reconfigures
306 * the event device with an additional port if it is required to use a service
307 * function for packet transfer from the ethernet device to the event device.
308 * If the device had been started before this call, this error code indicates
309 * an error in restart following an error in reconfiguration, i.e., a
310 * combination of the two error codes.
312 int rte_event_eth_rx_adapter_queue_add(uint8_t id,
315 const struct rte_event_eth_rx_adapter_queue_conf *conf);
319 * @b EXPERIMENTAL: this API may change without prior notice
321 * Delete receive queue from an event adapter.
324 * Adapter identifier.
327 * Port identifier of Ethernet device.
330 * Ethernet device receive queue index.
331 * If rx_queue_id is -1, then all Rx queues configured for
332 * the device are deleted. If the ethdev Rx queues can only be
333 * connected to a single event queue then rx_queue_id is
335 * @see RTE_EVENT_ETH_RX_ADAPTER_CAP_MULTI_EVENTQ
338 * - 0: Success, Receive queue deleted correctly.
339 * - <0: Error code on failure.
341 int rte_event_eth_rx_adapter_queue_del(uint8_t id, uint16_t eth_dev_id,
342 int32_t rx_queue_id);
346 * @b EXPERIMENTAL: this API may change without prior notice
348 * Start ethernet Rx event adapter
351 * Adapter identifier.
354 * - 0: Success, Adapter started correctly.
355 * - <0: Error code on failure.
357 int rte_event_eth_rx_adapter_start(uint8_t id);
361 * @b EXPERIMENTAL: this API may change without prior notice
363 * Stop ethernet Rx event adapter
366 * Adapter identifier.
369 * - 0: Success, Adapter started correctly.
370 * - <0: Error code on failure.
372 int rte_event_eth_rx_adapter_stop(uint8_t id);
376 * @b EXPERIMENTAL: this API may change without prior notice
378 * Retrieve statistics for an adapter
381 * Adapter identifier.
384 * A pointer to structure used to retrieve statistics for an adapter.
387 * - 0: Success, retrieved successfully.
388 * - <0: Error code on failure.
390 int rte_event_eth_rx_adapter_stats_get(uint8_t id,
391 struct rte_event_eth_rx_adapter_stats *stats);
395 * @b EXPERIMENTAL: this API may change without prior notice
397 * Reset statistics for an adapter.
400 * Adapter identifier.
403 * - 0: Success, statistics reset successfully.
404 * - <0: Error code on failure.
406 int rte_event_eth_rx_adapter_stats_reset(uint8_t id);
410 * @b EXPERIMENTAL: this API may change without prior notice
412 * Retrieve the service ID of an adapter. If the adapter doesn't use
413 * a rte_service function, this function returns -ESRCH.
416 * Adapter identifier.
418 * @param [out] service_id
419 * A pointer to a uint32_t, to be filled in with the service id.
423 * - <0: Error code on failure, if the adapter doesn't use a rte_service
424 * function, this function returns -ESRCH.
426 int rte_event_eth_rx_adapter_service_id_get(uint8_t id, uint32_t *service_id);
431 #endif /* _RTE_EVENT_ETH_RX_ADAPTER_ */