Overview

This software component is designed for Texas Instruments SITARA AM64x based platforms with PRU-ICSS IP to enable customers to integrate EtherNet/IP Adapter functionality into their system. It implements a CIP and EtherNet/IP stack based on PRU-ICSS firmware by Texas Instruments.

Licensing

KUNBUS License

Copyright © 2021, KUNBUS GmbH

All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Public Licensed Packages

The EtherNet/IP Adapter software is based on the Lightweight TCP/IP stack (lwIP) version 0.7 stable.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Known Issues

[DTKEIPA-820]

UART console is printing an incorrect MAC address.
The issue is related to optimizations applied to support QuickConnect.

[DTKEIPA-751]

The Identity Object reports unicast ListIdentity error.
The ODVA CT18.1 conformance test reports following error:
The DUT delayed 1295 ms to respond to the unicast ListIdentity command. The DUT shall not delay to a unicast ListIdentity request. Please verify the actual delay with a Wireshark capture.

[DTKEIPA-659]

Sporadic status mismatch in Identity Object.
In rare occasions the ODVA CT17 conformance test may log an error message: 1> *** Instance 1 Attribute 5 (Status) mismatch in Get_Attributes_All.

[DTKEIPA-653]

After setting the PHY speed to 10 mbps (MBit/s) in RGMII mode the network connection may be lost.

[DTKEIPA-643]

The ODVA CT18.1 conformance test reports following error:
EtherNet/IP Devices undergoing certification for the first time and multi-port devices receiving an update that adds CIP functionality are required to implement LLDP protocol and LLDP Management Object starting from May 2022.

[DTKEIPA-642]

Unwanted dependency of multicast connections.
When two (or more) implicit I/O connections using multicast addressing are established, the connections "reuse" the packet stream of the connection which was started first. When the first connection is terminated e.g. by a Forward_Close, the packet stream stops, and the later connections experience a timeout.

[DTKEIPA-621]

DLR unstable in RGMII mode.

[DTKEIPA-612]

ODVA CT17 Test for Identity/Configuration Reset: DUT closes connection before sending response to be clarified with ODVA, since response is actually been sent by DUT.

[DTKEIPA-566]

The ACD SemiActiveProbe should only send on the last connected port, not on both ports.

[DTKEIPA-563]

CT17 Connection ID Usage Test failure (6.3.4). The same connection ID is reused after reset.

[DTKEIPA-557]

With active CIP IO data exchange, running concurrent explicit messaging may occasionally result in that data values of attributes added to assemblies are processed incorrect.

[DTKEIPA-554]

Originator disconnection may not be correctly recognized by target.

[DTKEIPA-551]

Ethernet Link Object (0xF6) always reports successfull autonegotiation even if manual settings are applied on the link counterpart.

[ECSYNC-220]

Set value for PortLogSyncIntervalCfg (Attribute 15) must be equal or less than PortLogAnnounceIntervalCfg (Attribute 14).

[ECSYNC-219]

Writing the DomainNumber (Attribute 18) to non-volatile memory is not supported via PTP Management messages, CIP explicit messaging has to be used instead.

[ECSYNC-217]

PortLogSyncIntervalCfg and PortLogAnnounceIntervalCfg must be settable on timeSync driver.

[ECSYNC-202]

MeanPathDelay (Attribute 7) response by timeSync driver is inconsistant for different PTP Master Capable devices.

[ECSYNC-201]

Attribute 29 (Associated Interface Objects) is not supported.

[ECSYNC-198]

StepsRemoved (Attribute 27) is not working.

Release Version 1.04.00

New Features

New documentation section on CODESYS on Texas Instruments AM64x processors.
Improved EtherNet/IP QuickConnect.
Additional functionality with CIP Sync (PTP Management).
Migration to MCU SDK 8.01.00.26

Fixed Issues

[DTKEIPA-752]: Set "Group Sync" service as "Not Supported" based on bug report from ODVA CT18.1 conformance test. The ODVA CT18.1 conformance test reports following error: *** Unexpected success for not allowed service!
[DTKEIPA-645]: ODVA CT18.1 may report an error after the Interface Configuration Attribute (0x05) of the TCP/IP Interface Object (0xF5) has been written.
[ECSYNC-200]: Disabling ptpEnable Attribute (Attribute 1) has no effect.
[ECSYNC-199]: PTP Management Message feature is not supported.
[ECSYNC-197]: DomainNumber (Attribute 18) is not working correctly.

Release Version 1.03.04

New Features

Updated Documentation

Fixed Issues

no code changes

Release Version 1.03.03

New Features

Support for EtherNet/IP QuickConnect.
Support for CIP Sync.
Migration to MCU SDK 8.01.00.15
Tested against ODVA CT18.1.

Fixed Issues

[DTKEIPA-474]: DLR Active Supervisor change not seen reliably.
When the precedence of the Backup Supervisor is set high, the DUT reports IP and MAC address of the new active supervisor correctly. But when the precedence is then set back to the low value, and the formerly active supervisor takes over again, its addresses are not shown by the DUT.

Release Version 1.03.02

New Features

Support for LP-AM243 AM243x Arm-based MCU general purpose LaunchPad development kit.
Support for FreeRTOS based on MCU+ SDK Version 8.01.00.10 added.

Fixed Issues

[DTKEIPA-562]: ACD error in CT18 ACD test 4.14. Detected with ODVA CT18.
[DTKEIPA-432]: Failures in 6.3.2.2 Electronic Key Test for UCMM.
[DTKEIPA-431]: Wrong address sent when "reusing" existing multicast connection. Detected with ODVA CT18.

Release Version 1.03.01

New Features

[DTKEIPA-610]: Split receive of RT packets and NRT packets to 2 different callbacks.
Same callback for RT (real time) and NRT (non real time) packets was used.
Addressing [DTKEIPA-608] data abort due to memory overflow.

Fixed Issues

[DTKEIPA-608]: Data abort errors may be detected on high network load.
: IO Connection identifier after reset is identical to previous IO connection identifier.

Release Version 1.03.00

New Features

Device Level Ring (DLR) enabled for FreeRTOS.
Documentation enhancements in Quick Start section.
Description of an IEC 61131-3 program for CODESYS controlling the EtherNet/IP Adapter example.

Fixed Issues

[DTKEIPA-560]: CT17 Reset service test (6.2) failure.
[DTKEIPA-324]: BOOL datatype can be set to any value and not only 0 or 1.

Release Version 1.02.01

Description

EtherNet/IP Adapter software developed and tested against ODVA Conformance Test CT17.

New Features

Initital Release for Sitara AM64x.
Support for 10 Mbit/s and 100 MBit/s.
Support for MII and RGMII PHY modes.
Boot from OSPI flash supported.
Device Level Ring (DLR) currently not supported for FreeRTOS.

Fixed Issues

[DTKEIPA-549]: When power cycling the device after an address conflict, 0xF5 TCP/IP Interface Object Attribute 11 forgets ACD activity status ongoing detection (other information in Attribute 11 is retained).
[DTKEIPA-547]: After replugging the network cable, the ACD bit in Attribute 1 of the 0xF5 TCP/IP Interface Object is not set 1.
[DTKEIPA-546]: With ACD switched off (0xF5 TCP/IP Interface Object, Attribute 10 set to 0), the device behaves as if ACD is still active.
[DTKEIPA-520]: Get_and_Clear service did not clear Attribute Media Counters.

Release Version 1.02.00

New Features

Support for FreeRTOS based on MCU+ SDK Version 7.03.02.04 added.

Release Version 1.01.03

New Features

TI SDK PRU Firmware delivery has been included in release package.
Release package structure updated.
Based on TI-RTOS(SYS/BIOS) Version 6.83.00.18.
Device Level Ring supported, not yet fully tested.
PRU firmware updated to Version 1.00.04.05.

Release Version 1.01.02

Description

PRU Firmware delivery has been included in release package.
PRU Firmware & PDK version update.
Based on TI-RTOS(SYS/BIOS) Version 6.83.00.18.

New Features

DHCP enabled.
PRU Firmware updated to Version 1.00.04.01.
AM65x Platform Development Kit updated to Version 07.01.00.55.

Release Version 1.01.01

New Features

PRU firmware delivery files included into project.

Release Version 1.01.00

Description

For a details on the supported functionality see Supported EtherNet/IP Functionality.

New Features

Initital Release

Limitations

THIS IS A BETA RELEASE AND SHALL BE TREATED AS SUCH.
THERE ARE FEATURES WHICH AT THIS TIME REMAIN UNTESTED DUE TO OBSERVED ISSUES.
COMPLIANCE TESTS HAVE NOT BEEN DONE/SUCCESSFULLY COMPLETED YET.