drivers/net/ice/base/ice_protocol_type.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2001-2020 Intel Corporation
   3  */
   4
   5 #ifndef _ICE_PROTOCOL_TYPE_H_
   6 #define _ICE_PROTOCOL_TYPE_H_
   7 #include "ice_flex_type.h"
   8 #define ICE_IPV6_ADDR_LENGTH 16
   9
  10 /* Each recipe can match up to 5 different fields. Fields to match can be meta-
  11  * data, values extracted from packet headers, or results from other recipes.
  12  * One of the 5 fields is reserved for matching the switch ID. So, up to 4
  13  * recipes can provide intermediate results to another one through chaining,
  14  * e.g. recipes 0, 1, 2, and 3 can provide intermediate results to recipe 4.
  15  */
  16 #define ICE_NUM_WORDS_RECIPE 4
  17
  18 /* Max recipes that can be chained */
  19 #define ICE_MAX_CHAIN_RECIPE 5
  20
  21 /* 1 word reserved for switch ID from allowed 5 words.
  22  * So a recipe can have max 4 words. And you can chain 5 such recipes
  23  * together. So maximum words that can be programmed for look up is 5 * 4.
  24  */
  25 #define ICE_MAX_CHAIN_WORDS (ICE_NUM_WORDS_RECIPE * ICE_MAX_CHAIN_RECIPE)
  26
  27 /* Field vector index corresponding to chaining */
  28 #define ICE_CHAIN_FV_INDEX_START 47
  29
  30 enum ice_protocol_type {
  31         ICE_MAC_OFOS = 0,
  32         ICE_MAC_IL,
  33         ICE_ETYPE_OL,
  34         ICE_VLAN_OFOS,
  35         ICE_IPV4_OFOS,
  36         ICE_IPV4_IL,
  37         ICE_IPV6_OFOS,
  38         ICE_IPV6_IL,
  39         ICE_TCP_IL,
  40         ICE_UDP_OF,
  41         ICE_UDP_ILOS,
  42         ICE_SCTP_IL,
  43         ICE_VXLAN,
  44         ICE_GENEVE,
  45         ICE_VXLAN_GPE,
  46         ICE_NVGRE,
  47         ICE_GTP,
  48         ICE_PPPOE,
  49         ICE_PFCP,
  50         ICE_L2TPV3,
  51         ICE_ESP,
  52         ICE_AH,
  53         ICE_NAT_T,
  54         ICE_PROTOCOL_LAST
  55 };
  56
  57 enum ice_sw_tunnel_type {
  58         ICE_NON_TUN = 0,
  59         ICE_SW_TUN_AND_NON_TUN,
  60         ICE_SW_TUN_VXLAN_GPE,
  61         ICE_SW_TUN_GENEVE,      /* GENEVE matches only non-VLAN pkts */
  62         ICE_SW_TUN_GENEVE_VLAN, /* GENEVE matches both VLAN and non-VLAN pkts */
  63         ICE_SW_TUN_VXLAN,       /* VXLAN matches only non-VLAN pkts */
  64         ICE_SW_TUN_VXLAN_VLAN,  /* VXLAN matches both VLAN and non-VLAN pkts */
  65         ICE_SW_TUN_NVGRE,
  66         ICE_SW_TUN_UDP, /* This means all "UDP" tunnel types: VXLAN-GPE, VXLAN
  67                          * and GENEVE
  68                          */
  69         ICE_SW_TUN_GTP,
  70         ICE_SW_TUN_PPPOE,
  71         ICE_SW_TUN_IPV4_ESP,
  72         ICE_SW_TUN_IPV6_ESP,
  73         ICE_SW_TUN_IPV4_AH,
  74         ICE_SW_TUN_IPV6_AH,
  75         ICE_SW_TUN_IPV4_NAT_T,
  76         ICE_SW_TUN_IPV6_NAT_T,
  77         ICE_SW_TUN_IPV4_L2TPV3,
  78         ICE_SW_TUN_IPV6_L2TPV3,
  79         ICE_SW_TUN_PROFID_IPV6_ESP,
  80         ICE_SW_TUN_PROFID_IPV6_AH,
  81         ICE_SW_TUN_PROFID_MAC_IPV6_L2TPV3,
  82         ICE_SW_TUN_PROFID_IPV6_NAT_T,
  83         ICE_SW_TUN_PROFID_IPV4_PFCP_NODE,
  84         ICE_SW_TUN_PROFID_IPV4_PFCP_SESSION,
  85         ICE_SW_TUN_PROFID_IPV6_PFCP_NODE,
  86         ICE_SW_TUN_PROFID_IPV6_PFCP_SESSION,
  87         ICE_ALL_TUNNELS /* All tunnel types including NVGRE */
  88 };
  89
  90 /* Decoders for ice_prot_id:
  91  * - F: First
  92  * - I: Inner
  93  * - L: Last
  94  * - O: Outer
  95  * - S: Single
  96  */
  97 enum ice_prot_id {
  98         ICE_PROT_ID_INVAL       = 0,
  99         ICE_PROT_MAC_OF_OR_S    = 1,
 100         ICE_PROT_MAC_O2         = 2,
 101         ICE_PROT_MAC_IL         = 4,
 102         ICE_PROT_MAC_IN_MAC     = 7,
 103         ICE_PROT_ETYPE_OL       = 9,
 104         ICE_PROT_ETYPE_IL       = 10,
 105         ICE_PROT_PAY            = 15,
 106         ICE_PROT_EVLAN_O        = 16,
 107         ICE_PROT_VLAN_O         = 17,
 108         ICE_PROT_VLAN_IF        = 18,
 109         ICE_PROT_MPLS_OL_MINUS_1 = 27,
 110         ICE_PROT_MPLS_OL_OR_OS  = 28,
 111         ICE_PROT_MPLS_IL        = 29,
 112         ICE_PROT_IPV4_OF_OR_S   = 32,
 113         ICE_PROT_IPV4_IL        = 33,
 114         ICE_PROT_IPV6_OF_OR_S   = 40,
 115         ICE_PROT_IPV6_IL        = 41,
 116         ICE_PROT_IPV6_FRAG      = 47,
 117         ICE_PROT_TCP_IL         = 49,
 118         ICE_PROT_UDP_OF         = 52,
 119         ICE_PROT_UDP_IL_OR_S    = 53,
 120         ICE_PROT_GRE_OF         = 64,
 121         ICE_PROT_NSH_F          = 84,
 122         ICE_PROT_ESP_F          = 88,
 123         ICE_PROT_ESP_2          = 89,
 124         ICE_PROT_SCTP_IL        = 96,
 125         ICE_PROT_ICMP_IL        = 98,
 126         ICE_PROT_ICMPV6_IL      = 100,
 127         ICE_PROT_VRRP_F         = 101,
 128         ICE_PROT_OSPF           = 102,
 129         ICE_PROT_PPPOE          = 103,
 130         ICE_PROT_L2TPV3         = 104,
 131         ICE_PROT_ATAOE_OF       = 114,
 132         ICE_PROT_CTRL_OF        = 116,
 133         ICE_PROT_LLDP_OF        = 117,
 134         ICE_PROT_ARP_OF         = 118,
 135         ICE_PROT_EAPOL_OF       = 120,
 136         ICE_PROT_META_ID        = 255, /* when offset == metaddata */
 137         ICE_PROT_INVALID        = 255  /* when offset == ICE_FV_OFFSET_INVAL */
 138 };
 139
 140 #define ICE_VNI_OFFSET          12 /* offset of VNI from ICE_PROT_UDP_OF */
 141
 142 #define ICE_MAC_OFOS_HW         1
 143 #define ICE_MAC_IL_HW           4
 144 #define ICE_ETYPE_OL_HW         9
 145 #define ICE_VLAN_OL_HW          17
 146 #define ICE_IPV4_OFOS_HW        32
 147 #define ICE_IPV4_IL_HW          33
 148 #define ICE_IPV6_OFOS_HW        40
 149 #define ICE_IPV6_IL_HW          41
 150 #define ICE_TCP_IL_HW           49
 151 #define ICE_UDP_ILOS_HW         53
 152 #define ICE_ESP_HW                      88
 153 #define ICE_AH_HW                       89
 154 #define ICE_SCTP_IL_HW          96
 155 #define ICE_PPPOE_HW            103
 156 #define ICE_L2TPV3_HW           104
 157
 158 /* ICE_UDP_OF is used to identify all 3 tunnel types
 159  * VXLAN, GENEVE and VXLAN_GPE. To differentiate further
 160  * need to use flags from the field vector
 161  */
 162 #define ICE_UDP_OF_HW   52 /* UDP Tunnels */
 163 #define ICE_GRE_OF_HW   64 /* NVGRE */
 164 #define ICE_META_DATA_ID_HW 255 /* this is used for tunnel type */
 165
 166 #define ICE_MDID_SIZE 2
 167 #define ICE_TUN_FLAG_MDID 21
 168 #define ICE_TUN_FLAG_MDID_OFF (ICE_MDID_SIZE * ICE_TUN_FLAG_MDID)
 169 #define ICE_TUN_FLAG_MASK 0xFF
 170 #define ICE_TUN_FLAG_VLAN_MASK 0x01
 171 #define ICE_TUN_FLAG_FV_IND 2
 172
 173 #define ICE_PROTOCOL_MAX_ENTRIES 16
 174
 175 /* Mapping of software defined protocol ID to hardware defined protocol ID */
 176 struct ice_protocol_entry {
 177         enum ice_protocol_type type;
 178         u8 protocol_id;
 179 };
 180
 181 struct ice_ether_hdr {
 182         u8 dst_addr[ETH_ALEN];
 183         u8 src_addr[ETH_ALEN];
 184 };
 185
 186 struct ice_ethtype_hdr {
 187         __be16 ethtype_id;
 188 };
 189
 190 struct ice_ether_vlan_hdr {
 191         u8 dst_addr[ETH_ALEN];
 192         u8 src_addr[ETH_ALEN];
 193         __be32 vlan_id;
 194 };
 195
 196 struct ice_vlan_hdr {
 197         __be16 vlan;
 198         __be16 type;
 199 };
 200
 201 struct ice_ipv4_hdr {
 202         u8 version;
 203         u8 tos;
 204         __be16 total_length;
 205         __be16 id;
 206         __be16 frag_off;
 207         u8 time_to_live;
 208         u8 protocol;
 209         __be16 check;
 210         __be32 src_addr;
 211         __be32 dst_addr;
 212 };
 213
 214 struct ice_le_ver_tc_flow {
 215         union {
 216                 struct {
 217                         u32 flow_label : 20;
 218                         u32 tc : 8;
 219                         u32 version : 4;
 220                 } fld;
 221                 u32 val;
 222         } u;
 223 };
 224
 225 struct ice_ipv6_hdr {
 226         __be32 be_ver_tc_flow;
 227         __be16 payload_len;
 228         u8 next_hdr;
 229         u8 hop_limit;
 230         u8 src_addr[ICE_IPV6_ADDR_LENGTH];
 231         u8 dst_addr[ICE_IPV6_ADDR_LENGTH];
 232 };
 233
 234 struct ice_sctp_hdr {
 235         __be16 src_port;
 236         __be16 dst_port;
 237         __be32 verification_tag;
 238         __be32 check;
 239 };
 240
 241 struct ice_l4_hdr {
 242         __be16 src_port;
 243         __be16 dst_port;
 244         __be16 len;
 245         __be16 check;
 246 };
 247
 248 struct ice_udp_tnl_hdr {
 249         __be16 field;
 250         __be16 proto_type;
 251         __be32 vni;     /* only use lower 24-bits */
 252 };
 253
 254 struct ice_udp_gtp_hdr {
 255         u8 flags;
 256         u8 msg_type;
 257         __be16 rsrvd_len;
 258         __be32 teid;
 259         __be16 rsrvd_seq_nbr;
 260         u8 rsrvd_n_pdu_nbr;
 261         u8 rsrvd_next_ext;
 262         u8 rsvrd_ext_len;
 263         u8 pdu_type;
 264         u8 qfi;
 265         u8 rsvrd;
 266 };
 267
 268 struct ice_pppoe_hdr {
 269         u8 rsrvd_ver_type;
 270         u8 rsrvd_code;
 271         __be16 session_id;
 272         __be16 length;
 273         __be16 ppp_prot_id; /* control and data only */
 274 };
 275
 276 struct ice_pfcp_hdr {
 277         u8 flags;
 278         u8 msg_type;
 279         __be16 length;
 280         __be64 seid;
 281         __be32 seq;
 282         u8 spare;
 283 };
 284
 285 struct ice_l2tpv3_sess_hdr {
 286         __be32 session_id;
 287         __be64 cookie;
 288 };
 289
 290 struct ice_esp_hdr {
 291         __be32 spi;
 292         __be32 seq;
 293 };
 294
 295 struct ice_ah_hdr {
 296         u8 next_hdr;
 297         u8 paylen;
 298         __be16 rsrvd;
 299         __be32 spi;
 300         __be32 seq;
 301 };
 302
 303 struct ice_nat_t_hdr {
 304         struct ice_esp_hdr esp;
 305 };
 306
 307 struct ice_nvgre {
 308         __be16 flags;
 309         __be16 protocol;
 310         __be32 tni_flow;
 311 };
 312
 313 union ice_prot_hdr {
 314         struct ice_ether_hdr eth_hdr;
 315         struct ice_ethtype_hdr ethertype;
 316         struct ice_vlan_hdr vlan_hdr;
 317         struct ice_ipv4_hdr ipv4_hdr;
 318         struct ice_ipv6_hdr ipv6_hdr;
 319         struct ice_l4_hdr l4_hdr;
 320         struct ice_sctp_hdr sctp_hdr;
 321         struct ice_udp_tnl_hdr tnl_hdr;
 322         struct ice_nvgre nvgre_hdr;
 323         struct ice_udp_gtp_hdr gtp_hdr;
 324         struct ice_pppoe_hdr pppoe_hdr;
 325         struct ice_pfcp_hdr pfcp_hdr;
 326         struct ice_l2tpv3_sess_hdr l2tpv3_sess_hdr;
 327         struct ice_esp_hdr esp_hdr;
 328         struct ice_ah_hdr ah_hdr;
 329         struct ice_nat_t_hdr nat_t_hdr;
 330 };
 331
 332 /* This is mapping table entry that maps every word within a given protocol
 333  * structure to the real byte offset as per the specification of that
 334  * protocol header.
 335  * for e.g. dst address is 3 words in ethertype header and corresponding bytes
 336  * are 0, 2, 3 in the actual packet header and src address is at 4, 6, 8
 337  */
 338 struct ice_prot_ext_tbl_entry {
 339         enum ice_protocol_type prot_type;
 340         /* Byte offset into header of given protocol type */
 341         u8 offs[sizeof(union ice_prot_hdr)];
 342 };
 343
 344 /* Extractions to be looked up for a given recipe */
 345 struct ice_prot_lkup_ext {
 346         u16 prot_type;
 347         u8 n_val_words;
 348         /* create a buffer to hold max words per recipe */
 349         u16 field_off[ICE_MAX_CHAIN_WORDS];
 350         u16 field_mask[ICE_MAX_CHAIN_WORDS];
 351
 352         struct ice_fv_word fv_words[ICE_MAX_CHAIN_WORDS];
 353
 354         /* Indicate field offsets that have field vector indices assigned */
 355         ice_declare_bitmap(done, ICE_MAX_CHAIN_WORDS);
 356 };
 357
 358 struct ice_pref_recipe_group {
 359         u8 n_val_pairs;         /* Number of valid pairs */
 360         struct ice_fv_word pairs[ICE_NUM_WORDS_RECIPE];
 361         u16 mask[ICE_NUM_WORDS_RECIPE];
 362 };
 363
 364 struct ice_recp_grp_entry {
 365         struct LIST_ENTRY_TYPE l_entry;
 366
 367 #define ICE_INVAL_CHAIN_IND 0xFF
 368         u16 rid;
 369         u8 chain_idx;
 370         u16 fv_idx[ICE_NUM_WORDS_RECIPE];
 371         u16 fv_mask[ICE_NUM_WORDS_RECIPE];
 372         struct ice_pref_recipe_group r_group;
 373 };
 374 #endif /* _ICE_PROTOCOL_TYPE_H_ */