Aim MIL-STD-1553 - Apicmdfiforeadstatus

MIL-STD-1553 Reference Manual
190
Chapter 6 – FIFO Functions
6.3 ApiCmdFifoReadStatus
Prototype:
AiInt16 ApiCmdFifoReadStatus ( AiUInt32 ul_ModuleHandle, AiUInt8 biu, AiUInt8 f_id,
AiUInt16 *status );
Driver Command:
API_FIFO_STATUS_READ (0xA2)
Purpose:
This function is used to read the status of the transmitted buffer’s of the specified
FIFO. The status value indicates the number of 16-bit words to reload. This function
may be used to reload the buffer’s of the FIFOs ( see ApiCmdFifoWrite function).
I
I
n
n
p
p
u
u
t
t
A
A
i
i
U
U
I
I
n
n
t
t
8
8
f
f
_
_
i
i
d
d
Value
Description
1..32
FIFO Identifier
O
O
u
u
t
t
p
p
u
u
t
t
A
A
i
i
U
U
I
I
n
n
t
t
1
1
6
6
*
*
s
s
t
t
a
a
t
t
u
u
s
s
Status of transmitted Buffer’s
Value
Description
0
Half buffer not yet sent
>0
Amount of 16-bit word’s to reload into
the free half buffer
0xFFFF
Reload under run
Return Value
A
A
i
i
I
I
n
n
t
t
1
1
6
6
All API functions return API_OK if no error occurred. If the return value is not equal
to API_OK the function ApiGetErrorDescription can be used to obtain an error
description.