CCAENV1x90.h

Go to the documentation of this file.

/*
    This software is Copyright by the Board of Trustees of Michigan
    State University (c) Copyright 2005.

    You may use this software under the terms of the GNU public license
    (GPL).  The terms of this license are described at:

     http://www.gnu.org/licenses/gpl.txt

     Author:
             Ron Fox
             NSCL
             Michigan State University
             East Lansing, MI 48824-1321
*/


#ifndef __CCAENV1x90_H
#define __CCAENV1x90_h


#ifndef __STL_VECTOR
#include <vector>
#ifndef __STL_VECTOR
#define __STL_VECTOR
#endif
#endif



#ifndef __DESIGNBYCONTRACT_H
#include "DesignByContract.h"
#ifndef __DESIGNBYCONTRACT_H
#define __DESIGNBYCONTRACT_H
#endif
#endif

#ifndef VMEMODULE_H
#include <VmeModule.h>
#endif


// Class definitions.


class CCAENV1x90 
{
  // Exported data types:

public:
  typedef enum _ECLOutputSelect {
    DATA_READY,
    FULL,
    ALMOST_FULL,
    ERROR
  } ECLOutputSelect;

  struct TriggerConfiguration {
    unsigned short s_MatchWidth;
             short s_MatchOffset;
    unsigned short s_MatchExtra;
    unsigned short s_RejectMargin;
    unsigned short s_Subtracting;
  };
  typedef enum _EdgeMode {
    EdgeMode_Pair       = 0 ,
    EdgeMode_Leading    = 2,
    EdgeMode_Trailing   = 1,
    EdgeMode_Both       = 3

  } EdgeMode;
  typedef enum _Resolution {
    Res_25ps    = 3,                    // 1290 only.
    Res_100ps   = 2,
    Res_200ps   = 1,
    Res_800ps   = 0
  } Resolution;
  typedef enum _LEResolution {
    LE_100ps        = 0,
    LE_200ps       = 1,
    LE_400ps       = 2,
    LE_800ps       = 3,
    LE_1600ps      = 4,
    LE_3120ps      = 5,
    LE_6250ps      = 6,
    LE_12500ps     = 7
  } LEResolution;
  typedef enum _PWResolution {
    PW_100ps       = 0,
    PW_200ps       = 1,  
    PW_400ps       = 2,
    PW_800ps       = 3,
    PW_1600ps      = 4,
    PW_3200ps      = 5,
    PW_6250ps      = 6,
    PW_12500ps     = 7,
    PW_25ns        = 8,
    PW_50ns        = 9,
    PW_100ns       = 10,
    PW_200ns       = 11,
    PW_400ns       = 12,
    PW_800ns       = 13
  } PWResolution;

  typedef enum _DeadTime {
    DT_5ns       = 0,
    DT_10ns      = 1,
    DT_30ns      = 2,
    DT_100ns     = 3
  } DeadTime;
  // Instance data.
  typedef enum _HitMax {
    HITS_0       = 0,                   // No hits.
    HITS_1       = 1,
    HITS_2       = 2,
    HITS_4       = 3,
    HITS_8       = 4,
    HITS_16      = 5,
    HITS_32      = 6,
    HITS_64      = 7,
    HITS_128     = 8,
    HITS_UNLIMITED = 9          // No limit on hits.
  } HitMax;
  typedef enum _L1Size {
    L1_2wds,
    L1_4wds,
    L1_8wds,
    L1_16wds,
    L1_32wds,
    L1_64wds,
    L1_128wds,
    L1_256wds
  } L1Size;

  // public data

public:
  // Error masks for Get/Set ErrorEnables:
  
  static const unsigned short ERR_VERNIER;
  static const unsigned short ERR_COARSE;
  static const unsigned short ERR_SELECT;
  static const unsigned short ERR_L1PARITY;
  static const unsigned short ERR_TFIFOPARITY;
  static const unsigned short ERR_MATCHERROR;
  static const unsigned short ERR_RFIFOPARITY;
  static const unsigned short ERR_RDOSTATE;
  static const unsigned short ERR_SUPPARITY;
  static const unsigned short ERR_CTLPARITY;
  static const unsigned short ERR_JTAGPARITY;

  // Tap masks for calibrate delayline.
  
  static const unsigned short TAP_CONTACT1;
  static const unsigned short TAP_CONTACT2;
  static const unsigned short TAP_CONTACT3;

  
private:
  unsigned long m_nBase;        
  unsigned int  m_nCrate;       
  unsigned int  m_nSlot;        
  CVmeModule
            m_pRegisters;       
  unsigned int  m_nModel;       
  unsigned char m_cVersion;     
  unsigned int  m_nSerialNumber; 
  unsigned int  m_nChipCount;   
  unsigned int  m_nChannels;    
  unsigned int  m_nBoardRevision; 
  bool          m_fCanHiRes;    
  bool          m_fIsHiResMode; 
  bool          m_fTriggerMatching; 


  // Constructors and canonical operations.

public:
  CCAENV1x90(unsigned int nSlot, unsigned int nCrate,
             unsigned long nBase); 
  ~CCAENV1x90();
private:                        // Copy etc. not allowed.
  CCAENV1x90(const CCAENV1x90& rhs);
  CCAENV1x90& operator= (const CCAENV1x90& rhs);
  int         operator==(const CCAENV1x90& rhs) const;
  int         operator!=(const CCAENV1x90& rhs) const;
public:


  // Selectors:


public:

  unsigned int getModel() const { 
    return m_nModel;
  }
  unsigned char getVersion() const { 
    return m_cVersion;
  }
  unsigned int getSerialNumber() const { 
    return m_nSerialNumber;
  }
  unsigned int getChipCount() const { 
    return m_nChipCount;
  }
  unsigned int getChannelCount() const { 
    return m_nChannels;
  }

  // Class operations:

public:
  unsigned short SR();          

  bool isSetSR(unsigned short bitnum); 
  unsigned short ReadCR();      
  bool isSetCR(unsigned short bitnum); 

  // Functionality exposed by the control register:

  void Terminate();             
  void Unterminate();           
  void TerminateWithSwitch();   
  void EnableTriggerTagTime();  
  void DisableTriggerTagTime(); 
 
  // Status register functionality:

  bool DataReady();             
  bool AlmostFull();            
  bool isFull();                
  bool isTriggerMatching();     
  bool isHeaderEnabled();       
  bool isTerminated();          
  bool HadError(unsigned int nChip);            
  int  ReadResolution();        
  bool isPairMode();            
  bool WereTriggersLost();      

  void SetGeographicalID(unsigned short int); 
  unsigned short GetGeographicalID(); 

  // Key register access functions (sorry that's an SIS -ism).
  
  void Reset() ;                        
  void Clear();                 
  void EventReset();            
  void Trigger();               

  // Access various register counters.

  unsigned long TriggerCount(); 
  unsigned short EventCount();  
 

  // Full levels:

  void SetAlmostFullLevel(unsigned int nWords); 
  unsigned short  GetAlmostFullLevel(); 
  

  // Define what the ECL output is set to be.

  void DefineECLOutput(ECLOutputSelect signal); 
  ECLOutputSelect GetECLOutputDefinition(); 

  // State of the event fifo.  This is used to see what
  // an event in the buffer memory is going to look like:

  unsigned short EventFIFOCount(); 
  unsigned long ReadEventFIFO(); 
  bool         isEventFIFOReady(); 
  bool         isEventFIFOFull(); 
  unsigned short FIFOEventNumber(unsigned long fifoentry); 
  unsigned short FIFOWordCount(unsigned long fifoentry); 


  // Here begin the whole series of operations that involve the
  // micro sequencer.  The labels in the text below 
  // are taken from the corresponding sections in the hardware
  // manual for the board.

  // 5.2 Acquisition modee opcodes:

  void TriggerMatchMode();      
  void ContinuousStorageMode(); 
  void TransferUntilDone();     
  void TransferOneAtATime();    
  void LoadDefaultConfig();     
  void SaveUserConfig();        
  void LoadUserConfig();        
  void AutoLoadUserConfig();    
  void AutoLoadDefaultConfig(); 

  // 5.3 Trigger  opcodes.

  void SetWindowWidth(unsigned int nWidth);
  void SetWindowOffset(int nOffset); 
  void SetExtraSearchMargin(unsigned int nMargin); 
  void SetRejectMargin(unsigned int nMargin);
  void EnableTriggerTimeSubtraction(); 
  void DisableTriggerTimeSubtraction(); 
  TriggerConfiguration
       GetTriggerConfiguration();       
  unsigned int GetMatchWindow(TriggerConfiguration config);
           int GetWindowOffset(TriggerConfiguration config);
  unsigned int GetExtraSearchMargin(TriggerConfiguration config);
  unsigned int GetRejectMargin(TriggerConfiguration config);

  bool         isTriggerTimeSubtracted(TriggerConfiguration config);

  //  5.4 Trigger opcodes.
  
  void     SetEdgeDetectMode(EdgeMode nEdgeMode); 
  EdgeMode GetEdgeDetectMode();                   
  void     SetIndividualLSB(Resolution nResolution); 
  void     SetPairResolutions(LEResolution nLeadingEdge,
                              PWResolution nPulseWidth); 
  unsigned short GetResolution();                  
  Resolution InterpretEdgeResolution(unsigned short nResolution);
  LEResolution InterpretLEResolution(unsigned short nResolution);
  PWResolution InterpretWidthResolution(unsigned short nResolution);
  void SetDoubleHitResolution(DeadTime nDead); 
  DeadTime GetDoubleHitResolution(); 

  // 5.5 TDC Readout OPCODES:

  void EnableTDCEncapsulation(); 
  void DisableTDCEncapsulation(); 
  bool isTDCEncapsulationOn();  
  void SetMaxHitsPerEvent(HitMax nHits); 
  HitMax GetMaxHitsPerEvent();  
  void EnableErrorMark();       
  void DisableErrorMark();      
  void EnableBypassOnError();   
  void DisableBypassOnError();  
  void SetErrorEnables(unsigned short nErrors); 
  unsigned short GetErrorEnables(); 
  void SetL1Size(L1Size nL1Size); 
  L1Size GetL1Size();           


  // 5.6 Channel enable opcodes. nn below is a tdc chip number.
  
  void EnableChannel(unsigned short nChannel); 
  void DisableChannel(unsigned short nChannel); 
  void EnableAllChannels();     
  void DisableAllChannels();    
  void SetChannelEnables(STD(vector)<unsigned short> masks); 
  void GetChannelEnables(STD(vector)<unsigned short>& masks); 
  void SetChipEnables(unsigned short nChip,
                      unsigned int nMask); 
  unsigned int GetChipEnables(unsigned short nChip); 

  // 5.7 Adjustment opcodes.
  
  void SetGlobalOffset(unsigned short nCoarse,
                       unsigned short nVernier); 
  void ReadGlobalOffset(unsigned short& nCoarse,
                        unsigned short& nVernier); 
  void SetChannelOffset(unsigned short nChannel,
                        unsigned short nOffset); 
  unsigned short GetChannelOffset(unsigned int nChannel); 
  // V1290 only:

  void CalibrateDelayLine(unsigned short nChip,
                          unsigned short Tap1Contact,
                          unsigned short Tap2Contact,
                          unsigned short Tap3Contact,
                          unsigned short Tap4Contat); 
  void GetDelayLineCalibration(unsigned short nChip,
                               unsigned short& Tap1Contact,
                               unsigned short& Tap2Contact,
                               unsigned short& Tap3Contact,
                               unsigned short& Tap4Contact); 
  void SaveDelayLineCalibrations(); 
  
  // 5.8 Miscellaneous 

  unsigned int GetChipId(unsigned short nChip); 
  void GetuCFirmwareInfo(unsigned short& nRevision,
                         unsigned short& nDay,
                         unsigned short& nMonth,
                         unsigned short& nYear); 
  unsigned short GetChipErrors(unsigned short nChip); 

  // 5.9 system testing.

  void EnableTestMode(unsigned int nValue); 
  void DisableTestMode(); 

  // Data acquisition functions (finally)

  unsigned int ReadData(void* pBuffer,
                        unsigned int nMaxLongs);        
  unsigned int ReadPacket(void* pBuffer,
                          unsigned int nMaxLongs); 
  unsigned int ReadValid(void* pBuffer,
                         unsigned int nMaxLongs); 

  
  void WaitMicroWrite();        

  // utility functions

protected:
  bool ValidBoard(CVmeModule& pROM); 
  void BoardProperties(CVmeModule& pROM);
  void WriteCR(unsigned short mask); 
  void BitSetCR(unsigned short bit); 
  void BitClearCR(unsigned short bit); 

  void WriteMicro(unsigned short nWord); 
  unsigned short ReadMicro();   
  void WriteMicroBlock(void* pWords, 
                       unsigned int nWords); 
  void ReadMicroBlock(void* pWords,
                      unsigned int nWords); 
  void MicroTransaction(unsigned short opcode,
                        void* pWords,
                        unsigned int nWords); 
  unsigned long ReadPromLong(CVmeModule& prombase, 
                             unsigned long ByteOffset);

};
#endif

---