AosFramer.hpp

Go to the documentation of this file.

// ======================================================================
// \title  AosFramer.hpp
// \author Will MacCormack (Aos Modifications)
// \brief  hpp file for AosFramer component implementation class
// \details modified from thomas-bc's TmFramer
// ======================================================================

#ifndef Svc_Ccsds_AosFramer_HPP
#define Svc_Ccsds_AosFramer_HPP

#include "Svc/Ccsds/AosFramer/AosFramerComponentAc.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/SpacePacketHeaderSerializableAc.hpp"
#include "Svc/Ccsds/Types/TfvnEnumAc.hpp"

namespace Svc {

namespace Ccsds {

class AosFramer final : public AosFramerComponentBase {
    friend class AosFramerTester;

    static constexpr U8 SPP_IDLE_DATA_PATTERN = 0x44;
    static constexpr U8 MIN_SPP_LENGTH = 7;

    // Offset to start of payload
    static constexpr U16 START_OF_PAYLOAD = AOSHeader::SERIALIZED_SIZE + M_PDUHeader::SERIALIZED_SIZE;

    enum class BufferOwnershipState {
        NOT_OWNED,  
        OWNED,      
    };

    struct PDU {
        Fw::Buffer packet;             
        ComCfg::FrameContext context;  
        FwSizeType offset = 0;         
    };

    struct AosVc {
        U8 vc_struct_index = 0xFF;  
        U8 virtualChannelId = 0;    
        // Current implementation uses a single virtual channel, so we can use a single virtual frame count
        U32 virtualFrameCount = 0;  

        // Because the AOS protocol use fixed width frames, and only one frame is in transit between ComQueue and
        // ComInterface at a time, we can use a member fixed-size buffer to hold the frame data
        struct FrameBuffer {
            U8 backer[ComCfg::AosMaxFrameFixedSize];                   
            Fw::Buffer buffer;                                         
            BufferOwnershipState state = BufferOwnershipState::OWNED;  
        } frame;

        // multi frame per PDU support
        PDU outstanding;

        // Bitfield of supported PVNs for inserted Idle Packets
        // Default to only supporting SPP Idle packets
        U8 idle_packet_types = PvnBitfield::SPP_MASK;

        // SPP Idle packet backstop
        // Technically we'd only use 6 of the 7 bytes at worst
        // cuz the first one had to go into the prev frame
        struct SppIdle {
            U8 backer[MIN_SPP_LENGTH];
            U8 offset = 0;
        } spp_idle;

        // Multi PDU per frame and
        U16 current_payload_offset = 0;        
        bool past_first_fresh_packet = false;  
    };

  public:
    // ----------------------------------------------------------------------
    // Component construction and destruction
    // ----------------------------------------------------------------------

    AosFramer(const char* const compName  
    );

    ~AosFramer();

    void configure(U32 fixedFixedSize,                       
                   bool frameErrorControlField,              
                   U16 spacecraftId = ComCfg::SpacecraftId,  
                   U8 vcId = 1,                              
                   U8 idlePvns = PvnBitfield::SPP_MASK       
    );

  private:
    // ----------------------------------------------------------------------
    // Handler implementations for typed input ports
    // ----------------------------------------------------------------------

    void comStatusIn_handler(FwIndexType portNum,    
                             Fw::Success& condition  
                             ) override;

    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;

    // ----------------------------------------------------------------------
    // Helpers
    // ----------------------------------------------------------------------

    FwSizeType get_min_size();

  private:
    void fill_with_idle_packet(AosVc& vc, const ComCfg::FrameContext& context);

    void serialize_idle_spp_packet(Fw::SerialBufferBase& serializer, U16 length);

    void setup_header(const ComCfg::FrameContext& context);

    void setup_m_pdu_header(const ComCfg::FrameContext& context, bool noFresh = false);

    void pack_packet(Fw::Buffer& data, const ComCfg::FrameContext& context, FwSizeType offset = 0);

    void check_and_send_vc(AosFramer::AosVc& currentVc);

    void pack_pad_send(Fw::Buffer& data, const ComCfg::FrameContext& context, FwSizeType offset = 0);

    void compute_and_inject_fecf(AosVc& currentVc);

    static bool buffer_belongs(Fw::Buffer& buffer, U8 const* start, FwSizeType size);

    AosVc& get_vc_struct(const ComCfg::FrameContext& context);

    // ----------------------------------------------------------------------
    // Members
    // ----------------------------------------------------------------------
  private:
    // Config Parameters
    bool m_fecf = true;      
    U16 m_spacecraftId = 0;  

    AosVc m_vcs[1];  
};

}  // namespace Ccsds
}  // namespace Svc

#endif