4 * Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
34 #ifndef _RTE_ETH_CTRL_H_
35 #define _RTE_ETH_CTRL_H_
40 * Ethernet device features and related data structures used
41 * by control APIs should be defined in this file.
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
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
80 * Feature filter types
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,
88 RTE_ETH_FILTER_NTUPLE,
89 RTE_ETH_FILTER_TUNNEL,
96 * Generic operations on filters
99 /** used to check whether the type filter is supported */
100 RTE_ETH_FILTER_NOP = 0,
101 RTE_ETH_FILTER_ADD, /**< add filter entry */
102 RTE_ETH_FILTER_UPDATE, /**< update filter entry */
103 RTE_ETH_FILTER_DELETE, /**< delete filter entry */
104 RTE_ETH_FILTER_FLUSH, /**< flush all entries */
105 RTE_ETH_FILTER_GET, /**< get filter entry */
106 RTE_ETH_FILTER_SET, /**< configurations */
107 RTE_ETH_FILTER_INFO, /**< retrieve information */
108 RTE_ETH_FILTER_STATS, /**< retrieve statistics */
109 RTE_ETH_FILTER_OP_MAX
115 enum rte_mac_filter_type {
116 RTE_MAC_PERFECT_MATCH = 1, /**< exact match of MAC addr. */
117 RTE_MACVLAN_PERFECT_MATCH, /**< exact match of MAC addr and VLAN ID. */
118 RTE_MAC_HASH_MATCH, /**< hash match of MAC addr. */
119 /** hash match of MAC addr and exact match of VLAN ID. */
120 RTE_MACVLAN_HASH_MATCH,
126 struct rte_eth_mac_filter {
127 uint8_t is_vf; /**< 1 for VF, 0 for port dev */
128 uint16_t dst_id; /**< VF ID, available when is_vf is 1*/
129 enum rte_mac_filter_type filter_type; /**< MAC filter type */
130 struct ether_addr mac_addr;
134 * Define all structures for Ethertype Filter type.
137 #define RTE_ETHTYPE_FLAGS_MAC 0x0001 /**< If set, compare mac */
138 #define RTE_ETHTYPE_FLAGS_DROP 0x0002 /**< If set, drop packet when match */
141 * A structure used to define the ethertype filter entry
142 * to support RTE_ETH_FILTER_ETHERTYPE with RTE_ETH_FILTER_ADD,
143 * RTE_ETH_FILTER_DELETE and RTE_ETH_FILTER_GET operations.
145 struct rte_eth_ethertype_filter {
146 struct ether_addr mac_addr; /**< Mac address to match. */
147 uint16_t ether_type; /**< Ether type to match */
148 uint16_t flags; /**< Flags from RTE_ETHTYPE_FLAGS_* */
149 uint16_t queue; /**< Queue assigned to when match*/
152 #define RTE_FLEX_FILTER_MAXLEN 128 /**< bytes to use in flex filter. */
153 #define RTE_FLEX_FILTER_MASK_SIZE \
154 (RTE_ALIGN(RTE_FLEX_FILTER_MAXLEN, CHAR_BIT) / CHAR_BIT)
155 /**< mask bytes in flex filter. */
158 * A structure used to define the flex filter entry
159 * to support RTE_ETH_FILTER_FLEXIBLE with RTE_ETH_FILTER_ADD,
160 * RTE_ETH_FILTER_DELETE and RTE_ETH_FILTER_GET operations.
162 struct rte_eth_flex_filter {
164 uint8_t bytes[RTE_FLEX_FILTER_MAXLEN]; /**< flex bytes in big endian.*/
165 uint8_t mask[RTE_FLEX_FILTER_MASK_SIZE]; /**< if mask bit is 1b, do
166 not compare corresponding byte. */
168 uint16_t queue; /**< Queue assigned to when match. */
172 * A structure used to define the TCP syn filter entry
173 * to support RTE_ETH_FILTER_SYN with RTE_ETH_FILTER_ADD,
174 * RTE_ETH_FILTER_DELETE and RTE_ETH_FILTER_GET operations.
176 struct rte_eth_syn_filter {
177 uint8_t hig_pri; /**< 1 - higher priority than other filters,
178 0 - lower priority. */
179 uint16_t queue; /**< Queue assigned to when match */
183 * Define all structures for ntuple Filter type.
186 #define RTE_NTUPLE_FLAGS_DST_IP 0x0001 /**< If set, dst_ip is part of ntuple */
187 #define RTE_NTUPLE_FLAGS_SRC_IP 0x0002 /**< If set, src_ip is part of ntuple */
188 #define RTE_NTUPLE_FLAGS_DST_PORT 0x0004 /**< If set, dst_port is part of ntuple */
189 #define RTE_NTUPLE_FLAGS_SRC_PORT 0x0008 /**< If set, src_port is part of ntuple */
190 #define RTE_NTUPLE_FLAGS_PROTO 0x0010 /**< If set, protocol is part of ntuple */
191 #define RTE_NTUPLE_FLAGS_TCP_FLAG 0x0020 /**< If set, tcp flag is involved */
193 #define RTE_5TUPLE_FLAGS ( \
194 RTE_NTUPLE_FLAGS_DST_IP | \
195 RTE_NTUPLE_FLAGS_SRC_IP | \
196 RTE_NTUPLE_FLAGS_DST_PORT | \
197 RTE_NTUPLE_FLAGS_SRC_PORT | \
198 RTE_NTUPLE_FLAGS_PROTO)
200 #define RTE_2TUPLE_FLAGS ( \
201 RTE_NTUPLE_FLAGS_DST_PORT | \
202 RTE_NTUPLE_FLAGS_PROTO)
204 #define TCP_URG_FLAG 0x20
205 #define TCP_ACK_FLAG 0x10
206 #define TCP_PSH_FLAG 0x08
207 #define TCP_RST_FLAG 0x04
208 #define TCP_SYN_FLAG 0x02
209 #define TCP_FIN_FLAG 0x01
210 #define TCP_FLAG_ALL 0x3F
213 * A structure used to define the ntuple filter entry
214 * to support RTE_ETH_FILTER_NTUPLE with RTE_ETH_FILTER_ADD,
215 * RTE_ETH_FILTER_DELETE and RTE_ETH_FILTER_GET operations.
217 struct rte_eth_ntuple_filter {
218 uint16_t flags; /**< Flags from RTE_NTUPLE_FLAGS_* */
219 uint32_t dst_ip; /**< Destination IP address in big endian. */
220 uint32_t dst_ip_mask; /**< Mask of destination IP address. */
221 uint32_t src_ip; /**< Source IP address in big endian. */
222 uint32_t src_ip_mask; /**< Mask of destination IP address. */
223 uint16_t dst_port; /**< Destination port in big endian. */
224 uint16_t dst_port_mask; /**< Mask of destination port. */
225 uint16_t src_port; /**< Source Port in big endian. */
226 uint16_t src_port_mask; /**< Mask of source port. */
227 uint8_t proto; /**< L4 protocol. */
228 uint8_t proto_mask; /**< Mask of L4 protocol. */
229 /** tcp_flags only meaningful when the proto is TCP.
230 The packet matched above ntuple fields and contain
231 any set bit in tcp_flags will hit this filter. */
233 uint16_t priority; /**< seven levels (001b-111b), 111b is highest,
234 used when more than one filter matches. */
235 uint16_t queue; /**< Queue assigned to when match*/
241 enum rte_eth_tunnel_type {
242 RTE_TUNNEL_TYPE_NONE = 0,
243 RTE_TUNNEL_TYPE_VXLAN,
244 RTE_TUNNEL_TYPE_GENEVE,
245 RTE_TUNNEL_TYPE_TEREDO,
246 RTE_TUNNEL_TYPE_NVGRE,
251 * filter type of tunneling packet
253 #define ETH_TUNNEL_FILTER_OMAC 0x01 /**< filter by outer MAC addr */
254 #define ETH_TUNNEL_FILTER_OIP 0x02 /**< filter by outer IP Addr */
255 #define ETH_TUNNEL_FILTER_TENID 0x04 /**< filter by tenant ID */
256 #define ETH_TUNNEL_FILTER_IMAC 0x08 /**< filter by inner MAC addr */
257 #define ETH_TUNNEL_FILTER_IVLAN 0x10 /**< filter by inner VLAN ID */
258 #define ETH_TUNNEL_FILTER_IIP 0x20 /**< filter by inner IP addr */
260 #define RTE_TUNNEL_FILTER_IMAC_IVLAN (ETH_TUNNEL_FILTER_IMAC | \
261 ETH_TUNNEL_FILTER_IVLAN)
262 #define RTE_TUNNEL_FILTER_IMAC_IVLAN_TENID (ETH_TUNNEL_FILTER_IMAC | \
263 ETH_TUNNEL_FILTER_IVLAN | \
264 ETH_TUNNEL_FILTER_TENID)
265 #define RTE_TUNNEL_FILTER_IMAC_TENID (ETH_TUNNEL_FILTER_IMAC | \
266 ETH_TUNNEL_FILTER_TENID)
267 #define RTE_TUNNEL_FILTER_OMAC_TENID_IMAC (ETH_TUNNEL_FILTER_OMAC | \
268 ETH_TUNNEL_FILTER_TENID | \
269 ETH_TUNNEL_FILTER_IMAC)
272 * Select IPv4 or IPv6 for tunnel filters.
274 enum rte_tunnel_iptype {
275 RTE_TUNNEL_IPTYPE_IPV4 = 0, /**< IPv4. */
276 RTE_TUNNEL_IPTYPE_IPV6, /**< IPv6. */
280 * Tunneling Packet filter configuration.
282 struct rte_eth_tunnel_filter_conf {
283 struct ether_addr *outer_mac; /**< Outer MAC address filter. */
284 struct ether_addr *inner_mac; /**< Inner MAC address filter. */
285 uint16_t inner_vlan; /**< Inner VLAN filter. */
286 enum rte_tunnel_iptype ip_type; /**< IP address type. */
288 uint32_t ipv4_addr; /**< IPv4 source address to match. */
289 uint32_t ipv6_addr[4]; /**< IPv6 source address to match. */
290 } ip_addr; /**< IPv4/IPv6 source address to match (union of above). */
292 uint16_t filter_type; /**< Filter type. */
293 enum rte_eth_tunnel_type tunnel_type; /**< Tunnel Type. */
294 uint32_t tenant_id; /**< Tenant number. */
295 uint16_t queue_id; /**< Queue number. */
299 * Global eth device configuration type.
301 enum rte_eth_global_cfg_type {
302 RTE_ETH_GLOBAL_CFG_TYPE_UNKNOWN = 0,
303 RTE_ETH_GLOBAL_CFG_TYPE_GRE_KEY_LEN,
304 RTE_ETH_GLOBAL_CFG_TYPE_MAX,
308 * Global eth device configuration.
310 struct rte_eth_global_cfg {
311 enum rte_eth_global_cfg_type cfg_type; /**< Global config type. */
313 uint8_t gre_key_len; /**< Valid GRE key length in byte. */
314 uint64_t reserved; /**< Reserve space for future use. */
318 #define RTE_ETH_FDIR_MAX_FLEXLEN 16 /**< Max length of flexbytes. */
319 #define RTE_ETH_INSET_SIZE_MAX 128 /**< Max length of input set. */
322 * Input set fields for Flow Director and Hash filters
324 enum rte_eth_input_set_field {
325 RTE_ETH_INPUT_SET_UNKNOWN = 0,
328 RTE_ETH_INPUT_SET_L2_SRC_MAC = 1,
329 RTE_ETH_INPUT_SET_L2_DST_MAC,
330 RTE_ETH_INPUT_SET_L2_OUTER_VLAN,
331 RTE_ETH_INPUT_SET_L2_INNER_VLAN,
332 RTE_ETH_INPUT_SET_L2_ETHERTYPE,
335 RTE_ETH_INPUT_SET_L3_SRC_IP4 = 129,
336 RTE_ETH_INPUT_SET_L3_DST_IP4,
337 RTE_ETH_INPUT_SET_L3_SRC_IP6,
338 RTE_ETH_INPUT_SET_L3_DST_IP6,
339 RTE_ETH_INPUT_SET_L3_IP4_TOS,
340 RTE_ETH_INPUT_SET_L3_IP4_PROTO,
341 RTE_ETH_INPUT_SET_L3_IP6_TC,
342 RTE_ETH_INPUT_SET_L3_IP6_NEXT_HEADER,
345 RTE_ETH_INPUT_SET_L4_UDP_SRC_PORT = 257,
346 RTE_ETH_INPUT_SET_L4_UDP_DST_PORT,
347 RTE_ETH_INPUT_SET_L4_TCP_SRC_PORT,
348 RTE_ETH_INPUT_SET_L4_TCP_DST_PORT,
349 RTE_ETH_INPUT_SET_L4_SCTP_SRC_PORT,
350 RTE_ETH_INPUT_SET_L4_SCTP_DST_PORT,
351 RTE_ETH_INPUT_SET_L4_SCTP_VERIFICATION_TAG,
354 RTE_ETH_INPUT_SET_TUNNEL_L2_INNER_DST_MAC = 385,
355 RTE_ETH_INPUT_SET_TUNNEL_L2_INNER_SRC_MAC,
356 RTE_ETH_INPUT_SET_TUNNEL_L2_INNER_VLAN,
357 RTE_ETH_INPUT_SET_TUNNEL_L4_UDP_KEY,
358 RTE_ETH_INPUT_SET_TUNNEL_GRE_KEY,
360 /* Flexible Payload */
361 RTE_ETH_INPUT_SET_FLEX_PAYLOAD_1ST_WORD = 641,
362 RTE_ETH_INPUT_SET_FLEX_PAYLOAD_2ND_WORD,
363 RTE_ETH_INPUT_SET_FLEX_PAYLOAD_3RD_WORD,
364 RTE_ETH_INPUT_SET_FLEX_PAYLOAD_4TH_WORD,
365 RTE_ETH_INPUT_SET_FLEX_PAYLOAD_5TH_WORD,
366 RTE_ETH_INPUT_SET_FLEX_PAYLOAD_6TH_WORD,
367 RTE_ETH_INPUT_SET_FLEX_PAYLOAD_7TH_WORD,
368 RTE_ETH_INPUT_SET_FLEX_PAYLOAD_8TH_WORD,
370 RTE_ETH_INPUT_SET_DEFAULT = 65533,
371 RTE_ETH_INPUT_SET_NONE = 65534,
372 RTE_ETH_INPUT_SET_MAX = 65535,
376 * Filters input set operations
378 enum rte_filter_input_set_op {
379 RTE_ETH_INPUT_SET_OP_UNKNOWN,
380 RTE_ETH_INPUT_SET_SELECT, /**< select input set */
381 RTE_ETH_INPUT_SET_ADD, /**< add input set entry */
382 RTE_ETH_INPUT_SET_OP_MAX
387 * A structure used to define the input set configuration for
388 * flow director and hash filters
390 struct rte_eth_input_set_conf {
393 enum rte_eth_input_set_field field[RTE_ETH_INSET_SIZE_MAX];
394 enum rte_filter_input_set_op op;
398 * A structure used to define the input for L2 flow
400 struct rte_eth_l2_flow {
401 uint16_t ether_type; /**< Ether type to match */
405 * A structure used to define the input for IPV4 flow
407 struct rte_eth_ipv4_flow {
408 uint32_t src_ip; /**< IPv4 source address to match. */
409 uint32_t dst_ip; /**< IPv4 destination address to match. */
413 * A structure used to define the input for IPV4 UDP flow
415 struct rte_eth_udpv4_flow {
416 struct rte_eth_ipv4_flow ip; /**< IPv4 fields to match. */
417 uint16_t src_port; /**< UDP source port to match. */
418 uint16_t dst_port; /**< UDP destination port to match. */
422 * A structure used to define the input for IPV4 TCP flow
424 struct rte_eth_tcpv4_flow {
425 struct rte_eth_ipv4_flow ip; /**< IPv4 fields to match. */
426 uint16_t src_port; /**< TCP source port to match. */
427 uint16_t dst_port; /**< TCP destination port to match. */
431 * A structure used to define the input for IPV4 SCTP flow
433 struct rte_eth_sctpv4_flow {
434 struct rte_eth_ipv4_flow ip; /**< IPv4 fields to match. */
435 uint16_t src_port; /**< SCTP source port to match. */
436 uint16_t dst_port; /**< SCTP destination port to match. */
437 uint32_t verify_tag; /**< Verify tag to match */
441 * A structure used to define the input for IPV6 flow
443 struct rte_eth_ipv6_flow {
444 uint32_t src_ip[4]; /**< IPv6 source address to match. */
445 uint32_t dst_ip[4]; /**< IPv6 destination address to match. */
449 * A structure used to define the input for IPV6 UDP flow
451 struct rte_eth_udpv6_flow {
452 struct rte_eth_ipv6_flow ip; /**< IPv6 fields to match. */
453 uint16_t src_port; /**< UDP source port to match. */
454 uint16_t dst_port; /**< UDP destination port to match. */
458 * A structure used to define the input for IPV6 TCP flow
460 struct rte_eth_tcpv6_flow {
461 struct rte_eth_ipv6_flow ip; /**< IPv6 fields to match. */
462 uint16_t src_port; /**< TCP source port to match. */
463 uint16_t dst_port; /**< TCP destination port to match. */
467 * A structure used to define the input for IPV6 SCTP flow
469 struct rte_eth_sctpv6_flow {
470 struct rte_eth_ipv6_flow ip; /**< IPv6 fields to match. */
471 uint16_t src_port; /**< SCTP source port to match. */
472 uint16_t dst_port; /**< SCTP destination port to match. */
473 uint32_t verify_tag; /**< Verify tag to match */
477 * A structure used to define the input for MAC VLAN flow
479 struct rte_eth_mac_vlan_flow {
480 struct ether_addr mac_addr; /**< Mac address to match. */
484 * Tunnel type for flow director.
486 enum rte_eth_fdir_tunnel_type {
487 RTE_FDIR_TUNNEL_TYPE_UNKNOWN = 0,
488 RTE_FDIR_TUNNEL_TYPE_NVGRE,
489 RTE_FDIR_TUNNEL_TYPE_VXLAN,
493 * A structure used to define the input for tunnel flow, now it's VxLAN or
496 struct rte_eth_tunnel_flow {
497 enum rte_eth_fdir_tunnel_type tunnel_type; /**< Tunnel type to match. */
498 uint32_t tunnel_id; /**< Tunnel ID to match. TNI, VNI... */
499 struct ether_addr mac_addr; /**< Mac address to match. */
503 * An union contains the inputs for all types of flow
505 union rte_eth_fdir_flow {
506 struct rte_eth_l2_flow l2_flow;
507 struct rte_eth_udpv4_flow udp4_flow;
508 struct rte_eth_tcpv4_flow tcp4_flow;
509 struct rte_eth_sctpv4_flow sctp4_flow;
510 struct rte_eth_ipv4_flow ip4_flow;
511 struct rte_eth_udpv6_flow udp6_flow;
512 struct rte_eth_tcpv6_flow tcp6_flow;
513 struct rte_eth_sctpv6_flow sctp6_flow;
514 struct rte_eth_ipv6_flow ipv6_flow;
515 struct rte_eth_mac_vlan_flow mac_vlan_flow;
516 struct rte_eth_tunnel_flow tunnel_flow;
520 * A structure used to contain extend input of flow
522 struct rte_eth_fdir_flow_ext {
524 uint8_t flexbytes[RTE_ETH_FDIR_MAX_FLEXLEN];
525 /**< It is filled by the flexible payload to match. */
526 uint8_t is_vf; /**< 1 for VF, 0 for port dev */
527 uint16_t dst_id; /**< VF ID, available when is_vf is 1*/
531 * A structure used to define the input for a flow director filter entry
533 struct rte_eth_fdir_input {
535 union rte_eth_fdir_flow flow;
536 /**< Flow fields to match, dependent on flow_type */
537 struct rte_eth_fdir_flow_ext flow_ext;
538 /**< Additional fields to match */
542 * Behavior will be taken if FDIR match
544 enum rte_eth_fdir_behavior {
545 RTE_ETH_FDIR_ACCEPT = 0,
550 * Flow director report status
551 * It defines what will be reported if FDIR entry is matched.
553 enum rte_eth_fdir_status {
554 RTE_ETH_FDIR_NO_REPORT_STATUS = 0, /**< Report nothing. */
555 RTE_ETH_FDIR_REPORT_ID, /**< Only report FD ID. */
556 RTE_ETH_FDIR_REPORT_ID_FLEX_4, /**< Report FD ID and 4 flex bytes. */
557 RTE_ETH_FDIR_REPORT_FLEX_8, /**< Report 8 flex bytes. */
561 * A structure used to define an action when match FDIR packet filter.
563 struct rte_eth_fdir_action {
564 uint16_t rx_queue; /**< Queue assigned to if FDIR match. */
565 enum rte_eth_fdir_behavior behavior; /**< Behavior will be taken */
566 enum rte_eth_fdir_status report_status; /**< Status report option */
568 /**< If report_status is RTE_ETH_FDIR_REPORT_ID_FLEX_4 or
569 RTE_ETH_FDIR_REPORT_FLEX_8, flex_off specifies where the reported
570 flex bytes start from in flexible payload. */
574 * A structure used to define the flow director filter entry by filter_ctrl API
575 * It supports RTE_ETH_FILTER_FDIR with RTE_ETH_FILTER_ADD and
576 * RTE_ETH_FILTER_DELETE operations.
578 struct rte_eth_fdir_filter {
580 /**< ID, an unique value is required when deal with FDIR entry */
581 struct rte_eth_fdir_input input; /**< Input set */
582 struct rte_eth_fdir_action action; /**< Action taken when match */
586 * A structure used to configure FDIR masks that are used by the device
587 * to match the various fields of RX packet headers.
589 struct rte_eth_fdir_masks {
590 uint16_t vlan_tci_mask;
591 struct rte_eth_ipv4_flow ipv4_mask;
592 struct rte_eth_ipv6_flow ipv6_mask;
593 uint16_t src_port_mask;
594 uint16_t dst_port_mask;
595 uint8_t mac_addr_byte_mask; /** Per byte MAC address mask */
596 uint32_t tunnel_id_mask; /** tunnel ID mask */
597 uint8_t tunnel_type_mask;
603 enum rte_eth_payload_type {
604 RTE_ETH_PAYLOAD_UNKNOWN = 0,
609 RTE_ETH_PAYLOAD_MAX = 8,
613 * A structure used to select bytes extracted from the protocol layers to
614 * flexible payload for filter
616 struct rte_eth_flex_payload_cfg {
617 enum rte_eth_payload_type type; /**< Payload type */
618 uint16_t src_offset[RTE_ETH_FDIR_MAX_FLEXLEN];
619 /**< Offset in bytes from the beginning of packet's payload
620 src_offset[i] indicates the flexbyte i's offset in original
621 packet payload. This value should be less than
622 flex_payload_limit in struct rte_eth_fdir_info.*/
626 * A structure used to define FDIR masks for flexible payload
629 struct rte_eth_fdir_flex_mask {
631 uint8_t mask[RTE_ETH_FDIR_MAX_FLEXLEN];
632 /**< Mask for the whole flexible payload */
636 * A structure used to define all flexible payload related setting
637 * include flex payload and flex mask
639 struct rte_eth_fdir_flex_conf {
640 uint16_t nb_payloads; /**< The number of following payload cfg */
641 uint16_t nb_flexmasks; /**< The number of following mask */
642 struct rte_eth_flex_payload_cfg flex_set[RTE_ETH_PAYLOAD_MAX];
643 /**< Flex payload configuration for each payload type */
644 struct rte_eth_fdir_flex_mask flex_mask[RTE_ETH_FLOW_MAX];
645 /**< Flex mask configuration for each flow type */
649 * Flow Director setting modes: none, signature or perfect.
652 RTE_FDIR_MODE_NONE = 0, /**< Disable FDIR support. */
653 RTE_FDIR_MODE_SIGNATURE, /**< Enable FDIR signature filter mode. */
654 RTE_FDIR_MODE_PERFECT, /**< Enable FDIR perfect filter mode. */
655 RTE_FDIR_MODE_PERFECT_MAC_VLAN, /**< Enable FDIR filter mode - MAC VLAN. */
656 RTE_FDIR_MODE_PERFECT_TUNNEL, /**< Enable FDIR filter mode - tunnel. */
659 #define UINT32_BIT (CHAR_BIT * sizeof(uint32_t))
660 #define RTE_FLOW_MASK_ARRAY_SIZE \
661 (RTE_ALIGN(RTE_ETH_FLOW_MAX, UINT32_BIT)/UINT32_BIT)
664 * A structure used to get the information of flow director filter.
665 * It supports RTE_ETH_FILTER_FDIR with RTE_ETH_FILTER_INFO operation.
666 * It includes the mode, flexible payload configuration information,
667 * capabilities and supported flow types, flexible payload characters.
668 * It can be gotten to help taking specific configurations per device.
670 struct rte_eth_fdir_info {
671 enum rte_fdir_mode mode; /**< Flow director mode */
672 struct rte_eth_fdir_masks mask;
673 /** Flex payload configuration information */
674 struct rte_eth_fdir_flex_conf flex_conf;
675 uint32_t guarant_spc; /**< Guaranteed spaces.*/
676 uint32_t best_spc; /**< Best effort spaces.*/
677 /** Bit mask for every supported flow type. */
678 uint32_t flow_types_mask[RTE_FLOW_MASK_ARRAY_SIZE];
679 uint32_t max_flexpayload; /**< Total flex payload in bytes. */
680 /** Flexible payload unit in bytes. Size and alignments of all flex
681 payload segments should be multiplies of this value. */
682 uint32_t flex_payload_unit;
683 /** Max number of flexible payload continuous segments.
684 Each segment should be a multiple of flex_payload_unit.*/
685 uint32_t max_flex_payload_segment_num;
686 /** Maximum src_offset in bytes allowed. It indicates that
687 src_offset[i] in struct rte_eth_flex_payload_cfg should be less
689 uint16_t flex_payload_limit;
690 /** Flex bitmask unit in bytes. Size of flex bitmasks should be a
691 multiply of this value. */
692 uint32_t flex_bitmask_unit;
693 /** Max supported size of flex bitmasks in flex_bitmask_unit */
694 uint32_t max_flex_bitmask_num;
698 * A structure used to define the statistics of flow director.
699 * It supports RTE_ETH_FILTER_FDIR with RTE_ETH_FILTER_STATS operation.
701 struct rte_eth_fdir_stats {
702 uint32_t collision; /**< Number of filters with collision. */
703 uint32_t free; /**< Number of free filters. */
705 /**< The lookup hash value of the added filter that updated the value
706 of the MAXLEN field */
707 uint32_t maxlen; /**< Longest linked list of filters. */
708 uint64_t add; /**< Number of added filters. */
709 uint64_t remove; /**< Number of removed filters. */
710 uint64_t f_add; /**< Number of failed added filters. */
711 uint64_t f_remove; /**< Number of failed removed filters. */
712 uint32_t guarant_cnt; /**< Number of filters in guaranteed spaces. */
713 uint32_t best_cnt; /**< Number of filters in best effort spaces. */
717 * Flow Director filter information types.
719 enum rte_eth_fdir_filter_info_type {
720 RTE_ETH_FDIR_FILTER_INFO_TYPE_UNKNOWN = 0,
721 /** Flow Director filter input set configuration */
722 RTE_ETH_FDIR_FILTER_INPUT_SET_SELECT,
723 RTE_ETH_FDIR_FILTER_INFO_TYPE_MAX,
727 * A structure used to set FDIR filter information, to support filter type
728 * of 'RTE_ETH_FILTER_FDIR' RTE_ETH_FDIR_FILTER_INPUT_SET_SELECT operation.
730 struct rte_eth_fdir_filter_info {
731 enum rte_eth_fdir_filter_info_type info_type; /**< Information type */
732 /** Details of fdir filter information */
734 /** Flow Director input set configuration per port */
735 struct rte_eth_input_set_conf input_set_conf;
740 * Hash filter information types.
741 * - RTE_ETH_HASH_FILTER_SYM_HASH_ENA_PER_PORT is for getting/setting the
742 * information/configuration of 'symmetric hash enable' per port.
743 * - RTE_ETH_HASH_FILTER_GLOBAL_CONFIG is for getting/setting the global
744 * configurations of hash filters. Those global configurations are valid
745 * for all ports of the same NIC.
746 * - RTE_ETH_HASH_FILTER_INPUT_SET_SELECT is for setting the global
747 * hash input set fields
749 enum rte_eth_hash_filter_info_type {
750 RTE_ETH_HASH_FILTER_INFO_TYPE_UNKNOWN = 0,
751 /** Symmetric hash enable per port */
752 RTE_ETH_HASH_FILTER_SYM_HASH_ENA_PER_PORT,
753 /** Configure globally for hash filter */
754 RTE_ETH_HASH_FILTER_GLOBAL_CONFIG,
755 /** Global Hash filter input set configuration */
756 RTE_ETH_HASH_FILTER_INPUT_SET_SELECT,
757 RTE_ETH_HASH_FILTER_INFO_TYPE_MAX,
761 * Hash function types.
763 enum rte_eth_hash_function {
764 RTE_ETH_HASH_FUNCTION_DEFAULT = 0,
765 RTE_ETH_HASH_FUNCTION_TOEPLITZ, /**< Toeplitz */
766 RTE_ETH_HASH_FUNCTION_SIMPLE_XOR, /**< Simple XOR */
767 RTE_ETH_HASH_FUNCTION_MAX,
770 #define RTE_SYM_HASH_MASK_ARRAY_SIZE \
771 (RTE_ALIGN(RTE_ETH_FLOW_MAX, UINT32_BIT)/UINT32_BIT)
773 * A structure used to set or get global hash function configurations which
774 * include symmetric hash enable per flow type and hash function type.
775 * Each bit in sym_hash_enable_mask[] indicates if the symmetric hash of the
776 * corresponding flow type is enabled or not.
777 * Each bit in valid_bit_mask[] indicates if the corresponding bit in
778 * sym_hash_enable_mask[] is valid or not. For the configurations gotten, it
779 * also means if the flow type is supported by hardware or not.
781 struct rte_eth_hash_global_conf {
782 enum rte_eth_hash_function hash_func; /**< Hash function type */
783 /** Bit mask for symmetric hash enable per flow type */
784 uint32_t sym_hash_enable_mask[RTE_SYM_HASH_MASK_ARRAY_SIZE];
785 /** Bit mask indicates if the corresponding bit is valid */
786 uint32_t valid_bit_mask[RTE_SYM_HASH_MASK_ARRAY_SIZE];
790 * A structure used to set or get hash filter information, to support filter
791 * type of 'RTE_ETH_FILTER_HASH' and its operations.
793 struct rte_eth_hash_filter_info {
794 enum rte_eth_hash_filter_info_type info_type; /**< Information type */
795 /** Details of hash filter information */
797 /** For RTE_ETH_HASH_FILTER_SYM_HASH_ENA_PER_PORT */
799 /** Global configurations of hash filter */
800 struct rte_eth_hash_global_conf global_conf;
801 /** Global configurations of hash filter input set */
802 struct rte_eth_input_set_conf input_set_conf;
810 #endif /* _RTE_ETH_CTRL_H_ */