mirror of
https://github.com/nasa/fprime.git
synced 2025-12-11 13:54:34 -06:00
c69ff72110
* Format Svc and add to CI * Fix comlogger include * fix assert UTs * Fix static analysis warning * formatting
73 lines
2.3 KiB
C++
73 lines
2.3 KiB
C++
// ======================================================================
|
|
// \title FprimeProtocol.hpp
|
|
// \author mstarch
|
|
// \brief hpp file for FprimeProtocol class
|
|
//
|
|
// \copyright
|
|
// Copyright 2009-2021, by the California Institute of Technology.
|
|
// ALL RIGHTS RESERVED. United States Government Sponsorship
|
|
// acknowledged.
|
|
//
|
|
// ======================================================================
|
|
|
|
#ifndef SVC_FPRIME_PROTOCOL_HPP
|
|
#define SVC_FPRIME_PROTOCOL_HPP
|
|
|
|
#include <Svc/FramingProtocol/DeframingProtocol.hpp>
|
|
#include <Svc/FramingProtocol/FramingProtocol.hpp>
|
|
|
|
namespace Svc {
|
|
|
|
// Definitions for the F Prime frame header
|
|
namespace FpFrameHeader {
|
|
|
|
//! Token type for F Prime frame header
|
|
typedef U32 TokenType;
|
|
|
|
enum {
|
|
//! Header size for F Prime frame header
|
|
SIZE = sizeof(TokenType) * 2
|
|
};
|
|
|
|
//! The start word for F Prime framing
|
|
const TokenType START_WORD = static_cast<TokenType>(0xdeadbeef);
|
|
|
|
} // namespace FpFrameHeader
|
|
|
|
//! \brief Implements the F Prime framing protocol
|
|
class FprimeFraming : public FramingProtocol {
|
|
public:
|
|
//! Constructor
|
|
FprimeFraming();
|
|
|
|
//! Implements the frame method
|
|
void frame(const U8* const data, //!< The data
|
|
const U32 size, //!< The data size in bytes
|
|
Fw::ComPacketType packet_type //!< The packet type
|
|
) override;
|
|
};
|
|
|
|
//! \brief Implements the F Prime deframing protocol
|
|
class FprimeDeframing : public DeframingProtocol {
|
|
public:
|
|
//! Constructor
|
|
FprimeDeframing();
|
|
|
|
//! Validates data against the stored hash value
|
|
//! 1. Computes the hash value V of bytes [0,size-1] in the circular buffer
|
|
//! 2. Compares V against bytes [size, size + HASH_DIGEST_LENGTH - 1] of
|
|
//! the circular buffer, which are expected to be the stored hash value.
|
|
bool validate(Types::CircularBuffer& buffer, //!< The circular buffer
|
|
U32 size //!< The data size in bytes
|
|
);
|
|
|
|
//! Implements the deframe method
|
|
//! \return Status
|
|
DeframingStatus deframe(Types::CircularBuffer& buffer, //!< The circular buffer
|
|
U32& needed //!< The number of bytes needed, updated by the caller
|
|
) override;
|
|
};
|
|
|
|
} // namespace Svc
|
|
#endif // SVC_FPRIME_PROTOCOL_HPP
|