CIP Vol2 1.4 PDF
CIP Vol2 1.4 PDF
CIP Vol2 1.4 PDF
Volume 2
Edition 1.4
November 2007
The right to make, use or sell product or system implementations described herein is granted
only under separate license pursuant to a Terms of Usage Agreement or other agreement.
Terms of Usage Agreements for individual CIP Networks are available, at standard charges,
over the Internet at the following web sites:
– ii –
Edition 1.4
ODVA & ControlNet International, Ltd.
The CIP Networks Library Volume 2: EtherNet/IP Adaptation of CIP
Table of Contents
Revisions - Summary of Changes in this Edition
– iii –
Edition 1.4
ODVA & ControlNet International, Ltd.
The CIP Networks Library Volume 2: EtherNet/IP Adaptation of CIP
Revisions
The CIP Networks Library Volume 2: EtherNet/IP Adaptation of CIP, Edition 1.4 contains the
following changes from Edition 1.3. Please see the change bars on the pages noted here for
specific modifications. Note: Some of the pages within the ranges noted may not contain any
changes.
– iv –
Edition 1.4
ODVA & ControlNet International, Ltd.
The CIP Networks Library Volume 2: EtherNet/IP Adaptation of CIP
Preface
–v–
Edition 1.4
ODVA & ControlNet International, Ltd.
The CIP Networks Library Volume 2: EtherNet/IP Adaptation of CIP
This common structure presents CIP in one volume with a separate volume for each network
adaptation of CIP. The specifications for the CIP Networks are two-volume sets, paired as
shown below.
The EtherNet/IP specification consists of:
Volume 1: Common Industrial Protocol (CIP™)
Volume 2: EtherNet/IP Adaptation of CIP
The DeviceNet specification consists of:
Volume 1: Common Industrial Protocol (CIP™)
Volume 3: DeviceNet Adaptation of CIP
The ControlNet specification consists of:
Volume 1: Common Industrial Protocol (CIP™)
Volume 4: ControlNet Adaptation of CIP
The CompoNet specification consists of:
Volume 1: Common Industrial Protocol (CIP™)
Volume 6: CompoNet Adaptation of CIP
The specification for CIP Safety™ is distributed in a single volume:
Volume 5: CIP Safety
The specification for integrating Modbus Devices is distributed in a single volume:
Volume 7: Integration of Modbus Devices into the CIP Architecture
Specification Enhancement Process
The specifications for CIP Networks are continually being enhanced to meet the increasing
needs of users for features and functionality. ODVA and ControlNet International have also
agreed to operate using a common Specification Enhancement Process in order to ensure open
and stable specifications for all CIP Networks. This process is on going throughout the year for
each CIP Network Specification as shown in the figure below. New editions of each CIP
Network specification are published on a periodic basis.
Conformance Tests
Updated
Technical Review Board
Reviews and Approves
Specification Enhancements
– vi –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP
Contents
1-1 Introduction........................................................................................................................................................3
1-2 Scope..................................................................................................................................................................4
1-3 References..........................................................................................................................................................6
1-3.1 Normative References................................................................................................................................6
1-4 Additional Reference Material...........................................................................................................................6
1-5 Definitions .........................................................................................................................................................8
1-6 Abbreviations.....................................................................................................................................................9
– 1-2 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 1: Introduction to EtherNet/IP
1-1 Introduction
EtherNet/IP (Ethernet/Industrial Protocol) is a communication system suitable for use in
industrial environments. EtherNet/IP allows industrial devices to exchange time-critical
application information. These devices include simple I/O devices such as sensors/actuators, as
well as complex control devices such as robots, programmable logic controllers, welders, and
process controllers.
EtherNet/IP uses CIP (Control and Information Protocol), the common network, transport and
application layers also shared by ControlNet and DeviceNet. EtherNet/IP then makes use of
standard Ethernet and TCP/IP technology to transport CIP communications packets. The result
is a common, open application layer on top of open and highly popular Ethernet and TCP/IP
protocols.
EtherNet/IP provides a producer/consumer model for the exchange of time-critical control data.
The producer/consumer model allows the exchange of application information between a
sending device (e.g., the producer) and many receiving devices (e.g., the consumers) without
the need to send the data multiple times to multiple destinations. For EtherNet/IP, this is
accomplished by making use of the CIP network and transport layers along with IP Multicast
technology. Many EtherNet/IP devices can receive the same produced piece of application
information from a single producing device.
EtherNet/IP makes use of standard IEEE 802.3 technology; there are no non-standard additions
that attempt to improve determinism. Rather, EtherNet/IP recommends the use of commercial
switch technology, with 100 Mbps bandwidth and full-duplex operation, to provide for more
deterministic performance.
NOTE: EtherNet/IP does not require specific implementation or performance requirements due
to the broad range of application requirements. However, work is underway to define a
standard set of EtherNet/IP benchmarks and metrics by which the performance of devices will
be measured. These measurements may become required entries within a product's Electronic
Data Sheet. The goal of such benchmarks and metrics will be to help the user determine the
suitability of a particular EtherNet/IP device for a specific application.
The figure below illustrates how EtherNet/IP, DeviceNet and ControlNet share the CIP
Common layers.
– 1-3 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 1: Introduction to EtherNet/IP
User
Common
Layer
Spec
CIP
Application Object Library
Application &
Transport Layers
CIP Messaging: Explicit, I/O, Routing
Ecapsulation
DeviceNet ControlNet
UDP TCP Future ?
Adaptation & Data Link Data Link
Layer Layer IP
Data Link Layers
[CAN] [CTDMA] Enet Data Link
Layer [CSMA/CD]
1-2 Scope
The EtherNet/IP specification is divided into the following chapters:
– 1-4 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 1: Introduction to EtherNet/IP
This chapter is the Introduction to EtherNet/IP. The following drawing shows the relationship
of these chapters to each other and to the CIP Common specification (published separately by
ODVA and ControlNet International). Both this specification (volume2) and the CIP Common
specification (volume1) are required to completely specify an EtherNet/IP product. The
encapsulation protocol defined in Chapter 2 of this specification is also suitable to encapsulate
other industrial protocols, as illustrated in the following drawing. However, the specific details
of encapsulating other protocols are not included in this release of the specification.
As can be seen in Figure 1-2.1, the encapsulation protocol in chapter 2 uses a TCP/IP layer to
insulate it from the network medium. As such, the encapsulation protocol may be used on any
medium that supports TCP/IP. For example, the encapsulation protocol could run on an FDDI
or PPP network. Chapter 9 (Indicators and Middle Layers) requires conformance with the RFC
that documents how TCP/IP is implemented on a particular network. Furthermore, chapter 8
(Physical Layers) narrows the scope of certified EtherNet/IP implementations to run on either
10 or 100 Mb Ethernet. Specifically, chapter documents two permissible conformance levels
of devices: one called “commercial” and the other “industrial”. Other conformance levels may
be added through modification to this specification.
Figure 1-2.1 shows the relationship between the various parts of the EtherNet/IP specification.
As shown in the figure, the darker sections (chapters 2-7 and 10) are predominately
documented by the CIP Common specification (volume 1). The corresponding chapters of the
EtherNet/IP Adaptation of CIP (volume 2) supplements or modifies these chapters of the CIP
Common specification in some areas. The lightly shaded sections (chapters 2, 3, 8 and 9) are
predominately documented by volume 2. These chapters contain information applicable
specifically to EtherNet/IP devices, but not necessarily to those on other CIP networks (for
example, DeviceNet or ControlNet).
SEMI Pneu AC
Chapters 6 and 7 PLC
Devices Valve Drive
Chapter 2
Chapters 2, 3 and 10 Encap-
CIP Messaging
sulation
Chapter 3 Explicit, I/O, Routing.
of other
industrial
networks
Internet Internet
KEY apps
Encapsulation of CIP
apps
(e.g. (e.g.
CIP Common NFS) Encapsulation HTTP)
Specification (Vol 1)
UDP TCP
IP Chapter 9
Ethernet/IP
Adaptation of CIP Ethernet Data Link Layer
(Vol 2)
Ethernet Physical Layer Chapter 8
– 1-5 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 1: Introduction to EtherNet/IP
1-3 References
– 1-6 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 1: Introduction to EtherNet/IP
RFC 1103: June 1989, A Proposed Standard for the Transmission of IP Datagrams over FDDI
Networks
RFC 1112: August 1989, Host Extensions for IP Multicasting
RFC 1117:1989, Internet numbers
RFC 1122: October 1989, Requirements for Internet Hosts -- Communication Layers
RFC 1123: October 1989, Requirements for Internet Hosts -- Application and Support
RFC 1127: October 1989, A Perspective on the Host Requirements RFCs
RFC 1171: July 1990, The Point-to-Point Protocol for the Transmission of Multi-Protocol
Datagrams Over Point-to-Point Links
RFC 1201: February 1991, Transmitting IP Traffic over ARCNET Networks
RFC 1392: January 1993, Internet Users' Glossary
RFC2236: November 1997, Internet Group Management Protocol, Version 2
– 1-7 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 1: Introduction to EtherNet/IP
1-5 Definitions
For the purposes of this standard, the following definitions apply. Also see CIP Common
Specification, Chapter 1 for additional definitions.
Term Definition
automation outlet The interface where the generic telecommunications cabling ends and the automation
specific cabling begins, including the interfaces where automation specific cabling
terminates within the automation island.
broadcast A special type of multicast packet that all nodes on the network are always willing to
receive. [Source: RFC1392]
broadcast storm An incorrect packet broadcast onto a network that causes multiple hosts to respond all at once,
typically with equally incorrect packets which causes the storm to grow exponentially in severity.
[Source: RFC1392]
datagram A self-contained, independent entity of data carrying sufficient information to be
routed from the source to the destination computer without reliance on earlier
exchanges between this source and destination computer and the transporting network.
[Source: RFC1392]
bulkhead A wall or barrier which maintains the ingress and climatic environmental classification
applicable on either side
bulkhead connection An assembly of two back-to-back connections separated by a bulkhead
bulkhead cable gland A device at an enclosure bulkhead that provides cable passage for power or signals
channel A channel is defined as the end-to-end transmission path between two points at which
application-specific equipment is connected. Alternatively a channel is a path of data
transfer between two end devices
encapsulation The technique used by layered protocols in which a layer adds header information to
the protocol data unit (PDU) from the layer above. As an example, in Internet
terminology, a packet would contain a header from the physical layer, followed by a
header from the network layer (IP), followed by a header from the transport layer
(TCP), followed by the application protocol data. [Source: RFC1208]
Ethernet A 10-Mb/s standard for LANs, initially developed by Xerox, and later refined by
Digital, Intel and Xerox (DIX). All hosts are connected to a coaxial cable where they
contend for network access using a Carrier Sense Multiple Access with Collision
Detection (CSMA/CD) paradigm. See also: 802.x, Local Area Network, token ring.
[Source: RFC1392]
EtherNet/IP Products compliant with this specification as well as the CIP Common specification
are known as EtherNet/IP products. EtherNet/IP stands for Ethernet Industrial
Protocol. [Source: RFC1392]
frame Single data transfer on a link.
link The physical connection between two active mating components
MAC ID the 48-bit physical address of an Ethernet node
network status Indicators on a node indicating the status of the Physical and Data Link Layers.
indicators
network address or A node’s 32-bit TCP/IP address on the link. In most CIP networks, this network
node address address is the MAC ID; however, this is not the case on Ethernet. The DLL of
Ethernet has a 48-bit MAC ID that is not used directly by the CIP communication
stack.
physical medium An active interface defined by the appropriate standards to serve a specific medium
dependant such as copper 2/4 pair or fiber
physical topology The physical layout of devices on a network, or the way that the devices on a network
are arranged and how they communicate with each other, is called the physical
topology
– 1-8 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 1: Introduction to EtherNet/IP
Term Definition
port Within the EtherNet/IP specific context, a TCP or UDP port is a transport layer
demultiplexing value. Each application has a unique port number associated with it.
[Source: RFC1392]. See CIP Common Specification for an additional definition of
this term.
Power over Ethernet The delivery of device power along with Ethernet signals, as defined by 803.3an in
cooperation with TIA-TR42 standards committee
redundant media A system using more than one medium to help prevent communication failures.
segment Trunk–cable sections connected via taps with terminators at each end; a segment has
no active components and does not include repeaters.
transceiver The physical component within a node that provides transmission and reception of
signals onto and off of the medium.
1-6 Abbreviations
For the purposes of this standard, the following abbreviations apply. Also see the CIP Common
Specification Chapter 1 for additional abbreviations.
Abbreviation Meaning
AO Automation Outlet
COTS Commercially off the shelf. Refers to commercial grade components
FTP File transfer protocol. An internet application that uses TCP reliable packet
transfer to move file between different nodes. (not to be confused with STP/FTP)
LED Light emitting diode
PMD Physical Media Dependant
PoE Power over Ethernet
rcv Receive
RFC Request For Comments (RFC) – The document series, begun in 1969, which
describes the Internet suite of protocols and related experiments. Not all (in fact,
very few) RFCs describe the Internet standards, but all Internet standards are
written up as RFCs. The RFC series of documents is unusual in that the proposed
protocols are forwarded by the Internet research and development community,
acting on their own behalf, as opposed to the formally reviewed and standardized
protocols that are promoted by organizations such as CCITT and ANSI. [Source:
RFC 1392]
rx Receive
STP/FTP Shielded twisted pair/foil twisted pair
TCP Transmission Control Protocol (TCP) - An Internet Standard transport layer
protocol defined in STD 7, RFC 793. It is connection-oriented and stream-
oriented, as opposed to UDP. See also: connection-oriented, stream-oriented,
User Datagram Protocol. [Source: RFC1392]
Tx transmit
UDP User Datagram Protocol (UDP) - An Internet Standard transport layer protocol
defined in STD 6, RFC 768. It is a connectionless protocol which adds a level of
reliability and multiplexing to IP. See also: connectionless, Transmission Control
Protocol. [Source: RFC1392]
UTP Unshielded twisted pair
Xmit transmit
– 1-9 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 1: Introduction to EtherNet/IP
– 1-10 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP
Contents
2-1 Introduction........................................................................................................................................................3
2-2 Use of TCP and UDP .........................................................................................................................................3
2-3 Encapsulation Messages ....................................................................................................................................4
2-3.1 Encapsulation Packet Structure..................................................................................................................4
2-3.2 Command Field..........................................................................................................................................5
2-3.3 Length Field ...............................................................................................................................................6
2-3.4 Session Handle...........................................................................................................................................6
2-3.5 Status Field.................................................................................................................................................6
2-3.6 Sender Context Field..................................................................................................................................7
2-3.7 Options Field..............................................................................................................................................7
2-3.8 Command Specific Data Field ...................................................................................................................7
2-4 Command Descriptions......................................................................................................................................8
2-4.1 NOP ...........................................................................................................................................................8
2-4.2 ListIdentity.................................................................................................................................................9
2-4.3 ListInterfaces............................................................................................................................................11
2-4.4 RegisterSession ........................................................................................................................................12
2-4.5 UnRegisterSession ...................................................................................................................................14
2-4.6 ListServices..............................................................................................................................................15
2-4.7 SendRRData.............................................................................................................................................17
2-4.8 SendUnitData ...........................................................................................................................................19
2-5 Session Management........................................................................................................................................20
2-5.1 Phases of a TCP Encapsulation Session...................................................................................................20
2-5.2 Establishing a Session ..............................................................................................................................20
2-5.3 Terminating a Session ..............................................................................................................................20
2-5.4 Maintaining a Session ..............................................................................................................................20
2-5.5 TCP Behavior (informative) ....................................................................................................................21
2-6 Common Packet Format...................................................................................................................................22
2-6.1 General.....................................................................................................................................................22
2-6.2 Address Items...........................................................................................................................................23
2-6.3 Data Items ................................................................................................................................................24
– 2-2 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
2-1 Introduction
This chapter (chapter 2) of the specification documents the method used to encapsulate
industrial protocols on a TCP/IP network. This mechanism can be applied to the CIP industrial
protocol or to other networks. Chapter 3 of this specification details the application of this
encapsulation protocol to CIP.
With respect to the OSI reference model, this encapsulation protocol inhabits Layer 2 Data Link
functions.
NOTE: TCP is a stream-based protocol. It is permitted to send almost any length IP packet it
chooses. For example, if two back-to-back encapsulated messages were passed to a TCP/IP
stack, the TCP/IP stack may choose to put both encapsulated messages in one Ethernet frame.
Alternately, it may choose to place half of the first message in the first Ethernet frame and all
the rest in the next Ethernet frame. This is shown in Figure 2-2.1 Usage of TCP to Encapsulate
Two Messages.
or
NOTE: It is not the intention of this specification to document the details of the TCP, UDP and
IP transport mechanisms. Many excellent resources including the RFCs referenced throughout
this specification should be used to obtain this information.
– 2-3 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
The encapsulation protocol also defines a reserved UDP port number that shall be supported by
all EtherNet/IP devices. All devices shall accept UDP packets on UDP port number 0xAF12.
Since UDP, unlike TCP, does not have an ability to reorder packets, whenever UDP is used to
send an encapsulated message, the entire message shall be sent in a single UDP packet. Only
one encapsulated message shall be present in a single UDP packet destined to UDP port
0xAF12.
Some encapsulated messages shall only be sent via TCP. Other may be sent via either UDP or
TCP. See “Table 2-3.2 Encapsulation Commands” for details about which commands are
restricted to TCP.
The encapsulation message length shall not override length restrictions imposed by the
encapsulated protocol.
NOTE: For example, a CIP UCMM message is still limited to 504 bytes even when
encapsulated. See chapter 3 of the CIP Common Specification.
Multi-byte integer fields in the encapsulation messages shall be transmitted in little-endian byte
order.
NOTE: This is different from the byte ordering used in standard Internet network protocols,
which is big-endian.
Although the header contains no explicit information to distinguish between a request and a
reply, this information shall be determined in either of two ways:
– 2-4 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
• implicitly, by the command and the context in which the message is generated. (For
example, in the case of the RegisterSession command, the request is generated by an
originator and the target generates the reply);
• explicitly, by the contents of an encapsulated protocol packet in the data part of the
message.
A device shall accept commands that it does not support without breaking the session or
underlying TCP connection. A status code indicating that an unsupported command was
received shall be returned to the sender of the message.
– 2-5 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
NOTE: The establishment of a session is defined in section 2-5. In short, a session makes a
TCP/IP connection between originator and target over which encapsulated commands may be
sent. Since TCP/IP connections are modeled as a stream of bytes, the encapsulation header is
prepended to each encapsulated packet so that the receiving device can know where packets
begin and end.
The entire encapsulation message shall be read from the TCP/IP connection even if the length
is invalid for a particular command or exceeds the target's internal buffers.
NOTE: Failure to read the entire message can result in losing track of the message boundaries
in the TCP byte stream.
NOTE: Some commands (i.e., NOP) do not require a session handle even if a session has been
established. Whether or not a particular command requires a session is noted in the description
of that command.
NOTE: This field does not reflect errors that are generated by an encapsulated protocol packet
contained within the data portion of the message. For example, an error encountered during an
end node's processing of a Set Attributes service would be returned via the CIP specified error
mechanism (see chapter 3 of the CIP Common specification)..
– 2-6 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
NOTE: The sender of a command may place any value in this field. It could be used to match
requests with their associated replies.
NOTE: The intent of this field is to provide bits that modify the meaning of the various
encapsulation commands. No particular use for this field has not yet been specified.
The common packet format allows commands to structure their command specific data field in
an extensible way.
– 2-7 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
2-4.1 NOP
Either an originator or a target may send a NOP command. No reply shall be generated by this
command. The data portion of the command shall be from 0 to 65511 bytes long. The receiver
shall ignore any data that is contained in the message.
NOTE: A NOP provides a way for either an originator or target to determine if the TCP
connection is still open.
– 2-8 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
2-4.2 ListIdentity
2-4.2.1 General
A connection originator may use the ListIdentity command to locate and identify potential
targets. This command shall be sent as a broadcast message using UDP and does not require
that a session be established.
2-4.2.2 Request
The ListIdentity request shall be as shown below:
2-4.2.3 Reply
One reply item is defined for this command, Target Identity, with item type code 0x0C. This
item shall be supported (returned) by all CIP capable devices.
Each receiver of the List Identity command shall reply with a standard encapsulation header
and data, as shown below. The data portion of the message shall provide the information on
the target’s identity. The reply shall be sent to the IP address from which the broadcast request
was received.
– 2-9 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
The data portion of the message shall be the Common Packet Format that contains a 2-byte
item count followed by an array of items providing the target identity.
At a minimum, the CIP Identity item shall be returned and has the format as defined in Table 2-
4.4. Part of this item definition follows the Get Attribute All service response definition of the
Identity Object (data returned based on instance one of this object), and may adopt new
members if and when new members are added to that service response. Unlike most fields in
the Common Packet Format, the Socket Address field shall be sent in big endian order.
– 2-10 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
2-4.3 ListInterfaces
2-4.3.1 General
The optional List Interfaces command shall be used by a connection originator to identify
potential non-CIP communication interfaces associated with the target. A session need not be
established to send this command.
2-4.3.2 Request
The ListInterfaces request shall be as shown below.
2-4.3.3 Reply
If supported, the receiver of a ListInterfaces request command shall reply with a standard
encapsulation header and data, as shown below. The data portion of the message is structured
as a Common Packet Format and shall provide information on the non-CIP communication
interfaces associated with the target.
The data portion of the message shall be the Common Packet Format, which contains a 2-byte
item count followed by an array of items providing interface information. There are no
publicly defined items returned with this reply. The vendor-specific item(s) which is/are
returned shall, at a minimum, return a 32 bit Interface Handle which is used by other
encapsulation commands, for example, the SendRRData command.
– 2-11 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
2-4.4 RegisterSession
2-4.4.1 General
An originator shall send a RegisterSession command to a target to initiate a session.
NOTE: See section 2-5, for detailed information on establishing and maintaining a session.
2-4.4.2 Request
The RegisterSession request shall be as follows:
2-4.4.3 Reply
The target shall send a RegisterSession reply to indicate that it has registered the originator.
The reply shall have the same format as the request as shown below:
– 2-12 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
The Session Handle field of the header shall contain a target-generated identifier that the
originator shall save and insert in the Session Handle field of the header for all subsequent
requests to that target. This field shall be valid only if the Status field is zero (0).
The Sender Context field of the header shall contain the same values present in the original
sender request. If the originator has been registered with the target, the Status field shall be
zero (0). If the target was unable to register, the Status field shall be set to 0x69 (unsupported
encapsulation protocol revision).
The Protocol Version field shall equal the requested version if the originator was successfully
registered. If the target does not support the requested version of the protocol,
• the session shall not be created;
• the Status field shall be set to unsupported encapsulation protocol 0x69;
• the target shall return the highest supported version in the Protocol Version field.
If all requested options are supported, the Options field shall return the originator's value. This
value shall be zero.
– 2-13 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
2-4.5 UnRegisterSession
Either an originator or a target may send this command to terminate the session. The receiver
shall initiate a close of the underlying TCP/IP connection when it receives this command. The
session shall also be terminated when the transport connection between the originator and
target is terminated. The receiver shall perform any other associated cleanup required on its
end. There shall be no reply to this command.
The Session Handle shall be set to the value obtained by the original RegisterSession reply.
Once the client has sent this command, it shall no longer use the handle. .
NOTE: See section 2-5.3 for more detail about terminating a session.
– 2-14 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
2-4.6 ListServices
2-4.6.1 General
The ListServices command shall determine which encapsulation service classes the target
device supports.
NOTE: Each service class has a unique type code, and an optional ASCII name.
2-4.6.2 Request
The ListServices header shall be as follows:
2-4.6.3 Reply
The receiver shall reply with a standard encapsulation message, consisting of the header and
data, as shown below. The data portion of the message shall provide the information on the
services supported.
– 2-15 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
One service class is defined, with type code 0x100 and name "Communications". This service
class shall indicate that the device supports encapsulation of CIP packets. All devices that
support encapsulating CIP shall support the ListServices request and Communications service
class.
NOTE: See section 2-6 for a description of items and a list of all reserved item codes.
The Version field shall indicate the version of the service supported by the target to help
maintain compatibility between applications.
Each service shall have a different set of capability flags. Unused flags shall be set to zero.
The Capability Flags, defined for the Communications service, shall be as follows:
The Name field shall allow up to a 16-byte, NULL-terminated ASCII string for descriptive
purposes only. The 16-byte limit shall include the NULL character.
– 2-16 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
2-4.7 SendRRData
2-4.7.1 General
A SendRRData command shall transfer an encapsulated request/reply packet between the
originator and target, where the originator initiates the command. The actual request/reply
packets shall be encapsulated in the data portion of the message and shall be the responsibility
of the target and originator.
NOTE: When used to encapsulate the CIP, the SendRRData request and response are used to
send encapsulated UCMM messages (unconnected messages). See chapter 3 for more detail.
2-4.7.2 Request
The SendRRData header shall be as follows:
The Interface handle shall identify the Communications Interface to which the request is
directed. This handle shall be 0 for encapsulating CIP packets.
The target shall abort the requested operation after the timeout expires. When the “timeout”
field is in the range 1 to 65535, the timeout shall be set to this number of seconds. When the
“timeout” field is set to 0, the encapsulation protocol shall not have its own timeout. Instead, it
shall rely on the timeout mechanism of the encapsulated protocol.
NOTE: When used to encapsulate CIP packets, the timeout field is usually set to 0 since CIP
provides its own timeout mechanism for connected messages.
The encapsulated protocol packet shall be encoded in the Common Packet Format as shown in
section 2-6.
2-4.7.3 Reply
The SendRRData reply, as shown below, shall contain data in response to the SendRRData
request. The reply to the original encapsulated protocol request shall be contained in the data
portion of the SendRRData reply.
– 2-17 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
The format of the data portion of the reply message shall be the same as that of the
SendRRData request message.
NOTE: Since the request and reply share a common format, the reply message contains a
timeout field; however, it is not used.
– 2-18 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
2-4.8 SendUnitData
The SendUnitData command shall send encapsulated connected messages. This command may
be used when the encapsulated protocol has its own underlying end-to-end transport
mechanism. A reply shall not be returned. The SendUnitData command may be sent by either
end of the TCP connection.
NOTE: When used to encapsulate the CIP, the SendUnitData command is used to send CIP
connected data in both the O⇒T and T⇒O directions.
Interface handle and Timeout shall be set the zero. The timeout field is not used since no reply
is generated upon receipt of a SendUnitData command.
– 2-19 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
– 2-20 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
If an originator process detects that a target has closed its end of a connection or that a
connection is broken, it assumes the session with the target is broken and closes its connection
to the target. A new session is then established as described above in order to resume
communications with the target.
Although an originator process is notified when the other end of a connection has been closed,
a broken connection can only be detected when a process actually attempts to send a message
over the connection. In most cases, the originator process sends messages to targets frequently
enough that a crash of a target machine is detected in a timely manner. Likewise, targets send
messages back to originators frequently enough that terminated originator processes and
originator machine crashes are detected quickly. However, it is possible that an originator or
target may not have any messages to send on a connection for a relatively long period of time.
The TCP protocol supports keep-alive processing. An application can ask TCP to make sure
the connection remains working during periods when the application does not have any
messages to send. If this feature is enabled, when the connection has been idle for some period
of time, TCP will send a keep-alive message to its peer at the other end of the connection. If
TCP sends several keep-alive messages and does not receive a reply, TCP assumes the
connection has broken and the application is notified just as if it had sent an actual message that
timed out.
– 2-21 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
2-6.1 General
The common packet format shall consist of an item count, followed by an address item, then a
data item (in that order) as shown below. Additional optional items may follow.
NOTE: The common packet format defines a standard format for protocol packets that are
transported with the encapsulation protocol. The common packet format is a general-purpose
mechanism designed to accommodate future packet or address types.
– 2-22 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
NOTE: Connection identifiers are exchanged in the Forward_Open service of the Connection
Manager.
– 2-23 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
NOTE: The format of the “data” field is dependent on the encapsulated protocol. When used
to encapsulate CIP, the format of the “data” field is that of a Message Router request or
Message Router reply. See chapter 3 of this specification for details of the encapsulation of
UCMM messages. See chapter 2 of the CIP Common specification for the format of the
Message Router request and reply packets.
The context field in the encapsulation header shall be used for unconnected request/reply
matching.
– 2-24 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
NOTE: The format of the “data” field is dependent on the encapsulated protocol. When used
to encapsulate CIP, the format of the “data” field is that of connected packet. See chapter 3 of
this specification for details of the encapsulation of connected packets. See chapter 3 of the
CIP Common specification for the format of connected packets.
NOTE: The structure of the Sockaddr item has been patterned after the sockaddr_in structure
from the Winsock specification, version 1.1.
– 2-25 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 2: Encapsulation Protocol
– 2-26 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP
Contents
3-1 Introduction........................................................................................................................................................3
3-2 CIP Packets over TCP/IP ...................................................................................................................................3
3-2.1 Unconnected Messages ..............................................................................................................................3
3-2.2 CIP Transport Class 0 and Class 1 Connections ........................................................................................4
3-2.2.1 CIP transport Class 0 and Class 1 Packets .........................................................................................4
3-2.2.2 Behavior of Class 0 and Class 1 Connections (informative)..............................................................4
3-2.2.3 No Linkage with TCP Connections ...................................................................................................5
3-2.3 CIP Transport Class 2 and Class 3 Connections ........................................................................................5
3-2.4 CIP Transport Classes 4 Through 6 ...........................................................................................................6
3-3 Connection Manager Object ..............................................................................................................................6
3-3.1 Connection Parameters ..............................................................................................................................6
3-3.2 Connection Type ........................................................................................................................................6
3-3.3 Priority .......................................................................................................................................................6
3-3.4 Trigger Type ..............................................................................................................................................6
3-3.5 Connection Size .........................................................................................................................................6
3-3.6 Connection Request Timeout.....................................................................................................................6
3-3.7 Connection Path .........................................................................................................................................7
3-3.7.1 Network Connection ID .....................................................................................................................8
3-3.8 Forward_Open for CIP Transport Class 2 and Class 3 Connections........................................................10
3-3.9 Forward_Open for CIP Transport Class 0 and Class 1 Connections........................................................11
3-3.9.1 General.............................................................................................................................................11
3-3.9.2 Mapping Connections to IP Multicast Addresses ............................................................................11
3-3.9.3 Completing the Multicast Connection (informative)........................................................................11
3-4 CIP Transport Class 0 and Class 1 Connected Data ........................................................................................12
3-4.1 UDP Datagrams .......................................................................................................................................12
3-4.2 CIP Transport Class 0 and Class 1 Packet Ordering ................................................................................12
3-4.3 Screening Incoming Connected Data.......................................................................................................13
3-5 IP Multicast Scoping and Address Allocation .................................................................................................13
3-5.1 Background (informative)........................................................................................................................13
3-5.1.1 General.............................................................................................................................................13
3-5.1.2 IP Multicast Scoping Practices.........................................................................................................14
3-5.1.3 IP Multicast Address Allocation Practices .......................................................................................14
3-5.2 Multicast Scoping for EtherNet/IP...........................................................................................................15
3-5.3 Multicast Address Allocation for EtherNet/IP .........................................................................................15
3-5.4 User Considerations (informative) ...........................................................................................................17
3-5.5 Future Directions for EtherNet/IP (informative)......................................................................................17
3-6 IGMP Usage.....................................................................................................................................................18
3-6.1 Background (informative)........................................................................................................................18
3-6.2 IGMP Membership Report Messages ......................................................................................................18
3-6.3 IGMP Leave Group messages..................................................................................................................18
– 3-2 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 3: Mapping of Explicit and I/O Messaging
to TCP/IP
3-1 Introduction
This chapter (chapter 3) of the EtherNet/IP specification describes the application of the
encapsulation in chapter 2 to the Common Industrial Protocol (CIP). Specifically, this chapter
documents the encapsulation of the UCMM and connected packets; extends the format of the
path to include IP addresses; and limits which CIP transport parameters can be used in
combination.
– 3-3 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 3: Mapping of Explicit and I/O Messaging
to TCP/IP
Table 3-2.2 UCMM Reply
On Ethernet, it is possible for a CIP transport class 0 or class 1 connected data packet to be lost,
for example due to excessive collisions. By definition, class 0 and class 1 connections do not
guarantee the delivery of every packet. Rather, producers simply send data at the specified rate
(the API). If a packet is lost on a class 0 or class 1 connection, the consumer receives the next
packet from the producer.
The degree to which lost packets can be tolerated is application-specific. Ethernet is not
suitable for those applications that cannot tolerate any lost packets.
– 3-4 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 3: Mapping of Explicit and I/O Messaging
to TCP/IP
For CIP transport class 1 connections, the consuming CIP transport can detect packet loss by
examining the CIP sequence number in the class 1 packet. For class 0 connections, it is not
possible for the application to know that a specific packet has been lost since class 0 does not
use a sequence number.
The connection timeout mechanism provides feedback to the application when too many
packets are lost. The connection timeout is determined by the Requested Packet Interval (RPI)
and by the Connection Timeout Multiplier. If a packet is not received in the time specified by
the RPI times the Connection Timeout Multiplier, the connection is broken. For example, if
the RPI is 50 ms and the Connection Timeout Multiplier is 4, then the connection will time out
if a fresh packet is not received in 200 ms (the equivalent of 4 packets being lost). Receipt of
older packets (those with lower CIP sequence numbers) will not sustain the CIP connection.
The degree of packet loss for any particular connection will be dependent upon many factors
related to the user's Ethernet network configuration. It is beyond the scope of this specification
to address this in further detail.
Although it is recommended that devices leave the TCP connection open, there shall be no
linkage between the TCP connection used to open a transport class 0 or class 1 connection and
the resulting class 0 or class 1 connection. If a TCP connection closes, the closing of the TCP
connection shall not cause the target or the originator to close any corresponding CIP transport
class 0 or class 1 connections.
Multiple CIP connections may be sent over a single TCP connection. An implementation need
not support a specific number of CIP connections per TCP connection. An implementation
may impose an upper bound if it chooses.
Because of the full-duplex nature of TCP, the CIP originator to target (O⇒T) and CIP target to
originator (T⇒O) link connections shall use the same TCP connection. However if a target
subsequently originates a CIP connection, then it shall be considered an originator, and a
different TCP connection shall be used.
NOTE: This standard defines no requirements for management of the TCP connection, such as
inactivity timeouts, or closing the TCP connection when all native connections are closed.
However, implementations are free to implement these.
– 3-5 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 3: Mapping of Explicit and I/O Messaging
to TCP/IP
3-2.4 CIP Transport Classes 4 Through 6
The encapsulation protocol described in chapter 2 shall not be used to encapsulate CIP
transport classes 4, 5 and 6.
3-3.3 Priority
The CIP priority shall be LOW, or HIGH, or SCHEDULED. At present, SCHEDULED
priority shall be treated no differently than HIGH priority.
Targets and originators shall close any CIP transport class 2 or 3 connections when the
corresponding originating TCP connection is closed.
NOTE: SCHEDULED priority for Ethernet-TCP/IP connections may be further defined in the
future.
NOTE: The Forward_Open request limits the connection size to 511 bytes; however, the
optional Ex_Forward_Open allows larger connection sizes.
– 3-6 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 3: Mapping of Explicit and I/O Messaging
to TCP/IP
Because of the large variation in connection request processing over TCP/IP, CIP routers in the
connection path shall not subtract anything from the connection request timeout.
NOTE: Other TCP port numbers may be implemented; however, this specification does not
provide a mechanism to determine which TCP port numbers are supported by a device. The
use of other TCP port numbers is therefore discouraged. The guaranteed TCP port number,
0xAF12, has been reserved with the Internet Assigned Numbers Authority (IANA) for use by
the encapsulation protocol.
Since port segments must be word-aligned, a pad byte may be required at the end of the string.
The pad byte shall be 0x00, and shall not be counted in the Optional Address Size field of the
port segment.
NOTE: Examples of port segments are shown in Table 3-3.1 (see Volume 1 for the definition
of a port segment).
– 3-7 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 3: Mapping of Explicit and I/O Messaging
to TCP/IP
Table 3-3.1 TCP/IP Link Address Examples
3-3.7.1.1 General
For EtherNet/IP connections, the Network Connection ID shall be a 32-bit identifier
meaningful to the device that chooses it. The Network Connection ID need not be subdivided
into any specific fields.
In general, the consuming device selects the Network Connection ID for a point-to-point
connection, and the producing device selects the Network Connection ID for a multicast
connection. The following table shows which device, Target or Originator, shall choose the T-
>O and O->T Network Connection IDs:
The Network Connection ID shall not be reused until the connection has been closed or has
timed out. When a device restarts, it shall not reuse Network Connection IDs from previously
opened connections until those connections have been closed or have timed out. A specific
connection ID shall not be reused so long as there is the possibility that packets with that
connection ID are present in the network.
– 3-8 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 3: Mapping of Explicit and I/O Messaging
to TCP/IP
The following two sections describe possible methods to implement unique Network
Connection IDs.
Where:
Connection Number is a 16-bit identifier meaningful to the device choosing the Connection ID.
Incarnation ID is a 16-bit identifier that each device generates before accepting or initiating
any connections.
The Incarnation ID persists while the device is powered up and accepting connections. Each
successive power-up cycle must cause a new (unique) Incarnation ID to be generated. The
following are acceptable methods for generating Incarnation ID's:
Devices such as workstations, because of the large variation in startup time, can safely use the
value of the system clock as an Incarnation ID. However, for embedded devices, using the
system clock is not reliable since the firmware generally goes through the exact same sequence
of instructions at each powerup. This results in the same clock value at the point where it
would be selected for the Incarnation ID. For these embedded devices, the Incarnation ID
needs to be generated based on random inputs. This is best done using a pseudo-random
number generator such as the MD5 algorithm.
– 3-9 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 3: Mapping of Explicit and I/O Messaging
to TCP/IP
3-3.7.1.3 Pseudo-Random Connection ID Per Connection (informative)
This section describes another solution that prevents Connection ID reuse when a device
restarts. With this solution, the device generates a pseudo-random Connection ID each time a
class 0 or class 1 Connection ID is needed. The Connection ID format for this approach is
shown in Figure 3-3.2.
Where:
Connection Number is a 16-bit identifier meaningful to the device choosing the Connection ID.
With this approach, the device generates the Pseudo-Random Number portion each time a
Connection ID is needed. A "strong mixing function" such as the MD5 algorithm [RFC 1321]
[RFC 1750] should be used to generate the pseudo-random number. Such functions take
multiple input and produce pseudo-random outputs.
In order to prevent Connection IDs from being reused across powerups, the seed values for the
inputs to the MD5 algorithm must be unique across successive powerup cycles. The
recommended approach is to use the following inputs upon receiving the first incoming
connection request:
• Vendor ID, Serial Number, Connection Serial Number
• Contents of the sockaddr_in struct (for the next hop if outbound connection; of the sender
if inbound connection)
• Value of system clock
NOTE: This assumes the Ethernet device is a bridge or the Target of the connection and would
not be applicable if the device is the connection Originator. For connection originators, the
above seed values would likely be the same across successive powerups. Connection
originators must use another source for initial seed values, or else use the Incarnation ID
approach.
By definition, there is a non-zero probability that a Connection ID conflict may still occur.
However, the probability is lowered by:
– 3-10 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 3: Mapping of Explicit and I/O Messaging
to TCP/IP
3-3.9 Forward_Open for CIP Transport Class 0 and Class 1 Connections
3-3.9.1 General
The Forward_Open service for CIP transport class 0 and class 1 connections shall be sent over
a TCP connection using the SendRRData command defined in chapter 2. As part of the
Forward_Open dialog, the producer and consumer shall exchange the UDP port numbers and
IP multicast address (for multicast connections) necessary to send the CIP transport class 0 and
class 1 connected data. The Sockaddr Info item defined in Chapter 2 shall be used to encode
the UDP port numbers and IP multicast address. The use of the Sockaddr Info item varies
depending on whether the connection is multicast or point-to-point, and whether the connection
originator or the connection target is the producer.
For multicast connections, the producer shall choose an IP multicast address to which to send
the connected data. The port number shall be the registered UDP port number (0x08AE)
assigned by the IANA. The IP multicast address and UDP port number shall be encoded via a
Sockaddr Info item. A Sockaddr Info item shall be sent with Forward_Open (if the connection
originator is the producer), or with the Forward_Open_reply (if the connection target is the
producer).
For point-to-point connections, the consumer shall choose a UDP port number to which the
connected data shall be sent. The port number may be the registered port number (0x08AE) or
may be a port number chosen by the consumer. The port number shall be encoded in a
Sockaddr Info item and shall be sent with the Forward_Open (if the connection originator is the
consumer), or with the Forward_Open_reply (if the connection target is the consumer).
The Sockaddr Info item(s) shall be placed after the Forward_Open and/or Forward_Open_reply
data in the SendRRData command/reply. If the Sockaddr Info items are not present, or are in
error, a Forward_Open_reply shall be returned with status code 0x01 and extended status
0x205.
Since a unique IP multicast address per multicast connection is not required, consumers shall
be able to handle the situation in which packets from multiple multicast connections are being
sent to the same IP multicast address. Consumers shall be able to screen the incoming packets
based on the Connection ID and source IP address.
NOTE: Requirements for screening connected data are defined in section 3-4.3.
– 3-11 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 3: Mapping of Explicit and I/O Messaging
to TCP/IP
NOTE: When using UDP to transport CIP class 0 and class 1 connected data, there is no
guarantee that packets arrive in the same order that they were sent. When both sender and
receiver are on the same subnet, packets typically arrive in order. However, when going
through routers, when there are multiple paths that a packet could take, it is possible for packets
to arrive out of order.
For class 0 and class 1 connections over Ethernet, devices shall maintain a sequence number in
the UDP payload defined in section 3-4.1. The sequence number shall be maintained per
connection. Each time an Ethernet device sends a CIP class 1 packet, it shall increment the
sequence number for that connection. If the receiving Ethernet device receives a packet whose
sequence number is less than the previously received packet, the packet with the smaller
sequence number shall be discarded. Duplicate packets shall be accepted and given to the
transport layer.
The sequence number shall be operated on with modular arithmetic to deal with sequence
rollover.
NOTE: Dealing with 32-bit sequence numbers is described in RFC793 (the TCP definition), as
follows:
– 3-12 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 3: Mapping of Explicit and I/O Messaging
to TCP/IP
It is essential to remember that the actual sequence number space is finite, though very large.
This space ranges from 0 to 2**32 - 1. Since the space is finite, all arithmetic dealing with
sequence numbers must be performed modulo 2**32. This unsigned arithmetic preserves the
relationship of sequence numbers as they cycle from 2**32 - 1 to 0 again. There are some
subtleties to computer modulo arithmetic, so great care should be taken in programming the
comparison of such values. The symbol "=<" means "less than or equal" (modulo 2**32).
Example macros show how this may be done:
/*
* TCP sequence numbers are unsigned 32 bit integers operated
* on with modular arithmetic. These macros can be
* used to compare such integers.
*/
3-5.1.1 General
Two issues related to IP multicast must be considered when implementing EtherNet/IP
multicast connections: IP multicast scoping and IP multicast address allocation.
IP multicast scoping refers to the practice of limiting how widely a given multicast datagram is
propagated across the network. IP multicast address allocation refers to the problem of how
applications select IP multicast addresses that are used to send and receive IP multicast
datagrams.
– 3-13 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 3: Mapping of Explicit and I/O Messaging
to TCP/IP
The following subsections on multicast scoping and allocation practices are informative, and
are intended to set the general context for considering the issues of scoping and address
allocation. Specific requirements for EtherNet/IP devices follow in subsequent sections.
TTL scoping refers to the practice of using the “Time to Live” (TTL) field in the IP header to
limit the number of network hops over which the multicast packet is propagated. When
sending an IP multicast datagram, a host can set the TTL field in the IP header to an
appropriate value based on how widely the datagram should be propagated. As the datagram is
routed through the network, each hop decrements the TTL field. Routers can be configured
with TTL thresholds such that they will not forward a packet unless the TTL is greater than the
threshold.
Note that a multicast datagram with an initial TTL of 1 limits the datagram to the local subnet.
Other common TTL values are 16 for multicast within a site and 64 for multicast within a
region.
In addition to TTL scoping, multicast routing protocols and other methods are commonly used
to control the propagation of multicast traffic. Routers commonly support multicast protocols
such as PIM, DVMRP, etc. Switches that implement “IGMP snooping” can limit the multicast
packets sent on a port to only those multicast addresses for which the end device has issued an
IGMP membership message. Configuration of switches and routers is usually done by
knowledgeable staff.
Unfortunately at present there are no widely deployed standard mechanisms for allocating and
assigning multicast addresses to applications. For example, when a network administrator
deploys a video streaming application, the application will have its own specific mechanism for
assigning IP multicast addresses.
– 3-14 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 3: Mapping of Explicit and I/O Messaging
to TCP/IP
3-5.2 Multicast Scoping for EtherNet/IP
By default, EtherNet/IP devices shall use a TTL equal to 1 for transport class 0 and 1 multicast
packets. The use of a TTL value of 1 prevents multicast packets from propagating beyond the
local subnet. When TTL is equal to 1, both the EtherNet/IP producer and consumer must be on
the same subnet.
EtherNet/IP devices are strongly encouraged to support the explicit configuration of the TTL
value for IP multicast packets. If supported, devices shall use the TCP/IP Interface Object
(class 0xF5) as the mechanism to configure the TTL value. When a TTL value greater than 1 is
configured, then the producer and consumer may be on different subnets.
If the TTL value has not been configured to be greater than 1 and if a multicast connection
request is received from an originator on a different subnet, then the device shall return General
Status 0x01 and Extended Status 0x813 in the Forward_Open Reply.
When the TTL value is explicitly configured, it shall be used for all EtherNet/IP multicast
packets.
The overall IP multicast address range shall be the Organizational Local Scope, and shall
start at 239.192.1.0. Each device shall use a block of (at most) 32 multicast addresses from
this range. Each device shall calculate the block of multicast addresses via an algorithm,
described further below, that uses the Host Id portion of the device’s IP address.
A device’s Host Id shall be determined by applying the subnet mask to the device’s IP
address. If a subnet mask is configured for the device, the subnet mask shall be applied to
the IP address to determine the Host Id. If no subnet mask is in use, then the class of the
device’s IP address shall be used to determine the Host Id (e.g., for Class C addresses 8 bits
of Host Id shall be used, for Class B addresses 16 bits of host id shall be used, and for Class
A addresses 24 bits of Host Id shall be used).
In order to keep the IP multicast addresses within the IPv4 Organization Local Scope, and
to put a reasonable bounds on the number of multicast addresses in use, devices shall use at
most the low-order 10 bits of the Host Id in generating the range of multicast addresses.
This allows for 1024 unique Host Ids.
The following pseudo-code shows the algorithm to determine the device’s starting and
ending multicast addresses:
CIP_Mcast_Base_Addr = 0xEFC00100 // 239.192.1.0 is the starting address
CIP_Host_Mask = 0x3FF // 10 bits of host id
– 3-15 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 3: Mapping of Explicit and I/O Messaging
to TCP/IP
if Subnet_mask configured then
Netmask = Subnet_mask
else
if IP_address is Class A then
Netmask = 255.0.0.0
else if IP_address is Class B then
Netmask = 255.255.0.0
else if IP_address is Class C then
Netmask = 255.255.255.0
end_else
Since there are a finite number of unique Host Ids, it is possible for different devices to
produce data using the same multicast address. Consequently, devices that receive packets
on EtherNet/IP multicast connections shall screen the incoming packets based on the CIP
Connection Id as well as the IP address of the sending device. This is described in Chapter
3-4.3.
Note that when the device’s IP address or subnet mask changes, the IP multicast addresses
generated by the algorithm also shall change accordingly.
IP multicast addresses are configured via the TCP/IP Interface Object (class 0xF5). The
user (or software) can configure a starting multicast address and number of multicast
addresses to allocate. The configured multicast addresses shall then be used for EtherNet/IP
multicast packets.
EtherNet/IP devices shall at least implement the algorithmic method for allocating IP multicast
addresses, and are encouraged to implement both methods. If both methods are implemented,
the algorithmic method shall be the default “out of box” method.
– 3-16 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 3: Mapping of Explicit and I/O Messaging
to TCP/IP
3-5.4 User Considerations (informative)
This section is informational, and is meant to be an aid to vendors and users in the practical
deployment of EtherNet/IP applications. When deploying an EtherNet/IP system that uses
multicast connections, the user should consider a number of aspects in order to achieve
satisfactory application performance.
1. When devices allocate IP multicast addresses according to the default algorithm in section
3-6.3, the assignment of IP addresses to devices affects the way that IP multicast addresses
are selected. Users should be aware that only 10 bits the IP address are used to generate
the Host Id, which in turn determines the device’s range of IP addresses. If the user’s
subnet mask is larger than 10 bits, there is the potential for multiple devices to use the same
IP multicast address when producing data. While this does not result in incorrect
operation, it can result in devices experiencing performance degradation due to the receipt
of additional multicast packets that must be discarded.
2. When multicast addresses are explicitly configured, care should be taken so that devices in
the same subnet have unique blocks of multicast addresses. Further, if multicast
connections will cross subnet boundaries, then care must be taken to ensure that all devices
in the network have unique blocks of multicast addresses. When configuring multicast
addresses, it is recommended that addresses from the IPv4 Local Scope be used
(239.255.0.0 – 239.255.255.255) so as not to conflict with multicast address that may be
generated algorithmically.
3. Some routers experience performance degradation when they must handle many multicast
packets with TTL equal to 1. In such situations, users may configure TTL to be greater
than 1 even though I/O connections do not need to cross subnets. When setting TTL
greater than 1, it is recommended that users also configure multicast addresses for each
device. If multicast addresses are not explicitly configured, they are generated according to
the algorithm in the specification. Care must be taken in this situation since devices in
different subnets could generate the same IP multicast addresses. The multicast packets
sent from one subnet would then be received on the other subnet, possibly impacting
performance. In order to prevent unwanted multicast propagation, the user must perform
additional router configuration to constrain the EtherNet/IP multicast packets to the subnet
on which they originate. There are several techniques for constraining multicast at the
router. Router configuration is beyond the scope of this specification.
4. Users are strongly recommended to use switches that implement IGMP snooping. When
IGMP snooping is used, devices will only receive the multicast packets in which they are
interested (i.e., for which they have issued an IGMP membership message).
– 3-17 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 3: Mapping of Explicit and I/O Messaging
to TCP/IP
Since EtherNet/IP devices make extensive use of IP multicast for CIP transport class 0 and 1
connections, consistent IGMP usage by EtherNet/IP devices is essential in order to create well-
functioning EtherNet/IP application networks.
Devices shall also send Membership Report messages in response to Membership Query
messages, per the IGMP RFCs.
– 3-18 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 3: Mapping of Explicit and I/O Messaging
to TCP/IP
1. When the T->O Connection Type is multicast (originator is multicast consumer), the
originator shall issue a Leave Group upon receipt of a successful Forward_Close reply if
the originator has no other open connections consuming on that IP multicast address.
2. When the O->T Connection Type is multicast (target is multicast consumer), the target
shall issue a Leave Group upon sending a successful Forward_Close reply if the target has
no other open connections consuming on that IP multicast address.
3. In the event of a connection timeout, the multicast consumer (whether target or originator)
shall issue a Leave Group message if the multicast consumer has no other connections
consuming on that IP multicast address.
– 3-19 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 3: Mapping of Explicit and I/O Messaging
to TCP/IP
– 3-20 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP
Contents
4-1 Introduction........................................................................................................................................................3
– 4-2 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP,Chapter 4: Object Model
4-1 Introduction
This chapter of the EtherNet/IP specification contains additions to the CIP object model that
are EtherNet/IP specific. At this time, no such additions exist.
– 4-3 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP,Chapter 4: Object Model
– 4-4 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP
Contents
5-1 Introduction........................................................................................................................................................3
5-2 Reserved Class Codes ........................................................................................................................................3
5-3 TCP/IP Interface Object.....................................................................................................................................4
5-3.1 Scope..........................................................................................................................................................4
5-3.2 Attributes....................................................................................................................................................4
5-3.2.1 Class Attributes ..................................................................................................................................4
5-3.2.2 Instance Attributes .............................................................................................................................4
5-3.2.2.1 Status Instance Attribute .................................................................................................................7
5-3.2.2.2 Configuration Capability Instance Attribute ...................................................................................7
5-3.2.2.3 Configuration Control Instance Attribute .......................................................................................8
5-3.2.2.4 Physical Link Object.......................................................................................................................9
5-3.2.2.5 Interface Configuration ...................................................................................................................9
5-3.2.2.6 Host Name ....................................................................................................................................10
5-3.2.2.7 TTL Value.....................................................................................................................................10
5-3.2.2.8 Mcast Config.................................................................................................................................11
5-3.3 Common Services ....................................................................................................................................12
5-3.3.1 All Services ......................................................................................................................................12
5-3.3.2 Get_Attribute_All Response ............................................................................................................12
5-3.3.3 Set_Attribute_All Request ...............................................................................................................13
5-3.4 Behavior...................................................................................................................................................13
5-4 Ethernet Link Object........................................................................................................................................15
5-4.1 Scope........................................................................................................................................................15
5-4.2 Revision History ......................................................................................................................................15
5-4.3 Attributes..................................................................................................................................................15
5-4.3.1 Class Attributes ................................................................................................................................15
5-4.3.2 Instance Attributes ...........................................................................................................................16
5-4.3.2.1 Interface Flags...............................................................................................................................18
5-4.3.2.2 Interface Speed..............................................................................................................................18
5-4.3.2.3 Physical Address ...........................................................................................................................19
5-4.3.2.4 Interface Counters .........................................................................................................................19
5-4.3.2.5 Media Counters .............................................................................................................................19
5-4.3.2.6 Interface Control ...........................................................................................................................19
5-4.3.2.7 Interface Type ...............................................................................................................................20
5-4.3.2.8 Interface State ...............................................................................................................................21
5-4.3.2.9 Admin State ..................................................................................................................................21
5-4.3.2.10 Interface Label ............................................................................................................................21
5-4.4 Common Services ....................................................................................................................................21
5-4.4.1 All Services ......................................................................................................................................21
5-4.4.2 Get_Attribute_All Response ............................................................................................................22
5-4.5 Class-Specific Services ............................................................................................................................22
5-4.5.1 Get_and_Clear Service.....................................................................................................................22
– 5-2 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 5: Object Library
5-1 Introduction
In this standard, object modeling is used to represent the network visible behavior of devices.
Devices are modeled as a collection of objects. Each class of objects is a collection of related
services, attributes and behaviors. Services are the procedures that an object performs.
Attributes are characteristics of objects represented by values, which can vary. An object’s
behavior is an indication of how the object responds to particular events.
This chapter of the specification contains the object descriptions specific to EtherNet/IP. The
rest of the object descriptions can be found in the Volume 1, Chapter 5. With respect to the
OSI reference model, CIP objects perform the Layer 7 Application functions. They also
provide a mechanism to access station management counters via the network.
– 5-3 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 5: Object Library
TCP/IP Object, Class Code: F5Hex
The TCP/IP Interface Object provides the mechanism to configure a device’s TCP/IP network
interface. Examples of configurable items include the device’s IP Address, Network Mask, and
Gateway Address.
The underlying physical communications interface associated with the TCP/IP Interface Object
shall be any interface that supports the TCP/IP protocol. For example, a TCP/IP Interface
Object may be associated any of the following: an Ethernet 802.3 interface, an ATM interface,
a serial port running SLIP, a serial port running PPP, etc. The TCP/IP Interface Object
provides an attribute that identifies the link-specific object for the associated physical
communications interface. The link-specific object is generally expected to provide link-
specific counters as well as any link-specific configuration attributes.
Each device shall support exactly one instance of the TCP/IP Interface Object for each TCP/IP-
capable communications interface on the module.
5-3.2 Attributes
– 5-4 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 5: Object Library
TCP/IP Object, Class Code: F5Hex
Attr Need In Access Rule Name Data Description of Semantics of Values
ID Implem Type Attribute
4 Required Get Physical Link STRUCT Path to physical See section 5-3.2.2.4
Object of: link object
Path size UINT Size of Path Number of 16 bit words
in Path
Path Padded Logical segments The path is restricted to
EPATH identifying the one logical class segment
physical link and one logical instance
object segment. The maximum
size is 12 bytes. See
Appendix C of Volume
1, Logical Segments.
5 Required Set Interface STRUCT TCP/IP network See section 5-3.2.2.5
Configuration of: interface
configuration.
IP Address UDINT The device’s IP Value of 0 indicates no IP
address. address has been
configured. Otherwise,
the IP address shall be set
to a valid Class A, B, or C
address and shall not be
set to the loopback address
(127.0.0.1).
Network Mask UDINT The device’s Value of 0 indicates no
network mask network mask address has
been configured.
Gateway UDINT Default gateway Value of 0 indicates no IP
Address address address has been
configured. Otherwise,
the IP address shall be set
to a valid Class A, B, or C
address and shall not be
set to the loopback address
(127.0.0.1).
Name Server UDINT Primary name Value of 0 indicates no
server name server address has
been configured.
Otherwise, the name
server address shall be set
to a valid Class A, B, or C
address.
Name Server 2 UDINT Secondary name Value of 0 indicates no
server secondary name server
address has been
configured. Otherwise,
the name server address
shall be set to a valid Class
A, B, or C address.
Domain Name STRING Default domain ASCII characters.
name Maximum length is 48
characters. Shall be
padded to an even number
of characters (pad not
included in length). A
length of 0 shall indicate
no Domain Name is
configured.
– 5-5 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 5: Object Library
TCP/IP Object, Class Code: F5Hex
Attr Need In Access Rule Name Data Description of Semantics of Values
ID Implem Type Attribute
6 Required Set Host Name STRING Host name ASCII characters.
(Optional. Maximum length is 64
See section characters. Shall be
5-3.2.2.6) padded to an even
number of characters
(pad not included in
length). A length of 0
shall indicate no Host
Name is configured. See
section 5-3.2.2.6.
7 Conditional1 Safety 6 octets See CIP Safety
Network Specfication,
Number Volume 5,
Chapter 3
8 Conditional2 Get TTL Value USINT TTL value for Time-to-Live value for
Set is EtherNet/IP IP multicast packets.
conditional3 multicast packets Default value is 1.
Minimum is 1; maximum
is 255
See Chapter 5-3.2.2.7.
2
9 Conditional Get Mcast Config STRUCT IP multicast See Chapter 5-3.2.2.8.
Set is of: address
conditional3 configuration
Alloc Control USINT Multicast address See Chapter 5-3.2.2.8 for
allocation control details.
word. Determines whether
Determines how multicast addresses are
addresses are generated via algorithm
allocated. or are explicitly set.
Reserved USINT Reserved for Shall be 0.
future use
Num Mcast UINT Number of IP The number of IP
multicast multicast addresses
addresses to allocated, starting at
allocate for “Mcast Start Addr”.
EtherNet/IP Maximum value is
device specific, however
shall not exceed the
number of EtherNet/IP
multicast connections
supported by the device.
Mcast Start UDINT Starting multicast IP multicast address
Addr address from (Class D). A block of
which to begin “Num Mcast” addresses
allocation. is allocated starting with
this address.
1 – This attribute is required for EtherNet/IP safety devices. Non-safety devices shall not implement this attribute.
2 – If either TTL Value or Mcast Config is implemented, both must be implemented.
3 – If either TTL Value or Mcast Config is implemented as settable, both must be implemented as settable.
– 5-6 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 5: Object Library
TCP/IP Object, Class Code: F5Hex
5-3.2.2.1 Status Instance Attribute
The Status attribute is a bitmap that shall indicate the status of the TCP/IP network interface.
Refer to the state diagram in section 5-3.4, Behavior, for a description of object states as they
relate to the Status attribute.
– 5-7 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 5: Object Library
TCP/IP Object, Class Code: F5Hex
5-3.2.2.3 Configuration Control Instance Attribute
The Configuration Control attribute is a bitmap used to control network configuration
options.
Devices are not required to support any of the particular values of the Startup Configuration
bits, however a device must support at least one method of obtaining an initial TCP/IP interface
configuration.
Some devices, in particular low-end devices, may choose to obtain network interface
configuration via BOOTP or DHCP only. The use of BOOTP and/or DHCP may not be
appropriate for all devices. DHCP in particular supports dynamically allocated IP addresses,
which could result in a device getting a different IP address each time it powers up. This
behavior is not appropriate for devices that need to have static IP addresses.
A device may obtain its initial IP address via BOOTP or DHCP and then have that address
retained in non-volatile storage. After receiving an IP address via BOOTP or DHCP, the
address can be retained by setting the Startup Configuration bits to 0.
Out of the box, a device may wish to obtain its initial configuration via some method other than
BOOTP or DHCP. For example, the device may wish to obtain its initial configuration over an
attached serial port. In this case, the device should have its Startup Configuration bits set to 0,
and its Interface Configuration attribute fields to all 0s. The device should then wait to be
configured.
Once a device is up and running, when the value of the Startup Configuration bits is 0, a
request to set the Interface Configuration attribute shall cause the device to store the contents of
the Interface Configuration attribute in non-volatile storage if supported by the device. The
Startup Configuration bits shall not be set to 0 unless the Interface Configuration attribute
minimally contains a valid IP address. Otherwise the device could be rendered unable to
communicate on the network.
Additional standard configuration methods are may be adopted in the future as they are
developed and accepted by the Internet community. Non-standard techniques, including
various forms of "IP Gleaning," which rely upon arrival of unusual sequences of messages shall
not be used for configuration of EtherNet/IP nodes.
– 5-8 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 5: Object Library
TCP/IP Object, Class Code: F5Hex
5-3.2.2.4 Physical Link Object
This attribute identifies the object associated with the underlying physical communications
interface (e.g., an 802.3 interface). There are two components to the attribute: a Path Size (in
UINTs) and a Path. The Path shall contain a Logical Segment, type Class, and a Logical
Segment, type Instance that identifies the physical link object. The maximum Path Size is 6
(assuming a 32 bit logical segment for each of the class and instance).
The physical link object itself typically maintains link-specific counters as well as any link-
specific configuration attributes. If the CIP port associated with the TCP/IP Interface Object
has an Ethernet physical layer, this attribute shall point to an instance of the Ethernet Link
Object (class code = 0xF6). When there are multiple physical interfaces that correspond to the
TCP/IP interface, this attribute shall either contain a Path Size of 0, or shall contain a path to
the object representing an internal communications interface (often used in the case of an
embedded switch).
The TCP/IP Interface Object shall apply the new configuration upon completion of the Set
service. If the value of the Startup Configuration bits (Configuration Control attribute) is 0, the
new configuration shall be stored in non-volatile memory. The device shall not reply to the set
service until the values are safely stored to non-volatile storage. An attempt to set any of the
components of the Interface Configuration attribute to invalid values (see Semantics of Values
in Table 5-3.2) shall result in an error (status code 0x09) returned from the Set service.
Devices are not required to support the Set service. Some implementations, for example those
running on a PC or Workstation, need not support setting the network interface configuration
via the TCP/IP Interface Object.
– 5-9 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 5: Object Library
TCP/IP Object, Class Code: F5Hex
Table 5-3.7 Interface Configuration Attribute
Name Meaning
IP address The device’s IP address.
Network mask The device’s network mask. The network mask is used when the IP network has
been partitioned into subnets. The network mask is used to determine whether an IP
address is located on another subnet.
Gateway address The IP address of the device’s default gateway. When a destination IP address is on
a different subnet, packets are forwarded to the default gateway for routing to the
destination subnet.
Name server The IP address of the primary name server. The name server is used to resolve host
names. For example, that might be contained in a CIP connection path.
Name server 2 The IP address of the secondary name server. The secondary name server is used
when the primary name server is not available, or is unable to resolve a host name.
Domain name The default domain name. The default domain name is used when resolving host
names that are not fully qualified. For example, if the default domain name is
“odva.org”, and the device needs to resolve a host name of “plc”, then the device will
attempt to resolve the host name as “plc.odva.org”.
The host name attribute does not need to be set for the device to operate normally. The value of
the Host Name attribute, if it is configured, shall be used for the value of the FQDN option in
the DHCP request. If the Host Name attribute has not been configured then the device shall not
include the FQDN option in the DHCP request.
For devices that do not support the DHCP-DNS capability, or are not configured to use DHCP,
then the host name can be used for informational purposes.
The set access is optional when the Interface Configuration attribute is not settable. Some
devices, for example, a PC or workstation, may not allow the Interface Configuration or Host
name to be set via the TCP/IP interface object. If the set is not implemented, an “Attribute not
settable” (0x0E) error shall be returned in response to a “Set attribute single” request.
– 5-10 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 5: Object Library
TCP/IP Object, Class Code: F5Hex
When set, the TTL Value attribute shall be saved in non-volatile memory, and shall take affect
the next time the device starts. Setting the TTL Value attribute shall also cause the Mcast
Pending bit in the Interface Status attribute to be set, indicating that there is pending
configuration. When a new TTL Value is pending, Get_Attribute_Single or Get_Attributes_All
requests shall return the pending value. The Mcast Pending bit shall be cleared the next time
the device starts.
Users should exercise caution when setting the TTL Value greater than 1, to prevent unwanted
multicast traffic from propagating through the network. Chapter 3 includes a discussion on user
considerations when using multicast.
Alloc Control determines how the device shall allocate IP multicast addresses (e.g., whether
by algorithm, whether they are explicitly set, etc.) Table 5-3.8 shows the details for Alloc
Control.
Num Mcast is the number of IP multicast addresses allocated. The maximum number of
multicast addresses is device specific, but shall not exceed the number of EtherNet/IP multicast
connections supported by the device.
Mcast Start Addr is the starting multicast address from which Num Mcast addresses are
allocated.
When set, the Mcast Config attribute shall be saved in non-volatile memory, and shall take
affect the next time the device starts. Setting the Mcast Config attribute shall also cause the
Mcast Pending bit in the Interface Status attribute to be set, indicating that there is pending
configuration. When a new Mcast Config value is pending, Get_Attribute_Single or
Get_Attributes_All requests shall return the pending value. The Mcast Pending bit shall be
cleared the next time the device starts.
When the multicast addresses are generated using the default algorithm, Num Mcast and Mcast
Start Addr shall report the values generated by the algorithm.
– 5-11 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 5: Object Library
TCP/IP Object, Class Code: F5Hex
5-3.3 Common Services
The TCP/IP Interface Object shall provide the following common services.
For class attributes, (since there is only one class attribute) class attribute #1 shall be returned.
For instance attributes, attributes shall be returned in numerical order up to the last
implemented attribute. The Get_Attribute_All reply shall be as follows:
2 4 Configuration Capability
3 4 Configuration Control
2 Physical Link Object, Path Size
4
Variable, 12 bytes max Physical Link Object, Path (if Path Size is non-zero)
4 IP Address
4 Network Mask
4 Gateway Address
4 Name Server
5 4 Secondary Name Server
2 Domain Name Length
Variable,
Domain Name
equal to Domain Name Length
1 Pad byte only if Domain Name Length is odd
2 Host Name Length
Variable,
6 Host Name
equal to Host Name Length
1 Pad byte only if Host Name Length is odd
See CIP Safety Specification Volume 5, Chapter 3.
7 6 octets Not present if attribute 7 is not implemented. Shall be 0 when
additional attributes greater than attribute ID 7 are included.
– 5-12 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 5: Object Library
TCP/IP Object, Class Code: F5Hex
Attribute ID Size in Bytes Contents
TTL Value.
8 1 octet Not present if attribute 8 is not implemented. Shall be 0 when
additional attributes greater than attribute ID 8 are included.
Mcast Config.
9 8 octets Not present if attribute 9 is not implemented. Shall be 0 when
additional attributes greater than attribute ID 9 are included.
The lengths of the Physical Link Object path, Domain Name, and Host Name are not known
before issuing the Get_Attribute_All service request. Implementers shall be prepared to accept
a response containing the maximum sizes of the Physical Link Object path (6 UINTs), the
Domain Name (48 USINTs), and Host Name (64 USINTs).
The instance Set_Attribute_All request contains the Configuration Control attribute, followed
by the Interface Configuration attribute.
5-3.4 Behavior
The behavior of the TCP/IP Interface Object shall be as illustrated in the State Transition
Diagram below. Note that the act of obtaining an initial executable image via BOOTP/TFTP
shall not be considered within the scope of the TCP/IP Interface Object behavior. Devices are
free to implement such behavior, however it shall be considered to have occurred in the “Non-
existent” state.
– 5-13 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 5: Object Library
TCP/IP Object, Class Code: F5Hex
Figure 5-3.1 State Diagram Showing the Behavior of the TCP/IP Object
Non-existent
Powerup/Reset
Status = 0x00000000
BOOTP/DHCP
Obtaining Initial Disabled AND Stored
Configuration Config is Valid
Waiting for
Configuration
Set_Attributes BOOTP/DHCP
Request Received Response Received
Status = 0x00000000
Applying
Configuration
Configuration
Applied
Change Interface
Configuration
TCP/IP Network
Interface Configured
(Status = 0x00000001)
– 5-14 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 5: Object Library
Ethernet Link Object, Class Code: F6Hex
The Ethernet Link Object maintains link-specific counters and status information for a Ethernet
802.3 communications interface. Each device shall support exactly one instance of the Ethernet
Link Object for each Ethernet IEEE 802.3 communications interface on the module. Devices
may use an Ethernet Link Object instance for an internally accessible interface, such as an
internal port for an embedded switch, Refer to Chapter 6 (Device Profiles) for additional
information on multi-port EtherNet/IP devices.
Since the initial release of this object class definition changes have been made that require a
revision update of this object class. The table below represents the revision history.
5-4.3 Attributes
The Ethernet Link Object shall support the following class attributes.
An error reading the Class Revision attribute implies this is a revision 1 only implementation.
– 5-15 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 5: Object Library
Ethernet Link Object, Class Code: F6Hex
The Ethernet Link Object shall support the following instance attributes.
– 5-16 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 5: Object Library
Ethernet Link Object, Class Code: F6Hex
– 5-17 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 5: Object Library
Ethernet Link Object, Class Code: F6Hex
– 5-18 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 5: Object Library
Ethernet Link Object, Class Code: F6Hex
1. In each instance, count the MAC frames sent/received by the device itself over the port
represented by that instance (i.e., each physical interface counts the MAC frames
sent/received over that interface). This is the preferred solution.
2. Use counter values of 0 for those instances that correspond to the external switch ports;
count MAC frames in the instance that corresponds to the internal device interface
3. Use the same counter values for all instances, counting MAC frames sent/received by the
device itself
Note: some underlying hardware or system implementations may not provide all of the Media
Counters. In the case of fiber media, some of the counters do not apply (e.g., collision
counters). Devices shall use values of 0 for counters that are not implemented.
– 5-19 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 5: Object Library
Ethernet Link Object, Class Code: F6Hex
If auto-negotiation is enabled, attempting to set the Forced Interface Speed shall result in a
GRC hex 0x0C (Object State Conflict).
– 5-20 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 5: Object Library
Ethernet Link Object, Class Code: F6Hex
The Ethernet Link Object shall provide the following common services.
– 5-21 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 5: Object Library
Ethernet Link Object, Class Code: F6Hex
The Get_Attribute_Single shall be implemented for the class attribute if the class attribute is
implemented.
For class attributes, since there is only one possible attribute, the Get_Attribute_All response is
the same as the Get_Attribute_Single response. If no class attributes are implemented, then no
data is returned in the data portion of the reply.
For instance attributes, attributes shall be returned in numerical order, up to the last
implemented attribute. All 0’s shall be returned for the Interface Counters and Media Counters
attributes if they are not implemented but the Interface Control attribute is implemented.
The Ethernet Link Object shall support the following class-specific services:
The Get_and_Clear service is a class-specific service. It is only supported for the Interface
Counters and Media Counters attributes. The Get_and_Clear response shall be the same as the
Get_Attribute_Single response for the specified attribute. After the response is built, the value
of the attribute shall be set to zero.
– 5-22 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP
Contents
6-1 Introduction........................................................................................................................................................3
6-2 Required Objects................................................................................................................................................3
– 6-2 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 6: Device Profiles
6-1 Introduction
This chapter of the EtherNet/IP specification contains device profiles that are EtherNet/IP
specific.
NOTE: This specification permits the use of any medium that supports TCP/IP; however, only
the Ethernet medium has been completely standardized here. It is likely in the future that
ODVA/CI will standardize other link objects for frequently used TCP/IP media. For example,
in the future, a standardized PPP object may be defined.
Although it does not have an object class code, each device shall also implement the CIP
Unconnected Message Manager (UCMM).
Connection
Manager
Identity Object
Object Application
Objects
TCP/IP Message
Interface Router
Object Object
– 6-3 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 6: Device Profiles
Devices with multiple interfaces shall implement multiple instances of the TCP/IP interface
Object and physical link objects (e.g., Ethernet Link Object) as applicable to the device
function as listed below:
• 1 instance of the TCP/IP Interface Object for each TCP/IP interface (i.e., for each IP
address).
• 1 instance of a physical link object (e.g., Ethernet Link Object) for each physical interface
exposed via EtherNet/IP. Devices may elect not to expose all interfaces,
• Devices may use a physical link object instance (e.g., Ethernet Link Object) for an internal
interface such as the internal device port of an embedded switch.
• Devices with multiple IP addresses may elect to represent each IP interface as a different
CIP port, and allow CIP messages to be routed from one port to the other. For example,
the CIP connection path would enter one of the ports and exit the other port. In this
scenario, the device shall implement one instance of the Port Object for each CIP port, and
shall implement the CIP routing mechanism described in Volume 1. Devices are not
required to implement the Port Object unless they implement multiple CIP ports.
The following sections illustrate some of the different possibilities for devices with varying
numbers of Ethernet interfaces.
– 6-4 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 6: Device Profiles
TCP/IP
Interface
Object
Ethernet
Link Object
In this example, there are 2 instances of the TCP/IP Interface Object, and one instance of the
Ethernet Link Object that represents the physical interface. TCP/IP Interface Object class
attributes 2 (Max. instances) and 3 (Number of instances) are used. The instance attribute 4
(Physical Link Object) of both instances refers to the same Ethernet Link Object
TCP/IP TCP/IP
Interface Interface
Object Object
Ethernet
Link Object
– 6-5 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 6: Device Profiles
6-3.3 Case 3, Device with 2 Ethernet ports. Each port has an associated IP Address
Example : A device with a multiple Ethernet interfaces, each with an associated IP address.
Each interface would be a different CIP-addressable port (i.e., there would be a Port Object
instance per interface).
In this example, there are 2 instances of the TCP/IP Interface Object, and 2 instances of the
Ethernet Link Object that represent each the physical interface. TCP/IP Interface Object /
Ethernet Link Object class attributes 2 (Max. instances) and 3 (Number of instances) are used.
The new Ethernet Link instance attribute 10 (Interface Label) is used to get the correlation
between the Ethernet Link Object and the physical port.
TCP/IP TCP/IP
Interface Interface
Object Object
Ethernet Ethernet
Link Object Link Object
6-3.4 Case 4, Device with Multiple Ethernet interfaces and a single IP Address and CIP
Interface
Example:An example is a device with embedded switch technology (to support linear
topology), or an EtherNet/IP-enabled switch. In this case, the device has multiple Ethernet
interfaces, but the interfaces are not CIP-addressable ports (i.e., they do not have corresponding
CIP port numbers or Port Object instances).
It is however useful to allow configuration of the Ethernet interfaces, for example to set port
speed and duplex via the Ethernet Link Object. Note that there is no intent to specify switching
behavior of the device.
In this case, there is a single instance of the TCP/IP Interface Object, an optional “internal”
instance of the Ethernet Link Object (corresponding to the internal device port), and then
Ethernet Link Object instances for each of the physical interfaces.
New Ethernet Link Object class attributes 2 (Max. instances) and 3 (Number of instances) are
used. The new Ethernet Link instance attribute 10 (Interface Label) is used to get the
correlation between the Ethernet Link Object and the physical port. The new Ethernet Link
instance attribute 7 (Interface Type) defines the kind of object (internal/external).
– 6-6 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 6: Device Profiles
TCP/IP
Interface
Object
Ethernet
Link Object
Refer to Chapter 5 (Object Library) for specific EtherNet/IP object definitions and
requirements.
– 6-7 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 6: Device Profiles
– 6-8 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP
Contents
7-1 Introduction........................................................................................................................................................3
7-2 [Device Classification] section ..........................................................................................................................3
7-3 [Port] section......................................................................................................................................................3
– 7-2 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 7: Electronic Data Sheets
7-1 Introduction
This chapter of the EtherNet/IP specification contains additions to the definition of electronic
data sheets (EDS) that are EtherNet/IP specific. See the CIP Common specification for more
information about the format of electronic data sheets and the definition of EDS related terms
such as EDS section, EDS entry and EDS field.
The optional “Port Object” field shall be set to the path of the TCP Object for this port.
No additional requirements, beyond those in the CIP Common Specification (Volume 1), are
placed on the “Name” and “Port Number” fields. .
NOTE: An EDS for an EtherNet/IP device does not directly refer to the link object for the
EtherNet/IP port (for example, the Ethernet Link Object) since it can be referenced through the
TCP Object for the port.
– 7-3 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 7: Electronic Data Sheets
[Port]
Port1 =
TCP,
"EtherNet/IP port",
"20 F5 24 01",
1;
– 7-4 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP
Contents
8-1 Introduction........................................................................................................................................................3
8-2 General...............................................................................................................................................................3
8-3 Grounding (earthing) and Bonding ....................................................................................................................3
8-4 Environmental Compatibility.............................................................................................................................3
8-5 Auxiliary Power .................................................................................................................................................4
8-6 Supported Physical Topologies and relation to other networks .........................................................................4
8-7 Performance Levels............................................................................................................................................5
8-7.1 COMMERCIAL based EtherNet/IP products............................................................................................5
8-7.1.1 Copper and Fiber Cabling Components .............................................................................................5
8-7.1.2 active interfaces (PMD) .....................................................................................................................5
8-7.2 Industrial EtherNet/IP products..................................................................................................................6
8-7.2.1 EtherNet/IP Copper and Fiber Cabling Components .........................................................................6
8-7.2.2 Industrial EtherNet/IP Active Interfaces ............................................................................................6
8-8 COMMERCIAL Based EtherNet/IP Products and Physical Layer....................................................................6
8-8.1 Copper Media.............................................................................................................................................6
8-8.1.1 Cables.................................................................................................................................................6
8-8.1.2 Connectors .........................................................................................................................................6
8-8.1.3 Length Constraints .............................................................................................................................6
8-9 Industrial EtherNet/IP Media and Physical Layer..............................................................................................7
8-9.1 Environmental Requirements.....................................................................................................................7
8-9.2 Copper Media.............................................................................................................................................8
8-9.2.1 Copper Media Attachment (Normative References) ..........................................................................8
8-9.2.2 Copper Cabling Commercial and Industrial.......................................................................................8
8-9.2.3 Connectors .......................................................................................................................................11
8-9.2.4 Industrial EtherNet/IP TP-PMD (Normative References)................................................................21
8-9.3 Termination for a 10/100 Mbps Interface with 4 Pair Support ................................................................24
8-9.4 Shield Grounding .....................................................................................................................................25
8-9.4.1 Connectivity Device (Switch, Hub, Bridges, Routers, etc.) .............................................................25
8-9.4.2 Two Port Devices.............................................................................................................................25
8-9.4.3 Active Devices (sensor, PLC etc.) ...................................................................................................25
8-9.5 Fiber Media Variant .................................................................................................................................27
8-9.5.1 Cables...............................................................................................................................................27
8-9.5.2 Connectors .......................................................................................................................................27
8-9.5.3 Fiber PMD........................................................................................................................................29
8-9.5.4 Fiber Optic Transceivers ..................................................................................................................30
– 8-2 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
8-1 Introduction
Chapter 8 specifies EtherNet/IP media and physical layer requirements for EtherNet/IP
installations and active devices. In some cases, industrial environmental requirements may
exceed those used in office environments. Products and components may need to be enhanced
to provide the level of performance required to support industrial applications. Some of these
enhancements include noise rejection, sealing, voltage isolation, chemical resistance, shock,
vibration and wide/dynamic temperature ranges.
8-2 General
The following sections will delineate physical layer media variants for EtherNet/IP. This
standard does not define requirements for coaxial Ethernet components or commercial off the
shelf components (COMMERCIAL). Requirements for these components can be found in
ANSI IEEE 802.3 standard and TIA 568 standards. In this chapter, components that fall under
these standards will be referred to as “standard components”. Systems constructed of standard
components have been deployed in industrial environments primarily in information systems
and limited control applications. These systems, for the most part, have been successfully
providing services at 10 Mbps. Whether providing services at 10 Mbps or 100 Mbps, standard
components are recognized and acceptable for use within the guidelines of this specification.
However, because testing has shown that in order to survive harsh environments both in high
noise, diverse temperatures and the presence of chemicals both in liquid and solid forms, there
are system and component enhancements that are required.
– 8-3 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
AO
EtherNet/IP
To Generic cabling Linking Linking
HMI I/O PLC
system device device
according to
ISO/IEC24702
ControlNet
Coupling/ Linking
HMI I/O PLC
Potentially explosive area adaptor device
Coupling/ Isolation/
barrier
adaptor
ControlNet IS DeviceNet
a
Components are to be IS rated
There are three basic topologies for Ethernet based networks. EtherNet/IP supports all three of
the standard active physical topologies as detailed in Figure 8-6.2.
– 8-4 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
Linear Bus
Ring
Star Node
Branch
A switching device is expected to be a dedicated device usually located in the center of the star
physical topology. For other topologies such as the physical linear bus and ring the switching
device may be embedded in a node. A physical linear bus and ring device requires two physical
connections to the cabling infrastructure.
NOTE: There are many sections within this chapter that specify optional requirements. This
section distils these requirements into two distinct levels: commercial copper and fiber and
industrial EtherNet/IP copper and fiber.
Copper and fiber based COMMERCIAL active products shall meet the minimum requirements
of this chapter. Since these devices are not expected to be industrial hardened, they may
require additional mitigation when installed in a harsh environment. The copper interfaces
shall provide a non-sealed RJ-45 jack at the network interface. The fiber interface shall provide
connectivity to one of the non-sealed connectors detailed in 8-9.5.2.1 (LC, SC or ST).
– 8-5 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
These components are designed to better withstand high noise and harsh environments
common to the industrial environment. Additional consideration is required for the selection of
materials in special applications such as robotic and welding applications ect..
Copper and fiber-based Industrial EtherNet/IP products shall meet all applicable requirements
of the EtherNet/IP specification, chapter 9. For a product to achieve the Industrial EtherNet/IP
performance in harsh environments level, the physical layer shall conform to the requirements
as outlined in section 8-9 of this chapter.
8-8.1.1 Cables
The transmission performance of shielded or unshielded 4 pair twisted pair cables shall meet
the requirements of ANSI/TIA/EIA-568-B.2 standards and the requirements of E1 columns of
Table 8-9.4, Table 8-9.5 and Table 8-9.6.
8-8.1.2 Connectors
The RJ-45 connectors are the de-facto standard for Ethernet systems. RJ-45 connectors shall
meet the requirements stated in ANSI/TIA/EIA-568-B.2. In addition IEC 60603-7 series
defines the mechanical and electrical requirements for the RJ-45 connectors.
The total permanent link length for twisted pair systems is limited to 90m (295 ft). The
permanent link shall conform to ANSI/TIA/EIA-568-B.1.
The total channel length for twisted pair systems is 100m (328 ft) including patch cables as
defined in ANSI/TIA/EIA-568-B.1. Channel and patch cable design and testing shall be in
accordance with ANSI/TIA/EIA-568-B.1 and ‘B.2 respectively.
– 8-6 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
Copper and fiber based Industrial EtherNet/IP products should meet the minimum
environmental recommendations as defined in Table 8-9.1. Copper and Fiber cabling
components shall support the requirements in of Table 8-9.2. Active devices shall meet the
minimum EMI requirements of Table 8-9.2. The values found in Table 8-9.2 represent the
minimum requirements for IEC light industrial.
Shock (Unpackaged)
Acceleration 15g (operational)
IEC 60068-2-27
30g (non-operational)
Temperature
Operating range 0 °C min. to +60 °C min. * IEC 60068-2-1
IEC 60068-2-2
Storage -40 to +70 °C IEC 60068-2-1
IEC 60068-2-2
Humidity operating
IEC 60068-2-30
5 to 95% RH condensing
Ingress protection
IP 20 minimum IEC 60529
Voltage proof (connector only) IEC 60512-1
Contact/contact 1000 Vd.c. or a.c. peak
Contact/test panel 1500 Vd.c. or a.c. peak
* There may be components or topology de-rating for temperatures below 0 degrees C, or above 60 degrees C.
– 8-7 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
A copper media attachment to an EtherNet/IP network shall support shielded and unshielded
twisted pair technology. The specifications shall contain enhancements (where needed) based
on ANSI/TIA/EIA-568-B.1 category 5e cabling performance levels minimum. The signaling
and coupling of these variants shall comply with the requirements of IEEE 802.3, 2005 Ed/TP-
PMD standard subject to the deviations listed in this section 8-9.2.4. Likewise, the cable’s
electrical mechanical and environmental performance shall be as defined in section 8-4. The
IEEE 802.3 standard defines many internal interfaces within the physical layer. EtherNet/IP
products need not directly implement each of these interfaces, but shall behave as if these
interfaces exist. These interfaces may be internal to the node and possibly internal to a
semiconductor device.
This standard supports 10BASE T and 100BASE TX copper variants as defined by IEEE Std
802.3, 2005 Ed. and the ANSI X.3.263 TP-PMD. Two pair cabling does not support 100BASE-
T4 and is infrequently used, therefore 100BASE-T4 is not supported by this standard.
Active devices shall be fitted with one of the jacks defined by this chapter. Attached cables
with flying leads or flying leads with jacks are not allowed.
The cable is critical in influencing the performance of the network in the presence of high
noise. To support industrial information and industrial control systems two basic cable types
(Commercial and Industrial EtherNet/IP Cables) are recognized. Only cables adhering to this
specification will be eligible for the appropriate conformance check mark.
– 8-8 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
Table 8-9.3 Minimum Cable Requirements for Commercial and Industrial cabling
Industrial EtherNet/IP Cable Specifications and Requirements
Specification Type
Electrical Shielded Unshielded
Conductors 2 or 4 pairs + Shield 2 or 4 pairs
Attenuation Solid ANSI/TIA-EIA 568-B.2 Cat 5e Horizontal ANSI/TIA-EIA 568-B.2 Cat 5e Horizontal
Conductors
Attenuation Stranded ANSI/TIA-EIA 568-B.2 Cat 5e Patch 1 ANSI/TIA-EIA 568-B.2 Cat 5e Patch 1
Conductors
Impedance (fitted) ASTM 95-110 Ω 1-4 MHz 95-110 Ω 1-4 MHz
4566 95 – 107 Ω 4-100 MHz 95 – 107 Ω 4-100 MHz
RL (dB) 1-10 MHz 20 + 6Log10(f) 1-10 MHz 20 + 6Log10(f)
10-20 MHz 26 10-20 MHz 26
20-100 MHz 26-5*Log10(f/20) 20-100 MHz 26-5*Log10(f/20)
NEXT Loss (dB) ANSI/TIA-EIA 568-B.2 Cat 5e ANSI/TIA-EIA 568-B.2 Cat 5e
Coupling Attenuation (dB) Freq E1 E2 E3 NA
(MHz) See Table 8-9.5
Shielding Effectiveness tbd N/A
Capacitance unbalance <= 150pf/100meter < = 150pf /100meter
DCR 9.38 Ω/100 meters 9.38 Ω/100 meters
DCR Unbalance 3% 3%
TCL NA Frequency E1 E2 E3
(MHz)
See Table 8-9.4
ELTCTL Frequency E1 E2 E3
(MHz) See Table 8-9.5
Mechanical Shielded Unshielded
Pulling Tension 111 N 111 N
Breaking Strength 400 N 400 N
Bend Radius 1" at -20C 1" at –20C
Dimensional Shielded Unshielded
(Recommended for RJ 45
compatibility)
Jacket OD 0.315" Max 0.315" Max
Insulated Conductor 0.048" Max 0.048" Max
1 The insertion loss is based on COMMERCIAL cables. Other constructions, such as high flex, may have different
performance. Consult the manufacturer for more information.
8-9.2.2.1.1 Unshielded twisted pair transverse conversions loss (TCL) and equal level
transverse conversion transfer loss (ELTCTL)
Each pair of unshielded twisted-pair channels shall meet the TCL requirements of Table 8-9.4
and ELTCTL requirements of Table 8-9.5 below. TCL and ELTCTL shall be measured in
accordance with ANSI/TIA/EIA-568-B.2-9.
– 8-9 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
Each pair of screened twisted-pair channels shall meet the coupling attenuation requirements of
Table 8-9.6.
5e 30 ≤ f ≤100 40 50 60
Two and four pair cable color codes shall be as defined Table 8-9.7 and Table 8-9.8 in
respectively
– 8-10 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
8-9.2.3 Connectors
Attachment to the medium shall be via either of two types of Industrial grade RJ-45
connectors:
• Non-Sealed industrial RJ-45 EtherNet/IP connector – The RJ-45 EtherNet/IP connector
shall meet the IEC 60603-7 standard and additional requirements of this chapter.
• Sealed Industrial EtherNet/IP RJ-45 connector housing – The IP67 sealed industrial
EtherNet/IP connector housing shall conform to the specifications IEC 61076-3-106.
8-9.2.3.1.1 Sealed and Non-Sealed Industrial EtherNet/IP Connector
Standard industrial hardened RJ-45 connector shall meet the following specifications:
– 8-11 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
The non-sealed connector shall be wired in accordance with the pin/wire assignments in Table
8-9.9.
Both ends of the cable shall be wired the same unless constructing a crossover cable.
The sealing interface shall meet a minimum of IP67 sealing performance as defined in IEC
60529. The pin/pair wiring of section 8-9.2.3.1.1 applies to the Sealed Industrial EtherNet/IP 8-
Way modular connector. Cross over cable are allowed within the same connector family.
The Sealed RJ-45 variant 1 is based on the IEC 61076-3-106 specification. The following
sealed jack drawing sufficiently defines the jack to maintain compatibility for mating and
sealing amongst various vendors who may make one or both parts. The jack may be offered as
a PCB mount, bulkhead connector and cable end either field installed or manufactured
assembly. The jack is fully compatible with standard off-the-shelf plugs.
– 8-12 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
The Sealed RJ 45 variant 1 is based on the IEC 61076-3-106 specification. The following
sealed plug drawing sufficiently defines the plug to maintain compatibility for mating and
sealing amongst various vendors who may make one or both parts. The plug may be offered as
a field installable or manufactured cable assembly. The plug housing will accommodate a
standard plug as defined by IEC 60603-7 standard with the exception of the locking
mechanism, which is disabled.
The M12-4 “Type D” coding connector is well known and accepted in industrial ethernet
applications – for more than 20 years it has been the standard for connection of sensors in the
industry. The connector is defined in Amendment 1 to IEC 61076-2-101, 4-pin “Type D”
Coding. The 4-pin M12 connector is suitable for use with 2-pair shielded or unshielded
Ethernet cables only.
The M12-4 “D” coding connector shall be wired in accordance with the pin/wire assignments
in Table 8-9.10.
– 8-13 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
The 4-Pin M12 connector is suitable for use with 2 pair shielded or unshielded Ethernet cables
only.
Note:
“D” Coding Keyways
Pair 2 2 Pair 1 2
3 1 3 Pair 2
1
4 4
Cords using multi family connectors are permissible provided the number of conductors in the
cable is equal to the minimum contact number of connector of the least contact assignment.
For example, 4 pair cables shall not be used in the same channel with M12-4 “D” coding
connectors. An exception to this requirement is where the unused pairs of active channel are
terminated at their characteristic impedance. If terminated, a differential termination without
reference to ground is preferred. Figure 8-9.4 shows the concept of terminating the un-used
pairs of active channels in a 4 pair cable. The use of terminal strips is not recommended and is
only here for illustration. Termination is required at both ends of the active cable where the
pairs are not used.
– 8-14 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
PT U
2 pair cable
4 pair cable
Ohm
100
Blu
Blu/Wh
Ohm
100
un-used pairs
Brn/Wh
Brn
8-9.2.3.3 Coupler
A coupler consists of two closely spaced (less than 10cm) electrically connected interfaces.
Both interfaces are of the same physical mating interface.
A mated coupler shall conform to the transmission requirements of one connection of the
appropriate media and category.
If the interfaces are not electrically close or the coupler does not meet the transmission of the
appropriate media and category, then the coupler shall be counted as two mated connections.
8-9.2.3.4 Adapter
An adapter consists of two closely spaced electrically connected interfaces. They may be of
different circuit counts. Both interfaces may be of the same or different physical mating
interface; for example an M12-4 “D” coding connector to a RJ-45.
A mated adapter shall conform to the transmission requirements of one connection of the
appropriate media and category.
If they not electrically close or the adapter dose not meet the transmission of the appropriate
media and category, then the adapter shall be counted as two mated connections.
Bulkhead connectors allow systems to be designed and built in modular configurations. This
method should be considered based on user design and service preferences. Modularity
provides quick deployment and ease of serviceability.
– 8-15 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
The designer shall be aware of metallic bulkhead feed troughs that connect the cabling at the
enclosure wall. This may form a ground loop that could disrupt communications. Where a
ground loop may be formed, a separate grounding conductor should be installed to provide an
equal potential between the two points. An alternative method would be to isolate the bulkhead
feed through using an insulator between the bulkhead feed through and the enclosure wall.
The transmission performance requirements for a bulkhead connector are defined in section 8-
9.2.3.5. Figure 8-9.5 is an example of M12-4 D-coding EtherNet/IP bulkhead feed through
connectors.
Consult the manufacturer’s data sheet for mounting hole cut out dimensions. Consider the
panel minimum and maximum wall thickness of the enclosure when selecting a bulkhead.
EtherNet/IP specifications limit the channel to 100 meters or up to 90 meters horizontal wiring
with two 5-meter patch cords. Some applications will require longer patch cords. In these
applications the total length of horizontal wiring must be adjusted to compensate for the added
loss of each connector pair and additional patch cord length beyond 10m.
( 102 − H)
C (1)
( 1 + D)
Where:
C is the maximum combined length (m) of the work area cable, equipment cable, and patch
cord.
D is a de-rating factor for the patch cord type (0.2 for 24 AWG UTP/24 AWG ScTP and 0.5 for
26 AWG ScTP). The de-rating factors are based on COMMERCIAL cables. Other
constructions, such as high flex, may have different performance. Consult the manufacturer for
more information.
– 8-16 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
The maximum stranded cable length is limited to 85m for the channel with the standard 20%
derating for standard stranded cables.
Elevated temperatures cause higher signal loss in copper cables due to increased resistance.
This added loss must be considered in addition to the type of copper cable (solid conductor
horizontal or stranded conductor patch) to determine the maximum channel length. Shielded
(STP) copper cable typically exhibit 0.2% attenuation increase for every 1° C temperature rise
above 20° C to 60° C. Unshielded (UTP) Category 5e cables typically exhibit 0.4% attenuation
increase for every 1° C temperature rise from 20° C to 60° C. Unshielded (UTP) Category 6
cable exhibit 0.4% attenuation increase for every 1° C temperature rise from 20° C to 40° C
and 0.6% attenuation increase for every 1° C temperature rise from 40° C to 60° C, due to more
copper and plastic content. The elevated temperature insertion loss is based on
COMMERCIAL cables. Other constructions, such as high flex, may have different
performance. The change in attenuation with temperatures beyond 60° C is product specific.
Consult your supplier for more information.
The channel length and attenuation are linearly related, that is a 12% increase in attenuation
reduces the channel length 12%. The following examples show how to calculate the maximum
channel length for a given configuration and temperature.
AElev.Temp.=AIncrease Coefficient * Δ T
LElev.Temp.=AIncrease Coefficient * Δ T
Where: AElev.Temp = elevated temperature attenuation
AIncrease Coefficient = attenuation temperature coefficient
Δ T = change in temperature
LElev.Temp = elevated temperature maximum length
Assume you want to use solid conductor, Category 5e, horizontal cable at 60° C.
– 8-17 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
Note: The entire length should be treated as if the temperature is the worst-case temperature to
ensure a conservative, simplified calculation.
You are limited to 100 meters based on the cable type. This distance must be de-rated to
accommodate the elevated temperature. 60° C is 40° C above 20° C. 40° C times 0.4% equals
16% length reduction. The length reduction is calculated by taking the percent reduction times
the cable type length limit: 16% x 100 meters = 16 meters.
The maximum channel length is calculated by subtracting the elevated temperature length
reduction from the cable type channel limit: 100 meters – 16 meters = 84 meters. The
maximum channel length for all solid, horizontal Cat 5e cable at 60° C is 84 meters.
For all stranded conductor patch Cat 5e at 60° C we have the following:
Cable type channel limit= 85 meters
Temperature change = 40C
Temperature coefficient = 0.4%
Total change = 16%
Length reduction = 13.6 meters
Maximum channel length for all stranded, patch Cat 5 at 60° C is 68.7 meters.
For 25 meters solid, horizontal Cat 5e cable with some length of #24 AWG, stranded
conductor, Cat 5e patch at 40° C we have the following:
• 25 meters of solid, horizontal cable at 40° C has the loss of 8% more length of cable, 25 x
1.08 = 27 meters effective length
• Based on 27 meters we can have the effective length of patch as, (102-27)/(1+0.2)=62.5
• Total effective maximum stranded, patch length = 62.5 meters
• 62.5 meters of stranded, Cat 5e patch has 8% more loss then the actual length at 20° C,
62.5/1.08 = 57.9 meters actual length.
• The actual maximum stranded length = 57.9 meters
• The total channel length limit is the sum of the actual solid, horizontal cable maximum
length limit plus the actual stranded, patch cable maximum length limit, 25 + 57.9 = 82.9
meters
• The maximum channel length limit for 25 meters of solid conductor, horizontal Cat 5e
cable is 82.9 meters at 40° C with a maximum of 57.9 meters of stranded conductor, Cat 5e
patch cable.
8-9.2.3.7 Industrial Permanent Link
The length of a industrial permanent link is limited to that of 8-9.2.3.6 less the equivalent
length of 10 meters of patch cords.
The number of mated connections allowed in a channel is determined by the desired channel
performance (Category) and the performance level of the components selected. A Mated
Connection is defined as an electrically conductive communications path comprised of a mated
jack and plug. Back to back jack bulkheads may be counted as one connection provided they
meet the requirements of this chapter. Cable lengths between connecting hardware greater than
10cm shall be counted in the total channel/link appropriate cable length budget.
– 8-18 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
Alternate configurations should be field tested to ensure adequate performance. Table 8-9.12
provides guidance for connector cable performance levels to achieve a given category channel
for more than 4 connections.
a) A Category 5e channel topology can include up to 6-mated connections, where each mated
connection meets minimum Category 6A performance.
b) Maximum distance between jack and jack of the bulkhead connection is 10 cm. If the
distance is greater than 10 cm each plug/jack interface shall be considered as a separate mated
connection.
In order to maintain Category 5e performance in the channel for more than 4 mated
connections, Category 6A connections shall be used. See Table 8-9.13 for return loss and
NEXT, transmission requirements for construction of higher count channels.
Bulkhead cable glands provide entry/exit passages for permanently installed cables. Bulkhead
feed troughs and/or bulkhead connectors allow systems to be designed and built in modular
configurations. This method should be considered based on user design and service
preferences. Modularity provides quick deployment and ease of serviceability.
Figure 8-9.6 shows an intermediate cabling channel and a floor distribution channel created
using a fixed cable terminated at a closure bulkhead.
The length of the fixed cable used within a channel shall be determined by the equations shown
in section 8-9.2.3.6.
a) The flexible cable within these cords has a higher insertion loss specification than that used
in the fixed cable,
– 8-19 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
b) The cables within these cords in the channel have a common insertion loss specification.
The maximum length of the fixed cable will depend on the total length of cords to be supported
within a channel. During the operation of the installed cabling, a management system should be
implemented to ensure that the cords used to create the channel conform to the design rules for
the floor, building or installation.
Cable C
EQP NI
Cable C
EQP C C NI
Cable C
EQP C C NI
Equipment enclosure
c
c
c
Cable C
EQP c C C NI
c
c
patch
Panel
Equipment enclosure
Cable C
EQP C C C C NI
Apparatus enclosure
Equipment enclosure
c
c
c
Cable C
EQP c
C C C C NI
c
c
patch Apparatus enclosure
Panel
Equipment enclosure
c
c
c
Cable C
EQP c
C C C C C NI
c
c
patch NI = Network Interface Apparatus enclosure
Panel
EQP = Equipment
C = connector
C C = adaptor or bulkhead
– 8-20 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
A device that connects to the Industrial EtherNet/IP copper media shall conform to IEC 802.3
and ANSI X3.263 TP-PMD standard unless noted in this subclause.
The impedance at the media interface shall conform to ISO/IEC 802.3 (ANSI/IEEE Std 802.3)
and IEEE Std 802.3u-1995 supplement with the exception of impedance tolerance. The
temperature range and vibration shall be consistent with the targeted environment. In some
cases it may be necessary to add components to protect the PMD from surge, ESD, EFT and
conducted noises. Figure 8-9.10 is an example of how protection devices may be used to
protect the EtherNet/IP device. In order to maximize the performance in noise, it is critical that
the components selected for the PMD provide key characteristics. The transformer should
(highly recommended) provide a minimum of 59dB common mode rejection (CMR) at 30
MHz. In addition special care in the circuit board trace parameters is needed to maintain
impedance and noise immunity. Figure 8-9.7 is an example layout showing ground planes and
isolation areas to help maintain noise immunity.
0.08"
Optional
0.01uF/500V
1 M Ohm 1/4W
Earth
Power Ground
Planes
RJ-45
PHY
Chip
LED
LED
A copper media attachment to an EtherNet/IP network shall support shielded and unshielded
twisted pair technology. Active interfaces shall be compatible with ANSI/TIA/EIA-568-B.1
category 5e cabling system and cabling/component enhancements specified by this chapter.
The signaling, encoding and coupling of these variants shall comply with the requirements of
IEEE 802.3/TP-PMD and ANSI X3.263 TP-PMD standard subject to the deviations listed in
this chapter. Likewise, the cable’s electrical mechanical and environmental performance shall
be as defined in section 8-9.1. The environmental classifications that support this requirement
is defined the MICE table as defined by IEC 24702. The IEEE 802.3 standard defines many
internal interfaces within the physical layer. EtherNet/IP products need not directly implement
each of these interfaces, but shall behave as if these interfaces exist. These interfaces may be
internal to the node and possibly internal to a semiconductor device.
– 8-21 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
At a minimum active interfaces shall support 10BASE T and 100BASE TX as defined by IEEE
Std 802.3, 2000 Ed. and the ANSI X.3.263 TP-PMD. Two pair cabling will not support
100BASE-T4 therefore 100BASE-T4 interfaces are not supported by this standard.
Active devices are end devices such as computers, sensors and HMIs. These devices generally
support single network connections unless redundant. An active device with an embedded
switch shall support AutoMDIX on its ports and be wired in accordance with this sub chapter.
Repeaters should default to MDIX mode when AutoMDIX or Auto Negotiation is disabled.
Active devices shall be fitted with one of the jacks defined in this chapter. Attached cables with
flying leads or flying leads with jacks are not allowed. The jacks for active devices shall be
wired in accordance with the pin definition described in Table 8-9.9 and Table 8-9.10.
Connectivity devices are active devices used to control the flow of data throughout the
infrastructure. For example connectivity devices are classified as repeaters, switches, routers
and bridges. These devices may have one or more of the following ports, LAN, WAN, Uplink.
Figure 8-9.8 shows the relationship between LAN and WAN/Uplink ports for connectivity and
active devices. Connectivity devices such as Switches, routers and bridges shall be fitted with
jacks. The LAN side of the connectivity devices shall be wired in accordance with Table 8-9.14
and Table 8-9.15 or provide AutoMDIX. If the connectivity device supports AutoMDIX, then
it shall default to MDIX state when AutoMDIX is disabled. WAN ports including uplink ports
shall be wired in accordance with Table 8-9.9 and Table 8-9.10.
– 8-22 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
Connectivity Device
LAN Ports
Connectivity Device
WAN/uplink
Ports
Active Devices
Table 8-9.14 8-Way Modular Jack Pin Assignment for LAN Ports
PIN Signal Name
1 RXD+
2 RXD-
3 TXD+
4 NA1
5 NA1
6 TXD-
7 NA1
8 NA1
Table 8-9.15 M12-4 "D" Coding Jack Pin Assignment for LAN Ports
PIN Signal Name
1 RXD +
3 RXD -
2 TXD +
4 TXD -
– 8-23 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
Active devices shall use an appropriate termination technique such as found in Figure 8-9.9 for
both the used and unused pairs. The unused pairs shall be terminated into their characteristic
impedance at the device to prevent reflections of coupled energy. A common mode
termination shall be used to terminate the TXD and RXD pairs. The resistor values may be
adjusted between 50Ω and 75Ω to obtain 100Ω differential impedance and the appropriate
common mode impedance.
50 R 75
Unused
pairs
0.1 uf
50 R 75
0.1 uf
– 8-24 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
Magnetics
59dB CMMR
Ethernet 10/
100
Transmitter
Industrial
Grade RJ 2 or 4 Pair STP/
45 FTP Cable
Connector
Jack/Plug
Assembly
Ethernet 10/100
Receiver
Shield Termination
MOV
1 Meg Ohm
0.01uf
The communications shield shall be terminated directly to earth ground in accordance with
IEEE 802.3.
Two port devices that provide two active ports should not use ganged RJ 45 jacks with
common shields; doing so will propagate the grounds and potential cause ground loops in the
system. Termination of the shield shall be in accordance with Active Devices.
To prevent ground loops caused by shielded cables, devices shall not connect the shield directly
to ground. Industrial EtherNet/IP devices shall provide shield terminated as detailed in Figure
8-9.11. For Commercial active devices where the shielded RJ 45 connector provides direct
ground, the shield should be disconnected at the active device end of the channel as shown in
Figure 8-9.12 and Figure 8-9.13.
The shield termination for Industrial EtherNet/IP active devices, using a parallel resistor and
capacitor is shown in Figure 8-9.11.
– 8-25 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
RJ45
Shield
1Meg
.01 uF
Transient
500V
Protection
min.
Device
If the active device provides direct connection to ground through the RJ-45 connector, then the
shield shall not be connected at the RJ45 plug. Figure 8-9.12 and Figure 8-9.13 are examples of
how to break the shield at a device that is directly grounded.
Switch
Network
device
Ground here Do not ground here
Device Switch
BR
3 4 5 6 7 8
8
BR
W/BR
W/BL W/BR
74 5 6
O
O
W/BL
Latch
Latch
BL
BL
W/O
W/O
3
G
2
2
W/G
W/G
1
– 8-26 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
8-9.5.1 Cables
The following multimode fiber optic cables are in accordance with ANSI/TIA/EIA 568-B.3.
• 62.5/125µm
• 50/125µm
8-9.5.1.2 Single mode fiber optic 9/125µm
TBD
8-9.5.2 Connectors
The fiber media attachment to an EtherNet/IP network shall be limited to the LC, SC and ST
variants. The signaling and coupling for the fiber types shall be as specified in the IEEE 802.3
standard subject to the deviations listed in this section (section 8-9.5). The SC and ST
connectors are allowable, however are not recommended for new designs. SC and ST
connectors are legacy connectors with limited interfaces available. EtherNet/IP devices
utilizing the LC transceivers shall have duplex jacks with center spacing compatible with the
FOCIS standard of 0.246 inches (6.25mm). Permanently attached fiber pigtails shall not be
used.
– 8-27 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
Fiber optic connector designs shall meet the requirements of the corresponding ANSI/TIA/EIA
(Fiber Optic Connector Intermateability Standard (FOCIS) documents). In the case where the
LC fiber optic connector is placed into the IP65/67 shell or enclosure whereby the latch is
defeated, the FOCIS requirements may not be applicable. See Table 8-9.18 LC, SC and ST
Connector Insertion Loss.
The following sealed plug drawing in Figure 8-9.14 defines the plug. The plug is fully
compatible with standard off-the-shelf plugs with the exception of the defeated locking
mechanism when placed in the Variant 1 housing. The dimensions are expressed in inches
[mm].
The following sealed outlet/jack drawing in Figure 8-9.15 defines the outlet to maintain
compatibility for mating and sealing amongst various vendors who make one or both parts.
The outlet is fully compatible with off-the-shelf fiber optic LC plugs and jacks. The
dimensions are expressed in inches [mm].
– 8-28 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
TBD
The IEEE 802.3 standard defines many internal interfaces within the Physical Layer.
EtherNet/IP products need not directly implement each of these interfaces, but shall behave “as
if” these interfaces existed. These interfaces may be internal to the node and possibly internal
to a semiconductor device. There are three media variants supported:
• 100BASE-LX10 using Single mode silica fibers;
• 100BASE-FX using multi mode silica fibers;
• 100 Mbps using Multi mode graded index plastic optical fiber, compatible with signaling
of 100BASE-FX.
Other data rates are possible; however they are outside the scope of this standard and will not
be compatible with the 100 Mbps fiber optic systems.
– 8-29 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 8: Physical Layer
Fiber transceivers shall conform to IEEE 802.3 for 100BASE-LX10 (Ethernet in the First Mile)
using SM Silica fibers. Additional requirements can be found in ISO/IEC 9314-3 Information
processing systems-Fiber distributed Data Interface (FDDI)- part 3 Physical Layer Medium
Dependant (PMD) standards with the exception of the transceiver which provides single mode
coupling using the same wavelength of 1310nm as the multimode variant. The data rate shall
be 100 Mbps.
8-9.5.4.2 Multimode
Fiber transceivers shall conform to IEEE 802.3 for 100BASE-FX when using multimode
fibers. Additional requirements can be found in ISO/IEC 9314-3 Information processing
systems-Fiber distributed Data Interface (FDDI)- part 3 Physical Layer Medium Dependant
(PMD) standards.
– 8-30 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP
Contents
9-1 Introduction........................................................................................................................................................3
9-2 Data Link Layers................................................................................................................................................3
9-3 Requirements for TCP/IP Support .....................................................................................................................4
9-4 Indicators ...........................................................................................................................................................5
9-4.1 Required Indicators ................................................................................................................................5
9-4.2 Common Indicator Requirements ..........................................................................................................5
9-4.2.1 Applicability of Common Requirements ........................................................................................... 5
9-4.2.2 Visibility of Indicators .......................................................................................................................5
9-4.2.3 Indicator Flash Rate ...........................................................................................................................5
9-4.2.4 Indicators at Power Up.......................................................................................................................5
9-4.3 Module Status Indicator .........................................................................................................................6
9-4.3.1 Description .........................................................................................................................................6
9-4.3.2 Labeling .............................................................................................................................................6
9-4.3.3 States ..................................................................................................................................................7
9-4.4 Network Status Indicator........................................................................................................................7
9-4.4.1 Description .........................................................................................................................................7
9-4.4.2 Labeling .............................................................................................................................................7
9-4.4.3 States ..................................................................................................................................................8
– 9-2 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP , Chapter 9: Indicators & Middle Layers
9-1 Introduction
Chapter 9 specifies the standard appearance and behavior of EtherNet/IP diagnostic LEDs. This
chapter also specifies TCP/IP requirements of EtherNet/IP devices.
NOTE: For example, the EtherNet/IP protocol could be used over FDDI, modem lines (SLIP
or PPP), ATM, etc.
When any particular medium is used, it shall be used in accordance to commonly accepted
standards. In particular, when Ethernet is used, it shall be used as defined by the IEEE 802.3
specification.
– 9-3 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP , Chapter 9: Indicators & Middle Layers
– 9-4 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP , Chapter 9: Indicators & Middle Layers
9-4 Indicators
9-4.1 Required Indicators
A product need not have indicators to be compliant with this specification. However, to be
compliant with the Industrial Performance Level described in Chapter 8, a product shall
support both the module status and network status indicators as defined by sections 9-4.2, 9-4.3
and 9-4.4.
If a product does support any of the indicators described here, they must adhere to the
specifications described in this section (section 9-4).
NOTE: Products are encouraged to have an indicator that displays the state of link (for
example, link status, tx/rx, collision, etc.) following generally accepted industry practices (as
used in devices such as switches).
The common indicator requirement shall only apply to indicators for which requirements are
specified in this standard.
Indicators shall be viewable without removing covers or parts from the equipment. Indicators
shall be easily seen in normal lighting. Any labels and icons shall be visible whether or not the
indicator is illuminated.
Unless otherwise indicated, the flash rate of all indicators is approximately 1 flash per second.
The indicator should be on for approximately 0.5 second and off for approximately 0.5 second.
This flash rate specification only applies to the indicators specified in this chapter.
– 9-5 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP , Chapter 9: Indicators & Middle Layers
9-4.3.1 Description
The indication of module status shall require a single bicolor (red/green) indicator that
represents the state of the entire product.
NOTE: A product with more than one communication port would have only one module status
indicator, but more than one network status indicator (one per port).
9-4.3.2 Labeling
The module status indicator shall be labeled with one of the following:
• “MS”;
• "Mod";
• “Mod Status”;
• “Module Status”.
– 9-6 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP , Chapter 9: Indicators & Middle Layers
9-4.3.3 States
9-4.4.1 Description
The indication of network status shall require a single bicolor (red/green) indicator that
represents the state of a single communication port.
NOTE: A product with more than one communication port would have only one module status
indicator, but more than one network status indicator (one per port).
9-4.4.2 Labeling
The network status indicator shall be labeled with one of the following:
• “NS”;
• “Net”;
• “Net Status”;
• "Network Status".
– 9-7 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP , Chapter 9: Indicators & Middle Layers
9-4.4.3 States
– 9-8 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP
Contents
10-1 Introduction....................................................................................................................................................3
– 10-2 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 10: Bridging & Routing
10-1 Introduction
This chapter of the EtherNet/IP specification contains additions to the definition of CIP
bridging and routing that are EtherNet/IP specific. At this time, no such additions exist.
– 10-3 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Chapter 10: Bridging & Routing
– 10-4 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP
Contents
A-1 Introduction........................................................................................................................................................3
– A-2 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Appendix A: Explicit Messaging Services
A-1 Introduction
This chapter of the EtherNet/IP specification contains additions to the definition of CIP explicit
messaging services that are EtherNet/IP specific. At this time there are no such additions.
– A-3 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Appendix A: Explicit Messaging Services
– A-4 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP
Contents
B-1 Introduction........................................................................................................................................................3
– B-2 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Appendix B: Status Codes
B-1 Introduction
This chapter of the EtherNet/IP specification contains additions to the definition of CIP error
codes that are EtherNet/IP specific. At this time there are no such additions.
– B-3 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Appendix B: Status Codes
– B-4 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP
Contents
C-1 Introduction........................................................................................................................................................3
– C-2 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Appendix C: Data Management
C-1 Introduction
This chapter of the EtherNet/IP specification contains additions to the CIP Data Management
specification that are EtherNet/IP specific. At this time there are no such additions.
– C-3 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Appendix C: Data Management
– C-4 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP
Contents
D-1 Introduction........................................................................................................................................................3
– D-2 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Appendix D: Engineering Units
D-1 Introduction
This chapter of the EtherNet/IP specification contains additions to the list of CIP engineering
units that are EtherNet/IP specific. At this time, there are no such additions.
– D-3 –
Edition 1.4
ODVA & ControlNet International, Ltd.
Volume 2: EtherNet/IP Adaptation of CIP, Appendix D: Engineering Units
– D-4 –
Edition 1.4
ODVA & ControlNet International, Ltd.