Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Interrupt Legacy Functions
NAI Board Library - Module Functions » SER Module Functions » Serial Module Legacy Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetInterruptEnableEx (int32_t cardIndex, int32_t module, int32_t channel, uint32_t intEnable)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetInterruptEnableEx (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outIntEnable)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetInterruptEdgeLevelEx (int32_t cardIndex, int32_t module, int32_t channel, uint32_t edgeLevel)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetInterruptEdgeLevelEx (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outEdgeLevel)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetInterruptVectorEx (int32_t cardIndex, int32_t module, int32_t channel, uint32_t vector)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetInterruptVectorEx (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outvector)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetInterruptSteeringEx (int32_t cardIndex, int32_t module, int32_t channel, naibrd_int_steering_t steering)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetInterruptSteeringEx (int32_t cardIndex, int32_t module, int32_t channel, naibrd_int_steering_t *outsteering)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetInterruptEnable (int32_t cardIndex, int32_t module, nai_ser_status_type_t type, uint32_t intEnable)
 /warning This function is deprecated and has been replaced by naibrd_SER_SetEventMappedInterruptEnable().
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetInterruptEnable (int32_t cardIndex, int32_t module, nai_ser_status_type_t type, uint32_t *outIntEnable)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetInterruptEdgeLevel (int32_t cardIndex, int32_t module, nai_ser_status_type_t type, uint32_t edgeLevel)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetInterruptEdgeLevel (int32_t cardIndex, int32_t module, nai_ser_status_type_t type, uint32_t *outEdgeLevel)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetInterruptVector (int32_t cardIndex, int32_t module, nai_ser_status_type_t type, uint32_t vector)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetInterruptVector (int32_t cardIndex, int32_t module, nai_ser_status_type_t type, uint32_t *outvector)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetInterruptSteering (int32_t cardIndex, int32_t module, nai_ser_status_type_t type, naibrd_int_steering_t steering)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetInterruptSteering (int32_t cardIndex, int32_t module, nai_ser_status_type_t type, naibrd_int_steering_t *outsteering)
 

Detailed Description

Function Documentation

◆ naibrd_SER_GetInterruptEdgeLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetInterruptEdgeLevel ( int32_t cardIndex,
int32_t module,
nai_ser_status_type_t type,
uint32_t * outEdgeLevel )
Warning
This function is deprecated and has been replaced by ().

Retrieves the 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]).
type: (Input) Status Type: refer to nai_ser_status_type_t definition.
outEdgeLevel: (Output) Bit mask of the trigger Mode of interrupts (0 = EDGE, 1 = LEVEL).
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_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_GetInterruptEdgeLevelEx()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetInterruptEdgeLevelEx ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * outEdgeLevel )
Warning
This function is deprecated and has been replaced by naibrd_SER_GetEventMappedInterruptSteering().

Retrieves the 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) Bit mask of the trigger Mode of interrupts (0 = EDGE, 1 = LEVEL).
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_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_GetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetInterruptEnable ( int32_t cardIndex,
int32_t module,
nai_ser_status_type_t type,
uint32_t * outIntEnable )
Warning
This function is deprecated and has been replaced by naibrd_SER_GetEventMappedInterruptEnable().

Retrieves the Interrupt Enable register value for the specified Serial channel. Setting the bits to 1 enabled interrupts. Status is reported in the 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]).
type: (Input) Status Type: refer to nai_ser_status_type_t definition.
outIntEnable: (Output) Bit mask of interrupts to enable(1) and/or disable(0).
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_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_GetInterruptEnableEx()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetInterruptEnableEx ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * outIntEnable )
Warning
This function is deprecated and has been replaced by naibrd_SER_GetEventMappedInterruptEnable().

Retrieves the Interrupt Enable register value for the specified Serial channel. Setting the bits to 1 enabled interrupts. Status is reported in the 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) Bit mask of interrupts to enable(1) and/or disable(0).
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_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_GetInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetInterruptSteering ( int32_t cardIndex,
int32_t module,
nai_ser_status_type_t type,
naibrd_int_steering_t * outsteering )
Warning
This function is deprecated and has been replaced by naibrd_SER_GetEventMappedInterruptSteering().

Retrieves the 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]).
type: (Input) Status Type: refer to nai_ser_status_type_t definition.
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 module 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_GetInterruptSteeringEx()

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

Retrieves the 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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
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 module 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_GetInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetInterruptVector ( int32_t cardIndex,
int32_t module,
nai_ser_status_type_t type,
uint32_t * outvector )
Warning
This function is deprecated and has been replaced by naibrd_SER_GetEventMappedInterruptVector().

Retrieves the interrupt vector 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]).
type: (Input) Status Type: refer to nai_ser_status_type_t definition.
outvector: (Output) Interrupt vector.
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_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_GetInterruptVectorEx()

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

Retrieves the interrupt vector 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]).
outvector: (Output) Interrupt vector.
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_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_SetInterruptEdgeLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetInterruptEdgeLevel ( int32_t cardIndex,
int32_t module,
nai_ser_status_type_t type,
uint32_t edgeLevel )
Warning
This function is deprecated and has been replaced by naibrd_SER_SetEventMappedInterruptTriggerType().

Sets the 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]).
type: (Input) Status Type: refer to nai_ser_status_type_t definition.
edgeLevel: (Input) Bit mask of the trigger Mode for interrupts (0 = EDGE, 1 = LEVEL). Register is bit mapped to interrupt status types.
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_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_SetInterruptEdgeLevelEx()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetInterruptEdgeLevelEx ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t edgeLevel )
Warning
This function is deprecated and has been replaced by naibrd_SER_SetEventMappedInterruptSteering().

Sets the 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) Bit mask of the trigger Mode for interrupts (0 = EDGE, 1 = LEVEL). Register is bit mapped to interrupt status types.
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_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_SetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetInterruptEnable ( int32_t cardIndex,
int32_t module,
nai_ser_status_type_t type,
uint32_t intEnable )

/warning This function is deprecated and has been replaced by naibrd_SER_SetEventMappedInterruptEnable().

Sets the Interrupt Enable register value for the specified Serial channel. Setting the bits to 1 enabled interrupts. Status is reported in the 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]).
type: (Input) Status Type: refer to nai_ser_status_type_t definition.
intEnable: (Input) Bit mask of interrupts to enable(1) and/or disable(0).
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_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_SetInterruptEnableEx()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetInterruptEnableEx ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t intEnable )
Warning
This function is deprecated and has been replaced by naibrd_SER_SetEventMappedInterruptEnable().

Sets the Interrupt Enable register value for the specified Serial channel. Setting the bits to 1 enabled interrupts. Status is reported in the 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) Bit mask of interrupts to enable(1) and/or disable(0).
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_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_SetInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetInterruptSteering ( int32_t cardIndex,
int32_t module,
nai_ser_status_type_t type,
naibrd_int_steering_t steering )
Warning
This function is deprecated and has been replaced by naibrd_SER_SetEventMappedInterruptSteering().

Sets the 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]).
type: (Input) Status Type: refer to nai_ser_status_type_t definition.
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 module 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_SetInterruptSteeringEx()

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

Sets the 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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
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 module 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_SetInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetInterruptVector ( int32_t cardIndex,
int32_t module,
nai_ser_status_type_t type,
uint32_t vector )
Warning
This function is deprecated and has been replaced by naibrd_SER_SetEventMappedInterruptVector().

Sets the interrupt vector 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]).
type: (Input) Status Type: refer to nai_ser_status_type_t definition.
vector: (Input) Interrupt vector.
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_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_SetInterruptVectorEx()

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

Sets the interrupt vector 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]).
vector: (Input) Interrupt vector.
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_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.