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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetDataBits (int32_t cardIndex, int32_t module, int32_t channel, uint8_t dataBits)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetDataBits (int32_t cardIndex, int32_t module, int32_t channel, uint8_t *p_outdataBits)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetStopBits (int32_t cardIndex, int32_t module, int32_t channel, uint8_t stopBits)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetStopBits (int32_t cardIndex, int32_t module, int32_t channel, uint8_t *p_outstopBits)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetClockMode (int32_t cardIndex, int32_t module, int32_t channel, uint32_t clockMode)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetClockMode (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outclockMode)
 

Detailed Description

Function Documentation

◆ naibrd_SER_GetClockMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetClockMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outclockMode )
Warning
This function is deprecated and has been replaced with naibrd_SER_GetSyncClockMode().

Retrieves the raw clock mode 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_outclockMode: (Output) Clock Mode, see below. 
0   -   TXINT_RXINT
1   -   TXEXT_RXEXT
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_GetDataBits()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetDataBits ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint8_t * p_outdataBits )
Warning
This function is deprecated and has been replaced with naibrd_SER_GetNumDataBits().

Retrieves the Number of Data Bits in the Data Configuration 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_outdataBits: (Output) Number of Data Bits (5, 6, 7, 8, or 9).
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_GetStopBits()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetStopBits ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint8_t * p_outstopBits )
Warning
This function is deprecated and has been replaced with naibrd_SER_SetNumStopBits().

Retrieves the Number of Stop Bits in the Data Configuration 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_outstopBits: (Output) Number of Stop Bits to set (1 or 2).
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_SetClockMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetClockMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t clockMode )
Warning
This function is deprecated and has been replaced with naibrd_SER_SetSyncClockMode().

Sets the raw clock mode 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]).
clockMode: (Input) Clock Mode, see below. 
0   -   TXINT_RXINT
1   -   TXEXT_RXEXT
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_SetDataBits()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetDataBits ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint8_t dataBits )
Warning
This function is deprecated and has been replaced by naibrd_SER_SetNumDataBits().

Sets the Number of Data Bits in the Data Configuration for the specified Serial channel. In sync modes, number of data bits is set to 8 and cannot be changed.

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]).
dataBits: (Input) Number of Data Bits (5, 6, 7, 8, or 9).
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_SetStopBits()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetStopBits ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint8_t stopBits )
Warning
This function is deprecated and has been replaced with naibrd_SER_SetNumStopBits().

Sets the Number of Stop Bits in the Data Configuration 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]).
stopBits: (Input) Number of Stop Bits to set (1 or 2).
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.