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 Tx core can handle */
44 #define EVENT_MODE_MAX_ADAPTERS_PER_TX_CORE EVENT_MODE_MAX_TX_ADAPTERS
47 * Packet transfer mode of the application
49 enum eh_pkt_transfer_mode {
50 EH_PKT_TRANSFER_MODE_POLL = 0,
51 EH_PKT_TRANSFER_MODE_EVENT,
54 /* Event dev params */
55 struct eventdev_params {
57 uint8_t nb_eventqueue;
59 uint8_t ev_queue_mode;
63 * Event-lcore link configuration
65 struct eh_event_link_info {
67 /**< Event device ID */
68 uint8_t event_port_id;
71 /**< Event queue to be linked to the port */
73 /**< Lcore to be polling on this port */
76 /* Rx adapter connection info */
77 struct rx_adapter_connection_info {
80 int32_t ethdev_rx_qid;
84 struct rx_adapter_conf {
88 uint8_t nb_connections;
89 struct rx_adapter_connection_info
90 conn[EVENT_MODE_MAX_CONNECTIONS_PER_ADAPTER];
93 /* Tx adapter connection info */
94 struct tx_adapter_connection_info {
96 int32_t ethdev_tx_qid;
100 struct tx_adapter_conf {
104 uint8_t nb_connections;
105 struct tx_adapter_connection_info
106 conn[EVENT_MODE_MAX_CONNECTIONS_PER_TX_ADAPTER];
110 /* Eventmode conf data */
111 struct eventmode_conf {
113 /**< No of event devs */
114 struct eventdev_params eventdev_config[EVENT_MODE_MAX_EVENT_DEVS];
115 /**< Per event dev conf */
116 uint8_t nb_rx_adapter;
117 /**< No of Rx adapters */
118 struct rx_adapter_conf rx_adapter[EVENT_MODE_MAX_RX_ADAPTERS];
119 /**< Rx adapter conf */
120 uint8_t nb_tx_adapter;
121 /**< No of Tx adapters */
122 struct tx_adapter_conf tx_adapter[EVENT_MODE_MAX_TX_ADAPTERS];
123 /** Tx adapter conf */
126 struct eh_event_link_info
127 link[EVENT_MODE_MAX_LCORE_LINKS];
128 /**< Per link conf */
129 struct rte_bitmap *eth_core_mask;
130 /**< Core mask of cores to be used for software Rx and Tx */
131 uint32_t eth_portmask;
132 /**< Mask of the eth ports to be used */
136 uint64_t sched_type : 2;
137 /**< Schedule type */
138 uint64_t all_ev_queue_to_ev_port : 1;
140 * When enabled, all event queues need to be mapped to
146 /**< 64 bit field to specify extended params */
150 * Event helper configuration
153 enum eh_pkt_transfer_mode mode;
154 /**< Packet transfer mode of the application */
155 uint32_t eth_portmask;
157 * Mask of the eth ports to be used. This portmask would be
158 * checked while initializing devices using helper routines.
161 /**< Mode specific parameters */
165 * Initialize event mode devices
167 * Application can call this function to get the event devices, eth devices
168 * and eth rx & tx adapters initialized according to the default config or
169 * config populated using the command line args.
171 * Application is expected to initialize the eth devices and then the event
172 * mode helper subsystem will stop & start eth devices according to its
173 * requirement. Call to this function should be done after the eth devices
174 * are successfully initialized.
177 * Event helper configuration
183 eh_devs_init(struct eh_conf *conf);
186 * Release event mode devices
188 * Application can call this function to release event devices,
189 * eth rx & tx adapters according to the config.
191 * Call to this function should be done before application stops
192 * and closes eth devices. This function will not close and stop
196 * Event helper configuration
202 eh_devs_uninit(struct eh_conf *conf);
205 * Get eventdev tx queue
207 * If the application uses event device which does not support internal port
208 * then it needs to submit the events to a Tx queue before final transmission.
209 * This Tx queue will be created internally by the eventmode helper subsystem,
210 * and application will need its queue ID when it runs the execution loop.
213 * Event helper configuration
220 eh_get_tx_queue(struct eh_conf *conf, uint8_t eventdev_id);
223 * Display event mode configuration
226 * Event helper configuration
229 eh_display_conf(struct eh_conf *conf);
231 #endif /* _EVENT_HELPER_H_ */