Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
1553 Remote Terminal (RT) Functions
1553 Module Functions

Functions

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtInitialize (int16_t swDevice, uint16_t wCommandStackSize, uint32_t dwOptions)
 Configure a RT.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtSetAddressSource (int16_t swDevice, uint16_t wRtAddressSource)
 Set RT address source as either internal or external. This function is not supported for FTJ/FTK modules.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtGetAddressSource (int16_t swDevice, uint16_t *wpRtAddressSource)
 Gets RT address source (external or internal).
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtAddressRelatch (int16_t swDevice)
 If RT_ADR_LAT is set high in the Misc Bits Auxiliary register (0x2), this function re-latches the RT address based on the current state of the external RT address pins. Use this function to make the device re-read the external RT address pins to reset the RT address of the device. If RT_ADR_LAT is set high, changing the state of the external pins by itself will not change the RT address of the device.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtSetAddress (int16_t swDevice, uint16_t wRtAddress)
 This function is used to set the RT address if the RT address source is set to Internal.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtGetAddress (int16_t swDevice, uint16_t *wpRtAddress)
 Retrieves the RT address.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtStart (int16_t swDevice)
 Starts the RT.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtStop (int16_t swDevice)
 Stops the RT.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtDataBlockGetSize (uint16_t wDataBlockType, uint16_t *wpSizeOfAllocatedDeviceMemory, uint16_t *wpActualSizeOfDataBlock)
 Gets the size of a data block type.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtDataBlockCreate (int16_t swDevice, int16_t swDataBlockId, uint16_t wDataBlockType, uint16_t *wapBuffer, uint16_t wBufferSize)
 Creates a RT data block to be used.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtDataBlockGetAddress (int16_t swDevice, int16_t swDataBlockId, uint16_t *wpDeviceMemoryAddress)
 Gets the memory address of the specified RT data block.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtDataBlockDelete (int16_t swDevice, int16_t swDataBlockId)
 Deletes a data block represented by the given block id.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtDataBlockWrite (int16_t swDevice, int16_t swDataBlockId, uint16_t *wapBuffer, uint16_t wBufferSize, uint16_t wOffset)
 Writes data to a data block.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtDataBlockRead (int16_t swDevice, int16_t swDataBlockId, uint16_t *wapBuffer, uint16_t wBufferSize, uint16_t wOffset)
 Reads data from a data block.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtDataBlockMapToSubaddress (int16_t swDevice, int16_t swDataBlockId, uint16_t wSubaddress, uint16_t wMessageTypes, uint16_t wIrqOptions, uint16_t bIsSubaddressLegalizationRequested)
 Maps a data block to a subaddress.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtDataBlockUnmapFromSubaddress (int16_t swDevice, int16_t swDataBlockId, uint16_t wSubaddress, uint16_t wMessageTypes)
 Unmaps a data block from a subaddress.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtTxDataBlockSwap (int16_t swDevice, int16_t swDataBlockId, uint16_t wSubaddress)
 This function swaps the data block that is currently mapped to a given Tx subaddress with the data block given by swDataBlockId. This function is especially useful for multiple buffering of Tx messages for a RT to BC or RT to RT commands.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtModeCodeIrqEnable (int16_t swDevice, uint16_t wModeCodeType, uint16_t wModeCodeIrq)
 Enable interrupt on a received mode code.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtModeCodeIrqDisable (int16_t swDevice, uint16_t wModeCodeType, uint16_t wModeCodeIrq)
 Disable interrupts on one or more mode codes.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtModeCodeGetIrqStatus (int16_t swDevice, uint16_t wModeCodeType, uint16_t *wpModeCodeIrq)
 Gets the status of which mode codes will generate interrupts.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtModeCodeReadData (int16_t swDevice, uint16_t wDataContainingModeCode, uint16_t *wpData)
 Reads data from the Mode Code Data Locations Table.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtModeCodeWriteData (int16_t swDevice, uint16_t wDataContainingModeCode, uint16_t wData)
 Writes data to the Mode Code Data Locations Table.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtMessageLegalityEnable (int16_t swDevice, uint16_t wOwnAddressOrBroadcast, uint16_t wMessageDirection, uint16_t wSubaddress, uint32_t dwWordCountOrModeCodeMask)
 Legalize messages for a subaddress with a given set of criteria.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtMessageLegalityDisable (int16_t swDevice, uint16_t wOwnAddressOrBroadcast, uint16_t wMessageDirection, uint16_t wSubaddress, uint32_t dwWordCountOrModeCodeMask)
 Illegalize messages for a subaddress with a given set of criteria.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtMessageLegalityGetStatus (int16_t swDevice, uint16_t wOwnAddressOrBroadcast, uint16_t wMessageDirection, uint16_t wSubaddress, uint32_t *dwpMessageLegality)
 Gets the legalization status of a subaddress.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtResponseStatusBitsSet (int16_t swDevice, uint16_t wStatusEnablerMask)
 Sets the status enable bits to configure RT status responses.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtResponseStatusBitsUnset (int16_t swDevice, uint16_t wStatusEnablerMask)
 Deactivates the status enable bits for RT status responses.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtResponseStatusBitsGet (int16_t swDevice, uint16_t *wpStatusEnablerMask)
 Gets the status enable bits for RT status responses.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtMessageGetFromStackRaw (int16_t swDevice, uint16_t *wapBuffer, uint16_t wBufferSize)
 Reads raw messages off of the RT command stack. Each message read is NAI_1553_MAX_MESSAGE_SIZE_RT words long (4 words stack entry, 32 words data) regardless of the data word count. Messages will be read until the internal pointer value is equal to the current command stack pointer value, or until the words read surpass wBufferSize. The data stack pointer (3rd word in message) is replaced with a word such that the MSByte contains the count of data words for the read message and the LSByte contains the type of message that was read.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtMessageGetFromStackDecoded (int16_t swDevice, naiDecodedMessageStructure *dmspDecodedMessage, uint16_t wMessageLocationAndRemoval)
 Gets a message from the RT Command Stack and decodes it into a message structure.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtMessageDecodeRaw (int16_t swDevice, uint16_t *wapBuffer, naiDecodedMessageStructure *dmspDecodedMessage)
 Decodes a raw message into a message structure.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtBITWordConfigure (int16_t swDevice, uint16_t wWordLocation, uint16_t wPermitOrInhibitIfRtBusy)
 Configure the way in which the Built in Test word is read and written and inhibit/permit the Built in Test if the RT is busy.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtBITWordRead (int16_t swDevice, uint16_t wWordLocation, uint16_t *wpWord)
 Read the current Built in Test word from the given location.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtBITWordWrite (int16_t swDevice, uint16_t wWord)
 Write the given Built in Test word if the current BIT word location is in the memory.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtHbuffInstall (int16_t swDevice, uint32_t dwHostBufferSize)
 Install given RT device's host buffer.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtHbuffUnInstall (int16_t swDevice)
 Free given RT device's host buffer.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtStkToHbuf32 (int16_t swDevice)
 Record the newly received messages from the command stack of given RT device into its host buffer.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtGetHBufMsgDecoded (int16_t swDevice, naiDecodedMessageStructure *dmspDecodedMessage, uint32_t *dwpMessageCount, uint32_t *dwpStackLostMessageCount, uint32_t *dwpHostBufferLostMessageCount, uint16_t wMessageLocationAndRemoval)
 Read from the host buffer of given RT device the message at given location, decode it into given structure, and purge it if so required. Also get the number of retrieved messages (actually only 0 or 1), the host buffer's current number of lost messages, and the current number of lost messages for given RT device's RT stack.
 
NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RTGetHBufMsgCount (int16_t swDevice)
 Get the number of messages that are currently available in the host buffer that is assigned with given RT device.
 

Detailed Description


Function Documentation

◆ naibrd_1553_RtAddressRelatch()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtAddressRelatch ( int16_t swDevice)

If RT_ADR_LAT is set high in the Misc Bits Auxiliary register (0x2), this function re-latches the RT address based on the current state of the external RT address pins. Use this function to make the device re-read the external RT address pins to reset the RT address of the device. If RT_ADR_LAT is set high, changing the state of the external pins by itself will not change the RT address of the device.

Parameters
swDevice: (Input) Logical Device Number (0-31).
Returns
  • NAI_SUCCESS
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device is not set in RT or RT/MT mode
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state

◆ naibrd_1553_RtBITWordConfigure()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtBITWordConfigure ( int16_t swDevice,
uint16_t wWordLocation,
uint16_t wPermitOrInhibitIfRtBusy )

Configure the way in which the Built in Test word is read and written and inhibit/permit the Built in Test if the RT is busy.

Parameters
swDevice: (Input) Logical Device Number (0-31).
wWordLocation: (Input) Source of the BIT word (NAI_1553_RT_BIT_REGISTER or NAI_1553_RT_BIT_MEMORY). For FTJ/FTK modules, NAI_1760_RT_BIT_REGISTER or NAI_1760_RT_ALT_BIT_REGISTER.
wPermitOrInhibitIfRtBusy: (Input) Permit (NAI_1553_RT_BIT_ENABLED) or inhibit (NAI_1553_RT_BIT_DISABLED) the BIT when the RT is busy.
Returns
  • NAI_SUCCESS when function is completed successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when the value of wWordLocation and/or wPermitOrInhibitIfRtBusy are invalid

◆ naibrd_1553_RtBITWordRead()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtBITWordRead ( int16_t swDevice,
uint16_t wWordLocation,
uint16_t * wpWord )

Read the current Built in Test word from the given location.

Parameters
swDevice: (Input) Logical Device Number (0-31).
wWordLocation: (Input) Source of the BIT word (NAI_1553_RT_BIT_REGISTER or NAI_1553_RT_BIT_MEMORY).

For FTJ/FTK modules, NAI_1760_RT_BIT_REGISTER or NAI_1760_RT_ALT_BIT_REGISTER.

Parameters
wpWord: (Output) The BIT word value.
Returns
  • NAI_SUCCESS when function is completed successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when the wpWord pointer is null and/or wWordLocation is invalid

◆ naibrd_1553_RtBITWordWrite()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtBITWordWrite ( int16_t swDevice,
uint16_t wWord )

Write the given Built in Test word if the current BIT word location is in the memory.

Parameters
swDevice: (Input) Logical Device Number (0-31).
wWord: (Input) The BIT word to write.
Returns
  • NAI_SUCCESS when function is completed successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when the device is currently not configured to use the BIT word in device memory

◆ naibrd_1553_RtDataBlockCreate()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtDataBlockCreate ( int16_t swDevice,
int16_t swDataBlockId,
uint16_t wDataBlockType,
uint16_t * wapBuffer,
uint16_t wBufferSize )

Creates a RT data block to be used.

Parameters
swDevice: (Input) Logical Device Number (0-31).
swDataBlockId: (Input) Unique value representing the block id for future use and removal (Must be greater than 0).
wDataBlockType: (Input) Type of data block to be allocated. 
1 - 32
This value defines the number of words for Single Buffer Mode

NAI_1553_RT_DATABLOCK_DOUBLE        (DDC: ACE_RT_DBLK_DOUBLE)
Double buffered message datablock 64 words long

NAI_1553_RT_DATABLOCK_CIRCULAR_128  (DDC: ACE_RT_DBLK_C_128)
Circular buffer 128 words long

NAI_1553_RT_DATABLOCK_CIRCULAR_256  (DDC: ACE_RT_DBLK_C_256)
Circular buffer 256 words long

NAI_1553_RT_DATABLOCK_CIRCULAR_512  (DDC: ACE_RT_DBLK_C_512)
Circular buffer 512 words long

NAI_1553_RT_DATABLOCK_CIRCULAR_1024  (DDC: ACE_RT_DBLK_C_1024)
Circular buffer 1024 words long

NAI_1553_RT_DATABLOCK_CIRCULAR_2048  (DDC: ACE_RT_DBLK_C_2048)
Circular buffer 2048 words long

NAI_1553_RT_DATABLOCK_CIRCULAR_4096  (DDC: ACE_RT_DBLK_C_4096)
Circular buffer 4096 words long

NAI_1553_RT_DATABLOCK_CIRCULAR_8192  (DDC: ACE_RT_DBLK_C_8192)
Circular buffer 8192 words long
wapBuffer: (Input) Address of a buffer containing info to be copied to the created data block.
wBufferSize: (Input) Number of words in buffer to be copied into the created data block.
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in invalid state
  • NAI_1553_RC_INVALID_PARAMETER when swDataBlockId and/or wDataBlockType values are invalid, or when wBufferSize is greater than size of allocated memory
  • NAI_1553_RC_RT_DATA_BLOCK_EXISTS when the specified data block already exists
  • NAI_1553_RC_ALLOCATION_FAIL when memory allocation failed for this data block

◆ naibrd_1553_RtDataBlockDelete()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtDataBlockDelete ( int16_t swDevice,
int16_t swDataBlockId )

Deletes a data block represented by the given block id.

Parameters
swDevice: (Input) Logical Device Number (0-31).
swDataBlockId: (Input) Unique value representing the block id for future use and removal (Must be greater than 0).
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when the value of swDataBlockId is invalid
  • NAI_1553_RC_UNDEFINED_NODE when the specified data block with given swDataBlockId does not exist

◆ naibrd_1553_RtDataBlockGetAddress()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtDataBlockGetAddress ( int16_t swDevice,
int16_t swDataBlockId,
uint16_t * wpDeviceMemoryAddress )

Gets the memory address of the specified RT data block.

Parameters
swDevice: (Input) Logical Device Number (0-31).
swDataBlockId: (Input) Unique value representing the block id for future use and removal (Must be greater than 0).
wpDeviceMemoryAddress: (Output) Starting address of the data block in device memory.
Returns
  • NAI_SUCCESS
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when the value of swDataBlockId is invalid
  • NAI_1553_RC_UNDEFINED_NODE when the specified data block with given swDataBlockId does not exist

◆ naibrd_1553_RtDataBlockGetSize()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtDataBlockGetSize ( uint16_t wDataBlockType,
uint16_t * wpSizeOfAllocatedDeviceMemory,
uint16_t * wpActualSizeOfDataBlock )

Gets the size of a data block type.

Parameters
wDataBlockType: (Input) Type of data block. 
1 - 32
This value defines the number of words for Single Buffer Mode

NAI_1553_RT_DATABLOCK_DOUBLE        (DDC: ACE_RT_DBLK_DOUBLE)
Double buffered message datablock 64 words long

NAI_1553_RT_DATABLOCK_CIRCULAR_128  (DDC: ACE_RT_DBLK_C_128)
Circular buffer 128 words long

NAI_1553_RT_DATABLOCK_CIRCULAR_256  (DDC: ACE_RT_DBLK_C_256)
Circular buffer 256 words long

NAI_1553_RT_DATABLOCK_CIRCULAR_512  (DDC: ACE_RT_DBLK_C_512)
Circular buffer 512 words long

NAI_1553_RT_DATABLOCK_CIRCULAR_1024  (DDC: ACE_RT_DBLK_C_1024)
Circular buffer 1024 words long

NAI_1553_RT_DATABLOCK_CIRCULAR_2048  (DDC: ACE_RT_DBLK_C_2048)
Circular buffer 2048 words long

NAI_1553_RT_DATABLOCK_CIRCULAR_4096  (DDC: ACE_RT_DBLK_C_4096)
Circular buffer 4096 words long

NAI_1553_RT_DATABLOCK_CIRCULAR_8192  (DDC: ACE_RT_DBLK_C_8192)
Circular buffer 8192 words long
wpSizeOfAllocatedDeviceMemory: (Output) Size of allocated device memory (in words).
wpActualSizeOfDataBlock: (Output) Actual size of data block (in words).
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_PARAMETER when incorrect wDataBlockType is specified, or when wpSizeOfAllocatedDeviceMemory and/or wpActualSizeOfDataBlock pointers are null

◆ naibrd_1553_RtDataBlockMapToSubaddress()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtDataBlockMapToSubaddress ( int16_t swDevice,
int16_t swDataBlockId,
uint16_t wSubaddress,
uint16_t wMessageTypes,
uint16_t wIrqOptions,
uint16_t bIsSubaddressLegalizationRequested )

Maps a data block to a subaddress.

Parameters
swDevice: (Input) Logical Device Number (0-31).
swDataBlockId: (Input) Unique user supplied ID of the previously created data block that will be mapped to an SA. The user provided this ID during the creation of the data block with the naibrd_1553_RtDataBlockCreate() function.
wSubaddress: (Input) Subaddress to be mapped (0-31).
wMessageTypes: (Input) Description of the message types that will be mapped by this command. This parameter is generated by OR'ing the following message types together: 
NAI_1553_RT_MESSAGE_TYPE_RX         (DDC: ACE_RT_MSGTYPE_RX)
NAI_1553_RT_MESSAGE_TYPE_TX         (DDC: ACE_RT_MSGTYPE_TX)
NAI_1553_RT_MESSAGE_TYPE_BROADCAST      (DDC: ACE_RT_MSGTYPE_BCST)
NAI_1553_RT_MESSAGE_TYPE_ALL        (DDC: ACE_RT_MSGTYPE_ALL)
wIrqOptions: (Input) This value can be optionally set to generate interrupts due to circular buffer rollover or an end of message. This value can be either 0 or an OR'ed combination of the following: 
NAI_1553_RT_DATABLOCK_IRQ_CIRC_BUFFER       (DDC: ACE_RT_DBLK_CIRC_IRQ)
NAI_1553_RT_DATABLOCK_IRQ_END_OF_MESSAGE  (DDC: ACE_RT_DBLK_EOM_IRQ)
bIsSubaddressLegalizationRequested: (Input) If this value is set to TRUE, then the Sub-Address being mapped will also be legalized.
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when the value of swDataBlockId, wSubaddress, wMessageTypes and/or wIrqOptions are invalid
  • NAI_1553_RC_RT_DATA_BLOCK_EXISTS when the data block specified by swDataBlockId already exists
  • NAI_1553_RC_RT_DATA_BLOCK_MAPPED when the data block specified by swDataBlockId is already mapped

◆ naibrd_1553_RtDataBlockRead()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtDataBlockRead ( int16_t swDevice,
int16_t swDataBlockId,
uint16_t * wapBuffer,
uint16_t wBufferSize,
uint16_t wOffset )

Reads data from a data block.

Parameters
swDevice: (Input) Logical Device Number (0-31).
swDataBlockId: (Input) Unique user supplied ID of the previously created data block that will be mapped to an SA. The user provided this ID during the creation of the data block with the naibrd_1553_RtDataBlockCreate() function.
wapBuffer: (Output) Buffer that will receive the data from the data block.
wBufferSize: (Input) Size of buffer (in words).
wOffset: (Input) Offset into the buffer where read data will be written to (>= 0).
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when the value of swDataBlockId, wapBuffer, wBufferSize and/or wOffset are invalid
  • NAI_1553_RC_UNDEFINED_NODE when the specified data block with given swDataBlockId does not exist

◆ naibrd_1553_RtDataBlockUnmapFromSubaddress()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtDataBlockUnmapFromSubaddress ( int16_t swDevice,
int16_t swDataBlockId,
uint16_t wSubaddress,
uint16_t wMessageTypes )

Unmaps a data block from a subaddress.

Parameters
swDevice: (Input) Logical Device Number (0-31).
swDataBlockId: (Input) Unique user supplied ID of the previously created data block that will be mapped to an SA. The user provided this ID during the creation of the data block with the naibrd_1553_RtDataBlockCreate() function.
wSubaddress: (Input) Subaddress to be unmapped (0-31).
wMessageTypes: (Input) Description of the message types that will be unmapped by this command. This parameter is generated by OR'ing the following message types together: 
NAI_1553_RT_MESSAGE_TYPE_RX   (DDC: ACE_RT_MSGTYPE_RX)
NAI_1553_RT_MESSAGE_TYPE_TX   (DDC: ACE_RT_MSGTYPE_TX)
NAI_1553_RT_MESSAGE_TYPE_BROADCAST  (DDC: ACE_RT_MSGTYPE_BCST)
NAI_1553_RT_MESSAGE_TYPE_ALL  (DDC: ACE_RT_MSGTYPE_ALL)
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when the value of swDataBlockId, wSubaddress and/or wMessageTypes are invalid
  • NAI_1553_RC_UNDEFINED_NODE when the data block specified by swDataBlockId does not exist

◆ naibrd_1553_RtDataBlockWrite()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtDataBlockWrite ( int16_t swDevice,
int16_t swDataBlockId,
uint16_t * wapBuffer,
uint16_t wBufferSize,
uint16_t wOffset )

Writes data to a data block.

Parameters
swDevice: (Input) Logical Device Number (0-31).
swDataBlockId: (Input) Unique user supplied ID of the previously created data block that will be mapped to an SA. The user provided this ID during the creation of the data block with the naibrd_1553_RtDataBlockCreate() function.
wapBuffer: (Input) Buffer that contains the data to be written to the data block.
wBufferSize: (Input) Size of buffer (in words).
wOffset: (Input) Offset into data buffer where the function will start to write the words to the data block (>= 0).
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when the value of swDataBlockId is invalid
  • NAI_1553_RC_UNDEFINED_NODE when the specified data block with given swDataBlockId does not exist

◆ naibrd_1553_RtGetAddress()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtGetAddress ( int16_t swDevice,
uint16_t * wpRtAddress )

Retrieves the RT address.

Parameters
swDevice: (Input) Logical Device Number (0-31).
wpRtAddress: (Output) Remote Terminal address assigned to the device (0-31).
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device is not set in RT or RT/MT mode
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when wpRtAddress pointer is null

◆ naibrd_1553_RtGetAddressSource()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtGetAddressSource ( int16_t swDevice,
uint16_t * wpRtAddressSource )

Gets RT address source (external or internal).

Parameters
swDevice: (Input) Logical Device Number (0-31).
wpRtAddressSource: (Output) Retrieved RT Address Source (NAI_1553_RT_ADDR_SOURCE_INTERNAL, NAI_1553_RT_ADDR_SOURCE_EXTERNAL).
Returns
  • NAI_SUCCESS
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device is not set in RT or RT/MT mode
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when wRtAddressSource is null

◆ naibrd_1553_RTGetHBufMsgCount()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RTGetHBufMsgCount ( int16_t swDevice)

Get the number of messages that are currently available in the host buffer that is assigned with given RT device.

Parameters
swDevice: (Input) Logical Device Number (0-31).
Returns
  • NAI_SUCCESS when function is completed successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_RT_HOST_BUFFER_NOT_INSTALLED when the host buffer was not successfully installed

◆ naibrd_1553_RtGetHBufMsgDecoded()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtGetHBufMsgDecoded ( int16_t swDevice,
naiDecodedMessageStructure * dmspDecodedMessage,
uint32_t * dwpMessageCount,
uint32_t * dwpStackLostMessageCount,
uint32_t * dwpHostBufferLostMessageCount,
uint16_t wMessageLocationAndRemoval )

Read from the host buffer of given RT device the message at given location, decode it into given structure, and purge it if so required. Also get the number of retrieved messages (actually only 0 or 1), the host buffer's current number of lost messages, and the current number of lost messages for given RT device's RT stack.

Parameters
swDevice: (Input) Logical Device Number (0-31).
dmspDecodedMessage: (Output) A pointer to a structure into which a message is decoded.
dwpMessageCount: (Output) A pointer to a variable in which the number of retrieved messages (actually only 0 or 1) is returned.
dwpStackLostMessageCount: (Output) A pointer to a variable in which given device stack's current number of lost messages is returned.
dwpHostBufferLostMessageCount: (Output) A pointer to a variable in which the host buffer's current number of lost messages is returned.
wMessageLocationAndRemoval: (Input) The location in the stack or host buffer of the message to read, and removal instructions.
Returns
  • NAI_SUCCESS when function is completed successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_RT_HOST_BUFFER_NOT_INSTALLED when the host buffer was not successfully installed
  • NAI_1553_RC_INVALID_PARAMETER

◆ naibrd_1553_RtHbuffInstall()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtHbuffInstall ( int16_t swDevice,
uint32_t dwHostBufferSize )

Install given RT device's host buffer.

Parameters
swDevice: (Input) Logical Device Number (0-31).
dwHostBufferSize: (Input) The size of the host buffer.
Returns
  • NAI_SUCCESS when function is completed successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_RT_HOST_BUFFER_NOT_INSTALLED when the host buffer was not successfully installed
  • NAI_1553_RC_INVALID_PARAMETER

◆ naibrd_1553_RtHbuffUnInstall()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtHbuffUnInstall ( int16_t swDevice)

Free given RT device's host buffer.

Parameters
swDevice: (Input) Logical Device Number (0-31).
Returns
NAI_SUCCESS when function is completed successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_RT_HOST_BUFFER_NOT_INSTALLED when the host buffer was not successfully installed
  • NAI_1553_RC_INVALID_PARAMETER

◆ naibrd_1553_RtInitialize()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtInitialize ( int16_t swDevice,
uint16_t wCommandStackSize,
uint32_t dwOptions )

Configure a RT.

Parameters
swDevice: (Input) Logical Device Number (0-31).
wCommandStackSize: (Input) Desired RT command stack size. 
NAI_1553_RT_CMDSTK_SIZE_256           (DDC: ACE_RT_CMDSTK_256)
256 words

NAI_1553_RT_CMDSTK_SIZE_512           (DDC: ACE_RT_CMDSTK_512)
512 words

NAI_1553_RT_CMDSTK_SIZE_1024          (DDC: ACE_RT_CMDSTK_1024)
1024 words

NAI_1553_RT_CMDSTK_SIZE_2048          (DDC: ACE_RT_CMDSTK_2048)
2048 words
dwOptions: (Input) RT options. The following bit masks may be logically OR'ed together to set one or more options. 
NAI_1553_RT_OPT_CLEAR_SERVICE_REQUEST
Clear service request after Tx vector word.
NAI_1553_RT_OPT_LOAD_TIME_TAG
Load time tag on synchronize command.
NAI_1553_RT_OPT_CLEAR_TIME_TAG
Clear time tag on synchronize command.
NAI_1553_RT_OPT_OVERWRITE_DATA
Overwrite invalid data.
NAI_1553_RT_OPT_OVERRIDE_MODE_BIT
Override mode T/R* error.
NAI_1553_RT_OPT_ALTERNATE_STATUS
RT alternate status word enable.
NAI_1553_RT_OPT_ILL_RX_DISABLE
Illegal receive transfer disable.
NAI_1553_RT_OPT_BUSY_RX_DISABLE
Busy receive transfer disable.
NAI_1553_RT_OPT_SET_RT_FLAG
Flag if loopback test failed.
NAI_1553_RT_OPT_1553A_MODE_CODES
1553a mode codes enabled.
NAI_1553_RT_OPT_MODE_COMMAND_OVERRIDE_BUSY
Busy bit and data word sent.
NAI_1553_RT_OPT_BROADCAST_DISABLE
Broadcast disabled.
Returns
  • NAI_SUCCESS
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device is not set in RT mode
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when wCommandStackSize is an invalid value

◆ naibrd_1553_RtMessageDecodeRaw()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtMessageDecodeRaw ( int16_t swDevice,
uint16_t * wapBuffer,
naiDecodedMessageStructure * dmspDecodedMessage )

Decodes a raw message into a message structure.

Parameters
swDevice: (Input) Logical Device Number (0-31).
wapBuffer: (Input) Pointer to a buffer containing the raw message.
dmspDecodedMessage: (Output) Pointer to a naiDecodedMessageStructure that will contain the decoded message. This structure contains the following member variables: 
wType                         Message type
wBlockStatus                  Block status word
wTimeTag3                     Time tag - 3rd word (UNUSED)
wTimeTag2                     Time tag - 2nd word (UNUSED)
wTimeTag                      Time tag - 1st word
wCommandWord1                 First command word
wCommandWord2                 Second command word
bIsCommandWord1Relevant       A flag that says if first command word is relevant (always TRUE)
bIsCommandWord2Relevant       A flag that says if second command word is relevant
wStatus1                      The [first] status word that's actually identified on the bus
wStatus2                      The second status word that's actually identified on the bus
bIsStatus1Relevant            A flag that says if first status word is relevant
bIsStatus2Relevant            A flag that says if second status word is relevant
wDataWordCount                The number of valid data words that have been received for this message
waData[32]                    An Array containing the data words
wBcControlWord                Control word (BC only)
wBcGapTime                    Message gap time (BC only)
wBcLoopbackWord1              The echo of the last word transmitted by the BC (BC only)
wUnused01                     An unused field, kept only in order to be compatible with DDC
bIsBcLoopbackWord1Relevant    A flag that says if first loopback word is relevant (BC only)
wUnused02                     An unused field, kept only in order to be compatible with DDC
Returns
  • NAI_SUCCESS when function is completed successfully
  • NAI_1553_RC_INVALID_PARAMETER when the dmspDecodedMessage pointer and/or wapBuffer are null

◆ naibrd_1553_RtMessageGetFromStackDecoded()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtMessageGetFromStackDecoded ( int16_t swDevice,
naiDecodedMessageStructure * dmspDecodedMessage,
uint16_t wMessageLocationAndRemoval )

Gets a message from the RT Command Stack and decodes it into a message structure.

Parameters
swDevice: (Input) Logical Device Number (0-31).
dmspDecodedMessage: (Output) Pointer to a naiDecodedMessageStructure that will contain the decoded message. This structure contains the following member variables: 
wType                         Message type
wBlockStatus                  Block status word
wTimeTag3                     Time tag - 3rd word (UNUSED)
wTimeTag2                     Time tag - 2nd word (UNUSED)
wTimeTag                      Time tag - 1st word
wCommandWord1                 First command word
wCommandWord2                 Second command word
bIsCommandWord1Relevant       A flag that says if first command word is relevant (always TRUE)
bIsCommandWord2Relevant       A flag that says if second command word is relevant
wStatus1                      The [first] status word that's actually identified on the bus
wStatus2                      The second status word that's actually identified on the bus
bIsStatus1Relevant            A flag that says if first status word is relevant
bIsStatus2Relevant            A flag that says if second status word is relevant
wDataWordCount                The number of valid data words that have been received for this message
waData[32]                    An Array containing the data words
wBcControlWord                Control word (BC only)
wBcGapTime                    Message gap time (BC only)
wBcLoopbackWord1              The echo of the last word transmitted by the BC (BC only)
wUnused01                     An unused field, kept only in order to be compatible with DDC
bIsBcLoopbackWord1Relevant    A flag that says if first loopback word is relevant (BC only)
wUnused02                     An unused field, kept only in order to be compatible with DDC
wMessageLocationAndRemoval: (Input) Location in the stack to read from and removal instructions. NAI_1553_RT_MESSAGE_LOC_NEXT_PURGE NAI_1553_RT_MESSAGE_LOC_NEXT_NO_PURGE NAI_1553_RT_MESSAGE_LOC_LATEST_PURGE NAI_1553_RT_MESSAGE_LOC_LATEST_NO_PURGE
Returns
  • 1 when a message was read and decoded
  • 0 when no message is available and no error occurred
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when the dmspDecodedMessage pointer is null and/or wMessageLocationAndRemoval is invalid

◆ naibrd_1553_RtMessageGetFromStackRaw()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtMessageGetFromStackRaw ( int16_t swDevice,
uint16_t * wapBuffer,
uint16_t wBufferSize )

Reads raw messages off of the RT command stack. Each message read is NAI_1553_MAX_MESSAGE_SIZE_RT words long (4 words stack entry, 32 words data) regardless of the data word count. Messages will be read until the internal pointer value is equal to the current command stack pointer value, or until the words read surpass wBufferSize. The data stack pointer (3rd word in message) is replaced with a word such that the MSByte contains the count of data words for the read message and the LSByte contains the type of message that was read.

Parameters
swDevice: (Input) Logical Device Number (0-31).
wapBuffer: (Output) Pointer to a buffer where the raw messages are stored.
wBufferSize: (Input) Size (in words) of the data buffer pointed to by wapBuffer.
Returns
  • A non-negative number indicating the number of messages read, if the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when the wapBuffer pointer is null and/or wBufferSize is less than NAI_1553_MAX_MESSAGE_SIZE_RT

◆ naibrd_1553_RtMessageLegalityDisable()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtMessageLegalityDisable ( int16_t swDevice,
uint16_t wOwnAddressOrBroadcast,
uint16_t wMessageDirection,
uint16_t wSubaddress,
uint32_t dwWordCountOrModeCodeMask )

Illegalize messages for a subaddress with a given set of criteria.

Parameters
swDevice: (Input) Logical Device Number (0-31).
wOwnAddressOrBroadcast: (Input) Specify own or broadcast RT address (NAI_1553_RT_ADDRESS_OWN, NAI_1553_RT_ADDRESS_BROADCAST, NAI_1553_RT_ADDRESS_BOTH).
wMessageDirection: (Input) Specify the message direction (NAI_1553_MT_FILTER_TX, NAI_1553_MT_FILTER_RX, NAI_1553_MT_FILTER_ALL).
wSubaddress: (Input) Subaddress (0-31, NAI_1553_RT_SA_ALL).
dwWordCountOrModeCodeMask: (Input) A 32-bit value in which each bit represents a word count to be illegalized (0x00000000-0xFFFFFFFF). The LSB corresponds to word count 0 and the MSB corresponds to word count 31.
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when the value of wOwnAddressOrBroadcast, wMessageDirection and/or wSubaddress is invalid

◆ naibrd_1553_RtMessageLegalityEnable()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtMessageLegalityEnable ( int16_t swDevice,
uint16_t wOwnAddressOrBroadcast,
uint16_t wMessageDirection,
uint16_t wSubaddress,
uint32_t dwWordCountOrModeCodeMask )

Legalize messages for a subaddress with a given set of criteria.

Parameters
swDevice: (Input) Logical Device Number (0-31).
wOwnAddressOrBroadcast: (Input) Specify own or broadcast RT address (NAI_1553_RT_ADDRESS_OWN, NAI_1553_RT_ADDRESS_BROADCAST, NAI_1553_RT_ADDRESS_BOTH).
wMessageDirection: (Input) Specify the message direction (NAI_1553_MT_FILTER_TX, NAI_1553_MT_FILTER_RX, NAI_1553_MT_FILTER_ALL).
wSubaddress: (Input) Subaddress (0-31, NAI_1553_RT_SA_ALL).
dwWordCountOrModeCodeMask: (Input) A 32-bit value in which each bit represents a word count to be legalized (0x00000000-0xFFFFFFFF) as shown below (Note that bit 0 represents word count 32). 
Bit       31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
Wordcount 31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 32
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when the value of wOwnAddressOrBroadcast, wMessageDirection and/or wSubaddress is invalid

◆ naibrd_1553_RtMessageLegalityGetStatus()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtMessageLegalityGetStatus ( int16_t swDevice,
uint16_t wOwnAddressOrBroadcast,
uint16_t wMessageDirection,
uint16_t wSubaddress,
uint32_t * dwpMessageLegality )

Gets the legalization status of a subaddress.

Parameters
swDevice: (Input) Logical Device Number (0-31).
wOwnAddressOrBroadcast: (Input) Specify own or broadcast RT address (NAI_1553_RT_ADDRESS_OWN, NAI_1553_RT_ADDRESS_BROADCAST).
wMessageDirection: (Input) Specify the message direction (NAI_1553_MT_FILTER_TX, NAI_1553_MT_FILTER_RX).
wSubaddress: (Input) Subaddress (0-31).
dwpMessageLegality: (Output) Pointer to a 32-bit value in which each bit represents a word count that is legalized for this subaddress. The LSB corresponds to word count 0 and the MSB corresponds to word count 31.
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when the value of wOwnAddressOrBroadcast, wMessageDirection and/or wSubaddress is invalid and/or when the dwpMessageLegality pointer is null

◆ naibrd_1553_RtModeCodeGetIrqStatus()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtModeCodeGetIrqStatus ( int16_t swDevice,
uint16_t wModeCodeType,
uint16_t * wpModeCodeIrq )

Gets the status of which mode codes will generate interrupts.

Parameters
swDevice: (Input) Logical Device Number (0-31).
wModeCodeType: (Input) Select mode code type from one of the following: 
NAI_1553_RT_MODECODE_TYPE_RX_NO_DATA                              (DDC: ACE_RT_MCTYPE_RX_NO_DATA)
NAI_1553_RT_MODECODE_TYPE_RX_DATA                                     (DDC: ACE_RT_MCTYPE_RX_DATA)
NAI_1553_RT_MODECODE_TYPE_TX_NO_DATA                                  (DDC: ACE_RT_MCTYPE_TX_NO_DATA)
NAI_1553_RT_MODECODE_TYPE_TX_DATA                                     (DDC: ACE_RT_MCTYPE_TX_DATA)
NAI_1553_RT_MODECODE_TYPE_BROADCAST_RX_NO_DATA                        (DDC: ACE_RT_MCTYPE_BCST_RX_NO_DATA)
NAI_1553_RT_MODECODE_TYPE_BROADCAST_RX_DATA                           (DDC: ACE_RT_MCTYPE_BCST_RX_DATA)
NAI_1553_RT_MODECODE_TYPE_BROADCAST_TX_NO_DATA                        (DDC: ACE_RT_MCTYPE_BCST_TX_NO_DATA)
NAI_1553_RT_MODECODE_TYPE_BROADCAST_TX_DATA                           (DDC: ACE_RT_MCTYPE_BCST_TX_DATA)
wpModeCodeIrq: (Output) Parameter containing mode codes that will generate an interrupt. This parameter contains the OR'ed combination of zero, one or more of the following mode codes: 
NAI_1553_RT_MODECODE_IRQ_DYNAMIC_BUS_CONTROL                      (DDC: ACE_RT_MCIRQ_DYN_BUS_CTRL)
Bit 0.

NAI_1553_RT_MODECODE_IRQ_SYNCHRONIZE                              (DDC: ACE_RT_MCIRQ_SYNCHRONIZE)
Bit 1.

NAI_1553_RT_MODECODE_IRQ_TRANSMIT_STATUS                          (DDC: ACE_RT_MCIRQ_TRNS_STATUS)
Bit 2.

NAI_1553_RT_MODECODE_IRQ_INITIALIZE_SELF_TEST                     (DDC: ACE_RT_MCIRQ_INIT_SELF_TEST)
Bit 3.

NAI_1553_RT_MODECODE_IRQ_TRANSMITTER_SHUTDOWN                     (DDC: ACE_RT_MCIRQ_TRNS_SHUTDOWN)
Bit 4.

NAI_1553_RT_MODECODE_IRQ_OVERRIDE_TRANSMITTER_SHUTDOWN            (DDC: ACE_RT_MCIRQ_OVR_TRNS_SHUTDWN)
Bit 5.

NAI_1553_RT_MODECODE_IRQ_INHIBIT_TERMINAL_FLAG                    (DDC: ACE_RT_MCIRQ_INH_TERM_FLAG)
Bit 6.

NAI_1553_RT_MODECODE_IRQ_OVERRIDE_INHIBIT_TERMINAL_FLAG           (DDC: ACE_RT_MCIRQ_OVR_INH_TERM_FLG)
Bit 7.

NAI_1553_RT_MODECODE_IRQ_RESET_REMOTE_TERMINAL                    (DDC: ACE_RT_MCIRQ_RESET_REMOTE_TERM)
Bit 8.

NAI_1553_RT_MODECODE_IRQ_TRANSMIT_VECTOR                          (DDC: ACE_RT_MCIRQ_TRNS_VECTOR)
Bit 0.

NAI_1553_RT_MODECODE_IRQ_TRANSMIT_LAST_COMMAND                    (DDC: ACE_RT_MCIRQ_TRNS_LAST_CMD)
Bit 2.

NAI_1553_RT_MODECODE_IRQ_TRANSMIT_BUILT_IN_TEST                   (DDC: ACE_RT_MCIRQ_TRNS_BIT)
Bit 3.

NAI_1553_RT_MODECODE_IRQ_SELECTED_TRANSMITTER_SHUTDOWN            (DDC: ACE_RT_MCIRQ_SEL_TRNS_SHUTDWN)
Bit 4.

NAI_1553_RT_MODECODE_IRQ_OVERRIDE_SELECTED_TRANSMITTER_SHUTDOWN   (DDC: ACE_RT_MCIRQ_OVR_SEL_TRNS_SHUTDWN)
Bit 5.

NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT6                            (DDC: ACE_RT_MCIRQ_RESERVED_BIT6)
Bit 6.

NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT7                            (DDC: ACE_RT_MCIRQ_RESERVED_BIT7)
Bit 7.

NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT8                            (DDC: ACE_RT_MCIRQ_RESERVED_BIT8)
Bit 8.

NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT9                            (DDC: ACE_RT_MCIRQ_RESERVED_BIT9)
Bit 9.

NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT10                           (DDC: ACE_RT_MCIRQ_RESERVED_BIT10)
Bit 10.

NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT11                           (DDC: ACE_RT_MCIRQ_RESERVED_BIT11)
Bit 11.

NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT12                           (DDC: ACE_RT_MCIRQ_RESERVED_BIT12)
Bit 12.

NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT13                           (DDC: ACE_RT_MCIRQ_RESERVED_BIT13)
Bit 13.

NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT14                           (DDC: ACE_RT_MCIRQ_RESERVED_BIT14)
Bit 14.

NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT15                           (DDC: ACE_RT_MCIRQ_RESERVED_BIT15)
Bit 15.
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when the value of wModeCodeType is invalid and/or the wpModeCodeIrq pointer is null

◆ naibrd_1553_RtModeCodeIrqDisable()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtModeCodeIrqDisable ( int16_t swDevice,
uint16_t wModeCodeType,
uint16_t wModeCodeIrq )

Disable interrupts on one or more mode codes.

Parameters
swDevice: (Input) Logical Device Number (0-31).
wModeCodeType: (Input) Select mode code type from one of the following: 
NAI_1553_RT_MODECODE_TYPE_RX_NO_DATA                              (DDC: ACE_RT_MCTYPE_RX_NO_DATA)
NAI_1553_RT_MODECODE_TYPE_RX_DATA                                     (DDC: ACE_RT_MCTYPE_RX_DATA)
NAI_1553_RT_MODECODE_TYPE_TX_NO_DATA                                  (DDC: ACE_RT_MCTYPE_TX_NO_DATA)
NAI_1553_RT_MODECODE_TYPE_TX_DATA                                     (DDC: ACE_RT_MCTYPE_TX_DATA)
NAI_1553_RT_MODECODE_TYPE_BROADCAST_RX_NO_DATA                        (DDC: ACE_RT_MCTYPE_BCST_RX_NO_DATA)
NAI_1553_RT_MODECODE_TYPE_BROADCAST_RX_DATA                           (DDC: ACE_RT_MCTYPE_BCST_RX_DATA)
NAI_1553_RT_MODECODE_TYPE_BROADCAST_TX_NO_DATA                        (DDC: ACE_RT_MCTYPE_BCST_TX_NO_DATA)
NAI_1553_RT_MODECODE_TYPE_BROADCAST_TX_DATA                           (DDC: ACE_RT_MCTYPE_BCST_TX_DATA)
wModeCodeIrq: (Input) Parameter that specifies mode code(s) to disable. This parameter is generated by OR'ing the following mode codes together: 
NAI_1553_RT_MODECODE_IRQ_DYNAMIC_BUS_CONTROL                      (DDC: ACE_RT_MCIRQ_DYN_BUS_CTRL)
NAI_1553_RT_MODECODE_IRQ_SYNCHRONIZE                              (DDC: ACE_RT_MCIRQ_SYNCHRONIZE)
NAI_1553_RT_MODECODE_IRQ_TRANSMIT_STATUS                          (DDC: ACE_RT_MCIRQ_TRNS_STATUS)
NAI_1553_RT_MODECODE_IRQ_INITIALIZE_SELF_TEST                     (DDC: ACE_RT_MCIRQ_INIT_SELF_TEST)
NAI_1553_RT_MODECODE_IRQ_TRANSMITTER_SHUTDOWN                     (DDC: ACE_RT_MCIRQ_TRNS_SHUTDOWN)
NAI_1553_RT_MODECODE_IRQ_OVERRIDE_TRANSMITTER_SHUTDOWN            (DDC: ACE_RT_MCIRQ_OVR_TRNS_SHUTDWN)
NAI_1553_RT_MODECODE_IRQ_INHIBIT_TERMINAL_FLAG                    (DDC: ACE_RT_MCIRQ_INH_TERM_FLAG)
NAI_1553_RT_MODECODE_IRQ_OVERRIDE_INHIBIT_TERMINAL_FLAG           (DDC: ACE_RT_MCIRQ_OVR_INH_TERM_FLG)
NAI_1553_RT_MODECODE_IRQ_RESET_REMOTE_TERMINAL                    (DDC: ACE_RT_MCIRQ_RESET_REMOTE_TERM)
NAI_1553_RT_MODECODE_IRQ_TRANSMIT_VECTOR                          (DDC: ACE_RT_MCIRQ_TRNS_VECTOR)
NAI_1553_RT_MODECODE_IRQ_TRANSMIT_LAST_COMMAND                    (DDC: ACE_RT_MCIRQ_TRNS_LAST_CMD)
NAI_1553_RT_MODECODE_IRQ_TRANSMIT_BUILT_IN_TEST                   (DDC: ACE_RT_MCIRQ_TRNS_BIT)
NAI_1553_RT_MODECODE_IRQ_SELECTED_TRANSMITTER_SHUTDOWN            (DDC: ACE_RT_MCIRQ_SEL_TRNS_SHUTDWN)
NAI_1553_RT_MODECODE_IRQ_OVERRIDE_SELECTED_TRANSMITTER_SHUTDOWN   (DDC: ACE_RT_MCIRQ_OVR_SEL_TRNS_SHUTDWN)
NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT6                            (DDC: ACE_RT_MCIRQ_RESERVED_BIT6)
NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT7                            (DDC: ACE_RT_MCIRQ_RESERVED_BIT7)
NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT8                            (DDC: ACE_RT_MCIRQ_RESERVED_BIT8)
NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT9                            (DDC: ACE_RT_MCIRQ_RESERVED_BIT9)
NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT10                           (DDC: ACE_RT_MCIRQ_RESERVED_BIT10)
NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT11                           (DDC: ACE_RT_MCIRQ_RESERVED_BIT11)
NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT12                           (DDC: ACE_RT_MCIRQ_RESERVED_BIT12)
NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT13                           (DDC: ACE_RT_MCIRQ_RESERVED_BIT13)
NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT14                           (DDC: ACE_RT_MCIRQ_RESERVED_BIT14)
NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT15                           (DDC: ACE_RT_MCIRQ_RESERVED_BIT15)
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when the value of wModeCodeType and/or wModeCodeIrq are invalid

◆ naibrd_1553_RtModeCodeIrqEnable()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtModeCodeIrqEnable ( int16_t swDevice,
uint16_t wModeCodeType,
uint16_t wModeCodeIrq )

Enable interrupt on a received mode code.

Parameters
swDevice: (Input) Logical Device Number (0-31).
wModeCodeType: (Input) Select mode code type from one of the following: 
NAI_1553_RT_MODECODE_TYPE_RX_NO_DATA                              (DDC: ACE_RT_MCTYPE_RX_NO_DATA)
NAI_1553_RT_MODECODE_TYPE_RX_DATA                                     (DDC: ACE_RT_MCTYPE_RX_DATA)
NAI_1553_RT_MODECODE_TYPE_TX_NO_DATA                                  (DDC: ACE_RT_MCTYPE_TX_NO_DATA)
NAI_1553_RT_MODECODE_TYPE_TX_DATA                                     (DDC: ACE_RT_MCTYPE_TX_DATA)
NAI_1553_RT_MODECODE_TYPE_BROADCAST_RX_NO_DATA                        (DDC: ACE_RT_MCTYPE_BCST_RX_NO_DATA)
NAI_1553_RT_MODECODE_TYPE_BROADCAST_RX_DATA                           (DDC: ACE_RT_MCTYPE_BCST_RX_DATA)
NAI_1553_RT_MODECODE_TYPE_BROADCAST_TX_NO_DATA                        (DDC: ACE_RT_MCTYPE_BCST_TX_NO_DATA)
NAI_1553_RT_MODECODE_TYPE_BROADCAST_TX_DATA                           (DDC: ACE_RT_MCTYPE_BCST_TX_DATA)
wModeCodeIrq: (Input) Parameter that specifies mode code(s) that will generate the interrupt. This parameter is generated by OR'ing the following mode codes together: 
NAI_1553_RT_MODECODE_IRQ_DYNAMIC_BUS_CONTROL                      (DDC: ACE_RT_MCIRQ_DYN_BUS_CTRL)
NAI_1553_RT_MODECODE_IRQ_SYNCHRONIZE                              (DDC: ACE_RT_MCIRQ_SYNCHRONIZE)
NAI_1553_RT_MODECODE_IRQ_TRANSMIT_STATUS                          (DDC: ACE_RT_MCIRQ_TRNS_STATUS)
NAI_1553_RT_MODECODE_IRQ_INITIALIZE_SELF_TEST                     (DDC: ACE_RT_MCIRQ_INIT_SELF_TEST)
NAI_1553_RT_MODECODE_IRQ_TRANSMITTER_SHUTDOWN                     (DDC: ACE_RT_MCIRQ_TRNS_SHUTDOWN)
NAI_1553_RT_MODECODE_IRQ_OVERRIDE_TRANSMITTER_SHUTDOWN            (DDC: ACE_RT_MCIRQ_OVR_TRNS_SHUTDWN)
NAI_1553_RT_MODECODE_IRQ_INHIBIT_TERMINAL_FLAG                    (DDC: ACE_RT_MCIRQ_INH_TERM_FLAG)
NAI_1553_RT_MODECODE_IRQ_OVERRIDE_INHIBIT_TERMINAL_FLAG           (DDC: ACE_RT_MCIRQ_OVR_INH_TERM_FLG)
NAI_1553_RT_MODECODE_IRQ_RESET_REMOTE_TERMINAL                    (DDC: ACE_RT_MCIRQ_RESET_REMOTE_TERM)
NAI_1553_RT_MODECODE_IRQ_TRANSMIT_VECTOR                          (DDC: ACE_RT_MCIRQ_TRNS_VECTOR)
NAI_1553_RT_MODECODE_IRQ_TRANSMIT_LAST_COMMAND                    (DDC: ACE_RT_MCIRQ_TRNS_LAST_CMD)
NAI_1553_RT_MODECODE_IRQ_TRANSMIT_BUILT_IN_TEST                   (DDC: ACE_RT_MCIRQ_TRNS_BIT)
NAI_1553_RT_MODECODE_IRQ_SELECTED_TRANSMITTER_SHUTDOWN            (DDC: ACE_RT_MCIRQ_SEL_TRNS_SHUTDWN)
NAI_1553_RT_MODECODE_IRQ_OVERRIDE_SELECTED_TRANSMITTER_SHUTDOWN   (DDC: ACE_RT_MCIRQ_OVR_SEL_TRNS_SHUTDWN)
NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT6                            (DDC: ACE_RT_MCIRQ_RESERVED_BIT6)
NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT7                            (DDC: ACE_RT_MCIRQ_RESERVED_BIT7)
NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT8                            (DDC: ACE_RT_MCIRQ_RESERVED_BIT8)
NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT9                            (DDC: ACE_RT_MCIRQ_RESERVED_BIT9)
NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT10                           (DDC: ACE_RT_MCIRQ_RESERVED_BIT10)
NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT11                           (DDC: ACE_RT_MCIRQ_RESERVED_BIT11)
NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT12                           (DDC: ACE_RT_MCIRQ_RESERVED_BIT12)
NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT13                           (DDC: ACE_RT_MCIRQ_RESERVED_BIT13)
NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT14                           (DDC: ACE_RT_MCIRQ_RESERVED_BIT14)
NAI_1553_RT_MODECODE_IRQ_RESERVED_BIT15                           (DDC: ACE_RT_MCIRQ_RESERVED_BIT15)
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when the value of wModeCodeType and/or wModeCodeIrq are invalid

◆ naibrd_1553_RtModeCodeReadData()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtModeCodeReadData ( int16_t swDevice,
uint16_t wDataContainingModeCode,
uint16_t * wpData )

Reads data from the Mode Code Data Locations Table.

Parameters
swDevice: (Input) Logical Device Number (0-31).
wDataContainingModeCode: (Input) Specify the data containing mode code: 
NAI_1553_RT_MODECODE_DATA_RX_SYNCHRONIZE                                      (DDC: ACE_RT_MCDATA_RX_SYNCHRONIZE)
NAI_1553_RT_MODECODE_DATA_RX_TRANSMITTER_SHUTDOWN                             (DDC: ACE_RT_MCDATA_RX_SEL_T_SHUTDWN)
NAI_1553_RT_MODECODE_DATA_RX_OVERRIDE_TRANSMITTER_SHUTDOWN                    (DDC: ACE_RT_MCDATA_RX_OVR_SEL_T_SHUTDWN)
NAI_1553_RT_MODECODE_DATA_TX_TRANSMIT_VECTOR_WORD                             (DDC: ACE_RT_MCDATA_TX_TRNS_VECTOR)
NAI_1553_RT_MODECODE_DATA_TX_TRANSMIT_LAST_COMMAND_WORD                       (DDC: ACE_RT_MCDATA_TX_TRNS_LAST_CMD)
NAI_1553_RT_MODECODE_DATA_TX_TRANSMIT_BUILT_IN_TEST_WORD                      (DDC: ACE_RT_MCDATA_TX_TRNS_BIT)
NAI_1553_RT_MODECODE_DATA_BROADCAST_SYNCHRONIZE                               (DDC: ACE_RT_MCDATA_BCST_SYNCHRONIZE)
NAI_1553_RT_MODECODE_DATA_BROADCAST_SELECTED_TRANSMITTER_SHUTDOWN             (DDC: ACE_RT_MCDATA_BCST_SEL_T_SHUTDWN)
NAI_1553_RT_MODECODE_DATA_BROADCAST_OVERRIDE_SELECTED_TRANSMITTER_SHUTDOWN    (DDC: ACE_RT_MCDATA_BCST_OVR_SEL_T_SHUTDWN)
wpData: (Output) Returned data.
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when the value of wDataContainingModeCode is invalid and/or the wpData pointer is null

◆ naibrd_1553_RtModeCodeWriteData()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtModeCodeWriteData ( int16_t swDevice,
uint16_t wDataContainingModeCode,
uint16_t wData )

Writes data to the Mode Code Data Locations Table.

Parameters
swDevice: (Input) Logical Device Number (0-31).
wDataContainingModeCode: (Input) Specify the data containing mode code: 
NAI_1553_RT_MODECODE_DATA_RX_SYNCHRONIZE                                      (DDC: ACE_RT_MCDATA_RX_SYNCHRONIZE)
NAI_1553_RT_MODECODE_DATA_RX_TRANSMITTER_SHUTDOWN                             (DDC: ACE_RT_MCDATA_RX_SEL_T_SHUTDWN)
NAI_1553_RT_MODECODE_DATA_RX_OVERRIDE_TRANSMITTER_SHUTDOWN                    (DDC: ACE_RT_MCDATA_RX_OVR_SEL_T_SHUTDWN)
NAI_1553_RT_MODECODE_DATA_TX_TRANSMIT_VECTOR_WORD                             (DDC: ACE_RT_MCDATA_TX_TRNS_VECTOR)
NAI_1553_RT_MODECODE_DATA_TX_TRANSMIT_LAST_COMMAND_WORD                       (DDC: ACE_RT_MCDATA_TX_TRNS_LAST_CMD)
NAI_1553_RT_MODECODE_DATA_TX_TRANSMIT_BUILT_IN_TEST_WORD                      (DDC: ACE_RT_MCDATA_TX_TRNS_BIT)
NAI_1553_RT_MODECODE_DATA_BROADCAST_SYNCHRONIZE                               (DDC: ACE_RT_MCDATA_BCST_SYNCHRONIZE)
NAI_1553_RT_MODECODE_DATA_BROADCAST_SELECTED_TRANSMITTER_SHUTDOWN             (DDC: ACE_RT_MCDATA_BCST_SEL_T_SHUTDWN)
NAI_1553_RT_MODECODE_DATA_BROADCAST_OVERRIDE_SELECTED_TRANSMITTER_SHUTDOWN    (DDC: ACE_RT_MCDATA_BCST_OVR_SEL_T_SHUTDWN)
wData: (Input) Data to be written.
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when the value of wDataContainingModeCode is invalid

◆ naibrd_1553_RtResponseStatusBitsGet()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtResponseStatusBitsGet ( int16_t swDevice,
uint16_t * wpStatusEnablerMask )

Gets the status enable bits for RT status responses.

Parameters
swDevice: (Input) Logical Device Number (0-31).
wpStatusEnablerMask: (Output) Retrieved status enable word. This word is an OR'ed combination of zero, one or more of the following status bits: 
NAI_1553_RT_STATUS_BIT_DBCA                     (DDC: ACE_RT_STSBIT_DBCA)
NAI_1553_RT_STATUS_BIT_BUSY                     (DDC: ACE_RT_STSBIT_BUSY)
NAI_1553_RT_STATUS_BIT_SERVICE_REQUEST          (DDC: ACE_RT_STSBIT_SREQ)
NAI_1553_RT_STATUS_BIT_SUBSYSTEM_FLAG           (DDC: ACE_RT_STSBIT_SSFLAG)
NAI_1553_RT_STATUS_BIT_RT_FLAG                  (DDC: ACE_RT_STSBIT_RTFLAG)
NAI_1553_RT_STATUS_BIT_S10                      (DDC: ACE_RT_STSBIT_S10)
NAI_1553_RT_STATUS_BIT_S09                      (DDC: ACE_RT_STSBIT_S09)
NAI_1553_RT_STATUS_BIT_S08                      (DDC: ACE_RT_STSBIT_S08)
NAI_1553_RT_STATUS_BIT_S07                      (DDC: ACE_RT_STSBIT_S07)
NAI_1553_RT_STATUS_BIT_S06                      (DDC: ACE_RT_STSBIT_S06)
NAI_1553_RT_STATUS_BIT_S05                      (DDC: ACE_RT_STSBIT_S05)
NAI_1553_RT_STATUS_BIT_S04                      (DDC: ACE_RT_STSBIT_S04)
NAI_1553_RT_STATUS_BIT_S03                      (DDC: ACE_RT_STSBIT_S03)
NAI_1553_RT_STATUS_BIT_S02                      (DDC: ACE_RT_STSBIT_S02)
NAI_1553_RT_STATUS_BIT_S01                      (DDC: ACE_RT_STSBIT_S01)
NAI_1553_RT_STATUS_BIT_S00                      (DDC: ACE_RT_STSBIT_S00)
NAI_1760_RT_STATUS_BIT_INSTRUMENTATION          Used to set Instrumentation status bit for for FTJ/FTK 1760 modules
NAI_1760_RT_STATUS_BIT_MESSAGE_ERROR            Used for to check the output for the message error bit for FTJ/FTK 1760 modules
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when the wpStatusEnablerMask pointer is null

◆ naibrd_1553_RtResponseStatusBitsSet()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtResponseStatusBitsSet ( int16_t swDevice,
uint16_t wStatusEnablerMask )

Sets the status enable bits to configure RT status responses.

Parameters
swDevice: (Input) Logical Device Number (0-31).
wStatusEnablerMask: (Input) Status enabler bit mask. This mask is generated by OR'ing the following status bits together: 
NAI_1553_RT_STATUS_BIT_DBCA                     (DDC: ACE_RT_STSBIT_DBCA)
Bit 11. Dynamic Bus Control Acceptance bit

NAI_1553_RT_STATUS_BIT_BUSY                     (DDC: ACE_RT_STSBIT_BUSY)       
Bit 10. Busy bit

NAI_1553_RT_STATUS_BIT_SERVICE_REQUEST          (DDC: ACE_RT_STSBIT_SREQ)
Bit 9. Service Request bit

NAI_1553_RT_STATUS_BIT_SUBSYSTEM_FLAG           (DDC: ACE_RT_STSBIT_SSFLAG)
Bit 8. Subsystem Flag bit

NAI_1553_RT_STATUS_BIT_RT_FLAG                  (DDC: ACE_RT_STSBIT_RTFLAG)       
Bit 7. Remote Terminal Flag bit

NAI_1553_RT_STATUS_BIT_S10                      (DDC: ACE_RT_STSBIT_S10)
Bit 11. Alternate status mode: status bit 11

NAI_1553_RT_STATUS_BIT_S09                      (DDC: ACE_RT_STSBIT_S09)
Bit 10. Alternate status mode: status bit 10

NAI_1553_RT_STATUS_BIT_S08                      (DDC: ACE_RT_STSBIT_S08)
Bit 9. Alternate status mode: status bit 9

NAI_1553_RT_STATUS_BIT_S07                      (DDC: ACE_RT_STSBIT_S07)
Bit 8. Alternate status mode: status bit 8       

NAI_1553_RT_STATUS_BIT_S06                      (DDC: ACE_RT_STSBIT_S06)
Bit 7. Alternate status mode: status bit 7

NAI_1553_RT_STATUS_BIT_S05                      (DDC: ACE_RT_STSBIT_S05)
Bit 6. Alternate status mode: status bit 6

NAI_1553_RT_STATUS_BIT_S04                      (DDC: ACE_RT_STSBIT_S04)
Bit 5. Alternate status mode: status bit 5

NAI_1553_RT_STATUS_BIT_S03                      (DDC: ACE_RT_STSBIT_S03)
Bit 4. Alternate status mode: status bit 4

NAI_1553_RT_STATUS_BIT_S02                      (DDC: ACE_RT_STSBIT_S02)
Bit 3. Alternate status mode: status bit 3

NAI_1553_RT_STATUS_BIT_S01                      (DDC: ACE_RT_STSBIT_S01)
Bit 2. Alternate status mode: status bit 2

NAI_1553_RT_STATUS_BIT_S00                      (DDC: ACE_RT_STSBIT_S00)
Bit 1. Alternate status mode: status bit 1

NAI_1760_RT_STATUS_BIT_INSTRUMENTATION          
Bit 1. Used to set Instrumentation status bit for FTJ/FTK 1760 modules
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state

◆ naibrd_1553_RtResponseStatusBitsUnset()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtResponseStatusBitsUnset ( int16_t swDevice,
uint16_t wStatusEnablerMask )

Deactivates the status enable bits for RT status responses.

Parameters
swDevice: (Input) Logical Device Number (0-31).
wStatusEnablerMask: (Input) Status clear bit mask. This mask is generated by OR'ing the following status bits together: 
NAI_1553_RT_STATUS_BIT_DBCA                     (DDC: ACE_RT_STSBIT_DBCA)
NAI_1553_RT_STATUS_BIT_BUSY                     (DDC: ACE_RT_STSBIT_BUSY)
NAI_1553_RT_STATUS_BIT_SERVICE_REQUEST          (DDC: ACE_RT_STSBIT_SREQ)
NAI_1553_RT_STATUS_BIT_SUBSYSTEM_FLAG           (DDC: ACE_RT_STSBIT_SSFLAG)
NAI_1553_RT_STATUS_BIT_RT_FLAG                  (DDC: ACE_RT_STSBIT_RTFLAG)
NAI_1553_RT_STATUS_BIT_S10                      (DDC: ACE_RT_STSBIT_S10)
NAI_1553_RT_STATUS_BIT_S09                      (DDC: ACE_RT_STSBIT_S09)
NAI_1553_RT_STATUS_BIT_S08                      (DDC: ACE_RT_STSBIT_S08)
NAI_1553_RT_STATUS_BIT_S07                      (DDC: ACE_RT_STSBIT_S07)
NAI_1553_RT_STATUS_BIT_S06                      (DDC: ACE_RT_STSBIT_S06)
NAI_1553_RT_STATUS_BIT_S05                      (DDC: ACE_RT_STSBIT_S05)
NAI_1553_RT_STATUS_BIT_S04                      (DDC: ACE_RT_STSBIT_S04)
NAI_1553_RT_STATUS_BIT_S03                      (DDC: ACE_RT_STSBIT_S03)
NAI_1553_RT_STATUS_BIT_S02                      (DDC: ACE_RT_STSBIT_S02)
NAI_1553_RT_STATUS_BIT_S01                      (DDC: ACE_RT_STSBIT_S01)
NAI_1553_RT_STATUS_BIT_S00                      (DDC: ACE_RT_STSBIT_S00)
NAI_1760_RT_STATUS_BIT_INSTRUMENTATION          Used to set Instrumentation status bit for FTJ/FTK 1760 modules
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state

◆ naibrd_1553_RtSetAddress()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtSetAddress ( int16_t swDevice,
uint16_t wRtAddress )

This function is used to set the RT address if the RT address source is set to Internal.

Parameters
swDevice: (Input) Logical Device Number (0-31).
wRtAddress: (Input) Remote Terminal address to be assigned to the device (0-31).
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device is not set in RT or RT/MT mode
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when value of wRtAddress is invalid
  • NAI_1553_RC_LIMITED_DEVICE when limited-performance device is not using RT 24
  • NAI_1553_RC_WRITE_ERROR when setting of the RT address failed

◆ naibrd_1553_RtSetAddressSource()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtSetAddressSource ( int16_t swDevice,
uint16_t wRtAddressSource )

Set RT address source as either internal or external. This function is not supported for FTJ/FTK modules.

Parameters
swDevice: (Input) Logical Device Number (0-31).
wRtAddressSource: (Input) RT Address Source (NAI_1553_RT_ADDR_SOURCE_INTERNAL, NAI_1553_RT_ADDR_SOURCE_EXTERNAL).
Returns
  • NAI_SUCCESS
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device is not set in RT or RT/MT mode
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when wRtAddressSource is an invalid value

◆ naibrd_1553_RtStart()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtStart ( int16_t swDevice)

Starts the RT.

Parameters
swDevice: (Input) Logical Device Number (0-31).
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device is not set in RT mode
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_ACCESS when device is in an invalid access mode

◆ naibrd_1553_RtStkToHbuf32()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtStkToHbuf32 ( int16_t swDevice)

Record the newly received messages from the command stack of given RT device into its host buffer.

Parameters
swDevice: (Input) Logical Device Number (0-31).
Returns
NAI_SUCCESS when function is completed successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_RT_HOST_BUFFER_NOT_INSTALLED when the host buffer was not successfully installed
  • NAI_1553_RC_INVALID_PARAMETER

◆ naibrd_1553_RtStop()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtStop ( int16_t swDevice)

Stops the RT.

Parameters
swDevice: (Input) Logical Device Number (0-31).
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device is not set in RT mode
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_ACCESS when device is in an invalid access mode

◆ naibrd_1553_RtTxDataBlockSwap()

NAIBRDFUNC nai_1553_t NAIAPI naibrd_1553_RtTxDataBlockSwap ( int16_t swDevice,
int16_t swDataBlockId,
uint16_t wSubaddress )

This function swaps the data block that is currently mapped to a given Tx subaddress with the data block given by swDataBlockId. This function is especially useful for multiple buffering of Tx messages for a RT to BC or RT to RT commands.

Parameters
swDevice: (Input) Logical Device Number (0-31).
swDataBlockId: (Input) Unique user supplied ID of the previously created data block that will be mapped to an SA, replacing the data block the SA is currently mapped to. The user provided this ID during the creation of the data block with the naibrd_1553_RtDataBlockCreate() function.
wSubaddress: (Input) Tx Subaddress (0-31)
Returns
  • NAI_SUCCESS
  • NAI_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAI_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAI_1553_RC_INVALID_STATE when device is in an invalid state
  • NAI_1553_RC_INVALID_PARAMETER when the values of swDataBlockId and/or wSubaddress are invalid