Aim MIL-STD-1553 - Apicmdtimerintrcheck

MIL-STD-1553 Reference Manual
118
Chapter 3 – System Functions
3.1.26 ApiCmdTimerIntrCheck
Prototype:
AiInt16 ApiCmdTimerIntrCheck ( AiUInt32 ul_ModuleHandle, AiUInt8 tmr,
AiUInt32 *stat );
Driver Command:
API_TIMER_INTR_STATUS (0x3B)
Purpose:
This function is used to read the interrupt status of the selected Software Timer. (refer
to function ApiCmdPSCTimerCon).
Note: this function is not supported for all boards. Please see Table B-III – Function
Support By Boards With ASP for details
Input
A
A
i
i
U
U
I
I
n
n
t
t
8
8
t
t
m
m
r
r
Timer number
Value
Constant
Description
0
API_TIMER_1
Timer/Counter 0
1
API_TIMER_2
Timer/Counter 1
2
API_TIMER_3
Timer/Counter 2
3
API_TIMER_4
Timer/Counter 3
Output
A
A
i
i
U
U
I
I
n
n
t
t
3
3
2
2
*
*
s
s
t
t
a
a
t
t
Interrupt counter, number of occurred Timer interrupt events between
two consecutive calls of this function
Value
Constant
Description
0
API_NO_INT_OCCURED
No interrupt event occured
>0
Count of interrupt events (set to 0 after
calling this function !)
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.
Note: The number of valid Timer Interrupt events is equal to the returned stat value.
The number of interrupt events is cleared with every call of this function.