Tcl command "rockmfifo"

ROCKM FIFO library tcl interface
If a fifo is opened, no other should use that FIFO!


Index:


Input types

ROCKMT_ITrid
pointer

ROCKM_id returned from rockm command

ROCKMFIFOT_ITfid
pointer

Should be the same as ROCKMFIFOT_OTfid

ROCKMFIFOT_ITcancache
case insensitive set
  • "off"
    disable read-ahead caching
  • "minimal"
    read more only if hf
  • "advanced"
    read until empty
  • "block"
    force block read
  • "block_advanced"
    block read all the fifo

ROCKMFIFOT_ITrefill
list of
natural

ROCKMFIFOT_ITraw2frame
list of
natural

ROCKMFIFOT_ITsuperheader
record
chadd
natural

Chain address

trigger
natural

Should be the same as in all the subheaders

ring
natural

ROCKMFIFOT_ITsubheader
record
last
natural

trigger
natural

Should be the same as in the superheader

ROCKMFIFOT_ITslave
record
slvadd
natural

channel
natural

reserved
natural

slvdata
natural

ROCKMFIFOT_ITslaves
list of
ROCKMFIFOT_ITslave

ROCKMFIFOT_ITsubfooter
record
softparity
natural

calculated parity
Should be the same as hardparity

hardparity
natural

hardware reported parity
Should be the same as softparity

ROCKMFIFOT_ITsubframe
record
cradd
natural

Crate address

header
ROCKMFIFOT_ITsubheader

slaves
ROCKMFIFOT_ITslaves

footer
ROCKMFIFOT_ITsubfooter

ROCKMFIFOT_ITsubframes
list of
ROCKMFIFOT_ITsubframe

ROCKMFIFOT_ITsuperfooter_parity_fail
natural

the bit 0 represent crate 0

ROCKMFIFOT_ITsuperfooter
record
softparity_fail
ROCKMFIFOT_ITsuperfooter_parity_fail

calculated parity bits, one per crate
Should be the same as hardparity_fail

hardparity_fail
ROCKMFIFOT_ITsuperfooter_parity_fail

hardware parity bits, one per crate
Should be the same as softparity_fail

overflow
natural

overflow in counter

softcounter
natural

calculated counter
Should be the same as hardcounter

hardcounter
natural

hardware reported counter
Should be the same as softcounter

ROCKMFIFOT_ITsuperframe
record
header
ROCKMFIFOT_ITsuperheader

subfr
ROCKMFIFOT_ITsubframes

footer
ROCKMFIFOT_ITsuperfooter


Output types

ROCKMFIFOT_OTfid
pointer

Should be the same as ROCKMFIFOT_ITfid

ROCKMFIFOT_OTdummy
integer

Dummy result

ROCKMFIFOT_OTclose
list of
natural

ROCKMFIFOT_OTread
list of
natural

ROCKMFIFOT_OTsuperheader
record
chadd
natural

Chain address

trigger
natural

Should be the same as in all the subheaders

ring
natural

if ring on (0), only superheader, superfooter, subframe.cradd and subheader.last have sense

ROCKMFIFOT_OTsubheader
record
last
natural

trigger
natural

Should be the same as in the superheader

ROCKMFIFOT_OTslave
record
slvadd
natural

channel
natural

reserved
natural

slvdata
natural

ROCKMFIFOT_OTslaves
list of
ROCKMFIFOT_OTslave

ROCKMFIFOT_OTsubfooter
record
softparity
natural

calculated parity
Should be the same as hardparity

hardparity
natural

hardware reported parity
Should be the same as softparity

ROCKMFIFOT_OTsubframe
record
cradd
natural

Crate address

header
ROCKMFIFOT_OTsubheader

slaves
ROCKMFIFOT_OTslaves

footer
ROCKMFIFOT_OTsubfooter

ROCKMFIFOT_OTsubframes
list of
ROCKMFIFOT_OTsubframe

ROCKMFIFOT_OTsuperfooter_parity_fail
natural

the bit 0 represent crate 0

ROCKMFIFOT_OTsuperfooter
record
softparity_fail
ROCKMFIFOT_OTsuperfooter_parity_fail

calculated parity bits, one per crate
Should be the same as hardparity_fail

hardparity_fail
ROCKMFIFOT_OTsuperfooter_parity_fail

hardware parity bits, one per crate
Should be the same as softparity_fail

overflow
natural

overflow in counter

softcounter
natural

calculated counter
Should be the same as hardcounter

hardcounter
natural

hardware reported counter
Should be the same as softcounter

ROCKMFIFOT_OTsuperframe
record
header
ROCKMFIFOT_OTsuperheader

subfr
ROCKMFIFOT_OTsubframes

footer
ROCKMFIFOT_OTsuperfooter

ROCKMFIFOT_OTdecode_elements
list of
ROCKMFIFOT_OTsuperframe

ROCKMFIFOT_OTdecode
record
status
string

Empty if no error

elements
ROCKMFIFOT_OTdecode_elements

ROCKMFIFOT_OTread_frame
record
status
string

Empty if no error

elements
ROCKMFIFOT_OTread

ROCKMFIFOT_OTraw2frame
record
status
string

Empty if no error

superframe
ROCKMFIFOT_OTsuperframe

ROCKMFIFOT_OTframe2raw
list of
natural

ROCKMFIFOT_OTconv_whatis
string

One of the following:
- superheader
- subheader
- slave
- subfooter
- superfooter
- invalid


Commands

rockmfifo open rid [cancache]
Input:
rid
ROCKMT_ITrid

cancache
ROCKMFIFOT_ITcancache

cache type, default is minimal

Output:
ROCKMFIFOT_OTfid

C function:
rockmfifot_tl_open

Open the FIFO

rockmfifo close fid
Input:
fid
ROCKMFIFOT_ITfid

Output:
ROCKMFIFOT_OTclose

C function:
rockmfifot_tl_close

Close the FIFO

rockmfifo isempty fid
Input:
fid
ROCKMFIFOT_ITfid

Output:
numeric boolean

C function:
rockmfifot_tl_isempty

Returns 1 if the FIFO is empty

rockmfifo read fid [nrels]
Input:
fid
ROCKMFIFOT_ITfid

nrels
natural

Nr of elements to read, default 1
Less elements can be read out

Output:
ROCKMFIFOT_OTread

C function:
rockmfifot_tl_read

Read raw data from the FIFO

rockmfifo decode fid [nrels]
Input:
fid
ROCKMFIFOT_ITfid

nrels
natural

Nr of frames to read, default 1
Less frames can be read out
Parity, last, trigger and counter errors are not considered!

Output:
ROCKMFIFOT_OTdecode

C function:
rockmfifot_tl_decode

Read frames from the FIFO

rockmfifo read_frame fid
Input:
fid
ROCKMFIFOT_ITfid

Output:
ROCKMFIFOT_OTread_frame

C function:
rockmfifot_tl_read_frame

Read raw frame from the FIFO

rockmfifo synch fid
Input:
fid
ROCKMFIFOT_ITfid

Output:
ROCKMFIFOT_OTread

C function:
rockmfifot_tl_synch

Read raw data from the FIFO until a start of frame

rockmfifo cache set fid cancache
Input:
fid
ROCKMFIFOT_ITfid

cancache
ROCKMFIFOT_ITcancache

cache type

Output:
ROCKMFIFOT_OTdummy

C function:
rockmfifot_tl_setcancache

Set a new type of caching

rockmfifo cache flush fid
Input:
fid
ROCKMFIFOT_ITfid

Output:
ROCKMFIFOT_OTread

C function:
rockmfifot_tl_flush

Empty the cache and return the contents

rockmfifo cache refill fid newdata
Input:
fid
ROCKMFIFOT_ITfid

newdata
ROCKMFIFOT_ITrefill

Data to be filled in the FIFO.

Output:
ROCKMFIFOT_OTdummy

C function:
rockmfifot_tl_refill

Fill the cache with raw data
It can be very dangerous!!!
Use with care.

rockmfifo conv raw2frame rawdata
Input:
rawdata
ROCKMFIFOT_ITraw2frame

Output:
ROCKMFIFOT_OTraw2frame

C function:
rockmfifot_tl_conv_raw2frame

Convert raw data frame to a formated one

rockmfifo conv frame2raw aframe
Input:
aframe
ROCKMFIFOT_ITsuperframe

Output:
ROCKMFIFOT_OTframe2raw

C function:
rockmfifot_tl_conv_frame2raw

Convert a formated frame to raw data

rockmfifo conv whatis rawel
Input:
rawel
natural

Output:
ROCKMFIFOT_OTconv_whatis

C function:
rockmfifot_tl_conv_whatis

Determine the type of the element


Generated Wed 29. Oct 1997 11:40:23 from a tl file.
Do not modify by hand!