|
static int32_t | GetChannelCount (uint32_t modId) |
|
static int32_t | GetMaxFifoCount (uint32_t modId) |
|
static int32_t | GetMaxDataRate (uint32_t modId) |
|
static nai_status_t | verify_channel (uint32_t modId, int32_t channel) |
|
static nai_status_t | is568Channel (uint32_t modId, int32_t channel) |
|
static nai_status_t | is579Channel (uint32_t modId, int32_t channel) |
|
static nai_status_t | ar_GetRxBufferCnt (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outcount) |
|
NAIBRDFUNC int32_t NAIAPI | naibrd_AR_GetChannelCount (uint32_t modId) |
| Returns the number of channels for the specified ARINC Module ID.
|
|
NAIBRDFUNC int32_t NAIAPI | naibrd_AR_GetMaxFifoCount (uint32_t modId) |
| Returns the max Fifo count for the specified ARINC Module ID.
|
|
NAIBRDFUNC int32_t NAIAPI | naibrd_AR_GetMaxDataRate (uint32_t modId) |
| Returns the max Data Rate for the specified ARINC Module ID.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetTxEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables or disables the Transmitter of the specified channel. The enabling of the transmitter should occur after configuration of the channel is completed by the user. In particular, make sure to set the Tx Mode with naibrd_AR_SetTransmitSendMode() prior to enabling the transmitter. Otherwise, the module may exhibit undefined behavior.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetTxEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Reads the state of the Transmitter of the specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetRxEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables or disables the receiver of the channel specified. The enabling of the receiver should occur after configuration of the channel is completed by the user. In particular, make sure to set the Rx Mode with naibrd_AR_SetReceiveMode() prior to enabling the receiver. Otherwise, the module may exhibit undefined behavior.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetRxEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Reads the receiver enabled / disabled status of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_LoadTxFifo (int32_t cardIndex, int32_t module, int32_t channel, int32_t txCount, const uint32_t *p_buffer, int32_t *p_outtxCount) |
| This function will write multiple 32-bit words of data to the transmit FIFO of the specified channel. A pointer to a buffer and length are passed as parameters. The actual number of words placed in the buffer is returned. If the available space in the FIFO is less than the number of messages being placed in the FIFO, the messages are not placed in the FIFO and instead, the available space in the FIFO is returned in the output variable.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_ReadRxFifo (int32_t cardIndex, int32_t module, int32_t channel, bool_t timeStampEnabled, int32_t rxCount, uint32_t *p_outstatus, uint32_t *p_outdata, uint32_t *p_outtimeStamp, int32_t *p_outrxCount) |
| This function reads new ARINC messages from the receive FIFO buffer. If timestamping is ENABLED and a new ARINC message is received, the receive FIFO will contain a new entry comprising three 32-bit words: status word, ARINC word and timestamp word. Under this scenario, if the user calls this function by passing in a 1 for rxCount, three words will be read from the receive FIFO to retrieve the status word, ARINC word and timestamp word. If timestamping is DISABLED and a new ARINC message is received, the receive FIFO will contain a new entry comprising two 32-bit words: status word and ARINC word. In this case, if the user calls this function by passing in a 1 for rxCount, two words will be read from the receive FIFO to retrieve the status word and ARINC word. NOTE: The user must indicate whether or not timestamping is enabled on this channel using the timeStampEnabled input parameter. Timestamping on a channel by channel basis is enabled or disabled with naibrd_AR_SetRxTimeStampEn().
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_ReadMBoxRxFifo (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outSDILabel) |
| This function, which is only used in Mailbox Receive mode, is used to retrieve SDI/Labels of new ARINC messages that have arrived in their respective mailboxes. In Mailbox Receive mode, which is configured with the function naibrd_AR_SetReceiveMode(), the hardware reserves 1024 32-bit words in module memory for 1024 mailboxes. Each mailbox is associated with a unique address given by the SDI/Label, of which there are 1024 (0 to 0x3FF) values. This function will read one 32-bit word from the Rx FIFO of the specified channel. This word will contain only the SDI/Label of the new ARINC message. Call naibrd_AR_ReadMBox with this SDI/Label to retrieve the new ARINC message from the mailbox. NOTE: The specified channel must be in Mailbox Receive mode for this function to work properly. This function will NOT check to make sure the channel is in the correct Receive mode.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_ReadMBox (int32_t cardIndex, int32_t module, int32_t channel, bool_t timeStampEnabled, uint32_t SDILabel, uint16_t *p_outstatus, uint32_t *p_outdata, uint32_t *p_outtimeStamp) |
| This function, which is only used in Mailbox Receive mode, is used to read ARINC messages from mailboxes. This function will read the ARINC word and associated status (and timestamp, if enabled) from the Mailbox specified by the SDI/Label. Use the naibrd_AR_ReadMBoxRxFifo function to read off any new SDI/Labels for which a new ARINC message has arrived. Then use this function to fetch the new ARINC message for that SDI/Label. NOTE: The specified channel must be in Mailbox Receive mode for this function to work properly. This function will NOT check to make sure the channel is in the correct Receive mode. Additionally, the user must indicate whether or not timestamping is enabled on this channel using the timeStampEnabled input parameter. Timestamping on a channel by channel basis is enabled or disabled with naibrd_AR_SetRxTimeStampEn().
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetTxFifoCnt (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outcount) |
| Returns the number of 32-bit ARINC words in the transmit FIFO of the specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetRxFifoCnt (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outcount) |
| Returns the number of ARINC messages in the receive FIFO of the specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_chan_mapped_status_type_t statusType, nai_status_bit_t *p_outstatusBit) |
| Read a channel mapped status bit for the specified channel and status type. Valid status types are defined by the naibrd_ar_chan_mapped_status_type_t enumeration. Refer to naibrd_AR_GetEventMappedStatus() for reading event mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_ar_chan_mapped_status_type_t statusType, uint32_t *p_outstatusRaw) |
| Read a channel mapped status register for the specified status type. Valid status types are defined by the naibrd_ar_chan_mapped_status_type_t enumeration. Refer to naibrd_AR_GetEventMappedStatusRaw() for reading event mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_ClearChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_chan_mapped_status_type_t statusType) |
| Clears the user specified latched status bit on the user specified channel. Refer to naibrd_AR_ClearEventMappedStatus() for clearing event mapped statuses. NOTE: this function does not apply to *_REALTIME status types, which do not clear. If a *_REALTIME status type is specified, this function returns NAI_ERROR_INVALID_VALUE.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_ClearChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_ar_chan_mapped_status_type_t statusType, uint32_t statusRaw) |
| Clears one or more latched channel mapped status bits for the user specified status type. Refer to naibrd_AR_ClearEventMappedStatusRaw() for clearing event mapped statuses. NOTE: this function does not apply to *_REALTIME status types, which do not clear. If a *_REALTIME status type is specified, this function returns NAI_ERROR_INVALID_VALUE.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetEventMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_event_mapped_status_type_t statusType, nai_status_bit_t *p_outstatusBit) |
| Read an event mapped status bit for the specified channel and status type. Valid status types are defined by the naibrd_ar_event_mapped_status_type_t enumeration.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetEventMappedStatusRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_status_access_type_t accessType, naibrd_ar_event_mapped_category_type_t categoryType, uint32_t *p_outstatusRaw) |
| This function reads an event mapped status register for the specified channel. Logic 1 is active.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_ClearEventMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_event_mapped_status_type_t statusType) |
| Clears the specified event mapped status bit. When an event occurs, the corresponding status bit gets set in both the realtime (dynamic) and latched status registers. The latched status bit will only clear if the user writes a '1' to the bit. This function is used to clear a user-specified bit in the latched status register. NOTE: If a _REALTIME status type is provided, the function will return NAI_ERROR_INVALID_VALUE since realtime status bits are not cleared by the user.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_ClearEventMappedStatusRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_event_mapped_category_type_t categoryType, uint32_t statusRaw) |
| This function clears one or more latched event mapped status bits. When an event occurs, the corresponding status bit gets set in both the realtime (dynamic) and latched status registers. The latched status bit will only clear if the user writes a '1' to the bit. This function is used to clear one or more user-specified bits in the latched status register.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetBaudRate (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_datarate_t dataRate) |
| Sets the ARINC channel data rate to high or low speed.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetBaudRate (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_datarate_t *p_outdataRate) |
| Gets the ARINC channel data rate.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetParityBitUsage (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_parity_t parityUsage) |
| This function sets the usage of the parity bit for the specified channel. When the parity bit usage is set for No Parity (NAIBRD_AR_PAR_NONE), the parity bit (bit 31) in the ARINC word is treated as another data bit and no parity checking occurs. If the parity bit usage is set for Odd Parity (NAIBRD_AR_PAR_ODD), bit 31 is treated as an odd parity bit. When Odd Parity is enabled, the transmitter calculates the odd parity bit and transmits it as bit 31. The receiver will check the received ARINC word for odd parity and will flag an error if even parity is detected.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetParityBitUsage (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_parity_t *p_outparityUsage) |
| This function gets the current usage setting of the parity bit for the specified channel. When the parity bit usage is set for No Parity (NAIBRD_AR_PAR_NONE), the parity bit (bit 31) in the ARINC word is treated as another data bit and no parity checking occurs. If the parity bit usage is set for Odd Parity (NAIBRD_AR_PAR_ODD), bit 31 is treated as an odd parity bit. When Odd Parity is enabled, the transmitter calculates the odd parity bit and transmits it as bit 31. The receiver will check the received ARINC word for odd parity and will flag an error if even parity is detected.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetRxFifoThreshold (int32_t cardIndex, int32_t module, int32_t channel, int32_t rxFifoThreshold) |
| Sets the receive FIFO threshold of the channel specified. The threshold range is 0 to 255.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetRxFifoThreshold (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outrxFifoThreshold) |
| Reads the receive FIFO threshold of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetRxFifoSize (int32_t cardIndex, int32_t module, int32_t channel, int32_t bufferLength) |
| Set the receive FIFO Buffer size (1 to 255) of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetRxFifoSize (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outbufferLength) |
| Get the receive FIFO Buffer size of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetRxFifoBounded (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| This function enables or disables bounded Rx FIFO mode. If bounded mode is enabled and the FIFO becomes full, the circuitry will block additional writes to the FIFO. If bounded mode is disabled and the FIFO becomes full, any new data will overwrite the oldest value in the FIFO and the FIFO essentially behaves like a circular FIFO.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetRxFifoBounded (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Reads the enabled / disabled state of the Bounded Rx FIFO configuration option. If Bounded Rx FIFO is enabled, after the FIFO is full, the circuitry will block additional writes to the FIFO. If Bounded Rx FIFO is disabled, after the FIFO is full, the new data will overwrite the oldest value in the FIFO, essentially behaving like a circular FIFO.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetReceiveMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_rx_mode_t rxMode) |
| Sets the received message storage mode of the specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetReceiveMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_rx_mode_t *p_outrxMode) |
| Gets the receive mode of the channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetRxStoreOnErrorEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| This function enables or disables receive message "store-on-error" for the specified channel. If store-on-error is disabled, errored ARINC messages will be discarded.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetRxStoreOnErrorEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Reads the receiver store on error status of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetTxFifoThreshold (int32_t cardIndex, int32_t module, int32_t channel, int32_t txFifoThreshold) |
| This function sets the transmit FIFO threshold of the specified channel. The threshold range is 0 to 255.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetTxFifoThreshold (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outtxFifoThreshold) |
| Reads the transmit FIFO threshold of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetTxGapTime (int32_t cardIndex, int32_t module, int32_t channel, int32_t txRate) |
| Sets the Gap time (Transmit Interval Rate) between transmitted ARINC messages in FIFO transmit modes. Gap time is given in bit times. Values less than 4 are not valid.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetTxGapTime (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outtxRate) |
| Gets the currently configured Gap time (Transmit Interval Rate) interval, which is number of bit times between transmitted ARINC messages when running in FIFO transmit mode.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetTransmitSendMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_tx_mode_t txSendMode) |
| This function sets the Transmit mode of the specified channel. Three modes are currently supported. In "Immediate
FIFO Mode", ARINC messages written to the Tx FIFO are immediately sent out. In "Triggered FIFO Mode", ARINC messages written to the Tx FIFO are sent out only if a Trigger issued with naibrd_AR_SetTxSendTrigger(). In "Scheduled Mode", ARINC messages are sent in accordance with a built-in schedule that is user-programmed.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetTransmitSendMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_tx_mode_t *p_outtxSendMode) |
| Gets the Transmit mode of the channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetRxValidationEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables or disables Message Validation for the channel specified. If message validation is not enabled, all received ARINC messages will be stored (in FIFO or Mailbox, depending on Rx mode). If message validation is enabled, only ARINC messages containing SDI/Labels that are match enabled will be stored. Match enabling for a particular SDI/Label can be enabled/disabled with naibrd_AR_SetLabelEnable(). Match enabling for all SDI/Labels can be enabled/disabled with naibrd_AR_SetLabelEnableAll().
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetRxValidationEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Gets the Message Validation configuration setting (enable or disable) for the channel specified. If message validation is not enabled, all received ARINC messages will be stored (in FIFO or Mailbox, depending on Rx mode). If message validation is enabled, only ARINC messages containing SDI/Labels that are match enabled will be stored. Match enabling for a particular SDI/Label can be enabled/disabled with naibrd_AR_SetLabelEnable(). Match enabling for all SDI/Labels can be enabled/disabled with naibrd_AR_SetLabelEnableAll().
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_ResetModule (int32_t cardIndex, int32_t module) |
| Resets the module specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_ChannelReset (int32_t cardIndex, int32_t module, int32_t channel) |
| Clears out Channel Control Low and Interrupt Enable registers as well as reset the transmit and receive circuits. (This will NOT reset the channel Transmit FIFO Rate, Tx Buffer Almost Empty, and Rx Buffer Almost Full registers)
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_ClearRxFifo (int32_t cardIndex, int32_t module, int32_t channel) |
| Clears the receive FIFO for the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_ClearTxFifo (int32_t cardIndex, int32_t module, int32_t channel) |
| Clears the transmit FIFO for the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetTxSendTrigger (int32_t cardIndex, int32_t module, int32_t channel) |
| Sets the transmit trigger for the channel specified, triggering a scheduled or trigger fifo operation. This bit is reset by the hardware.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetTxPause (int32_t cardIndex, int32_t module, int32_t channel) |
| Pauses the transmitter for the channel specified after the current word and gap time has finished transmitting. To resume, issue Transmit Trigger command or issue a Transmit Stop command to halt transmission.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetTxStop (int32_t cardIndex, int32_t module, int32_t channel) |
| Stops the transmitter for the channel specified after the current word and gap time has finished transmitting. Also, clears the FIFO.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetLabelEnable (int32_t cardIndex, int32_t module, int32_t channel, uint32_t SDILabel, bool_t enable) |
| Enables or disables matching for messages containing the user specified SDI/Label. If Message Validation is enabled (using naibrd_AR_SetRxValidationEnable() function) for the channel, only ARINC messages containing SDI/Labels that have enabled matching will get stored. If Message Validation is not enabled for the channel, this function has no effect and all ARINC messages (without errors) will get stored.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetLabelEnable (int32_t cardIndex, int32_t module, int32_t channel, uint32_t SDILabel, bool_t *p_outenable) |
| Gets the current match enable setting of the user specified SDI/Label. If Message Validation is enabled (using naibrd_AR_SetRxValidationEnable() function) for the channel, only ARINC messages containing SDI/Labels that have enabled matching will get stored. If Message Validation is not enabled for the channel, all ARINC messages (without errors) will get stored regardless of the SDI/Label's match enable setting.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetLabelEnableAll (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables or disables matching for all 1024 SDI/Labels (0x0 to 0x3FF). If Message Validation is enabled (using naibrd_AR_SetRxValidationEnable() function) for the channel, only ARINC messages containing SDI/Labels that have enabled matching will get stored. If Message Validation is not enabled for the channel, this function has no effect and all ARINC messages (without errors) will get stored.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetTxScheduleCmd (int32_t cardIndex, int32_t module, int32_t channel, uint32_t cmdNum, naibrd_ar_sched_cmd_t cmdType, uint16_t parameter) |
| Set up a command in the transmit schedule. Use this function to build a transmit message schedule. Make sure that the transmit send mode is set to Schedule Mode with naibrd_AR_SetTransmitSendMode() prior to using this function. The transmit schedule memory allows up to 512 commands (or instructions) for message transmission without host software intervention. The following command types (instructions) are available for constructing a schedule:
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetTxScheduleCmd (int32_t cardIndex, int32_t module, int32_t channel, uint32_t cmdNum, uint16_t *p_outcmdWord) |
| Reads a command entry (given by the user-specified command number) in the transmit message schedule. The commands in the transmit message schedule are set up using the function naibrd_AR_SetTxScheduleCmd(). The current function is used to read what is currently loaded in the transmit message schedule. After this function executes, the output variable p_outcmdWord will contain a 16-bit value that can be decoded in the following way:
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_WriteMsgMem (int32_t cardIndex, int32_t module, int32_t channel, uint32_t memAddr, uint32_t data) |
| Writes 32-bit data to the user specified Transmit Message Memory Address (memAddr) of the specified channel. The Transmit Message Memory is used to store 32-bit ARINC words and Gap Times for utilization by the Transmit Message Scheduler. Please read the description of naibrd_AR_SetTxScheduleCmd() to understand how this function is used in the context of setting up a schedule. The valid range for memAddr is 0 to 1023 (0x3FF) and it addresses a 32-bit word in memory.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_ReadMsgMem (int32_t cardIndex, int32_t module, int32_t channel, uint32_t memAddr, uint32_t *p_outdata) |
| Reads 32-bit data from the user specified Transmit Message Memory Address (memAddr) of the specified channel. The Transmit Message Memory is used to store 32-bit ARINC words and Gap Times for utilization by the Transmit Message Scheduler. This function is used to read the contents of the Transmit Message Memory at user-specified locations. The valid range for memAddr is 0 to 1023 (0x3FF) and it addresses a 32-bit word in memory.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SendAsyncMsg (int32_t cardIndex, int32_t module, int32_t channel, uint32_t msgWord) |
| Send an asynchronous ARINC word on the specified channel. This function is used to send an asynchronous message while the channel is transmitting a schedule. Asynchronous messages will only get sent between messages during gap times that are greater than or equal to 40 bit-times. Asynchronous messages will not get sent during Fixed Gap times. Use naibrd_AR_GetEventMappedStatus() to check the Async Data Available bit, which clears once the Async word has transmitted.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetRxTimeStampEn (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables or disables time stamping for the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetRxTimeStampEn (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Reads the time stamp enable status of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_ResetTimeStamp (int32_t cardIndex, int32_t module) |
| Resets the time stamp for the module specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetTimeStampResolution (int32_t cardIndex, int32_t module, naibrd_ar_tstamp_t resolution) |
| Sets the time stamp resolution for the module specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetTimeStampResolution (int32_t cardIndex, int32_t module, naibrd_ar_tstamp_t *p_outresolution) |
| Gets the time stamp resolution for the module specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetModuleTimeStamp (int32_t cardIndex, int32_t module, uint32_t *p_outtimeStamp) |
| Reads the time stamp for the module specified. The time stamp resolution can be retrieved by calling naibrd_AR_GetTimeStampResolution().
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_InitiateBIT (int32_t cardIndex, int32_t module, int32_t channel, bool_t waitForResult) |
| Executes the AR-429 Initiated Built-in Test and returns the result. If the user chooses to wait for the result (waitForResult = NAI_TRUE) then the result of the test is returned in the status, either as NAI_SUCCESS or NAI_ERROR_BIT_FAILED. If the user chooses not to wait for the result, they can call naibrd_AR_CheckBITComplete() and naibrd_AR_GetChanMappedStatus() at a later time to verify the test has completed and fetch the BIT status.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_CheckBITComplete (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outbitComplete) |
| Retrieves the BIT status (complete or incomplete) of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_CheckPowerOnBITComplete (int32_t cardIndex, int32_t module, bool_t *p_outpbitComplete) |
| Retrieves the Power-On BIT (PBIT) status (complete or incomplete) for the specified channel. The PBIT result will be in the BIT status register.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetChanMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_chan_mapped_status_type_t statusType, bool_t enable) |
| This function is used to enable interrupt generation on a single channel mapped status bit. Refer to naibrd_AR_SetEventMappedInterruptEnable() to set the interrupt enable/disable setting of event-mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetChanMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_chan_mapped_status_type_t statusType, bool_t *p_outenable) |
| Get the interrupt enable state for a channel mapped status bit. Refer to naibrd_AR_GetEventMappedInterruptEnable() to retrieve the interrupt enable/disable setting of event-mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetChanMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_chan_mapped_status_type_t statusType, naibrd_int_trigger_type_t triggerType) |
| Sets the Interrupt trigger mode (edge or level) for a channel mapped status bit. Refer to naibrd_AR_SetEventMappedInterruptTriggerType() to set the interrupt trigger mode of event mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetChanMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_chan_mapped_status_type_t statusType, naibrd_int_trigger_type_t *p_outtriggerType) |
| Gets the Interrupt trigger mode (edge or level) for a channel mapped status bit. Refer to naibrd_AR_GetEventMappedInterruptTriggerType() to retrieve the interrupt trigger mode of event mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetChanMappedInterruptVector (int32_t cardIndex, int32_t module, naibrd_ar_chan_mapped_status_type_t statusType, int32_t vector) |
| Sets the Interrupt Vector for the status type specified. The Interrupt Service callback routine passes in this vector value to identify the status type that generated the interrupt.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetChanMappedInterruptVector (int32_t cardIndex, int32_t module, naibrd_ar_chan_mapped_status_type_t statusType, int32_t *p_outvector) |
| Returns the Interrupt Vector of the status type specified. The Interrupt Service callback routine passes in this vector value to identify the status type that generated the interrupt.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetChanMappedInterruptSteering (int32_t cardIndex, int32_t module, naibrd_ar_chan_mapped_status_type_t statusType, naibrd_int_steering_t steering) |
| Sets the Interrupt Steering, which indicates where to direct the interrupt signal, for the specified status type.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetChanMappedInterruptSteering (int32_t cardIndex, int32_t module, naibrd_ar_chan_mapped_status_type_t statusType, naibrd_int_steering_t *p_outsteering) |
| Retrieves the Interrupt Steering, which indicates where to direct the interrupt signal, for the specified status type.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetEventMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_event_mapped_status_type_t statusType, bool_t enable) |
| This function is used to enable interrupt generation on a single event mapped status bit. Refer to naibrd_AR_SetChanMappedInterruptEnable() to set the interrupt enable/disable setting of channel-mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetEventMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_event_mapped_status_type_t statusType, bool_t *p_outenable) |
| This function is used to retrieve the interrupt enable state on a single event mapped status bit. Refer to naibrd_AR_GetChanMappedInterruptEnable() to get the interrupt enable/disable setting of channel-mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetEventMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_event_mapped_status_type_t statusType, naibrd_int_trigger_type_t triggerType) |
| Sets the Interrupt trigger mode (edge or level) for an event mapped status bit. Refer to naibrd_AR_SetChanMappedInterruptTriggerType() to set the interrupt trigger mode of channel mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetEventMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_event_mapped_status_type_t statusType, naibrd_int_trigger_type_t *p_outtriggerType) |
| Gets the Interrupt trigger mode (edge or level) for an event mapped status bit. Refer to naibrd_AR_GetChanMappedInterruptTriggerType() to retrieve the interrupt trigger mode of channel mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetEventMappedInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_event_mapped_category_type_t categoryType, uint32_t vector) |
| Sets the Interrupt Vector for the channel and category type specified. Only NAIBRD_AR_EVENT_MAP_GENERAL category is supported by this function. The Interrupt Service callback routine passes in this vector value to identify the channel that generated the interrupt.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetEventMappedInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_event_mapped_category_type_t categoryType, uint32_t *p_outvector) |
| Retrieves the Interrupt Vector for the channel and category type specified. Only NAIBRD_AR_EVENT_MAP_GENERAL category is supported by this function. The Interrupt Service callback routine passes in this vector value to identify the channel that generated the interrupt.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetEventMappedInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_event_mapped_category_type_t categoryType, naibrd_int_steering_t steering) |
| Sets the Interrupt Steering, which indicates where to direct the interrupt signal, for the channel and category specified. Only the NAIBRD_AR_EVENT_MAP_GENERAL category is supported by this function.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetEventMappedInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_event_mapped_category_type_t categoryType, naibrd_int_steering_t *p_outsteering) |
| Retrieves the Interrupt Steering, which indicates where to direct the interrupt signal, for the channel and category specified. Only the NAIBRD_AR_EVENT_MAP_GENERAL category is supported by this function.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetModuleBITEnable (int32_t cardIndex, int32_t module, uint32_t bitEnable) |
| Executes the Initiated BIT test for the specified channels in bitEnable. Use this function if you want to run IBIT on more than one channel at a time. Otherwise use naibrd_AR_InitiateBIT().
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetModuleBITEnable (int32_t cardIndex, int32_t module, uint32_t *p_outbitEnable) |
| Retrieves the state (enabled or disabled) of the Initiated BIT test on all channels. Once the IBIT test is enabled by calling naibrd_AR_SetModuleBITEnable() use this function to check if the test has completed by verifying the bits set have cleared.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_SetModuleBITErrorThreshold (int32_t cardIndex, int32_t module, uint32_t threshold) |
| Sets the BIT Error Threshold for continuous BIT conditions. The Error Threshold is a scalar for the internal BIT +2/-1 counter. To filter our momentary or intermittent anomalies in background BIT errors, this value can be increased to allow the error the "come and go" before the BIT status is flagged.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_GetModuleBITErrorThreshold (int32_t cardIndex, int32_t module, uint32_t *p_outthreshold) |
| Retrieves the BIT Error Threshold for continuous BIT conditions. The Error Threshold is a scalar for the internal BIT +2/-1 counter. To filter our momentary or intermittent anomalies in background BIT errors, this value can be increased to allow the error the "come and go" before the BIT status is flagged.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR_ClearModuleBITLogic (int32_t cardIndex, int32_t module, int32_t channel) |
| Resets the Continuous BIT internal circuitry and counter mechanism for the specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_SetTxEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables or disables the Transmitter of the specified channel. The enabling of the transmitter should occur after configuration of the channel is completed by the user. In particular, make sure to set the Tx Mode with naibrd_AR568_SetTransmitSendMode() prior to enabling the transmitter. Otherwise, the module may exhibit undefined behavior.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetTxEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Reads the state of the Transmitter of the specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_SetRxEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables or disables the receiver of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetRxEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Reads the receiver enabled / disabled status of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_LoadTxFifo (int32_t cardIndex, int32_t module, int32_t channel, int32_t txCount, const uint32_t *p_buffer, int32_t *p_outtxCount) |
| This function will write multiple 32-bit words of data to the transmit FIFO of the specified channel. A pointer to a buffer and length are passed as parameters. The actual number of words placed in the buffer is returned. If the available space in the FIFO is less than the number of messages being placed in the FIFO, the messages are not placed in the FIFO and instead, the available space in the FIFO is returned in the output variable.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_ReadRxFifo (int32_t cardIndex, int32_t module, int32_t channel, int32_t rxCount, uint32_t *p_outdata, int32_t *p_outrxCount) |
| This function reads the 32-bit ARINC-568 data from the receive FIFO of the specified channel for the number of words (of data) specified (up to 1024).
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetTxFifoCnt (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outcount) |
| Returns the number of 32-bit ARINC-568 words in the transmit FIFO of the specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetRxFifoCnt (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outcount) |
| Returns the number of ARINC-568 messages in the receive FIFO of the specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_chan_mapped_status_type_t statusType, nai_status_bit_t *p_outstatusBit) |
| Read a channel mapped status bit for the specified channel and status type. Valid status types are defined by the naibrd_ar568_chan_mapped_status_type_t enumeration. Only BIT statuses are able to be read using this function. Refer to naibrd_AR568_GetEventMappedStatus() for reading event mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_ar568_chan_mapped_status_type_t statusType, uint32_t *p_outstatusRaw) |
| Read a channel mapped status register for the specified status type. Valid status types are defined by the naibrd_ar568_chan_mapped_status_type_t enumeration. Only BIT statuses are able to be read using this function. Refer to naibrd_AR568_GetEventMappedStatusRaw() for reading event mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_ClearChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_chan_mapped_status_type_t statusType) |
| Clears the user specified latched status bit on the user specified channel. Only BIT statuses are able to be cleared using this function. Refer to naibrd_AR568_ClearEventMappedStatus() for clearing event mapped statuses. NOTE: this function does not apply to *_REALTIME status types, which do not clear. If a *_REALTIME status type is specified, this function returns NAI_ERROR_INVALID_VALUE.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_ClearChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_ar568_chan_mapped_status_type_t statusType, uint32_t statusRaw) |
| Clears one or more latched channel mapped status bits for the user specified status type. Only BIT statuses are able to be cleared using this function. Refer to naibrd_AR568_ClearEventMappedStatusRaw() for clearing event mapped statuses. NOTE: this function does not apply to *_REALTIME status types, which do not clear. If a *_REALTIME status type is specified, this function returns NAI_ERROR_INVALID_VALUE.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetEventMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_event_mapped_status_type_t statusType, nai_status_bit_t *p_outstatusBit) |
| Read an event mapped status bit for the specified channel and status type. Valid status types are defined by the naibrd_ar568_event_mapped_status_type_t enumeration.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetEventMappedStatusRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_status_access_type_t accessType, naibrd_ar568_event_mapped_category_type_t categoryType, uint32_t *p_outstatusRaw) |
| This function reads an event mapped status register for the specified channel. Logic 1 is active.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_ClearEventMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_event_mapped_status_type_t statusType) |
| Clears the specified event mapped status bit. When an event occurs, the corresponding status bit gets set in both the realtime (dynamic) and latched status registers. The latched status bit will only clear if the user writes a '1' to the bit. This function is used to clear a user-specified bit in the latched status register. NOTE: If a _REALTIME status type is provided, the function will return NAI_ERROR_INVALID_VALUE since realtime status bits are not cleared by the user.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_ClearEventMappedStatusRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_event_mapped_category_type_t categoryType, uint32_t statusRaw) |
| This function clears one or more latched event mapped status bits. When an event occurs, the corresponding status bit gets set in both the realtime (dynamic) and latched status registers. The latched status bit will only clear if the user writes a '1' to the bit. This function is used to clear one or more user-specified bits in the latched status register.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_SetTxBITEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables or disables Tx Built-in-Test of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetTxBITEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Reads the Tx Built-in-Test Enable / Disable status of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_SetRxBITEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables or disables Rx Built-in-Test of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetRxBITEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Reads the Rx Built-in-Test Enable / Disable status of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_SetRxFifoThresholds (int32_t cardIndex, int32_t module, int32_t channel, int32_t aeThreshold, int32_t afThreshold) |
| Sets the receive FIFO almost empty and almost full thresholds of the channel specified to a number between 0 and 1023.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetRxFifoThresholds (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outaeThreshold, int32_t *p_outafThreshold) |
| Reads the receive Almost Empty and Almost Full FIFO thresholds of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_SetRxFifoBounded (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables or disables Bounded Rx FIFO mode. If Bounded Rx FIFO is enabled, after the FIFO is full, the circuitry will block additional writes to the FIFO. If Bounded Rx FIFO is disabled, after the FIFO is full, the new data will overwrite the oldest value in the FIFO, essentially behaving like a circular FIFO.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetRxFifoBounded (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Reads the enabled / disabled state of the Bounded Rx FIFO configuration option. If Bounded Rx FIFO is enabled, after the FIFO is full, the circuitry will block additional writes to the FIFO. If Bounded Rx FIFO is disabled, after the FIFO is full, the new data will overwrite the oldest value in the FIFO, essentially behaving like a circular FIFO.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_SetBITErrorThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t bitErrorThreshold) |
| Set the BIT Error Threshold (number at which the BIT error count causes a BIT error).
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetBITErrorThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outbitErrorThreshold) |
| Get the BIT Error Threshold (number at which the BIT error count causes a BIT error).
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_SetTxFifoThresholds (int32_t cardIndex, int32_t module, int32_t channel, int32_t aeThreshold, int32_t afThreshold) |
| Sets the transmit FIFO threshold of the channel specified to a number between 0 and 1023.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetTxFifoThresholds (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outaeThreshold, int32_t *p_outafThreshold) |
| Reads the transmit FIFO threshold of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_SetTxFifoBounded (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables or disables Bounded Tx FIFO mode. If Bounded Tx FIFO is enabled, after the FIFO is full, the circuitry will block additional writes to the FIFO. If Bounded Tx FIFO is disabled, after the FIFO is full, the new data will overwrite the oldest value in the FIFO, essentially behaving like a circular FIFO.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetTxFifoBounded (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Reads the enabled / disabled state of the Bounded Tx FIFO configuration option. If Bounded Tx FIFO is enabled, after the FIFO is full, the circuitry will block additional writes to the FIFO. If Bounded Tx FIFO is disabled, after the FIFO is full, the new data will overwrite the oldest value in the FIFO, essentially behaving like a circular FIFO.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_SetTxGapTime (int32_t cardIndex, int32_t module, int32_t channel, int32_t txRate) |
| Sets the Gap time (Transmit Interval Rate) between transmitted ARINC messages in FIFO transmit modes. Gap time is given in bit times. Values less than 4 are not valid.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetTxGapTime (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outtxRate) |
| Gets the currently configured Gap time (Transmit Interval Rate) interval, which is number of bit times between transmitted ARINC messages when running in FIFO transmit mode.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_SetTransmitSendMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_tx_mode_t txSendMode) |
| This function sets the Transmit mode of the specified channel. Two modes are currently supported. In "Immediate
FIFO Mode", ARINC messages written to the Tx FIFO are immediately sent out. In "Triggered FIFO Mode", ARINC messages written to the Tx FIFO are sent out only if a Trigger issued with naibrd_AR_SetTxSendTrigger().
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetTransmitSendMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_tx_mode_t *p_outtxSendMode) |
| Gets the Transmit mode of the channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_SetLoopbackEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enable or disable the Tx Loopback option of the 568 channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetLoopbackEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Reads the Tx Loopback enabled status of the 568 channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_ChannelReset (int32_t cardIndex, int32_t module, int32_t channel) |
| Clears out Channel Control Low and Interrupt Enable registers as well as reset the transmit and receive circuits. (This will NOT reset the channel Transmit FIFO Rate, Tx Buffer Almost Empty, and Rx Buffer Almost Full registers)
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_ClearRxFifo (int32_t cardIndex, int32_t module, int32_t channel) |
| Clears the receive FIFO for the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_ClearTxFifo (int32_t cardIndex, int32_t module, int32_t channel) |
| Clears the transmit FIFO for the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_SetTxSendTrigger (int32_t cardIndex, int32_t module, int32_t channel) |
| Sets the transmit trigger for the channel specified, triggering a scheduled or trigger fifo operation. This bit is reset by the hardware.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_ClearTxBITError (int32_t cardIndex, int32_t module, int32_t channel) |
| Clear the Tx BIT Error.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_ClearRxBITError (int32_t cardIndex, int32_t module, int32_t channel) |
| Clear the Rx BIT Error.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_SetChanMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_chan_mapped_status_type_t statusType, bool_t enable) |
| This function is used to enable interrupt generation on a single channel mapped status bit. Only BIT events are supported in this function. Refer to naibrd_AR568_SetEventMappedInterruptEnable() to set the interrupt enable/disable setting of event-mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetChanMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_chan_mapped_status_type_t statusType, bool_t *p_outenable) |
| Get the interrupt enable state for a channel mapped status bit. Only BIT interrupts are supported in this function. Refer to naibrd_AR568_GetEventMappedInterruptEnable() to retrieve the interrupt enable/disable setting of event-mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_SetChanMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_chan_mapped_status_type_t statusType, naibrd_int_trigger_type_t triggerType) |
| Sets the Interrupt trigger mode (edge or level) for a channel mapped status bit. Only BIT interrupts are supported in this function. Refer to naibrd_AR568_SetEventMappedInterruptTriggerType() to set the interrupt trigger mode of event mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetChanMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_chan_mapped_status_type_t statusType, naibrd_int_trigger_type_t *p_outtriggerType) |
| Gets the Interrupt trigger mode (edge or level) for a channel mapped status bit. Only BIT interrupts are supported in this function. Refer to naibrd_AR568_GetEventMappedInterruptTriggerType() to retrieve the interrupt trigger mode of event mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_SetChanMappedInterruptVector (int32_t cardIndex, int32_t module, naibrd_ar568_chan_mapped_status_type_t statusType, int32_t vector) |
| Sets the Interrupt Vector for the status type specified. Only the BIT status type is supported by this function. The Interrupt Service callback routine passes in this vector value to identify the status type that generated the interrupt.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetChanMappedInterruptVector (int32_t cardIndex, int32_t module, naibrd_ar568_chan_mapped_status_type_t statusType, int32_t *p_outvector) |
| Returns the Interrupt Vector of the status type specified. Only the BIT status type is supported by this function. The Interrupt Service callback routine passes in this vector value to identify the status type that generated the interrupt.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_SetChanMappedInterruptSteering (int32_t cardIndex, int32_t module, naibrd_ar568_chan_mapped_status_type_t statusType, naibrd_int_steering_t steering) |
| Sets the Interrupt Steering, which indicates where to direct the interrupt signal, for the specified status type. Only the BIT status type is supported by this function.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetChanMappedInterruptSteering (int32_t cardIndex, int32_t module, naibrd_ar568_chan_mapped_status_type_t statusType, naibrd_int_steering_t *p_outsteering) |
| Retrieves the Interrupt Steering, which indicates where to direct the interrupt signal, for the specified status type. Only the BIT status type is supported by this function.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_SetEventMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_event_mapped_status_type_t statusType, bool_t enable) |
| This function is used to enable interrupt generation on a single event mapped status bit. Refer to naibrd_AR568_SetChanMappedInterruptEnable() to set the interrupt enable/disable setting of channel-mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetEventMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_event_mapped_status_type_t statusType, bool_t *p_outenable) |
| This function is used to retrieve the interrupt enable state on a single event mapped status bit. Refer to naibrd_AR568_GetChanMappedInterruptEnable() to get the interrupt enable/disable setting of channel-mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_SetEventMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_event_mapped_status_type_t statusType, naibrd_int_trigger_type_t triggerType) |
| Sets the Interrupt trigger mode (edge or level) for an event mapped status bit. Refer to naibrd_AR568_SetChanMappedInterruptTriggerType() to set the interrupt trigger mode of channel mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetEventMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_event_mapped_status_type_t statusType, naibrd_int_trigger_type_t *p_outtriggerType) |
| Gets the Interrupt trigger mode (edge or level) for an event mapped status bit. Refer to naibrd_AR568_GetChanMappedInterruptTriggerType() to retrieve the interrupt trigger mode of channel mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_SetEventMappedInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_event_mapped_category_type_t categoryType, uint32_t vector) |
| Sets the Interrupt Vector for the channel and category type specified. Only NAIBRD_AR568_EVENT_MAP_GENERAL category is supported by this function. The Interrupt Service callback routine passes in this vector value to identify the channel that generated the interrupt.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetEventMappedInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_event_mapped_category_type_t categoryType, uint32_t *p_outvector) |
| Retrieves the Interrupt Vector for the channel and category type specified. Only NAIBRD_AR568_EVENT_MAP_GENERAL category is supported by this function. The Interrupt Service callback routine passes in this vector value to identify the channel that generated the interrupt.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_SetEventMappedInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_event_mapped_category_type_t categoryType, naibrd_int_steering_t steering) |
| Sets the Interrupt Steering, which indicates where to direct the interrupt signal, for the channel and category specified. Only the NAIBRD_AR568_EVENT_MAP_GENERAL category is supported by this function.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR568_GetEventMappedInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar568_event_mapped_category_type_t categoryType, naibrd_int_steering_t *p_outsteering) |
| Retrieves the Interrupt Steering, which indicates where to direct the interrupt signal, for the channel and category specified. Only the NAIBRD_AR568_EVENT_MAP_GENERAL category is supported by this function.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetTxEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables or disables the Transmitter of the specified channel. The enabling of the transmitter should occur after configuration of the channel is completed by the user. In particular, make sure to set the Tx Mode with naibrd_AR579_SetTransmitSendMode() prior to enabling the transmitter. Otherwise, the module may exhibit undefined behavior.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetTxEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Reads the state of the Transmitter of the specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetRxEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables or disables the receiver of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetRxEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Reads the receiver enabled / disabled status of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_LoadTxFifo (int32_t cardIndex, int32_t module, int32_t channel, int32_t txCount, const uint32_t *p_buffer, int32_t *p_outtxCount) |
| This function will write multiple 32-bit words of data to the transmit FIFO of the specified channel. A pointer to a buffer and length are passed as parameters. The actual number of words placed in the buffer is returned. If the available space in the FIFO is less than the number of messages being placed in the FIFO, the messages are not placed in the FIFO and instead, the available space in the FIFO is returned in the output variable.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_ReadRxFifo (int32_t cardIndex, int32_t module, int32_t channel, bool_t timeStampEnabled, int32_t rxCount, uint32_t *p_outstatus, uint32_t *p_outdata, uint32_t *p_outtimeStamp, int32_t *p_outrxCount) |
| This function reads the 32-bit ARINC-579 data from the receive FIFO of the specified channel for the number of words (of data) specified (up to 1024).
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetTxFifoCnt (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outcount) |
| Returns the number of 32-bit ARINC-579 words in the transmit FIFO of the specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetRxFifoCnt (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outcount) |
| Returns the number of ARINC-579 messages in the receive FIFO of the specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_chan_mapped_status_type_t statusType, nai_status_bit_t *p_outstatusBit) |
| Read a channel mapped status bit for the specified channel and status type. Valid status types are defined by the naibrd_ar579_chan_mapped_status_type_t enumeration. Only BIT statuses are able to be read using this function. Refer to naibrd_AR579_GetEventMappedStatus() for reading event mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_ar579_chan_mapped_status_type_t statusType, uint32_t *p_outstatusRaw) |
| Read a channel mapped status register for the specified status type. Valid status types are defined by the naibrd_ar579_chan_mapped_status_type_t enumeration. Only BIT statuses are able to be read using this function. Refer to naibrd_AR579_GetEventMappedStatusRaw() for reading event mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_ClearChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_chan_mapped_status_type_t statusType) |
| Clears the user specified latched status bit on the user specified channel. Only BIT statuses are able to be cleared using this function. Refer to naibrd_AR579_ClearEventMappedStatus() for clearing event mapped statuses. NOTE: this function does not apply to *_REALTIME status types, which do not clear. If a *_REALTIME status type is specified, this function returns NAI_ERROR_INVALID_VALUE.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_ClearChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_ar579_chan_mapped_status_type_t statusType, uint32_t statusRaw) |
| Clears one or more latched channel mapped status bits for the user specified status type. Only BIT statuses are able to be cleared using this function. Refer to naibrd_AR579_ClearEventMappedStatusRaw() for clearing event mapped statuses. NOTE: this function does not apply to *_REALTIME status types, which do not clear. If a *_REALTIME status type is specified, this function returns NAI_ERROR_INVALID_VALUE.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetEventMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_event_mapped_status_type_t statusType, nai_status_bit_t *p_outstatusBit) |
| Read an event mapped status bit for the specified channel and status type. Valid status types are defined by the naibrd_ar579_event_mapped_status_type_t enumeration.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetEventMappedStatusRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_status_access_type_t accessType, naibrd_ar579_event_mapped_category_type_t categoryType, uint32_t *p_outstatusRaw) |
| This function reads an event mapped status register for the specified channel. Logic 1 is active.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_ClearEventMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_event_mapped_status_type_t statusType) |
| Clears the specified event mapped status bit. When an event occurs, the corresponding status bit gets set in both the realtime (dynamic) and latched status registers. The latched status bit will only clear if the user writes a '1' to the bit. This function is used to clear a user-specified bit in the latched status register. NOTE: If a _REALTIME status type is provided, the function will return NAI_ERROR_INVALID_VALUE since realtime status bits are not cleared by the user.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_ClearEventMappedStatusRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_event_mapped_category_type_t categoryType, uint32_t statusRaw) |
| This function clears one or more latched event mapped status bits. When an event occurs, the corresponding status bit gets set in both the realtime (dynamic) and latched status registers. The latched status bit will only clear if the user writes a '1' to the bit. This function is used to clear one or more user-specified bits in the latched status register.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetParityBitUsage (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_parity_t parityUsage) |
| This function sets the usage of the parity bit for the specified channel. When the parity bit usage is set for No Parity (NAIBRD_AR_PAR_NONE), the parity bit (bit 31) in the ARINC word is treated as another data bit and no parity checking occurs. If the parity bit usage is set for Odd Parity (NAIBRD_AR_PAR_ODD), bit 31 is treated as an odd parity bit. When Odd Parity is enabled, the transmitter calculates the odd parity bit and transmits it as bit 31. The receiver will check the received ARINC word for odd parity and will flag an error if even parity is detected.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetParityBitUsage (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar_parity_t *p_outparityUsage) |
| This function gets the current usage setting of the parity bit for the specified channel. When the parity bit usage is set for No Parity (NAIBRD_AR_PAR_NONE), the parity bit (bit 31) in the ARINC word is treated as another data bit and no parity checking occurs. If the parity bit usage is set for Odd Parity (NAIBRD_AR_PAR_ODD), bit 31 is treated as an odd parity bit. When Odd Parity is enabled, the transmitter calculates the odd parity bit and transmits it as bit 31. The receiver will check the received ARINC word for odd parity and will flag an error if even parity is detected.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetTxBITEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables or disables Tx Built-in-Test of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetTxBITEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Reads the Tx Built-in-Test Enable / Disable status of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetRxBITEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables or disables Rx Built-in-Test of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetRxBITEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Reads the Rx Built-in-Test Enable / Disable status of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetRxFifoThresholds (int32_t cardIndex, int32_t module, int32_t channel, int32_t aeThreshold, int32_t afThreshold) |
| Sets the receive FIFO almost empty and almost full thresholds of the channel specified to a number between 0 and 1023.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetRxFifoThresholds (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outaeThreshold, int32_t *p_outafThreshold) |
| Reads the receive Almost Empty and Almost Full FIFO thresholds of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetRxFifoBounded (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables or disables Bounded Rx FIFO mode. If Bounded Rx FIFO is enabled, after the FIFO is full, the circuitry will block additional writes to the FIFO. If Bounded Rx FIFO is disabled, after the FIFO is full, the new data will overwrite the oldest value in the FIFO, essentially behaving like a circular FIFO.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetRxFifoBounded (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Reads the enabled / disabled state of the Bounded Rx FIFO configuration option. If Bounded Rx FIFO is enabled, after the FIFO is full, the circuitry will block additional writes to the FIFO. If Bounded Rx FIFO is disabled, after the FIFO is full, the new data will overwrite the oldest value in the FIFO, essentially behaving like a circular FIFO.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetRxStoreOnErrorEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| This function enables or disables receive message "store-on-error" for the specified channel. If store-on-error is disabled, errored ARINC messages will be discarded.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetRxStoreOnErrorEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Reads the receiver store on error status of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetBITErrorThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t bitErrorThreshold) |
| Set the BIT Error Threshold (number at which the BIT error count causes a BIT error).
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetBITErrorThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outbitErrorThreshold) |
| Get the BIT Error Threshold (number at which the BIT error count causes a BIT error).
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetTxFifoThresholds (int32_t cardIndex, int32_t module, int32_t channel, int32_t aeThreshold, int32_t afThreshold) |
| Sets the transmit FIFO threshold of the channel specified to a number between 0 and 1023.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetTxFifoThresholds (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outaeThreshold, int32_t *p_outafThreshold) |
| Reads the transmit FIFO threshold of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetTxFifoBounded (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Reads the enabled / disabled state of the Bounded Tx FIFO configuration option. If Bounded Tx FIFO is enabled, after the FIFO is full, the circuitry will block additional writes to the FIFO. If Bounded Tx FIFO is disabled, after the FIFO is full, the new data will overwrite the oldest value in the FIFO, essentially behaving like a circular FIFO.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetTxGapTime (int32_t cardIndex, int32_t module, int32_t channel, int32_t txRate) |
| Sets the Gap time (Transmit Interval Rate) between transmitted ARINC messages in FIFO transmit modes. Gap time is given in bit times. Values less than 4 are not valid.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetTxGapTime (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outtxRate) |
| Gets the currently configured Gap time (Transmit Interval Rate) interval, which is number of bit times between transmitted ARINC messages when running in FIFO transmit mode.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetTransmitSendMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_tx_mode_t txSendMode) |
| This function sets the Transmit mode of the specified channel. Two modes are currently supported. In "Immediate
FIFO Mode", ARINC messages written to the Tx FIFO are immediately sent out. In "Triggered FIFO Mode", ARINC messages written to the Tx FIFO are sent out only if a Trigger issued with naibrd_AR_SetTxSendTrigger().
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetTransmitSendMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_tx_mode_t *p_outtxSendMode) |
| Gets the Transmit mode of the channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetTxRiseAndFallTime (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_slope_control_t txRiseFallTime) |
| Set the rise/fall time of the ARINC transmitter.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetTxRiseAndFallTime (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_slope_control_t *p_outtxRiseFallTime) |
| Reads the currently set rise/fall time of the ARINC transmitter.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_ChannelReset (int32_t cardIndex, int32_t module, int32_t channel) |
| Clears out Channel Control Low and Interrupt Enable registers as well as reset the transmit and receive circuits. (This will NOT reset the channel Transmit FIFO Rate, Tx Buffer Almost Empty, and Rx Buffer Almost Full registers)
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_ClearRxFifo (int32_t cardIndex, int32_t module, int32_t channel) |
| Clears the receive FIFO for the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_ClearTxFifo (int32_t cardIndex, int32_t module, int32_t channel) |
| Clears the transmit FIFO for the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetTxSendTrigger (int32_t cardIndex, int32_t module, int32_t channel) |
| Sets the transmit trigger for the channel specified, triggering a scheduled or trigger fifo operation. This bit is reset by the hardware.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_ClearTxBITError (int32_t cardIndex, int32_t module, int32_t channel) |
| Clear the Tx BIT Error.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_ClearRxBITError (int32_t cardIndex, int32_t module, int32_t channel) |
| Clear the Rx BIT Error.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetRxTimeStampEn (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables or disables time stamping for the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetRxTimeStampEn (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Reads the time stamp enable status of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_ResetTimeStamp (int32_t cardIndex, int32_t module) |
| Resets the time stamp for the module specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetTimeStampResolution (int32_t cardIndex, int32_t module, naibrd_ar_tstamp_t resolution) |
| Sets the time stamp resolution for the module specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetTimeStampResolution (int32_t cardIndex, int32_t module, naibrd_ar_tstamp_t *p_outresolution) |
| Gets the time stamp resolution for the module specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetModuleTimeStamp (int32_t cardIndex, int32_t module, uint32_t *p_outtimeStamp) |
| Reads the time stamp for the module specified. The time stamp resolution can be retrieved by calling naibrd_AR579_GetTimeStampResolution().
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetChanMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_chan_mapped_status_type_t statusType, bool_t enable) |
| This function is used to enable interrupt generation on a single channel mapped status bit. Only BIT events are supported in this function. Refer to naibrd_AR579_SetEventMappedInterruptEnable() to set the interrupt enable/disable setting of event-mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetChanMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_chan_mapped_status_type_t statusType, bool_t *p_outenable) |
| Get the interrupt enable state for a channel mapped status bit. Only BIT interrupts are supported in this function. Refer to naibrd_AR579_GetEventMappedInterruptEnable() to retrieve the interrupt enable/disable setting of event-mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetChanMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_chan_mapped_status_type_t statusType, naibrd_int_trigger_type_t triggerType) |
| Sets the Interrupt trigger mode (edge or level) for a channel mapped status bit. Only BIT interrupts are supported in this function. Refer to naibrd_AR579_SetEventMappedInterruptTriggerType() to set the interrupt trigger mode of event mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetChanMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_chan_mapped_status_type_t statusType, naibrd_int_trigger_type_t *p_outtriggerType) |
| Gets the Interrupt trigger mode (edge or level) for a channel mapped status bit. Only BIT interrupts are supported in this function. Refer to naibrd_AR579_GetEventMappedInterruptTriggerType() to retrieve the interrupt trigger mode of event mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetChanMappedInterruptVector (int32_t cardIndex, int32_t module, naibrd_ar579_chan_mapped_status_type_t statusType, int32_t vector) |
| Sets the Interrupt Vector for the status type specified. Only the BIT status type is supported by this function. The Interrupt Service callback routine passes in this vector value to identify the status type that generated the interrupt.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetChanMappedInterruptVector (int32_t cardIndex, int32_t module, naibrd_ar579_chan_mapped_status_type_t statusType, int32_t *p_outvector) |
| Returns the Interrupt Vector of the status type specified. Only the BIT status type is supported by this function. The Interrupt Service callback routine passes in this vector value to identify the status type that generated the interrupt.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetChanMappedInterruptSteering (int32_t cardIndex, int32_t module, naibrd_ar579_chan_mapped_status_type_t statusType, naibrd_int_steering_t steering) |
| Sets the Interrupt Steering, which indicates where to direct the interrupt signal, for the specified status type. Only the BIT status type is supported by this function.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetChanMappedInterruptSteering (int32_t cardIndex, int32_t module, naibrd_ar579_chan_mapped_status_type_t statusType, naibrd_int_steering_t *p_outsteering) |
| Retrieves the Interrupt Steering, which indicates where to direct the interrupt signal, for the specified status type. Only the BIT status type is supported by this function.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetEventMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_event_mapped_status_type_t statusType, bool_t enable) |
| This function is used to enable interrupt generation on a single event mapped status bit. Refer to naibrd_AR579_SetChanMappedInterruptEnable() to set the interrupt enable/disable setting of channel-mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetEventMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_event_mapped_status_type_t statusType, bool_t *p_outenable) |
| This function is used to retrieve the interrupt enable state on a single event mapped status bit. Refer to naibrd_AR579_GetChanMappedInterruptEnable() to get the interrupt enable/disable setting of channel-mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetEventMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_event_mapped_status_type_t statusType, naibrd_int_trigger_type_t triggerType) |
| Sets the Interrupt trigger mode (edge or level) for an event mapped status bit. Refer to naibrd_AR579_SetChanMappedInterruptTriggerType() to set the interrupt trigger mode of channel mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetEventMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_event_mapped_status_type_t statusType, naibrd_int_trigger_type_t *p_outtriggerType) |
| Gets the Interrupt trigger mode (edge or level) for an event mapped status bit. Refer to naibrd_AR579_GetChanMappedInterruptTriggerType() to retrieve the interrupt trigger mode of channel mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetEventMappedInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_event_mapped_category_type_t categoryType, uint32_t vector) |
| Sets the Interrupt Vector for the channel and category type specified. Only NAIBRD_AR579_EVENT_MAP_GENERAL category is supported by this function. The Interrupt Service callback routine passes in this vector value to identify the channel that generated the interrupt.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetEventMappedInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_event_mapped_category_type_t categoryType, uint32_t *p_outvector) |
| Retrieves the Interrupt Vector for the channel and category type specified. Only NAIBRD_AR579_EVENT_MAP_GENERAL category is supported by this function. The Interrupt Service callback routine passes in this vector value to identify the channel that generated the interrupt.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_SetEventMappedInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_event_mapped_category_type_t categoryType, naibrd_int_steering_t steering) |
| Sets the Interrupt Steering, which indicates where to direct the interrupt signal, for the channel and category specified. Only the NAIBRD_AR579_EVENT_MAP_GENERAL category is supported by this function.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AR579_GetEventMappedInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ar579_event_mapped_category_type_t categoryType, naibrd_int_steering_t *p_outsteering) |
| Retrieves the Interrupt Steering, which indicates where to direct the interrupt signal, for the channel and category specified. Only the NAIBRD_AR579_EVENT_MAP_GENERAL category is supported by this function.
|
|