ActivePhaser.hpp

Go to the documentation of this file.

// ======================================================================
// \title  ActivePhaser.hpp
// \author mstarch
// \brief  cpp file for ActivePhaser component implementation class
//
// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================

#ifndef Svc_ActivePhaser_HPP
#define Svc_ActivePhaser_HPP

#include "Svc/ActivePhaser/ActivePhaserComponentAc.hpp"

namespace Svc {

class ActivePhaser final : public ActivePhaserComponentBase {
    friend class ActivePhaserTester;

  public:
    static const U32 MAX_CHILDREN = 100;
    static const U32 DONT_CARE = 0xFFFFFFFFlu;
    static constexpr FwIndexType CONNECTION_COUNT_MAX = NUM_PHASERMEMBEROUT_OUTPUT_PORTS;

    enum PhaserContextType {
        SEQUENTIAL,  // Context stores the number of times a port is called from the beginning of execution.
        COUNT        // Context stores the number of phaser cycles elapsed within a user-specified time window.
    };

    enum FinishStatus {
        UNKNOWN,  
        ON_TIME,  
        LATE      
    };

    struct PhaserStateEntry {
        FwIndexType port;
        U32 start;
        U32 length;
        U32 context;
        PhaserContextType contextType;
        bool started;
    };

    struct PhaserStateTable {
        U32 used;     
        U32 current;  
        PhaserStateEntry entries[MAX_CHILDREN];
    };

    // ----------------------------------------------------------------------
    // Component construction and destruction
    // ----------------------------------------------------------------------

    ActivePhaser(const char* const compName  
    );

    void init(const FwSizeType queueDepth,   
              const FwIndexType instance = 0 
    );

    void configure(U32 cycle_ticks);

    void register_phased(FwIndexType port, U32 length, U32 start = DONT_CARE, U32 context = DONT_CARE);

    ~ActivePhaser();

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

    void CycleIn_handler(FwIndexType portNum,     
                         Os::RawTime& cycleStart  
                         ) override;

    // ----------------------------------------------------------------------
    // Handler implementations for user-defined internal interfaces
    // ----------------------------------------------------------------------

    void Tick_internalInterfaceHandler() override;

    FinishStatus finishChild(U32 current_ticks);

    void startChild(U32 current_ticks);

    U32 getNextContext(FwIndexType port);

    U32 timeInCycle(U32 full_ticks);

    Os::Mutex m_lock;
    U32 m_cycle;           // The number of ticks that makes up a phaser cycle
    U32 m_ticks;           // The current tick count
    U32 m_ticks_rollover;  // Roll-over value for ticks
    U32 m_last_start_ticks;
    U32 m_last_cycle_ticks;
    U32 m_cycle_count;
    PhaserStateTable m_state;
};

}  // namespace Svc

#endif