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