beamtime/gsi-aug12/hd/mbs/vftxlib.h (r4864/r3172)

Go to the documentation of this file.

//            VFTX 10ps FPGA TDC: 
//         FPGA based TDC with 16-32 channels
//           ======
//        include file
//       (for implementation cf source file)
//
//  P.-A. Loizeau (PI, Uni-HD) June 2012
//  Based on "vulomdef_tdc.h" P.-A. Loizeau (PI, Uni-HD) June 2010
//  Based on "f_user.c" by N.Kurz (EE, GSI) 8 July 2010
//  Based on "vulom3def.h" by J. Frühauf (GSI) November  2009
//
//-----------------------------------------------------------
#ifndef VFTX_DEF_TDC
#define VFTX_DEF_TDC

#ifdef GSI_MBS // N.Kurz, EE, GSI, 4-Sep-2007
 #define printf printm
#endif // MBS_MBS

//#define TDC_DEBUG

#define TDC_N_CHA        32 

/**************** FPGA TDC **********************/
#define TDC_CHAN_ENABLE    0x00   // r/w 32b
#define TDC_TRIGGER_ENABLE 0x04   // r/w 32b 
#define TDC_POSS_RESET     0x08   // r/w  1b ?+  8b?
   #define TDC_PR_POSSRST       0x00000001    // 1st bit is poss reset
   #define TDC_PR_VERSION_MAJOR 0xF0000000    // last hex is X of vX.Y
   #define TDC_PR_VERSION_MAJOR_SHIFT 28
   #define TDC_PR_VERSION_MINOR 0x0F000000    // prev hex is Y of vX.Y
   #define TDC_PR_VERSION_MINOR_SHIFT 24
#define TDC_READY_RESET    0x0C   // r/w  1b
#define TDC_RESET          0x10   // r/w  32b
#define TDC_STATUS         0x14   // r    3b + 16b
   #define TDC_STATUS_READY          0x00000001
   #define TDC_STATUS_POSS           0x00000002
   #define TDC_STATUS_POSS_SHIFT            1
   #define TDC_STATUS_RESET          0x00000004
   #define TDC_STATUS_RESET_SHIFT           2
   #define TDC_STATUS_EVT_SIZE       0x00001FF0  // Mask for 16 channels!!!!!
   #define TDC_STATUS_EVT_SIZE_SHIFT        4
#define TDC_TRIGGER_WINDOW 0x18   // r/w 11b + (4*'0') +  1b + 12b + (4*'0')
   #define TDC_TRIGWIN_STOP          0x000007FF
   #define TDC_TRIGWIN_FUTURE_F      0x00008000 
   #define TDC_TRIGWIN_START         0x0FFF0000
   #define TDC_TRIGWIN_START_MASK    0x00000FFF
   #define TDC_TRIGWIN_START_SHIFT         16
#define TDC_DATA_FIFO      0x1C   // r   32b
   #define TDC_FIFO_FINE_CT          0x000007FF
   #define TDC_FIFO_COARSE_CT        0x01FFF800    // Coarse counter value
   #define TDC_FIFO_COARSE_CT_SHIFT        11
   #define TDC_FIFO_FUTURE_BIT       0x02000000    // Flag for hits after trigger
   #define TDC_FIFO_FUTURE_BIT_SHIFT       25
   #define TDC_FIFO_DATA_CHAN        0x7C000000
   #define TDC_FIFO_DATA_CHAN_SHIFT        26
   
   #define TDC_FIFO_HEADER_DATA_CNT  0x000000FF    // Data count
   #define TDC_FIFO_HEADER_TRIG_TYPE 0x60000000    // Trigger Type
   #define TDC_FIFO_HEADER_TRIG_TYPE_SHIFT 29
   #define TDC_FIFO_MESSAGE_TYPE     0x80000000    // Message Type 
   #define TDC_FIFO_MESSAGE_TYPE_SHIFT     31      // (1 = header, 0 = data)

typedef struct
{
   char name[20] ;
   int  moduleIndex ;

   long  volatile *pl_chan_ena;
   long  volatile *pl_trg_ena;
   long  volatile *pl_poss_rst;
   long  volatile *pl_ready_rst;
   long  volatile *pl_reset;
   long  volatile *pl_status;
   long  volatile *pl_trg_wind;
   long  volatile *pl_dat_fifo;

   long  volatile *pl_dat_save;
   long  volatile *p32_tmp;
}
s_vftx ;

int  VFTX_TDC_SetName( s_vftx* ps_vTdc, char* newName, int newModuleIndex );

// Init Pointer
int  VFTX_TDC_GetPointers( s_vftx* ps_vTdc, long vTDC_VME_virt_addr );
int  VFTX_TDC_PrintPointersAll( s_vftx* ps_vTdc );

// Reset the triggered event scaler for all channels
int  VFTX_TDC_Reset( s_vftx* ps_vTdc );
int  VFTX_TDC_Reset_ChanPattern( s_vftx* ps_vTdc, unsigned channels);
int  VFTX_TDC_Reset_Chan( s_vftx* ps_vTdc, unsigned char channel);
// Reset Ready
int  VFTX_TDC_ResetReady( s_vftx* ps_vTdc );
// Reset Poss 
int  VFTX_TDC_ResetPoss( s_vftx* ps_vTdc );

// Set the trigger window
int  VFTX_TDC_SetTriggerWindow( s_vftx* ps_vTdc, unsigned windowStart,
                                 unsigned windowStop, unsigned char futureFlag);

// Enable/Disable channels, by block or individually
int  VFTX_TDC_SetChanEnablePattern( s_vftx* ps_vTdc, unsigned channels);
int  VFTX_TDC_ChannelEnable(  s_vftx* ps_vTdc, unsigned char channel );
int  VFTX_TDC_ChannelDisable( s_vftx* ps_vTdc, unsigned char channel );

// Enable/Disable channels/trigger, by block or individually (Pos. edge trigger)
// not sure of implementation for those 2, code has to be checked again!!!!!!
int  VFTX_TDC_SetTrigEnablePattern( s_vftx* ps_vTdc, unsigned channel  );
int  VFTX_TDC_TriggerEnable( s_vftx* ps_vTdc, unsigned char channel  );
int  VFTX_TDC_TriggerDisable( s_vftx* ps_vTdc, unsigned char channel  );

int  VFTX_TDC_GetVersion( s_vftx* ps_vTdc, int* major, int* minor );
int  VFTX_TDC_GetReady( s_vftx* ps_vTdc );
int  VFTX_TDC_GetPoss( s_vftx* ps_vTdc );
int  VFTX_TDC_GetEventSize( s_vftx* ps_vTdc );
unsigned VFTX_TDC_GetChanEnablePattern( s_vftx* ps_vTdc );
unsigned VFTX_TDC_GetTrigEnablePattern( s_vftx* ps_vTdc );
unsigned long  VFTX_TDC_GetTriggerWindow( s_vftx* ps_vTdc );

int  VFTX_TDC_PrintVersion( s_vftx* ps_vTdc );
int  VFTX_TDC_PrintResetsReg( s_vftx* ps_vTdc );
int  VFTX_TDC_PrintStatus( s_vftx* ps_vTdc );
int  VFTX_TDC_PrintChanEnablePattern( s_vftx* ps_vTdc );
int  VFTX_TDC_PrintTriggerWindow( s_vftx* ps_vTdc );

int VFTX_TDC_InitTdc(s_vftx* ps_vTdc);

int VFTX_TDC_ReadEvent( s_vftx*  ps_vTdc,
                        long  *  pl_dat);

#endif // VFTX_DEF_TDC