1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016 Cavium, Inc
5 #ifndef _RTE_EVENTDEV_PMD_H_
6 #define _RTE_EVENTDEV_PMD_H_
12 * These API are from event PMD only and user applications should not call
22 #include <rte_common.h>
23 #include <rte_config.h>
26 #include <rte_malloc.h>
28 #include "rte_eventdev.h"
29 #include "rte_event_timer_adapter_pmd.h"
32 #define RTE_EDEV_LOG_ERR(...) \
33 RTE_LOG(ERR, EVENTDEV, \
34 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
35 __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
37 #ifdef RTE_LIBRTE_EVENTDEV_DEBUG
38 #define RTE_EDEV_LOG_DEBUG(...) \
39 RTE_LOG(DEBUG, EVENTDEV, \
40 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
41 __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
43 #define RTE_EDEV_LOG_DEBUG(...) (void)0
46 /* Macros to check for valid device */
47 #define RTE_EVENTDEV_VALID_DEVID_OR_ERR_RET(dev_id, retval) do { \
48 if (!rte_event_pmd_is_valid_dev((dev_id))) { \
49 RTE_EDEV_LOG_ERR("Invalid dev_id=%d\n", dev_id); \
54 #define RTE_EVENTDEV_VALID_DEVID_OR_ERRNO_RET(dev_id, errno, retval) do { \
55 if (!rte_event_pmd_is_valid_dev((dev_id))) { \
56 RTE_EDEV_LOG_ERR("Invalid dev_id=%d\n", dev_id); \
62 #define RTE_EVENTDEV_VALID_DEVID_OR_RET(dev_id) do { \
63 if (!rte_event_pmd_is_valid_dev((dev_id))) { \
64 RTE_EDEV_LOG_ERR("Invalid dev_id=%d\n", dev_id); \
69 #define RTE_EVENT_ETH_RX_ADAPTER_SW_CAP \
70 ((RTE_EVENT_ETH_RX_ADAPTER_CAP_OVERRIDE_FLOW_ID) | \
71 (RTE_EVENT_ETH_RX_ADAPTER_CAP_MULTI_EVENTQ))
73 /**< Ethernet Rx adapter cap to return If the packet transfers from
74 * the ethdev to eventdev use a SW service function
77 #define RTE_EVENTDEV_DETACHED (0)
78 #define RTE_EVENTDEV_ATTACHED (1)
82 /** Global structure used for maintaining state of allocated event devices */
83 struct rte_eventdev_global {
84 uint8_t nb_devs; /**< Number of devices found */
87 extern struct rte_eventdev_global *rte_eventdev_globals;
88 /** Pointer to global event devices data structure. */
89 extern struct rte_eventdev *rte_eventdevs;
90 /** The pool of rte_eventdev structures. */
93 * Get the rte_eventdev structure device pointer for the named device.
96 * device name to select the device structure.
99 * - The rte_eventdev structure pointer for the given device ID.
101 static inline struct rte_eventdev *
102 rte_event_pmd_get_named_dev(const char *name)
104 struct rte_eventdev *dev;
110 for (i = 0; i < RTE_EVENT_MAX_DEVS; i++) {
111 dev = &rte_eventdevs[i];
112 if ((dev->attached == RTE_EVENTDEV_ATTACHED) &&
113 (strcmp(dev->data->name, name) == 0))
121 * Validate if the event device index is valid attached event device.
124 * Event device index.
127 * - If the device index is valid (1) or not (0).
129 static inline unsigned
130 rte_event_pmd_is_valid_dev(uint8_t dev_id)
132 struct rte_eventdev *dev;
134 if (dev_id >= RTE_EVENT_MAX_DEVS)
137 dev = &rte_eventdevs[dev_id];
138 if (dev->attached != RTE_EVENTDEV_ATTACHED)
145 * Definitions of all functions exported by a driver through the
146 * the generic structure of type *event_dev_ops* supplied in the
147 * *rte_eventdev* structure associated with a device.
151 * Get device information of a device.
154 * Event device pointer
156 * Event device information structure
159 * Returns 0 on success
161 typedef void (*eventdev_info_get_t)(struct rte_eventdev *dev,
162 struct rte_event_dev_info *dev_info);
165 * Configure a device.
168 * Event device pointer
171 * Returns 0 on success
173 typedef int (*eventdev_configure_t)(const struct rte_eventdev *dev);
176 * Start a configured device.
179 * Event device pointer
182 * Returns 0 on success
184 typedef int (*eventdev_start_t)(struct rte_eventdev *dev);
187 * Stop a configured device.
190 * Event device pointer
192 typedef void (*eventdev_stop_t)(struct rte_eventdev *dev);
195 * Close a configured device.
198 * Event device pointer
202 * - (-EAGAIN) if can't close as device is busy
204 typedef int (*eventdev_close_t)(struct rte_eventdev *dev);
207 * Retrieve the default event queue configuration.
210 * Event device pointer
213 * @param[out] queue_conf
214 * Event queue configuration structure
217 typedef void (*eventdev_queue_default_conf_get_t)(struct rte_eventdev *dev,
218 uint8_t queue_id, struct rte_event_queue_conf *queue_conf);
221 * Setup an event queue.
224 * Event device pointer
228 * Event queue configuration structure
231 * Returns 0 on success.
233 typedef int (*eventdev_queue_setup_t)(struct rte_eventdev *dev,
235 const struct rte_event_queue_conf *queue_conf);
238 * Release resources allocated by given event queue.
241 * Event device pointer
246 typedef void (*eventdev_queue_release_t)(struct rte_eventdev *dev,
250 * Retrieve the default event port configuration.
253 * Event device pointer
256 * @param[out] port_conf
257 * Event port configuration structure
260 typedef void (*eventdev_port_default_conf_get_t)(struct rte_eventdev *dev,
261 uint8_t port_id, struct rte_event_port_conf *port_conf);
264 * Setup an event port.
267 * Event device pointer
271 * Event port configuration structure
274 * Returns 0 on success.
276 typedef int (*eventdev_port_setup_t)(struct rte_eventdev *dev,
278 const struct rte_event_port_conf *port_conf);
281 * Release memory resources allocated by given event port.
287 typedef void (*eventdev_port_release_t)(void *port);
290 * Link multiple source event queues to destination event port.
293 * Event device pointer
297 * Points to an array of *nb_links* event queues to be linked
300 * Points to an array of *nb_links* service priorities associated with each
301 * event queue link to event port.
303 * The number of links to establish
306 * Returns 0 on success.
309 typedef int (*eventdev_port_link_t)(struct rte_eventdev *dev, void *port,
310 const uint8_t queues[], const uint8_t priorities[],
314 * Unlink multiple source event queues from destination event port.
317 * Event device pointer
321 * An array of *nb_unlinks* event queues to be unlinked from the event port.
323 * The number of unlinks to establish
326 * Returns 0 on success.
329 typedef int (*eventdev_port_unlink_t)(struct rte_eventdev *dev, void *port,
330 uint8_t queues[], uint16_t nb_unlinks);
333 * Converts nanoseconds to *timeout_ticks* value for rte_event_dequeue()
336 * Event device pointer
338 * Wait time in nanosecond
339 * @param[out] timeout_ticks
340 * Value for the *timeout_ticks* parameter in rte_event_dequeue() function
343 * Returns 0 on success.
346 typedef int (*eventdev_dequeue_timeout_ticks_t)(struct rte_eventdev *dev,
347 uint64_t ns, uint64_t *timeout_ticks);
350 * Dump internal information
353 * Event device pointer
355 * A pointer to a file for output
358 typedef void (*eventdev_dump_t)(struct rte_eventdev *dev, FILE *f);
361 * Retrieve a set of statistics from device
364 * Event device pointer
366 * The stat ids to retrieve
368 * The returned stat values
370 * The number of id values and entries in the values array
372 * The number of stat values successfully filled into the values array
374 typedef int (*eventdev_xstats_get_t)(const struct rte_eventdev *dev,
375 enum rte_event_dev_xstats_mode mode, uint8_t queue_port_id,
376 const unsigned int ids[], uint64_t values[], unsigned int n);
379 * Resets the statistic values in xstats for the device, based on mode.
381 typedef int (*eventdev_xstats_reset_t)(struct rte_eventdev *dev,
382 enum rte_event_dev_xstats_mode mode,
383 int16_t queue_port_id,
384 const uint32_t ids[],
388 * Get names of extended stats of an event device
391 * Event device pointer
392 * @param xstats_names
393 * Array of name values to be filled in
395 * Number of values in the xstats_names array
397 * When size >= the number of stats, return the number of stat values filled
399 * When size < the number of available stats, return the number of stats
400 * values, and do not fill in any data into xstats_names.
402 typedef int (*eventdev_xstats_get_names_t)(const struct rte_eventdev *dev,
403 enum rte_event_dev_xstats_mode mode, uint8_t queue_port_id,
404 struct rte_event_dev_xstats_name *xstats_names,
405 unsigned int *ids, unsigned int size);
408 * Get value of one stats and optionally return its id
411 * Event device pointer
413 * The name of the stat to retrieve
415 * Pointer to an unsigned int where we store the stat-id for future reference.
416 * This pointer may be null if the id is not required.
418 * The value of the stat, or (uint64_t)-1 if the stat is not found.
419 * If the stat is not found, the id value will be returned as (unsigned)-1,
420 * if id pointer is non-NULL
422 typedef uint64_t (*eventdev_xstats_get_by_name)(const struct rte_eventdev *dev,
423 const char *name, unsigned int *id);
427 * Retrieve the event device's ethdev Rx adapter capabilities for the
428 * specified ethernet port
431 * Event device pointer
434 * Ethernet device pointer
437 * A pointer to memory filled with Rx event adapter capabilities.
440 * - 0: Success, driver provides Rx event adapter capabilities for the
442 * - <0: Error code returned by the driver function.
445 typedef int (*eventdev_eth_rx_adapter_caps_get_t)
446 (const struct rte_eventdev *dev,
447 const struct rte_eth_dev *eth_dev,
450 struct rte_event_eth_rx_adapter_queue_conf *queue_conf;
453 * Retrieve the event device's timer adapter capabilities, as well as the ops
454 * structure that an event timer adapter should call through to enter the
458 * Event device pointer
461 * Flags that can be used to determine how to select an event timer
462 * adapter ops structure
465 * A pointer to memory filled with Rx event adapter capabilities.
468 * A pointer to the ops pointer to set with the address of the desired ops
472 * - 0: Success, driver provides Rx event adapter capabilities for the
474 * - <0: Error code returned by the driver function.
477 typedef int (*eventdev_timer_adapter_caps_get_t)(
478 const struct rte_eventdev *dev,
481 const struct rte_event_timer_adapter_ops **ops);
484 * Add ethernet Rx queues to event device. This callback is invoked if
485 * the caps returned from rte_eventdev_eth_rx_adapter_caps_get(, eth_port_id)
486 * has RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT set.
489 * Event device pointer
492 * Ethernet device pointer
495 * Ethernet device receive queue index
498 * Additional configuration structure
501 * - 0: Success, ethernet receive queue added successfully.
502 * - <0: Error code returned by the driver function.
505 typedef int (*eventdev_eth_rx_adapter_queue_add_t)(
506 const struct rte_eventdev *dev,
507 const struct rte_eth_dev *eth_dev,
509 const struct rte_event_eth_rx_adapter_queue_conf *queue_conf);
512 * Delete ethernet Rx queues from event device. This callback is invoked if
513 * the caps returned from eventdev_eth_rx_adapter_caps_get(, eth_port_id)
514 * has RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT set.
517 * Event device pointer
520 * Ethernet device pointer
523 * Ethernet device receive queue index
526 * - 0: Success, ethernet receive queue deleted successfully.
527 * - <0: Error code returned by the driver function.
530 typedef int (*eventdev_eth_rx_adapter_queue_del_t)
531 (const struct rte_eventdev *dev,
532 const struct rte_eth_dev *eth_dev,
533 int32_t rx_queue_id);
536 * Start ethernet Rx adapter. This callback is invoked if
537 * the caps returned from eventdev_eth_rx_adapter_caps_get(.., eth_port_id)
538 * has RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT set and Rx queues
539 * from eth_port_id have been added to the event device.
542 * Event device pointer
545 * Ethernet device pointer
548 * - 0: Success, ethernet Rx adapter started successfully.
549 * - <0: Error code returned by the driver function.
551 typedef int (*eventdev_eth_rx_adapter_start_t)
552 (const struct rte_eventdev *dev,
553 const struct rte_eth_dev *eth_dev);
556 * Stop ethernet Rx adapter. This callback is invoked if
557 * the caps returned from eventdev_eth_rx_adapter_caps_get(..,eth_port_id)
558 * has RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT set and Rx queues
559 * from eth_port_id have been added to the event device.
562 * Event device pointer
565 * Ethernet device pointer
568 * - 0: Success, ethernet Rx adapter stopped successfully.
569 * - <0: Error code returned by the driver function.
571 typedef int (*eventdev_eth_rx_adapter_stop_t)
572 (const struct rte_eventdev *dev,
573 const struct rte_eth_dev *eth_dev);
575 struct rte_event_eth_rx_adapter_stats *stats;
578 * Retrieve ethernet Rx adapter statistics.
581 * Event device pointer
584 * Ethernet device pointer
587 * Pointer to stats structure
590 * Return 0 on success.
593 typedef int (*eventdev_eth_rx_adapter_stats_get)
594 (const struct rte_eventdev *dev,
595 const struct rte_eth_dev *eth_dev,
596 struct rte_event_eth_rx_adapter_stats *stats);
598 * Reset ethernet Rx adapter statistics.
601 * Event device pointer
604 * Ethernet device pointer
607 * Return 0 on success.
609 typedef int (*eventdev_eth_rx_adapter_stats_reset)
610 (const struct rte_eventdev *dev,
611 const struct rte_eth_dev *eth_dev);
613 * Start eventdev selftest.
616 * Return 0 on success.
618 typedef int (*eventdev_selftest)(void);
620 /** Event device operations function pointer table */
621 struct rte_eventdev_ops {
622 eventdev_info_get_t dev_infos_get; /**< Get device info. */
623 eventdev_configure_t dev_configure; /**< Configure device. */
624 eventdev_start_t dev_start; /**< Start device. */
625 eventdev_stop_t dev_stop; /**< Stop device. */
626 eventdev_close_t dev_close; /**< Close device. */
628 eventdev_queue_default_conf_get_t queue_def_conf;
629 /**< Get default queue configuration. */
630 eventdev_queue_setup_t queue_setup;
631 /**< Set up an event queue. */
632 eventdev_queue_release_t queue_release;
633 /**< Release an event queue. */
635 eventdev_port_default_conf_get_t port_def_conf;
636 /**< Get default port configuration. */
637 eventdev_port_setup_t port_setup;
638 /**< Set up an event port. */
639 eventdev_port_release_t port_release;
640 /**< Release an event port. */
642 eventdev_port_link_t port_link;
643 /**< Link event queues to an event port. */
644 eventdev_port_unlink_t port_unlink;
645 /**< Unlink event queues from an event port. */
646 eventdev_dequeue_timeout_ticks_t timeout_ticks;
647 /**< Converts ns to *timeout_ticks* value for rte_event_dequeue() */
648 eventdev_dump_t dump;
649 /* Dump internal information */
651 eventdev_xstats_get_t xstats_get;
652 /**< Get extended device statistics. */
653 eventdev_xstats_get_names_t xstats_get_names;
654 /**< Get names of extended stats. */
655 eventdev_xstats_get_by_name xstats_get_by_name;
656 /**< Get one value by name. */
657 eventdev_xstats_reset_t xstats_reset;
658 /**< Reset the statistics values in xstats. */
660 eventdev_eth_rx_adapter_caps_get_t eth_rx_adapter_caps_get;
661 /**< Get ethernet Rx adapter capabilities */
662 eventdev_eth_rx_adapter_queue_add_t eth_rx_adapter_queue_add;
663 /**< Add Rx queues to ethernet Rx adapter */
664 eventdev_eth_rx_adapter_queue_del_t eth_rx_adapter_queue_del;
665 /**< Delete Rx queues from ethernet Rx adapter */
666 eventdev_eth_rx_adapter_start_t eth_rx_adapter_start;
667 /**< Start ethernet Rx adapter */
668 eventdev_eth_rx_adapter_stop_t eth_rx_adapter_stop;
669 /**< Stop ethernet Rx adapter */
670 eventdev_eth_rx_adapter_stats_get eth_rx_adapter_stats_get;
671 /**< Get ethernet Rx stats */
672 eventdev_eth_rx_adapter_stats_reset eth_rx_adapter_stats_reset;
673 /**< Reset ethernet Rx stats */
675 eventdev_timer_adapter_caps_get_t timer_adapter_caps_get;
676 /**< Get timer adapter capabilities */
678 eventdev_selftest dev_selftest;
679 /**< Start eventdev Selftest */
681 eventdev_stop_flush_t dev_stop_flush;
682 /**< User-provided event flush function */
686 * Allocates a new eventdev slot for an event device and returns the pointer
687 * to that slot for the driver to use.
690 * Unique identifier name for each device
692 * Socket to allocate resources on.
694 * - Slot in the rte_dev_devices array for a new device;
696 struct rte_eventdev *
697 rte_event_pmd_allocate(const char *name, int socket_id);
700 * Release the specified eventdev device.
703 * The *eventdev* pointer is the address of the *rte_eventdev* structure.
705 * - 0 on success, negative on error
708 rte_event_pmd_release(struct rte_eventdev *eventdev);
714 #endif /* _RTE_EVENTDEV_PMD_H_ */