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