Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Board Master/Slave Functions
NAI Board Library - Board Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SetMaster (int32_t cardIndex, int32_t masterCardIndex)
 Specifies another card as the card's master, sending all Ethernet I/O operations though the master card.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_GetMasterInfo (int32_t cardIndex, int32_t *p_outmasterCardIndex, nai_comm_t *p_outcomm)
 Retrieves info about a potential master card. If the card (specified by cardIndex) is a slave card, p_outmasterCardIndex and p_outcomm will return info about the master card. If the card (specified by cardIndex) is not a slave, it will return info about itself.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AdjTargetAddr (int32_t masterCardIdx, int32_t slaveCardIdx, uint32_t *p_inoutaddress)
 Adjusts the slaves address for a master/slave ethernet/PCI configuration. If masterCardIdx equals slaveCardIdx, then there is no no master/slave configuration and we return the address in p_inoutaddress unmodified. If the two indexes differ, than we fetch and add the correct offset to the address from the off-board configuration.
 
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_SetAddress (int32_t cardIndex, uint32_t address)
 Sets the address to communicate with the card using another card as a master.
 

Detailed Description

Function Documentation

◆ naibrd_AdjTargetAddr()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AdjTargetAddr ( int32_t masterCardIdx,
int32_t slaveCardIdx,
uint32_t * p_inoutaddress )

Adjusts the slaves address for a master/slave ethernet/PCI configuration. If masterCardIdx equals slaveCardIdx, then there is no no master/slave configuration and we return the address in p_inoutaddress unmodified. If the two indexes differ, than we fetch and add the correct offset to the address from the off-board configuration.

Parameters
masterCardIdx: (Input) Logical Card Index assigned to the master board (0 - NAI_MAX_CARDS-1).
slaveCardIdx: (Input) Logical Card Index assigned to the slave board (0 - NAI_MAX_CARDS-1).
p_inoutaddress: (Input/Output) The address to be adjusted. If masterCardIdx equals slaveCardIdx, p_inoutaddress is not modified.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_GetMasterInfo()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetMasterInfo ( int32_t cardIndex,
int32_t * p_outmasterCardIndex,
nai_comm_t * p_outcomm )

Retrieves info about a potential master card. If the card (specified by cardIndex) is a slave card, p_outmasterCardIndex and p_outcomm will return info about the master card. If the card (specified by cardIndex) is not a slave, it will return info about itself.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
p_outmasterCardIndex: (Output) Logical Card Index of the Master, if one is present. If no master is present, this value is set to cardIndex.
p_outcomm: (Output) Communication type of the Master, if one is present. If no master is present, this value is set to the communication type associated with cardIndex.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ 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 address 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_SetAddress()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SetAddress ( int32_t cardIndex,
uint32_t address )

Sets the address to communicate with the card using another card as a master.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
address: (Input) Start address of the card.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SetMaster()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SetMaster ( int32_t cardIndex,
int32_t masterCardIndex )

Specifies another card as the card's master, sending all Ethernet I/O operations though the master card.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
masterCardIndex: (Input) Logical Card Index assigned to the connection with the master card.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.