Board Information Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_GetSerialNo (int32_t cardIndex, uint32_t *sn)
	Gets the serial number of the card.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_GetDateCode (int32_t cardIndex, uint32_t *dateCode)
	Gets the date code of the card.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_GetPartNo (int32_t cardIndex, uint32_t *pn)
	Gets the part number of the card.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_GetCardInfo (int32_t cardIndex, uint32_t *platform, uint32_t *model, uint32_t *gen, uint32_t *ver, uint32_t *special)
	Gets card information details.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_GetCardRev (int32_t cardIndex, uint32_t *pcbrev, uint32_t *procrev, uint32_t *fpgarev)
	Gets card information details.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_GetDeviceID (int32_t cardIndex, uint32_t *devid)
	Gets the device ID of the board, where the upper 16 bits are the generation and the lower 16 bits are the model.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_GetOffBoardCfgInfo (int32_t cardIndex, uint32_t offBdIdx, uint32_t *address, uint32_t *size, uint32_t *deviceId)
	Gets the off-board configuration from the card.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_GetBoardGen (int32_t cardIndex, uint32_t *boardgen)
	Gets the HW Generation of the card.

Detailed Description

Function Documentation

naibrd_GetBoardGen()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetBoardGen	(	int32_t	cardIndex,
		uint32_t *	boardgen )

Gets the HW Generation of the card.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
boardgen	: (Output) The HW Generation of the card. This value will be one of the following: NAI_BLACKFIN_GEN2_ID, NAI_BLACKFIN_GEN3_ID, or NAI_XILINX_GEN5_ID

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_NOT_OPEN when handle to board is invalid.

naibrd_GetCardInfo()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetCardInfo	(	int32_t	cardIndex,
		uint32_t *	platform,
		uint32_t *	model,
		uint32_t *	gen,
		uint32_t *	ver,
		uint32_t *	special )

Gets card information details.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
platform	: (Output) The platform ID of the card.
model	: (Output) The model ID of the card.
gen	: (Output) The generation ID of the card.
ver	: (Output) The version ID of the card.
special	: (Output) The special code of the card.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_NOT_OPEN when handle to board is invalid.

naibrd_GetCardRev()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetCardRev	(	int32_t	cardIndex,
		uint32_t *	pcbrev,
		uint32_t *	procrev,
		uint32_t *	fpgarev )

Gets card information details.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
pcbrev	: (Output) The PCB revision of the card.
procrev	: (Output) The master processor ID of the card. (Note: This parameter is not supported on Gen 5 cards).
fpgarev	: (Output) The interface FPGA ID of the card.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_NOT_OPEN when handle to board is invalid.

naibrd_GetDateCode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetDateCode	(	int32_t	cardIndex,
		uint32_t *	dateCode )

Gets the date code of the card.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
dateCode	: (Output) The date code of the card.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_NOT_OPEN when handle to board is invalid.

naibrd_GetDeviceID()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetDeviceID	(	int32_t	cardIndex,
		uint32_t *	devid )

Gets the device ID of the board, where the upper 16 bits are the generation and the lower 16 bits are the model.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
devid	: (Output) The device ID.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_NOT_OPEN when handle to board is invalid.

naibrd_GetOffBoardCfgInfo()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetOffBoardCfgInfo	(	int32_t	cardIndex,
		uint32_t	offBdIdx,
		uint32_t *	address,
		uint32_t *	size,
		uint32_t *	deviceId )

Gets the off-board configuration from the card.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
offBdIdx	: (Input) off-board card index.
address	: (Output) Base memory addres of the off-board card.
size	: (Output) Memory size occupied by the off-board card.
deviceId	: (Output) The device ID of the off-board card.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_NOT_OPEN when handle to board is invalid.

naibrd_GetPartNo()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetPartNo	(	int32_t	cardIndex,
		uint32_t *	pn )

Gets the part number of the card.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
pn	: (Output) The part number of the card.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_NOT_OPEN when handle to board is invalid.

naibrd_GetSerialNo()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetSerialNo	(	int32_t	cardIndex,
		uint32_t *	sn )

Gets the serial number of the card.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
sn	: (Output) The serial number of the card.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_NOT_OPEN when handle to board is invalid.