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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChannelMappedStatus (int32_t cardIndex, int32_t module, nai_ser_chan_mapped_status_type_t statusType, uint32_t *outstatus)
 Retrieves either the BIT status or Summary (Receive Data Available) status for the module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_ClearChannelMappedStatus (int32_t cardIndex, int32_t module, nai_ser_chan_mapped_status_type_t statusType, uint32_t inStatus)
 Clears the latched BIT status or latched Summary (Rx Data Available) status.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChannelMappedInterruptEnable (int32_t cardIndex, int32_t module, nai_ser_chan_mapped_status_type_t statusType, uint32_t intEnable)
 Sets the Interrupt Enable register value for the specified statusType. Setting any of the bits to a (1) enables the interrupt on the channel in that bit position.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChannelMappedInterruptEnable (int32_t cardIndex, int32_t module, nai_ser_chan_mapped_status_type_t statusType, uint32_t *outIntEnable)
 Gets the Interrupt Enable register value for the specified statusType. A (1) indicates the interrupt is enabled for that channel, a (0) indicates it is not set. Each bit represents a channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChannelMappedInterruptTriggerType (int32_t cardIndex, int32_t module, nai_ser_chan_mapped_status_type_t statusType, uint32_t triggerType)
 Sets the Interrupt trigger type (edge/level) register value for the specified statusType. Setting any of the bits to a (0) sets the trigger type to edge, setting any of the bits to a (1) sets the trigger type to level. Each bit represents a channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChannelMappedInterruptTriggerType (int32_t cardIndex, int32_t module, nai_ser_chan_mapped_status_type_t statusType, uint32_t *outTriggerType)
 Gets the Interrupt trigger type (edge/level) register value for the specified statusType. A (0) indicates the trigger type is set to edge for that channel, a (1) indicates the trigger type is set to level. Each bit represents a channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChannelMappedInterruptVector (int32_t cardIndex, int32_t module, nai_ser_chan_mapped_status_type_t statusType, uint32_t vector)
 Sets the interrupt vector for the specified statusType interrupt.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChannelMappedInterruptVector (int32_t cardIndex, int32_t module, nai_ser_chan_mapped_status_type_t statusType, uint32_t *outVector)
 Gets the interrupt vector for the specified statusType interrupt.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChannelMappedInterruptSteering (int32_t cardIndex, int32_t module, nai_ser_chan_mapped_status_type_t statusType, naibrd_int_steering_t steering)
 Sets the interrupt steering for the specified statusType interrupt, this specifies the interrupt direction for each interrupt.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChannelMappedInterruptSteering (int32_t cardIndex, int32_t module, nai_ser_chan_mapped_status_type_t statusType, naibrd_int_steering_t *outSteering)
 Gets the interrupt steering for the specified statusType interrupt, this specifies the interrupt direction for each interrupt.
 

Detailed Description


Function Documentation

◆ naibrd_SER_ClearChannelMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_ClearChannelMappedStatus ( int32_t cardIndex,
int32_t module,
nai_ser_chan_mapped_status_type_t statusType,
uint32_t inStatus )

Clears the latched BIT status or latched Summary (Rx Data Available) status.

Note
Only latched statuses can be cleared. If a realtime status is passed in for statusType, the function will return NAI_ERROR_INVALID_VALUE.
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]).
statusType: (Input) The latched channel mapped status to clear: BIT or Summary.
inStatus: (Input) Mask of channels 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_VALUE if a realtime status parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SER_GetChannelMappedInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChannelMappedInterruptEnable ( int32_t cardIndex,
int32_t module,
nai_ser_chan_mapped_status_type_t statusType,
uint32_t * outIntEnable )

Gets the Interrupt Enable register value for the specified statusType. A (1) indicates the interrupt is enabled for that channel, a (0) indicates it is not set. Each bit represents a channel.

Note
Our interrupts are fired from the latched status, regardless if the user selects realtime or latched for the statusType parameter.
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]).
statusType: (Input) The type of interrupt to enable.
statusType: (Input) The type of interrupt to retrieve.
outIntEnable: (Output) Bitmask of channels that have interrupts enabled.
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_GetChannelMappedInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChannelMappedInterruptSteering ( int32_t cardIndex,
int32_t module,
nai_ser_chan_mapped_status_type_t statusType,
naibrd_int_steering_t * outSteering )

Gets the interrupt steering for the specified statusType interrupt, this specifies the interrupt direction for each interrupt.

Note
Our interrupts are fired from the latched status, regardless if the user selects realtime or latched for the statusType parameter.
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]).
statusType: (Input) The type of interrupt to enable.
outSteering: (Output) Interrupt steering. Refer to naibrd_int_steering_t
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_GetChannelMappedInterruptTriggerType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChannelMappedInterruptTriggerType ( int32_t cardIndex,
int32_t module,
nai_ser_chan_mapped_status_type_t statusType,
uint32_t * outTriggerType )

Gets the Interrupt trigger type (edge/level) register value for the specified statusType. A (0) indicates the trigger type is set to edge for that channel, a (1) indicates the trigger type is set to level. Each bit represents a channel.

Note
Our interrupts are fired from the latched status, regardless if the user selects realtime or latched for the statusType parameter.
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]).
statusType: (Input) The type of interrupt to get the trigger type of.
outTriggerType: (Output) Bitmask of the channels trigger type. (0) for edge, (1) for 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_NOT_SUPPORTED when function is not supported.

◆ naibrd_SER_GetChannelMappedInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChannelMappedInterruptVector ( int32_t cardIndex,
int32_t module,
nai_ser_chan_mapped_status_type_t statusType,
uint32_t * outVector )

Gets the interrupt vector for the specified statusType interrupt.

Note
Our interrupts are fired from the latched status, regardless if the user selects realtime or latched for the statusType parameter.
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]).
statusType: (Input) The type of interrupt to get the vector of.
outVector: (Output) Unique interrupt vector to be used to identify the interrupt in the Interrupt Service Routine (ISR).
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_GetChannelMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChannelMappedStatus ( int32_t cardIndex,
int32_t module,
nai_ser_chan_mapped_status_type_t statusType,
uint32_t * outstatus )

Retrieves either the BIT status or Summary (Receive Data Available) status for the module.

Note
For modules that don't support the Summary status, this function will grab the information from the channel 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]).
statusType: (Input) The channel mapped status to read: BIT realtime/latched or Summary realtime/latched.
outstatus: (Output) BIT status for the module (0 = PASS, 1 = FAIL) or Receive Data Available Status (0 = No data, 1 = Rx Data Available). Values are bit-mapped by channel.
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_SetChannelMappedInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChannelMappedInterruptEnable ( int32_t cardIndex,
int32_t module,
nai_ser_chan_mapped_status_type_t statusType,
uint32_t intEnable )

Sets the Interrupt Enable register value for the specified statusType. Setting any of the bits to a (1) enables the interrupt on the channel in that bit position.

Note
Our interrupts are fired from the latched status, regardless if the user selects realtime or latched for the statusType parameter.
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]).
statusType: (Input) The type of interrupt to enable.
intEnable: (Input) Bitmask of channels to enable the specified interrupt on.
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_SetChannelMappedInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChannelMappedInterruptSteering ( int32_t cardIndex,
int32_t module,
nai_ser_chan_mapped_status_type_t statusType,
naibrd_int_steering_t steering )

Sets the interrupt steering for the specified statusType interrupt, this specifies the interrupt direction for each interrupt.

Note
Our interrupts are fired from the latched status, regardless if the user selects realtime or latched for the statusType parameter.
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]).
statusType: (Input) The type of interrupt to set the steering on.
steering: (Input) Interrupt steering. Refer to naibrd_int_steering_t
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_SetChannelMappedInterruptTriggerType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChannelMappedInterruptTriggerType ( int32_t cardIndex,
int32_t module,
nai_ser_chan_mapped_status_type_t statusType,
uint32_t triggerType )

Sets the Interrupt trigger type (edge/level) register value for the specified statusType. Setting any of the bits to a (0) sets the trigger type to edge, setting any of the bits to a (1) sets the trigger type to level. Each bit represents a channel.

Note
Our interrupts are fired from the latched status, regardless if the user selects realtime or latched for the statusType parameter.
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]).
statusType: (Input) The type of interrupt to set the trigger type on.
triggerType: (Input) Bitmask of channels to set the trigger type on. (0) for edge, (1) for 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_NOT_SUPPORTED when function is not supported.

◆ naibrd_SER_SetChannelMappedInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_SetChannelMappedInterruptVector ( int32_t cardIndex,
int32_t module,
nai_ser_chan_mapped_status_type_t statusType,
uint32_t vector )

Sets the interrupt vector for the specified statusType interrupt.

Note
Our interrupts are fired from the latched status, regardless if the user selects realtime or latched for the statusType parameter.
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]).
statusType: (Input) The type of interrupt to set the vector on.
vector: (Input) Unique interrupt vector to be used to identify the interrupt in the Interrupt Service Routine (ISR).
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.