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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetBITStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ser_status_access_type_t type, bool_t *outBitStatus)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_ClearBITStatus (int32_t cardIndex, int32_t module, int32_t channel)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetBITInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t intEnable)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetBITInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outIntEnable)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetBITInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, bool_t edgeLevel)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetBITInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outEdgeLevel)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetBITInterruptVector (int32_t cardIndex, int32_t module, uint32_t vector)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetBITInterruptVector (int32_t cardIndex, int32_t module, uint32_t *outvector)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetBITInterruptSteering (int32_t cardIndex, int32_t module, naibrd_int_steering_t steering)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetBITInterruptSteering (int32_t cardIndex, int32_t module, naibrd_int_steering_t *outsteering)
 

Detailed Description


Function Documentation

◆ naibrd_SER_ClearBITStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_ClearBITStatus ( int32_t cardIndex,
int32_t module,
int32_t channel )
Warning
This function is deprecated and has been replaced by naibrd_SER_ClearChannelMappedStatus().

Clears the latched BIT status of the channel 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]).
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_GetBITInterruptEdgeLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetBITInterruptEdgeLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * outEdgeLevel )
Warning
This function is deprecated and has been replaced by naibrd_SER_GetChannelMappedInterruptTriggerType().

Retrieves the BIT Interrupt Edge/Level register value 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]).
outEdgeLevel: (Output) 0 = EDGE, 1 = LEVEL.
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_GetBITInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetBITInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * outIntEnable )
Warning
This function is deprecated and has been replaced by naibrd_SER_GetChannelMappedInterruptEnable().

Retrieves the BIT Interrupt Enable register value for the specified Serial channel. Setting the bits to 1 enabled interrupts. Status is reported in the BIT Interrupt Status register.

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]).
outIntEnable: (Output) enable(1) or disable(0).
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_GetBITInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetBITInterruptSteering ( int32_t cardIndex,
int32_t module,
naibrd_int_steering_t * outsteering )
Warning
This function is deprecated and has been replaced by naibrd_SER_GetChannelMappedInterruptSteering().

Retrieves the BIT Interrupt Steering which indicates the interrupt direction 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]).
outsteering: (Output) Interrupt Steering: refer to naibrd_int_steering_t definition.
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_VALUE when invalid group register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SER_GetBITInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetBITInterruptVector ( int32_t cardIndex,
int32_t module,
uint32_t * outvector )
Warning
This function is deprecated and has been replaced by naibrd_SER_GetChannelMappedInterruptVector().

Retrieves the BIT interrupt vector for the specified Serial module.

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]).
outvector: (Output) Interrupt vector.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_SER_GetBITStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetBITStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ser_status_access_type_t type,
bool_t * outBitStatus )
Warning
This function is deprecated and has been replaced by naibrd_SER_GetChannelMappedStatus().

Retrieves the BIT status of the channel 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) The status access type to read.
outBitStatus: (Output) Channel BIT Status (0 = pass, 1 = fail).
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_SetBITInterruptEdgeLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetBITInterruptEdgeLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t edgeLevel )
Warning
This function is deprecated and has been replaced by naibrd_SER_SetChannelMappedInterruptTriggerType().

Sets the BIT Interrupt Edge/Level register value 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]).
edgeLevel: (Input) 0 = EDGE, 1 = LEVEL.
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_SetBITInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetBITInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t intEnable )
Warning
This function is deprecated and has been replaced by naibrd_SER_SetChannelMappedInterruptEnable().

Sets the BIT Interrupt Enable register value for the specified Serial channel. Setting the bits to 1 enabled interrupts. Status is reported in the BIT Interrupt Status register.

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]).
intEnable: (Input) enable(1) or disable(0).
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_SetBITInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetBITInterruptSteering ( int32_t cardIndex,
int32_t module,
naibrd_int_steering_t steering )
Warning
This function is deprecated and has been replaced by naibrd_SER_SetChannelMappedInterruptSteering().

Sets the BIT Interrupt Steering which indicates the interrupt direction 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]).
steering: (Input) Interrupt Steering: refer to naibrd_int_steering_t definition.
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_VALUE when invalid group register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SER_SetBITInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetBITInterruptVector ( int32_t cardIndex,
int32_t module,
uint32_t vector )
Warning
This function is deprecated and has been replaced by naibrd_SER_SetChannelMappedInterruptVector().

Sets the BIT interrupt vector for the specified Serial module.

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]).
vector: (Input) Interrupt vector.
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_NOT_SUPPORTED when function is not supported.