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. Free Tx mbuf on demand
- 2.9. Queue start/stop
- 2.10. MTU update
- 2.11. Jumbo frame
- 2.12. Scattered Rx
- 2.13. LRO
- 2.14. TSO
- 2.15. Promiscuous mode
- 2.16. Allmulticast mode
- 2.17. Unicast MAC filter
- 2.18. Multicast MAC filter
- 2.19. RSS hash
- 2.20. RSS key update
- 2.21. RSS reta update
- 2.22. VMDq
- 2.23. SR-IOV
- 2.24. DCB
- 2.25. VLAN filter
- 2.26. Ethertype filter
- 2.27. N-tuple filter
- 2.28. SYN filter
- 2.29. Tunnel filter
- 2.30. Flexible filter
- 2.31. Hash filter
- 2.32. Flow director
- 2.33. Flow control
- 2.34. Flow API
- 2.35. Rate limitation
- 2.36. Traffic mirroring
- 2.37. CRC offload
- 2.38. VLAN offload
- 2.39. QinQ offload
- 2.40. L3 checksum offload
- 2.41. L4 checksum offload
- 2.42. MACsec offload
- 2.43. Inner L3 checksum
- 2.44. Inner L4 checksum
- 2.45. Packet type parsing
- 2.46. Timesync
- 2.47. Rx descriptor status
- 2.48. Tx descriptor status
- 2.49. Basic stats
- 2.50. Extended stats
- 2.51. Stats per queue
- 2.52. FW version
- 2.53. EEPROM dump
- 2.54. Registers dump
- 2.55. LED
- 2.56. Multiprocess aware
- 2.57. BSD nic_uio
- 2.58. Linux UIO
- 2.59. Linux VFIO
- 2.60. Other kdrv
- 2.61. ARMv7
- 2.62. ARMv8
- 2.63. Power8
- 2.64. x86-32
- 2.65. x86-64
- 2.66. Usage doc
- 2.67. Design doc
- 2.68. Perf doc
- 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. ARK Poll Mode Driver
- 4.1. Overview
- 4.2. Device Parameters
- 4.3. Data Path Interface
- 4.4. Configuration Information
- 4.5. Building DPDK
- 4.6. Supported ARK RTL PCIe Instances
- 4.7. Supported Operating Systems
- 4.8. Supported Features
- 4.9. Unsupported Features
- 4.10. Pre-Requisites
- 4.11. Usage Example
5. AVP Poll Mode Driver
- 5.1. Features and Limitations of the AVP PMD
- 5.2. Prerequisites
- 5.3. Launching a VM with an AVP type network attachment
6. BNX2X Poll Mode Driver
- 6.1. Supported Features
- 6.2. Non-supported Features
- 6.3. Co-existence considerations
- 6.4. Supported QLogic NICs
- 6.5. Prerequisites
- 6.6. Pre-Installation Configuration
  - 6.6.1. Config File Options
- 6.7. Driver compilation and testing
- 6.8. SR-IOV: Prerequisites and sample Application Notes
7. BNXT Poll Mode Driver
- 7.1. Limitations
8. CXGBE Poll Mode Driver
- 8.1. Features
- 8.2. Limitations
- 8.3. Supported Chelsio T5 NICs
- 8.4. Supported Chelsio T6 NICs
- 8.5. Prerequisites
- 8.6. Pre-Installation Configuration
  - 8.6.1. Config File Options
- 8.7. Driver compilation and testing
- 8.8. Linux
  - 8.8.1. Linux Installation
  - 8.8.2. Running testpmd
- 8.9. FreeBSD
  - 8.9.1. FreeBSD Installation
  - 8.9.2. Running testpmd
- 8.10. Sample Application Notes
  - 8.10.1. Enable/Disable Flow Control
  - 8.10.2. Jumbo Mode
9. DPAA2 Poll Mode Driver
- 9.1. NXP DPAA2 (Data Path Acceleration Architecture Gen2)
- 9.2. DPAA2 DPDK - Poll Mode Driver Overview
- 9.3. Supported DPAA2 SoCs
- 9.4. Prerequisites
- 9.5. Pre-Installation Configuration
  - 9.5.1. Config File Options
- 9.6. Driver compilation and testing
- 9.7. Limitations
10. Driver for VM Emulated Devices
- 10.1. Validated Hypervisors
- 10.2. Recommended Guest Operating System in Virtual Machine
- 10.3. Setting Up a KVM Virtual Machine
- 10.4. Known Limitations of Emulated Devices
11. ENA Poll Mode Driver
- 11.1. Overview
- 11.2. Management Interface
- 11.3. Data Path Interface
- 11.4. Configuration information
- 11.5. Building DPDK
- 11.6. Supported ENA adapters
- 11.7. Supported Operating Systems
- 11.8. Supported features
- 11.9. Unsupported features
- 11.10. Prerequisites
- 11.11. Usage example
12. ENIC Poll Mode Driver
- 12.1. How to obtain ENIC PMD integrated DPDK
- 12.2. Configuration information
- 12.3. Flow director support
- 12.4. SR-IOV mode utilization
- 12.5. Generic Flow API support
- 12.6. Limitations
- 12.7. How to build the suite
- 12.8. Supported Cisco VIC adapters
- 12.9. Supported Operating Systems
- 12.10. Supported features
- 12.11. Known bugs and unsupported features in this release
- 12.12. Prerequisites
- 12.13. Additional Reference
- 12.14. Contact Information
13. FM10K Poll Mode Driver
- 13.1. FTAG Based Forwarding of FM10K
- 13.2. Vector PMD for FM10K
  - 13.2.1. RX Constraints
  - 13.2.2. TX Constraint
- 13.3. Limitations
14. I40E Poll Mode Driver
- 14.1. Features
- 14.2. Prerequisites
- 14.3. Pre-Installation Configuration
  - 14.3.1. Config File Options
- 14.4. Driver compilation and testing
- 14.5. SR-IOV: Prerequisites and sample Application Notes
- 14.6. Sample Application Notes
- 14.7. Limitations or Known issues
- 14.8. High Performance of Small Packets on 40G NIC
  - 14.8.1. Use 16 Bytes RX Descriptor Size
  - 14.8.2. High Performance and per Packet Latency Tradeoff
- 14.9. Example of getting best performance with l3fwd example
15. IXGBE Driver
- 15.1. Vector PMD for IXGBE
  - 15.1.1. RX Constraints
  - 15.1.2. TX Constraint
- 15.2. Application Programming Interface
- 15.3. Sample Application Notes
  - 15.3.1. l3fwd
  - 15.3.2. load_balancer
- 15.4. Limitations or Known issues
- 15.5. Supported Chipsets and NICs
16. I40E/IXGBE/IGB Virtual Function Driver
- 16.1. SR-IOV Mode Utilization in a DPDK Environment
- 16.2. Setting Up a KVM Virtual Machine Monitor
- 16.3. DPDK SR-IOV PMD PF/VF Driver Usage Model
  - 16.3.1. Fast Host-based Packet Processing
- 16.4. SR-IOV (PF/VF) Approach for Inter-VM Communication
17. KNI Poll Mode Driver
- 17.1. Usage
- 17.2. Default interface configuration
- 17.3. PMD arguments
- 17.4. PMD log messages
- 17.5. PMD testing
18. LiquidIO VF Poll Mode Driver
- 18.1. Supported LiquidIO Adapters
- 18.2. Pre-Installation Configuration
- 18.3. SR-IOV: Prerequisites and Sample Application Notes
- 18.4. Limitations
19. MLX4 poll mode driver library
- 19.1. Implementation details
- 19.2. Features
- 19.3. Limitations
- 19.4. Configuration
- 19.5. Prerequisites
  - 19.5.1. Getting Mellanox OFED
- 19.6. Supported NICs
- 19.7. Quick Start Guide
- 19.8. Performance tuning
- 19.9. Usage example
20. MLX5 poll mode driver
- 20.1. Implementation details
- 20.2. Features
- 20.3. Limitations
- 20.4. Configuration
- 20.5. Prerequisites
  - 20.5.1. Getting Mellanox OFED
- 20.6. Supported NICs
- 20.7. Quick Start Guide
- 20.8. Performance tuning
- 20.9. Notes for testpmd
- 20.10. Usage example
21. NFP poll mode driver library
- 21.1. Dependencies
- 21.2. Building the software
- 21.3. Driver compilation and testing
- 21.4. System configuration
22. QEDE Poll Mode Driver
- 22.1. Supported Features
- 22.2. Non-supported Features
- 22.3. Supported QLogic Adapters
- 22.4. Prerequisites
  - 22.4.1. Performance note
  - 22.4.2. Config File Options
- 22.5. Driver compilation and testing
- 22.6. SR-IOV: Prerequisites and Sample Application Notes
23. Solarflare libefx-based Poll Mode Driver
- 23.1. Features
- 23.2. Non-supported Features
- 23.3. Limitations
- 23.4. Flow API support
  - 23.4.1. Ethernet destinaton individual/group match
- 23.5. Supported NICs
- 23.6. Prerequisites
- 23.7. Pre-Installation Configuration
  - 23.7.1. Config File Options
  - 23.7.2. Per-Device Parameters
24. SZEDATA2 poll mode driver library
- 24.1. Prerequisites
- 24.2. Configuration
- 24.3. Using the SZEDATA2 PMD
- 24.4. Example of usage
25. Tun/Tap Poll Mode Driver
- 25.1. Flow API support
  - 25.1.1. Examples of testpmd flow rules
- 25.2. Example
26. ThunderX NICVF Poll Mode Driver
- 26.1. Features
- 26.2. Supported ThunderX SoCs
- 26.3. Prerequisites
- 26.4. Pre-Installation Configuration
  - 26.4.1. Config File Options
- 26.5. Driver compilation and testing
- 26.6. Linux
- 26.7. Limitations
27. Poll Mode Driver for Emulated Virtio NIC
- 27.1. Virtio Implementation in DPDK
- 27.2. Features and Limitations of virtio PMD
- 27.3. Prerequisites
- 27.4. Virtio with kni vhost Back End
- 27.5. Virtio with qemu virtio Back End
- 27.6. Virtio PMD Rx/Tx Callbacks
- 27.7. Interrupt mode
  - 27.7.1. Prerequisites for Rx interrupts
  - 27.7.2. Example
28. Poll Mode Driver that wraps vhost library
- 28.1. Vhost Implementation in DPDK
- 28.2. Features and Limitations of vhost PMD
- 28.3. Vhost PMD arguments
- 28.4. Vhost PMD event handling
- 28.5. Vhost PMD with testpmd application
29. Poll Mode Driver for Paravirtual VMXNET3 NIC
- 29.1. VMXNET3 Implementation in the DPDK
- 29.2. Features and Limitations of VMXNET3 PMD
- 29.3. Prerequisites
- 29.4. VMXNET3 with a Native NIC Connected to a vSwitch
- 29.5. VMXNET3 Chaining VMs Connected to a vSwitch
30. Libpcap and Ring Based Poll Mode Drivers
- 30.1. Using the Drivers from the EAL Command Line
31. Fail-safe poll mode driver library
- 31.1. Features
- 31.2. Compilation option
- 31.3. Using the Fail-safe PMD from the EAL command line
  - 31.3.1. Fail-safe command line parameters
  - 31.3.2. Usage example
- 31.4. Using the Fail-safe PMD from an application
- 31.5. Plug-in feature
- 31.6. Plug-out feature
- 31.7. Fail-safe glossary

Figures

Fig. 16.2 Virtualization for a Single Port NIC in SR-IOV Mode

Fig. 16.3 Performance Benchmark Setup

Fig. 16.4 Fast Host-based Packet Processing

Fig. 16.5 Inter-VM Communication

Fig. 27.15 Host2VM Communication Example Using kni vhost Back End

Fig. 27.17 Host2VM Communication Example Using qemu vhost Back End

Fig. 29.1 Assigning a VMXNET3 interface to a VM using VMware vSphere Client

Fig. 29.2 VMXNET3 with a Native NIC Connected to a vSwitch

Fig. 29.3 VMXNET3 Chaining VMs Connected to a vSwitch