.TH "Vector::BLF::MostEthernetPkt" 3 "Vector BLF" \" -*- nroff -*- .ad l .nh .SH NAME Vector::BLF::MostEthernetPkt \- MOST_ETHERNET_PKT\&. .SH SYNOPSIS .br .PP .PP \fR#include \fP .PP Inherits \fBVector::BLF::ObjectHeader2\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBvoid\fP \fBread\fP (\fBAbstractFile\fP &\fBis\fP) \fBoverride\fP" .br .ti -1c .RI "\fBvoid\fP \fBwrite\fP (\fBAbstractFile\fP &\fBos\fP) \fBoverride\fP" .br .ti -1c .RI "\fBuint32_t\fP \fBcalculateObjectSize\fP () \fBconst\fP \fBoverride\fP" .br .in -1c Public Member Functions inherited from \fBVector::BLF::ObjectHeader2\fP .in +1c .ti -1c .RI "\fBObjectHeader2\fP (\fBconst\fP ObjectType \fBobjectType\fP)" .br .ti -1c .RI "\fBvoid\fP \fBread\fP (\fBAbstractFile\fP &\fBis\fP) \fBoverride\fP" .br .ti -1c .RI "\fBvoid\fP \fBwrite\fP (\fBAbstractFile\fP &\fBos\fP) \fBoverride\fP" .br .ti -1c .RI "\fBuint16_t\fP \fBcalculateHeaderSize\fP () \fBconst\fP \fBoverride\fP" .br .ti -1c .RI "\fBuint32_t\fP \fBcalculateObjectSize\fP () \fBconst\fP \fBoverride\fP" .br .in -1c Public Member Functions inherited from \fBVector::BLF::ObjectHeaderBase\fP .in +1c .ti -1c .RI "\fBObjectHeaderBase\fP (\fBconst\fP \fBuint16_t\fP \fBheaderVersion\fP, \fBconst\fP ObjectType \fBobjectType\fP)" .br .ti -1c .RI "\fBObjectHeaderBase\fP (\fBconst\fP \fBObjectHeaderBase\fP &)=\fBdefault\fP" .br .ti -1c .RI "\fBObjectHeaderBase\fP & \fBoperator=\fP (\fBconst\fP \fBObjectHeaderBase\fP &)=\fBdefault\fP" .br .ti -1c .RI "\fBObjectHeaderBase\fP (\fBObjectHeaderBase\fP &&)=\fBdefault\fP" .br .ti -1c .RI "\fBObjectHeaderBase\fP & \fBoperator=\fP (\fBObjectHeaderBase\fP &&)=\fBdefault\fP" .br .in -1c .SS "Public Attributes" .in +1c .ti -1c .RI "\fBuint16_t\fP \fBchannel\fP {}" .br .RI "application channel " .ti -1c .RI "\fBuint8_t\fP \fBdir\fP {}" .br .RI "direction: 0: Rx; 1: Tx; 2: TxRequest " .ti -1c .RI "\fBuint8_t\fP \fBreservedMostEthernetPkt1\fP {}" .br .ti -1c .RI "\fBuint32_t\fP \fBreservedMostEthernetPkt2\fP {}" .br .ti -1c .RI "\fBuint64_t\fP \fBsourceMacAdr\fP {}" .br .RI "48 bit source address " .ti -1c .RI "\fBuint64_t\fP \fBdestMacAdr\fP {}" .br .RI "48 bit target address " .ti -1c .RI "\fBuint8_t\fP \fBtransferType\fP {}" .br .RI "Tranfer Type\&. " .ti -1c .RI "\fBuint8_t\fP \fBstate\fP {}" .br .RI "transmission status " .ti -1c .RI "\fBuint8_t\fP \fBackNack\fP {}" .br .RI "acknowledge code " .ti -1c .RI "\fBuint8_t\fP \fBreservedMostEthernetPkt3\fP {}" .br .ti -1c .RI "\fBuint32_t\fP \fBcrc\fP {}" .br .RI "Cyclic Redundancy Check\&. " .ti -1c .RI "\fBuint8_t\fP \fBpAck\fP {}" .br .RI "a preemptive acknowledge code " .ti -1c .RI "\fBuint8_t\fP \fBcAck\fP {}" .br .RI "CRC acknowledge from the packet receiver(s) to the packet transmitter\&. " .ti -1c .RI "\fBuint16_t\fP \fBreservedMostEthernetPkt4\fP {}" .br .ti -1c .RI "\fBuint32_t\fP \fBpktDataLength\fP {}" .br .RI "length of variable data in bytes (1506 max) " .ti -1c .RI "\fBuint64_t\fP \fBreservedMostEthernetPkt5\fP {}" .br .ti -1c .RI "std::vector< \fBuint8_t\fP > \fBpktData\fP {}" .br .RI "variable data " .in -1c Public Attributes inherited from \fBVector::BLF::ObjectHeader2\fP .in +1c .ti -1c .RI "\fBuint32_t\fP \fBobjectFlags\fP {\fBObjectFlags::TimeOneNans\fP}" .br .RI "object flags " .ti -1c .RI "\fBuint8_t\fP \fBtimeStampStatus\fP {}" .br .RI "time stamp status " .ti -1c .RI "\fBuint8_t\fP \fBreservedObjectHeader\fP {0}" .br .ti -1c .RI "\fBuint16_t\fP \fBobjectVersion\fP {0}" .br .RI "object specific version " .ti -1c .RI "\fBuint64_t\fP \fBobjectTimeStamp\fP {0}" .br .RI "object timestamp " .ti -1c .RI "\fBuint64_t\fP \fBoriginalTimeStamp\fP {0}" .br .RI "original object timestamp " .in -1c Public Attributes inherited from \fBVector::BLF::ObjectHeaderBase\fP .in +1c .ti -1c .RI "\fBuint32_t\fP \fBsignature\fP {ObjectSignature}" .br .RI "signature (ObjectSignature) " .ti -1c .RI "\fBuint16_t\fP \fBheaderSize\fP {}" .br .RI "sizeof object header " .ti -1c .RI "\fBuint16_t\fP \fBheaderVersion\fP {}" .br .RI "header version (1) " .ti -1c .RI "\fBuint32_t\fP \fBobjectSize\fP {}" .br .RI "object size " .ti -1c .RI "ObjectType \fBobjectType\fP {ObjectType::UNKNOWN}" .br .RI "object type " .in -1c .SS "Additional Inherited Members" Public Types inherited from \fBVector::BLF::ObjectHeader2\fP .in +1c .ti -1c .RI "enum \fBObjectFlags\fP : uint32_t { \fBTimeTenMics\fP = 0x00000001, \fBTimeOneNans\fP = 0x00000002 }" .br .ti -1c .RI "enum \fBTimeStampStatus\fP : uint8_t { \fBOrig\fP = 0x01, \fBSwHw\fP = 0x02, \fBUser\fP = 0x10 }" .br .in -1c .SH "Detailed Description" .PP MOST_ETHERNET_PKT\&. Message on MOST Ethernet Packet Channel\&. .SH "Member Function Documentation" .PP .SS "\fBuint32_t\fP Vector::BLF::MostEthernetPkt::calculateObjectSize () const\fR [override]\fP, \fR [virtual]\fP" Calculates the objectSize .PP \fBReturns\fP .RS 4 object size .RE .PP .PP Reimplemented from \fBVector::BLF::ObjectHeaderBase\fP\&. .SS "\fBvoid\fP Vector::BLF::MostEthernetPkt::read (\fBAbstractFile\fP & is)\fR [override]\fP, \fR [virtual]\fP" Read the data of this object .PP \fBParameters\fP .RS 4 \fIis\fP input stream .RE .PP .PP Reimplemented from \fBVector::BLF::ObjectHeaderBase\fP\&. .SS "\fBvoid\fP Vector::BLF::MostEthernetPkt::write (\fBAbstractFile\fP & os)\fR [override]\fP, \fR [virtual]\fP" Write the data of this object .PP \fBParameters\fP .RS 4 \fIos\fP output stream .RE .PP .PP Reimplemented from \fBVector::BLF::ObjectHeaderBase\fP\&. .SH "Member Data Documentation" .PP .SS "\fBuint8_t\fP Vector::BLF::MostEthernetPkt::ackNack {}" .PP acknowledge code AckNack holds the transmit status of a control message (see Transmit Status Register of OS8104 for MOST25)\&. .IP "\(bu" 2 Bit 0: Meaning: .IP " \(bu" 4 1: no response (NoResp) Restriction: .IP " \(bu" 4 only for Dir = Tx or spy messages .PP .IP "\(bu" 2 Bit 1: Meaning: .IP " \(bu" 4 1: valid receipt (Valid) Restriction: .IP " \(bu" 4 only for Dir = Tx or spy messages .PP .IP "\(bu" 2 Bit 2: Meaning: .IP " \(bu" 4 1: CRC Error (CRCError) Restriction: .IP " \(bu" 4 only for Dir = Tx or spy messages .PP .IP "\(bu" 2 Bit 3: Meaning: .IP " \(bu" 4 1: receive buffer full (RxBufFull) Restriction: .IP " \(bu" 4 only for Dir = Tx or spy messages .PP .IP "\(bu" 2 Bit 4: Meaning: .IP " \(bu" 4 1: acknowledged (Ack) Restriction: .IP " \(bu" 4 only for Dir = Tx or spy messages (always set to 1 for Rx messages in node mode) .PP .IP "\(bu" 2 Bit 5: Meaning: .IP " \(bu" 4 1: negative acknowledge (NAck) Restriction: .IP " \(bu" 4 only for Dir = Tx or spy messages .PP .PP .SS "\fBuint8_t\fP Vector::BLF::MostEthernetPkt::cAck {}" .PP CRC acknowledge from the packet receiver(s) to the packet transmitter\&. CRC acknowledge from the packet receiver(s) to the packet transmitter (spy only) .IP "\(bu" 2 0x00: No Response .IP "\(bu" 2 0x01: CRC error .IP "\(bu" 2 0x04: OK .PP .SS "\fBuint16_t\fP Vector::BLF::MostEthernetPkt::channel {}" .PP application channel Application channel .SS "\fBuint32_t\fP Vector::BLF::MostEthernetPkt::crc {}" .PP Cyclic Redundancy Check\&. Cyclic Redundancy Check .SS "\fBuint64_t\fP Vector::BLF::MostEthernetPkt::destMacAdr {}" .PP 48 bit target address 48 bit target address .SS "\fBuint8_t\fP Vector::BLF::MostEthernetPkt::dir {}" .PP direction: 0: Rx; 1: Tx; 2: TxRequest Direction of message events: .IP "\(bu" 2 0: Rx (received) .IP "\(bu" 2 1: Tx (transmit receipt) .IP "\(bu" 2 2: Tx Request (transmit request) .PP .SS "\fBuint8_t\fP Vector::BLF::MostEthernetPkt::pAck {}" .PP a preemptive acknowledge code Pre-emptive acknowledge code (spy only) .IP "\(bu" 2 0x00: No Response .IP "\(bu" 2 0x01: Buffer full .IP "\(bu" 2 0x04: OK .PP .SS "std::vector<\fBuint8_t\fP> Vector::BLF::MostEthernetPkt::pktData {}" .PP variable data Variable data .SS "\fBuint32_t\fP Vector::BLF::MostEthernetPkt::pktDataLength {}" .PP length of variable data in bytes (1506 max) Length of variable data in bytes (1506 max) .SS "\fBuint8_t\fP Vector::BLF::MostEthernetPkt::reservedMostEthernetPkt1 {}" reserved .SS "\fBuint32_t\fP Vector::BLF::MostEthernetPkt::reservedMostEthernetPkt2 {}" reserved .SS "\fBuint8_t\fP Vector::BLF::MostEthernetPkt::reservedMostEthernetPkt3 {}" reserved .SS "\fBuint16_t\fP Vector::BLF::MostEthernetPkt::reservedMostEthernetPkt4 {}" reserved .SS "\fBuint64_t\fP Vector::BLF::MostEthernetPkt::reservedMostEthernetPkt5 {}" reserved .SS "\fBuint64_t\fP Vector::BLF::MostEthernetPkt::sourceMacAdr {}" .PP 48 bit source address 48 bit source address .SS "\fBuint8_t\fP Vector::BLF::MostEthernetPkt::state {}" .PP transmission status Transmission states of MOST50/150 messages and packets\&. .IP "\(bu" 2 Bit 0: Meaning: .IP " \(bu" 4 0: bus inactive .IP " \(bu" 4 1: bus active Restriction: .IP " \(bu" 4 only for Dir = Rx or mTransferType = Spy .PP .IP "\(bu" 2 Bit 4: Meaning: .IP " \(bu" 4 1: acknowledged (Ack) Restriction .IP " \(bu" 4 only for mTransferType = Node and Dir = Tx (always set to 1 for Rx messages in node mode) .PP .IP "\(bu" 2 Bit 5: Meaning: .IP " \(bu" 4 1: not acknowledged (NAck) Restriction: .IP " \(bu" 4 only for Dir = Tx .PP .IP "\(bu" 2 Bit 6: Meaning: Send result: .IP " \(bu" 4 0: Transmission error (TxF) .IP " \(bu" 4 1: OK Restriction: .IP " \(bu" 4 only for Dir = Tx .IP " \(bu" 4 only for mTransferType = Node .PP .PP .SS "\fBuint8_t\fP Vector::BLF::MostEthernetPkt::transferType {}" .PP Tranfer Type\&. Message-like events can either be recorded through the MOST transceiver chip or through a separate network spy\&. .IP "\(bu" 2 1: Node MOST transceiver reported the message (either due to a successful reception or as acknowledgment for a transmit request)\&. .IP "\(bu" 2 2: Spy Message was reported by the network spy\&. The Spy sees all messages independently of the desti-nation address\&. .PP .SH "Author" .PP Generated automatically by Doxygen for Vector BLF from the source code\&.