doc/guides/nics/features.rst

   1 ..  BSD LICENSE
   2     Copyright(c) 2017 Intel Corporation. All rights reserved.
   3     All rights reserved.
   4
   5     Redistribution and use in source and binary forms, with or without
   6     modification, are permitted provided that the following conditions
   7     are met:
   8
   9     * Redistributions of source code must retain the above copyright
  10     notice, this list of conditions and the following disclaimer.
  11     * Redistributions in binary form must reproduce the above copyright
  12     notice, this list of conditions and the following disclaimer in
  13     the documentation and/or other materials provided with the
  14     distribution.
  15     * Neither the name of Intel Corporation nor the names of its
  16     contributors may be used to endorse or promote products derived
  17     from this software without specific prior written permission.
  18
  19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22     A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23     OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30
  31 Features Overview
  32 =================
  33
  34 This section explains the supported features that are listed in the
  35 :doc:`overview`.
  36
  37 As a guide to implementers it also shows the structs where the features are
  38 defined and the APIs that can be use to get/set the values.
  39
  40 Following tags used for feature details, these are from driver point of view:
  41
  42 ``[uses]``       : Driver uses some kind of input from the application.
  43
  44 ``[implements]`` : Driver implements a functionality.
  45
  46 ``[provides]``   : Driver provides some kind of data to the application. It is possible
  47 to provide data by implementing some function, but "provides" is used
  48 for cases where provided data can't be represented simply by a function.
  49
  50 ``[related]``    : Related API with that feature.
  51
  52
  53 .. _nic_features_speed_capabilities:
  54
  55 Speed capabilities
  56 ------------------
  57
  58 Supports getting the speed capabilities that the current device is capable of.
  59
  60 * **[provides] rte_eth_dev_info**: ``speed_capa:ETH_LINK_SPEED_*``.
  61 * **[related]  API**: ``rte_eth_dev_info_get()``.
  62
  63
  64 .. _nic_features_link_status:
  65
  66 Link status
  67 -----------
  68
  69 Supports getting the link speed, duplex mode and link state (up/down).
  70
  71 * **[implements] eth_dev_ops**: ``link_update``.
  72 * **[implements] rte_eth_dev_data**: ``dev_link``.
  73 * **[related]    API**: ``rte_eth_link_get()``, ``rte_eth_link_get_nowait()``.
  74
  75
  76 .. _nic_features_link_status_event:
  77
  78 Link status event
  79 -----------------
  80
  81 Supports Link Status Change interrupts.
  82
  83 * **[uses]       user config**: ``dev_conf.intr_conf.lsc``.
  84 * **[uses]       rte_eth_dev_data**: ``dev_flags:RTE_ETH_DEV_INTR_LSC``.
  85 * **[uses]       rte_eth_event_type**: ``RTE_ETH_EVENT_INTR_LSC``.
  86 * **[implements] rte_eth_dev_data**: ``dev_link``.
  87 * **[provides]   rte_pci_driver.drv_flags**: ``RTE_PCI_DRV_INTR_LSC``.
  88 * **[related]    API**: ``rte_eth_link_get()``, ``rte_eth_link_get_nowait()``.
  89
  90
  91 .. _nic_features_removal_event:
  92
  93 Removal event
  94 -------------
  95
  96 Supports device removal interrupts.
  97
  98 * **[uses]     user config**: ``dev_conf.intr_conf.rmv``.
  99 * **[uses]     rte_eth_dev_data**: ``dev_flags:RTE_ETH_DEV_INTR_RMV``.
 100 * **[uses]     rte_eth_event_type**: ``RTE_ETH_EVENT_INTR_RMV``.
 101 * **[provides] rte_pci_driver.drv_flags**: ``RTE_PCI_DRV_INTR_RMV``.
 102
 103
 104 .. _nic_features_queue_status_event:
 105
 106 Queue status event
 107 ------------------
 108
 109 Supports queue enable/disable events.
 110
 111 * **[uses] rte_eth_event_type**: ``RTE_ETH_EVENT_QUEUE_STATE``.
 112
 113
 114 .. _nic_features_rx_interrupt:
 115
 116 Rx interrupt
 117 ------------
 118
 119 Supports Rx interrupts.
 120
 121 * **[uses]       user config**: ``dev_conf.intr_conf.rxq``.
 122 * **[implements] eth_dev_ops**: ``rx_queue_intr_enable``, ``rx_queue_intr_disable``.
 123 * **[related]    API**: ``rte_eth_dev_rx_intr_enable()``, ``rte_eth_dev_rx_intr_disable()``.
 124
 125
 126 .. _nic_features_lock-free_tx_queue:
 127
 128 Lock-free Tx queue
 129 ------------------
 130
 131 If a PMD advertises DEV_TX_OFFLOAD_MT_LOCKFREE capable, multiple threads can
 132 invoke rte_eth_tx_burst() concurrently on the same Tx queue without SW lock.
 133
 134 * **[uses]    rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_MT_LOCKFREE``.
 135 * **[provides] rte_eth_dev_info**: ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_MT_LOCKFREE``.
 136 * **[related]  API**: ``rte_eth_tx_burst()``.
 137
 138
 139 .. _nic_features_free_tx_mbuf_on_demand:
 140
 141 Free Tx mbuf on demand
 142 ----------------------
 143
 144 Supports freeing consumed buffers on a Tx ring.
 145
 146 * **[implements] eth_dev_ops**: ``tx_done_cleanup``.
 147 * **[related]    API**: ``rte_eth_tx_done_cleanup()``.
 148
 149
 150 .. _nic_features_queue_start_stop:
 151
 152 Queue start/stop
 153 ----------------
 154
 155 Supports starting/stopping a specific Rx/Tx queue of a port.
 156
 157 * **[implements] eth_dev_ops**: ``rx_queue_start``, ``rx_queue_stop``, ``tx_queue_start``,
 158   ``tx_queue_stop``.
 159 * **[related]    API**: ``rte_eth_dev_rx_queue_start()``, ``rte_eth_dev_rx_queue_stop()``,
 160   ``rte_eth_dev_tx_queue_start()``, ``rte_eth_dev_tx_queue_stop()``.
 161
 162
 163 .. _nic_features_mtu_update:
 164
 165 MTU update
 166 ----------
 167
 168 Supports updating port MTU.
 169
 170 * **[implements] eth_dev_ops**: ``mtu_set``.
 171 * **[implements] rte_eth_dev_data**: ``mtu``.
 172 * **[provides]   rte_eth_dev_info**: ``max_rx_pktlen``.
 173 * **[related]    API**: ``rte_eth_dev_set_mtu()``, ``rte_eth_dev_get_mtu()``.
 174
 175
 176 .. _nic_features_jumbo_frame:
 177
 178 Jumbo frame
 179 -----------
 180
 181 Supports Rx jumbo frames.
 182
 183 * **[uses]    rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_JUMBO_FRAME``.
 184   ``dev_conf.rxmode.max_rx_pkt_len``.
 185 * **[related] rte_eth_dev_info**: ``max_rx_pktlen``.
 186 * **[related] API**: ``rte_eth_dev_set_mtu()``.
 187
 188
 189 .. _nic_features_scattered_rx:
 190
 191 Scattered Rx
 192 ------------
 193
 194 Supports receiving segmented mbufs.
 195
 196 * **[uses]       rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_SCATTER``.
 197 * **[implements] datapath**: ``Scattered Rx function``.
 198 * **[implements] rte_eth_dev_data**: ``scattered_rx``.
 199 * **[provides]   eth_dev_ops**: ``rxq_info_get:scattered_rx``.
 200 * **[related]    eth_dev_ops**: ``rx_pkt_burst``.
 201
 202
 203 .. _nic_features_lro:
 204
 205 LRO
 206 ---
 207
 208 Supports Large Receive Offload.
 209
 210 * **[uses]       rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_TCP_LRO``.
 211 * **[implements] datapath**: ``LRO functionality``.
 212 * **[implements] rte_eth_dev_data**: ``lro``.
 213 * **[provides]   mbuf**: ``mbuf.ol_flags:PKT_RX_LRO``, ``mbuf.tso_segsz``.
 214 * **[provides]   rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_TCP_LRO``.
 215
 216
 217 .. _nic_features_tso:
 218
 219 TSO
 220 ---
 221
 222 Supports TCP Segmentation Offloading.
 223
 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``.
 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``.
 230
 231
 232 .. _nic_features_promiscuous_mode:
 233
 234 Promiscuous mode
 235 ----------------
 236
 237 Supports enabling/disabling promiscuous mode for a port.
 238
 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()``.
 243
 244
 245 .. _nic_features_allmulticast_mode:
 246
 247 Allmulticast mode
 248 -----------------
 249
 250 Supports enabling/disabling receiving multicast frames.
 251
 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()``.
 256
 257
 258 .. _nic_features_unicast_mac_filter:
 259
 260 Unicast MAC filter
 261 ------------------
 262
 263 Supports adding MAC addresses to enable whitelist filtering to accept packets.
 264
 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()``.
 270
 271
 272 .. _nic_features_multicast_mac_filter:
 273
 274 Multicast MAC filter
 275 --------------------
 276
 277 Supports setting multicast addresses to filter.
 278
 279 * **[implements] eth_dev_ops**: ``set_mc_addr_list``.
 280 * **[related]    API**: ``rte_eth_dev_set_mc_addr_list()``.
 281
 282
 283 .. _nic_features_rss_hash:
 284
 285 RSS hash
 286 --------
 287
 288 Supports RSS hashing on RX.
 289
 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 * **[provides] rte_eth_dev_info**: ``flow_type_rss_offloads``.
 293 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_RSS_HASH``, ``mbuf.rss``.
 294
 295
 296 .. _nic_features_rss_key_update:
 297
 298 RSS key update
 299 --------------
 300
 301 Supports configuration of Receive Side Scaling (RSS) hash computation. Updating
 302 Receive Side Scaling (RSS) hash key.
 303
 304 * **[implements] eth_dev_ops**: ``rss_hash_update``, ``rss_hash_conf_get``.
 305 * **[provides]   rte_eth_dev_info**: ``hash_key_size``.
 306 * **[related]    API**: ``rte_eth_dev_rss_hash_update()``,
 307   ``rte_eth_dev_rss_hash_conf_get()``.
 308
 309
 310 .. _nic_features_rss_reta_update:
 311
 312 RSS reta update
 313 ---------------
 314
 315 Supports updating Redirection Table of the Receive Side Scaling (RSS).
 316
 317 * **[implements] eth_dev_ops**: ``reta_update``, ``reta_query``.
 318 * **[provides]   rte_eth_dev_info**: ``reta_size``.
 319 * **[related]    API**: ``rte_eth_dev_rss_reta_update()``, ``rte_eth_dev_rss_reta_query()``.
 320
 321
 322 .. _nic_features_vmdq:
 323
 324 VMDq
 325 ----
 326
 327 Supports Virtual Machine Device Queues (VMDq).
 328
 329 * **[uses] user config**: ``dev_conf.rxmode.mq_mode`` = ``ETH_MQ_RX_VMDQ_FLAG``.
 330 * **[uses] user config**: ``dev_conf.rx_adv_conf.vmdq_dcb_conf``.
 331 * **[uses] user config**: ``dev_conf.rx_adv_conf.vmdq_rx_conf``.
 332 * **[uses] user config**: ``dev_conf.tx_adv_conf.vmdq_dcb_tx_conf``.
 333 * **[uses] user config**: ``dev_conf.tx_adv_conf.vmdq_tx_conf``.
 334
 335
 336 .. _nic_features_sriov:
 337
 338 SR-IOV
 339 ------
 340
 341 Driver supports creating Virtual Functions.
 342
 343 * **[implements] rte_eth_dev_data**: ``sriov``.
 344
 345 .. _nic_features_dcb:
 346
 347 DCB
 348 ---
 349
 350 Supports Data Center Bridging (DCB).
 351
 352 * **[uses]       user config**: ``dev_conf.rxmode.mq_mode`` = ``ETH_MQ_RX_DCB_FLAG``.
 353 * **[uses]       user config**: ``dev_conf.rx_adv_conf.vmdq_dcb_conf``.
 354 * **[uses]       user config**: ``dev_conf.rx_adv_conf.dcb_rx_conf``.
 355 * **[uses]       user config**: ``dev_conf.tx_adv_conf.vmdq_dcb_tx_conf``.
 356 * **[uses]       user config**: ``dev_conf.tx_adv_conf.vmdq_tx_conf``.
 357 * **[implements] eth_dev_ops**: ``get_dcb_info``.
 358 * **[related]    API**: ``rte_eth_dev_get_dcb_info()``.
 359
 360
 361 .. _nic_features_vlan_filter:
 362
 363 VLAN filter
 364 -----------
 365
 366 Supports filtering of a VLAN Tag identifier.
 367
 368 * **[uses]       rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_VLAN_FILTER``.
 369 * **[implements] eth_dev_ops**: ``vlan_filter_set``.
 370 * **[related]    API**: ``rte_eth_dev_vlan_filter()``.
 371
 372
 373 .. _nic_features_ethertype_filter:
 374
 375 Ethertype filter
 376 ----------------
 377
 378 Supports filtering on Ethernet type.
 379
 380 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_ETHERTYPE``.
 381 * **[related]    API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
 382
 383 .. _nic_features_ntuple_filter:
 384
 385 N-tuple filter
 386 --------------
 387
 388 Supports filtering on N-tuple values.
 389
 390 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_NTUPLE``.
 391 * **[related]    API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
 392
 393
 394 .. _nic_features_syn_filter:
 395
 396 SYN filter
 397 ----------
 398
 399 Supports TCP syn filtering.
 400
 401 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_SYN``.
 402 * **[related]    API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
 403
 404
 405 .. _nic_features_tunnel_filter:
 406
 407 Tunnel filter
 408 -------------
 409
 410 Supports tunnel filtering.
 411
 412 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_TUNNEL``.
 413 * **[related]    API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
 414
 415
 416 .. _nic_features_flexible_filter:
 417
 418 Flexible filter
 419 ---------------
 420
 421 Supports a flexible (non-tuple or Ethertype) filter.
 422
 423 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_FLEXIBLE``.
 424 * **[related]    API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
 425
 426
 427 .. _nic_features_hash_filter:
 428
 429 Hash filter
 430 -----------
 431
 432 Supports Hash filtering.
 433
 434 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_HASH``.
 435 * **[related]    API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
 436
 437
 438 .. _nic_features_flow_director:
 439
 440 Flow director
 441 -------------
 442
 443 Supports Flow Director style filtering to queues.
 444
 445 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_FDIR``.
 446 * **[provides]   mbuf**: ``mbuf.ol_flags:`` ``PKT_RX_FDIR``, ``PKT_RX_FDIR_ID``,
 447   ``PKT_RX_FDIR_FLX``.
 448 * **[related]    API**: ``rte_eth_dev_filter_ctrl()``, ``rte_eth_dev_filter_supported()``.
 449
 450
 451 .. _nic_features_flow_control:
 452
 453 Flow control
 454 ------------
 455
 456 Supports configuring link flow control.
 457
 458 * **[implements] eth_dev_ops**: ``flow_ctrl_get``, ``flow_ctrl_set``,
 459   ``priority_flow_ctrl_set``.
 460 * **[related]    API**: ``rte_eth_dev_flow_ctrl_get()``, ``rte_eth_dev_flow_ctrl_set()``,
 461   ``rte_eth_dev_priority_flow_ctrl_set()``.
 462
 463
 464 .. _nic_features_flow_api:
 465
 466 Flow API
 467 --------
 468
 469 Supports the DPDK Flow API for generic filtering.
 470
 471 * **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_GENERIC``.
 472 * **[implements] rte_flow_ops**: ``All``.
 473
 474
 475 .. _nic_features_rate_limitation:
 476
 477 Rate limitation
 478 ---------------
 479
 480 Supports Tx rate limitation for a queue.
 481
 482 * **[implements] eth_dev_ops**: ``set_queue_rate_limit``.
 483 * **[related]    API**: ``rte_eth_set_queue_rate_limit()``.
 484
 485
 486 .. _nic_features_traffic_mirroring:
 487
 488 Traffic mirroring
 489 -----------------
 490
 491 Supports adding traffic mirroring rules.
 492
 493 * **[implements] eth_dev_ops**: ``mirror_rule_set``, ``mirror_rule_reset``.
 494 * **[related]    API**: ``rte_eth_mirror_rule_set()``, ``rte_eth_mirror_rule_reset()``.
 495
 496
 497 .. _nic_features_crc_offload:
 498
 499 CRC offload
 500 -----------
 501
 502 Supports CRC stripping by hardware.
 503
 504 * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_CRC_STRIP``.
 505
 506
 507 .. _nic_features_vlan_offload:
 508
 509 VLAN offload
 510 ------------
 511
 512 Supports VLAN offload to hardware.
 513
 514 * **[uses]       rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_VLAN_STRIP,DEV_RX_OFFLOAD_VLAN_FILTER,DEV_RX_OFFLOAD_VLAN_EXTEND``.
 515 * **[uses]       rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_VLAN_INSERT``.
 516 * **[implements] eth_dev_ops**: ``vlan_offload_set``.
 517 * **[provides]   mbuf**: ``mbuf.ol_flags:PKT_RX_VLAN_STRIPPED``, ``mbuf.vlan_tci``.
 518 * **[provides]   rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_VLAN_STRIP``,
 519   ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_VLAN_INSERT``.
 520 * **[related]    API**: ``rte_eth_dev_set_vlan_offload()``,
 521   ``rte_eth_dev_get_vlan_offload()``.
 522
 523
 524 .. _nic_features_qinq_offload:
 525
 526 QinQ offload
 527 ------------
 528
 529 Supports QinQ (queue in queue) offload.
 530
 531 * **[uses]     rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_QINQ_STRIP``.
 532 * **[uses]     rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_QINQ_INSERT``.
 533 * **[uses]     mbuf**: ``mbuf.ol_flags:PKT_TX_QINQ_PKT``.
 534 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_QINQ_STRIPPED``, ``mbuf.vlan_tci``,
 535    ``mbuf.vlan_tci_outer``.
 536 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_QINQ_STRIP``,
 537   ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_QINQ_INSERT``.
 538
 539
 540 .. _nic_features_l3_checksum_offload:
 541
 542 L3 checksum offload
 543 -------------------
 544
 545 Supports L3 checksum offload.
 546
 547 * **[uses]     rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_IPV4_CKSUM``.
 548 * **[uses]     rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_IPV4_CKSUM``.
 549 * **[uses]     mbuf**: ``mbuf.ol_flags:PKT_TX_IP_CKSUM``,
 550   ``mbuf.ol_flags:PKT_TX_IPV4`` | ``PKT_TX_IPV6``.
 551 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_IP_CKSUM_UNKNOWN`` |
 552   ``PKT_RX_IP_CKSUM_BAD`` | ``PKT_RX_IP_CKSUM_GOOD`` |
 553   ``PKT_RX_IP_CKSUM_NONE``.
 554 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_IPV4_CKSUM``,
 555   ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_IPV4_CKSUM``.
 556
 557
 558 .. _nic_features_l4_checksum_offload:
 559
 560 L4 checksum offload
 561 -------------------
 562
 563 Supports L4 checksum offload.
 564
 565 * **[uses]     rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_UDP_CKSUM,DEV_RX_OFFLOAD_TCP_CKSUM``.
 566 * **[uses]     rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_UDP_CKSUM,DEV_TX_OFFLOAD_TCP_CKSUM,DEV_TX_OFFLOAD_SCTP_CKSUM``.
 567 * **[uses]     user config**: ``dev_conf.rxmode.hw_ip_checksum``.
 568 * **[uses]     mbuf**: ``mbuf.ol_flags:PKT_TX_IPV4`` | ``PKT_TX_IPV6``,
 569   ``mbuf.ol_flags:PKT_TX_L4_NO_CKSUM`` | ``PKT_TX_TCP_CKSUM`` |
 570   ``PKT_TX_SCTP_CKSUM`` | ``PKT_TX_UDP_CKSUM``.
 571 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_L4_CKSUM_UNKNOWN`` |
 572   ``PKT_RX_L4_CKSUM_BAD`` | ``PKT_RX_L4_CKSUM_GOOD`` |
 573   ``PKT_RX_L4_CKSUM_NONE``.
 574 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_UDP_CKSUM,DEV_RX_OFFLOAD_TCP_CKSUM``,
 575   ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_UDP_CKSUM,DEV_TX_OFFLOAD_TCP_CKSUM,DEV_TX_OFFLOAD_SCTP_CKSUM``.
 576
 577
 578 .. _nic_features_macsec_offload:
 579
 580 MACsec offload
 581 --------------
 582
 583 Supports MACsec.
 584
 585 * **[uses]     rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_MACSEC_STRIP``.
 586 * **[uses]     rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_MACSEC_INSERT``.
 587 * **[uses]     mbuf**: ``mbuf.ol_flags:PKT_TX_MACSEC``.
 588 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_MACSEC_STRIP``,
 589   ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_MACSEC_INSERT``.
 590
 591
 592 .. _nic_features_inner_l3_checksum:
 593
 594 Inner L3 checksum
 595 -----------------
 596
 597 Supports inner packet L3 checksum.
 598
 599 * **[uses]     rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM``.
 600 * **[uses]     rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM``.
 601 * **[uses]     mbuf**: ``mbuf.ol_flags:PKT_TX_IP_CKSUM``,
 602   ``mbuf.ol_flags:PKT_TX_IPV4`` | ``PKT_TX_IPV6``,
 603   ``mbuf.ol_flags:PKT_TX_OUTER_IP_CKSUM``,
 604   ``mbuf.ol_flags:PKT_TX_OUTER_IPV4`` | ``PKT_TX_OUTER_IPV6``.
 605 * **[uses]     mbuf**: ``mbuf.outer_l2_len``, ``mbuf.outer_l3_len``.
 606 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_EIP_CKSUM_BAD``.
 607 * **[provides] rte_eth_dev_info**: ``rx_offload_capa,rx_queue_offload_capa:DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM``,
 608   ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM``.
 609
 610
 611 .. _nic_features_inner_l4_checksum:
 612
 613 Inner L4 checksum
 614 -----------------
 615
 616 Supports inner packet L4 checksum.
 617
 618
 619 .. _nic_features_packet_type_parsing:
 620
 621 Packet type parsing
 622 -------------------
 623
 624 Supports packet type parsing and returns a list of supported types.
 625
 626 * **[implements] eth_dev_ops**: ``dev_supported_ptypes_get``.
 627 * **[related]    API**: ``rte_eth_dev_get_supported_ptypes()``.
 628
 629
 630 .. _nic_features_timesync:
 631
 632 Mbuf fast free
 633 --------------
 634
 635 Supports optimization for fast release of mbufs following successful Tx.
 636 Requires that per queue, all mbufs come from the same mempool and has refcnt = 1.
 637
 638 * **[uses]       rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_MBUF_FAST_FREE``.
 639 * **[provides]   rte_eth_dev_info**: ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_MBUF_FAST_FREE``.
 640
 641 Timesync
 642 --------
 643
 644 Supports IEEE1588/802.1AS timestamping.
 645
 646 * **[implements] eth_dev_ops**: ``timesync_enable``, ``timesync_disable``
 647   ``timesync_read_rx_timestamp``, ``timesync_read_tx_timestamp``,
 648   ``timesync_adjust_time``, ``timesync_read_time``, ``timesync_write_time``.
 649 * **[related]    API**: ``rte_eth_timesync_enable()``, ``rte_eth_timesync_disable()``,
 650   ``rte_eth_timesync_read_rx_timestamp()``,
 651   ``rte_eth_timesync_read_tx_timestamp``, ``rte_eth_timesync_adjust_time()``,
 652   ``rte_eth_timesync_read_time()``, ``rte_eth_timesync_write_time()``.
 653
 654
 655 .. _nic_features_rx_descriptor_status:
 656
 657 Rx descriptor status
 658 --------------------
 659
 660 Supports check the status of a Rx descriptor. When ``rx_descriptor_status`` is
 661 used, status can be "Available", "Done" or "Unavailable". When
 662 ``rx_descriptor_done`` is used, status can be "DD bit is set" or "DD bit is
 663 not set".
 664
 665 * **[implements] eth_dev_ops**: ``rx_descriptor_status``.
 666 * **[related]    API**: ``rte_eth_rx_descriptor_status()``.
 667 * **[implements] eth_dev_ops**: ``rx_descriptor_done``.
 668 * **[related]    API**: ``rte_eth_rx_descriptor_done()``.
 669
 670
 671 .. _nic_features_tx_descriptor_status:
 672
 673 Tx descriptor status
 674 --------------------
 675
 676 Supports checking the status of a Tx descriptor. Status can be "Full", "Done"
 677 or "Unavailable."
 678
 679 * **[implements] eth_dev_ops**: ``tx_descriptor_status``.
 680 * **[related]    API**: ``rte_eth_tx_descriptor_status()``.
 681
 682
 683 .. _nic_features_basic_stats:
 684
 685 Basic stats
 686 -----------
 687
 688 Support basic statistics such as: ipackets, opackets, ibytes, obytes,
 689 imissed, ierrors, oerrors, rx_nombuf.
 690
 691 And per queue stats: q_ipackets, q_opackets, q_ibytes, q_obytes, q_errors.
 692
 693 These apply to all drivers.
 694
 695 * **[implements] eth_dev_ops**: ``stats_get``, ``stats_reset``.
 696 * **[related]    API**: ``rte_eth_stats_get``, ``rte_eth_stats_reset()``.
 697
 698
 699 .. _nic_features_extended_stats:
 700
 701 Extended stats
 702 --------------
 703
 704 Supports Extended Statistics, changes from driver to driver.
 705
 706 * **[implements] eth_dev_ops**: ``xstats_get``, ``xstats_reset``, ``xstats_get_names``.
 707 * **[implements] eth_dev_ops**: ``xstats_get_by_id``, ``xstats_get_names_by_id``.
 708 * **[related]    API**: ``rte_eth_xstats_get()``, ``rte_eth_xstats_reset()``,
 709   ``rte_eth_xstats_get_names``, ``rte_eth_xstats_get_by_id()``,
 710   ``rte_eth_xstats_get_names_by_id()``, ``rte_eth_xstats_get_id_by_name()``.
 711
 712
 713 .. _nic_features_stats_per_queue:
 714
 715 Stats per queue
 716 ---------------
 717
 718 Supports configuring per-queue stat counter mapping.
 719
 720 * **[implements] eth_dev_ops**: ``queue_stats_mapping_set``.
 721 * **[related]    API**: ``rte_eth_dev_set_rx_queue_stats_mapping()``,
 722   ``rte_eth_dev_set_tx_queue_stats_mapping()``.
 723
 724
 725 .. _nic_features_fw_version:
 726
 727 FW version
 728 ----------
 729
 730 Supports getting device hardware firmware information.
 731
 732 * **[implements] eth_dev_ops**: ``fw_version_get``.
 733 * **[related]    API**: ``rte_eth_dev_fw_version_get()``.
 734
 735
 736 .. _nic_features_eeprom_dump:
 737
 738 EEPROM dump
 739 -----------
 740
 741 Supports getting/setting device eeprom data.
 742
 743 * **[implements] eth_dev_ops**: ``get_eeprom_length``, ``get_eeprom``, ``set_eeprom``.
 744 * **[related]    API**: ``rte_eth_dev_get_eeprom_length()``, ``rte_eth_dev_get_eeprom()``,
 745   ``rte_eth_dev_set_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_bsd_nic_uio:
 780
 781 BSD nic_uio
 782 -----------
 783
 784 BSD ``nic_uio`` module supported.
 785
 786
 787 .. _nic_features_linux_uio:
 788
 789 Linux UIO
 790 ---------
 791
 792 Works with ``igb_uio`` kernel module.
 793
 794 * **[provides] RTE_PMD_REGISTER_KMOD_DEP**: ``igb_uio``.
 795
 796 .. _nic_features_linux_vfio:
 797
 798 Linux VFIO
 799 ----------
 800
 801 Works with ``vfio-pci`` kernel module.
 802
 803 * **[provides] RTE_PMD_REGISTER_KMOD_DEP**: ``vfio-pci``.
 804
 805 .. _nic_features_other_kdrv:
 806
 807 Other kdrv
 808 ----------
 809
 810 Kernel module other than above ones supported.
 811
 812
 813 .. _nic_features_armv7:
 814
 815 ARMv7
 816 -----
 817
 818 Support armv7 architecture.
 819
 820 Use ``defconfig_arm-armv7a-*-*``.
 821
 822
 823 .. _nic_features_armv8:
 824
 825 ARMv8
 826 -----
 827
 828 Support armv8a (64bit) architecture.
 829
 830 Use ``defconfig_arm64-armv8a-*-*``
 831
 832
 833 .. _nic_features_power8:
 834
 835 Power8
 836 ------
 837
 838 Support PowerPC architecture.
 839
 840 Use ``defconfig_ppc_64-power8-*-*``
 841
 842 .. _nic_features_x86-32:
 843
 844 x86-32
 845 ------
 846
 847 Support 32bits x86 architecture.
 848
 849 Use ``defconfig_x86_x32-native-*-*`` and ``defconfig_i686-native-*-*``.
 850
 851
 852 .. _nic_features_x86-64:
 853
 854 x86-64
 855 ------
 856
 857 Support 64bits x86 architecture.
 858
 859 Use ``defconfig_x86_64-native-*-*``.
 860
 861
 862 .. _nic_features_usage_doc:
 863
 864 Usage doc
 865 ---------
 866
 867 Documentation describes usage.
 868
 869 See ``doc/guides/nics/*.rst``
 870
 871
 872 .. _nic_features_design_doc:
 873
 874 Design doc
 875 ----------
 876
 877 Documentation describes design.
 878
 879 See ``doc/guides/nics/*.rst``.
 880
 881
 882 .. _nic_features_perf_doc:
 883
 884 Perf doc
 885 --------
 886
 887 Documentation describes performance values.
 888
 889 See ``dpdk.org/doc/perf/*``.
 890
 891
 892
 893 .. _nic_features_other:
 894
 895 Other dev ops not represented by a Feature
 896 ------------------------------------------
 897
 898 * ``rxq_info_get``
 899 * ``txq_info_get``
 900 * ``vlan_tpid_set``
 901 * ``vlan_strip_queue_set``
 902 * ``vlan_pvid_set``
 903 * ``rx_queue_count``
 904 * ``l2_tunnel_offload_set``
 905 * ``uc_hash_table_set``
 906 * ``uc_all_hash_table_set``
 907 * ``udp_tunnel_port_add``
 908 * ``udp_tunnel_port_del``
 909 * ``l2_tunnel_eth_type_conf``
 910 * ``l2_tunnel_offload_set``
 911 * ``tx_pkt_prepare``