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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChannelEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enables or Disables the specified Serial channel. Channels must be disabled before any configuration change is made, or before InitiateBIT. Channels must be enabled for the configuration changes to take effect, or after InitiateBIT is complete.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChannelEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable)
 Retrieves the state of the specified Serial channel. Channels must be disabled before any configuration change is made, or before InitiateBIT. Channels must be enabled for the configuration changes to take effect, or after InitiateBIT is complete.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetReceiverEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Sets the Receiver state for the specified Serial channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetReceiverEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable)
 Retrieves the Receiver state for the specified Serial channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_TransmitInitiate (int32_t cardIndex, int32_t module, int32_t channel)
 Initiates the serial transmission for the specified Serial channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_TransmitStop (int32_t cardIndex, int32_t module, int32_t channel)
 Stops the serial transmission for the specified Serial channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_AsyncTransmitControl (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Sets the asynchronous data transmit mode for the specified Serial channel. When this mode is enabled, data written to the transmit FIFO buffer is transmitted. Tx initiate is not necessary. For Async mode only.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetRTS (int32_t cardIndex, int32_t module, int32_t channel, bool_t active)
 Sets RTS pin state for the specified Serial channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetRTS (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outactive)
 Retrieves RTS pin state for the specified Serial channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetCTS (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outactive)
 Retrieves the CTS pin state for the specified Serial channel.
 

Detailed Description

Function Documentation

◆ naibrd_SER_AsyncTransmitControl()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_AsyncTransmitControl ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t enable )

Sets the asynchronous data transmit mode for the specified Serial channel. When this mode is enabled, data written to the transmit FIFO buffer is transmitted. Tx initiate is not necessary. For Async mode only.

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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
enable: (Input) 0 = Disable, 1 = Enable.
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_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_SER_GetChannelEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChannelEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * p_outenable )

Retrieves the state of the specified Serial channel. Channels must be disabled before any configuration change is made, or before InitiateBIT. Channels must be enabled for the configuration changes to take effect, or after InitiateBIT is complete.

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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outenable: (Output) 0 = Disable, 1 = Enable.
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_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_SER_GetCTS()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetCTS ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * p_outactive )

Retrieves the CTS pin state for the specified Serial channel.

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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outactive: (Output) 0 = Inactive, 1 = Active.
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_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_SER_GetReceiverEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetReceiverEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * p_outenable )

Retrieves the Receiver state for the specified Serial channel.

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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outenable: (Output) 0 = disable receiver, 1 = enable receiver.
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_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_SER_GetRTS()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetRTS ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * p_outactive )

Retrieves RTS pin state for the specified Serial channel.

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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outactive: (Output) 0 = Inactive, 1 = Active.
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_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_SER_SetChannelEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChannelEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t enable )

Enables or Disables the specified Serial channel. Channels must be disabled before any configuration change is made, or before InitiateBIT. Channels must be enabled for the configuration changes to take effect, or after InitiateBIT is complete.

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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
enable: (Input) 0 = Disable, 1 = Enable.
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_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_SER_SetReceiverEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetReceiverEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t enable )

Sets the Receiver state for the specified Serial channel.

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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
enable: (Input) 0 = disable receiver, 1 = enable receiver.
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_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_SER_SetRTS()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetRTS ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t active )

Sets RTS pin state for the specified Serial channel.

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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
active: (Input) 0 = Inactive, 1 = Active.
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_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_SER_TransmitInitiate()

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

Initiates the serial transmission for the specified Serial channel.

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]).
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_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_SER_TransmitStop()

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

Stops the serial transmission for the specified Serial channel.

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]).
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_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.