1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright (C) 2020 Marvell International Ltd.
4 #ifndef _EVENT_HELPER_H_
5 #define _EVENT_HELPER_H_
9 #define RTE_LOGTYPE_EH RTE_LOGTYPE_USER4
11 #define EH_LOG_ERR(...) \
13 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__ ,) "\n", \
14 __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__ ,)))
16 #define EH_LOG_INFO(...) \
18 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__ ,) "\n", \
19 __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__ ,)))
21 /* Max event devices supported */
22 #define EVENT_MODE_MAX_EVENT_DEVS RTE_EVENT_MAX_DEVS
24 /* Max Rx adapters supported */
25 #define EVENT_MODE_MAX_RX_ADAPTERS RTE_EVENT_MAX_DEVS
27 /* Max Tx adapters supported */
28 #define EVENT_MODE_MAX_TX_ADAPTERS RTE_EVENT_MAX_DEVS
30 /* Max Rx adapter connections */
31 #define EVENT_MODE_MAX_CONNECTIONS_PER_ADAPTER 16
33 /* Max Tx adapter connections */
34 #define EVENT_MODE_MAX_CONNECTIONS_PER_TX_ADAPTER 16
36 /* Max event queues supported per event device */
37 #define EVENT_MODE_MAX_EVENT_QUEUES_PER_DEV RTE_EVENT_MAX_QUEUES_PER_DEV
39 /* Max event-lcore links */
40 #define EVENT_MODE_MAX_LCORE_LINKS \
41 (EVENT_MODE_MAX_EVENT_DEVS * EVENT_MODE_MAX_EVENT_QUEUES_PER_DEV)
43 /* Max adapters that one Rx core can handle */
44 #define EVENT_MODE_MAX_ADAPTERS_PER_RX_CORE EVENT_MODE_MAX_RX_ADAPTERS
46 /* Max adapters that one Tx core can handle */
47 #define EVENT_MODE_MAX_ADAPTERS_PER_TX_CORE EVENT_MODE_MAX_TX_ADAPTERS
49 /* Used to indicate that queue schedule type is not set */
50 #define SCHED_TYPE_NOT_SET 3
53 * Packet transfer mode of the application
55 enum eh_pkt_transfer_mode {
56 EH_PKT_TRANSFER_MODE_POLL = 0,
57 EH_PKT_TRANSFER_MODE_EVENT,
61 * Event mode packet rx types
64 EH_RX_TYPE_NON_BURST = 0,
69 * Event mode packet tx types
72 EH_TX_TYPE_INTERNAL_PORT = 0,
73 EH_TX_TYPE_NO_INTERNAL_PORT
77 * Event mode ipsec mode types
79 enum eh_ipsec_mode_types {
80 EH_IPSEC_MODE_TYPE_APP = 0,
81 EH_IPSEC_MODE_TYPE_DRIVER
84 /* Event dev params */
85 struct eventdev_params {
87 uint8_t nb_eventqueue;
89 uint8_t ev_queue_mode;
90 uint8_t all_internal_ports;
94 * Event-lcore link configuration
96 struct eh_event_link_info {
98 /**< Event device ID */
99 uint8_t event_port_id;
100 /**< Event port ID */
102 /**< Event queue to be linked to the port */
104 /**< Lcore to be polling on this port */
107 /* Rx adapter connection info */
108 struct rx_adapter_connection_info {
111 int32_t ethdev_rx_qid;
114 /* Rx adapter conf */
115 struct rx_adapter_conf {
119 uint8_t nb_connections;
120 struct rx_adapter_connection_info
121 conn[EVENT_MODE_MAX_CONNECTIONS_PER_ADAPTER];
124 /* Tx adapter connection info */
125 struct tx_adapter_connection_info {
127 int32_t ethdev_tx_qid;
130 /* Tx adapter conf */
131 struct tx_adapter_conf {
135 uint8_t nb_connections;
136 struct tx_adapter_connection_info
137 conn[EVENT_MODE_MAX_CONNECTIONS_PER_TX_ADAPTER];
141 /* Eventmode conf data */
142 struct eventmode_conf {
144 /**< No of event devs */
145 struct eventdev_params eventdev_config[EVENT_MODE_MAX_EVENT_DEVS];
146 /**< Per event dev conf */
147 uint8_t nb_rx_adapter;
148 /**< No of Rx adapters */
149 struct rx_adapter_conf rx_adapter[EVENT_MODE_MAX_RX_ADAPTERS];
150 /**< Rx adapter conf */
151 uint8_t nb_tx_adapter;
152 /**< No of Tx adapters */
153 struct tx_adapter_conf tx_adapter[EVENT_MODE_MAX_TX_ADAPTERS];
154 /** Tx adapter conf */
157 struct eh_event_link_info
158 link[EVENT_MODE_MAX_LCORE_LINKS];
159 /**< Per link conf */
160 struct rte_bitmap *eth_core_mask;
161 /**< Core mask of cores to be used for software Rx and Tx */
162 uint32_t eth_portmask;
163 /**< Mask of the eth ports to be used */
167 uint64_t sched_type : 2;
168 /**< Schedule type */
169 uint64_t all_ev_queue_to_ev_port : 1;
171 * When enabled, all event queues need to be mapped to
177 /**< 64 bit field to specify extended params */
181 * Event helper configuration
184 enum eh_pkt_transfer_mode mode;
185 /**< Packet transfer mode of the application */
186 uint32_t eth_portmask;
188 * Mask of the eth ports to be used. This portmask would be
189 * checked while initializing devices using helper routines.
192 /**< Mode specific parameters */
194 /** Application specific params */
195 enum eh_ipsec_mode_types ipsec_mode;
196 /**< Mode of ipsec run */
199 /* Workers registered by the application */
200 struct eh_app_worker_params {
205 /**< Specify status of rx type burst */
206 uint64_t tx_internal_port : 1;
207 /**< Specify whether tx internal port is available */
208 uint64_t ipsec_mode : 1;
209 /**< Specify ipsec processing level */
213 /**< Capabilities of this worker */
214 void (*worker_thread)(struct eh_event_link_info *links,
216 /**< Worker thread */
220 * Allocate memory for event helper configuration and initialize
221 * it with default values.
224 * - pointer to event helper configuration structure on success.
231 * Uninitialize event helper configuration and release its memory
234 * Event helper configuration
237 eh_conf_uninit(struct eh_conf *conf);
240 * Initialize event mode devices
242 * Application can call this function to get the event devices, eth devices
243 * and eth rx & tx adapters initialized according to the default config or
244 * config populated using the command line args.
246 * Application is expected to initialize the eth devices and then the event
247 * mode helper subsystem will stop & start eth devices according to its
248 * requirement. Call to this function should be done after the eth devices
249 * are successfully initialized.
252 * Event helper configuration
258 eh_devs_init(struct eh_conf *conf);
261 * Release event mode devices
263 * Application can call this function to release event devices,
264 * eth rx & tx adapters according to the config.
266 * Call to this function should be done before application stops
267 * and closes eth devices. This function will not close and stop
271 * Event helper configuration
277 eh_devs_uninit(struct eh_conf *conf);
280 * Get eventdev tx queue
282 * If the application uses event device which does not support internal port
283 * then it needs to submit the events to a Tx queue before final transmission.
284 * This Tx queue will be created internally by the eventmode helper subsystem,
285 * and application will need its queue ID when it runs the execution loop.
288 * Event helper configuration
295 eh_get_tx_queue(struct eh_conf *conf, uint8_t eventdev_id);
298 * Display event mode configuration
301 * Event helper configuration
304 eh_display_conf(struct eh_conf *conf);
308 * Launch eventmode worker
310 * The application can request the eventmode helper subsystem to launch the
311 * worker based on the capabilities of event device and the options selected
312 * while initializing the eventmode.
315 * Event helper configuration
317 * List of all the workers registered by application, along with its
319 * @param nb_wrkr_param
320 * Number of workers passed by the application
324 eh_launch_worker(struct eh_conf *conf, struct eh_app_worker_params *app_wrkr,
325 uint8_t nb_wrkr_param);
327 #endif /* _EVENT_HELPER_H_ */