crfe.cxx File Reference

#include <stdio.h>
#include <assert.h>
#include "midas.h"
#include "mfe.h"

Include dependency graph for crfe.cxx:

Go to the source code of this file.

Macros
#define	N_READBACK   4

Functions
INT	read_cr_event (char *pevent, INT off)
void	cr_settings_changed (HNDLE, HNDLE, int, void *)
INT	poll_event (INT source, INT count, BOOL test)
INT	interrupt_configure (INT cmd, INT source, POINTER_T adr)
INT	frontend_init ()
	Frontend initialization.
INT	frontend_exit ()
	Frontend exit.
INT	frontend_loop ()
	Frontend loop.
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.

Variables
const char *	frontend_name = "CR Frontend"
const char *	frontend_file_name = __FILE__
BOOL	frontend_call_loop = FALSE
INT	display_period = 1000
INT	max_event_size = 10000
INT	max_event_size_frag = 5 * 1024 * 1024
INT	event_buffer_size = 10 * 10000
BOOL	equipment_common_overwrite = TRUE
const char *	cr_settings_str []
EQUIPMENT	equipment []

Macro Definition Documentation

N_READBACK

#define N_READBACK   4

Definition at line 165 of file crfe.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 167 of file crfe.cxx.

{
   /*
    * This example code starts a run transition, then waits on some
    * external conditions by polling an array in the ODB. It expects
    * that other programs set the readback array in the ODB to the
    * current run number
    */
 
   HNDLE hDB, hKey;
   INT readback[N_READBACK], i;
   cm_get_experiment_database(&hDB, nullptr);
 
   // set requested run number in ODB
   db_set_value(hDB, 0, "/Equipment/Clock Reset/Run transitions/Requested run number", &run_number, sizeof(INT), 1, TID_INT);
 
   // retrieve readback array form ODB
   int size = sizeof(readback);
   memset(readback, 0, size);
   db_find_key(hDB, 0, "/Equipment/Clock Reset/Run transitions/FEB readback", &hKey);
   if (!hKey) {
      // create readback array if not existing
      db_create_key(hDB, 0, "/Equipment/Clock Reset/Run transitions/FEB readback", TID_INT);
      db_find_key(hDB, 0, "/Equipment/Clock Reset/Run transitions/FEB readback", &hKey);
      db_set_data(hDB, hKey, readback, size, N_READBACK, TID_INT);
   }
 
   // set equipment status for status web page
   set_equipment_status("Clock Reset", "Waiting for readback", "yellowLight");
 
   // wait until readback succeeds
   int start_time = ss_time();
   do {
      db_get_data(hDB, hKey, readback, &size, TID_INT);
      for (i=0 ; i<N_READBACK ; i++) {
         if (readback[i] != run_number)
            break;
      }
      if (i == N_READBACK)
         break;
 
      // don't waste 100% CPU time
      ss_sleep(10);
 
   } while (ss_time() < start_time + 5); // wait maximal 5 seconds
 
   if (i < N_READBACK) {
      strcpy(error, "Timeout receiving FEB feedback");
      return FE_ERR_HW;
   }
 
   // set equipment status for status web page
   set_equipment_status("Clock Reset", "Ok", "greenLight");
 
   return CM_SUCCESS;
}

Here is the call graph for this function:

cr_settings_changed()

void cr_settings_changed	(	HNDLE	hDB,
		HNDLE	hKey,
		int	,
		void *
	)

Definition at line 297 of file crfe.cxx.

{
   KEY key;
 
   db_get_key(hDB, hKey, &key);
 
   if (std::string(key.name) == "Active") {
      BOOL value;
      int size = sizeof(value);
      db_get_data(hDB, hKey, &value, &size, TID_BOOL);
      cm_msg(MINFO, "cr_settings_changed", "Set active to %d", value);
      // TODO: propagate to hardware
   }
 
   if (std::string(key.name) == "Delay") {
      INT value;
      int size = sizeof(value);
      db_get_data(hDB, hKey, &value, &size, TID_INT);
      cm_msg(MINFO, "cr_settings_changed", "Set delay to %d", value);
      // TODO: propagate to hardware
   }
 
   if (std::string(key.name) == "Reset Trigger") {
      BOOL value;
      int size = sizeof(value);
      db_get_data(hDB, hKey, &value, &size, TID_BOOL);
      if (value) {
         cm_msg(MINFO, "cr_settings_changed", "Execute reset");
         // TODO: propagate to hardware
         value = FALSE; // reset flag in ODB
         db_set_data(hDB, hKey, &value, sizeof(value), 1, TID_BOOL);
      }
   }
 
   if (std::string(key.name) == "Sync Trigger") {
      BOOL value;
      int size = sizeof(value);
      db_get_data(hDB, hKey, &value, &size, TID_BOOL);
      if (value) {
         cm_msg(MINFO, "cr_settings_changed", "Execute sync");
         // TODO: propagate to hardware
         value = FALSE; // reset flag in ODB
         db_set_data(hDB, hKey, &value, sizeof(value), 1, TID_BOOL);
      }
   }
}

Here is the call graph for this function:

Here is the caller 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 226 of file crfe.cxx.

{
   return CM_SUCCESS;
}

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 151 of file crfe.cxx.

{
   return CM_SUCCESS;
}

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 129 of file crfe.cxx.

{
   HNDLE hKey;
 
   // create Settings structure in ODB
   db_create_record(hDB, 0, "Equipment/Clock Reset/Settings", strcomb1(cr_settings_str).c_str());
   db_find_key(hDB, 0, "/Equipment/Clock Reset", &hKey);
   assert(hKey);
 
   db_watch(hDB, hKey, cr_settings_changed, NULL);
 
   /*
    * Set our transition sequence. The default is 500. Setting it
    * to 600 means we are called AFTER most other clients.
    */
   cm_set_transition_sequence(TR_START, 600);
 
   return CM_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 158 of file crfe.cxx.

{
   return CM_SUCCESS;
}

interrupt_configure()

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

Definition at line 122 of file crfe.cxx.

{
   return 1;
};

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 233 of file crfe.cxx.

{
   return CM_SUCCESS;
}

poll_event()

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

Definition at line 117 of file crfe.cxx.

{
   return 1;
};

read_cr_event()

INT read_cr_event	(	char *	pevent,
		INT	off
	)

Definition at line 278 of file crfe.cxx.

{
   bk_init(pevent);
 
   float *pdata;
   bk_create(pevent, "CRT1", TID_FLOAT, (void **)&pdata);
 
   *pdata++ = (float) rand() / RAND_MAX;
   *pdata++ = (float) rand() / RAND_MAX;
   *pdata++ = (float) rand() / RAND_MAX;
   *pdata++ = (float) rand() / RAND_MAX;
 
   bk_close(pevent, pdata);
 
   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 240 of file crfe.cxx.

{
   return CM_SUCCESS;
}

Variable Documentation

cr_settings_str

const char* cr_settings_str[]

Initial value:

= {
"Active = BOOL : 1",
"Delay = INT : 0",
"Reset Trigger = BOOL : 0",
"Sync Trigger = BOOL : 0",
"Names CRT1 = STRING[4] :",
"[32] Temp0",
"[32] Temp1",
"[32] Temp2",
"[32] Temp3",
NULL
}

Definition at line 80 of file crfe.cxx.

                                {
"Active = BOOL : 1",
"Delay = INT : 0",
"Reset Trigger = BOOL : 0",
"Sync Trigger = BOOL : 0",
"Names CRT1 = STRING[4] :",
"[32] Temp0",
"[32] Temp1",
"[32] Temp2",
"[32] Temp3",
NULL
};

display_period

INT display_period = 1000

Definition at line 59 of file crfe.cxx.

equipment

EQUIPMENT equipment[]

Initial value:

= {
 
   {"Clock Reset",              
    {10, 0,                     
     "SYSTEM",                  
     EQ_PERIODIC,               
     0,                         
     "MIDAS",                   
     TRUE,                      
     RO_ALWAYS | RO_ODB,        
     10000,                     
     0,                         
     0,                         
     1,                         
     "", "", ""} ,
    read_cr_event,              
   },
 
   {""}
}

Definition at line 93 of file crfe.cxx.

                        {
 
   {"Clock Reset",              /* equipment name */
    {10, 0,                     /* event ID, trigger mask */
     "SYSTEM",                  /* event buffer */
     EQ_PERIODIC,               /* equipment type */
     0,                         /* event source */
     "MIDAS",                   /* format */
     TRUE,                      /* enabled */
     RO_ALWAYS | RO_ODB,        /* read always and update ODB */
     10000,                     /* read every 10 sec */
     0,                         /* stop run after this event limit */
     0,                         /* number of sub events */
     1,                         /* log history every event */
     "", "", ""} ,
    read_cr_event,              /* readout routine */
   },
 
   {""}
};

equipment_common_overwrite

BOOL equipment_common_overwrite = TRUE

Definition at line 77 of file crfe.cxx.

event_buffer_size

INT event_buffer_size = 10 * 10000

Definition at line 68 of file crfe.cxx.

frontend_call_loop

BOOL frontend_call_loop = FALSE

Definition at line 56 of file crfe.cxx.

frontend_file_name

const char* frontend_file_name = __FILE__

Definition at line 53 of file crfe.cxx.

frontend_name

const char* frontend_name = "CR Frontend"

Definition at line 51 of file crfe.cxx.

max_event_size

INT max_event_size = 10000

Definition at line 62 of file crfe.cxx.

max_event_size_frag

INT max_event_size_frag = 5 * 1024 * 1024

Definition at line 65 of file crfe.cxx.