SysEthernetFrame (STRUCT) ¶ TYPE SysEthernetFrame : STRUCT InOut: Name Type udFrameLen UDINT ethData ARRAY [0..1521] OF BYTE
SysEthernetInterfaceCounters (STRUCT) ¶ TYPE SysEthernetInterfaceCounters : STRUCT The “HC Interface Counters” and the “Interface Counters” of EIP plus a quality flag for each value and a struct version. Quality Flags used in the runtime interface for reading the Ethernet interface settings. These quality flags are not from the EIP specification, but were added by CODESYS. The idea behind this is to be able to say for each individual value of the respective STRUCT whether it has been filled correctly by the platform implementation. Possible quality flags are: - ERR_OK: Value could be determined without errors - ERR_NOTIMPLEMENTED: Not implemented by this platform implementation - ERR_NOT_SUPPORTED: Not supported by this platform implementation - ERR_FAILED: Error: Value could not be determined InOut: Name Type Initial Comment structVersion DWORD 1 Version number of this struct. This is version 1. To be increased on changes. ifInNUcastPkts DWORD RFC 2863 InNUcastPackets: The number of packets, delivered by this sub-layer to a higher (sub-)layer, which were addressed to a multicast or broadcast address at this sub-layer. ifInDiscards DWORD RFC 2863 InDiscards: The number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being deliverable to a higher-layer protocol. One possible reason for discarding such a packet could be to free up buffer space. ifInErrors DWORD RFC 2863 InErrors: For packet-oriented interfaces, the number of inbound packets that contained errors preventing them from being deliverable to a higher-layer protocol. For character- oriented or fixed-length interfaces, the number of inbound transmission units that contained errors preventing them from being deliverable to a higher-layer protocol. ifInUnknownProtos DWORD RFC 2863 InUnknownProtos: For packet-oriented interfaces, the number of packets received via the interface which were discarded because of an unknown or unsupported protocol. For character-oriented or fixed-length interfaces that support protocol multiplexing the number of transmission units received via the interface which were discarded because of an unknown or unsupported protocol. For any interface that does not support protocol multiplexing, this counter will always be 0. ifOutNUcastPkts DWORD RFC 2863 OutNUcastPkts: The total number of packets that higher-level protocols requested be transmitted, and which were addressed to a multicast or broadcast address at this sub-layer, including those that were discarded or not sent. ifOutDiscards DWORD RFC 2863 OutDiscards: The number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. ifOutErrors DWORD RFC 2863 OutErrors: For packet-oriented interfaces, the number of outbound packets that could not be transmitted because of errors. For character-oriented or fixed-length interfaces, the number of outbound transmission units that could not be transmitted because of errors. hcInOctets LWORD The total number of octets received on the interface. This counter is a 64-bit version of In Octets. hcInUcastPkts LWORD Unicast packets received on the interface. This counter is a 64-bit version of In Ucast Packets. hcInMulticastPkts LWORD Multicast packets received on the interface. hcInBroadcastPkts LWORD Broadcast packets received on the interface. hcOutOctets LWORD Octets sent on the interface. This counter is a 64-bit version of Out Octets. hcOutUcastPkts LWORD Unicast packets sent on the interface. This counter is a 64-bit version of Out Ucast Packets. hcOutMulticastPkts LWORD Multicast packets sent on the interface. hcOutBroadcastPkts LWORD Broadcast packets sent on the interface. ifInNUcastPktsQuality SysTypes.RTS_IEC_RESULT ifInDiscardsQuality SysTypes.RTS_IEC_RESULT ifInErrorsQuality SysTypes.RTS_IEC_RESULT ifInUnknownProtosQuality SysTypes.RTS_IEC_RESULT ifOutNUcastPktsQuality SysTypes.RTS_IEC_RESULT ifOutDiscardsQuality SysTypes.RTS_IEC_RESULT ifOutErrorsQuality SysTypes.RTS_IEC_RESULT hcInOctetsQuality SysTypes.RTS_IEC_RESULT hcInUcastPktsQuality SysTypes.RTS_IEC_RESULT hcInMulticastPktsQuality SysTypes.RTS_IEC_RESULT hcInBroadcastPktsQuality SysTypes.RTS_IEC_RESULT hcOutOctetsQuality SysTypes.RTS_IEC_RESULT hcOutUcastPktsQuality SysTypes.RTS_IEC_RESULT hcOutMulticastPktsQuality SysTypes.RTS_IEC_RESULT hcOutBroadcastPktsQuality SysTypes.RTS_IEC_RESULT
SysEthernetMediaCounters (STRUCT) ¶ TYPE SysEthernetMediaCounters : STRUCT The “HC Media Counters” and the “Media Counters” of EIP plus a quality flag for each value and a struct version. Quality Flags used in the runtime interface for reading the Ethernet interface settings. These quality flags are not from the EIP specification, but were added by CODESYS. The idea behind this is to be able to say for each individual value of the respective STRUCT whether it has been filled correctly by the platform implementation. Possible quality flags are: - ERR_OK: Value could be determined without errors - ERR_NOTIMPLEMENTED: Not implemented by this platform implementation - ERR_NOT_SUPPORTED: Not supported by this platform implementation - ERR_FAILED: Error: Value could not be determined InOut: Name Type Initial Comment structVersion DWORD 1 Version number of this struct. This is version 1. To be increased on changes. dot3StatsSingleCollisionFrames DWORD RFC 3635 Single Collisions: A count of frames that are involved in a single collision, and are subsequently transmitted successfully. A frame that is counted by an instance of this object is also counted by the corresponding instance of either the ifOutUcastPkts, ifOutMulticastPkts, or ifOutBroadcastPkts, and is not counted by the corresponding instance of the dot3StatsMultipleCollisionFrames object. This counter does not increment when the interface is operating in full-duplex mode. dot3StatsMultipleCollisionFrames DWORD RFC 3635 Multiple Collisions: A count of frames that are involved in more than one collision and are subsequently transmitted successfully. A frame that is counted by an instance of this object is also counted by the corresponding instance of either the ifOutUcastPkts, ifOutMulticastPkts, or ifOutBroadcastPkts, and is not counted by the corresponding instance of the dot3StatsSingleCollisionFrames object. This counter does not increment when the interface is operating in full-duplex mode. dot3StatsSQETestErrors DWORD RFC 3635 SQE Test Errors: A count of times that the SQE TEST ERROR is received on a particular interface. The SQE TEST ERROR is set in accordance with the rules for verification of the SQE detection mechanism in the PLS Carrier Sense Function as described in IEEE Std. 802.3, 2000 Edition, section 7.2.4.6. This counter does not increment on interfaces operating at speeds greater than 10 Mb/s, or on interfaces operating in full-duplex mode. dot3StatsDeferredTransmissions DWORD RFC 3635 Deferred Transmissions: A count of frames for which the first transmission attempt on a particular interface is delayed because the medium is busy. The count represented by an instance of this object does not include frames involved in collisions. This counter does not increment when the interface is operating in full-duplex mode. dot3StatsLateCollisions DWORD RFC 3635 Late Collisions: The number of times that a collision is detected on a particular interface later than one slotTime into the transmission of a packet. A (late) collision included in a count represented by an instance of this object is also considered as a (generic) collision for purposes of other collision-related statistics. This counter does not increment when the interface is operating in full-duplex mode. dot3StatsExcessiveCollisions DWORD RFC 3635 Excessive Collisions: A count of frames for which transmission on a particular interface fails due to excessive collisions. This counter does not increment when the interface is operating in full-duplex mode. dot3StatsCarrierSenseErrors DWORD RFC 3635 Carrier Sense Errors: The number of times that the carrier sense condition was lost or never asserted when attempting to transmit a frame on a particular interface. The count represented by an instance of this object is incremented at most once per transmission attempt, even if the carrier sense condition fluctuates during a transmission attempt. This counter does not increment when the interface is operating in full-duplex mode. hcStatsAlignmentErrors LWORD Frames received that are not an integral number of octets in length and do not pass the FCS check. This counter is a 64-bit version of Alignment Errors. hcStatsFCSErrors LWORD Frames received that are an integral number of octets in length but do not pass the FCS check. This counter is a 64-bit version of FCS Errors. hcStatsInternalMacTransmitErrors LWORD Frames for which transmission fails due to an internal MAC sublayer transmit error. This counter is a 64-bit version of MAC Transmit Errors. hcStatsFrameTooLongs LWORD Frames received that exceed the maximum permitted frame size. This counter is a 64-bit version of Frame Too Long Errors. hcStatsInternalMacReceiveErrors LWORD Frames for which reception on an interface fails due to an internal MAC sublayer receive error. This counter is a 64-bit version of MAC Receive Errors. hcStatsSymbolErrors LWORD Number of times there was an invalid data symbol on the media when a valid carrier was present. dot3StatsAlignmentErrorsQuality SysTypes.RTS_IEC_RESULT dot3StatsFCSErrorsQuality SysTypes.RTS_IEC_RESULT dot3StatsSingleCollisionFramesQuality SysTypes.RTS_IEC_RESULT dot3StatsMultipleCollisionFramesQuality SysTypes.RTS_IEC_RESULT dot3StatsSQETestErrorsQuality SysTypes.RTS_IEC_RESULT dot3StatsDeferredTransmissionsQuality SysTypes.RTS_IEC_RESULT dot3StatsLateCollisionsQuality SysTypes.RTS_IEC_RESULT dot3StatsExcessiveCollisionsQuality SysTypes.RTS_IEC_RESULT dot3StatsInternalMacTransmitErrorsQuality SysTypes.RTS_IEC_RESULT dot3StatsCarrierSenseErrorsQuality SysTypes.RTS_IEC_RESULT dot3StatsFrameTooLongsQuality SysTypes.RTS_IEC_RESULT dot3StatsInternalMacReceiveErrorsQuality SysTypes.RTS_IEC_RESULT hcStatsAlignmentErrorsQuality SysTypes.RTS_IEC_RESULT hcStatsFCSErrorsQuality SysTypes.RTS_IEC_RESULT hcStatsInternalMacTransmitErrorsQuality SysTypes.RTS_IEC_RESULT hcStatsFrameTooLongsQuality SysTypes.RTS_IEC_RESULT hcStatsInternalMacReceiveErrorsQuality SysTypes.RTS_IEC_RESULT hcStatsSymbolErrorsQuality SysTypes.RTS_IEC_RESULT
AutoNegMode (GVL) ¶ Auto-negotiation mode of MAU (only valid, if auto-negotiation is supported) Attributes: qualified_only InOut: Scope Name Type Initial Constant SYSETH_AUTONEGMODE_Disabled USINT 0 SYSETH_AUTONEGMODE_Enabled USINT 1 SYSETH_AUTONEGMODE_Unknown USINT 255
AutoNegSupport (GVL) ¶ Auto-negotiation support of MAU Attributes: qualified_only InOut: Scope Name Type Initial Constant SYSETH_AUTONEGSUP_NotSupported USINT 0 SYSETH_AUTONEGSUP_Supported USINT 1 SYSETH_AUTONEGSUP_Unknown USINT 255
EventIDs (GVL) ¶ InOut: Name Type Initial Comment CMPID_SysEthernet DWORD 16#11C ComponentID to specify for EventOpen EVTPARAMID_SysEthernet WORD 16#1 ID for the event parameter structure EVTVERSION_SysEthernet WORD 16#2 Version for the event parameter structure EVT_EthPacketArrived DWORD (SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#1) Event is sent when Ethernet packet has arrived pEventParam may point to EVTPARAM_SysEthernet EVT_EthPacketSent DWORD (SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#2) Event is sent when Ethernet packet was sent pEventParam may point to EVTPARAM_SysEthernet EVT_EthGetParameterValue DWORD (SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#3) Event is created by the platform specific adaptation of SysEthernet, in case there are parameters, that are designed to be changed by the application. This way it is possible for the application to check if there are such possibilities and to get some parameters by calling “EventPost” pEventParam may point to EVTPARAM_SysEthernet EVT_EthSetParameterValue DWORD (SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#4) Event is created by the platform specific adaptation of SysEthernet, in case there are parameters, that are designed to be changed by the application. This way it is possible for the application to check if there are such possibilities and to set some parameters by calling “EventPost” pEventParam may point to EVTPARAM_SysEthernet
MauType (GVL) ¶ Media Access Unit (MAU) type according to RFC 4836 ‘IANAifMauTypeListBits’ Attributes: qualified_only InOut: Scope Name Type Initial Comment Constant SYSETH_MAUTYPE_OtherOrUnknown UDINT 0 other or unknown SYSETH_MAUTYPE_AUI UDINT 1 AUI SYSETH_MAUTYPE_10base5 UDINT 2 10BASE-5 SYSETH_MAUTYPE_Foirl UDINT 3 FOIRL SYSETH_MAUTYPE_10base2 UDINT 4 10BASE-2 SYSETH_MAUTYPE_10baseT UDINT 5 10BASE-T duplex mode unknown SYSETH_MAUTYPE_10baseFP UDINT 6 10BASE-FP SYSETH_MAUTYPE_10baseFB UDINT 7 10BASE-FB SYSETH_MAUTYPE_10baseFL UDINT 8 10BASE-FL duplex mode unknown SYSETH_MAUTYPE_10broad36 UDINT 9 10BROAD36 SYSETH_MAUTYPE_10baseTHD UDINT 10 10BASE-T half duplex mode SYSETH_MAUTYPE_10baseTFD UDINT 11 10BASE-T full duplex mode SYSETH_MAUTYPE_10baseFLHD UDINT 12 10BASE-FL half duplex mode SYSETH_MAUTYPE_10baseFLFD UDINT 13 10BASE-FL full duplex mode SYSETH_MAUTYPE_100baseT4 UDINT 14 100BASE-T4 SYSETH_MAUTYPE_100baseTXHD UDINT 15 100BASE-TX half duplex mode SYSETH_MAUTYPE_100baseTXFD UDINT 16 100BASE-TX full duplex mode SYSETH_MAUTYPE_100baseFXHD UDINT 17 100BASE-FX half duplex mode SYSETH_MAUTYPE_100baseFXFD UDINT 18 100BASE-FX full duplex mode SYSETH_MAUTYPE_100baseT2HD UDINT 19 100BASE-T2 half duplex mode SYSETH_MAUTYPE_100baseT2FD UDINT 20 100BASE-T2 full duplex mode SYSETH_MAUTYPE_1000baseXHD UDINT 21 1000BASE-X half duplex mode SYSETH_MAUTYPE_1000baseXFD UDINT 22 1000BASE-X full duplex mode SYSETH_MAUTYPE_1000baseLXHD UDINT 23 1000BASE-LX half duplex mode SYSETH_MAUTYPE_1000baseLXFD UDINT 24 1000BASE-LX full duplex mode SYSETH_MAUTYPE_1000baseSXHD UDINT 25 1000BASE-SX half duplex mode SYSETH_MAUTYPE_1000baseSXFD UDINT 26 1000BASE-SX full duplex mode SYSETH_MAUTYPE_1000baseCXHD UDINT 27 1000BASE-CX half duplex mode SYSETH_MAUTYPE_1000baseCXFD UDINT 28 1000BASE-CX full duplex mode SYSETH_MAUTYPE_1000baseTHD UDINT 29 1000BASE-T half duplex mode SYSETH_MAUTYPE_1000baseTFD UDINT 30 1000BASE-T full duplex mode SYSETH_MAUTYPE_10GbaseX UDINT 31 10GBASE-X SYSETH_MAUTYPE_10GbaseLX4 UDINT 32 10GBASE-LX4 SYSETH_MAUTYPE_10GbaseR UDINT 33 10GBASE-R SYSETH_MAUTYPE_10GbaseER UDINT 34 10GBASE-ER SYSETH_MAUTYPE_10GbaseLR UDINT 35 10GBASE-LR SYSETH_MAUTYPE_10GbaseSR UDINT 36 10GBASE-SR SYSETH_MAUTYPE_10GbaseW UDINT 37 10GBASE-W SYSETH_MAUTYPE_10GbaseEW UDINT 38 10GBASE-EW SYSETH_MAUTYPE_10GbaseLW UDINT 39 10GBASE-LW SYSETH_MAUTYPE_10GbaseSW UDINT 40 10GBASE-SW SYSETH_MAUTYPE_10GbaseCX4 UDINT 41 10GBASE-CX4 SYSETH_MAUTYPE_2BaseTL UDINT 42 2BASE-TL SYSETH_MAUTYPE_10PassTS UDINT 43 10PASS-TS SYSETH_MAUTYPE_100BaseBX10D UDINT 44 100BASE-BX10D SYSETH_MAUTYPE_100BaseBX10U UDINT 45 100BASE-BX10U SYSETH_MAUTYPE_100BaseLX10 UDINT 46 100BASE-LX10 SYSETH_MAUTYPE_1000BaseBX10D UDINT 47 1000BASE-BX10D SYSETH_MAUTYPE_1000BaseBX10U UDINT 48 1000BASE-BX10U SYSETH_MAUTYPE_1000BaseLX10 UDINT 49 1000BASE-LX10 SYSETH_MAUTYPE_1000BasePX10D UDINT 50 1000BASE-PX10D SYSETH_MAUTYPE_1000BasePX10U UDINT 51 1000BASE-PX10U SYSETH_MAUTYPE_1000BasePX20D UDINT 52 1000BASE-PX20D SYSETH_MAUTYPE_1000BasePX20U UDINT 53 1000BASE-PX20U SYSETH_MAUTYPE_10GbaseT UDINT 54 10GBASE-T SYSETH_MAUTYPE_10GbaseLRM UDINT 55 10GBASE-LRM SYSETH_MAUTYPE_1000baseKX UDINT 56 1000BASE-KX SYSETH_MAUTYPE_10GbaseKX4 UDINT 57 10GBASE-KX4 SYSETH_MAUTYPE_10GbaseKR UDINT 58 10GBASE-KR SYSETH_MAUTYPE_10G1GbasePRXD1 UDINT 59 10/1GBASE-PRX-D1 SYSETH_MAUTYPE_10G1GbasePRXD2 UDINT 60 10/1GBASE-PRX-D2 SYSETH_MAUTYPE_10G1GbasePRXD3 UDINT 61 10/1GBASE-PRX-D3 SYSETH_MAUTYPE_10G1GbasePRXU1 UDINT 62 10/1GBASE-PRX-U1 SYSETH_MAUTYPE_10G1GbasePRXU2 UDINT 63 10/1GBASE-PRX-U2 SYSETH_MAUTYPE_10G1GbasePRXU3 UDINT 64 10/1GBASE-PRX-U3 SYSETH_MAUTYPE_10GbasePRD1 UDINT 65 10GBASE-PR-D1 SYSETH_MAUTYPE_10GbasePRD2 UDINT 66 10GBASE-PR-D2 SYSETH_MAUTYPE_10GbasePRD3 UDINT 67 10GBASE-PR-D3 SYSETH_MAUTYPE_10GbasePRU1 UDINT 68 10GBASE-PR-U1 SYSETH_MAUTYPE_10GbasePRU3 UDINT 69 10GBASE-PR-U3 SYSETH_MAUTYPE_40GbaseKR4 UDINT 70 40GBASE-KR4 SYSETH_MAUTYPE_40GbaseCR4 UDINT 71 40GBASE-CR4 SYSETH_MAUTYPE_40GbaseSR4 UDINT 72 40GBASE-SR4 SYSETH_MAUTYPE_40GbaseFR UDINT 73 40GBASE-FR SYSETH_MAUTYPE_40GbaseLR4 UDINT 74 40GBASE-LR4 SYSETH_MAUTYPE_100GbaseCR10 UDINT 75 100GBASE-CR10 SYSETH_MAUTYPE_100GbaseSR10 UDINT 76 100GBASE-SR10 SYSETH_MAUTYPE_100GbaseLR4 UDINT 77 100GBASE-LR4 SYSETH_MAUTYPE_100GbaseER4 UDINT 78 100GBASE-ER4 SYSETH_MAUTYPE_1000baseT1 UDINT 79 1000BASE-T1 SYSETH_MAUTYPE_1000basePX30D UDINT 80 1000BASE-PX30D SYSETH_MAUTYPE_1000basePX30U UDINT 81 1000BASE-PX30U SYSETH_MAUTYPE_1000basePX40D UDINT 82 1000BASE-PX40D SYSETH_MAUTYPE_1000basePX40U UDINT 83 1000BASE-PX40U SYSETH_MAUTYPE_10G1GbasePRXD4 UDINT 84 10/1GBASE-PRX-D4 SYSETH_MAUTYPE_10G1GbasePRXU4 UDINT 85 10/1GBASE-PRX-U4 SYSETH_MAUTYPE_10GbasePRD4 UDINT 86 10GBASE-PRD4 SYSETH_MAUTYPE_10GbasePRU4 UDINT 87 10GBASE-PRU4 SYSETH_MAUTYPE_25GbaseCR UDINT 88 25GBASE-CR SYSETH_MAUTYPE_25GbaseCRS UDINT 89 25GBASE-CR-S SYSETH_MAUTYPE_25GbaseKR UDINT 90 25GBASE-KR SYSETH_MAUTYPE_25GbaseKRS UDINT 91 25GBASE-KR-S SYSETH_MAUTYPE_25GbaseR UDINT 92 25GBASE-R SYSETH_MAUTYPE_25GbaseSR UDINT 93 25GBASE-SR SYSETH_MAUTYPE_25GbaseT UDINT 94 25GBASE-T SYSETH_MAUTYPE_40GbaseER4 UDINT 95 40GBASE-ER4 SYSETH_MAUTYPE_40GbaseR UDINT 96 40GBASE-R SYSETH_MAUTYPE_40GbaseT UDINT 97 40GBASE-T SYSETH_MAUTYPE_100GbaseCR4 UDINT 98 100GBASE-CR4 SYSETH_MAUTYPE_100GbaseKR4 UDINT 99 100GBASE-KR4 SYSETH_MAUTYPE_100GbaseKP4 UDINT 100 100GBASE-KP4 SYSETH_MAUTYPE_100GbaseR UDINT 101 100GBASE-R SYSETH_MAUTYPE_100GbaseSR4 UDINT 102 100GBASE-SR4
MvtIdRange_Contains (FUN) ¶ FUNCTION MvtIdRange_Contains : BOOL InOut: Scope Name Type Inout Const mvtIds MvtIdRange Input mvtId ULINT Return MvtIdRange_Contains BOOL
OperStatus (GVL) ¶ Link state of Ethernet port according to RFC 2863 ‘IfOperStatus’ Attributes: qualified_only InOut: Scope Name Type Initial Comment Constant SYSETH_OPERSTAT_Up UINT 1 ready to pass packets SYSETH_OPERSTAT_Down UINT 2 down and not in a condition to pass packets SYSETH_OPERSTAT_Testing UINT 3 in some test mode SYSETH_OPERSTAT_Unknown UINT 4 status can not be determined for some reason SYSETH_OPERSTAT_Dormant UINT 5 not up, pending state SYSETH_OPERSTAT_NotPresent UINT 6 some component e. g. a hardware device is missing SYSETH_OPERSTAT_LowerLayerDown UINT 7 down due to state of lower-layer interface(s)
EventParameter ¶ EVTPARAM_SysEthernet (Struct)