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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetRaw (int32_t cardIndex, int32_t module, naibrd_sd_raw_t type, uint32_t rawData)
 Sets the raw data value in the register associated with the register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetRaw (int32_t cardIndex, int32_t module, naibrd_sd_raw_t type, uint32_t *p_outRawData)
 Retrieves the raw data value in the register associated with the register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sd_channel_raw_t type, uint32_t rawData)
 Sets the raw data value in the register associated with the channel and channel register type specified. BIT Error Limit feature supported in FPGA Version >= 9.28.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sd_channel_raw_t type, uint32_t *p_outRawData)
 Retrieves the raw data value in the register associated with the channel and channel register type specified. BIT Error Limit feature supported in FPGA Version >= 9.28.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_sd_chan_mapped_status_type_t statusType, uint32_t *p_outStatusRaw)
 Retrieves the raw data value in the status register associated with the status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ClearChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_sd_chan_mapped_status_type_t statusType, uint32_t statusRaw)
 Sets the raw data value in the status register associated with the status type specified. This function may be used to clear multiple latched status bits in the status word.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetChanMappedInterruptEnableRaw (int32_t cardIndex, int32_t module, naibrd_sd_chan_mapped_status_type_t statusType, uint32_t enableRaw)
 Sets the raw data value in the interrupt enable register associated with the status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetChanMappedInterruptEnableRaw (int32_t cardIndex, int32_t module, naibrd_sd_chan_mapped_status_type_t statusType, uint32_t *p_outEnableRaw)
 Retrieves the raw data value in the interrupt enable register associated with the status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetEventMappedStatusRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_status_access_type_t accessType, naibrd_sd_event_mapped_category_type_t type, uint32_t *p_outStatusRaw)
 Retrieves the raw data value in the event mapped status register associated with the SD channel and status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ClearEventMappedStatusRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sd_event_mapped_category_type_t type, uint32_t statusRaw)
 Clears the raw data value in the event mapped status register associated with the SD channel and status type specified and the bits specified in the parameter statusRaw.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetEventMappedInterruptEnableRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sd_event_mapped_category_type_t type, uint32_t enableRaw)
 Sets the raw data value in the event mapped interrupt enable register associated with the SD channel and status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetEventMappedInterruptEnableRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sd_event_mapped_category_type_t type, uint32_t *p_outEnableRaw)
 Retrieves the raw data value in the event mapped interrupt enable register associated with the SD channel and status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFORealtimeStatus (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outStatus)
 Retrieves the raw data value in the FIFO Realtime status register associated with the SD channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOLatchedStatus (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outStatus)
 Retrieves the raw data value in the FIFO Latched status register associated with the SD channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ClearFIFOLatchedStatus (int32_t cardIndex, int32_t module, int32_t channel, uint32_t bit)
 Clears the raw data value in the FIFO Latched status register associated with the SD channel and the bits specified in the parameter bit.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOIntEnable (int32_t cardIndex, int32_t module, int32_t channel, uint32_t intEnable)
 Sets the raw data value in the FIFO interrupt enable register associated with the SD channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOIntEnable (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outIntEnable)
 Retrieves the raw data value in the FIFO interrupt enable register associated with the SD channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetStatusRaw (int32_t cardIndex, int32_t module, nai_sd_status_type_t type, uint32_t statusRaw)
 Sets the raw data value in the status register associated with the status type specified. This function may be used to clear multiple latched status bits in the status word.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetStatusRaw (int32_t cardIndex, int32_t module, nai_sd_status_type_t type, uint32_t *p_outStatusRaw)
 Retrieves the raw data value in the status register associated with the status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetInterruptEnableRaw (int32_t cardIndex, int32_t module, nai_sd_status_type_t type, uint32_t statusIntEnabRaw)
 Sets the raw data value in the interrupt enable register associated with the status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetInterruptEnableRaw (int32_t cardIndex, int32_t module, nai_sd_status_type_t type, uint32_t *p_outStatusIntEnabRaw)
 Retrieves the raw data value in the interrupt enable register associated with the status type specified.
 

Detailed Description

Function Documentation

◆ naibrd_SD_ClearChanMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ClearChanMappedStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_sd_chan_mapped_status_type_t statusType,
uint32_t statusRaw )

Sets the raw data value in the status register associated with the status type specified. This function may be used to clear multiple latched status bits in the status word.

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) Status Type: refer to naibrd_sd_chan_mapped_status_type_t definition.
statusRaw: (Input) Raw Status Data Word.
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 invalid statusType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_ClearEventMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ClearEventMappedStatusRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sd_event_mapped_category_type_t type,
uint32_t statusRaw )

Clears the raw data value in the event mapped status register associated with the SD channel and status type specified and the bits specified in the parameter statusRaw.

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.
statusRaw: (Input) Raw Status Data Word bits to clear.
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_ClearFIFOLatchedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ClearFIFOLatchedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t bit )

Clears the raw data value in the FIFO Latched status register associated with the SD channel and the bits specified in the parameter bit.

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]).
bit: (Input) Raw Status Data Word bits to clear.
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_GetChanMappedInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetChanMappedInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
naibrd_sd_chan_mapped_status_type_t statusType,
uint32_t * p_outEnableRaw )

Retrieves the raw data value in the interrupt enable register associated with the status type 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]).
statusType: (Input) Status Type: refer to naibrd_sd_chan_mapped_status_type_t definition.
p_outEnableRaw: (Output) Raw Interrupt Enable Data Word.
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 invalid statusType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetChanMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetChanMappedStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_sd_chan_mapped_status_type_t statusType,
uint32_t * p_outStatusRaw )

Retrieves the raw data value in the status register associated with the status type 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]).
statusType: (Input) Status Type: refer to naibrd_sd_chan_mapped_status_type_t definition.
p_outStatusRaw: (Output) Raw Data Code.
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 invalid statusType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sd_channel_raw_t type,
uint32_t * p_outRawData )

Retrieves the raw data value in the register associated with the channel and channel register type specified. BIT Error Limit feature 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) Channel Raw Type: refer to naibrd_sd_channel_raw_t definition.
p_outRawData: (Output) Raw Data Value.
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_GetEventMappedInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetEventMappedInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sd_event_mapped_category_type_t type,
uint32_t * p_outEnableRaw )

Retrieves the raw data value in the event mapped interrupt enable register associated with the SD channel and status type 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) Event Mapped Status Category Type: refer to naibrd_sd_event_mapped_category_type_t definition.
p_outEnableRaw: (Output) Raw Interrupt Enable Data Word.
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_GetEventMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetEventMappedStatusRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_status_access_type_t accessType,
naibrd_sd_event_mapped_category_type_t type,
uint32_t * p_outStatusRaw )

Retrieves the raw data value in the event mapped status register associated with the SD channel and status type 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]).
accessType: (Input) nai_status_access_type_t type (NAI_STATUS_LATCHED or NAI_STATUS_REALTIME).
type: (Input) Event Mapped Status Category Type: refer to naibrd_sd_event_mapped_category_type_t definition.
p_outStatusRaw: (Output) Raw Status Data Word.
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 accessType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetFIFOIntEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOIntEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outIntEnable )

Retrieves the raw data value in the FIFO interrupt enable register associated with the 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_outIntEnable: (Output) Raw Interrupt Enable Data Word.
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_GetFIFOLatchedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOLatchedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outStatus )

Retrieves the raw data value in the FIFO Latched status register associated with the 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_outStatus: (Output) Raw Status Data Word.
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_GetFIFORealtimeStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFORealtimeStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outStatus )

Retrieves the raw data value in the FIFO Realtime status register associated with the 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_outStatus: (Output) Raw Status Data Word.
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_GetInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
nai_sd_status_type_t type,
uint32_t * p_outStatusIntEnabRaw )

Retrieves the raw data value in the interrupt enable register associated with the status type 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]).
type: (Input) Status Type: refer to naibrd_sd_chan_mapped_status_type_t definition.
p_outStatusIntEnabRaw: (Output) Raw Interrupt Enable Data Word.
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 invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetRaw ( int32_t cardIndex,
int32_t module,
naibrd_sd_raw_t type,
uint32_t * p_outRawData )

Retrieves the raw data value in the register associated with the register type 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]).
type: (Input) Raw Type: refer to naibrd_sd_raw_t definition.
p_outRawData: (Output) Raw Data Value.
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 invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetStatusRaw ( int32_t cardIndex,
int32_t module,
nai_sd_status_type_t type,
uint32_t * p_outStatusRaw )

Retrieves the raw data value in the status register associated with the status type 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]).
type: (Input) Status Type: refer to naibrd_sd_chan_mapped_status_type_t definition.
p_outStatusRaw: (Output) Raw Data Code.
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 invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetChanMappedInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetChanMappedInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
naibrd_sd_chan_mapped_status_type_t statusType,
uint32_t enableRaw )

Sets the raw data value in the interrupt enable register associated with the status type 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]).
statusType: (Input) Status Type: refer to naibrd_sd_chan_mapped_status_type_t definition.
enableRaw: (Input) Raw Interrupt Enable Data Word.
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 invalid statusType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sd_channel_raw_t type,
uint32_t rawData )

Sets the raw data value in the register associated with the channel and channel register type specified. BIT Error Limit feature 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) Channel Raw Type: refer to naibrd_sd_channel_raw_t definition. 
The following naibrd_sd_channel_raw_t definitions are read-only and will return NAI_ERROR_INVALID_VALUE if passed in as type:
   NAIBRD_SD_CHAN_RAW_ANGLE                (* Read-only *)
   NAIBRD_SD_CHAN_RAW_ANGLE_COMBINED       (* Read-only *)
   NAIBRD_SD_CHAN_RAW_VELOCITY             (* Read-only *)
   NAIBRD_SD_CHAN_RAW_FREQUENCY            (* Read-only *)
   NAIBRD_SD_CHAN_RAW_SIGNAL_VOLTAGE       (* Read-only *)
   NAIBRD_SD_CHAN_RAW_REF_VOLTAGE          (* Read-only *)
   NAIBRD_SD_CHAN_RAW_SINE                 (* Read-only *)
   NAIBRD_SD_CHAN_RAW_COSINE               (* Read-only *)
rawData: (Input) Raw Data.
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_SetEventMappedInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetEventMappedInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sd_event_mapped_category_type_t type,
uint32_t enableRaw )

Sets the raw data value in the event mapped interrupt enable register associated with the SD channel and status type 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) Event Mapped Status Category Type: refer to naibrd_sd_event_mapped_category_type_t definition.
enableRaw: (Input) Raw Interrupt Enable Data Word.
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_SetFIFOIntEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOIntEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t intEnable )

Sets the raw data value in the FIFO interrupt enable register associated with the 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]).
intEnable: (Input) Raw Interrupt Enable Data Word.
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_SetInterruptEnableRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetInterruptEnableRaw ( int32_t cardIndex,
int32_t module,
nai_sd_status_type_t type,
uint32_t statusIntEnabRaw )

Sets the raw data value in the interrupt enable register associated with the status type 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]).
type: (Input) Status Type: refer to naibrd_sd_chan_mapped_status_type_t definition.
statusIntEnabRaw: (Input) Raw Interrupt Enable Data Word.
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 invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetRaw ( int32_t cardIndex,
int32_t module,
naibrd_sd_raw_t type,
uint32_t rawData )

Sets the raw data value in the register associated with the register type 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]).
type: (Input) Raw Type: refer to naibrd_sd_raw_t definition.
rawData: (Input) Raw Data Value.
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 invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetStatusRaw ( int32_t cardIndex,
int32_t module,
nai_sd_status_type_t type,
uint32_t statusRaw )

Sets the raw data value in the status register associated with the status type specified. This function may be used to clear multiple latched status bits in the status word.

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 naibrd_sd_chan_mapped_status_type_t definition.
statusRaw: (Input) Raw Status Data Word.
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 invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.