Toshiba Electronic Devices & Storage Corporation TC956X PCIe Ethernet Host Driver

Release Date: 22 Jul 2021

Release Version: V_01-00-05 : Limited-tested version

TC956X PCIe EMAC driver is based on "Fedora 30, kernel-5.4.19".

Compilation & Run: Need to be root user to execute the following steps.

Execute following commands:

#make clean

#make
By default, DMA_OFFLOAD_ENABLE is disabled. If IPA offload is needed, enable macro DMA_OFFLOAD_ENABLE in tc956xmac.h and execute following commands:

#make clean

#make DMA_OFFLOAD=1
Load phylink module

#modprobe phylink
Load the driver

#insmod tc956x_pcie_eth.ko tc956x_speed=X

In the module parameter tc956x_speed, X is the desired PCIe Gen speed. X can be 3 or 2 or 1. Passing module parameter (tc956x_speed=X) is optional. If module parameter is not passed, by default Gen3 speed will be selected by the driver.
Remove the driver

#rmmod tc956x_pcie_eth

Release Versions:

TC956X_Host_Driver_20210326_V_01-00:

Initial Version

TC956X_Host_Driver_20210705_V_01-00-01:

Used Systick handler instead of Driver kernel timer to process transmitted Tx descriptors.
XFI interface supported and added module parameters for selection of Port0 and Port1 interface
kernel_read API replaced with kernel_read_file_from_path API
sprintf, vsprintf APIs replaced with vcnsprintf or vcnsprintf APIs
API to print IPA DMA channel statistics supported
Correction of print statement about selection of C45 PHY for Port0 interface

TC956X_Host_Driver_20210705_V_01-00-02:

XFI interface supported through compile time macro.
Removed module parameters for selection of Port0 and Port1 interface
Debugfs support for IPA statistics

TC956X_Host_Driver_20210720_V_01-00-03:

Debugfs not supported for IPA statistics
Default Port1 interface selected as SGMII

TC956X_Host_Driver_20210722_V_01-00-04:

Module parameters for selection of Port0 and Port1 interface

TC956X_Host_Driver_20210722_V_01-00-05:

Dynamic CM3 TAMAP configuration

Note:

Use below commands to advertise with Autonegotiation ON for speeds 10Gbps, 5Gbps, 2.5Gbps, 1Gbps, 100Mbps and 10Mbps as ethtool speed command does not support.

ethtool -s advertise 0x1000 autoneg on --> changes the advertisement to 10Gbps

ethtool -s advertise 0x1000000000000 autoneg on --> changes the advertisement to 5Gbps

ethtool -s advertise 0x800000000000 autoneg on --> changes the advertisement to 2.5Gbps

ethtool -s advertise 0x020 autoneg on --> changes the advertisement to 1Gbps

ethtool -s advertise 0x008 autoneg on --> changes the advertisement to 100Mbps

ethtool -s advertise 0x002 autoneg on --> changes the advertisement 10Mbps

Use the below command to insert the kernel module with specific modes for interfaces:

#insmod tc956x_pcie_eth.ko tc956x_port0_interface=x tc956x_port1_interface=y

argument info:
  tc956x_port0_interface: For PORT0 interface mode setting
  tc956x_port1_interface: For PORT1 interface mode setting
  x = [0: USXGMII, 1: XFI (default), 2: RGMII (unsupported), 3: SGMII]
  y = [0: USXGMII (unsupported), 1: XFI (unsupported), 2: RGMII, 3: SGMII(default)]

If invalid and unsupported modes are passed as kernel module parameter, the default interface mode will be selected.

Regarding the performance, use the below command to increase the dynamic byte queue limit

$echo "900000" > /sys/devices/pci0000:00/0000:00:01.0/0000:01:00.0/0000:02:03.0/0000:05:00.0/net/enp5s0f0/queues/tx-0/byte_queue_limits/limit_min 900000 is the random value chosen. It needs to adjust this value on their system and check "0000:00/0000:00:01.0/0000:01:00.0/0000:02:03.0/0000:05:00.0/" value can be obtained from the "lspci -t" command
The debug counters to check the interrupt count is available.

"#ethtool -S " needs to be executed and sample output is as below
```
total_interrupts: 120109
lpi_intr_n: 0
pmt_intr_n: 0
event_intr_n: 0
tx_intr_n: 120000
rx_intr_n: 51
xpcs_intr_n: 0
phy_intr_n: 46
sw_msi_n: 12
```
tx_intr_n = No of. Tx interrupts originating from eMAC sw_msi_n = No. of SW MSIs triggered by Systick Handler as part of optimized Tx Timer based on Systick approach. So total number of interrupts for Tx = tx_intr_n + sw_msi_n Please note that whenever Rx interruts are generated, the Host ISR will process the Tx completed descriptors too.

4.5 KiB Raw Blame History