sis3300.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 __SIS3300_H
#define __SIS3300_H

#ifndef __SPECTRODAQ_H
#include <spectrodaq.h>
#define __SPECTRODAQ_H
#endif


#ifndef __STL_STRING
#include <string>
#define __STL_STRING
#endif

class CSIS3300 {
public:
  typedef enum _ClockSource {
    Internal100Mhz = 0,
    Internal50Mhz  = 1,
    Internal25Mhz  = 2,
    Internal12_5Mhz= 3,
    Internal6_25Mhz= 4,
    Internal3_125Mhz=5,
    ExternalFp      =6,
    ExternalP2      =7 
  } ClockSource;                
  typedef enum _SampleSize {
    Sample128K     = 0,
    Sample16K      = 1,
    Sample4K       = 2,
    Sample2K       = 3,
    Sample1K       = 4,
    Sample512      = 5,
    Sample256      = 6,
    Sample128      = 7,
  } SampleSize; 

private:
  unsigned long           m_nBase;            
  // Register pointers:
  volatile unsigned long* m_pCsrs;            
  volatile unsigned long* m_pEi1;             
  volatile unsigned long* m_pEi2;              
  volatile unsigned long* m_pEi3;             
  volatile unsigned long* m_pEi4;             

  volatile unsigned long* m_pModuleId;        
  volatile unsigned long* m_pCsr;             
  volatile unsigned long* m_pAcqReg;         
  volatile unsigned long* m_pResetKey;        
  volatile unsigned long* m_pStart;           
  volatile unsigned long* m_pStop;            
  volatile unsigned long* m_pEventConfig;    
  volatile unsigned long* m_pStartDelay;        
  volatile unsigned long* m_pStopDelay;       
  volatile unsigned long* m_pAddressReg1; 
  volatile unsigned long* m_pAddressReg2; 
  volatile unsigned long* m_pAddressReg3; 
  volatile unsigned long* m_pAddressReg4; 
  volatile unsigned long* m_pEventDirectory1;   
  volatile unsigned long* m_pEventDirectory2;   
  volatile unsigned long* m_pEventDirectory3;   
  volatile unsigned long* m_pEventDirectory4;   
  volatile unsigned long* m_pBank1Buffers[4];   
  volatile unsigned long* m_pThresholds[4]; 

  // State which determines how the module is set up:
 
  void*         m_nFd;          
  ClockSource m_eClock;             
  bool        m_fStartDelayEnabled; 
  unsigned int m_nStartDelayClocks; 
  bool        m_fStopDelayEnabled;  
  unsigned int m_nStopDelayClocks;

  bool       m_fGateMode;        
  bool       m_fRandomClock;     
  bool       m_fLemoStartStop;
  bool       m_fP2StartStop;

  bool       m_fHiRA_RCM;        
  bool       m_fStopTrigger;    
  SampleSize m_ePagesize;       
  unsigned int m_nPagesize;     
  bool       m_fPageWrap;       
  bool       m_fThresholdLt[8]; 
  unsigned int m_nThresholds[8];        





public:
  // Constructors and other canonical member functions:

  CSIS3300(unsigned long nBaseAddress,
           unsigned int nCrate = 0);
private:
  CSIS3300(const CSIS3300& rhs);
  CSIS3300& operator=(const CSIS3300& rhs);
  int      operator==(const CSIS3300& rhs);
public:
  ~CSIS3300();

  // Selectors:
public:
  unsigned long getBaseAddress() const {
    return m_nBase;
  }
  unsigned long getPageSize() const {
    return m_nPagesize;
  }

  volatile unsigned long* getAddressRegister1() {
    return m_pAddressReg1;
  }
   volatile unsigned long* getAddressRegister2() {
    return m_pAddressReg2;
  }
  volatile unsigned long* getAddressRegister3() {
    return m_pAddressReg3;
  }
  volatile unsigned long* getAddressRegister4() {
    return m_pAddressReg4;
  }
  volatile unsigned long* getModuleBase() { 
    return m_pCsrs;
  }
  volatile unsigned long* getCsr() {
    return m_pCsr;
  }
  unsigned long getStatusRegister() const {  
    return *m_pCsrs;
  }
  void setControlRegister(unsigned long value) {
    *m_pCsrs = value;
  }
  volatile const unsigned long* getModuleId() const{
    return m_pModuleId;
  }
  unsigned int getModelNumber() const {
    return (*m_pModuleId >> 16) & 0xffff;
  }
  unsigned int getFirmwareMajor() const {
    return (*m_pModuleId >> 8) & 0xff;
  }
  unsigned int getFirmwareMinor() const {
    return (*m_pModuleId) & 0xff;
  }

  volatile const unsigned long* getAcquisitionRegister() const {
    return m_pAcqReg;
  }
  volatile unsigned long* getResetKeyRegister() {
    return m_pResetKey;
  }
  volatile unsigned long* getStartKeyRegister() {
    return m_pStart;
  }
  volatile unsigned long* getEventConfigRegister() {
    return m_pEventConfig;
  }
  volatile unsigned long* getStartDelayRegister() {
    return m_pStartDelay;
  }
  volatile unsigned long* getStopDelayRegister() {
    return m_pStopDelay;
  }
  volatile unsigned long* getEventDirectory1() {
    return m_pEventDirectory1;
  }

  volatile unsigned long* getEventDirectory2() {
    return m_pEventDirectory2;
  }
  volatile unsigned long* getEventDirectory3() {
    return m_pEventDirectory3;
  }
  volatile unsigned long* getEventDirectory4() {
    return m_pEventDirectory4;
  }
  void* getFd() {
    return m_nFd;
  }
  // These functions really only make sense inside the class body.
  // they return VME addresses not process virtual addresses.
private:
  volatile unsigned long getGroup1Address() {
    return getBaseAddress() + 0x400000;
  }
  volatile unsigned long getGroup2Address() {
    return getBaseAddress() + 0x480000;
  }
  volatile unsigned long getGroup3Address() {
    return getBaseAddress() + 0x500000;
  }
  volatile unsigned long getGroup4Address() {
    return getBaseAddress()+0x580000;
  }
public:

  // Configuration functions:
 
  void Reset();                 
  void SetClock(ClockSource eSource);
  void SetStartDelay(bool Enable = false, unsigned int nClocks = 0);
  void SetStopDelay(bool Enable  = false, unsigned int nClocks = 0);
  void GateMode(bool Enable = false);
  void RandomClock(bool Enable = false);
  void LemoStartStop(bool Enable = false);
  void P2StartStop(bool   Enable = false);
  void HiRA_RCM(bool Enable = false);
  void TriggerOnStop(bool Enable=true);
  void SetSampleSize(SampleSize eSamples);
  void EnableWrap(bool Enable=true);
  unsigned int GetUserInput();

  void SetThresholds(bool* pLessThan,
                     unsigned int* pValues);

  // Configuration inquiry functions.

  CSIS3300::ClockSource  getCurrentClockSource();
  bool         isStartDelayEnabled();
  unsigned int getStartDelayClocks();
  bool         isStopDelayEnabled();
  unsigned int getStopDelayClocks();
  unsigned int getThresholdValue(unsigned int channel) const {
    return m_nThresholds[channel];
  }
  bool         isLtThreshold(unsigned int channel) const {
    return m_fThresholdLt[channel];
  }
  bool haveHiRAFirmware() const;


  //  Data taking functions. 
public:
  void LightOn();
  void LightOff();
  void InitDaq();
  void Arm1();
  void Arm2();
  void DisArm1();
  void DisArm2();
  void StartSampling();
  void StopSampling();
  void EnableUserOut();
  void DisableUserOut();
  void StrobeUserOut(int time);
  bool WaitUntilDone(int timeout);
  unsigned long EventNumber(int bank);

  // New members to do I/O to ordinary buffers.

  unsigned int ReadGroup1(void* pBuffer);
  unsigned int ReadGroup2(void* pBuffer);
  unsigned int ReadGroup3(void* pBuffer);
  unsigned int ReadGroup4(void* pBuffer);
  unsigned int ReadAllGroups(void * pBuffer);
  //
  // Old style read to spectrodaq buffers.
  //
  unsigned int ReadGroup1(DAQWordBufferPtr& pBuffer);
  unsigned int ReadGroup2(DAQWordBufferPtr& pBuffer);
  unsigned int ReadGroup3(DAQWordBufferPtr& pBuffer);
  unsigned int ReadGroup4(DAQWordBufferPtr& pBuffer);
  unsigned int ReadAllGroups(DAQWordBufferPtr& pBuffer);

  void ClearDaq();
protected:
  unsigned int ReadAGroup(DAQWordBufferPtr& pBuffer,
                          volatile unsigned long* pAddressReg1,
                          unsigned long pBase);
 
  //
  unsigned int ReadAGroup(void* pbuffer,
                          volatile unsigned long* pAddressReg1,
                          unsigned long           pBase);
};



#endif

---