AosDeframer.hpp

Go to the documentation of this file.

// ======================================================================
// \title  AosDeframer.hpp
// \author Auto-generated
// \brief  hpp file for AosDeframer component implementation class
//
// Deframer for the AOS Space Data Link Protocol per CCSDS 732.0-B-5.
// Supports M_PDU data field service with:
// - Frame Error Control Field (FECF) validation
// - Space Packet Protocol (SPP) extraction
// - Encapsulation Packet Protocol (EPP) extraction per CCSDS 133.1-B-3
// ======================================================================

#ifndef Svc_Ccsds_AosDeframer_HPP
#define Svc_Ccsds_AosDeframer_HPP

#include "Svc/Ccsds/AosDeframer/AosDeframerComponentAc.hpp"
#include "Svc/Ccsds/AosDeframer/FppConstantsAc.hpp"
#include "Svc/Ccsds/Types/AOSHeaderSerializableAc.hpp"
#include "Svc/Ccsds/Types/AOSTrailerSerializableAc.hpp"
#include "Svc/Ccsds/Types/FppConstantsAc.hpp"
#include "Svc/Ccsds/Types/M_PDUHeaderSerializableAc.hpp"
#include "Svc/Ccsds/Types/TfvnEnumAc.hpp"
#include "config/FppConstantsAc.hpp"
#include "config/PvnEnumAc.hpp"

namespace Svc {
namespace Ccsds {

class AosDeframer : public AosDeframerComponentBase {
  public:
    // ----------------------------------------------------------------------
    // Component construction and destruction
    // ----------------------------------------------------------------------

    AosDeframer(const char* const compName  
    );

    ~AosDeframer();

    void configure(U32 fixedFrameSize,
                   bool frameErrorControlField,
                   U16 spacecraftId = ComCfg::SpacecraftId,
                   U8 vcId = 0,
                   U8 pvnMask = PvnBitfield::SPP_MASK | PvnBitfield::EPP_MASK);

  private:
    // Forward declaration for helper method signatures that reference the nested VC state type
    struct AosDeframerVc;

    // ----------------------------------------------------------------------
    // Handler implementations for user-defined typed input ports
    // ----------------------------------------------------------------------

    void dataIn_handler(FwIndexType portNum,  
                        Fw::Buffer& data,
                        const ComCfg::FrameContext& context) override;

    void dataReturnIn_handler(FwIndexType portNum,  
                              Fw::Buffer& data,     
                              const ComCfg::FrameContext& context) override;

    // ----------------------------------------------------------------------
    // Private helper methods
    // ----------------------------------------------------------------------

    AosDeframerVc* parseAndValidateHeader(Fw::Buffer& data, ComCfg::FrameContext& context);

    bool validateFecf(Fw::Buffer& data);

    void notifyErrorIfConnected(Ccsds::FrameError error);

    void abandonSpanningPacket(AosDeframerVc& vc);

    void extractPackets(AosDeframerVc& vc, Fw::Buffer& data);

    FwSizeType sizePacket(AosDeframerVc& vc, U8* packetStart, FwSizeType remainingBytes);

    FwSizeType sizeSppPacket(U8* payloadStart, FwSizeType payloadSize);

    FwSizeType sizeEppPacket(const U8* const payloadStart, FwSizeType payloadSize);

    static U8 getPacketVersion(U8 firstByte);

    FwSizeType appendToSpanningPacket(AosDeframerVc& vc, U8* data, FwSizeType size);

    AosDeframerVc* getVcStruct(const U8 vcId);

    struct AosDeframerVc {
        U8 vcStructIndex = 0xFF;                                     
        U8 virtualChannelId = 0;                                     
        U8 pvnMask = PvnBitfield::SPP_MASK | PvnBitfield::EPP_MASK;  

        // Telemetry counters (per-VC)
        U32 framesProcessed = 0;   
        U32 packetsExtracted = 0;  
        U32 vcFrameCount = 0;      

        // Spanning packet state (for packets that span multiple frames)
        // Per CCSDS 732.0-B-5 Section 4.1.4.2.2.3
        struct SpanningPacketState {
            static constexpr FwSizeType HEADER_BUF_SIZE =
                8;  
            U8 headerBuf[HEADER_BUF_SIZE];  

            Fw::Buffer buffer;  

            FwSizeType bytesReceived = 0;  
            // Context to be sent w/ the spanning packet
            ComCfg::FrameContext context;
        } spanningPacket;
    };

  private:
    // ----------------------------------------------------------------------
    // Member variables
    // ----------------------------------------------------------------------

    // Frame-level configuration parameters (set via configure())
    U32 m_fixedFrameSize = 0;   
    bool m_fecfEnabled = true;  
    U16 m_spacecraftId = 0;     

    U32 m_crcErrorCount = 0;

    AosDeframerVc m_vcs[AosDeframer_NumVcs];  
};

}  // namespace Ccsds
}  // namespace Svc

#endif