4 * Copyright(c) 2010-2014 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 * Feature filter types
52 enum rte_filter_type {
53 RTE_ETH_FILTER_NONE = 0,
54 RTE_ETH_FILTER_MACVLAN,
55 RTE_ETH_FILTER_ETHERTYPE,
56 RTE_ETH_FILTER_TUNNEL,
63 * Generic operations on filters
66 /** used to check whether the type filter is supported */
67 RTE_ETH_FILTER_NOP = 0,
68 RTE_ETH_FILTER_ADD, /**< add filter entry */
69 RTE_ETH_FILTER_UPDATE, /**< update filter entry */
70 RTE_ETH_FILTER_DELETE, /**< delete filter entry */
71 RTE_ETH_FILTER_FLUSH, /**< flush all entries */
72 RTE_ETH_FILTER_GET, /**< get filter entry */
73 RTE_ETH_FILTER_SET, /**< configurations */
74 RTE_ETH_FILTER_INFO, /**< retrieve information */
75 RTE_ETH_FILTER_STATS, /**< retrieve statistics */
82 enum rte_mac_filter_type {
83 RTE_MAC_PERFECT_MATCH = 1, /**< exact match of MAC addr. */
84 RTE_MACVLAN_PERFECT_MATCH, /**< exact match of MAC addr and VLAN ID. */
85 RTE_MAC_HASH_MATCH, /**< hash match of MAC addr. */
86 /** hash match of MAC addr and exact match of VLAN ID. */
87 RTE_MACVLAN_HASH_MATCH,
93 struct rte_eth_mac_filter {
94 uint8_t is_vf; /**< 1 for VF, 0 for port dev */
95 uint16_t dst_id; /**< VF ID, available when is_vf is 1*/
96 enum rte_mac_filter_type filter_type; /**< MAC filter type */
97 struct ether_addr mac_addr;
101 * Define all structures for Ethertype Filter type.
104 #define RTE_ETHTYPE_FLAGS_MAC 0x0001 /**< If set, compare mac */
105 #define RTE_ETHTYPE_FLAGS_DROP 0x0002 /**< If set, drop packet when match */
108 * A structure used to define the ethertype filter entry
109 * to support RTE_ETH_FILTER_ETHERTYPE with RTE_ETH_FILTER_ADD,
110 * RTE_ETH_FILTER_DELETE and RTE_ETH_FILTER_GET operations.
112 struct rte_eth_ethertype_filter {
113 struct ether_addr mac_addr; /**< Mac address to match. */
114 uint16_t ether_type; /**< Ether type to match */
115 uint16_t flags; /**< Flags from RTE_ETHTYPE_FLAGS_* */
116 uint16_t queue; /**< Queue assigned to when match*/
122 enum rte_eth_tunnel_type {
123 RTE_TUNNEL_TYPE_NONE = 0,
124 RTE_TUNNEL_TYPE_VXLAN,
125 RTE_TUNNEL_TYPE_GENEVE,
126 RTE_TUNNEL_TYPE_TEREDO,
127 RTE_TUNNEL_TYPE_NVGRE,
132 * filter type of tunneling packet
134 #define ETH_TUNNEL_FILTER_OMAC 0x01 /**< filter by outer MAC addr */
135 #define ETH_TUNNEL_FILTER_OIP 0x02 /**< filter by outer IP Addr */
136 #define ETH_TUNNEL_FILTER_TENID 0x04 /**< filter by tenant ID */
137 #define ETH_TUNNEL_FILTER_IMAC 0x08 /**< filter by inner MAC addr */
138 #define ETH_TUNNEL_FILTER_IVLAN 0x10 /**< filter by inner VLAN ID */
139 #define ETH_TUNNEL_FILTER_IIP 0x20 /**< filter by inner IP addr */
141 #define RTE_TUNNEL_FILTER_IMAC_IVLAN (ETH_TUNNEL_FILTER_IMAC | \
142 ETH_TUNNEL_FILTER_IVLAN)
143 #define RTE_TUNNEL_FILTER_IMAC_IVLAN_TENID (ETH_TUNNEL_FILTER_IMAC | \
144 ETH_TUNNEL_FILTER_IVLAN | \
145 ETH_TUNNEL_FILTER_TENID)
146 #define RTE_TUNNEL_FILTER_IMAC_TENID (ETH_TUNNEL_FILTER_IMAC | \
147 ETH_TUNNEL_FILTER_TENID)
148 #define RTE_TUNNEL_FILTER_OMAC_TENID_IMAC (ETH_TUNNEL_FILTER_OMAC | \
149 ETH_TUNNEL_FILTER_TENID | \
150 ETH_TUNNEL_FILTER_IMAC)
153 * Select IPv4 or IPv6 for tunnel filters.
155 enum rte_tunnel_iptype {
156 RTE_TUNNEL_IPTYPE_IPV4 = 0, /**< IPv4. */
157 RTE_TUNNEL_IPTYPE_IPV6, /**< IPv6. */
161 * Tunneling Packet filter configuration.
163 struct rte_eth_tunnel_filter_conf {
164 struct ether_addr *outer_mac; /**< Outer MAC address filter. */
165 struct ether_addr *inner_mac; /**< Inner MAC address filter. */
166 uint16_t inner_vlan; /**< Inner VLAN filter. */
167 enum rte_tunnel_iptype ip_type; /**< IP address type. */
169 uint32_t ipv4_addr; /**< IPv4 source address to match. */
170 uint32_t ipv6_addr[4]; /**< IPv6 source address to match. */
171 } ip_addr; /**< IPv4/IPv6 source address to match (union of above). */
173 uint16_t filter_type; /**< Filter type. */
174 enum rte_eth_tunnel_type tunnel_type; /**< Tunnel Type. */
175 uint32_t tenant_id; /** < Tenant number. */
176 uint16_t queue_id; /** < queue number. */
179 #define RTE_ETH_FDIR_MAX_FLEXLEN 16 /** < Max length of flexbytes. */
184 enum rte_eth_flow_type {
185 RTE_ETH_FLOW_TYPE_NONE = 0,
186 RTE_ETH_FLOW_TYPE_RAW,
187 RTE_ETH_FLOW_TYPE_UDPV4,
188 RTE_ETH_FLOW_TYPE_TCPV4,
189 RTE_ETH_FLOW_TYPE_SCTPV4,
190 RTE_ETH_FLOW_TYPE_IPV4_OTHER,
191 RTE_ETH_FLOW_TYPE_FRAG_IPV4,
192 RTE_ETH_FLOW_TYPE_UDPV6,
193 RTE_ETH_FLOW_TYPE_TCPV6,
194 RTE_ETH_FLOW_TYPE_SCTPV6,
195 RTE_ETH_FLOW_TYPE_IPV6_OTHER,
196 RTE_ETH_FLOW_TYPE_FRAG_IPV6,
197 RTE_ETH_FLOW_TYPE_MAX = 64,
201 * A structure used to define the input for IPV4 flow
203 struct rte_eth_ipv4_flow {
204 uint32_t src_ip; /**< IPv4 source address to match. */
205 uint32_t dst_ip; /**< IPv4 destination address to match. */
209 * A structure used to define the input for IPV4 UDP flow
211 struct rte_eth_udpv4_flow {
212 struct rte_eth_ipv4_flow ip; /**< IPv4 fields to match. */
213 uint16_t src_port; /**< UDP source port to match. */
214 uint16_t dst_port; /**< UDP destination port to match. */
218 * A structure used to define the input for IPV4 TCP flow
220 struct rte_eth_tcpv4_flow {
221 struct rte_eth_ipv4_flow ip; /**< IPv4 fields to match. */
222 uint16_t src_port; /**< TCP source port to match. */
223 uint16_t dst_port; /**< TCP destination port to match. */
227 * A structure used to define the input for IPV4 SCTP flow
229 struct rte_eth_sctpv4_flow {
230 struct rte_eth_ipv4_flow ip; /**< IPv4 fields to match. */
231 uint32_t verify_tag; /**< Verify tag to match */
235 * A structure used to define the input for IPV6 flow
237 struct rte_eth_ipv6_flow {
238 uint32_t src_ip[4]; /**< IPv6 source address to match. */
239 uint32_t dst_ip[4]; /**< IPv6 destination address to match. */
243 * A structure used to define the input for IPV6 UDP flow
245 struct rte_eth_udpv6_flow {
246 struct rte_eth_ipv6_flow ip; /**< IPv6 fields to match. */
247 uint16_t src_port; /**< UDP source port to match. */
248 uint16_t dst_port; /**< UDP destination port to match. */
252 * A structure used to define the input for IPV6 TCP flow
254 struct rte_eth_tcpv6_flow {
255 struct rte_eth_ipv6_flow ip; /**< IPv6 fields to match. */
256 uint16_t src_port; /**< TCP source port to match. */
257 uint16_t dst_port; /**< TCP destination port to match. */
261 * A structure used to define the input for IPV6 SCTP flow
263 struct rte_eth_sctpv6_flow {
264 struct rte_eth_ipv6_flow ip; /**< IPv6 fields to match. */
265 uint32_t verify_tag; /**< Verify tag to match */
269 * An union contains the inputs for all types of flow
271 union rte_eth_fdir_flow {
272 struct rte_eth_udpv4_flow udp4_flow;
273 struct rte_eth_tcpv4_flow tcp4_flow;
274 struct rte_eth_sctpv4_flow sctp4_flow;
275 struct rte_eth_ipv4_flow ip4_flow;
276 struct rte_eth_udpv6_flow udp6_flow;
277 struct rte_eth_tcpv6_flow tcp6_flow;
278 struct rte_eth_sctpv6_flow sctp6_flow;
279 struct rte_eth_ipv6_flow ipv6_flow;
283 * A structure used to contain extend input of flow
285 struct rte_eth_fdir_flow_ext {
287 uint8_t flexbytes[RTE_ETH_FDIR_MAX_FLEXLEN];
288 /**< It is filled by the flexible payload to match. */
292 * A structure used to define the input for a flow director filter entry
294 struct rte_eth_fdir_input {
295 enum rte_eth_flow_type flow_type; /**< Type of flow */
296 union rte_eth_fdir_flow flow;
297 /**< Flow fields to match, dependent on flow_type */
298 struct rte_eth_fdir_flow_ext flow_ext;
299 /**< Additional fields to match */
303 * Behavior will be taken if FDIR match
305 enum rte_eth_fdir_behavior {
306 RTE_ETH_FDIR_ACCEPT = 0,
311 * Flow director report status
312 * It defines what will be reported if FDIR entry is matched.
314 enum rte_eth_fdir_status {
315 RTE_ETH_FDIR_NO_REPORT_STATUS = 0, /**< Report nothing. */
316 RTE_ETH_FDIR_REPORT_ID, /**< Only report FD ID. */
317 RTE_ETH_FDIR_REPORT_ID_FLEX_4, /**< Report FD ID and 4 flex bytes. */
318 RTE_ETH_FDIR_REPORT_FLEX_8, /**< Report 8 flex bytes. */
322 * A structure used to define an action when match FDIR packet filter.
324 struct rte_eth_fdir_action {
325 uint16_t rx_queue; /**< Queue assigned to if FDIR match. */
326 enum rte_eth_fdir_behavior behavior; /**< Behavior will be taken */
327 enum rte_eth_fdir_status report_status; /**< Status report option */
329 /**< If report_status is RTE_ETH_FDIR_REPORT_ID_FLEX_4 or
330 RTE_ETH_FDIR_REPORT_FLEX_8, flex_off specifies where the reported
331 flex bytes start from in flexible payload. */
335 * A structure used to define the flow director filter entry by filter_ctrl API
336 * It supports RTE_ETH_FILTER_FDIR with RTE_ETH_FILTER_ADD and
337 * RTE_ETH_FILTER_DELETE operations.
339 struct rte_eth_fdir_filter {
341 /**< ID, an unique value is required when deal with FDIR entry */
342 struct rte_eth_fdir_input input; /**< Input set */
343 struct rte_eth_fdir_action action; /**< Action taken when match */
347 * A structure used to configure FDIR masks that are used by the device
348 * to match the various fields of RX packet headers.
350 struct rte_eth_fdir_masks {
351 uint16_t vlan_tci_mask;
352 struct rte_eth_ipv4_flow ipv4_mask;
353 struct rte_eth_ipv6_flow ipv6_mask;
354 uint16_t src_port_mask;
355 uint16_t dst_port_mask;
361 enum rte_eth_payload_type {
362 RTE_ETH_PAYLOAD_UNKNOWN = 0,
367 RTE_ETH_PAYLOAD_MAX = 8,
371 * A structure used to select bytes extracted from the protocol layers to
372 * flexible payload for filter
374 struct rte_eth_flex_payload_cfg {
375 enum rte_eth_payload_type type; /**< Payload type */
376 uint16_t src_offset[RTE_ETH_FDIR_MAX_FLEXLEN];
377 /**< Offset in bytes from the beginning of packet's payload
378 src_offset[i] indicates the flexbyte i's offset in original
379 packet payload. This value should be less than
380 flex_payload_limit in struct rte_eth_fdir_info.*/
384 * A structure used to define FDIR masks for flexible payload
387 struct rte_eth_fdir_flex_mask {
388 enum rte_eth_flow_type flow_type; /**< Flow type */
389 uint8_t mask[RTE_ETH_FDIR_MAX_FLEXLEN];
390 /**< Mask for the whole flexible payload */
394 * A structure used to define all flexible payload related setting
395 * include flexpay load and flex mask
397 struct rte_eth_fdir_flex_conf {
398 uint16_t nb_payloads; /**< The number of following payload cfg */
399 uint16_t nb_flexmasks; /**< The number of following mask */
400 struct rte_eth_flex_payload_cfg flex_set[RTE_ETH_PAYLOAD_MAX];
401 /**< Flex payload configuration for each payload type */
402 struct rte_eth_fdir_flex_mask flex_mask[RTE_ETH_FLOW_TYPE_MAX];
403 /**< Flex mask configuration for each flow type */
407 * Flow Director setting modes: none, signature or perfect.
410 RTE_FDIR_MODE_NONE = 0, /**< Disable FDIR support. */
411 RTE_FDIR_MODE_SIGNATURE, /**< Enable FDIR signature filter mode. */
412 RTE_FDIR_MODE_PERFECT, /**< Enable FDIR perfect filter mode. */
416 * A structure used to get the information of flow director filter.
417 * It supports RTE_ETH_FILTER_FDIR with RTE_ETH_FILTER_INFO operation.
418 * It includes the mode, flexible payload configuration information,
419 * capabilities and supported flow types, flexible payload characters.
420 * It can be gotten to help taking specific configurations per device.
422 struct rte_eth_fdir_info {
423 enum rte_fdir_mode mode; /**< Flow director mode */
424 struct rte_eth_fdir_masks mask;
425 struct rte_eth_fdir_flex_conf flex_conf;
426 /**< Flex payload configuration information */
427 uint32_t guarant_spc; /**< Guaranteed spaces.*/
428 uint32_t best_spc; /**< Best effort spaces.*/
429 uint32_t flow_types_mask[RTE_ETH_FLOW_TYPE_MAX / sizeof(uint32_t)];
430 /**< Bit mask for every supported flow type. */
431 uint32_t max_flexpayload; /**< Total flex payload in bytes. */
432 uint32_t flex_payload_unit;
433 /**< Flexible payload unit in bytes. Size and alignments of all flex
434 payload segments should be multiplies of this value. */
435 uint32_t max_flex_payload_segment_num;
436 /**< Max number of flexible payload continuous segments.
437 Each segment should be a multiple of flex_payload_unit.*/
438 uint16_t flex_payload_limit;
439 /**< Maximum src_offset in bytes allowed. It indicates that
440 src_offset[i] in struct rte_eth_flex_payload_cfg should be
441 less than this value. */
442 uint32_t flex_bitmask_unit;
443 /**< Flex bitmask unit in bytes. Size of flex bitmasks should
444 be a multiply of this value. */
445 uint32_t max_flex_bitmask_num;
446 /**< Max supported size of flex bitmasks in flex_bitmask_unit */
450 * A structure used to define the statistics of flow director.
451 * It supports RTE_ETH_FILTER_FDIR with RTE_ETH_FILTER_STATS operation.
453 struct rte_eth_fdir_stats {
454 uint32_t collision; /**< Number of filters with collision. */
455 uint32_t free; /**< Number of free filters. */
457 /**< The lookup hash value of the added filter that updated the value
458 of the MAXLEN field */
459 uint32_t maxlen; /**< Longest linked list of filters. */
460 uint64_t add; /**< Number of added filters. */
461 uint64_t remove; /**< Number of removed filters. */
462 uint64_t f_add; /**< Number of failed added filters. */
463 uint64_t f_remove; /**< Number of failed removed filters. */
464 uint32_t guarant_cnt; /**< Number of filters in guaranteed spaces. */
465 uint32_t best_cnt; /**< Number of filters in best effort spaces. */
469 * Hash filter information types.
470 * - RTE_ETH_HASH_FILTER_SYM_HASH_ENA_PER_PORT is for getting/setting the
471 * information/configuration of 'symmetric hash enable' per port.
472 * - RTE_ETH_HASH_FILTER_GLOBAL_CONFIG is for getting/setting the global
473 * configurations of hash filters. Those global configurations are valid
474 * for all ports of the same NIC.
476 enum rte_eth_hash_filter_info_type {
477 RTE_ETH_HASH_FILTER_INFO_TYPE_UNKNOWN = 0,
478 /** Symmetric hash enable per port */
479 RTE_ETH_HASH_FILTER_SYM_HASH_ENA_PER_PORT,
480 /** Configure globally for hash filter */
481 RTE_ETH_HASH_FILTER_GLOBAL_CONFIG,
482 RTE_ETH_HASH_FILTER_INFO_TYPE_MAX,
486 * Hash function types.
488 enum rte_eth_hash_function {
489 RTE_ETH_HASH_FUNCTION_DEFAULT = 0,
490 RTE_ETH_HASH_FUNCTION_TOEPLITZ, /**< Toeplitz */
491 RTE_ETH_HASH_FUNCTION_SIMPLE_XOR, /**< Simple XOR */
492 RTE_ETH_HASH_FUNCTION_MAX,
495 #define UINT32_BIT (CHAR_BIT * sizeof(uint32_t))
496 #define RTE_SYM_HASH_MASK_ARRAY_SIZE \
497 (RTE_ALIGN(RTE_ETH_FLOW_TYPE_MAX, UINT32_BIT)/UINT32_BIT)
499 * A structure used to set or get global hash function configurations which
500 * include symmetric hash enable per flow type and hash function type.
501 * Each bit in sym_hash_enable_mask[] indicates if the symmetric hash of the
502 * coresponding flow type is enabled or not.
503 * Each bit in valid_bit_mask[] indicates if the corresponding bit in
504 * sym_hash_enable_mask[] is valid or not. For the configurations gotten, it
505 * also means if the flow type is supported by hardware or not.
507 struct rte_eth_hash_global_conf {
508 enum rte_eth_hash_function hash_func; /**< Hash function type */
509 /** Bit mask for symmetric hash enable per flow type */
510 uint32_t sym_hash_enable_mask[RTE_SYM_HASH_MASK_ARRAY_SIZE];
511 /** Bit mask indicates if the corresponding bit is valid */
512 uint32_t valid_bit_mask[RTE_SYM_HASH_MASK_ARRAY_SIZE];
516 * A structure used to set or get hash filter information, to support filter
517 * type of 'RTE_ETH_FILTER_HASH' and its operations.
519 struct rte_eth_hash_filter_info {
520 enum rte_eth_hash_filter_info_type info_type; /**< Information type */
521 /** Details of hash filter information */
523 /** For RTE_ETH_HASH_FILTER_SYM_HASH_ENA_PER_PORT */
525 /** Global configurations of hash filter */
526 struct rte_eth_hash_global_conf global_conf;
534 #endif /* _RTE_ETH_CTRL_H_ */