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

ROCK id

ROCKFIFOT_ITfid
pointer

FIFO id
Must be the same as ROCKFIFOT_OTfid

ROCKFIFOT_ITelbits
record
nvd
natural

Should always be off(1)

ff
natural

hf
natural

ef
natural

fifodata
natural

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

ROCKFIFOT_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

ROCKFIFOT_ITrefill_el
ROCKFIFOT_ITelbits

ROCKFIFOT_ITrefill
list of
ROCKFIFOT_ITrefill_el

ROCKFIFOT_ITheader
record
sy
natural

last
natural

cradd
natural

trigger
natural

ROCKFIFOT_ITslave
record
slvadd
natural

channel
natural

reserved
natural

slvdata
natural

ROCKFIFOT_ITslaves
list of
ROCKFIFOT_ITslave

ROCKFIFOT_ITfooter
record
last
natural

softparity
natural

hardparity
natural

ROCKFIFOT_ITframe
record
header
ROCKFIFOT_ITheader

slaves
ROCKFIFOT_ITslaves

footer
ROCKFIFOT_ITfooter

ROCKFIFOT_ITraw2frame
list of
natural

ROCKFIFOT_ITraw_bits2frame
ROCKFIFOT_ITrefill

Output types

ROCKFIFOT_OTdummy
integer

Dummy result

ROCKFIFOT_OTfid
pointer

FIFO id
Must be the same as ROCKFIFIT_OTfid

ROCKFIFOT_OTelbits
record
nvd
natural

Should always be off(1)

ff
natural

hf
natural

ef
natural

fifodata
natural

ROCKFIFOT_OTclose
list of
ROCKFIFOT_OTelbits

ROCKFIFOT_OTread
list of
natural

ROCKFIFOT_OTread_bits_el
ROCKFIFOT_OTelbits

ROCKFIFOT_OTread_bits
list of
ROCKFIFOT_OTread_bits_el

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_OTread_frame
record
status
string

Empty if no error

elements
ROCKFIFOT_OTread

ROCKFIFOT_OTread_frame_bits
record
status
string

Empty if no error

elements
ROCKFIFOT_OTread_bits

ROCKFIFOT_OTraw2frame
record
status
string

Empty if no error

frame
ROCKFIFOT_OTframe

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

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 read_bits fid [nrels]
Input:
fid
ROCKFIFOT_ITfid

nrels
natural

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

Output:
ROCKFIFOT_OTread_bits

C function:
rockfifot_tl_read_bits

Read complete raw data from the FIFO

rockfifo decode fid [nrels]
Input:
fid
ROCKFIFOT_ITfid

nrels
natural

Nr of frames to read, default 1
Less frames 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 read_frame fid
Input:
fid
ROCKFIFOT_ITfid

Output:
ROCKFIFOT_OTread_frame

C function:
rockfifot_tl_read_frame

Read raw frame from the FIFO

rockfifo read_frame_bits fid
Input:
fid
ROCKFIFOT_ITfid

Output:
ROCKFIFOT_OTread_frame_bits

C function:
rockfifot_tl_read_frame_bits

Read raw frame with flags from the FIFO

rockfifo synch fid
Input:
fid
ROCKFIFOT_ITfid

Output:
ROCKFIFOT_OTread

C function:
rockfifot_tl_synch

Read raw data from the FIFO until a start of frame

rockfifo synch_bits fid
Input:
fid
ROCKFIFOT_ITfid

Output:
ROCKFIFOT_OTread_bits

C function:
rockfifot_tl_synch_bits

Read complete raw data from the FIFO until a start of frame

rockfifo cache set fid cancache
Input:
fid
ROCKFIFOT_ITfid

cancache
ROCKFIFOT_ITcancache

cache type

Output:
ROCKFIFOT_OTdummy

C function:
rockfifot_tl_setcancache

Set a new type of caching

rockfifo cache flush fid
Input:
fid
ROCKFIFOT_ITfid

Output:
ROCKFIFOT_OTread_bits

C function:
rockfifot_tl_flush

Empty the cache and return the contents

rockfifo cache refill fid newdata
Input:
fid
ROCKFIFOT_ITfid

newdata
ROCKFIFOT_ITrefill

Data to be filled in the FIFO.

Output:
ROCKFIFOT_OTdummy

C function:
rockfifot_tl_refill

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

rockfifo conv frame2raw framedata
Input:
framedata
ROCKFIFOT_ITframe

Output:
ROCKFIFOT_OTread

C function:
rockfifot_tl_frame2raw

Convert a formated frame in a raw frame

rockfifo conv raw2frame rawdata
Input:
rawdata
ROCKFIFOT_ITraw2frame

Output:
ROCKFIFOT_OTraw2frame

C function:
rockfifot_tl_raw2frame

Convert raw data frame to a formated one

rockfifo conv raw_bits2frame rawdata
Input:
rawdata
ROCKFIFOT_ITraw_bits2frame

Output:
ROCKFIFOT_OTraw2frame

C function:
rockfifot_tl_raw_bits2frame

Convert raw data frame to a formated one

Generated Mon 30. Jun 1997 10:36:38 from a tl file.
Do not modify by hand!