drivers/net/ice/base/ice_protocol_type.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2001-2019
   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_IPV4_OFOS,
  35         ICE_IPV4_IL,
  36         ICE_IPV6_OFOS,
  37         ICE_IPV6_IL,
  38         ICE_TCP_IL,
  39         ICE_UDP_OF,
  40         ICE_UDP_ILOS,
  41         ICE_SCTP_IL,
  42         ICE_VXLAN,
  43         ICE_GENEVE,
  44         ICE_VXLAN_GPE,
  45         ICE_NVGRE,
  46         ICE_GTP,
  47         ICE_PPPOE,
  48         ICE_PROTOCOL_LAST
  49 };
  50
  51 enum ice_sw_tunnel_type {
  52         ICE_NON_TUN = 0,
  53         ICE_SW_TUN_AND_NON_TUN,
  54         ICE_SW_TUN_VXLAN_GPE,
  55         ICE_SW_TUN_GENEVE,
  56         ICE_SW_TUN_VXLAN,
  57         ICE_SW_TUN_NVGRE,
  58         ICE_SW_TUN_UDP, /* This means all "UDP" tunnel types: VXLAN-GPE, VXLAN
  59                          * and GENEVE
  60                          */
  61         ICE_SW_TUN_GTP,
  62         ICE_SW_TUN_PPPOE,
  63         ICE_ALL_TUNNELS /* All tunnel types including NVGRE */
  64 };
  65
  66 /* Decoders for ice_prot_id:
  67  * - F: First
  68  * - I: Inner
  69  * - L: Last
  70  * - O: Outer
  71  * - S: Single
  72  */
  73 enum ice_prot_id {
  74         ICE_PROT_ID_INVAL       = 0,
  75         ICE_PROT_MAC_OF_OR_S    = 1,
  76         ICE_PROT_MAC_O2         = 2,
  77         ICE_PROT_MAC_IL         = 4,
  78         ICE_PROT_MAC_IN_MAC     = 7,
  79         ICE_PROT_ETYPE_OL       = 9,
  80         ICE_PROT_ETYPE_IL       = 10,
  81         ICE_PROT_PAY            = 15,
  82         ICE_PROT_EVLAN_O        = 16,
  83         ICE_PROT_VLAN_O         = 17,
  84         ICE_PROT_VLAN_IF        = 18,
  85         ICE_PROT_MPLS_OL_MINUS_1 = 27,
  86         ICE_PROT_MPLS_OL_OR_OS  = 28,
  87         ICE_PROT_MPLS_IL        = 29,
  88         ICE_PROT_IPV4_OF_OR_S   = 32,
  89         ICE_PROT_IPV4_IL        = 33,
  90         ICE_PROT_IPV6_OF_OR_S   = 40,
  91         ICE_PROT_IPV6_IL        = 41,
  92         ICE_PROT_IPV6_FRAG      = 47,
  93         ICE_PROT_TCP_IL         = 49,
  94         ICE_PROT_UDP_OF         = 52,
  95         ICE_PROT_UDP_IL_OR_S    = 53,
  96         ICE_PROT_GRE_OF         = 64,
  97         ICE_PROT_NSH_F          = 84,
  98         ICE_PROT_ESP_F          = 88,
  99         ICE_PROT_ESP_2          = 89,
 100         ICE_PROT_SCTP_IL        = 96,
 101         ICE_PROT_ICMP_IL        = 98,
 102         ICE_PROT_ICMPV6_IL      = 100,
 103         ICE_PROT_VRRP_F         = 101,
 104         ICE_PROT_OSPF           = 102,
 105         ICE_PROT_PPPOE          = 103,
 106         ICE_PROT_ATAOE_OF       = 114,
 107         ICE_PROT_CTRL_OF        = 116,
 108         ICE_PROT_LLDP_OF        = 117,
 109         ICE_PROT_ARP_OF         = 118,
 110         ICE_PROT_EAPOL_OF       = 120,
 111         ICE_PROT_META_ID        = 255, /* when offset == metaddata */
 112         ICE_PROT_INVALID        = 255  /* when offset == 0xFF */
 113 };
 114
 115 #define ICE_VNI_OFFSET          12 /* offset of VNI from ICE_PROT_UDP_OF */
 116
 117 #define ICE_MAC_OFOS_HW         1
 118 #define ICE_MAC_IL_HW           4
 119 #define ICE_ETYPE_OL_HW         9
 120 #define ICE_IPV4_OFOS_HW        32
 121 #define ICE_IPV4_IL_HW          33
 122 #define ICE_IPV6_OFOS_HW        40
 123 #define ICE_IPV6_IL_HW          41
 124 #define ICE_TCP_IL_HW           49
 125 #define ICE_UDP_ILOS_HW         53
 126 #define ICE_SCTP_IL_HW          96
 127 #define ICE_PPPOE_HW            103
 128
 129 /* ICE_UDP_OF is used to identify all 3 tunnel types
 130  * VXLAN, GENEVE and VXLAN_GPE. To differentiate further
 131  * need to use flags from the field vector
 132  */
 133 #define ICE_UDP_OF_HW   52 /* UDP Tunnels */
 134 #define ICE_GRE_OF_HW   64 /* NVGRE */
 135 #define ICE_META_DATA_ID_HW 255 /* this is used for tunnel type */
 136
 137 #define ICE_MDID_SIZE 2
 138 #define ICE_TUN_FLAG_MDID 21
 139 #define ICE_TUN_FLAG_MASK 0xFF
 140 #define ICE_TUN_FLAG_FV_IND 2
 141
 142 #define ICE_PROTOCOL_MAX_ENTRIES 16
 143
 144 /* Mapping of software defined protocol ID to hardware defined protocol ID */
 145 struct ice_protocol_entry {
 146         enum ice_protocol_type type;
 147         u8 protocol_id;
 148 };
 149
 150 struct ice_ether_hdr {
 151         u8 dst_addr[ETH_ALEN];
 152         u8 src_addr[ETH_ALEN];
 153 };
 154
 155 struct ice_ethtype_hdr {
 156         u16 ethtype_id;
 157 };
 158
 159 struct ice_ether_vlan_hdr {
 160         u8 dst_addr[ETH_ALEN];
 161         u8 src_addr[ETH_ALEN];
 162         u32 vlan_id;
 163 };
 164
 165 struct ice_ipv4_hdr {
 166         u8 version;
 167         u8 tos;
 168         u16 total_length;
 169         u16 id;
 170         u16 frag_off;
 171         u8 time_to_live;
 172         u8 protocol;
 173         u16 check;
 174         u32 src_addr;
 175         u32 dst_addr;
 176 };
 177
 178 struct ice_ipv6_hdr {
 179         u8 version;
 180         u8 tc;
 181         u16 flow_label;
 182         u16 payload_len;
 183         u8 next_hdr;
 184         u8 hop_limit;
 185         u8 src_addr[ICE_IPV6_ADDR_LENGTH];
 186         u8 dst_addr[ICE_IPV6_ADDR_LENGTH];
 187 };
 188
 189 struct ice_sctp_hdr {
 190         u16 src_port;
 191         u16 dst_port;
 192         u32 verification_tag;
 193         u32 check;
 194 };
 195
 196 struct ice_l4_hdr {
 197         u16 src_port;
 198         u16 dst_port;
 199         u16 len;
 200         u16 check;
 201 };
 202
 203 struct ice_udp_tnl_hdr {
 204         u16 field;
 205         u16 proto_type;
 206         u32 vni;        /* only use lower 24-bits */
 207 };
 208
 209 #pragma pack(1)
 210 struct ice_udp_gtp_hdr {
 211         u8 flags;
 212         u8 msg_type;
 213         u16 rsrvd_len;
 214         u32 teid;
 215         u16 rsrvd_seq_nbr;
 216         u8 rsrvd_n_pdu_nbr;
 217         u8 rsrvd_next_ext;
 218         u8 rsvrd_ext_len;
 219         u8 pdu_type;
 220         u8 qfi;
 221         u8 rsvrd;
 222 };
 223
 224 struct ice_pppoe_hdr {
 225         u8 rsrvd_ver_type;
 226         u8 rsrved_code;
 227         u16 session_id;
 228         u16 length;
 229         u16 ppp_prot_id; /* control and data only */
 230 };
 231 #pragma pack()
 232
 233 struct ice_nvgre {
 234         u16 flags;
 235         u16 protocol;
 236         u32 tni_flow;
 237 };
 238
 239 union ice_prot_hdr {
 240         struct ice_ether_hdr eth_hdr;
 241         struct ice_ethtype_hdr ethertype;
 242         struct ice_ipv4_hdr ipv4_hdr;
 243         struct ice_ipv6_hdr ipv6_hdr;
 244         struct ice_l4_hdr l4_hdr;
 245         struct ice_sctp_hdr sctp_hdr;
 246         struct ice_udp_tnl_hdr tnl_hdr;
 247         struct ice_nvgre nvgre_hdr;
 248         struct ice_udp_gtp_hdr gtp_hdr;
 249         struct ice_pppoe_hdr pppoe_hdr;
 250 };
 251
 252 /* This is mapping table entry that maps every word within a given protocol
 253  * structure to the real byte offset as per the specification of that
 254  * protocol header.
 255  * for e.g. dst address is 3 words in ethertype header and corresponding bytes
 256  * are 0, 2, 3 in the actual packet header and src address is at 4, 6, 8
 257  */
 258 struct ice_prot_ext_tbl_entry {
 259         enum ice_protocol_type prot_type;
 260         /* Byte offset into header of given protocol type */
 261         u8 offs[sizeof(union ice_prot_hdr)];
 262 };
 263
 264 /* Extractions to be looked up for a given recipe */
 265 struct ice_prot_lkup_ext {
 266         u16 prot_type;
 267         u8 n_val_words;
 268         /* create a buffer to hold max words per recipe */
 269         u16 field_off[ICE_MAX_CHAIN_WORDS];
 270         u16 field_mask[ICE_MAX_CHAIN_WORDS];
 271
 272         struct ice_fv_word fv_words[ICE_MAX_CHAIN_WORDS];
 273
 274         /* Indicate field offsets that have field vector indices assigned */
 275         ice_declare_bitmap(done, ICE_MAX_CHAIN_WORDS);
 276 };
 277
 278 struct ice_pref_recipe_group {
 279         u8 n_val_pairs;         /* Number of valid pairs */
 280         struct ice_fv_word pairs[ICE_NUM_WORDS_RECIPE];
 281         u16 mask[ICE_NUM_WORDS_RECIPE];
 282 };
 283
 284 struct ice_recp_grp_entry {
 285         struct LIST_ENTRY_TYPE l_entry;
 286
 287 #define ICE_INVAL_CHAIN_IND 0xFF
 288         u16 rid;
 289         u8 chain_idx;
 290         u16 fv_idx[ICE_NUM_WORDS_RECIPE];
 291         u16 fv_mask[ICE_NUM_WORDS_RECIPE];
 292         struct ice_pref_recipe_group r_group;
 293 };
 294 #endif /* _ICE_PROTOCOL_TYPE_H_ */