Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Channel Control Functions
NAI Board Library - Module Functions » AR Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ResetModule (int32_t cardIndex, int32_t module)
 Resets the module specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ChannelReset (int32_t cardIndex, int32_t module, int32_t channel)
 Clears out Channel Control Low and Interrupt Enable registers as well as reset the transmit and receive circuits. (This will NOT reset the channel Transmit FIFO Rate, Tx Buffer Almost Empty, and Rx Buffer Almost Full registers)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ClearRxFifo (int32_t cardIndex, int32_t module, int32_t channel)
 Clears the receive FIFO for the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ClearTxFifo (int32_t cardIndex, int32_t module, int32_t channel)
 Clears the transmit FIFO for the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxSendTrigger (int32_t cardIndex, int32_t module, int32_t channel)
 Sets the transmit trigger for the channel specified, triggering a scheduled or trigger fifo operation. This bit is reset by the hardware.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxPause (int32_t cardIndex, int32_t module, int32_t channel)
 Pauses the transmitter for the channel specified after the current word and gap time has finished transmitting. To resume, issue Transmit Trigger command or issue a Transmit Stop command to halt transmission.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxStop (int32_t cardIndex, int32_t module, int32_t channel)
 Stops the transmitter for the channel specified after the current word and gap time has finished transmitting. Also, clears the FIFO.
 

Detailed Description

Function Documentation

◆ naibrd_AR_ChannelReset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ChannelReset ( int32_t cardIndex,
int32_t module,
int32_t channel )

Clears out Channel Control Low and Interrupt Enable registers as well as reset the transmit and receive circuits. (This will NOT reset the channel Transmit FIFO Rate, Tx Buffer Almost Empty, and Rx Buffer Almost Full registers)

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

◆ naibrd_AR_ClearRxFifo()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ClearRxFifo ( int32_t cardIndex,
int32_t module,
int32_t channel )

Clears the receive FIFO for the channel specified.

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

◆ naibrd_AR_ClearTxFifo()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ClearTxFifo ( int32_t cardIndex,
int32_t module,
int32_t channel )

Clears the transmit FIFO for the channel specified.

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

◆ naibrd_AR_ResetModule()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_ResetModule ( int32_t cardIndex,
int32_t module )

Resets the module specified.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect 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 module parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_SetTxPause()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxPause ( int32_t cardIndex,
int32_t module,
int32_t channel )

Pauses the transmitter for the channel specified after the current word and gap time has finished transmitting. To resume, issue Transmit Trigger command or issue a Transmit Stop command to halt transmission.

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

◆ naibrd_AR_SetTxSendTrigger()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxSendTrigger ( int32_t cardIndex,
int32_t module,
int32_t channel )

Sets the transmit trigger for the channel specified, triggering a scheduled or trigger fifo operation. This bit is reset by the hardware.

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

◆ naibrd_AR_SetTxStop()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxStop ( int32_t cardIndex,
int32_t module,
int32_t channel )

Stops the transmitter for the channel specified after the current word and gap time has finished transmitting. Also, clears the FIFO.

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