drivers/net/ice/base/ice_protocol_type.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2001-2021 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_GTP_NO_PAY,
  55         ICE_VLAN_EX,
  56         ICE_VLAN_IN,
  57         ICE_PROTOCOL_LAST
  58 };
  59
  60 enum ice_sw_tunnel_type {
  61         ICE_NON_TUN = 0,
  62         ICE_SW_TUN_AND_NON_TUN,
  63         ICE_SW_TUN_VXLAN_GPE,
  64         ICE_SW_TUN_GENEVE,      /* GENEVE matches only non-VLAN pkts */
  65         ICE_SW_TUN_GENEVE_VLAN, /* GENEVE matches both VLAN and non-VLAN pkts */
  66         ICE_SW_TUN_VXLAN,       /* VXLAN matches only non-VLAN pkts */
  67         ICE_SW_TUN_VXLAN_VLAN,  /* VXLAN matches both VLAN and non-VLAN pkts */
  68         ICE_SW_TUN_NVGRE,
  69         ICE_SW_TUN_UDP, /* This means all "UDP" tunnel types: VXLAN-GPE, VXLAN
  70                          * and GENEVE
  71                          */
  72         ICE_SW_IPV4_TCP,
  73         ICE_SW_IPV4_UDP,
  74         ICE_SW_IPV6_TCP,
  75         ICE_SW_IPV6_UDP,
  76         ICE_SW_TUN_GTP,
  77         ICE_SW_TUN_IPV4_GTPU_NO_PAY,
  78         ICE_SW_TUN_IPV6_GTPU_NO_PAY,
  79         ICE_SW_TUN_IPV4_GTPU_EH_IPV4,
  80         ICE_SW_TUN_IPV4_GTPU_IPV4_UDP,
  81         ICE_SW_TUN_IPV4_GTPU_EH_IPV4_UDP,
  82         ICE_SW_TUN_IPV4_GTPU_IPV4_TCP,
  83         ICE_SW_TUN_IPV4_GTPU_EH_IPV4_TCP,
  84         ICE_SW_TUN_IPV4_GTPU_EH_IPV6,
  85         ICE_SW_TUN_IPV4_GTPU_IPV6_UDP,
  86         ICE_SW_TUN_IPV4_GTPU_EH_IPV6_UDP,
  87         ICE_SW_TUN_IPV4_GTPU_IPV6_TCP,
  88         ICE_SW_TUN_IPV4_GTPU_EH_IPV6_TCP,
  89         ICE_SW_TUN_IPV6_GTPU_EH_IPV4,
  90         ICE_SW_TUN_IPV6_GTPU_IPV4_UDP,
  91         ICE_SW_TUN_IPV6_GTPU_EH_IPV4_UDP,
  92         ICE_SW_TUN_IPV6_GTPU_IPV4_TCP,
  93         ICE_SW_TUN_IPV6_GTPU_EH_IPV4_TCP,
  94         ICE_SW_TUN_IPV6_GTPU_EH_IPV6,
  95         ICE_SW_TUN_IPV6_GTPU_IPV6_UDP,
  96         ICE_SW_TUN_IPV6_GTPU_EH_IPV6_UDP,
  97         ICE_SW_TUN_IPV6_GTPU_IPV6_TCP,
  98         ICE_SW_TUN_IPV6_GTPU_EH_IPV6_TCP,
  99         ICE_SW_TUN_PPPOE,
 100         ICE_SW_TUN_PPPOE_PAY,
 101         ICE_SW_TUN_PPPOE_IPV4,
 102         ICE_SW_TUN_PPPOE_IPV4_TCP,
 103         ICE_SW_TUN_PPPOE_IPV4_UDP,
 104         ICE_SW_TUN_PPPOE_IPV6,
 105         ICE_SW_TUN_PPPOE_IPV6_TCP,
 106         ICE_SW_TUN_PPPOE_IPV6_UDP,
 107         ICE_SW_TUN_IPV4_ESP,
 108         ICE_SW_TUN_IPV6_ESP,
 109         ICE_SW_TUN_IPV4_AH,
 110         ICE_SW_TUN_IPV6_AH,
 111         ICE_SW_TUN_IPV4_NAT_T,
 112         ICE_SW_TUN_IPV6_NAT_T,
 113         ICE_SW_TUN_IPV4_L2TPV3,
 114         ICE_SW_TUN_IPV6_L2TPV3,
 115         ICE_SW_TUN_PROFID_IPV6_ESP,
 116         ICE_SW_TUN_PROFID_IPV6_AH,
 117         ICE_SW_TUN_PROFID_MAC_IPV6_L2TPV3,
 118         ICE_SW_TUN_PROFID_IPV6_NAT_T,
 119         ICE_SW_TUN_PROFID_IPV4_PFCP_NODE,
 120         ICE_SW_TUN_PROFID_IPV4_PFCP_SESSION,
 121         ICE_SW_TUN_PROFID_IPV6_PFCP_NODE,
 122         ICE_SW_TUN_PROFID_IPV6_PFCP_SESSION,
 123         ICE_SW_TUN_AND_NON_TUN_QINQ,
 124         ICE_NON_TUN_QINQ,
 125         ICE_SW_TUN_PPPOE_QINQ,
 126         ICE_SW_TUN_PPPOE_PAY_QINQ,
 127         ICE_SW_TUN_PPPOE_IPV4_QINQ,
 128         ICE_SW_TUN_PPPOE_IPV6_QINQ,
 129         ICE_SW_TUN_IPV4_GTPU_IPV4,
 130         ICE_SW_TUN_IPV4_GTPU_IPV6,
 131         ICE_SW_TUN_IPV6_GTPU_IPV4,
 132         ICE_SW_TUN_IPV6_GTPU_IPV6,
 133         ICE_SW_TUN_GTP_IPV4,
 134         ICE_SW_TUN_GTP_IPV6,
 135         ICE_ALL_TUNNELS /* All tunnel types including NVGRE */
 136 };
 137
 138 /* Decoders for ice_prot_id:
 139  * - F: First
 140  * - I: Inner
 141  * - L: Last
 142  * - O: Outer
 143  * - S: Single
 144  */
 145 enum ice_prot_id {
 146         ICE_PROT_ID_INVAL       = 0,
 147         ICE_PROT_MAC_OF_OR_S    = 1,
 148         ICE_PROT_MAC_O2         = 2,
 149         ICE_PROT_MAC_IL         = 4,
 150         ICE_PROT_MAC_IN_MAC     = 7,
 151         ICE_PROT_ETYPE_OL       = 9,
 152         ICE_PROT_ETYPE_IL       = 10,
 153         ICE_PROT_PAY            = 15,
 154         ICE_PROT_EVLAN_O        = 16,
 155         ICE_PROT_VLAN_O         = 17,
 156         ICE_PROT_VLAN_IF        = 18,
 157         ICE_PROT_MPLS_OL_MINUS_1 = 27,
 158         ICE_PROT_MPLS_OL_OR_OS  = 28,
 159         ICE_PROT_MPLS_IL        = 29,
 160         ICE_PROT_IPV4_OF_OR_S   = 32,
 161         ICE_PROT_IPV4_IL        = 33,
 162         ICE_PROT_IPV4_IL_IL     = 34,
 163         ICE_PROT_IPV6_OF_OR_S   = 40,
 164         ICE_PROT_IPV6_IL        = 41,
 165         ICE_PROT_IPV6_IL_IL     = 42,
 166         ICE_PROT_IPV6_FRAG      = 47,
 167         ICE_PROT_TCP_IL         = 49,
 168         ICE_PROT_UDP_OF         = 52,
 169         ICE_PROT_UDP_IL_OR_S    = 53,
 170         ICE_PROT_GRE_OF         = 64,
 171         ICE_PROT_NSH_F          = 84,
 172         ICE_PROT_ESP_F          = 88,
 173         ICE_PROT_ESP_2          = 89,
 174         ICE_PROT_SCTP_IL        = 96,
 175         ICE_PROT_ICMP_IL        = 98,
 176         ICE_PROT_ICMPV6_IL      = 100,
 177         ICE_PROT_VRRP_F         = 101,
 178         ICE_PROT_OSPF           = 102,
 179         ICE_PROT_PPPOE          = 103,
 180         ICE_PROT_L2TPV3         = 104,
 181         ICE_PROT_ECPRI          = 105,
 182         ICE_PROT_PPP            = 106,
 183         ICE_PROT_ATAOE_OF       = 114,
 184         ICE_PROT_CTRL_OF        = 116,
 185         ICE_PROT_LLDP_OF        = 117,
 186         ICE_PROT_ARP_OF         = 118,
 187         ICE_PROT_EAPOL_OF       = 120,
 188         ICE_PROT_META_ID        = 255, /* when offset == metaddata */
 189         ICE_PROT_INVALID        = 255  /* when offset == ICE_FV_OFFSET_INVAL */
 190 };
 191
 192 #define ICE_VNI_OFFSET          12 /* offset of VNI from ICE_PROT_UDP_OF */
 193
 194 #define ICE_MAC_OFOS_HW         1
 195 #define ICE_MAC_IL_HW           4
 196 #define ICE_ETYPE_OL_HW         9
 197 #define ICE_VLAN_OF_HW          16
 198 #define ICE_VLAN_OL_HW          17
 199 #define ICE_IPV4_OFOS_HW        32
 200 #define ICE_IPV4_IL_HW          33
 201 #define ICE_IPV6_OFOS_HW        40
 202 #define ICE_IPV6_IL_HW          41
 203 #define ICE_TCP_IL_HW           49
 204 #define ICE_UDP_ILOS_HW         53
 205 #define ICE_ESP_HW                      88
 206 #define ICE_AH_HW                       89
 207 #define ICE_SCTP_IL_HW          96
 208 #define ICE_PPPOE_HW            103
 209 #define ICE_L2TPV3_HW           104
 210
 211 /* ICE_UDP_OF is used to identify all 3 tunnel types
 212  * VXLAN, GENEVE and VXLAN_GPE. To differentiate further
 213  * need to use flags from the field vector
 214  */
 215 #define ICE_UDP_OF_HW   52 /* UDP Tunnels */
 216 #define ICE_GRE_OF_HW   64 /* NVGRE */
 217 #define ICE_META_DATA_ID_HW 255 /* this is used for tunnel type */
 218
 219 #define ICE_MDID_SIZE 2
 220 #define ICE_TUN_FLAG_MDID 21
 221 #define ICE_TUN_FLAG_MDID_OFF (ICE_MDID_SIZE * ICE_TUN_FLAG_MDID)
 222 #define ICE_TUN_FLAG_MASK 0xFF
 223 #define ICE_TUN_FLAG_VLAN_MASK 0x01
 224 #define ICE_TUN_FLAG_FV_IND 2
 225
 226 #define ICE_PROTOCOL_MAX_ENTRIES 16
 227
 228 /* Mapping of software defined protocol ID to hardware defined protocol ID */
 229 struct ice_protocol_entry {
 230         enum ice_protocol_type type;
 231         u8 protocol_id;
 232 };
 233
 234 struct ice_ether_hdr {
 235         u8 dst_addr[ETH_ALEN];
 236         u8 src_addr[ETH_ALEN];
 237 };
 238
 239 struct ice_ethtype_hdr {
 240         __be16 ethtype_id;
 241 };
 242
 243 struct ice_ether_vlan_hdr {
 244         u8 dst_addr[ETH_ALEN];
 245         u8 src_addr[ETH_ALEN];
 246         __be32 vlan_id;
 247 };
 248
 249 struct ice_vlan_hdr {
 250         __be16 type;
 251         __be16 vlan;
 252 };
 253
 254 struct ice_ipv4_hdr {
 255         u8 version;
 256         u8 tos;
 257         __be16 total_length;
 258         __be16 id;
 259         __be16 frag_off;
 260         u8 time_to_live;
 261         u8 protocol;
 262         __be16 check;
 263         __be32 src_addr;
 264         __be32 dst_addr;
 265 };
 266
 267 struct ice_le_ver_tc_flow {
 268         union {
 269                 struct {
 270                         u32 flow_label : 20;
 271                         u32 tc : 8;
 272                         u32 version : 4;
 273                 } fld;
 274                 u32 val;
 275         } u;
 276 };
 277
 278 struct ice_ipv6_hdr {
 279         __be32 be_ver_tc_flow;
 280         __be16 payload_len;
 281         u8 next_hdr;
 282         u8 hop_limit;
 283         u8 src_addr[ICE_IPV6_ADDR_LENGTH];
 284         u8 dst_addr[ICE_IPV6_ADDR_LENGTH];
 285 };
 286
 287 struct ice_sctp_hdr {
 288         __be16 src_port;
 289         __be16 dst_port;
 290         __be32 verification_tag;
 291         __be32 check;
 292 };
 293
 294 struct ice_l4_hdr {
 295         __be16 src_port;
 296         __be16 dst_port;
 297         __be16 len;
 298         __be16 check;
 299 };
 300
 301 struct ice_udp_tnl_hdr {
 302         __be16 field;
 303         __be16 proto_type;
 304         __be32 vni;     /* only use lower 24-bits */
 305 };
 306
 307 struct ice_udp_gtp_hdr {
 308         u8 flags;
 309         u8 msg_type;
 310         __be16 rsrvd_len;
 311         __be32 teid;
 312         __be16 rsrvd_seq_nbr;
 313         u8 rsrvd_n_pdu_nbr;
 314         u8 rsrvd_next_ext;
 315         u8 rsvrd_ext_len;
 316         u8 pdu_type;
 317         u8 qfi;
 318         u8 rsvrd;
 319 };
 320
 321 struct ice_pppoe_hdr {
 322         u8 rsrvd_ver_type;
 323         u8 rsrvd_code;
 324         __be16 session_id;
 325         __be16 length;
 326         __be16 ppp_prot_id; /* control and data only */
 327 };
 328
 329 struct ice_pfcp_hdr {
 330         u8 flags;
 331         u8 msg_type;
 332         __be16 length;
 333         __be64 seid;
 334         __be32 seq;
 335         u8 spare;
 336 };
 337
 338 struct ice_l2tpv3_sess_hdr {
 339         __be32 session_id;
 340         __be64 cookie;
 341 };
 342
 343 struct ice_esp_hdr {
 344         __be32 spi;
 345         __be32 seq;
 346 };
 347
 348 struct ice_ah_hdr {
 349         u8 next_hdr;
 350         u8 paylen;
 351         __be16 rsrvd;
 352         __be32 spi;
 353         __be32 seq;
 354 };
 355
 356 struct ice_nat_t_hdr {
 357         struct ice_esp_hdr esp;
 358 };
 359
 360 struct ice_nvgre {
 361         __be16 flags;
 362         __be16 protocol;
 363         __be32 tni_flow;
 364 };
 365
 366 union ice_prot_hdr {
 367         struct ice_ether_hdr eth_hdr;
 368         struct ice_ethtype_hdr ethertype;
 369         struct ice_vlan_hdr vlan_hdr;
 370         struct ice_ipv4_hdr ipv4_hdr;
 371         struct ice_ipv6_hdr ipv6_hdr;
 372         struct ice_l4_hdr l4_hdr;
 373         struct ice_sctp_hdr sctp_hdr;
 374         struct ice_udp_tnl_hdr tnl_hdr;
 375         struct ice_nvgre nvgre_hdr;
 376         struct ice_udp_gtp_hdr gtp_hdr;
 377         struct ice_pppoe_hdr pppoe_hdr;
 378         struct ice_pfcp_hdr pfcp_hdr;
 379         struct ice_l2tpv3_sess_hdr l2tpv3_sess_hdr;
 380         struct ice_esp_hdr esp_hdr;
 381         struct ice_ah_hdr ah_hdr;
 382         struct ice_nat_t_hdr nat_t_hdr;
 383 };
 384
 385 /* This is mapping table entry that maps every word within a given protocol
 386  * structure to the real byte offset as per the specification of that
 387  * protocol header.
 388  * for e.g. dst address is 3 words in ethertype header and corresponding bytes
 389  * are 0, 2, 3 in the actual packet header and src address is at 4, 6, 8
 390  */
 391 struct ice_prot_ext_tbl_entry {
 392         enum ice_protocol_type prot_type;
 393         /* Byte offset into header of given protocol type */
 394         u8 offs[sizeof(union ice_prot_hdr)];
 395 };
 396
 397 /* Extractions to be looked up for a given recipe */
 398 struct ice_prot_lkup_ext {
 399         u16 prot_type;
 400         u8 n_val_words;
 401         /* create a buffer to hold max words per recipe */
 402         u16 field_off[ICE_MAX_CHAIN_WORDS];
 403         u16 field_mask[ICE_MAX_CHAIN_WORDS];
 404
 405         struct ice_fv_word fv_words[ICE_MAX_CHAIN_WORDS];
 406
 407         /* Indicate field offsets that have field vector indices assigned */
 408         ice_declare_bitmap(done, ICE_MAX_CHAIN_WORDS);
 409 };
 410
 411 struct ice_pref_recipe_group {
 412         u8 n_val_pairs;         /* Number of valid pairs */
 413         struct ice_fv_word pairs[ICE_NUM_WORDS_RECIPE];
 414         u16 mask[ICE_NUM_WORDS_RECIPE];
 415 };
 416
 417 struct ice_recp_grp_entry {
 418         struct LIST_ENTRY_TYPE l_entry;
 419
 420 #define ICE_INVAL_CHAIN_IND 0xFF
 421         u16 rid;
 422         u8 chain_idx;
 423         u16 fv_idx[ICE_NUM_WORDS_RECIPE];
 424         u16 fv_mask[ICE_NUM_WORDS_RECIPE];
 425         struct ice_pref_recipe_group r_group;
 426 };
 427 #endif /* _ICE_PROTOCOL_TYPE_H_ */