root/drivers/net/ethernet/intel/ice/ice_fdir.h
/* SPDX-License-Identifier: GPL-2.0 */
/* Copyright (C) 2018-2020, Intel Corporation. */

#ifndef _ICE_FDIR_H_
#define _ICE_FDIR_H_

#define ICE_FDIR_TUN_PKT_OFF            50
#define ICE_FDIR_MAX_RAW_PKT_SIZE       (512 + ICE_FDIR_TUN_PKT_OFF)

/* macros for offsets into packets for flow director programming */
#define ICE_ETH_TYPE_F_OFFSET           12
#define ICE_ETH_VLAN_TCI_OFFSET         14
#define ICE_ETH_TYPE_VLAN_OFFSET        16
#define ICE_IPV4_SRC_ADDR_OFFSET        26
#define ICE_IPV4_DST_ADDR_OFFSET        30
#define ICE_IPV4_TCP_SRC_PORT_OFFSET    34
#define ICE_IPV4_TCP_DST_PORT_OFFSET    36
#define ICE_IPV4_UDP_SRC_PORT_OFFSET    34
#define ICE_IPV4_UDP_DST_PORT_OFFSET    36
#define ICE_IPV4_SCTP_SRC_PORT_OFFSET   34
#define ICE_IPV4_SCTP_DST_PORT_OFFSET   36
#define ICE_IPV4_PROTO_OFFSET           23
#define ICE_IPV6_SRC_ADDR_OFFSET        22
#define ICE_IPV6_DST_ADDR_OFFSET        38
#define ICE_IPV6_TCP_SRC_PORT_OFFSET    54
#define ICE_IPV6_TCP_DST_PORT_OFFSET    56
#define ICE_IPV6_UDP_SRC_PORT_OFFSET    54
#define ICE_IPV6_UDP_DST_PORT_OFFSET    56
#define ICE_IPV6_SCTP_SRC_PORT_OFFSET   54
#define ICE_IPV6_SCTP_DST_PORT_OFFSET   56
#define ICE_MAC_ETHTYPE_OFFSET          12
#define ICE_IPV4_TOS_OFFSET             15
#define ICE_IPV4_TTL_OFFSET             22
#define ICE_IPV6_TC_OFFSET              14
#define ICE_IPV6_HLIM_OFFSET            21
#define ICE_IPV6_PROTO_OFFSET           20
#define ICE_IPV4_GTPU_TEID_OFFSET       46
#define ICE_IPV4_GTPU_QFI_OFFSET        56
#define ICE_IPV4_L2TPV3_SESS_ID_OFFSET  34
#define ICE_IPV6_L2TPV3_SESS_ID_OFFSET  54
#define ICE_IPV4_ESP_SPI_OFFSET         34
#define ICE_IPV6_ESP_SPI_OFFSET         54
#define ICE_IPV4_AH_SPI_OFFSET          38
#define ICE_IPV6_AH_SPI_OFFSET          58
#define ICE_IPV4_NAT_T_ESP_SPI_OFFSET   42
#define ICE_IPV6_NAT_T_ESP_SPI_OFFSET   62

#define ICE_FDIR_MAX_FLTRS              16384

/* IP v4 has 2 flag bits that enable fragment processing: DF and MF. DF
 * requests that the packet not be fragmented. MF indicates that a packet has
 * been fragmented.
 */
#define ICE_FDIR_IPV4_PKT_FLAG_MF               0x20

#define ICE_FDIR_NO_QUEUE_IDX                   -1

enum ice_fltr_prgm_desc_dest {
        ICE_FLTR_PRGM_DESC_DEST_DROP_PKT,
        ICE_FLTR_PRGM_DESC_DEST_DIRECT_PKT_QINDEX,
        ICE_FLTR_PRGM_DESC_DEST_DIRECT_PKT_QGROUP,
        ICE_FLTR_PRGM_DESC_DEST_DIRECT_PKT_OTHER,
};

enum ice_fltr_prgm_desc_fd_status {
        ICE_FLTR_PRGM_DESC_FD_STATUS_NONE,
        ICE_FLTR_PRGM_DESC_FD_STATUS_FD_ID,
};

/* Flow Director (FD) Filter Programming descriptor */
struct ice_fd_fltr_desc_ctx {
        u32 fdid;
        u16 qindex;
        u16 cnt_index;
        u16 fd_vsi;
        u16 flex_val;
        u8 comp_q;
        u8 comp_report;
        u8 fd_space;
        u8 cnt_ena;
        u8 evict_ena;
        u8 toq;
        u8 toq_prio;
        u8 dpu_recipe;
        u8 drop;
        u8 flex_prio;
        u8 flex_mdid;
        u8 dtype;
        u8 pcmd;
        u8 desc_prof_prio;
        u8 desc_prof;
        u8 swap;
        u8 fdid_prio;
        u8 fdid_mdid;
};

#define ICE_FLTR_PRGM_FLEX_WORD_SIZE    sizeof(__be16)

struct ice_rx_flow_userdef {
        u16 flex_word;
        u16 flex_offset;
        u16 flex_fltr;
};

struct ice_fdir_v4 {
        __be32 dst_ip;
        __be32 src_ip;
        __be16 dst_port;
        __be16 src_port;
        __be32 l4_header;
        __be32 sec_parm_idx;    /* security parameter index */
        u8 tos;
        u8 ip_ver;
        u8 proto;
        u8 ttl;
};

#define ICE_IPV6_ADDR_LEN_AS_U32                4

struct ice_fdir_v6 {
        __be32 dst_ip[ICE_IPV6_ADDR_LEN_AS_U32];
        __be32 src_ip[ICE_IPV6_ADDR_LEN_AS_U32];
        __be16 dst_port;
        __be16 src_port;
        __be32 l4_header; /* next header */
        __be32 sec_parm_idx; /* security parameter index */
        u8 tc;
        u8 proto;
        u8 hlim;
};

struct ice_fdir_udp_gtp {
        u8 flags;
        u8 msg_type;
        __be16 rsrvd_len;
        __be32 teid;
        __be16 rsrvd_seq_nbr;
        u8 rsrvd_n_pdu_nbr;
        u8 rsrvd_next_ext_type;
        u8 rsvrd_ext_len;
        u8      pdu_type:4,
                spare:4;
        u8      ppp:1,
                rqi:1,
                qfi:6;
        u32 rsvrd;
        u8 next_ext;
};

struct ice_fdir_l2tpv3 {
        __be32 session_id;
};

struct ice_fdir_extra {
        u8 dst_mac[ETH_ALEN];   /* dest MAC address */
        u8 src_mac[ETH_ALEN];   /* src MAC address */
        __be16 ether_type;      /* for NON_IP_L2 */
        u32 usr_def[2];         /* user data */
        __be16 vlan_type;       /* VLAN ethertype */
        __be16 vlan_tag;        /* VLAN tag info */
};

struct ice_fdir_fltr {
        struct list_head fltr_node;
        enum ice_fltr_ptype flow_type;

        struct ethhdr eth, eth_mask;

        union {
                struct ice_fdir_v4 v4;
                struct ice_fdir_v6 v6;
        } ip, mask;

        struct ice_fdir_udp_gtp gtpu_data;
        struct ice_fdir_udp_gtp gtpu_mask;

        struct ice_fdir_l2tpv3 l2tpv3_data;
        struct ice_fdir_l2tpv3 l2tpv3_mask;

        struct ice_fdir_extra ext_data;
        struct ice_fdir_extra ext_mask;

        /* flex byte filter data */
        __be16 flex_word;
        /* queue region size (=2^q_region) */
        u8 q_region;
        u16 flex_offset;
        u16 flex_fltr;

        /* filter control */
        s16 q_index;
        u16 orig_q_index;
        u16 dest_vsi;
        u8 dest_ctl;
        u8 cnt_ena;
        u8 fltr_status;
        u16 cnt_index;
        u32 fltr_id;
        u8 fdid_prio;
        u8 comp_report;
};

/* Dummy packet filter definition structure */
struct ice_fdir_base_pkt {
        enum ice_fltr_ptype flow;
        u16 pkt_len;
        const u8 *pkt;
        u16 tun_pkt_len;
        const u8 *tun_pkt;
};

struct ice_vsi;

int ice_alloc_fd_res_cntr(struct ice_hw *hw, u16 *cntr_id);
int ice_free_fd_res_cntr(struct ice_hw *hw, u16 cntr_id);
int ice_alloc_fd_guar_item(struct ice_hw *hw, u16 *cntr_id, u16 num_fltr);
int ice_alloc_fd_shrd_item(struct ice_hw *hw, u16 *cntr_id, u16 num_fltr);
void
ice_fdir_get_prgm_desc(struct ice_hw *hw, struct ice_fdir_fltr *input,
                       struct ice_fltr_desc *fdesc, bool add);
int
ice_fdir_get_gen_prgm_pkt(struct ice_hw *hw, struct ice_fdir_fltr *input,
                          u8 *pkt, bool frag, bool tun);
int ice_get_fdir_cnt_all(struct ice_hw *hw);
int ice_fdir_num_avail_fltr(struct ice_hw *hw, struct ice_vsi *vsi);
bool ice_fdir_is_dup_fltr(struct ice_hw *hw, struct ice_fdir_fltr *input);
bool ice_fdir_has_frag(enum ice_fltr_ptype flow);
struct ice_fdir_fltr *
ice_fdir_find_fltr_by_idx(struct ice_hw *hw, u32 fltr_idx);
void
ice_fdir_update_cntrs(struct ice_hw *hw, enum ice_fltr_ptype flow, bool add);
void ice_fdir_list_add_fltr(struct ice_hw *hw, struct ice_fdir_fltr *input);
#endif /* _ICE_FDIR_H_ */