drivers/net/ice/base/ice_fdir.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2001-2021 Intel Corporation
   3  */
   4
   5 #ifndef _ICE_FDIR_H_
   6 #define _ICE_FDIR_H_
   7
   8 #include "ice_common.h"
   9
  10 #define ICE_FDIR_IP_PROTOCOLS
  11 #define ICE_IP_PROTO_TCP                6
  12 #define ICE_IP_PROTO_UDP                17
  13 #define ICE_IP_PROTO_SCTP               132
  14 #define ICE_IP_PROTO_IP                 0
  15 #define ICE_IP_PROTO_ESP                50
  16
  17 #define ICE_FDIR_GTPU_IP_INNER_PKT_OFF 50
  18 #define ICE_FDIR_GTPU_EH_INNER_PKT_OFF 58
  19
  20 #define ICE_FDIR_TUN_PKT_OFF            50
  21 #define ICE_FDIR_MAX_RAW_PKT_SIZE       (512 + ICE_FDIR_TUN_PKT_OFF)
  22 #define ICE_FDIR_BUF_FULL_MARGIN        10
  23
  24 /* macros for offsets into packets for flow director programming */
  25 #define ICE_IPV4_SRC_ADDR_OFFSET        26
  26 #define ICE_IPV4_DST_ADDR_OFFSET        30
  27 #define ICE_IPV4_TCP_SRC_PORT_OFFSET    34
  28 #define ICE_IPV4_TCP_DST_PORT_OFFSET    36
  29 #define ICE_IPV4_UDP_SRC_PORT_OFFSET    34
  30 #define ICE_IPV4_UDP_DST_PORT_OFFSET    36
  31 #define ICE_IPV4_SCTP_SRC_PORT_OFFSET   34
  32 #define ICE_IPV4_SCTP_DST_PORT_OFFSET   36
  33 #define ICE_IPV4_PROTO_OFFSET           23
  34 #define ICE_IPV6_SRC_ADDR_OFFSET        22
  35 #define ICE_IPV6_DST_ADDR_OFFSET        38
  36 #define ICE_IPV6_TCP_SRC_PORT_OFFSET    54
  37 #define ICE_IPV6_TCP_DST_PORT_OFFSET    56
  38 #define ICE_IPV6_UDP_SRC_PORT_OFFSET    54
  39 #define ICE_IPV6_UDP_DST_PORT_OFFSET    56
  40 #define ICE_IPV6_SCTP_SRC_PORT_OFFSET   54
  41 #define ICE_IPV6_SCTP_DST_PORT_OFFSET   56
  42
  43 #define ICE_MAC_ETHTYPE_OFFSET          12
  44 #define ICE_IPV4_TOS_OFFSET             15
  45 #define ICE_IPV4_TTL_OFFSET             22
  46 #define ICE_IPV6_TC_OFFSET              14
  47 #define ICE_IPV6_HLIM_OFFSET            21
  48 #define ICE_IPV6_PROTO_OFFSET           20
  49 /* For TUN inner (without inner MAC) */
  50 #define ICE_IPV4_NO_MAC_TOS_OFFSET      1
  51 #define ICE_IPV4_NO_MAC_TTL_OFFSET      8
  52 #define ICE_IPV4_NO_MAC_PROTO_OFFSET    9
  53 #define ICE_IPV4_NO_MAC_SRC_ADDR_OFFSET 12
  54 #define ICE_IPV4_NO_MAC_DST_ADDR_OFFSET 16
  55 #define ICE_TCP4_NO_MAC_SRC_PORT_OFFSET 20
  56 #define ICE_TCP4_NO_MAC_DST_PORT_OFFSET 22
  57 #define ICE_UDP4_NO_MAC_SRC_PORT_OFFSET 20
  58 #define ICE_UDP4_NO_MAC_DST_PORT_OFFSET 22
  59 #define ICE_IPV6_NO_MAC_TC_OFFSET       0
  60 #define ICE_IPV6_NO_MAC_HLIM_OFFSET     7
  61 #define ICE_IPV6_NO_MAC_PROTO_OFFSET    6
  62 #define ICE_IPV6_NO_MAC_SRC_ADDR_OFFSET 8
  63 #define ICE_IPV6_NO_MAC_DST_ADDR_OFFSET 24
  64 #define ICE_TCP6_NO_MAC_SRC_PORT_OFFSET 40
  65 #define ICE_TCP6_NO_MAC_DST_PORT_OFFSET 42
  66 #define ICE_UDP6_NO_MAC_SRC_PORT_OFFSET 40
  67 #define ICE_UDP6_NO_MAC_DST_PORT_OFFSET 42
  68 #define ICE_IPV4_GTPU_TEID_OFFSET       46
  69 #define ICE_IPV4_GTPU_QFI_OFFSET        56
  70 #define ICE_IPV6_GTPU_TEID_OFFSET       66
  71 #define ICE_IPV6_GTPU_QFI_OFFSET        76
  72 #define ICE_IPV4_L2TPV3_SESS_ID_OFFSET  34
  73 #define ICE_IPV6_L2TPV3_SESS_ID_OFFSET  54
  74 #define ICE_IPV4_ESP_SPI_OFFSET         34
  75 #define ICE_IPV6_ESP_SPI_OFFSET         54
  76 #define ICE_IPV4_AH_SPI_OFFSET          38
  77 #define ICE_IPV6_AH_SPI_OFFSET          58
  78 #define ICE_IPV4_NAT_T_ESP_SPI_OFFSET   42
  79 #define ICE_IPV6_NAT_T_ESP_SPI_OFFSET   62
  80 #define ICE_IPV4_VXLAN_VNI_OFFSET       45
  81 #define ICE_ECPRI_TP0_PC_ID_OFFSET      18
  82 #define ICE_IPV4_UDP_ECPRI_TP0_PC_ID_OFFSET                     46
  83
  84 #define ICE_FDIR_MAX_FLTRS              16384
  85
  86 /* IPv4 has 2 flag bits that enable fragment processing: DF and MF. DF
  87  * requests that the packet not be fragmented. MF indicates that a packet has
  88  * been fragmented, except that for the last fragment has a non-zero
  89  * Fragment Offset field with zero MF.
  90  */
  91 #define ICE_FDIR_IPV4_PKT_FLAG_MF               0x20
  92 #define ICE_FDIR_IPV4_PKT_FLAG_MF_SHIFT 8
  93 #define ICE_FDIR_IPV4_PKT_FLAG_DF               0x40
  94
  95 /* For IPv6 fragmented packets, all fragments except the last have
  96  * the MF flag set.
  97  */
  98 #define ICE_FDIR_IPV6_PKT_FLAG_MF               0x100
  99 #define ICE_FDIR_IPV6_PKT_FLAG_MF_SHIFT 8
 100
 101 enum ice_fltr_prgm_desc_dest {
 102         ICE_FLTR_PRGM_DESC_DEST_DROP_PKT,
 103         ICE_FLTR_PRGM_DESC_DEST_DIRECT_PKT_QINDEX,
 104         ICE_FLTR_PRGM_DESC_DEST_DIRECT_PKT_QGROUP,
 105         ICE_FLTR_PRGM_DESC_DEST_DIRECT_PKT_OTHER,
 106 };
 107
 108 enum ice_fltr_prgm_desc_fd_status {
 109         ICE_FLTR_PRGM_DESC_FD_STATUS_NONE,
 110         ICE_FLTR_PRGM_DESC_FD_STATUS_FD_ID,
 111         ICE_FLTR_PRGM_DESC_FD_STATUS_FD_ID_4FLEX_BYTES,
 112         ICE_FLTR_PRGM_DESC_FD_STATUS_8FLEX_BYTES,
 113 };
 114
 115 /* Flow Director (FD) Filter Programming descriptor */
 116 struct ice_fd_fltr_desc_ctx {
 117         u32 fdid;
 118         u16 qindex;
 119         u16 cnt_index;
 120         u16 fd_vsi;
 121         u16 flex_val;
 122         u8 comp_q;
 123         u8 comp_report;
 124         u8 fd_space;
 125         u8 cnt_ena;
 126         u8 evict_ena;
 127         u8 toq;
 128         u8 toq_prio;
 129         u8 dpu_recipe;
 130         u8 drop;
 131         u8 flex_prio;
 132         u8 flex_mdid;
 133         u8 dtype;
 134         u8 pcmd;
 135         u8 desc_prof_prio;
 136         u8 desc_prof;
 137         u8 swap;
 138         u8 fdid_prio;
 139         u8 fdid_mdid;
 140 };
 141
 142 #define ICE_FLTR_PRGM_FLEX_WORD_SIZE    sizeof(__be16)
 143
 144 struct ice_rx_flow_userdef {
 145         u16 flex_word;
 146         u16 flex_offset;
 147         u16 flex_fltr;
 148 };
 149
 150 struct ice_fdir_v4 {
 151         __be32 dst_ip;
 152         __be32 src_ip;
 153         __be16 dst_port;
 154         __be16 src_port;
 155         __be32 l4_header;
 156         __be32 sec_parm_idx;    /* security parameter index */
 157         u8 tos;
 158         u8 ip_ver;
 159         u8 proto;
 160         u8 ttl;
 161 };
 162
 163 #define ICE_IPV6_ADDR_LEN_AS_U32                4
 164
 165 struct ice_fdir_v6 {
 166         __be32 dst_ip[ICE_IPV6_ADDR_LEN_AS_U32];
 167         __be32 src_ip[ICE_IPV6_ADDR_LEN_AS_U32];
 168         __be16 dst_port;
 169         __be16 src_port;
 170         __be32 l4_header; /* next header */
 171         __be32 sec_parm_idx; /* security parameter index */
 172         u8 tc;
 173         u8 proto;
 174         u8 hlim;
 175 };
 176
 177 struct ice_fdir_udp_gtp {
 178         u8 flags;
 179         u8 msg_type;
 180         __be16 rsrvd_len;
 181         __be32 teid;
 182         __be16 rsrvd_seq_nbr;
 183         u8 rsrvd_n_pdu_nbr;
 184         u8 rsrvd_next_ext_type;
 185         u8 rsvrd_ext_len;
 186         u8      pdu_type:4,
 187                 spare:4;
 188         u8      ppp:1,
 189                 rqi:1,
 190                 qfi:6;
 191         u32 rsvrd;
 192         u8 next_ext;
 193 };
 194
 195 struct ice_fdir_l2tpv3 {
 196         __be32 session_id;
 197 };
 198
 199 struct ice_fdir_udp_vxlan {
 200         __be32 vni; /* 8 bits reserved, always be zero */
 201 };
 202
 203 struct ice_fdir_ecpri {
 204         __be16 pc_id;
 205 };
 206
 207 struct ice_fdir_extra {
 208         u8 dst_mac[ETH_ALEN];   /* dest MAC address */
 209         u8 src_mac[ETH_ALEN];   /* src MAC address */
 210         __be16 ether_type;      /* for NON_IP_L2 */
 211         u32 usr_def[2];         /* user data */
 212         __be16 vlan_type;       /* VLAN ethertype */
 213         __be16 vlan_tag;        /* VLAN tag info */
 214 };
 215
 216 struct ice_fdir_fltr {
 217         struct LIST_ENTRY_TYPE fltr_node;
 218         enum ice_fltr_ptype flow_type;
 219
 220         union {
 221                 struct ice_fdir_v4 v4;
 222                 struct ice_fdir_v6 v6;
 223         } ip, mask;
 224
 225         /* for tunnel outer part */
 226         union {
 227                 struct ice_fdir_v4 v4;
 228                 struct ice_fdir_v6 v6;
 229         } ip_outer, mask_outer;
 230
 231         struct ice_fdir_extra ext_data_outer;
 232         struct ice_fdir_extra ext_mask_outer;
 233
 234         struct ice_fdir_udp_vxlan vxlan_data;
 235         struct ice_fdir_udp_vxlan vxlan_mask;
 236
 237         struct ice_fdir_udp_gtp gtpu_data;
 238         struct ice_fdir_udp_gtp gtpu_mask;
 239
 240         struct ice_fdir_l2tpv3 l2tpv3_data;
 241         struct ice_fdir_l2tpv3 l2tpv3_mask;
 242
 243         struct ice_fdir_ecpri ecpri_data;
 244         struct ice_fdir_ecpri ecpri_mask;
 245
 246         struct ice_fdir_extra ext_data;
 247         struct ice_fdir_extra ext_mask;
 248
 249         /* flex byte filter data */
 250         __be16 flex_word;
 251         /* queue region size (=2^q_region) */
 252         u8 q_region;
 253         u16 flex_offset;
 254         u16 flex_fltr;
 255
 256         /* filter control */
 257         u16 q_index;
 258         u16 dest_vsi;
 259         u8 dest_ctl;
 260         u8 cnt_ena;
 261         u8 fltr_status;
 262         u16 cnt_index;
 263         u32 fltr_id;
 264         u8 fdid_prio;
 265         u8 comp_report;
 266         /* Set to true for an ACL filter */
 267         bool acl_fltr;
 268 };
 269
 270 /* Dummy packet filter definition structure */
 271 struct ice_fdir_base_pkt {
 272         enum ice_fltr_ptype flow;
 273         u16 pkt_len;
 274         const u8 *pkt;
 275         u16 tun_pkt_len;
 276         const u8 *tun_pkt;
 277 };
 278
 279 enum ice_status ice_alloc_fd_res_cntr(struct ice_hw *hw, u16 *cntr_id);
 280 enum ice_status ice_free_fd_res_cntr(struct ice_hw *hw, u16 cntr_id);
 281 enum ice_status
 282 ice_alloc_fd_guar_item(struct ice_hw *hw, u16 *cntr_id, u16 num_fltr);
 283 enum ice_status
 284 ice_free_fd_guar_item(struct ice_hw *hw, u16 cntr_id, u16 num_fltr);
 285 enum ice_status
 286 ice_alloc_fd_shrd_item(struct ice_hw *hw, u16 *cntr_id, u16 num_fltr);
 287 enum ice_status
 288 ice_free_fd_shrd_item(struct ice_hw *hw, u16 cntr_id, u16 num_fltr);
 289 enum ice_status ice_clear_pf_fd_table(struct ice_hw *hw);
 290 void
 291 ice_fdir_get_prgm_desc(struct ice_hw *hw, struct ice_fdir_fltr *input,
 292                        struct ice_fltr_desc *fdesc, bool add);
 293 enum ice_status
 294 ice_fdir_get_gen_prgm_pkt(struct ice_hw *hw, struct ice_fdir_fltr *input,
 295                           u8 *pkt, bool frag, bool tun);
 296 enum ice_status
 297 ice_fdir_get_prgm_pkt(struct ice_fdir_fltr *input, u8 *pkt, bool frag);
 298 int ice_get_fdir_cnt_all(struct ice_hw *hw);
 299 bool ice_fdir_is_dup_fltr(struct ice_hw *hw, struct ice_fdir_fltr *input);
 300 bool ice_fdir_has_frag(enum ice_fltr_ptype flow);
 301 struct ice_fdir_fltr *
 302 ice_fdir_find_fltr_by_idx(struct ice_hw *hw, u32 fltr_idx);
 303 void
 304 ice_fdir_update_cntrs(struct ice_hw *hw, enum ice_fltr_ptype flow,
 305                       bool acl_fltr, bool add);
 306 void ice_fdir_list_add_fltr(struct ice_hw *hw, struct ice_fdir_fltr *input);
 307 #endif /* _ICE_FDIR_H_ */