xref: /dpdk/drivers/net/hns3/hns3_fdir.h (revision ac72aae60f71b8716f65d1e2daf531a5ca38c998)

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2018-2021 HiSilicon Limited.
 */

#ifndef HNS3_FDIR_H
#define HNS3_FDIR_H

#include <stdint.h>

#include <rte_flow.h>

struct hns3_fd_key_cfg {
	uint8_t key_sel;
	uint8_t inner_sipv6_word_en;
	uint8_t inner_dipv6_word_en;
	uint8_t outer_sipv6_word_en;
	uint8_t outer_dipv6_word_en;
	uint32_t tuple_active;
	uint32_t meta_data_active;
};

enum HNS3_FD_STAGE {
	HNS3_FD_STAGE_1,
	HNS3_FD_STAGE_2,
	HNS3_FD_STAGE_NUM,
};

enum HNS3_FD_ACTION {
	HNS3_FD_ACTION_ACCEPT_PACKET,
	HNS3_FD_ACTION_DROP_PACKET,
};

struct hns3_fd_cfg {
	uint8_t fd_mode;
	uint16_t max_key_length;
	uint32_t rule_num[HNS3_FD_STAGE_NUM]; /* rule entry number */
	uint16_t cnt_num[HNS3_FD_STAGE_NUM];  /* rule hit counter number */
	struct hns3_fd_key_cfg key_cfg[HNS3_FD_STAGE_NUM];
};

/* OUTER_XXX indicates tuples in tunnel header of tunnel packet
 * INNER_XXX indicate tuples in tunneled header of tunnel packet or
 *           tuples of non-tunnel packet
 */
enum HNS3_FD_TUPLE {
	OUTER_DST_MAC,
	OUTER_SRC_MAC,
	OUTER_VLAN_TAG_FST,
	OUTER_VLAN_TAG_SEC,
	OUTER_ETH_TYPE,
	OUTER_L2_RSV,
	OUTER_IP_TOS,
	OUTER_IP_PROTO,
	OUTER_SRC_IP,
	OUTER_DST_IP,
	OUTER_L3_RSV,
	OUTER_SRC_PORT,
	OUTER_DST_PORT,
	OUTER_L4_RSV,
	OUTER_TUN_VNI,
	OUTER_TUN_FLOW_ID,
	INNER_DST_MAC,
	INNER_SRC_MAC,
	INNER_VLAN_TAG1,
	INNER_VLAN_TAG2,
	INNER_ETH_TYPE,
	INNER_L2_RSV,
	INNER_IP_TOS,
	INNER_IP_PROTO,
	INNER_SRC_IP,
	INNER_DST_IP,
	INNER_L3_RSV,
	INNER_SRC_PORT,
	INNER_DST_PORT,
	INNER_SCTP_TAG,
	MAX_TUPLE,
};

#define VLAN_TAG_NUM_MAX 2
#define VNI_OR_TNI_LEN 3
#define IP_ADDR_LEN    4 /* Length of IPv6 address. */
#define IP_ADDR_KEY_ID 3 /* The last 32bit of IP address as FDIR search key */
#define IPV6_ADDR_WORD_MASK 3 /* The last two word of IPv6 as FDIR search key */

struct hns3_fd_rule_tuples {
	uint8_t src_mac[RTE_ETHER_ADDR_LEN];
	uint8_t dst_mac[RTE_ETHER_ADDR_LEN];
	uint32_t src_ip[IP_ADDR_LEN];
	uint32_t dst_ip[IP_ADDR_LEN];
	uint16_t src_port;
	uint16_t dst_port;
	uint16_t vlan_tag1;
	uint16_t vlan_tag2;
	uint16_t ether_type;
	uint8_t ip_tos;
	uint8_t ip_proto;
	uint32_t sctp_tag;
	uint16_t outer_src_port;
	uint16_t tunnel_type;
	uint16_t outer_vlan_tag1;
	uint16_t outer_vlan_tag2;
	uint16_t outer_ether_type;
	uint8_t outer_proto;
	uint8_t outer_tun_vni[VNI_OR_TNI_LEN];
	uint8_t outer_tun_flow_id;
};

struct hns3_fd_ad_data {
	uint16_t ad_id;
	uint8_t drop_packet;
	/*
	 * equal 0 when action is drop.
	 * index of queue when action is queue.
	 * index of first queue of queue region when action is queue region.
	 */
	uint16_t queue_id;
	/*
	 * equal 0 when action is drop.
	 * equal 1 when action is queue.
	 * numbers of queues of queue region when action is queue region.
	 */
	uint16_t nb_queues;
	uint8_t use_counter;
	uint8_t counter_id;
	uint8_t use_next_stage;
	uint8_t write_rule_id_to_bd;
	uint8_t next_input_key;
	uint16_t rule_id;
};

#define HNS3_RULE_FLAG_FDID		0x1
#define HNS3_RULE_FLAG_VF_ID		0x2
#define HNS3_RULE_FLAG_COUNTER		0x4
#define HNS3_RULE_FLAG_COUNTER_INDIR	0x8

struct hns3_fdir_key_conf {
	struct hns3_fd_rule_tuples spec;
	struct hns3_fd_rule_tuples mask;
	uint8_t vlan_num;
	uint8_t outer_vlan_num;
};

struct hns3_fdir_rule {
	struct hns3_fdir_key_conf key_conf;
	uint32_t input_set;
	uint32_t flags;
	uint32_t fd_id; /* APP marked unique value for this rule. */
	uint8_t action;
	/* VF id, available when flags with HNS3_RULE_FLAG_VF_ID. */
	uint8_t vf_id;
	/*
	 * equal 0 when action is drop.
	 * index of queue when action is queue.
	 * index of first queue of queue region when action is queue region.
	 */
	uint16_t queue_id;
	/*
	 * equal 0 when action is drop.
	 * equal 1 when action is queue.
	 * numbers of queues of queue region when action is queue region.
	 */
	uint16_t nb_queues;
	uint16_t location;
	struct rte_flow_action_count act_cnt;
	bool has_vlan_m;
	bool has_vlan_v;
	bool has_more_vlan_m;
	bool has_more_vlan_v;
};

/* FDIR filter list structure */
struct hns3_fdir_rule_ele {
	TAILQ_ENTRY(hns3_fdir_rule_ele) entries;
	struct hns3_fdir_rule fdir_conf;
};

TAILQ_HEAD(hns3_fdir_rule_list, hns3_fdir_rule_ele);

/*
 * On 'strict' mode, hardware bases on VLAN number to exactly match the
 * input flow.
 */
#define HNS3_FDIR_VLAN_STRICT_MATCH	1
#define HNS3_FDIR_VLAN_NOSTRICT_MATCH	0

/*
 * The hardware supports many tuples match (see @enum HNS3_FD_TUPLE),
 * however, the width of hardware entries is limited, therefore, only part
 * of tuples are enabled (see as @hns3_init_fd_config).
 *
 * We should replace the existing tuples if we want to enable other tuples
 * because the width capacity is insufficient.
 */
enum hns3_fdir_tuple_config {
	/* Default tuple config (see as @hns3_init_fd_config). */
	HNS3_FDIR_TUPLE_CONFIG_DEFAULT,
	/*
	 * Based on the default tuple config, disable the inner src-mac tuple,
	 * and enable the outer VLAN tuple.
	 */
	HNS3_FDIR_TUPLE_OUTVLAN_REPLACE_INSMAC,
	/*
	 * Based on the default tuple config, disable the inner dst-mac tuple,
	 * and enable the outer VLAN tuple.
	 */
	HNS3_FDIR_TUPLE_OUTVLAN_REPLACE_INDMAC,
	/*
	 * Based on the default tuple config, disable the inner src-ip tuple,
	 * and enable the outer VLAN tuple.
	 */
	HNS3_FDIR_TUPLE_OUTVLAN_REPLACE_INSIP,
	/*
	 * Based on the default tuple config, disable the inner dst-ip tuple,
	 * and enable the outer VLAN tuple.
	 */
	HNS3_FDIR_TUPLE_OUTVLAN_REPLACE_INDIP,
	/*
	 * Based on the default tuple config, disable the sctp-tag tuple,
	 * and enable the outer VLAN tuple.
	 */
	HNS3_FDIR_TUPLE_OUTVLAN_REPLACE_SCTPTAG,
	/*
	 * Based on the default tuple config, disable the tunnel vni tuple,
	 * and enable the outer VLAN tuple.
	 */
	HNS3_FDIR_TUPLE_OUTVLAN_REPLACE_TUNVNI,

	HNS3_FDIR_TUPLE_CONFIG_BUTT
};

enum hns3_fdir_index_config {
	/* Generate the hardware flow director index based on rte_hash (Default) */
	HNS3_FDIR_INDEX_CONFIG_HASH,

	/* Use the rte_flow priority field as the hardware flow director index. */
	HNS3_FDIR_INDEX_CONFIG_PRIORITY
};

/*
 *  A structure used to define fields of a FDIR related info.
 */
struct hns3_fdir_info {
	struct hns3_fdir_rule_list fdir_list;
	struct hns3_fdir_rule_ele **hash_map;
	struct rte_hash *hash_handle;
	struct hns3_fd_cfg fd_cfg;
	uint8_t vlan_match_mode;
	enum hns3_fdir_tuple_config tuple_cfg;
	enum hns3_fdir_index_config index_cfg;
};

struct hns3_adapter;
struct hns3_hw;

int hns3_init_fd_config(struct hns3_adapter *hns);
int hns3_fdir_filter_init(struct hns3_adapter *hns);
void hns3_fdir_filter_uninit(struct hns3_adapter *hns);
int hns3_fdir_filter_program(struct hns3_adapter *hns,
			     struct hns3_fdir_rule *rule, bool del);
int hns3_clear_all_fdir_filter(struct hns3_adapter *hns);
int hns3_fd_get_count(struct hns3_hw *hw, uint32_t id, uint64_t *value);
int hns3_restore_all_fdir_filter(struct hns3_adapter *hns);

enum hns3_fdir_tuple_config hns3_parse_tuple_config(const char *name);
const char *hns3_tuple_config_name(enum hns3_fdir_tuple_config tuple_cfg);
const char *hns3_fdir_index_config_name(enum hns3_fdir_index_config cfg);

#endif /* HNS3_FDIR_H */