drivers/net/ice/base/ice_fdir.h

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