BC Message Functions

Functions
NAIBRDFUNC naibrd_1553_t NAIAPI	naibrd_1553_BcMsgCreateBcToRt (int16_t device, int16_t messageId, int16_t dataBlockId, naibrd_1553_rt_address_t receiverRt, naibrd_1553_rt_subaddress_t receiverRtSubaddress, uint16_t wordCount, uint16_t gapTime_uS, naibrd_1553_bc_msg_options_t bcMsgOptions)
	Create a BC to RT message.
NAIBRDFUNC naibrd_1553_t NAIAPI	naibrd_1553_BcMsgCreateRtToBc (int16_t device, int16_t messageId, int16_t dataBlockId, naibrd_1553_rt_address_t transmitterRt, naibrd_1553_rt_subaddress_t transmitterRtSubaddress, uint16_t wordCount, uint16_t gapTime_uS, naibrd_1553_bc_msg_options_t bcMsgOptions)
	Create a RT to BC message.
NAIBRDFUNC naibrd_1553_t NAIAPI	naibrd_1553_BcMsgCreateRtToRt (int16_t device, int16_t messageId, int16_t dataBlockId, naibrd_1553_rt_address_t receiverRt, naibrd_1553_rt_subaddress_t receiverRtSubaddress, uint16_t wordCount, naibrd_1553_rt_address_t transmitterRt, naibrd_1553_rt_subaddress_t transmitterRtSubaddress, uint16_t gapTime_uS, naibrd_1553_bc_msg_options_t bcMsgOptions)
	Create a RT to RT message.
NAIBRDFUNC naibrd_1553_t NAIAPI	naibrd_1553_BcMsgCreateMode (int16_t device, int16_t messageId, int16_t dataBlockId, naibrd_1553_rt_address_t rt, naibrd_1553_messageDirection_t messageDirection, naibrd_1553_bc_mode_commands_t modeCommand, uint16_t gapTime_uS, naibrd_1553_bc_msg_options_t bcMsgOptions)
	Create a Mode message.
NAIBRDFUNC naibrd_1553_t NAIAPI	naibrd_1553_BcMsgCreateBcToBroadcast (int16_t device, int16_t messageId, int16_t dataBlockId, naibrd_1553_rt_subaddress_t receiverRtSubaddress, uint16_t wordCount, uint16_t gapTime_uS, naibrd_1553_bc_msg_options_t bcMsgOptions)
	Create a BC to Broadcast message.
NAIBRDFUNC naibrd_1553_t NAIAPI	naibrd_1553_BcMsgCreateRtToBroadcast (int16_t device, int16_t messageId, int16_t dataBlockId, naibrd_1553_rt_subaddress_t receiverRtSubaddress, uint16_t wordCount, naibrd_1553_rt_address_t transmitterRt, naibrd_1553_rt_subaddress_t transmitterRtSubaddress, uint16_t gapTime_uS, naibrd_1553_bc_msg_options_t bcMsgOptions)
	Create a RT to Broadcast message.
NAIBRDFUNC naibrd_1553_t NAIAPI	naibrd_1553_BcMsgCreateBroadcastMode (int16_t device, int16_t messageId, int16_t dataBlockId, naibrd_1553_messageDirection_t messageDirection, naibrd_1553_bc_mode_commands_t modeCommand, uint16_t gapTime_uS, naibrd_1553_bc_msg_options_t bcMsgOptions)
	Create a Broadcast Mode message.
NAIBRDFUNC naibrd_1553_t NAIAPI	naibrd_1553_BcMsgCreate (int16_t device, int16_t messageId, int16_t dataBlockIdForMessage1, uint16_t bcControlWordForMessage1, uint16_t commandWord1ForMessage1, uint16_t commandWord2ForMessage1, uint16_t gapTimeForMessage1_uS, int16_t dataBlockIdForMessage2, uint16_t bcControlWordForMessage2, uint16_t commandWord1ForMessage2, uint16_t commandWord2ForMessage2, uint16_t gapTimeForMessage2_uS, naibrd_1553_bc_msg_options_t bcMsgOptions)
	Create a single or dual BC message.
NAIBRDFUNC naibrd_1553_t NAIAPI	naibrd_1553_BcMsgDelete (int16_t device, int16_t messageId)
	Delete a BC message.

Detailed Description

Function Documentation

naibrd_1553_BcMsgCreate()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_BcMsgCreate	(	int16_t	device,
		int16_t	messageId,
		int16_t	dataBlockIdForMessage1,
		uint16_t	bcControlWordForMessage1,
		uint16_t	commandWord1ForMessage1,
		uint16_t	commandWord2ForMessage1,
		uint16_t	gapTimeForMessage1_uS,
		int16_t	dataBlockIdForMessage2,
		uint16_t	bcControlWordForMessage2,
		uint16_t	commandWord1ForMessage2,
		uint16_t	commandWord2ForMessage2,
		uint16_t	gapTimeForMessage2_uS,
		naibrd_1553_bc_msg_options_t	bcMsgOptions )

Create a single or dual BC message.

Parameters

device	: (Input) Logical Device Number (0-31).
messageId	: (Input) Unique message ID.
dataBlockIdForMessage1	: (Input) Unique data block ID of an existing data block for message 1.
bcControlWordForMessage1	: (Input) BC control word of message 1. This is an OR'ed combination of the following: * NAIBRD_1553_BC_CTRL_1553A * MIL-STD-1553A. * * NAIBRD_1553_BC_CTRL_1553B * MIL-STD-1553B. * * NAIBRD_1553_BC_CTRL_END_OF_MESSAGE_INTERRUPT_ENABLED * End of Message Interrupt enabled. * * NAIBRD_1553_BC_CTRL_BROADCAST_CHECK_MASKED * Broadcast check masked. * * NAIBRD_1553_BC_CTRL_LOOPBACK_TEST_PERFORMED * Enable offline self test. * * NAIBRD_1553_BC_CTRL_BUS_A * Send message on bus A. * * NAIBRD_1553_BC_CTRL_BUS_B * Send message on bus B. * * NAIBRD_1553_BC_CTRL_RETRY_ENABLED * Message retry enable. * * NAIBRD_1553_BC_CTRL_RESERVE_STATUS_BITS_MASKED * Reserved status bit masked. * * NAIBRD_1553_BC_CTRL_TERMINAL_STATUS_FLAG_MASKED * Terminal status flag masked. * * NAIBRD_1553_BC_CTRL_SUBSYSTEM_STATUS_FLAG_MASKED * Subsystem status flag masked. * * NAIBRD_1553_BC_CTRL_BUSY_STATUS_BIT_MASKED * Busy status bit masked. * * NAIBRD_1553_BC_CTRL_SERVICE_REQUEST_STATUS_BIT_MASKED * Service request status bit masked. * * NAIBRD_1553_BC_CTRL_MESSAGE_ERROR_STATUS_BIT_MASKED * Message error status bit masked. * * NAIBRD_1553_BC_CTRL_TX_TIMETAG_IN_SYNC_W_DATA_MODE_CMD * Tx time tag in sync with data mode command. *
commandWord1ForMessage1	: (Input) Command Word 1 of message 1.
commandWord2ForMessage1	: (Input) Command Word 2 of message 1.
gapTimeForMessage1_uS	: (Input) Time to next message 1 (in uS).
dataBlockIdForMessage2	: (Input) Unique data block ID of an existing data block for message 2.
bcControlWordForMessage2	: (Input) BC control word of message 2. This is an OR'ed combination of the following: * NAIBRD_1553_BC_CTRL_1553A * MIL-STD-1553A. * * NAIBRD_1553_BC_CTRL_1553B * MIL-STD-1553B. * * NAIBRD_1553_BC_CTRL_END_OF_MESSAGE_INTERRUPT_ENABLED * End of Message Interrupt enabled. * * NAIBRD_1553_BC_CTRL_BROADCAST_CHECK_MASKED * Broadcast check masked. * * NAIBRD_1553_BC_CTRL_LOOPBACK_TEST_PERFORMED * Enable offline self test. * * NAIBRD_1553_BC_CTRL_BUS_A * Send message on bus A. * * NAIBRD_1553_BC_CTRL_BUS_B * Send message on bus B. * * NAIBRD_1553_BC_CTRL_RETRY_ENABLED * Message retry enable. * * NAIBRD_1553_BC_CTRL_RESERVE_STATUS_BITS_MASKED * Reserved status bit masked. * * NAIBRD_1553_BC_CTRL_TERMINAL_STATUS_FLAG_MASKED * Terminal status flag masked. * * NAIBRD_1553_BC_CTRL_SUBSYSTEM_STATUS_FLAG_MASKED * Subsystem status flag masked. * * NAIBRD_1553_BC_CTRL_BUSY_STATUS_BIT_MASKED * Busy status bit masked. * * NAIBRD_1553_BC_CTRL_SERVICE_REQUEST_STATUS_BIT_MASKED * Service request status bit masked. * * NAIBRD_1553_BC_CTRL_MESSAGE_ERROR_STATUS_BIT_MASKED * Message error status bit masked. * * NAIBRD_1553_BC_CTRL_TX_TIMETAG_IN_SYNC_W_DATA_MODE_CMD * Tx time tag in sync with data mode command. *
commandWord1ForMessage2	: (Input) Command Word 1 of message 2.
commandWord2ForMessage2	: (Input) Command Word 2 of message 2.
gapTimeForMessage2_uS	: (Input) Time to next message 2 (in uS).
bcMsgOptions	: (Input) Message options that may contain an OR'ed combination of the following: * NAIBRD_1553_BC_CTRL_1553A * MIL-STD-1553A. * * NAIBRD_1553_BC_CTRL_1553B * MIL-STD-1553B. * * NAIBRD_1553_BC_CTRL_END_OF_MESSAGE_INTERRUPT_ENABLED * End of Message Interrupt enabled. * * NAIBRD_1553_BC_CTRL_BROADCAST_CHECK_MASKED * Broadcast check masked. * * NAIBRD_1553_BC_CTRL_LOOPBACK_TEST_PERFORMED * Enable offline self test. * * NAIBRD_1553_BC_CTRL_BUS_A * Send message on bus A. * * NAIBRD_1553_BC_CTRL_BUS_B * Send message on bus B. * * NAIBRD_1553_BC_CTRL_RETRY_ENABLED * Message retry enable. * * NAIBRD_1553_BC_CTRL_RESERVE_STATUS_BITS_MASKED * Reserved status bit masked. * * NAIBRD_1553_BC_CTRL_TERMINAL_STATUS_FLAG_MASKED * Terminal status flag masked. * * NAIBRD_1553_BC_CTRL_SUBSYSTEM_STATUS_FLAG_MASKED * Subsystem status flag masked. * * NAIBRD_1553_BC_CTRL_BUSY_STATUS_BIT_MASKED * Busy status bit masked. * * NAIBRD_1553_BC_CTRL_SERVICE_REQUEST_STATUS_BIT_MASKED * Service request status bit masked. * * NAIBRD_1553_BC_CTRL_MESSAGE_ERROR_STATUS_BIT_MASKED * Message error status bit masked. * * NAIBRD_1553_BC_CTRL_TX_TIMETAG_IN_SYNC_W_DATA_MODE_CMD * Tx time tag in sync with data mode command. * * NAIBRD_1553_BC_MESSAGE_OPT_DUAL_MESSAGE * A pair of messages stored one after the other in device memory to support an XQF opcode. * * NAIBRD_1553_BC_MESSAGE_OPT_STAY_ON_ALTERNATE_BUS * A specific usage of XQF opcode when the message fails, flip to the double buffered message and stay on it until next error. *

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_RC_INVALID_PARAMETER when an invalid messageId, dataBlockIdForMessage1 or dataBlockIdForMessage2 is specified
• NAIBRD_1553_RC_INVALID_MESSAGE_OPTIONS when invalid options are specified
• NAIBRD_1553_RC_BC_OBJECT_ALREADY_EXISTS when a message associated with messageId already exists
• NAIBRD_1553_RC_UNDEFINED_NODE when a data block identified by dataBlockIdForMessage1 or dataBlockIdForMessage2 is not defined
• NAIBRD_1553_RC_BC_INVALID_DATA_BLOCK_SIZE when the data block size is not suitable for the given command

naibrd_1553_BcMsgCreateBcToBroadcast()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_BcMsgCreateBcToBroadcast	(	int16_t	device,
		int16_t	messageId,
		int16_t	dataBlockId,
		naibrd_1553_rt_subaddress_t	receiverRtSubaddress,
		uint16_t	wordCount,
		uint16_t	gapTime_uS,
		naibrd_1553_bc_msg_options_t	bcMsgOptions )

Create a BC to Broadcast message.

Parameters

device	: (Input) Logical Device Number (0-31).
messageId	: (Input) Unique message ID.
dataBlockId	: (Input) Unique data block ID of an existing data block.
receiverRtSubaddress	: (Input) Receiving RT Subaddress.
wordCount	: (Input) Message Word Count.
gapTime_uS	: (Input) Time to next message (in uS).
bcMsgOptions	: (Input) Message options that may contain an OR'ed combination of the following: * NAIBRD_1553_BC_CTRL_1553A * MIL-STD-1553A. * * NAIBRD_1553_BC_CTRL_1553B * MIL-STD-1553B. * * NAIBRD_1553_BC_CTRL_END_OF_MESSAGE_INTERRUPT_ENABLED * End of Message Interrupt enabled. * * NAIBRD_1553_BC_CTRL_BROADCAST_CHECK_MASKED * Broadcast check masked. * * NAIBRD_1553_BC_CTRL_LOOPBACK_TEST_PERFORMED * Enable offline self test. * * NAIBRD_1553_BC_CTRL_BUS_A * Send message on bus A. * * NAIBRD_1553_BC_CTRL_BUS_B * Send message on bus B. * * NAIBRD_1553_BC_CTRL_RETRY_ENABLED * Message retry enable. * * NAIBRD_1553_BC_CTRL_RESERVE_STATUS_BITS_MASKED * Reserved status bit masked. * * NAIBRD_1553_BC_CTRL_TERMINAL_STATUS_FLAG_MASKED * Terminal status flag masked. * * NAIBRD_1553_BC_CTRL_SUBSYSTEM_STATUS_FLAG_MASKED * Subsystem status flag masked. * * NAIBRD_1553_BC_CTRL_BUSY_STATUS_BIT_MASKED * Busy status bit masked. * * NAIBRD_1553_BC_CTRL_SERVICE_REQUEST_STATUS_BIT_MASKED * Service request status bit masked. * * NAIBRD_1553_BC_CTRL_MESSAGE_ERROR_STATUS_BIT_MASKED * Message error status bit masked. * * NAIBRD_1553_BC_CTRL_TX_TIMETAG_IN_SYNC_W_DATA_MODE_CMD * Tx time tag in sync with data mode command. * * NAIBRD_1553_BC_MESSAGE_OPT_DUAL_MESSAGE * A pair of messages stored one after the other in device memory to support an XQF opcode. * * NAIBRD_1553_BC_MESSAGE_OPT_STAY_ON_ALTERNATE_BUS * A specific usage of XQF opcode when the message fails, flip to the double buffered message and stay on it until next error. *

Returns

• NAI_SUCCESS when function is completed successfully
• NAIBRD_1553_RC_INVALID_MESSAGE_OPTIONS when invalid bcMsgOptions are specified

naibrd_1553_BcMsgCreateBcToRt()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_BcMsgCreateBcToRt	(	int16_t	device,
		int16_t	messageId,
		int16_t	dataBlockId,
		naibrd_1553_rt_address_t	receiverRt,
		naibrd_1553_rt_subaddress_t	receiverRtSubaddress,
		uint16_t	wordCount,
		uint16_t	gapTime_uS,
		naibrd_1553_bc_msg_options_t	bcMsgOptions )

Create a BC to RT message.

Parameters

device	: (Input) Logical Device Number (0-31).
messageId	: (Input) Unique message ID.
dataBlockId	: (Input) Unique data block ID of an existing data block.
receiverRt	: (Input) Receiving RT Address.
receiverRtSubaddress	: (Input) Receiving RT Subaddress.
wordCount	: (Input) Message Word Count.
gapTime_uS	: (Input) Time to next message (in uS).
bcMsgOptions	: (Input) Message options that may contain an OR'ed combination of the following: * NAIBRD_1553_BC_CTRL_1553A * MIL-STD-1553A. * * NAIBRD_1553_BC_CTRL_1553B * MIL-STD-1553B. * * NAIBRD_1553_BC_CTRL_END_OF_MESSAGE_INTERRUPT_ENABLED * End of Message Interrupt enabled. * * NAIBRD_1553_BC_CTRL_BROADCAST_CHECK_MASKED * Broadcast check masked. * * NAIBRD_1553_BC_CTRL_LOOPBACK_TEST_PERFORMED * Enable offline self test. * * NAIBRD_1553_BC_CTRL_BUS_A * Send message on bus A. * * NAIBRD_1553_BC_CTRL_BUS_B * Send message on bus B. * * NAIBRD_1553_BC_CTRL_RETRY_ENABLED * Message retry enable. * * NAIBRD_1553_BC_CTRL_RESERVE_STATUS_BITS_MASKED * Reserved status bit masked. * * NAIBRD_1553_BC_CTRL_TERMINAL_STATUS_FLAG_MASKED * Terminal status flag masked. * * NAIBRD_1553_BC_CTRL_SUBSYSTEM_STATUS_FLAG_MASKED * Subsystem status flag masked. * * NAIBRD_1553_BC_CTRL_BUSY_STATUS_BIT_MASKED * Busy status bit masked. * * NAIBRD_1553_BC_CTRL_SERVICE_REQUEST_STATUS_BIT_MASKED * Service request status bit masked. * * NAIBRD_1553_BC_CTRL_MESSAGE_ERROR_STATUS_BIT_MASKED * Message error status bit masked. * * NAIBRD_1553_BC_CTRL_TX_TIMETAG_IN_SYNC_W_DATA_MODE_CMD * Tx time tag in sync with data mode command. * * NAIBRD_1553_BC_MESSAGE_OPT_DUAL_MESSAGE * A pair of messages stored one after the other in device memory to support an XQF opcode. * * NAIBRD_1553_BC_MESSAGE_OPT_STAY_ON_ALTERNATE_BUS * A specific usage of XQF opcode when the message fails, flip to the double buffered message and stay on it until next error. *

Returns

• NAI_SUCCESS when function is completed successfully
• NAIBRD_1553_RC_INVALID_MESSAGE_OPTIONS when invalid options are specified

naibrd_1553_BcMsgCreateBroadcastMode()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_BcMsgCreateBroadcastMode	(	int16_t	device,
		int16_t	messageId,
		int16_t	dataBlockId,
		naibrd_1553_messageDirection_t	messageDirection,
		naibrd_1553_bc_mode_commands_t	modeCommand,
		uint16_t	gapTime_uS,
		naibrd_1553_bc_msg_options_t	bcMsgOptions )

Create a Broadcast Mode message.

Parameters

device	: (Input) Logical Device Number (0-31).
messageId	: (Input) Unique message ID.
dataBlockId	: (Input) Unique data block ID of an existing data block.
messageDirection	: (Input) Transmit or Receive (NAIBRD_1553_CMD_TX or NAIBRD_1553_CMD_RX).
modeCommand	: (Input) Mode Code Command (0-31).
gapTime_uS	: (Input) Time to next message (in uS).
bcMsgOptions	: (Input) Message options that may contain an OR'ed combination of the following: * NAIBRD_1553_BC_CTRL_1553A * MIL-STD-1553A. * * NAIBRD_1553_BC_CTRL_1553B * MIL-STD-1553B. * * NAIBRD_1553_BC_CTRL_END_OF_MESSAGE_INTERRUPT_ENABLED * End of Message Interrupt enabled. * * NAIBRD_1553_BC_CTRL_BROADCAST_CHECK_MASKED * Broadcast check masked. * * NAIBRD_1553_BC_CTRL_LOOPBACK_TEST_PERFORMED * Enable offline self test. * * NAIBRD_1553_BC_CTRL_BUS_A * Send message on bus A. * * NAIBRD_1553_BC_CTRL_BUS_B * Send message on bus B. * * NAIBRD_1553_BC_CTRL_RETRY_ENABLED * Message retry enable. * * NAIBRD_1553_BC_CTRL_RESERVE_STATUS_BITS_MASKED * Reserved status bit masked. * * NAIBRD_1553_BC_CTRL_TERMINAL_STATUS_FLAG_MASKED * Terminal status flag masked. * * NAIBRD_1553_BC_CTRL_SUBSYSTEM_STATUS_FLAG_MASKED * Subsystem status flag masked. * * NAIBRD_1553_BC_CTRL_BUSY_STATUS_BIT_MASKED * Busy status bit masked. * * NAIBRD_1553_BC_CTRL_SERVICE_REQUEST_STATUS_BIT_MASKED * Service request status bit masked. * * NAIBRD_1553_BC_CTRL_MESSAGE_ERROR_STATUS_BIT_MASKED * Message error status bit masked. * * NAIBRD_1553_BC_CTRL_TX_TIMETAG_IN_SYNC_W_DATA_MODE_CMD * Tx time tag in sync with data mode command. * * NAIBRD_1553_BC_MESSAGE_OPT_DUAL_MESSAGE * A pair of messages stored one after the other in device memory to support an XQF opcode. * * NAIBRD_1553_BC_MESSAGE_OPT_STAY_ON_ALTERNATE_BUS * A specific usage of XQF opcode when the message fails, flip to the double buffered message and stay on it until next error. *

Returns

• NAI_SUCCESS when function is completed successfully
• NAIBRD_1553_RC_INVALID_MESSAGE_OPTIONS when invalid bcMsgOptions are specified

naibrd_1553_BcMsgCreateMode()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_BcMsgCreateMode	(	int16_t	device,
		int16_t	messageId,
		int16_t	dataBlockId,
		naibrd_1553_rt_address_t	rt,
		naibrd_1553_messageDirection_t	messageDirection,
		naibrd_1553_bc_mode_commands_t	modeCommand,
		uint16_t	gapTime_uS,
		naibrd_1553_bc_msg_options_t	bcMsgOptions )

Create a Mode message.

Parameters

device	: (Input) Logical Device Number (0-31).
messageId	: (Input) Unique message ID.
dataBlockId	: (Input) Unique data block ID of an existing data block.
rt	: (Input) RT Address.
messageDirection	: (Input) Transmit or Receive (NAIBRD_1553_CMD_TX or NAIBRD_1553_CMD_RX).
modeCommand	: (Input) Mode Code Command (0-31).
gapTime_uS	: (Input) Time to next message (in uS).
bcMsgOptions	: (Input) Message options that may contain an OR'ed combination of the following: * NAIBRD_1553_BC_CTRL_1553A * MIL-STD-1553A. * * NAIBRD_1553_BC_CTRL_1553B * MIL-STD-1553B. * * NAIBRD_1553_BC_CTRL_END_OF_MESSAGE_INTERRUPT_ENABLED * End of Message Interrupt enabled. * * NAIBRD_1553_BC_CTRL_BROADCAST_CHECK_MASKED * Broadcast check masked. * * NAIBRD_1553_BC_CTRL_LOOPBACK_TEST_PERFORMED * Enable offline self test. * * NAIBRD_1553_BC_CTRL_BUS_A * Send message on bus A. * * NAIBRD_1553_BC_CTRL_BUS_B * Send message on bus B. * * NAIBRD_1553_BC_CTRL_RETRY_ENABLED * Message retry enable. * * NAIBRD_1553_BC_CTRL_RESERVE_STATUS_BITS_MASKED * Reserved status bit masked. * * NAIBRD_1553_BC_CTRL_TERMINAL_STATUS_FLAG_MASKED * Terminal status flag masked. * * NAIBRD_1553_BC_CTRL_SUBSYSTEM_STATUS_FLAG_MASKED * Subsystem status flag masked. * * NAIBRD_1553_BC_CTRL_BUSY_STATUS_BIT_MASKED * Busy status bit masked. * * NAIBRD_1553_BC_CTRL_SERVICE_REQUEST_STATUS_BIT_MASKED * Service request status bit masked. * * NAIBRD_1553_BC_CTRL_MESSAGE_ERROR_STATUS_BIT_MASKED * Message error status bit masked. * * NAIBRD_1553_BC_CTRL_TX_TIMETAG_IN_SYNC_W_DATA_MODE_CMD * Tx time tag in sync with data mode command. * * NAIBRD_1553_BC_MESSAGE_OPT_DUAL_MESSAGE * A pair of messages stored one after the other in device memory to support an XQF opcode. * * NAIBRD_1553_BC_MESSAGE_OPT_STAY_ON_ALTERNATE_BUS * A specific usage of XQF opcode when the message fails, flip to the double buffered message and stay on it until next error. *

Returns

• NAI_SUCCESS when function is completed successfully
• NAIBRD_1553_RC_INVALID_MESSAGE_OPTIONS when invalid bcMsgOptions are specified

naibrd_1553_BcMsgCreateRtToBc()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_BcMsgCreateRtToBc	(	int16_t	device,
		int16_t	messageId,
		int16_t	dataBlockId,
		naibrd_1553_rt_address_t	transmitterRt,
		naibrd_1553_rt_subaddress_t	transmitterRtSubaddress,
		uint16_t	wordCount,
		uint16_t	gapTime_uS,
		naibrd_1553_bc_msg_options_t	bcMsgOptions )

Create a RT to BC message.

Parameters

device	: (Input) Logical Device Number (0-31).
messageId	: (Input) Unique message ID.
dataBlockId	: (Input) Unique data block ID of an existing data block.
transmitterRt	: (Input) Transmitting RT Address.
transmitterRtSubaddress	: (Input) Transmitter RT Subaddress.
wordCount	: (Input) Message Word Count.
gapTime_uS	: (Input) Time to next message (in uS).
bcMsgOptions	: (Input) Message options that may contain an OR'ed combination of the following: * NAIBRD_1553_BC_CTRL_1553A * MIL-STD-1553A. * * NAIBRD_1553_BC_CTRL_1553B * MIL-STD-1553B. * * NAIBRD_1553_BC_CTRL_END_OF_MESSAGE_INTERRUPT_ENABLED * End of Message Interrupt enabled. * * NAIBRD_1553_BC_CTRL_BROADCAST_CHECK_MASKED * Broadcast check masked. * * NAIBRD_1553_BC_CTRL_LOOPBACK_TEST_PERFORMED * Enable offline self test. * * NAIBRD_1553_BC_CTRL_BUS_A * Send message on bus A. * * NAIBRD_1553_BC_CTRL_BUS_B * Send message on bus B. * * NAIBRD_1553_BC_CTRL_RETRY_ENABLED * Message retry enable. * * NAIBRD_1553_BC_CTRL_RESERVE_STATUS_BITS_MASKED * Reserved status bit masked. * * NAIBRD_1553_BC_CTRL_TERMINAL_STATUS_FLAG_MASKED * Terminal status flag masked. * * NAIBRD_1553_BC_CTRL_SUBSYSTEM_STATUS_FLAG_MASKED * Subsystem status flag masked. * * NAIBRD_1553_BC_CTRL_BUSY_STATUS_BIT_MASKED * Busy status bit masked. * * NAIBRD_1553_BC_CTRL_SERVICE_REQUEST_STATUS_BIT_MASKED * Service request status bit masked. * * NAIBRD_1553_BC_CTRL_MESSAGE_ERROR_STATUS_BIT_MASKED * Message error status bit masked. * * NAIBRD_1553_BC_CTRL_TX_TIMETAG_IN_SYNC_W_DATA_MODE_CMD * Tx time tag in sync with data mode command. * * NAIBRD_1553_BC_MESSAGE_OPT_DUAL_MESSAGE * A pair of messages stored one after the other in device memory to support an XQF opcode. * * NAIBRD_1553_BC_MESSAGE_OPT_STAY_ON_ALTERNATE_BUS * A specific usage of XQF opcode when the message fails, flip to the double buffered message and stay on it until next error. *

Returns

• NAI_SUCCESS when function is completed successfully
• NAIBRD_1553_RC_INVALID_MESSAGE_OPTIONS when invalid options are specified

naibrd_1553_BcMsgCreateRtToBroadcast()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_BcMsgCreateRtToBroadcast	(	int16_t	device,
		int16_t	messageId,
		int16_t	dataBlockId,
		naibrd_1553_rt_subaddress_t	receiverRtSubaddress,
		uint16_t	wordCount,
		naibrd_1553_rt_address_t	transmitterRt,
		naibrd_1553_rt_subaddress_t	transmitterRtSubaddress,
		uint16_t	gapTime_uS,
		naibrd_1553_bc_msg_options_t	bcMsgOptions )

Create a RT to Broadcast message.

Parameters

device	: (Input) Logical Device Number (0-31).
messageId	: (Input) Unique message ID.
dataBlockId	: (Input) Unique data block ID of an existing data block.
receiverRtSubaddress	: (Input) Receiving RT Subaddress.
wordCount	: (Input) Message Word Count.
transmitterRt	: (Input) Transmitter RT Address.
transmitterRtSubaddress	: (Input) Transmitter RT Subaddress.
gapTime_uS	: (Input) Time to next message (in uS).
bcMsgOptions	: (Input) Message options that may contain an OR'ed combination of the following: * NAIBRD_1553_BC_CTRL_1553A * MIL-STD-1553A. * * NAIBRD_1553_BC_CTRL_1553B * MIL-STD-1553B. * * NAIBRD_1553_BC_CTRL_END_OF_MESSAGE_INTERRUPT_ENABLED * End of Message Interrupt enabled. * * NAIBRD_1553_BC_CTRL_BROADCAST_CHECK_MASKED * Broadcast check masked. * * NAIBRD_1553_BC_CTRL_LOOPBACK_TEST_PERFORMED * Enable offline self test. * * NAIBRD_1553_BC_CTRL_BUS_A * Send message on bus A. * * NAIBRD_1553_BC_CTRL_BUS_B * Send message on bus B. * * NAIBRD_1553_BC_CTRL_RETRY_ENABLED * Message retry enable. * * NAIBRD_1553_BC_CTRL_RESERVE_STATUS_BITS_MASKED * Reserved status bit masked. * * NAIBRD_1553_BC_CTRL_TERMINAL_STATUS_FLAG_MASKED * Terminal status flag masked. * * NAIBRD_1553_BC_CTRL_SUBSYSTEM_STATUS_FLAG_MASKED * Subsystem status flag masked. * * NAIBRD_1553_BC_CTRL_BUSY_STATUS_BIT_MASKED * Busy status bit masked. * * NAIBRD_1553_BC_CTRL_SERVICE_REQUEST_STATUS_BIT_MASKED * Service request status bit masked. * * NAIBRD_1553_BC_CTRL_MESSAGE_ERROR_STATUS_BIT_MASKED * Message error status bit masked. * * NAIBRD_1553_BC_CTRL_TX_TIMETAG_IN_SYNC_W_DATA_MODE_CMD * Tx time tag in sync with data mode command. * * NAIBRD_1553_BC_MESSAGE_OPT_DUAL_MESSAGE * A pair of messages stored one after the other in device memory to support an XQF opcode. * * NAIBRD_1553_BC_MESSAGE_OPT_STAY_ON_ALTERNATE_BUS * A specific usage of XQF opcode when the message fails, flip to the double buffered message and stay on it until next error. *

Returns

• NAI_SUCCESS when function is completed successfully
• NAIBRD_1553_RC_INVALID_MESSAGE_OPTIONS when invalid bcMsgOptions are specified

naibrd_1553_BcMsgCreateRtToRt()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_BcMsgCreateRtToRt	(	int16_t	device,
		int16_t	messageId,
		int16_t	dataBlockId,
		naibrd_1553_rt_address_t	receiverRt,
		naibrd_1553_rt_subaddress_t	receiverRtSubaddress,
		uint16_t	wordCount,
		naibrd_1553_rt_address_t	transmitterRt,
		naibrd_1553_rt_subaddress_t	transmitterRtSubaddress,
		uint16_t	gapTime_uS,
		naibrd_1553_bc_msg_options_t	bcMsgOptions )

Create a RT to RT message.

Parameters

device	: (Input) Logical Device Number (0-31).
messageId	: (Input) Unique message ID.
dataBlockId	: (Input) Unique data block ID of an existing data block.
receiverRt	: (Input) Receiving RT Address.
receiverRtSubaddress	: (Input) Receiving RT Subaddress.
wordCount	: (Input) Message Word Count.
transmitterRt	: (Input) Transmitter RT Address.
transmitterRtSubaddress	: (Input) Transmitter RT Subaddress.
gapTime_uS	: (Input) Time to next message (in uS).
bcMsgOptions	: (Input) Message options that may contain an OR'ed combination of the following: * NAIBRD_1553_BC_CTRL_1553A * MIL-STD-1553A. * * NAIBRD_1553_BC_CTRL_1553B * MIL-STD-1553B. * * NAIBRD_1553_BC_CTRL_END_OF_MESSAGE_INTERRUPT_ENABLED * End of Message Interrupt enabled. * * NAIBRD_1553_BC_CTRL_BROADCAST_CHECK_MASKED * Broadcast check masked. * * NAIBRD_1553_BC_CTRL_LOOPBACK_TEST_PERFORMED * Enable offline self test. * * NAIBRD_1553_BC_CTRL_BUS_A * Send message on bus A. * * NAIBRD_1553_BC_CTRL_BUS_B * Send message on bus B. * * NAIBRD_1553_BC_CTRL_RETRY_ENABLED * Message retry enable. * * NAIBRD_1553_BC_CTRL_RESERVE_STATUS_BITS_MASKED * Reserved status bit masked. * * NAIBRD_1553_BC_CTRL_TERMINAL_STATUS_FLAG_MASKED * Terminal status flag masked. * * NAIBRD_1553_BC_CTRL_SUBSYSTEM_STATUS_FLAG_MASKED * Subsystem status flag masked. * * NAIBRD_1553_BC_CTRL_BUSY_STATUS_BIT_MASKED * Busy status bit masked. * * NAIBRD_1553_BC_CTRL_SERVICE_REQUEST_STATUS_BIT_MASKED * Service request status bit masked. * * NAIBRD_1553_BC_CTRL_MESSAGE_ERROR_STATUS_BIT_MASKED * Message error status bit masked. * * NAIBRD_1553_BC_CTRL_TX_TIMETAG_IN_SYNC_W_DATA_MODE_CMD * Tx time tag in sync with data mode command. * * NAIBRD_1553_BC_MESSAGE_OPT_DUAL_MESSAGE * A pair of messages stored one after the other in device memory to support an XQF opcode. * * NAIBRD_1553_BC_MESSAGE_OPT_STAY_ON_ALTERNATE_BUS * A specific usage of XQF opcode when the message fails, flip to the double buffered message and stay on it until next error. *

Returns

• NAI_SUCCESS when function is completed successfully
• NAIBRD_1553_RC_INVALID_MESSAGE_OPTIONS when invalid options are specified

naibrd_1553_BcMsgDelete()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_BcMsgDelete	(	int16_t	device,
		int16_t	messageId )

Delete a BC message.

Parameters

device	: (Input) Logical Device Number (0-31).
messageId	: (Input) Unique message ID.

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_RC_INVALID_PARAMETER when an invalid swMessageId is specified
• NAIBRD_1553_RC_UNDEFINED_MESSAGE_BLOCK when a message associated with swMessageId is undefined
• NAIBRD_1553_RC_NOT_SUPPORTED when the opcode command in the message is still in use