mdflib-sys 0.2.2

Low-level FFI bindings for mdflib
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

/*
* Copyright 2024 Ingemar Hedvall
* SPDX-License-Identifier: MIT
 */

#pragma once

#include <cstdint>
#include <array>
#include <vector>
#include <algorithm>

#include "mdf/samplerecord.h"

namespace mdf {

class MdfWriter;
class IDataGroup;
class IChannelGroup;

enum class EthMessageType : int {
  ETH_Frame,
  ETH_ChecksumError,
  ETH_LengthError,
  ETH_ReceiveError
};

enum class EthErrorType : int {
  Unknown = 0,
  CollisionError = 1
};

class EthMessage {
 public:
  EthMessage() = default;

  [[deprecated("Use the default EthMessage() constructor instead.")]]
  explicit EthMessage(const MdfWriter& writer);

  void MessageType(EthMessageType type) const { message_type_ = type; }
  [[nodiscard]] EthMessageType MessageType() const { return message_type_; };

  void BusChannel(uint8_t channel) {bus_channel_ = channel;};
  [[nodiscard]] uint8_t BusChannel() const {return bus_channel_;};

  void Dir(bool transmit) { dir_ = transmit;};
  [[nodiscard]] bool Dir() const {return dir_;};

  void ErrorType(EthErrorType type) {error_type_ = type;};
  [[nodiscard]] EthErrorType ErrorType() const {return error_type_;};

  void Source(const uint8_t source[6]) {
    std::copy_n( source , source_.size(), source_.data() );
  }
  void Source(const std::array<uint8_t,6>& source) { source_ = source; }
  [[nodiscard]] const std::array<uint8_t, 6>& Source() const { return source_;}

  void Destination(const uint8_t destination[6]) {
    std::copy_n( destination , destination_.size(), destination_.data() );
  }
  void Destination(const std::array<uint8_t,6>& destination) {
    destination_ = destination;
  }
  [[nodiscard]] const std::array<uint8_t, 6>& Destination() const {
    return destination_;
  }

  void EthType(uint16_t type) { eth_type_ = type; }
  [[nodiscard]] uint16_t EthType() const { return eth_type_; }

  void ReceivedDataByteCount(uint16_t nof_bytes) {
    received_data_byte_count_ = nof_bytes;
  }
  [[nodiscard]] uint16_t ReceivedDataByteCount() const {
    return received_data_byte_count_;
  }

  void DataLength(uint16_t nof_bytes) {
    data_length_ = nof_bytes;
  }

  [[nodiscard]] uint16_t DataLength() const {
    return data_length_;
  }

  void DataBytes(const std::vector<uint8_t>& data);

  [[nodiscard]] const std::vector<uint8_t>& DataBytes() const {
    return data_bytes_;
  }

  void Crc(uint32_t crc) {
    crc_ = crc;
  }

  [[nodiscard]] uint32_t Crc() const {
    return crc_;
  }

  void ExpectedCrc(uint32_t crc) {
    expected_crc_ = crc;
  }

  [[nodiscard]] uint32_t ExpectedCrc() const {
    return expected_crc_;
  }
  void PaddingByteCount(uint16_t nof_bytes) {
    padding_byte_count_ = nof_bytes;
  }

  [[nodiscard]] uint16_t PaddingByteCount() const {
    return padding_byte_count_;
  }

  void Reset();

  void ToRaw(EthMessageType msg_type, SampleRecord& sample) const;

  void DataGroup(const IDataGroup* data_group) const {
    data_group_ = data_group;
  }

  void ChannelGroup(const IChannelGroup* channel_group) const {
    channel_group_ = channel_group;
  }

 private:
  uint8_t bus_channel_ = 0;
  bool dir_ = false;
  EthErrorType error_type_ = EthErrorType::Unknown;
  std::array<uint8_t,6> source_ = {};
  std::array<uint8_t,6> destination_ = {};
  uint16_t eth_type_ = 0x0800; ///< IPv4 as default
  uint16_t received_data_byte_count_ = 0;
  uint16_t data_length_ = 0;
  std::vector<uint8_t> data_bytes_;
  uint32_t crc_ = 0;
  uint32_t expected_crc_ = 0;
  uint16_t padding_byte_count_ = 0;

  mutable EthMessageType message_type_ = EthMessageType::ETH_Frame;
  mutable const IDataGroup* data_group_ = nullptr;
  mutable const IChannelGroup* channel_group_ = nullptr;

  void MakeDataFrame(SampleRecord& sample) const;
  void MakeChecksumError(SampleRecord& sample) const;
  void MakeLengthError(SampleRecord& sample) const;
  void MakeReceiveError(SampleRecord& sample) const;
};

}  // namespace mdf