#include <v1720CONET2.hxx>

Collaboration diagram for v1720CONET2:

Classes
struct	V1720_CONFIG_SETTINGS
	Settings structure for this v1740 module. More...

Public Member Functions
	v1720CONET2 (int feindex, int link, int board, int moduleID)
	Constructor for the module object.

	~v1720CONET2 ()
	Destructor for the module object.

CAENComm_ErrorCode	Connect ()
	Connect the board through the optical link.

CAENComm_ErrorCode	Disconnect ()
	Disconnect the board through the optical link.

CAENComm_ErrorCode	StartRun ()
	Start data acquisition.

CAENComm_ErrorCode	StopRun ()
	Start data acquisition.

CAENComm_ErrorCode	SetupPreset (int)
	Setup board registers using preset (see ov1720.c:ov1720_Setup())

CAENComm_ErrorCode	AcqCtl (uint32_t)
	Control data acquisition.

CAENComm_ErrorCode	ChannelConfig (uint32_t)
	Control data acquisition.

CAENComm_ErrorCode	ReadReg (DWORD, DWORD *)
	Read 32-bit register.

CAENComm_ErrorCode	WriteReg (DWORD, DWORD)
	Write to 32-bit register.

CAENComm_ErrorCode	ReadEvent (DWORD , int )
	Read event buffer.

CAENComm_ErrorCode	SendTrigger ()
	Send a software trigger to the board.

CAENComm_ErrorCode	Poll (DWORD *)
	Poll Event Stored register.

int	SetODBRecord (HNDLE h, void(cb_func)(INT, INT, void ))
	Set the ODB record for this module.

int	InitializeForAcq ()
	Initialize the hardware for data acquisition.

bool	IsConnected ()
	Get connected status.

bool	IsRunning ()
	Get run status.

std::string	GetName ()
	Get short string identifying the module's index, link and board number.

HNDLE	GetODBHandle ()
	returns ODB handle

bool	GetSettingsTouched ()

void	SetSettingsTouched (bool t)

int	GetHandle ()
	returns device handler

int	GetModuleID ()
	returns unique module ID

int	GetLink ()
	returns optical link number

int	GetBoard ()
	returns board number

int	GetFEIndex ()
	returns frontend index

void	getChannelConfig (DWORD aChannelConfig)
	Get data type and ZLE configuration.

BOOL	IsZLEData ()
	Get ZLE setting.

void	fillQtBank (char aDest, uint32_t aZLEData, int aModule)
	Fill Qt Bank.

Public Attributes
int	verbose

struct v1720CONET2::V1720_CONFIG_SETTINGS	config
	instance of config structure

BOOL	mZLE
	true if ZLE (Zero-length encoding) is enabled on all channels

int	mDataType

Static Public Attributes
static const char *	config_str []
	Configuration string for this module. (ODB: /Equipment/[eq_name]/Settings/[board_name]/)

Private Attributes
int	_handle
	Device handler.

int	_feindex
	Frontend index number.

int	_link
	Optical link number.

int	_board
	Module/Board number.

int	_moduleID
	Unique module ID.

HNDLE	_odb_handle
	ODB handle.

bool	_settings_loaded
	ODB settings loaded.

bool	_settings_touched
	ODB settings touched.

bool	_running
	Run in progress.

Detailed Description

Driver class for the v1720 module using the CAEN CONET2 (optical) interface. Contains all the methods necessary to:

Connect/disconnect the board through an optical connection
Initialize the hardware (set the registers) for data acquisition
Read and write to the ODB
Poll the hardware and read the event buffer into a midas bank
Handle ZLE data
Send a software trigger to the board if desired

Definition at line 35 of file v1720CONET2.hxx.

Constructor & Destructor Documentation

◆ v1720CONET2()

v1720CONET2::v1720CONET2	(	int	feindex,
		int	link,
		int	board,
		int	moduleID
	)

Constructor for the module object.

Set the basic hardware parameters

Parameters

[in]	feindex	Frontend index number
[in]	link	Optical link number
[in]	board	Board number on the optical link
[in]	moduleID	Unique ID assigned to module

Definition at line 111 of file v1720CONET2.cxx.

: _feindex(feindex), _link(link), _board(board), _moduleID(moduleID)
{
  _handle = -1;
  _odb_handle = 0;
  verbose = 0;
  _settings_loaded=false;
  _settings_touched=false;
  _running=false;
  mZLE=false;
  mDataType = 0;
}

◆ ~v1720CONET2()

v1720CONET2::~v1720CONET2 ( )

Destructor for the module object.

Nothing to do.

Definition at line 129 of file v1720CONET2.cxx.

130{

131}

Member Function Documentation

◆ AcqCtl()

CAENComm_ErrorCode v1720CONET2::AcqCtl ( uint32_t operation )

Control data acquisition.

Write to Acquisition Control reg

Parameters

[in] operation acquisition mode (see v1720.h)

Returns: CAENComm Error Code (see CAENComm.h)

Definition at line 297 of file v1720CONET2.cxx.

{
#if SIMULATION
  return CAENComm_Success;
#else
  return ov1720_AcqCtl(_handle, operation);
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ChannelConfig()

CAENComm_ErrorCode v1720CONET2::ChannelConfig ( uint32_t operation )

Control data acquisition.

Write to Acquisition Control reg

Parameters

[in] operation acquisition mode (see v1720.h)

Returns: CAENComm Error Code (see CAENComm.h)

Definition at line 313 of file v1720CONET2.cxx.

{
#if SIMULATION
  return CAENComm_Success;
#else
  return ov1720_ChannelConfig(_handle, operation);
#endif
}

Here is the call graph for this function:

◆ Connect()

CAENComm_ErrorCode v1720CONET2::Connect ( )

Connect the board through the optical link.

Returns: CAENComm Error Code (see CAENComm.h)

Definition at line 171 of file v1720CONET2.cxx.

{
  if (verbose) cout << GetName() << "::Connect()\n";
  if (IsConnected()) { cout << "Error: trying to connect already connected board" << endl;
  return (CAENComm_ErrorCode) 1; }
#if SIMULATION
  if (verbose) cout << "Opening device " << _board << endl;
#else
  if (verbose) cout << "Opening device (i,l,b) = (" << _feindex << "," << _link << "," << _board << ")" << endl;
#endif
 
  CAENComm_ErrorCode sCAEN;
 
#if SIMULATION
  sCAEN = CAENComm_Success;
  _handle = 1;  //random
#else
  sCAEN = CAENComm_OpenDevice(CAENComm_PCIE_OpticalLink, _link, _board, 0, &_handle);
#endif
 
  if (sCAEN != CAENComm_Success) _handle = -1;
  return sCAEN;
}

Here is the call graph for this function:

◆ Disconnect()

CAENComm_ErrorCode v1720CONET2::Disconnect ( )

Disconnect the board through the optical link.

Returns: CAENComm Error Code (see CAENComm.h)

Definition at line 199 of file v1720CONET2.cxx.

{
  if (verbose) cout << GetName() << "::Disconnect()\n";
  if (!IsConnected()) { cout << "Error: trying to disconnect already disconnected board" << endl;  return (CAENComm_ErrorCode)1; }
  if (IsRunning()) { cout << "Error: trying to disconnect running board" << endl;  return (CAENComm_ErrorCode)1; }
#if SIMULATION
  if (verbose) cout << "Closing device " << _board << endl;
#else
  if (verbose) cout << "Closing device (i,l,b) = (" << _feindex << "," << _link << "," << _board << ")" << endl;
#endif
 
  CAENComm_ErrorCode sCAEN;
 
#if SIMULATION
  sCAEN = CAENComm_Success;
#else
  sCAEN = CAENComm_CloseDevice(_handle);
#endif
 
  _handle = -1;
  return sCAEN;
}

Here is the call graph for this function:

◆ fillQtBank()

void v1720CONET2::fillQtBank	(	char *	pevent,
		uint32_t *	pZLEData,
		int	moduleID
	)

Fill Qt Bank.

Parameters

[in]	pevent	pointer to event buffer
[in]	pZLEData	pointer to the data area of the bank
[in]	moduleID	unique module/board ID

Definition at line 719 of file v1720CONET2.cxx.

                                                                            {
  // >>> Create bank.
  // QtData is the pointer to the memory location hodling the Qt data
  // Content
  // V1720 event counter
  // V1720 Trigger time tag
  // Number of Qt
  // QT format: channel 28 time 16 charge 0
  char tBankName[5];
  sprintf(tBankName,"QT%02d",moduleID);
  uint32_t *QtData;
  bk_create(pevent, tBankName, TID_DWORD, &QtData);
 
 
  // >>> copy some header words
  *QtData = *(pZLEData+2); // event counter QtData[0]
  QtData++;
  *QtData = *(pZLEData+3); // trigger time tag QtData[1]
  QtData++;
 
  // >>> Figure out channel mapping
  //if(mNCh==0){
  int mNCh=0;
  uint32_t mChMap[8];
  uint32_t chMask = pZLEData[1] & 0xFF;
  for(int iCh=0; iCh<8; iCh++){
    if(chMask & (1<<iCh)){
      mChMap[mNCh] = iCh;
      mNCh++;
    }
  }
  if(mNCh==0){
    // printf("No channels found for module %i! Something wrong with channel mask\n", aModule);
  }
  //}
 
  // >>> Skip location QtData[2]. Will be used for number of QT;
  uint32_t* nQt = QtData;
  *(nQt) = 0;
  QtData++;
  //std::cout << QtData[0] <<  " " << *(QtData-2) << " " << QtData[1] << " " << *nQt << " " << *(QtData-1)<< " ";
  // >>> Loop over ZLE data and fill up Qt data bank
 
  uint32_t iPtr=4;
  for(int iCh=0; iCh<mNCh; iCh++){
    uint32_t chSize = pZLEData[iPtr];
    uint32_t iChPtr = 1;// The chSize space is included in chSize
    uint32_t iBin=0;
    iPtr++;
    //std::cout << "--------------- Channel: " << aModule << "-" << iCh << " size=" << chSize << " " <<  std::endl;
    uint32_t prevGoodData=1;
    while(iChPtr<chSize){
      uint32_t goodData = ((pZLEData[iPtr]>>31) & 0x1);
      uint32_t nWords = (pZLEData[iPtr] & 0xFFFFF);
      if(prevGoodData==0 && goodData==0){ // consecutive skip. Bad
        /*  std::cout << "consecutive skip: V1720=" << aModule
      << " | ch=" << iCh
      << " | prev word="  << pZLEData[iPtr-1]
      << " | cur word=" << pZLEData[iPtr] << std::endl;
         */}
      prevGoodData=goodData;
      if(goodData){
        uint32_t iMin = iBin;
        uint32_t min=4096;
        uint32_t baseline = (pZLEData[iPtr+1]&0xFFF);
        for(uint32_t iWord=0; iWord<nWords; iWord++){
          iPtr++;
          iChPtr++;
          if(min > (pZLEData[iPtr]&0xFFF) ){
            iMin = iBin+iWord*2;
            min = (pZLEData[iPtr]&0xFFF);
          }
          if(min > ((pZLEData[iPtr]>>16)&0xFFF) ){
            iMin = iBin+iWord*2+1;
            min = ((pZLEData[iPtr]>>16)&0xFFF);
          }
        }
        // package channel | iMin | min in one 32 bit word
        // don't bother for now. Temporary!!!!
        (*nQt)++; // increment number of Qt
        min = baseline-min; // turn it into a positive number
        *QtData = (((mChMap[iCh]<<28) & 0xF0000000) |
            ((iMin<<16)        & 0x0FFF0000) |
            (min               & 0x0000FFFF));
        QtData++;
        //std::cout << aModule << " "  << mChMap[iCh] << " " << iMin << " " << min << " " << *(QtData-1) << std::endl;
      }
      else{  // skip
        iBin += (nWords*2);
      }
 
      iChPtr++;
      iPtr++;
    }
  }
  //std::cout << " | " << *nQt << std::endl;
  bk_close(pevent, QtData);
}

Here is the call graph for this function:

◆ GetBoard()

int v1720CONET2::GetBoard ( )

inline

returns board number

Definition at line 125 of file v1720CONET2.hxx.

◆ getChannelConfig()

void v1720CONET2::getChannelConfig ( DWORD aChannelConfig )

Get data type and ZLE configuration.

Takes the channel configuration (0x8000) as parameter and checks against the fields for data type (pack 2 or pack 2.5) and for ZLE (Zero-length encoding). Puts the results in fields mDataType and mZLE.

Parameters

[in] aChannelConfig Channel configuration (32-bit)

Definition at line 666 of file v1720CONET2.cxx.

                                                      {
 
  // Set Device, data type and packing for QT calculation later
  int dataType = ((aChannelConfig >> 11) & 0x1);
  if(((aChannelConfig >> 16) & 0xF) == 0) {
    if(dataType == 1) {
      // 2.5 pack, full data
      mDataType = 1;
      mZLE=0;
      cm_msg(MINFO,"FE","Data Type: Full data with 2.5 Packing");
    }
    else{
      // 2 pack, full data
      mZLE=0;
      mDataType = 0;
      cm_msg(MINFO,"FE","Data Type: Full data with 2 Packing");
    }
  }
  else if(((aChannelConfig >> 16) & 0xF) == 2) {
    if(dataType == 1) {
      // 2.5 pack, ZLE data
      mDataType = 3;
      cm_msg(MINFO,"FE","Data Type: ZLE data with 2.5 Packing");
      mZLE=1;
    }
    else{
      // 2 pack, ZLE data
      mDataType = 2;
      cm_msg(MINFO,"FE","Data Type: ZLE data with 2 Packing");
      mZLE=1;
    }
  }
  else{
    cm_msg(MERROR,"FE","V1720 Data format Unrecognised reg: 0x%04x", 0x8000);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFEIndex()

int v1720CONET2::GetFEIndex ( )

inline

returns frontend index

Definition at line 126 of file v1720CONET2.hxx.

◆ GetHandle()

int v1720CONET2::GetHandle ( )

inline

returns device handler

Definition at line 118 of file v1720CONET2.hxx.

◆ GetLink()

int v1720CONET2::GetLink ( )

inline

returns optical link number

Definition at line 124 of file v1720CONET2.hxx.

◆ GetModuleID()

int v1720CONET2::GetModuleID ( )

inline

returns unique module ID

Definition at line 123 of file v1720CONET2.hxx.

◆ GetName()

string v1720CONET2::GetName ( )

Get short string identifying the module's index, link and board number.

Returns: name string

Definition at line 138 of file v1720CONET2.cxx.

{
  stringstream txt;
#if SIMULATION
  txt << "B" << _board;
#else
  txt << "F" << _feindex << _link << _board;
#endif
  return txt.str();
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetODBHandle()

HNDLE v1720CONET2::GetODBHandle ( )

inline

returns ODB handle

Definition at line 111 of file v1720CONET2.hxx.

◆ GetSettingsTouched()

bool v1720CONET2::GetSettingsTouched ( )

inline

returns true if odb settings touched

Definition at line 112 of file v1720CONET2.hxx.

                            {                   
    return _settings_touched;
  }

◆ InitializeForAcq()

int v1720CONET2::InitializeForAcq ( )

Initialize the hardware for data acquisition.

Initial setup:

Set FP I/O Ctrl (0x811C) to default settings (output trigger).
Do software reset + clear.
Set up busy daisy chaining
Put acquisition on stop.

Checks

AMC firmware version (and check that each channel has the same AMC firmware)
ROC firmware version
board type

Set registers

Use a preset if setup != 0 in the config string, or set them manually otherwise.

Returns: 0 on success, -1 on error

Definition at line 514 of file v1720CONET2.cxx.

{
  if (verbose) cout << GetName() << "::InitializeForAcq()" << endl;
 
  if (!_settings_loaded) {
    cout << "Error: cannot call InitializeForAcq() without settings loaded properly" << endl;
    return -1;    }
  if (!IsConnected())     {
    cout << "Error: trying to call InitializeForAcq() to unconnected board" << endl;
    return -1;    }
  if (IsRunning())    {
    cout << "Error: trying to call InitializeForAcq() to already running board" << endl;
    return -1;    }
 
  //don't do anything if settings haven't been changed
  if (_settings_loaded && !_settings_touched) return 0;
 
  CAENComm_ErrorCode sCAEN;
 
  // Set register V1720_FP_IO_CONTROL (0x811C) to default settings
  // (output trigger) will set the board that output the clock latter
  sCAEN = WriteReg(V1720_FP_IO_CONTROL, 0x00000000);
 
  // Clear the board
  sCAEN = WriteReg(V1720_SW_RESET, 0x1);
  sCAEN = WriteReg(V1720_SW_CLEAR, 0x1);
 
  // Setup Busy daisy chaining
  printf("\nBusy daisy chaining \n\n");
  sCAEN = WriteReg(V1720_FP_IO_CONTROL,           0x104);
  //sCAEN = WriteReg(V1720_FP_LVDS_IO_CRTL,         0x22);
  sCAEN = WriteReg(V1720_ACQUISITION_CONTROL,         0x100);
 
#if SIMULATION
  cm_msg(MINFO,"feoV1720","Simulation, no firmware check");
#else
  // Firmware version check
  // read each AMC firmware version
  // [31:16] Revision date Y/M/DD
  // [15:8] Firmware Revision (X)
  // [7:0] Firmware Revision (Y)
  // eg 0x760C0103 is 12th June 07, revision 1.3
  int addr = 0;
  uint32_t version = 0;
  uint32_t prev_chan = 0;
  // Hardcode correct firmware verisons
  // Current release 3.4_0.11 Feb 2012
  const uint32_t amc_fw_ver = 0xc102000b;
  const uint32_t roc_fw_ver = 0xc2080304;
  const uint32_t roc_fw_ver_test = 0xc5250306;   //new version we're testing
 
  for(int iCh=0;iCh<8;iCh++) {
    addr = 0x108c | (iCh << 8);
    sCAEN = ReadReg(addr, &version);
    if((iCh != 0) && (prev_chan != version)) {
      cm_msg(MERROR, "feoV1720","Error AMC Channels have different Firmware \n");
    }
    prev_chan = version;
  }
  cm_msg(MINFO,"feoV1720","Format: YMDD:XX.YY");
  if(version != amc_fw_ver) {
    cm_msg(MERROR,"feoV1720","Incorrect AMC Firmware Version: 0x%08x", version);
  }
  else {
    cm_msg(MINFO,"feoV1720","AMC Firmware Version: 0x%08x", version);
  }
 
  // read ROC firmware revision
  // Format as above
  sCAEN = ReadReg(V1720_ROC_FPGA_FW_REV, &version);
  switch (version)
  {
  case roc_fw_ver:
    cm_msg(MINFO,"feoV1720","ROC Firmware Version: 0x%08x", version);
    break;
  case roc_fw_ver_test:
    cm_msg(MINFO,"feoV1720","*** WARNING *** using new ROC Firmware Version: 0x%08x", version);
    break;
  default:
    cm_msg(MERROR,"feoV1720","Incorrect ROC Firmware Version: 0x%08x", version);
    break;
  }
 
  // Verify Board Type
  const uint32_t v1720_board_type = 0x03;
  sCAEN = ReadReg(V1720_BOARD_INFO, &version);
  if((version & 0xFF) != v1720_board_type)
    cm_msg(MINFO,"feoV1720","*** WARNING *** Trying to use a v1720 frontend with another"
        " type of board.  Results will be unexpected!");
 
#endif  //SIMULATION
 
  this->getChannelConfig(config.channel_config);
 
  //use preset setting if enabled
  if (config.setup != 0) SetupPreset(config.setup);
  //else use odb values
  else
  {
    //already reset/clear earlier this function, so skip here
    AcqCtl(config.acq_mode);
    WriteReg(V1720_CHANNEL_CONFIG,          config.channel_config);
    WriteReg(V1720_BUFFER_ORGANIZATION,     config.buffer_organization);
    WriteReg(V1720_CUSTOM_SIZE,             config.custom_size);
    WriteReg(V1720_CHANNEL_EN_MASK,         config.channel_mask);
    AcqCtl(V1720_COUNT_ACCEPTED_TRIGGER);
    WriteReg(V1720_TRIG_SRCE_EN_MASK,       config.trigger_source);
    WriteReg(V1720_FP_TRIGGER_OUT_EN_MASK,  config.trigger_output);
    WriteReg(V1720_POST_TRIGGER_SETTING,    config.post_trigger);
    //WriteReg(V1720_ALMOST_FULL_LEVEL,       850);
    WriteReg(V1720_MONITOR_MODE,            0x3);
    WriteReg(V1720_BLT_EVENT_NB,            0x1);
    WriteReg(V1720_VME_CONTROL,             V1720_ALIGN64);
 
    //set specfic channel values
    for (int iChan=0; iChan<8; iChan++)
    {
      WriteReg(V1720_CHANNEL_THRESHOLD   + (iChan<<8), config.threshold     [iChan]);
      WriteReg(V1720_CHANNEL_OUTHRESHOLD + (iChan<<8), config.nbouthreshold [iChan]);
      WriteReg(V1720_ZS_THRESHOLD        + (iChan<<8), config.zs_threshold  [iChan]);
      WriteReg(V1720_ZS_NSAMP            + (iChan<<8), config.zs_nsamp      [iChan]);
      WriteReg(V1720_CHANNEL_DAC         + (iChan<<8), config.dac           [iChan]);
      //NB: in original frontend, zst and zsn regs were set via a short calculation in the
      //frontend, not the exact values as in odb. it was not clear that this was done
      //without looking at source code, so i have changed it to just take values direct
      //from ODB.
      //On my todo list is to figure out a better way of setting up ODB settings
      //for the frontends.
 
    }
    //could do Status here
  }
 
  //todo: some kind of check to make sure stuff is set correctly???
 
  _settings_touched = false;
  UNUSED(sCAEN);
 
  //ready to do startrun
 
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsConnected()

bool v1720CONET2::IsConnected ( )

Get connected status.

Returns: true if board is connected

Definition at line 153 of file v1720CONET2.cxx.

{
  return (_handle >= 0);
}

Here is the caller graph for this function:

◆ IsRunning()

bool v1720CONET2::IsRunning ( )

Get run status.

Returns: true if run is started

Definition at line 162 of file v1720CONET2.cxx.

{
  return _running;
}

Here is the caller graph for this function:

◆ IsZLEData()

BOOL v1720CONET2::IsZLEData ( )

Get ZLE setting.

Get the current ZLE setting from the channel configuration.

Returns: true if data is ZLE

Definition at line 709 of file v1720CONET2.cxx.

                           {
  return mZLE;
}

◆ Poll()

CAENComm_ErrorCode v1720CONET2::Poll ( DWORD * val )

Poll Event Stored register.

Check Event Stored register for any event stored

Parameters

[out] val Number of events stored

Returns: CAENComm Error Code (see CAENComm.h)

Definition at line 361 of file v1720CONET2.cxx.

{
#if SIMULATION
  return CAENComm_Success;
#else
  return CAENComm_Read32(_handle, V1720_EVENT_STORED, val);
#endif
}

Here is the call graph for this function:

◆ ReadEvent()

CAENComm_ErrorCode v1720CONET2::ReadEvent	(	DWORD *	data,
		int *	dwords_read
	)

Read event buffer.

Read the event buffer for this module using BLT (32-bit) cycles. This function reads nothing if EVENT_SIZE register was zero.

Parameters

[out]	data	Where to write content of event buffer
[out]	dwords_read	Number of DWORDs read from the buffer

Returns: CAENComm Error Code (see CAENComm.h)

Definition at line 382 of file v1720CONET2.cxx.

{
  if (!IsConnected()) {
    cout << "Error: trying to ReadEvent disconnected board" << endl;
    return (CAENComm_ErrorCode)1;
  }
  DWORD size_remaining, *data_pos = data, to_read;
  int tempnw = 0;
  *dwords_read = 0;
 
  //read size of event to be read
#if SIMULATION
  CAENComm_ErrorCode sCAEN = CAENComm_Success;
  size_remaining = MAX_BLT_READ_SIZE;
#else
  CAENComm_ErrorCode sCAEN = ReadReg(V1720_EVENT_SIZE, &size_remaining);
#endif
 
  while (size_remaining > 0 && sCAEN == CAENComm_Success)
  {
#if SIMULATION
    to_read = size_remaining > MAX_BLT_READ_SIZE ? MAX_BLT_READ_SIZE : size_remaining;
    for (WORD i = 0; i < to_read; i++)
      *data_pos++ = rand();
    sCAEN = CAENComm_Success;
    tempnw = to_read; //simulate success reading all data
#else
    //calculate amount of data to be read in this iteration
    to_read = size_remaining > MAX_BLT_READ_SIZE ? MAX_BLT_READ_SIZE : size_remaining;
    sCAEN = CAENComm_BLTRead(_handle, V1720_EVENT_READOUT_BUFFER, data_pos, to_read, &tempnw);
#endif
 
    if (verbose >= 2) cout << sCAEN << " = BLTRead(handle=" << _handle
        << ", addr=" << V1720_EVENT_READOUT_BUFFER
        << ", data_pos=" << data_pos
        << ", to_read=" << to_read
        << ", tempnw returned " << tempnw << ");" << endl;
 
    //increment pointers/counters
    *dwords_read += tempnw;
    size_remaining -= tempnw;
    data_pos += tempnw;
  }
  return sCAEN;
}

Here is the call graph for this function:

◆ ReadReg()

CAENComm_ErrorCode v1720CONET2::ReadReg	(	DWORD	address,
		DWORD *	val
	)

Read 32-bit register.

Parameters

[in]	address	address of the register to read
[out]	val	value read from register

Returns: CAENComm Error Code (see CAENComm.h)

Definition at line 328 of file v1720CONET2.cxx.

{
  if (verbose >= 2) cout << GetName() << "::ReadReg(" << hex << address << ")" << endl;
#if SIMULATION
  return CAENComm_Success;
#else
  return CAENComm_Read32(_handle, address, val);
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendTrigger()

CAENComm_ErrorCode v1720CONET2::SendTrigger ( )

Send a software trigger to the board.

Send a software trigger to the board. May require software triggers to be enabled in register.

Returns: CAENComm Error Code (see CAENComm.h)

Definition at line 435 of file v1720CONET2.cxx.

{
  if (verbose) cout << GetName() << "::SendTrigger()" << endl;
  if (!IsConnected()) { cout << "Error: trying to SendTrigger disconnected board" << endl; return (CAENComm_ErrorCode)1; }
#if SIMULATION
  if (verbose) cout << "Sending Trigger " << _board << endl;
#else
  if (verbose) cout << "Sending Trigger (l,b) = (" << _link << "," << _board << ")" << endl;
#endif
 
  return WriteReg(V1720_SW_TRIGGER, 0x1);
}

Here is the call graph for this function:

◆ SetODBRecord()

int v1720CONET2::SetODBRecord	(	HNDLE	h,
		void()(INT, INT, void )	cb_func
	)

Set the ODB record for this module.

Create a record for the board with settings from the configuration string (v1720CONET2::config_str) if it doesn't exist or merge with existing record. Create hotlink with callback function for when the record is updated. Get the handle to the record.

Ex: For a frontend with index number 2 and board number 0, this record will be created/merged:

/Equipment/FEv1720I2/Settings/Board0

Parameters

[in]	h	main ODB handle
[in]	cb_func	Callback function to call when record is updated

Returns: ODB Error Code (see midas.h)

Definition at line 464 of file v1720CONET2.cxx.

{
  char set_str[200];
 
#if SIMULATION
  sprintf(set_str, "/Equipment/FEv1720_SIM/Settings/Board%d", _board);
#else
  if(_feindex == -1)
    sprintf(set_str, "/Equipment/FEv1720I/Settings/Board%d", _moduleID);
  else
    sprintf(set_str, "/Equipment/FEv1720I%0d/Settings/Board%d", _feindex, _moduleID);
#endif
 
  if (verbose) cout << GetName() << "::SetODBRecord(" << h << "," << set_str << ",...)" << endl;
  int status,size;
  //create record if doesn't exist and find key
  status = db_create_record(h, 0, set_str, strcomb(config_str));
  status = db_find_key(h, 0, set_str, &_odb_handle);
  if (status != DB_SUCCESS) cm_msg(MINFO,"FE","Key %s not found", set_str);
 
  //hotlink
  size = sizeof(V1720_CONFIG_SETTINGS);
  status = db_open_record(h, _odb_handle, &config, size, MODE_READ, cb_func, NULL);
 
  //get actual record
  status = db_get_record(h, _odb_handle, &config, &size, 0);
  if (status == DB_SUCCESS) _settings_loaded = true;
  _settings_touched = true;
 
  return status; //== DB_SUCCESS for success
}

Here is the call graph for this function:

◆ SetSettingsTouched()

void v1720CONET2::SetSettingsTouched ( bool t )

inline

set _settings_touched

Definition at line 115 of file v1720CONET2.hxx.

                                  {             
    _settings_touched = t;
  }

◆ SetupPreset()

CAENComm_ErrorCode v1720CONET2::SetupPreset ( int mode )

Setup board registers using preset (see ov1720.c:ov1720_Setup())

Setup board registers using a preset defined in the midas file ov1720.c

Mode 0x0: "Setup Skip\n"
Mode 0x1: "Trigger from FP, 8ch, 1Ks, postTrigger 800\n"
Mode 0x2: "Trigger from LEMO\n"

Parameters

[in] mode Configuration mode number

Returns: CAENComm Error Code (see CAENComm.h)

Definition at line 281 of file v1720CONET2.cxx.

{
#if SIMULATION
  return CAENComm_Success;
#else
  return ov1720_Setup(_handle, mode);
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StartRun()

CAENComm_ErrorCode v1720CONET2::StartRun ( )

Start data acquisition.

Write to Acquisition Control reg to put board in RUN mode. If ODB settings have been changed, re-initialize the board with the new settings. Set _running flag true.

Returns: CAENComm Error Code (see CAENComm.h)

Definition at line 230 of file v1720CONET2.cxx.

{
  if (verbose) cout << GetName() << "::StartRun()\n";
  if (IsRunning()) {
    cout << "Error: trying to start already started board" << endl;
    return (CAENComm_ErrorCode)1;
  }
  if (!IsConnected()) {
    cout << "Error: trying to start disconnected board" << endl;
    return (CAENComm_ErrorCode)1;
  }
  if (_settings_touched)
  {
    cm_msg(MINFO, "feoV1720", "Note: settings on board %s touched. Re-initializing board.",
        GetName().c_str());
    cout << "reinitializing" << endl;
    InitializeForAcq();
  }
 
  CAENComm_ErrorCode e = AcqCtl(V1720_RUN_START);
  if (e == CAENComm_Success) _running=true;
  return e;
}

Here is the call graph for this function:

◆ StopRun()

CAENComm_ErrorCode v1720CONET2::StopRun ( )

Start data acquisition.

Write to Acquisition Control reg to put board in STOP mode. Set _running flag false.

Returns: CAENComm Error Code (see CAENComm.h)

Definition at line 261 of file v1720CONET2.cxx.

{
  if (verbose) cout << GetName() << "::StopRun()\n";
  if (!IsRunning()) { cout << "Error: trying to stop already stopped board" << endl; return (CAENComm_ErrorCode)1; }
  if (!IsConnected()) { cout << "Error: trying to stop disconnected board" << endl; return (CAENComm_ErrorCode)1; }
  CAENComm_ErrorCode e = AcqCtl(V1720_RUN_STOP);
  if (e == CAENComm_Success) _running=false;
  return e;
}

Here is the call graph for this function:

◆ WriteReg()

CAENComm_ErrorCode v1720CONET2::WriteReg	(	DWORD	address,
		DWORD	val
	)

Write to 32-bit register.

Parameters

[in]	address	address of the register to write to
[in]	val	value to write to the register

Returns: CAENComm Error Code (see CAENComm.h)

Definition at line 344 of file v1720CONET2.cxx.

{
  if (verbose >= 2) cout << GetName() << "::WriteReg(" << hex << address << "," << val << ")" << endl;
#if SIMULATION
  return CAENComm_Success;
#else
  return CAENComm_Write32(_handle, address, val);
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ _board

int v1720CONET2::_board

private

Module/Board number.

Definition at line 44 of file v1720CONET2.hxx.

◆ _feindex

int v1720CONET2::_feindex

private

Frontend index number.

Definition at line 42 of file v1720CONET2.hxx.

◆ _handle

int v1720CONET2::_handle

private

Device handler.

Definition at line 41 of file v1720CONET2.hxx.

◆ _link

int v1720CONET2::_link

private

Optical link number.

Definition at line 43 of file v1720CONET2.hxx.

◆ _moduleID

int v1720CONET2::_moduleID

private

Unique module ID.

Definition at line 45 of file v1720CONET2.hxx.

◆ _odb_handle

HNDLE v1720CONET2::_odb_handle

private

ODB handle.

Definition at line 48 of file v1720CONET2.hxx.

◆ _running

bool v1720CONET2::_running

private

Run in progress.

Definition at line 51 of file v1720CONET2.hxx.

◆ _settings_loaded

bool v1720CONET2::_settings_loaded

private

ODB settings loaded.

Definition at line 49 of file v1720CONET2.hxx.

◆ _settings_touched

bool v1720CONET2::_settings_touched

private

ODB settings touched.

Definition at line 50 of file v1720CONET2.hxx.

◆ config

struct v1720CONET2::V1720_CONFIG_SETTINGS v1720CONET2::config

instance of config structure

◆ config_str

const char * v1720CONET2::config_str

static

Configuration string for this module. (ODB: /Equipment/[eq_name]/Settings/[board_name]/)

Definition at line 18 of file v1720CONET2.hxx.

           {
#include "CAENComm.h"
#include "ov1720drv.h"
}
#include "midas.h"
 
class v1720CONET2
{
private:
#if SIMULATION
  int _handle, _board;
#else
  int _handle,  
  _feindex,     
  _link,        
  _board,       
  _moduleID;    
#endif
 
  HNDLE _odb_handle;      
  bool _settings_loaded,  
  _settings_touched,      
  _running;               
 
public:
  int verbose;  
 
 
  struct V1720_CONFIG_SETTINGS {
    INT       setup; 
    INT       acq_mode;                
    DWORD     channel_config;          
    INT       buffer_organization;     
    INT       custom_size;             
    DWORD     channel_mask;            
    DWORD     trigger_source;          
    DWORD     trigger_output;          
    DWORD     post_trigger;            
    // Hard code the two fp_* settings to alway on (Alex 21/2/13)
    //    DWORD     fp_io_ctrl;              //!< 0x811C@[31.. 0]
    DWORD     almost_full;             
    //    DWORD     fp_lvds_io_ctrl;         //!< 0x81A0@[31.. 0]
    //    BOOL      trigger_positive_pulse;  //!< 0x8000@[     6]
    //    WORD      pre_record_zs;           //!< 0x1n24@[31..16]
    //    WORD      post_record_zs;          //!< 0x1n24@[15.. 0]
    DWORD     threshold[8];            
    DWORD     nbouthreshold[8];        

◆ mDataType

int v1720CONET2::mDataType

Data type for all channels:

0: Full data, 2 packing
1: Full data, 2.5 packing
2: ZLE data, 2 packing
3: ZLE data, 2.5 packing

Definition at line 139 of file v1720CONET2.hxx.

◆ mZLE

BOOL v1720CONET2::mZLE

true if ZLE (Zero-length encoding) is enabled on all channels

Definition at line 132 of file v1720CONET2.hxx.

◆ verbose

int v1720CONET2::verbose

Make the driver verbose 0: off 1: normal 2: very verbose

Definition at line 54 of file v1720CONET2.hxx.

The documentation for this class was generated from the following files:

examples/oofes/v1720/v1720CONET2.hxx
examples/oofes/v1720/v1720CONET2.cxx

Classes

Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ v1720CONET2()

◆ ~v1720CONET2()

Member Function Documentation

◆ AcqCtl()

◆ ChannelConfig()

◆ Connect()

◆ Disconnect()

◆ fillQtBank()

◆ GetBoard()

◆ getChannelConfig()

◆ GetFEIndex()

◆ GetHandle()

◆ GetLink()

◆ GetModuleID()

◆ GetName()

◆ GetODBHandle()

◆ GetSettingsTouched()

◆ InitializeForAcq()

Initial setup:

Checks

Set registers

◆ IsConnected()

◆ IsRunning()

◆ IsZLEData()

◆ Poll()

◆ ReadEvent()

◆ ReadReg()

◆ SendTrigger()

◆ SetODBRecord()

◆ SetSettingsTouched()

◆ SetupPreset()

◆ StartRun()

◆ StopRun()

◆ WriteReg()

Member Data Documentation

◆ _board

◆ _feindex

◆ _handle

◆ _link

◆ _moduleID

◆ _odb_handle

◆ _running

◆ _settings_loaded

◆ _settings_touched

◆ config

◆ config_str

◆ mDataType

◆ mZLE

◆ verbose