CSM MiniDAQ Quickstart Guide

University of Michigan

August 29, 2001

J. Gregory

University of Michigan Physics 2

Contents

Section Page

1. Introduction to the CSM MiniDAQ . . . . 3

2. Starting the CSM DAQ . . . . . . 4

3. JTAG Programming . . . . . . 5

3.1 Connecting th e hardware . . . . . 5

3.2 Enabling the JTAG serial connection . . . . 5

3.3 Loading a saved profile . . . . . 6

3.4 Applying a common setup . . . . . 6

3.5 Applying an individualized setup . . . . 7

3.6 JTAG and *NIX . . . . . . 7

4. Acquisition Runs . . . . . . . 8

4.1 Enabling AMTs . . . . . . 8

4.2 Selecting Storage . . . . . . 9

4.3 Beginning a run . . . . . . 9

4.4 Accumulating data . . . . . . 9

4.5 Ending a run . . . . . . . 9

5. Diagnostic Tools . . . . . . . 10

5.1 Using the CSM - 0 Diagnostic panel . . . . 10

5.2 Using the JTAG Diagno stics pane . . . . 12

Appendixes

A. AMT - 1 Control Bits . . . . . . 13

A.1 Main Setup Panel . . . . . . 13

B. Data Formats . . . . . . . 15

B.1 CSM Words . . . . . . . 15

B.2 TDC Words . . . . . . . 15

B.3 Data buffer . . . . . . . 16

C. Build Optio ns . . . . . . . 17

D. References . . . . . . . 18

University of Michigan Physics 3

1 Introduction to the CSM MiniDAQ

CSM MiniDAQ is software developed at the University of Michigan using National

Instruments LabWindows/CVI (part of Measurement Studio) and is a specialized version

of the ATLAS MiniDAQ software for use with the CSM - 0 Module also developed at the

University of Michigan. The purpose of the ATLAS MiniDAQ is to provide access to

the CSM and AMT hardware in an easy to use windows interface. The ATLAS

MiniDAQ has three major functions: JTAG programming, data acquisition, and hardware

diagnostics.

More detailed information on the CSM and ATLAS MiniDAQ [1], the AMT - 1 [2] and

the CSM project [3] can be found in their respective manuals. This guide is designed to

be a guid e to users new to the CSM MiniDAQ and combine the most commonly needed

aspects of several sources into one concise guide.

The newest distribution version of the CSM MiniDAQ is version 1.3.3, which fixes many

of the bugs in earlier versions of the MiniDAQ and includes some minor upgrades. The

screen shots in this guide are from versions v1.3.2 and v1.3.3. These versions are

identical in all respects except that v1.3.3 has the startup sequence discussed here.

Version 1.3.2 was never widely distributed. T he new sequence for starting a data

acquisition run is the main change in the new version, but otherwise all the information

applies to earlier versions except JTAG - > Setup Send does not exist in versions earlier

than v1.3.2 and it is not possible to set up individual AMT cards in the earlier versions.

University of Michigan Physics 4

2 Starting the CSM MiniDAQ

Figure 1. The CSM MiniDAQ main window

This guide assumes you are using a National Instruments VME interface for the CSM

card. If you are not using a National Instruments compatible controller card, the standard

CSM MiniDAQ distribution will not work and the code will need to be modified to take

into account the different drivers. Before running the CSM MiniDAQ program, make

sure that the VME hardware has been initialized with the NI Resource Manager and that

all CSM - 0 Modules are include in the device list. CSM - 0 Cards require A32 address

space with an address that agrees with the address set by the dipswitches on the CSM - 0

Card. The default address for a card is 0x2000 000.

The CSM MiniDAQ program is started with the file csm0.exe, which brings up the main

CSM MiniDAQ window. The first step in data acquisition or diagnostics using an AMT

card is to use JTAG to program the AMT cards. All of the necessary commands for

J TAG programming are in the J

TAG pull - down menu, including the JTAG diagnostic

panel. Saved programming profiles are accessed from the F

ile menu. Once JTAG

programming is finished, standard data acquisition commands are all located on the main

window. D iagnostic tools including test data acquisition are located on the Diagnostics

Panel, which is accessed from the D

iagnostics menu.

University of Michigan Physics 5

3 JTAG Programming

JTAG Programming consists of five steps, two of which are optional:

1. Connect the hardware or check of the hardware setup.

2. Enable the JTAG serial connection.

3. Load a saved profile (optional)

4. Apply a common setup to the AMT cards

5. Apply individualized settings to any AMT cards (optional)

Once the AMT cards have been programmed, the setup used can be saved for later use.

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 po rt to a mezzanine card is skipped or

connected in series with the next port in the chain. Placing the jumper on the pins farth er

from the edge of the board includes the associated mezzanine card i n 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 ada pter card as seen from the card edge

with jumpers is the first device in the chain.

There are two JTAG ports on the CSM - 0 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 J P3. 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 Enabling the JTAG serial connection

To enable the JTAG serial conn ection,

click on the JTAG menu and select

�Enable JTAG Serial.� The JTAG Serial

Enabled LED should turn green. It is

important to disable JTAG serial before

taking data, and to disable JTAG serial,

select JTAG - > Disable JTAG Serial .

Only when JTAG seri al is enabled will the

JTAG programming and JTAG diagnostic

commands be available.

University of Michigan Physics 6

3.3 Loading a saved profile

To load a saved profile, select File - > Load Profile . This

will bring up a file open dialog and display files of type .prf.

Included with the CSM MiniDAQ is a file called default.prf

that contains standard setup options, but these will need to be

tweaked for the particular hardware setup to be programmed.

A saved profile contains both the general JTAG setup and the

individual JTAG setups, however loading a profile does not

apply any settings to the AMT and Setup All or Setup Send must still be run. Setup Send

is only available in versions of the CSM MiniDAQ later than 1.3.2. Setup Send takes the

current JTAG profile and loads it to the AM T devices without any intermediate steps and

applies both a common setup to all cards and then programs any individual setups that

have been created. Setup send is accessed via JTAG - > Setup Send . If you have a setup

you would like to reuse, save the set up with File - > Save Profile .

3.4 Applying a common setup

Before individual setups can be accessed, a common

setup must be applied to all attached AMT cards. To

apply a common setup to the AMT cards select JTAG - >

Setup All .

The setup screen for the AMT - 1 contains a plethora of

switches, number boxes and a few buttons tossed in for spice. If a saved profile has been

loaded, check that the Total no. of TDCs is correct and click

Figure 2. JTAG Setup for Mezzanine Cards

University of Michigan Physics 7

If not u sing a saved profile, or if the saved profile is not correct, the setup values will

need to be modified. The

button accesses the AMT - 1 JTAG Channel Select

panel and the

button accesses the AMT - 1 JTAG Error Setup pa nel. The JTAG

programming is not applied until the

button on the JTAG Setup for

Mezzanine Cards window is selected.

closes the window and reverts to any

previous values. All of the AMT - 1 options are explained in A ppendix A, which is a

summary of the command register section of the AMT - 1 manual. For most options, the

default values will be sufficient. The values that will need the most tweaking are Trigger

Offset, DAC Voltage Output, and the Mask, Search and Match Windows.

3.5 Applying an individualized setup

Once a common setup has been

applied to the attached AMT cards,

any given AMT card can be

individualized. In most cases this is

not necessary. To setup an individual

AMT card selected JTAG - > Setup

Individua l - > Mezzanine N , where N is

the number of the mezzanine card in

the JTAG chain. This will only agree

with the TDC number on the CSM - 0 if

the JTAG chain order agrees with this CSM - 0 numbering. The individual setup panel is

virtually identical to the comm on setup panel. If a profile was loaded with an

individualized setting for a card, the panel corresponding to that card will hold the saved

values. Individualized settings saved into a profile are not applied until setup individual

has been run on that c ard or Setup Send has been run.

3.6 JTAG and *NIX

To facilitate JTAG programming in a *NIX environment, CSM MiniDAQ has the ability

to produce a text output of the JTAG programming string. To get a text output of the

JTAG setup, toggle the Save Bit String b utton , located in the lower right hand corner, to

say �SAVE�. No utility is provided for reading this file in *NIX and sending it out to

JTAG devices.

University of Michigan Physics 8

4 Acquisition Runs

After using the JTAG commands to program all attached AMT cards, the next step in

standard use is to setup and begin a data acquisition run. Data acquisition is handled

from the main CSM MiniDAQ panel. There are four steps to collecting data:

1. Enable the AMT cards to be monitored during the run.

2. Select Storage

3. Begin the run.

4. Accumulate data.

5. End the run.

4.1 Enabling AMTs

To enable AMTs, click

on the main CSM MiniDAQ panel. AMTs are

enabled with the TDC Enables panel. If an AMT is not enabled the CSM will not expect

data from that card and will ignore any data sent by that card. To turn channels on or off

for all AMT cards, click on Channels on the JTAG Setup for Mezzanine Cards panel,

accessed from JTAG - > Setup All . To turn channels on or off for an individual AMT

card , click on Channels in the individual setup panel for that card and select the channels.

The TDC Enables panel is for turning on an entire AMT, and not individual channels.

Figure 3. TDC Channel Enables panel

For normal operations, it is sufficie nt to select the TDCs to be enabled and then hit done.

Enabling a TDC that is not connected to the CSM will hang the data acquisition

processes while the CSM - 0 waits for data from a card that

is not there. The enabled AMTs are indicated by the TDC

Enable mask.

University of Michigan Physics 9

4.2 Selecting Storage

Figure 4. Storage section of main panel, lower left section

Before starting a new run, it is important to select how data is to be

stored. There are two main choices, either store data to a disk or to

discard acquired data. Select between Disk and None using the

Storage pull down menu.

If None is selected, data will be discarded, however the Analyze command can be used

to check the data for missing words or errors, and is a useful diagnos tic tool. To use

Analyze, click Analyze anytime when there is no active data acquisition run. If Analyze

is enabled, the indicator will turn from red to green.

If Disk is selected, data will be stored in the file indicated by File Name . The storage fi le

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. Analyze will

work when Disk is selected, but the limit to the trigger rate will be lower.

4.3 Beginn ing a run

To begin a run, hit the button

. CSM MiniDAQ will ask for the run

number. Hitting Enter will default to incrementing the run number by one. After

clicking OK or hitting Enter the run proceeds.

Data will either be stored to the file in File Name or will be discarded depending on the

value of Storage. See 4.2 Selecting Storage Option.

4.4 Accumulating data

Once a run is begun (see the previous section), data acquisition is automatic. The Evt No

status box will automatic ally update as triggers are read. To allow for faster data

acquisition, data from multiple events are written into a single buffer that is stored to disk

when it is full. The number of these buffers stored to disk is indicated by Buffers .

During the run ,

and

on the CSM MiniDAQ main panel can

be used to resume and suspend data acquisition.

4.5 Ending a run

Once enough triggers have been read for the run, click

on the CSM MiniDAQ

main panel to be gin the run termination process. The CSM MiniDAQ will ignore any

new triggers, read the rest of the buffered events, and flush the last buffer to disk.

University of Michigan Physics 10

5 Diagnostic Tools

CSM MiniDAQ provides tools for diagnosing JTAG programming errors, data

acquisi tion, and the CSM - 0 hardware. JTAG programming has a diagnostic panel that

can be used when JTAG serial is enabled by clicking JTAG - > Diagnostics . CSM - 0

hardware and data acquisition diagnostic tools can be accessed with Diagnostics - > Run .

5.1 Using the CSM - 0 Diagnostic panel

Figure 4. CSM - 0 Diagnostic Panel

Taking data with the diagnostic panel requires that the

AMT cards have been programmed using JTAG. Emulator

cards do not require JTAG programming, however the

software reset is not alw ays sufficient for these cards and

the hardware reset button on the emulator card should be

used before trying to read its output.

Once the AMT or emulator cards are ready, follow these steps:

1. Click

. This command resets the CSM - 0 and the AMT

cards.

2. Select CSM0 Controls - > Enable TDCs

and select TDCs that are attached to the

CSM - 0, this procedure is the same as in

4.1 Enabling AMTs .

3. Click Set/Clear DAQ

Active .

4. To read external triggers, click

Set/Clear Ext Trigger Enable , to se nd a software trigger click Trigger

Controls - > Software Trigger .

University of Michigan Physics 11

Several methods are available for reading the VME FIFO and checking on the data

received by the CSM - 0.

Expand FIFO Print will include decipher the hex words read from

the CSM - 0 to a more readable form.

Trigger Controls - > Read FIFO All - >

Print will read the EVID/WC register of the

CSM - 0 and grab the indicated number of

words and write them to the standard

output. If the EVID/WC register is em pty,

the CSM - 0 either did not receive a trigger,

is waiting for a missing header or trailer, or

there is an EVID mismatch.

Trigger Controls - > Mty VME FIFO (print) dumps

the contents of the CSM - 0 VME FIFO to the standard

output without checking the EVID /WC register. There

will probably be an extra 0x0 word between events. The

word is there to counteract a problem with the VME chip

used by the CSM - 0 where the chip grabs an extra word.

This zero word is discarded in data acquisition runs.

Readback di splays the contents of the register indicated by the

Readback Register . The most useful registers for general

diagnostics are the received headers and received trailers

registers which can also be read with Trigger Controls - >

Received Hdrs and Trigger Co ntrols - > Received Trls.

These are 3 byte registers where each byte is on if the header or

trailer for that 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 trig ger.

CSM0 Controls - > Disable EVID match and CSM0

Controls - > Disable BCID match will allow the CSM0 to

read events where the EVID and BCID of the TDC data

does not match the CSM0 internal EVID and BCID.

University of Michigan Physics 12

5.2 Using the JTAG Diagnostics panel

Th e JTAG Diagnostics panel is useful for checking if the

AMT boards are configured correctly. To bring up the

JTAG Diagnostics panel, Enable JTAG Serial must be

on, then click JTAG - > Diagnostics .

Check Status downloads the status registers of the AMT ca rd indicated by TDC ID .

Check JTAG downloads the control registers of the AMT card indicated by TDC ID and

displays the contents in a panel.

Global Reset performs a reset using the control registers of the AMT. Using Global

Reset can change the JTAG pr ogramming of the AMT cards and its use is not suggested.

Figure 4. JTAG Diagnostics panel

University of Michigan Physics 13

Appendix A. AMT - 1 Control Bits

A.1 Main Setup Panel

The information in this appendix is from the AMT - 1 & 2 user manual [2], for a more

comp lete description see the AMT manual. The default value is for typical operation. If

the default is underlined, it is required for correct operation of the CSM - 0 with an AMT - 1

mezzanine card.

CSM MiniDAQ Name (AMT - 1 Name) [DEFAULT] Description

Automatic Reject (enable_auto_reject) [ON] Reject hits when the channel

buffers are full.

Buffer Overflow Detect (enable_l1ovr_detect) [ON] Detect L1 buffer overflows.

Clkout Mode (clkout_mode) [40 Mhz] One of four clock modes:

Start Sync: Clock is synchronized wit h the START signal.

40 Mhz: output of the PLL clock /2, typical in most logics.

80 Mhz: output of the PLL clock.

CCount carry: carry out of the coarse counter, used to extend the time range.

Coarse Offset (coarse_time_offset) [0] BCID counter offset.

Co unt Roll Over (count_roll_over) [4095] Roll over value for the coarse counter.

DAC Voltage Output (CLPD register) [114] Input to the DAC that sets the threshold

for the ASD. 0 corresponds to - 1 V and 255 to +1V with a sensitivity of 1 fC/12

mV, so voltag es are in steps of 4 mV or 0.33 fC. The standard threshold for MDT

tubes is � 5fC which corresponds to 114. For a NIM pulse on the injector boards

built at UofM, the DAC input should be around 70.

Direct Control (enable_direct) [ OFF

] Trigger reset comes f rom direct input pins.

Disable Encode (disable_encode) [OFF] Disable fine timer encoder and output.

Disable Ring Osc (disable_ringosc) [ OFF

] Stop the ring oscillator and disable the PLL.

Enable Errst Bcrevr (enable_errst_bcrecr) [ON] Reset error status on any reset.

Enable Mask Flags Read (enable_mask) [ON] Enable mask flags for hits less than

Match Window clock ticks before the search window.

Enable Serial (enable_serial) [ ON

] Serial data readout.

Encoded Master Reset (enable_mreset_code) [ ON

] Master rese t from an encoded reset.

Error Mark Overflow (enable_errmark_ovr) [ON] Flags events with buffer overflow.

Error Mark Rejection (enable_errmark_rejected) [ON] Error mark if a hit is rejected in

Match Window.

Event Offset (event_count_offset) [0] Offset of the counter for EVID.

Force Rejection (enable_rejected) [ON] Recover rejected hits from buffer overflow.

L1 Buffer Occupancy Readout (enable_l1occup_readout) [OFF] Allow readout of L1

buffer occupancy.

L1 Full Reject (enable_l1_full_reject) [ON] Reject h its if L1 buffer is nearly full.

Leading (enable_leading) [ON] Enable leading edge measurements of hits.

Local Head (enable_header) [ ON

] Enable TDC header.

Local Trailer (enable_trailer) [ ON

]Enable TDC trailer.

Mark Rejection (not implemented) This code is not implemented in the AMT - 1.

University of Michigan Physics 14

Mask Window (mask_window) [20] Number of 25 ns clock cycles before a trigger

during which a hit will set off a mask flag.

Match Window (match_window) [80] Number of 25 ns clock cycles after a trigger

during which hits will be considered to belong to that trigger.

Pair (enable_pair) [OFF] Enable paired measurements and mask Leading and Trailing.

PLL Multiplier (pll_multi) [ 1:2

] ratio between the external clock and the internal ring

oscillator.

Pulse Width Resolution (width_s elect) [0.78 ns] Resolution of the pulse width, for use

in Pair measurements.

Readout FIFO Full Reject (enable_rofull_reject) [ON] Reject hits if read - out FIFO full.

Reject Offset (reject_count_offset) [Trigger Offset � 100] Offset for the rejection

coun ter, when the rejection counter matches the BCID of a hit, the hit will be

discarded.

Relative (enable_relative) [ON] Subtract the trigger count from the coarse count of hits.

Reset Channel Buffer on Separator (enable_resetcb_sepa) [ON] Reset the channel

buffer when a separator is inserted.

Search Window (search_window) [100] Sets the number of clock cycles after a trigger

to search for hits.

Separator on Bunch Reset (enable_sepa_bcrst) [OFF]

Separator on Event Reset (enable_sepa_evrst) [OFF]

Separator Re adout (enable_sepa_readout) [OFF]

Serial Readout Speed (readout_speed) [40 Mbits/sec]speed at which data is read from

the AMT to the CSM - 0.

Set Counters on Bunch Reset (enable_setcount_bcrst) [ON] sets all counters to be reset

on a bunch count reset.

Str obe Select (strobe_select) [ Edge Cont

] selects one of four modes for data transfer:

DS strobe: Gated DS strobe

DS str cont: Continuous DS strobe

Lead Edge: Gated leading edge

Edge Cont: continuous leading edge strobe. CSM - 0 requires this mode.

Test Mod e (test_mode) [ OFF

] test mode for diagnosing AMT hardware problems.

Test Invert Mode (test_invert) [ OFF]

Trailing (enable_trailing) [ ON

] enable trailing edge measurements.

Trigger Full Reject (enable_trfull_reject) [ON] reject hits if trigger FIFO is near ly full.

Trigger Matching (enable_match) [ ON

] has the TDC match triggers to hits.

Trigger Offset (bunch_count_offset) [4040] sets the offset of the trigger time tag to

account for delays between the trigger and the data.

University of Michigan Physics 15

Appendix B. Data Formats

The f ollowing charts are adopted from CSM Design & CSM - 0 Production by R. Ball,

J. Chapman, et al.

B.1 CSM Words

CSM HEADER

8 7 6 5 4 3 2 1 0

0x5 0x9 EVID BCID

CSM TRA ILER

8 7 6 5 4 3 2 1 0

0x5 0xb EVID Word count

CSM Error Word

8 7 6 5 4 3 2 1 0

0x5 0 Error Code High Bit for each abnormal TDC

B.2 TDC Words

TDC HEADER

8 7 6 5 4 3 2 1 0

0xa TDC ID EVID BCID

TDC TRAILER

8 7 6 5 4 3 2 1 0

0xc TDC ID EVID Word count

LEADING EDGE DATA

8 7 6 5 4 3 2 1 0

0x3 TDC ID Channel 1 E Coarse time Fine time

TRAILING EDGE DATA

8 7 6 5 4 3 2 1 0

0x3 TDC ID Channel 0 E Coarse time Fine time

Bit 17, E, is the error flag.

PAIRED DATA

8 7 6 5 4 3 2 1 0

0x4 TDC ID Channel Width Coarse time Fine time

MASK FLAG

8 7 6 5 4 3 2 1 0

0x2 TDC ID Mask flags

TDC ERROR WORD

8 7 6 5 4 3 2 1 0

0x6 TDC ID Unused Errors

University of Michigan Physics 16

B.3 Data buffer

Data in the CSM MiniDAQ is saved to disk in buffers that have a maximum length set by

the environment variable MAX_BUF. To allow for faster data acquisition, several events

are placed in a single buffer which is then stored to disk. Knowing the format of the data

buffer is important for writing software t o parse a CSM MiniDAQ data file.

Words 11 and 12+ are repeated for all wo rds in the buffer. There is no buffer trailer.

Word Contents

0 Total words in buffer

1 Run number

2 Number of events in buffer

3 Undefined

4 Undefined

5 User word 1 (number of triggers in buffer)

6 User word 2 (number of words minus buffer header)

7 User word 3 (ASD voltage threshold)

8 User word 4 (0x0)

9 User word 5 (0x0)

10 Number of words minus buffer header

11 EVID/WC register contents of first event

12+ Headers, data and trailers of first event

University of Michigan Physics 17

Appendix C. Build Options

Included in the 1.3.2 and 1.3.3 distributions of CSM MiniDAQ is a file called

constants.h. 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 is o nly present in distribution 1.3.3 and 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, uncomment the line #define ENVIRO_CHECK .

University of Michigan Physics 18

Appendix D. References

[1] �ATLAS MiniDAQ Reference Guide�, R. Ball, J. Chapma n, J. Hollar, J. Kuah, J.

Gregory. University of Michigan. June, 2001.

[2] �AMT - 1 & 2 (ATLAS Muon TDC version 1 & 2) User�s Manual�, Yasuo Arai.

KEK, National High Energy Accelerator Research Organization, Japan. Rev

0.83, Feb 26, 2001.

[3] �CSM Design & CSM - 0 Production�, R. Ball, J. Chapman, J. Kuah, J. Mann, J.

Hollar. University of Michigan. October, 2000.