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. Ethertype filter
- 2.29. N-tuple filter
- 2.30. SYN filter
- 2.31. Tunnel filter
- 2.32. Flexible filter
- 2.33. Hash filter
- 2.34. Flow director
- 2.35. Flow control
- 2.36. Flow API
- 2.37. Rate limitation
- 2.38. Traffic mirroring
- 2.39. Inline crypto
- 2.40. CRC offload
- 2.41. VLAN offload
- 2.42. QinQ offload
- 2.43. L3 checksum offload
- 2.44. L4 checksum offload
- 2.45. Timestamp offload
- 2.46. MACsec offload
- 2.47. Inner L3 checksum
- 2.48. Inner L4 checksum
- 2.49. Packet type parsing
- 2.50. Timesync
- 2.51. Rx descriptor status
- 2.52. Tx descriptor status
- 2.53. Basic stats
- 2.54. Extended stats
- 2.55. Stats per queue
- 2.56. FW version
- 2.57. EEPROM dump
- 2.58. Module EEPROM dump
- 2.59. Registers dump
- 2.60. LED
- 2.61. Multiprocess aware
- 2.62. BSD nic_uio
- 2.63. Linux UIO
- 2.64. Linux VFIO
- 2.65. Other kdrv
- 2.66. ARMv7
- 2.67. ARMv8
- 2.68. Power8
- 2.69. x86-32
- 2.70. x86-64
- 2.71. Usage doc
- 2.72. Design doc
- 2.73. Perf doc
- 2.74. Runtime Rx queue setup
- 2.75. Runtime Tx queue setup
- 2.76. 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. ARK Poll Mode Driver
- 5.1. Overview
- 5.2. Device Parameters
- 5.3. Data Path Interface
- 5.4. Configuration Information
- 5.5. Building DPDK
- 5.6. Supported ARK RTL PCIe Instances
- 5.7. Supported Operating Systems
- 5.8. Supported Features
- 5.9. Unsupported Features
- 5.10. Pre-Requisites
- 5.11. Usage Example
6. Aquantia Atlantic DPDK Driver
- 6.1. Supported features
- 6.2. Configuration Information
7. AVP Poll Mode Driver
- 7.1. Features and Limitations of the AVP PMD
- 7.2. Prerequisites
- 7.3. Launching a VM with an AVP type network attachment
8. AXGBE Poll Mode Driver
- 8.1. Supported Features
- 8.2. Configuration Information
- 8.3. Building DPDK
- 8.4. Prerequisites and Pre-conditions
- 8.5. Usage Example
9. BNX2X Poll Mode Driver
- 9.1. Supported Features
- 9.2. Non-supported Features
- 9.3. Co-existence considerations
- 9.4. Supported QLogic NICs
- 9.5. Prerequisites
- 9.6. Pre-Installation Configuration
  - 9.6.1. Config File Options
- 9.7. Driver compilation and testing
- 9.8. SR-IOV: Prerequisites and sample Application Notes
10. BNXT Poll Mode Driver
- 10.1. Limitations
11. CXGBE Poll Mode Driver
- 11.1. Features
- 11.2. Limitations
- 11.3. Supported Chelsio T5 NICs
- 11.4. Supported Chelsio T6 NICs
- 11.5. Supported SR-IOV Chelsio NICs
- 11.6. Prerequisites
- 11.7. Pre-Installation Configuration
  - 11.7.1. Config File Options
  - 11.7.2. Runtime Options
- 11.8. Driver compilation and testing
- 11.9. Linux
- 11.10. FreeBSD
  - 11.10.1. FreeBSD Installation
  - 11.10.2. Running testpmd
- 11.11. Sample Application Notes
  - 11.11.1. Enable/Disable Flow Control
  - 11.11.2. Jumbo Mode
12. DPAA Poll Mode Driver
- 12.1. NXP DPAA (Data Path Acceleration Architecture - Gen 1)
  - 12.1.1. DPAA Overview
- 12.2. DPAA DPDK - Poll Mode Driver Overview
- 12.3. Whitelisting & Blacklisting
- 12.4. Supported DPAA SoCs
- 12.5. Prerequisites
- 12.6. Pre-Installation Configuration
  - 12.6.1. Config File Options
  - 12.6.2. Environment Variables
- 12.7. Driver compilation and testing
- 12.8. Limitations
13. DPAA2 Poll Mode Driver
- 13.1. NXP DPAA2 (Data Path Acceleration Architecture Gen2)
- 13.2. DPAA2 DPDK - Poll Mode Driver Overview
- 13.3. Supported DPAA2 SoCs
- 13.4. Prerequisites
- 13.5. Pre-Installation Configuration
  - 13.5.1. Config File Options
- 13.6. Driver compilation and testing
- 13.7. Enabling logs
- 13.8. Whitelisting & Blacklisting
- 13.9. Limitations
14. Driver for VM Emulated Devices
- 14.1. Validated Hypervisors
- 14.2. Recommended Guest Operating System in Virtual Machine
- 14.3. Setting Up a KVM Virtual Machine
- 14.4. Known Limitations of Emulated Devices
15. ENA Poll Mode Driver
- 15.1. Overview
- 15.2. Management Interface
- 15.3. Data Path Interface
- 15.4. Configuration information
- 15.5. Building DPDK
- 15.6. Supported ENA adapters
- 15.7. Supported Operating Systems
- 15.8. Supported features
- 15.9. Prerequisites
- 15.10. Usage example
16. ENETC Poll Mode Driver
- 16.1. ENETC
17. ENIC Poll Mode Driver
- 17.1. How to obtain ENIC PMD integrated DPDK
- 17.2. Configuration information
- 17.3. Flow director support
- 17.4. SR-IOV mode utilization
- 17.5. Generic Flow API support
- 17.6. Overlay Offload
- 17.7. Ingress VLAN Rewrite
- 17.8. Vectorized Rx Handler
- 17.9. Limitations
- 17.10. How to build the suite
- 17.11. Supported Cisco VIC adapters
- 17.12. Supported Operating Systems
- 17.13. Supported features
- 17.14. Known bugs and unsupported features in this release
- 17.15. Prerequisites
- 17.16. Additional Reference
- 17.17. Contact Information
18. FM10K Poll Mode Driver
- 18.1. FTAG Based Forwarding of FM10K
- 18.2. Vector PMD for FM10K
  - 18.2.1. RX Constraints
  - 18.2.2. TX Constraint
- 18.3. Limitations
19. I40E Poll Mode Driver
- 19.1. Features
- 19.2. Prerequisites
- 19.3. Recommended Matching List
- 19.4. Pre-Installation Configuration
- 19.5. Driver compilation and testing
- 19.6. SR-IOV: Prerequisites and sample Application Notes
- 19.7. Sample Application Notes
- 19.8. Limitations or Known issues
- 19.9. High Performance of Small Packets on 40GbE NIC
  - 19.9.1. Use 16 Bytes RX Descriptor Size
- 19.10. Example of getting best performance with l3fwd example
20. ICE Poll Mode Driver
- 20.1. Prerequisites
- 20.2. Pre-Installation Configuration
  - 20.2.1. Config File Options
  - 20.2.2. Runtime Config Options
- 20.3. Driver compilation and testing
- 20.4. Sample Application Notes
  - 20.4.1. Vlan filter
- 20.5. Limitations or Known issues
21. IFCVF vDPA driver
- 21.1. Pre-Installation Configuration
  - 21.1.1. Config File Options
- 21.2. IFCVF vDPA Implementation
  - 21.2.1. Key IFCVF vDPA driver ops
  - 21.2.2. To create a vhost port with IFC VF
- 21.3. Features
- 21.4. Prerequisites
- 21.5. Limitations
  - 21.5.1. Dependency on vfio-pci
  - 21.5.2. Live Migration with VIRTIO_NET_F_GUEST_ANNOUNCE
22. IGB Poll Mode Driver
- 22.1. Features
- 22.2. Limitations or Known issues
- 22.3. Supported Chipsets and NICs
23. IXGBE Driver
- 23.1. Vector PMD for IXGBE
  - 23.1.1. RX Constraints
  - 23.1.2. TX Constraint
- 23.2. Application Programming Interface
- 23.3. Sample Application Notes
  - 23.3.1. l3fwd
  - 23.3.2. load_balancer
- 23.4. Limitations or Known issues
- 23.5. Inline crypto processing support
- 23.6. Virtual Function Port Representors
- 23.7. Supported Chipsets and NICs
24. Intel Virtual Function Driver
- 24.1. SR-IOV Mode Utilization in a DPDK Environment
- 24.2. Setting Up a KVM Virtual Machine Monitor
- 24.3. DPDK SR-IOV PMD PF/VF Driver Usage Model
  - 24.3.1. Fast Host-based Packet Processing
- 24.4. SR-IOV (PF/VF) Approach for Inter-VM Communication
25. KNI Poll Mode Driver
- 25.1. Usage
- 25.2. Default interface configuration
- 25.3. PMD arguments
- 25.4. PMD log messages
- 25.5. PMD testing
26. LiquidIO VF Poll Mode Driver
- 26.1. Supported LiquidIO Adapters
- 26.2. Pre-Installation Configuration
- 26.3. SR-IOV: Prerequisites and Sample Application Notes
- 26.4. Limitations
27. MLX4 poll mode driver library
- 27.1. Implementation details
- 27.2. Configuration
- 27.3. Limitations
- 27.4. Prerequisites
  - 27.4.1. Current RDMA core package and Linux kernel (recommended)
  - 27.4.2. Mellanox OFED as a fallback
- 27.5. Supported NICs
- 27.6. Quick Start Guide
- 27.7. Performance tuning
- 27.8. Usage example
28. MLX5 poll mode driver
- 28.1. Implementation details
- 28.2. Features
- 28.3. Limitations
- 28.4. Statistics
- 28.5. Configuration
- 28.6. Prerequisites
  - 28.6.1. Installation
- 28.7. Supported NICs
- 28.8. Quick Start Guide on OFED
- 28.9. Performance tuning
- 28.10. Notes for testpmd
- 28.11. Usage example
29. MVNETA Poll Mode Driver
- 29.1. Features
- 29.2. Limitations
- 29.3. Prerequisites
- 29.4. Pre-Installation Configuration
  - 29.4.1. Config File Options
  - 29.4.2. Runtime options
- 29.5. Building DPDK
- 29.6. Usage Example
30. MVPP2 Poll Mode Driver
- 30.1. Features
- 30.2. Limitations
- 30.3. Prerequisites
- 30.4. Config File Options
- 30.5. Building DPDK
- 30.6. Usage Example
- 30.7. Extended stats
- 30.8. QoS Configuration
  - 30.8.1. Configuration syntax
- 30.9. Flow API
- 30.10. Traffic metering and policing
  - 30.10.1. Limitations
  - 30.10.2. Usage example
- 30.11. Traffic Management API
  - 30.11.1. Limitations
  - 30.11.2. Usage example
31. Netvsc poll mode driver
- 31.1. Features and Limitations of Hyper-V PMD
- 31.2. Installation
- 31.3. Prerequisites
- 31.4. Netvsc PMD arguments
32. NFP poll mode driver library
- 32.1. Dependencies
- 32.2. Building the software
- 32.3. Driver compilation and testing
- 32.4. Using the PF
- 32.5. PF multiport support
- 32.6. PF multiprocess support
- 32.7. System configuration
33. OCTEON TX Poll Mode driver
- 33.1. Features
- 33.2. Supported OCTEON TX SoCs
- 33.3. Unsupported features
- 33.4. Prerequisites
- 33.5. Pre-Installation Configuration
  - 33.5.1. Config File Options
  - 33.5.2. Driver compilation and testing
- 33.6. Initialization
  - 33.6.1. Device arguments
  - 33.6.2. Dependency
- 33.7. Limitations
34. QEDE Poll Mode Driver
- 34.1. Supported Features
- 34.2. Non-supported Features
- 34.3. Co-existence considerations
- 34.4. Supported QLogic Adapters
- 34.5. Prerequisites
  - 34.5.1. Performance note
  - 34.5.2. Config File Options
- 34.6. Driver compilation and testing
- 34.7. SR-IOV: Prerequisites and Sample Application Notes
35. Solarflare libefx-based Poll Mode Driver
- 35.1. Features
- 35.2. Non-supported Features
- 35.3. Limitations
  - 35.3.1. Equal stride super-buffer mode
- 35.4. Tunnels support
- 35.5. Flow API support
  - 35.5.1. Ethernet destinaton individual/group match
  - 35.5.2. Exceptions to flow rules
- 35.6. Supported NICs
- 35.7. Prerequisites
- 35.8. Pre-Installation Configuration
36. Soft NIC Poll Mode Driver
- 36.1. Flow
- 36.2. Supported Operating Systems
- 36.3. Build options
- 36.4. Soft NIC PMD arguments
- 36.5. Soft NIC testing
- 36.6. Soft NIC Firmware
- 36.7. QoS API Support:
- 36.8. Flow API support:
  - 36.8.1. Example:
37. SZEDATA2 poll mode driver library
- 37.1. Prerequisites
  - 37.1.1. Versions of the packages
- 37.2. Configuration
- 37.3. Using the SZEDATA2 PMD
- 37.4. NFB card architecture
- 37.5. Limitations
- 37.6. Example of usage
38. Tun|Tap Poll Mode Driver
- 38.1. Flow API support
  - 38.1.1. Examples of testpmd flow rules
- 38.2. Multi-process sharing
- 38.3. Example
- 38.4. RSS specifics
- 38.5. Systems supporting flow API
39. ThunderX NICVF Poll Mode Driver
- 39.1. Features
- 39.2. Supported ThunderX SoCs
- 39.3. Prerequisites
- 39.4. Pre-Installation Configuration
  - 39.4.1. Config File Options
- 39.5. Driver compilation and testing
- 39.6. Linux
- 39.7. Module params
  - 39.7.1. skip_data_bytes
- 39.8. Limitations
40. VDEV_NETVSC driver
- 40.1. Implementation details
- 40.2. Build options
- 40.3. Run-time parameters
41. Poll Mode Driver for Emulated Virtio NIC
- 41.1. Virtio Implementation in DPDK
- 41.2. Features and Limitations of virtio PMD
- 41.3. Prerequisites
- 41.4. Virtio with kni vhost Back End
- 41.5. Virtio with qemu virtio Back End
- 41.6. Virtio PMD Rx/Tx Callbacks
- 41.7. Interrupt mode
  - 41.7.1. Prerequisites for Rx interrupts
  - 41.7.2. Example
- 41.8. Virtio PMD arguments
42. Poll Mode Driver that wraps vhost library
- 42.1. Vhost Implementation in DPDK
- 42.2. Features and Limitations of vhost PMD
- 42.3. Vhost PMD arguments
- 42.4. Vhost PMD event handling
- 42.5. Vhost PMD with testpmd application
43. Poll Mode Driver for Paravirtual VMXNET3 NIC
- 43.1. VMXNET3 Implementation in the DPDK
- 43.2. Features and Limitations of VMXNET3 PMD
- 43.3. Prerequisites
- 43.4. VMXNET3 with a Native NIC Connected to a vSwitch
- 43.5. VMXNET3 Chaining VMs Connected to a vSwitch
44. Libpcap and Ring Based Poll Mode Drivers
- 44.1. Using the Drivers from the EAL Command Line
45. Fail-safe poll mode driver library
- 45.1. Features
- 45.2. Compilation option
- 45.3. Using the Fail-safe PMD from the EAL command line
  - 45.3.1. Fail-safe command line parameters
  - 45.3.2. Usage example
- 45.4. Using the Fail-safe PMD from an application
- 45.5. Plug-in feature
- 45.6. Plug-out feature
- 45.7. Fail-safe glossary