lib: add missing include dependencies
[dpdk.git] / lib / librte_ether / rte_eth_ctrl.h
index 536b19e..fe80eb0 100644 (file)
@@ -1,7 +1,7 @@
 /*-
  *   BSD LICENSE
  *
- *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
+ *   Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
  *   All rights reserved.
  *
  *   Redistribution and use in source and binary forms, with or without
 #ifndef _RTE_ETH_CTRL_H_
 #define _RTE_ETH_CTRL_H_
 
+#include <stdint.h>
+#include <rte_common.h>
+#include "rte_ether.h"
+
 /**
  * @file
  *
@@ -74,7 +78,12 @@ extern "C" {
 #define RTE_ETH_FLOW_IPV6_EX            15
 #define RTE_ETH_FLOW_IPV6_TCP_EX        16
 #define RTE_ETH_FLOW_IPV6_UDP_EX        17
-#define RTE_ETH_FLOW_MAX                18
+#define RTE_ETH_FLOW_PORT               18
+       /**< Consider device port number as a flow differentiator */
+#define RTE_ETH_FLOW_VXLAN              19 /**< VXLAN protocol based flow */
+#define RTE_ETH_FLOW_GENEVE             20 /**< GENEVE protocol based flow */
+#define RTE_ETH_FLOW_NVGRE              21 /**< NVGRE protocol based flow */
+#define RTE_ETH_FLOW_MAX                22
 
 /**
  * Feature filter types
@@ -89,6 +98,7 @@ enum rte_filter_type {
        RTE_ETH_FILTER_TUNNEL,
        RTE_ETH_FILTER_FDIR,
        RTE_ETH_FILTER_HASH,
+       RTE_ETH_FILTER_L2_TUNNEL,
        RTE_ETH_FILTER_MAX
 };
 
@@ -244,6 +254,8 @@ enum rte_eth_tunnel_type {
        RTE_TUNNEL_TYPE_GENEVE,
        RTE_TUNNEL_TYPE_TEREDO,
        RTE_TUNNEL_TYPE_NVGRE,
+       RTE_TUNNEL_TYPE_IP_IN_GRE,
+       RTE_L2_TUNNEL_TYPE_E_TAG,
        RTE_TUNNEL_TYPE_MAX,
 };
 
@@ -280,36 +292,141 @@ enum rte_tunnel_iptype {
  * Tunneling Packet filter configuration.
  */
 struct rte_eth_tunnel_filter_conf {
-       struct ether_addr *outer_mac;  /**< Outer MAC address filter. */
-       struct ether_addr *inner_mac;  /**< Inner MAC address filter. */
-       uint16_t inner_vlan;           /**< Inner VLAN filter. */
+       struct ether_addr outer_mac;    /**< Outer MAC address to match. */
+       struct ether_addr inner_mac;    /**< Inner MAC address to match. */
+       uint16_t inner_vlan;            /**< Inner VLAN to match. */
        enum rte_tunnel_iptype ip_type; /**< IP address type. */
+       /** Outer destination IP address to match if ETH_TUNNEL_FILTER_OIP
+           is set in filter_type, or inner destination IP address to match
+           if ETH_TUNNEL_FILTER_IIP is set in filter_type . */
        union {
-               uint32_t ipv4_addr;    /**< IPv4 source address to match. */
-               uint32_t ipv6_addr[4]; /**< IPv6 source address to match. */
-       } ip_addr; /**< IPv4/IPv6 source address to match (union of above). */
-
-       uint16_t filter_type;   /**< Filter type. */
+               uint32_t ipv4_addr;     /**< IPv4 address in big endian. */
+               uint32_t ipv6_addr[4];  /**< IPv6 address in big endian. */
+       } ip_addr;
+       /** Flags from ETH_TUNNEL_FILTER_XX - see above. */
+       uint16_t filter_type;
        enum rte_eth_tunnel_type tunnel_type; /**< Tunnel Type. */
-       uint32_t tenant_id;     /** < Tenant number. */
-       uint16_t queue_id;      /** < queue number. */
+       uint32_t tenant_id;     /**< Tenant ID to match. VNI, GRE key... */
+       uint16_t queue_id;      /**< Queue assigned to if match. */
+};
+
+/**
+ * Global eth device configuration type.
+ */
+enum rte_eth_global_cfg_type {
+       RTE_ETH_GLOBAL_CFG_TYPE_UNKNOWN = 0,
+       RTE_ETH_GLOBAL_CFG_TYPE_GRE_KEY_LEN,
+       RTE_ETH_GLOBAL_CFG_TYPE_MAX,
+};
+
+/**
+ * Global eth device configuration.
+ */
+struct rte_eth_global_cfg {
+       enum rte_eth_global_cfg_type cfg_type; /**< Global config type. */
+       union {
+               uint8_t gre_key_len; /**< Valid GRE key length in byte. */
+               uint64_t reserved; /**< Reserve space for future use. */
+       } cfg;
+};
+
+#define RTE_ETH_FDIR_MAX_FLEXLEN 16  /**< Max length of flexbytes. */
+#define RTE_ETH_INSET_SIZE_MAX   128 /**< Max length of input set. */
+
+/**
+ * Input set fields for Flow Director and Hash filters
+ */
+enum rte_eth_input_set_field {
+       RTE_ETH_INPUT_SET_UNKNOWN = 0,
+
+       /* L2 */
+       RTE_ETH_INPUT_SET_L2_SRC_MAC = 1,
+       RTE_ETH_INPUT_SET_L2_DST_MAC,
+       RTE_ETH_INPUT_SET_L2_OUTER_VLAN,
+       RTE_ETH_INPUT_SET_L2_INNER_VLAN,
+       RTE_ETH_INPUT_SET_L2_ETHERTYPE,
+
+       /* L3 */
+       RTE_ETH_INPUT_SET_L3_SRC_IP4 = 129,
+       RTE_ETH_INPUT_SET_L3_DST_IP4,
+       RTE_ETH_INPUT_SET_L3_SRC_IP6,
+       RTE_ETH_INPUT_SET_L3_DST_IP6,
+       RTE_ETH_INPUT_SET_L3_IP4_TOS,
+       RTE_ETH_INPUT_SET_L3_IP4_PROTO,
+       RTE_ETH_INPUT_SET_L3_IP6_TC,
+       RTE_ETH_INPUT_SET_L3_IP6_NEXT_HEADER,
+       RTE_ETH_INPUT_SET_L3_IP4_TTL,
+       RTE_ETH_INPUT_SET_L3_IP6_HOP_LIMITS,
+
+       /* L4 */
+       RTE_ETH_INPUT_SET_L4_UDP_SRC_PORT = 257,
+       RTE_ETH_INPUT_SET_L4_UDP_DST_PORT,
+       RTE_ETH_INPUT_SET_L4_TCP_SRC_PORT,
+       RTE_ETH_INPUT_SET_L4_TCP_DST_PORT,
+       RTE_ETH_INPUT_SET_L4_SCTP_SRC_PORT,
+       RTE_ETH_INPUT_SET_L4_SCTP_DST_PORT,
+       RTE_ETH_INPUT_SET_L4_SCTP_VERIFICATION_TAG,
+
+       /* Tunnel */
+       RTE_ETH_INPUT_SET_TUNNEL_L2_INNER_DST_MAC = 385,
+       RTE_ETH_INPUT_SET_TUNNEL_L2_INNER_SRC_MAC,
+       RTE_ETH_INPUT_SET_TUNNEL_L2_INNER_VLAN,
+       RTE_ETH_INPUT_SET_TUNNEL_L4_UDP_KEY,
+       RTE_ETH_INPUT_SET_TUNNEL_GRE_KEY,
+
+       /* Flexible Payload */
+       RTE_ETH_INPUT_SET_FLEX_PAYLOAD_1ST_WORD = 641,
+       RTE_ETH_INPUT_SET_FLEX_PAYLOAD_2ND_WORD,
+       RTE_ETH_INPUT_SET_FLEX_PAYLOAD_3RD_WORD,
+       RTE_ETH_INPUT_SET_FLEX_PAYLOAD_4TH_WORD,
+       RTE_ETH_INPUT_SET_FLEX_PAYLOAD_5TH_WORD,
+       RTE_ETH_INPUT_SET_FLEX_PAYLOAD_6TH_WORD,
+       RTE_ETH_INPUT_SET_FLEX_PAYLOAD_7TH_WORD,
+       RTE_ETH_INPUT_SET_FLEX_PAYLOAD_8TH_WORD,
+
+       RTE_ETH_INPUT_SET_DEFAULT = 65533,
+       RTE_ETH_INPUT_SET_NONE = 65534,
+       RTE_ETH_INPUT_SET_MAX = 65535,
+};
+
+/**
+ * Filters input set operations
+ */
+enum rte_filter_input_set_op {
+       RTE_ETH_INPUT_SET_OP_UNKNOWN,
+       RTE_ETH_INPUT_SET_SELECT, /**< select input set */
+       RTE_ETH_INPUT_SET_ADD,    /**< add input set entry */
+       RTE_ETH_INPUT_SET_OP_MAX
 };
 
-#define RTE_ETH_FDIR_MAX_FLEXLEN         16 /** < Max length of flexbytes. */
+
+/**
+ * A structure used to define the input set configuration for
+ * flow director and hash filters
+ */
+struct rte_eth_input_set_conf {
+       uint16_t flow_type;
+       uint16_t inset_size;
+       enum rte_eth_input_set_field field[RTE_ETH_INSET_SIZE_MAX];
+       enum rte_filter_input_set_op op;
+};
 
 /**
  * A structure used to define the input for L2 flow
  */
 struct rte_eth_l2_flow {
-       uint16_t ether_type;          /**< Ether type to match */
+       uint16_t ether_type;          /**< Ether type in big endian */
 };
 
 /**
  * A structure used to define the input for IPV4 flow
  */
 struct rte_eth_ipv4_flow {
-       uint32_t src_ip;      /**< IPv4 source address to match. */
-       uint32_t dst_ip;      /**< IPv4 destination address to match. */
+       uint32_t src_ip;      /**< IPv4 source address in big endian. */
+       uint32_t dst_ip;      /**< IPv4 destination address in big endian. */
+       uint8_t  tos;         /**< Type of service to match. */
+       uint8_t  ttl;         /**< Time to live to match. */
+       uint8_t  proto;       /**< Protocol, next header in big endian. */
 };
 
 /**
@@ -317,8 +434,8 @@ struct rte_eth_ipv4_flow {
  */
 struct rte_eth_udpv4_flow {
        struct rte_eth_ipv4_flow ip; /**< IPv4 fields to match. */
-       uint16_t src_port;           /**< UDP source port to match. */
-       uint16_t dst_port;           /**< UDP destination port to match. */
+       uint16_t src_port;           /**< UDP source port in big endian. */
+       uint16_t dst_port;           /**< UDP destination port in big endian. */
 };
 
 /**
@@ -326,8 +443,8 @@ struct rte_eth_udpv4_flow {
  */
 struct rte_eth_tcpv4_flow {
        struct rte_eth_ipv4_flow ip; /**< IPv4 fields to match. */
-       uint16_t src_port;           /**< TCP source port to match. */
-       uint16_t dst_port;           /**< TCP destination port to match. */
+       uint16_t src_port;           /**< TCP source port in big endian. */
+       uint16_t dst_port;           /**< TCP destination port in big endian. */
 };
 
 /**
@@ -335,15 +452,20 @@ struct rte_eth_tcpv4_flow {
  */
 struct rte_eth_sctpv4_flow {
        struct rte_eth_ipv4_flow ip; /**< IPv4 fields to match. */
-       uint32_t verify_tag;         /**< Verify tag to match */
+       uint16_t src_port;           /**< SCTP source port in big endian. */
+       uint16_t dst_port;           /**< SCTP destination port in big endian. */
+       uint32_t verify_tag;         /**< Verify tag in big endian */
 };
 
 /**
  * A structure used to define the input for IPV6 flow
  */
 struct rte_eth_ipv6_flow {
-       uint32_t src_ip[4];      /**< IPv6 source address to match. */
-       uint32_t dst_ip[4];      /**< IPv6 destination address to match. */
+       uint32_t src_ip[4];      /**< IPv6 source address in big endian. */
+       uint32_t dst_ip[4];      /**< IPv6 destination address in big endian. */
+       uint8_t  tc;             /**< Traffic class to match. */
+       uint8_t  proto;          /**< Protocol, next header to match. */
+       uint8_t  hop_limits;     /**< Hop limits to match. */
 };
 
 /**
@@ -351,8 +473,8 @@ struct rte_eth_ipv6_flow {
  */
 struct rte_eth_udpv6_flow {
        struct rte_eth_ipv6_flow ip; /**< IPv6 fields to match. */
-       uint16_t src_port;           /**< UDP source port to match. */
-       uint16_t dst_port;           /**< UDP destination port to match. */
+       uint16_t src_port;           /**< UDP source port in big endian. */
+       uint16_t dst_port;           /**< UDP destination port in big endian. */
 };
 
 /**
@@ -360,8 +482,8 @@ struct rte_eth_udpv6_flow {
  */
 struct rte_eth_tcpv6_flow {
        struct rte_eth_ipv6_flow ip; /**< IPv6 fields to match. */
-       uint16_t src_port;           /**< TCP source port to match. */
-       uint16_t dst_port;           /**< TCP destination port to match. */
+       uint16_t src_port;           /**< TCP source port to in big endian. */
+       uint16_t dst_port;           /**< TCP destination port in big endian. */
 };
 
 /**
@@ -369,11 +491,41 @@ struct rte_eth_tcpv6_flow {
  */
 struct rte_eth_sctpv6_flow {
        struct rte_eth_ipv6_flow ip; /**< IPv6 fields to match. */
-       uint32_t verify_tag;         /**< Verify tag to match */
+       uint16_t src_port;           /**< SCTP source port in big endian. */
+       uint16_t dst_port;           /**< SCTP destination port in big endian. */
+       uint32_t verify_tag;         /**< Verify tag in big endian. */
+};
+
+/**
+ * A structure used to define the input for MAC VLAN flow
+ */
+struct rte_eth_mac_vlan_flow {
+       struct ether_addr mac_addr;  /**< Mac address to match. */
+};
+
+/**
+ * Tunnel type for flow director.
+ */
+enum rte_eth_fdir_tunnel_type {
+       RTE_FDIR_TUNNEL_TYPE_UNKNOWN = 0,
+       RTE_FDIR_TUNNEL_TYPE_NVGRE,
+       RTE_FDIR_TUNNEL_TYPE_VXLAN,
+};
+
+/**
+ * A structure used to define the input for tunnel flow, now it's VxLAN or
+ * NVGRE
+ */
+struct rte_eth_tunnel_flow {
+       enum rte_eth_fdir_tunnel_type tunnel_type; /**< Tunnel type to match. */
+       /** Tunnel ID to match. TNI, VNI... in big endian. */
+       uint32_t tunnel_id;
+       struct ether_addr mac_addr;                /**< Mac address to match. */
 };
 
 /**
  * An union contains the inputs for all types of flow
+ * Items in flows need to be in big endian
  */
 union rte_eth_fdir_flow {
        struct rte_eth_l2_flow     l2_flow;
@@ -385,6 +537,8 @@ union rte_eth_fdir_flow {
        struct rte_eth_tcpv6_flow  tcp6_flow;
        struct rte_eth_sctpv6_flow sctp6_flow;
        struct rte_eth_ipv6_flow   ipv6_flow;
+       struct rte_eth_mac_vlan_flow mac_vlan_flow;
+       struct rte_eth_tunnel_flow   tunnel_flow;
 };
 
 /**
@@ -394,6 +548,8 @@ struct rte_eth_fdir_flow_ext {
        uint16_t vlan_tci;
        uint8_t flexbytes[RTE_ETH_FDIR_MAX_FLEXLEN];
        /**< It is filled by the flexible payload to match. */
+       uint8_t is_vf;   /**< 1 for VF, 0 for port dev */
+       uint16_t dst_id; /**< VF ID, available when is_vf is 1*/
 };
 
 /**
@@ -413,6 +569,7 @@ struct rte_eth_fdir_input {
 enum rte_eth_fdir_behavior {
        RTE_ETH_FDIR_ACCEPT = 0,
        RTE_ETH_FDIR_REJECT,
+       RTE_ETH_FDIR_PASSTHRU,
 };
 
 /**
@@ -456,11 +613,22 @@ struct rte_eth_fdir_filter {
  *  to match the various fields of RX packet headers.
  */
 struct rte_eth_fdir_masks {
-       uint16_t vlan_tci_mask;
+       uint16_t vlan_tci_mask;   /**< Bit mask for vlan_tci in big endian */
+       /** Bit mask for ipv4 flow in big endian. */
        struct rte_eth_ipv4_flow   ipv4_mask;
+       /** Bit maks for ipv6 flow in big endian. */
        struct rte_eth_ipv6_flow   ipv6_mask;
+       /** Bit mask for L4 source port in big endian. */
        uint16_t src_port_mask;
+       /** Bit mask for L4 destination port in big endian. */
        uint16_t dst_port_mask;
+       /** 6 bit mask for proper 6 bytes of Mac address, bit 0 matches the
+           first byte on the wire */
+       uint8_t mac_addr_byte_mask;
+       /** Bit mask for tunnel ID in big endian. */
+       uint32_t tunnel_id_mask;
+       uint8_t tunnel_type_mask; /**< 1 - Match tunnel type,
+                                      0 - Ignore tunnel type. */
 };
 
 /**
@@ -500,7 +668,7 @@ struct rte_eth_fdir_flex_mask {
 
 /**
  * A structure used to define all flexible payload related setting
- * include flexpay load and flex mask
+ * include flex payload and flex mask
  */
 struct rte_eth_fdir_flex_conf {
        uint16_t nb_payloads;  /**< The number of following payload cfg */
@@ -518,6 +686,8 @@ enum rte_fdir_mode {
        RTE_FDIR_MODE_NONE      = 0, /**< Disable FDIR support. */
        RTE_FDIR_MODE_SIGNATURE,     /**< Enable FDIR signature filter mode. */
        RTE_FDIR_MODE_PERFECT,       /**< Enable FDIR perfect filter mode. */
+       RTE_FDIR_MODE_PERFECT_MAC_VLAN, /**< Enable FDIR filter mode - MAC VLAN. */
+       RTE_FDIR_MODE_PERFECT_TUNNEL,   /**< Enable FDIR filter mode - tunnel. */
 };
 
 #define UINT32_BIT (CHAR_BIT * sizeof(uint32_t))
@@ -577,6 +747,29 @@ struct rte_eth_fdir_stats {
        uint32_t best_cnt;     /**< Number of filters in best effort spaces. */
 };
 
+/**
+ * Flow Director filter information types.
+ */
+enum rte_eth_fdir_filter_info_type {
+       RTE_ETH_FDIR_FILTER_INFO_TYPE_UNKNOWN = 0,
+       /** Flow Director filter input set configuration */
+       RTE_ETH_FDIR_FILTER_INPUT_SET_SELECT,
+       RTE_ETH_FDIR_FILTER_INFO_TYPE_MAX,
+};
+
+/**
+ * A structure used to set FDIR filter information, to support filter type
+ * of 'RTE_ETH_FILTER_FDIR' RTE_ETH_FDIR_FILTER_INPUT_SET_SELECT operation.
+ */
+struct rte_eth_fdir_filter_info {
+       enum rte_eth_fdir_filter_info_type info_type; /**< Information type */
+       /** Details of fdir filter information */
+       union {
+               /** Flow Director input set configuration per port */
+               struct rte_eth_input_set_conf input_set_conf;
+       } info;
+};
+
 /**
  * Hash filter information types.
  * - RTE_ETH_HASH_FILTER_SYM_HASH_ENA_PER_PORT is for getting/setting the
@@ -584,6 +777,8 @@ struct rte_eth_fdir_stats {
  * - 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.
+ * - RTE_ETH_HASH_FILTER_INPUT_SET_SELECT is for setting the global
+ *   hash input set fields
  */
 enum rte_eth_hash_filter_info_type {
        RTE_ETH_HASH_FILTER_INFO_TYPE_UNKNOWN = 0,
@@ -591,6 +786,8 @@ enum rte_eth_hash_filter_info_type {
        RTE_ETH_HASH_FILTER_SYM_HASH_ENA_PER_PORT,
        /** Configure globally for hash filter */
        RTE_ETH_HASH_FILTER_GLOBAL_CONFIG,
+       /** Global Hash filter input set configuration */
+       RTE_ETH_HASH_FILTER_INPUT_SET_SELECT,
        RTE_ETH_HASH_FILTER_INFO_TYPE_MAX,
 };
 
@@ -610,7 +807,7 @@ enum rte_eth_hash_function {
  * 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.
+ * corresponding 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.
@@ -635,9 +832,22 @@ struct rte_eth_hash_filter_info {
                uint8_t enable;
                /** Global configurations of hash filter */
                struct rte_eth_hash_global_conf global_conf;
+               /** Global configurations of hash filter input set */
+               struct rte_eth_input_set_conf input_set_conf;
        } info;
 };
 
+/**
+ * l2 tunnel configuration.
+ */
+struct rte_eth_l2_tunnel_conf {
+       enum rte_eth_tunnel_type l2_tunnel_type;
+       uint16_t ether_type; /* ether type in l2 header */
+       uint32_t tunnel_id; /* port tag id for e-tag */
+       uint16_t vf_id; /* VF id for tag insertion */
+       uint32_t pool; /* destination pool for tag based forwarding */
+};
+
 #ifdef __cplusplus
 }
 #endif