Operation Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_CAN_GetChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_can_chan_mapped_status_type_t statusType, nai_status_bit_t *p_outstatusBit)
	Get the interrupt status for the specified channel. Valid interrupt status flags are defined by the naibrd_can_status_type enumeration.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_CAN_ClearChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_can_chan_mapped_status_type_t statusType)
	Clears the latched status (NOTE if "REALTIME" version of interrupt is asked to be cleared, the "LATCHED" version of the interrupt is what really gets cleared as there is no way to clear the "REALTIME".
NAIBRDFUNC nai_status_t NAIAPI	naibrd_CAN_GetSWTData (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outupdateOccured, bool_t *p_outinterruptOccured, naibrd_can_swt_fault_type_t *p_outfaultType, uint32_t *p_outfaultValue)
	Gets the information associated with the SWT (Short Wire Test) status for a specific channel. This function is only for CB6 modules since a "special" FPGA is required to detect wire shorts.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_CAN_GetDropCount (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outdropCount)
	Get the Drop Count for specified channel. (How many CAN msgs known to have been dropped)

Detailed Description

Function Documentation

naibrd_CAN_ClearChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CAN_ClearChanMappedStatus	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_can_chan_mapped_status_type_t	statusType )

Clears the latched status (NOTE if "REALTIME" version of interrupt is asked to be cleared, the "LATCHED" version of the interrupt is what really gets cleared as there is no way to clear the "REALTIME".

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) CAN Status Type - refer to naibrd_can_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 function is not supported.

naibrd_CAN_GetChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CAN_GetChanMappedStatus	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_can_chan_mapped_status_type_t	statusType,
		nai_status_bit_t *	p_outstatusBit )

Get the interrupt status for the specified channel. Valid interrupt status flags are defined by the naibrd_can_status_type enumeration.

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) CAN Status Type - refer to naibrd_can_chan_mapped_status_type_t definition.
p_outstatusBit	: (Output) Interrupt status.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_CAN_GetDropCount	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		int32_t *	p_outdropCount )

Get the Drop Count for specified channel. (How many CAN msgs known to have been dropped)

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]).
p_outdropCount	: (Output) CAN message drop count.

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_SUPPORTED when function is not supported.

naibrd_CAN_GetSWTData()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CAN_GetSWTData	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t *	p_outupdateOccured,
		bool_t *	p_outinterruptOccured,
		naibrd_can_swt_fault_type_t *	p_outfaultType,
		uint32_t *	p_outfaultValue )

Gets the information associated with the SWT (Short Wire Test) status for a specific channel. This function is only for CB6 modules since a "special" FPGA is required to detect wire shorts.

NOTE: The Good Value is a Fault Value recorded after the first 16 transmissions for a particular channel. This recorded Good Value is the value that will be used as a benchmark for all future transmissions, when determining if the bus is faulty or not.

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]).
p_outupdateOccured	: (Output) If NAI_TRUE the Fault Value from the most recent transmission is within tolerance of the Good Value.
p_outinterruptOccured	: (Output) If NAI_TRUE the Fault Value from the most recent transmission is not within tolerance of the Good Value. This is an indicator that a fault has occurred.
p_outfaultType	: (Output) A Value indicating what type of BUS problem caused the fault.
p_outfaultValue	: (Output) Value of the measured signature for the specified Fault Type.

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.