IRIG Event Mapped Status Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_IRIG_GetEventMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_event_mapped_status_type_t statusType, nai_status_bit_t *p_outstatus)
	Retrieves the event mapped status of a channel for a specific event mapped status type.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_IRIG_ClearEventMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_event_mapped_status_type_t statusType)
	Clears the IRIG Event Mapped Latched Status for the specified channel and status type.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_IRIG_GetEventMappedStatusRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_event_mapped_category_type_t type, nai_status_access_type_t accessType, uint32_t *p_outStatus)
	Retrieves the interrupt status raw register data of the channel, interrupt category type, and status access type specified.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_IRIG_ClearEventMappedStatusRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_event_mapped_category_type_t type, uint32_t mask)
	Clears the latched interrupt status raw register data of the channel and interrupt category type specified. Only the bits set in the parameter mask will be cleared.

Detailed Description

Function Documentation

naibrd_IRIG_ClearEventMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_ClearEventMappedStatus	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_irig_event_mapped_status_type_t	statusType )

Clears the IRIG Event Mapped Latched Status for the specified channel and 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]).
statusType	: (Input) Latched Status Type to clear: refer to naibrd_irig_event_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_INVALID_VALUE when invalid statusType parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_IRIG_ClearEventMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_ClearEventMappedStatusRaw	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_irig_event_mapped_category_type_t	type,
		uint32_t	mask )

Clears the latched interrupt status raw register data of the channel and interrupt category type specified. Only the bits set in the parameter mask will be cleared.

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 Category Type: refer to naibrd_irig_event_mapped_category_type_t definition.
mask	: (Input) Mask of bits to clear in latched status register.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetEventMappedStatus	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_irig_event_mapped_status_type_t	statusType,
		nai_status_bit_t *	p_outstatus )

Retrieves the event mapped status of a channel for a specific event mapped 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]).
statusType	: (Input) Status Type: refer to naibrd_irig_event_mapped_status_type_t definition.
p_outstatus	: (Output) Event Mapped Status (NAI_STATUS_BIT_LO/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 invalid statusType parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_IRIG_GetEventMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetEventMappedStatusRaw	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_irig_event_mapped_category_type_t	type,
		nai_status_access_type_t	accessType,
		uint32_t *	p_outStatus )

Retrieves the interrupt status raw register data of the channel, interrupt category type, and status access 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) Status Category Type: refer to naibrd_irig_event_mapped_category_type_t definition.
accessType	: (Input) Status Access Type: NAI_STATUS_LATCHED or NAI_STATUS_REALTIME.
p_outStatus	: (Output) Returns interrupts status bits 0 to 32 in hex.

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.