Aim MIL-STD-1553 - Apicmdbmstackentryread

MIL-STD-1553 Reference Manual
356
Chapter 9 – Bus Monitor Functions
9.1.16 ApiCmdBMStackEntryRead
Prototype:
AiInt16 ApiCmdBMStackEntryRead ( AiUInt32 ul_ModuleHandle, AiUInt8 biu, AiUInt8 ptype,
AiUInt8 sgn, AiUInt32 offset,
TY_API_BM_STACK_DSP *pentry );
Driver Command:
API_BM_ENTRY_READ (0xBC)
Purpose:
This function is used to read a Monitor Buffer Entry specified by the Buffer Pointer
Read Mode plus offset. Each Monitor Buffer Entry comprises a 32-bit Word.
I
I
n
n
p
p
u
u
t
t
A
A
i
i
U
U
I
I
n
n
t
t
8
8
p
p
t
t
y
y
p
p
e
e
Buffer Pointer Read Mode
Value
Constant
Description
0
API_BM_READ_STP
Read from Monitor Start Entry Pointer (stp)
1
API_BM_READ_CTP
Read from Monitor Capture Start / Trigger
Pointer (ctp)
2
API_BM_READ_ETP
Read from Monitor Buffer Fill / End Pointer (etp)
3
API_BM_READ_ABS
Read from address given in the parameter
‘offset’ relative to the start of the monitor
memory area
A
A
i
i
U
U
I
I
n
n
t
t
8
8
s
s
g
g
n
n
Entry Offset Sign
‘ptype’
Value
Constant
Description
0,1
0
API_BM_SIGN_POS
Positive entry offset
1,2
1
API_BM_SIGN_NEG
Negative entry offset
3
0
-
reserved
A
A
i
i
U
U
I
I
n
n
t
t
3
3
2
2
o
o
f
f
f
f
s
s
e
e
t
t
‘ptype’
Value
Description
0..2
0..m
Number of entries relative to the selected Buffer
Pointer Read Mode (where m is the bus monitor
size / 4)
3
0..n
Long word address offset to read from, relative to
the start of the monitor memory area
O
O
u
u
t
t
p
p
u
u
t
t
T
T
Y
Y
_
_
A
A
P
P
I
I
_
_
B
B
M
M
_
_
S
S
T
T
A
A
C
C
K
K
_
_
D
D
S
S
P
P
*
*
p
p
e
e
n
n
t
t
r
r
y
y
BM Stack Entry Data
typedef struct ty_api_bm_stack_dsp
{
AiUInt32 entry;
} TY_API_BM_STACK_DSP;