lib/eventdev/rte_eventdev_core.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2016-2018 Intel Corporation.
   3  * Copyright(C) 2021 Marvell.
   4  * Copyright 2016 NXP
   5  * All rights reserved.
   6  */
   7
   8 #ifndef _RTE_EVENTDEV_CORE_H_
   9 #define _RTE_EVENTDEV_CORE_H_
  10
  11 #ifdef __cplusplus
  12 extern "C" {
  13 #endif
  14
  15 typedef uint16_t (*event_enqueue_t)(void *port, const struct rte_event *ev);
  16 /**< @internal Enqueue event on port of a device */
  17
  18 typedef uint16_t (*event_enqueue_burst_t)(void *port,
  19                                           const struct rte_event ev[],
  20                                           uint16_t nb_events);
  21 /**< @internal Enqueue burst of events on port of a device */
  22
  23 typedef uint16_t (*event_dequeue_t)(void *port, struct rte_event *ev,
  24                                     uint64_t timeout_ticks);
  25 /**< @internal Dequeue event from port of a device */
  26
  27 typedef uint16_t (*event_dequeue_burst_t)(void *port, struct rte_event ev[],
  28                                           uint16_t nb_events,
  29                                           uint64_t timeout_ticks);
  30 /**< @internal Dequeue burst of events from port of a device */
  31
  32 typedef uint16_t (*event_tx_adapter_enqueue_t)(void *port,
  33                                                struct rte_event ev[],
  34                                                uint16_t nb_events);
  35 /**< @internal Enqueue burst of events on port of a device */
  36
  37 typedef uint16_t (*event_crypto_adapter_enqueue_t)(void *port,
  38                                                    struct rte_event ev[],
  39                                                    uint16_t nb_events);
  40 /**< @internal Enqueue burst of events on crypto adapter */
  41
  42 #define RTE_EVENTDEV_NAME_MAX_LEN (64)
  43 /**< @internal Max length of name of event PMD */
  44
  45 /**
  46  * @internal
  47  * The data part, with no function pointers, associated with each device.
  48  *
  49  * This structure is safe to place in shared memory to be common among
  50  * different processes in a multi-process configuration.
  51  */
  52 struct rte_eventdev_data {
  53         int socket_id;
  54         /**< Socket ID where memory is allocated */
  55         uint8_t dev_id;
  56         /**< Device ID for this instance */
  57         uint8_t nb_queues;
  58         /**< Number of event queues. */
  59         uint8_t nb_ports;
  60         /**< Number of event ports. */
  61         void *ports[RTE_EVENT_MAX_PORTS_PER_DEV];
  62         /**< Array of pointers to ports. */
  63         struct rte_event_port_conf ports_cfg[RTE_EVENT_MAX_PORTS_PER_DEV];
  64         /**< Array of port configuration structures. */
  65         struct rte_event_queue_conf queues_cfg[RTE_EVENT_MAX_QUEUES_PER_DEV];
  66         /**< Array of queue configuration structures. */
  67         uint16_t links_map[RTE_EVENT_MAX_PORTS_PER_DEV *
  68                            RTE_EVENT_MAX_QUEUES_PER_DEV];
  69         /**< Memory to store queues to port connections. */
  70         void *dev_private;
  71         /**< PMD-specific private data */
  72         uint32_t event_dev_cap;
  73         /**< Event device capabilities(RTE_EVENT_DEV_CAP_)*/
  74         struct rte_event_dev_config dev_conf;
  75         /**< Configuration applied to device. */
  76         uint8_t service_inited;
  77         /* Service initialization state */
  78         uint32_t service_id;
  79         /* Service ID*/
  80         void *dev_stop_flush_arg;
  81         /**< User-provided argument for event flush function */
  82
  83         RTE_STD_C11
  84         uint8_t dev_started : 1;
  85         /**< Device state: STARTED(1)/STOPPED(0) */
  86
  87         char name[RTE_EVENTDEV_NAME_MAX_LEN];
  88         /**< Unique identifier name */
  89
  90         uint64_t reserved_64s[4]; /**< Reserved for future fields */
  91         void *reserved_ptrs[4];   /**< Reserved for future fields */
  92 } __rte_cache_aligned;
  93
  94 /** @internal The data structure associated with each event device. */
  95 struct rte_eventdev {
  96         event_enqueue_t enqueue;
  97         /**< Pointer to PMD enqueue function. */
  98         event_enqueue_burst_t enqueue_burst;
  99         /**< Pointer to PMD enqueue burst function. */
 100         event_enqueue_burst_t enqueue_new_burst;
 101         /**< Pointer to PMD enqueue burst function(op new variant) */
 102         event_enqueue_burst_t enqueue_forward_burst;
 103         /**< Pointer to PMD enqueue burst function(op forward variant) */
 104         event_dequeue_t dequeue;
 105         /**< Pointer to PMD dequeue function. */
 106         event_dequeue_burst_t dequeue_burst;
 107         /**< Pointer to PMD dequeue burst function. */
 108         event_tx_adapter_enqueue_t txa_enqueue_same_dest;
 109         /**< Pointer to PMD eth Tx adapter burst enqueue function with
 110          * events destined to same Eth port & Tx queue.
 111          */
 112         event_tx_adapter_enqueue_t txa_enqueue;
 113         /**< Pointer to PMD eth Tx adapter enqueue function. */
 114         struct rte_eventdev_data *data;
 115         /**< Pointer to device data */
 116         struct eventdev_ops *dev_ops;
 117         /**< Functions exported by PMD */
 118         struct rte_device *dev;
 119         /**< Device info. supplied by probing */
 120
 121         RTE_STD_C11
 122         uint8_t attached : 1;
 123         /**< Flag indicating the device is attached */
 124
 125         event_crypto_adapter_enqueue_t ca_enqueue;
 126         /**< Pointer to PMD crypto adapter enqueue function. */
 127
 128         uint64_t reserved_64s[4]; /**< Reserved for future fields */
 129         void *reserved_ptrs[3];   /**< Reserved for future fields */
 130 } __rte_cache_aligned;
 131
 132 extern struct rte_eventdev *rte_eventdevs;
 133 /** @internal The pool of rte_eventdev structures. */
 134
 135 #ifdef __cplusplus
 136 }
 137 #endif
 138
 139 #endif /*_RTE_EVENTDEV_CORE_H_*/