BC Configuration Functions

Functions
NAIBRDFUNC naibrd_1553_t NAIAPI	naibrd_1553_BcCfg (int16_t device, naibrd_1553_bc_options_t bcOperationOptions)
	Initialize the device as a bus controller (BC) with the given initialization options.
NAIBRDFUNC naibrd_1553_t NAIAPI	naibrd_1553_BcSetMsgRetryPolicy (int16_t device, naibrd_1553_bc_num_retries_t numberOfRetries, naibrd_1553_bc_retry_bus_t firstRetryBus, naibrd_1553_bc_retry_bus_t secondRetryBus, uint16_t reserved)
	Configure the message retry policy of given BC device to given number of retries and given first and second chance bus to retry the message with.
NAIBRDFUNC naibrd_1553_t NAIAPI	naibrd_1553_BcCfgMsgGapTimerEnable (int16_t device, uint16_t enable)
	Enable or disable the message gap time field for all messages.

Detailed Description

Function Documentation

naibrd_1553_BcCfg()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_BcCfg	(	int16_t	device,
		naibrd_1553_bc_options_t	bcOperationOptions )

Initialize the device as a bus controller (BC) with the given initialization options.

Parameters

device	: (Input) Logical Device Number (0-31).
bcOperationOptions	: (Input) BC Operation options. Valid values are the following: * 0 * NAIBRD_1553_BC_ASYNCHRONOUS_LOW_PRIORITY_MODE * NAIBRD_1553_BC_ASYNCHRONOUS_HIGH_PRIORITY_MODE * NAIBRD_1553_BC_ASYNCHRONOUS_BOTH_PRIORITY_MODES *

Returns

• NAIBRD_SUCCESS when function is completed successfully
• NAIBRD_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
• NAIBRD_1553_RC_INVALID_MODE when device mode is not set to BC
• NAIBRD_1553_RC_INVALID_STATE when device is in an invalid state

naibrd_1553_BcCfgMsgGapTimerEnable()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_BcCfgMsgGapTimerEnable	(	int16_t	device,
		uint16_t	enable )

Enable or disable the message gap time field for all messages.

Parameters

device	: (Input) Logical Device Number (0-31).
enable	: (Input) Gap Time field enable (1 = enable, 0 = disable).

Returns

• NAI_SUCCESS when function is completed successfully
• NAIBRD_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
• NAIBRD_1553_RC_INVALID_MODE when device mode is not set to BC
• NAIBRD_1553_RC_INVALID_STATE when device is in an invalid state

naibrd_1553_BcSetMsgRetryPolicy()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_BcSetMsgRetryPolicy	(	int16_t	device,
		naibrd_1553_bc_num_retries_t	numberOfRetries,
		naibrd_1553_bc_retry_bus_t	firstRetryBus,
		naibrd_1553_bc_retry_bus_t	secondRetryBus,
		uint16_t	reserved )

Configure the message retry policy of given BC device to given number of retries and given first and second chance bus to retry the message with.

Note:

• In order to make a BC device retry a message in case of error, all the following terms must be matched:
• Function naibrd_1553_SetMsgRetryPolicy has been called to configure the BC device with a suitable number of retries and actually available retry buses.
• Each of the messages that should be retried on error has been defined with message option NAIBRD_1553_BC_CTRL_RETRY_ENABLED upon its creation using function naibrd_1553_BcMsgCreate* (or modified after creation using function naibrd_1553_BcMsgModify*).

Equivalent DDC definition: aceBCSetMsgRetry

Parameters

device	: (Input) Logical Device Number (0-31).
numberOfRetries	: (Input) Desired number of retries on message failure (NAIBRD_1553_MESSAGE_RETRY_NONE, NAIBRD_1553_MESSAGE_RETRY_ONCE, NAIBRD_1553_MESSAGE_RETRY_TWICE).
firstRetryBus	: (Input) The bus to retry the message with in the first time in case of message failure (NAIBRD_1553_MESSAGE_RETRY_SAME or NAIBRD_1553_MESSAGE_RETRY_ALT).
secondRetryBus	: (Input) The bus to retry the message with in the second time in case of message failure (NAIBRD_1553_MESSAGE_RETRY_SAME or NAIBRD_1553_MESSAGE_RETRY_ALT).
reserved	: (Input) Reserved for future use.

Returns

• NAI_SUCCESS
• NAIBRD_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
• NAIBRD_1553_RC_INVALID_MODE when device is not set in RT or RT/MT mode
• NAIBRD_1553_RC_INVALID_STATE when device is in an invalid state
• NAIBRD_1553_RC_INVALID_PARAMETER when numberOfRetries, firstRetryBus or secondRetryBus is an invalid value