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