199a2dd95SBruce Richardson /* SPDX-License-Identifier: BSD-3-Clause 299a2dd95SBruce Richardson * Copyright(c) 2016 Cavium, Inc. 399a2dd95SBruce Richardson * Copyright(c) 2016-2018 Intel Corporation. 499a2dd95SBruce Richardson * Copyright 2016 NXP 599a2dd95SBruce Richardson * All rights reserved. 699a2dd95SBruce Richardson */ 799a2dd95SBruce Richardson 899a2dd95SBruce Richardson #ifndef _RTE_EVENTDEV_H_ 999a2dd95SBruce Richardson #define _RTE_EVENTDEV_H_ 1099a2dd95SBruce Richardson 1199a2dd95SBruce Richardson /** 1299a2dd95SBruce Richardson * @file 1399a2dd95SBruce Richardson * 1499a2dd95SBruce Richardson * RTE Event Device API 1599a2dd95SBruce Richardson * 1699a2dd95SBruce Richardson * In a polling model, lcores poll ethdev ports and associated rx queues 1799a2dd95SBruce Richardson * directly to look for packet. In an event driven model, by contrast, lcores 1899a2dd95SBruce Richardson * call the scheduler that selects packets for them based on programmer 1999a2dd95SBruce Richardson * specified criteria. Eventdev library adds support for event driven 2099a2dd95SBruce Richardson * programming model, which offer applications automatic multicore scaling, 2199a2dd95SBruce Richardson * dynamic load balancing, pipelining, packet ingress order maintenance and 2299a2dd95SBruce Richardson * synchronization services to simplify application packet processing. 2399a2dd95SBruce Richardson * 2499a2dd95SBruce Richardson * The Event Device API is composed of two parts: 2599a2dd95SBruce Richardson * 2699a2dd95SBruce Richardson * - The application-oriented Event API that includes functions to setup 2799a2dd95SBruce Richardson * an event device (configure it, setup its queues, ports and start it), to 2899a2dd95SBruce Richardson * establish the link between queues to port and to receive events, and so on. 2999a2dd95SBruce Richardson * 3099a2dd95SBruce Richardson * - The driver-oriented Event API that exports a function allowing 3199a2dd95SBruce Richardson * an event poll Mode Driver (PMD) to simultaneously register itself as 3299a2dd95SBruce Richardson * an event device driver. 3399a2dd95SBruce Richardson * 3499a2dd95SBruce Richardson * Event device components: 3599a2dd95SBruce Richardson * 3699a2dd95SBruce Richardson * +-----------------+ 3799a2dd95SBruce Richardson * | +-------------+ | 3899a2dd95SBruce Richardson * +-------+ | | flow 0 | | 3999a2dd95SBruce Richardson * |Packet | | +-------------+ | 4099a2dd95SBruce Richardson * |event | | +-------------+ | 4199a2dd95SBruce Richardson * | | | | flow 1 | |port_link(port0, queue0) 4299a2dd95SBruce Richardson * +-------+ | +-------------+ | | +--------+ 4399a2dd95SBruce Richardson * +-------+ | +-------------+ o-----v-----o |dequeue +------+ 4499a2dd95SBruce Richardson * |Crypto | | | flow n | | | event +------->|Core 0| 4599a2dd95SBruce Richardson * |work | | +-------------+ o----+ | port 0 | | | 4699a2dd95SBruce Richardson * |done ev| | event queue 0 | | +--------+ +------+ 4799a2dd95SBruce Richardson * +-------+ +-----------------+ | 4899a2dd95SBruce Richardson * +-------+ | 4999a2dd95SBruce Richardson * |Timer | +-----------------+ | +--------+ 5099a2dd95SBruce Richardson * |expiry | | +-------------+ | +------o |dequeue +------+ 5199a2dd95SBruce Richardson * |event | | | flow 0 | o-----------o event +------->|Core 1| 5299a2dd95SBruce Richardson * +-------+ | +-------------+ | +----o port 1 | | | 5399a2dd95SBruce Richardson * Event enqueue | +-------------+ | | +--------+ +------+ 5499a2dd95SBruce Richardson * o-------------> | | flow 1 | | | 5599a2dd95SBruce Richardson * enqueue( | +-------------+ | | 5699a2dd95SBruce Richardson * queue_id, | | | +--------+ +------+ 5799a2dd95SBruce Richardson * flow_id, | +-------------+ | | | |dequeue |Core 2| 5899a2dd95SBruce Richardson * sched_type, | | flow n | o-----------o event +------->| | 5999a2dd95SBruce Richardson * event_type, | +-------------+ | | | port 2 | +------+ 6099a2dd95SBruce Richardson * subev_type, | event queue 1 | | +--------+ 6199a2dd95SBruce Richardson * event) +-----------------+ | +--------+ 6299a2dd95SBruce Richardson * | | |dequeue +------+ 6399a2dd95SBruce Richardson * +-------+ +-----------------+ | | event +------->|Core n| 6499a2dd95SBruce Richardson * |Core | | +-------------+ o-----------o port n | | | 6599a2dd95SBruce Richardson * |(SW) | | | flow 0 | | | +--------+ +--+---+ 6699a2dd95SBruce Richardson * |event | | +-------------+ | | | 6799a2dd95SBruce Richardson * +-------+ | +-------------+ | | | 6899a2dd95SBruce Richardson * ^ | | flow 1 | | | | 6999a2dd95SBruce Richardson * | | +-------------+ o------+ | 7099a2dd95SBruce Richardson * | | +-------------+ | | 7199a2dd95SBruce Richardson * | | | flow n | | | 7299a2dd95SBruce Richardson * | | +-------------+ | | 7399a2dd95SBruce Richardson * | | event queue n | | 7499a2dd95SBruce Richardson * | +-----------------+ | 7599a2dd95SBruce Richardson * | | 7699a2dd95SBruce Richardson * +-----------------------------------------------------------+ 7799a2dd95SBruce Richardson * 7899a2dd95SBruce Richardson * Event device: A hardware or software-based event scheduler. 7999a2dd95SBruce Richardson * 8099a2dd95SBruce Richardson * Event: A unit of scheduling that encapsulates a packet or other datatype 8199a2dd95SBruce Richardson * like SW generated event from the CPU, Crypto work completion notification, 8299a2dd95SBruce Richardson * Timer expiry event notification etc as well as metadata. 8399a2dd95SBruce Richardson * The metadata includes flow ID, scheduling type, event priority, event_type, 8499a2dd95SBruce Richardson * sub_event_type etc. 8599a2dd95SBruce Richardson * 8699a2dd95SBruce Richardson * Event queue: A queue containing events that are scheduled by the event dev. 8799a2dd95SBruce Richardson * An event queue contains events of different flows associated with scheduling 8899a2dd95SBruce Richardson * types, such as atomic, ordered, or parallel. 8999a2dd95SBruce Richardson * 9099a2dd95SBruce Richardson * Event port: An application's interface into the event dev for enqueue and 9199a2dd95SBruce Richardson * dequeue operations. Each event port can be linked with one or more 9299a2dd95SBruce Richardson * event queues for dequeue operations. 9399a2dd95SBruce Richardson * 9499a2dd95SBruce Richardson * By default, all the functions of the Event Device API exported by a PMD 9599a2dd95SBruce Richardson * are lock-free functions which assume to not be invoked in parallel on 9699a2dd95SBruce Richardson * different logical cores to work on the same target object. For instance, 9799a2dd95SBruce Richardson * the dequeue function of a PMD cannot be invoked in parallel on two logical 9899a2dd95SBruce Richardson * cores to operates on same event port. Of course, this function 9999a2dd95SBruce Richardson * can be invoked in parallel by different logical cores on different ports. 10099a2dd95SBruce Richardson * It is the responsibility of the upper level application to enforce this rule. 10199a2dd95SBruce Richardson * 10299a2dd95SBruce Richardson * In all functions of the Event API, the Event device is 10399a2dd95SBruce Richardson * designated by an integer >= 0 named the device identifier *dev_id* 10499a2dd95SBruce Richardson * 10599a2dd95SBruce Richardson * At the Event driver level, Event devices are represented by a generic 10699a2dd95SBruce Richardson * data structure of type *rte_event_dev*. 10799a2dd95SBruce Richardson * 10899a2dd95SBruce Richardson * Event devices are dynamically registered during the PCI/SoC device probing 10999a2dd95SBruce Richardson * phase performed at EAL initialization time. 11099a2dd95SBruce Richardson * When an Event device is being probed, a *rte_event_dev* structure and 11199a2dd95SBruce Richardson * a new device identifier are allocated for that device. Then, the 11299a2dd95SBruce Richardson * event_dev_init() function supplied by the Event driver matching the probed 11399a2dd95SBruce Richardson * device is invoked to properly initialize the device. 11499a2dd95SBruce Richardson * 11599a2dd95SBruce Richardson * The role of the device init function consists of resetting the hardware or 11699a2dd95SBruce Richardson * software event driver implementations. 11799a2dd95SBruce Richardson * 11899a2dd95SBruce Richardson * If the device init operation is successful, the correspondence between 11999a2dd95SBruce Richardson * the device identifier assigned to the new device and its associated 12099a2dd95SBruce Richardson * *rte_event_dev* structure is effectively registered. 12199a2dd95SBruce Richardson * Otherwise, both the *rte_event_dev* structure and the device identifier are 12299a2dd95SBruce Richardson * freed. 12399a2dd95SBruce Richardson * 12499a2dd95SBruce Richardson * The functions exported by the application Event API to setup a device 12599a2dd95SBruce Richardson * designated by its device identifier must be invoked in the following order: 12699a2dd95SBruce Richardson * - rte_event_dev_configure() 12799a2dd95SBruce Richardson * - rte_event_queue_setup() 12899a2dd95SBruce Richardson * - rte_event_port_setup() 12999a2dd95SBruce Richardson * - rte_event_port_link() 13099a2dd95SBruce Richardson * - rte_event_dev_start() 13199a2dd95SBruce Richardson * 13299a2dd95SBruce Richardson * Then, the application can invoke, in any order, the functions 13399a2dd95SBruce Richardson * exported by the Event API to schedule events, dequeue events, enqueue events, 13499a2dd95SBruce Richardson * change event queue(s) to event port [un]link establishment and so on. 13599a2dd95SBruce Richardson * 13699a2dd95SBruce Richardson * Application may use rte_event_[queue/port]_default_conf_get() to get the 13799a2dd95SBruce Richardson * default configuration to set up an event queue or event port by 13899a2dd95SBruce Richardson * overriding few default values. 13999a2dd95SBruce Richardson * 14099a2dd95SBruce Richardson * If the application wants to change the configuration (i.e. call 14199a2dd95SBruce Richardson * rte_event_dev_configure(), rte_event_queue_setup(), or 14299a2dd95SBruce Richardson * rte_event_port_setup()), it must call rte_event_dev_stop() first to stop the 14399a2dd95SBruce Richardson * device and then do the reconfiguration before calling rte_event_dev_start() 14499a2dd95SBruce Richardson * again. The schedule, enqueue and dequeue functions should not be invoked 14599a2dd95SBruce Richardson * when the device is stopped. 14699a2dd95SBruce Richardson * 14799a2dd95SBruce Richardson * Finally, an application can close an Event device by invoking the 14899a2dd95SBruce Richardson * rte_event_dev_close() function. 14999a2dd95SBruce Richardson * 15099a2dd95SBruce Richardson * Each function of the application Event API invokes a specific function 15199a2dd95SBruce Richardson * of the PMD that controls the target device designated by its device 15299a2dd95SBruce Richardson * identifier. 15399a2dd95SBruce Richardson * 15499a2dd95SBruce Richardson * For this purpose, all device-specific functions of an Event driver are 15599a2dd95SBruce Richardson * supplied through a set of pointers contained in a generic structure of type 15699a2dd95SBruce Richardson * *event_dev_ops*. 15799a2dd95SBruce Richardson * The address of the *event_dev_ops* structure is stored in the *rte_event_dev* 15899a2dd95SBruce Richardson * structure by the device init function of the Event driver, which is 15999a2dd95SBruce Richardson * invoked during the PCI/SoC device probing phase, as explained earlier. 16099a2dd95SBruce Richardson * 16199a2dd95SBruce Richardson * In other words, each function of the Event API simply retrieves the 16299a2dd95SBruce Richardson * *rte_event_dev* structure associated with the device identifier and 16399a2dd95SBruce Richardson * performs an indirect invocation of the corresponding driver function 16499a2dd95SBruce Richardson * supplied in the *event_dev_ops* structure of the *rte_event_dev* structure. 16599a2dd95SBruce Richardson * 16699a2dd95SBruce Richardson * For performance reasons, the address of the fast-path functions of the 16799a2dd95SBruce Richardson * Event driver is not contained in the *event_dev_ops* structure. 16899a2dd95SBruce Richardson * Instead, they are directly stored at the beginning of the *rte_event_dev* 16999a2dd95SBruce Richardson * structure to avoid an extra indirect memory access during their invocation. 17099a2dd95SBruce Richardson * 17199a2dd95SBruce Richardson * RTE event device drivers do not use interrupts for enqueue or dequeue 17299a2dd95SBruce Richardson * operation. Instead, Event drivers export Poll-Mode enqueue and dequeue 17399a2dd95SBruce Richardson * functions to applications. 17499a2dd95SBruce Richardson * 17599a2dd95SBruce Richardson * The events are injected to event device through *enqueue* operation by 17699a2dd95SBruce Richardson * event producers in the system. The typical event producers are ethdev 17799a2dd95SBruce Richardson * subsystem for generating packet events, CPU(SW) for generating events based 17899a2dd95SBruce Richardson * on different stages of application processing, cryptodev for generating 17999a2dd95SBruce Richardson * crypto work completion notification etc 18099a2dd95SBruce Richardson * 18199a2dd95SBruce Richardson * The *dequeue* operation gets one or more events from the event ports. 18299a2dd95SBruce Richardson * The application process the events and send to downstream event queue through 18399a2dd95SBruce Richardson * rte_event_enqueue_burst() if it is an intermediate stage of event processing, 18499a2dd95SBruce Richardson * on the final stage, the application may use Tx adapter API for maintaining 18599a2dd95SBruce Richardson * the ingress order and then send the packet/event on the wire. 18699a2dd95SBruce Richardson * 18799a2dd95SBruce Richardson * The point at which events are scheduled to ports depends on the device. 18899a2dd95SBruce Richardson * For hardware devices, scheduling occurs asynchronously without any software 18999a2dd95SBruce Richardson * intervention. Software schedulers can either be distributed 19099a2dd95SBruce Richardson * (each worker thread schedules events to its own port) or centralized 19199a2dd95SBruce Richardson * (a dedicated thread schedules to all ports). Distributed software schedulers 19299a2dd95SBruce Richardson * perform the scheduling in rte_event_dequeue_burst(), whereas centralized 19399a2dd95SBruce Richardson * scheduler logic need a dedicated service core for scheduling. 19499a2dd95SBruce Richardson * The RTE_EVENT_DEV_CAP_DISTRIBUTED_SCHED capability flag is not set 19599a2dd95SBruce Richardson * indicates the device is centralized and thus needs a dedicated scheduling 19699a2dd95SBruce Richardson * thread that repeatedly calls software specific scheduling function. 19799a2dd95SBruce Richardson * 19899a2dd95SBruce Richardson * An event driven worker thread has following typical workflow on fastpath: 19999a2dd95SBruce Richardson * \code{.c} 20099a2dd95SBruce Richardson * while (1) { 20199a2dd95SBruce Richardson * rte_event_dequeue_burst(...); 20299a2dd95SBruce Richardson * (event processing) 20399a2dd95SBruce Richardson * rte_event_enqueue_burst(...); 20499a2dd95SBruce Richardson * } 20599a2dd95SBruce Richardson * \endcode 20699a2dd95SBruce Richardson */ 20799a2dd95SBruce Richardson 20899a2dd95SBruce Richardson #ifdef __cplusplus 20999a2dd95SBruce Richardson extern "C" { 21099a2dd95SBruce Richardson #endif 21199a2dd95SBruce Richardson 2121094dd94SDavid Marchand #include <rte_compat.h> 21399a2dd95SBruce Richardson #include <rte_common.h> 21499a2dd95SBruce Richardson #include <rte_errno.h> 21599a2dd95SBruce Richardson #include <rte_mbuf_pool_ops.h> 21699a2dd95SBruce Richardson #include <rte_mempool.h> 21799a2dd95SBruce Richardson 21899a2dd95SBruce Richardson #include "rte_eventdev_trace_fp.h" 21999a2dd95SBruce Richardson 22099a2dd95SBruce Richardson struct rte_mbuf; /* we just use mbuf pointers; no need to include rte_mbuf.h */ 22199a2dd95SBruce Richardson struct rte_event; 22299a2dd95SBruce Richardson 22399a2dd95SBruce Richardson /* Event device capability bitmap flags */ 22499a2dd95SBruce Richardson #define RTE_EVENT_DEV_CAP_QUEUE_QOS (1ULL << 0) 22544516e6bSShijith Thotton /**< Event scheduling prioritization is based on the priority and weight 22644516e6bSShijith Thotton * associated with each event queue. Events from a queue with highest priority 22744516e6bSShijith Thotton * is scheduled first. If the queues are of same priority, weight of the queues 22844516e6bSShijith Thotton * are considered to select a queue in a weighted round robin fashion. 22944516e6bSShijith Thotton * Subsequent dequeue calls from an event port could see events from the same 23044516e6bSShijith Thotton * event queue, if the queue is configured with an affinity count. Affinity 23144516e6bSShijith Thotton * count is the number of subsequent dequeue calls, in which an event port 23244516e6bSShijith Thotton * should use the same event queue if the queue is non-empty 23399a2dd95SBruce Richardson * 23497b914f4SShijith Thotton * @see rte_event_queue_setup(), rte_event_queue_attr_set() 23599a2dd95SBruce Richardson */ 23699a2dd95SBruce Richardson #define RTE_EVENT_DEV_CAP_EVENT_QOS (1ULL << 1) 23799a2dd95SBruce Richardson /**< Event scheduling prioritization is based on the priority associated with 23899a2dd95SBruce Richardson * each event. Priority of each event is supplied in *rte_event* structure 23999a2dd95SBruce Richardson * on each enqueue operation. 24099a2dd95SBruce Richardson * 24199a2dd95SBruce Richardson * @see rte_event_enqueue_burst() 24299a2dd95SBruce Richardson */ 24399a2dd95SBruce Richardson #define RTE_EVENT_DEV_CAP_DISTRIBUTED_SCHED (1ULL << 2) 24499a2dd95SBruce Richardson /**< Event device operates in distributed scheduling mode. 24599a2dd95SBruce Richardson * In distributed scheduling mode, event scheduling happens in HW or 24699a2dd95SBruce Richardson * rte_event_dequeue_burst() or the combination of these two. 24799a2dd95SBruce Richardson * If the flag is not set then eventdev is centralized and thus needs a 24899a2dd95SBruce Richardson * dedicated service core that acts as a scheduling thread . 24999a2dd95SBruce Richardson * 25099a2dd95SBruce Richardson * @see rte_event_dequeue_burst() 25199a2dd95SBruce Richardson */ 25299a2dd95SBruce Richardson #define RTE_EVENT_DEV_CAP_QUEUE_ALL_TYPES (1ULL << 3) 253*ef0646ceSBruce Richardson /**< Event device is capable of accepting enqueued events, of any type 254*ef0646ceSBruce Richardson * advertised as supported by the device, to all destination queues. 25599a2dd95SBruce Richardson * 256*ef0646ceSBruce Richardson * When this capability is set, the "schedule_type" field of the 257*ef0646ceSBruce Richardson * rte_event_queue_conf structure is ignored when a queue is being configured. 258*ef0646ceSBruce Richardson * Instead the "sched_type" field of each event enqueued is used to 259*ef0646ceSBruce Richardson * select the scheduling to be performed on that event. 260*ef0646ceSBruce Richardson * 261*ef0646ceSBruce Richardson * If this capability is not set, the queue only supports events of the 262*ef0646ceSBruce Richardson * *RTE_SCHED_TYPE_* type specified in the rte_event_queue_conf structure 263*ef0646ceSBruce Richardson * at time of configuration. 264*ef0646ceSBruce Richardson * 265*ef0646ceSBruce Richardson * @see RTE_SCHED_TYPE_ATOMIC 266*ef0646ceSBruce Richardson * @see RTE_SCHED_TYPE_ORDERED 267*ef0646ceSBruce Richardson * @see RTE_SCHED_TYPE_PARALLEL 268*ef0646ceSBruce Richardson * @see rte_event_queue_conf.schedule_type 26999a2dd95SBruce Richardson */ 27099a2dd95SBruce Richardson #define RTE_EVENT_DEV_CAP_BURST_MODE (1ULL << 4) 27199a2dd95SBruce Richardson /**< Event device is capable of operating in burst mode for enqueue(forward, 27299a2dd95SBruce Richardson * release) and dequeue operation. If this capability is not set, application 27399a2dd95SBruce Richardson * still uses the rte_event_dequeue_burst() and rte_event_enqueue_burst() but 27499a2dd95SBruce Richardson * PMD accepts only one event at a time. 27599a2dd95SBruce Richardson * 27699a2dd95SBruce Richardson * @see rte_event_dequeue_burst() rte_event_enqueue_burst() 27799a2dd95SBruce Richardson */ 27899a2dd95SBruce Richardson #define RTE_EVENT_DEV_CAP_IMPLICIT_RELEASE_DISABLE (1ULL << 5) 27999a2dd95SBruce Richardson /**< Event device ports support disabling the implicit release feature, in 28099a2dd95SBruce Richardson * which the port will release all unreleased events in its dequeue operation. 28199a2dd95SBruce Richardson * If this capability is set and the port is configured with implicit release 28299a2dd95SBruce Richardson * disabled, the application is responsible for explicitly releasing events 28399a2dd95SBruce Richardson * using either the RTE_EVENT_OP_FORWARD or the RTE_EVENT_OP_RELEASE event 28499a2dd95SBruce Richardson * enqueue operations. 28599a2dd95SBruce Richardson * 28699a2dd95SBruce Richardson * @see rte_event_dequeue_burst() rte_event_enqueue_burst() 28799a2dd95SBruce Richardson */ 28899a2dd95SBruce Richardson 28999a2dd95SBruce Richardson #define RTE_EVENT_DEV_CAP_NONSEQ_MODE (1ULL << 6) 29099a2dd95SBruce Richardson /**< Event device is capable of operating in none sequential mode. The path 29199a2dd95SBruce Richardson * of the event is not necessary to be sequential. Application can change 29299a2dd95SBruce Richardson * the path of event at runtime. If the flag is not set, then event each event 29399a2dd95SBruce Richardson * will follow a path from queue 0 to queue 1 to queue 2 etc. If the flag is 29499a2dd95SBruce Richardson * set, events may be sent to queues in any order. If the flag is not set, the 29599a2dd95SBruce Richardson * eventdev will return an error when the application enqueues an event for a 29699a2dd95SBruce Richardson * qid which is not the next in the sequence. 29799a2dd95SBruce Richardson */ 29899a2dd95SBruce Richardson 29999a2dd95SBruce Richardson #define RTE_EVENT_DEV_CAP_RUNTIME_PORT_LINK (1ULL << 7) 30099a2dd95SBruce Richardson /**< Event device is capable of configuring the queue/port link at runtime. 30199a2dd95SBruce Richardson * If the flag is not set, the eventdev queue/port link is only can be 30299a2dd95SBruce Richardson * configured during initialization. 30399a2dd95SBruce Richardson */ 30499a2dd95SBruce Richardson 30599a2dd95SBruce Richardson #define RTE_EVENT_DEV_CAP_MULTIPLE_QUEUE_PORT (1ULL << 8) 30699a2dd95SBruce Richardson /**< Event device is capable of setting up the link between multiple queue 30799a2dd95SBruce Richardson * with single port. If the flag is not set, the eventdev can only map a 30899a2dd95SBruce Richardson * single queue to each port or map a single queue to many port. 30999a2dd95SBruce Richardson */ 31099a2dd95SBruce Richardson 31199a2dd95SBruce Richardson #define RTE_EVENT_DEV_CAP_CARRY_FLOW_ID (1ULL << 9) 31299a2dd95SBruce Richardson /**< Event device preserves the flow ID from the enqueued 31399a2dd95SBruce Richardson * event to the dequeued event if the flag is set. Otherwise, 31499a2dd95SBruce Richardson * the content of this field is implementation dependent. 31599a2dd95SBruce Richardson */ 31699a2dd95SBruce Richardson 317bd991897SMattias Rönnblom #define RTE_EVENT_DEV_CAP_MAINTENANCE_FREE (1ULL << 10) 318bd991897SMattias Rönnblom /**< Event device *does not* require calls to rte_event_maintain(). 319bd991897SMattias Rönnblom * An event device that does not set this flag requires calls to 320bd991897SMattias Rönnblom * rte_event_maintain() during periods when neither 321bd991897SMattias Rönnblom * rte_event_dequeue_burst() nor rte_event_enqueue_burst() are called 322bd991897SMattias Rönnblom * on a port. This will allow the event device to perform internal 323bd991897SMattias Rönnblom * processing, such as flushing buffered events, return credits to a 324bd991897SMattias Rönnblom * global pool, or process signaling related to load balancing. 32554f17843SMattias Rönnblom */ 32654f17843SMattias Rönnblom 32797b914f4SShijith Thotton #define RTE_EVENT_DEV_CAP_RUNTIME_QUEUE_ATTR (1ULL << 11) 32897b914f4SShijith Thotton /**< Event device is capable of changing the queue attributes at runtime i.e 32997b914f4SShijith Thotton * after rte_event_queue_setup() or rte_event_start() call sequence. If this 33097b914f4SShijith Thotton * flag is not set, eventdev queue attributes can only be configured during 33197b914f4SShijith Thotton * rte_event_queue_setup(). 33297b914f4SShijith Thotton */ 33397b914f4SShijith Thotton 334d007a7f3SPavan Nikhilesh #define RTE_EVENT_DEV_CAP_PROFILE_LINK (1ULL << 12) 335d007a7f3SPavan Nikhilesh /**< Event device is capable of supporting multiple link profiles per event port 336d007a7f3SPavan Nikhilesh * i.e., the value of `rte_event_dev_info::max_profiles_per_port` is greater 337d007a7f3SPavan Nikhilesh * than one. 338d007a7f3SPavan Nikhilesh */ 339d007a7f3SPavan Nikhilesh 340eaa8fb6cSBruce Richardson #define RTE_EVENT_DEV_CAP_ATOMIC (1ULL << 13) 341eaa8fb6cSBruce Richardson /**< Event device is capable of atomic scheduling. 342eaa8fb6cSBruce Richardson * When this flag is set, the application can configure queues with scheduling type 343eaa8fb6cSBruce Richardson * atomic on this event device. 344eaa8fb6cSBruce Richardson * @see RTE_SCHED_TYPE_ATOMIC 345eaa8fb6cSBruce Richardson */ 346eaa8fb6cSBruce Richardson 347eaa8fb6cSBruce Richardson #define RTE_EVENT_DEV_CAP_ORDERED (1ULL << 14) 348eaa8fb6cSBruce Richardson /**< Event device is capable of ordered scheduling. 349eaa8fb6cSBruce Richardson * When this flag is set, the application can configure queues with scheduling type 350eaa8fb6cSBruce Richardson * ordered on this event device. 351eaa8fb6cSBruce Richardson * @see RTE_SCHED_TYPE_ORDERED 352eaa8fb6cSBruce Richardson */ 353eaa8fb6cSBruce Richardson 354eaa8fb6cSBruce Richardson #define RTE_EVENT_DEV_CAP_PARALLEL (1ULL << 15) 355eaa8fb6cSBruce Richardson /**< Event device is capable of parallel scheduling. 356eaa8fb6cSBruce Richardson * When this flag is set, the application can configure queues with scheduling type 357eaa8fb6cSBruce Richardson * parallel on this event device. 358eaa8fb6cSBruce Richardson * @see RTE_SCHED_TYPE_PARALLEL 359eaa8fb6cSBruce Richardson */ 360eaa8fb6cSBruce Richardson 36199a2dd95SBruce Richardson /* Event device priority levels */ 36299a2dd95SBruce Richardson #define RTE_EVENT_DEV_PRIORITY_HIGHEST 0 36399a2dd95SBruce Richardson /**< Highest priority expressed across eventdev subsystem 36499a2dd95SBruce Richardson * @see rte_event_queue_setup(), rte_event_enqueue_burst() 36599a2dd95SBruce Richardson * @see rte_event_port_link() 36699a2dd95SBruce Richardson */ 36799a2dd95SBruce Richardson #define RTE_EVENT_DEV_PRIORITY_NORMAL 128 36899a2dd95SBruce Richardson /**< Normal priority expressed across eventdev subsystem 36999a2dd95SBruce Richardson * @see rte_event_queue_setup(), rte_event_enqueue_burst() 37099a2dd95SBruce Richardson * @see rte_event_port_link() 37199a2dd95SBruce Richardson */ 37299a2dd95SBruce Richardson #define RTE_EVENT_DEV_PRIORITY_LOWEST 255 37399a2dd95SBruce Richardson /**< Lowest priority expressed across eventdev subsystem 37499a2dd95SBruce Richardson * @see rte_event_queue_setup(), rte_event_enqueue_burst() 37599a2dd95SBruce Richardson * @see rte_event_port_link() 37699a2dd95SBruce Richardson */ 37799a2dd95SBruce Richardson 37844516e6bSShijith Thotton /* Event queue scheduling weights */ 37944516e6bSShijith Thotton #define RTE_EVENT_QUEUE_WEIGHT_HIGHEST 255 38044516e6bSShijith Thotton /**< Highest weight of an event queue 38144516e6bSShijith Thotton * @see rte_event_queue_attr_get(), rte_event_queue_attr_set() 38244516e6bSShijith Thotton */ 38344516e6bSShijith Thotton #define RTE_EVENT_QUEUE_WEIGHT_LOWEST 0 38444516e6bSShijith Thotton /**< Lowest weight of an event queue 38544516e6bSShijith Thotton * @see rte_event_queue_attr_get(), rte_event_queue_attr_set() 38644516e6bSShijith Thotton */ 38744516e6bSShijith Thotton 38844516e6bSShijith Thotton /* Event queue scheduling affinity */ 38944516e6bSShijith Thotton #define RTE_EVENT_QUEUE_AFFINITY_HIGHEST 255 39044516e6bSShijith Thotton /**< Highest scheduling affinity of an event queue 39144516e6bSShijith Thotton * @see rte_event_queue_attr_get(), rte_event_queue_attr_set() 39244516e6bSShijith Thotton */ 39344516e6bSShijith Thotton #define RTE_EVENT_QUEUE_AFFINITY_LOWEST 0 39444516e6bSShijith Thotton /**< Lowest scheduling affinity of an event queue 39544516e6bSShijith Thotton * @see rte_event_queue_attr_get(), rte_event_queue_attr_set() 39644516e6bSShijith Thotton */ 39744516e6bSShijith Thotton 39899a2dd95SBruce Richardson /** 39999a2dd95SBruce Richardson * Get the total number of event devices that have been successfully 40099a2dd95SBruce Richardson * initialised. 40199a2dd95SBruce Richardson * 40299a2dd95SBruce Richardson * @return 40399a2dd95SBruce Richardson * The total number of usable event devices. 40499a2dd95SBruce Richardson */ 40599a2dd95SBruce Richardson uint8_t 40699a2dd95SBruce Richardson rte_event_dev_count(void); 40799a2dd95SBruce Richardson 40899a2dd95SBruce Richardson /** 40999a2dd95SBruce Richardson * Get the device identifier for the named event device. 41099a2dd95SBruce Richardson * 41199a2dd95SBruce Richardson * @param name 41299a2dd95SBruce Richardson * Event device name to select the event device identifier. 41399a2dd95SBruce Richardson * 41499a2dd95SBruce Richardson * @return 41599a2dd95SBruce Richardson * Returns event device identifier on success. 41699a2dd95SBruce Richardson * - <0: Failure to find named event device. 41799a2dd95SBruce Richardson */ 41899a2dd95SBruce Richardson int 41999a2dd95SBruce Richardson rte_event_dev_get_dev_id(const char *name); 42099a2dd95SBruce Richardson 42199a2dd95SBruce Richardson /** 42299a2dd95SBruce Richardson * Return the NUMA socket to which a device is connected. 42399a2dd95SBruce Richardson * 42499a2dd95SBruce Richardson * @param dev_id 42599a2dd95SBruce Richardson * The identifier of the device. 42699a2dd95SBruce Richardson * @return 42799a2dd95SBruce Richardson * The NUMA socket id to which the device is connected or 42899a2dd95SBruce Richardson * a default of zero if the socket could not be determined. 42999a2dd95SBruce Richardson * -(-EINVAL) dev_id value is out of range. 43099a2dd95SBruce Richardson */ 43199a2dd95SBruce Richardson int 43299a2dd95SBruce Richardson rte_event_dev_socket_id(uint8_t dev_id); 43399a2dd95SBruce Richardson 43499a2dd95SBruce Richardson /** 43599a2dd95SBruce Richardson * Event device information 43699a2dd95SBruce Richardson */ 43799a2dd95SBruce Richardson struct rte_event_dev_info { 43899a2dd95SBruce Richardson const char *driver_name; /**< Event driver name */ 43999a2dd95SBruce Richardson struct rte_device *dev; /**< Device information */ 44099a2dd95SBruce Richardson uint32_t min_dequeue_timeout_ns; 44199a2dd95SBruce Richardson /**< Minimum supported global dequeue timeout(ns) by this device */ 44299a2dd95SBruce Richardson uint32_t max_dequeue_timeout_ns; 44399a2dd95SBruce Richardson /**< Maximum supported global dequeue timeout(ns) by this device */ 44499a2dd95SBruce Richardson uint32_t dequeue_timeout_ns; 44599a2dd95SBruce Richardson /**< Configured global dequeue timeout(ns) for this device */ 44699a2dd95SBruce Richardson uint8_t max_event_queues; 44799a2dd95SBruce Richardson /**< Maximum event_queues supported by this device */ 44899a2dd95SBruce Richardson uint32_t max_event_queue_flows; 44999a2dd95SBruce Richardson /**< Maximum supported flows in an event queue by this device*/ 45099a2dd95SBruce Richardson uint8_t max_event_queue_priority_levels; 45199a2dd95SBruce Richardson /**< Maximum number of event queue priority levels by this device. 45299a2dd95SBruce Richardson * Valid when the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability 45399a2dd95SBruce Richardson */ 45499a2dd95SBruce Richardson uint8_t max_event_priority_levels; 45599a2dd95SBruce Richardson /**< Maximum number of event priority levels by this device. 45699a2dd95SBruce Richardson * Valid when the device has RTE_EVENT_DEV_CAP_EVENT_QOS capability 45799a2dd95SBruce Richardson */ 45899a2dd95SBruce Richardson uint8_t max_event_ports; 45999a2dd95SBruce Richardson /**< Maximum number of event ports supported by this device */ 46099a2dd95SBruce Richardson uint8_t max_event_port_dequeue_depth; 46199a2dd95SBruce Richardson /**< Maximum number of events can be dequeued at a time from an 46299a2dd95SBruce Richardson * event port by this device. 46399a2dd95SBruce Richardson * A device that does not support bulk dequeue will set this as 1. 46499a2dd95SBruce Richardson */ 46599a2dd95SBruce Richardson uint32_t max_event_port_enqueue_depth; 46699a2dd95SBruce Richardson /**< Maximum number of events can be enqueued at a time from an 46799a2dd95SBruce Richardson * event port by this device. 46899a2dd95SBruce Richardson * A device that does not support bulk enqueue will set this as 1. 46999a2dd95SBruce Richardson */ 47099a2dd95SBruce Richardson uint8_t max_event_port_links; 47199a2dd95SBruce Richardson /**< Maximum number of queues that can be linked to a single event 47299a2dd95SBruce Richardson * port by this device. 47399a2dd95SBruce Richardson */ 47499a2dd95SBruce Richardson int32_t max_num_events; 47599a2dd95SBruce Richardson /**< A *closed system* event dev has a limit on the number of events it 47699a2dd95SBruce Richardson * can manage at a time. An *open system* event dev does not have a 47799a2dd95SBruce Richardson * limit and will specify this as -1. 47899a2dd95SBruce Richardson */ 47999a2dd95SBruce Richardson uint32_t event_dev_cap; 48099a2dd95SBruce Richardson /**< Event device capabilities(RTE_EVENT_DEV_CAP_)*/ 48199a2dd95SBruce Richardson uint8_t max_single_link_event_port_queue_pairs; 48299a2dd95SBruce Richardson /**< Maximum number of event ports and queues that are optimized for 48399a2dd95SBruce Richardson * (and only capable of) single-link configurations supported by this 48499a2dd95SBruce Richardson * device. These ports and queues are not accounted for in 48599a2dd95SBruce Richardson * max_event_ports or max_event_queues. 48699a2dd95SBruce Richardson */ 487d007a7f3SPavan Nikhilesh uint8_t max_profiles_per_port; 488d007a7f3SPavan Nikhilesh /**< Maximum number of event queue profiles per event port. 489d007a7f3SPavan Nikhilesh * A device that doesn't support multiple profiles will set this as 1. 490d007a7f3SPavan Nikhilesh */ 49199a2dd95SBruce Richardson }; 49299a2dd95SBruce Richardson 49399a2dd95SBruce Richardson /** 49499a2dd95SBruce Richardson * Retrieve the contextual information of an event device. 49599a2dd95SBruce Richardson * 49699a2dd95SBruce Richardson * @param dev_id 49799a2dd95SBruce Richardson * The identifier of the device. 49899a2dd95SBruce Richardson * 49999a2dd95SBruce Richardson * @param[out] dev_info 50099a2dd95SBruce Richardson * A pointer to a structure of type *rte_event_dev_info* to be filled with the 50199a2dd95SBruce Richardson * contextual information of the device. 50299a2dd95SBruce Richardson * 50399a2dd95SBruce Richardson * @return 50499a2dd95SBruce Richardson * - 0: Success, driver updates the contextual information of the event device 50599a2dd95SBruce Richardson * - <0: Error code returned by the driver info get function. 50699a2dd95SBruce Richardson */ 50799a2dd95SBruce Richardson int 50899a2dd95SBruce Richardson rte_event_dev_info_get(uint8_t dev_id, struct rte_event_dev_info *dev_info); 50999a2dd95SBruce Richardson 51099a2dd95SBruce Richardson /** 51199a2dd95SBruce Richardson * The count of ports. 51299a2dd95SBruce Richardson */ 51399a2dd95SBruce Richardson #define RTE_EVENT_DEV_ATTR_PORT_COUNT 0 51499a2dd95SBruce Richardson /** 51599a2dd95SBruce Richardson * The count of queues. 51699a2dd95SBruce Richardson */ 51799a2dd95SBruce Richardson #define RTE_EVENT_DEV_ATTR_QUEUE_COUNT 1 51899a2dd95SBruce Richardson /** 51999a2dd95SBruce Richardson * The status of the device, zero for stopped, non-zero for started. 52099a2dd95SBruce Richardson */ 52199a2dd95SBruce Richardson #define RTE_EVENT_DEV_ATTR_STARTED 2 52299a2dd95SBruce Richardson 52399a2dd95SBruce Richardson /** 52499a2dd95SBruce Richardson * Get an attribute from a device. 52599a2dd95SBruce Richardson * 52699a2dd95SBruce Richardson * @param dev_id Eventdev id 52799a2dd95SBruce Richardson * @param attr_id The attribute ID to retrieve 52899a2dd95SBruce Richardson * @param[out] attr_value A pointer that will be filled in with the attribute 52999a2dd95SBruce Richardson * value if successful. 53099a2dd95SBruce Richardson * 53199a2dd95SBruce Richardson * @return 53299a2dd95SBruce Richardson * - 0: Successfully retrieved attribute value 53399a2dd95SBruce Richardson * - -EINVAL: Invalid device or *attr_id* provided, or *attr_value* is NULL 53499a2dd95SBruce Richardson */ 53599a2dd95SBruce Richardson int 53699a2dd95SBruce Richardson rte_event_dev_attr_get(uint8_t dev_id, uint32_t attr_id, 53799a2dd95SBruce Richardson uint32_t *attr_value); 53899a2dd95SBruce Richardson 53999a2dd95SBruce Richardson 54099a2dd95SBruce Richardson /* Event device configuration bitmap flags */ 54199a2dd95SBruce Richardson #define RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT (1ULL << 0) 54299a2dd95SBruce Richardson /**< Override the global *dequeue_timeout_ns* and use per dequeue timeout in ns. 54399a2dd95SBruce Richardson * @see rte_event_dequeue_timeout_ticks(), rte_event_dequeue_burst() 54499a2dd95SBruce Richardson */ 54599a2dd95SBruce Richardson 54699a2dd95SBruce Richardson /** Event device configuration structure */ 54799a2dd95SBruce Richardson struct rte_event_dev_config { 54899a2dd95SBruce Richardson uint32_t dequeue_timeout_ns; 54999a2dd95SBruce Richardson /**< rte_event_dequeue_burst() timeout on this device. 55099a2dd95SBruce Richardson * This value should be in the range of *min_dequeue_timeout_ns* and 55199a2dd95SBruce Richardson * *max_dequeue_timeout_ns* which previously provided in 55299a2dd95SBruce Richardson * rte_event_dev_info_get() 55399a2dd95SBruce Richardson * The value 0 is allowed, in which case, default dequeue timeout used. 55499a2dd95SBruce Richardson * @see RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT 55599a2dd95SBruce Richardson */ 55699a2dd95SBruce Richardson int32_t nb_events_limit; 55799a2dd95SBruce Richardson /**< In a *closed system* this field is the limit on maximum number of 55899a2dd95SBruce Richardson * events that can be inflight in the eventdev at a given time. The 55999a2dd95SBruce Richardson * limit is required to ensure that the finite space in a closed system 56099a2dd95SBruce Richardson * is not overwhelmed. The value cannot exceed the *max_num_events* 56199a2dd95SBruce Richardson * as provided by rte_event_dev_info_get(). 56299a2dd95SBruce Richardson * This value should be set to -1 for *open system*. 56399a2dd95SBruce Richardson */ 56499a2dd95SBruce Richardson uint8_t nb_event_queues; 56599a2dd95SBruce Richardson /**< Number of event queues to configure on this device. 56699a2dd95SBruce Richardson * This value cannot exceed the *max_event_queues* which previously 56799a2dd95SBruce Richardson * provided in rte_event_dev_info_get() 56899a2dd95SBruce Richardson */ 56999a2dd95SBruce Richardson uint8_t nb_event_ports; 57099a2dd95SBruce Richardson /**< Number of event ports to configure on this device. 57199a2dd95SBruce Richardson * This value cannot exceed the *max_event_ports* which previously 57299a2dd95SBruce Richardson * provided in rte_event_dev_info_get() 57399a2dd95SBruce Richardson */ 57499a2dd95SBruce Richardson uint32_t nb_event_queue_flows; 57599a2dd95SBruce Richardson /**< Number of flows for any event queue on this device. 57699a2dd95SBruce Richardson * This value cannot exceed the *max_event_queue_flows* which previously 57799a2dd95SBruce Richardson * provided in rte_event_dev_info_get() 57899a2dd95SBruce Richardson */ 57999a2dd95SBruce Richardson uint32_t nb_event_port_dequeue_depth; 58099a2dd95SBruce Richardson /**< Maximum number of events can be dequeued at a time from an 58199a2dd95SBruce Richardson * event port by this device. 58299a2dd95SBruce Richardson * This value cannot exceed the *max_event_port_dequeue_depth* 58399a2dd95SBruce Richardson * which previously provided in rte_event_dev_info_get(). 58499a2dd95SBruce Richardson * Ignored when device is not RTE_EVENT_DEV_CAP_BURST_MODE capable. 58599a2dd95SBruce Richardson * @see rte_event_port_setup() 58699a2dd95SBruce Richardson */ 58799a2dd95SBruce Richardson uint32_t nb_event_port_enqueue_depth; 58899a2dd95SBruce Richardson /**< Maximum number of events can be enqueued at a time from an 58999a2dd95SBruce Richardson * event port by this device. 59099a2dd95SBruce Richardson * This value cannot exceed the *max_event_port_enqueue_depth* 59199a2dd95SBruce Richardson * which previously provided in rte_event_dev_info_get(). 59299a2dd95SBruce Richardson * Ignored when device is not RTE_EVENT_DEV_CAP_BURST_MODE capable. 59399a2dd95SBruce Richardson * @see rte_event_port_setup() 59499a2dd95SBruce Richardson */ 59599a2dd95SBruce Richardson uint32_t event_dev_cfg; 59699a2dd95SBruce Richardson /**< Event device config flags(RTE_EVENT_DEV_CFG_)*/ 59799a2dd95SBruce Richardson uint8_t nb_single_link_event_port_queues; 59899a2dd95SBruce Richardson /**< Number of event ports and queues that will be singly-linked to 59999a2dd95SBruce Richardson * each other. These are a subset of the overall event ports and 60099a2dd95SBruce Richardson * queues; this value cannot exceed *nb_event_ports* or 60199a2dd95SBruce Richardson * *nb_event_queues*. If the device has ports and queues that are 60299a2dd95SBruce Richardson * optimized for single-link usage, this field is a hint for how many 60399a2dd95SBruce Richardson * to allocate; otherwise, regular event ports and queues can be used. 60499a2dd95SBruce Richardson */ 60599a2dd95SBruce Richardson }; 60699a2dd95SBruce Richardson 60799a2dd95SBruce Richardson /** 60899a2dd95SBruce Richardson * Configure an event device. 60999a2dd95SBruce Richardson * 61099a2dd95SBruce Richardson * This function must be invoked first before any other function in the 61199a2dd95SBruce Richardson * API. This function can also be re-invoked when a device is in the 61299a2dd95SBruce Richardson * stopped state. 61399a2dd95SBruce Richardson * 61499a2dd95SBruce Richardson * The caller may use rte_event_dev_info_get() to get the capability of each 61599a2dd95SBruce Richardson * resources available for this event device. 61699a2dd95SBruce Richardson * 61799a2dd95SBruce Richardson * @param dev_id 61899a2dd95SBruce Richardson * The identifier of the device to configure. 61999a2dd95SBruce Richardson * @param dev_conf 62099a2dd95SBruce Richardson * The event device configuration structure. 62199a2dd95SBruce Richardson * 62299a2dd95SBruce Richardson * @return 62399a2dd95SBruce Richardson * - 0: Success, device configured. 62499a2dd95SBruce Richardson * - <0: Error code returned by the driver configuration function. 62599a2dd95SBruce Richardson */ 62699a2dd95SBruce Richardson int 62799a2dd95SBruce Richardson rte_event_dev_configure(uint8_t dev_id, 62899a2dd95SBruce Richardson const struct rte_event_dev_config *dev_conf); 62999a2dd95SBruce Richardson 63099a2dd95SBruce Richardson /* Event queue specific APIs */ 63199a2dd95SBruce Richardson 63299a2dd95SBruce Richardson /* Event queue configuration bitmap flags */ 63399a2dd95SBruce Richardson #define RTE_EVENT_QUEUE_CFG_ALL_TYPES (1ULL << 0) 63499a2dd95SBruce Richardson /**< Allow ATOMIC,ORDERED,PARALLEL schedule type enqueue 63599a2dd95SBruce Richardson * 63699a2dd95SBruce Richardson * @see RTE_SCHED_TYPE_ORDERED, RTE_SCHED_TYPE_ATOMIC, RTE_SCHED_TYPE_PARALLEL 63799a2dd95SBruce Richardson * @see rte_event_enqueue_burst() 63899a2dd95SBruce Richardson */ 63999a2dd95SBruce Richardson #define RTE_EVENT_QUEUE_CFG_SINGLE_LINK (1ULL << 1) 64099a2dd95SBruce Richardson /**< This event queue links only to a single event port. 64199a2dd95SBruce Richardson * 64299a2dd95SBruce Richardson * @see rte_event_port_setup(), rte_event_port_link() 64399a2dd95SBruce Richardson */ 64499a2dd95SBruce Richardson 64599a2dd95SBruce Richardson /** Event queue configuration structure */ 64699a2dd95SBruce Richardson struct rte_event_queue_conf { 64799a2dd95SBruce Richardson uint32_t nb_atomic_flows; 64899a2dd95SBruce Richardson /**< The maximum number of active flows this queue can track at any 64999a2dd95SBruce Richardson * given time. If the queue is configured for atomic scheduling (by 65099a2dd95SBruce Richardson * applying the RTE_EVENT_QUEUE_CFG_ALL_TYPES flag to event_queue_cfg 65199a2dd95SBruce Richardson * or RTE_SCHED_TYPE_ATOMIC flag to schedule_type), then the 65299a2dd95SBruce Richardson * value must be in the range of [1, nb_event_queue_flows], which was 65399a2dd95SBruce Richardson * previously provided in rte_event_dev_configure(). 65499a2dd95SBruce Richardson */ 65599a2dd95SBruce Richardson uint32_t nb_atomic_order_sequences; 65699a2dd95SBruce Richardson /**< The maximum number of outstanding events waiting to be 65799a2dd95SBruce Richardson * reordered by this queue. In other words, the number of entries in 65899a2dd95SBruce Richardson * this queue’s reorder buffer.When the number of events in the 65999a2dd95SBruce Richardson * reorder buffer reaches to *nb_atomic_order_sequences* then the 66099a2dd95SBruce Richardson * scheduler cannot schedule the events from this queue and invalid 66199a2dd95SBruce Richardson * event will be returned from dequeue until one or more entries are 66299a2dd95SBruce Richardson * freed up/released. 66399a2dd95SBruce Richardson * If the queue is configured for ordered scheduling (by applying the 66499a2dd95SBruce Richardson * RTE_EVENT_QUEUE_CFG_ALL_TYPES flag to event_queue_cfg or 66599a2dd95SBruce Richardson * RTE_SCHED_TYPE_ORDERED flag to schedule_type), then the value must 66699a2dd95SBruce Richardson * be in the range of [1, nb_event_queue_flows], which was 66799a2dd95SBruce Richardson * previously supplied to rte_event_dev_configure(). 66899a2dd95SBruce Richardson */ 66999a2dd95SBruce Richardson uint32_t event_queue_cfg; 67099a2dd95SBruce Richardson /**< Queue cfg flags(EVENT_QUEUE_CFG_) */ 67199a2dd95SBruce Richardson uint8_t schedule_type; 67299a2dd95SBruce Richardson /**< Queue schedule type(RTE_SCHED_TYPE_*). 67399a2dd95SBruce Richardson * Valid when RTE_EVENT_QUEUE_CFG_ALL_TYPES bit is not set in 67499a2dd95SBruce Richardson * event_queue_cfg. 67599a2dd95SBruce Richardson */ 67699a2dd95SBruce Richardson uint8_t priority; 67799a2dd95SBruce Richardson /**< Priority for this event queue relative to other event queues. 67899a2dd95SBruce Richardson * The requested priority should in the range of 67999a2dd95SBruce Richardson * [RTE_EVENT_DEV_PRIORITY_HIGHEST, RTE_EVENT_DEV_PRIORITY_LOWEST]. 68099a2dd95SBruce Richardson * The implementation shall normalize the requested priority to 68199a2dd95SBruce Richardson * event device supported priority value. 68299a2dd95SBruce Richardson * Valid when the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability 68399a2dd95SBruce Richardson */ 6842f279a1bSShijith Thotton uint8_t weight; 6852f279a1bSShijith Thotton /**< Weight of the event queue relative to other event queues. 6862f279a1bSShijith Thotton * The requested weight should be in the range of 6872f279a1bSShijith Thotton * [RTE_EVENT_DEV_WEIGHT_HIGHEST, RTE_EVENT_DEV_WEIGHT_LOWEST]. 6882f279a1bSShijith Thotton * The implementation shall normalize the requested weight to event 6892f279a1bSShijith Thotton * device supported weight value. 6902f279a1bSShijith Thotton * Valid when the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability. 6912f279a1bSShijith Thotton */ 6922f279a1bSShijith Thotton uint8_t affinity; 6932f279a1bSShijith Thotton /**< Affinity of the event queue relative to other event queues. 6942f279a1bSShijith Thotton * The requested affinity should be in the range of 6952f279a1bSShijith Thotton * [RTE_EVENT_DEV_AFFINITY_HIGHEST, RTE_EVENT_DEV_AFFINITY_LOWEST]. 6962f279a1bSShijith Thotton * The implementation shall normalize the requested affinity to event 6972f279a1bSShijith Thotton * device supported affinity value. 6982f279a1bSShijith Thotton * Valid when the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability. 6992f279a1bSShijith Thotton */ 70099a2dd95SBruce Richardson }; 70199a2dd95SBruce Richardson 70299a2dd95SBruce Richardson /** 70399a2dd95SBruce Richardson * Retrieve the default configuration information of an event queue designated 70499a2dd95SBruce Richardson * by its *queue_id* from the event driver for an event device. 70599a2dd95SBruce Richardson * 70699a2dd95SBruce Richardson * This function intended to be used in conjunction with rte_event_queue_setup() 70799a2dd95SBruce Richardson * where caller needs to set up the queue by overriding few default values. 70899a2dd95SBruce Richardson * 70999a2dd95SBruce Richardson * @param dev_id 71099a2dd95SBruce Richardson * The identifier of the device. 71199a2dd95SBruce Richardson * @param queue_id 71299a2dd95SBruce Richardson * The index of the event queue to get the configuration information. 71399a2dd95SBruce Richardson * The value must be in the range [0, nb_event_queues - 1] 71499a2dd95SBruce Richardson * previously supplied to rte_event_dev_configure(). 71599a2dd95SBruce Richardson * @param[out] queue_conf 71699a2dd95SBruce Richardson * The pointer to the default event queue configuration data. 71799a2dd95SBruce Richardson * @return 71899a2dd95SBruce Richardson * - 0: Success, driver updates the default event queue configuration data. 71999a2dd95SBruce Richardson * - <0: Error code returned by the driver info get function. 72099a2dd95SBruce Richardson * 72199a2dd95SBruce Richardson * @see rte_event_queue_setup() 72299a2dd95SBruce Richardson */ 72399a2dd95SBruce Richardson int 72499a2dd95SBruce Richardson rte_event_queue_default_conf_get(uint8_t dev_id, uint8_t queue_id, 72599a2dd95SBruce Richardson struct rte_event_queue_conf *queue_conf); 72699a2dd95SBruce Richardson 72799a2dd95SBruce Richardson /** 72899a2dd95SBruce Richardson * Allocate and set up an event queue for an event device. 72999a2dd95SBruce Richardson * 73099a2dd95SBruce Richardson * @param dev_id 73199a2dd95SBruce Richardson * The identifier of the device. 73299a2dd95SBruce Richardson * @param queue_id 73399a2dd95SBruce Richardson * The index of the event queue to setup. The value must be in the range 73499a2dd95SBruce Richardson * [0, nb_event_queues - 1] previously supplied to rte_event_dev_configure(). 73599a2dd95SBruce Richardson * @param queue_conf 73699a2dd95SBruce Richardson * The pointer to the configuration data to be used for the event queue. 73799a2dd95SBruce Richardson * NULL value is allowed, in which case default configuration used. 73899a2dd95SBruce Richardson * 73999a2dd95SBruce Richardson * @see rte_event_queue_default_conf_get() 74099a2dd95SBruce Richardson * 74199a2dd95SBruce Richardson * @return 74299a2dd95SBruce Richardson * - 0: Success, event queue correctly set up. 74399a2dd95SBruce Richardson * - <0: event queue configuration failed 74499a2dd95SBruce Richardson */ 74599a2dd95SBruce Richardson int 74699a2dd95SBruce Richardson rte_event_queue_setup(uint8_t dev_id, uint8_t queue_id, 74799a2dd95SBruce Richardson const struct rte_event_queue_conf *queue_conf); 74899a2dd95SBruce Richardson 74999a2dd95SBruce Richardson /** 75099a2dd95SBruce Richardson * The priority of the queue. 75199a2dd95SBruce Richardson */ 75299a2dd95SBruce Richardson #define RTE_EVENT_QUEUE_ATTR_PRIORITY 0 75399a2dd95SBruce Richardson /** 75499a2dd95SBruce Richardson * The number of atomic flows configured for the queue. 75599a2dd95SBruce Richardson */ 75699a2dd95SBruce Richardson #define RTE_EVENT_QUEUE_ATTR_NB_ATOMIC_FLOWS 1 75799a2dd95SBruce Richardson /** 75899a2dd95SBruce Richardson * The number of atomic order sequences configured for the queue. 75999a2dd95SBruce Richardson */ 76099a2dd95SBruce Richardson #define RTE_EVENT_QUEUE_ATTR_NB_ATOMIC_ORDER_SEQUENCES 2 76199a2dd95SBruce Richardson /** 76299a2dd95SBruce Richardson * The cfg flags for the queue. 76399a2dd95SBruce Richardson */ 76499a2dd95SBruce Richardson #define RTE_EVENT_QUEUE_ATTR_EVENT_QUEUE_CFG 3 76599a2dd95SBruce Richardson /** 76699a2dd95SBruce Richardson * The schedule type of the queue. 76799a2dd95SBruce Richardson */ 76899a2dd95SBruce Richardson #define RTE_EVENT_QUEUE_ATTR_SCHEDULE_TYPE 4 76944516e6bSShijith Thotton /** 77044516e6bSShijith Thotton * The weight of the queue. 77144516e6bSShijith Thotton */ 77244516e6bSShijith Thotton #define RTE_EVENT_QUEUE_ATTR_WEIGHT 5 77344516e6bSShijith Thotton /** 77444516e6bSShijith Thotton * Affinity of the queue. 77544516e6bSShijith Thotton */ 77644516e6bSShijith Thotton #define RTE_EVENT_QUEUE_ATTR_AFFINITY 6 77799a2dd95SBruce Richardson 77899a2dd95SBruce Richardson /** 77999a2dd95SBruce Richardson * Get an attribute from a queue. 78099a2dd95SBruce Richardson * 78199a2dd95SBruce Richardson * @param dev_id 78299a2dd95SBruce Richardson * Eventdev id 78399a2dd95SBruce Richardson * @param queue_id 78499a2dd95SBruce Richardson * Eventdev queue id 78599a2dd95SBruce Richardson * @param attr_id 78699a2dd95SBruce Richardson * The attribute ID to retrieve 78799a2dd95SBruce Richardson * @param[out] attr_value 78899a2dd95SBruce Richardson * A pointer that will be filled in with the attribute value if successful 78999a2dd95SBruce Richardson * 79099a2dd95SBruce Richardson * @return 79199a2dd95SBruce Richardson * - 0: Successfully returned value 79299a2dd95SBruce Richardson * - -EINVAL: invalid device, queue or attr_id provided, or attr_value was 79399a2dd95SBruce Richardson * NULL 79499a2dd95SBruce Richardson * - -EOVERFLOW: returned when attr_id is set to 79599a2dd95SBruce Richardson * RTE_EVENT_QUEUE_ATTR_SCHEDULE_TYPE and event_queue_cfg is set to 79699a2dd95SBruce Richardson * RTE_EVENT_QUEUE_CFG_ALL_TYPES 79799a2dd95SBruce Richardson */ 79899a2dd95SBruce Richardson int 79999a2dd95SBruce Richardson rte_event_queue_attr_get(uint8_t dev_id, uint8_t queue_id, uint32_t attr_id, 80099a2dd95SBruce Richardson uint32_t *attr_value); 80199a2dd95SBruce Richardson 80297b914f4SShijith Thotton /** 80397b914f4SShijith Thotton * Set an event queue attribute. 80497b914f4SShijith Thotton * 80597b914f4SShijith Thotton * @param dev_id 80697b914f4SShijith Thotton * Eventdev id 80797b914f4SShijith Thotton * @param queue_id 80897b914f4SShijith Thotton * Eventdev queue id 80997b914f4SShijith Thotton * @param attr_id 81097b914f4SShijith Thotton * The attribute ID to set 81197b914f4SShijith Thotton * @param attr_value 81297b914f4SShijith Thotton * The attribute value to set 81397b914f4SShijith Thotton * 81497b914f4SShijith Thotton * @return 81597b914f4SShijith Thotton * - 0: Successfully set attribute. 81697b914f4SShijith Thotton * - -EINVAL: invalid device, queue or attr_id. 81797b914f4SShijith Thotton * - -ENOTSUP: device does not support setting the event attribute. 81897b914f4SShijith Thotton * - <0: failed to set event queue attribute 81997b914f4SShijith Thotton */ 82097b914f4SShijith Thotton int 82197b914f4SShijith Thotton rte_event_queue_attr_set(uint8_t dev_id, uint8_t queue_id, uint32_t attr_id, 82297b914f4SShijith Thotton uint64_t attr_value); 82397b914f4SShijith Thotton 82499a2dd95SBruce Richardson /* Event port specific APIs */ 82599a2dd95SBruce Richardson 82699a2dd95SBruce Richardson /* Event port configuration bitmap flags */ 82799a2dd95SBruce Richardson #define RTE_EVENT_PORT_CFG_DISABLE_IMPL_REL (1ULL << 0) 82899a2dd95SBruce Richardson /**< Configure the port not to release outstanding events in 82999a2dd95SBruce Richardson * rte_event_dev_dequeue_burst(). If set, all events received through 83099a2dd95SBruce Richardson * the port must be explicitly released with RTE_EVENT_OP_RELEASE or 83199a2dd95SBruce Richardson * RTE_EVENT_OP_FORWARD. Must be unset if the device is not 83299a2dd95SBruce Richardson * RTE_EVENT_DEV_CAP_IMPLICIT_RELEASE_DISABLE capable. 83399a2dd95SBruce Richardson */ 83499a2dd95SBruce Richardson #define RTE_EVENT_PORT_CFG_SINGLE_LINK (1ULL << 1) 83599a2dd95SBruce Richardson /**< This event port links only to a single event queue. 83699a2dd95SBruce Richardson * 83799a2dd95SBruce Richardson * @see rte_event_port_setup(), rte_event_port_link() 83899a2dd95SBruce Richardson */ 83997632958SHarry van Haaren #define RTE_EVENT_PORT_CFG_HINT_PRODUCER (1ULL << 2) 84097632958SHarry van Haaren /**< Hint that this event port will primarily enqueue events to the system. 84197632958SHarry van Haaren * A PMD can optimize its internal workings by assuming that this port is 84297632958SHarry van Haaren * primarily going to enqueue NEW events. 84397632958SHarry van Haaren * 84497632958SHarry van Haaren * Note that this flag is only a hint, so PMDs must operate under the 84597632958SHarry van Haaren * assumption that any port can enqueue an event with any type of op. 84697632958SHarry van Haaren * 84797632958SHarry van Haaren * @see rte_event_port_setup() 84897632958SHarry van Haaren */ 84997632958SHarry van Haaren #define RTE_EVENT_PORT_CFG_HINT_CONSUMER (1ULL << 3) 85097632958SHarry van Haaren /**< Hint that this event port will primarily dequeue events from the system. 85197632958SHarry van Haaren * A PMD can optimize its internal workings by assuming that this port is 85297632958SHarry van Haaren * primarily going to consume events, and not enqueue FORWARD or RELEASE 85397632958SHarry van Haaren * events. 85497632958SHarry van Haaren * 85597632958SHarry van Haaren * Note that this flag is only a hint, so PMDs must operate under the 85697632958SHarry van Haaren * assumption that any port can enqueue an event with any type of op. 85797632958SHarry van Haaren * 85897632958SHarry van Haaren * @see rte_event_port_setup() 85997632958SHarry van Haaren */ 86097632958SHarry van Haaren #define RTE_EVENT_PORT_CFG_HINT_WORKER (1ULL << 4) 86197632958SHarry van Haaren /**< Hint that this event port will primarily pass existing events through. 86297632958SHarry van Haaren * A PMD can optimize its internal workings by assuming that this port is 86397632958SHarry van Haaren * primarily going to FORWARD events, and not enqueue NEW or RELEASE events 86497632958SHarry van Haaren * often. 86597632958SHarry van Haaren * 86697632958SHarry van Haaren * Note that this flag is only a hint, so PMDs must operate under the 86797632958SHarry van Haaren * assumption that any port can enqueue an event with any type of op. 86897632958SHarry van Haaren * 86997632958SHarry van Haaren * @see rte_event_port_setup() 87097632958SHarry van Haaren */ 87199a2dd95SBruce Richardson 87299a2dd95SBruce Richardson /** Event port configuration structure */ 87399a2dd95SBruce Richardson struct rte_event_port_conf { 87499a2dd95SBruce Richardson int32_t new_event_threshold; 87599a2dd95SBruce Richardson /**< A backpressure threshold for new event enqueues on this port. 87699a2dd95SBruce Richardson * Use for *closed system* event dev where event capacity is limited, 87799a2dd95SBruce Richardson * and cannot exceed the capacity of the event dev. 87899a2dd95SBruce Richardson * Configuring ports with different thresholds can make higher priority 87999a2dd95SBruce Richardson * traffic less likely to be backpressured. 88099a2dd95SBruce Richardson * For example, a port used to inject NIC Rx packets into the event dev 88199a2dd95SBruce Richardson * can have a lower threshold so as not to overwhelm the device, 88299a2dd95SBruce Richardson * while ports used for worker pools can have a higher threshold. 88399a2dd95SBruce Richardson * This value cannot exceed the *nb_events_limit* 88499a2dd95SBruce Richardson * which was previously supplied to rte_event_dev_configure(). 88599a2dd95SBruce Richardson * This should be set to '-1' for *open system*. 88699a2dd95SBruce Richardson */ 88799a2dd95SBruce Richardson uint16_t dequeue_depth; 88899a2dd95SBruce Richardson /**< Configure number of bulk dequeues for this event port. 88999a2dd95SBruce Richardson * This value cannot exceed the *nb_event_port_dequeue_depth* 89099a2dd95SBruce Richardson * which previously supplied to rte_event_dev_configure(). 89199a2dd95SBruce Richardson * Ignored when device is not RTE_EVENT_DEV_CAP_BURST_MODE capable. 89299a2dd95SBruce Richardson */ 89399a2dd95SBruce Richardson uint16_t enqueue_depth; 89499a2dd95SBruce Richardson /**< Configure number of bulk enqueues for this event port. 89599a2dd95SBruce Richardson * This value cannot exceed the *nb_event_port_enqueue_depth* 89699a2dd95SBruce Richardson * which previously supplied to rte_event_dev_configure(). 89799a2dd95SBruce Richardson * Ignored when device is not RTE_EVENT_DEV_CAP_BURST_MODE capable. 89899a2dd95SBruce Richardson */ 89999a2dd95SBruce Richardson uint32_t event_port_cfg; /**< Port cfg flags(EVENT_PORT_CFG_) */ 90099a2dd95SBruce Richardson }; 90199a2dd95SBruce Richardson 90299a2dd95SBruce Richardson /** 90399a2dd95SBruce Richardson * Retrieve the default configuration information of an event port designated 90499a2dd95SBruce Richardson * by its *port_id* from the event driver for an event device. 90599a2dd95SBruce Richardson * 90699a2dd95SBruce Richardson * This function intended to be used in conjunction with rte_event_port_setup() 90799a2dd95SBruce Richardson * where caller needs to set up the port by overriding few default values. 90899a2dd95SBruce Richardson * 90999a2dd95SBruce Richardson * @param dev_id 91099a2dd95SBruce Richardson * The identifier of the device. 91199a2dd95SBruce Richardson * @param port_id 91299a2dd95SBruce Richardson * The index of the event port to get the configuration information. 91399a2dd95SBruce Richardson * The value must be in the range [0, nb_event_ports - 1] 91499a2dd95SBruce Richardson * previously supplied to rte_event_dev_configure(). 91599a2dd95SBruce Richardson * @param[out] port_conf 91699a2dd95SBruce Richardson * The pointer to the default event port configuration data 91799a2dd95SBruce Richardson * @return 91899a2dd95SBruce Richardson * - 0: Success, driver updates the default event port configuration data. 91999a2dd95SBruce Richardson * - <0: Error code returned by the driver info get function. 92099a2dd95SBruce Richardson * 92199a2dd95SBruce Richardson * @see rte_event_port_setup() 92299a2dd95SBruce Richardson */ 92399a2dd95SBruce Richardson int 92499a2dd95SBruce Richardson rte_event_port_default_conf_get(uint8_t dev_id, uint8_t port_id, 92599a2dd95SBruce Richardson struct rte_event_port_conf *port_conf); 92699a2dd95SBruce Richardson 92799a2dd95SBruce Richardson /** 92899a2dd95SBruce Richardson * Allocate and set up an event port for an event device. 92999a2dd95SBruce Richardson * 93099a2dd95SBruce Richardson * @param dev_id 93199a2dd95SBruce Richardson * The identifier of the device. 93299a2dd95SBruce Richardson * @param port_id 93399a2dd95SBruce Richardson * The index of the event port to setup. The value must be in the range 93499a2dd95SBruce Richardson * [0, nb_event_ports - 1] previously supplied to rte_event_dev_configure(). 93599a2dd95SBruce Richardson * @param port_conf 93699a2dd95SBruce Richardson * The pointer to the configuration data to be used for the queue. 93799a2dd95SBruce Richardson * NULL value is allowed, in which case default configuration used. 93899a2dd95SBruce Richardson * 93999a2dd95SBruce Richardson * @see rte_event_port_default_conf_get() 94099a2dd95SBruce Richardson * 94199a2dd95SBruce Richardson * @return 94299a2dd95SBruce Richardson * - 0: Success, event port correctly set up. 94399a2dd95SBruce Richardson * - <0: Port configuration failed 94499a2dd95SBruce Richardson * - (-EDQUOT) Quota exceeded(Application tried to link the queue configured 94599a2dd95SBruce Richardson * with RTE_EVENT_QUEUE_CFG_SINGLE_LINK to more than one event ports) 94699a2dd95SBruce Richardson */ 94799a2dd95SBruce Richardson int 94899a2dd95SBruce Richardson rte_event_port_setup(uint8_t dev_id, uint8_t port_id, 94999a2dd95SBruce Richardson const struct rte_event_port_conf *port_conf); 95099a2dd95SBruce Richardson 9511ff23ce6SPavan Nikhilesh typedef void (*rte_eventdev_port_flush_t)(uint8_t dev_id, 9521ff23ce6SPavan Nikhilesh struct rte_event event, void *arg); 9531ff23ce6SPavan Nikhilesh /**< Callback function prototype that can be passed during 9541ff23ce6SPavan Nikhilesh * rte_event_port_release(), invoked once per a released event. 9551ff23ce6SPavan Nikhilesh */ 9561ff23ce6SPavan Nikhilesh 9571ff23ce6SPavan Nikhilesh /** 9581ff23ce6SPavan Nikhilesh * Quiesce any core specific resources consumed by the event port. 9591ff23ce6SPavan Nikhilesh * 9601ff23ce6SPavan Nikhilesh * Event ports are generally coupled with lcores, and a given Hardware 9611ff23ce6SPavan Nikhilesh * implementation might require the PMD to store port specific data in the 9621ff23ce6SPavan Nikhilesh * lcore. 9631ff23ce6SPavan Nikhilesh * When the application decides to migrate the event port to another lcore 9641ff23ce6SPavan Nikhilesh * or teardown the current lcore it may to call `rte_event_port_quiesce` 9651ff23ce6SPavan Nikhilesh * to make sure that all the data associated with the event port are released 9661ff23ce6SPavan Nikhilesh * from the lcore, this might also include any prefetched events. 9671ff23ce6SPavan Nikhilesh * While releasing the event port from the lcore, this function calls the 9681ff23ce6SPavan Nikhilesh * user-provided flush callback once per event. 9691ff23ce6SPavan Nikhilesh * 9701ff23ce6SPavan Nikhilesh * @note Invocation of this API does not affect the existing port configuration. 9711ff23ce6SPavan Nikhilesh * 9721ff23ce6SPavan Nikhilesh * @param dev_id 9731ff23ce6SPavan Nikhilesh * The identifier of the device. 9741ff23ce6SPavan Nikhilesh * @param port_id 9751ff23ce6SPavan Nikhilesh * The index of the event port to setup. The value must be in the range 9761ff23ce6SPavan Nikhilesh * [0, nb_event_ports - 1] previously supplied to rte_event_dev_configure(). 9771ff23ce6SPavan Nikhilesh * @param release_cb 9781ff23ce6SPavan Nikhilesh * Callback function invoked once per flushed event. 9791ff23ce6SPavan Nikhilesh * @param args 9801ff23ce6SPavan Nikhilesh * Argument supplied to callback. 9811ff23ce6SPavan Nikhilesh */ 9821ff23ce6SPavan Nikhilesh void 9831ff23ce6SPavan Nikhilesh rte_event_port_quiesce(uint8_t dev_id, uint8_t port_id, 9841ff23ce6SPavan Nikhilesh rte_eventdev_port_flush_t release_cb, void *args); 9851ff23ce6SPavan Nikhilesh 98699a2dd95SBruce Richardson /** 98799a2dd95SBruce Richardson * The queue depth of the port on the enqueue side 98899a2dd95SBruce Richardson */ 98999a2dd95SBruce Richardson #define RTE_EVENT_PORT_ATTR_ENQ_DEPTH 0 99099a2dd95SBruce Richardson /** 99199a2dd95SBruce Richardson * The queue depth of the port on the dequeue side 99299a2dd95SBruce Richardson */ 99399a2dd95SBruce Richardson #define RTE_EVENT_PORT_ATTR_DEQ_DEPTH 1 99499a2dd95SBruce Richardson /** 99599a2dd95SBruce Richardson * The new event threshold of the port 99699a2dd95SBruce Richardson */ 99799a2dd95SBruce Richardson #define RTE_EVENT_PORT_ATTR_NEW_EVENT_THRESHOLD 2 99899a2dd95SBruce Richardson /** 99999a2dd95SBruce Richardson * The implicit release disable attribute of the port 100099a2dd95SBruce Richardson */ 100199a2dd95SBruce Richardson #define RTE_EVENT_PORT_ATTR_IMPLICIT_RELEASE_DISABLE 3 100299a2dd95SBruce Richardson 100399a2dd95SBruce Richardson /** 100499a2dd95SBruce Richardson * Get an attribute from a port. 100599a2dd95SBruce Richardson * 100699a2dd95SBruce Richardson * @param dev_id 100799a2dd95SBruce Richardson * Eventdev id 100899a2dd95SBruce Richardson * @param port_id 100999a2dd95SBruce Richardson * Eventdev port id 101099a2dd95SBruce Richardson * @param attr_id 101199a2dd95SBruce Richardson * The attribute ID to retrieve 101299a2dd95SBruce Richardson * @param[out] attr_value 101399a2dd95SBruce Richardson * A pointer that will be filled in with the attribute value if successful 101499a2dd95SBruce Richardson * 101599a2dd95SBruce Richardson * @return 101699a2dd95SBruce Richardson * - 0: Successfully returned value 101799a2dd95SBruce Richardson * - (-EINVAL) Invalid device, port or attr_id, or attr_value was NULL 101899a2dd95SBruce Richardson */ 101999a2dd95SBruce Richardson int 102099a2dd95SBruce Richardson rte_event_port_attr_get(uint8_t dev_id, uint8_t port_id, uint32_t attr_id, 102199a2dd95SBruce Richardson uint32_t *attr_value); 102299a2dd95SBruce Richardson 102399a2dd95SBruce Richardson /** 102499a2dd95SBruce Richardson * Start an event device. 102599a2dd95SBruce Richardson * 102699a2dd95SBruce Richardson * The device start step is the last one and consists of setting the event 102799a2dd95SBruce Richardson * queues to start accepting the events and schedules to event ports. 102899a2dd95SBruce Richardson * 102999a2dd95SBruce Richardson * On success, all basic functions exported by the API (event enqueue, 103099a2dd95SBruce Richardson * event dequeue and so on) can be invoked. 103199a2dd95SBruce Richardson * 103299a2dd95SBruce Richardson * @param dev_id 103399a2dd95SBruce Richardson * Event device identifier 103499a2dd95SBruce Richardson * @return 103599a2dd95SBruce Richardson * - 0: Success, device started. 103699a2dd95SBruce Richardson * - -ESTALE : Not all ports of the device are configured 103799a2dd95SBruce Richardson * - -ENOLINK: Not all queues are linked, which could lead to deadlock. 103899a2dd95SBruce Richardson */ 103999a2dd95SBruce Richardson int 104099a2dd95SBruce Richardson rte_event_dev_start(uint8_t dev_id); 104199a2dd95SBruce Richardson 104299a2dd95SBruce Richardson /** 104399a2dd95SBruce Richardson * Stop an event device. 104499a2dd95SBruce Richardson * 104599a2dd95SBruce Richardson * This function causes all queued events to be drained, including those 104699a2dd95SBruce Richardson * residing in event ports. While draining events out of the device, this 104799a2dd95SBruce Richardson * function calls the user-provided flush callback (if one was registered) once 104899a2dd95SBruce Richardson * per event. 104999a2dd95SBruce Richardson * 105099a2dd95SBruce Richardson * The device can be restarted with a call to rte_event_dev_start(). Threads 105199a2dd95SBruce Richardson * that continue to enqueue/dequeue while the device is stopped, or being 105299a2dd95SBruce Richardson * stopped, will result in undefined behavior. This includes event adapters, 105399a2dd95SBruce Richardson * which must be stopped prior to stopping the eventdev. 105499a2dd95SBruce Richardson * 105599a2dd95SBruce Richardson * @param dev_id 105699a2dd95SBruce Richardson * Event device identifier. 105799a2dd95SBruce Richardson * 105899a2dd95SBruce Richardson * @see rte_event_dev_stop_flush_callback_register() 105999a2dd95SBruce Richardson */ 106099a2dd95SBruce Richardson void 106199a2dd95SBruce Richardson rte_event_dev_stop(uint8_t dev_id); 106299a2dd95SBruce Richardson 1063d986276fSPavan Nikhilesh typedef void (*rte_eventdev_stop_flush_t)(uint8_t dev_id, 1064d986276fSPavan Nikhilesh struct rte_event event, void *arg); 106599a2dd95SBruce Richardson /**< Callback function called during rte_event_dev_stop(), invoked once per 106699a2dd95SBruce Richardson * flushed event. 106799a2dd95SBruce Richardson */ 106899a2dd95SBruce Richardson 106999a2dd95SBruce Richardson /** 107099a2dd95SBruce Richardson * Registers a callback function to be invoked during rte_event_dev_stop() for 107199a2dd95SBruce Richardson * each flushed event. This function can be used to properly dispose of queued 107299a2dd95SBruce Richardson * events, for example events containing memory pointers. 107399a2dd95SBruce Richardson * 107499a2dd95SBruce Richardson * The callback function is only registered for the calling process. The 107599a2dd95SBruce Richardson * callback function must be registered in every process that can call 107699a2dd95SBruce Richardson * rte_event_dev_stop(). 107799a2dd95SBruce Richardson * 107899a2dd95SBruce Richardson * To unregister a callback, call this function with a NULL callback pointer. 107999a2dd95SBruce Richardson * 108099a2dd95SBruce Richardson * @param dev_id 108199a2dd95SBruce Richardson * The identifier of the device. 108299a2dd95SBruce Richardson * @param callback 108399a2dd95SBruce Richardson * Callback function invoked once per flushed event. 108499a2dd95SBruce Richardson * @param userdata 108599a2dd95SBruce Richardson * Argument supplied to callback. 108699a2dd95SBruce Richardson * 108799a2dd95SBruce Richardson * @return 108899a2dd95SBruce Richardson * - 0 on success. 108999a2dd95SBruce Richardson * - -EINVAL if *dev_id* is invalid 109099a2dd95SBruce Richardson * 109199a2dd95SBruce Richardson * @see rte_event_dev_stop() 109299a2dd95SBruce Richardson */ 1093d986276fSPavan Nikhilesh int rte_event_dev_stop_flush_callback_register(uint8_t dev_id, 1094d986276fSPavan Nikhilesh rte_eventdev_stop_flush_t callback, void *userdata); 109599a2dd95SBruce Richardson 109699a2dd95SBruce Richardson /** 109799a2dd95SBruce Richardson * Close an event device. The device cannot be restarted! 109899a2dd95SBruce Richardson * 109999a2dd95SBruce Richardson * @param dev_id 110099a2dd95SBruce Richardson * Event device identifier 110199a2dd95SBruce Richardson * 110299a2dd95SBruce Richardson * @return 110399a2dd95SBruce Richardson * - 0 on successfully closing device 110499a2dd95SBruce Richardson * - <0 on failure to close device 110599a2dd95SBruce Richardson * - (-EAGAIN) if device is busy 110699a2dd95SBruce Richardson */ 110799a2dd95SBruce Richardson int 110899a2dd95SBruce Richardson rte_event_dev_close(uint8_t dev_id); 110999a2dd95SBruce Richardson 111099a2dd95SBruce Richardson /** 111199a2dd95SBruce Richardson * Event vector structure. 111299a2dd95SBruce Richardson */ 111399a2dd95SBruce Richardson struct rte_event_vector { 111499a2dd95SBruce Richardson uint16_t nb_elem; 11150fbb55efSPavan Nikhilesh /**< Number of elements valid in this event vector. */ 11160fbb55efSPavan Nikhilesh uint16_t elem_offset : 12; 11170fbb55efSPavan Nikhilesh /**< Offset into the vector array where valid elements start from. */ 11180fbb55efSPavan Nikhilesh uint16_t rsvd : 3; 111999a2dd95SBruce Richardson /**< Reserved for future use */ 112099a2dd95SBruce Richardson uint16_t attr_valid : 1; 112199a2dd95SBruce Richardson /**< Indicates that the below union attributes have valid information. 112299a2dd95SBruce Richardson */ 112399a2dd95SBruce Richardson union { 112499a2dd95SBruce Richardson /* Used by Rx/Tx adapter. 112599a2dd95SBruce Richardson * Indicates that all the elements in this vector belong to the 112699a2dd95SBruce Richardson * same port and queue pair when originating from Rx adapter, 112799a2dd95SBruce Richardson * valid only when event type is ETHDEV_VECTOR or 112899a2dd95SBruce Richardson * ETH_RX_ADAPTER_VECTOR. 112999a2dd95SBruce Richardson * Can also be used to indicate the Tx adapter the destination 113099a2dd95SBruce Richardson * port and queue of the mbufs in the vector 113199a2dd95SBruce Richardson */ 113299a2dd95SBruce Richardson struct { 113399a2dd95SBruce Richardson uint16_t port; 113499a2dd95SBruce Richardson /* Ethernet device port id. */ 113599a2dd95SBruce Richardson uint16_t queue; 113699a2dd95SBruce Richardson /* Ethernet device queue id. */ 113799a2dd95SBruce Richardson }; 113899a2dd95SBruce Richardson }; 113999a2dd95SBruce Richardson /**< Union to hold common attributes of the vector array. */ 114099a2dd95SBruce Richardson uint64_t impl_opaque; 1141699155f2SBruce Richardson 1142699155f2SBruce Richardson /* empty structures do not have zero size in C++ leading to compilation errors 1143699155f2SBruce Richardson * with clang about structure having different sizes in C and C++. 1144699155f2SBruce Richardson * Since these are all zero-sized arrays, we can omit the "union" wrapper for 1145699155f2SBruce Richardson * C++ builds, removing the warning. 1146699155f2SBruce Richardson */ 1147699155f2SBruce Richardson #ifndef __cplusplus 114899a2dd95SBruce Richardson /**< Implementation specific opaque value. 114999a2dd95SBruce Richardson * An implementation may use this field to hold implementation specific 115099a2dd95SBruce Richardson * value to share between dequeue and enqueue operation. 115199a2dd95SBruce Richardson * The application should not modify this field. 115299a2dd95SBruce Richardson */ 115399a2dd95SBruce Richardson union { 1154699155f2SBruce Richardson #endif 115599a2dd95SBruce Richardson struct rte_mbuf *mbufs[0]; 115699a2dd95SBruce Richardson void *ptrs[0]; 11575fa63911SPavan Nikhilesh uint64_t u64s[0]; 1158699155f2SBruce Richardson #ifndef __cplusplus 115999a2dd95SBruce Richardson } __rte_aligned(16); 1160699155f2SBruce Richardson #endif 116199a2dd95SBruce Richardson /**< Start of the vector array union. Depending upon the event type the 116299a2dd95SBruce Richardson * vector array can be an array of mbufs or pointers or opaque u64 116399a2dd95SBruce Richardson * values. 116499a2dd95SBruce Richardson */ 1165699155f2SBruce Richardson } __rte_aligned(16); 116699a2dd95SBruce Richardson 116799a2dd95SBruce Richardson /* Scheduler type definitions */ 116899a2dd95SBruce Richardson #define RTE_SCHED_TYPE_ORDERED 0 116999a2dd95SBruce Richardson /**< Ordered scheduling 117099a2dd95SBruce Richardson * 117199a2dd95SBruce Richardson * Events from an ordered flow of an event queue can be scheduled to multiple 117299a2dd95SBruce Richardson * ports for concurrent processing while maintaining the original event order. 117399a2dd95SBruce Richardson * This scheme enables the user to achieve high single flow throughput by 117499a2dd95SBruce Richardson * avoiding SW synchronization for ordering between ports which bound to cores. 117599a2dd95SBruce Richardson * 117699a2dd95SBruce Richardson * The source flow ordering from an event queue is maintained when events are 117799a2dd95SBruce Richardson * enqueued to their destination queue within the same ordered flow context. 117899a2dd95SBruce Richardson * An event port holds the context until application call 117999a2dd95SBruce Richardson * rte_event_dequeue_burst() from the same port, which implicitly releases 118099a2dd95SBruce Richardson * the context. 118199a2dd95SBruce Richardson * User may allow the scheduler to release the context earlier than that 118299a2dd95SBruce Richardson * by invoking rte_event_enqueue_burst() with RTE_EVENT_OP_RELEASE operation. 118399a2dd95SBruce Richardson * 118499a2dd95SBruce Richardson * Events from the source queue appear in their original order when dequeued 118599a2dd95SBruce Richardson * from a destination queue. 118699a2dd95SBruce Richardson * Event ordering is based on the received event(s), but also other 118799a2dd95SBruce Richardson * (newly allocated or stored) events are ordered when enqueued within the same 118899a2dd95SBruce Richardson * ordered context. Events not enqueued (e.g. released or stored) within the 118999a2dd95SBruce Richardson * context are considered missing from reordering and are skipped at this time 119099a2dd95SBruce Richardson * (but can be ordered again within another context). 119199a2dd95SBruce Richardson * 119299a2dd95SBruce Richardson * @see rte_event_queue_setup(), rte_event_dequeue_burst(), RTE_EVENT_OP_RELEASE 119399a2dd95SBruce Richardson */ 119499a2dd95SBruce Richardson 119599a2dd95SBruce Richardson #define RTE_SCHED_TYPE_ATOMIC 1 119699a2dd95SBruce Richardson /**< Atomic scheduling 119799a2dd95SBruce Richardson * 119899a2dd95SBruce Richardson * Events from an atomic flow of an event queue can be scheduled only to a 119999a2dd95SBruce Richardson * single port at a time. The port is guaranteed to have exclusive (atomic) 120099a2dd95SBruce Richardson * access to the associated flow context, which enables the user to avoid SW 120199a2dd95SBruce Richardson * synchronization. Atomic flows also help to maintain event ordering 120299a2dd95SBruce Richardson * since only one port at a time can process events from a flow of an 120399a2dd95SBruce Richardson * event queue. 120499a2dd95SBruce Richardson * 120599a2dd95SBruce Richardson * The atomic queue synchronization context is dedicated to the port until 120699a2dd95SBruce Richardson * application call rte_event_dequeue_burst() from the same port, 120799a2dd95SBruce Richardson * which implicitly releases the context. User may allow the scheduler to 120899a2dd95SBruce Richardson * release the context earlier than that by invoking rte_event_enqueue_burst() 120999a2dd95SBruce Richardson * with RTE_EVENT_OP_RELEASE operation. 121099a2dd95SBruce Richardson * 121199a2dd95SBruce Richardson * @see rte_event_queue_setup(), rte_event_dequeue_burst(), RTE_EVENT_OP_RELEASE 121299a2dd95SBruce Richardson */ 121399a2dd95SBruce Richardson 121499a2dd95SBruce Richardson #define RTE_SCHED_TYPE_PARALLEL 2 121599a2dd95SBruce Richardson /**< Parallel scheduling 121699a2dd95SBruce Richardson * 121799a2dd95SBruce Richardson * The scheduler performs priority scheduling, load balancing, etc. functions 121899a2dd95SBruce Richardson * but does not provide additional event synchronization or ordering. 121999a2dd95SBruce Richardson * It is free to schedule events from a single parallel flow of an event queue 122099a2dd95SBruce Richardson * to multiple events ports for concurrent processing. 122199a2dd95SBruce Richardson * The application is responsible for flow context synchronization and 122299a2dd95SBruce Richardson * event ordering (SW synchronization). 122399a2dd95SBruce Richardson * 122499a2dd95SBruce Richardson * @see rte_event_queue_setup(), rte_event_dequeue_burst() 122599a2dd95SBruce Richardson */ 122699a2dd95SBruce Richardson 122799a2dd95SBruce Richardson /* Event types to classify the event source */ 122899a2dd95SBruce Richardson #define RTE_EVENT_TYPE_ETHDEV 0x0 122999a2dd95SBruce Richardson /**< The event generated from ethdev subsystem */ 123099a2dd95SBruce Richardson #define RTE_EVENT_TYPE_CRYPTODEV 0x1 123199a2dd95SBruce Richardson /**< The event generated from crypodev subsystem */ 123299a2dd95SBruce Richardson #define RTE_EVENT_TYPE_TIMER 0x2 123399a2dd95SBruce Richardson /**< The event generated from event timer adapter */ 123499a2dd95SBruce Richardson #define RTE_EVENT_TYPE_CPU 0x3 123599a2dd95SBruce Richardson /**< The event generated from cpu for pipelining. 123699a2dd95SBruce Richardson * Application may use *sub_event_type* to further classify the event 123799a2dd95SBruce Richardson */ 123899a2dd95SBruce Richardson #define RTE_EVENT_TYPE_ETH_RX_ADAPTER 0x4 123999a2dd95SBruce Richardson /**< The event generated from event eth Rx adapter */ 124066a30a29SAmit Prakash Shukla #define RTE_EVENT_TYPE_DMADEV 0x5 124166a30a29SAmit Prakash Shukla /**< The event generated from dma subsystem */ 124299a2dd95SBruce Richardson #define RTE_EVENT_TYPE_VECTOR 0x8 124399a2dd95SBruce Richardson /**< Indicates that event is a vector. 124499a2dd95SBruce Richardson * All vector event types should be a logical OR of EVENT_TYPE_VECTOR. 124599a2dd95SBruce Richardson * This simplifies the pipeline design as one can split processing the events 124699a2dd95SBruce Richardson * between vector events and normal event across event types. 124799a2dd95SBruce Richardson * Example: 124899a2dd95SBruce Richardson * if (ev.event_type & RTE_EVENT_TYPE_VECTOR) { 124999a2dd95SBruce Richardson * // Classify and handle vector event. 125099a2dd95SBruce Richardson * } else { 125199a2dd95SBruce Richardson * // Classify and handle event. 125299a2dd95SBruce Richardson * } 125399a2dd95SBruce Richardson */ 125499a2dd95SBruce Richardson #define RTE_EVENT_TYPE_ETHDEV_VECTOR \ 125599a2dd95SBruce Richardson (RTE_EVENT_TYPE_VECTOR | RTE_EVENT_TYPE_ETHDEV) 125699a2dd95SBruce Richardson /**< The event vector generated from ethdev subsystem */ 125799a2dd95SBruce Richardson #define RTE_EVENT_TYPE_CPU_VECTOR (RTE_EVENT_TYPE_VECTOR | RTE_EVENT_TYPE_CPU) 125899a2dd95SBruce Richardson /**< The event vector generated from cpu for pipelining. */ 125999a2dd95SBruce Richardson #define RTE_EVENT_TYPE_ETH_RX_ADAPTER_VECTOR \ 126099a2dd95SBruce Richardson (RTE_EVENT_TYPE_VECTOR | RTE_EVENT_TYPE_ETH_RX_ADAPTER) 126199a2dd95SBruce Richardson /**< The event vector generated from eth Rx adapter. */ 1262c1749bc5SVolodymyr Fialko #define RTE_EVENT_TYPE_CRYPTODEV_VECTOR \ 1263c1749bc5SVolodymyr Fialko (RTE_EVENT_TYPE_VECTOR | RTE_EVENT_TYPE_CRYPTODEV) 1264c1749bc5SVolodymyr Fialko /**< The event vector generated from cryptodev adapter. */ 126599a2dd95SBruce Richardson 126699a2dd95SBruce Richardson #define RTE_EVENT_TYPE_MAX 0x10 126799a2dd95SBruce Richardson /**< Maximum number of event types */ 126899a2dd95SBruce Richardson 126999a2dd95SBruce Richardson /* Event enqueue operations */ 127099a2dd95SBruce Richardson #define RTE_EVENT_OP_NEW 0 127199a2dd95SBruce Richardson /**< The event producers use this operation to inject a new event to the 127299a2dd95SBruce Richardson * event device. 127399a2dd95SBruce Richardson */ 127499a2dd95SBruce Richardson #define RTE_EVENT_OP_FORWARD 1 127599a2dd95SBruce Richardson /**< The CPU use this operation to forward the event to different event queue or 127699a2dd95SBruce Richardson * change to new application specific flow or schedule type to enable 127799a2dd95SBruce Richardson * pipelining. 127899a2dd95SBruce Richardson * 127999a2dd95SBruce Richardson * This operation must only be enqueued to the same port that the 128099a2dd95SBruce Richardson * event to be forwarded was dequeued from. 128199a2dd95SBruce Richardson */ 128299a2dd95SBruce Richardson #define RTE_EVENT_OP_RELEASE 2 128399a2dd95SBruce Richardson /**< Release the flow context associated with the schedule type. 128499a2dd95SBruce Richardson * 128599a2dd95SBruce Richardson * If current flow's scheduler type method is *RTE_SCHED_TYPE_ATOMIC* 128699a2dd95SBruce Richardson * then this function hints the scheduler that the user has completed critical 128799a2dd95SBruce Richardson * section processing in the current atomic context. 128899a2dd95SBruce Richardson * The scheduler is now allowed to schedule events from the same flow from 128999a2dd95SBruce Richardson * an event queue to another port. However, the context may be still held 129099a2dd95SBruce Richardson * until the next rte_event_dequeue_burst() call, this call allows but does not 129199a2dd95SBruce Richardson * force the scheduler to release the context early. 129299a2dd95SBruce Richardson * 129399a2dd95SBruce Richardson * Early atomic context release may increase parallelism and thus system 129499a2dd95SBruce Richardson * performance, but the user needs to design carefully the split into critical 129599a2dd95SBruce Richardson * vs non-critical sections. 129699a2dd95SBruce Richardson * 129799a2dd95SBruce Richardson * If current flow's scheduler type method is *RTE_SCHED_TYPE_ORDERED* 129899a2dd95SBruce Richardson * then this function hints the scheduler that the user has done all that need 129999a2dd95SBruce Richardson * to maintain event order in the current ordered context. 130099a2dd95SBruce Richardson * The scheduler is allowed to release the ordered context of this port and 130199a2dd95SBruce Richardson * avoid reordering any following enqueues. 130299a2dd95SBruce Richardson * 130399a2dd95SBruce Richardson * Early ordered context release may increase parallelism and thus system 130499a2dd95SBruce Richardson * performance. 130599a2dd95SBruce Richardson * 130699a2dd95SBruce Richardson * If current flow's scheduler type method is *RTE_SCHED_TYPE_PARALLEL* 130799a2dd95SBruce Richardson * or no scheduling context is held then this function may be an NOOP, 130899a2dd95SBruce Richardson * depending on the implementation. 130999a2dd95SBruce Richardson * 131099a2dd95SBruce Richardson * This operation must only be enqueued to the same port that the 131199a2dd95SBruce Richardson * event to be released was dequeued from. 131299a2dd95SBruce Richardson */ 131399a2dd95SBruce Richardson 131499a2dd95SBruce Richardson /** 131599a2dd95SBruce Richardson * The generic *rte_event* structure to hold the event attributes 131699a2dd95SBruce Richardson * for dequeue and enqueue operation 131799a2dd95SBruce Richardson */ 131899a2dd95SBruce Richardson struct rte_event { 131999a2dd95SBruce Richardson /** WORD0 */ 132099a2dd95SBruce Richardson union { 132199a2dd95SBruce Richardson uint64_t event; 132299a2dd95SBruce Richardson /** Event attributes for dequeue or enqueue operation */ 132399a2dd95SBruce Richardson struct { 132499a2dd95SBruce Richardson uint32_t flow_id:20; 132599a2dd95SBruce Richardson /**< Targeted flow identifier for the enqueue and 132699a2dd95SBruce Richardson * dequeue operation. 132799a2dd95SBruce Richardson * The value must be in the range of 132899a2dd95SBruce Richardson * [0, nb_event_queue_flows - 1] which 132999a2dd95SBruce Richardson * previously supplied to rte_event_dev_configure(). 133099a2dd95SBruce Richardson */ 133199a2dd95SBruce Richardson uint32_t sub_event_type:8; 133299a2dd95SBruce Richardson /**< Sub-event types based on the event source. 133399a2dd95SBruce Richardson * @see RTE_EVENT_TYPE_CPU 133499a2dd95SBruce Richardson */ 133599a2dd95SBruce Richardson uint32_t event_type:4; 133699a2dd95SBruce Richardson /**< Event type to classify the event source. 133799a2dd95SBruce Richardson * @see RTE_EVENT_TYPE_ETHDEV, (RTE_EVENT_TYPE_*) 133899a2dd95SBruce Richardson */ 133999a2dd95SBruce Richardson uint8_t op:2; 134099a2dd95SBruce Richardson /**< The type of event enqueue operation - new/forward/ 134199a2dd95SBruce Richardson * etc.This field is not preserved across an instance 134299a2dd95SBruce Richardson * and is undefined on dequeue. 134399a2dd95SBruce Richardson * @see RTE_EVENT_OP_NEW, (RTE_EVENT_OP_*) 134499a2dd95SBruce Richardson */ 134599a2dd95SBruce Richardson uint8_t rsvd:4; 134699a2dd95SBruce Richardson /**< Reserved for future use */ 134799a2dd95SBruce Richardson uint8_t sched_type:2; 134899a2dd95SBruce Richardson /**< Scheduler synchronization type (RTE_SCHED_TYPE_*) 134999a2dd95SBruce Richardson * associated with flow id on a given event queue 135099a2dd95SBruce Richardson * for the enqueue and dequeue operation. 135199a2dd95SBruce Richardson */ 135299a2dd95SBruce Richardson uint8_t queue_id; 135399a2dd95SBruce Richardson /**< Targeted event queue identifier for the enqueue or 135499a2dd95SBruce Richardson * dequeue operation. 135599a2dd95SBruce Richardson * The value must be in the range of 135699a2dd95SBruce Richardson * [0, nb_event_queues - 1] which previously supplied to 135799a2dd95SBruce Richardson * rte_event_dev_configure(). 135899a2dd95SBruce Richardson */ 135999a2dd95SBruce Richardson uint8_t priority; 136099a2dd95SBruce Richardson /**< Event priority relative to other events in the 136199a2dd95SBruce Richardson * event queue. The requested priority should in the 136299a2dd95SBruce Richardson * range of [RTE_EVENT_DEV_PRIORITY_HIGHEST, 136399a2dd95SBruce Richardson * RTE_EVENT_DEV_PRIORITY_LOWEST]. 136499a2dd95SBruce Richardson * The implementation shall normalize the requested 136599a2dd95SBruce Richardson * priority to supported priority value. 136699a2dd95SBruce Richardson * Valid when the device has 136799a2dd95SBruce Richardson * RTE_EVENT_DEV_CAP_EVENT_QOS capability. 136899a2dd95SBruce Richardson */ 136999a2dd95SBruce Richardson uint8_t impl_opaque; 137099a2dd95SBruce Richardson /**< Implementation specific opaque value. 137199a2dd95SBruce Richardson * An implementation may use this field to hold 137299a2dd95SBruce Richardson * implementation specific value to share between 137399a2dd95SBruce Richardson * dequeue and enqueue operation. 137499a2dd95SBruce Richardson * The application should not modify this field. 137599a2dd95SBruce Richardson */ 137699a2dd95SBruce Richardson }; 137799a2dd95SBruce Richardson }; 137899a2dd95SBruce Richardson /** WORD1 */ 137999a2dd95SBruce Richardson union { 138099a2dd95SBruce Richardson uint64_t u64; 138199a2dd95SBruce Richardson /**< Opaque 64-bit value */ 138299a2dd95SBruce Richardson void *event_ptr; 138399a2dd95SBruce Richardson /**< Opaque event pointer */ 138499a2dd95SBruce Richardson struct rte_mbuf *mbuf; 138599a2dd95SBruce Richardson /**< mbuf pointer if dequeued event is associated with mbuf */ 138699a2dd95SBruce Richardson struct rte_event_vector *vec; 138799a2dd95SBruce Richardson /**< Event vector pointer. */ 138899a2dd95SBruce Richardson }; 138999a2dd95SBruce Richardson }; 139099a2dd95SBruce Richardson 139199a2dd95SBruce Richardson /* Ethdev Rx adapter capability bitmap flags */ 139299a2dd95SBruce Richardson #define RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT 0x1 139399a2dd95SBruce Richardson /**< This flag is sent when the packet transfer mechanism is in HW. 139499a2dd95SBruce Richardson * Ethdev can send packets to the event device using internal event port. 139599a2dd95SBruce Richardson */ 139699a2dd95SBruce Richardson #define RTE_EVENT_ETH_RX_ADAPTER_CAP_MULTI_EVENTQ 0x2 139799a2dd95SBruce Richardson /**< Adapter supports multiple event queues per ethdev. Every ethdev 139899a2dd95SBruce Richardson * Rx queue can be connected to a unique event queue. 139999a2dd95SBruce Richardson */ 140099a2dd95SBruce Richardson #define RTE_EVENT_ETH_RX_ADAPTER_CAP_OVERRIDE_FLOW_ID 0x4 140199a2dd95SBruce Richardson /**< The application can override the adapter generated flow ID in the 140299a2dd95SBruce Richardson * event. This flow ID can be specified when adding an ethdev Rx queue 1403a256a743SPavan Nikhilesh * to the adapter using the ev.flow_id member. 140499a2dd95SBruce Richardson * @see struct rte_event_eth_rx_adapter_queue_conf::ev 140599a2dd95SBruce Richardson * @see struct rte_event_eth_rx_adapter_queue_conf::rx_queue_flags 140699a2dd95SBruce Richardson */ 140799a2dd95SBruce Richardson #define RTE_EVENT_ETH_RX_ADAPTER_CAP_EVENT_VECTOR 0x8 140899a2dd95SBruce Richardson /**< Adapter supports event vectorization per ethdev. */ 140999a2dd95SBruce Richardson 141099a2dd95SBruce Richardson /** 141199a2dd95SBruce Richardson * Retrieve the event device's ethdev Rx adapter capabilities for the 141299a2dd95SBruce Richardson * specified ethernet port 141399a2dd95SBruce Richardson * 141499a2dd95SBruce Richardson * @param dev_id 141599a2dd95SBruce Richardson * The identifier of the device. 141699a2dd95SBruce Richardson * 141799a2dd95SBruce Richardson * @param eth_port_id 141899a2dd95SBruce Richardson * The identifier of the ethernet device. 141999a2dd95SBruce Richardson * 142099a2dd95SBruce Richardson * @param[out] caps 142199a2dd95SBruce Richardson * A pointer to memory filled with Rx event adapter capabilities. 142299a2dd95SBruce Richardson * 142399a2dd95SBruce Richardson * @return 142499a2dd95SBruce Richardson * - 0: Success, driver provides Rx event adapter capabilities for the 142599a2dd95SBruce Richardson * ethernet device. 142699a2dd95SBruce Richardson * - <0: Error code returned by the driver function. 142799a2dd95SBruce Richardson */ 142899a2dd95SBruce Richardson int 142999a2dd95SBruce Richardson rte_event_eth_rx_adapter_caps_get(uint8_t dev_id, uint16_t eth_port_id, 143099a2dd95SBruce Richardson uint32_t *caps); 143199a2dd95SBruce Richardson 143299a2dd95SBruce Richardson #define RTE_EVENT_TIMER_ADAPTER_CAP_INTERNAL_PORT (1ULL << 0) 143399a2dd95SBruce Richardson /**< This flag is set when the timer mechanism is in HW. */ 143499a2dd95SBruce Richardson 143599a2dd95SBruce Richardson #define RTE_EVENT_TIMER_ADAPTER_CAP_PERIODIC (1ULL << 1) 143699a2dd95SBruce Richardson /**< This flag is set if periodic mode is supported. */ 143799a2dd95SBruce Richardson 143899a2dd95SBruce Richardson /** 143999a2dd95SBruce Richardson * Retrieve the event device's timer adapter capabilities. 144099a2dd95SBruce Richardson * 144199a2dd95SBruce Richardson * @param dev_id 144299a2dd95SBruce Richardson * The identifier of the device. 144399a2dd95SBruce Richardson * 144499a2dd95SBruce Richardson * @param[out] caps 144599a2dd95SBruce Richardson * A pointer to memory to be filled with event timer adapter capabilities. 144699a2dd95SBruce Richardson * 144799a2dd95SBruce Richardson * @return 144899a2dd95SBruce Richardson * - 0: Success, driver provided event timer adapter capabilities. 144999a2dd95SBruce Richardson * - <0: Error code returned by the driver function. 145099a2dd95SBruce Richardson */ 145199a2dd95SBruce Richardson int 145299a2dd95SBruce Richardson rte_event_timer_adapter_caps_get(uint8_t dev_id, uint32_t *caps); 145399a2dd95SBruce Richardson 145499a2dd95SBruce Richardson /* Crypto adapter capability bitmap flag */ 145599a2dd95SBruce Richardson #define RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_OP_NEW 0x1 145699a2dd95SBruce Richardson /**< Flag indicates HW is capable of generating events in 145799a2dd95SBruce Richardson * RTE_EVENT_OP_NEW enqueue operation. Cryptodev will send 145899a2dd95SBruce Richardson * packets to the event device as new events using an internal 145999a2dd95SBruce Richardson * event port. 146099a2dd95SBruce Richardson */ 146199a2dd95SBruce Richardson 146299a2dd95SBruce Richardson #define RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_OP_FWD 0x2 146399a2dd95SBruce Richardson /**< Flag indicates HW is capable of generating events in 146499a2dd95SBruce Richardson * RTE_EVENT_OP_FORWARD enqueue operation. Cryptodev will send 146599a2dd95SBruce Richardson * packets to the event device as forwarded event using an 146699a2dd95SBruce Richardson * internal event port. 146799a2dd95SBruce Richardson */ 146899a2dd95SBruce Richardson 146999a2dd95SBruce Richardson #define RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_QP_EV_BIND 0x4 147099a2dd95SBruce Richardson /**< Flag indicates HW is capable of mapping crypto queue pair to 147199a2dd95SBruce Richardson * event queue. 147299a2dd95SBruce Richardson */ 147399a2dd95SBruce Richardson 147499a2dd95SBruce Richardson #define RTE_EVENT_CRYPTO_ADAPTER_CAP_SESSION_PRIVATE_DATA 0x8 147599a2dd95SBruce Richardson /**< Flag indicates HW/SW supports a mechanism to store and retrieve 147699a2dd95SBruce Richardson * the private data information along with the crypto session. 147799a2dd95SBruce Richardson */ 147899a2dd95SBruce Richardson 1479c1749bc5SVolodymyr Fialko #define RTE_EVENT_CRYPTO_ADAPTER_CAP_EVENT_VECTOR 0x10 1480c1749bc5SVolodymyr Fialko /**< Flag indicates HW is capable of aggregating processed 1481c1749bc5SVolodymyr Fialko * crypto operations into rte_event_vector. 1482c1749bc5SVolodymyr Fialko */ 1483c1749bc5SVolodymyr Fialko 148499a2dd95SBruce Richardson /** 148599a2dd95SBruce Richardson * Retrieve the event device's crypto adapter capabilities for the 148699a2dd95SBruce Richardson * specified cryptodev device 148799a2dd95SBruce Richardson * 148899a2dd95SBruce Richardson * @param dev_id 148999a2dd95SBruce Richardson * The identifier of the device. 149099a2dd95SBruce Richardson * 149199a2dd95SBruce Richardson * @param cdev_id 149299a2dd95SBruce Richardson * The identifier of the cryptodev device. 149399a2dd95SBruce Richardson * 149499a2dd95SBruce Richardson * @param[out] caps 149599a2dd95SBruce Richardson * A pointer to memory filled with event adapter capabilities. 149699a2dd95SBruce Richardson * It is expected to be pre-allocated & initialized by caller. 149799a2dd95SBruce Richardson * 149899a2dd95SBruce Richardson * @return 149999a2dd95SBruce Richardson * - 0: Success, driver provides event adapter capabilities for the 150099a2dd95SBruce Richardson * cryptodev device. 150199a2dd95SBruce Richardson * - <0: Error code returned by the driver function. 150299a2dd95SBruce Richardson */ 150399a2dd95SBruce Richardson int 150499a2dd95SBruce Richardson rte_event_crypto_adapter_caps_get(uint8_t dev_id, uint8_t cdev_id, 150599a2dd95SBruce Richardson uint32_t *caps); 150699a2dd95SBruce Richardson 150766a30a29SAmit Prakash Shukla /* DMA adapter capability bitmap flag */ 150866a30a29SAmit Prakash Shukla #define RTE_EVENT_DMA_ADAPTER_CAP_INTERNAL_PORT_OP_NEW 0x1 150966a30a29SAmit Prakash Shukla /**< Flag indicates HW is capable of generating events in 151066a30a29SAmit Prakash Shukla * RTE_EVENT_OP_NEW enqueue operation. DMADEV will send 151166a30a29SAmit Prakash Shukla * packets to the event device as new events using an 151266a30a29SAmit Prakash Shukla * internal event port. 151366a30a29SAmit Prakash Shukla */ 151466a30a29SAmit Prakash Shukla 151566a30a29SAmit Prakash Shukla #define RTE_EVENT_DMA_ADAPTER_CAP_INTERNAL_PORT_OP_FWD 0x2 151666a30a29SAmit Prakash Shukla /**< Flag indicates HW is capable of generating events in 151766a30a29SAmit Prakash Shukla * RTE_EVENT_OP_FORWARD enqueue operation. DMADEV will send 151866a30a29SAmit Prakash Shukla * packets to the event device as forwarded event using an 151966a30a29SAmit Prakash Shukla * internal event port. 152066a30a29SAmit Prakash Shukla */ 152166a30a29SAmit Prakash Shukla 152266a30a29SAmit Prakash Shukla #define RTE_EVENT_DMA_ADAPTER_CAP_INTERNAL_PORT_VCHAN_EV_BIND 0x4 152366a30a29SAmit Prakash Shukla /**< Flag indicates HW is capable of mapping DMA vchan to event queue. */ 152466a30a29SAmit Prakash Shukla 152566a30a29SAmit Prakash Shukla /** 152666a30a29SAmit Prakash Shukla * Retrieve the event device's DMA adapter capabilities for the 152766a30a29SAmit Prakash Shukla * specified dmadev device 152866a30a29SAmit Prakash Shukla * 152966a30a29SAmit Prakash Shukla * @param dev_id 153066a30a29SAmit Prakash Shukla * The identifier of the device. 153166a30a29SAmit Prakash Shukla * 153266a30a29SAmit Prakash Shukla * @param dmadev_id 153366a30a29SAmit Prakash Shukla * The identifier of the dmadev device. 153466a30a29SAmit Prakash Shukla * 153566a30a29SAmit Prakash Shukla * @param[out] caps 153666a30a29SAmit Prakash Shukla * A pointer to memory filled with event adapter capabilities. 153766a30a29SAmit Prakash Shukla * It is expected to be pre-allocated & initialized by caller. 153866a30a29SAmit Prakash Shukla * 153966a30a29SAmit Prakash Shukla * @return 154066a30a29SAmit Prakash Shukla * - 0: Success, driver provides event adapter capabilities for the 154166a30a29SAmit Prakash Shukla * dmadev device. 154266a30a29SAmit Prakash Shukla * - <0: Error code returned by the driver function. 154366a30a29SAmit Prakash Shukla * 154466a30a29SAmit Prakash Shukla */ 154566a30a29SAmit Prakash Shukla __rte_experimental 154666a30a29SAmit Prakash Shukla int 154766a30a29SAmit Prakash Shukla rte_event_dma_adapter_caps_get(uint8_t dev_id, uint8_t dmadev_id, uint32_t *caps); 154866a30a29SAmit Prakash Shukla 154999a2dd95SBruce Richardson /* Ethdev Tx adapter capability bitmap flags */ 155099a2dd95SBruce Richardson #define RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT 0x1 155199a2dd95SBruce Richardson /**< This flag is sent when the PMD supports a packet transmit callback 155299a2dd95SBruce Richardson */ 155399a2dd95SBruce Richardson #define RTE_EVENT_ETH_TX_ADAPTER_CAP_EVENT_VECTOR 0x2 155499a2dd95SBruce Richardson /**< Indicates that the Tx adapter is capable of handling event vector of 155599a2dd95SBruce Richardson * mbufs. 155699a2dd95SBruce Richardson */ 155799a2dd95SBruce Richardson 155899a2dd95SBruce Richardson /** 155999a2dd95SBruce Richardson * Retrieve the event device's eth Tx adapter capabilities 156099a2dd95SBruce Richardson * 156199a2dd95SBruce Richardson * @param dev_id 156299a2dd95SBruce Richardson * The identifier of the device. 156399a2dd95SBruce Richardson * 156499a2dd95SBruce Richardson * @param eth_port_id 156599a2dd95SBruce Richardson * The identifier of the ethernet device. 156699a2dd95SBruce Richardson * 156799a2dd95SBruce Richardson * @param[out] caps 156899a2dd95SBruce Richardson * A pointer to memory filled with eth Tx adapter capabilities. 156999a2dd95SBruce Richardson * 157099a2dd95SBruce Richardson * @return 157199a2dd95SBruce Richardson * - 0: Success, driver provides eth Tx adapter capabilities. 157299a2dd95SBruce Richardson * - <0: Error code returned by the driver function. 157399a2dd95SBruce Richardson */ 157499a2dd95SBruce Richardson int 157599a2dd95SBruce Richardson rte_event_eth_tx_adapter_caps_get(uint8_t dev_id, uint16_t eth_port_id, 157699a2dd95SBruce Richardson uint32_t *caps); 157799a2dd95SBruce Richardson 157899a2dd95SBruce Richardson /** 157999a2dd95SBruce Richardson * Converts nanoseconds to *timeout_ticks* value for rte_event_dequeue_burst() 158099a2dd95SBruce Richardson * 158199a2dd95SBruce Richardson * If the device is configured with RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT flag 158299a2dd95SBruce Richardson * then application can use this function to convert timeout value in 158399a2dd95SBruce Richardson * nanoseconds to implementations specific timeout value supplied in 158499a2dd95SBruce Richardson * rte_event_dequeue_burst() 158599a2dd95SBruce Richardson * 158699a2dd95SBruce Richardson * @param dev_id 158799a2dd95SBruce Richardson * The identifier of the device. 158899a2dd95SBruce Richardson * @param ns 158999a2dd95SBruce Richardson * Wait time in nanosecond 159099a2dd95SBruce Richardson * @param[out] timeout_ticks 159199a2dd95SBruce Richardson * Value for the *timeout_ticks* parameter in rte_event_dequeue_burst() 159299a2dd95SBruce Richardson * 159399a2dd95SBruce Richardson * @return 159499a2dd95SBruce Richardson * - 0 on success. 159599a2dd95SBruce Richardson * - -ENOTSUP if the device doesn't support timeouts 159699a2dd95SBruce Richardson * - -EINVAL if *dev_id* is invalid or *timeout_ticks* is NULL 159799a2dd95SBruce Richardson * - other values < 0 on failure. 159899a2dd95SBruce Richardson * 159999a2dd95SBruce Richardson * @see rte_event_dequeue_burst(), RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT 160099a2dd95SBruce Richardson * @see rte_event_dev_configure() 160199a2dd95SBruce Richardson */ 160299a2dd95SBruce Richardson int 160399a2dd95SBruce Richardson rte_event_dequeue_timeout_ticks(uint8_t dev_id, uint64_t ns, 160499a2dd95SBruce Richardson uint64_t *timeout_ticks); 160599a2dd95SBruce Richardson 160699a2dd95SBruce Richardson /** 160799a2dd95SBruce Richardson * Link multiple source event queues supplied in *queues* to the destination 160899a2dd95SBruce Richardson * event port designated by its *port_id* with associated service priority 160999a2dd95SBruce Richardson * supplied in *priorities* on the event device designated by its *dev_id*. 161099a2dd95SBruce Richardson * 161199a2dd95SBruce Richardson * The link establishment shall enable the event port *port_id* from 161299a2dd95SBruce Richardson * receiving events from the specified event queue(s) supplied in *queues* 161399a2dd95SBruce Richardson * 161499a2dd95SBruce Richardson * An event queue may link to one or more event ports. 161599a2dd95SBruce Richardson * The number of links can be established from an event queue to event port is 161699a2dd95SBruce Richardson * implementation defined. 161799a2dd95SBruce Richardson * 161899a2dd95SBruce Richardson * Event queue(s) to event port link establishment can be changed at runtime 161999a2dd95SBruce Richardson * without re-configuring the device to support scaling and to reduce the 162099a2dd95SBruce Richardson * latency of critical work by establishing the link with more event ports 162199a2dd95SBruce Richardson * at runtime. 162299a2dd95SBruce Richardson * 1623d007a7f3SPavan Nikhilesh * When the value of ``rte_event_dev_info::max_profiles_per_port`` is greater 1624d007a7f3SPavan Nikhilesh * than or equal to one, this function links the event queues to the default 1625d007a7f3SPavan Nikhilesh * profile_id i.e. profile_id 0 of the event port. 1626d007a7f3SPavan Nikhilesh * 162799a2dd95SBruce Richardson * @param dev_id 162899a2dd95SBruce Richardson * The identifier of the device. 162999a2dd95SBruce Richardson * 163099a2dd95SBruce Richardson * @param port_id 163199a2dd95SBruce Richardson * Event port identifier to select the destination port to link. 163299a2dd95SBruce Richardson * 163399a2dd95SBruce Richardson * @param queues 163499a2dd95SBruce Richardson * Points to an array of *nb_links* event queues to be linked 163599a2dd95SBruce Richardson * to the event port. 163699a2dd95SBruce Richardson * NULL value is allowed, in which case this function links all the configured 163799a2dd95SBruce Richardson * event queues *nb_event_queues* which previously supplied to 163899a2dd95SBruce Richardson * rte_event_dev_configure() to the event port *port_id* 163999a2dd95SBruce Richardson * 164099a2dd95SBruce Richardson * @param priorities 164199a2dd95SBruce Richardson * Points to an array of *nb_links* service priorities associated with each 164299a2dd95SBruce Richardson * event queue link to event port. 164399a2dd95SBruce Richardson * The priority defines the event port's servicing priority for 164499a2dd95SBruce Richardson * event queue, which may be ignored by an implementation. 164599a2dd95SBruce Richardson * The requested priority should in the range of 164699a2dd95SBruce Richardson * [RTE_EVENT_DEV_PRIORITY_HIGHEST, RTE_EVENT_DEV_PRIORITY_LOWEST]. 164799a2dd95SBruce Richardson * The implementation shall normalize the requested priority to 164899a2dd95SBruce Richardson * implementation supported priority value. 164999a2dd95SBruce Richardson * NULL value is allowed, in which case this function links the event queues 165099a2dd95SBruce Richardson * with RTE_EVENT_DEV_PRIORITY_NORMAL servicing priority 165199a2dd95SBruce Richardson * 165299a2dd95SBruce Richardson * @param nb_links 165399a2dd95SBruce Richardson * The number of links to establish. This parameter is ignored if queues is 165499a2dd95SBruce Richardson * NULL. 165599a2dd95SBruce Richardson * 165699a2dd95SBruce Richardson * @return 165799a2dd95SBruce Richardson * The number of links actually established. The return value can be less than 165899a2dd95SBruce Richardson * the value of the *nb_links* parameter when the implementation has the 165999a2dd95SBruce Richardson * limitation on specific queue to port link establishment or if invalid 166099a2dd95SBruce Richardson * parameters are specified in *queues* 166199a2dd95SBruce Richardson * If the return value is less than *nb_links*, the remaining links at the end 166299a2dd95SBruce Richardson * of link[] are not established, and the caller has to take care of them. 166399a2dd95SBruce Richardson * If return value is less than *nb_links* then implementation shall update the 166499a2dd95SBruce Richardson * rte_errno accordingly, Possible rte_errno values are 166599a2dd95SBruce Richardson * (EDQUOT) Quota exceeded(Application tried to link the queue configured with 166699a2dd95SBruce Richardson * RTE_EVENT_QUEUE_CFG_SINGLE_LINK to more than one event ports) 166799a2dd95SBruce Richardson * (EINVAL) Invalid parameter 166899a2dd95SBruce Richardson */ 166999a2dd95SBruce Richardson int 167099a2dd95SBruce Richardson rte_event_port_link(uint8_t dev_id, uint8_t port_id, 167199a2dd95SBruce Richardson const uint8_t queues[], const uint8_t priorities[], 167299a2dd95SBruce Richardson uint16_t nb_links); 167399a2dd95SBruce Richardson 167499a2dd95SBruce Richardson /** 167599a2dd95SBruce Richardson * Unlink multiple source event queues supplied in *queues* from the destination 167699a2dd95SBruce Richardson * event port designated by its *port_id* on the event device designated 167799a2dd95SBruce Richardson * by its *dev_id*. 167899a2dd95SBruce Richardson * 167999a2dd95SBruce Richardson * The unlink call issues an async request to disable the event port *port_id* 168099a2dd95SBruce Richardson * from receiving events from the specified event queue *queue_id*. 168199a2dd95SBruce Richardson * Event queue(s) to event port unlink establishment can be changed at runtime 168299a2dd95SBruce Richardson * without re-configuring the device. 168399a2dd95SBruce Richardson * 1684d007a7f3SPavan Nikhilesh * When the value of ``rte_event_dev_info::max_profiles_per_port`` is greater 1685d007a7f3SPavan Nikhilesh * than or equal to one, this function unlinks the event queues from the default 1686d007a7f3SPavan Nikhilesh * profile identifier i.e. profile 0 of the event port. 1687d007a7f3SPavan Nikhilesh * 168899a2dd95SBruce Richardson * @see rte_event_port_unlinks_in_progress() to poll for completed unlinks. 168999a2dd95SBruce Richardson * 169099a2dd95SBruce Richardson * @param dev_id 169199a2dd95SBruce Richardson * The identifier of the device. 169299a2dd95SBruce Richardson * 169399a2dd95SBruce Richardson * @param port_id 169499a2dd95SBruce Richardson * Event port identifier to select the destination port to unlink. 169599a2dd95SBruce Richardson * 169699a2dd95SBruce Richardson * @param queues 169799a2dd95SBruce Richardson * Points to an array of *nb_unlinks* event queues to be unlinked 169899a2dd95SBruce Richardson * from the event port. 169999a2dd95SBruce Richardson * NULL value is allowed, in which case this function unlinks all the 170099a2dd95SBruce Richardson * event queue(s) from the event port *port_id*. 170199a2dd95SBruce Richardson * 170299a2dd95SBruce Richardson * @param nb_unlinks 170399a2dd95SBruce Richardson * The number of unlinks to establish. This parameter is ignored if queues is 170499a2dd95SBruce Richardson * NULL. 170599a2dd95SBruce Richardson * 170699a2dd95SBruce Richardson * @return 170799a2dd95SBruce Richardson * The number of unlinks successfully requested. The return value can be less 170899a2dd95SBruce Richardson * than the value of the *nb_unlinks* parameter when the implementation has the 170999a2dd95SBruce Richardson * limitation on specific queue to port unlink establishment or 171099a2dd95SBruce Richardson * if invalid parameters are specified. 171199a2dd95SBruce Richardson * If the return value is less than *nb_unlinks*, the remaining queues at the 171299a2dd95SBruce Richardson * end of queues[] are not unlinked, and the caller has to take care of them. 171399a2dd95SBruce Richardson * If return value is less than *nb_unlinks* then implementation shall update 171499a2dd95SBruce Richardson * the rte_errno accordingly, Possible rte_errno values are 171599a2dd95SBruce Richardson * (EINVAL) Invalid parameter 171699a2dd95SBruce Richardson */ 171799a2dd95SBruce Richardson int 171899a2dd95SBruce Richardson rte_event_port_unlink(uint8_t dev_id, uint8_t port_id, 171999a2dd95SBruce Richardson uint8_t queues[], uint16_t nb_unlinks); 172099a2dd95SBruce Richardson 172199a2dd95SBruce Richardson /** 1722d007a7f3SPavan Nikhilesh * Link multiple source event queues supplied in *queues* to the destination 1723d007a7f3SPavan Nikhilesh * event port designated by its *port_id* with associated profile identifier 1724d007a7f3SPavan Nikhilesh * supplied in *profile_id* with service priorities supplied in *priorities* 1725d007a7f3SPavan Nikhilesh * on the event device designated by its *dev_id*. 1726d007a7f3SPavan Nikhilesh * 1727d007a7f3SPavan Nikhilesh * If *profile_id* is set to 0 then, the links created by the call `rte_event_port_link` 1728d007a7f3SPavan Nikhilesh * will be overwritten. 1729d007a7f3SPavan Nikhilesh * 1730d007a7f3SPavan Nikhilesh * Event ports by default use profile_id 0 unless it is changed using the 1731d007a7f3SPavan Nikhilesh * call ``rte_event_port_profile_switch()``. 1732d007a7f3SPavan Nikhilesh * 1733d007a7f3SPavan Nikhilesh * The link establishment shall enable the event port *port_id* from 1734d007a7f3SPavan Nikhilesh * receiving events from the specified event queue(s) supplied in *queues* 1735d007a7f3SPavan Nikhilesh * 1736d007a7f3SPavan Nikhilesh * An event queue may link to one or more event ports. 1737d007a7f3SPavan Nikhilesh * The number of links can be established from an event queue to event port is 1738d007a7f3SPavan Nikhilesh * implementation defined. 1739d007a7f3SPavan Nikhilesh * 1740d007a7f3SPavan Nikhilesh * Event queue(s) to event port link establishment can be changed at runtime 1741d007a7f3SPavan Nikhilesh * without re-configuring the device to support scaling and to reduce the 1742d007a7f3SPavan Nikhilesh * latency of critical work by establishing the link with more event ports 1743d007a7f3SPavan Nikhilesh * at runtime. 1744d007a7f3SPavan Nikhilesh * 1745d007a7f3SPavan Nikhilesh * @param dev_id 1746d007a7f3SPavan Nikhilesh * The identifier of the device. 1747d007a7f3SPavan Nikhilesh * 1748d007a7f3SPavan Nikhilesh * @param port_id 1749d007a7f3SPavan Nikhilesh * Event port identifier to select the destination port to link. 1750d007a7f3SPavan Nikhilesh * 1751d007a7f3SPavan Nikhilesh * @param queues 1752d007a7f3SPavan Nikhilesh * Points to an array of *nb_links* event queues to be linked 1753d007a7f3SPavan Nikhilesh * to the event port. 1754d007a7f3SPavan Nikhilesh * NULL value is allowed, in which case this function links all the configured 1755d007a7f3SPavan Nikhilesh * event queues *nb_event_queues* which previously supplied to 1756d007a7f3SPavan Nikhilesh * rte_event_dev_configure() to the event port *port_id* 1757d007a7f3SPavan Nikhilesh * 1758d007a7f3SPavan Nikhilesh * @param priorities 1759d007a7f3SPavan Nikhilesh * Points to an array of *nb_links* service priorities associated with each 1760d007a7f3SPavan Nikhilesh * event queue link to event port. 1761d007a7f3SPavan Nikhilesh * The priority defines the event port's servicing priority for 1762d007a7f3SPavan Nikhilesh * event queue, which may be ignored by an implementation. 1763d007a7f3SPavan Nikhilesh * The requested priority should in the range of 1764d007a7f3SPavan Nikhilesh * [RTE_EVENT_DEV_PRIORITY_HIGHEST, RTE_EVENT_DEV_PRIORITY_LOWEST]. 1765d007a7f3SPavan Nikhilesh * The implementation shall normalize the requested priority to 1766d007a7f3SPavan Nikhilesh * implementation supported priority value. 1767d007a7f3SPavan Nikhilesh * NULL value is allowed, in which case this function links the event queues 1768d007a7f3SPavan Nikhilesh * with RTE_EVENT_DEV_PRIORITY_NORMAL servicing priority 1769d007a7f3SPavan Nikhilesh * 1770d007a7f3SPavan Nikhilesh * @param nb_links 1771d007a7f3SPavan Nikhilesh * The number of links to establish. This parameter is ignored if queues is 1772d007a7f3SPavan Nikhilesh * NULL. 1773d007a7f3SPavan Nikhilesh * 1774d007a7f3SPavan Nikhilesh * @param profile_id 1775d007a7f3SPavan Nikhilesh * The profile identifier associated with the links between event queues and 1776d007a7f3SPavan Nikhilesh * event port. Should be less than the max capability reported by 1777d007a7f3SPavan Nikhilesh * ``rte_event_dev_info::max_profiles_per_port`` 1778d007a7f3SPavan Nikhilesh * 1779d007a7f3SPavan Nikhilesh * @return 1780d007a7f3SPavan Nikhilesh * The number of links actually established. The return value can be less than 1781d007a7f3SPavan Nikhilesh * the value of the *nb_links* parameter when the implementation has the 1782d007a7f3SPavan Nikhilesh * limitation on specific queue to port link establishment or if invalid 1783d007a7f3SPavan Nikhilesh * parameters are specified in *queues* 1784d007a7f3SPavan Nikhilesh * If the return value is less than *nb_links*, the remaining links at the end 1785d007a7f3SPavan Nikhilesh * of link[] are not established, and the caller has to take care of them. 1786d007a7f3SPavan Nikhilesh * If return value is less than *nb_links* then implementation shall update the 1787d007a7f3SPavan Nikhilesh * rte_errno accordingly, Possible rte_errno values are 1788d007a7f3SPavan Nikhilesh * (EDQUOT) Quota exceeded(Application tried to link the queue configured with 1789d007a7f3SPavan Nikhilesh * RTE_EVENT_QUEUE_CFG_SINGLE_LINK to more than one event ports) 1790d007a7f3SPavan Nikhilesh * (EINVAL) Invalid parameter 1791d007a7f3SPavan Nikhilesh * 1792d007a7f3SPavan Nikhilesh */ 1793d007a7f3SPavan Nikhilesh __rte_experimental 1794d007a7f3SPavan Nikhilesh int 1795d007a7f3SPavan Nikhilesh rte_event_port_profile_links_set(uint8_t dev_id, uint8_t port_id, const uint8_t queues[], 1796d007a7f3SPavan Nikhilesh const uint8_t priorities[], uint16_t nb_links, uint8_t profile_id); 1797d007a7f3SPavan Nikhilesh 1798d007a7f3SPavan Nikhilesh /** 1799d007a7f3SPavan Nikhilesh * Unlink multiple source event queues supplied in *queues* that belong to profile 1800d007a7f3SPavan Nikhilesh * designated by *profile_id* from the destination event port designated by its 1801d007a7f3SPavan Nikhilesh * *port_id* on the event device designated by its *dev_id*. 1802d007a7f3SPavan Nikhilesh * 1803d007a7f3SPavan Nikhilesh * If *profile_id* is set to 0 i.e., the default profile then, then this function 1804d007a7f3SPavan Nikhilesh * will act as ``rte_event_port_unlink``. 1805d007a7f3SPavan Nikhilesh * 1806d007a7f3SPavan Nikhilesh * The unlink call issues an async request to disable the event port *port_id* 1807d007a7f3SPavan Nikhilesh * from receiving events from the specified event queue *queue_id*. 1808d007a7f3SPavan Nikhilesh * Event queue(s) to event port unlink establishment can be changed at runtime 1809d007a7f3SPavan Nikhilesh * without re-configuring the device. 1810d007a7f3SPavan Nikhilesh * 1811d007a7f3SPavan Nikhilesh * @see rte_event_port_unlinks_in_progress() to poll for completed unlinks. 1812d007a7f3SPavan Nikhilesh * 1813d007a7f3SPavan Nikhilesh * @param dev_id 1814d007a7f3SPavan Nikhilesh * The identifier of the device. 1815d007a7f3SPavan Nikhilesh * 1816d007a7f3SPavan Nikhilesh * @param port_id 1817d007a7f3SPavan Nikhilesh * Event port identifier to select the destination port to unlink. 1818d007a7f3SPavan Nikhilesh * 1819d007a7f3SPavan Nikhilesh * @param queues 1820d007a7f3SPavan Nikhilesh * Points to an array of *nb_unlinks* event queues to be unlinked 1821d007a7f3SPavan Nikhilesh * from the event port. 1822d007a7f3SPavan Nikhilesh * NULL value is allowed, in which case this function unlinks all the 1823d007a7f3SPavan Nikhilesh * event queue(s) from the event port *port_id*. 1824d007a7f3SPavan Nikhilesh * 1825d007a7f3SPavan Nikhilesh * @param nb_unlinks 1826d007a7f3SPavan Nikhilesh * The number of unlinks to establish. This parameter is ignored if queues is 1827d007a7f3SPavan Nikhilesh * NULL. 1828d007a7f3SPavan Nikhilesh * 1829d007a7f3SPavan Nikhilesh * @param profile_id 1830d007a7f3SPavan Nikhilesh * The profile identifier associated with the links between event queues and 1831d007a7f3SPavan Nikhilesh * event port. Should be less than the max capability reported by 1832d007a7f3SPavan Nikhilesh * ``rte_event_dev_info::max_profiles_per_port`` 1833d007a7f3SPavan Nikhilesh * 1834d007a7f3SPavan Nikhilesh * @return 1835d007a7f3SPavan Nikhilesh * The number of unlinks successfully requested. The return value can be less 1836d007a7f3SPavan Nikhilesh * than the value of the *nb_unlinks* parameter when the implementation has the 1837d007a7f3SPavan Nikhilesh * limitation on specific queue to port unlink establishment or 1838d007a7f3SPavan Nikhilesh * if invalid parameters are specified. 1839d007a7f3SPavan Nikhilesh * If the return value is less than *nb_unlinks*, the remaining queues at the 1840d007a7f3SPavan Nikhilesh * end of queues[] are not unlinked, and the caller has to take care of them. 1841d007a7f3SPavan Nikhilesh * If return value is less than *nb_unlinks* then implementation shall update 1842d007a7f3SPavan Nikhilesh * the rte_errno accordingly, Possible rte_errno values are 1843d007a7f3SPavan Nikhilesh * (EINVAL) Invalid parameter 1844d007a7f3SPavan Nikhilesh * 1845d007a7f3SPavan Nikhilesh */ 1846d007a7f3SPavan Nikhilesh __rte_experimental 1847d007a7f3SPavan Nikhilesh int 1848d007a7f3SPavan Nikhilesh rte_event_port_profile_unlink(uint8_t dev_id, uint8_t port_id, uint8_t queues[], 1849d007a7f3SPavan Nikhilesh uint16_t nb_unlinks, uint8_t profile_id); 1850d007a7f3SPavan Nikhilesh 1851d007a7f3SPavan Nikhilesh /** 185299a2dd95SBruce Richardson * Returns the number of unlinks in progress. 185399a2dd95SBruce Richardson * 185499a2dd95SBruce Richardson * This function provides the application with a method to detect when an 185599a2dd95SBruce Richardson * unlink has been completed by the implementation. 185699a2dd95SBruce Richardson * 185799a2dd95SBruce Richardson * @see rte_event_port_unlink() to issue unlink requests. 185899a2dd95SBruce Richardson * 185999a2dd95SBruce Richardson * @param dev_id 186099a2dd95SBruce Richardson * The identifier of the device. 186199a2dd95SBruce Richardson * 186299a2dd95SBruce Richardson * @param port_id 186399a2dd95SBruce Richardson * Event port identifier to select port to check for unlinks in progress. 186499a2dd95SBruce Richardson * 186599a2dd95SBruce Richardson * @return 186699a2dd95SBruce Richardson * The number of unlinks that are in progress. A return of zero indicates that 186799a2dd95SBruce Richardson * there are no outstanding unlink requests. A positive return value indicates 186899a2dd95SBruce Richardson * the number of unlinks that are in progress, but are not yet complete. 186999a2dd95SBruce Richardson * A negative return value indicates an error, -EINVAL indicates an invalid 187099a2dd95SBruce Richardson * parameter passed for *dev_id* or *port_id*. 187199a2dd95SBruce Richardson */ 187299a2dd95SBruce Richardson int 187399a2dd95SBruce Richardson rte_event_port_unlinks_in_progress(uint8_t dev_id, uint8_t port_id); 187499a2dd95SBruce Richardson 187599a2dd95SBruce Richardson /** 187699a2dd95SBruce Richardson * Retrieve the list of source event queues and its associated service priority 187799a2dd95SBruce Richardson * linked to the destination event port designated by its *port_id* 187899a2dd95SBruce Richardson * on the event device designated by its *dev_id*. 187999a2dd95SBruce Richardson * 188099a2dd95SBruce Richardson * @param dev_id 188199a2dd95SBruce Richardson * The identifier of the device. 188299a2dd95SBruce Richardson * 188399a2dd95SBruce Richardson * @param port_id 188499a2dd95SBruce Richardson * Event port identifier. 188599a2dd95SBruce Richardson * 188699a2dd95SBruce Richardson * @param[out] queues 188799a2dd95SBruce Richardson * Points to an array of *queues* for output. 188899a2dd95SBruce Richardson * The caller has to allocate *RTE_EVENT_MAX_QUEUES_PER_DEV* bytes to 188999a2dd95SBruce Richardson * store the event queue(s) linked with event port *port_id* 189099a2dd95SBruce Richardson * 189199a2dd95SBruce Richardson * @param[out] priorities 189299a2dd95SBruce Richardson * Points to an array of *priorities* for output. 189399a2dd95SBruce Richardson * The caller has to allocate *RTE_EVENT_MAX_QUEUES_PER_DEV* bytes to 189499a2dd95SBruce Richardson * store the service priority associated with each event queue linked 189599a2dd95SBruce Richardson * 189699a2dd95SBruce Richardson * @return 189799a2dd95SBruce Richardson * The number of links established on the event port designated by its 189899a2dd95SBruce Richardson * *port_id*. 189999a2dd95SBruce Richardson * - <0 on failure. 190099a2dd95SBruce Richardson */ 190199a2dd95SBruce Richardson int 190299a2dd95SBruce Richardson rte_event_port_links_get(uint8_t dev_id, uint8_t port_id, 190399a2dd95SBruce Richardson uint8_t queues[], uint8_t priorities[]); 190499a2dd95SBruce Richardson 190599a2dd95SBruce Richardson /** 1906d007a7f3SPavan Nikhilesh * Retrieve the list of source event queues and its service priority 1907d007a7f3SPavan Nikhilesh * associated to a *profile_id* and linked to the destination event port 1908d007a7f3SPavan Nikhilesh * designated by its *port_id* on the event device designated by its *dev_id*. 1909d007a7f3SPavan Nikhilesh * 1910d007a7f3SPavan Nikhilesh * @param dev_id 1911d007a7f3SPavan Nikhilesh * The identifier of the device. 1912d007a7f3SPavan Nikhilesh * 1913d007a7f3SPavan Nikhilesh * @param port_id 1914d007a7f3SPavan Nikhilesh * Event port identifier. 1915d007a7f3SPavan Nikhilesh * 1916d007a7f3SPavan Nikhilesh * @param[out] queues 1917d007a7f3SPavan Nikhilesh * Points to an array of *queues* for output. 1918d007a7f3SPavan Nikhilesh * The caller has to allocate *RTE_EVENT_MAX_QUEUES_PER_DEV* bytes to 1919d007a7f3SPavan Nikhilesh * store the event queue(s) linked with event port *port_id* 1920d007a7f3SPavan Nikhilesh * 1921d007a7f3SPavan Nikhilesh * @param[out] priorities 1922d007a7f3SPavan Nikhilesh * Points to an array of *priorities* for output. 1923d007a7f3SPavan Nikhilesh * The caller has to allocate *RTE_EVENT_MAX_QUEUES_PER_DEV* bytes to 1924d007a7f3SPavan Nikhilesh * store the service priority associated with each event queue linked 1925d007a7f3SPavan Nikhilesh * 1926d007a7f3SPavan Nikhilesh * @param profile_id 1927d007a7f3SPavan Nikhilesh * The profile identifier associated with the links between event queues and 1928d007a7f3SPavan Nikhilesh * event port. Should be less than the max capability reported by 1929d007a7f3SPavan Nikhilesh * ``rte_event_dev_info::max_profiles_per_port`` 1930d007a7f3SPavan Nikhilesh * 1931d007a7f3SPavan Nikhilesh * @return 1932d007a7f3SPavan Nikhilesh * The number of links established on the event port designated by its 1933d007a7f3SPavan Nikhilesh * *port_id*. 1934d007a7f3SPavan Nikhilesh * - <0 on failure. 1935d007a7f3SPavan Nikhilesh */ 1936d007a7f3SPavan Nikhilesh __rte_experimental 1937d007a7f3SPavan Nikhilesh int 1938d007a7f3SPavan Nikhilesh rte_event_port_profile_links_get(uint8_t dev_id, uint8_t port_id, uint8_t queues[], 1939d007a7f3SPavan Nikhilesh uint8_t priorities[], uint8_t profile_id); 1940d007a7f3SPavan Nikhilesh 1941d007a7f3SPavan Nikhilesh /** 194299a2dd95SBruce Richardson * Retrieve the service ID of the event dev. If the adapter doesn't use 194399a2dd95SBruce Richardson * a rte_service function, this function returns -ESRCH. 194499a2dd95SBruce Richardson * 194599a2dd95SBruce Richardson * @param dev_id 194699a2dd95SBruce Richardson * The identifier of the device. 194799a2dd95SBruce Richardson * 194899a2dd95SBruce Richardson * @param [out] service_id 194999a2dd95SBruce Richardson * A pointer to a uint32_t, to be filled in with the service id. 195099a2dd95SBruce Richardson * 195199a2dd95SBruce Richardson * @return 195299a2dd95SBruce Richardson * - 0: Success 195399a2dd95SBruce Richardson * - <0: Error code on failure, if the event dev doesn't use a rte_service 195499a2dd95SBruce Richardson * function, this function returns -ESRCH. 195599a2dd95SBruce Richardson */ 195699a2dd95SBruce Richardson int 195799a2dd95SBruce Richardson rte_event_dev_service_id_get(uint8_t dev_id, uint32_t *service_id); 195899a2dd95SBruce Richardson 195999a2dd95SBruce Richardson /** 196099a2dd95SBruce Richardson * Dump internal information about *dev_id* to the FILE* provided in *f*. 196199a2dd95SBruce Richardson * 196299a2dd95SBruce Richardson * @param dev_id 196399a2dd95SBruce Richardson * The identifier of the device. 196499a2dd95SBruce Richardson * 196599a2dd95SBruce Richardson * @param f 196699a2dd95SBruce Richardson * A pointer to a file for output 196799a2dd95SBruce Richardson * 196899a2dd95SBruce Richardson * @return 196999a2dd95SBruce Richardson * - 0: on success 197099a2dd95SBruce Richardson * - <0: on failure. 197199a2dd95SBruce Richardson */ 197299a2dd95SBruce Richardson int 197399a2dd95SBruce Richardson rte_event_dev_dump(uint8_t dev_id, FILE *f); 197499a2dd95SBruce Richardson 197599a2dd95SBruce Richardson /** Maximum name length for extended statistics counters */ 197699a2dd95SBruce Richardson #define RTE_EVENT_DEV_XSTATS_NAME_SIZE 64 197799a2dd95SBruce Richardson 197899a2dd95SBruce Richardson /** 197999a2dd95SBruce Richardson * Selects the component of the eventdev to retrieve statistics from. 198099a2dd95SBruce Richardson */ 198199a2dd95SBruce Richardson enum rte_event_dev_xstats_mode { 198299a2dd95SBruce Richardson RTE_EVENT_DEV_XSTATS_DEVICE, 198399a2dd95SBruce Richardson RTE_EVENT_DEV_XSTATS_PORT, 198499a2dd95SBruce Richardson RTE_EVENT_DEV_XSTATS_QUEUE, 198599a2dd95SBruce Richardson }; 198699a2dd95SBruce Richardson 198799a2dd95SBruce Richardson /** 198899a2dd95SBruce Richardson * A name-key lookup element for extended statistics. 198999a2dd95SBruce Richardson * 199099a2dd95SBruce Richardson * This structure is used to map between names and ID numbers 199199a2dd95SBruce Richardson * for extended ethdev statistics. 199299a2dd95SBruce Richardson */ 199399a2dd95SBruce Richardson struct rte_event_dev_xstats_name { 199499a2dd95SBruce Richardson char name[RTE_EVENT_DEV_XSTATS_NAME_SIZE]; 199599a2dd95SBruce Richardson }; 199699a2dd95SBruce Richardson 199799a2dd95SBruce Richardson /** 199899a2dd95SBruce Richardson * Retrieve names of extended statistics of an event device. 199999a2dd95SBruce Richardson * 200099a2dd95SBruce Richardson * @param dev_id 200199a2dd95SBruce Richardson * The identifier of the event device. 200299a2dd95SBruce Richardson * @param mode 200399a2dd95SBruce Richardson * The mode of statistics to retrieve. Choices include the device statistics, 200499a2dd95SBruce Richardson * port statistics or queue statistics. 200599a2dd95SBruce Richardson * @param queue_port_id 200699a2dd95SBruce Richardson * Used to specify the port or queue number in queue or port mode, and is 200799a2dd95SBruce Richardson * ignored in device mode. 200899a2dd95SBruce Richardson * @param[out] xstats_names 200999a2dd95SBruce Richardson * Block of memory to insert names into. Must be at least size in capacity. 201099a2dd95SBruce Richardson * If set to NULL, function returns required capacity. 201199a2dd95SBruce Richardson * @param[out] ids 201299a2dd95SBruce Richardson * Block of memory to insert ids into. Must be at least size in capacity. 201399a2dd95SBruce Richardson * If set to NULL, function returns required capacity. The id values returned 201499a2dd95SBruce Richardson * can be passed to *rte_event_dev_xstats_get* to select statistics. 201599a2dd95SBruce Richardson * @param size 201699a2dd95SBruce Richardson * Capacity of xstats_names (number of names). 201799a2dd95SBruce Richardson * @return 201899a2dd95SBruce Richardson * - positive value lower or equal to size: success. The return value 201999a2dd95SBruce Richardson * is the number of entries filled in the stats table. 202099a2dd95SBruce Richardson * - positive value higher than size: error, the given statistics table 202199a2dd95SBruce Richardson * is too small. The return value corresponds to the size that should 202299a2dd95SBruce Richardson * be given to succeed. The entries in the table are not valid and 202399a2dd95SBruce Richardson * shall not be used by the caller. 202499a2dd95SBruce Richardson * - negative value on error: 202599a2dd95SBruce Richardson * -ENODEV for invalid *dev_id* 202699a2dd95SBruce Richardson * -EINVAL for invalid mode, queue port or id parameters 202799a2dd95SBruce Richardson * -ENOTSUP if the device doesn't support this function. 202899a2dd95SBruce Richardson */ 202999a2dd95SBruce Richardson int 203099a2dd95SBruce Richardson rte_event_dev_xstats_names_get(uint8_t dev_id, 203199a2dd95SBruce Richardson enum rte_event_dev_xstats_mode mode, 203299a2dd95SBruce Richardson uint8_t queue_port_id, 203399a2dd95SBruce Richardson struct rte_event_dev_xstats_name *xstats_names, 20341bdfe4d7SPavan Nikhilesh uint64_t *ids, 203599a2dd95SBruce Richardson unsigned int size); 203699a2dd95SBruce Richardson 203799a2dd95SBruce Richardson /** 203899a2dd95SBruce Richardson * Retrieve extended statistics of an event device. 203999a2dd95SBruce Richardson * 204099a2dd95SBruce Richardson * @param dev_id 204199a2dd95SBruce Richardson * The identifier of the device. 204299a2dd95SBruce Richardson * @param mode 204399a2dd95SBruce Richardson * The mode of statistics to retrieve. Choices include the device statistics, 204499a2dd95SBruce Richardson * port statistics or queue statistics. 204599a2dd95SBruce Richardson * @param queue_port_id 204699a2dd95SBruce Richardson * Used to specify the port or queue number in queue or port mode, and is 204799a2dd95SBruce Richardson * ignored in device mode. 204899a2dd95SBruce Richardson * @param ids 204999a2dd95SBruce Richardson * The id numbers of the stats to get. The ids can be got from the stat 205099a2dd95SBruce Richardson * position in the stat list from rte_event_dev_get_xstats_names(), or 205199a2dd95SBruce Richardson * by using rte_event_dev_xstats_by_name_get(). 205299a2dd95SBruce Richardson * @param[out] values 205399a2dd95SBruce Richardson * The values for each stats request by ID. 205499a2dd95SBruce Richardson * @param n 205599a2dd95SBruce Richardson * The number of stats requested 205699a2dd95SBruce Richardson * @return 205799a2dd95SBruce Richardson * - positive value: number of stat entries filled into the values array 205899a2dd95SBruce Richardson * - negative value on error: 205999a2dd95SBruce Richardson * -ENODEV for invalid *dev_id* 206099a2dd95SBruce Richardson * -EINVAL for invalid mode, queue port or id parameters 206199a2dd95SBruce Richardson * -ENOTSUP if the device doesn't support this function. 206299a2dd95SBruce Richardson */ 206399a2dd95SBruce Richardson int 206499a2dd95SBruce Richardson rte_event_dev_xstats_get(uint8_t dev_id, 206599a2dd95SBruce Richardson enum rte_event_dev_xstats_mode mode, 206699a2dd95SBruce Richardson uint8_t queue_port_id, 20671bdfe4d7SPavan Nikhilesh const uint64_t ids[], 206899a2dd95SBruce Richardson uint64_t values[], unsigned int n); 206999a2dd95SBruce Richardson 207099a2dd95SBruce Richardson /** 207199a2dd95SBruce Richardson * Retrieve the value of a single stat by requesting it by name. 207299a2dd95SBruce Richardson * 207399a2dd95SBruce Richardson * @param dev_id 207499a2dd95SBruce Richardson * The identifier of the device 207599a2dd95SBruce Richardson * @param name 207699a2dd95SBruce Richardson * The stat name to retrieve 207799a2dd95SBruce Richardson * @param[out] id 207899a2dd95SBruce Richardson * If non-NULL, the numerical id of the stat will be returned, so that further 207999a2dd95SBruce Richardson * requests for the stat can be got using rte_event_dev_xstats_get, which will 208099a2dd95SBruce Richardson * be faster as it doesn't need to scan a list of names for the stat. 208199a2dd95SBruce Richardson * If the stat cannot be found, the id returned will be (unsigned)-1. 208299a2dd95SBruce Richardson * @return 208399a2dd95SBruce Richardson * - positive value or zero: the stat value 208499a2dd95SBruce Richardson * - negative value: -EINVAL if stat not found, -ENOTSUP if not supported. 208599a2dd95SBruce Richardson */ 208699a2dd95SBruce Richardson uint64_t 208799a2dd95SBruce Richardson rte_event_dev_xstats_by_name_get(uint8_t dev_id, const char *name, 20881bdfe4d7SPavan Nikhilesh uint64_t *id); 208999a2dd95SBruce Richardson 209099a2dd95SBruce Richardson /** 209199a2dd95SBruce Richardson * Reset the values of the xstats of the selected component in the device. 209299a2dd95SBruce Richardson * 209399a2dd95SBruce Richardson * @param dev_id 209499a2dd95SBruce Richardson * The identifier of the device 209599a2dd95SBruce Richardson * @param mode 209699a2dd95SBruce Richardson * The mode of the statistics to reset. Choose from device, queue or port. 209799a2dd95SBruce Richardson * @param queue_port_id 209899a2dd95SBruce Richardson * The queue or port to reset. 0 and positive values select ports and queues, 209999a2dd95SBruce Richardson * while -1 indicates all ports or queues. 210099a2dd95SBruce Richardson * @param ids 210199a2dd95SBruce Richardson * Selects specific statistics to be reset. When NULL, all statistics selected 210299a2dd95SBruce Richardson * by *mode* will be reset. If non-NULL, must point to array of at least 210399a2dd95SBruce Richardson * *nb_ids* size. 210499a2dd95SBruce Richardson * @param nb_ids 210599a2dd95SBruce Richardson * The number of ids available from the *ids* array. Ignored when ids is NULL. 210699a2dd95SBruce Richardson * @return 210799a2dd95SBruce Richardson * - zero: successfully reset the statistics to zero 210899a2dd95SBruce Richardson * - negative value: -EINVAL invalid parameters, -ENOTSUP if not supported. 210999a2dd95SBruce Richardson */ 211099a2dd95SBruce Richardson int 211199a2dd95SBruce Richardson rte_event_dev_xstats_reset(uint8_t dev_id, 211299a2dd95SBruce Richardson enum rte_event_dev_xstats_mode mode, 211399a2dd95SBruce Richardson int16_t queue_port_id, 21141bdfe4d7SPavan Nikhilesh const uint64_t ids[], 211599a2dd95SBruce Richardson uint32_t nb_ids); 211699a2dd95SBruce Richardson 211799a2dd95SBruce Richardson /** 211899a2dd95SBruce Richardson * Trigger the eventdev self test. 211999a2dd95SBruce Richardson * 212099a2dd95SBruce Richardson * @param dev_id 212199a2dd95SBruce Richardson * The identifier of the device 212299a2dd95SBruce Richardson * @return 212399a2dd95SBruce Richardson * - 0: Selftest successful 212499a2dd95SBruce Richardson * - -ENOTSUP if the device doesn't support selftest 212599a2dd95SBruce Richardson * - other values < 0 on failure. 212699a2dd95SBruce Richardson */ 212799a2dd95SBruce Richardson int rte_event_dev_selftest(uint8_t dev_id); 212899a2dd95SBruce Richardson 212999a2dd95SBruce Richardson /** 213099a2dd95SBruce Richardson * Get the memory required per event vector based on the number of elements per 213199a2dd95SBruce Richardson * vector. 213299a2dd95SBruce Richardson * This should be used to create the mempool that holds the event vectors. 213399a2dd95SBruce Richardson * 213499a2dd95SBruce Richardson * @param name 213599a2dd95SBruce Richardson * The name of the vector pool. 213699a2dd95SBruce Richardson * @param n 213799a2dd95SBruce Richardson * The number of elements in the mbuf pool. 213899a2dd95SBruce Richardson * @param cache_size 213999a2dd95SBruce Richardson * Size of the per-core object cache. See rte_mempool_create() for 214099a2dd95SBruce Richardson * details. 214199a2dd95SBruce Richardson * @param nb_elem 214299a2dd95SBruce Richardson * The number of elements that a single event vector should be able to hold. 214399a2dd95SBruce Richardson * @param socket_id 214499a2dd95SBruce Richardson * The socket identifier where the memory should be allocated. The 214599a2dd95SBruce Richardson * value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the 214699a2dd95SBruce Richardson * reserved zone 214799a2dd95SBruce Richardson * 214899a2dd95SBruce Richardson * @return 214999a2dd95SBruce Richardson * The pointer to the newly allocated mempool, on success. NULL on error 215099a2dd95SBruce Richardson * with rte_errno set appropriately. Possible rte_errno values include: 215199a2dd95SBruce Richardson * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure 215299a2dd95SBruce Richardson * - E_RTE_SECONDARY - function was called from a secondary process instance 215399a2dd95SBruce Richardson * - EINVAL - cache size provided is too large, or priv_size is not aligned. 215499a2dd95SBruce Richardson * - ENOSPC - the maximum number of memzones has already been allocated 215599a2dd95SBruce Richardson * - EEXIST - a memzone with the same name already exists 215699a2dd95SBruce Richardson * - ENOMEM - no appropriate memory area found in which to create memzone 215799a2dd95SBruce Richardson * - ENAMETOOLONG - mempool name requested is too long. 215899a2dd95SBruce Richardson */ 215999a2dd95SBruce Richardson struct rte_mempool * 216099a2dd95SBruce Richardson rte_event_vector_pool_create(const char *name, unsigned int n, 216199a2dd95SBruce Richardson unsigned int cache_size, uint16_t nb_elem, 216299a2dd95SBruce Richardson int socket_id); 216399a2dd95SBruce Richardson 216426f14535SPavan Nikhilesh #include <rte_eventdev_core.h> 216526f14535SPavan Nikhilesh 216626f14535SPavan Nikhilesh static __rte_always_inline uint16_t 216726f14535SPavan Nikhilesh __rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id, 216826f14535SPavan Nikhilesh const struct rte_event ev[], uint16_t nb_events, 216926f14535SPavan Nikhilesh const event_enqueue_burst_t fn) 217026f14535SPavan Nikhilesh { 2171052e25d9SPavan Nikhilesh const struct rte_event_fp_ops *fp_ops; 2172052e25d9SPavan Nikhilesh void *port; 217326f14535SPavan Nikhilesh 2174052e25d9SPavan Nikhilesh fp_ops = &rte_event_fp_ops[dev_id]; 2175052e25d9SPavan Nikhilesh port = fp_ops->data[port_id]; 217626f14535SPavan Nikhilesh #ifdef RTE_LIBRTE_EVENTDEV_DEBUG 2177052e25d9SPavan Nikhilesh if (dev_id >= RTE_EVENT_MAX_DEVS || 2178052e25d9SPavan Nikhilesh port_id >= RTE_EVENT_MAX_PORTS_PER_DEV) { 217926f14535SPavan Nikhilesh rte_errno = EINVAL; 218026f14535SPavan Nikhilesh return 0; 218126f14535SPavan Nikhilesh } 218226f14535SPavan Nikhilesh 2183052e25d9SPavan Nikhilesh if (port == NULL) { 218426f14535SPavan Nikhilesh rte_errno = EINVAL; 218526f14535SPavan Nikhilesh return 0; 218626f14535SPavan Nikhilesh } 218726f14535SPavan Nikhilesh #endif 2188153e7d88SBruce Richardson rte_eventdev_trace_enq_burst(dev_id, port_id, ev, nb_events, (void *)fn); 218926f14535SPavan Nikhilesh /* 219026f14535SPavan Nikhilesh * Allow zero cost non burst mode routine invocation if application 219126f14535SPavan Nikhilesh * requests nb_events as const one 219226f14535SPavan Nikhilesh */ 219326f14535SPavan Nikhilesh if (nb_events == 1) 2194052e25d9SPavan Nikhilesh return (fp_ops->enqueue)(port, ev); 219526f14535SPavan Nikhilesh else 2196052e25d9SPavan Nikhilesh return fn(port, ev, nb_events); 219726f14535SPavan Nikhilesh } 219826f14535SPavan Nikhilesh 219926f14535SPavan Nikhilesh /** 220026f14535SPavan Nikhilesh * Enqueue a burst of events objects or an event object supplied in *rte_event* 220126f14535SPavan Nikhilesh * structure on an event device designated by its *dev_id* through the event 220226f14535SPavan Nikhilesh * port specified by *port_id*. Each event object specifies the event queue on 220326f14535SPavan Nikhilesh * which it will be enqueued. 220426f14535SPavan Nikhilesh * 220526f14535SPavan Nikhilesh * The *nb_events* parameter is the number of event objects to enqueue which are 220626f14535SPavan Nikhilesh * supplied in the *ev* array of *rte_event* structure. 220726f14535SPavan Nikhilesh * 220826f14535SPavan Nikhilesh * Event operations RTE_EVENT_OP_FORWARD and RTE_EVENT_OP_RELEASE must only be 220926f14535SPavan Nikhilesh * enqueued to the same port that their associated events were dequeued from. 221026f14535SPavan Nikhilesh * 221126f14535SPavan Nikhilesh * The rte_event_enqueue_burst() function returns the number of 221226f14535SPavan Nikhilesh * events objects it actually enqueued. A return value equal to *nb_events* 221326f14535SPavan Nikhilesh * means that all event objects have been enqueued. 221426f14535SPavan Nikhilesh * 221526f14535SPavan Nikhilesh * @param dev_id 221626f14535SPavan Nikhilesh * The identifier of the device. 221726f14535SPavan Nikhilesh * @param port_id 221826f14535SPavan Nikhilesh * The identifier of the event port. 221926f14535SPavan Nikhilesh * @param ev 222026f14535SPavan Nikhilesh * Points to an array of *nb_events* objects of type *rte_event* structure 222126f14535SPavan Nikhilesh * which contain the event object enqueue operations to be processed. 222226f14535SPavan Nikhilesh * @param nb_events 222326f14535SPavan Nikhilesh * The number of event objects to enqueue, typically number of 222426f14535SPavan Nikhilesh * rte_event_port_attr_get(...RTE_EVENT_PORT_ATTR_ENQ_DEPTH...) 222526f14535SPavan Nikhilesh * available for this port. 222626f14535SPavan Nikhilesh * 222726f14535SPavan Nikhilesh * @return 222826f14535SPavan Nikhilesh * The number of event objects actually enqueued on the event device. The 222926f14535SPavan Nikhilesh * return value can be less than the value of the *nb_events* parameter when 223026f14535SPavan Nikhilesh * the event devices queue is full or if invalid parameters are specified in a 223126f14535SPavan Nikhilesh * *rte_event*. If the return value is less than *nb_events*, the remaining 223226f14535SPavan Nikhilesh * events at the end of ev[] are not consumed and the caller has to take care 223326f14535SPavan Nikhilesh * of them, and rte_errno is set accordingly. Possible errno values include: 223426f14535SPavan Nikhilesh * - EINVAL The port ID is invalid, device ID is invalid, an event's queue 223526f14535SPavan Nikhilesh * ID is invalid, or an event's sched type doesn't match the 223626f14535SPavan Nikhilesh * capabilities of the destination queue. 223726f14535SPavan Nikhilesh * - ENOSPC The event port was backpressured and unable to enqueue 223826f14535SPavan Nikhilesh * one or more events. This error code is only applicable to 223926f14535SPavan Nikhilesh * closed systems. 224026f14535SPavan Nikhilesh * @see rte_event_port_attr_get(), RTE_EVENT_PORT_ATTR_ENQ_DEPTH 224126f14535SPavan Nikhilesh */ 224226f14535SPavan Nikhilesh static inline uint16_t 224326f14535SPavan Nikhilesh rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id, 224426f14535SPavan Nikhilesh const struct rte_event ev[], uint16_t nb_events) 224526f14535SPavan Nikhilesh { 2246052e25d9SPavan Nikhilesh const struct rte_event_fp_ops *fp_ops; 224726f14535SPavan Nikhilesh 2248052e25d9SPavan Nikhilesh fp_ops = &rte_event_fp_ops[dev_id]; 224926f14535SPavan Nikhilesh return __rte_event_enqueue_burst(dev_id, port_id, ev, nb_events, 2250052e25d9SPavan Nikhilesh fp_ops->enqueue_burst); 225126f14535SPavan Nikhilesh } 225226f14535SPavan Nikhilesh 225326f14535SPavan Nikhilesh /** 225426f14535SPavan Nikhilesh * Enqueue a burst of events objects of operation type *RTE_EVENT_OP_NEW* on 225526f14535SPavan Nikhilesh * an event device designated by its *dev_id* through the event port specified 225626f14535SPavan Nikhilesh * by *port_id*. 225726f14535SPavan Nikhilesh * 225826f14535SPavan Nikhilesh * Provides the same functionality as rte_event_enqueue_burst(), expect that 225926f14535SPavan Nikhilesh * application can use this API when the all objects in the burst contains 226026f14535SPavan Nikhilesh * the enqueue operation of the type *RTE_EVENT_OP_NEW*. This specialized 226126f14535SPavan Nikhilesh * function can provide the additional hint to the PMD and optimize if possible. 226226f14535SPavan Nikhilesh * 226326f14535SPavan Nikhilesh * The rte_event_enqueue_new_burst() result is undefined if the enqueue burst 226426f14535SPavan Nikhilesh * has event object of operation type != RTE_EVENT_OP_NEW. 226526f14535SPavan Nikhilesh * 226626f14535SPavan Nikhilesh * @param dev_id 226726f14535SPavan Nikhilesh * The identifier of the device. 226826f14535SPavan Nikhilesh * @param port_id 226926f14535SPavan Nikhilesh * The identifier of the event port. 227026f14535SPavan Nikhilesh * @param ev 227126f14535SPavan Nikhilesh * Points to an array of *nb_events* objects of type *rte_event* structure 227226f14535SPavan Nikhilesh * which contain the event object enqueue operations to be processed. 227326f14535SPavan Nikhilesh * @param nb_events 227426f14535SPavan Nikhilesh * The number of event objects to enqueue, typically number of 227526f14535SPavan Nikhilesh * rte_event_port_attr_get(...RTE_EVENT_PORT_ATTR_ENQ_DEPTH...) 227626f14535SPavan Nikhilesh * available for this port. 227726f14535SPavan Nikhilesh * 227826f14535SPavan Nikhilesh * @return 227926f14535SPavan Nikhilesh * The number of event objects actually enqueued on the event device. The 228026f14535SPavan Nikhilesh * return value can be less than the value of the *nb_events* parameter when 228126f14535SPavan Nikhilesh * the event devices queue is full or if invalid parameters are specified in a 228226f14535SPavan Nikhilesh * *rte_event*. If the return value is less than *nb_events*, the remaining 228326f14535SPavan Nikhilesh * events at the end of ev[] are not consumed and the caller has to take care 228426f14535SPavan Nikhilesh * of them, and rte_errno is set accordingly. Possible errno values include: 228526f14535SPavan Nikhilesh * - EINVAL The port ID is invalid, device ID is invalid, an event's queue 228626f14535SPavan Nikhilesh * ID is invalid, or an event's sched type doesn't match the 228726f14535SPavan Nikhilesh * capabilities of the destination queue. 228826f14535SPavan Nikhilesh * - ENOSPC The event port was backpressured and unable to enqueue 228926f14535SPavan Nikhilesh * one or more events. This error code is only applicable to 229026f14535SPavan Nikhilesh * closed systems. 229126f14535SPavan Nikhilesh * @see rte_event_port_attr_get(), RTE_EVENT_PORT_ATTR_ENQ_DEPTH 229226f14535SPavan Nikhilesh * @see rte_event_enqueue_burst() 229326f14535SPavan Nikhilesh */ 229426f14535SPavan Nikhilesh static inline uint16_t 229526f14535SPavan Nikhilesh rte_event_enqueue_new_burst(uint8_t dev_id, uint8_t port_id, 229626f14535SPavan Nikhilesh const struct rte_event ev[], uint16_t nb_events) 229726f14535SPavan Nikhilesh { 2298052e25d9SPavan Nikhilesh const struct rte_event_fp_ops *fp_ops; 229926f14535SPavan Nikhilesh 2300052e25d9SPavan Nikhilesh fp_ops = &rte_event_fp_ops[dev_id]; 230126f14535SPavan Nikhilesh return __rte_event_enqueue_burst(dev_id, port_id, ev, nb_events, 2302052e25d9SPavan Nikhilesh fp_ops->enqueue_new_burst); 230326f14535SPavan Nikhilesh } 230426f14535SPavan Nikhilesh 230526f14535SPavan Nikhilesh /** 230626f14535SPavan Nikhilesh * Enqueue a burst of events objects of operation type *RTE_EVENT_OP_FORWARD* 230726f14535SPavan Nikhilesh * on an event device designated by its *dev_id* through the event port 230826f14535SPavan Nikhilesh * specified by *port_id*. 230926f14535SPavan Nikhilesh * 231026f14535SPavan Nikhilesh * Provides the same functionality as rte_event_enqueue_burst(), expect that 231126f14535SPavan Nikhilesh * application can use this API when the all objects in the burst contains 231226f14535SPavan Nikhilesh * the enqueue operation of the type *RTE_EVENT_OP_FORWARD*. This specialized 231326f14535SPavan Nikhilesh * function can provide the additional hint to the PMD and optimize if possible. 231426f14535SPavan Nikhilesh * 231526f14535SPavan Nikhilesh * The rte_event_enqueue_new_burst() result is undefined if the enqueue burst 231626f14535SPavan Nikhilesh * has event object of operation type != RTE_EVENT_OP_FORWARD. 231726f14535SPavan Nikhilesh * 231826f14535SPavan Nikhilesh * @param dev_id 231926f14535SPavan Nikhilesh * The identifier of the device. 232026f14535SPavan Nikhilesh * @param port_id 232126f14535SPavan Nikhilesh * The identifier of the event port. 232226f14535SPavan Nikhilesh * @param ev 232326f14535SPavan Nikhilesh * Points to an array of *nb_events* objects of type *rte_event* structure 232426f14535SPavan Nikhilesh * which contain the event object enqueue operations to be processed. 232526f14535SPavan Nikhilesh * @param nb_events 232626f14535SPavan Nikhilesh * The number of event objects to enqueue, typically number of 232726f14535SPavan Nikhilesh * rte_event_port_attr_get(...RTE_EVENT_PORT_ATTR_ENQ_DEPTH...) 232826f14535SPavan Nikhilesh * available for this port. 232926f14535SPavan Nikhilesh * 233026f14535SPavan Nikhilesh * @return 233126f14535SPavan Nikhilesh * The number of event objects actually enqueued on the event device. The 233226f14535SPavan Nikhilesh * return value can be less than the value of the *nb_events* parameter when 233326f14535SPavan Nikhilesh * the event devices queue is full or if invalid parameters are specified in a 233426f14535SPavan Nikhilesh * *rte_event*. If the return value is less than *nb_events*, the remaining 233526f14535SPavan Nikhilesh * events at the end of ev[] are not consumed and the caller has to take care 233626f14535SPavan Nikhilesh * of them, and rte_errno is set accordingly. Possible errno values include: 233726f14535SPavan Nikhilesh * - EINVAL The port ID is invalid, device ID is invalid, an event's queue 233826f14535SPavan Nikhilesh * ID is invalid, or an event's sched type doesn't match the 233926f14535SPavan Nikhilesh * capabilities of the destination queue. 234026f14535SPavan Nikhilesh * - ENOSPC The event port was backpressured and unable to enqueue 234126f14535SPavan Nikhilesh * one or more events. This error code is only applicable to 234226f14535SPavan Nikhilesh * closed systems. 234326f14535SPavan Nikhilesh * @see rte_event_port_attr_get(), RTE_EVENT_PORT_ATTR_ENQ_DEPTH 234426f14535SPavan Nikhilesh * @see rte_event_enqueue_burst() 234526f14535SPavan Nikhilesh */ 234626f14535SPavan Nikhilesh static inline uint16_t 234726f14535SPavan Nikhilesh rte_event_enqueue_forward_burst(uint8_t dev_id, uint8_t port_id, 234826f14535SPavan Nikhilesh const struct rte_event ev[], uint16_t nb_events) 234926f14535SPavan Nikhilesh { 2350052e25d9SPavan Nikhilesh const struct rte_event_fp_ops *fp_ops; 235126f14535SPavan Nikhilesh 2352052e25d9SPavan Nikhilesh fp_ops = &rte_event_fp_ops[dev_id]; 235326f14535SPavan Nikhilesh return __rte_event_enqueue_burst(dev_id, port_id, ev, nb_events, 2354052e25d9SPavan Nikhilesh fp_ops->enqueue_forward_burst); 235526f14535SPavan Nikhilesh } 235626f14535SPavan Nikhilesh 235726f14535SPavan Nikhilesh /** 235826f14535SPavan Nikhilesh * Dequeue a burst of events objects or an event object from the event port 235926f14535SPavan Nikhilesh * designated by its *event_port_id*, on an event device designated 236026f14535SPavan Nikhilesh * by its *dev_id*. 236126f14535SPavan Nikhilesh * 236226f14535SPavan Nikhilesh * rte_event_dequeue_burst() does not dictate the specifics of scheduling 236326f14535SPavan Nikhilesh * algorithm as each eventdev driver may have different criteria to schedule 236426f14535SPavan Nikhilesh * an event. However, in general, from an application perspective scheduler may 236526f14535SPavan Nikhilesh * use the following scheme to dispatch an event to the port. 236626f14535SPavan Nikhilesh * 236726f14535SPavan Nikhilesh * 1) Selection of event queue based on 236826f14535SPavan Nikhilesh * a) The list of event queues are linked to the event port. 236926f14535SPavan Nikhilesh * b) If the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability then event 237026f14535SPavan Nikhilesh * queue selection from list is based on event queue priority relative to 237126f14535SPavan Nikhilesh * other event queue supplied as *priority* in rte_event_queue_setup() 237226f14535SPavan Nikhilesh * c) If the device has RTE_EVENT_DEV_CAP_EVENT_QOS capability then event 237326f14535SPavan Nikhilesh * queue selection from the list is based on event priority supplied as 237426f14535SPavan Nikhilesh * *priority* in rte_event_enqueue_burst() 237526f14535SPavan Nikhilesh * 2) Selection of event 237626f14535SPavan Nikhilesh * a) The number of flows available in selected event queue. 237726f14535SPavan Nikhilesh * b) Schedule type method associated with the event 237826f14535SPavan Nikhilesh * 237926f14535SPavan Nikhilesh * The *nb_events* parameter is the maximum number of event objects to dequeue 238026f14535SPavan Nikhilesh * which are returned in the *ev* array of *rte_event* structure. 238126f14535SPavan Nikhilesh * 238226f14535SPavan Nikhilesh * The rte_event_dequeue_burst() function returns the number of events objects 238326f14535SPavan Nikhilesh * it actually dequeued. A return value equal to *nb_events* means that all 238426f14535SPavan Nikhilesh * event objects have been dequeued. 238526f14535SPavan Nikhilesh * 238626f14535SPavan Nikhilesh * The number of events dequeued is the number of scheduler contexts held by 238726f14535SPavan Nikhilesh * this port. These contexts are automatically released in the next 238826f14535SPavan Nikhilesh * rte_event_dequeue_burst() invocation if the port supports implicit 238926f14535SPavan Nikhilesh * releases, or invoking rte_event_enqueue_burst() with RTE_EVENT_OP_RELEASE 239026f14535SPavan Nikhilesh * operation can be used to release the contexts early. 239126f14535SPavan Nikhilesh * 239226f14535SPavan Nikhilesh * Event operations RTE_EVENT_OP_FORWARD and RTE_EVENT_OP_RELEASE must only be 239326f14535SPavan Nikhilesh * enqueued to the same port that their associated events were dequeued from. 239426f14535SPavan Nikhilesh * 239526f14535SPavan Nikhilesh * @param dev_id 239626f14535SPavan Nikhilesh * The identifier of the device. 239726f14535SPavan Nikhilesh * @param port_id 239826f14535SPavan Nikhilesh * The identifier of the event port. 239926f14535SPavan Nikhilesh * @param[out] ev 240026f14535SPavan Nikhilesh * Points to an array of *nb_events* objects of type *rte_event* structure 240126f14535SPavan Nikhilesh * for output to be populated with the dequeued event objects. 240226f14535SPavan Nikhilesh * @param nb_events 240326f14535SPavan Nikhilesh * The maximum number of event objects to dequeue, typically number of 240426f14535SPavan Nikhilesh * rte_event_port_dequeue_depth() available for this port. 240526f14535SPavan Nikhilesh * 240626f14535SPavan Nikhilesh * @param timeout_ticks 240726f14535SPavan Nikhilesh * - 0 no-wait, returns immediately if there is no event. 240826f14535SPavan Nikhilesh * - >0 wait for the event, if the device is configured with 240926f14535SPavan Nikhilesh * RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT then this function will wait until 241026f14535SPavan Nikhilesh * at least one event is available or *timeout_ticks* time. 241126f14535SPavan Nikhilesh * if the device is not configured with RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT 241226f14535SPavan Nikhilesh * then this function will wait until the event available or 241326f14535SPavan Nikhilesh * *dequeue_timeout_ns* ns which was previously supplied to 241426f14535SPavan Nikhilesh * rte_event_dev_configure() 241526f14535SPavan Nikhilesh * 241626f14535SPavan Nikhilesh * @return 241726f14535SPavan Nikhilesh * The number of event objects actually dequeued from the port. The return 241826f14535SPavan Nikhilesh * value can be less than the value of the *nb_events* parameter when the 241926f14535SPavan Nikhilesh * event port's queue is not full. 242026f14535SPavan Nikhilesh * 242126f14535SPavan Nikhilesh * @see rte_event_port_dequeue_depth() 242226f14535SPavan Nikhilesh */ 242326f14535SPavan Nikhilesh static inline uint16_t 242426f14535SPavan Nikhilesh rte_event_dequeue_burst(uint8_t dev_id, uint8_t port_id, struct rte_event ev[], 242526f14535SPavan Nikhilesh uint16_t nb_events, uint64_t timeout_ticks) 242626f14535SPavan Nikhilesh { 2427052e25d9SPavan Nikhilesh const struct rte_event_fp_ops *fp_ops; 2428052e25d9SPavan Nikhilesh void *port; 242926f14535SPavan Nikhilesh 2430052e25d9SPavan Nikhilesh fp_ops = &rte_event_fp_ops[dev_id]; 2431052e25d9SPavan Nikhilesh port = fp_ops->data[port_id]; 243226f14535SPavan Nikhilesh #ifdef RTE_LIBRTE_EVENTDEV_DEBUG 2433052e25d9SPavan Nikhilesh if (dev_id >= RTE_EVENT_MAX_DEVS || 2434052e25d9SPavan Nikhilesh port_id >= RTE_EVENT_MAX_PORTS_PER_DEV) { 243526f14535SPavan Nikhilesh rte_errno = EINVAL; 243626f14535SPavan Nikhilesh return 0; 243726f14535SPavan Nikhilesh } 243826f14535SPavan Nikhilesh 2439052e25d9SPavan Nikhilesh if (port == NULL) { 244026f14535SPavan Nikhilesh rte_errno = EINVAL; 244126f14535SPavan Nikhilesh return 0; 244226f14535SPavan Nikhilesh } 244326f14535SPavan Nikhilesh #endif 244426f14535SPavan Nikhilesh rte_eventdev_trace_deq_burst(dev_id, port_id, ev, nb_events); 244526f14535SPavan Nikhilesh /* 244626f14535SPavan Nikhilesh * Allow zero cost non burst mode routine invocation if application 244726f14535SPavan Nikhilesh * requests nb_events as const one 244826f14535SPavan Nikhilesh */ 244926f14535SPavan Nikhilesh if (nb_events == 1) 2450052e25d9SPavan Nikhilesh return (fp_ops->dequeue)(port, ev, timeout_ticks); 245126f14535SPavan Nikhilesh else 2452052e25d9SPavan Nikhilesh return (fp_ops->dequeue_burst)(port, ev, nb_events, 2453052e25d9SPavan Nikhilesh timeout_ticks); 245426f14535SPavan Nikhilesh } 245526f14535SPavan Nikhilesh 245654f17843SMattias Rönnblom #define RTE_EVENT_DEV_MAINT_OP_FLUSH (1 << 0) 245754f17843SMattias Rönnblom /**< Force an immediately flush of any buffered events in the port, 245854f17843SMattias Rönnblom * potentially at the cost of additional overhead. 245954f17843SMattias Rönnblom * 246054f17843SMattias Rönnblom * @see rte_event_maintain() 246154f17843SMattias Rönnblom */ 246254f17843SMattias Rönnblom 246354f17843SMattias Rönnblom /** 246454f17843SMattias Rönnblom * Maintain an event device. 246554f17843SMattias Rönnblom * 2466bd991897SMattias Rönnblom * This function is only relevant for event devices which do not have 2467bd991897SMattias Rönnblom * the @ref RTE_EVENT_DEV_CAP_MAINTENANCE_FREE flag set. Such devices 246854f17843SMattias Rönnblom * require an application thread using a particular port to 246954f17843SMattias Rönnblom * periodically call rte_event_maintain() on that port during periods 247054f17843SMattias Rönnblom * which it is neither attempting to enqueue events to nor dequeue 247154f17843SMattias Rönnblom * events from the port. rte_event_maintain() is a low-overhead 247254f17843SMattias Rönnblom * function and should be called at a high rate (e.g., in the 247354f17843SMattias Rönnblom * application's poll loop). 247454f17843SMattias Rönnblom * 247554f17843SMattias Rönnblom * No port may be left unmaintained. 247654f17843SMattias Rönnblom * 247754f17843SMattias Rönnblom * At the application thread's convenience, rte_event_maintain() may 247854f17843SMattias Rönnblom * (but is not required to) be called even during periods when enqueue 247954f17843SMattias Rönnblom * or dequeue functions are being called, at the cost of a slight 248054f17843SMattias Rönnblom * increase in overhead. 248154f17843SMattias Rönnblom * 2482bd991897SMattias Rönnblom * rte_event_maintain() may be called on event devices which have set 2483bd991897SMattias Rönnblom * @ref RTE_EVENT_DEV_CAP_MAINTENANCE_FREE, in which case it is a 2484bd991897SMattias Rönnblom * no-operation. 248554f17843SMattias Rönnblom * 248654f17843SMattias Rönnblom * @param dev_id 248754f17843SMattias Rönnblom * The identifier of the device. 248854f17843SMattias Rönnblom * @param port_id 248954f17843SMattias Rönnblom * The identifier of the event port. 249054f17843SMattias Rönnblom * @param op 249154f17843SMattias Rönnblom * 0, or @ref RTE_EVENT_DEV_MAINT_OP_FLUSH. 249254f17843SMattias Rönnblom * @return 249354f17843SMattias Rönnblom * - 0 on success. 249454f17843SMattias Rönnblom * - -EINVAL if *dev_id*, *port_id*, or *op* is invalid. 249554f17843SMattias Rönnblom * 2496bd991897SMattias Rönnblom * @see RTE_EVENT_DEV_CAP_MAINTENANCE_FREE 249754f17843SMattias Rönnblom */ 249854f17843SMattias Rönnblom static inline int 249954f17843SMattias Rönnblom rte_event_maintain(uint8_t dev_id, uint8_t port_id, int op) 250054f17843SMattias Rönnblom { 250154f17843SMattias Rönnblom const struct rte_event_fp_ops *fp_ops; 250254f17843SMattias Rönnblom void *port; 250354f17843SMattias Rönnblom 250454f17843SMattias Rönnblom fp_ops = &rte_event_fp_ops[dev_id]; 250554f17843SMattias Rönnblom port = fp_ops->data[port_id]; 250654f17843SMattias Rönnblom #ifdef RTE_LIBRTE_EVENTDEV_DEBUG 250754f17843SMattias Rönnblom if (dev_id >= RTE_EVENT_MAX_DEVS || 250854f17843SMattias Rönnblom port_id >= RTE_EVENT_MAX_PORTS_PER_DEV) 250954f17843SMattias Rönnblom return -EINVAL; 251054f17843SMattias Rönnblom 251154f17843SMattias Rönnblom if (port == NULL) 251254f17843SMattias Rönnblom return -EINVAL; 251354f17843SMattias Rönnblom 251454f17843SMattias Rönnblom if (op & (~RTE_EVENT_DEV_MAINT_OP_FLUSH)) 251554f17843SMattias Rönnblom return -EINVAL; 251654f17843SMattias Rönnblom #endif 251754f17843SMattias Rönnblom rte_eventdev_trace_maintain(dev_id, port_id, op); 251854f17843SMattias Rönnblom 251954f17843SMattias Rönnblom if (fp_ops->maintain != NULL) 252054f17843SMattias Rönnblom fp_ops->maintain(port, op); 252154f17843SMattias Rönnblom 252254f17843SMattias Rönnblom return 0; 252354f17843SMattias Rönnblom } 252454f17843SMattias Rönnblom 2525d007a7f3SPavan Nikhilesh /** 2526d007a7f3SPavan Nikhilesh * Change the active profile on an event port. 2527d007a7f3SPavan Nikhilesh * 2528d007a7f3SPavan Nikhilesh * This function is used to change the current active profile on an event port 2529d007a7f3SPavan Nikhilesh * when multiple link profiles are configured on an event port through the 2530d007a7f3SPavan Nikhilesh * function call ``rte_event_port_profile_links_set``. 2531d007a7f3SPavan Nikhilesh * 2532d007a7f3SPavan Nikhilesh * On the subsequent ``rte_event_dequeue_burst`` call, only the event queues 2533d007a7f3SPavan Nikhilesh * that were associated with the newly active profile will participate in 2534d007a7f3SPavan Nikhilesh * scheduling. 2535d007a7f3SPavan Nikhilesh * 2536d007a7f3SPavan Nikhilesh * @param dev_id 2537d007a7f3SPavan Nikhilesh * The identifier of the device. 2538d007a7f3SPavan Nikhilesh * @param port_id 2539d007a7f3SPavan Nikhilesh * The identifier of the event port. 2540d007a7f3SPavan Nikhilesh * @param profile_id 2541d007a7f3SPavan Nikhilesh * The identifier of the profile. 2542d007a7f3SPavan Nikhilesh * @return 2543d007a7f3SPavan Nikhilesh * - 0 on success. 2544d007a7f3SPavan Nikhilesh * - -EINVAL if *dev_id*, *port_id*, or *profile_id* is invalid. 2545d007a7f3SPavan Nikhilesh */ 2546d007a7f3SPavan Nikhilesh static inline uint8_t 2547d007a7f3SPavan Nikhilesh rte_event_port_profile_switch(uint8_t dev_id, uint8_t port_id, uint8_t profile_id) 2548d007a7f3SPavan Nikhilesh { 2549d007a7f3SPavan Nikhilesh const struct rte_event_fp_ops *fp_ops; 2550d007a7f3SPavan Nikhilesh void *port; 2551d007a7f3SPavan Nikhilesh 2552d007a7f3SPavan Nikhilesh fp_ops = &rte_event_fp_ops[dev_id]; 2553d007a7f3SPavan Nikhilesh port = fp_ops->data[port_id]; 2554d007a7f3SPavan Nikhilesh 2555d007a7f3SPavan Nikhilesh #ifdef RTE_LIBRTE_EVENTDEV_DEBUG 2556d007a7f3SPavan Nikhilesh if (dev_id >= RTE_EVENT_MAX_DEVS || 2557d007a7f3SPavan Nikhilesh port_id >= RTE_EVENT_MAX_PORTS_PER_DEV) 2558d007a7f3SPavan Nikhilesh return -EINVAL; 2559d007a7f3SPavan Nikhilesh 2560d007a7f3SPavan Nikhilesh if (port == NULL) 2561d007a7f3SPavan Nikhilesh return -EINVAL; 2562d007a7f3SPavan Nikhilesh 2563d007a7f3SPavan Nikhilesh if (profile_id >= RTE_EVENT_MAX_PROFILES_PER_PORT) 2564d007a7f3SPavan Nikhilesh return -EINVAL; 2565d007a7f3SPavan Nikhilesh #endif 2566d007a7f3SPavan Nikhilesh rte_eventdev_trace_port_profile_switch(dev_id, port_id, profile_id); 2567d007a7f3SPavan Nikhilesh 2568d007a7f3SPavan Nikhilesh return fp_ops->profile_switch(port, profile_id); 2569d007a7f3SPavan Nikhilesh } 2570d007a7f3SPavan Nikhilesh 257199a2dd95SBruce Richardson #ifdef __cplusplus 257299a2dd95SBruce Richardson } 257399a2dd95SBruce Richardson #endif 257499a2dd95SBruce Richardson 257599a2dd95SBruce Richardson #endif /* _RTE_EVENTDEV_H_ */ 2576