EtherNet/IP™ Adapter  1.02.01
User Reference Manual
Release Notes

Table of Contents

Overview

This software component is designed for Texas Instruments SITARA AM24x 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:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. 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.
  3. 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.

Copyright (c) 2001-2004 Swedish Institute of Computer Science.
All rights reserved.

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

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. 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.
  3. 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.

Supported Functionality

Feature Description Implementation
EtherNet/IP Device Class Adapter yes
Scanner no
Connection Types Exclusive Owner yes
Input Only yes
Listen Only yes
Connection Trigger Types Cyclic yes
Application Triggered no
Change of State yes
Maximum Connections Class 1 8
Class 3 32
Explicit Messaging Connected yes
Unconnected yes
Standard Objects Identity Object (0x01) yes
Message Router Object (0x02) yes
Assembly Object (0x04) yes
Connection Manager Object (0x06) yes
Device Level Ring Object (0x47) no¹
QoS Object (0x48) yes
TCP/IP Interface Object (0xF5) yes
Ethernet Link Object (0xF6) yes
Supported Elementary Data Types BOOL yes
SINT yes
INT yes
DINT yes
LINT yes
USINT yes
UINT yes
UDINT yes
ULINT yes
REAL yes
LREAL yes
STRING no¹
BYTE yes
WORD yes
DWORD yes
LWORD yes
STRING2 no¹
SHORT_STRING yes
EPATH yes
Supported Constructed Data Types Formal Array yes
IP Addressing Modes DHCP yes
BOOTP no¹
Static yes
Supported Network Features Device Level Ring (DLR) - Beacon based no²
Address Conflict Detection (ACD) yes
Quality of Service (QoS) yes
CIP Reset Services Identity Object Reset Services of Typ 0, 1, and 2
CIP Sync no¹
Baud Rate 100 Mbit/s yes
10 Mbit/s yes
Duplex Mode Half yes
Full yes
Auto Negotiation yes
Conformance ODVA CT17

Table Footnotes:
¹ Planned for stack revision 2.0
² Planned for stack revision 2.0, min. beacon interval 200 μs, min. beacon timeout 400 μs

Feature Description Setting
Key Performance Parameters
Process Data Image max. I/O assembly (size) 1480 Bytes
Connection Trigger Types and Cycle Times Cyclic (Class 1) 1 ms
Change of State 1 ms

Release Version 1.02.01

Description

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

Major Changes

  • 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

Minor Changes

  • none

Fixed Issues

  • [DTKEIPA-520] Get_and_Clear service didn't clear attribute Media Counters.
  • [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-547] After replugging the network cable, the ACD bit in attribute1 of the 0xF5 TCP/IP Interface Object is not set 1.
  • [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).

Known Issues

  • [DTKEIPA-560] CT17 Reset Service Test (6.2) failure. Issue identified, to be resolved with next release.
  • [DTKEIPA-563] CT17 Connection ID Usage Test failure (6.3.4). The same connection ID is reused after reset.
  • [DTKEIPA-324] BOOL datatype can be set to any value and not only 0 or 1.
  • [DTKEIPA-551] Ethernet Link Object (0xF6) always reports successfull autonegotiation even if manual settings are applied on the link-counterpart.
  • [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.

Release Version 1.02.00

Major Changes

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

Minor Changes

  • none

Release Version 1.01.03

Major Changes

  • 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

Minor Changes

  • 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
  • DHCP enabled
  • Based on TI-RTOS(SYS/BIOS) Version 6.83.00.18

Major Changes

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

Minor Changes

  • none

Release Version 1.01.01

Major Changes

  • none

Minor Changes

  • 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.

Major Changes

  • Initital Release

Minor Changes

  • none

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.