University of Michigan

Contents

Contents

Section Page

Appendixes

B. Data Formats . . . . . . . 45

C. Programmable Parameters of AMT Mezzanine Card . 48

1 Introduction to the CSM MiniDAQ and Installation

1  Introduction to the CSM MiniDAQ and Installation

 

2 Installation and Starting the CSM MiniDAQ

2  Installation and Starting the CSM MiniDAQ

 
Installation and Build Option:
 
To install the CSM MiniDAQ3.0.0, first get the MiniDAQ3.0.0 distribution kit from http://atlas.physics.lsa.umich.edu/docushare/dscgi/ds.py/View/Collection-178/ . Then run the setup.exe where user is able to modify the installation path.
 
A file <constant.h> is included in the 3.0.0 distributions of CSM MiniDAQ. This file contains build options and parameters that can be changed to reflect hardware upgrades. The main build options are FIREWIRE , PDT_ONLY , and ENVIRO_CHECK . If a FIREWIRE (IEEE 1394) VME interface is in use, the diagnostic menu does not print the VME FIFO correctly unless the line #define FIREWIRE is uncommented. PDT_ONLY tells the CSM MiniDAQ to use only programmed IO instead of block transfers when collecting data (note: this does not affect the diagnostics panel which uses block transfers). To use block transfers, comment out the line #define PDT_ONLY . Finally, ENVIRO_CHECK includes support for using an ADC card to take measurements of temperature, pressure, and humidity and also to use these as a feedback control on the chamber. The calibration is specific to the University of Michigan cosmic ray test, but the code can be easily modified to use different ADC and DAC cards. To enable the environment checking software, comment out the line #define ENVIRO_CHECK .
 
Starting the CSM MiniDAQ:
 

 

For normal data acquisition with AMT mezzanine cards, DAQ initialization could be performed by simply hitting the button at first. All of the necessary commands to modify the AMT mezzanine card settings are in the JTAG pull-down menu, including the JTAG diagnostic panel. The mezzanine card setups can be saved and be recalled from the File menu. Once JTAG programming is finished, standard data acquisition commands are all located on the main window. Diagnostic tools are located in BoardTest pull-down menu for CSM0 board functionality tests, in JTAG pull-down menu of “Diagnostics” for JTAG tests and in the Execute pull-down menu of “Diagnostic Run” for data acquisition diagnostics.

3 JTAG Programming

3   JTAG Programming

 
3.1  Connecting the hardware
 
JTAG protocol requires all devices on the JTAG chain to be in series to work properly. There are two kinds of adapter boards used with the AMT-1 cards. The 4-channel adapter boards have jumpers that determine if a port to a mezzanine card is skipped or connected in series with the next port in the chain. Placing the jumper on the pins farther from the edge of the board includes the associated mezzanine card in the series connection; placing the jumper on the pins closer to the edge skips the mezzanine card. The 18-channel adapter card automatically includes each device plugged into it in the JTAG chain. The leftmost device on the 18-channel adapter card is the first device in the chain. The rightmost device on the 4-channel adapter card as seen from the card edge with jumpers is the first device in the chain. There are two JTAG ports on the CSM0 Module, JTAG IN and JTAG OUT. For the 4-channel adapter card, JTAG IN should be connected to JP1. JTAG OUT should be connected to JP3. The ports should be labeled on the 18-adapter board, but the left port is JTAG IN, the right port is JTAG OUT.
 
Be sure the power is applied before starting JTAG programming.

3.2  JTAG Menu
                                                                   
The AMT mezzanine cards are programmed through their JTAG port connections by using the JTAG pull-down menu as shown in the right picture. Also diagnostics tool has been provided and will be discussed later. Loading an individual mezzanine card (Setup Individual) is enabled only after mezzanine cards have been initialized with common settings.
                                                                                               

·   Mezz. Connection Map provides a way for user to map the mezzanine card connections with CSM0 input channels (TDCs) automatically or manually. The mezzanine card ID is assigned by using following rules: 1) If mezzanine card connection map is provided, the TDC’s number will be assigned as mezzanine card ID. 2) Or if the number of enabled TDCs is same as the number of mezzanine cards, the first mezzanine card in JTAG serial chain has ID as the first enabled TDC’s number and second mezzanine card in JTAG serial chain takes the second enabled TDC’s number as its ID and so on. 3) Neither above two cases, it is assumed that first mezzanine card in JTAG serial chain is connected to CSM0 Channel 0, second mezzanine card in JTAG serial chain is connected to CSM0 Channel 1 and so on, and corresponding TDC’s number is assigned to mezzanine card as its ID. Therefore it is implicitly required to connect the JTAG cables serially in the same order as they are plugged into the RJ45 jacks of CSM0 board if no mezzanine card connection map is provided. Figure 2 shows an obtained mezzanine card connection map by using Mezz. Connection Map, where the mezzanine card number is the sequent number starting from 0 in the JTAG serial chain. Pushing button will restart mapping the mezzanine card connection between mezzanine cards and CSM0 input channels. A valid map is indicated by as shown in Figure 2, where the first mezzanine card is connected to CSM0 channel 17 (TDC 17) and second mezzanine card is connected to CSM0 channel 4 (TDC 4).
 

Applying individual setting to mezzanine card:

                                  

Setup All), which contains switches, selection boxes and command buttons. The AMT Error Control Window (Figure 4) is invoked by clicking .

Each mezzanine card contains 24 channels which could be individually turn on/off by clicking on desired channel. Also each mezzanine card has three ASD chips which are programmable. The buttons of , and access the corresponding ASD setup window as shown in Figure 5 (example for ASD1).

  

saves the current mezzanine card settings to a text file. recalls the mezzanine card default settings and closes the setup windows and reverts to previous settings. The mezzanine card settings are applied after the button on the Mezzanine Card Setup Window is selected.

There is a command button in the mezzanine card setup window as shown in Figure 2. It brings up the copy mezzanine card setup window as shown in Figure 6 and it allows user to copy mezzanine card settings between mezzanine cards. The command button is disabled if there is only one on no mezzanine card for obvious reason.

and destinations are a group toggle buttons. The main threshold, AMT channel mask and ASD channel mask are controllable, therefore user can decided whether to copy them. If the mezzanine card settings are copied, it is assumed that those mezzanine cards settings is individualized. To start copy mezzanine card settings, click on button and click on to exit from the copy mezzanine card setup window.

4 Acquisition Runs

4   Acquisition Runs

 
To collect data, the right PROM in CSM0 daughter card should be used, where the XILINX and TTCEM version number is 0x5005 (Hexadecimal) or higher. If AMT mezzanine cards are used, the first step in a data acquisition is to download mezzanine card settings by using JTAG menu. If Demo boards (Emulator cards) are used, the reset button on Demo boards should be pushed before taking data.
 
Data acquisition is handled from the main CSM MiniDAQ panel, following steps involved in the run of data collection:
1.  Select wanted CSM0 input channels if it is not done yet;
2.  Modify run setups as user wishes, such as Auto Run Setup, Get BCID Preset Value, Data Monitor Controls and Storage Selection;
3.  Initialize DAQ if necessary;
4.  Begin the run and accumulate data;
5.  End the run if automatically stopping run is not enabled.
 
4.1  CSM Input Channel Control (TDC Enable and Control)
 
To select wanted CSM0 input channels, click on the main CSM MiniDAQ panel brings up the TDC Enable and Control panel as shown in Figure 7.
 

                                          Figure 7. The TDC Enable and Control Window
 
To enable or disable an individual CSM0 input channel, click on TDC button where TDC number is the CSM0 input channel number. A green TDC button indicates that the CSM0 input channel is selected and a red TDC button  indicates that the CSM0 input channel is disabled. If mezzanine card connection mapping has been done, click on button will enable all CSM0 input channels which are connected to mezzanine cards.
 
If a connected CSM0 input channel is not enabled, the CSM0 will not expect to receive data from that input channel and will ignore any data from that CSM0 input channel. The TDC enable and Control panel is used to turn on or off the entire CSM0 input channel, therefore an unselected TDC will block all the data to that CSM0 input channel. To turn individual channel on/off for each mezzanine card, use JTAG menu as discussed in Section 3 JTAG Programming. If unconnected CSM0 input channels are enabled, it will hang the data acquisition system while the CSM0 is waiting for data from un-existing cards. User also is able to change trigger FIFO and WC FIFO limits which are maximum number of allowed events. For normal operations, it is sufficient to enable the desired TDCs and then push button. The TDC Enable Mask 
 
on the CSM0 MiniDAQ Main Window indicates the CSM0 input channel selection, where 1/0 indicates on/off of the corresponding CSM0 input channel.
 

To select data storage, use the Storage pull-down menu as shown in Figure 8. There are two main choices, either discard acquired data (select None) or store data into a disk file (select Disk). If Disk is selected, data will be stored in the file indicated by . There are two options for save data into a disk file:

2.  Disk (User Defined Filename) will let user to give a file name. The storage file can either be selected using the BROWSE button (which will bring up a standard windows file selection window) or the file name can be edited directly in the window. And the file will be checked to see if it is already in disk to avoid overwriting existing file after start the run.

Auto Run Setup:

After finish the auto run setup, just click button.

The DAQ rate, event size and data flow rate are numerically and graphically displayed in DAQ information window. And DAQ time is shown also. By default, the current run DAQ plots are displayed, the most recent 15 minutes DAQ plots can be displayed by clicking on button. The background color has following means (not for DAQ plots): green

If data analysis is enabled, the data will be monitored and checked. If any error is found, data monitor error report window will be automatically popped out as in Figure 12. It is assumed that user wishes to close the data monitor error report window for rest of the run if user clicks on button. User can bring up the data monitor error report window by using Execute

After hit button to do a DAQ initialization, a run could be started by just clicking the button. Few things will be checked, such as event offset (another name EVID Preset Value), BCID Rollover and whether disk file will be overwritten if storage selected as Disk. If any problem is detected, user will be informed and will be asked to make decisions.

During the run, and on the CSM MiniDAQ main window allow user to suspend and resume data acquisition. Once enough events have been accumulated, click on command button to start the run termination process where the CSM MiniDAQ will ignore any new triggers, read the rest buffered events and flush the last storage buffer into disk. A run log is saved into disk with a file name <***.log> and a hit summary is written into a file with name <***.sum> normally, and an error summary is kept into a disk file with name <***.err> also if data monitor is enabled, where *** is the data file name without “.dat”.

5  Diagnostic Tools

5    Diagnostic Tools

 
CSM MiniDAQ provides tools for diagnosing the CSM0 hardware, JTAG programming, data acquisition. CSM0 hardware diagnostic tools including the Board Test pull-down menu and Execute ŕ Diagnostics Run. JTAG programming has a diagnostic panel that can be used when JTAG serial is enabled through JTAG ŕ Diagnostics. The tools for data acquisition can be accessed with Execute ŕ Diagnostics. Few useful tools are accessible via Execute pull-down menu.
 
5.1  Using the Board Test Menu
 
Board Test pull-down menu provides an easy and quick way to check the functionality of CSM0 VME board and daughter board, which including following tools:
·   Test CSM/Mezz. Board: It will bring up the panel as shown in Figure 13 to test CSM0 VME board and CSM0 Mezzanine Board (another name CSM0 Daughter Board).
 

                                              Figure 13. Test CSM/Mezzanine Board Window    
 
It first checks whether the CSM0 VME board is functional by looking its Board ID   and will enable all CSM0 register tests if the Board ID is correct. Also it verifies the CSM0 mezzanine board and will enable all CSM0 mezzanine register tests if verification is passed. Click on a desired register test toggle button will enable or disable that register test. It is also possible to enable/disable register tests by group as shown in Figure 13. A green register item indicates that register test is on and a red register item indicates that register test is off. If the register passed the test, the corresponding LED indicator will turn to green , otherwise it stays on red (register test not passed or not selected). After all the tests have been performed, a test summary will be reported in the Message box.
 
It is worth to point out the test which checks whether master reset is functional as expected. At first same data word is written to all the CSM0 mezzanine card registers including VME address 96 for JTAG, then a master reset is issued and all used registers are checked against expected value where most of them should be zero. And the test is repeated 1000 times. To perform test which checks whether the CSM0 receives trigger and flag event ready bit correctly, external trigger must be connected with a trigger rate at least 100Hz.
 
·   Look Mezz. Card Signals: User is required to check the CSM0 mezzanine card signal period by using scope and to compare it with expected period, where the diagnostic PROM is involved. After the signal has been checked, user need to click on corresponding Period Status toggle button if the observed period is same as expected or only corresponding Check Status toggle button if the observed period is not same as expected. Figure 14 shows an example to look CSM0 mezzanine card read address 9 to 13 signals. User will be warned if some signals are not checked.
 
 
                                             Figure 14. Look Read Address(9:13) Signal Window    
 
·   Measure Received Rate(TDCs off): It brings up the CSM0 Received Trigger Rate window as shown in Figure 15 and measures the CSM0 received trigger rate twice in 30 seconds and 60 seconds respectively, where all TDCs are off. During the rate measurement the time progress bar will be filled seconds by seconds with green color as measurement proceeding. Because the rate is measured by using computer CPU, any activities of the computer could has significant impact on the measurement, therefore it is better do not touch the computer during rate measurement.
 
 
                                             Figure 15. Measure CSM Received Trigger Rate Window    
 

· Loop on Register: It allows user to read/write any VME address with any wanted data and it is also allowed to check read data to expected values, where the corresponding LED will indicate the compared results (green = OK, red = Error). The loop on register panel is shown in Figure 16.

 

There are three ways to select desired register by its name, address or address given by user. To active wished the way, click on corresponding area and select wanted register or VME address, other two will be automatically in idle mode. Push to start loop and  to stop loop, and loop time is also displayed. Exit the loop on register panel by hitting  button.

There are three ways to select desired register by its name, address or address given by user. To active wished the way, click on corresponding area and select wanted register or VME address, other two will be automatically in idle mode. Push to start loop and  to stop loop, and loop time is also displayed. Exit the loop on register panel by hitting  button.

box. Command button allow user to rescan all the CSM0 input channels, and to quit from the panel.

5.2  Using the JTAG Diagnostics Panel

allows to select mezzanine card by its ID;

reads the AMT ID code and compared with expected AMT ID code;

performs a global reset to all connected mezzanine cards using the control register of the AMT mezzanine card;

reads the status registers of the selected mezzanine card, where the AMT mezzanine card ID follows the ID in ;

        

shows the selected mezzanine card settings;

shows the mezzanine card common settings used by Setup All (see Section 3.2 and 3.3);

checks the settings of selected AMT mezzanine card, where the settings are read back and compared with original one. The read back settings are displayed in programming information panel as shown in Figure 19.

checks the mezzanine card common settings used by Setup All;

performs loop test on all mezzanine cards at same time with “random” setup array. Figure 20 illustrates the window of loop test on JTAG setup. CSM0 JTAG could be verified decently by performing that test.

performs loop test on the selected mezzanine card with “random” setup array, test sequence is same as ;

performs loop test on all mezzanine cards one by one with “random” setup array, test sequence is same as ;

provides a way to perform CSM0 JTAG test without AMT mezzanine card. A straight RJ45 cable is used to connect CSM0 JTAG IN and JTAG OUT directly, where the fixed data patterns are used in the test.

5.3  Using the CSM0 Diagnostic Panel

Diagnostics Run controls the CSM0 diagnostic panel as shown in Figure 21. Due to the fact that user is able to write and read many CSM0 registers by using Global Controls, TTCem Controls and CSM0 Controls menus, and button, it is a powerful and robust tool for CSM0 board diagnostics. Few examples will be illustrated below. It also can be used to debug the data acquisition problems and will be discussed in more details later.

Click on button, the content of the selected register indicated by the Readback Register will be displayed. And controls how many times of next operation will be done and it will be reset back to 1 if the next operation is performed. For instance, the Repeat is set as 16 as shown in Figure 21, if button is pushed, the Board ID in Readback Register box will be read 16 times.

Examples for CSM0 Board Diagnostics

DAQ Diagnostics

2.  Click on for event read preparation. It will reset the CSM0 and attached mezzanine cards, set used CSM0 registers and enable selected TDCs, where in default, EVID match testing at CSM0 is enabled and BCID matching test is disabled. It will set DAQ active if any TDC has been selected.

3.  (Optional) Set registers. As an example, disable EVID match testing at CSM0 by using CSM0 Controls

4.  Select trigger by clicking on toggle button of Set/Clear Ext Trigger Enable, if user selects , external trigger will be used. And means to use software trigger, where user has to issue software trigger by selecting Trigger Controls

Trigger Controls

Trigger Controls ŕ Read VME FIFO will ask user to give number of data words to be read from VME FIFO, and read VME FIFO word by word, i.e., block transfer is not used. The data words are written to standard output.

If software trigger is used, a combined command button for steps 4 and 5 is provided to read event where issuing software triggers is not required. Warning: Repeat counter should be no more than trigger limits, otherwise it may result in data error. If external trigger is in use, the same button with name can be used to read event directly. Here the event is read by using same way as Trigger Controls

The most useful registers for general diagnostics of data acquisition are TDC stop bits in the FIFO Threshold, the Stop & Full Flags, the received headers and received trailers registers which are selected by the Readback Register box and read by clicking on button. The received headers and trailers registers can also be read with Trigger Controls -> Received Hdrs and Trigger Controls -> Received Trls. These are 3 byte registers where each byte is on if the header or trailer for that CSM0 input channel has been received. When a full set of headers and trailers have been received these registers reset back to all zeroes until the next trigger.

It is worth to point out the command button which will let user to turn on/off whether to reset other CSMs during data taking if there are at least 2 CSM0 boards in the VME crate. This is used to demonstrate that the multiple CSM0 boards in same VME crate are functional normally.

5.4  Run DAQ with Software Trigger

6 Useful Information

6  Useful Information

 
6.1  Varies Panels and Controls
 
CSM Register Setup Panel
 
 The CSM register setup window (Figure 22) can be brought up by clicking on button in the main CSM MiniDAQ window, where CSM0 register contents can be modified and will be used for data taking. No all the CSM0 register settings will be valid for data acquisition (for instance ID codes should never be changed), therefore caution is absolutely necessary in changing CSM0 register settings. If the PROM version is 0x21020 or higher, the event prescale factor could be chose for DAQ up to 100KHz level.  
 

                                              Figure 22. CSM Register Setup Window
 
CSM0 Base: The CSM0 base (switch settings) could be modified by the command box in the main CSM MiniDAQ window and by the command box CSM0 Base Address of CSM0 diagnostic window, which allow user to use different CSM0 or change CSM0 switch settings for base address.
 
·   Cold Start: Execute ŕ CSM Board Cold Start performs a power up sequence for the CSM0 board and issues a global reset where the TDC enable mask will be kept. If the data acquisition is hang, this command could be used to reset the DAQ system and ensure the continuation of the data acqusition.
·   Set Run Number for Next Run:  It allows to set run number for next run, otherwise the run number is automatically increased by one for new run when Disk option is selected.
·   Save error summary: Execute ŕ Save Data Error Report save error summary report into a file.
·   Save error summary: Execute ŕ Data Error Report brings up the data error report window.
 
6.2  DAQ Parameter File
 
Basic DAQ parameters are written into file <DAQpara.txt> for future usage. The saved DAQ parameters are listed below:
Default Profile Saved : 0
CSM0 Base : 0x02000000
Run Number : 10000
# Used Mezz. Cards : 0
EVID Preset Value : 0
BCID Preset Value : 4018
BCID Rollover : 4095
Block Transfer in DAQ : 0
Direct VMEMap Warning: 0
Only Save Logfiles : 0
// Save CSM0 Clock (40MHz) counters 0 = Do Not Save
// 1 = Save to ASCI file
// 2 = Save to Binary file
Save Clock25 Counters : 0
// Collect data till VME FIFO full if enabled.
waitTill VMEFIFO Full : 0
// DAQ infor precision (# decimal points) is used for average event size and data flow
// rate. Allowed value is from 0 to 4, only the number is allowd to be changed.
DAQ Infor Precision : 2
Normally it is not necessary for user to change any DAQ parameter. Few options may be useful. Only log files will be put into disk if one turns on “Only Save Logfiles” . For PROM with version number 0x21020 or higher, the absolute trigger time could be obtained by reading out clock 25 counter. Also   it is allowed to change the decimal precision of average event size and data flow rate for DAQ infor window through the line of “ DAQ Infor Precision : 2” , where allowed value is from 0 to 4 for the decimal precision places.
 
6.3  Automatic Run Control File
 
MiniDAQ3.0.0 provides a flexible way to make automatic runs at different DAQ settings. The automatic run control file has a file extension of “.ctrl”, and the format of the control file is user friendly and easy to use. A simple automatic run control file <example.ctrl> is included in the distribution, it is recommended to refer to <example.ctrl> to make an automatic run control file.
 
 
 
Comments:
Any line starts with //, /* or *. Please note, commends must be preceded by //, /* or *, otherwise undesired effect or DAQ problem may occur.
 
Commands:
A command contains two parts “Key Words” and “Command Parameter”, where the “Command Parameter” is separated from “Key words” by “:” or blank space. A command line looks as following:
Key Words : Command Parameter
Following automatic run control commands are available:
·   Run Number :   Run number (unsigned int)
·   Number of Event :   Number required events for the run (unsigned int)
·   DAQ Time (s) : Required DAQ time in seconds (unsigned int)
·   TDC Enable Mask (HEX) : TDC selection mask (Hexdecimal)
·   Trigger Limit : CSM0 trigger limit 0 to 14
·   Event Prescaled Factor : Event prescaled factor 1, 101, 1009 and 10007 only valid for PROM with version number 0x21020 or higher
·   Storage Selection : Data output selection 0 and 1
0 = No Storage
1 = Auto Generated Filename
·   Data Analysis : Data monitor enable/disable (1/0 == on/off)
·   DAQ Infor : DAQ INFOR enable/disable (1/0 == on/off)
·   Profile : Profile name
·   Matching Window : AMT matching window (int)
·   AMT Channel Enable (HEX): AMT channel enable/disable (Hexdecimal)
·   ASD Channel Enable (HEX) : ASD channel enable/disable (Hexdecimal)
·   ASD Threshold (mV) : ASD main threshold in mV (int)
·   ASD1 Threshold (mV) : ASD1 main threshold in mV (int)
·   ASD2 Threshold (mV) : ASD2 main threshold in mV (int)
·   ASD3 Threshold (mV) : ASD3 main threshold in mV (in