Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Interrupt Functions
S/D Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_sd_status_type_t type, nai_sd_enable_t intenable)
 Sets the Interrupt Enable associated with the Status Type for the specified channel. By default, interrupts are disabled. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_sd_status_type_t type, nai_sd_enable_t *outintenable)
 Retrieves the Interrupt Enable associated with the Status Type from the specified channel. By default, interrupts are disabled. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetEdgeLevelInterrupt (int32_t cardIndex, int32_t module, int32_t channel, nai_sd_status_type_t type, nai_sd_interrupt_t interruptType)
 Sets the Interrupt Edge/Level property for the specified channel and interrupt status type. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetEdgeLevelInterrupt (int32_t cardIndex, int32_t module, int32_t channel, nai_sd_status_type_t type, nai_sd_interrupt_t *outinterruptType)
 Retrieves the Interrupt Edge/Level property for the specified channel and interrupt status type. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetInterruptVector (int32_t cardIndex, int32_t module, nai_sd_status_type_t type, uint32_t interruptvector)
 Sets the Interrupt Vector associated with the Status Type for the specified channel. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetInterruptVector (int32_t cardIndex, int32_t module, nai_sd_status_type_t type, uint32_t *outinterruptvector)
 Retrieves the Interrupt Vector associated with the Status Type from the specified channel. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetInterruptSteering (int32_t cardIndex, int32_t module, nai_sd_status_type_t type, naibrd_int_steering_t steering)
 Sets the Interrupt Steering which indicates the interrupt direction for the specified channel. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetInterruptSteering (int32_t cardIndex, int32_t module, nai_sd_status_type_t type, naibrd_int_steering_t *outsteering)
 Retrieves the Interrupt Steering which indicates the interrupt direction for the specified channel. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, uint32_t vector32)
 Sets the Interrupt Vector for the specified SD channel's FIFO Buffer.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outvector32)
 Retrieves the Interrupt Vector for the specified SD channel's FIFO Buffer.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_sd_fifo_status_t edgelevelmask)
 Sets the edge or level triggered interrupt mask for the specified SD channel's FIFO Buffer.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_sd_fifo_status_t *outedgelevelmask)
 Retrieves the edge or level triggered interrupt mask for the specified SD channel's FIFO Buffer.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_int_steering_t steering)
 Sets the Interrupt Steering which indicates the interrupt direction for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_int_steering_t *outsteering)
 Retrieves the Interrupt Steering which indicates the interrupt direction for the specified channel.
 

Detailed Description


Function Documentation

◆ naibrd_SD_GetEdgeLevelInterrupt()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetEdgeLevelInterrupt ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sd_status_type_t type,
nai_sd_interrupt_t * outinterruptType )

Retrieves the Interrupt Edge/Level property for the specified channel and interrupt status type. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.

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) Status Type: refer to nai_sd_status_type_t definition.
outinterruptType: (Output) NAI_SD_EDGE_INTERRUPT or NAI_SD_LEVEL_INTERRUPT.
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 the type parameter is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetFIFOInterruptEdgeLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOInterruptEdgeLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sd_fifo_status_t * outedgelevelmask )

Retrieves the edge or level triggered interrupt mask for the specified SD channel's FIFO Buffer.

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]).
outedgelevelmask: (Output) channel bit mapped mask of edge(0) or level(1) triggered interrupts.
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_SD_GetFIFOInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOInterruptSteering ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_int_steering_t * outsteering )

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 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_SD_GetFIFOInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * outvector32 )

Retrieves the Interrupt Vector for the specified SD channel's FIFO Buffer.

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]).
outvector32: (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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sd_status_type_t type,
nai_sd_enable_t * outintenable )

Retrieves the Interrupt Enable associated with the Status Type from the specified channel. By default, interrupts are disabled. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.

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) Status Type: refer to nai_sd_status_type_t definition.
outintenable: (Output) NAI_SD_STATE_ENABLED or NAI_SD_STATE_DISABLED.
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 the type parameter is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetInterruptSteering ( int32_t cardIndex,
int32_t module,
nai_sd_status_type_t type,
naibrd_int_steering_t * outsteering )

Retrieves the Interrupt Steering which indicates the interrupt direction for the specified channel. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.

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_sd_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 type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetInterruptVector ( int32_t cardIndex,
int32_t module,
nai_sd_status_type_t type,
uint32_t * outinterruptvector )

Retrieves the Interrupt Vector associated with the Status Type from the specified channel. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.

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_sd_status_type_t definition.
outinterruptvector: (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_INVALID_VALUE when the type parameter is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetEdgeLevelInterrupt()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetEdgeLevelInterrupt ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sd_status_type_t type,
nai_sd_interrupt_t interruptType )

Sets the Interrupt Edge/Level property for the specified channel and interrupt status type. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.

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) Status Type: refer to nai_sd_status_type_t definition.
interruptType: (Input) NAI_SD_EDGE_INTERRUPT or NAI_SD_LEVEL_INTERRUPT.
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 the type or interruptType parameters are invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetFIFOInterruptEdgeLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOInterruptEdgeLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sd_fifo_status_t edgelevelmask )

Sets the edge or level triggered interrupt mask for the specified SD channel's FIFO Buffer.

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]).
edgelevelmask: (Input) channel bit mapped mask of edge(0) or level(1) triggered interrupts.
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_SD_SetFIFOInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOInterruptSteering ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_int_steering_t steering )

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 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_SD_SetFIFOInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t vector32 )

Sets the Interrupt Vector for the specified SD channel's FIFO Buffer.

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]).
vector32: (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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sd_status_type_t type,
nai_sd_enable_t intenable )

Sets the Interrupt Enable associated with the Status Type for the specified channel. By default, interrupts are disabled. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.

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) Status Type: refer to nai_sd_status_type_t definition.
intenable: (Input) NAI_SD_STATE_ENABLED or NAI_SD_STATE_DISABLED.
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 the type or intenable parameters are invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetInterruptSteering ( int32_t cardIndex,
int32_t module,
nai_sd_status_type_t type,
naibrd_int_steering_t steering )

Sets the Interrupt Steering which indicates the interrupt direction for the specified channel. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.

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_sd_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 type parameter or invalid steering parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetInterruptVector ( int32_t cardIndex,
int32_t module,
nai_sd_status_type_t type,
uint32_t interruptvector )

Sets the Interrupt Vector associated with the Status Type for the specified channel. NAI_SD_STATUS_SUMMARY supported in FPGA Version >= 9.28.

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_sd_status_type_t definition.
interruptvector: (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_INVALID_VALUE when the type parameter is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.