Ethernet Link Object
(Original Document)
Overview
The Ethernet Link object consists of the instances, attributes and services described below.
Class ID
F6 (hex), 246 (decimal)
Instance IDs
The Ethernet Link object presents two instance values:
Attributes
The Ethernet Link object presents the following attributes:
Instance ID = 0 (class attributes):
Attribute ID
Description
GET
SET
01
Revision
X
02
Max Instance
X
03
Number of Instances
X
X = supported
— = not supported
Instance ID = 1 (instance attributes):
Attribute ID
Description
Type
GET
SET
Value
hex
dec
01
01
Interface Speed
UDINT
X
Valid values include:
0, 10000000, 100000000
02
02
Interface Flags
DWORD
X
Bit 0: link status
0 = Inactive
1 = Active
Bit 1: duplex mode
0 = half duplex
1 = full duplex
Bits 2—4: negotiation status
3 = successfully negotiated speed and duplex
4 = forced speed and link
Bit 5: manual setting requires reset
0 = automatic
1 = device need reset
Bit 6: local hardware detected error
0 = no event
1 = event detected
03
03
Physical Address
ARRAY of 6 USINT
X
module MAC address
04
04
Interface Counters
STRUCT
X
In octets
UDINT
octets received on the interface
In Ucast Packets
UDINT
unicast packets received on the interface
In NUcast Packets
UDINT
non-unicast packets received on the interface
In Discards
UDINT
inbound packets received on the interface, but discarded
In Errors
UDINT
inbound packets with detected errors (does not include in discards)
In Unknown Protos
UDINT
inbound packets with unknown protocol
Out Octets
UDINT
octets sent on the interface
Out Ucast Packets
UDINT
unicast packets sent on the interface
Out NUcast Packets
UDINT
non-unicast packets sent on the interface
Out Discards
UDINT
outbound packets discarded
Out Errors
UDINT
outbound packets with detected errors
05
05
Media Counters
STRUCT
X
Alignment Errors
UDINT
frames that are not an integral number of octets in length
FCS Errors
UDINT
bad CRC — frames received do not pass the FCS check
Single Collisions
UDINT
successfully transmitted frames that experienced exactly 1 collision
Multiple Collisions
UDINT
successfully transmitted frames that experienced more than 1 collision
SQE Test Errors
UDINT
number of times the detected SQE test error is generated
Deferred Transmissions
UDINT
frames for which first transmission attempt is delayed because the medium is busy
Late Collisions
UDINT
number of times a collision is detected later than 512 bit times into the transmission of a packet
Excessive Collisions
UDINT
frames that do not transmit due to excessive collisions
MAC Transmit Errors
UDINT
frames that do not transmit due to a detected internal MAC sublayer transmit error
Carrier Sense Errors
UDINT
times that the carrier sense condition was lost or not asserted when attempting to transmit a frame
Frame Too Long
UDINT
frames received that exceed the maximum permitted frame size
MAC Receive Errors
UDINT
frames not received on an interface due to a detected internal MAC sublayer receive error
06
06
Interface Control
STRUCT
X
X
API of the connection
Control Bits
WORD
Bit 0: Auto-negotiation
0 = disabled
1 = enabled
Note: When auto-negotiation is enabled, 0x0C (object state conflict) is returned when attempting to set either:
  • forced interface speed
    or
  • forced duplex mode
Bit 1: forced duplex mode (if auto-negotiation bit = 0)
0 = half duplex
1 = full duplex
Forced Interface Speed
UINT
Valid values include:
10000000, 100000000
Note: Attempting to set any other value returns the detected error 0x09 (invalid attribute value)
10
16
Interface Label
SHORT_STRING
X
A fixed textual string identifying the interface, that should include ‘internal’ for internal interfaces. Maximum number of characters is 64.
X = supported
— = not supported
Services
The Ethernet Link object performs the following services upon the listed object types:
Service ID
Description
Class
Instance
hex
dec
01
01
Get_Attributes_All
X
X
10
16
Set_Attribute_Single
X
0E
14
Get_Attribute_Single
X
X
4C
76
Get_and_Clear
X
X = supported
— = not supported