env_period_card.h

Go to the documentation of this file.

#ifndef ENV_PERIOD_CARD_H
#define ENV_PERIOD_CARD_H

#include "dae2_card.h"

class EnvPeriodCardIntf : public DAE2CardIntf
{
public:
        EnvPeriodCardIntf() { }
        virtual ~EnvPeriodCardIntf() { }
        virtual void printStatus(std::ostream& os, DAEstatus& status) = 0;

        // main period register
        virtual int getCurrentPeriodNumber(DAEstatus& status) = 0; // 0 is first period
        virtual bool inDwellPeriod(DAEstatus& status) = 0; // is current period a dwell
        virtual int setNumberOfPeriods(isisU16_t n, DAEstatus& status) = 0; // numbered internally 0 to n-1
        virtual int getNumberOfPeriods(DAEstatus& status) = 0; 
        virtual int getCurrentPeriodSequence(DAEstatus& status) = 0;

        // vetos
//      int clearVetoCounters(DAEstatus& status);

        // extract trigger veto count
//      int getExtractTriggerVetoCountLow(isisU16_t* value, DAEstatus& status);
//      int getExtractTriggerVetoCountHigh(isisU16_t* value, DAEstatus& status);
//      int getExtractTriggerVetoCount(isisU32_t* value, DAEstatus& status);
//      int enableExtractTriggerVeto(DAEstatus& status);
//      int disableExtractTriggerVeto(DAEstatus& status);
        virtual int getMSModeVetoedFrames(isisU32_t* value, DAEstatus& status) = 0;

        virtual int resetPeriodCard(DAEstatus& status) = 0;
        virtual int clearPeriodCounters(DAEstatus& status) = 0;
//      int enable50HzVeto(DAEstatus& status);
//      int disable50HzVeto(DAEstatus& status);
//      int setInternalPeriodClockMode(DAEstatus& status);
//      int setExternalPeriodClockMode(DAEstatus& status);
        virtual int setSinglePeriodSequenceMode(DAEstatus& status) = 0;
        virtual int setMultiplePeriodSequenceMode(int nseq, DAEstatus& status) = 0;
        virtual bool isMultipleSequenceComplete(DAEstatus& status) = 0;
//      int setInternalPeriodControlMode(DAEstatus& status);
//      int setExternalPeriodControlMode(DAEstatus& status);
        virtual int enablePeriodMode(bool external_mode, DAEstatus& status) = 0;
        virtual int disablePeriodMode(DAEstatus& status) = 0;
        virtual int enableMSMode(DAEstatus& status) = 0;
        virtual int disableMSMode(DAEstatus& status) = 0;
        virtual int endRunAfterSequenceCompletes(DAEstatus& status) = 0;
        virtual bool isRunEndedAndSequenceComplete(DAEstatus& status) = 0;
        virtual bool isEndRunAfterSequenceCompletesInProgress(DAEstatus& status) = 0;

        virtual int enableEventMode(DAEstatus& status) = 0;
        virtual int disableEventMode(DAEstatus& status) = 0;

        virtual int programPERLUT(isisU16_t* dwell_flags, isisU16_t* frames, int nperiod, DAEstatus& status) = 0;
        virtual int programOUTLUT(isisU32_t* outputs, int nperiod, DAEstatus& status) = 0;
        virtual int readPERLUT(isisU16_t* dwell_flags, isisU16_t* frames, int nperiod, DAEstatus& status) = 0;
        virtual int readOUTLUT(isisU32_t* outputs, int nperiod, DAEstatus& status) = 0;
        virtual int getPeriodRawFrames(int period, isisU32_t* frames, DAEstatus& status) = 0;
        virtual int getPeriodGoodFrames(int period, isisU32_t* frames, DAEstatus& status) = 0;
        virtual int zeroPeriodFrameCounters(DAEstatus& status) = 0;
        virtual int zeroPeriodProtonCounters(DAEstatus& status) = 0;
        virtual int zeroPeriodExtraCounters(DAEstatus& status) = 0;
        virtual int setPeriodControlBits(isisU32_t mask, bool preserve, DAEstatus& status) = 0;


        virtual float getRawUAmpHoursPeriod(int period, DAEstatus& status) = 0;
        virtual float getGoodUAmpHoursPeriod(int period, DAEstatus& status) = 0;
        virtual int getRawPPPLowerPeriod(int period, isisU32_t* value, DAEstatus& status) = 0;
        virtual int getRawPPPUpperPeriod(int period, isisU32_t* value, DAEstatus& status) = 0;
        virtual int getGoodPPPLowerPeriod(int period, isisU32_t* value, DAEstatus& status) = 0;
        virtual int getGoodPPPUpperPeriod(int period, isisU32_t* value, DAEstatus& status) = 0;

//      int startDataCollection(DAEstatus& status);
//      int stopDataCollection(DAEstatus& status);
        virtual void abortSequenceCompleteWait(DAEstatus& status) = 0;
        virtual int setPeriodOutputDelay(isisU32_t delay, DAEstatus& status) = 0; // in microseconds

        virtual int setMuonPulse(int pulse, DAEstatus& status) = 0;

        virtual int enableDelayedStart(DAEstatus& status) = 0;
        virtual int disableDelayedStart(DAEstatus& status) = 0;
//environment

public:
        virtual int startRun(DAEstatus& status) = 0;
        virtual int stopRun(DAEstatus& status) = 0;
        virtual int ClearFramesAndPPP(DAEstatus& status) = 0;
        virtual int setFrameSync(FrameSync fs, DAEstatus& status) = 0;
        virtual FrameSync getFrameSync(DAEstatus& status) = 0;
        virtual bool isRunning(DAEstatus& status) = 0;
        virtual int resetRunController(DAEstatus& status) = 0;
        virtual int getRawFrames(isisU32_t* value, DAEstatus& status) = 0;
        virtual int getGoodFrames(isisU32_t* value, DAEstatus& status) = 0;
        virtual int getRawPPPLower(isisU32_t* value, DAEstatus& status) = 0;
        virtual int getRawPPPUpper(isisU32_t* value, DAEstatus& status) = 0;
        virtual int getRawPPP(isisU64_t* value, DAEstatus& status) = 0;
        virtual int getGoodPPPLower(isisU32_t* value, DAEstatus& status) = 0;
        virtual int getGoodPPPUpper(isisU32_t* value, DAEstatus& status) = 0;
        virtual int getGoodPPP(isisU64_t* value, DAEstatus& status) = 0;
        virtual int enableSMPVeto(DAEstatus& status) = 0;
        virtual int enableExternalVeto(int veto_number, DAEstatus& status) = 0;
        virtual int enableInternalVeto(DAEstatus& status) = 0;
        virtual int enableFIFOVeto(DAEstatus& status) = 0;
        virtual int enableFermiChopperVeto(int chopper_number, int delay, int width, DAEstatus& status) = 0;
        virtual int enableTS2PulseVeto(DAEstatus& status) = 0;
        virtual int enableISIS50HzVeto(DAEstatus& status) = 0;
        virtual int syncFrameTimer(DAEstatus& status) = 0;
        virtual int readFrameTimer(FILETIME& ft, DAEstatus& status) = 0;
        virtual double frameTimerDrift(DAEstatus& status) = 0; // icp - dae


        virtual int enableHardwarePeriods(DAEstatus& status) = 0; 
    virtual int disableHardwarePeriods(DAEstatus& status) = 0; 
        virtual int disableSMPVeto(DAEstatus& status) = 0;
        virtual int disableExternalVeto(int veto_number, DAEstatus& status) = 0;
        virtual int disableInternalVeto(DAEstatus& status) = 0;
        virtual int disableFIFOVeto(DAEstatus& status) = 0;
        virtual int disableFermiChopperVeto(int chopper_number, DAEstatus& status) = 0;
        virtual int disableTS2PulseVeto(DAEstatus& status) = 0;
        virtual int disableISIS50HzVeto(DAEstatus& status) = 0;

        virtual int getSMPVetoedFrames(isisU32_t* value, DAEstatus& status) = 0;
        virtual int getExternalVetoedFrames(int veto_number, isisU32_t* value, DAEstatus& status) = 0;
        virtual int getFIFOVetoedFrames(isisU32_t* value, DAEstatus& status) = 0;
        virtual int getInternalVetoedFrames(isisU32_t* value, DAEstatus& status) = 0;
        virtual int getFermiChopperVetoedFrames(int chopper_number, isisU32_t* value, DAEstatus& status) = 0;
        virtual int getTS2PulseVetoedFrames(isisU32_t* value, DAEstatus& status) = 0;
        virtual int getISIS50HzVetoedFrames(isisU32_t* value, DAEstatus& status) = 0;

//      int clearSMPVetoedFrames(DAEstatus& status);
//      int clearExternalVetoedFrames(DAEstatus& status);
//      int clearFIFOVetoedFrames(DAEstatus& status);

        virtual int setFrameSyncDelay(isisU32_t value, DAEstatus& status) = 0;                  // in us
        virtual int getFrameSyncDelay(isisU32_t* value, DAEstatus& status) = 0;                 // in us
        virtual float getRawUAmpHours(DAEstatus& status) = 0;
        virtual float getGoodUAmpHours(DAEstatus& status) = 0;
        virtual bool usingHardwarePeriods(DAEstatus& status) = 0;

        virtual int getFChopperVetoedFrames(int chopper_number, isisU32_t* value, DAEstatus& status) = 0;
        virtual int enableFChopperVeto(int chopper_number, int delay, int width, DAEstatus& status) = 0;  // in 20ns units
        virtual int disableFChopperVeto(int chopper_number, DAEstatus& status) = 0;
        virtual int printVetoDetails(std::ostream& os, DAEstatus& status) = 0;
        virtual int whichVeto(std::ostream& os, DAEstatus& status) = 0;

        virtual int resetCardState(DAEstatus& status) = 0;

};

template <class EnvPeriodPolicy>
class EnvPeriodCard : public DAE2Card<EnvPeriodPolicy>, public EnvPeriodCardIntf
{

private:
        unsigned m_options; 
        enum EnvPCOptions 
        { 
                MSMode=0x1,                 
                RotateFrameCountersRight=0x2, 
                FChopperVeto=0x4,
                NoCheckSRAM=0x8,   
                EventModeTimer=0x10
        };
//      enum EPCFrameSync { FrameSyncInternal = 0x0, FrameSyncSMP=0x1, FrameSyncTOF=0x2, FrameSyncMuon=0x3 };
// period card
public:

        EnvPeriodCard(int position, ISISVME* vme, DAEstatus& status);
        void printStatus(std::ostream& os, DAEstatus& status);

        // main period register
        int getCurrentPeriodNumber(DAEstatus& status); // 0 is first period
        bool inDwellPeriod(DAEstatus& status); // is current period a dwell
        int setNumberOfPeriods(isisU16_t n, DAEstatus& status); // numbered internally 0 to n-1
        int getNumberOfPeriods(DAEstatus& status); 
        int getCurrentPeriodSequence(DAEstatus& status);

        // vetos
//      int clearVetoCounters(DAEstatus& status);

        // extract trigger veto count
//      int getExtractTriggerVetoCountLow(isisU16_t* value, DAEstatus& status);
//      int getExtractTriggerVetoCountHigh(isisU16_t* value, DAEstatus& status);
//      int getExtractTriggerVetoCount(isisU32_t* value, DAEstatus& status);
//      int enableExtractTriggerVeto(DAEstatus& status);
//      int disableExtractTriggerVeto(DAEstatus& status);
        int getMSModeVetoedFrames(isisU32_t* value, DAEstatus& status);

        int resetPeriodCard(DAEstatus& status);
        int clearPeriodCounters(DAEstatus& status);
//      int enable50HzVeto(DAEstatus& status);
//      int disable50HzVeto(DAEstatus& status);
//      int setInternalPeriodClockMode(DAEstatus& status);
//      int setExternalPeriodClockMode(DAEstatus& status);
        int setSinglePeriodSequenceMode(DAEstatus& status);
        int setMultiplePeriodSequenceMode(int nseq, DAEstatus& status);
        bool isMultipleSequenceComplete(DAEstatus& status);
//      int setInternalPeriodControlMode(DAEstatus& status);
//      int setExternalPeriodControlMode(DAEstatus& status);
        int enablePeriodMode(bool external_mode, DAEstatus& status);
        int disablePeriodMode(DAEstatus& status);
        int enableMSMode(DAEstatus& status);
        int disableMSMode(DAEstatus& status);
        int endRunAfterSequenceCompletes(DAEstatus& status);
        bool isRunEndedAndSequenceComplete(DAEstatus& status);
        bool isEndRunAfterSequenceCompletesInProgress(DAEstatus& status);

        int enableEventMode(DAEstatus& status);
        int disableEventMode(DAEstatus& status);

        int programPERLUT(isisU16_t* dwell_flags, isisU16_t* frames, int nperiod, DAEstatus& status);
        int programOUTLUT(isisU32_t* outputs, int nperiod, DAEstatus& status);
        int readPERLUT(isisU16_t* dwell_flags, isisU16_t* frames, int nperiod, DAEstatus& status);
        int readOUTLUT(isisU32_t* outputs, int nperiod, DAEstatus& status);
        int getPeriodRawFrames(int period, isisU32_t* frames, DAEstatus& status);
        int getPeriodGoodFrames(int period, isisU32_t* frames, DAEstatus& status);
        int zeroPeriodFrameCounters(DAEstatus& status);
        int zeroPeriodProtonCounters(DAEstatus& status);
        int zeroPeriodExtraCounters(DAEstatus& status);
        int setPeriodControlBits(isisU32_t mask, bool preserve, DAEstatus& status);



        float getRawUAmpHoursPeriod(int period, DAEstatus& status);
        float getGoodUAmpHoursPeriod(int period, DAEstatus& status);
        int getRawPPPLowerPeriod(int period, isisU32_t* value, DAEstatus& status);
        int getRawPPPUpperPeriod(int period, isisU32_t* value, DAEstatus& status);
        int getGoodPPPLowerPeriod(int period, isisU32_t* value, DAEstatus& status);
        int getGoodPPPUpperPeriod(int period, isisU32_t* value, DAEstatus& status);

//      int startDataCollection(DAEstatus& status);
//      int stopDataCollection(DAEstatus& status);
        void abortSequenceCompleteWait(DAEstatus& status);
        int setPeriodOutputDelay(isisU32_t delay, DAEstatus& status); // in microseconds

        int setMuonPulse(int pulse, DAEstatus& status);

        int enableDelayedStart(DAEstatus& status);
        int disableDelayedStart(DAEstatus& status);

protected:
        int setVetoRegisterBits(isisU32_t mask, bool preserve, DAEstatus& status);
        int clearVetoRegisterBits(isisU32_t mask, DAEstatus& status);

        int clearPeriodControlBits(isisU32_t mask, DAEstatus& status);
        int setAndClearPeriodControlBits(isisU32_t mask, bool preserve, DAEstatus& status);
        int getRawFrames(int period_start, int nperiod, isisU32_t frames[], DAEstatus& status);
        int getGoodFrames(int period_start, int nperiod, isisU32_t frames[], DAEstatus& status);
        int getPeriodRequestedFrames(int period, isisU32_t* frames, DAEstatus& status);
        int getRequestedFrames(int period_start, int nperiod, isisU32_t frames[], DAEstatus& status);

// lookup table access register
        int lookupAccessOUTLUT(DAEstatus& status);
        int lookupAccessPERLUT(DAEstatus& status);
        int lookupFinished(DAEstatus& status);

// environment card
//environment

public:
        int startRun(DAEstatus& status);
        int stopRun(DAEstatus& status);
        int ClearFramesAndPPP(DAEstatus& status);
        int setFrameSync(FrameSync fs, DAEstatus& status);
        FrameSync getFrameSync(DAEstatus& status);
        bool isRunning(DAEstatus& status);
        int resetRunController(DAEstatus& status);
        int getRawFrames(isisU32_t* value, DAEstatus& status);
        int getGoodFrames(isisU32_t* value, DAEstatus& status);
        int getRawPPPLower(isisU32_t* value, DAEstatus& status);
        int getRawPPPUpper(isisU32_t* value, DAEstatus& status);
        int getRawPPP(isisU64_t* value, DAEstatus& status);
        int getGoodPPPLower(isisU32_t* value, DAEstatus& status);
        int getGoodPPPUpper(isisU32_t* value, DAEstatus& status);
        int getGoodPPP(isisU64_t* value, DAEstatus& status);
        int enableSMPVeto(DAEstatus& status);
        int enableExternalVeto(int veto_number, DAEstatus& status);
        int enableInternalVeto(DAEstatus& status);
        int enableFIFOVeto(DAEstatus& status);
        int enableFermiChopperVeto(int chopper_number, int delay, int width, DAEstatus& status);
        int enableTS2PulseVeto(DAEstatus& status);
        int enableISIS50HzVeto(DAEstatus& status);
        int syncFrameTimer(DAEstatus& status);
        int readFrameTimer(FILETIME& ft, DAEstatus& status);
        double frameTimerDrift(DAEstatus& status); // icp - dae


        int enableHardwarePeriods(DAEstatus& status); 
    int disableHardwarePeriods(DAEstatus& status); 
        int disableSMPVeto(DAEstatus& status);
        int disableExternalVeto(int veto_number, DAEstatus& status);
        int disableInternalVeto(DAEstatus& status);
        int disableFIFOVeto(DAEstatus& status);
        int disableFermiChopperVeto(int chopper_number, DAEstatus& status);
        int disableTS2PulseVeto(DAEstatus& status);
        int disableISIS50HzVeto(DAEstatus& status);

        int getSMPVetoedFrames(isisU32_t* value, DAEstatus& status);
        int getExternalVetoedFrames(int veto_number, isisU32_t* value, DAEstatus& status);
        int getFIFOVetoedFrames(isisU32_t* value, DAEstatus& status);
        int getInternalVetoedFrames(isisU32_t* value, DAEstatus& status);
        int getFermiChopperVetoedFrames(int chopper_number, isisU32_t* value, DAEstatus& status);
        int getTS2PulseVetoedFrames(isisU32_t* value, DAEstatus& status);
        int getISIS50HzVetoedFrames(isisU32_t* value, DAEstatus& status);

//      int clearSMPVetoedFrames(DAEstatus& status);
//      int clearExternalVetoedFrames(DAEstatus& status);
//      int clearFIFOVetoedFrames(DAEstatus& status);

        int setFrameSyncDelay(isisU32_t value, DAEstatus& status);                      // in us
        int getFrameSyncDelay(isisU32_t* value, DAEstatus& status);                     // in us
        float getRawUAmpHours(DAEstatus& status);
        float getGoodUAmpHours(DAEstatus& status);
        bool usingHardwarePeriods(DAEstatus& status);

        int getFChopperVetoedFrames(int chopper_number, isisU32_t* value, DAEstatus& status);
        int enableFChopperVeto(int chopper_number, int delay, int width, DAEstatus& status);  // in 20ns units
        int disableFChopperVeto(int chopper_number, DAEstatus& status);
        int printVetoDetails(std::ostream& os, DAEstatus& status);
        int whichVeto(std::ostream& os, DAEstatus& status);

        virtual int resetCardState(DAEstatus& status);

        virtual int position() const { return DAE2Card<EnvPeriodPolicy>::position(); }
        virtual std::string daeDevice() const  { return DAE2Card<EnvPeriodPolicy>::daeDevice(); }

protected:
        int setRunControlBits(isisU32_t mask, bool preserve, DAEstatus& status);
        int clearRunControlBits(isisU32_t mask, DAEstatus& status);
        int setAndClearRunControlBits(isisU32_t mask, bool preserve, DAEstatus& status);
        int clearPPP(DAEstatus& status);
        int updateOptions(DAEstatus& status);
        void setOptions(EnvPCOptions opts)
        {
                m_options |= opts;
        }
        void clearOptions(EnvPCOptions opts)
        {
                m_options &= ~opts;
        }
        bool checkOptions(EnvPCOptions opts)
        {
                return ((m_options & opts) != 0 ? true : false);
        }
        int processFermiChopperVeto(int chopper_number, boost::function<int(isisU32_t, DAEstatus&)> func, DAEstatus& status);
        int computeTimeOffsetDelay(isisU32_t& delay, DAEstatus& status);
};

#endif /* ENV_PERIOD_CARD_H */