EthFw Release Notes

Version: 10.01.00.04

Introduction

This release notes provides important information that will assist you in using the EthFw component. This document provides the product information and known issues with respect to EthFw software component. The EthFw component consists of firmware for Ethernet switch, profiling tools and demos/applications for J721E, J7200, J784S4 and J742S2 silicon platforms.

Licensing

Refer to Processor SDK RTOS top-level manifest.

Getting Started

The Ethernet Firmware User's Guide provides the documentation and references necessary to run EthFw demos and begin development on TI's platforms.

Documentation

Refer to following documentation for further details:

Ethernet Firmware User Guide	Build instructions, Demos	[HTML]
Ethernet Firmware API Guide	API Guide	[HTML]

What's New

TCP throughput support > 400 Mbps on RTOS.
RTOS client support on MCU3_0.
PPS signal generation support.
Heartbeat mechanism support enabled on EthFw.

Upgrade and Compatibility Information

Users moving from SDK 8.2 or older to SDK 8.6 must refer to the Porting Guide document which describes how the board initialization routines have been restructured.

CpswProxy_init() now takes initialization configuration params (CpswProxy_initParams).

CpswProxy_attach() and CpswProxy_attachExtended() now has feature flag (features) parameter. This flag is required by clients to identify features enabled in hardware like checksum offload when enabled in CPSW, remote clients can disable software checksum.

Error codes for Ethw Remote config layer (EthRemoteCfg_ErrorCode) has been updated to match the Enet driver Error codes.

Response of ETHREMOTECFG_CMD_GET_SERVER_STATUS cmd (EthRemoteCfg_ServerStatusRes) now return the server status of type (EthRemoteCfg_ServerStatus) instead on uint32_t status.

Ethernet Firmware configuration (EthFw_Config) now has PPS config params (ppsConfig).

Ethernet Firmware configuration (EthFw_Config) now has parameter to pass packets with errors to Host Port (passErrPkt). This feature is currently not enabled due to a known HW issue.

EthFw_initConfigParams() and EthFw_init() now has Enet instance id parameter in their declarations.

EthFwCallbacks_lwipifCpswGetHandle now takes Enet Type and instance id parameters along with inArgs and outArgs.

EthFwCallbacks_lwipifCpswReleaseHandle now takes Enet Type and instance id parameters along with releaseInfo.

The following ETHFW commands have been discontinued:

ETHREMOTECFG_CMD_ENABLE_PROMISC and ETHREMOTECFG_CMD_DISABLE_PROMISC used to enable/disable promiscuous mode by virtual MAC ports. Removed due to hardware limitation.

ETHREMOTECFG_CMD_MESSAGE_PING used to check ETHFW command interface. It's replaced by ETHREMOTECFG_CMD_GET_SERVER_STATUS.

ETHREMOTECFG_CMD_READ_REGISTER and ETHREMOTECFG_CMD_WRITE_REGISTER used to read/write Ethernet device registers.

ETHREMOTECFG_CMD_IOCTL allowed thin clients to execute Enet LLD IOCTLs remotely. Remote clients should use the dedicated command corresponding to the feature of interest.

VLAN configuration parameter from static shared multicast table has been removed.

In VEPA case VLAN is handled based on VLANs joined by client and VEPA table. Clients can join a particual VLAN and then can join the shared multicast with that VLAN. VEPA table will have client mask based on mac address + VLAN

In NON-VEPA VLAN is not handled due to lwIP bridge VLAN handling limitation (lwIP bridge does not differentiate tagged and untagged packets). Hence this parameter is not required at all.

Exclusive multicast address is considered to be exclusive irrespective of VLAN. In case when client registers exclusive multicast in a VLAN, VLAN provided will be ignored and it will be registered only based on multicast address. Any other client registering the same multicast address (even with different VLAN) will result an error from EthFw.

Device Support

Below table shows device support for EthFw.

SoC	HOST (OS)	Target (OS)	Test Platform
J721E	Linux	FreeRTOS, SafeRTOS	J721E EVM with GESI and QSGMII Daughter Boards
J7200	Linux	FreeRTOS, SafeRTOS	J7200 EVM with QSGMII Daughter Board
J784S4	Linux	FreeRTOS, SafeRTOS	J784S4 EVM with QSGMII Daughter Board

Refer Processor SDK RTOS RTOS release notes for SDK device support.

Validation Information

This release was built and validated using the following tools. Refer to the EthFw User's Guide for additional instructions to install and setup the dependencies.

Build Tools (included in Processor SDK)

TI ARM CLANG: 3.2.2.LTS
lwIP stack: 2.2.0
FreeRTOS Kernel: 10.4.3
SafeRTOS Kernel - see table below

SoC	ISA	SafeRTOS package version
J721E	R5F	009-004-199-024-219-005
J7200	R5F	009-004-199-024-219-005
J784S4	R5F	009-004-199-024-219-005

Fixed Issues

Issue ID	Headline	Module	Reported in Release	Affected Platforms	Fixed in Release
ETHFW-2006	UDP Speed slow down while open 2 ports on EVM	EthFw	08.00.00.00	J721E, J7200, J784S4	10.01.00
ETHFW-2839	VLAN Broadcast packets were not duplicated to clients in VEPA	EthFw	09.02.00.00	J784S4	10.01.00
ETHFW-2840	Deletion of Exclusive Multicast Address return error for removing address	EthFw	09.02.00.00	J721E, J7200, J784S4	10.01.00
ETHFW-2852	Assertion in ENET DMA packet in lwipif layer due to packet state when both polling and interrupt modes are enabled	EthFw	09.02.00.00	J721E, J784S4	10.01.00

Known Issues and Limitations

Issue ID	Headline	Module	Reported in Release	Affected Platforms	Workaround in this release
ETHFW-2088	EthFW will get stuck waiting for link if link partner is not ready	Documentation	08.04.00.00	J721E, J7200, J784S4	None.
ETHFW-2575	CPSW error flags are not getting updated in UDMA host packet descriptor	EthFw	09.02.00.00	J721E, J7200, J784S4	None.
ETHFW-2593	ETHFW: gPTP: TSN stack initialization increased	EthFw	09.02.00.00	J721E, J7200, J784S4	None.
ETHFW-2975	ETHFW: REGISTER_MAC request fails post reset recovery with Linux client due to timeout	EthFw	10.01.00.00	J721E, J784S4	Reduce logging level of gPTP and combase untill stack initialization time has been reduced.
ETHFW-2924	ETHFW: Multiple EthFw init and EthFw deinit causes failure	EthFw	10.01.00.00	J721E, J7200, J784S4	None.

Limitations

As J742S2 EVM E1 version does not provide any Enet board/connector, hence no functionality test has been done on J742S2-EVM. EthFw (built for J742S2) for CPSW_9G is validated on J784S4-EVM post applying a patch. Please refer to ETHFW J742S2 Testing section in ETHFW User's Guide for more details.

Dependencies

All Ethernet Firmware dependencies are also part of the SDK, please refer to the User's Guide for details.

Technical Support

For technical support and additional assistance, contact local TI Field Application Engineer

Package Versioning

Each package version is composed of 4 period-delimited numbers - represented here by the letters M, m, p and b [M.m.p.b]. The table below provides a descriptive reference regarding package version numbering.

Digit	Meaning	Description
1 (M=Major)	Major revision	Incremented when the new version is substantially different from the previous For example, a new module added or an existing module's algorithm significantly altered.
2 (m=minor)	Minor revision	Incremented when the new version has changed but not in a major way. For example, some minor changes in the API or feature set.
3 (p=patch)	Patch number	Incremented for all other source code changes. This include any packaging support code.
4 (b=build)	Build number	Incremented for each release delivery to CM. Reset for any change to M, m or p.