1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2017 Intel Corporation.
7 This section explains the supported features that are listed in the
10 As a guide to implementers it also shows the structs where the features are
11 defined and the APIs that can be use to get/set the values.
13 Following tags used for feature details, these are from driver point of view:
15 ``[uses]`` : Driver uses some kind of input from the application.
17 ``[implements]`` : Driver implements a functionality.
19 ``[provides]`` : Driver provides some kind of data to the application. It is possible
20 to provide data by implementing some function, but "provides" is used
21 for cases where provided data can't be represented simply by a function.
23 ``[related]`` : Related API with that feature.
26 .. _nic_features_speed_capabilities:
31 Supports getting the speed capabilities that the current device is capable of.
33 * **[provides] rte_eth_dev_info**: ``speed_capa:ETH_LINK_SPEED_*``.
34 * **[related] API**: ``rte_eth_dev_info_get()``.
37 .. _nic_features_link_status:
42 Supports getting the link speed, duplex mode and link state (up/down).
44 * **[implements] eth_dev_ops**: ``link_update``.
45 * **[implements] rte_eth_dev_data**: ``dev_link``.
46 * **[related] API**: ``rte_eth_link_get()``, ``rte_eth_link_get_nowait()``.
49 .. _nic_features_link_status_event:
54 Supports Link Status Change interrupts.
56 * **[uses] user config**: ``dev_conf.intr_conf.lsc``.
57 * **[uses] rte_eth_dev_data**: ``dev_flags:RTE_ETH_DEV_INTR_LSC``.
58 * **[uses] rte_eth_event_type**: ``RTE_ETH_EVENT_INTR_LSC``.
59 * **[implements] rte_eth_dev_data**: ``dev_link``.
60 * **[provides] rte_pci_driver.drv_flags**: ``RTE_PCI_DRV_INTR_LSC``.
61 * **[related] API**: ``rte_eth_link_get()``, ``rte_eth_link_get_nowait()``.
64 .. _nic_features_removal_event:
69 Supports device removal interrupts.
71 * **[uses] user config**: ``dev_conf.intr_conf.rmv``.
72 * **[uses] rte_eth_dev_data**: ``dev_flags:RTE_ETH_DEV_INTR_RMV``.
73 * **[uses] rte_eth_event_type**: ``RTE_ETH_EVENT_INTR_RMV``.
74 * **[provides] rte_pci_driver.drv_flags**: ``RTE_PCI_DRV_INTR_RMV``.
77 .. _nic_features_queue_status_event:
82 Supports queue enable/disable events.
84 * **[uses] rte_eth_event_type**: ``RTE_ETH_EVENT_QUEUE_STATE``.
87 .. _nic_features_rx_interrupt:
92 Supports Rx interrupts.
94 * **[uses] user config**: ``dev_conf.intr_conf.rxq``.
95 * **[implements] eth_dev_ops**: ``rx_queue_intr_enable``, ``rx_queue_intr_disable``.
96 * **[related] API**: ``rte_eth_dev_rx_intr_enable()``, ``rte_eth_dev_rx_intr_disable()``.
99 .. _nic_features_lock-free_tx_queue:
104 If a PMD advertises DEV_TX_OFFLOAD_MT_LOCKFREE capable, multiple threads can
105 invoke rte_eth_tx_burst() concurrently on the same Tx queue without SW lock.
107 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_MT_LOCKFREE``.
108 * **[provides] rte_eth_dev_info**: ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_MT_LOCKFREE``.
109 * **[related] API**: ``rte_eth_tx_burst()``.
112 .. _nic_features_fast_mbuf_free:
117 Supports optimization for fast release of mbufs following successful Tx.
118 Requires that per queue, all mbufs come from the same mempool and has refcnt = 1.
120 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_MBUF_FAST_FREE``.
121 * **[provides] rte_eth_dev_info**: ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_MBUF_FAST_FREE``.
124 .. _nic_features_free_tx_mbuf_on_demand:
126 Free Tx mbuf on demand
127 ----------------------
129 Supports freeing consumed buffers on a Tx ring.
131 * **[implements] eth_dev_ops**: ``tx_done_cleanup``.
132 * **[related] API**: ``rte_eth_tx_done_cleanup()``.
135 .. _nic_features_queue_start_stop:
140 Supports starting/stopping a specific Rx/Tx queue of a port.
142 * **[implements] eth_dev_ops**: ``rx_queue_start``, ``rx_queue_stop``, ``tx_queue_start``,
144 * **[related] API**: ``rte_eth_dev_rx_queue_start()``, ``rte_eth_dev_rx_queue_stop()``,
145 ``rte_eth_dev_tx_queue_start()``, ``rte_eth_dev_tx_queue_stop()``.
148 .. _nic_features_mtu_update:
153 Supports updating port MTU.
155 * **[implements] eth_dev_ops**: ``mtu_set``.
156 * **[implements] rte_eth_dev_data**: ``mtu``.
157 * **[provides] rte_eth_dev_info**: ``max_rx_pktlen``.
158 * **[related] API**: ``rte_eth_dev_set_mtu()``, ``rte_eth_dev_get_mtu()``.
161 .. _nic_features_jumbo_frame:
166 Supports Rx jumbo frames.
168 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``dev_conf.rxmode.mtu``.
169 * **[related] rte_eth_dev_info**: ``max_rx_pktlen``.
170 * **[related] API**: ``rte_eth_dev_set_mtu()``.
173 .. _nic_features_scattered_rx:
178 Supports receiving segmented mbufs.
180 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_SCATTER``.
181 * **[implements] datapath**: ``Scattered Rx function``.
182 * **[implements] rte_eth_dev_data**: ``scattered_rx``.
183 * **[provides] eth_dev_ops**: ``rxq_info_get:scattered_rx``.
184 * **[related] eth_dev_ops**: ``rx_pkt_burst``.
187 .. _nic_features_buffer_split:
192 Scatters the packets being received on specified boundaries to segmented mbufs.
194 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:RTE_ETH_RX_OFFLOAD_BUFFER_SPLIT``.
195 * **[uses] rte_eth_rxconf**: ``rx_conf.rx_seg, rx_conf.rx_nseg``.
196 * **[implements] datapath**: ``Buffer Split functionality``.
197 * **[provides] rte_eth_dev_info**: ``rx_offload_capa:RTE_ETH_RX_OFFLOAD_BUFFER_SPLIT``.
198 * **[related] API**: ``rte_eth_rx_queue_setup()``.
201 .. _nic_features_lro:
206 Supports Large Receive Offload.
208 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_TCP_LRO``.
209 ``dev_conf.rxmode.max_lro_pkt_size``.
210 * **[implements] datapath**: ``LRO functionality``.
211 * **[implements] rte_eth_dev_data**: ``lro``.
212 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_LRO``, ``mbuf.tso_segsz``.
213 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_TCP_LRO``.
214 * **[provides] rte_eth_dev_info**: ``max_lro_pkt_size``.
217 .. _nic_features_tso:
222 Supports TCP Segmentation Offloading.
224 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_TCP_TSO``.
225 * **[uses] rte_eth_desc_lim**: ``nb_seg_max``, ``nb_mtu_seg_max``.
226 * **[uses] mbuf**: ``mbuf.ol_flags:`` ``PKT_TX_TCP_SEG``, ``PKT_TX_IPV4``, ``PKT_TX_IPV6``, ``PKT_TX_IP_CKSUM``.
227 * **[uses] mbuf**: ``mbuf.tso_segsz``, ``mbuf.l2_len``, ``mbuf.l3_len``, ``mbuf.l4_len``.
228 * **[implements] datapath**: ``TSO functionality``.
229 * **[provides] rte_eth_dev_info**: ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_TCP_TSO,DEV_TX_OFFLOAD_UDP_TSO``.
232 .. _nic_features_promiscuous_mode:
237 Supports enabling/disabling promiscuous mode for a port.
239 * **[implements] eth_dev_ops**: ``promiscuous_enable``, ``promiscuous_disable``.
240 * **[implements] rte_eth_dev_data**: ``promiscuous``.
241 * **[related] API**: ``rte_eth_promiscuous_enable()``, ``rte_eth_promiscuous_disable()``,
242 ``rte_eth_promiscuous_get()``.
245 .. _nic_features_allmulticast_mode:
250 Supports enabling/disabling receiving multicast frames.
252 * **[implements] eth_dev_ops**: ``allmulticast_enable``, ``allmulticast_disable``.
253 * **[implements] rte_eth_dev_data**: ``all_multicast``.
254 * **[related] API**: ``rte_eth_allmulticast_enable()``,
255 ``rte_eth_allmulticast_disable()``, ``rte_eth_allmulticast_get()``.
258 .. _nic_features_unicast_mac_filter:
263 Supports adding MAC addresses to enable incoming filtering of packets.
265 * **[implements] eth_dev_ops**: ``mac_addr_set``, ``mac_addr_add``, ``mac_addr_remove``.
266 * **[implements] rte_eth_dev_data**: ``mac_addrs``.
267 * **[related] API**: ``rte_eth_dev_default_mac_addr_set()``,
268 ``rte_eth_dev_mac_addr_add()``, ``rte_eth_dev_mac_addr_remove()``,
269 ``rte_eth_macaddr_get()``.
272 .. _nic_features_multicast_mac_filter:
277 Supports setting multicast addresses to filter.
279 * **[implements] eth_dev_ops**: ``set_mc_addr_list``.
280 * **[related] API**: ``rte_eth_dev_set_mc_addr_list()``.
283 .. _nic_features_rss_hash:
288 Supports RSS hashing on RX.
290 * **[uses] user config**: ``dev_conf.rxmode.mq_mode`` = ``ETH_MQ_RX_RSS_FLAG``.
291 * **[uses] user config**: ``dev_conf.rx_adv_conf.rss_conf``.
292 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_RSS_HASH``.
293 * **[provides] rte_eth_dev_info**: ``flow_type_rss_offloads``.
294 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_RSS_HASH``, ``mbuf.rss``.
297 .. _nic_features_inner_rss:
302 Supports RX RSS hashing on Inner headers.
304 * **[uses] rte_flow_action_rss**: ``level``.
305 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_RSS_HASH``.
306 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_RSS_HASH``, ``mbuf.rss``.
309 .. _nic_features_rss_key_update:
314 Supports configuration of Receive Side Scaling (RSS) hash computation. Updating
315 Receive Side Scaling (RSS) hash key.
317 * **[implements] eth_dev_ops**: ``rss_hash_update``, ``rss_hash_conf_get``.
318 * **[provides] rte_eth_dev_info**: ``hash_key_size``.
319 * **[related] API**: ``rte_eth_dev_rss_hash_update()``,
320 ``rte_eth_dev_rss_hash_conf_get()``.
323 .. _nic_features_rss_reta_update:
328 Supports updating Redirection Table of the Receive Side Scaling (RSS).
330 * **[implements] eth_dev_ops**: ``reta_update``, ``reta_query``.
331 * **[provides] rte_eth_dev_info**: ``reta_size``.
332 * **[related] API**: ``rte_eth_dev_rss_reta_update()``, ``rte_eth_dev_rss_reta_query()``.
335 .. _nic_features_vmdq:
340 Supports Virtual Machine Device Queues (VMDq).
342 * **[uses] user config**: ``dev_conf.rxmode.mq_mode`` = ``ETH_MQ_RX_VMDQ_FLAG``.
343 * **[uses] user config**: ``dev_conf.rx_adv_conf.vmdq_dcb_conf``.
344 * **[uses] user config**: ``dev_conf.rx_adv_conf.vmdq_rx_conf``.
345 * **[uses] user config**: ``dev_conf.tx_adv_conf.vmdq_dcb_tx_conf``.
346 * **[uses] user config**: ``dev_conf.tx_adv_conf.vmdq_tx_conf``.
349 .. _nic_features_sriov:
354 Driver supports creating Virtual Functions.
356 * **[implements] rte_eth_dev_data**: ``sriov``.
358 .. _nic_features_dcb:
363 Supports Data Center Bridging (DCB).
365 * **[uses] user config**: ``dev_conf.rxmode.mq_mode`` = ``ETH_MQ_RX_DCB_FLAG``.
366 * **[uses] user config**: ``dev_conf.rx_adv_conf.vmdq_dcb_conf``.
367 * **[uses] user config**: ``dev_conf.rx_adv_conf.dcb_rx_conf``.
368 * **[uses] user config**: ``dev_conf.tx_adv_conf.vmdq_dcb_tx_conf``.
369 * **[uses] user config**: ``dev_conf.tx_adv_conf.vmdq_tx_conf``.
370 * **[implements] eth_dev_ops**: ``get_dcb_info``.
371 * **[related] API**: ``rte_eth_dev_get_dcb_info()``.
374 .. _nic_features_vlan_filter:
379 Supports filtering of a VLAN Tag identifier.
381 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_VLAN_FILTER``.
382 * **[implements] eth_dev_ops**: ``vlan_filter_set``.
383 * **[related] API**: ``rte_eth_dev_vlan_filter()``.
386 .. _nic_features_flow_control:
391 Supports configuring link flow control.
393 * **[implements] eth_dev_ops**: ``flow_ctrl_get``, ``flow_ctrl_set``,
394 ``priority_flow_ctrl_set``.
395 * **[related] API**: ``rte_eth_dev_flow_ctrl_get()``, ``rte_eth_dev_flow_ctrl_set()``,
396 ``rte_eth_dev_priority_flow_ctrl_set()``.
399 .. _nic_features_rate_limitation:
404 Supports Tx rate limitation for a queue.
406 * **[implements] eth_dev_ops**: ``set_queue_rate_limit``.
407 * **[related] API**: ``rte_eth_set_queue_rate_limit()``.
410 .. _nic_features_inline_crypto_doc:
415 Supports inline crypto processing defined by rte_security library to perform crypto
416 operations of security protocol while packet is received in NIC. NIC is not aware
417 of protocol operations. See Security library and PMD documentation for more details.
419 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_SECURITY``,
420 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_SECURITY``.
421 * **[uses] mbuf**: ``mbuf.l2_len``.
422 * **[implements] rte_security_ops**: ``session_create``, ``session_update``,
423 ``session_stats_get``, ``session_destroy``, ``set_pkt_metadata``, ``capabilities_get``.
424 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_SECURITY``,
425 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_SECURITY``.
426 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_SEC_OFFLOAD``,
427 ``mbuf.ol_flags:PKT_TX_SEC_OFFLOAD``, ``mbuf.ol_flags:PKT_RX_SEC_OFFLOAD_FAILED``.
428 * **[provides] rte_security_ops, capabilities_get**: ``action: RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO``
431 .. _nic_features_inline_protocol_doc:
436 Supports inline protocol processing defined by rte_security library to perform
437 protocol processing for the security protocol (e.g. IPsec, MACSEC) while the
438 packet is received at NIC. The NIC is capable of understanding the security
439 protocol operations. See security library and PMD documentation for more details.
441 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_SECURITY``,
442 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_SECURITY``.
443 * **[uses] mbuf**: ``mbuf.l2_len``.
444 * **[implements] rte_security_ops**: ``session_create``, ``session_update``,
445 ``session_stats_get``, ``session_destroy``, ``set_pkt_metadata``, ``get_userdata``,
446 ``capabilities_get``.
447 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_SECURITY``,
448 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_SECURITY``.
449 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_SEC_OFFLOAD``,
450 ``mbuf.ol_flags:PKT_TX_SEC_OFFLOAD``, ``mbuf.ol_flags:PKT_RX_SEC_OFFLOAD_FAILED``.
451 * **[provides] rte_security_ops, capabilities_get**: ``action: RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL``
454 .. _nic_features_crc_offload:
459 Supports CRC stripping by hardware.
460 A PMD assumed to support CRC stripping by default. PMD should advertise if it supports keeping CRC.
462 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_KEEP_CRC``.
465 .. _nic_features_vlan_offload:
470 Supports VLAN offload to hardware.
472 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_VLAN_STRIP,DEV_RX_OFFLOAD_VLAN_FILTER,DEV_RX_OFFLOAD_VLAN_EXTEND``.
473 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_VLAN_INSERT``.
474 * **[uses] mbuf**: ``mbuf.ol_flags:PKT_TX_VLAN``, ``mbuf.vlan_tci``.
475 * **[implements] eth_dev_ops**: ``vlan_offload_set``.
476 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_VLAN_STRIPPED``, ``mbuf.ol_flags:PKT_RX_VLAN`` ``mbuf.vlan_tci``.
477 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_VLAN_STRIP``,
478 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_VLAN_INSERT``.
479 * **[related] API**: ``rte_eth_dev_set_vlan_offload()``,
480 ``rte_eth_dev_get_vlan_offload()``.
483 .. _nic_features_qinq_offload:
488 Supports QinQ (queue in queue) offload.
490 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_QINQ_STRIP``.
491 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_QINQ_INSERT``.
492 * **[uses] mbuf**: ``mbuf.ol_flags:PKT_TX_QINQ``, ``mbuf.vlan_tci_outer``.
493 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_QINQ_STRIPPED``, ``mbuf.ol_flags:PKT_RX_QINQ``,
494 ``mbuf.ol_flags:PKT_RX_VLAN_STRIPPED``, ``mbuf.ol_flags:PKT_RX_VLAN``
495 ``mbuf.vlan_tci``, ``mbuf.vlan_tci_outer``.
496 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_QINQ_STRIP``,
497 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_QINQ_INSERT``.
500 .. _nic_features_fec:
505 Supports Forward error correction. Forward error correction (FEC) is a bit error correction mode.
506 It adds error correction information to data packets at the transmit end, and uses the error correction
507 information to correct the bit errors generated during data packet transmission at the receive end. This
508 improves signal quality but also brings a delay to signals. This function can be enabled or disabled as required.
510 * **[implements] eth_dev_ops**: ``fec_get_capability``, ``fec_get``, ``fec_set``.
511 * **[provides] rte_eth_fec_capa**: ``speed:ETH_SPEED_NUM_*``, ``capa:RTE_ETH_FEC_MODE_TO_CAPA()``.
512 * **[related] API**: ``rte_eth_fec_get_capability()``, ``rte_eth_fec_get()``, ``rte_eth_fec_set()``.
515 .. _nic_features_l3_checksum_offload:
520 Supports L3 checksum offload.
522 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_IPV4_CKSUM``.
523 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_IPV4_CKSUM``.
524 * **[uses] mbuf**: ``mbuf.ol_flags:PKT_TX_IP_CKSUM``,
525 ``mbuf.ol_flags:PKT_TX_IPV4`` | ``PKT_TX_IPV6``.
526 * **[uses] mbuf**: ``mbuf.l2_len``, ``mbuf.l3_len``.
527 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_IP_CKSUM_UNKNOWN`` |
528 ``PKT_RX_IP_CKSUM_BAD`` | ``PKT_RX_IP_CKSUM_GOOD`` |
529 ``PKT_RX_IP_CKSUM_NONE``.
530 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_IPV4_CKSUM``,
531 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_IPV4_CKSUM``.
534 .. _nic_features_l4_checksum_offload:
539 Supports L4 checksum offload.
541 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_UDP_CKSUM,DEV_RX_OFFLOAD_TCP_CKSUM,DEV_RX_OFFLOAD_SCTP_CKSUM``.
542 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_UDP_CKSUM,DEV_TX_OFFLOAD_TCP_CKSUM,DEV_TX_OFFLOAD_SCTP_CKSUM``.
543 * **[uses] mbuf**: ``mbuf.ol_flags:PKT_TX_IPV4`` | ``PKT_TX_IPV6``,
544 ``mbuf.ol_flags:PKT_TX_L4_NO_CKSUM`` | ``PKT_TX_TCP_CKSUM`` |
545 ``PKT_TX_SCTP_CKSUM`` | ``PKT_TX_UDP_CKSUM``.
546 * **[uses] mbuf**: ``mbuf.l2_len``, ``mbuf.l3_len``.
547 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_L4_CKSUM_UNKNOWN`` |
548 ``PKT_RX_L4_CKSUM_BAD`` | ``PKT_RX_L4_CKSUM_GOOD`` |
549 ``PKT_RX_L4_CKSUM_NONE``.
550 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_UDP_CKSUM,DEV_RX_OFFLOAD_TCP_CKSUM,DEV_RX_OFFLOAD_SCTP_CKSUM``,
551 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_UDP_CKSUM,DEV_TX_OFFLOAD_TCP_CKSUM,DEV_TX_OFFLOAD_SCTP_CKSUM``.
553 .. _nic_features_hw_timestamp:
560 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_TIMESTAMP``.
561 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_TIMESTAMP``.
562 * **[provides] mbuf**: ``mbuf.timestamp``.
563 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa: DEV_RX_OFFLOAD_TIMESTAMP``.
564 * **[related] eth_dev_ops**: ``read_clock``.
566 .. _nic_features_macsec_offload:
573 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_MACSEC_STRIP``.
574 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_MACSEC_INSERT``.
575 * **[uses] mbuf**: ``mbuf.ol_flags:PKT_TX_MACSEC``.
576 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_MACSEC_STRIP``,
577 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_MACSEC_INSERT``.
580 .. _nic_features_inner_l3_checksum:
585 Supports inner packet L3 checksum.
587 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM``.
588 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM``.
589 * **[uses] mbuf**: ``mbuf.ol_flags:PKT_TX_IP_CKSUM``,
590 ``mbuf.ol_flags:PKT_TX_IPV4`` | ``PKT_TX_IPV6``,
591 ``mbuf.ol_flags:PKT_TX_OUTER_IP_CKSUM``,
592 ``mbuf.ol_flags:PKT_TX_OUTER_IPV4`` | ``PKT_TX_OUTER_IPV6``.
593 * **[uses] mbuf**: ``mbuf.outer_l2_len``, ``mbuf.outer_l3_len``.
594 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_OUTER_IP_CKSUM_BAD``.
595 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM``,
596 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM``.
599 .. _nic_features_inner_l4_checksum:
604 Supports inner packet L4 checksum.
606 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_OUTER_UDP_CKSUM``.
607 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_OUTER_L4_CKSUM_UNKNOWN`` |
608 ``PKT_RX_OUTER_L4_CKSUM_BAD`` | ``PKT_RX_OUTER_L4_CKSUM_GOOD`` | ``PKT_RX_OUTER_L4_CKSUM_INVALID``.
609 * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_OUTER_UDP_CKSUM``.
610 * **[uses] mbuf**: ``mbuf.ol_flags:PKT_TX_OUTER_IPV4`` | ``PKT_TX_OUTER_IPV6``.
611 ``mbuf.ol_flags:PKT_TX_OUTER_UDP_CKSUM``.
612 * **[uses] mbuf**: ``mbuf.outer_l2_len``, ``mbuf.outer_l3_len``.
613 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_OUTER_UDP_CKSUM``,
614 ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_OUTER_UDP_CKSUM``.
617 .. _nic_features_packet_type_parsing:
622 Supports packet type parsing and returns a list of supported types.
623 Allows application to set ptypes it is interested in.
625 * **[implements] eth_dev_ops**: ``dev_supported_ptypes_get``,
626 * **[related] API**: ``rte_eth_dev_get_supported_ptypes()``,
627 ``rte_eth_dev_set_ptypes()``, ``dev_ptypes_set``.
628 * **[provides] mbuf**: ``mbuf.packet_type``.
631 .. _nic_features_timesync:
636 Supports IEEE1588/802.1AS timestamping.
638 * **[implements] eth_dev_ops**: ``timesync_enable``, ``timesync_disable``
639 ``timesync_read_rx_timestamp``, ``timesync_read_tx_timestamp``,
640 ``timesync_adjust_time``, ``timesync_read_time``, ``timesync_write_time``.
641 * **[related] API**: ``rte_eth_timesync_enable()``, ``rte_eth_timesync_disable()``,
642 ``rte_eth_timesync_read_rx_timestamp()``,
643 ``rte_eth_timesync_read_tx_timestamp``, ``rte_eth_timesync_adjust_time()``,
644 ``rte_eth_timesync_read_time()``, ``rte_eth_timesync_write_time()``.
647 .. _nic_features_rx_descriptor_status:
652 Supports check the status of a Rx descriptor. When ``rx_descriptor_status`` is
653 used, status can be "Available", "Done" or "Unavailable".
655 * **[implements] rte_eth_dev**: ``rx_descriptor_status``.
656 * **[related] API**: ``rte_eth_rx_descriptor_status()``.
659 .. _nic_features_tx_descriptor_status:
664 Supports checking the status of a Tx descriptor. Status can be "Full", "Done"
667 * **[implements] rte_eth_dev**: ``tx_descriptor_status``.
668 * **[related] API**: ``rte_eth_tx_descriptor_status()``.
671 .. _nic_features_basic_stats:
676 Support basic statistics such as: ipackets, opackets, ibytes, obytes,
677 imissed, ierrors, oerrors, rx_nombuf.
679 And per queue stats: q_ipackets, q_opackets, q_ibytes, q_obytes, q_errors.
681 These apply to all drivers.
683 * **[implements] eth_dev_ops**: ``stats_get``, ``stats_reset``.
684 * **[related] API**: ``rte_eth_stats_get``, ``rte_eth_stats_reset()``.
687 .. _nic_features_extended_stats:
692 Supports Extended Statistics, changes from driver to driver.
694 * **[implements] eth_dev_ops**: ``xstats_get``, ``xstats_reset``, ``xstats_get_names``.
695 * **[implements] eth_dev_ops**: ``xstats_get_by_id``, ``xstats_get_names_by_id``.
696 * **[related] API**: ``rte_eth_xstats_get()``, ``rte_eth_xstats_reset()``,
697 ``rte_eth_xstats_get_names``, ``rte_eth_xstats_get_by_id()``,
698 ``rte_eth_xstats_get_names_by_id()``, ``rte_eth_xstats_get_id_by_name()``.
701 .. _nic_features_stats_per_queue:
706 Supports configuring per-queue stat counter mapping.
708 * **[implements] eth_dev_ops**: ``queue_stats_mapping_set``.
709 * **[related] API**: ``rte_eth_dev_set_rx_queue_stats_mapping()``,
710 ``rte_eth_dev_set_tx_queue_stats_mapping()``.
713 .. _nic_features_fw_version:
718 Supports getting device hardware firmware information.
720 * **[implements] eth_dev_ops**: ``fw_version_get``.
721 * **[related] API**: ``rte_eth_dev_fw_version_get()``.
724 .. _nic_features_eeprom_dump:
729 Supports getting/setting device eeprom data.
731 * **[implements] eth_dev_ops**: ``get_eeprom_length``, ``get_eeprom``, ``set_eeprom``.
732 * **[related] API**: ``rte_eth_dev_get_eeprom_length()``, ``rte_eth_dev_get_eeprom()``,
733 ``rte_eth_dev_set_eeprom()``.
736 .. _nic_features_module_eeprom_dump:
741 Supports getting information and data of plugin module eeprom.
743 * **[implements] eth_dev_ops**: ``get_module_info``, ``get_module_eeprom``.
744 * **[related] API**: ``rte_eth_dev_get_module_info()``, ``rte_eth_dev_get_module_eeprom()``.
747 .. _nic_features_register_dump:
752 Supports retrieving device registers and registering attributes (number of
753 registers and register size).
755 * **[implements] eth_dev_ops**: ``get_reg``.
756 * **[related] API**: ``rte_eth_dev_get_reg_info()``.
759 .. _nic_features_led:
764 Supports turning on/off a software controllable LED on a device.
766 * **[implements] eth_dev_ops**: ``dev_led_on``, ``dev_led_off``.
767 * **[related] API**: ``rte_eth_led_on()``, ``rte_eth_led_off()``.
770 .. _nic_features_multiprocess_aware:
775 Driver can be used for primary-secondary process model.
778 .. _nic_features_freebsd:
783 Supports running on FreeBSD.
786 .. _nic_features_linux:
791 Supports running on Linux.
794 .. _nic_features_windows:
799 Supports running on Windows.
802 .. _nic_features_armv7:
807 Support armv7 architecture.
810 .. _nic_features_armv8:
815 Support armv8a (64bit) architecture.
818 .. _nic_features_power8:
823 Support PowerPC architecture.
826 .. _nic_features_x86-32:
831 Support 32bits x86 architecture.
834 .. _nic_features_x86-64:
839 Support 64bits x86 architecture.
842 .. _nic_features_usage_doc:
847 Documentation describes usage.
849 See ``doc/guides/nics/*.rst``
852 .. _nic_features_design_doc:
857 Documentation describes design.
859 See ``doc/guides/nics/*.rst``.
862 .. _nic_features_perf_doc:
867 Documentation describes performance values.
869 See ``dpdk.org/doc/perf/*``.
871 .. _nic_features_runtime_rx_queue_setup:
873 Runtime Rx queue setup
874 ----------------------
876 Supports Rx queue setup after device started.
878 * **[provides] rte_eth_dev_info**: ``dev_capa:RTE_ETH_DEV_CAPA_RUNTIME_RX_QUEUE_SETUP``.
879 * **[related] API**: ``rte_eth_dev_info_get()``.
881 .. _nic_features_runtime_tx_queue_setup:
883 Runtime Tx queue setup
884 ----------------------
886 Supports Tx queue setup after device started.
888 * **[provides] rte_eth_dev_info**: ``dev_capa:RTE_ETH_DEV_CAPA_RUNTIME_TX_QUEUE_SETUP``.
889 * **[related] API**: ``rte_eth_dev_info_get()``.
891 .. _nic_features_burst_mode_info:
896 Supports to get Rx/Tx packet burst mode information.
898 * **[implements] eth_dev_ops**: ``rx_burst_mode_get``, ``tx_burst_mode_get``.
899 * **[related] API**: ``rte_eth_rx_burst_mode_get()``, ``rte_eth_tx_burst_mode_get()``.
901 .. _nic_features_get_monitor_addr:
903 PMD power management using monitor addresses
904 --------------------------------------------
906 Supports getting a monitoring condition to use together with Ethernet PMD power
907 management (see :doc:`../prog_guide/power_man` for more details).
909 * **[implements] eth_dev_ops**: ``get_monitor_addr``
911 .. _nic_features_other:
913 Other dev ops not represented by a Feature
914 ------------------------------------------
919 * ``vlan_strip_queue_set``
922 * ``uc_hash_table_set``
923 * ``uc_all_hash_table_set``
924 * ``udp_tunnel_port_add``
925 * ``udp_tunnel_port_del``