Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Raw Register Access Functions
NAI Board Library - Module Functions » TC Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_channel_raw_t type, uint32_t rawdata)
 Sets the raw data value in the register associated with the channel and channel register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_channel_raw_t type, uint32_t *p_outrawdata)
 Retrieves the raw data value in the register associated with the channel and channel register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetStatusRaw (int32_t cardIndex, int32_t module, naibrd_tc_chan_mapped_status_type_t type, uint32_t *p_outstatusraw)
 Retrieves the raw status value in the register associated with the status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_ClearStatusRaw (int32_t cardIndex, int32_t module, naibrd_tc_chan_mapped_status_type_t type, uint32_t clearstatusraw)
 Clears the status for the channels specified (bit-masked) of the status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_SetInterruptEnableRaw (int32_t cardIndex, int32_t module, naibrd_tc_chan_mapped_status_type_t type, uint32_t statusintenab)
 Sets the raw interrupt enable data value in the register associated with the status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetInterruptEnableRaw (int32_t cardIndex, int32_t module, naibrd_tc_chan_mapped_status_type_t type, uint32_t *p_outstatusintenab)
 Retrieves the raw interrupt enable data value in the register associated with the status type specified.
 

Detailed Description

Function Documentation

◆ naibrd_TC_ClearStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_ClearStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_tc_chan_mapped_status_type_t type,
uint32_t clearstatusraw )

Clears the status for the channels specified (bit-masked) of the status type specified.

Note: The background BIT test runs at intervals of up to 2 minutes, and the BIT Status is only updated at these intervals.

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]).
type: (Input) Status Type : refer to nai_tc_status_type_t definition
clearstatusraw: (Input) Raw Data Code
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_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TC_GetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_tc_channel_raw_t type,
uint32_t * p_outrawdata )

Retrieves the raw data value in the register associated with the channel and channel register type specified.

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) Channel Register Type : refer to nai_tc_channel_raw_t definition.
p_outrawdata: (Output) Raw Data Code.
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_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TC_GetInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
naibrd_tc_chan_mapped_status_type_t type,
uint32_t * p_outstatusintenab )

Retrieves the raw interrupt enable data value in the register associated with the status type specified.

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]).
type: (Input) Status Type : refer to nai_tc_status_type_t definition
p_outstatusintenab: (Output) Raw Data Code
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_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TC_GetStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_tc_chan_mapped_status_type_t type,
uint32_t * p_outstatusraw )

Retrieves the raw status value in the register associated with the status type specified.

Note: The background BIT test runs at intervals of up to 2 minutes, and the BIT Status is only updated at these intervals.

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]).
type: (Input) Status Type : refer to nai_tc_status_type_t definition
p_outstatusraw: (Output) Raw Data Code
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_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TC_SetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_SetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_tc_channel_raw_t type,
uint32_t rawdata )

Sets the raw data value in the register associated with the channel and channel register type specified.

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) Channel Register Type : refer to nai_tc_channel_raw_t definition.
rawdata: (Input) Raw Data Code.
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_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TC_SetInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_SetInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
naibrd_tc_chan_mapped_status_type_t type,
uint32_t statusintenab )

Sets the raw interrupt enable data value in the register associated with the status type specified.

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]).
type: (Input) Status Type : refer to nai_tc_status_type_t definition
statusintenab: (Input) Raw Data Code.
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_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.