Tcl command "rockfifo"

ROCK FIFO library tcl interface
If you use this command, do not read the FIFO in other ways!


Index:


Input types

ROCKT_ITrid
pointer

ROCKFIFOT_ITfid
pointer

FIFO id
Must be the same as ROCKFIFOT_OTfid

ROCKFIFOT_ITwhat
case insensitive set
  • "efifo"
  • "dfifo"

ROCKFIFOT_ITcancache
case insensitive set
  • "off"
  • "minimal"
  • "advanced"
  • "block"
  • "block_advanced"


Output types

ROCKFIFOT_OTfid
pointer

FIFO id
Must be the same as ROCKFIFIT_OTfid

ROCKFIFOT_OTclose
list of
natural

ROCKFIFOT_OTread
list of
natural

ROCKFIFOT_OTheader
record
sy
natural

last
natural

cradd
natural

trigger
natural

ROCKFIFOT_OTslave
record
slvadd
natural

channel
natural

reserved
natural

slvdata
natural

ROCKFIFOT_OTslaves
list of
ROCKFIFOT_OTslave

ROCKFIFOT_OTfooter
record
last
natural

softparity
natural

hardparity
natural

ROCKFIFOT_OTframe
record
header
ROCKFIFOT_OTheader

slaves
ROCKFIFOT_OTslaves

footer
ROCKFIFOT_OTfooter

ROCKFIFOT_OTdecode_elements
list of
ROCKFIFOT_OTframe

ROCKFIFOT_OTdecode
record
status
string

Empty if no error

elements
ROCKFIFOT_OTdecode_elements

ROCKFIFOT_OTsynch
list of
natural


Commands

rockfifo open what rid [cancache]
Input:
what
ROCKFIFOT_ITwhat

rid
ROCKT_ITrid

rid returned by rock open

cancache
ROCKFIFOT_ITcancache

cache type, default is minimal

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

Output:
ROCKFIFOT_OTfid

C function:
rockfifot_tl_open

Open a ROCK FIFO channel

rockfifo close fid
Input:
fid
ROCKFIFOT_ITfid

Output:
ROCKFIFOT_OTclose

C function:
rockfifot_tl_close

Close a ROCK FIFO channel
Return the contents of the cache

rockfifo isempty fid
Input:
fid
ROCKFIFOT_ITfid

Output:
numeric boolean

C function:
rockfifot_tl_isempty

Returns 1 if the FIFO is empty

rockfifo read fid [nrels]
Input:
fid
ROCKFIFOT_ITfid

nrels
natural

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

Output:
ROCKFIFOT_OTread

C function:
rockfifot_tl_read

Read raw data from the FIFO

rockfifo decode fid [nrels]
Input:
fid
ROCKFIFOT_ITfid

nrels
natural

Nr of frames to read, default 1
Less framess can be read out
A parity error is not considered an error!

Output:
ROCKFIFOT_OTdecode

C function:
rockfifot_tl_decode

Read frames from the FIFO

rockfifo synch fid
Input:
fid
ROCKFIFOT_ITfid

Output:
ROCKFIFOT_OTsynch

C function:
rockfifot_tl_synch

Read raw data from the FIFO until a start of frame


Generated Tue 25. Mar 1997 15:06:56 from a tl file.
Do not modify by hand!