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_TEID_OFFSET       46
  91 #define ICE_IPV4_GTPU_QFI_OFFSET        56
  92
  93 #define ICE_FDIR_MAX_FLTRS              16384
  94
  95 /* IP v4 has 2 flag bits that enable fragment processing: DF and MF. DF
  96  * requests that the packet not be fragmented. MF indicates that a packet has
  97  * been fragmented.
  98  */
  99 #define ICE_FDIR_IPV4_PKT_FLAG_DF               0x20
 100 #define ICE_FDIR_IPV4_PKT_FLAG_MF               0x40
 101
 102 enum ice_fltr_prgm_desc_dest {
 103         ICE_FLTR_PRGM_DESC_DEST_DROP_PKT,
 104         ICE_FLTR_PRGM_DESC_DEST_DIRECT_PKT_QINDEX,
 105         ICE_FLTR_PRGM_DESC_DEST_DIRECT_PKT_QGROUP,
 106         ICE_FLTR_PRGM_DESC_DEST_DIRECT_PKT_OTHER,
 107 };
 108
 109 enum ice_fltr_prgm_desc_fd_status {
 110         ICE_FLTR_PRGM_DESC_FD_STATUS_NONE,
 111         ICE_FLTR_PRGM_DESC_FD_STATUS_FD_ID,
 112         ICE_FLTR_PRGM_DESC_FD_STATUS_FD_ID_4FLEX_BYTES,
 113         ICE_FLTR_PRGM_DESC_FD_STATUS_8FLEX_BYTES,
 114 };
 115
 116 #define ICE_FLTR_PRGM_FLEX_WORD_SIZE    sizeof(__be16)
 117
 118 struct ice_rx_flow_userdef {
 119         u16 flex_word;
 120         u16 flex_offset;
 121         u16 flex_fltr;
 122 };
 123
 124 struct ice_fdir_v4 {
 125         __be32 dst_ip;
 126         __be32 src_ip;
 127         __be16 dst_port;
 128         __be16 src_port;
 129         __be32 l4_header;
 130         __be32 sec_parm_idx;    /* security parameter index */
 131         u8 tos;
 132         u8 ip_ver;
 133         u8 proto;
 134         u8 ttl;
 135 };
 136
 137 #define ICE_IPV6_ADDR_LEN_AS_U32                4
 138
 139 struct ice_fdir_v6 {
 140         __be32 dst_ip[ICE_IPV6_ADDR_LEN_AS_U32];
 141         __be32 src_ip[ICE_IPV6_ADDR_LEN_AS_U32];
 142         __be16 dst_port;
 143         __be16 src_port;
 144         __be32 l4_header; /* next header */
 145         __be32 sec_parm_idx; /* security parameter index */
 146         u8 tc;
 147         u8 proto;
 148         u8 hlim;
 149 };
 150
 151 struct ice_fdir_udp_gtp {
 152         u8 flags;
 153         u8 msg_type;
 154         u16 rsrvd_len;
 155         u32 teid;
 156         u16 rsrvd_seq_nbr;
 157         u8 rsrvd_n_pdu_nbr;
 158         u8 rsrvd_next_ext_type;
 159         u8 rsvrd_ext_len;
 160         u8      pdu_type:4,
 161                 spare:4;
 162         u8      ppp:1,
 163                 rqi:1,
 164                 qfi:6;
 165         u32 rsvrd;
 166         u8 next_ext;
 167 };
 168
 169 struct ice_fdir_extra {
 170         u8 dst_mac[ETH_ALEN];   /* dest MAC address */
 171         u32 usr_def[2];         /* user data */
 172         __be16 vlan_type;       /* VLAN ethertype */
 173         __be16 vlan_tag;        /* VLAN tag info */
 174 };
 175
 176 struct ice_fdir_fltr {
 177         struct LIST_ENTRY_TYPE fltr_node;
 178         enum ice_fltr_ptype flow_type;
 179
 180         union {
 181                 struct ice_fdir_v4 v4;
 182                 struct ice_fdir_v6 v6;
 183         } ip, mask;
 184
 185         struct ice_fdir_udp_gtp gtpu_data;
 186         struct ice_fdir_udp_gtp gtpu_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 };
 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, bool add);
 237 void ice_fdir_list_add_fltr(struct ice_hw *hw, struct ice_fdir_fltr *input);
 238 #endif /* _ICE_FDIR_H_ */