9. CXGBE Poll Mode Driver

9.7.1. Config File Options

The following options can be modified in the .config file. Please note that enabling debugging options may affect system performance.

• CONFIG_RTE_LIBRTE_CXGBE_PMD (default y)

  Toggle compilation of librte_pmd_cxgbe driver.

  Note

  This controls compilation of both CXGBE and CXGBEVF PMD.

• CONFIG_RTE_LIBRTE_CXGBE_DEBUG (default n)

  Toggle display of generic debugging messages.

• CONFIG_RTE_LIBRTE_CXGBE_DEBUG_REG (default n)

  Toggle display of registers related run-time check messages.

• CONFIG_RTE_LIBRTE_CXGBE_DEBUG_MBOX (default n)

  Toggle display of firmware mailbox related run-time check messages.

• CONFIG_RTE_LIBRTE_CXGBE_DEBUG_TX (default n)

  Toggle display of transmission data path run-time check messages.

• CONFIG_RTE_LIBRTE_CXGBE_DEBUG_RX (default n)

  Toggle display of receiving data path run-time check messages.

• CONFIG_RTE_LIBRTE_CXGBE_TPUT (default y)

  Toggle behaviour to prefer Throughput or Latency.

9.7.2. Runtime Options

The following devargs options can be enabled at runtime. They must be passed as part of EAL arguments. For example,

testpmd -w 02:00.4,keep_ovlan=1 -- -i

• keep_ovlan (default 0)

  Toggle behaviour to keep/strip outer VLAN in Q-in-Q packets. If enabled, the outer VLAN tag is preserved in Q-in-Q packets. Otherwise, the outer VLAN tag is stripped in Q-in-Q packets.

• force_link_up (default 0)

  When set to 1, CXGBEVF PMD always forces link as up for all VFs on underlying Chelsio NICs. This enables multiple VFs on the same NIC to send traffic to each other even when the physical link is down.

9.9.1. Linux Installation

Steps to manually install the latest firmware from the downloaded Chelsio Unified Wire package for Linux operating system are as follows:

1. Load the kernel module:

   modprobe cxgb4
   

2. Use ifconfig to get the interface name assigned to Chelsio card:

   ifconfig -a | grep "00:07:43"
   

   Example output:

   p1p1      Link encap:Ethernet  HWaddr 00:07:43:2D:EA:C0
   p1p2      Link encap:Ethernet  HWaddr 00:07:43:2D:EA:C8
   

3. Install cxgbtool:

   cd <path_to_uwire>/tools/cxgbtool
   make install
   

4. Use cxgbtool to load the firmware config file onto the card:

   cxgbtool p1p1 loadcfg <path_to_uwire>/src/network/firmware/t5-config.txt
   

5. Use cxgbtool to load the firmware image onto the card:

   cxgbtool p1p1 loadfw <path_to_uwire>/src/network/firmware/t5fw-*.bin
   

6. Unload and reload the kernel module:

   modprobe -r cxgb4
   modprobe cxgb4
   

7. Verify with ethtool:

   ethtool -i p1p1 | grep "firmware"
   

   Example output:

   firmware-version: 1.17.14.0, TP 0.1.4.9
   

9.9.2. Running testpmd

This section demonstrates how to launch testpmd with Chelsio devices managed by librte_pmd_cxgbe in Linux operating system.

1. Load the kernel module:

   modprobe cxgb4
   

2. Get the PCI bus addresses of the interfaces bound to cxgb4 driver:

   dmesg | tail -2
   

   Example output:

   cxgb4 0000:02:00.4 p1p1: renamed from eth0
   cxgb4 0000:02:00.4 p1p2: renamed from eth1
   

   Note

   Both the interfaces of a Chelsio 2-port adapter are bound to the same PCI bus address.

3. Unload the kernel module:

   modprobe -ar cxgb4 csiostor
   

4. Running testpmd

   Follow instructions available in the document compiling and testing a PMD for a NIC to run testpmd.

   Note

   Currently, CXGBE PMD only supports the binding of PF4 for Chelsio NICs.

   Example output:

   [...]
   EAL: PCI device 0000:02:00.4 on NUMA socket -1
   EAL:   probe driver: 1425:5401 rte_cxgbe_pmd
   EAL:   PCI memory mapped at 0x7fd7c0200000
   EAL:   PCI memory mapped at 0x7fd77cdfd000
   EAL:   PCI memory mapped at 0x7fd7c10b7000
   PMD: rte_cxgbe_pmd: fw: 1.17.14.0, TP: 0.1.4.9
   PMD: rte_cxgbe_pmd: Coming up as MASTER: Initializing adapter
   Interactive-mode selected
   Configuring Port 0 (socket 0)
   Port 0: 00:07:43:2D:EA:C0
   Configuring Port 1 (socket 0)
   Port 1: 00:07:43:2D:EA:C8
   Checking link statuses...
   PMD: rte_cxgbe_pmd: Port0: passive DA port module inserted
   PMD: rte_cxgbe_pmd: Port1: passive DA port module inserted
   Port 0 Link Up - speed 10000 Mbps - full-duplex
   Port 1 Link Up - speed 10000 Mbps - full-duplex
   Done
   testpmd>
   

   Note

   Flow control pause TX/RX is disabled by default and can be enabled via testpmd. Refer section Enable/Disable Flow Control for more details.

9.9.3. Configuring SR-IOV Virtual Functions

This section demonstrates how to enable SR-IOV virtual functions on Chelsio NICs and demonstrates how to run testpmd with SR-IOV virtual functions.

1. Load the kernel module:

   modprobe cxgb4
   

2. Get the PCI bus addresses of the interfaces bound to cxgb4 driver:

   dmesg | tail -2
   

   Example output:

   cxgb4 0000:02:00.4 p1p1: renamed from eth0
   cxgb4 0000:02:00.4 p1p2: renamed from eth1
   

   Note

   Both the interfaces of a Chelsio 2-port adapter are bound to the same PCI bus address.

3. Use ifconfig to get the interface name assigned to Chelsio card:

   ifconfig -a | grep "00:07:43"
   

   Example output:

   p1p1      Link encap:Ethernet  HWaddr 00:07:43:2D:EA:C0
   p1p2      Link encap:Ethernet  HWaddr 00:07:43:2D:EA:C8
   

4. Bring up the interfaces:

   ifconfig p1p1 up
   ifconfig p1p2 up
   

5. Instantiate SR-IOV Virtual Functions. PF0..3 can be used for SR-IOV VFs. Multiple VFs can be instantiated on each of PF0..3. To instantiate one SR-IOV VF on each PF0 and PF1:

   echo 1 > /sys/bus/pci/devices/0000\:02\:00.0/sriov_numvfs
   echo 1 > /sys/bus/pci/devices/0000\:02\:00.1/sriov_numvfs
   

6. Get the PCI bus addresses of the virtual functions:

   lspci | grep -i "Chelsio" | grep -i "VF"
   

   Example output:

   02:01.0 Ethernet controller: Chelsio Communications Inc T540-CR Unified Wire Ethernet Controller [VF]
   02:01.1 Ethernet controller: Chelsio Communications Inc T540-CR Unified Wire Ethernet Controller [VF]
   

7. Running testpmd

   Follow instructions available in the document compiling and testing a PMD for a NIC to bind virtual functions and run testpmd.

   Example output:

   [...]
   EAL: PCI device 0000:02:01.0 on NUMA socket 0
   EAL:   probe driver: 1425:5803 net_cxgbevf
   PMD: rte_cxgbe_pmd: Firmware version: 1.17.14.0
   PMD: rte_cxgbe_pmd: TP Microcode version: 0.1.4.9
   PMD: rte_cxgbe_pmd: Chelsio rev 0
   PMD: rte_cxgbe_pmd: No bootstrap loaded
   PMD: rte_cxgbe_pmd: No Expansion ROM loaded
   PMD: rte_cxgbe_pmd:  0000:02:01.0 Chelsio rev 0 1G/10GBASE-SFP
   EAL: PCI device 0000:02:01.1 on NUMA socket 0
   EAL:   probe driver: 1425:5803 net_cxgbevf
   PMD: rte_cxgbe_pmd: Firmware version: 1.17.14.0
   PMD: rte_cxgbe_pmd: TP Microcode version: 0.1.4.9
   PMD: rte_cxgbe_pmd: Chelsio rev 0
   PMD: rte_cxgbe_pmd: No bootstrap loaded
   PMD: rte_cxgbe_pmd: No Expansion ROM loaded
   PMD: rte_cxgbe_pmd:  0000:02:01.1 Chelsio rev 0 1G/10GBASE-SFP
   Configuring Port 0 (socket 0)
   Port 0: 06:44:29:44:40:00
   Configuring Port 1 (socket 0)
   Port 1: 06:44:29:44:40:10
   Checking link statuses...
   Done
   testpmd>
   

9.10.1. FreeBSD Installation

Steps to manually install the latest firmware from the downloaded Chelsio Unified Wire package for FreeBSD operating system are as follows:

1. Load the kernel module:

   kldload if_cxgbe
   

2. Use dmesg to get the t5nex instance assigned to the Chelsio card:

   dmesg | grep "t5nex"
   

   Example output:

   t5nex0: <Chelsio T520-CR> irq 16 at device 0.4 on pci2
   cxl0: <port 0> on t5nex0
   cxl1: <port 1> on t5nex0
   t5nex0: PCIe x8, 2 ports, 14 MSI-X interrupts, 31 eq, 13 iq
   

   In the example above, a Chelsio T520-CR card is bound to a t5nex0 instance.

3. Install cxgbetool from FreeBSD source repository:

   cd <path_to_FreeBSD_source>/tools/tools/cxgbetool/
   make && make install
   

4. Use cxgbetool to load the firmware image onto the card:

   cxgbetool t5nex0 loadfw <path_to_uwire>/src/network/firmware/t5fw-*.bin
   

5. Unload and reload the kernel module:

   kldunload if_cxgbe
   kldload if_cxgbe
   

6. Verify with sysctl:

   sysctl -a | grep "t5nex" | grep "firmware"
   

   Example output:

   dev.t5nex.0.firmware_version: 1.17.14.0
   

9.10.2. Running testpmd

This section demonstrates how to launch testpmd with Chelsio devices managed by librte_pmd_cxgbe in FreeBSD operating system.

1. Change to DPDK source directory where the target has been compiled in section Driver compilation and testing:

   cd <DPDK-source-directory>
   

2. Copy the contigmem kernel module to /boot/kernel directory:

   cp x86_64-native-bsdapp-clang/kmod/contigmem.ko /boot/kernel/
   

3. Add the following lines to /boot/loader.conf:

   # reserve 2 x 1G blocks of contiguous memory using contigmem driver
   hw.contigmem.num_buffers=2
   hw.contigmem.buffer_size=1073741824
   # load contigmem module during boot process
   contigmem_load="YES"
   

   The above lines load the contigmem kernel module during boot process and allocate 2 x 1G blocks of contiguous memory to be used for DPDK later on. This is to avoid issues with potential memory fragmentation during later system up time, which may result in failure of allocating the contiguous memory required for the contigmem kernel module.

4. Restart the system and ensure the contigmem module is loaded successfully:

   reboot
   kldstat | grep "contigmem"
   

   Example output:

   2    1 0xffffffff817f1000 3118     contigmem.ko
   

5. Repeat step 1 to ensure that you are in the DPDK source directory.

6. Load the cxgbe kernel module:

   kldload if_cxgbe
   

7. Get the PCI bus addresses of the interfaces bound to t5nex driver:

   pciconf -l | grep "t5nex"
   

   Example output:

   t5nex0@pci0:2:0:4: class=0x020000 card=0x00001425 chip=0x54011425 rev=0x00
   

   In the above example, the t5nex0 is bound to 2:0:4 bus address.

   Note

   Both the interfaces of a Chelsio 2-port adapter are bound to the same PCI bus address.

8. Unload the kernel module:

   kldunload if_cxgbe
   

9. Set the PCI bus addresses to hw.nic_uio.bdfs kernel environment parameter:

   kenv hw.nic_uio.bdfs="2:0:4"
   

   This automatically binds 2:0:4 to nic_uio kernel driver when it is loaded in the next step.

   Note

   Currently, CXGBE PMD only supports the binding of PF4 for Chelsio NICs.

10. Load nic_uio kernel driver:

    kldload ./x86_64-native-bsdapp-clang/kmod/nic_uio.ko
    

11. Start testpmd with basic parameters:

    ./x86_64-native-bsdapp-clang/app/testpmd -l 0-3 -n 4 -w 0000:02:00.4 -- -i
    

    Example output:

    [...]
    EAL: PCI device 0000:02:00.4 on NUMA socket 0
    EAL:   probe driver: 1425:5401 rte_cxgbe_pmd
    EAL:   PCI memory mapped at 0x8007ec000
    EAL:   PCI memory mapped at 0x842800000
    EAL:   PCI memory mapped at 0x80086c000
    PMD: rte_cxgbe_pmd: fw: 1.17.14.0, TP: 0.1.4.9
    PMD: rte_cxgbe_pmd: Coming up as MASTER: Initializing adapter
    Interactive-mode selected
    Configuring Port 0 (socket 0)
    Port 0: 00:07:43:2D:EA:C0
    Configuring Port 1 (socket 0)
    Port 1: 00:07:43:2D:EA:C8
    Checking link statuses...
    PMD: rte_cxgbe_pmd: Port0: passive DA port module inserted
    PMD: rte_cxgbe_pmd: Port1: passive DA port module inserted
    Port 0 Link Up - speed 10000 Mbps - full-duplex
    Port 1 Link Up - speed 10000 Mbps - full-duplex
    Done
    testpmd>
    

9.11.1. Enable/Disable Flow Control

Flow control pause TX/RX is disabled by default and can be enabled via testpmd as follows:

testpmd> set flow_ctrl rx on tx on 0 0 0 0 mac_ctrl_frame_fwd off autoneg on 0
testpmd> set flow_ctrl rx on tx on 0 0 0 0 mac_ctrl_frame_fwd off autoneg on 1

To disable again, run:

testpmd> set flow_ctrl rx off tx off 0 0 0 0 mac_ctrl_frame_fwd off autoneg off 0
testpmd> set flow_ctrl rx off tx off 0 0 0 0 mac_ctrl_frame_fwd off autoneg off 1

9.11.2. Jumbo Mode

There are two ways to enable sending and receiving of jumbo frames via testpmd. One method involves using the mtu command, which changes the mtu of an individual port without having to stop the selected port. Another method involves stopping all the ports first and then running max-pkt-len command to configure the mtu of all the ports with a single command.

• To configure each port individually, run the mtu command as follows:

  testpmd> port config mtu 0 9000
  testpmd> port config mtu 1 9000
  

• To configure all the ports at once, stop all the ports first and run the max-pkt-len command as follows:

  testpmd> port stop all
  testpmd> port config all max-pkt-len 9000