period_card.h

Go to the documentation of this file.

#ifndef PERIOD_CARD_H
#define PERIOD_CARD_H

#define MAT_1                     0x4

#define MAX_NUM_PERIODS (16*1024) // should be same of OUTLUT and PERLUT sizes

// all 32 bit aligned addresses

#define MPCNT                     0x60  // main period (DAQ + Dwell) counter (14 bit, RO) also has dwell flag
#define MPLIM                     0x64  // main period (DAQ + Dwell) limit register (14 bit, RW)
#define PSCNT                     0x68  // period sequence counter (16 bit, RO)
#define PSLR                      0x6c  // period sequence limit register (16 bit, RW)
#define EXTTRIGVC0                0x70  // extraft trigger veto count low (16 bit, RO)
#define EXTTRIGVC1                0x74  // extract trigger veto count high (16 bit, RO)
#define I50HZVC0                  0x78  // isis not at 50Hz veto count low (16 bit, RO)
#define I50HZVC1                  0x7C  // isis not at 50Hz veto count high (16 bit, RO)
#define EXTPTRANVC0               0x80  // external period transition veto counter low (16 bit, RO)
#define EXTPTRANVC1               0x84  // external period transition veto counter high (16 bit, RO)
#define LOOKTAR                   0x40000  // lookup table access register (4bit, RW) - see below
#define PCREG                     0x40088  // period control register (16 bit, RW) - see below
#define EXTPERREG                 0x4008c  // external periods register (16bit, RW) - see below
#define FWVERREG                  0x7fffc  // firmware version regiuster (32 bit, RW)
#define PERLUTSTART               0x80000  // period lookup table (16k x 32 bit RW)
#define PERLUTSIZE                (16*1024)  // 
#define PERLUTEND                 (PERLUTSTART + 4*PERLUTSIZE)

#define OUTLUTSTART               0xc0000  // period switching output lookup table (16k x 16 bit RW)
#define OUTLUTSIZE                (16*1024)  // 
#define OUTLUTEND                 (OUTLUTSTART + 4*OUTLUTSIZE)
#define RFCNT0START               0x100000 // raw frame counters(16k x 32 bit, RW) in counts0
#define RFCNT0SIZE                (16*1024)
#define GFCNT0START               0x110000 // good frame counters(16k x 32 bit, RW) in counts0
#define GFCNT0SIZE                (16*1024)
#define RPCNT0START               0x120000 // raw frame counters(16k x 32 bit, RW) in counts0
#define RFCNT0SIZE                (16*1024)
#define GPCNT0START               0x130000 // good frame counters(16k x 32 bit, RW) in counts0
#define GFCNT0SIZE                (16*1024)

// bits for lookup table access register (LOOKTAR, 0x40000)
// All are active high
#define TARPERLUT               (1 << 0) // access PERLUT enable bit, RW
#define TAROUTLUT               (1 << 1) // access OUTLUT enable bit, RW
#define TARCNT0                 (1 << 2) // access Counts0 enable bit, RW
#define TARBCT1                 (1 << 3) // access Counts1 enable bit, RW

// bits for period control register (PCREG, 0x40088)
// All are active high
#define PCENDAFTER              (1 << 1)        // end run after period sequence completes control bit (RW)
#define PCSEQCOMP               (1 << 2)    // period sequence complete monitor bit (RO)
#define PCENDSEQCOMP    (1 << 3)    // run ended and period sequence complete monitor bit (RO)
#define PCENAB                  (1 << 4)    // normal/period mode enable (RW)
#define PCEXTENAB               (1 << 5)    // internal/external periods control mode enable (RW)
#define PCMULENAB               (1 << 6)    // single/multi period sequence control mode enable  (RW)
#define PCMULCOMP               (1 << 7)    // multiple period sequence completed monitor bit (RO)
#define PCEXTPERCLK     (1 << 8)    // internal/external period clock mode enable (RW)
#define PC50HZENAB      (1 << 9)    // isis not at 50 Hz veto enable (RW)
#define PCEXTTRIG               (1 << 10)   // extract trigger veto enable (RW)
#define PCCLRVETO               (1 << 12)   // clear veto counters (RW)
#define PCCLRPC                 (1 << 13)   // clear period counters (RW)
#define PCRESET                 (1 << 15)   // period card reset control bit(RW)

// bits for perlut
#define PERLUTTYPE                (1 << 31) // bit of perlut used to decide if dwell or daq period

#include "dae2_card.h"

class PeriodCard : public DAE2Card
{

public:
        PeriodCard(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 resetCard(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(DAEstatus& status);
        int setInternalPeriodControlMode(DAEstatus& status);
        int setExternalPeriodControlMode(DAEstatus& status);
        int enablePeriodMode(DAEstatus& status);
        int disablePeriodMode(DAEstatus& status);
        int endRunAfterSequenceCompletes(DAEstatus& status);
        bool isRunEndedAndSequenceComplete(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 setPeriodControlBits(isisU32_t mask, bool preserve, DAEstatus& status);

        int startDataCollection(DAEstatus& status);
        int stopDataCollection(DAEstatus& status);
        void abortSequenceCompleteWait(DAEstatus& status);

protected:

        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);
};

#endif /* PERIOD_CARD_H */