Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Channel Based Statuses (BIT & Summary (Rx Data Available))
NAI Board Library - Module Functions » SER Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_chan_mapped_status_type_t statusType, nai_status_bit_t *p_outstatusBit)
 Read a channel mapped status bit for the specified channel and status type. Valid status types are defined by the naibrd_ser_chan_mapped_status_type_t enumeration. Only BIT and Summary (Rx Data Available) statuses are able to be read using this function. Refer to naibrd_SER_GetEventMappedStatus() for reading event mapped statuses.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_ser_chan_mapped_status_type_t statusType, uint32_t *p_outstatusRaw)
 Read a channel mapped status register for the specified status type. Valid status types are defined by the naibrd_ser_chan_mapped_status_type_t enumeration. Only BIT and Summary (Rx Data Available) statuses are able to be read using this function. Refer to naibrd_SER_GetEventMappedStatusRaw() for reading event mapped statuses.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_ClearChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_chan_mapped_status_type_t statusType)
 Clears the user specified latched status bit on the user specified channel. Only BIT and Summary (Rx Data Available) statuses are able to be cleared using this function. Refer to naibrd_SER_ClearEventMappedStatus() for clearing event mapped statuses.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_ClearChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_ser_chan_mapped_status_type_t statusType, uint32_t statusRaw)
 Clears one or more latched channel mapped status bits for the user specified status type. Only BIT statuses and Summary (Rx Data Available) statuses are able to be cleared using this function. Refer to naibrd_SER_ClearEventMappedStatusRaw() for clearing event mapped statuses.
 

Detailed Description

Function Documentation

◆ naibrd_SER_ClearChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_ClearChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ser_chan_mapped_status_type_t statusType )

Clears the user specified latched status bit on the user specified channel. Only BIT and Summary (Rx Data Available) statuses are able to be cleared using this function. Refer to naibrd_SER_ClearEventMappedStatus() for clearing event mapped statuses.

Note
Only latched statuses can be cleared. If a realtime status is passed in for statusType, the function will return NAI_ERROR_INVALID_VALUE.
Only SC3 with FPGA revision >= 1.0 has the Summary (Rx Data Available) status.
Parameters
cardIndex: (Input) Logical Card Index assigned to connect 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]).
statusType: (Input) SER Status Type - refer to naibrd_ser_chan_mapped_status_type_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 the module does not support the specified statusType.
  • NAI_ERROR_INVALID_VALUE when invalid statusType is specified.

◆ naibrd_SER_ClearChanMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_ClearChanMappedStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_ser_chan_mapped_status_type_t statusType,
uint32_t statusRaw )

Clears one or more latched channel mapped status bits for the user specified status type. Only BIT statuses and Summary (Rx Data Available) statuses are able to be cleared using this function. Refer to naibrd_SER_ClearEventMappedStatusRaw() for clearing event mapped statuses.

Note
Only latched statuses can be cleared. If a realtime status is passed in for statusType, the function will return NAI_ERROR_INVALID_VALUE.
Only SC3 with FPGA revision >= 1.0 has the Summary (Rx Data Available) status.
Parameters
cardIndex: (Input) Logical Card Index assigned to connect 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) SER Status Type - refer to naibrd_ser_chan_mapped_status_type_t definition.
statusRaw: (Input) 32-bit unsigned int representing OR'ed combination of channel-mapped status 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 the module does not support the specified statusType.
  • NAI_ERROR_INVALID_VALUE when invalid statusType is specified.

◆ naibrd_SER_GetChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ser_chan_mapped_status_type_t statusType,
nai_status_bit_t * p_outstatusBit )

Read a channel mapped status bit for the specified channel and status type. Valid status types are defined by the naibrd_ser_chan_mapped_status_type_t enumeration. Only BIT and Summary (Rx Data Available) statuses are able to be read using this function. Refer to naibrd_SER_GetEventMappedStatus() for reading event mapped statuses.

Note
Only SC3 with FPGA revision >= 1.0 has the Summary (Rx Data Available) status.
Parameters
cardIndex: (Input) Logical Card Index assigned to connect 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]).
statusType: (Input) SER Channel Mapped Status Type - refer to naibrd_SER_chan_mapped_status_type_t definition.
p_outstatusBit: (Output) Status (NAI_STATUS_BIT_LO or NAI_STATUS_BIT_HI).
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 an incorrect parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when the module does not support the specified statusType.

◆ naibrd_SER_GetChanMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SER_GetChanMappedStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_ser_chan_mapped_status_type_t statusType,
uint32_t * p_outstatusRaw )

Read a channel mapped status register for the specified status type. Valid status types are defined by the naibrd_ser_chan_mapped_status_type_t enumeration. Only BIT and Summary (Rx Data Available) statuses are able to be read using this function. Refer to naibrd_SER_GetEventMappedStatusRaw() for reading event mapped statuses.

Note
Only SC3 with FPGA revision >= 1.0 has the Summary (Rx Data Available) status.
Parameters
cardIndex: (Input) Logical Card Index assigned to connect 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) SER Channel Mapped Status Type - refer to naibrd_ser_chan_mapped_status_type_t definition.
p_outstatusRaw: (Output) 32-bit unsigned int representing OR'ed combination of channel-mapped status bits.
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 the module does not support the specified statusType.
  • NAI_ERROR_INVALID_VALUE when invalid statusType is specified.