Aim MIL-STD-1553 - Low Speed Functions; Apibhmodify

MIL-STD-1553 Reference Manual
158
Chapter 5 – Buffer Functions
5.1 Low Speed Functions
5.1.1 ApiBHModify
Prototype:
AiInt16 ApiBHModify ( AiUInt32 ul_ModuleHandle, TY_API_BH_MODIFY *px_BHInfo );
Driver Command:
-
Purpose:
This function is used to modify the BC/RT buffer header on-the-fly. The buffer header
is addressed via the output address that can be achieved from the command
ApiCmdBCBHDef or ApiCmdRTBHDef.
Input
T
T
Y
Y
_
_
A
A
P
P
I
I
_
_
B
B
H
H
_
_
M
M
O
O
D
D
I
I
F
F
Y
Y
*
*
p
p
x
x
_
_
B
B
H
H
I
I
n
n
f
f
o
o
Buffer header modify description
typedef struct ty_api_bh_modify
{
AiUInt32 ul_BHAddr;
AiUInt32 ul_DataBufferStoreMode;
AiUInt32 ul_BufferSizeMode;
AiUInt32 ul_BufferSize;
AiUInt32 ul_BufferQueueMode ;
AiUInt32 ul_BufferQueueSize ;
AiUInt32 ul_StatusQueueSize;
AiUInt32 ul_EventQueueSize;
AiUInt32 ul_CurrentBufferIndex;
} TY_API_BH_MODIFY;
A
A
i
i
U
U
I
I
n
n
t
t
3
3
2
2
u
u
l
l
_
_
B
B
H
H
A
A
d
d
d
d
r
r
BC/RT buffer header address relative to the start of the Global RAM. This address is achieved
via the command ApiCmdBCBHDef for BC buffer header and ApiCmdRTBHDef for RT buffer
header.
A
A
i
i
U
U
I
I
n
n
t
t
3
3
2
2
u
u
l
l
_
_
D
D
a
a
t
t
a
a
B
B
u
u
f
f
f
f
e
e
r
r
S
S
t
t
o
o
r
r
e
e
M
M
o
o
d
d
e
e
Data Buffer Store Mode
For Receive Operation the following options are valid:
Value
Constant
Description
0
API_BSM_RX_DISCARD
Discard error messages from the
current Data Buffer
1
API_BSM_RX_KEEP_CURRENT
Keep error messages at the current
Data Buffer
0xFFFFFFFF
-
Do not modify this parameter