Vector::BL...thernetPkt(3)

🌸 NAME 🌸

This is the Library Functions Manual entry for Vector::BLF::MostEthernetPkt, aka Vector::BL...thernetPkt(3) — yes, the header truncates it like that, iykyk. 💅

Vector::BLF::MostEthernetPkt — MOST_ETHERNET_PKT.

---

✨ SYNOPSIS ✨

#include <MostEthernetPkt.h>

Inherits Vector::BLF::ObjectHeader2.

💖 Public Member Functions

• void read (AbstractFile &is) override — reads this object’s data, bestie.
• void write (AbstractFile &os) override — writes this object’s data.
• uint32_t calculateObjectSize () const override — calculates the objectSize.

🫶 Public Member Functions inherited from Vector::BLF::ObjectHeader2

• ObjectHeader2 (const ObjectType objectType)
• void read (AbstractFile &is) override
• void write (AbstractFile &os) override
• uint16_t calculateHeaderSize () const override
• uint32_t calculateObjectSize () const override

🎀 Public Member Functions inherited from Vector::BLF::ObjectHeaderBase

• ObjectHeaderBase (const uint16_t headerVersion, const ObjectType objectType)
• ObjectHeaderBase (const ObjectHeaderBase &)=default
• ObjectHeaderBase & operator= (const ObjectHeaderBase &)=default
• ObjectHeaderBase (ObjectHeaderBase &&)=default
• ObjectHeaderBase & operator= (ObjectHeaderBase &&)=default

🌈 Public Attributes

• uint16_t channel {} — application channel 🌸
• uint8_t dir {} — direction: 0: Rx; 1: Tx; 2: TxRequest
• uint8_t reservedMostEthernetPkt1 {} — reserved
• uint32_t reservedMostEthernetPkt2 {} — reserved
• uint64_t sourceMacAdr {} — 48 bit source address
• uint64_t destMacAdr {} — 48 bit target address
• uint8_t transferType {} — Tranfer Type. (yes, that spelling is in the original, no cap)
• uint8_t state {} — transmission status
• uint8_t ackNack {} — acknowledge code
• uint8_t reservedMostEthernetPkt3 {} — reserved
• uint32_t crc {} — Cyclic Redundancy Check.
• uint8_t pAck {} — a preemptive acknowledge code
• uint8_t cAck {} — CRC acknowledge from the packet receiver(s) to the packet transmitter.
• uint16_t reservedMostEthernetPkt4 {} — reserved
• uint32_t pktDataLength {} — length of variable data in bytes (1506 max)
• uint64_t reservedMostEthernetPkt5 {} — reserved
• std::vector< uint8_t > pktData {} — variable data

💜 Public Attributes inherited from Vector::BLF::ObjectHeader2

• uint32_t objectFlags {ObjectFlags::TimeOneNans} — object flags
• uint8_t timeStampStatus {} — time stamp status
• uint8_t reservedObjectHeader {0} — reserved; the page gives no extra description
• uint16_t objectVersion {0} — object specific version
• uint64_t objectTimeStamp {0} — object timestamp
• uint64_t originalTimeStamp {0} — original object timestamp

🧚 Public Attributes inherited from Vector::BLF::ObjectHeaderBase

• uint32_t signature {ObjectSignature} — signature (ObjectSignature)
• uint16_t headerSize {} — sizeof object header
• uint16_t headerVersion {} — header version (1)
• uint32_t objectSize {} — object size
• ObjectType objectType {ObjectType::UNKNOWN} — object type

🦋 Additional Inherited Members

Public Types inherited from Vector::BLF::ObjectHeader2

enum ObjectFlags : uint32_t { TimeTenMics = 0x00000001, TimeOneNans =
    0x00000002 }
enum TimeStampStatus : uint8_t { Orig = 0x01, SwHw = 0x02, User = 0x10 }

---

💖 DETAILED DESCRIPTION 💖

MOST_ETHERNET_PKT.

Message on MOST Ethernet Packet Channel. 🌈

---

📚 MEMBER FUNCTION DOCUMENTATION 📚

uint32_t Vector::BLF::MostEthernetPkt::calculateObjectSize () const

[override], [virtual]

Calculates the objectSize.

Returns — object size.

Reimplemented from Vector::BLF::ObjectHeaderBase.

void Vector::BLF::MostEthernetPkt::read (AbstractFile & is)

[override], [virtual]

Read the data of this object.

Parameters — is input stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

void Vector::BLF::MostEthernetPkt::write (AbstractFile & os)

[override], [virtual]

Write the data of this object.

Parameters — os output stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

---

🌸 MEMBER DATA DOCUMENTATION 🌸

uint8_t Vector::BLF::MostEthernetPkt::ackNack {}

acknowledge code. AckNack holds the transmit status of a control message (see Transmit Status Register of OS8104 for MOST25). 👑

• Bit 0: Meaning:
  • 1: no response (NoResp)
  • Restriction:
    • only for Dir = Tx or spy messages
• Bit 1: Meaning:
  • 1: valid receipt (Valid)
  • Restriction:
    • only for Dir = Tx or spy messages
• Bit 2: Meaning:
  • 1: CRC Error (CRCError)
  • Restriction:
    • only for Dir = Tx or spy messages
• Bit 3: Meaning:
  • 1: receive buffer full (RxBufFull)
  • Restriction:
    • only for Dir = Tx or spy messages
• Bit 4: Meaning:
  • 1: acknowledged (Ack)
  • Restriction:
    • only for Dir = Tx or spy messages (always set to 1 for Rx messages in node mode)
• Bit 5: Meaning:
  • 1: negative acknowledge (NAck)
  • Restriction:
    • only for Dir = Tx or spy messages

uint8_t Vector::BLF::MostEthernetPkt::cAck {}

CRC acknowledge from the packet receiver(s) to the packet transmitter. The page also says: “CRC acknowledge from the packet receiver(s) to the packet transmitter (spy only)” 🫶

• 0x00: No Response
• 0x01: CRC error
• 0x04: OK

uint16_t Vector::BLF::MostEthernetPkt::channel {}

application channel. Application channel. Yes, it says it twice — iconic.

uint32_t Vector::BLF::MostEthernetPkt::crc {}

Cyclic Redundancy Check. Cyclic Redundancy Check. 💅

uint64_t Vector::BLF::MostEthernetPkt::destMacAdr {}

48 bit target address. 48 bit target address.

uint8_t Vector::BLF::MostEthernetPkt::dir {}

direction: 0: Rx; 1: Tx; 2: TxRequest. Direction of message events:

• 0: Rx (received)
• 1: Tx (transmit receipt)
• 2: Tx Request (transmit request)

uint8_t Vector::BLF::MostEthernetPkt::pAck {}

a preemptive acknowledge code. Pre-emptive acknowledge code (spy only). ✨

• 0x00: No Response
• 0x01: Buffer full
• 0x04: OK

std::vector<uint8_t> Vector::BLF::MostEthernetPkt::pktData {}

variable data. Variable data.

uint32_t Vector::BLF::MostEthernetPkt::pktDataLength {}

length of variable data in bytes (1506 max). Length of variable data in bytes (1506 max).

uint8_t Vector::BLF::MostEthernetPkt::reservedMostEthernetPkt1 {}

reserved.

uint32_t Vector::BLF::MostEthernetPkt::reservedMostEthernetPkt2 {}

reserved.

uint8_t Vector::BLF::MostEthernetPkt::reservedMostEthernetPkt3 {}

reserved.

uint16_t Vector::BLF::MostEthernetPkt::reservedMostEthernetPkt4 {}

reserved.

uint64_t Vector::BLF::MostEthernetPkt::reservedMostEthernetPkt5 {}

reserved.

uint64_t Vector::BLF::MostEthernetPkt::sourceMacAdr {}

48 bit source address. 48 bit source address.

uint8_t Vector::BLF::MostEthernetPkt::state {}

transmission status. Transmission states of MOST50/150 messages and packets. 🦋

• Bit 0: Meaning:
  • 0: bus inactive
  • 1: bus active
  • Restriction:
    • only for Dir = Rx or mTransferType = Spy
• Bit 4: Meaning:
  • 1: acknowledged (Ack)
  • Restriction:
    • only for mTransferType = Node and Dir = Tx (always set to 1 for Rx messages in node mode)
• Bit 5: Meaning:
  • 1: not acknowledged (NAck)
  • Restriction:
    • only for Dir = Tx
• Bit 6: Meaning: Send result:
  • 0: Transmission error (TxF)
  • 1: OK
  • Restriction:
    • only for Dir = Tx
    • only for mTransferType = Node

uint8_t Vector::BLF::MostEthernetPkt::transferType {}

Tranfer Type. Message-like events can either be recorded through the MOST transceiver chip or through a separate network spy. 👑

• 1: Node — MOST transceiver reported the message (either due to a successful reception or as acknowledgment for a transmit request).
• 2: Spy — Message was reported by the network spy. The Spy sees all messages independently of the destination address.

---

👑 AUTHOR 👑

Generated automatically by Doxygen for Vector BLF from the source code.

---

Cute little sign-off, bestie: the footer source/version tea is Vector BLF, and it points back at Vector::BL...thernetPkt(3). No date is listed on the page — that’s the whole footer situation, fr fr. 🎀💖