Aim MIL-STD-1553 - Apicmdrtbhread

MIL-STD-1553 Reference Manual
273
Chapter 8 – Remote Terminal Functions
8.1.2 ApiCmdRTBHRead
Prototype:
AiInt16 ApiCmdRTBHRead ( AiUInt32 ul_ModuleHandle, AiUInt8 biu, AiUInt16 uw_HeaderId,
TY_API_RT_BH_INFO *px_Pbh );
Driver Command:
API_RT_BH_READ (0x8C)
Purpose:
This function is used to read the RT-SA buffer header structure (containing data buffer
base pointer, status queue base pointer and event queue base pointer).
I
I
n
n
p
p
u
u
t
t
A
A
i
i
U
U
I
I
n
n
t
t
1
1
6
6
u
u
w
w
_
_
H
H
e
e
a
a
d
d
e
e
r
r
I
I
d
d
Buffer Header ID
Note: See Section 1.3.5 for the range allowed for this parameter.
O
O
u
u
t
t
p
p
u
u
t
t
T
T
Y
Y
_
_
A
A
P
P
I
I
_
_
R
R
T
T
_
_
B
B
H
H
_
_
I
I
N
N
F
F
O
O
*
*
p
p
x
x
_
_
P
P
b
b
h
h
RT Buffer Header information
typedef struct ty_api_rt_bh_info
{
AiUInt16 bid;
AiUInt16 sid;
AiUInt16 eid;
AiUInt16 nbufs;
AiUInt32 hid_addr;
AiUInt32 bq_addr;
AiUInt32 sq_addr;
AiUInt32 eq_addr;
} TY_API_RT_BH_INFO
A
A
i
i
U
U
I
I
n
n
t
t
1
1
6
6
b
b
i
i
d
d
Value
Description
0..2047
Assigned Data Buffer Identifier
A
A
i
i
U
U
I
I
n
n
t
t
1
1
6
6
s
s
i
i
d
d
Status Queue Entry Identifier
A
A
i
i
U
U
I
I
n
n
t
t
1
1
6
6
e
e
i
i
d
d
Event Queue Entry Identifier
A
A
i
i
U
U
I
I
n
n
t
t
1
1
6
6
n
n
b
b
u
u
f
f
s
s
Value
Description
1..256
Amount of allocated contiguous Data Buffers
A
A
i
i
U
U
I
I
n
n
t
t
3
3
2
2
h
h
i
i
d
d
_
_
a
a
d
d
d
d
r
r
26-bit RT Buffer Header Address (Byte-Address)
A
A
i
i
U
U
I
I
n
n
t
t
3
3
2
2
b
b
q
q
_
_
a
a
d
d
d
d
r
r
26-bit RT Data Buffer Queue Base Pointer (Byte-Address)