5b8d3ed8c8055892ca70100daf6f54b35c7a8189
[dpdk.git] / drivers / common / octeontx2 / hw / otx2_npc.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(C) 2019 Marvell International Ltd.
3  */
4
5 #ifndef __OTX2_NPC_HW_H__
6 #define __OTX2_NPC_HW_H__
7
8 /* Register offsets */
9
10 #define NPC_AF_CFG                                   (0x0ull)
11 #define NPC_AF_ACTIVE_PC                             (0x10ull)
12 #define NPC_AF_CONST                                 (0x20ull)
13 #define NPC_AF_CONST1                                (0x30ull)
14 #define NPC_AF_BLK_RST                               (0x40ull)
15 #define NPC_AF_MCAM_SCRUB_CTL                        (0xa0ull)
16 #define NPC_AF_KCAM_SCRUB_CTL                        (0xb0ull)
17 #define NPC_AF_KPUX_CFG(a)                           \
18         (0x500ull | (uint64_t)(a) << 3)
19 #define NPC_AF_PCK_CFG                               (0x600ull)
20 #define NPC_AF_PCK_DEF_OL2                           (0x610ull)
21 #define NPC_AF_PCK_DEF_OIP4                          (0x620ull)
22 #define NPC_AF_PCK_DEF_OIP6                          (0x630ull)
23 #define NPC_AF_PCK_DEF_IIP4                          (0x640ull)
24 #define NPC_AF_KEX_LDATAX_FLAGS_CFG(a)               \
25         (0x800ull | (uint64_t)(a) << 3)
26 #define NPC_AF_INTFX_KEX_CFG(a)                      \
27         (0x1010ull | (uint64_t)(a) << 8)
28 #define NPC_AF_PKINDX_ACTION0(a)                     \
29         (0x80000ull | (uint64_t)(a) << 6)
30 #define NPC_AF_PKINDX_ACTION1(a)                     \
31         (0x80008ull | (uint64_t)(a) << 6)
32 #define NPC_AF_PKINDX_CPI_DEFX(a, b)                 \
33         (0x80020ull | (uint64_t)(a) << 6 | (uint64_t)(b) << 3)
34 #define NPC_AF_KPUX_ENTRYX_CAMX(a, b, c)             \
35         (0x100000ull | (uint64_t)(a) << 14 | (uint64_t)(b) << 6 | \
36         (uint64_t)(c) << 3)
37 #define NPC_AF_KPUX_ENTRYX_ACTION0(a, b)             \
38         (0x100020ull | (uint64_t)(a) << 14 | (uint64_t)(b) << 6)
39 #define NPC_AF_KPUX_ENTRYX_ACTION1(a, b)             \
40         (0x100028ull | (uint64_t)(a) << 14 | (uint64_t)(b) << 6)
41 #define NPC_AF_KPUX_ENTRY_DISX(a, b)                 \
42         (0x180000ull | (uint64_t)(a) << 6 | (uint64_t)(b) << 3)
43 #define NPC_AF_CPIX_CFG(a)                           \
44         (0x200000ull | (uint64_t)(a) << 3)
45 #define NPC_AF_INTFX_LIDX_LTX_LDX_CFG(a, b, c, d)    \
46         (0x900000ull | (uint64_t)(a) << 16 | (uint64_t)(b) << 12 | \
47         (uint64_t)(c) << 5 | (uint64_t)(d) << 3)
48 #define NPC_AF_INTFX_LDATAX_FLAGSX_CFG(a, b, c)      \
49         (0x980000ull | (uint64_t)(a) << 16 | (uint64_t)(b) << 12 | \
50         (uint64_t)(c) << 3)
51 #define NPC_AF_MCAMEX_BANKX_CAMX_INTF(a, b, c)       \
52         (0x1000000ull | (uint64_t)(a) << 10 | (uint64_t)(b) << 6 | \
53         (uint64_t)(c) << 3)
54 #define NPC_AF_MCAMEX_BANKX_CAMX_W0(a, b, c)         \
55         (0x1000010ull | (uint64_t)(a) << 10 | (uint64_t)(b) << 6 | \
56         (uint64_t)(c) << 3)
57 #define NPC_AF_MCAMEX_BANKX_CAMX_W1(a, b, c)         \
58         (0x1000020ull | (uint64_t)(a) << 10 | (uint64_t)(b) << 6 | \
59         (uint64_t)(c) << 3)
60 #define NPC_AF_MCAMEX_BANKX_CFG(a, b)                \
61         (0x1800000ull | (uint64_t)(a) << 8 | (uint64_t)(b) << 4)
62 #define NPC_AF_MCAMEX_BANKX_STAT_ACT(a, b)           \
63         (0x1880000ull | (uint64_t)(a) << 8 | (uint64_t)(b) << 4)
64 #define NPC_AF_MATCH_STATX(a)                        \
65         (0x1880008ull | (uint64_t)(a) << 8)
66 #define NPC_AF_INTFX_MISS_STAT_ACT(a)                \
67         (0x1880040ull + (uint64_t)(a) * 0x8)
68 #define NPC_AF_MCAMEX_BANKX_ACTION(a, b)             \
69         (0x1900000ull | (uint64_t)(a) << 8 | (uint64_t)(b) << 4)
70 #define NPC_AF_MCAMEX_BANKX_TAG_ACT(a, b)            \
71         (0x1900008ull | (uint64_t)(a) << 8 | (uint64_t)(b) << 4)
72 #define NPC_AF_INTFX_MISS_ACT(a)                     \
73         (0x1a00000ull | (uint64_t)(a) << 4)
74 #define NPC_AF_INTFX_MISS_TAG_ACT(a)                 \
75         (0x1b00008ull | (uint64_t)(a) << 4)
76 #define NPC_AF_MCAM_BANKX_HITX(a, b)                 \
77         (0x1c80000ull | (uint64_t)(a) << 8 | (uint64_t)(b) << 4)
78 #define NPC_AF_LKUP_CTL                              (0x2000000ull)
79 #define NPC_AF_LKUP_DATAX(a)                         \
80         (0x2000200ull | (uint64_t)(a) << 4)
81 #define NPC_AF_LKUP_RESULTX(a)                       \
82         (0x2000400ull | (uint64_t)(a) << 4)
83 #define NPC_AF_INTFX_STAT(a)                         \
84         (0x2000800ull | (uint64_t)(a) << 4)
85 #define NPC_AF_DBG_CTL                               (0x3000000ull)
86 #define NPC_AF_DBG_STATUS                            (0x3000010ull)
87 #define NPC_AF_KPUX_DBG(a)                           \
88         (0x3000020ull | (uint64_t)(a) << 8)
89 #define NPC_AF_IKPU_ERR_CTL                          (0x3000080ull)
90 #define NPC_AF_KPUX_ERR_CTL(a)                       \
91         (0x30000a0ull | (uint64_t)(a) << 8)
92 #define NPC_AF_MCAM_DBG                              (0x3001000ull)
93 #define NPC_AF_DBG_DATAX(a)                          \
94         (0x3001400ull | (uint64_t)(a) << 4)
95 #define NPC_AF_DBG_RESULTX(a)                        \
96         (0x3001800ull | (uint64_t)(a) << 4)
97
98
99 /* Enum offsets */
100
101 #define NPC_INTF_NIX0_RX    (0x0ull)
102 #define NPC_INTF_NIX0_TX    (0x1ull)
103
104 #define NPC_LKUPOP_PKT      (0x0ull)
105 #define NPC_LKUPOP_KEY      (0x1ull)
106
107 #define NPC_MCAM_KEY_X1     (0x0ull)
108 #define NPC_MCAM_KEY_X2     (0x1ull)
109 #define NPC_MCAM_KEY_X4     (0x2ull)
110
111 enum NPC_ERRLEV_E {
112         NPC_ERRLEV_RE = 0,
113         NPC_ERRLEV_LA = 1,
114         NPC_ERRLEV_LB = 2,
115         NPC_ERRLEV_LC = 3,
116         NPC_ERRLEV_LD = 4,
117         NPC_ERRLEV_LE = 5,
118         NPC_ERRLEV_LF = 6,
119         NPC_ERRLEV_LG = 7,
120         NPC_ERRLEV_LH = 8,
121         NPC_ERRLEV_R9 = 9,
122         NPC_ERRLEV_R10 = 10,
123         NPC_ERRLEV_R11 = 11,
124         NPC_ERRLEV_R12 = 12,
125         NPC_ERRLEV_R13 = 13,
126         NPC_ERRLEV_R14 = 14,
127         NPC_ERRLEV_NIX = 15,
128         NPC_ERRLEV_ENUM_LAST = 16,
129 };
130
131 enum npc_kpu_err_code {
132         NPC_EC_NOERR = 0, /* has to be zero */
133         NPC_EC_UNK,
134         NPC_EC_IH_LENGTH,
135         NPC_EC_EDSA_UNK,
136         NPC_EC_L2_K1,
137         NPC_EC_L2_K2,
138         NPC_EC_L2_K3,
139         NPC_EC_L2_K3_ETYPE_UNK,
140         NPC_EC_L2_K4,
141         NPC_EC_MPLS_2MANY,
142         NPC_EC_MPLS_UNK,
143         NPC_EC_NSH_UNK,
144         NPC_EC_IP_TTL_0,
145         NPC_EC_IP_FRAG_OFFSET_1,
146         NPC_EC_IP_VER,
147         NPC_EC_IP6_HOP_0,
148         NPC_EC_IP6_VER,
149         NPC_EC_TCP_FLAGS_FIN_ONLY,
150         NPC_EC_TCP_FLAGS_ZERO,
151         NPC_EC_TCP_FLAGS_RST_FIN,
152         NPC_EC_TCP_FLAGS_URG_SYN,
153         NPC_EC_TCP_FLAGS_RST_SYN,
154         NPC_EC_TCP_FLAGS_SYN_FIN,
155         NPC_EC_VXLAN,
156         NPC_EC_NVGRE,
157         NPC_EC_GRE,
158         NPC_EC_GRE_VER1,
159         NPC_EC_L4,
160         NPC_EC_OIP4_CSUM,
161         NPC_EC_IIP4_CSUM,
162         NPC_EC_LAST /* has to be the last item */
163 };
164
165 enum NPC_LID_E {
166         NPC_LID_LA = 0,
167         NPC_LID_LB,
168         NPC_LID_LC,
169         NPC_LID_LD,
170         NPC_LID_LE,
171         NPC_LID_LF,
172         NPC_LID_LG,
173         NPC_LID_LH,
174 };
175
176 #define NPC_LT_NA 0
177
178 enum npc_kpu_la_ltype {
179         NPC_LT_LA_8023 = 1,
180         NPC_LT_LA_ETHER,
181         NPC_LT_LA_IH_NIX_ETHER,
182         NPC_LT_LA_IH_8_ETHER,
183         NPC_LT_LA_IH_4_ETHER,
184         NPC_LT_LA_IH_2_ETHER,
185 };
186
187 enum npc_kpu_lb_ltype {
188         NPC_LT_LB_ETAG = 1,
189         NPC_LT_LB_CTAG,
190         NPC_LT_LB_STAG_QINQ,
191         NPC_LT_LB_BTAG,
192         NPC_LT_LB_ITAG,
193         NPC_LT_LB_DSA,
194         NPC_LT_LB_DSA_VLAN,
195         NPC_LT_LB_EDSA,
196         NPC_LT_LB_EDSA_VLAN,
197         NPC_LT_LB_EXDSA,
198         NPC_LT_LB_EXDSA_VLAN,
199 };
200
201 enum npc_kpu_lc_ltype {
202         NPC_LT_LC_IP = 1,
203         NPC_LT_LC_IP_OPT,
204         NPC_LT_LC_IP6,
205         NPC_LT_LC_IP6_EXT,
206         NPC_LT_LC_ARP,
207         NPC_LT_LC_RARP,
208         NPC_LT_LC_MPLS,
209         NPC_LT_LC_NSH,
210         NPC_LT_LC_PTP,
211         NPC_LT_LC_FCOE,
212 };
213
214 /* Don't modify Ltypes upto SCTP, otherwise it will
215  * effect flow tag calculation and thus RSS.
216  */
217 enum npc_kpu_ld_ltype {
218         NPC_LT_LD_TCP = 1,
219         NPC_LT_LD_UDP,
220         NPC_LT_LD_ICMP,
221         NPC_LT_LD_SCTP,
222         NPC_LT_LD_ICMP6,
223         NPC_LT_LD_IGMP = 8,
224         NPC_LT_LD_ESP,
225         NPC_LT_LD_AH,
226         NPC_LT_LD_GRE,
227         NPC_LT_LD_NVGRE,
228         NPC_LT_LD_NSH,
229         NPC_LT_LD_TU_MPLS_IN_NSH,
230         NPC_LT_LD_TU_MPLS_IN_IP,
231 };
232
233 enum npc_kpu_le_ltype {
234         NPC_LT_LE_VXLAN = 1,
235         NPC_LT_LE_GENEVE,
236         NPC_LT_LE_GTPU = 4,
237         NPC_LT_LE_VXLANGPE,
238         NPC_LT_LE_GTPC,
239         NPC_LT_LE_NSH,
240         NPC_LT_LE_TU_MPLS_IN_GRE,
241         NPC_LT_LE_TU_NSH_IN_GRE,
242         NPC_LT_LE_TU_MPLS_IN_UDP,
243 };
244
245 enum npc_kpu_lf_ltype {
246         NPC_LT_LF_TU_ETHER = 1,
247         NPC_LT_LF_TU_PPP,
248         NPC_LT_LF_TU_MPLS_IN_VXLANGPE,
249         NPC_LT_LF_TU_NSH_IN_VXLANGPE,
250         NPC_LT_LF_TU_MPLS_IN_NSH,
251         NPC_LT_LF_TU_3RD_NSH,
252 };
253
254 enum npc_kpu_lg_ltype {
255         NPC_LT_LG_TU_IP = 1,
256         NPC_LT_LG_TU_IP6,
257         NPC_LT_LG_TU_ARP,
258         NPC_LT_LG_TU_ETHER_IN_NSH,
259 };
260
261 /* Don't modify Ltypes upto SCTP, otherwise it will
262  * effect flow tag calculation and thus RSS.
263  */
264 enum npc_kpu_lh_ltype {
265         NPC_LT_LH_TU_TCP = 1,
266         NPC_LT_LH_TU_UDP,
267         NPC_LT_LH_TU_ICMP,
268         NPC_LT_LH_TU_SCTP,
269         NPC_LT_LH_TU_ICMP6,
270         NPC_LT_LH_TU_IGMP = 8,
271         NPC_LT_LH_TU_ESP,
272         NPC_LT_LH_TU_AH,
273 };
274
275 /* Structures definitions */
276 struct npc_kpu_profile_cam {
277         uint8_t state;
278         uint8_t state_mask;
279         uint16_t dp0;
280         uint16_t dp0_mask;
281         uint16_t dp1;
282         uint16_t dp1_mask;
283         uint16_t dp2;
284         uint16_t dp2_mask;
285 };
286
287 struct npc_kpu_profile_action {
288         uint8_t errlev;
289         uint8_t errcode;
290         uint8_t dp0_offset;
291         uint8_t dp1_offset;
292         uint8_t dp2_offset;
293         uint8_t bypass_count;
294         uint8_t parse_done;
295         uint8_t next_state;
296         uint8_t ptr_advance;
297         uint8_t cap_ena;
298         uint8_t lid;
299         uint8_t ltype;
300         uint8_t flags;
301         uint8_t offset;
302         uint8_t mask;
303         uint8_t right;
304         uint8_t shift;
305 };
306
307 struct npc_kpu_profile {
308         int cam_entries;
309         int action_entries;
310         struct npc_kpu_profile_cam *cam;
311         struct npc_kpu_profile_action *action;
312 };
313
314 /* NPC KPU register formats */
315 struct npc_kpu_cam {
316         uint64_t dp0_data       : 16;
317         uint64_t dp1_data       : 16;
318         uint64_t dp2_data       : 16;
319         uint64_t state          : 8;
320         uint64_t rsvd_63_56     : 8;
321 };
322
323 struct npc_kpu_action0 {
324         uint64_t var_len_shift  : 3;
325         uint64_t var_len_right  : 1;
326         uint64_t var_len_mask   : 8;
327         uint64_t var_len_offset : 8;
328         uint64_t ptr_advance    : 8;
329         uint64_t capture_flags  : 8;
330         uint64_t capture_ltype  : 4;
331         uint64_t capture_lid    : 3;
332         uint64_t rsvd_43        : 1;
333         uint64_t next_state     : 8;
334         uint64_t parse_done     : 1;
335         uint64_t capture_ena    : 1;
336         uint64_t byp_count      : 3;
337         uint64_t rsvd_63_57     : 7;
338 };
339
340 struct npc_kpu_action1 {
341         uint64_t dp0_offset     : 8;
342         uint64_t dp1_offset     : 8;
343         uint64_t dp2_offset     : 8;
344         uint64_t errcode        : 8;
345         uint64_t errlev         : 4;
346         uint64_t rsvd_63_36     : 28;
347 };
348
349 struct npc_kpu_pkind_cpi_def {
350         uint64_t cpi_base       : 10;
351         uint64_t rsvd_11_10     : 2;
352         uint64_t add_shift      : 3;
353         uint64_t rsvd_15        : 1;
354         uint64_t add_mask       : 8;
355         uint64_t add_offset     : 8;
356         uint64_t flags_mask     : 8;
357         uint64_t flags_match    : 8;
358         uint64_t ltype_mask     : 4;
359         uint64_t ltype_match    : 4;
360         uint64_t lid            : 3;
361         uint64_t rsvd_62_59     : 4;
362         uint64_t ena            : 1;
363 };
364
365 struct nix_rx_action {
366         uint64_t op      :4;
367         uint64_t pf_func     :16;
368         uint64_t index       :20;
369         uint64_t match_id    :16;
370         uint64_t flow_key_alg    :5;
371         uint64_t rsvd_63_61  :3;
372 };
373
374 struct nix_tx_action {
375         uint64_t        op              :4;
376         uint64_t        rsvd_11_4       :8;
377         uint64_t        index           :20;
378         uint64_t        match_id        :16;
379         uint64_t        rsvd_63_48      :16;
380 };
381
382 /* NPC layer parse information structure */
383 struct npc_layer_info_s {
384         uint32_t lptr       : 8;
385         uint32_t flags      : 8;
386         uint32_t ltype      : 4;
387         uint32_t rsvd_31_20 : 12;
388 };
389
390 /* NPC layer mcam search key extract structure */
391 struct npc_layer_kex_s {
392         uint16_t flags      : 8;
393         uint16_t ltype      : 4;
394         uint16_t rsvd_15_12 : 4;
395 };
396
397 /* NPC mcam search key x1 structure */
398 struct npc_mcam_key_x1_s {
399         uint64_t intf         : 2;
400         uint64_t rsvd_63_2    : 62;
401         uint64_t kw0          : 64;  /* W1 */
402         uint64_t kw1          : 48;
403         uint64_t rsvd_191_176 : 16;
404 };
405
406 /* NPC mcam search key x2 structure */
407 struct npc_mcam_key_x2_s {
408         uint64_t intf         : 2;
409         uint64_t rsvd_63_2    : 62;
410         uint64_t kw0          : 64;  /* W1 */
411         uint64_t kw1          : 64;  /* W2 */
412         uint64_t kw2          : 64;  /* W3 */
413         uint64_t kw3          : 32;
414         uint64_t rsvd_319_288 : 32;
415 };
416
417 /* NPC mcam search key x4 structure */
418 struct npc_mcam_key_x4_s {
419         uint64_t intf      : 2;
420         uint64_t rsvd_63_2 : 62;
421         uint64_t kw0       : 64;     /* W1 */
422         uint64_t kw1       : 64;     /* W2 */
423         uint64_t kw2       : 64;     /* W3 */
424         uint64_t kw3       : 64;     /* W4 */
425         uint64_t kw4       : 64;     /* W5 */
426         uint64_t kw5       : 64;     /* W6 */
427         uint64_t kw6       : 64;     /* W7 */
428 };
429
430 /* NPC parse key extract structure */
431 struct npc_parse_kex_s {
432         uint64_t chan         : 12;
433         uint64_t errlev       : 4;
434         uint64_t errcode      : 8;
435         uint64_t l2m          : 1;
436         uint64_t l2b          : 1;
437         uint64_t l3m          : 1;
438         uint64_t l3b          : 1;
439         uint64_t la           : 12;
440         uint64_t lb           : 12;
441         uint64_t lc           : 12;
442         uint64_t ld           : 12;
443         uint64_t le           : 12;
444         uint64_t lf           : 12;
445         uint64_t lg           : 12;
446         uint64_t lh           : 12;
447         uint64_t rsvd_127_124 : 4;
448 };
449
450 /* NPC result structure */
451 struct npc_result_s {
452         uint64_t intf         : 2;
453         uint64_t pkind        : 6;
454         uint64_t chan         : 12;
455         uint64_t errlev       : 4;
456         uint64_t errcode      : 8;
457         uint64_t l2m          : 1;
458         uint64_t l2b          : 1;
459         uint64_t l3m          : 1;
460         uint64_t l3b          : 1;
461         uint64_t eoh_ptr      : 8;
462         uint64_t rsvd_63_44   : 20;
463         uint64_t action       : 64;  /* W1 */
464         uint64_t vtag_action  : 64;  /* W2 */
465         uint64_t la           : 20;
466         uint64_t lb           : 20;
467         uint64_t lc           : 20;
468         uint64_t rsvd_255_252 : 4;
469         uint64_t ld           : 20;
470         uint64_t le           : 20;
471         uint64_t lf           : 20;
472         uint64_t rsvd_319_316 : 4;
473         uint64_t lg           : 20;
474         uint64_t lh           : 20;
475         uint64_t rsvd_383_360 : 24;
476 };
477
478 #endif /* __OTX2_NPC_HW_H__ */