drivers/net/ice/base/ice_fdir.h

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