feoV1740.cxx File Reference

#include <stdio.h>
#include <stdlib.h>
#include <vector>
#include "midas.h"
#include "mvmestd.h"
#include "CAENComm.h"
#include "v1740CONET2.hxx"

Include dependency graph for feoV1740.cxx:

Go to the source code of this file.

Macros
#define	Nv1740   1
	Set the number of v1720 modules to be used.
#define	EQ_EVID   4
	Event ID.
#define	EQ_TRGMSK   0
	Trigger mask.
#define	FE_NAME   "feoV1740"
	Frontend name.
#define	UNUSED(x)   ((void)(x))
	Suppress compiler warnings.

Functions
INT	frontend_init ()
	Frontend initialization.
INT	frontend_exit ()
	Frontend exit.
INT	begin_of_run (INT run_number, char *error)
	Begin of Run.
INT	end_of_run (INT run_number, char *error)
	End of Run.
INT	pause_run (INT run_number, char *error)
	Pause Run.
INT	resume_run (INT run_number, char *error)
	Resume Run.
INT	frontend_loop ()
	Frontend loop.
void	interrupt_routine (void)
	Interrupt Service Routine.
INT	read_trigger_event (char *pevent, INT off)
	Trigger event readout.
INT	read_scaler_event (char *pevent, INT off)
	Scaler event readout.
void	seq_callback (INT hDB, INT hseq, void *info)
	Sequencer callback info.
INT	poll_event (INT source, INT count, BOOL test)
	Polling routine for events.
INT	interrupt_configure (INT cmd, INT source, POINTER_T adr)
	Interrupt configuration (not implemented)

Variables
HNDLE	hDB
	main ODB handle
BOOL	debug
	debug printouts
char *	frontend_name = (char*)FE_NAME
	The frontend name (client name) as seen by other MIDAS clients.
char *	frontend_file_name = (char*)__FILE__
	The frontend file name, don't change it.
BOOL	frontend_call_loop = FALSE
	frontend_loop is called periodically if this variable is TRUE
INT	display_period = 000
	a frontend status page is displayed with this frequency in ms
INT	max_event_size = 32 * 34000
	maximum event size produced by this frontend
INT	max_event_size_frag = 5 * 1024 * 1024
	maximum event size for fragmented events (EQ_FRAGMENTED)
INT	event_buffer_size = 200 * max_event_size
	buffer size to hold events
bool	runInProgress = false
	run is in progress
bool	runOver = false
	run is over
bool	runStopRequested = false
	stop run requested
EQUIPMENT	equipment []
	Main structure for midas equipment.
vector< v1740CONET2 >	ov1740
	objects for the v1740 modules controlled by this frontend
vector< v1740CONET2 >::iterator	itv1740
	iterator
int	Nloop
	Number of loops executed in event polling.
int	Ncount
	Loop count for event polling timeout.

Macro Definition Documentation

EQ_EVID

#define EQ_EVID   4

Event ID.

Definition at line 63 of file feoV1740.cxx.

EQ_TRGMSK

#define EQ_TRGMSK   0

Trigger mask.

Definition at line 64 of file feoV1740.cxx.

FE_NAME

#define FE_NAME   "feoV1740"

Frontend name.

Definition at line 69 of file feoV1740.cxx.

Nv1740

#define Nv1740   1

Set the number of v1720 modules to be used.

Definition at line 62 of file feoV1740.cxx.

UNUSED

#define UNUSED

(

x

)

((void)(x))

Suppress compiler warnings.

Definition at line 72 of file feoV1740.cxx.

Function Documentation

begin_of_run()

INT begin_of_run	(	INT	run_number,
		char *	error
	)

Begin of Run.

Called every run start transition. Set equipment status in ODB, start acquisition on the modules.

Parameters

[in]	run_number	Number of the run being started
[out]	error	Can be used to write a message string to midas.log

Definition at line 285 of file feoV1740.cxx.

{
 
  set_equipment_status(equipment[0].name, "Starting run...", "#FFFF00");
 
  printf("<<< Begin of begin_of_run\n");
 
  CAENComm_ErrorCode sCAEN = CAENComm_Success;  //hardcoded for now
 
  for (itv1740 = ov1740.begin(); itv1740 != ov1740.end(); ++itv1740) {
    if (! itv1740->IsConnected()) continue;   // Skip unconnected board
 
    //  //Done at SetOdbRecord (frontend_init)
    //  size = sizeof(V1740_CONFIG_SETTINGS);
    //  if ((status = db_get_record (hDB, hSet, &tsvc, &size, 0)) != DB_SUCCESS)
    //    return status;
 
    itv1740->InitializeForAcq();
    itv1740->StartRun();
  }
 
  runInProgress = true;
 
  //------ FINAL ACTIONS before BOR -----------
  set_equipment_status(equipment[0].name, "Started run", "#00ff00");
  printf(">>> End of begin_of_run\n\n");
  return (sCAEN == CAENComm_Success ? SUCCESS : sCAEN);
}

Here is the call graph for this function:

end_of_run()

INT end_of_run	(	INT	run_number,
		char *	error
	)

End of Run.

Called every stop run transition. Set equipment status in ODB, stop acquisition on the modules.

Parameters

[in]	run_number	Number of the run being ended
[out]	error	Can be used to write a message string to midas.log

Definition at line 323 of file feoV1740.cxx.

{
  set_equipment_status(equipment[0].name, "Ending run...", "#FFFF00");
 
  printf("<<< Begin of end_of_run \n");
  // Stop run
  CAENComm_ErrorCode sCAEN = CAENComm_Success;
  uint32_t status, eStored;
 
  for (itv1740 = ov1740.begin(); itv1740 != ov1740.end(); ++itv1740) {
    if (itv1740->IsConnected()) {  // Skip unconnected board
      sCAEN = itv1740->StopRun();
 
      itv1740->ReadReg(V1740_ACQUISITION_STATUS, &status);
      itv1740->ReadReg(V1740_EVENT_STORED, &eStored);
 
      cout << "End of EOR. handle=" << itv1740->GetHandle() << " link=" << itv1740->GetLink()
                                   << " ACQ_STATUS=" << status << " EV_STORED=" << eStored << " sCAEN=" << sCAEN << endl;
    }
  }
 
  // Stop DAQ for seting up the parameters
  runOver = false;
  runStopRequested = false;
  runInProgress = false;
 
  printf(">>> End Of end_of_run\n\n");
  set_equipment_status(equipment[0].name, "Ended run", "#00ff00");
 
  return (sCAEN == CAENComm_Success ? SUCCESS : sCAEN);
}

Here is the call graph for this function:

frontend_exit()

INT frontend_exit

(

void

)

Frontend exit.

Runs at frontend shutdown. Disconnect hardware and set equipment status in ODB

Returns

Midas status code

Definition at line 259 of file feoV1740.cxx.

{ 
  set_equipment_status(equipment[0].name, "Exiting...", "#FFFF00");
  cout << "frontend_exit";
 
  for (itv1740 = ov1740.begin(); itv1740 != ov1740.end(); ++itv1740) {
    if (itv1740->IsConnected()){
      cm_msg(MINFO,"exit", "Closing handle %d", itv1740->GetHandle());
      itv1740->Disconnect();
    }
  }
 
  set_equipment_status(equipment[0].name, "Exited", "#00ff00");
  printf("End of exit\n");
  return SUCCESS;
}

Here is the call graph for this function:

frontend_init()

INT frontend_init

(

void

)

Frontend initialization.

Runs once at application startup. We initialize the hardware and optical interfaces and set the equipment status in ODB. We also lock the frontend to once physical cpu core.

Returns

Midas status code

Definition at line 198 of file feoV1740.cxx.

{
  set_equipment_status(equipment[0].name, "Initializing...", "#FFFF00");
 
  // Suppress watchdog for PCIe for now
  cm_set_watchdog_params(FALSE, 0);
 
  // --- Get the frontend index. Derive the Optical link number
  int feIndex = get_frontend_index();
 
  int tNActivev1740=0;  //Number of v1740 boards activated at the end of frontend_init
 
  for (int iBoard=0; iBoard < Nv1740; iBoard++)
  {
    printf("<<< Init board %i\n", iBoard);
 
    //If no index supplied, use link 0, else use index as link number
    if(feIndex == -1)
      ov1740.push_back(v1740CONET2(0, iBoard, iBoard));
    else
      ov1740.push_back(v1740CONET2(feIndex, iBoard, iBoard));
 
    ov1740.back().verbose = 1;
 
    //load ODB settings
    ov1740.back().SetODBRecord(hDB,seq_callback);
 
    // Open Optical interface
    CAENComm_ErrorCode sCAEN;
    sCAEN = ov1740.back().Connect();
    if (sCAEN != CAENComm_Success) {
      cm_msg(MERROR, "fe", "Could not connect to board; error:%d", sCAEN);
    }
    else {
      tNActivev1740++;
      printf("Board#:%d Module_Handle[%d]:%d (active:%d)\n",
          iBoard, iBoard, ov1740.back().GetHandle(), tNActivev1740);
 
      ov1740.back().CheckBoardType();
    }
  }
 
  printf(">>> End of Init. %d active v1740. Expected %d\n\n", tNActivev1740, Nv1740);
 
  set_equipment_status(equipment[0].name, "Initialized", "#00ff00");
  printf("end of Init: %d\n", SUCCESS);
 
#if SIMULATION
  printf("*** RUNNING SIMULATION ***\n");
#endif
 
  return SUCCESS;
}

Here is the call graph for this function:

frontend_loop()

INT frontend_loop

(

void

)

Frontend loop.

If frontend_call_loop is true, this routine gets called when the frontend is idle or once between every event.

Returns

Midas status code

Definition at line 398 of file feoV1740.cxx.

{
  cout << "frontend_lopp";
  /* if frontend_call_loop is true, this routine gets called when
     the frontend is idle or once between every event */
  char str[128];
  static DWORD evlimit;
 
  if (runStopRequested && !runOver) {
    db_set_value(hDB,0,"/logger/channels/0/Settings/Event limit", &evlimit, sizeof(evlimit), 1, TID_DWORD);
    if (cm_transition(TR_STOP, 0, str, sizeof(str), ASYNC, FALSE) != CM_SUCCESS) {
      cm_msg(MERROR, "feodeap", "cannot stop run: %s", str);
    }
    runInProgress = false;
    runOver = true;
    cm_msg(MERROR, "feodeap","feodeap Stop requested");
  }
  return SUCCESS;
}

Here is the call graph for this function:

interrupt_configure()

INT interrupt_configure	(	INT	cmd,
		INT	source,
		POINTER_T	adr
	)

Interrupt configuration (not implemented)

Routine for interrupt configuration if equipment is set in EQ_INTERRUPT mode. Not implemented right now, returns SUCCESS.

Parameters

[in]	cmd	Command for interrupt events (see midas.h)
[in]	source	Equipment index number
[in]	adr	Interrupt routine (see mfe.c)

Returns

Midas status code

Definition at line 475 of file feoV1740.cxx.

{
  cout << "interrupt_configure";
  switch (cmd) {
  case CMD_INTERRUPT_ENABLE:
    break;
  case CMD_INTERRUPT_DISABLE:
    break;
  case CMD_INTERRUPT_ATTACH:
    break;
  case CMD_INTERRUPT_DETACH:
    break;
  }
  return SUCCESS;
}

Here is the call graph for this function:

interrupt_routine()

void interrupt_routine ( void  )

extern

Interrupt Service Routine.

pause_run()

INT pause_run	(	INT	run_number,
		char *	error
	)

Pause Run.

Called every pause run transition.

Parameters

[in]	run_number	Number of the run being ended
[out]	error	Can be used to write a message string to midas.log

Returns

Midas status code

Definition at line 365 of file feoV1740.cxx.

{
  cout << "pause";
 
  runInProgress = false;
  return SUCCESS;
}

Here is the call graph for this function:

poll_event()

INT poll_event	(	INT	source,
		INT	count,
		BOOL	test
	)

Polling routine for events.

Parameters

[in]	source	Event source (LAM/IRQ)
[in]	count	Loop count for event polling timeout
[in]	test	flag used to time the polling

Returns

1 if event is available, 0 if done polling (no event). If test equals TRUE, don't return.

Definition at line 436 of file feoV1740.cxx.

{
 
  register int i;  // , mod=-1;
  register uint32_t lam = 0;
  //  register uint32_t event_size = 0;
  CAENComm_ErrorCode sCAEN;
 
  for (i=0; i<count; i++)
  {
    sCAEN = ov1740[0].ReadReg(V1740_ACQUISITION_STATUS, &lam);
    UNUSED(sCAEN);
    lam &= 0x8;
 
    if (lam) {
      Nloop = i; Ncount = count;
      if (!test)
        return lam;
    }
  }
 
  return 0;
}

Here is the call graph for this function:

read_scaler_event()

INT read_scaler_event	(	char *	pevent,
		INT	off
	)

Scaler event readout.

Placeholder.

Scaler event readout routine. Not used in this example.

Parameters

[in]	pevent	Pointer to event buffer
[in]	off	Caller info (unused here), see mfe.c

Returns

Size of the event

Definition at line 554 of file feoV1740.cxx.

{
  /* init bank structure */
  bk_init(pevent);
  return 0;  // bk_size(pevent);
}

Here is the call graph for this function:

read_trigger_event()

INT read_trigger_event	(	char *	pevent,
		INT	off
	)

Trigger event readout.

Main trigger event readout routine. This is called by the polling or interrupt routines. (see mfe.c). For each module, read the event buffer into a midas data bank.

Parameters

[in]	pevent	Pointer to event buffer
[in]	off	Caller info (unused here), see mfe.c

Returns

Size of the event

Definition at line 502 of file feoV1740.cxx.

{
  if (!runInProgress) return 0;
 
  DWORD *pdata;
  DWORD event_size, sn;
  int dwords_read;
  //  int sLoop, eEvent;
 
  sn = SERIAL_NUMBER(pevent);
  bk_init32(pevent);
 
  CAENComm_ErrorCode sCAEN;
 
  for (itv1740 = ov1740.begin(); itv1740 != ov1740.end(); ++itv1740) {
    if (!itv1740->IsConnected()) continue;   // Skip unconnected board
 
    itv1740->ReadReg(V1740_EVENT_SIZE, &event_size);
    if (event_size > 0)
    {
 
      char bankName[5];
      sprintf(bankName,"W4%02d",itv1740->GetLink());
      bk_create(pevent, bankName, TID_DWORD, &pdata);
 
      sCAEN = itv1740->ReadEvent(pdata, &dwords_read);
 
      //(eStored > 1) ? sLoop = 2 : sLoop = eStored;
      //  for (eEvent=0; eEvent < sLoop; eEvent++) {
      //sCAEN = CAENComm_Read32(v1740->GetHandle(), V1740_EVENT_SIZE, &eSize);
 
      bk_close(pevent, pdata + dwords_read);
    }
  }
 
  //primitive progress bar
  if (sn % 100 == 0) printf(".");
 
  UNUSED(sCAEN);
  return bk_size(pevent);
}

Here is the call graph for this function:

resume_run()

INT resume_run	(	INT	run_number,
		char *	error
	)

Resume Run.

Called every resume run transition.

Parameters

[in]	run_number	Number of the run being ended
[out]	error	Can be used to write a message string to midas.log

Returns

Midas status code

Definition at line 383 of file feoV1740.cxx.

{
  cout << "resume";
  runInProgress = true;
  return SUCCESS;
}

Here is the call graph for this function:

seq_callback()

void seq_callback	(	INT	hDB,
		INT	hseq,
		void *	info
	)

Sequencer callback info.

Function which gets called when record is updated

Parameters

[in]	hDB	main ODB handle
[in]	hseq	Handle for key where search starts in ODB, zero for root.
[in]	info	Record descriptor additional info

Definition at line 176 of file feoV1740.cxx.

{
  KEY key;
 
  for (itv1740 = ov1740.begin(); itv1740 != ov1740.end(); ++itv1740) {
    if (hseq == itv1740->GetODBHandle()) {
      db_get_key(hDB, hseq, &key);
      itv1740->SetSettingsTouched(true);
      printf("Settings %s touched. Changes will take effect at start of next run.\n", key.name);
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

debug

BOOL debug

extern

debug printouts

Definition at line 254 of file mana.cxx.

display_period

INT display_period = 000

a frontend status page is displayed with this frequency in ms

Definition at line 93 of file feoV1740.cxx.

equipment

EQUIPMENT equipment[]

Main structure for midas equipment.

Definition at line 121 of file feoV1740.cxx.

{
  {
#if SIMULATION
    "FEv1740_SIM",              /* equipment name */
#else
    "FEv1740",                  /* equipment name */
#endif
    {
      EQ_EVID, EQ_TRGMSK,       /* event ID, trigger mask */
      "SYSTEM",                 /* event buffer */
 
#ifdef USE_INT
      EQ_INTERRUPT,             /* equipment type */
#else
      EQ_POLLED,                /* equipment type */
#endif
 
      LAM_SOURCE(0, 0x0),       /* event source crate 0, all stations */
      "MIDAS",                  /* format */
      TRUE,                     /* enabled */
      RO_RUNNING,               /* read only when running */
      500,                      /* poll for 500ms */
      0,                        /* stop run after this event limit */
      0,                        /* number of sub events */
      0,                        /* don't log history */
      "", "", ""
    },
    read_trigger_event,         /* readout routine */
  },
  {""}
};

event_buffer_size

INT event_buffer_size = 200 * max_event_size

buffer size to hold events

Definition at line 99 of file feoV1740.cxx.

frontend_call_loop

BOOL frontend_call_loop = FALSE

frontend_loop is called periodically if this variable is TRUE

Definition at line 91 of file feoV1740.cxx.

frontend_file_name

char* frontend_file_name = (char*)__FILE__

The frontend file name, don't change it.

Definition at line 89 of file feoV1740.cxx.

frontend_name

char* frontend_name = (char*)FE_NAME

The frontend name (client name) as seen by other MIDAS clients.

Definition at line 87 of file feoV1740.cxx.

hDB

HNDLE hDB

extern

main ODB handle

Definition at line 207 of file mana.cxx.

itv1740

vector<v1740CONET2>::iterator itv1740

iterator

Definition at line 160 of file feoV1740.cxx.

max_event_size

INT max_event_size = 32 * 34000

maximum event size produced by this frontend

Definition at line 95 of file feoV1740.cxx.

max_event_size_frag

INT max_event_size_frag = 5 * 1024 * 1024

maximum event size for fragmented events (EQ_FRAGMENTED)

Definition at line 97 of file feoV1740.cxx.

Ncount

int Ncount

Loop count for event polling timeout.

Definition at line 423 of file feoV1740.cxx.

Nloop

int Nloop

Number of loops executed in event polling.

Definition at line 422 of file feoV1740.cxx.

ov1740

vector<v1740CONET2> ov1740

objects for the v1740 modules controlled by this frontend

Definition at line 159 of file feoV1740.cxx.

runInProgress

bool runInProgress = false

run is in progress

Definition at line 101 of file feoV1740.cxx.

runOver

bool runOver = false

run is over

Definition at line 102 of file feoV1740.cxx.

runStopRequested

bool runStopRequested = false

stop run requested

Definition at line 103 of file feoV1740.cxx.