Aim MIL-STD-1553 - Apicmdsysgetboardinfo

MIL-STD-1553 Reference Manual
101
Chapter 3 – System Functions
3.1.19 ApiCmdSysGetBoardInfo
Prototype:
AiInt16 ApiCmdSysGetBoardInfo( AiUInt32 ulModHandle, AiUInt32 ulDataStart,
AiUInt32 ulDataCount, AiUInt32 * ulOutput );
Purpose:
This function can be used to get information about the board from the target software.
The interpretation of the fields is analog to the function ApiGetBoardInfo description.
Input
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
S
S
t
t
a
a
r
r
t
t
Identifies the first board information element to read.
Define
Interpretations
TY_BOARD_INFO_DEVICE_TYPE
ul_DeviceType
TY_BOARD_INFO_CHANNEL_COUNT
ul_NumberOfChannels
TY_BOARD_INFO_BIU_COUNT
ul_NumberOfBiu
TY_BOARD_INFO_BOARD_TYPE
ul_NovRamBoardType
TY_BOARD_INFO_BOARD_CONFIG
ul_NovRamBoardConfig
TY_BOARD_INFO_SERIAL
ul_SerialNumber
TY_BOARD_INFO_PARTNO
Partnumber
TY_BOARD_INFO_SIZE_GLOBAL
Size of the global RAM
TY_BOARD_INFO_SIZE_SHARED
Size of the shared RAM
TY_BOARD_INFO_OFFS_GLOBAL
Global RAM offset for second PBI
TY_BOARD_INFO_CHANGE_AMPL
ul_CanChangeAmplitude
TY_BOARD_INFO_COUPLING
TY_COUPLING_CAPABILITIES
TY_BOARD_INFO_IRIG
TY_IRIG_CAPABILITIES
TY_BOARD_INFO_DISCRETE_CNT
Number of discretes available
TY_BOARD_INFO_DISCRETE_CONFIG
Configuration of discretes
TY_BOARD_INFO_IR
Reserved for interrupts on gpio
TY_BOARD_INFO_IS_MULTI_CHANNEL
This value is 1 for multichannel FW
TY_BOARD_INFO_IS_HS_REDUNDANT
This value is 1 if HS channel B is
not available.
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
C
C
o
o
u
u
n
n
t
t
Defines the number of board information elements to read. This value is in the range
from 1 to TY_BOARD_INFO_MAX.
Output
A
A
i
i
U
U
I
I
n
n
t
t
3
3
2
2
*
*
u
u
l
l
O
O
u
u
t
t
p
p
u
u
t
t
This array must be preallocated with the size of ulDataCount. This array contains
the requested values.
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.