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 */
20 #define ICE_MAX_FV_WORDS 48
22 struct ice_fv_word ew[ICE_MAX_FV_WORDS];
25 /* Package and segment headers and tables */
27 struct ice_pkg_ver format_ver;
33 struct ice_generic_seg_hdr {
34 #define SEGMENT_TYPE_METADATA 0x00000001
35 #define SEGMENT_TYPE_ICE 0x00000010
37 struct ice_pkg_ver seg_ver;
39 char seg_name[ICE_PKG_NAME_SIZE];
42 /* ice specific segment */
52 struct ice_device_id_entry {
53 union ice_device_id device;
54 union ice_device_id sub_device;
58 struct ice_generic_seg_hdr hdr;
59 __le32 device_table_count;
60 struct ice_device_id_entry device_table[1];
63 struct ice_nvm_table {
69 #define ICE_PKG_BUF_SIZE 4096
70 u8 buf[ICE_PKG_BUF_SIZE];
73 struct ice_buf_table {
75 struct ice_buf buf_array[1];
78 /* global metadata specific segment */
79 struct ice_global_metadata_seg {
80 struct ice_generic_seg_hdr hdr;
81 struct ice_pkg_ver pkg_ver;
83 char pkg_name[ICE_PKG_NAME_SIZE];
86 #define ICE_MIN_S_OFF 12
87 #define ICE_MAX_S_OFF 4095
88 #define ICE_MIN_S_SZ 1
89 #define ICE_MAX_S_SZ 4084
91 /* section information */
92 struct ice_section_entry {
98 #define ICE_MIN_S_COUNT 1
99 #define ICE_MAX_S_COUNT 511
100 #define ICE_MIN_S_DATA_END 12
101 #define ICE_MAX_S_DATA_END 4096
103 #define ICE_METADATA_BUF 0x80000000
106 __le16 section_count;
108 struct ice_section_entry section_entry[1];
111 #define ICE_MAX_ENTRIES_IN_BUF(hd_sz, ent_sz) ((ICE_PKG_BUF_SIZE - \
112 sizeof(struct ice_buf_hdr) - (hd_sz)) / (ent_sz))
114 /* ice package section IDs */
115 #define ICE_SID_XLT0_SW 10
116 #define ICE_SID_XLT_KEY_BUILDER_SW 11
117 #define ICE_SID_XLT1_SW 12
118 #define ICE_SID_XLT2_SW 13
119 #define ICE_SID_PROFID_TCAM_SW 14
120 #define ICE_SID_PROFID_REDIR_SW 15
121 #define ICE_SID_FLD_VEC_SW 16
122 #define ICE_SID_CDID_KEY_BUILDER_SW 17
123 #define ICE_SID_CDID_REDIR_SW 18
125 #define ICE_SID_XLT0_ACL 20
126 #define ICE_SID_XLT_KEY_BUILDER_ACL 21
127 #define ICE_SID_XLT1_ACL 22
128 #define ICE_SID_XLT2_ACL 23
129 #define ICE_SID_PROFID_TCAM_ACL 24
130 #define ICE_SID_PROFID_REDIR_ACL 25
131 #define ICE_SID_FLD_VEC_ACL 26
132 #define ICE_SID_CDID_KEY_BUILDER_ACL 27
133 #define ICE_SID_CDID_REDIR_ACL 28
135 #define ICE_SID_XLT0_FD 30
136 #define ICE_SID_XLT_KEY_BUILDER_FD 31
137 #define ICE_SID_XLT1_FD 32
138 #define ICE_SID_XLT2_FD 33
139 #define ICE_SID_PROFID_TCAM_FD 34
140 #define ICE_SID_PROFID_REDIR_FD 35
141 #define ICE_SID_FLD_VEC_FD 36
142 #define ICE_SID_CDID_KEY_BUILDER_FD 37
143 #define ICE_SID_CDID_REDIR_FD 38
145 #define ICE_SID_XLT0_RSS 40
146 #define ICE_SID_XLT_KEY_BUILDER_RSS 41
147 #define ICE_SID_XLT1_RSS 42
148 #define ICE_SID_XLT2_RSS 43
149 #define ICE_SID_PROFID_TCAM_RSS 44
150 #define ICE_SID_PROFID_REDIR_RSS 45
151 #define ICE_SID_FLD_VEC_RSS 46
152 #define ICE_SID_CDID_KEY_BUILDER_RSS 47
153 #define ICE_SID_CDID_REDIR_RSS 48
155 #define ICE_SID_RXPARSER_CAM 50
156 #define ICE_SID_RXPARSER_NOMATCH_CAM 51
157 #define ICE_SID_RXPARSER_IMEM 52
158 #define ICE_SID_RXPARSER_XLT0_BUILDER 53
159 #define ICE_SID_RXPARSER_NODE_PTYPE 54
160 #define ICE_SID_RXPARSER_MARKER_PTYPE 55
161 #define ICE_SID_RXPARSER_BOOST_TCAM 56
162 #define ICE_SID_RXPARSER_PROTO_GRP 57
163 #define ICE_SID_RXPARSER_METADATA_INIT 58
164 #define ICE_SID_RXPARSER_XLT0 59
166 #define ICE_SID_TXPARSER_CAM 60
167 #define ICE_SID_TXPARSER_NOMATCH_CAM 61
168 #define ICE_SID_TXPARSER_IMEM 62
169 #define ICE_SID_TXPARSER_XLT0_BUILDER 63
170 #define ICE_SID_TXPARSER_NODE_PTYPE 64
171 #define ICE_SID_TXPARSER_MARKER_PTYPE 65
172 #define ICE_SID_TXPARSER_BOOST_TCAM 66
173 #define ICE_SID_TXPARSER_PROTO_GRP 67
174 #define ICE_SID_TXPARSER_METADATA_INIT 68
175 #define ICE_SID_TXPARSER_XLT0 69
177 #define ICE_SID_RXPARSER_INIT_REDIR 70
178 #define ICE_SID_TXPARSER_INIT_REDIR 71
179 #define ICE_SID_RXPARSER_MARKER_GRP 72
180 #define ICE_SID_TXPARSER_MARKER_GRP 73
181 #define ICE_SID_RXPARSER_LAST_PROTO 74
182 #define ICE_SID_TXPARSER_LAST_PROTO 75
183 #define ICE_SID_RXPARSER_PG_SPILL 76
184 #define ICE_SID_TXPARSER_PG_SPILL 77
185 #define ICE_SID_RXPARSER_NOMATCH_SPILL 78
186 #define ICE_SID_TXPARSER_NOMATCH_SPILL 79
188 #define ICE_SID_XLT0_PE 80
189 #define ICE_SID_XLT_KEY_BUILDER_PE 81
190 #define ICE_SID_XLT1_PE 82
191 #define ICE_SID_XLT2_PE 83
192 #define ICE_SID_PROFID_TCAM_PE 84
193 #define ICE_SID_PROFID_REDIR_PE 85
194 #define ICE_SID_FLD_VEC_PE 86
195 #define ICE_SID_CDID_KEY_BUILDER_PE 87
196 #define ICE_SID_CDID_REDIR_PE 88
198 /* Label Metadata section IDs */
199 #define ICE_SID_LBL_FIRST 0x80000010
200 #define ICE_SID_LBL_RXPARSER_IMEM 0x80000010
201 #define ICE_SID_LBL_TXPARSER_IMEM 0x80000011
202 #define ICE_SID_LBL_RESERVED_12 0x80000012
203 #define ICE_SID_LBL_RESERVED_13 0x80000013
204 #define ICE_SID_LBL_RXPARSER_MARKER 0x80000014
205 #define ICE_SID_LBL_TXPARSER_MARKER 0x80000015
206 #define ICE_SID_LBL_PTYPE 0x80000016
207 #define ICE_SID_LBL_PROTOCOL_ID 0x80000017
208 #define ICE_SID_LBL_RXPARSER_TMEM 0x80000018
209 #define ICE_SID_LBL_TXPARSER_TMEM 0x80000019
210 #define ICE_SID_LBL_RXPARSER_PG 0x8000001A
211 #define ICE_SID_LBL_TXPARSER_PG 0x8000001B
212 #define ICE_SID_LBL_RXPARSER_M_TCAM 0x8000001C
213 #define ICE_SID_LBL_TXPARSER_M_TCAM 0x8000001D
214 #define ICE_SID_LBL_SW_PROFID_TCAM 0x8000001E
215 #define ICE_SID_LBL_ACL_PROFID_TCAM 0x8000001F
216 #define ICE_SID_LBL_PE_PROFID_TCAM 0x80000020
217 #define ICE_SID_LBL_RSS_PROFID_TCAM 0x80000021
218 #define ICE_SID_LBL_FD_PROFID_TCAM 0x80000022
219 #define ICE_SID_LBL_FLAG 0x80000023
220 #define ICE_SID_LBL_REG 0x80000024
221 #define ICE_SID_LBL_SW_PTG 0x80000025
222 #define ICE_SID_LBL_ACL_PTG 0x80000026
223 #define ICE_SID_LBL_PE_PTG 0x80000027
224 #define ICE_SID_LBL_RSS_PTG 0x80000028
225 #define ICE_SID_LBL_FD_PTG 0x80000029
226 #define ICE_SID_LBL_SW_VSIG 0x8000002A
227 #define ICE_SID_LBL_ACL_VSIG 0x8000002B
228 #define ICE_SID_LBL_PE_VSIG 0x8000002C
229 #define ICE_SID_LBL_RSS_VSIG 0x8000002D
230 #define ICE_SID_LBL_FD_VSIG 0x8000002E
231 #define ICE_SID_LBL_PTYPE_META 0x8000002F
232 #define ICE_SID_LBL_SW_PROFID 0x80000030
233 #define ICE_SID_LBL_ACL_PROFID 0x80000031
234 #define ICE_SID_LBL_PE_PROFID 0x80000032
235 #define ICE_SID_LBL_RSS_PROFID 0x80000033
236 #define ICE_SID_LBL_FD_PROFID 0x80000034
237 #define ICE_SID_LBL_RXPARSER_MARKER_GRP 0x80000035
238 #define ICE_SID_LBL_TXPARSER_MARKER_GRP 0x80000036
239 #define ICE_SID_LBL_RXPARSER_PROTO 0x80000037
240 #define ICE_SID_LBL_TXPARSER_PROTO 0x80000038
241 /* The following define MUST be updated to reflect the last label section ID */
242 #define ICE_SID_LBL_LAST 0x80000038
266 /* Packet Type (PTYPE) values */
267 #define ICE_PTYPE_MAC_PAY 1
268 #define ICE_PTYPE_IPV4FRAG_PAY 22
269 #define ICE_PTYPE_IPV4_PAY 23
270 #define ICE_PTYPE_IPV4_UDP_PAY 24
271 #define ICE_PTYPE_IPV4_TCP_PAY 26
272 #define ICE_PTYPE_IPV4_SCTP_PAY 27
273 #define ICE_PTYPE_IPV4_ICMP_PAY 28
274 #define ICE_PTYPE_IPV6FRAG_PAY 88
275 #define ICE_PTYPE_IPV6_PAY 89
276 #define ICE_PTYPE_IPV6_UDP_PAY 90
277 #define ICE_PTYPE_IPV6_TCP_PAY 92
278 #define ICE_PTYPE_IPV6_SCTP_PAY 93
279 #define ICE_PTYPE_IPV6_ICMP_PAY 94
281 /* Packet Type Groups (PTG) - Inner Most fields (IM) */
282 #define ICE_PTG_IM_IPV4_TCP 16
283 #define ICE_PTG_IM_IPV4_UDP 17
284 #define ICE_PTG_IM_IPV4_SCTP 18
285 #define ICE_PTG_IM_IPV4_PAY 20
286 #define ICE_PTG_IM_IPV4_OTHER 21
287 #define ICE_PTG_IM_IPV6_TCP 32
288 #define ICE_PTG_IM_IPV6_UDP 33
289 #define ICE_PTG_IM_IPV6_SCTP 34
290 #define ICE_PTG_IM_IPV6_OTHER 37
291 #define ICE_PTG_IM_L2_OTHER 67
293 struct ice_flex_fields {
298 u8 flow_label; /* valid for IPv6 only */
316 u8 flow_label; /* valid for IPv6 only */
327 #define ICE_XLT1_DFLT_GRP 0
328 #define ICE_XLT1_TABLE_SIZE 1024
333 #define ICE_PKG_LABEL_SIZE 64
334 char name[ICE_PKG_LABEL_SIZE];
337 struct ice_label_section {
339 struct ice_label label[1];
342 #define ICE_MAX_LABELS_IN_BUF ICE_MAX_ENTRIES_IN_BUF( \
343 sizeof(struct ice_label_section) - sizeof(struct ice_label), \
344 sizeof(struct ice_label))
346 struct ice_sw_fv_section {
352 struct ice_sw_fv_list_entry {
353 struct LIST_ENTRY_TYPE list_entry;
355 struct ice_fv *fv_ptr;
359 /* The BOOST TCAM stores the match packet header in reverse order, meaning
360 * the fields are reversed; in addition, this means that the normally big endian
361 * fields of the packet are now little endian.
363 struct ice_boost_key_value {
364 #define ICE_BOOST_REMAINING_HV_KEY 15
365 u8 remaining_hv_key[ICE_BOOST_REMAINING_HV_KEY];
366 __le16 hv_dst_port_key;
367 __le16 hv_src_port_key;
373 struct ice_boost_key {
374 struct ice_boost_key_value key;
375 struct ice_boost_key_value key2;
378 /* package Boost TCAM entry */
379 struct ice_boost_tcam_entry {
382 /* break up the 40 bytes of key into different fields */
383 struct ice_boost_key key;
384 u8 boost_hit_index_group;
385 /* The following contains bitfields which are not on byte boundaries.
386 * These fields are currently unused by driver software.
388 #define ICE_BOOST_BIT_FIELDS 43
389 u8 bit_fields[ICE_BOOST_BIT_FIELDS];
392 struct ice_boost_tcam_section {
395 struct ice_boost_tcam_entry tcam[1];
398 #define ICE_MAX_BST_TCAMS_IN_BUF ICE_MAX_ENTRIES_IN_BUF( \
399 sizeof(struct ice_boost_tcam_section) - \
400 sizeof(struct ice_boost_tcam_entry), \
401 sizeof(struct ice_boost_tcam_entry))
404 struct ice_xlt1_section {
412 #define ICE_XLT1_SIZE(n) (sizeof(struct ice_xlt1_section) + \
413 (sizeof(u8) * ((n) - 1)))
415 struct ice_xlt2_section {
421 #define ICE_XLT2_SIZE(n) (sizeof(struct ice_xlt2_section) + \
422 (sizeof(u16) * ((n) - 1)))
424 struct ice_prof_redir_section {
430 #define ICE_PROF_REDIR_SIZE(n) (sizeof(struct ice_prof_redir_section) + \
431 (sizeof(u8) * ((n) - 1)))
433 /* package buffer building */
435 struct ice_buf_build {
437 u16 reserved_section_table_entries;
440 struct ice_pkg_enum {
441 struct ice_buf_table *buf_table;
445 struct ice_buf_hdr *buf;
451 void *(*handler)(u32 sect_type, void *section, u32 index, u32 *offset);
454 /* Tunnel enabling */
456 enum ice_tunnel_type {
473 struct ice_tunnel_type_scan {
474 enum ice_tunnel_type type;
475 const char *label_prefix;
478 struct ice_tunnel_entry {
479 enum ice_tunnel_type type;
485 struct ice_boost_tcam_entry *boost_entry;
488 #define ICE_TUNNEL_MAX_ENTRIES 16
490 struct ice_tunnel_table {
492 struct ice_tunnel_entry tbl[ICE_TUNNEL_MAX_ENTRIES];
498 struct ice_fv_word es[1];
507 u8 reverse; /* set to true to reverse FV order */
508 struct LIST_HEAD_TYPE prof_map;
509 struct ice_fv_word *t;
512 /* PTYPE Group management */
514 /* Note: XLT1 table takes 13-bit as input, and results in an 8-bit packet type
515 * group (PTG) ID as output.
517 * Note: PTG 0 is the default packet type group and it is assumed that all PTYPE
518 * are a part of this group until moved to a new PTG.
520 #define ICE_DEFAULT_PTG 0
522 struct ice_ptg_entry {
524 struct ice_ptg_ptype *first_ptype;
527 struct ice_ptg_ptype {
529 struct ice_ptg_ptype *next_ptype;
532 #define ICE_MAX_TCAM_PER_PROFILE 8
533 #define ICE_MAX_PTYPE_PER_PROFILE 8
535 struct ice_prof_map {
536 struct LIST_ENTRY_TYPE list;
541 u8 ptype[ICE_MAX_PTYPE_PER_PROFILE];
544 #define ICE_INVALID_TCAM 0xFFFF
546 struct ice_tcam_inf {
553 struct ice_vsig_prof {
554 struct LIST_ENTRY_TYPE list;
558 struct ice_tcam_inf tcam[ICE_MAX_TCAM_PER_PROFILE];
561 struct ice_vsig_entry {
563 struct LIST_HEAD_TYPE prop_lst;
564 struct ice_vsig_vsi *first_vsi;
567 struct ice_vsig_vsi {
571 struct ice_vsig_vsi *next_vsi;
574 #define ICE_XLT1_CNT 1024
575 #define ICE_MAX_PTGS 256
581 struct ice_ptg_entry *ptg_tbl;
582 struct ice_ptg_ptype *ptypes;
586 #define ICE_XLT2_CNT 768
587 #define ICE_MAX_VSIGS 768
590 * [0:12]: incremental vsig index 1 to ICE_MAX_VSIGS
591 * [13:15]: pf number of device
593 #define ICE_VSIG_IDX_M (0x1FFF)
594 #define ICE_PF_NUM_S 13
595 #define ICE_PF_NUM_M (0x07 << ICE_PF_NUM_S)
596 #define ICE_VSIG_VALUE(vsig, pf_id) \
597 (u16)((((u16)(vsig)) & ICE_VSIG_IDX_M) | \
598 (((u16)(pf_id) << ICE_PF_NUM_S) & ICE_PF_NUM_M))
599 #define ICE_DEFAULT_VSIG 0
605 struct ice_vsig_entry *vsig_tbl;
606 struct ice_vsig_vsi *vsis;
610 /* Extraction sequence - list of match fields:
611 * protocol ID, offset, profile length
613 union ice_match_fld {
618 u8 reserved; /* must be zero */
623 #define ICE_MATCH_LIST_SZ 20
627 union ice_match_fld list[ICE_MATCH_LIST_SZ];
630 /* Profile ID Management */
631 struct ice_prof_id_key {
637 /* Keys are made up of two values, each one-half the size of the key.
638 * For TCAM, the entire key is 80 bits wide (or 2, 40-bit wide values)
640 #define ICE_TCAM_KEY_VAL_SZ 5
641 #define ICE_TCAM_KEY_SZ (2 * ICE_TCAM_KEY_VAL_SZ)
643 struct ice_prof_tcam_entry {
645 u8 key[ICE_TCAM_KEY_SZ];
649 struct ice_prof_id_section {
651 struct ice_prof_tcam_entry entry[1];
656 struct ice_prof_tcam {
660 u8 cdid_bits; /* # cdid bits to use in key, 0, 2, 4, or 8 */
661 struct ice_prof_tcam_entry *t;
664 struct ice_prof_redir {
670 /* Tables per block */
671 struct ice_blk_info {
672 struct ice_xlt1 xlt1;
673 struct ice_xlt2 xlt2;
674 struct ice_prof_tcam prof;
675 struct ice_prof_redir prof_redir;
677 u8 overwrite; /* set to true to allow overwrite of table entries */
690 struct LIST_ENTRY_TYPE list_entry;
691 enum ice_chg_type type;
706 #define ICE_FLOW_PTYPE_MAX ICE_XLT1_CNT
708 #endif /* _ICE_FLEX_TYPE_H_ */