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
50 * Packet transfer mode of the application
52 enum eh_pkt_transfer_mode {
53 EH_PKT_TRANSFER_MODE_POLL = 0,
54 EH_PKT_TRANSFER_MODE_EVENT,
58 * Event mode packet rx types
61 EH_RX_TYPE_NON_BURST = 0,
65 /* Event dev params */
66 struct eventdev_params {
68 uint8_t nb_eventqueue;
70 uint8_t ev_queue_mode;
74 * Event-lcore link configuration
76 struct eh_event_link_info {
78 /**< Event device ID */
79 uint8_t event_port_id;
82 /**< Event queue to be linked to the port */
84 /**< Lcore to be polling on this port */
87 /* Rx adapter connection info */
88 struct rx_adapter_connection_info {
91 int32_t ethdev_rx_qid;
95 struct rx_adapter_conf {
99 uint8_t nb_connections;
100 struct rx_adapter_connection_info
101 conn[EVENT_MODE_MAX_CONNECTIONS_PER_ADAPTER];
104 /* Tx adapter connection info */
105 struct tx_adapter_connection_info {
107 int32_t ethdev_tx_qid;
110 /* Tx adapter conf */
111 struct tx_adapter_conf {
115 uint8_t nb_connections;
116 struct tx_adapter_connection_info
117 conn[EVENT_MODE_MAX_CONNECTIONS_PER_TX_ADAPTER];
121 /* Eventmode conf data */
122 struct eventmode_conf {
124 /**< No of event devs */
125 struct eventdev_params eventdev_config[EVENT_MODE_MAX_EVENT_DEVS];
126 /**< Per event dev conf */
127 uint8_t nb_rx_adapter;
128 /**< No of Rx adapters */
129 struct rx_adapter_conf rx_adapter[EVENT_MODE_MAX_RX_ADAPTERS];
130 /**< Rx adapter conf */
131 uint8_t nb_tx_adapter;
132 /**< No of Tx adapters */
133 struct tx_adapter_conf tx_adapter[EVENT_MODE_MAX_TX_ADAPTERS];
134 /** Tx adapter conf */
137 struct eh_event_link_info
138 link[EVENT_MODE_MAX_LCORE_LINKS];
139 /**< Per link conf */
140 struct rte_bitmap *eth_core_mask;
141 /**< Core mask of cores to be used for software Rx and Tx */
142 uint32_t eth_portmask;
143 /**< Mask of the eth ports to be used */
147 uint64_t sched_type : 2;
148 /**< Schedule type */
149 uint64_t all_ev_queue_to_ev_port : 1;
151 * When enabled, all event queues need to be mapped to
157 /**< 64 bit field to specify extended params */
161 * Event helper configuration
164 enum eh_pkt_transfer_mode mode;
165 /**< Packet transfer mode of the application */
166 uint32_t eth_portmask;
168 * Mask of the eth ports to be used. This portmask would be
169 * checked while initializing devices using helper routines.
172 /**< Mode specific parameters */
175 /* Workers registered by the application */
176 struct eh_app_worker_params {
181 /**< Specify status of rx type burst */
185 /**< Capabilities of this worker */
186 void (*worker_thread)(struct eh_event_link_info *links,
188 /**< Worker thread */
192 * Initialize event mode devices
194 * Application can call this function to get the event devices, eth devices
195 * and eth rx & tx adapters initialized according to the default config or
196 * config populated using the command line args.
198 * Application is expected to initialize the eth devices and then the event
199 * mode helper subsystem will stop & start eth devices according to its
200 * requirement. Call to this function should be done after the eth devices
201 * are successfully initialized.
204 * Event helper configuration
210 eh_devs_init(struct eh_conf *conf);
213 * Release event mode devices
215 * Application can call this function to release event devices,
216 * eth rx & tx adapters according to the config.
218 * Call to this function should be done before application stops
219 * and closes eth devices. This function will not close and stop
223 * Event helper configuration
229 eh_devs_uninit(struct eh_conf *conf);
232 * Get eventdev tx queue
234 * If the application uses event device which does not support internal port
235 * then it needs to submit the events to a Tx queue before final transmission.
236 * This Tx queue will be created internally by the eventmode helper subsystem,
237 * and application will need its queue ID when it runs the execution loop.
240 * Event helper configuration
247 eh_get_tx_queue(struct eh_conf *conf, uint8_t eventdev_id);
250 * Display event mode configuration
253 * Event helper configuration
256 eh_display_conf(struct eh_conf *conf);
260 * Launch eventmode worker
262 * The application can request the eventmode helper subsystem to launch the
263 * worker based on the capabilities of event device and the options selected
264 * while initializing the eventmode.
267 * Event helper configuration
269 * List of all the workers registered by application, along with its
271 * @param nb_wrkr_param
272 * Number of workers passed by the application
276 eh_launch_worker(struct eh_conf *conf, struct eh_app_worker_params *app_wrkr,
277 uint8_t nb_wrkr_param);
279 #endif /* _EVENT_HELPER_H_ */