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