Aim MIL-STD-1553 - Apicmdbmreadmsgfltrec

MIL-STD-1553 Reference Manual
339
Chapter 9 – Bus Monitor Functions
9.1.12 ApiCmdBMReadMsgFltRec
Prototype:
AiInt16 ApiCmdBMReadMsgFltRec ( AiUInt32 ul_ModuleHandle, AiUInt8 biu,
AiUInt8 mode, AiUInt8 con,
AiUInt32 max_size, AiUInt16 max_msg,
void *lpBuf, AiUInt8 *ovfl,
AiUInt32 *lWordsRead )
Driver Command:
API_BM_READ_MSG_FLT_REC (0xC9)
Purpose:
This function is used to retrieve multiple 1553 message transfers from the Monitor
Buffer in one of four fomats. The data is required to have been recorded by the BM
while in Message Filter Recording mode (see ApiCmdBMCapMode).
Note: This function will copy the recorded data to the output buffer specified by the
user in ‘lpBuf‘ input parameter. The amount of valid data in Words copied to
the ‘lpbuf’ location is returned in ‘rsize’ (MS-Byte first). The format of the
data copied to the ‘lpbuf’ location is based on the ‘con’- parameter.
I
I
n
n
p
p
u
u
t
t
A
A
i
i
U
U
I
I
n
n
t
t
8
8
m
m
o
o
d
d
e
e
Value
Constant
Description
0
API_BM_FLT_MODE_INDEPENDENT
Returning ‘lWordsRead’ independend
from Monitor Trigger event
1
API_BM_FLT_MODE_DEPENDENT
Calculation of ‘lWordsRead’
depending on Monitor Trigger event
A
A
i
i
U
U
I
I
n
n
t
t
8
8
c
c
o
o
n
n
Message Filter Recording format – (See chapter 9.1.12.1)
Value
Constant
Description
0
API_BM_MSG_FLT_FORMAT_0
Format 0
1
API_BM_MSG_FLT_FORMAT_1
Format 1
2
API_BM_MSG_FLT_FORMAT_2
Format 2
3
API_BM_MSG_FLT_FORMAT_3
Format 3
4
API_BM_MSG_FLT_FORMAT_4
Format 4
A
A
i
i
U
U
I
I
n
n
t
t
3
3
2
2
m
m
a
a
x
x
_
_
s
s
i
i
z
z
e
e
Size of the allocated buffer in Words
A
A
i
i
U
U
I
I
n
n
t
t
1
1
6
6
m
m
a
a
x
x
_
_
m
m
s
s
g
g
Number of messages to read
‘con’
Value
Description
0..2
0
Read all messages
3
>0
Read ‘max_msg’ messages
v
v
o
o
i
i
d
d
*
*
l
l
p
p
B
B
u
u
f
f
Pointer to application buffer area (used to store recording data)