Standard Operation Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_CD_GetBitStatus (int32_t cardIndex, int32_t module, naibrd_cd_bit_status_type_t type, nai_status_bit_t *p_outstatusBit)
	Retrieves the bit status for the specified bit status type.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_CD_GetChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_cd_chan_mapped_status_type_t statusType, nai_status_bit_t *p_outstatusBit)
	Retrieves the status for the specified Chip Detect channel and status type.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_CD_ClearChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_cd_chan_mapped_status_type_t statusType)
	Clears the latched or realtime status for the specified Chip Detect channel and status type.

Detailed Description

Function Documentation

naibrd_CD_ClearChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_ClearChanMappedStatus	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_cd_chan_mapped_status_type_t	statusType )

Clears the latched or realtime status for the specified Chip Detect channel and status type.

Note

If any realtime status type is provided, the function will return NAI_ERROR_INVALID_VALUE since realtime status bits are not cleared by the user.

If the statusType passed in is NAIBRD_CD_STATUS_BIT_LATCHED, the channel will be irrelevant. All channels 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]).
statusType	: (Input) Status Type: refer to naibrd_cd_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_NOT_OPEN when handle to board is invalid.
• NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
• NAI_ERROR_INVALID_VALUE when invalid status type parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_CD_GetBitStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetBitStatus	(	int32_t	cardIndex,
		int32_t	module,
		naibrd_cd_bit_status_type_t	type,
		nai_status_bit_t *	p_outstatusBit )

Retrieves the bit status for the specified bit 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]).
type	: (Input) Status Type: refer to nai_cd_bit_status_type_t definition.
p_outstatusBit	: (Output) 0 for Normal, 1 Failure Detected.

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

naibrd_CD_GetChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetChanMappedStatus	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_cd_chan_mapped_status_type_t	statusType,
		nai_status_bit_t *	p_outstatusBit )

Retrieves the status for the specified Chip Detect channel and status type.

Note

If NAIBRD_CD_STATUS_BIT_LATCHED or NAIBRD_CD_STATUS_BIT_REALTIME is passed in for statusType, the channel will be irrelevant. If one channel fails BIT, all channels will fail.

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_dt_chan_mapped_status_type_t definition.
p_outstatusBit	: (Output) 0 for Normal, 1 Failure Detected.

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