ethdev: extend flow type and flexible payload type for flow director
[dpdk.git] / lib / librte_ether / rte_eth_ctrl.h
index b05d9eb..87d4075 100644 (file)
@@ -52,8 +52,10 @@ extern "C" {
 enum rte_filter_type {
        RTE_ETH_FILTER_NONE = 0,
        RTE_ETH_FILTER_MACVLAN,
+       RTE_ETH_FILTER_ETHERTYPE,
        RTE_ETH_FILTER_TUNNEL,
        RTE_ETH_FILTER_FDIR,
+       RTE_ETH_FILTER_HASH,
        RTE_ETH_FILTER_MAX
 };
 
@@ -61,8 +63,8 @@ enum rte_filter_type {
  * Generic operations on filters
  */
 enum rte_filter_op {
+       /** used to check whether the type filter is supported */
        RTE_ETH_FILTER_NOP = 0,
-       /**< used to check whether the type filter is supported */
        RTE_ETH_FILTER_ADD,      /**< add filter entry */
        RTE_ETH_FILTER_UPDATE,   /**< update filter entry */
        RTE_ETH_FILTER_DELETE,   /**< delete filter entry */
@@ -70,19 +72,19 @@ enum rte_filter_op {
        RTE_ETH_FILTER_GET,      /**< get filter entry */
        RTE_ETH_FILTER_SET,      /**< configurations */
        RTE_ETH_FILTER_INFO,     /**< retrieve information */
+       RTE_ETH_FILTER_STATS,    /**< retrieve statistics */
        RTE_ETH_FILTER_OP_MAX
 };
 
-/**
+/*
  * MAC filter type
  */
 enum rte_mac_filter_type {
        RTE_MAC_PERFECT_MATCH = 1, /**< exact match of MAC addr. */
-       RTE_MACVLAN_PERFECT_MATCH,
-       /**< exact match of MAC addr and VLAN ID. */
+       RTE_MACVLAN_PERFECT_MATCH, /**< exact match of MAC addr and VLAN ID. */
        RTE_MAC_HASH_MATCH, /**< hash match of MAC addr. */
+       /** hash match of MAC addr and exact match of VLAN ID. */
        RTE_MACVLAN_HASH_MATCH,
-       /**< hash match of MAC addr and exact match of VLAN ID. */
 };
 
 /**
@@ -95,6 +97,25 @@ struct rte_eth_mac_filter {
        struct ether_addr mac_addr;
 };
 
+/**
+ * Define all structures for Ethertype Filter type.
+ */
+
+#define RTE_ETHTYPE_FLAGS_MAC    0x0001 /**< If set, compare mac */
+#define RTE_ETHTYPE_FLAGS_DROP   0x0002 /**< If set, drop packet when match */
+
+/**
+ * A structure used to define the ethertype filter entry
+ * to support RTE_ETH_FILTER_ETHERTYPE with RTE_ETH_FILTER_ADD,
+ * RTE_ETH_FILTER_DELETE and RTE_ETH_FILTER_GET operations.
+ */
+struct rte_eth_ethertype_filter {
+       struct ether_addr mac_addr;   /**< Mac address to match. */
+       uint16_t ether_type;          /**< Ether type to match */
+       uint16_t flags;               /**< Flags from RTE_ETHTYPE_FLAGS_* */
+       uint16_t queue;               /**< Queue assigned to when match*/
+};
+
 /**
  * Tunneled type.
  */
@@ -162,6 +183,7 @@ struct rte_eth_tunnel_filter_conf {
  */
 enum rte_eth_flow_type {
        RTE_ETH_FLOW_TYPE_NONE = 0,
+       RTE_ETH_FLOW_TYPE_RAW,
        RTE_ETH_FLOW_TYPE_UDPV4,
        RTE_ETH_FLOW_TYPE_TCPV4,
        RTE_ETH_FLOW_TYPE_SCTPV4,
@@ -254,7 +276,7 @@ union rte_eth_fdir_flow {
        struct rte_eth_udpv6_flow  udp6_flow;
        struct rte_eth_tcpv6_flow  tcp6_flow;
        struct rte_eth_sctpv6_flow sctp6_flow;
-       struct rte_eth_ipv6_flow   ip6_flow;
+       struct rte_eth_ipv6_flow   ipv6_flow;
 };
 
 /**
@@ -326,6 +348,7 @@ struct rte_eth_fdir_filter {
  */
 enum rte_eth_payload_type {
        RTE_ETH_PAYLOAD_UNKNOWN = 0,
+       RTE_ETH_RAW_PAYLOAD,
        RTE_ETH_L2_PAYLOAD,
        RTE_ETH_L3_PAYLOAD,
        RTE_ETH_L4_PAYLOAD,
@@ -410,6 +433,87 @@ struct rte_eth_fdir_info {
        /**< Max supported size of flex bitmasks in flex_bitmask_unit */
 };
 
+/**
+ * A structure used to define the statistics of flow director.
+ * It supports RTE_ETH_FILTER_FDIR with RTE_ETH_FILTER_STATS operation.
+ */
+struct rte_eth_fdir_stats {
+       uint32_t collision;    /**< Number of filters with collision. */
+       uint32_t free;         /**< Number of free filters. */
+       uint32_t maxhash;
+       /**< The lookup hash value of the added filter that updated the value
+          of the MAXLEN field */
+       uint32_t maxlen;       /**< Longest linked list of filters. */
+       uint64_t add;          /**< Number of added filters. */
+       uint64_t remove;       /**< Number of removed filters. */
+       uint64_t f_add;        /**< Number of failed added filters. */
+       uint64_t f_remove;     /**< Number of failed removed filters. */
+       uint32_t guarant_cnt;  /**< Number of filters in guaranteed spaces. */
+       uint32_t best_cnt;     /**< Number of filters in best effort spaces. */
+};
+
+/**
+ * Hash filter information types.
+ * - RTE_ETH_HASH_FILTER_SYM_HASH_ENA_PER_PORT is for getting/setting the
+ *   information/configuration of 'symmetric hash enable' per port.
+ * - RTE_ETH_HASH_FILTER_GLOBAL_CONFIG is for getting/setting the global
+ *   configurations of hash filters. Those global configurations are valid
+ *   for all ports of the same NIC.
+ */
+enum rte_eth_hash_filter_info_type {
+       RTE_ETH_HASH_FILTER_INFO_TYPE_UNKNOWN = 0,
+       /** Symmetric hash enable per port */
+       RTE_ETH_HASH_FILTER_SYM_HASH_ENA_PER_PORT,
+       /** Configure globally for hash filter */
+       RTE_ETH_HASH_FILTER_GLOBAL_CONFIG,
+       RTE_ETH_HASH_FILTER_INFO_TYPE_MAX,
+};
+
+/**
+ * Hash function types.
+ */
+enum rte_eth_hash_function {
+       RTE_ETH_HASH_FUNCTION_DEFAULT = 0,
+       RTE_ETH_HASH_FUNCTION_TOEPLITZ, /**< Toeplitz */
+       RTE_ETH_HASH_FUNCTION_SIMPLE_XOR, /**< Simple XOR */
+       RTE_ETH_HASH_FUNCTION_MAX,
+};
+
+#define UINT32_BIT (CHAR_BIT * sizeof(uint32_t))
+#define RTE_SYM_HASH_MASK_ARRAY_SIZE \
+       (RTE_ALIGN(RTE_ETH_FLOW_TYPE_MAX, UINT32_BIT)/UINT32_BIT)
+/**
+ * A structure used to set or get global hash function configurations which
+ * include symmetric hash enable per flow type and hash function type.
+ * Each bit in sym_hash_enable_mask[] indicates if the symmetric hash of the
+ * coresponding flow type is enabled or not.
+ * Each bit in valid_bit_mask[] indicates if the corresponding bit in
+ * sym_hash_enable_mask[] is valid or not. For the configurations gotten, it
+ * also means if the flow type is supported by hardware or not.
+ */
+struct rte_eth_hash_global_conf {
+       enum rte_eth_hash_function hash_func; /**< Hash function type */
+       /** Bit mask for symmetric hash enable per flow type */
+       uint32_t sym_hash_enable_mask[RTE_SYM_HASH_MASK_ARRAY_SIZE];
+       /** Bit mask indicates if the corresponding bit is valid */
+       uint32_t valid_bit_mask[RTE_SYM_HASH_MASK_ARRAY_SIZE];
+};
+
+/**
+ * A structure used to set or get hash filter information, to support filter
+ * type of 'RTE_ETH_FILTER_HASH' and its operations.
+ */
+struct rte_eth_hash_filter_info {
+       enum rte_eth_hash_filter_info_type info_type; /**< Information type */
+       /** Details of hash filter information */
+       union {
+               /** For RTE_ETH_HASH_FILTER_SYM_HASH_ENA_PER_PORT */
+               uint8_t enable;
+               /** Global configurations of hash filter */
+               struct rte_eth_hash_global_conf global_conf;
+       } info;
+};
+
 #ifdef __cplusplus
 }
 #endif