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