drivers/net/ethernet/intel/ice/ice_protocol_type.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /* Copyright (c) 2019, Intel Corporation. */
   3
   4 #ifndef _ICE_PROTOCOL_TYPE_H_
   5 #define _ICE_PROTOCOL_TYPE_H_
   6 #define ICE_IPV6_ADDR_LENGTH 16
   7
   8 /* Each recipe can match up to 5 different fields. Fields to match can be meta-
   9  * data, values extracted from packet headers, or results from other recipes.
  10  * One of the 5 fields is reserved for matching the switch ID. So, up to 4
  11  * recipes can provide intermediate results to another one through chaining,
  12  * e.g. recipes 0, 1, 2, and 3 can provide intermediate results to recipe 4.
  13  */
  14 #define ICE_NUM_WORDS_RECIPE 4
  15
  16 /* Max recipes that can be chained */
  17 #define ICE_MAX_CHAIN_RECIPE 5
  18
  19 /* 1 word reserved for switch ID from allowed 5 words.
  20  * So a recipe can have max 4 words. And you can chain 5 such recipes
  21  * together. So maximum words that can be programmed for look up is 5 * 4.
  22  */
  23 #define ICE_MAX_CHAIN_WORDS (ICE_NUM_WORDS_RECIPE * ICE_MAX_CHAIN_RECIPE)
  24
  25 /* Field vector index corresponding to chaining */
  26 #define ICE_CHAIN_FV_INDEX_START 47
  27
  28 enum ice_protocol_type {
  29         ICE_MAC_OFOS = 0,
  30         ICE_MAC_IL,
  31         ICE_ETYPE_OL,
  32         ICE_ETYPE_IL,
  33         ICE_VLAN_OFOS,
  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_VXLAN,
  42         ICE_GENEVE,
  43         ICE_NVGRE,
  44         ICE_GTP,
  45         ICE_GTP_NO_PAY,
  46         ICE_PPPOE,
  47         ICE_VLAN_EX,
  48         ICE_VLAN_IN,
  49         ICE_VXLAN_GPE,
  50         ICE_SCTP_IL,
  51         ICE_PROTOCOL_LAST
  52 };
  53
  54 enum ice_sw_tunnel_type {
  55         ICE_NON_TUN = 0,
  56         ICE_SW_TUN_AND_NON_TUN,
  57         ICE_SW_TUN_VXLAN,
  58         ICE_SW_TUN_GENEVE,
  59         ICE_SW_TUN_NVGRE,
  60         ICE_SW_TUN_GTPU,
  61         ICE_SW_TUN_GTPC,
  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_IL         = 4,
  76         ICE_PROT_ETYPE_OL       = 9,
  77         ICE_PROT_ETYPE_IL       = 10,
  78         ICE_PROT_IPV4_OF_OR_S   = 32,
  79         ICE_PROT_IPV4_IL        = 33,
  80         ICE_PROT_IPV6_OF_OR_S   = 40,
  81         ICE_PROT_IPV6_IL        = 41,
  82         ICE_PROT_TCP_IL         = 49,
  83         ICE_PROT_UDP_OF         = 52,
  84         ICE_PROT_UDP_IL_OR_S    = 53,
  85         ICE_PROT_GRE_OF         = 64,
  86         ICE_PROT_ESP_F          = 88,
  87         ICE_PROT_ESP_2          = 89,
  88         ICE_PROT_SCTP_IL        = 96,
  89         ICE_PROT_ICMP_IL        = 98,
  90         ICE_PROT_ICMPV6_IL      = 100,
  91         ICE_PROT_PPPOE          = 103,
  92         ICE_PROT_L2TPV3         = 104,
  93         ICE_PROT_ARP_OF         = 118,
  94         ICE_PROT_META_ID        = 255, /* when offset == metadata */
  95         ICE_PROT_INVALID        = 255  /* when offset == ICE_FV_OFFSET_INVAL */
  96 };
  97
  98 #define ICE_VNI_OFFSET          12 /* offset of VNI from ICE_PROT_UDP_OF */
  99
 100 #define ICE_MAC_OFOS_HW         1
 101 #define ICE_MAC_IL_HW           4
 102 #define ICE_ETYPE_OL_HW         9
 103 #define ICE_ETYPE_IL_HW         10
 104 #define ICE_VLAN_OF_HW          16
 105 #define ICE_VLAN_OL_HW          17
 106 #define ICE_IPV4_OFOS_HW        32
 107 #define ICE_IPV4_IL_HW          33
 108 #define ICE_IPV6_OFOS_HW        40
 109 #define ICE_IPV6_IL_HW          41
 110 #define ICE_TCP_IL_HW           49
 111 #define ICE_UDP_ILOS_HW         53
 112 #define ICE_GRE_OF_HW           64
 113 #define ICE_PPPOE_HW            103
 114
 115 #define ICE_UDP_OF_HW   52 /* UDP Tunnels */
 116 #define ICE_META_DATA_ID_HW 255 /* this is used for tunnel and VLAN type */
 117
 118 #define ICE_MDID_SIZE 2
 119
 120 #define ICE_TUN_FLAG_MDID 21
 121 #define ICE_TUN_FLAG_MDID_OFF (ICE_MDID_SIZE * ICE_TUN_FLAG_MDID)
 122 #define ICE_TUN_FLAG_MASK 0xFF
 123
 124 #define ICE_VLAN_FLAG_MDID 20
 125 #define ICE_VLAN_FLAG_MDID_OFF (ICE_MDID_SIZE * ICE_VLAN_FLAG_MDID)
 126 #define ICE_PKT_FLAGS_0_TO_15_VLAN_FLAGS_MASK 0xD000
 127
 128 #define ICE_TUN_FLAG_FV_IND 2
 129
 130 /* Mapping of software defined protocol ID to hardware defined protocol ID */
 131 struct ice_protocol_entry {
 132         enum ice_protocol_type type;
 133         u8 protocol_id;
 134 };
 135
 136 struct ice_ether_hdr {
 137         u8 dst_addr[ETH_ALEN];
 138         u8 src_addr[ETH_ALEN];
 139 };
 140
 141 struct ice_ethtype_hdr {
 142         __be16 ethtype_id;
 143 };
 144
 145 struct ice_ether_vlan_hdr {
 146         u8 dst_addr[ETH_ALEN];
 147         u8 src_addr[ETH_ALEN];
 148         __be32 vlan_id;
 149 };
 150
 151 struct ice_vlan_hdr {
 152         __be16 type;
 153         __be16 vlan;
 154 };
 155
 156 struct ice_ipv4_hdr {
 157         u8 version;
 158         u8 tos;
 159         __be16 total_length;
 160         __be16 id;
 161         __be16 frag_off;
 162         u8 time_to_live;
 163         u8 protocol;
 164         __be16 check;
 165         __be32 src_addr;
 166         __be32 dst_addr;
 167 };
 168
 169 struct ice_ipv6_hdr {
 170         __be32 be_ver_tc_flow;
 171         __be16 payload_len;
 172         u8 next_hdr;
 173         u8 hop_limit;
 174         u8 src_addr[ICE_IPV6_ADDR_LENGTH];
 175         u8 dst_addr[ICE_IPV6_ADDR_LENGTH];
 176 };
 177
 178 struct ice_sctp_hdr {
 179         __be16 src_port;
 180         __be16 dst_port;
 181         __be32 verification_tag;
 182         __be32 check;
 183 };
 184
 185 struct ice_l4_hdr {
 186         __be16 src_port;
 187         __be16 dst_port;
 188         __be16 len;
 189         __be16 check;
 190 };
 191
 192 struct ice_udp_tnl_hdr {
 193         __be16 field;
 194         __be16 proto_type;
 195         __be32 vni;     /* only use lower 24-bits */
 196 };
 197
 198 struct ice_udp_gtp_hdr {
 199         u8 flags;
 200         u8 msg_type;
 201         __be16 rsrvd_len;
 202         __be32 teid;
 203         __be16 rsrvd_seq_nbr;
 204         u8 rsrvd_n_pdu_nbr;
 205         u8 rsrvd_next_ext;
 206         u8 rsvrd_ext_len;
 207         u8 pdu_type;
 208         u8 qfi;
 209         u8 rsvrd;
 210 };
 211
 212 struct ice_pppoe_hdr {
 213         u8 rsrvd_ver_type;
 214         u8 rsrvd_code;
 215         __be16 session_id;
 216         __be16 length;
 217         __be16 ppp_prot_id; /* control and data only */
 218 };
 219
 220 struct ice_nvgre_hdr {
 221         __be16 flags;
 222         __be16 protocol;
 223         __be32 tni_flow;
 224 };
 225
 226 union ice_prot_hdr {
 227         struct ice_ether_hdr eth_hdr;
 228         struct ice_ethtype_hdr ethertype;
 229         struct ice_vlan_hdr vlan_hdr;
 230         struct ice_ipv4_hdr ipv4_hdr;
 231         struct ice_ipv6_hdr ipv6_hdr;
 232         struct ice_l4_hdr l4_hdr;
 233         struct ice_sctp_hdr sctp_hdr;
 234         struct ice_udp_tnl_hdr tnl_hdr;
 235         struct ice_nvgre_hdr nvgre_hdr;
 236         struct ice_udp_gtp_hdr gtp_hdr;
 237         struct ice_pppoe_hdr pppoe_hdr;
 238 };
 239
 240 /* This is mapping table entry that maps every word within a given protocol
 241  * structure to the real byte offset as per the specification of that
 242  * protocol header.
 243  * for e.g. dst address is 3 words in ethertype header and corresponding bytes
 244  * are 0, 2, 3 in the actual packet header and src address is at 4, 6, 8
 245  */
 246 struct ice_prot_ext_tbl_entry {
 247         enum ice_protocol_type prot_type;
 248         /* Byte offset into header of given protocol type */
 249         u8 offs[sizeof(union ice_prot_hdr)];
 250 };
 251
 252 /* Extractions to be looked up for a given recipe */
 253 struct ice_prot_lkup_ext {
 254         u16 prot_type;
 255         u8 n_val_words;
 256         /* create a buffer to hold max words per recipe */
 257         u16 field_off[ICE_MAX_CHAIN_WORDS];
 258         u16 field_mask[ICE_MAX_CHAIN_WORDS];
 259
 260         struct ice_fv_word fv_words[ICE_MAX_CHAIN_WORDS];
 261
 262         /* Indicate field offsets that have field vector indices assigned */
 263         DECLARE_BITMAP(done, ICE_MAX_CHAIN_WORDS);
 264 };
 265
 266 struct ice_pref_recipe_group {
 267         u8 n_val_pairs;         /* Number of valid pairs */
 268         struct ice_fv_word pairs[ICE_NUM_WORDS_RECIPE];
 269         u16 mask[ICE_NUM_WORDS_RECIPE];
 270 };
 271
 272 struct ice_recp_grp_entry {
 273         struct list_head l_entry;
 274
 275 #define ICE_INVAL_CHAIN_IND 0xFF
 276         u16 rid;
 277         u8 chain_idx;
 278         u16 fv_idx[ICE_NUM_WORDS_RECIPE];
 279         u16 fv_mask[ICE_NUM_WORDS_RECIPE];
 280         struct ice_pref_recipe_group r_group;
 281 };
 282 #endif /* _ICE_PROTOCOL_TYPE_H_ */