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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetControlRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_ctrl_t control)
 Sets the control register of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetControlRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_ctrl_t *outcontrol)
 Reads the control register of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxControlRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_ctrl_t control)
 Sets the Tx control register of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTxControlRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_ctrl_t *outcontrol)
 Reads the Tx control register of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxControlRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_ctrl_t control)
 Sets the Rx control register of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxControlRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_ctrl_t *outcontrol)
 Reads the Rx control register of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetConfigRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_ctrl_t config)
 Sets the Rx configuration register of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetConfigRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ar_ctrl_t *outconfig)
 Reads the Rx Configuration register of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTimeCtrlRaw (int32_t cardIndex, int32_t module, nai_ar_tstamp_t value)
 Sets the time stamp control register for the module specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTimeCtrlRaw (int32_t cardIndex, int32_t module, nai_ar_tstamp_t *outvalue)
 Reads the time stamp control register for the module specified.
 

Detailed Description


Function Documentation

◆ naibrd_AR_GetConfigRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetConfigRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ar_ctrl_t * outconfig )

Reads the Rx Configuration register of the specified channel.

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]).
outconfig: (Output) 32-bit Config word.
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_GetControlRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetControlRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ar_ctrl_t * outcontrol )

Reads the control register of the specified channel.

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]).
outcontrol: (Output) 32-bit Control word.
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_GetRxControlRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetRxControlRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ar_ctrl_t * outcontrol )

Reads the Rx control register of the specified channel.

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]).
outcontrol: (Output) 32-bit Control word.
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_GetTimeCtrlRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTimeCtrlRaw ( int32_t cardIndex,
int32_t module,
nai_ar_tstamp_t * outvalue )

Reads the time stamp control register for 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]).
outvalue: (Output) Value read from the register.
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_GetTxControlRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetTxControlRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ar_ctrl_t * outcontrol )

Reads the Tx control register of the specified channel.

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]).
outcontrol: (Output) 32-bit Control word.
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_SetConfigRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetConfigRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ar_ctrl_t config )

Sets the Rx configuration register of the specified channel.

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]).
config: (Input) 32-bit Config word.
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_SetControlRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetControlRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ar_ctrl_t control )

Sets the control register of the specified channel.

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]).
control: (Input) 32-bit Control word.
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_SetRxControlRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetRxControlRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ar_ctrl_t control )

Sets the Rx control register of the specified channel.

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]).
control: (Input) 32-bit Control word.
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_SetTimeCtrlRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTimeCtrlRaw ( int32_t cardIndex,
int32_t module,
nai_ar_tstamp_t value )

Sets the time stamp control register for 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]).
value: (Input) Value to be written.
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_SetTxControlRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetTxControlRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ar_ctrl_t control )

Sets the Tx control register of the specified channel.

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]).
control: (Input) 32-bit Control word.
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.