1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2001-2019
5 #ifndef _ICE_FLEX_TYPE_H_
6 #define _ICE_FLEX_TYPE_H_
8 #define ICE_FV_OFFSET_INVAL 0x1FF
11 /* Extraction Sequence (Field Vector) Table */
14 u16 off; /* Offset within the protocol header */
19 #define ICE_MAX_FV_WORDS 48
21 struct ice_fv_word ew[ICE_MAX_FV_WORDS];
24 /* Package and segment headers and tables */
26 struct ice_pkg_ver format_ver;
32 struct ice_generic_seg_hdr {
33 #define SEGMENT_TYPE_METADATA 0x00000001
34 #define SEGMENT_TYPE_ICE 0x00000010
36 struct ice_pkg_ver seg_ver;
38 char seg_name[ICE_PKG_NAME_SIZE];
41 /* ice specific segment */
51 struct ice_device_id_entry {
52 union ice_device_id device;
53 union ice_device_id sub_device;
57 struct ice_generic_seg_hdr hdr;
58 __le32 device_table_count;
59 struct ice_device_id_entry device_table[1];
62 struct ice_nvm_table {
68 #define ICE_PKG_BUF_SIZE 4096
69 u8 buf[ICE_PKG_BUF_SIZE];
72 struct ice_buf_table {
74 struct ice_buf buf_array[1];
77 /* global metadata specific segment */
78 struct ice_global_metadata_seg {
79 struct ice_generic_seg_hdr hdr;
80 struct ice_pkg_ver pkg_ver;
82 char pkg_name[ICE_PKG_NAME_SIZE];
85 #define ICE_MIN_S_OFF 12
86 #define ICE_MAX_S_OFF 4095
87 #define ICE_MIN_S_SZ 1
88 #define ICE_MAX_S_SZ 4084
90 /* section information */
91 struct ice_section_entry {
97 #define ICE_MIN_S_COUNT 1
98 #define ICE_MAX_S_COUNT 511
99 #define ICE_MIN_S_DATA_END 12
100 #define ICE_MAX_S_DATA_END 4096
102 #define ICE_METADATA_BUF 0x80000000
105 __le16 section_count;
107 struct ice_section_entry section_entry[1];
110 #define ICE_MAX_ENTRIES_IN_BUF(hd_sz, ent_sz) ((ICE_PKG_BUF_SIZE - \
111 sizeof(struct ice_buf_hdr) - (hd_sz)) / (ent_sz))
113 /* ice package section IDs */
114 #define ICE_SID_XLT0_SW 10
115 #define ICE_SID_XLT_KEY_BUILDER_SW 11
116 #define ICE_SID_XLT1_SW 12
117 #define ICE_SID_XLT2_SW 13
118 #define ICE_SID_PROFID_TCAM_SW 14
119 #define ICE_SID_PROFID_REDIR_SW 15
120 #define ICE_SID_FLD_VEC_SW 16
121 #define ICE_SID_CDID_KEY_BUILDER_SW 17
122 #define ICE_SID_CDID_REDIR_SW 18
124 #define ICE_SID_XLT0_ACL 20
125 #define ICE_SID_XLT_KEY_BUILDER_ACL 21
126 #define ICE_SID_XLT1_ACL 22
127 #define ICE_SID_XLT2_ACL 23
128 #define ICE_SID_PROFID_TCAM_ACL 24
129 #define ICE_SID_PROFID_REDIR_ACL 25
130 #define ICE_SID_FLD_VEC_ACL 26
131 #define ICE_SID_CDID_KEY_BUILDER_ACL 27
132 #define ICE_SID_CDID_REDIR_ACL 28
134 #define ICE_SID_XLT0_FD 30
135 #define ICE_SID_XLT_KEY_BUILDER_FD 31
136 #define ICE_SID_XLT1_FD 32
137 #define ICE_SID_XLT2_FD 33
138 #define ICE_SID_PROFID_TCAM_FD 34
139 #define ICE_SID_PROFID_REDIR_FD 35
140 #define ICE_SID_FLD_VEC_FD 36
141 #define ICE_SID_CDID_KEY_BUILDER_FD 37
142 #define ICE_SID_CDID_REDIR_FD 38
144 #define ICE_SID_XLT0_RSS 40
145 #define ICE_SID_XLT_KEY_BUILDER_RSS 41
146 #define ICE_SID_XLT1_RSS 42
147 #define ICE_SID_XLT2_RSS 43
148 #define ICE_SID_PROFID_TCAM_RSS 44
149 #define ICE_SID_PROFID_REDIR_RSS 45
150 #define ICE_SID_FLD_VEC_RSS 46
151 #define ICE_SID_CDID_KEY_BUILDER_RSS 47
152 #define ICE_SID_CDID_REDIR_RSS 48
154 #define ICE_SID_RXPARSER_CAM 50
155 #define ICE_SID_RXPARSER_NOMATCH_CAM 51
156 #define ICE_SID_RXPARSER_IMEM 52
157 #define ICE_SID_RXPARSER_XLT0_BUILDER 53
158 #define ICE_SID_RXPARSER_NODE_PTYPE 54
159 #define ICE_SID_RXPARSER_MARKER_PTYPE 55
160 #define ICE_SID_RXPARSER_BOOST_TCAM 56
161 #define ICE_SID_RXPARSER_PROTO_GRP 57
162 #define ICE_SID_RXPARSER_METADATA_INIT 58
163 #define ICE_SID_RXPARSER_XLT0 59
165 #define ICE_SID_TXPARSER_CAM 60
166 #define ICE_SID_TXPARSER_NOMATCH_CAM 61
167 #define ICE_SID_TXPARSER_IMEM 62
168 #define ICE_SID_TXPARSER_XLT0_BUILDER 63
169 #define ICE_SID_TXPARSER_NODE_PTYPE 64
170 #define ICE_SID_TXPARSER_MARKER_PTYPE 65
171 #define ICE_SID_TXPARSER_BOOST_TCAM 66
172 #define ICE_SID_TXPARSER_PROTO_GRP 67
173 #define ICE_SID_TXPARSER_METADATA_INIT 68
174 #define ICE_SID_TXPARSER_XLT0 69
176 #define ICE_SID_RXPARSER_INIT_REDIR 70
177 #define ICE_SID_TXPARSER_INIT_REDIR 71
178 #define ICE_SID_RXPARSER_MARKER_GRP 72
179 #define ICE_SID_TXPARSER_MARKER_GRP 73
180 #define ICE_SID_RXPARSER_LAST_PROTO 74
181 #define ICE_SID_TXPARSER_LAST_PROTO 75
182 #define ICE_SID_RXPARSER_PG_SPILL 76
183 #define ICE_SID_TXPARSER_PG_SPILL 77
184 #define ICE_SID_RXPARSER_NOMATCH_SPILL 78
185 #define ICE_SID_TXPARSER_NOMATCH_SPILL 79
187 #define ICE_SID_XLT0_PE 80
188 #define ICE_SID_XLT_KEY_BUILDER_PE 81
189 #define ICE_SID_XLT1_PE 82
190 #define ICE_SID_XLT2_PE 83
191 #define ICE_SID_PROFID_TCAM_PE 84
192 #define ICE_SID_PROFID_REDIR_PE 85
193 #define ICE_SID_FLD_VEC_PE 86
194 #define ICE_SID_CDID_KEY_BUILDER_PE 87
195 #define ICE_SID_CDID_REDIR_PE 88
197 /* Label Metadata section IDs */
198 #define ICE_SID_LBL_FIRST 0x80000010
199 #define ICE_SID_LBL_RXPARSER_IMEM 0x80000010
200 #define ICE_SID_LBL_TXPARSER_IMEM 0x80000011
201 #define ICE_SID_LBL_RESERVED_12 0x80000012
202 #define ICE_SID_LBL_RESERVED_13 0x80000013
203 #define ICE_SID_LBL_RXPARSER_MARKER 0x80000014
204 #define ICE_SID_LBL_TXPARSER_MARKER 0x80000015
205 #define ICE_SID_LBL_PTYPE 0x80000016
206 #define ICE_SID_LBL_PROTOCOL_ID 0x80000017
207 #define ICE_SID_LBL_RXPARSER_TMEM 0x80000018
208 #define ICE_SID_LBL_TXPARSER_TMEM 0x80000019
209 #define ICE_SID_LBL_RXPARSER_PG 0x8000001A
210 #define ICE_SID_LBL_TXPARSER_PG 0x8000001B
211 #define ICE_SID_LBL_RXPARSER_M_TCAM 0x8000001C
212 #define ICE_SID_LBL_TXPARSER_M_TCAM 0x8000001D
213 #define ICE_SID_LBL_SW_PROFID_TCAM 0x8000001E
214 #define ICE_SID_LBL_ACL_PROFID_TCAM 0x8000001F
215 #define ICE_SID_LBL_PE_PROFID_TCAM 0x80000020
216 #define ICE_SID_LBL_RSS_PROFID_TCAM 0x80000021
217 #define ICE_SID_LBL_FD_PROFID_TCAM 0x80000022
218 #define ICE_SID_LBL_FLAG 0x80000023
219 #define ICE_SID_LBL_REG 0x80000024
220 #define ICE_SID_LBL_SW_PTG 0x80000025
221 #define ICE_SID_LBL_ACL_PTG 0x80000026
222 #define ICE_SID_LBL_PE_PTG 0x80000027
223 #define ICE_SID_LBL_RSS_PTG 0x80000028
224 #define ICE_SID_LBL_FD_PTG 0x80000029
225 #define ICE_SID_LBL_SW_VSIG 0x8000002A
226 #define ICE_SID_LBL_ACL_VSIG 0x8000002B
227 #define ICE_SID_LBL_PE_VSIG 0x8000002C
228 #define ICE_SID_LBL_RSS_VSIG 0x8000002D
229 #define ICE_SID_LBL_FD_VSIG 0x8000002E
230 #define ICE_SID_LBL_PTYPE_META 0x8000002F
231 #define ICE_SID_LBL_SW_PROFID 0x80000030
232 #define ICE_SID_LBL_ACL_PROFID 0x80000031
233 #define ICE_SID_LBL_PE_PROFID 0x80000032
234 #define ICE_SID_LBL_RSS_PROFID 0x80000033
235 #define ICE_SID_LBL_FD_PROFID 0x80000034
236 #define ICE_SID_LBL_RXPARSER_MARKER_GRP 0x80000035
237 #define ICE_SID_LBL_TXPARSER_MARKER_GRP 0x80000036
238 #define ICE_SID_LBL_RXPARSER_PROTO 0x80000037
239 #define ICE_SID_LBL_TXPARSER_PROTO 0x80000038
240 /* The following define MUST be updated to reflect the last label section ID */
241 #define ICE_SID_LBL_LAST 0x80000038
265 /* Packet Type (PTYPE) values */
266 #define ICE_PTYPE_MAC_PAY 1
267 #define ICE_PTYPE_IPV4FRAG_PAY 22
268 #define ICE_PTYPE_IPV4_PAY 23
269 #define ICE_PTYPE_IPV4_UDP_PAY 24
270 #define ICE_PTYPE_IPV4_TCP_PAY 26
271 #define ICE_PTYPE_IPV4_SCTP_PAY 27
272 #define ICE_PTYPE_IPV4_ICMP_PAY 28
273 #define ICE_PTYPE_IPV6FRAG_PAY 88
274 #define ICE_PTYPE_IPV6_PAY 89
275 #define ICE_PTYPE_IPV6_UDP_PAY 90
276 #define ICE_PTYPE_IPV6_TCP_PAY 92
277 #define ICE_PTYPE_IPV6_SCTP_PAY 93
278 #define ICE_PTYPE_IPV6_ICMP_PAY 94
280 /* Packet Type Groups (PTG) - Inner Most fields (IM) */
281 #define ICE_PTG_IM_IPV4_TCP 16
282 #define ICE_PTG_IM_IPV4_UDP 17
283 #define ICE_PTG_IM_IPV4_SCTP 18
284 #define ICE_PTG_IM_IPV4_PAY 20
285 #define ICE_PTG_IM_IPV4_OTHER 21
286 #define ICE_PTG_IM_IPV6_TCP 32
287 #define ICE_PTG_IM_IPV6_UDP 33
288 #define ICE_PTG_IM_IPV6_SCTP 34
289 #define ICE_PTG_IM_IPV6_OTHER 37
290 #define ICE_PTG_IM_L2_OTHER 67
292 struct ice_flex_fields {
297 u8 flow_label; /* valid for IPv6 only */
315 u8 flow_label; /* valid for IPv6 only */
326 #define ICE_XLT1_DFLT_GRP 0
327 #define ICE_XLT1_TABLE_SIZE 1024
332 #define ICE_PKG_LABEL_SIZE 64
333 char name[ICE_PKG_LABEL_SIZE];
336 struct ice_label_section {
338 struct ice_label label[1];
341 #define ICE_MAX_LABELS_IN_BUF ICE_MAX_ENTRIES_IN_BUF( \
342 sizeof(struct ice_label_section) - sizeof(struct ice_label), \
343 sizeof(struct ice_label))
345 struct ice_sw_fv_section {
351 struct ice_sw_fv_list_entry {
352 struct LIST_ENTRY_TYPE list_entry;
354 struct ice_fv *fv_ptr;
358 /* The BOOST TCAM stores the match packet header in reverse order, meaning
359 * the fields are reversed; in addition, this means that the normally big endian
360 * fields of the packet are now little endian.
362 struct ice_boost_key_value {
363 #define ICE_BOOST_REMAINING_HV_KEY 15
364 u8 remaining_hv_key[ICE_BOOST_REMAINING_HV_KEY];
365 __le16 hv_dst_port_key;
366 __le16 hv_src_port_key;
371 struct ice_boost_key {
372 struct ice_boost_key_value key;
373 struct ice_boost_key_value key2;
376 /* package Boost TCAM entry */
377 struct ice_boost_tcam_entry {
380 /* break up the 40 bytes of key into different fields */
381 struct ice_boost_key key;
382 u8 boost_hit_index_group;
383 /* The following contains bitfields which are not on byte boundaries.
384 * These fields are currently unused by driver software.
386 #define ICE_BOOST_BIT_FIELDS 43
387 u8 bit_fields[ICE_BOOST_BIT_FIELDS];
390 struct ice_boost_tcam_section {
393 struct ice_boost_tcam_entry tcam[1];
396 #define ICE_MAX_BST_TCAMS_IN_BUF ICE_MAX_ENTRIES_IN_BUF( \
397 sizeof(struct ice_boost_tcam_section) - \
398 sizeof(struct ice_boost_tcam_entry), \
399 sizeof(struct ice_boost_tcam_entry))
402 struct ice_xlt1_section {
409 #define ICE_XLT1_SIZE(n) (sizeof(struct ice_xlt1_section) + \
410 (sizeof(u8) * ((n) - 1)))
412 struct ice_xlt2_section {
418 #define ICE_XLT2_SIZE(n) (sizeof(struct ice_xlt2_section) + \
419 (sizeof(u16) * ((n) - 1)))
421 struct ice_prof_redir_section {
427 #define ICE_PROF_REDIR_SIZE(n) (sizeof(struct ice_prof_redir_section) + \
428 (sizeof(u8) * ((n) - 1)))
430 /* package buffer building */
432 struct ice_buf_build {
434 u16 reserved_section_table_entries;
437 struct ice_pkg_enum {
438 struct ice_buf_table *buf_table;
442 struct ice_buf_hdr *buf;
448 void *(*handler)(u32 sect_type, void *section, u32 index, u32 *offset);
451 /* Tunnel enabling */
453 enum ice_tunnel_type {
460 struct ice_tunnel_type_scan {
461 enum ice_tunnel_type type;
462 const char *label_prefix;
465 struct ice_tunnel_entry {
466 enum ice_tunnel_type type;
469 struct ice_boost_tcam_entry *boost_entry;
475 #define ICE_TUNNEL_MAX_ENTRIES 16
477 struct ice_tunnel_table {
478 struct ice_tunnel_entry tbl[ICE_TUNNEL_MAX_ENTRIES];
485 struct ice_fv_word es[1];
493 struct LIST_HEAD_TYPE prof_map;
494 struct ice_fv_word *t;
495 struct ice_lock prof_map_lock; /* protect access to profiles list */
497 u8 reverse; /* set to true to reverse FV order */
500 /* PTYPE Group management */
502 /* Note: XLT1 table takes 13-bit as input, and results in an 8-bit packet type
503 * group (PTG) ID as output.
505 * Note: PTG 0 is the default packet type group and it is assumed that all PTYPE
506 * are a part of this group until moved to a new PTG.
508 #define ICE_DEFAULT_PTG 0
510 struct ice_ptg_entry {
511 struct ice_ptg_ptype *first_ptype;
515 struct ice_ptg_ptype {
516 struct ice_ptg_ptype *next_ptype;
520 #define ICE_MAX_TCAM_PER_PROFILE 8
521 #define ICE_MAX_PTYPE_PER_PROFILE 8
523 struct ice_prof_map {
524 struct LIST_ENTRY_TYPE list;
529 u8 ptype[ICE_MAX_PTYPE_PER_PROFILE];
532 #define ICE_INVALID_TCAM 0xFFFF
534 struct ice_tcam_inf {
541 struct ice_vsig_prof {
542 struct LIST_ENTRY_TYPE list;
546 struct ice_tcam_inf tcam[ICE_MAX_TCAM_PER_PROFILE];
549 struct ice_vsig_entry {
550 struct LIST_HEAD_TYPE prop_lst;
551 struct ice_vsig_vsi *first_vsi;
555 struct ice_vsig_vsi {
556 struct ice_vsig_vsi *next_vsi;
562 #define ICE_XLT1_CNT 1024
563 #define ICE_MAX_PTGS 256
567 struct ice_ptg_entry *ptg_tbl;
568 struct ice_ptg_ptype *ptypes;
574 #define ICE_XLT2_CNT 768
575 #define ICE_MAX_VSIGS 768
578 * [0:12]: incremental vsig index 1 to ICE_MAX_VSIGS
579 * [13:15]: pf number of device
581 #define ICE_VSIG_IDX_M (0x1FFF)
582 #define ICE_PF_NUM_S 13
583 #define ICE_PF_NUM_M (0x07 << ICE_PF_NUM_S)
584 #define ICE_VSIG_VALUE(vsig, pf_id) \
585 (u16)((((u16)(vsig)) & ICE_VSIG_IDX_M) | \
586 (((u16)(pf_id) << ICE_PF_NUM_S) & ICE_PF_NUM_M))
587 #define ICE_DEFAULT_VSIG 0
591 struct ice_vsig_entry *vsig_tbl;
592 struct ice_vsig_vsi *vsis;
598 /* Extraction sequence - list of match fields:
599 * protocol ID, offset, profile length
601 union ice_match_fld {
606 u8 reserved; /* must be zero */
611 #define ICE_MATCH_LIST_SZ 20
615 union ice_match_fld list[ICE_MATCH_LIST_SZ];
618 /* Profile ID Management */
619 struct ice_prof_id_key {
625 /* Keys are made up of two values, each one-half the size of the key.
626 * For TCAM, the entire key is 80 bits wide (or 2, 40-bit wide values)
628 #define ICE_TCAM_KEY_VAL_SZ 5
629 #define ICE_TCAM_KEY_SZ (2 * ICE_TCAM_KEY_VAL_SZ)
631 struct ice_prof_tcam_entry {
633 u8 key[ICE_TCAM_KEY_SZ];
637 struct ice_prof_id_section {
639 struct ice_prof_tcam_entry entry[1];
643 struct ice_prof_tcam {
647 struct ice_prof_tcam_entry *t;
648 u8 cdid_bits; /* # cdid bits to use in key, 0, 2, 4, or 8 */
651 struct ice_prof_redir {
657 /* Tables per block */
658 struct ice_blk_info {
659 struct ice_xlt1 xlt1;
660 struct ice_xlt2 xlt2;
661 struct ice_prof_tcam prof;
662 struct ice_prof_redir prof_redir;
664 u8 overwrite; /* set to true to allow overwrite of table entries */
678 struct LIST_ENTRY_TYPE list_entry;
679 enum ice_chg_type type;
694 #define ICE_FLOW_PTYPE_MAX ICE_XLT1_CNT
696 #endif /* _ICE_FLEX_TYPE_H_ */