Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Raw Register Access Functions
Serial Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChannelConfigRaw (int32_t cardIndex, int32_t module, int32_t channel, uint32_t configRaw)
 Sets the raw channel configuration for the specified Serial channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChannelConfigRaw (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outconfigRaw)
 Retrieves the raw channel configuration for the specified Serial channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetDataConfigRaw (int32_t cardIndex, int32_t module, int32_t channel, uint32_t dataConfigRaw)
 Sets the raw data configuration for the specified Serial channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetDataConfigRaw (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outdataConfigRaw)
 Retrieves the raw data configuration for the specified Serial channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChannelControlRaw (int32_t cardIndex, int32_t module, int32_t channel, uint32_t chanCtrlRaw)
 Sets the raw channel control configuration for the specified Serial channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChannelControlRaw (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *chanCtrlRaw)
 Retrieves the raw channel control configuration for the specified Serial channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetControlExtRaw (int32_t cardIndex, int32_t module, int32_t channel, uint32_t controlExtRaw)
 Sets the raw extended channel control configuration for the specified Serial channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetControlExtRaw (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outcontrolExtRaw)
 Retrieves the raw extended channel control configuration for the specified Serial channel.
 

Detailed Description


Function Documentation

◆ naibrd_SER_GetChannelConfigRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChannelConfigRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * outconfigRaw )

Retrieves the raw channel 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]).
outconfigRaw: (Output) Channel configuration bits.
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_SER_GetChannelControlRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChannelControlRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * chanCtrlRaw )

Retrieves the raw channel control 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]).
chanCtrlRaw: (Output) Channel Control bits.
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_SER_GetControlExtRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetControlExtRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * outcontrolExtRaw )

Retrieves the raw extended channel control 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]).
outcontrolExtRaw: (Output) Channel Control Extended bits.
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_SER_GetDataConfigRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetDataConfigRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * outdataConfigRaw )

Retrieves the raw 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]).
outdataConfigRaw: (Output) Data Configuration bits.
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_SER_SetChannelConfigRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChannelConfigRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t configRaw )

Sets the raw channel 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]).
configRaw: (Input) Channel configuration bits.
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_SER_SetChannelControlRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChannelControlRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t chanCtrlRaw )

Sets the raw channel control 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]).
chanCtrlRaw: (Input) Channel Control bits.
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_SER_SetControlExtRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetControlExtRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t controlExtRaw )

Sets the raw extended channel control 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]).
controlExtRaw: (Input) Channel Control Extended bits.
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_SER_SetDataConfigRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetDataConfigRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t dataConfigRaw )

Sets the raw 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]).
dataConfigRaw: (Input) Data Configuration bits.
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.