naibrd_rly.c File Reference

#include <stdlib.h>
#include "functions/naibrd_rly.h"
#include "maps/nai_map_rly.h"
#include "advanced/naibrd_adv.h"
#include "naibrd_config.h"
#include "boards/naibrd_gen5.h"

Functions
NAIBRDFUNC int32_t NAIAPI	naibrd_RLY_GetChannelCount (uint32_t modid)
	Returns the number of channels for the specified RLY Module ID.
NAIBRDFUNC int32_t NAIAPI	naibrd_RLY_GetGroupCount (uint32_t modid)
	Returns the number of channel groups for the specified RLY Module ID.
NAIBRDFUNC int32_t NAIAPI	naibrd_RLY_GetGroupSize (uint32_t modid)
	Returns the number of channel in each group for the specified RLY Module ID.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_SetRelayState (int32_t cardIndex, int32_t module, int32_t channel, nai_rly_state_t setstate)
	Sets the relay control state for the specified RLY channel.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_GetRelayState (int32_t cardIndex, int32_t module, int32_t channel, nai_rly_state_t *outstate)
	Retrieves the control setting state for the specified RLY channel.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_GetRelayPosition (int32_t cardIndex, int32_t module, int32_t channel, nai_rly_state_t *outstate)
	Retrieves the physical relay position for the specified RLY channel, via reading of secondary pole contacts.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_rly_status_type_t type, nai_status_bit_t *outstatusBit)
	Retrieves the status for the specified status type and RLY channel.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_ClearStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_rly_status_type_t type)
	Clears the latched status for the specified RLY channel and status type. (Applicable for latched status types only)
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_SetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_rly_status_type_t type, bool_t enable)
	Sets the Interrupt Enable for the specified RLY channel and interrupt status type.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_GetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_rly_status_type_t type, bool_t *outenable)
	Retrieves the Interrupt Enable setting for the specified RLY channel and interrupt status type.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_SetEdgeLevelInterrupt (int32_t cardIndex, int32_t module, int32_t channel, nai_rly_status_type_t type, nai_rly_interrupt_t interruptType)
	Sets the Interrupt Edge/Level property for the specified RLY channel and interrupt status type. Determines whether an interrupt condition can retrigger on the same occurrence without clearing first.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_GetEdgeLevelInterrupt (int32_t cardIndex, int32_t module, int32_t channel, nai_rly_status_type_t type, nai_rly_interrupt_t *outinterruptType)
	Retrieves the Interrupt Edge/Level property for the specified RLY channel and interrupt status type.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_SetGroupInterruptVector (int32_t cardIndex, int32_t module, int32_t group, nai_rly_status_type_t type, uint32_t vector)
	Sets the Interrupt Vector for the specified RLY channel and interrupt status type.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_GetGroupInterruptVector (int32_t cardIndex, int32_t module, int32_t group, nai_rly_status_type_t type, uint32_t *outvector)
	Retrieves the Interrupt Vector for the specified RLY channel and interrupt status type.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_SetGroupInterruptSteering (int32_t cardIndex, int32_t module, int32_t group, nai_rly_status_type_t type, naibrd_int_steering_t steering)
	Sets the Interrupt Steering which indicates the interrupt direction for the specified RLY group and interrupt status type.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_GetGroupInterruptSteering (int32_t cardIndex, int32_t module, int32_t group, nai_rly_status_type_t type, naibrd_int_steering_t *outsteering)
	Retrieves the Interrupt Steering which indicates the interrupt direction for the specified RLY group and interrupt status type.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_SetGroupRaw (int32_t cardIndex, int32_t module, int32_t group, nai_rly_raw_group_t type, uint32_t rawdata)
	Sets the raw data value in the register associated to the group and register type specified.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_GetGroupRaw (int32_t cardIndex, int32_t module, int32_t group, nai_rly_raw_group_t type, uint32_t *outrawdata)
	Retrieves the raw data value in the register associated to the group and register type specified.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_SetInduceBIT (int32_t cardIndex, int32_t module, int32_t channel, nai_rly_state_t forceBIT)
	Induces a simulated BIT fault on the specified RLY channel, by inverting the readback from the secondary pole. forceBITSet to zero under normal conditions, and set to one to force a BIT condition. For test purposes only.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_GetInduceBIT (int32_t cardIndex, int32_t module, int32_t channel, nai_rly_state_t *outforceBIT)
	Reads the Induce BIT configuration setting for the specified RLY channel.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_GetRelayType (int32_t cardIndex, int32_t module, nai_rly_relaytype_t *outtype)
	Returns the relay type designation for the specified RLY Module (fixed by hardware configuration). 0 denotes non-latching, 1 is latching type. For internal reference purposes only.

Function Documentation

naibrd_RLY_GetInduceBIT()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetInduceBIT	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_rly_state_t *	outforceBIT )

Reads the Induce BIT configuration setting for the specified RLY 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]).
outforceBIT	: (Output) NAI_RLY_STATE_OPEN (normal) or NAI_RLY_STATE_CLOSE (BIT forced).

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_INVALID_MODULE when invalid card 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_NOT_SUPPORTED when function is not supported.

naibrd_RLY_GetRelayType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetRelayType	(	int32_t	cardIndex,
		int32_t	module,
		nai_rly_relaytype_t *	outtype )

Returns the relay type designation for the specified RLY Module (fixed by hardware configuration). 0 denotes non-latching, 1 is latching type. For internal reference purposes only.

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]).
outtype	: (Output) Refer to nai_rly_relaytype_t definitions.

Returns

• Type of relay (latching or non latching) for the module.

naibrd_RLY_SetInduceBIT()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_SetInduceBIT	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_rly_state_t	forceBIT )

Induces a simulated BIT fault on the specified RLY channel, by inverting the readback from the secondary pole. forceBITSet to zero under normal conditions, and set to one to force a BIT condition. For test purposes only.

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]).
forceBIT	: (Input) NAI_RLY_STATE_OPEN or NAI_RLY_STATE_CLOSE.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_INVALID_MODULE when invalid card 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_NOT_SUPPORTED when function is not supported.