doc/guides/nics/features.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2017 Intel Corporation.
   3
   4 Features Overview
   5 =================
   6
   7 This section explains the supported features that are listed in the
   8 :doc:`overview`.
   9
  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.
  12
  13 Following tags used for feature details, these are from driver point of view:
  14
  15 ``[uses]``       : Driver uses some kind of input from the application.
  16
  17 ``[implements]`` : Driver implements a functionality.
  18
  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.
  22
  23 ``[related]``    : Related API with that feature.
  24
  25
  26 .. _nic_features_speed_capabilities:
  27
  28 Speed capabilities
  29 ------------------
  30
  31 Supports getting the speed capabilities that the current device is capable of.
  32
  33 * **[provides] rte_eth_dev_info**: ``speed_capa:ETH_LINK_SPEED_*``.
  34 * **[related]  API**: ``rte_eth_dev_info_get()``.
  35
  36
  37 .. _nic_features_link_status:
  38
  39 Link status
  40 -----------
  41
  42 Supports getting the link speed, duplex mode and link state (up/down).
  43
  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()``.
  47
  48
  49 .. _nic_features_link_status_event:
  50
  51 Link status event
  52 -----------------
  53
  54 Supports Link Status Change interrupts.
  55
  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()``.
  62
  63
  64 .. _nic_features_removal_event:
  65
  66 Removal event
  67 -------------
  68
  69 Supports device removal interrupts.
  70
  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``.
  75
  76
  77 .. _nic_features_queue_status_event:
  78
  79 Queue status event
  80 ------------------
  81
  82 Supports queue enable/disable events.
  83
  84 * **[uses] rte_eth_event_type**: ``RTE_ETH_EVENT_QUEUE_STATE``.
  85
  86
  87 .. _nic_features_rx_interrupt:
  88
  89 Rx interrupt
  90 ------------
  91
  92 Supports Rx interrupts.
  93
  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()``.
  97
  98
  99 .. _nic_features_lock-free_tx_queue:
 100
 101 Lock-free Tx queue
 102 ------------------
 103
 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.
 106
 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()``.
 110
 111
 112 .. _nic_features_fast_mbuf_free:
 113
 114 Fast mbuf free
 115 --------------
 116
 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.
 119
 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``.
 122
 123
 124 .. _nic_features_free_tx_mbuf_on_demand:
 125
 126 Free Tx mbuf on demand
 127 ----------------------
 128
 129 Supports freeing consumed buffers on a Tx ring.
 130
 131 * **[implements] eth_dev_ops**: ``tx_done_cleanup``.
 132 * **[related]    API**: ``rte_eth_tx_done_cleanup()``.
 133
 134
 135 .. _nic_features_queue_start_stop:
 136
 137 Queue start/stop
 138 ----------------
 139
 140 Supports starting/stopping a specific Rx/Tx queue of a port.
 141
 142 * **[implements] eth_dev_ops**: ``rx_queue_start``, ``rx_queue_stop``, ``tx_queue_start``,
 143   ``tx_queue_stop``.
 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()``.
 146
 147
 148 .. _nic_features_mtu_update:
 149
 150 MTU update
 151 ----------
 152
 153 Supports updating port MTU.
 154
 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()``.
 159
 160
 161 .. _nic_features_scattered_rx:
 162
 163 Scattered Rx
 164 ------------
 165
 166 Supports receiving segmented mbufs.
 167
 168 * **[uses]       rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_SCATTER``.
 169 * **[implements] datapath**: ``Scattered Rx function``.
 170 * **[implements] rte_eth_dev_data**: ``scattered_rx``.
 171 * **[provides]   eth_dev_ops**: ``rxq_info_get:scattered_rx``.
 172 * **[related]    eth_dev_ops**: ``rx_pkt_burst``.
 173
 174
 175 .. _nic_features_buffer_split:
 176
 177 Buffer Split on Rx
 178 ------------------
 179
 180 Scatters the packets being received on specified boundaries to segmented mbufs.
 181
 182 * **[uses]       rte_eth_rxconf,rte_eth_rxmode**: ``offloads:RTE_ETH_RX_OFFLOAD_BUFFER_SPLIT``.
 183 * **[uses]       rte_eth_rxconf**: ``rx_conf.rx_seg, rx_conf.rx_nseg``.
 184 * **[implements] datapath**: ``Buffer Split functionality``.
 185 * **[provides]   rte_eth_dev_info**: ``rx_offload_capa:RTE_ETH_RX_OFFLOAD_BUFFER_SPLIT``.
 186 * **[related] API**: ``rte_eth_rx_queue_setup()``.
 187
 188
 189 .. _nic_features_lro:
 190
 191 LRO
 192 ---
 193
 194 Supports Large Receive Offload.
 195
 196 * **[uses]       rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_TCP_LRO``.
 197   ``dev_conf.rxmode.max_lro_pkt_size``.
 198 * **[implements] datapath**: ``LRO functionality``.
 199 * **[implements] rte_eth_dev_data**: ``lro``.
 200 * **[provides]   mbuf**: ``mbuf.ol_flags:PKT_RX_LRO``, ``mbuf.tso_segsz``.
 201 * **[provides]   rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_TCP_LRO``.
 202 * **[provides]   rte_eth_dev_info**: ``max_lro_pkt_size``.
 203
 204
 205 .. _nic_features_tso:
 206
 207 TSO
 208 ---
 209
 210 Supports TCP Segmentation Offloading.
 211
 212 * **[uses]       rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_TCP_TSO``.
 213 * **[uses]       rte_eth_desc_lim**: ``nb_seg_max``, ``nb_mtu_seg_max``.
 214 * **[uses]       mbuf**: ``mbuf.ol_flags:`` ``PKT_TX_TCP_SEG``, ``PKT_TX_IPV4``, ``PKT_TX_IPV6``, ``PKT_TX_IP_CKSUM``.
 215 * **[uses]       mbuf**: ``mbuf.tso_segsz``, ``mbuf.l2_len``, ``mbuf.l3_len``, ``mbuf.l4_len``.
 216 * **[implements] datapath**: ``TSO functionality``.
 217 * **[provides]   rte_eth_dev_info**: ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_TCP_TSO,DEV_TX_OFFLOAD_UDP_TSO``.
 218
 219
 220 .. _nic_features_promiscuous_mode:
 221
 222 Promiscuous mode
 223 ----------------
 224
 225 Supports enabling/disabling promiscuous mode for a port.
 226
 227 * **[implements] eth_dev_ops**: ``promiscuous_enable``, ``promiscuous_disable``.
 228 * **[implements] rte_eth_dev_data**: ``promiscuous``.
 229 * **[related]    API**: ``rte_eth_promiscuous_enable()``, ``rte_eth_promiscuous_disable()``,
 230   ``rte_eth_promiscuous_get()``.
 231
 232
 233 .. _nic_features_allmulticast_mode:
 234
 235 Allmulticast mode
 236 -----------------
 237
 238 Supports enabling/disabling receiving multicast frames.
 239
 240 * **[implements] eth_dev_ops**: ``allmulticast_enable``, ``allmulticast_disable``.
 241 * **[implements] rte_eth_dev_data**: ``all_multicast``.
 242 * **[related]    API**: ``rte_eth_allmulticast_enable()``,
 243   ``rte_eth_allmulticast_disable()``, ``rte_eth_allmulticast_get()``.
 244
 245
 246 .. _nic_features_unicast_mac_filter:
 247
 248 Unicast MAC filter
 249 ------------------
 250
 251 Supports adding MAC addresses to enable incoming filtering of packets.
 252
 253 * **[implements] eth_dev_ops**: ``mac_addr_set``, ``mac_addr_add``, ``mac_addr_remove``.
 254 * **[implements] rte_eth_dev_data**: ``mac_addrs``.
 255 * **[related]    API**: ``rte_eth_dev_default_mac_addr_set()``,
 256   ``rte_eth_dev_mac_addr_add()``, ``rte_eth_dev_mac_addr_remove()``,
 257   ``rte_eth_macaddr_get()``.
 258
 259
 260 .. _nic_features_multicast_mac_filter:
 261
 262 Multicast MAC filter
 263 --------------------
 264
 265 Supports setting multicast addresses to filter.
 266
 267 * **[implements] eth_dev_ops**: ``set_mc_addr_list``.
 268 * **[related]    API**: ``rte_eth_dev_set_mc_addr_list()``.
 269
 270
 271 .. _nic_features_rss_hash:
 272
 273 RSS hash
 274 --------
 275
 276 Supports RSS hashing on RX.
 277
 278 * **[uses]     user config**: ``dev_conf.rxmode.mq_mode`` = ``ETH_MQ_RX_RSS_FLAG``.
 279 * **[uses]     user config**: ``dev_conf.rx_adv_conf.rss_conf``.
 280 * **[uses]     rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_RSS_HASH``.
 281 * **[provides] rte_eth_dev_info**: ``flow_type_rss_offloads``.
 282 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_RSS_HASH``, ``mbuf.rss``.
 283
 284
 285 .. _nic_features_inner_rss:
 286
 287 Inner RSS
 288 ---------
 289
 290 Supports RX RSS hashing on Inner headers.
 291
 292 * **[uses]    rte_flow_action_rss**: ``level``.
 293 * **[uses]    rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_RSS_HASH``.
 294 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_RSS_HASH``, ``mbuf.rss``.
 295
 296
 297 .. _nic_features_rss_key_update:
 298
 299 RSS key update
 300 --------------
 301
 302 Supports configuration of Receive Side Scaling (RSS) hash computation. Updating
 303 Receive Side Scaling (RSS) hash key.
 304
 305 * **[implements] eth_dev_ops**: ``rss_hash_update``, ``rss_hash_conf_get``.
 306 * **[provides]   rte_eth_dev_info**: ``hash_key_size``.
 307 * **[related]    API**: ``rte_eth_dev_rss_hash_update()``,
 308   ``rte_eth_dev_rss_hash_conf_get()``.
 309
 310
 311 .. _nic_features_rss_reta_update:
 312
 313 RSS reta update
 314 ---------------
 315
 316 Supports updating Redirection Table of the Receive Side Scaling (RSS).
 317
 318 * **[implements] eth_dev_ops**: ``reta_update``, ``reta_query``.
 319 * **[provides]   rte_eth_dev_info**: ``reta_size``.
 320 * **[related]    API**: ``rte_eth_dev_rss_reta_update()``, ``rte_eth_dev_rss_reta_query()``.
 321
 322
 323 .. _nic_features_vmdq:
 324
 325 VMDq
 326 ----
 327
 328 Supports Virtual Machine Device Queues (VMDq).
 329
 330 * **[uses] user config**: ``dev_conf.rxmode.mq_mode`` = ``ETH_MQ_RX_VMDQ_FLAG``.
 331 * **[uses] user config**: ``dev_conf.rx_adv_conf.vmdq_dcb_conf``.
 332 * **[uses] user config**: ``dev_conf.rx_adv_conf.vmdq_rx_conf``.
 333 * **[uses] user config**: ``dev_conf.tx_adv_conf.vmdq_dcb_tx_conf``.
 334 * **[uses] user config**: ``dev_conf.tx_adv_conf.vmdq_tx_conf``.
 335
 336
 337 .. _nic_features_sriov:
 338
 339 SR-IOV
 340 ------
 341
 342 Driver supports creating Virtual Functions.
 343
 344 * **[implements] rte_eth_dev_data**: ``sriov``.
 345
 346 .. _nic_features_dcb:
 347
 348 DCB
 349 ---
 350
 351 Supports Data Center Bridging (DCB).
 352
 353 * **[uses]       user config**: ``dev_conf.rxmode.mq_mode`` = ``ETH_MQ_RX_DCB_FLAG``.
 354 * **[uses]       user config**: ``dev_conf.rx_adv_conf.vmdq_dcb_conf``.
 355 * **[uses]       user config**: ``dev_conf.rx_adv_conf.dcb_rx_conf``.
 356 * **[uses]       user config**: ``dev_conf.tx_adv_conf.vmdq_dcb_tx_conf``.
 357 * **[uses]       user config**: ``dev_conf.tx_adv_conf.vmdq_tx_conf``.
 358 * **[implements] eth_dev_ops**: ``get_dcb_info``.
 359 * **[related]    API**: ``rte_eth_dev_get_dcb_info()``.
 360
 361
 362 .. _nic_features_vlan_filter:
 363
 364 VLAN filter
 365 -----------
 366
 367 Supports filtering of a VLAN Tag identifier.
 368
 369 * **[uses]       rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_VLAN_FILTER``.
 370 * **[implements] eth_dev_ops**: ``vlan_filter_set``.
 371 * **[related]    API**: ``rte_eth_dev_vlan_filter()``.
 372
 373
 374 .. _nic_features_flow_control:
 375
 376 Flow control
 377 ------------
 378
 379 Supports configuring link flow control.
 380
 381 * **[implements] eth_dev_ops**: ``flow_ctrl_get``, ``flow_ctrl_set``,
 382   ``priority_flow_ctrl_set``.
 383 * **[related]    API**: ``rte_eth_dev_flow_ctrl_get()``, ``rte_eth_dev_flow_ctrl_set()``,
 384   ``rte_eth_dev_priority_flow_ctrl_set()``.
 385
 386
 387 .. _nic_features_rate_limitation:
 388
 389 Rate limitation
 390 ---------------
 391
 392 Supports Tx rate limitation for a queue.
 393
 394 * **[implements] eth_dev_ops**: ``set_queue_rate_limit``.
 395 * **[related]    API**: ``rte_eth_set_queue_rate_limit()``.
 396
 397
 398 .. _nic_features_inline_crypto_doc:
 399
 400 Inline crypto
 401 -------------
 402
 403 Supports inline crypto processing defined by rte_security library to perform crypto
 404 operations of security protocol while packet is received in NIC. NIC is not aware
 405 of protocol operations. See Security library and PMD documentation for more details.
 406
 407 * **[uses]       rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_SECURITY``,
 408 * **[uses]       rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_SECURITY``.
 409 * **[uses]       mbuf**: ``mbuf.l2_len``.
 410 * **[implements] rte_security_ops**: ``session_create``, ``session_update``,
 411   ``session_stats_get``, ``session_destroy``, ``set_pkt_metadata``, ``capabilities_get``.
 412 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_SECURITY``,
 413   ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_SECURITY``.
 414 * **[provides]   mbuf**: ``mbuf.ol_flags:PKT_RX_SEC_OFFLOAD``,
 415   ``mbuf.ol_flags:PKT_TX_SEC_OFFLOAD``, ``mbuf.ol_flags:PKT_RX_SEC_OFFLOAD_FAILED``.
 416 * **[provides]   rte_security_ops, capabilities_get**:  ``action: RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO``
 417
 418
 419 .. _nic_features_inline_protocol_doc:
 420
 421 Inline protocol
 422 ---------------
 423
 424 Supports inline protocol processing defined by rte_security library to perform
 425 protocol processing for the security protocol (e.g. IPsec, MACSEC) while the
 426 packet is received at NIC. The NIC is capable of understanding the security
 427 protocol operations. See security library and PMD documentation for more details.
 428
 429 * **[uses]       rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_SECURITY``,
 430 * **[uses]       rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_SECURITY``.
 431 * **[uses]       mbuf**: ``mbuf.l2_len``.
 432 * **[implements] rte_security_ops**: ``session_create``, ``session_update``,
 433   ``session_stats_get``, ``session_destroy``, ``set_pkt_metadata``, ``get_userdata``,
 434   ``capabilities_get``.
 435 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_SECURITY``,
 436   ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_SECURITY``.
 437 * **[provides]   mbuf**: ``mbuf.ol_flags:PKT_RX_SEC_OFFLOAD``,
 438   ``mbuf.ol_flags:PKT_TX_SEC_OFFLOAD``, ``mbuf.ol_flags:PKT_RX_SEC_OFFLOAD_FAILED``.
 439 * **[provides]   rte_security_ops, capabilities_get**:  ``action: RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL``
 440
 441
 442 .. _nic_features_crc_offload:
 443
 444 CRC offload
 445 -----------
 446
 447 Supports CRC stripping by hardware.
 448 A PMD assumed to support CRC stripping by default. PMD should advertise if it supports keeping CRC.
 449
 450 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_KEEP_CRC``.
 451
 452
 453 .. _nic_features_vlan_offload:
 454
 455 VLAN offload
 456 ------------
 457
 458 Supports VLAN offload to hardware.
 459
 460 * **[uses]       rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_VLAN_STRIP,DEV_RX_OFFLOAD_VLAN_FILTER,DEV_RX_OFFLOAD_VLAN_EXTEND``.
 461 * **[uses]       rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_VLAN_INSERT``.
 462 * **[uses]       mbuf**: ``mbuf.ol_flags:PKT_TX_VLAN``, ``mbuf.vlan_tci``.
 463 * **[implements] eth_dev_ops**: ``vlan_offload_set``.
 464 * **[provides]   mbuf**: ``mbuf.ol_flags:PKT_RX_VLAN_STRIPPED``, ``mbuf.ol_flags:PKT_RX_VLAN`` ``mbuf.vlan_tci``.
 465 * **[provides]   rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_VLAN_STRIP``,
 466   ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_VLAN_INSERT``.
 467 * **[related]    API**: ``rte_eth_dev_set_vlan_offload()``,
 468   ``rte_eth_dev_get_vlan_offload()``.
 469
 470
 471 .. _nic_features_qinq_offload:
 472
 473 QinQ offload
 474 ------------
 475
 476 Supports QinQ (queue in queue) offload.
 477
 478 * **[uses]     rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_QINQ_STRIP``.
 479 * **[uses]     rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_QINQ_INSERT``.
 480 * **[uses]     mbuf**: ``mbuf.ol_flags:PKT_TX_QINQ``, ``mbuf.vlan_tci_outer``.
 481 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_QINQ_STRIPPED``, ``mbuf.ol_flags:PKT_RX_QINQ``,
 482   ``mbuf.ol_flags:PKT_RX_VLAN_STRIPPED``, ``mbuf.ol_flags:PKT_RX_VLAN``
 483   ``mbuf.vlan_tci``, ``mbuf.vlan_tci_outer``.
 484 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_QINQ_STRIP``,
 485   ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_QINQ_INSERT``.
 486
 487
 488 .. _nic_features_fec:
 489
 490 FEC
 491 ---
 492
 493 Supports Forward error correction. Forward error correction (FEC) is a bit error correction mode.
 494 It adds error correction information to data packets at the transmit end, and uses the error correction
 495 information to correct the bit errors generated during data packet transmission at the receive end. This
 496 improves signal quality but also brings a delay to signals. This function can be enabled or disabled as required.
 497
 498 * **[implements] eth_dev_ops**: ``fec_get_capability``, ``fec_get``, ``fec_set``.
 499 * **[provides]   rte_eth_fec_capa**: ``speed:ETH_SPEED_NUM_*``, ``capa:RTE_ETH_FEC_MODE_TO_CAPA()``.
 500 * **[related]    API**: ``rte_eth_fec_get_capability()``, ``rte_eth_fec_get()``, ``rte_eth_fec_set()``.
 501
 502
 503 .. _nic_features_l3_checksum_offload:
 504
 505 L3 checksum offload
 506 -------------------
 507
 508 Supports L3 checksum offload.
 509
 510 * **[uses]     rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_IPV4_CKSUM``.
 511 * **[uses]     rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_IPV4_CKSUM``.
 512 * **[uses]     mbuf**: ``mbuf.ol_flags:PKT_TX_IP_CKSUM``,
 513   ``mbuf.ol_flags:PKT_TX_IPV4`` | ``PKT_TX_IPV6``.
 514 * **[uses]     mbuf**: ``mbuf.l2_len``, ``mbuf.l3_len``.
 515 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_IP_CKSUM_UNKNOWN`` |
 516   ``PKT_RX_IP_CKSUM_BAD`` | ``PKT_RX_IP_CKSUM_GOOD`` |
 517   ``PKT_RX_IP_CKSUM_NONE``.
 518 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_IPV4_CKSUM``,
 519   ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_IPV4_CKSUM``.
 520
 521
 522 .. _nic_features_l4_checksum_offload:
 523
 524 L4 checksum offload
 525 -------------------
 526
 527 Supports L4 checksum offload.
 528
 529 * **[uses]     rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_UDP_CKSUM,DEV_RX_OFFLOAD_TCP_CKSUM,DEV_RX_OFFLOAD_SCTP_CKSUM``.
 530 * **[uses]     rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_UDP_CKSUM,DEV_TX_OFFLOAD_TCP_CKSUM,DEV_TX_OFFLOAD_SCTP_CKSUM``.
 531 * **[uses]     mbuf**: ``mbuf.ol_flags:PKT_TX_IPV4`` | ``PKT_TX_IPV6``,
 532   ``mbuf.ol_flags:PKT_TX_L4_NO_CKSUM`` | ``PKT_TX_TCP_CKSUM`` |
 533   ``PKT_TX_SCTP_CKSUM`` | ``PKT_TX_UDP_CKSUM``.
 534 * **[uses]     mbuf**: ``mbuf.l2_len``, ``mbuf.l3_len``.
 535 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_L4_CKSUM_UNKNOWN`` |
 536   ``PKT_RX_L4_CKSUM_BAD`` | ``PKT_RX_L4_CKSUM_GOOD`` |
 537   ``PKT_RX_L4_CKSUM_NONE``.
 538 * **[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``,
 539   ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_UDP_CKSUM,DEV_TX_OFFLOAD_TCP_CKSUM,DEV_TX_OFFLOAD_SCTP_CKSUM``.
 540
 541 .. _nic_features_hw_timestamp:
 542
 543 Timestamp offload
 544 -----------------
 545
 546 Supports Timestamp.
 547
 548 * **[uses]     rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_TIMESTAMP``.
 549 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_TIMESTAMP``.
 550 * **[provides] mbuf**: ``mbuf.timestamp``.
 551 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa: DEV_RX_OFFLOAD_TIMESTAMP``.
 552 * **[related] eth_dev_ops**: ``read_clock``.
 553
 554 .. _nic_features_macsec_offload:
 555
 556 MACsec offload
 557 --------------
 558
 559 Supports MACsec.
 560
 561 * **[uses]     rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_MACSEC_STRIP``.
 562 * **[uses]     rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_MACSEC_INSERT``.
 563 * **[uses]     mbuf**: ``mbuf.ol_flags:PKT_TX_MACSEC``.
 564 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_MACSEC_STRIP``,
 565   ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_MACSEC_INSERT``.
 566
 567
 568 .. _nic_features_inner_l3_checksum:
 569
 570 Inner L3 checksum
 571 -----------------
 572
 573 Supports inner packet L3 checksum.
 574
 575 * **[uses]     rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM``.
 576 * **[uses]     rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM``.
 577 * **[uses]     mbuf**: ``mbuf.ol_flags:PKT_TX_IP_CKSUM``,
 578   ``mbuf.ol_flags:PKT_TX_IPV4`` | ``PKT_TX_IPV6``,
 579   ``mbuf.ol_flags:PKT_TX_OUTER_IP_CKSUM``,
 580   ``mbuf.ol_flags:PKT_TX_OUTER_IPV4`` | ``PKT_TX_OUTER_IPV6``.
 581 * **[uses]     mbuf**: ``mbuf.outer_l2_len``, ``mbuf.outer_l3_len``.
 582 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_OUTER_IP_CKSUM_BAD``.
 583 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM``,
 584   ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM``.
 585
 586
 587 .. _nic_features_inner_l4_checksum:
 588
 589 Inner L4 checksum
 590 -----------------
 591
 592 Supports inner packet L4 checksum.
 593
 594 * **[uses]     rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_OUTER_UDP_CKSUM``.
 595 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_OUTER_L4_CKSUM_UNKNOWN`` |
 596   ``PKT_RX_OUTER_L4_CKSUM_BAD`` | ``PKT_RX_OUTER_L4_CKSUM_GOOD`` | ``PKT_RX_OUTER_L4_CKSUM_INVALID``.
 597 * **[uses]     rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_OUTER_UDP_CKSUM``.
 598 * **[uses]     mbuf**: ``mbuf.ol_flags:PKT_TX_OUTER_IPV4`` | ``PKT_TX_OUTER_IPV6``.
 599   ``mbuf.ol_flags:PKT_TX_OUTER_UDP_CKSUM``.
 600 * **[uses]     mbuf**: ``mbuf.outer_l2_len``, ``mbuf.outer_l3_len``.
 601 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_OUTER_UDP_CKSUM``,
 602   ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_OUTER_UDP_CKSUM``.
 603
 604
 605 .. _nic_features_shared_rx_queue:
 606
 607 Shared Rx queue
 608 ---------------
 609
 610 Supports shared Rx queue for ports in same Rx domain of a switch domain.
 611
 612 * **[uses]     rte_eth_dev_info**: ``dev_capa:RTE_ETH_DEV_CAPA_RXQ_SHARE``.
 613 * **[uses]     rte_eth_dev_info，rte_eth_switch_info**: ``rx_domain``, ``domain_id``.
 614 * **[uses]     rte_eth_rxconf**: ``share_group``, ``share_qid``.
 615 * **[provides] mbuf**: ``mbuf.port``.
 616
 617
 618 .. _nic_features_packet_type_parsing:
 619
 620 Packet type parsing
 621 -------------------
 622
 623 Supports packet type parsing and returns a list of supported types.
 624 Allows application to set ptypes it is interested in.
 625
 626 * **[implements] eth_dev_ops**: ``dev_supported_ptypes_get``,
 627 * **[related]    API**: ``rte_eth_dev_get_supported_ptypes()``,
 628   ``rte_eth_dev_set_ptypes()``, ``dev_ptypes_set``.
 629 * **[provides]   mbuf**: ``mbuf.packet_type``.
 630
 631
 632 .. _nic_features_timesync:
 633
 634 Timesync
 635 --------
 636
 637 Supports IEEE1588/802.1AS timestamping.
 638
 639 * **[implements] eth_dev_ops**: ``timesync_enable``, ``timesync_disable``
 640   ``timesync_read_rx_timestamp``, ``timesync_read_tx_timestamp``,
 641   ``timesync_adjust_time``, ``timesync_read_time``, ``timesync_write_time``.
 642 * **[related]    API**: ``rte_eth_timesync_enable()``, ``rte_eth_timesync_disable()``,
 643   ``rte_eth_timesync_read_rx_timestamp()``,
 644   ``rte_eth_timesync_read_tx_timestamp``, ``rte_eth_timesync_adjust_time()``,
 645   ``rte_eth_timesync_read_time()``, ``rte_eth_timesync_write_time()``.
 646
 647
 648 .. _nic_features_rx_descriptor_status:
 649
 650 Rx descriptor status
 651 --------------------
 652
 653 Supports check the status of a Rx descriptor. When ``rx_descriptor_status`` is
 654 used, status can be "Available", "Done" or "Unavailable".
 655
 656 * **[implements] rte_eth_dev**: ``rx_descriptor_status``.
 657 * **[related]    API**: ``rte_eth_rx_descriptor_status()``.
 658
 659
 660 .. _nic_features_tx_descriptor_status:
 661
 662 Tx descriptor status
 663 --------------------
 664
 665 Supports checking the status of a Tx descriptor. Status can be "Full", "Done"
 666 or "Unavailable."
 667
 668 * **[implements] rte_eth_dev**: ``tx_descriptor_status``.
 669 * **[related]    API**: ``rte_eth_tx_descriptor_status()``.
 670
 671
 672 .. _nic_features_basic_stats:
 673
 674 Basic stats
 675 -----------
 676
 677 Support basic statistics such as: ipackets, opackets, ibytes, obytes,
 678 imissed, ierrors, oerrors, rx_nombuf.
 679
 680 And per queue stats: q_ipackets, q_opackets, q_ibytes, q_obytes, q_errors.
 681
 682 These apply to all drivers.
 683
 684 * **[implements] eth_dev_ops**: ``stats_get``, ``stats_reset``.
 685 * **[related]    API**: ``rte_eth_stats_get``, ``rte_eth_stats_reset()``.
 686
 687
 688 .. _nic_features_extended_stats:
 689
 690 Extended stats
 691 --------------
 692
 693 Supports Extended Statistics, changes from driver to driver.
 694
 695 * **[implements] eth_dev_ops**: ``xstats_get``, ``xstats_reset``, ``xstats_get_names``.
 696 * **[implements] eth_dev_ops**: ``xstats_get_by_id``, ``xstats_get_names_by_id``.
 697 * **[related]    API**: ``rte_eth_xstats_get()``, ``rte_eth_xstats_reset()``,
 698   ``rte_eth_xstats_get_names``, ``rte_eth_xstats_get_by_id()``,
 699   ``rte_eth_xstats_get_names_by_id()``, ``rte_eth_xstats_get_id_by_name()``.
 700
 701
 702 .. _nic_features_stats_per_queue:
 703
 704 Stats per queue
 705 ---------------
 706
 707 Supports configuring per-queue stat counter mapping.
 708
 709 * **[implements] eth_dev_ops**: ``queue_stats_mapping_set``.
 710 * **[related]    API**: ``rte_eth_dev_set_rx_queue_stats_mapping()``,
 711   ``rte_eth_dev_set_tx_queue_stats_mapping()``.
 712
 713
 714 .. _nic_features_fw_version:
 715
 716 FW version
 717 ----------
 718
 719 Supports getting device hardware firmware information.
 720
 721 * **[implements] eth_dev_ops**: ``fw_version_get``.
 722 * **[related]    API**: ``rte_eth_dev_fw_version_get()``.
 723
 724
 725 .. _nic_features_eeprom_dump:
 726
 727 EEPROM dump
 728 -----------
 729
 730 Supports getting/setting device eeprom data.
 731
 732 * **[implements] eth_dev_ops**: ``get_eeprom_length``, ``get_eeprom``, ``set_eeprom``.
 733 * **[related]    API**: ``rte_eth_dev_get_eeprom_length()``, ``rte_eth_dev_get_eeprom()``,
 734   ``rte_eth_dev_set_eeprom()``.
 735
 736
 737 .. _nic_features_module_eeprom_dump:
 738
 739 Module EEPROM dump
 740 ------------------
 741
 742 Supports getting information and data of plugin module eeprom.
 743
 744 * **[implements] eth_dev_ops**: ``get_module_info``, ``get_module_eeprom``.
 745 * **[related]    API**: ``rte_eth_dev_get_module_info()``, ``rte_eth_dev_get_module_eeprom()``.
 746
 747
 748 .. _nic_features_register_dump:
 749
 750 Registers dump
 751 --------------
 752
 753 Supports retrieving device registers and registering attributes (number of
 754 registers and register size).
 755
 756 * **[implements] eth_dev_ops**: ``get_reg``.
 757 * **[related]    API**: ``rte_eth_dev_get_reg_info()``.
 758
 759
 760 .. _nic_features_led:
 761
 762 LED
 763 ---
 764
 765 Supports turning on/off a software controllable LED on a device.
 766
 767 * **[implements] eth_dev_ops**: ``dev_led_on``, ``dev_led_off``.
 768 * **[related]    API**: ``rte_eth_led_on()``, ``rte_eth_led_off()``.
 769
 770
 771 .. _nic_features_multiprocess_aware:
 772
 773 Multiprocess aware
 774 ------------------
 775
 776 Driver can be used for primary-secondary process model.
 777
 778
 779 .. _nic_features_freebsd:
 780
 781 FreeBSD
 782 -------
 783
 784 Supports running on FreeBSD.
 785
 786
 787 .. _nic_features_linux:
 788
 789 Linux
 790 -----
 791
 792 Supports running on Linux.
 793
 794
 795 .. _nic_features_windows:
 796
 797 Windows
 798 -------
 799
 800 Supports running on Windows.
 801
 802
 803 .. _nic_features_armv7:
 804
 805 ARMv7
 806 -----
 807
 808 Support armv7 architecture.
 809
 810
 811 .. _nic_features_armv8:
 812
 813 ARMv8
 814 -----
 815
 816 Support armv8a (64bit) architecture.
 817
 818
 819 .. _nic_features_power8:
 820
 821 Power8
 822 ------
 823
 824 Support PowerPC architecture.
 825
 826
 827 .. _nic_features_x86-32:
 828
 829 x86-32
 830 ------
 831
 832 Support 32bits x86 architecture.
 833
 834
 835 .. _nic_features_x86-64:
 836
 837 x86-64
 838 ------
 839
 840 Support 64bits x86 architecture.
 841
 842
 843 .. _nic_features_usage_doc:
 844
 845 Usage doc
 846 ---------
 847
 848 Documentation describes usage.
 849
 850 See ``doc/guides/nics/*.rst``
 851
 852
 853 .. _nic_features_design_doc:
 854
 855 Design doc
 856 ----------
 857
 858 Documentation describes design.
 859
 860 See ``doc/guides/nics/*.rst``.
 861
 862
 863 .. _nic_features_perf_doc:
 864
 865 Perf doc
 866 --------
 867
 868 Documentation describes performance values.
 869
 870 See ``dpdk.org/doc/perf/*``.
 871
 872 .. _nic_features_runtime_rx_queue_setup:
 873
 874 Runtime Rx queue setup
 875 ----------------------
 876
 877 Supports Rx queue setup after device started.
 878
 879 * **[provides] rte_eth_dev_info**: ``dev_capa:RTE_ETH_DEV_CAPA_RUNTIME_RX_QUEUE_SETUP``.
 880 * **[related]  API**: ``rte_eth_dev_info_get()``.
 881
 882 .. _nic_features_runtime_tx_queue_setup:
 883
 884 Runtime Tx queue setup
 885 ----------------------
 886
 887 Supports Tx queue setup after device started.
 888
 889 * **[provides] rte_eth_dev_info**: ``dev_capa:RTE_ETH_DEV_CAPA_RUNTIME_TX_QUEUE_SETUP``.
 890 * **[related]  API**: ``rte_eth_dev_info_get()``.
 891
 892 .. _nic_features_burst_mode_info:
 893
 894 Burst mode info
 895 ---------------
 896
 897 Supports to get Rx/Tx packet burst mode information.
 898
 899 * **[implements] eth_dev_ops**: ``rx_burst_mode_get``, ``tx_burst_mode_get``.
 900 * **[related] API**: ``rte_eth_rx_burst_mode_get()``, ``rte_eth_tx_burst_mode_get()``.
 901
 902 .. _nic_features_get_monitor_addr:
 903
 904 PMD power management using monitor addresses
 905 --------------------------------------------
 906
 907 Supports getting a monitoring condition to use together with Ethernet PMD power
 908 management (see :doc:`../prog_guide/power_man` for more details).
 909
 910 * **[implements] eth_dev_ops**: ``get_monitor_addr``
 911
 912 .. _nic_features_other:
 913
 914 Other dev ops not represented by a Feature
 915 ------------------------------------------
 916
 917 * ``rxq_info_get``
 918 * ``txq_info_get``
 919 * ``vlan_tpid_set``
 920 * ``vlan_strip_queue_set``
 921 * ``vlan_pvid_set``
 922 * ``rx_queue_count``
 923 * ``uc_hash_table_set``
 924 * ``uc_all_hash_table_set``
 925 * ``udp_tunnel_port_add``
 926 * ``udp_tunnel_port_del``
 927 * ``tx_pkt_prepare``