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