event/octeontx2: add Rx adapter
[dpdk.git] / drivers / event / octeontx2 / otx2_evdev.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(C) 2019 Marvell International Ltd.
3  */
4
5 #ifndef __OTX2_EVDEV_H__
6 #define __OTX2_EVDEV_H__
7
8 #include <rte_eventdev.h>
9 #include <rte_eventdev_pmd.h>
10 #include <rte_event_eth_rx_adapter.h>
11
12 #include "otx2_common.h"
13 #include "otx2_dev.h"
14 #include "otx2_ethdev.h"
15 #include "otx2_mempool.h"
16
17 #define EVENTDEV_NAME_OCTEONTX2_PMD otx2_eventdev
18
19 #define sso_func_trace otx2_sso_dbg
20
21 #define OTX2_SSO_MAX_VHGRP                  RTE_EVENT_MAX_QUEUES_PER_DEV
22 #define OTX2_SSO_MAX_VHWS                   (UINT8_MAX)
23 #define OTX2_SSO_FC_NAME                    "otx2_evdev_xaq_fc"
24 #define OTX2_SSO_XAQ_SLACK                  (8)
25 #define OTX2_SSO_XAQ_CACHE_CNT              (0x7)
26
27 /* SSO LF register offsets (BAR2) */
28 #define SSO_LF_GGRP_OP_ADD_WORK0            (0x0ull)
29 #define SSO_LF_GGRP_OP_ADD_WORK1            (0x8ull)
30
31 #define SSO_LF_GGRP_QCTL                    (0x20ull)
32 #define SSO_LF_GGRP_EXE_DIS                 (0x80ull)
33 #define SSO_LF_GGRP_INT                     (0x100ull)
34 #define SSO_LF_GGRP_INT_W1S                 (0x108ull)
35 #define SSO_LF_GGRP_INT_ENA_W1S             (0x110ull)
36 #define SSO_LF_GGRP_INT_ENA_W1C             (0x118ull)
37 #define SSO_LF_GGRP_INT_THR                 (0x140ull)
38 #define SSO_LF_GGRP_INT_CNT                 (0x180ull)
39 #define SSO_LF_GGRP_XAQ_CNT                 (0x1b0ull)
40 #define SSO_LF_GGRP_AQ_CNT                  (0x1c0ull)
41 #define SSO_LF_GGRP_AQ_THR                  (0x1e0ull)
42 #define SSO_LF_GGRP_MISC_CNT                (0x200ull)
43
44 /* SSOW LF register offsets (BAR2) */
45 #define SSOW_LF_GWS_LINKS                   (0x10ull)
46 #define SSOW_LF_GWS_PENDWQP                 (0x40ull)
47 #define SSOW_LF_GWS_PENDSTATE               (0x50ull)
48 #define SSOW_LF_GWS_NW_TIM                  (0x70ull)
49 #define SSOW_LF_GWS_GRPMSK_CHG              (0x80ull)
50 #define SSOW_LF_GWS_INT                     (0x100ull)
51 #define SSOW_LF_GWS_INT_W1S                 (0x108ull)
52 #define SSOW_LF_GWS_INT_ENA_W1S             (0x110ull)
53 #define SSOW_LF_GWS_INT_ENA_W1C             (0x118ull)
54 #define SSOW_LF_GWS_TAG                     (0x200ull)
55 #define SSOW_LF_GWS_WQP                     (0x210ull)
56 #define SSOW_LF_GWS_SWTP                    (0x220ull)
57 #define SSOW_LF_GWS_PENDTAG                 (0x230ull)
58 #define SSOW_LF_GWS_OP_ALLOC_WE             (0x400ull)
59 #define SSOW_LF_GWS_OP_GET_WORK             (0x600ull)
60 #define SSOW_LF_GWS_OP_SWTAG_FLUSH          (0x800ull)
61 #define SSOW_LF_GWS_OP_SWTAG_UNTAG          (0x810ull)
62 #define SSOW_LF_GWS_OP_SWTP_CLR             (0x820ull)
63 #define SSOW_LF_GWS_OP_UPD_WQP_GRP0         (0x830ull)
64 #define SSOW_LF_GWS_OP_UPD_WQP_GRP1         (0x838ull)
65 #define SSOW_LF_GWS_OP_DESCHED              (0x880ull)
66 #define SSOW_LF_GWS_OP_DESCHED_NOSCH        (0x8c0ull)
67 #define SSOW_LF_GWS_OP_SWTAG_DESCHED        (0x980ull)
68 #define SSOW_LF_GWS_OP_SWTAG_NOSCHED        (0x9c0ull)
69 #define SSOW_LF_GWS_OP_CLR_NSCHED0          (0xa00ull)
70 #define SSOW_LF_GWS_OP_CLR_NSCHED1          (0xa08ull)
71 #define SSOW_LF_GWS_OP_SWTP_SET             (0xc00ull)
72 #define SSOW_LF_GWS_OP_SWTAG_NORM           (0xc10ull)
73 #define SSOW_LF_GWS_OP_SWTAG_FULL0          (0xc20ull)
74 #define SSOW_LF_GWS_OP_SWTAG_FULL1          (0xc28ull)
75 #define SSOW_LF_GWS_OP_GWC_INVAL            (0xe00ull)
76
77 #define OTX2_SSOW_GET_BASE_ADDR(_GW)        ((_GW) - SSOW_LF_GWS_OP_GET_WORK)
78
79 #define NSEC2USEC(__ns)                 ((__ns) / 1E3)
80 #define USEC2NSEC(__us)                 ((__us) * 1E3)
81 #define NSEC2TICK(__ns, __freq)         (((__ns) * (__freq)) / 1E9)
82 #define TICK2NSEC(__tck, __freq)        (((__tck) * 1E9) / (__freq))
83
84 enum otx2_sso_lf_type {
85         SSO_LF_GGRP,
86         SSO_LF_GWS
87 };
88
89 union otx2_sso_event {
90         uint64_t get_work0;
91         struct {
92                 uint32_t flow_id:20;
93                 uint32_t sub_event_type:8;
94                 uint32_t event_type:4;
95                 uint8_t op:2;
96                 uint8_t rsvd:4;
97                 uint8_t sched_type:2;
98                 uint8_t queue_id;
99                 uint8_t priority;
100                 uint8_t impl_opaque;
101         };
102 } __rte_aligned(64);
103
104 enum {
105         SSO_SYNC_ORDERED,
106         SSO_SYNC_ATOMIC,
107         SSO_SYNC_UNTAGGED,
108         SSO_SYNC_EMPTY
109 };
110
111 struct otx2_sso_qos {
112         uint8_t queue;
113         uint8_t xaq_prcnt;
114         uint8_t taq_prcnt;
115         uint8_t iaq_prcnt;
116 };
117
118 struct otx2_sso_evdev {
119         OTX2_DEV; /* Base class */
120         uint8_t max_event_queues;
121         uint8_t max_event_ports;
122         uint8_t is_timeout_deq;
123         uint8_t nb_event_queues;
124         uint8_t nb_event_ports;
125         uint8_t configured;
126         uint32_t deq_tmo_ns;
127         uint32_t min_dequeue_timeout_ns;
128         uint32_t max_dequeue_timeout_ns;
129         int32_t max_num_events;
130         uint64_t *fc_mem;
131         uint64_t xaq_lmt;
132         uint64_t nb_xaq_cfg;
133         rte_iova_t fc_iova;
134         struct rte_mempool *xaq_pool;
135         uint32_t adptr_xae_cnt;
136         /* Dev args */
137         uint8_t dual_ws;
138         uint8_t selftest;
139         uint32_t xae_cnt;
140         uint8_t qos_queue_cnt;
141         struct otx2_sso_qos *qos_parse_data;
142         /* HW const */
143         uint32_t xae_waes;
144         uint32_t xaq_buf_size;
145         uint32_t iue;
146         /* MSIX offsets */
147         uint16_t sso_msixoff[OTX2_SSO_MAX_VHGRP];
148         uint16_t ssow_msixoff[OTX2_SSO_MAX_VHWS];
149 } __rte_cache_aligned;
150
151 #define OTX2_SSOGWS_OPS \
152         /* WS ops */                    \
153         uintptr_t getwrk_op;            \
154         uintptr_t tag_op;               \
155         uintptr_t wqp_op;               \
156         uintptr_t swtp_op;              \
157         uintptr_t swtag_norm_op;        \
158         uintptr_t swtag_desched_op;     \
159         uint8_t cur_tt;                 \
160         uint8_t cur_grp
161
162 /* Event port aka GWS */
163 struct otx2_ssogws {
164         /* Get Work Fastpath data */
165         OTX2_SSOGWS_OPS;
166         uint8_t swtag_req;
167         uint8_t port;
168         /* Add Work Fastpath data */
169         uint64_t xaq_lmt __rte_cache_aligned;
170         uint64_t *fc_mem;
171         uintptr_t grps_base[OTX2_SSO_MAX_VHGRP];
172 } __rte_cache_aligned;
173
174 struct otx2_ssogws_state {
175         OTX2_SSOGWS_OPS;
176 };
177
178 struct otx2_ssogws_dual {
179         /* Get Work Fastpath data */
180         struct otx2_ssogws_state ws_state[2]; /* Ping and Pong */
181         uint8_t swtag_req;
182         uint8_t vws; /* Ping pong bit */
183         uint8_t port;
184         /* Add Work Fastpath data */
185         uint64_t xaq_lmt __rte_cache_aligned;
186         uint64_t *fc_mem;
187         uintptr_t grps_base[OTX2_SSO_MAX_VHGRP];
188 } __rte_cache_aligned;
189
190 static inline struct otx2_sso_evdev *
191 sso_pmd_priv(const struct rte_eventdev *event_dev)
192 {
193         return event_dev->data->dev_private;
194 }
195
196 static inline int
197 parse_kvargs_flag(const char *key, const char *value, void *opaque)
198 {
199         RTE_SET_USED(key);
200
201         *(uint8_t *)opaque = !!atoi(value);
202         return 0;
203 }
204
205 static inline int
206 parse_kvargs_value(const char *key, const char *value, void *opaque)
207 {
208         RTE_SET_USED(key);
209
210         *(uint32_t *)opaque = (uint32_t)atoi(value);
211         return 0;
212 }
213
214 /* Single WS API's */
215 uint16_t otx2_ssogws_enq(void *port, const struct rte_event *ev);
216 uint16_t otx2_ssogws_enq_burst(void *port, const struct rte_event ev[],
217                                uint16_t nb_events);
218 uint16_t otx2_ssogws_enq_new_burst(void *port, const struct rte_event ev[],
219                                    uint16_t nb_events);
220 uint16_t otx2_ssogws_enq_fwd_burst(void *port, const struct rte_event ev[],
221                                    uint16_t nb_events);
222
223 uint16_t otx2_ssogws_deq(void *port, struct rte_event *ev,
224                          uint64_t timeout_ticks);
225 uint16_t otx2_ssogws_deq_burst(void *port, struct rte_event ev[],
226                                uint16_t nb_events, uint64_t timeout_ticks);
227 uint16_t otx2_ssogws_deq_timeout(void *port, struct rte_event *ev,
228                                  uint64_t timeout_ticks);
229 uint16_t otx2_ssogws_deq_timeout_burst(void *port, struct rte_event ev[],
230                                        uint16_t nb_events,
231                                        uint64_t timeout_ticks);
232 /* Dual WS API's */
233 uint16_t otx2_ssogws_dual_enq(void *port, const struct rte_event *ev);
234 uint16_t otx2_ssogws_dual_enq_burst(void *port, const struct rte_event ev[],
235                                     uint16_t nb_events);
236 uint16_t otx2_ssogws_dual_enq_new_burst(void *port, const struct rte_event ev[],
237                                         uint16_t nb_events);
238 uint16_t otx2_ssogws_dual_enq_fwd_burst(void *port, const struct rte_event ev[],
239                                         uint16_t nb_events);
240
241 uint16_t otx2_ssogws_dual_deq(void *port, struct rte_event *ev,
242                               uint64_t timeout_ticks);
243 uint16_t otx2_ssogws_dual_deq_burst(void *port, struct rte_event ev[],
244                                     uint16_t nb_events, uint64_t timeout_ticks);
245 uint16_t otx2_ssogws_dual_deq_timeout(void *port, struct rte_event *ev,
246                                       uint64_t timeout_ticks);
247 uint16_t otx2_ssogws_dual_deq_timeout_burst(void *port, struct rte_event ev[],
248                                             uint16_t nb_events,
249                                             uint64_t timeout_ticks);
250
251 void sso_updt_xae_cnt(struct otx2_sso_evdev *dev, void *data,
252                       uint32_t event_type);
253 int sso_xae_reconfigure(struct rte_eventdev *event_dev);
254 void sso_fastpath_fns_set(struct rte_eventdev *event_dev);
255
256 int otx2_sso_rx_adapter_caps_get(const struct rte_eventdev *event_dev,
257                                  const struct rte_eth_dev *eth_dev,
258                                  uint32_t *caps);
259 int otx2_sso_rx_adapter_queue_add(const struct rte_eventdev *event_dev,
260                                   const struct rte_eth_dev *eth_dev,
261                                   int32_t rx_queue_id,
262                 const struct rte_event_eth_rx_adapter_queue_conf *queue_conf);
263 int otx2_sso_rx_adapter_queue_del(const struct rte_eventdev *event_dev,
264                                   const struct rte_eth_dev *eth_dev,
265                                   int32_t rx_queue_id);
266
267 /* Clean up API's */
268 typedef void (*otx2_handle_event_t)(void *arg, struct rte_event ev);
269 void ssogws_flush_events(struct otx2_ssogws *ws, uint8_t queue_id,
270                          uintptr_t base, otx2_handle_event_t fn, void *arg);
271 void ssogws_reset(struct otx2_ssogws *ws);
272 /* Selftest */
273 int otx2_sso_selftest(void);
274 /* Init and Fini API's */
275 int otx2_sso_init(struct rte_eventdev *event_dev);
276 int otx2_sso_fini(struct rte_eventdev *event_dev);
277 /* IRQ handlers */
278 int sso_register_irqs(const struct rte_eventdev *event_dev);
279 void sso_unregister_irqs(const struct rte_eventdev *event_dev);
280
281 #endif /* __OTX2_EVDEV_H__ */