drivers/net/ice/base/ice_fdir.h

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