Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
RT Message Legalization Functions
NAI Board Library - Module Functions » M1553 Module Functions

Functions

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_RtMsgLegalEnable (int16_t device, naibrd_1553_rt_ownAddressOrBroadcast_t ownAddressOrBroadcast, naibrd_1553_messageDirection_t messageDirection, naibrd_1553_rt_subaddress_t subaddress, uint32_t wordCountOrModeCodeMask)
 Legalize messages for a subaddress with a given set of criteria.
 
NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_RtMsgLegalDisable (int16_t device, naibrd_1553_rt_ownAddressOrBroadcast_t ownAddressOrBroadcast, naibrd_1553_messageDirection_t messageDirection, naibrd_1553_rt_subaddress_t subaddress, uint32_t wordCountOrModeCodeMask)
 Illegalize messages for a subaddress with a given set of criteria.
 

Detailed Description

Function Documentation

◆ naibrd_1553_RtMsgLegalDisable()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_RtMsgLegalDisable ( int16_t device,
naibrd_1553_rt_ownAddressOrBroadcast_t ownAddressOrBroadcast,
naibrd_1553_messageDirection_t messageDirection,
naibrd_1553_rt_subaddress_t subaddress,
uint32_t wordCountOrModeCodeMask )

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

Parameters
device: (Input) Logical Device Number (0-31).
ownAddressOrBroadcast: (Input) Specify own or broadcast RT address (NAIBRD_1553_RT_ADDRESS_OWN, NAIBRD_1553_RT_ADDRESS_BROADCAST, NAIBRD_1553_RT_ADDRESS_BOTH).
messageDirection: (Input) Specify the message direction (NAIBRD_1553_DIRECTION_TX, NAIBRD_1553_DIRECTION_RX, NAIBRD_1553_DIRECTION_ALL).
subaddress: (Input) Subaddress (0-31, NAIBRD_1553_RT_SA_ALL).
wordCountOrModeCodeMask: (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
  • NAIBRD_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAIBRD_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAIBRD_1553_RC_INVALID_STATE when device is in an invalid state
  • NAIBRD_1553_RC_INVALID_PARAMETER when the value of ownAddressOrBroadcast, messageDirection and/or subaddress is invalid

◆ naibrd_1553_RtMsgLegalEnable()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_RtMsgLegalEnable ( int16_t device,
naibrd_1553_rt_ownAddressOrBroadcast_t ownAddressOrBroadcast,
naibrd_1553_messageDirection_t messageDirection,
naibrd_1553_rt_subaddress_t subaddress,
uint32_t wordCountOrModeCodeMask )

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

Parameters
device: (Input) Logical Device Number (0-31).
ownAddressOrBroadcast: (Input) Specify own or broadcast RT address (NAIBRD_1553_RT_ADDRESS_OWN, NAIBRD_1553_RT_ADDRESS_BROADCAST, NAIBRD_1553_RT_ADDRESS_BOTH).
messageDirection: (Input) Specify the message direction (NAIBRD_1553_DIRECTION_TX, NAIBRD_1553_DIRECTION_RX, NAIBRD_1553_DIRECTION_ALL).
subaddress: (Input) Subaddress (0-31, NAIBRD_1553_RT_SA_ALL).
wordCountOrModeCodeMask: (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
  • NAIBRD_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAIBRD_1553_RC_INVALID_MODE when device mode is not set to RT or RT/MT
  • NAIBRD_1553_RC_INVALID_STATE when device is in an invalid state
  • NAIBRD_1553_RC_INVALID_PARAMETER when the value of ownAddressOrBroadcast, messageDirection and/or subaddress is invalid