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"
31 #define RTE_EDEV_LOG_ERR(...) \
32 RTE_LOG(ERR, EVENTDEV, \
33 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
34 __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
36 #ifdef RTE_LIBRTE_EVENTDEV_DEBUG
37 #define RTE_EDEV_LOG_DEBUG(...) \
38 RTE_LOG(DEBUG, EVENTDEV, \
39 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
40 __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
42 #define RTE_EDEV_LOG_DEBUG(...) (void)0
45 /* Macros to check for valid device */
46 #define RTE_EVENTDEV_VALID_DEVID_OR_ERR_RET(dev_id, retval) do { \
47 if (!rte_event_pmd_is_valid_dev((dev_id))) { \
48 RTE_EDEV_LOG_ERR("Invalid dev_id=%d\n", dev_id); \
53 #define RTE_EVENTDEV_VALID_DEVID_OR_ERRNO_RET(dev_id, errno, retval) do { \
54 if (!rte_event_pmd_is_valid_dev((dev_id))) { \
55 RTE_EDEV_LOG_ERR("Invalid dev_id=%d\n", dev_id); \
61 #define RTE_EVENTDEV_VALID_DEVID_OR_RET(dev_id) do { \
62 if (!rte_event_pmd_is_valid_dev((dev_id))) { \
63 RTE_EDEV_LOG_ERR("Invalid dev_id=%d\n", dev_id); \
68 #define RTE_EVENT_ETH_RX_ADAPTER_SW_CAP \
69 ((RTE_EVENT_ETH_RX_ADAPTER_CAP_OVERRIDE_FLOW_ID) | \
70 (RTE_EVENT_ETH_RX_ADAPTER_CAP_MULTI_EVENTQ))
72 /**< Ethernet Rx adapter cap to return If the packet transfers from
73 * the ethdev to eventdev use a SW service function
76 #define RTE_EVENTDEV_DETACHED (0)
77 #define RTE_EVENTDEV_ATTACHED (1)
81 /** Global structure used for maintaining state of allocated event devices */
82 struct rte_eventdev_global {
83 uint8_t nb_devs; /**< Number of devices found */
86 extern struct rte_eventdev_global *rte_eventdev_globals;
87 /** Pointer to global event devices data structure. */
88 extern struct rte_eventdev *rte_eventdevs;
89 /** The pool of rte_eventdev structures. */
92 * Get the rte_eventdev structure device pointer for the named device.
95 * device name to select the device structure.
98 * - The rte_eventdev structure pointer for the given device ID.
100 static inline struct rte_eventdev *
101 rte_event_pmd_get_named_dev(const char *name)
103 struct rte_eventdev *dev;
109 for (i = 0; i < RTE_EVENT_MAX_DEVS; i++) {
110 dev = &rte_eventdevs[i];
111 if ((dev->attached == RTE_EVENTDEV_ATTACHED) &&
112 (strcmp(dev->data->name, name) == 0))
120 * Validate if the event device index is valid attached event device.
123 * Event device index.
126 * - If the device index is valid (1) or not (0).
128 static inline unsigned
129 rte_event_pmd_is_valid_dev(uint8_t dev_id)
131 struct rte_eventdev *dev;
133 if (dev_id >= RTE_EVENT_MAX_DEVS)
136 dev = &rte_eventdevs[dev_id];
137 if (dev->attached != RTE_EVENTDEV_ATTACHED)
144 * Definitions of all functions exported by a driver through the
145 * the generic structure of type *event_dev_ops* supplied in the
146 * *rte_eventdev* structure associated with a device.
150 * Get device information of a device.
153 * Event device pointer
155 * Event device information structure
158 * Returns 0 on success
160 typedef void (*eventdev_info_get_t)(struct rte_eventdev *dev,
161 struct rte_event_dev_info *dev_info);
164 * Configure a device.
167 * Event device pointer
170 * Returns 0 on success
172 typedef int (*eventdev_configure_t)(const struct rte_eventdev *dev);
175 * Start a configured device.
178 * Event device pointer
181 * Returns 0 on success
183 typedef int (*eventdev_start_t)(struct rte_eventdev *dev);
186 * Stop a configured device.
189 * Event device pointer
191 typedef void (*eventdev_stop_t)(struct rte_eventdev *dev);
194 * Close a configured device.
197 * Event device pointer
201 * - (-EAGAIN) if can't close as device is busy
203 typedef int (*eventdev_close_t)(struct rte_eventdev *dev);
206 * Retrieve the default event queue configuration.
209 * Event device pointer
212 * @param[out] queue_conf
213 * Event queue configuration structure
216 typedef void (*eventdev_queue_default_conf_get_t)(struct rte_eventdev *dev,
217 uint8_t queue_id, struct rte_event_queue_conf *queue_conf);
220 * Setup an event queue.
223 * Event device pointer
227 * Event queue configuration structure
230 * Returns 0 on success.
232 typedef int (*eventdev_queue_setup_t)(struct rte_eventdev *dev,
234 const struct rte_event_queue_conf *queue_conf);
237 * Release resources allocated by given event queue.
240 * Event device pointer
245 typedef void (*eventdev_queue_release_t)(struct rte_eventdev *dev,
249 * Retrieve the default event port configuration.
252 * Event device pointer
255 * @param[out] port_conf
256 * Event port configuration structure
259 typedef void (*eventdev_port_default_conf_get_t)(struct rte_eventdev *dev,
260 uint8_t port_id, struct rte_event_port_conf *port_conf);
263 * Setup an event port.
266 * Event device pointer
270 * Event port configuration structure
273 * Returns 0 on success.
275 typedef int (*eventdev_port_setup_t)(struct rte_eventdev *dev,
277 const struct rte_event_port_conf *port_conf);
280 * Release memory resources allocated by given event port.
286 typedef void (*eventdev_port_release_t)(void *port);
289 * Link multiple source event queues to destination event port.
292 * Event device pointer
296 * Points to an array of *nb_links* event queues to be linked
299 * Points to an array of *nb_links* service priorities associated with each
300 * event queue link to event port.
302 * The number of links to establish
305 * Returns 0 on success.
308 typedef int (*eventdev_port_link_t)(struct rte_eventdev *dev, void *port,
309 const uint8_t queues[], const uint8_t priorities[],
313 * Unlink multiple source event queues from destination event port.
316 * Event device pointer
320 * An array of *nb_unlinks* event queues to be unlinked from the event port.
322 * The number of unlinks to establish
325 * Returns 0 on success.
328 typedef int (*eventdev_port_unlink_t)(struct rte_eventdev *dev, void *port,
329 uint8_t queues[], uint16_t nb_unlinks);
332 * Converts nanoseconds to *timeout_ticks* value for rte_event_dequeue()
335 * Event device pointer
337 * Wait time in nanosecond
338 * @param[out] timeout_ticks
339 * Value for the *timeout_ticks* parameter in rte_event_dequeue() function
342 * Returns 0 on success.
345 typedef int (*eventdev_dequeue_timeout_ticks_t)(struct rte_eventdev *dev,
346 uint64_t ns, uint64_t *timeout_ticks);
349 * Dump internal information
352 * Event device pointer
354 * A pointer to a file for output
357 typedef void (*eventdev_dump_t)(struct rte_eventdev *dev, FILE *f);
360 * Retrieve a set of statistics from device
363 * Event device pointer
365 * The stat ids to retrieve
367 * The returned stat values
369 * The number of id values and entries in the values array
371 * The number of stat values successfully filled into the values array
373 typedef int (*eventdev_xstats_get_t)(const struct rte_eventdev *dev,
374 enum rte_event_dev_xstats_mode mode, uint8_t queue_port_id,
375 const unsigned int ids[], uint64_t values[], unsigned int n);
378 * Resets the statistic values in xstats for the device, based on mode.
380 typedef int (*eventdev_xstats_reset_t)(struct rte_eventdev *dev,
381 enum rte_event_dev_xstats_mode mode,
382 int16_t queue_port_id,
383 const uint32_t ids[],
387 * Get names of extended stats of an event device
390 * Event device pointer
391 * @param xstats_names
392 * Array of name values to be filled in
394 * Number of values in the xstats_names array
396 * When size >= the number of stats, return the number of stat values filled
398 * When size < the number of available stats, return the number of stats
399 * values, and do not fill in any data into xstats_names.
401 typedef int (*eventdev_xstats_get_names_t)(const struct rte_eventdev *dev,
402 enum rte_event_dev_xstats_mode mode, uint8_t queue_port_id,
403 struct rte_event_dev_xstats_name *xstats_names,
404 unsigned int *ids, unsigned int size);
407 * Get value of one stats and optionally return its id
410 * Event device pointer
412 * The name of the stat to retrieve
414 * Pointer to an unsigned int where we store the stat-id for future reference.
415 * This pointer may be null if the id is not required.
417 * The value of the stat, or (uint64_t)-1 if the stat is not found.
418 * If the stat is not found, the id value will be returned as (unsigned)-1,
419 * if id pointer is non-NULL
421 typedef uint64_t (*eventdev_xstats_get_by_name)(const struct rte_eventdev *dev,
422 const char *name, unsigned int *id);
426 * Retrieve the event device's ethdev Rx adapter capabilities for the
427 * specified ethernet port
430 * Event device pointer
433 * Ethernet device pointer
436 * A pointer to memory filled with Rx event adapter capabilities.
439 * - 0: Success, driver provides Rx event adapter capabilities for the
441 * - <0: Error code returned by the driver function.
444 typedef int (*eventdev_eth_rx_adapter_caps_get_t)
445 (const struct rte_eventdev *dev,
446 const struct rte_eth_dev *eth_dev,
449 struct rte_event_eth_rx_adapter_queue_conf *queue_conf;
452 * Add ethernet Rx queues to event device. This callback is invoked if
453 * the caps returned from rte_eventdev_eth_rx_adapter_caps_get(, eth_port_id)
454 * has RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT set.
457 * Event device pointer
460 * Ethernet device pointer
463 * Ethernet device receive queue index
466 * Additional configuration structure
469 * - 0: Success, ethernet receive queue added successfully.
470 * - <0: Error code returned by the driver function.
473 typedef int (*eventdev_eth_rx_adapter_queue_add_t)(
474 const struct rte_eventdev *dev,
475 const struct rte_eth_dev *eth_dev,
477 const struct rte_event_eth_rx_adapter_queue_conf *queue_conf);
480 * Delete ethernet Rx queues from event device. This callback is invoked if
481 * the caps returned from eventdev_eth_rx_adapter_caps_get(, eth_port_id)
482 * has RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT set.
485 * Event device pointer
488 * Ethernet device pointer
491 * Ethernet device receive queue index
494 * - 0: Success, ethernet receive queue deleted successfully.
495 * - <0: Error code returned by the driver function.
498 typedef int (*eventdev_eth_rx_adapter_queue_del_t)
499 (const struct rte_eventdev *dev,
500 const struct rte_eth_dev *eth_dev,
501 int32_t rx_queue_id);
504 * Start ethernet Rx adapter. This callback is invoked if
505 * the caps returned from eventdev_eth_rx_adapter_caps_get(.., eth_port_id)
506 * has RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT set and Rx queues
507 * from eth_port_id have been added to the event device.
510 * Event device pointer
513 * Ethernet device pointer
516 * - 0: Success, ethernet Rx adapter started successfully.
517 * - <0: Error code returned by the driver function.
519 typedef int (*eventdev_eth_rx_adapter_start_t)
520 (const struct rte_eventdev *dev,
521 const struct rte_eth_dev *eth_dev);
524 * Stop ethernet Rx adapter. This callback is invoked if
525 * the caps returned from eventdev_eth_rx_adapter_caps_get(..,eth_port_id)
526 * has RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT set and Rx queues
527 * from eth_port_id have been added to the event device.
530 * Event device pointer
533 * Ethernet device pointer
536 * - 0: Success, ethernet Rx adapter stopped successfully.
537 * - <0: Error code returned by the driver function.
539 typedef int (*eventdev_eth_rx_adapter_stop_t)
540 (const struct rte_eventdev *dev,
541 const struct rte_eth_dev *eth_dev);
543 struct rte_event_eth_rx_adapter_stats *stats;
546 * Retrieve ethernet Rx adapter statistics.
549 * Event device pointer
552 * Ethernet device pointer
555 * Pointer to stats structure
558 * Return 0 on success.
561 typedef int (*eventdev_eth_rx_adapter_stats_get)
562 (const struct rte_eventdev *dev,
563 const struct rte_eth_dev *eth_dev,
564 struct rte_event_eth_rx_adapter_stats *stats);
566 * Reset ethernet Rx adapter statistics.
569 * Event device pointer
572 * Ethernet device pointer
575 * Return 0 on success.
577 typedef int (*eventdev_eth_rx_adapter_stats_reset)
578 (const struct rte_eventdev *dev,
579 const struct rte_eth_dev *eth_dev);
581 * Start eventdev selftest.
584 * Return 0 on success.
586 typedef int (*eventdev_selftest)(void);
588 /** Event device operations function pointer table */
589 struct rte_eventdev_ops {
590 eventdev_info_get_t dev_infos_get; /**< Get device info. */
591 eventdev_configure_t dev_configure; /**< Configure device. */
592 eventdev_start_t dev_start; /**< Start device. */
593 eventdev_stop_t dev_stop; /**< Stop device. */
594 eventdev_close_t dev_close; /**< Close device. */
596 eventdev_queue_default_conf_get_t queue_def_conf;
597 /**< Get default queue configuration. */
598 eventdev_queue_setup_t queue_setup;
599 /**< Set up an event queue. */
600 eventdev_queue_release_t queue_release;
601 /**< Release an event queue. */
603 eventdev_port_default_conf_get_t port_def_conf;
604 /**< Get default port configuration. */
605 eventdev_port_setup_t port_setup;
606 /**< Set up an event port. */
607 eventdev_port_release_t port_release;
608 /**< Release an event port. */
610 eventdev_port_link_t port_link;
611 /**< Link event queues to an event port. */
612 eventdev_port_unlink_t port_unlink;
613 /**< Unlink event queues from an event port. */
614 eventdev_dequeue_timeout_ticks_t timeout_ticks;
615 /**< Converts ns to *timeout_ticks* value for rte_event_dequeue() */
616 eventdev_dump_t dump;
617 /* Dump internal information */
619 eventdev_xstats_get_t xstats_get;
620 /**< Get extended device statistics. */
621 eventdev_xstats_get_names_t xstats_get_names;
622 /**< Get names of extended stats. */
623 eventdev_xstats_get_by_name xstats_get_by_name;
624 /**< Get one value by name. */
625 eventdev_xstats_reset_t xstats_reset;
626 /**< Reset the statistics values in xstats. */
628 eventdev_eth_rx_adapter_caps_get_t eth_rx_adapter_caps_get;
629 /**< Get ethernet Rx adapter capabilities */
630 eventdev_eth_rx_adapter_queue_add_t eth_rx_adapter_queue_add;
631 /**< Add Rx queues to ethernet Rx adapter */
632 eventdev_eth_rx_adapter_queue_del_t eth_rx_adapter_queue_del;
633 /**< Delete Rx queues from ethernet Rx adapter */
634 eventdev_eth_rx_adapter_start_t eth_rx_adapter_start;
635 /**< Start ethernet Rx adapter */
636 eventdev_eth_rx_adapter_stop_t eth_rx_adapter_stop;
637 /**< Stop ethernet Rx adapter */
638 eventdev_eth_rx_adapter_stats_get eth_rx_adapter_stats_get;
639 /**< Get ethernet Rx stats */
640 eventdev_eth_rx_adapter_stats_reset eth_rx_adapter_stats_reset;
641 /**< Reset ethernet Rx stats */
643 eventdev_selftest dev_selftest;
644 /**< Start eventdev Selftest */
648 * Allocates a new eventdev slot for an event device and returns the pointer
649 * to that slot for the driver to use.
652 * Unique identifier name for each device
654 * Socket to allocate resources on.
656 * - Slot in the rte_dev_devices array for a new device;
658 struct rte_eventdev *
659 rte_event_pmd_allocate(const char *name, int socket_id);
662 * Release the specified eventdev device.
665 * The *eventdev* pointer is the address of the *rte_eventdev* structure.
667 * - 0 on success, negative on error
670 rte_event_pmd_release(struct rte_eventdev *eventdev);
676 #endif /* _RTE_EVENTDEV_PMD_H_ */