WIP: TC Packet PUS new serializer/creator function #629

Closed
muellerr wants to merge 13 commits from KSat/fsfw:mueller/tc-packet-pus-improvement into development
4 changed files with 89 additions and 3 deletions

View File

@ -1,3 +1,4 @@
target_sources(
${LIB_FSFW_NAME} PRIVATE TcPacketPusBase.cpp TcPacketPus.cpp
TcPacketStoredBase.cpp TcPacketStoredPus.cpp)
${LIB_FSFW_NAME}
PRIVATE TcPacketPusBase.cpp TcPacketPus.cpp TcPacketStoredBase.cpp
TcPacketStoredPus.cpp TcPacketSerializer.cpp)

View File

@ -22,7 +22,7 @@ class TcPacketPusBase : public SpacePacketBase, virtual public RedirectableDataP
friend class TcPacketStoredBase;
public:
enum AckField {
enum AckField : uint8_t {
//! No acknowledgements are expected.
ACK_NONE = 0b0000,
//! Acknowledgements on acceptance are expected.

View File

@ -0,0 +1,42 @@
#include "TcPacketSerializer.h"
#include <cstring>
TcPacketSerializer::TcPacketSerializer(uint8_t* store, size_t maxSize, PusConfig& cfg)
: TcPacketPus(nullptr), store(store), maxSize(maxSize), cfg(cfg) {}
ReturnValue_t TcPacketSerializer::serialize(uint8_t** buffer, size_t* size, size_t maxSize,
Endianness streamEndianness) const {
if (*size + getSerializedSize() > maxSize) {
return BUFFER_TOO_SHORT;
}
std::memcpy(*buffer, store, getSerializedSize());
*buffer += getSerializedSize();
*size += getSerializedSize();
return RETURN_OK;
}
size_t TcPacketSerializer::getSerializedSize() const { return TC_PACKET_MIN_SIZE + cfg.appDataLen; }
gaisser marked this conversation as resolved
Review

TC_PACKET_MIN_SIZE is compile time fix for a specific pus version. PusConfig allows for different PusVersions. This might be an issue for PUS A usage at compile time and PUS C usage here.

TC_PACKET_MIN_SIZE is compile time fix for a specific pus version. PusConfig allows for different PusVersions. This might be an issue for PUS A usage at compile time and PUS C usage here.
ReturnValue_t TcPacketSerializer::initialize() {
if (getSerializedSize() > maxSize) {
return SerializeIF::BUFFER_TOO_SHORT;
}
ReturnValue_t result = setData(store, maxSize);
if (result != RETURN_OK) {
return result;
}
initializeTcPacket(cfg.apid, cfg.sequenceCount, cfg.ack, cfg.service, cfg.subservice,
PusConfig::PUS_VERSION, cfg.sourceId);
if (cfg.appData != nullptr and cfg.appDataLen > 0) {
std::memcpy(&tcData->appData, cfg.appData, cfg.appDataLen);
}
setPacketDataLength(calculateFullPacketLength(cfg.appDataLen) - sizeof(CCSDSPrimaryHeader) - 1);
setErrorControl();
return RETURN_OK;
}
ReturnValue_t TcPacketSerializer::deSerialize(const uint8_t** buffer, size_t* size,
Endianness streamEndianness) {
return RETURN_FAILED;
}

View File

@ -0,0 +1,43 @@
#ifndef FSFW_SRC_FSFW_TMTCPACKET_PUS_TC_TCPACKETPUSINTOBUF_H_
#define FSFW_SRC_FSFW_TMTCPACKET_PUS_TC_TCPACKETPUSINTOBUF_H_
#include <cstdint>
#include "TcPacketPus.h"
#include "fsfw/serialize/SerializeIF.h"
struct PusConfig {
uint16_t apid = 0;
uint8_t service = 0;
uint8_t subservice = 0;
uint16_t sequenceCount = 0;
uint16_t sourceId = 0;
uint8_t* appData = nullptr;
size_t appDataLen = 0;
#if FSFW_USE_PUS_C_TELECOMMANDS == 1

Maybe fix this at compile time to be disallow problems with TC_PACKET_MIN_SIZE

Maybe fix this at compile time to be disallow problems with TC_PACKET_MIN_SIZE
static constexpr pus::PusVersion PUS_VERSION = pus::PusVersion::PUS_C_VERSION;
#else
static constexpr pus::PusVersion PUS_VERSION = pus::PusVersion::PUS_A_VERSION;
#endif
uint8_t ack = TcPacketPus::ACK_ALL;
};
class TcPacketSerializer : public TcPacketPus, public SerializeIF, public HasReturnvaluesIF {
public:
TcPacketSerializer(uint8_t* store, size_t maxSize, PusConfig& cfg);
ReturnValue_t initialize();
ReturnValue_t serialize(uint8_t** buffer, size_t* size, size_t maxSize,
Endianness streamEndianness) const override;
size_t getSerializedSize() const override;
ReturnValue_t deSerialize(const uint8_t** buffer, size_t* size,
Endianness streamEndianness) override;
private:
uint8_t* store;
size_t maxSize;
PusConfig& cfg;
};
#endif /* FSFW_SRC_FSFW_TMTCPACKET_PUS_TC_TCPACKETPUSINTOBUF_H_ */