lib/librte_ether/rte_eth_ctrl.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _RTE_ETH_CTRL_H_
  35 #define _RTE_ETH_CTRL_H_
  36
  37 /**
  38  * @file
  39  *
  40  * Ethernet device features and related data structures used
  41  * by control APIs should be defined in this file.
  42  *
  43  */
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 /*
  50  * A packet can be identified by hardware as different flow types. Different
  51  * NIC hardwares may support different flow types.
  52  * Basically, the NIC hardware identifies the flow type as deep protocol as
  53  * possible, and exclusively. For example, if a packet is identified as
  54  * 'RTE_ETH_FLOW_NONFRAG_IPV4_TCP', it will not be any of other flow types,
  55  * though it is an actual IPV4 packet.
  56  * Note that the flow types are used to define RSS offload types in
  57  * rte_ethdev.h.
  58  */
  59 #define RTE_ETH_FLOW_UNKNOWN             0
  60 #define RTE_ETH_FLOW_RAW                 1
  61 #define RTE_ETH_FLOW_IPV4                2
  62 #define RTE_ETH_FLOW_FRAG_IPV4           3
  63 #define RTE_ETH_FLOW_NONFRAG_IPV4_TCP    4
  64 #define RTE_ETH_FLOW_NONFRAG_IPV4_UDP    5
  65 #define RTE_ETH_FLOW_NONFRAG_IPV4_SCTP   6
  66 #define RTE_ETH_FLOW_NONFRAG_IPV4_OTHER  7
  67 #define RTE_ETH_FLOW_IPV6                8
  68 #define RTE_ETH_FLOW_FRAG_IPV6           9
  69 #define RTE_ETH_FLOW_NONFRAG_IPV6_TCP   10
  70 #define RTE_ETH_FLOW_NONFRAG_IPV6_UDP   11
  71 #define RTE_ETH_FLOW_NONFRAG_IPV6_SCTP  12
  72 #define RTE_ETH_FLOW_NONFRAG_IPV6_OTHER 13
  73 #define RTE_ETH_FLOW_L2_PAYLOAD         14
  74 #define RTE_ETH_FLOW_IPV6_EX            15
  75 #define RTE_ETH_FLOW_IPV6_TCP_EX        16
  76 #define RTE_ETH_FLOW_IPV6_UDP_EX        17
  77 #define RTE_ETH_FLOW_MAX                18
  78
  79 /**
  80  * Feature filter types
  81  */
  82 enum rte_filter_type {
  83         RTE_ETH_FILTER_NONE = 0,
  84         RTE_ETH_FILTER_MACVLAN,
  85         RTE_ETH_FILTER_ETHERTYPE,
  86         RTE_ETH_FILTER_FLEXIBLE,
  87         RTE_ETH_FILTER_SYN,
  88         RTE_ETH_FILTER_NTUPLE,
  89         RTE_ETH_FILTER_TUNNEL,
  90         RTE_ETH_FILTER_FDIR,
  91         RTE_ETH_FILTER_HASH,
  92         RTE_ETH_FILTER_L2_TUNNEL,
  93         RTE_ETH_FILTER_MAX
  94 };
  95
  96 /**
  97  * Generic operations on filters
  98  */
  99 enum rte_filter_op {
 100         /** used to check whether the type filter is supported */
 101         RTE_ETH_FILTER_NOP = 0,
 102         RTE_ETH_FILTER_ADD,      /**< add filter entry */
 103         RTE_ETH_FILTER_UPDATE,   /**< update filter entry */
 104         RTE_ETH_FILTER_DELETE,   /**< delete filter entry */
 105         RTE_ETH_FILTER_FLUSH,    /**< flush all entries */
 106         RTE_ETH_FILTER_GET,      /**< get filter entry */
 107         RTE_ETH_FILTER_SET,      /**< configurations */
 108         RTE_ETH_FILTER_INFO,     /**< retrieve information */
 109         RTE_ETH_FILTER_STATS,    /**< retrieve statistics */
 110         RTE_ETH_FILTER_OP_MAX
 111 };
 112
 113 /**
 114  * MAC filter type
 115  */
 116 enum rte_mac_filter_type {
 117         RTE_MAC_PERFECT_MATCH = 1, /**< exact match of MAC addr. */
 118         RTE_MACVLAN_PERFECT_MATCH, /**< exact match of MAC addr and VLAN ID. */
 119         RTE_MAC_HASH_MATCH, /**< hash match of MAC addr. */
 120         /** hash match of MAC addr and exact match of VLAN ID. */
 121         RTE_MACVLAN_HASH_MATCH,
 122 };
 123
 124 /**
 125  * MAC filter info
 126  */
 127 struct rte_eth_mac_filter {
 128         uint8_t is_vf; /**< 1 for VF, 0 for port dev */
 129         uint16_t dst_id; /**< VF ID, available when is_vf is 1*/
 130         enum rte_mac_filter_type filter_type; /**< MAC filter type */
 131         struct ether_addr mac_addr;
 132 };
 133
 134 /**
 135  * Define all structures for Ethertype Filter type.
 136  */
 137
 138 #define RTE_ETHTYPE_FLAGS_MAC    0x0001 /**< If set, compare mac */
 139 #define RTE_ETHTYPE_FLAGS_DROP   0x0002 /**< If set, drop packet when match */
 140
 141 /**
 142  * A structure used to define the ethertype filter entry
 143  * to support RTE_ETH_FILTER_ETHERTYPE with RTE_ETH_FILTER_ADD,
 144  * RTE_ETH_FILTER_DELETE and RTE_ETH_FILTER_GET operations.
 145  */
 146 struct rte_eth_ethertype_filter {
 147         struct ether_addr mac_addr;   /**< Mac address to match. */
 148         uint16_t ether_type;          /**< Ether type to match */
 149         uint16_t flags;               /**< Flags from RTE_ETHTYPE_FLAGS_* */
 150         uint16_t queue;               /**< Queue assigned to when match*/
 151 };
 152
 153 #define RTE_FLEX_FILTER_MAXLEN  128     /**< bytes to use in flex filter. */
 154 #define RTE_FLEX_FILTER_MASK_SIZE       \
 155         (RTE_ALIGN(RTE_FLEX_FILTER_MAXLEN, CHAR_BIT) / CHAR_BIT)
 156                                         /**< mask bytes in flex filter. */
 157
 158 /**
 159  *  A structure used to define the flex filter entry
 160  *  to support RTE_ETH_FILTER_FLEXIBLE with RTE_ETH_FILTER_ADD,
 161  *  RTE_ETH_FILTER_DELETE and RTE_ETH_FILTER_GET operations.
 162  */
 163 struct rte_eth_flex_filter {
 164         uint16_t len;
 165         uint8_t bytes[RTE_FLEX_FILTER_MAXLEN];  /**< flex bytes in big endian.*/
 166         uint8_t mask[RTE_FLEX_FILTER_MASK_SIZE];    /**< if mask bit is 1b, do
 167                                         not compare corresponding byte. */
 168         uint8_t priority;
 169         uint16_t queue;       /**< Queue assigned to when match. */
 170 };
 171
 172 /**
 173  * A structure used to define the TCP syn filter entry
 174  * to support RTE_ETH_FILTER_SYN with RTE_ETH_FILTER_ADD,
 175  * RTE_ETH_FILTER_DELETE and RTE_ETH_FILTER_GET operations.
 176  */
 177 struct rte_eth_syn_filter {
 178         uint8_t hig_pri;     /**< 1 - higher priority than other filters,
 179                                   0 - lower priority. */
 180         uint16_t queue;      /**< Queue assigned to when match */
 181 };
 182
 183 /**
 184  * Define all structures for ntuple Filter type.
 185  */
 186
 187 #define RTE_NTUPLE_FLAGS_DST_IP    0x0001 /**< If set, dst_ip is part of ntuple */
 188 #define RTE_NTUPLE_FLAGS_SRC_IP    0x0002 /**< If set, src_ip is part of ntuple */
 189 #define RTE_NTUPLE_FLAGS_DST_PORT  0x0004 /**< If set, dst_port is part of ntuple */
 190 #define RTE_NTUPLE_FLAGS_SRC_PORT  0x0008 /**< If set, src_port is part of ntuple */
 191 #define RTE_NTUPLE_FLAGS_PROTO     0x0010 /**< If set, protocol is part of ntuple */
 192 #define RTE_NTUPLE_FLAGS_TCP_FLAG  0x0020 /**< If set, tcp flag is involved */
 193
 194 #define RTE_5TUPLE_FLAGS ( \
 195                 RTE_NTUPLE_FLAGS_DST_IP | \
 196                 RTE_NTUPLE_FLAGS_SRC_IP | \
 197                 RTE_NTUPLE_FLAGS_DST_PORT | \
 198                 RTE_NTUPLE_FLAGS_SRC_PORT | \
 199                 RTE_NTUPLE_FLAGS_PROTO)
 200
 201 #define RTE_2TUPLE_FLAGS ( \
 202                 RTE_NTUPLE_FLAGS_DST_PORT | \
 203                 RTE_NTUPLE_FLAGS_PROTO)
 204
 205 #define TCP_URG_FLAG 0x20
 206 #define TCP_ACK_FLAG 0x10
 207 #define TCP_PSH_FLAG 0x08
 208 #define TCP_RST_FLAG 0x04
 209 #define TCP_SYN_FLAG 0x02
 210 #define TCP_FIN_FLAG 0x01
 211 #define TCP_FLAG_ALL 0x3F
 212
 213 /**
 214  * A structure used to define the ntuple filter entry
 215  * to support RTE_ETH_FILTER_NTUPLE with RTE_ETH_FILTER_ADD,
 216  * RTE_ETH_FILTER_DELETE and RTE_ETH_FILTER_GET operations.
 217  */
 218 struct rte_eth_ntuple_filter {
 219         uint16_t flags;          /**< Flags from RTE_NTUPLE_FLAGS_* */
 220         uint32_t dst_ip;         /**< Destination IP address in big endian. */
 221         uint32_t dst_ip_mask;    /**< Mask of destination IP address. */
 222         uint32_t src_ip;         /**< Source IP address in big endian. */
 223         uint32_t src_ip_mask;    /**< Mask of destination IP address. */
 224         uint16_t dst_port;       /**< Destination port in big endian. */
 225         uint16_t dst_port_mask;  /**< Mask of destination port. */
 226         uint16_t src_port;       /**< Source Port in big endian. */
 227         uint16_t src_port_mask;  /**< Mask of source port. */
 228         uint8_t proto;           /**< L4 protocol. */
 229         uint8_t proto_mask;      /**< Mask of L4 protocol. */
 230         /** tcp_flags only meaningful when the proto is TCP.
 231             The packet matched above ntuple fields and contain
 232             any set bit in tcp_flags will hit this filter. */
 233         uint8_t tcp_flags;
 234         uint16_t priority;       /**< seven levels (001b-111b), 111b is highest,
 235                                       used when more than one filter matches. */
 236         uint16_t queue;          /**< Queue assigned to when match*/
 237 };
 238
 239 /**
 240  * Tunneled type.
 241  */
 242 enum rte_eth_tunnel_type {
 243         RTE_TUNNEL_TYPE_NONE = 0,
 244         RTE_TUNNEL_TYPE_VXLAN,
 245         RTE_TUNNEL_TYPE_GENEVE,
 246         RTE_TUNNEL_TYPE_TEREDO,
 247         RTE_TUNNEL_TYPE_NVGRE,
 248         RTE_L2_TUNNEL_TYPE_E_TAG,
 249         RTE_TUNNEL_TYPE_MAX,
 250 };
 251
 252 /**
 253  * filter type of tunneling packet
 254  */
 255 #define ETH_TUNNEL_FILTER_OMAC  0x01 /**< filter by outer MAC addr */
 256 #define ETH_TUNNEL_FILTER_OIP   0x02 /**< filter by outer IP Addr */
 257 #define ETH_TUNNEL_FILTER_TENID 0x04 /**< filter by tenant ID */
 258 #define ETH_TUNNEL_FILTER_IMAC  0x08 /**< filter by inner MAC addr */
 259 #define ETH_TUNNEL_FILTER_IVLAN 0x10 /**< filter by inner VLAN ID */
 260 #define ETH_TUNNEL_FILTER_IIP   0x20 /**< filter by inner IP addr */
 261
 262 #define RTE_TUNNEL_FILTER_IMAC_IVLAN (ETH_TUNNEL_FILTER_IMAC | \
 263                                         ETH_TUNNEL_FILTER_IVLAN)
 264 #define RTE_TUNNEL_FILTER_IMAC_IVLAN_TENID (ETH_TUNNEL_FILTER_IMAC | \
 265                                         ETH_TUNNEL_FILTER_IVLAN | \
 266                                         ETH_TUNNEL_FILTER_TENID)
 267 #define RTE_TUNNEL_FILTER_IMAC_TENID (ETH_TUNNEL_FILTER_IMAC | \
 268                                         ETH_TUNNEL_FILTER_TENID)
 269 #define RTE_TUNNEL_FILTER_OMAC_TENID_IMAC (ETH_TUNNEL_FILTER_OMAC | \
 270                                         ETH_TUNNEL_FILTER_TENID | \
 271                                         ETH_TUNNEL_FILTER_IMAC)
 272
 273 /**
 274  *  Select IPv4 or IPv6 for tunnel filters.
 275  */
 276 enum rte_tunnel_iptype {
 277         RTE_TUNNEL_IPTYPE_IPV4 = 0, /**< IPv4. */
 278         RTE_TUNNEL_IPTYPE_IPV6,     /**< IPv6. */
 279 };
 280
 281 /**
 282  * Tunneling Packet filter configuration.
 283  */
 284 struct rte_eth_tunnel_filter_conf {
 285         struct ether_addr *outer_mac;  /**< Outer MAC address filter. */
 286         struct ether_addr *inner_mac;  /**< Inner MAC address filter. */
 287         uint16_t inner_vlan;           /**< Inner VLAN filter. */
 288         enum rte_tunnel_iptype ip_type; /**< IP address type. */
 289         union {
 290                 uint32_t ipv4_addr;    /**< IPv4 source address to match. */
 291                 uint32_t ipv6_addr[4]; /**< IPv6 source address to match. */
 292         } ip_addr; /**< IPv4/IPv6 source address to match (union of above). */
 293
 294         uint16_t filter_type;   /**< Filter type. */
 295         enum rte_eth_tunnel_type tunnel_type; /**< Tunnel Type. */
 296         uint32_t tenant_id;     /**< Tenant number. */
 297         uint16_t queue_id;      /**< Queue number. */
 298 };
 299
 300 /**
 301  * Global eth device configuration type.
 302  */
 303 enum rte_eth_global_cfg_type {
 304         RTE_ETH_GLOBAL_CFG_TYPE_UNKNOWN = 0,
 305         RTE_ETH_GLOBAL_CFG_TYPE_GRE_KEY_LEN,
 306         RTE_ETH_GLOBAL_CFG_TYPE_MAX,
 307 };
 308
 309 /**
 310  * Global eth device configuration.
 311  */
 312 struct rte_eth_global_cfg {
 313         enum rte_eth_global_cfg_type cfg_type; /**< Global config type. */
 314         union {
 315                 uint8_t gre_key_len; /**< Valid GRE key length in byte. */
 316                 uint64_t reserved; /**< Reserve space for future use. */
 317         } cfg;
 318 };
 319
 320 #define RTE_ETH_FDIR_MAX_FLEXLEN 16  /**< Max length of flexbytes. */
 321 #define RTE_ETH_INSET_SIZE_MAX   128 /**< Max length of input set. */
 322
 323 /**
 324  * Input set fields for Flow Director and Hash filters
 325  */
 326 enum rte_eth_input_set_field {
 327         RTE_ETH_INPUT_SET_UNKNOWN = 0,
 328
 329         /* L2 */
 330         RTE_ETH_INPUT_SET_L2_SRC_MAC = 1,
 331         RTE_ETH_INPUT_SET_L2_DST_MAC,
 332         RTE_ETH_INPUT_SET_L2_OUTER_VLAN,
 333         RTE_ETH_INPUT_SET_L2_INNER_VLAN,
 334         RTE_ETH_INPUT_SET_L2_ETHERTYPE,
 335
 336         /* L3 */
 337         RTE_ETH_INPUT_SET_L3_SRC_IP4 = 129,
 338         RTE_ETH_INPUT_SET_L3_DST_IP4,
 339         RTE_ETH_INPUT_SET_L3_SRC_IP6,
 340         RTE_ETH_INPUT_SET_L3_DST_IP6,
 341         RTE_ETH_INPUT_SET_L3_IP4_TOS,
 342         RTE_ETH_INPUT_SET_L3_IP4_PROTO,
 343         RTE_ETH_INPUT_SET_L3_IP6_TC,
 344         RTE_ETH_INPUT_SET_L3_IP6_NEXT_HEADER,
 345
 346         /* L4 */
 347         RTE_ETH_INPUT_SET_L4_UDP_SRC_PORT = 257,
 348         RTE_ETH_INPUT_SET_L4_UDP_DST_PORT,
 349         RTE_ETH_INPUT_SET_L4_TCP_SRC_PORT,
 350         RTE_ETH_INPUT_SET_L4_TCP_DST_PORT,
 351         RTE_ETH_INPUT_SET_L4_SCTP_SRC_PORT,
 352         RTE_ETH_INPUT_SET_L4_SCTP_DST_PORT,
 353         RTE_ETH_INPUT_SET_L4_SCTP_VERIFICATION_TAG,
 354
 355         /* Tunnel */
 356         RTE_ETH_INPUT_SET_TUNNEL_L2_INNER_DST_MAC = 385,
 357         RTE_ETH_INPUT_SET_TUNNEL_L2_INNER_SRC_MAC,
 358         RTE_ETH_INPUT_SET_TUNNEL_L2_INNER_VLAN,
 359         RTE_ETH_INPUT_SET_TUNNEL_L4_UDP_KEY,
 360         RTE_ETH_INPUT_SET_TUNNEL_GRE_KEY,
 361
 362         /* Flexible Payload */
 363         RTE_ETH_INPUT_SET_FLEX_PAYLOAD_1ST_WORD = 641,
 364         RTE_ETH_INPUT_SET_FLEX_PAYLOAD_2ND_WORD,
 365         RTE_ETH_INPUT_SET_FLEX_PAYLOAD_3RD_WORD,
 366         RTE_ETH_INPUT_SET_FLEX_PAYLOAD_4TH_WORD,
 367         RTE_ETH_INPUT_SET_FLEX_PAYLOAD_5TH_WORD,
 368         RTE_ETH_INPUT_SET_FLEX_PAYLOAD_6TH_WORD,
 369         RTE_ETH_INPUT_SET_FLEX_PAYLOAD_7TH_WORD,
 370         RTE_ETH_INPUT_SET_FLEX_PAYLOAD_8TH_WORD,
 371
 372         RTE_ETH_INPUT_SET_DEFAULT = 65533,
 373         RTE_ETH_INPUT_SET_NONE = 65534,
 374         RTE_ETH_INPUT_SET_MAX = 65535,
 375 };
 376
 377 /**
 378  * Filters input set operations
 379  */
 380 enum rte_filter_input_set_op {
 381         RTE_ETH_INPUT_SET_OP_UNKNOWN,
 382         RTE_ETH_INPUT_SET_SELECT, /**< select input set */
 383         RTE_ETH_INPUT_SET_ADD,    /**< add input set entry */
 384         RTE_ETH_INPUT_SET_OP_MAX
 385 };
 386
 387
 388 /**
 389  * A structure used to define the input set configuration for
 390  * flow director and hash filters
 391  */
 392 struct rte_eth_input_set_conf {
 393         uint16_t flow_type;
 394         uint16_t inset_size;
 395         enum rte_eth_input_set_field field[RTE_ETH_INSET_SIZE_MAX];
 396         enum rte_filter_input_set_op op;
 397 };
 398
 399 /**
 400  * A structure used to define the input for L2 flow
 401  */
 402 struct rte_eth_l2_flow {
 403         uint16_t ether_type;          /**< Ether type to match */
 404 };
 405
 406 /**
 407  * A structure used to define the input for IPV4 flow
 408  */
 409 struct rte_eth_ipv4_flow {
 410         uint32_t src_ip;      /**< IPv4 source address to match. */
 411         uint32_t dst_ip;      /**< IPv4 destination address to match. */
 412 };
 413
 414 /**
 415  * A structure used to define the input for IPV4 UDP flow
 416  */
 417 struct rte_eth_udpv4_flow {
 418         struct rte_eth_ipv4_flow ip; /**< IPv4 fields to match. */
 419         uint16_t src_port;           /**< UDP source port to match. */
 420         uint16_t dst_port;           /**< UDP destination port to match. */
 421 };
 422
 423 /**
 424  * A structure used to define the input for IPV4 TCP flow
 425  */
 426 struct rte_eth_tcpv4_flow {
 427         struct rte_eth_ipv4_flow ip; /**< IPv4 fields to match. */
 428         uint16_t src_port;           /**< TCP source port to match. */
 429         uint16_t dst_port;           /**< TCP destination port to match. */
 430 };
 431
 432 /**
 433  * A structure used to define the input for IPV4 SCTP flow
 434  */
 435 struct rte_eth_sctpv4_flow {
 436         struct rte_eth_ipv4_flow ip; /**< IPv4 fields to match. */
 437         uint16_t src_port;           /**< SCTP source port to match. */
 438         uint16_t dst_port;           /**< SCTP destination port to match. */
 439         uint32_t verify_tag;         /**< Verify tag to match */
 440 };
 441
 442 /**
 443  * A structure used to define the input for IPV6 flow
 444  */
 445 struct rte_eth_ipv6_flow {
 446         uint32_t src_ip[4];      /**< IPv6 source address to match. */
 447         uint32_t dst_ip[4];      /**< IPv6 destination address to match. */
 448 };
 449
 450 /**
 451  * A structure used to define the input for IPV6 UDP flow
 452  */
 453 struct rte_eth_udpv6_flow {
 454         struct rte_eth_ipv6_flow ip; /**< IPv6 fields to match. */
 455         uint16_t src_port;           /**< UDP source port to match. */
 456         uint16_t dst_port;           /**< UDP destination port to match. */
 457 };
 458
 459 /**
 460  * A structure used to define the input for IPV6 TCP flow
 461  */
 462 struct rte_eth_tcpv6_flow {
 463         struct rte_eth_ipv6_flow ip; /**< IPv6 fields to match. */
 464         uint16_t src_port;           /**< TCP source port to match. */
 465         uint16_t dst_port;           /**< TCP destination port to match. */
 466 };
 467
 468 /**
 469  * A structure used to define the input for IPV6 SCTP flow
 470  */
 471 struct rte_eth_sctpv6_flow {
 472         struct rte_eth_ipv6_flow ip; /**< IPv6 fields to match. */
 473         uint16_t src_port;           /**< SCTP source port to match. */
 474         uint16_t dst_port;           /**< SCTP destination port to match. */
 475         uint32_t verify_tag;         /**< Verify tag to match */
 476 };
 477
 478 /**
 479  * A structure used to define the input for MAC VLAN flow
 480  */
 481 struct rte_eth_mac_vlan_flow {
 482         struct ether_addr mac_addr;  /**< Mac address to match. */
 483 };
 484
 485 /**
 486  * Tunnel type for flow director.
 487  */
 488 enum rte_eth_fdir_tunnel_type {
 489         RTE_FDIR_TUNNEL_TYPE_UNKNOWN = 0,
 490         RTE_FDIR_TUNNEL_TYPE_NVGRE,
 491         RTE_FDIR_TUNNEL_TYPE_VXLAN,
 492 };
 493
 494 /**
 495  * A structure used to define the input for tunnel flow, now it's VxLAN or
 496  * NVGRE
 497  */
 498 struct rte_eth_tunnel_flow {
 499         enum rte_eth_fdir_tunnel_type tunnel_type; /**< Tunnel type to match. */
 500         uint32_t tunnel_id;                        /**< Tunnel ID to match. TNI, VNI... */
 501         struct ether_addr mac_addr;                /**< Mac address to match. */
 502 };
 503
 504 /**
 505  * An union contains the inputs for all types of flow
 506  * Items in flows need to be in big endian
 507  */
 508 union rte_eth_fdir_flow {
 509         struct rte_eth_l2_flow     l2_flow;
 510         struct rte_eth_udpv4_flow  udp4_flow;
 511         struct rte_eth_tcpv4_flow  tcp4_flow;
 512         struct rte_eth_sctpv4_flow sctp4_flow;
 513         struct rte_eth_ipv4_flow   ip4_flow;
 514         struct rte_eth_udpv6_flow  udp6_flow;
 515         struct rte_eth_tcpv6_flow  tcp6_flow;
 516         struct rte_eth_sctpv6_flow sctp6_flow;
 517         struct rte_eth_ipv6_flow   ipv6_flow;
 518         struct rte_eth_mac_vlan_flow mac_vlan_flow;
 519         struct rte_eth_tunnel_flow   tunnel_flow;
 520 };
 521
 522 /**
 523  * A structure used to contain extend input of flow
 524  */
 525 struct rte_eth_fdir_flow_ext {
 526         uint16_t vlan_tci;
 527         uint8_t flexbytes[RTE_ETH_FDIR_MAX_FLEXLEN];
 528         /**< It is filled by the flexible payload to match. */
 529         uint8_t is_vf;   /**< 1 for VF, 0 for port dev */
 530         uint16_t dst_id; /**< VF ID, available when is_vf is 1*/
 531 };
 532
 533 /**
 534  * A structure used to define the input for a flow director filter entry
 535  */
 536 struct rte_eth_fdir_input {
 537         uint16_t flow_type;
 538         union rte_eth_fdir_flow flow;
 539         /**< Flow fields to match, dependent on flow_type */
 540         struct rte_eth_fdir_flow_ext flow_ext;
 541         /**< Additional fields to match */
 542 };
 543
 544 /**
 545  * Behavior will be taken if FDIR match
 546  */
 547 enum rte_eth_fdir_behavior {
 548         RTE_ETH_FDIR_ACCEPT = 0,
 549         RTE_ETH_FDIR_REJECT,
 550         RTE_ETH_FDIR_PASSTHRU,
 551 };
 552
 553 /**
 554  * Flow director report status
 555  * It defines what will be reported if FDIR entry is matched.
 556  */
 557 enum rte_eth_fdir_status {
 558         RTE_ETH_FDIR_NO_REPORT_STATUS = 0, /**< Report nothing. */
 559         RTE_ETH_FDIR_REPORT_ID,            /**< Only report FD ID. */
 560         RTE_ETH_FDIR_REPORT_ID_FLEX_4,     /**< Report FD ID and 4 flex bytes. */
 561         RTE_ETH_FDIR_REPORT_FLEX_8,        /**< Report 8 flex bytes. */
 562 };
 563
 564 /**
 565  * A structure used to define an action when match FDIR packet filter.
 566  */
 567 struct rte_eth_fdir_action {
 568         uint16_t rx_queue;        /**< Queue assigned to if FDIR match. */
 569         enum rte_eth_fdir_behavior behavior;     /**< Behavior will be taken */
 570         enum rte_eth_fdir_status report_status;  /**< Status report option */
 571         uint8_t flex_off;
 572         /**< If report_status is RTE_ETH_FDIR_REPORT_ID_FLEX_4 or
 573              RTE_ETH_FDIR_REPORT_FLEX_8, flex_off specifies where the reported
 574              flex bytes start from in flexible payload. */
 575 };
 576
 577 /**
 578  * A structure used to define the flow director filter entry by filter_ctrl API
 579  * It supports RTE_ETH_FILTER_FDIR with RTE_ETH_FILTER_ADD and
 580  * RTE_ETH_FILTER_DELETE operations.
 581  */
 582 struct rte_eth_fdir_filter {
 583         uint32_t soft_id;
 584         /**< ID, an unique value is required when deal with FDIR entry */
 585         struct rte_eth_fdir_input input;    /**< Input set */
 586         struct rte_eth_fdir_action action;  /**< Action taken when match */
 587 };
 588
 589 /**
 590  *  A structure used to configure FDIR masks that are used by the device
 591  *  to match the various fields of RX packet headers.
 592  */
 593 struct rte_eth_fdir_masks {
 594         uint16_t vlan_tci_mask;   /**< Bit mask for vlan_tci in big endian */
 595         /** Bit mask for ipv4 flow in big endian. */
 596         struct rte_eth_ipv4_flow   ipv4_mask;
 597         /** Bit maks for ipv6 flow in big endian. */
 598         struct rte_eth_ipv6_flow   ipv6_mask;
 599         /** Bit mask for L4 source port in big endian. */
 600         uint16_t src_port_mask;
 601         /** Bit mask for L4 destination port in big endian. */
 602         uint16_t dst_port_mask;
 603         /** 6 bit mask for proper 6 bytes of Mac address, bit 0 matches the
 604             first byte on the wire */
 605         uint8_t mac_addr_byte_mask;
 606         /** Bit mask for tunnel ID in big endian. */
 607         uint32_t tunnel_id_mask;
 608         uint8_t tunnel_type_mask; /**< 1 - Match tunnel type,
 609                                        0 - Ignore tunnel type. */
 610 };
 611
 612 /**
 613  * Payload type
 614  */
 615 enum rte_eth_payload_type {
 616         RTE_ETH_PAYLOAD_UNKNOWN = 0,
 617         RTE_ETH_RAW_PAYLOAD,
 618         RTE_ETH_L2_PAYLOAD,
 619         RTE_ETH_L3_PAYLOAD,
 620         RTE_ETH_L4_PAYLOAD,
 621         RTE_ETH_PAYLOAD_MAX = 8,
 622 };
 623
 624 /**
 625  * A structure used to select bytes extracted from the protocol layers to
 626  * flexible payload for filter
 627  */
 628 struct rte_eth_flex_payload_cfg {
 629         enum rte_eth_payload_type type;  /**< Payload type */
 630         uint16_t src_offset[RTE_ETH_FDIR_MAX_FLEXLEN];
 631         /**< Offset in bytes from the beginning of packet's payload
 632              src_offset[i] indicates the flexbyte i's offset in original
 633              packet payload. This value should be less than
 634              flex_payload_limit in struct rte_eth_fdir_info.*/
 635 };
 636
 637 /**
 638  * A structure used to define FDIR masks for flexible payload
 639  * for each flow type
 640  */
 641 struct rte_eth_fdir_flex_mask {
 642         uint16_t flow_type;
 643         uint8_t mask[RTE_ETH_FDIR_MAX_FLEXLEN];
 644         /**< Mask for the whole flexible payload */
 645 };
 646
 647 /**
 648  * A structure used to define all flexible payload related setting
 649  * include flex payload and flex mask
 650  */
 651 struct rte_eth_fdir_flex_conf {
 652         uint16_t nb_payloads;  /**< The number of following payload cfg */
 653         uint16_t nb_flexmasks; /**< The number of following mask */
 654         struct rte_eth_flex_payload_cfg flex_set[RTE_ETH_PAYLOAD_MAX];
 655         /**< Flex payload configuration for each payload type */
 656         struct rte_eth_fdir_flex_mask flex_mask[RTE_ETH_FLOW_MAX];
 657         /**< Flex mask configuration for each flow type */
 658 };
 659
 660 /**
 661  *  Flow Director setting modes: none, signature or perfect.
 662  */
 663 enum rte_fdir_mode {
 664         RTE_FDIR_MODE_NONE      = 0, /**< Disable FDIR support. */
 665         RTE_FDIR_MODE_SIGNATURE,     /**< Enable FDIR signature filter mode. */
 666         RTE_FDIR_MODE_PERFECT,       /**< Enable FDIR perfect filter mode. */
 667         RTE_FDIR_MODE_PERFECT_MAC_VLAN, /**< Enable FDIR filter mode - MAC VLAN. */
 668         RTE_FDIR_MODE_PERFECT_TUNNEL,   /**< Enable FDIR filter mode - tunnel. */
 669 };
 670
 671 #define UINT32_BIT (CHAR_BIT * sizeof(uint32_t))
 672 #define RTE_FLOW_MASK_ARRAY_SIZE \
 673         (RTE_ALIGN(RTE_ETH_FLOW_MAX, UINT32_BIT)/UINT32_BIT)
 674
 675 /**
 676  * A structure used to get the information of flow director filter.
 677  * It supports RTE_ETH_FILTER_FDIR with RTE_ETH_FILTER_INFO operation.
 678  * It includes the mode, flexible payload configuration information,
 679  * capabilities and supported flow types, flexible payload characters.
 680  * It can be gotten to help taking specific configurations per device.
 681  */
 682 struct rte_eth_fdir_info {
 683         enum rte_fdir_mode mode; /**< Flow director mode */
 684         struct rte_eth_fdir_masks mask;
 685         /** Flex payload configuration information */
 686         struct rte_eth_fdir_flex_conf flex_conf;
 687         uint32_t guarant_spc; /**< Guaranteed spaces.*/
 688         uint32_t best_spc; /**< Best effort spaces.*/
 689         /** Bit mask for every supported flow type. */
 690         uint32_t flow_types_mask[RTE_FLOW_MASK_ARRAY_SIZE];
 691         uint32_t max_flexpayload; /**< Total flex payload in bytes. */
 692         /** Flexible payload unit in bytes. Size and alignments of all flex
 693             payload segments should be multiplies of this value. */
 694         uint32_t flex_payload_unit;
 695         /** Max number of flexible payload continuous segments.
 696             Each segment should be a multiple of flex_payload_unit.*/
 697         uint32_t max_flex_payload_segment_num;
 698         /** Maximum src_offset in bytes allowed. It indicates that
 699             src_offset[i] in struct rte_eth_flex_payload_cfg should be less
 700             than this value. */
 701         uint16_t flex_payload_limit;
 702         /** Flex bitmask unit in bytes. Size of flex bitmasks should be a
 703             multiply of this value. */
 704         uint32_t flex_bitmask_unit;
 705         /** Max supported size of flex bitmasks in flex_bitmask_unit */
 706         uint32_t max_flex_bitmask_num;
 707 };
 708
 709 /**
 710  * A structure used to define the statistics of flow director.
 711  * It supports RTE_ETH_FILTER_FDIR with RTE_ETH_FILTER_STATS operation.
 712  */
 713 struct rte_eth_fdir_stats {
 714         uint32_t collision;    /**< Number of filters with collision. */
 715         uint32_t free;         /**< Number of free filters. */
 716         uint32_t maxhash;
 717         /**< The lookup hash value of the added filter that updated the value
 718            of the MAXLEN field */
 719         uint32_t maxlen;       /**< Longest linked list of filters. */
 720         uint64_t add;          /**< Number of added filters. */
 721         uint64_t remove;       /**< Number of removed filters. */
 722         uint64_t f_add;        /**< Number of failed added filters. */
 723         uint64_t f_remove;     /**< Number of failed removed filters. */
 724         uint32_t guarant_cnt;  /**< Number of filters in guaranteed spaces. */
 725         uint32_t best_cnt;     /**< Number of filters in best effort spaces. */
 726 };
 727
 728 /**
 729  * Flow Director filter information types.
 730  */
 731 enum rte_eth_fdir_filter_info_type {
 732         RTE_ETH_FDIR_FILTER_INFO_TYPE_UNKNOWN = 0,
 733         /** Flow Director filter input set configuration */
 734         RTE_ETH_FDIR_FILTER_INPUT_SET_SELECT,
 735         RTE_ETH_FDIR_FILTER_INFO_TYPE_MAX,
 736 };
 737
 738 /**
 739  * A structure used to set FDIR filter information, to support filter type
 740  * of 'RTE_ETH_FILTER_FDIR' RTE_ETH_FDIR_FILTER_INPUT_SET_SELECT operation.
 741  */
 742 struct rte_eth_fdir_filter_info {
 743         enum rte_eth_fdir_filter_info_type info_type; /**< Information type */
 744         /** Details of fdir filter information */
 745         union {
 746                 /** Flow Director input set configuration per port */
 747                 struct rte_eth_input_set_conf input_set_conf;
 748         } info;
 749 };
 750
 751 /**
 752  * Hash filter information types.
 753  * - RTE_ETH_HASH_FILTER_SYM_HASH_ENA_PER_PORT is for getting/setting the
 754  *   information/configuration of 'symmetric hash enable' per port.
 755  * - RTE_ETH_HASH_FILTER_GLOBAL_CONFIG is for getting/setting the global
 756  *   configurations of hash filters. Those global configurations are valid
 757  *   for all ports of the same NIC.
 758  * - RTE_ETH_HASH_FILTER_INPUT_SET_SELECT is for setting the global
 759  *   hash input set fields
 760  */
 761 enum rte_eth_hash_filter_info_type {
 762         RTE_ETH_HASH_FILTER_INFO_TYPE_UNKNOWN = 0,
 763         /** Symmetric hash enable per port */
 764         RTE_ETH_HASH_FILTER_SYM_HASH_ENA_PER_PORT,
 765         /** Configure globally for hash filter */
 766         RTE_ETH_HASH_FILTER_GLOBAL_CONFIG,
 767         /** Global Hash filter input set configuration */
 768         RTE_ETH_HASH_FILTER_INPUT_SET_SELECT,
 769         RTE_ETH_HASH_FILTER_INFO_TYPE_MAX,
 770 };
 771
 772 /**
 773  * Hash function types.
 774  */
 775 enum rte_eth_hash_function {
 776         RTE_ETH_HASH_FUNCTION_DEFAULT = 0,
 777         RTE_ETH_HASH_FUNCTION_TOEPLITZ, /**< Toeplitz */
 778         RTE_ETH_HASH_FUNCTION_SIMPLE_XOR, /**< Simple XOR */
 779         RTE_ETH_HASH_FUNCTION_MAX,
 780 };
 781
 782 #define RTE_SYM_HASH_MASK_ARRAY_SIZE \
 783         (RTE_ALIGN(RTE_ETH_FLOW_MAX, UINT32_BIT)/UINT32_BIT)
 784 /**
 785  * A structure used to set or get global hash function configurations which
 786  * include symmetric hash enable per flow type and hash function type.
 787  * Each bit in sym_hash_enable_mask[] indicates if the symmetric hash of the
 788  * corresponding flow type is enabled or not.
 789  * Each bit in valid_bit_mask[] indicates if the corresponding bit in
 790  * sym_hash_enable_mask[] is valid or not. For the configurations gotten, it
 791  * also means if the flow type is supported by hardware or not.
 792  */
 793 struct rte_eth_hash_global_conf {
 794         enum rte_eth_hash_function hash_func; /**< Hash function type */
 795         /** Bit mask for symmetric hash enable per flow type */
 796         uint32_t sym_hash_enable_mask[RTE_SYM_HASH_MASK_ARRAY_SIZE];
 797         /** Bit mask indicates if the corresponding bit is valid */
 798         uint32_t valid_bit_mask[RTE_SYM_HASH_MASK_ARRAY_SIZE];
 799 };
 800
 801 /**
 802  * A structure used to set or get hash filter information, to support filter
 803  * type of 'RTE_ETH_FILTER_HASH' and its operations.
 804  */
 805 struct rte_eth_hash_filter_info {
 806         enum rte_eth_hash_filter_info_type info_type; /**< Information type */
 807         /** Details of hash filter information */
 808         union {
 809                 /** For RTE_ETH_HASH_FILTER_SYM_HASH_ENA_PER_PORT */
 810                 uint8_t enable;
 811                 /** Global configurations of hash filter */
 812                 struct rte_eth_hash_global_conf global_conf;
 813                 /** Global configurations of hash filter input set */
 814                 struct rte_eth_input_set_conf input_set_conf;
 815         } info;
 816 };
 817
 818 /**
 819  * l2 tunnel configuration.
 820  */
 821 struct rte_eth_l2_tunnel_conf {
 822         enum rte_eth_tunnel_type l2_tunnel_type;
 823         uint16_t ether_type; /* ether type in l2 header */
 824         uint32_t tunnel_id; /* port tag id for e-tag */
 825         uint16_t vf_id; /* VF id for tag insertion */
 826         uint32_t pool; /* destination pool for tag based forwarding */
 827 };
 828
 829 #ifdef __cplusplus
 830 }
 831 #endif
 832
 833 #endif /* _RTE_ETH_CTRL_H_ */