/* SPDX-License-Identifier: BSD-3-Clause */ /* Copyright (c) 2020, Intel Corporation * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * 3. Neither the name of the Intel Corporation nor the names of its * contributors may be used to endorse or promote products derived from * this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ /*$FreeBSD$*/ #ifndef _ICE_FLEX_TYPE_H_ #define _ICE_FLEX_TYPE_H_ #define ICE_FV_OFFSET_INVAL 0x1FF #pragma pack(1) /* Extraction Sequence (Field Vector) Table */ struct ice_fv_word { u8 prot_id; u16 off; /* Offset within the protocol header */ u8 resvrd; }; #pragma pack() #define ICE_MAX_NUM_PROFILES 256 #define ICE_MAX_FV_WORDS 48 struct ice_fv { struct ice_fv_word ew[ICE_MAX_FV_WORDS]; }; /* Package and segment headers and tables */ struct ice_pkg_hdr { struct ice_pkg_ver pkg_format_ver; __le32 seg_count; __le32 seg_offset[STRUCT_HACK_VAR_LEN]; }; /* generic segment */ struct ice_generic_seg_hdr { #define SEGMENT_TYPE_METADATA 0x00000001 #define SEGMENT_TYPE_ICE 0x00000010 __le32 seg_type; struct ice_pkg_ver seg_format_ver; __le32 seg_size; char seg_id[ICE_PKG_NAME_SIZE]; }; /* ice specific segment */ union ice_device_id { struct { __le16 device_id; __le16 vendor_id; } dev_vend_id; __le32 id; }; struct ice_device_id_entry { union ice_device_id device; union ice_device_id sub_device; }; struct ice_seg { struct ice_generic_seg_hdr hdr; __le32 device_table_count; struct ice_device_id_entry device_table[STRUCT_HACK_VAR_LEN]; }; struct ice_nvm_table { __le32 table_count; __le32 vers[STRUCT_HACK_VAR_LEN]; }; struct ice_buf { #define ICE_PKG_BUF_SIZE 4096 u8 buf[ICE_PKG_BUF_SIZE]; }; struct ice_buf_table { __le32 buf_count; struct ice_buf buf_array[STRUCT_HACK_VAR_LEN]; }; /* global metadata specific segment */ struct ice_global_metadata_seg { struct ice_generic_seg_hdr hdr; struct ice_pkg_ver pkg_ver; __le32 rsvd; char pkg_name[ICE_PKG_NAME_SIZE]; }; #define ICE_MIN_S_OFF 12 #define ICE_MAX_S_OFF 4095 #define ICE_MIN_S_SZ 1 #define ICE_MAX_S_SZ 4084 /* section information */ struct ice_section_entry { __le32 type; __le16 offset; __le16 size; }; #define ICE_MIN_S_COUNT 1 #define ICE_MAX_S_COUNT 511 #define ICE_MIN_S_DATA_END 12 #define ICE_MAX_S_DATA_END 4096 #define ICE_METADATA_BUF 0x80000000 struct ice_buf_hdr { __le16 section_count; __le16 data_end; struct ice_section_entry section_entry[STRUCT_HACK_VAR_LEN]; }; #define ICE_MAX_ENTRIES_IN_BUF(hd_sz, ent_sz) ((ICE_PKG_BUF_SIZE - \ ice_struct_size((struct ice_buf_hdr *)0, section_entry, 1) - (hd_sz)) /\ (ent_sz)) /* ice package section IDs */ #define ICE_SID_XLT0_SW 10 #define ICE_SID_XLT_KEY_BUILDER_SW 11 #define ICE_SID_XLT1_SW 12 #define ICE_SID_XLT2_SW 13 #define ICE_SID_PROFID_TCAM_SW 14 #define ICE_SID_PROFID_REDIR_SW 15 #define ICE_SID_FLD_VEC_SW 16 #define ICE_SID_CDID_KEY_BUILDER_SW 17 #define ICE_SID_CDID_REDIR_SW 18 #define ICE_SID_XLT0_ACL 20 #define ICE_SID_XLT_KEY_BUILDER_ACL 21 #define ICE_SID_XLT1_ACL 22 #define ICE_SID_XLT2_ACL 23 #define ICE_SID_PROFID_TCAM_ACL 24 #define ICE_SID_PROFID_REDIR_ACL 25 #define ICE_SID_FLD_VEC_ACL 26 #define ICE_SID_CDID_KEY_BUILDER_ACL 27 #define ICE_SID_CDID_REDIR_ACL 28 #define ICE_SID_XLT0_FD 30 #define ICE_SID_XLT_KEY_BUILDER_FD 31 #define ICE_SID_XLT1_FD 32 #define ICE_SID_XLT2_FD 33 #define ICE_SID_PROFID_TCAM_FD 34 #define ICE_SID_PROFID_REDIR_FD 35 #define ICE_SID_FLD_VEC_FD 36 #define ICE_SID_CDID_KEY_BUILDER_FD 37 #define ICE_SID_CDID_REDIR_FD 38 #define ICE_SID_XLT0_RSS 40 #define ICE_SID_XLT_KEY_BUILDER_RSS 41 #define ICE_SID_XLT1_RSS 42 #define ICE_SID_XLT2_RSS 43 #define ICE_SID_PROFID_TCAM_RSS 44 #define ICE_SID_PROFID_REDIR_RSS 45 #define ICE_SID_FLD_VEC_RSS 46 #define ICE_SID_CDID_KEY_BUILDER_RSS 47 #define ICE_SID_CDID_REDIR_RSS 48 #define ICE_SID_RXPARSER_CAM 50 #define ICE_SID_RXPARSER_NOMATCH_CAM 51 #define ICE_SID_RXPARSER_IMEM 52 #define ICE_SID_RXPARSER_XLT0_BUILDER 53 #define ICE_SID_RXPARSER_NODE_PTYPE 54 #define ICE_SID_RXPARSER_MARKER_PTYPE 55 #define ICE_SID_RXPARSER_BOOST_TCAM 56 #define ICE_SID_RXPARSER_PROTO_GRP 57 #define ICE_SID_RXPARSER_METADATA_INIT 58 #define ICE_SID_RXPARSER_XLT0 59 #define ICE_SID_TXPARSER_CAM 60 #define ICE_SID_TXPARSER_NOMATCH_CAM 61 #define ICE_SID_TXPARSER_IMEM 62 #define ICE_SID_TXPARSER_XLT0_BUILDER 63 #define ICE_SID_TXPARSER_NODE_PTYPE 64 #define ICE_SID_TXPARSER_MARKER_PTYPE 65 #define ICE_SID_TXPARSER_BOOST_TCAM 66 #define ICE_SID_TXPARSER_PROTO_GRP 67 #define ICE_SID_TXPARSER_METADATA_INIT 68 #define ICE_SID_TXPARSER_XLT0 69 #define ICE_SID_RXPARSER_INIT_REDIR 70 #define ICE_SID_TXPARSER_INIT_REDIR 71 #define ICE_SID_RXPARSER_MARKER_GRP 72 #define ICE_SID_TXPARSER_MARKER_GRP 73 #define ICE_SID_RXPARSER_LAST_PROTO 74 #define ICE_SID_TXPARSER_LAST_PROTO 75 #define ICE_SID_RXPARSER_PG_SPILL 76 #define ICE_SID_TXPARSER_PG_SPILL 77 #define ICE_SID_RXPARSER_NOMATCH_SPILL 78 #define ICE_SID_TXPARSER_NOMATCH_SPILL 79 #define ICE_SID_XLT0_PE 80 #define ICE_SID_XLT_KEY_BUILDER_PE 81 #define ICE_SID_XLT1_PE 82 #define ICE_SID_XLT2_PE 83 #define ICE_SID_PROFID_TCAM_PE 84 #define ICE_SID_PROFID_REDIR_PE 85 #define ICE_SID_FLD_VEC_PE 86 #define ICE_SID_CDID_KEY_BUILDER_PE 87 #define ICE_SID_CDID_REDIR_PE 88 /* Label Metadata section IDs */ #define ICE_SID_LBL_FIRST 0x80000010 #define ICE_SID_LBL_RXPARSER_IMEM 0x80000010 #define ICE_SID_LBL_TXPARSER_IMEM 0x80000011 #define ICE_SID_LBL_RESERVED_12 0x80000012 #define ICE_SID_LBL_RESERVED_13 0x80000013 #define ICE_SID_LBL_RXPARSER_MARKER 0x80000014 #define ICE_SID_LBL_TXPARSER_MARKER 0x80000015 #define ICE_SID_LBL_PTYPE 0x80000016 #define ICE_SID_LBL_PROTOCOL_ID 0x80000017 #define ICE_SID_LBL_RXPARSER_TMEM 0x80000018 #define ICE_SID_LBL_TXPARSER_TMEM 0x80000019 #define ICE_SID_LBL_RXPARSER_PG 0x8000001A #define ICE_SID_LBL_TXPARSER_PG 0x8000001B #define ICE_SID_LBL_RXPARSER_M_TCAM 0x8000001C #define ICE_SID_LBL_TXPARSER_M_TCAM 0x8000001D #define ICE_SID_LBL_SW_PROFID_TCAM 0x8000001E #define ICE_SID_LBL_ACL_PROFID_TCAM 0x8000001F #define ICE_SID_LBL_PE_PROFID_TCAM 0x80000020 #define ICE_SID_LBL_RSS_PROFID_TCAM 0x80000021 #define ICE_SID_LBL_FD_PROFID_TCAM 0x80000022 #define ICE_SID_LBL_FLAG 0x80000023 #define ICE_SID_LBL_REG 0x80000024 #define ICE_SID_LBL_SW_PTG 0x80000025 #define ICE_SID_LBL_ACL_PTG 0x80000026 #define ICE_SID_LBL_PE_PTG 0x80000027 #define ICE_SID_LBL_RSS_PTG 0x80000028 #define ICE_SID_LBL_FD_PTG 0x80000029 #define ICE_SID_LBL_SW_VSIG 0x8000002A #define ICE_SID_LBL_ACL_VSIG 0x8000002B #define ICE_SID_LBL_PE_VSIG 0x8000002C #define ICE_SID_LBL_RSS_VSIG 0x8000002D #define ICE_SID_LBL_FD_VSIG 0x8000002E #define ICE_SID_LBL_PTYPE_META 0x8000002F #define ICE_SID_LBL_SW_PROFID 0x80000030 #define ICE_SID_LBL_ACL_PROFID 0x80000031 #define ICE_SID_LBL_PE_PROFID 0x80000032 #define ICE_SID_LBL_RSS_PROFID 0x80000033 #define ICE_SID_LBL_FD_PROFID 0x80000034 #define ICE_SID_LBL_RXPARSER_MARKER_GRP 0x80000035 #define ICE_SID_LBL_TXPARSER_MARKER_GRP 0x80000036 #define ICE_SID_LBL_RXPARSER_PROTO 0x80000037 #define ICE_SID_LBL_TXPARSER_PROTO 0x80000038 /* The following define MUST be updated to reflect the last label section ID */ #define ICE_SID_LBL_LAST 0x80000038 enum ice_block { ICE_BLK_SW = 0, ICE_BLK_ACL, ICE_BLK_FD, ICE_BLK_RSS, ICE_BLK_PE, ICE_BLK_COUNT }; enum ice_sect { ICE_XLT0 = 0, ICE_XLT_KB, ICE_XLT1, ICE_XLT2, ICE_PROF_TCAM, ICE_PROF_REDIR, ICE_VEC_TBL, ICE_CDID_KB, ICE_CDID_REDIR, ICE_SECT_COUNT }; /* Packet Type (PTYPE) values */ #define ICE_PTYPE_MAC_PAY 1 #define ICE_PTYPE_IPV4FRAG_PAY 22 #define ICE_PTYPE_IPV4_PAY 23 #define ICE_PTYPE_IPV4_UDP_PAY 24 #define ICE_PTYPE_IPV4_TCP_PAY 26 #define ICE_PTYPE_IPV4_SCTP_PAY 27 #define ICE_PTYPE_IPV4_ICMP_PAY 28 #define ICE_PTYPE_IPV6FRAG_PAY 88 #define ICE_PTYPE_IPV6_PAY 89 #define ICE_PTYPE_IPV6_UDP_PAY 90 #define ICE_PTYPE_IPV6_TCP_PAY 92 #define ICE_PTYPE_IPV6_SCTP_PAY 93 #define ICE_PTYPE_IPV6_ICMP_PAY 94 /* Packet Type Groups (PTG) - Inner Most fields (IM) */ #define ICE_PTG_IM_IPV4_TCP 16 #define ICE_PTG_IM_IPV4_UDP 17 #define ICE_PTG_IM_IPV4_SCTP 18 #define ICE_PTG_IM_IPV4_PAY 20 #define ICE_PTG_IM_IPV4_OTHER 21 #define ICE_PTG_IM_IPV6_TCP 32 #define ICE_PTG_IM_IPV6_UDP 33 #define ICE_PTG_IM_IPV6_SCTP 34 #define ICE_PTG_IM_IPV6_OTHER 37 #define ICE_PTG_IM_L2_OTHER 67 struct ice_flex_fields { union { struct { u8 src_ip; u8 dst_ip; u8 flow_label; /* valid for IPv6 only */ } ip_fields; struct { u8 src_prt; u8 dst_prt; } tcp_udp_fields; struct { u8 src_ip; u8 dst_ip; u8 src_prt; u8 dst_prt; } ip_tcp_udp_fields; struct { u8 src_prt; u8 dst_prt; u8 flow_label; /* valid for IPv6 only */ u8 spi; } ip_esp_fields; struct { u32 offset; u32 length; } off_len; } fields; }; #define ICE_XLT1_DFLT_GRP 0 #define ICE_XLT1_TABLE_SIZE 1024 /* package labels */ struct ice_label { __le16 value; #define ICE_PKG_LABEL_SIZE 64 char name[ICE_PKG_LABEL_SIZE]; }; struct ice_label_section { __le16 count; struct ice_label label[STRUCT_HACK_VAR_LEN]; }; #define ICE_MAX_LABELS_IN_BUF ICE_MAX_ENTRIES_IN_BUF( \ ice_struct_size((struct ice_label_section *)0, label, 1) - \ sizeof(struct ice_label), sizeof(struct ice_label)) struct ice_sw_fv_section { __le16 count; __le16 base_offset; struct ice_fv fv[STRUCT_HACK_VAR_LEN]; }; struct ice_sw_fv_list_entry { struct LIST_ENTRY_TYPE list_entry; u32 profile_id; struct ice_fv *fv_ptr; }; #pragma pack(1) /* The BOOST TCAM stores the match packet header in reverse order, meaning * the fields are reversed; in addition, this means that the normally big endian * fields of the packet are now little endian. */ struct ice_boost_key_value { #define ICE_BOOST_REMAINING_HV_KEY 15 u8 remaining_hv_key[ICE_BOOST_REMAINING_HV_KEY]; __le16 hv_dst_port_key; __le16 hv_src_port_key; u8 tcam_search_key; }; #pragma pack() struct ice_boost_key { struct ice_boost_key_value key; struct ice_boost_key_value key2; }; /* package Boost TCAM entry */ struct ice_boost_tcam_entry { __le16 addr; __le16 reserved; /* break up the 40 bytes of key into different fields */ struct ice_boost_key key; u8 boost_hit_index_group; /* The following contains bitfields which are not on byte boundaries. * These fields are currently unused by driver software. */ #define ICE_BOOST_BIT_FIELDS 43 u8 bit_fields[ICE_BOOST_BIT_FIELDS]; }; struct ice_boost_tcam_section { __le16 count; __le16 reserved; struct ice_boost_tcam_entry tcam[STRUCT_HACK_VAR_LEN]; }; #define ICE_MAX_BST_TCAMS_IN_BUF ICE_MAX_ENTRIES_IN_BUF( \ ice_struct_size((struct ice_boost_tcam_section *)0, tcam, 1) - \ sizeof(struct ice_boost_tcam_entry), \ sizeof(struct ice_boost_tcam_entry)) struct ice_xlt1_section { __le16 count; __le16 offset; u8 value[STRUCT_HACK_VAR_LEN]; }; struct ice_xlt2_section { __le16 count; __le16 offset; __le16 value[STRUCT_HACK_VAR_LEN]; }; struct ice_prof_redir_section { __le16 count; __le16 offset; u8 redir_value[STRUCT_HACK_VAR_LEN]; }; /* package buffer building */ struct ice_buf_build { struct ice_buf buf; u16 reserved_section_table_entries; }; struct ice_pkg_enum { struct ice_buf_table *buf_table; u32 buf_idx; u32 type; struct ice_buf_hdr *buf; u32 sect_idx; void *sect; u32 sect_type; u32 entry_idx; void *(*handler)(u32 sect_type, void *section, u32 index, u32 *offset); }; /* Tunnel enabling */ enum ice_tunnel_type { TNL_VXLAN = 0, TNL_GENEVE, TNL_LAST = 0xFF, TNL_ALL = 0xFF, }; struct ice_tunnel_type_scan { enum ice_tunnel_type type; const char *label_prefix; }; struct ice_tunnel_entry { enum ice_tunnel_type type; u16 boost_addr; u16 port; u16 ref; struct ice_boost_tcam_entry *boost_entry; u8 valid; u8 in_use; u8 marked; }; #define ICE_TUNNEL_MAX_ENTRIES 16 struct ice_tunnel_table { struct ice_tunnel_entry tbl[ICE_TUNNEL_MAX_ENTRIES]; u16 count; }; struct ice_pkg_es { __le16 count; __le16 offset; struct ice_fv_word es[STRUCT_HACK_VAR_LEN]; }; struct ice_es { u32 sid; u16 count; u16 fvw; u16 *ref_count; struct LIST_HEAD_TYPE prof_map; struct ice_fv_word *t; struct ice_lock prof_map_lock; /* protect access to profiles list */ u8 *written; u8 reverse; /* set to true to reverse FV order */ }; /* PTYPE Group management */ /* Note: XLT1 table takes 13-bit as input, and results in an 8-bit packet type * group (PTG) ID as output. * * Note: PTG 0 is the default packet type group and it is assumed that all PTYPE * are a part of this group until moved to a new PTG. */ #define ICE_DEFAULT_PTG 0 struct ice_ptg_entry { struct ice_ptg_ptype *first_ptype; u8 in_use; }; struct ice_ptg_ptype { struct ice_ptg_ptype *next_ptype; u8 ptg; }; #define ICE_MAX_TCAM_PER_PROFILE 32 #define ICE_MAX_PTG_PER_PROFILE 32 struct ice_prof_map { struct LIST_ENTRY_TYPE list; u64 profile_cookie; u64 context; u8 prof_id; u8 ptg_cnt; u8 ptg[ICE_MAX_PTG_PER_PROFILE]; }; #define ICE_INVALID_TCAM 0xFFFF struct ice_tcam_inf { u16 tcam_idx; u8 ptg; u8 prof_id; u8 in_use; }; struct ice_vsig_prof { struct LIST_ENTRY_TYPE list; u64 profile_cookie; u8 prof_id; u8 tcam_count; struct ice_tcam_inf tcam[ICE_MAX_TCAM_PER_PROFILE]; }; struct ice_vsig_entry { struct LIST_HEAD_TYPE prop_lst; struct ice_vsig_vsi *first_vsi; u8 in_use; }; struct ice_vsig_vsi { struct ice_vsig_vsi *next_vsi; u32 prop_mask; u16 changed; u16 vsig; }; #define ICE_XLT1_CNT 1024 #define ICE_MAX_PTGS 256 /* XLT1 Table */ struct ice_xlt1 { struct ice_ptg_entry *ptg_tbl; struct ice_ptg_ptype *ptypes; u8 *t; u32 sid; u16 count; }; #define ICE_XLT2_CNT 768 #define ICE_MAX_VSIGS 768 /* VSIG bit layout: * [0:12]: incremental VSIG index 1 to ICE_MAX_VSIGS * [13:15]: PF number of device */ #define ICE_VSIG_IDX_M (0x1FFF) #define ICE_PF_NUM_S 13 #define ICE_PF_NUM_M (0x07 << ICE_PF_NUM_S) #define ICE_VSIG_VALUE(vsig, pf_id) \ (u16)((((u16)(vsig)) & ICE_VSIG_IDX_M) | \ (((u16)(pf_id) << ICE_PF_NUM_S) & ICE_PF_NUM_M)) #define ICE_DEFAULT_VSIG 0 /* XLT2 Table */ struct ice_xlt2 { struct ice_vsig_entry *vsig_tbl; struct ice_vsig_vsi *vsis; u16 *t; u32 sid; u16 count; }; /* Extraction sequence - list of match fields: * protocol ID, offset, profile length */ union ice_match_fld { struct { u8 prot_id; u8 offset; u8 length; u8 reserved; /* must be zero */ } fld; u32 val; }; #define ICE_MATCH_LIST_SZ 20 #pragma pack(1) struct ice_match { u8 count; union ice_match_fld list[ICE_MATCH_LIST_SZ]; }; /* Profile ID Management */ struct ice_prof_id_key { __le16 flags; u8 xlt1; __le16 xlt2_cdid; }; /* Keys are made up of two values, each one-half the size of the key. * For TCAM, the entire key is 80 bits wide (or 2, 40-bit wide values) */ #define ICE_TCAM_KEY_VAL_SZ 5 #define ICE_TCAM_KEY_SZ (2 * ICE_TCAM_KEY_VAL_SZ) struct ice_prof_tcam_entry { __le16 addr; u8 key[ICE_TCAM_KEY_SZ]; u8 prof_id; }; #pragma pack() struct ice_prof_id_section { __le16 count; struct ice_prof_tcam_entry entry[STRUCT_HACK_VAR_LEN]; }; struct ice_prof_tcam { u32 sid; u16 count; u16 max_prof_id; struct ice_prof_tcam_entry *t; u8 cdid_bits; /* # CDID bits to use in key, 0, 2, 4, or 8 */ }; struct ice_prof_redir { u8 *t; u32 sid; u16 count; }; /* Tables per block */ struct ice_blk_info { struct ice_xlt1 xlt1; struct ice_xlt2 xlt2; struct ice_prof_tcam prof; struct ice_prof_redir prof_redir; struct ice_es es; u8 overwrite; /* set to true to allow overwrite of table entries */ u8 is_list_init; }; enum ice_chg_type { ICE_TCAM_NONE = 0, ICE_PTG_ES_ADD, ICE_TCAM_ADD, ICE_VSIG_ADD, ICE_VSIG_REM, ICE_VSI_MOVE, }; struct ice_chs_chg { struct LIST_ENTRY_TYPE list_entry; enum ice_chg_type type; u8 add_ptg; u8 add_vsig; u8 add_tcam_idx; u8 add_prof; u16 ptype; u8 ptg; u8 prof_id; u16 vsi; u16 vsig; u16 orig_vsig; u16 tcam_idx; }; #define ICE_FLOW_PTYPE_MAX ICE_XLT1_CNT enum ice_prof_type { ICE_PROF_NON_TUN = 0x1, ICE_PROF_TUN_UDP = 0x2, ICE_PROF_TUN_GRE = 0x4, ICE_PROF_TUN_ALL = 0x6, ICE_PROF_ALL = 0xFF, }; #endif /* _ICE_FLEX_TYPE_H_ */