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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetEventMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sd_event_mapped_status_type_t type, bool_t enable)
 Sets the Event Mapped Interrupt Enable for the specified SD channel and event mapped interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetEventMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sd_event_mapped_status_type_t type, bool_t *p_outEnable)
 Retrieves the Event Mapped Interrupt Enable for the specified SD channel and event mapped interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetEventMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sd_event_mapped_status_type_t type, naibrd_int_trigger_type_t triggerType)
 Sets the Event Mapped Interrupt Edge/Level property for the specified SD channel and event mapped interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetEventMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sd_event_mapped_status_type_t type, naibrd_int_trigger_type_t *p_outTriggerType)
 Retrieves the Event Mapped Interrupt Edge/Level property for the specified SD channel and event mapped interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetEventMappedInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sd_event_mapped_category_type_t type, uint32_t vector)
 Sets the Event Mapped Interrupt Vector for the specified SD channel and event mapped interrupt status category type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetEventMappedInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sd_event_mapped_category_type_t type, uint32_t *p_outVector)
 Retrieves the Event Mapped Interrupt Vector for the specified SD channel and event mapped interrupt status category type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetEventMappedInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sd_event_mapped_category_type_t type, naibrd_int_steering_t steering)
 Sets the Event Mapped Interrupt Steering, which indicates the interrupt direction, for the specified SD channel and event mapped interrupt status category type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetEventMappedInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sd_event_mapped_category_type_t type, naibrd_int_steering_t *p_outSteering)
 Retrieves the Event Mapped Interrupt Steering, which indicates the interrupt direction, for the specified SD channel and event mapped interrupt status category type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, uint32_t vector32)
 Sets the FIFO Interrupt Vector for the specified SD channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outVector32)
 Retrieves the FIFO Interrupt Vector for the specified SD channel.
 
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 event mapped (e.g. hi-watermark, full, etc) 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 *p_outEdgeLevelMask)
 Retrieves the edge or level triggered interrupt event mapped (e.g. hi-watermark, full, etc) 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 FIFO Interrupt Steering, which indicates the interrupt direction, for the specified SD channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_int_steering_t *p_outSteering)
 Retrieves the FIFO Interrupt Steering, which indicates the interrupt direction, for the specified SD channel.
 

Detailed Description

Function Documentation

◆ naibrd_SD_GetEventMappedInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetEventMappedInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sd_event_mapped_status_type_t type,
bool_t * p_outEnable )

Retrieves the Event Mapped Interrupt Enable for the specified SD channel and event mapped interrupt status type.

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 naibrd_sd_event_mapped_status_type_t definition.
p_outEnable: (Output) 0 for disabled, 1 for enabled 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_NOT_OPEN when handle to board is invalid.
  • 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_SD_GetEventMappedInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetEventMappedInterruptSteering ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sd_event_mapped_category_type_t type,
naibrd_int_steering_t * p_outSteering )

Retrieves the Event Mapped Interrupt Steering, which indicates the interrupt direction, for the specified SD channel and event mapped interrupt status category type.

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) Event-Mapped Status Category Type: refer to naibrd_sd_event_mapped_category_type_t definition.
p_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_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_SD_GetEventMappedInterruptTriggerType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetEventMappedInterruptTriggerType ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sd_event_mapped_status_type_t type,
naibrd_int_trigger_type_t * p_outTriggerType )

Retrieves the Event Mapped Interrupt Edge/Level property for the specified SD channel and event mapped interrupt status type.

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 naibrd_sd_event_mapped_status_type_t definition.
p_outTriggerType: (Output) Interrupt trigger type (NAIBRD_INT_TRIGGER_TYPE_EDGE or NAIBRD_INT_TRIGGER_TYPE_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_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetEventMappedInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetEventMappedInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sd_event_mapped_category_type_t type,
uint32_t * p_outVector )

Retrieves the Event Mapped Interrupt Vector for the specified SD channel and event mapped interrupt status category type.

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) Event-Mapped Status Category Type: refer to naibrd_sd_event_mapped_category_type_t definition.
p_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_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_SD_GetFIFOInterruptEdgeLevel()

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

Retrieves the edge or level triggered interrupt event mapped (e.g. hi-watermark, full, etc) 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]).
p_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 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_SD_GetFIFOInterruptSteering()

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

Retrieves the FIFO Interrupt Steering, which indicates the interrupt direction, for the specified SD 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]).
p_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_INVALID_CHANNEL when invalid channel parameter 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 * p_outVector32 )

Retrieves the FIFO Interrupt Vector for the specified SD 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]).
p_outVector32: (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_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetEventMappedInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetEventMappedInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sd_event_mapped_status_type_t type,
bool_t enable )

Sets the Event Mapped Interrupt Enable for the specified SD channel and event mapped interrupt status type.

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 naibrd_sd_event_mapped_status_type_t definition.
enable: (Input) 0 to disable, 1 to enable 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter or invalid enable parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetEventMappedInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetEventMappedInterruptSteering ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sd_event_mapped_category_type_t type,
naibrd_int_steering_t steering )

Sets the Event Mapped Interrupt Steering, which indicates the interrupt direction, for the specified SD channel and event mapped interrupt status category type.

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) Event-Mapped Status Category Type: refer to naibrd_sd_event_mapped_category_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_INVALID_CHANNEL when invalid channel parameter is specified.
  • 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_SetEventMappedInterruptTriggerType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetEventMappedInterruptTriggerType ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sd_event_mapped_status_type_t type,
naibrd_int_trigger_type_t triggerType )

Sets the Event Mapped Interrupt Edge/Level property for the specified SD channel and event mapped interrupt status type.

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 naibrd_sd_event_mapped_status_type_t definition.
triggerType: (Input) Interrupt trigger type (NAIBRD_INT_TRIGGER_TYPE_EDGE or NAIBRD_INT_TRIGGER_TYPE_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_INVALID_VALUE when invalid type parameter or invalid triggerType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetEventMappedInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetEventMappedInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sd_event_mapped_category_type_t type,
uint32_t vector )

Sets the Event Mapped Interrupt Vector for the specified SD channel and event mapped interrupt status category type.

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) Event-Mapped Status Category Type: refer to naibrd_sd_event_mapped_category_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_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_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 event mapped (e.g. hi-watermark, full, etc) 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 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_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 FIFO Interrupt Steering, which indicates the interrupt direction, for the specified SD 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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid steering parameter 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 FIFO Interrupt Vector for the specified SD 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]).
vector32: (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_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.