Software Library API naibrd 1.62
See all documentation at naii.docs.com
Setup Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_ClockInitiate (int32_t cardIndex, int32_t module)
 Initiates clock for specified DIF CTS module and is needed to start receiving events. Only the control module needs to be initialized.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_SetSwitchDefVal (int32_t cardIndex, int32_t module, uint32_t defaultValue)
 Sets the CIA Switch default value for specified DIF CTS Module. Value written to this register is driven to the output upon flushing the queue.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_GetSwitchDefVal (int32_t cardIndex, int32_t module, uint32_t *outdefaultValue)
 Gets the CIA Switch default value for specified DIF CTS Module. Value written to this register is driven to the output upon flushing the queue.
 

Detailed Description


Function Documentation

◆ naibrd_DIF_CTS_ClockInitiate()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_ClockInitiate ( int32_t cardIndex,
int32_t module )

Initiates clock for specified DIF CTS module and is needed to start receiving events. Only the control module needs to be initialized.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_CTS_GetSwitchDefVal()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_GetSwitchDefVal ( int32_t cardIndex,
int32_t module,
uint32_t * outdefaultValue )

Gets the CIA Switch default value for specified DIF CTS Module. Value written to this register is driven to the output upon flushing the queue.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
outdefaultValue: (Output) Default value for outputs when flush queue is called.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DIF_CTS_SetSwitchDefVal()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_SetSwitchDefVal ( int32_t cardIndex,
int32_t module,
uint32_t defaultValue )

Sets the CIA Switch default value for specified DIF CTS Module. Value written to this register is driven to the output upon flushing the queue.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
defaultValue: (Input) Default value for outputs when flush queue is called.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.