Network Interface Controller Drivers

• 1. Overview of Networking Drivers
• 2. Features Overview
  • 2.1. Speed capabilities
  • 2.2. Link status
  • 2.3. Link status event
  • 2.4. Removal event
  • 2.5. Queue status event
  • 2.6. Rx interrupt
  • 2.7. Lock-free Tx queue
  • 2.8. Fast mbuf free
  • 2.9. Free Tx mbuf on demand
  • 2.10. Queue start/stop
  • 2.11. MTU update
  • 2.12. Jumbo frame
  • 2.13. Scattered Rx
  • 2.14. LRO
  • 2.15. TSO
  • 2.16. Promiscuous mode
  • 2.17. Allmulticast mode
  • 2.18. Unicast MAC filter
  • 2.19. Multicast MAC filter
  • 2.20. RSS hash
  • 2.21. Inner RSS
  • 2.22. RSS key update
  • 2.23. RSS reta update
  • 2.24. VMDq
  • 2.25. SR-IOV
  • 2.26. DCB
  • 2.27. VLAN filter
  • 2.28. Flow control
  • 2.29. Flow API
  • 2.30. Rate limitation
  • 2.31. Traffic mirroring
  • 2.32. Inline crypto
  • 2.33. CRC offload
  • 2.34. VLAN offload
  • 2.35. QinQ offload
  • 2.36. L3 checksum offload
  • 2.37. L4 checksum offload
  • 2.38. Timestamp offload
  • 2.39. MACsec offload
  • 2.40. Inner L3 checksum
  • 2.41. Inner L4 checksum
  • 2.42. Packet type parsing
  • 2.43. Timesync
  • 2.44. Rx descriptor status
  • 2.45. Tx descriptor status
  • 2.46. Basic stats
  • 2.47. Extended stats
  • 2.48. Stats per queue
  • 2.49. FW version
  • 2.50. EEPROM dump
  • 2.51. Module EEPROM dump
  • 2.52. Registers dump
  • 2.53. LED
  • 2.54. Multiprocess aware
  • 2.55. BSD nic_uio
  • 2.56. Linux UIO
  • 2.57. Linux VFIO
  • 2.58. Other kdrv
  • 2.59. ARMv7
  • 2.60. ARMv8
  • 2.61. Power8
  • 2.62. x86-32
  • 2.63. x86-64
  • 2.64. Usage doc
  • 2.65. Design doc
  • 2.66. Perf doc
  • 2.67. Runtime Rx queue setup
  • 2.68. Runtime Tx queue setup
  • 2.69. Other dev ops not represented by a Feature
• 3. Compiling and testing a PMD for a NIC
  • 3.1. Driver Compilation
  • 3.2. Running testpmd in Linux
• 4. AF_PACKET Poll Mode Driver
  • 4.1. Options and inherent limitations
  • 4.2. Prerequisites
  • 4.3. Set up an af_packet interface
• 5. AF_XDP Poll Mode Driver
  • 5.1. Options
  • 5.2. Prerequisites
  • 5.3. Set up an af_xdp interface
• 6. ARK Poll Mode Driver
  • 6.1. Overview
  • 6.2. Device Parameters
  • 6.3. Data Path Interface
  • 6.4. Configuration Information
  • 6.5. Building DPDK
  • 6.6. Supported ARK RTL PCIe Instances
  • 6.7. Supported Operating Systems
  • 6.8. Supported Features
  • 6.9. Unsupported Features
  • 6.10. Pre-Requisites
  • 6.11. Usage Example
• 7. Aquantia Atlantic DPDK Driver
  • 7.1. Supported features
  • 7.2. Experimental API features
  • 7.3. Configuration Information
    • 7.3.1. Application Programming Interface
    • 7.3.2. Limitations or Known issues
    • 7.3.3. Supported Chipsets and NICs
• 8. AVP Poll Mode Driver
  • 8.1. Features and Limitations of the AVP PMD
  • 8.2. Prerequisites
  • 8.3. Launching a VM with an AVP type network attachment
• 9. AXGBE Poll Mode Driver
  • 9.1. Supported Features
  • 9.2. Configuration Information
  • 9.3. Building DPDK
  • 9.4. Prerequisites and Pre-conditions
  • 9.5. Usage Example
• 10. BNX2X Poll Mode Driver
  • 10.1. Supported Features
  • 10.2. Non-supported Features
  • 10.3. Co-existence considerations
  • 10.4. Supported QLogic NICs
  • 10.5. Prerequisites
  • 10.6. Pre-Installation Configuration
    • 10.6.1. Config File Options
  • 10.7. Driver compilation and testing
  • 10.8. SR-IOV: Prerequisites and sample Application Notes
• 11. BNXT Poll Mode Driver
  • 11.1. BNXT PMD Features
  • 11.2. BNXT Vector PMD
    • 11.2.1. RX Requirements for Vector Mode
    • 11.2.2. TX Requirements for Vector Mode
  • 11.3. BNXT PMD Supported Chipsets and Adapters
• 12. CXGBE Poll Mode Driver
  • 12.1. Features
  • 12.2. Limitations
  • 12.3. Supported Chelsio T5 NICs
  • 12.4. Supported Chelsio T6 NICs
  • 12.5. Supported SR-IOV Chelsio NICs
  • 12.6. Prerequisites
  • 12.7. Pre-Installation Configuration
    • 12.7.1. Config File Options
    • 12.7.2. Runtime Options
  • 12.8. Driver compilation and testing
  • 12.9. Linux
    • 12.9.1. Linux Installation
    • 12.9.2. Running testpmd
    • 12.9.3. Configuring SR-IOV Virtual Functions
  • 12.10. FreeBSD
    • 12.10.1. FreeBSD Installation
    • 12.10.2. Running testpmd
  • 12.11. Sample Application Notes
    • 12.11.1. Enable/Disable Flow Control
    • 12.11.2. Jumbo Mode
• 13. DPAA Poll Mode Driver
  • 13.1. NXP DPAA (Data Path Acceleration Architecture - Gen 1)
    • 13.1.1. DPAA Overview
  • 13.2. DPAA DPDK - Poll Mode Driver Overview
    • 13.2.1. DPAA Bus driver
    • 13.2.2. DPAA NIC Driver (PMD)
    • 13.2.3. DPAA Mempool Driver
  • 13.3. Whitelisting & Blacklisting
  • 13.4. Supported DPAA SoCs
  • 13.5. Prerequisites
  • 13.6. Pre-Installation Configuration
    • 13.6.1. Config File Options
    • 13.6.2. Environment Variables
  • 13.7. Driver compilation and testing
  • 13.8. Limitations
    • 13.8.1. Platform Requirement
    • 13.8.2. Maximum packet length
    • 13.8.3. Multiprocess Support
• 14. DPAA2 Poll Mode Driver
  • 14.1. NXP DPAA2 (Data Path Acceleration Architecture Gen2)
    • 14.1.1. DPAA2 Overview
    • 14.1.2. Overview of DPAA2 Objects
    • 14.1.3. DPAA2 Objects for an Ethernet Network Interface
    • 14.1.4. Object Connections
    • 14.1.5. Interrupts
  • 14.2. DPAA2 DPDK - Poll Mode Driver Overview
    • 14.2.1. DPAA2 bus driver
    • 14.2.2. DPIO driver
    • 14.2.3. DPBP based Mempool driver
    • 14.2.4. DPAA2 NIC Driver
  • 14.3. Supported DPAA2 SoCs
  • 14.4. Prerequisites
  • 14.5. Pre-Installation Configuration
    • 14.5.1. Config File Options
  • 14.6. Driver compilation and testing
  • 14.7. Enabling logs
  • 14.8. Whitelisting & Blacklisting
  • 14.9. Limitations
    • 14.9.1. Platform Requirement
    • 14.9.2. Maximum packet length
    • 14.9.3. Other Limitations
• 15. Driver for VM Emulated Devices
  • 15.1. Validated Hypervisors
  • 15.2. Recommended Guest Operating System in Virtual Machine
  • 15.3. Setting Up a KVM Virtual Machine
  • 15.4. Known Limitations of Emulated Devices
• 16. ENA Poll Mode Driver
  • 16.1. Overview
  • 16.2. Management Interface
  • 16.3. Data Path Interface
  • 16.4. Configuration information
  • 16.5. Building DPDK
  • 16.6. Supported ENA adapters
  • 16.7. Supported Operating Systems
  • 16.8. Supported features
  • 16.9. Prerequisites
  • 16.10. Usage example
• 17. ENETC Poll Mode Driver
  • 17.1. ENETC
    • 17.1.1. ENETC Overview
    • 17.1.2. ENETC Features
    • 17.1.3. NIC Driver (PMD)
    • 17.1.4. Supported ENETC SoCs
    • 17.1.5. Prerequisites
    • 17.1.6. Driver compilation and testing
• 18. ENIC Poll Mode Driver
  • 18.1. How to obtain ENIC PMD integrated DPDK
  • 18.2. Configuration information
  • 18.3. Flow director support
  • 18.4. SR-IOV mode utilization
  • 18.5. Generic Flow API support
  • 18.6. Overlay Offload
  • 18.7. Ingress VLAN Rewrite
  • 18.8. Vectorized Rx Handler
  • 18.9. Limitations
  • 18.10. How to build the suite
  • 18.11. Supported Cisco VIC adapters
  • 18.12. Supported Operating Systems
  • 18.13. Supported features
  • 18.14. Known bugs and unsupported features in this release
  • 18.15. Prerequisites
  • 18.16. Additional Reference
  • 18.17. Contact Information
• 19. FM10K Poll Mode Driver
  • 19.1. FTAG Based Forwarding of FM10K
  • 19.2. Vector PMD for FM10K
    • 19.2.1. RX Constraints
    • 19.2.2. TX Constraint
  • 19.3. Limitations
    • 19.3.1. Switch manager
    • 19.3.2. Support for Switch Restart
    • 19.3.3. CRC striping
    • 19.3.4. Maximum packet length
    • 19.3.5. Statistic Polling Frequency
    • 19.3.6. Interrupt mode
• 20. HINIC Poll Mode Driver
  • 20.1. Features
  • 20.2. Prerequisites
  • 20.3. Pre-Installation Configuration
    • 20.3.1. Config File Options
  • 20.4. Driver compilation and testing
  • 20.5. Limitations or Known issues
• 21. I40E Poll Mode Driver
  • 21.1. Features
  • 21.2. Prerequisites
  • 21.3. Recommended Matching List
  • 21.4. Pre-Installation Configuration
    • 21.4.1. Config File Options
    • 21.4.2. Runtime Config Options
    • 21.4.3. Vector RX Pre-conditions
  • 21.5. Driver compilation and testing
  • 21.6. SR-IOV: Prerequisites and sample Application Notes
  • 21.7. Sample Application Notes
    • 21.7.1. Vlan filter
    • 21.7.2. Flow Director
    • 21.7.3. Floating VEB
    • 21.7.4. Dynamic Device Personalization (DDP)
    • 21.7.5. Input set configuration
    • 21.7.6. Queue region configuration
  • 21.8. Limitations or Known issues
    • 21.8.1. MPLS packet classification
    • 21.8.2. 16 Byte RX Descriptor setting on DPDK VF
    • 21.8.3. Receive packets with Ethertype 0x88A8
    • 21.8.4. Incorrect Rx statistics when packet is oversize
    • 21.8.5. VF & TC max bandwidth setting
    • 21.8.6. TC TX scheduling mode setting
    • 21.8.7. VF performance is impacted by PCI extended tag setting
    • 21.8.8. Vlan strip of VF
    • 21.8.9. DCB function
    • 21.8.10. Global configuration warning
  • 21.9. High Performance of Small Packets on 40GbE NIC
    • 21.9.1. Use 16 Bytes RX Descriptor Size
  • 21.10. Example of getting best performance with l3fwd example
    • 21.10.1. Tx bytes affected by the link status change
• 22. ICE Poll Mode Driver
  • 22.1. Prerequisites
  • 22.2. Pre-Installation Configuration
    • 22.2.1. Config File Options
    • 22.2.2. Runtime Config Options
  • 22.3. Driver compilation and testing
  • 22.4. Features
    • 22.4.1. Vector PMD
    • 22.4.2. Malicious driver detection (MDD)
  • 22.5. Sample Application Notes
    • 22.5.1. Vlan filter
  • 22.6. Limitations or Known issues
    • 22.6.1. 19.02 limitation
• 23. IFCVF vDPA driver
  • 23.1. Pre-Installation Configuration
    • 23.1.1. Config File Options
  • 23.2. IFCVF vDPA Implementation
    • 23.2.1. Key IFCVF vDPA driver ops
    • 23.2.2. To create a vhost port with IFC VF
  • 23.3. Features
  • 23.4. Prerequisites
  • 23.5. Limitations
    • 23.5.1. Dependency on vfio-pci
    • 23.5.2. Live Migration with VIRTIO_NET_F_GUEST_ANNOUNCE
• 24. IGB Poll Mode Driver
  • 24.1. Features
  • 24.2. Limitations or Known issues
  • 24.3. Supported Chipsets and NICs
• 25. IPN3KE Poll Mode Driver
  • 25.1. Prerequisites
  • 25.2. Pre-Installation Configuration
    • 25.2.1. Config File Options
    • 25.2.2. Runtime Config Options
  • 25.3. Driver compilation and testing
  • 25.4. Sample Application Notes
    • 25.4.1. Packet TX/RX with FPGA Pass-through image
    • 25.4.2. HQoS and flow acceleration
  • 25.5. Limitations or Known issues
    • 25.5.1. 19.05 limitation
• 26. IXGBE Driver
  • 26.1. Vector PMD for IXGBE
    • 26.1.1. RX Constraints
    • 26.1.2. TX Constraint
  • 26.2. Application Programming Interface
  • 26.3. Sample Application Notes
    • 26.3.1. l3fwd
    • 26.3.2. load_balancer
  • 26.4. Limitations or Known issues
    • 26.4.1. Malicious Driver Detection not Supported
    • 26.4.2. Statistics
    • 26.4.3. MTU setting
    • 26.4.4. VF MAC address setting
    • 26.4.5. X550 does not support legacy interrupt mode
  • 26.5. Inline crypto processing support
  • 26.6. Virtual Function Port Representors
  • 26.7. Supported Chipsets and NICs
• 27. Intel Virtual Function Driver
  • 27.1. SR-IOV Mode Utilization in a DPDK Environment
    • 27.1.1. Physical and Virtual Function Infrastructure
    • 27.1.2. Validated Hypervisors
    • 27.1.3. Expected Guest Operating System in Virtual Machine
  • 27.2. Setting Up a KVM Virtual Machine Monitor
  • 27.3. DPDK SR-IOV PMD PF/VF Driver Usage Model
    • 27.3.1. Fast Host-based Packet Processing
  • 27.4. SR-IOV (PF/VF) Approach for Inter-VM Communication
• 28. KNI Poll Mode Driver
  • 28.1. Usage
  • 28.2. Default interface configuration
  • 28.3. PMD arguments
  • 28.4. PMD log messages
  • 28.5. PMD testing
• 29. LiquidIO VF Poll Mode Driver
  • 29.1. Supported LiquidIO Adapters
  • 29.2. Pre-Installation Configuration
  • 29.3. SR-IOV: Prerequisites and Sample Application Notes
  • 29.4. Limitations
    • 29.4.1. VF MTU
    • 29.4.2. VLAN offload
    • 29.4.3. Ring size
    • 29.4.4. CRC striping
• 30. Memif Poll Mode Driver
  • 30.1. Shared memory
    • 30.1.1. Example: testpmd
    • 30.1.2. Example: testpmd and VPP
• 31. MLX4 poll mode driver library
  • 31.1. Implementation details
  • 31.2. Configuration
    • 31.2.1. Compilation options
    • 31.2.2. Environment variables
    • 31.2.3. Run-time configuration
    • 31.2.4. Kernel module parameters
  • 31.3. Limitations
  • 31.4. Prerequisites
    • 31.4.1. Current RDMA core package and Linux kernel (recommended)
    • 31.4.2. Mellanox OFED as a fallback
  • 31.5. Supported NICs
  • 31.6. Quick Start Guide
  • 31.7. Performance tuning
  • 31.8. Usage example
• 32. MLX5 poll mode driver
  • 32.1. Design
  • 32.2. Features
  • 32.3. Limitations
  • 32.4. Statistics
  • 32.5. Configuration
    • 32.5.1. Compilation options
    • 32.5.2. Environment variables
    • 32.5.3. Run-time configuration
    • 32.5.4. Firmware configuration
  • 32.6. Prerequisites
    • 32.6.1. Installation
  • 32.7. Supported NICs
  • 32.8. Quick Start Guide on OFED/EN
  • 32.9. Enable switchdev mode
  • 32.10. Performance tuning
  • 32.11. Supported hardware offloads
  • 32.12. Notes for testpmd
  • 32.13. Usage example
• 33. MVNETA Poll Mode Driver
  • 33.1. Features
  • 33.2. Limitations
  • 33.3. Prerequisites
  • 33.4. Pre-Installation Configuration
    • 33.4.1. Config File Options
    • 33.4.2. Runtime options
  • 33.5. Building DPDK
  • 33.6. Usage Example
• 34. MVPP2 Poll Mode Driver
  • 34.1. Features
  • 34.2. Limitations
  • 34.3. Prerequisites
  • 34.4. Config File Options
  • 34.5. Building DPDK
  • 34.6. Usage Example
  • 34.7. Extended stats
  • 34.8. QoS Configuration
    • 34.8.1. Configuration syntax
  • 34.9. Flow API
    • 34.9.1. Supported flow actions
    • 34.9.2. Supported flow items
    • 34.9.3. Classifier match engine
    • 34.9.4. Flow rules usage example
    • 34.9.5. Limitations
  • 34.10. Traffic metering and policing
    • 34.10.1. Limitations
    • 34.10.2. Usage example
  • 34.11. Traffic Management API
    • 34.11.1. Limitations
    • 34.11.2. Usage example
• 35. Netvsc poll mode driver
  • 35.1. Features and Limitations of Hyper-V PMD
  • 35.2. Installation
  • 35.3. Prerequisites
  • 35.4. Netvsc PMD arguments
• 36. NFB poll mode driver library
  • 36.1. Prerequisites
    • 36.1.1. Versions of the packages
  • 36.2. Configuration
  • 36.3. Using the NFB PMD
  • 36.4. NFB card architecture
  • 36.5. Limitations
  • 36.6. Example of usage
• 37. NFP poll mode driver library
  • 37.1. Dependencies
  • 37.2. Building the software
  • 37.3. Driver compilation and testing
  • 37.4. Using the PF
  • 37.5. PF multiport support
  • 37.6. PF multiprocess support
  • 37.7. System configuration
• 38. OCTEON TX Poll Mode driver
  • 38.1. Features
  • 38.2. Supported OCTEON TX SoCs
  • 38.3. Unsupported features
  • 38.4. Prerequisites
  • 38.5. Pre-Installation Configuration
    • 38.5.1. Config File Options
    • 38.5.2. Driver compilation and testing
  • 38.6. Initialization
    • 38.6.1. Device arguments
    • 38.6.2. Dependency
  • 38.7. Limitations
    • 38.7.1. octeontx_fpavf external mempool handler dependency
    • 38.7.2. CRC striping
    • 38.7.3. Maximum packet length
• 39. OCTEON TX2 Poll Mode driver
  • 39.1. Features
  • 39.2. Prerequisites
  • 39.3. Compile time Config Options
  • 39.4. Driver compilation and testing
  • 39.5. Runtime Config Options
  • 39.6. Limitations
    • 39.6.1. mempool_octeontx2 external mempool handler dependency
    • 39.6.2. CRC striping
  • 39.7. Debugging Options
  • 39.8. RTE Flow Support
• 40. QEDE Poll Mode Driver
  • 40.1. Supported Features
  • 40.2. Non-supported Features
  • 40.3. Co-existence considerations
  • 40.4. Supported QLogic Adapters
  • 40.5. Prerequisites
    • 40.5.1. Performance note
    • 40.5.2. Config File Options
  • 40.6. Driver compilation and testing
  • 40.7. SR-IOV: Prerequisites and Sample Application Notes
• 41. Solarflare libefx-based Poll Mode Driver
  • 41.1. Features
  • 41.2. Non-supported Features
  • 41.3. Limitations
    • 41.3.1. Equal stride super-buffer mode
  • 41.4. Tunnels support
  • 41.5. Flow API support
    • 41.5.1. Ethernet destination individual/group match
    • 41.5.2. Exceptions to flow rules
  • 41.6. Supported NICs
  • 41.7. Prerequisites
  • 41.8. Pre-Installation Configuration
    • 41.8.1. Config File Options
    • 41.8.2. Per-Device Parameters
    • 41.8.3. Dynamic Logging Parameters
• 42. Soft NIC Poll Mode Driver
  • 42.1. Flow
  • 42.2. Supported Operating Systems
  • 42.3. Build options
  • 42.4. Soft NIC PMD arguments
  • 42.5. Soft NIC testing
  • 42.6. Soft NIC Firmware
  • 42.7. QoS API Support:
  • 42.8. Flow API support:
    • 42.8.1. Example:
• 43. SZEDATA2 poll mode driver library
  • 43.1. Prerequisites
    • 43.1.1. Versions of the packages
  • 43.2. Configuration
  • 43.3. Using the SZEDATA2 PMD
  • 43.4. NFB card architecture
  • 43.5. Limitations
  • 43.6. Example of usage
• 44. Tun|Tap Poll Mode Driver
  • 44.1. Flow API support
    • 44.1.1. Examples of testpmd flow rules
  • 44.2. Multi-process sharing
  • 44.3. Example
  • 44.4. RSS specifics
  • 44.5. Systems supporting flow API
• 45. ThunderX NICVF Poll Mode Driver
  • 45.1. Features
  • 45.2. Supported ThunderX SoCs
  • 45.3. Prerequisites
  • 45.4. Pre-Installation Configuration
    • 45.4.1. Config File Options
  • 45.5. Driver compilation and testing
  • 45.6. Linux
    • 45.6.1. SR-IOV: Prerequisites and sample Application Notes
    • 45.6.2. Multiple Queue Set per DPDK port configuration
    • 45.6.3. Example device binding
  • 45.7. Module params
    • 45.7.1. skip_data_bytes
  • 45.8. Limitations
    • 45.8.1. CRC striping
    • 45.8.2. Maximum packet length
    • 45.8.3. Maximum packet segments
    • 45.8.4. skip_data_bytes
• 46. VDEV_NETVSC driver
  • 46.1. Implementation details
  • 46.2. Build options
  • 46.3. Run-time parameters
• 47. Poll Mode Driver for Emulated Virtio NIC
  • 47.1. Virtio Implementation in DPDK
  • 47.2. Features and Limitations of virtio PMD
  • 47.3. Prerequisites
  • 47.4. Virtio with kni vhost Back End
  • 47.5. Virtio with qemu virtio Back End
  • 47.6. Virtio PMD Rx/Tx Callbacks
  • 47.7. Interrupt mode
    • 47.7.1. Prerequisites for Rx interrupts
    • 47.7.2. Example
  • 47.8. Virtio PMD arguments
• 48. Poll Mode Driver that wraps vhost library
  • 48.1. Vhost Implementation in DPDK
  • 48.2. Features and Limitations of vhost PMD
  • 48.3. Vhost PMD arguments
  • 48.4. Vhost PMD event handling
  • 48.5. Vhost PMD with testpmd application
• 49. Poll Mode Driver for Paravirtual VMXNET3 NIC
  • 49.1. VMXNET3 Implementation in the DPDK
  • 49.2. Features and Limitations of VMXNET3 PMD
  • 49.3. Prerequisites
  • 49.4. VMXNET3 with a Native NIC Connected to a vSwitch
  • 49.5. VMXNET3 Chaining VMs Connected to a vSwitch
• 50. Libpcap and Ring Based Poll Mode Drivers
  • 50.1. Using the Drivers from the EAL Command Line
    • 50.1.1. Libpcap-based PMD
    • 50.1.2. Rings-based PMD
    • 50.1.3. Using the Poll Mode Driver from an Application
• 51. Fail-safe poll mode driver library
  • 51.1. Features
  • 51.2. Compilation option
  • 51.3. Using the Fail-safe PMD from the EAL command line
    • 51.3.1. Fail-safe command line parameters
    • 51.3.2. Usage example
  • 51.4. Using the Fail-safe PMD from an application
  • 51.5. Plug-in feature
  • 51.6. Plug-out feature
  • 51.7. Fail-safe glossary