Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
General Board Info Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_IsBoardReady (int32_t cardIndex)
 Indication whether the board and modules are ready to be accessed.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_GetSerialNo (int32_t cardIndex, uint32_t *p_outserialNo)
 Retrieves the serial number of the card.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_GetBoardGen (int32_t cardIndex, uint32_t *p_outboardGen)
 Retrieves the board generation.
 

Detailed Description

Function Documentation

◆ naibrd_GetBoardGen()

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

Retrieves the board generation.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
p_outboardGen: (Output) Generation of the card will be specified as one of the following: NAI_BLACKFIN_GEN2_ID, NAI_BLACKFIN_GEN3_ID, or NAI_XILINX_GEN5_ID Refer to these declarations in nai_libs\nailib\include\naidefs.h.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.

◆ naibrd_GetSerialNo()

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

Retrieves the serial number of the card.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
p_outserialNo: (Output) Serial number of the card.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.

◆ naibrd_IsBoardReady()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IsBoardReady ( int32_t cardIndex)

Indication whether the board and modules are ready to be accessed.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_READY when the board is not ready.
  • An error returned by naibrd_ReadReg32