Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Standard Operation Functions
SCG Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_SetControl (int32_t cardIndex, int32_t module, int32_t channel, nai_scg_control_t control, bool_t enable)
 Sets the control operation for the specified SCG channel. Operations can be OR'd together to enable/disable multiple operations at once.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_GetControl (int32_t cardIndex, int32_t module, int32_t channel, nai_scg_control_t control, bool_t *p_outenable)
 Retrieves the controls' state for the specified SCG channel. Operations can be OR'd together to access multiple operations at once. A return value of TRUE indicates ALL operations specifed are enabled, FALSE indicates at least one operation specified is disabled.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_SetTxData (int32_t cardIndex, int32_t module, int32_t channel, uint32_t txData)
 Sets the data that is to be serialized and shifted out for the specified channel. Only bits B0-B16 are valid, all others are ignored. The actual data pattern that is outputted is the data in this register with a hard-coded 7 bit preamble. Data is shifted out from B16 (first) to B0 (last).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_GetTxData (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outtxData)
 Retrieves the data that is to be serialized and shifted out for the specified channel. Only bits B0-B16 are valid, all others are ignored. The actual data pattern that is outputted is the data in this register with a hard-coded 7 bit preamble. Data is shifted out from B16 (first) to B0 (last).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_GetBITStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_status_access_type_t type, bool_t *p_outBITStatus)
 Retrieves the BIT status for the specified SCG channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_ClearBITStatus (int32_t cardIndex, int32_t module, int32_t channel)
 Clears the specified latched BIT Status bits for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_GetChannelStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_status_access_type_t type, nai_scg_status_t *p_outchannelStatus)
 Retrieves the status for the specified SCG channel with the output specified as follows:
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_ClearChannelStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_scg_status_t chanStatus)
 Clears the specified latched Channel Status bits from chanStatus.
 

Detailed Description


Function Documentation

◆ naibrd_SCG_ClearBITStatus()

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

Clears the specified latched BIT Status bits for the specified 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 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_SCG_ClearChannelStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_ClearChannelStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_scg_status_t chanStatus )

Clears the specified latched Channel Status bits from chanStatus.

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]).
chanStatus: (Input) Mask of Channel Status to clear.
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_SCG_GetBITStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_GetBITStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_status_access_type_t type,
bool_t * p_outBITStatus )

Retrieves the BIT status for the specified SCG 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]).
type: (Input) The status access type to read.
p_outBITStatus: (Output) BIT Status.
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_SCG_GetChannelStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_GetChannelStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_status_access_type_t type,
nai_scg_status_t * p_outchannelStatus )

Retrieves the status for the specified SCG channel with the output specified as follows: 

  NAI_SCG_STATUS_TXBUSY            0x00000001u
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]).
type: (Input) The status access type to read.
p_outchannelStatus: (Output) Channel Status.
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_SCG_GetControl()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_GetControl ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_scg_control_t control,
bool_t * p_outenable )

Retrieves the controls' state for the specified SCG channel. Operations can be OR'd together to access multiple operations at once. A return value of TRUE indicates ALL operations specifed are enabled, FALSE indicates at least one operation specified is disabled. 

  NAI_SCG_CONTROL_TXRUN           0x00000001u
  NAI_SCG_CONTROL_CLEAR           0x00000100u
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]).
control: (Input) The control opertion(s) to enable/disable.
p_outenable: (Output) TRUE = all specified operations are enabled, FALSE = at least one specified operation is disable.
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_SCG_GetTxData()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_GetTxData ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outtxData )

Retrieves the data that is to be serialized and shifted out for the specified channel. Only bits B0-B16 are valid, all others are ignored. The actual data pattern that is outputted is the data in this register with a hard-coded 7 bit preamble. Data is shifted out from B16 (first) to B0 (last).

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_outtxData: (Output) Data that is to be shifted out.
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_SCG_SetControl()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_SetControl ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_scg_control_t control,
bool_t enable )

Sets the control operation for the specified SCG channel. Operations can be OR'd together to enable/disable multiple operations at once. 

  NAI_SCG_CONTROL_TXRUN           0x00000001u
  NAI_SCG_CONTROL_CLEAR           0x00000100u
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]).
control: (Input) The control opertion(s) to enable/disable.
enable: (Input) TRUE = enable, FALSE = disable.
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_SCG_SetTxData()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SCG_SetTxData ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t txData )

Sets the data that is to be serialized and shifted out for the specified channel. Only bits B0-B16 are valid, all others are ignored. The actual data pattern that is outputted is the data in this register with a hard-coded 7 bit preamble. Data is shifted out from B16 (first) to B0 (last).

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]).
txData: (Input) Data that is to be shifted out.
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.