|
static int32_t | GetChannelCount (uint32_t modId) |
|
static nai_status_t | verify_channel (uint32_t modId, int32_t channel) |
|
static nai_status_t | naibrd_SER_AckWriteRegMask32 (int32_t cardIndex, int32_t module, int32_t channel, uint32_t modId, uint32_t offset, uint32_t mask, uint32_t value) |
|
static nai_status_t | naibrd_SER_ExtractInfoFromEventMappedStatus (naibrd_ser_event_mapped_status_type_t statusType, int32_t *p_outshiftCount, nai_status_access_type_t *p_outaccessType, naibrd_ser_event_mapped_category_type_t *p_outcategoryType) |
|
NAIBRDFUNC int32_t NAIAPI | naibrd_SER_GetChannelCount (uint32_t modId) |
| Returns the number of channels for the specified Serial Module ID.
|
|
NAIBRDFUNC uint32_t NAIAPI | naibrd_SER_GetFifoSize (uint32_t modId) |
| Returns the size of the FIFO buffer for the specified Serial Module ID.
|
|
NAIBRDFUNC uint32_t NAIAPI | naibrd_SER_GetMaxBaudRate (uint32_t modId, bool_t sync) |
| Returns the maximum baud rate for the Serial channels for the specified Serial Module ID and sync mode.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_LoadBufferWithTimeOut32 (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_buffer, int32_t txCount, int32_t bufferLength, int32_t timeout_msec, int32_t *p_outwritten) |
| Writes multiple bytes of data to the transmit FIFO for the specified Serial channel. The actual number of bytes placed in the buffer may be less than the length desired if the FIFO becomes full.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_ReceiveBufferWithTimeOut32 (int32_t cardIndex, int32_t module, int32_t channel, uint32_t outbuffer[], int32_t bufferLength, int32_t expectedCount, int32_t timeout_msec, int32_t *p_outreceived) |
| Retrieves multiple bytes of data from the receive FIFO for the specified Serial channel. The number of data elements read may be less than the amount requested if the FIFO goes empty during the read.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_ReceiveHDLCPacket (int32_t cardIndex, int32_t module, int32_t channel, uint32_t outbuffer[], int32_t expectedCount, int32_t *p_outreceived, int32_t timeout_msec) |
| Retrieves the buffer data for the specified serial channel associated with one(1) HDLC packet. When an HDLC packet is received OR the maximum count is read, the function returns. Otherwise, it blocks, waiting for data to be read or for the timeout to be reached. NOTE: This function extracts data from the fifo one element at a time, as opposed to naibrd_SER_ReceiveBufferWithTimeOut32() which extracts all of the data at once. For this reason, this API does not perform as efficiently as naibrd_SER_ReceiveBufferWithTimeOut32().
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetTxBufferCnt (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outcount) |
| Retrieves the number of bytes in the Transmit FIFO for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetRxBufferCnt (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outcount) |
| Retrieves the number of bytes in the Receive FIFO for specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetEventMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_event_mapped_status_type_t statusType, nai_status_bit_t *p_outstatusBit) |
| Retrieves the value (status set or status not set) for a specific event mapped status. Use this function if you want to get only one status at a time. Use to naibrd_SER_GetEventMappedStatusRaw if you want to get more than one status at a time.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_ClearEventMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_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 and latched status registers. This function is used to clear a user-specified bit in the latched status register.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetEventMappedStatusRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_status_access_type_t accessType, naibrd_ser_event_mapped_category_type_t categoryType, uint32_t *p_outstatusRaw) |
| Retrieves the raw event mapped status for the specified channel. Use this function if you want to get more than one status at a time.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_ClearEventMappedStatusRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_event_mapped_category_type_t categoryType, uint32_t statusRaw) |
| Clears the latched status for the specified channel. Use this function if you want to clear more than one status at a time.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_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_ser_chan_mapped_status_type_t enumeration. Only BIT and Summary (Rx Data Available) statuses are able to be read using this function. Refer to naibrd_SER_GetEventMappedStatus() for reading event mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_ser_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_ser_chan_mapped_status_type_t enumeration. Only BIT and Summary (Rx Data Available) statuses are able to be read using this function. Refer to naibrd_SER_GetEventMappedStatusRaw() for reading event mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_ClearChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_chan_mapped_status_type_t statusType) |
| Clears the user specified latched status bit on the user specified channel. Only BIT and Summary (Rx Data Available) statuses are able to be cleared using this function. Refer to naibrd_SER_ClearEventMappedStatus() for clearing event mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_ClearChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_ser_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 and Summary (Rx Data Available) statuses are able to be cleared using this function. Refer to naibrd_SER_ClearEventMappedStatusRaw() for clearing event mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetChannelEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables or Disables the specified Serial channel. Channels must be disabled before any configuration change is made, or before InitiateBIT. Channels must be enabled for the configuration changes to take effect, or after InitiateBIT is complete.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetChannelEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Retrieves the state of the specified Serial channel. Channels must be disabled before any configuration change is made, or before InitiateBIT. Channels must be enabled for the configuration changes to take effect, or after InitiateBIT is complete.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetReceiverEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Sets the Receiver state for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetReceiverEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Retrieves the Receiver state for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_TransmitInitiate (int32_t cardIndex, int32_t module, int32_t channel) |
| Initiates the serial transmission for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_TransmitStop (int32_t cardIndex, int32_t module, int32_t channel) |
| Stops the serial transmission for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_AsyncTransmitControl (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Sets the asynchronous data transmit mode for the specified Serial channel. When this mode is enabled, data written to the transmit FIFO buffer is transmitted. Tx initiate is not necessary. For Async mode only.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetRTS (int32_t cardIndex, int32_t module, int32_t channel, bool_t active) |
| Sets RTS pin state for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetRTS (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outactive) |
| Retrieves RTS pin state for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetCTS (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outactive) |
| Retrieves the CTS pin state for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetCommProtocol (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_protocol_t protocol) |
| Sets the protocol for the specified Serial channel specified as follows:
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetCommProtocol (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_protocol_t *p_outprotocol) |
| Retrieves the protocol for the specified Serial channel specified as follows:
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetInterface (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_interface_t level) |
| Sets interfaceLevel level for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetInterface (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_interface_t *p_outlevel) |
| Retrieves interface level for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetBaudrate (int32_t cardIndex, int32_t module, int32_t channel, uint32_t baudRate) |
| Sets the baud rate for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetBaudrate (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outbaudRate) |
| Retrieves the baud rate for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetNumDataBits (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_data_bits_t dataBits) |
| Sets the Number of Data Bits in the Data Configuration for the specified Serial channel. In sync modes, number of data bits is set to 8 and cannot be changed.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetNumDataBits (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_data_bits_t *p_outdataBits) |
| Retrieves the Number of Data Bits in the Data Configuration for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetNumStopBits (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_stop_bits_t stopBits) |
| Sets the Number of Stop Bits in the Data Configuration for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetNumStopBits (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_stop_bits_t *p_outstopBits) |
| Retrieves the Number of Stop Bits in the Data Configuration for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetSyncClockMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_clock_mode_t clockMode) |
| Sets the clock mode (Sync/HDLC only) for the specified Serial channel. Clock mode can be either Internal (module drives clock) or External (module is receiving a clock).
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetSyncClockMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_clock_mode_t *p_outclockMode) |
| Retrieves the clock mode (Sync/HDLC only) for the specified Serial channel. Clock mode can be either Internal (module drives clock) or External (module is receiving a clock).
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetParityType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_parity_t parity) |
| Sets the Parity in the Data Configuration register for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetParityType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_parity_t *p_outparity) |
| Retrieves the Parity in the Data Configuration register for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetEncoding (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_encoding_t encoding) |
| Sets the Encoding in the Data Configuration for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetEncoding (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_encoding_t *p_outencoding) |
| Retrieves the Encoding in the Data Configuration for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetPreamble (int32_t cardIndex, int32_t module, int32_t channel, uint32_t preamble) |
| Sets the Preamble for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetPreamble (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outpreamble) |
| Retrieves the Preamble for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetTxBufferAlmostEmpty (int32_t cardIndex, int32_t module, int32_t channel, uint32_t count) |
| Sets the watermark for the Transmit Buffer Almost Full for the specified Serial channel. The watermark specifies the minimum size, in bytes, for the transmit buffer before the Tx FIFO Almost Empty Status bit D1 in the FIFO status register is flagged. If the Tx Buffer Almost Empty interrupt is enabled, an interrupt will be generated when the status is set.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetTxBufferAlmostEmpty (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outcount) |
| Retrieves the watermark for the Transmit Buffer Almost Full for the specified Serial channel. The watermark specifies the minimum size, in bytes, for the transmit buffer before the Tx FIFO Almost Empty Status bit D1 in the FIFO status register is flagged. If the Tx Buffer Almost Empty interrupt is enabled, an interrupt will be generated when the status is set.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetRxBufferAlmostFull (int32_t cardIndex, int32_t module, int32_t channel, uint32_t count) |
| Sets the watermark associated with the Rx Buffer Almost Full value for the specified Serial channel. This watermark specifies the maximum size, in bytes, of the receive buffer before the RxFIFO Almost-Full Status bit D0 in the FIFO status register is flagged. If the Rx Buffer Almost Full interrupt is enabled, an interrupt will be generated when the status is set.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetRxBufferAlmostFull (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outcount) |
| Retrieves the watermark associated with the Rx Buffer Almost Full value for the specified Serial channel. This watermark specifies the maximum size, in bytes, of the receive buffer before the RxFIFO Almost-Full Status bit D0 in the FIFO status register is flagged. If the Rx Buffer Almost Full interrupt is enabled, an interrupt will be generated when the status is set.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetRxBufferHiWatermark (int32_t cardIndex, int32_t module, int32_t channel, uint32_t count) |
| Sets the Receive Buffer High Watermark value for the specified Serial channel. When Rx Buffer size equals the High Watermark value, the High Watermark Reached Status bit D2 in the FIFO status register is flagged and:
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetRxBufferHiWatermark (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outcount) |
| Retrieves the Receive Buffer High Watermark value for the specified Serial channel. When Rx Buffer size equals the High Watermark value, the High Watermark Reached Status bit D2 in the FIFO status register is flagged and:
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetRxBufferLoWatermark (int32_t cardIndex, int32_t module, int32_t channel, uint32_t count) |
| Sets the Receive Buffer Low Watermark value for the specified Serial channel. When the Rx Buffer size is less than the Low Watermark value, FIFO Status bit D3 is flagged and;.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetRxBufferLoWatermark (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outcount) |
| Retrieves the Receive Buffer Low Watermark value for the specified Serial channel. When the Rx Buffer size is less than the Low Watermark value, FIFO Status bit D3 is flagged and;.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetTerminationChar (int32_t cardIndex, int32_t module, int32_t channel, uint8_t termChar) |
| Sets Termination Character for the specified Serial channel. The termination character used for termination detection. When using the Asynchronous or Bi-Synchronous modes, the receive data stream is monitored for the occurrence of the termination character. If the interrupt mask for SYNC CHAR DETECTED bit is enabled, when this character is detected, an interrupt is generated.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetTerminationChar (int32_t cardIndex, int32_t module, int32_t channel, uint8_t *p_outtermChar) |
| Retrieves Termination Character for the specified Serial channel. The termination character used for termination detection. When using the Asynchronous or Bi-Synchronous modes, the receive data stream is monitored for the occurrence of the termination character. If the interrupt mask for SYNC CHAR DETECTED bit is enabled, when this character is detected, an interrupt is generated.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetXonChar (int32_t cardIndex, int32_t module, int32_t channel, uint8_t xonChar) |
| Sets the XON Character for in-band flow control when in Async mode for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetXonChar (int32_t cardIndex, int32_t module, int32_t channel, uint8_t *p_outxonChar) |
| Retrieves the XON Character for in-band flow control when in Async mode for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetXoffChar (int32_t cardIndex, int32_t module, int32_t channel, uint8_t xoffChar) |
| Sets the XOFF Character for in-band flow control when in Async mode for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetXoffChar (int32_t cardIndex, int32_t module, int32_t channel, uint8_t *p_outxoffChar) |
| Retrieves the XOFF Character for in-band flow control when in Async mode for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetRxHdlcAddrsSyncChar (int32_t cardIndex, int32_t module, int32_t channel, uint32_t syncChar) |
| Sets the Receive HDLC Address/Sync Character for the specified Serial channel. The handling of this value is mode dependent. If using HDLC mode, this value is compared to the address in received message and if it's equal, the message is stored in the receive buffer. If using Mono/Bi-Synchronous mode, this value is considered the 'Sync Character' and is used for communication synchronization. The receiver searches incoming data for the Sync Character, once found, communication is synchronized and additional data is valid.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetRxHdlcAddrsSyncChar (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outsyncChar) |
| Retrieves the Receive HDLC Address/Sync Character for the specified Serial channel. The handling of this value is mode dependent. If using HDLC mode, this value is compared to the address in received message and if it's equal, the message is stored in the receive buffer. If using Mono/Bi-Synchronous mode, this value is considered the 'Sync Character' and is used for communication synchronization. The receiver searches incoming data for the Sync Character, once found, communication is synchronized and additional data is valid.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetTxHdlcAddrsSyncChar (int32_t cardIndex, int32_t module, int32_t channel, uint32_t syncChar) |
| Sets the Transmit HDLC Address/Sync Character for the specified Serial channel. The handling of this value is mode dependent. If using HDLC mode, this value is prepended to the transmit buffer.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetTxHdlcAddrsSyncChar (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outsyncChar) |
| Retrieves the Transmit HDLC Address/Sync Character for the specified Serial channel. The handling of this value is mode dependent. If using HDLC mode, this value is prepended to the transmit buffer.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetTimeout (int32_t cardIndex, int32_t module, int32_t channel, uint32_t timeout) |
| Sets the Time Out Value for the specified Async Serial channel. When there is no receive line activity for the configured period of time, bit D10 in the Interrupt Status register will be set. If the Time Out Occurred interrupt is enabled, an interrupt will be generated when the status is set. The timeout is initialized to 40,000 (1 second).
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetTimeout (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outtimeout) |
| Retrieves the Time Out Value for the specified Serial channel. When there is no receive line activity for the configured period of time, bit D10 in the Interrupt Status register will be set. If the Time Out Occurred interrupt is enabled, an interrupt will be generated when the status is set. The timeout is initialized to 40,000 (1 second).
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetRxBufferSize (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outrxSize) |
| Retrieves the size (in bytes) of the Receive FIFO for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetTxBufferSize (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outtxSize) |
| Retrieves the size (in bytes) of the Transmit FIFO for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_ChannelReset (int32_t cardIndex, int32_t module, int32_t channel) |
| Resets both the transmit and receive FIFO buffers and UART for the specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_ClearRxFifo (int32_t cardIndex, int32_t module, int32_t channel) |
| Resets the receive FIFO buffer for the specified channel. This will flush the data from the FIFO.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_ClearTxFifo (int32_t cardIndex, int32_t module, int32_t channel) |
| Resets the transmit FIFO buffer for the specified channel. This will flush the data from the FIFO.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetChannelConfigRaw (int32_t cardIndex, int32_t module, int32_t channel, uint32_t configRaw) |
| Sets the raw channel configuration for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetChannelConfigRaw (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outconfigRaw) |
| Retrieves the raw channel configuration for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetChannelControlRaw (int32_t cardIndex, int32_t module, int32_t channel, uint32_t chanCtrlRaw) |
| Sets the raw channel control configuration for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetChannelControlRaw (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outchanCtrlRaw) |
| Retrieves the raw channel control configuration for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetDataConfigRaw (int32_t cardIndex, int32_t module, int32_t channel, uint32_t dataConfigRaw) |
| Sets the raw data configuration for the specified Serial channel. This overwrites all previously set bits in the data configuration register.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetDataConfigRaw (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outdataConfigRaw) |
| Retrieves the raw data configuration for the specified Serial channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_InitiateBIT (int32_t cardIndex, int32_t module, int32_t channel, bool_t waitForResult) |
| Executes the serial Built-in Test and returns the result. The BIT requires the user to disable the channel prior to executing this test. 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_SER_CheckBITComplete() and naibrd_SER_GetChanMappedStatus() at a later time to verify the test has completed and fetch the BIT status.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_CheckBITComplete (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outbitComplete) |
| Retrieves the initiate BIT status (complete or incomplete) of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_CheckPowerOnBITComplete (int32_t cardIndex, int32_t module, bool_t *p_outpbitComplete) |
| Retrieves the Power-On BIT (PBIT) status (complete or incomplete) for all channels. The PBIT result will be in the BIT status register.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_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_SER_InitiateBIT().
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_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_SER_SetModuleBITEnable() use this function to check if the test has completed by verifying the bits set have cleared.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_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_SER_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_SER_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_SER_SetEventMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_event_mapped_status_type_t statusType, bool_t enable) |
| Sets the Interrupt Enable for the specified Serial channel and interrupt status type. The interrupt statusType must be a latched status and be of the category NAIBRD_SER_EVENT_MAP_COMM.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetEventMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_event_mapped_status_type_t statusType, bool_t *p_outenable) |
| Retrieves the Interrupt Enable for the specified Serial channel and interrupt status type. The interrupt statusType must be a latched status and be of the category NAIBRD_SER_EVENT_MAP_COMM.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetEventMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_event_mapped_status_type_t statusType, naibrd_int_trigger_type_t triggerType) |
| Sets the Interrupt Edge/Level property for the specified Serial channel and interrupt status type. The interrupt statusType must be a latched status and be of the category NAIBRD_SER_EVENT_MAP_COMM.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetEventMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_event_mapped_status_type_t statusType, naibrd_int_trigger_type_t *p_outtriggerType) |
| Gets the Interrupt Edge/Level property for the specified Serial channel and interrupt status type. The interrupt statusType must be a latched status and be of the category NAIBRD_SER_EVENT_MAP_COMM.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetEventMappedInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_event_mapped_category_type_t categoryType, uint32_t vector) |
| Sets the Interrupt Vector for the channel number specified. The Interrupt Service callback routine passes in this vector value to identify the channel that generated the interrupt.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetEventMappedInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_event_mapped_category_type_t categoryType, uint32_t *p_outvector) |
| Retrieves the Interrupt Vector for the channel number specified. The Interrupt Service callback routine passes in this vector value to identify the channel that generated the interrupt.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetEventMappedInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_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 specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetEventMappedInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_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 specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetChanMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_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 or Summary (Rx Data Available) events are supported in this function. Refer to naibrd_SER_SetEventMappedInterruptEnable() to set the interrupt enable/disable setting of event-mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetChanMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_chan_mapped_status_type_t statusType, bool_t *p_outenable) |
| Get the interrupt enable state for a channel mapped status bit. Only BIT and Summary (Rx Data Available) interrupts are supported in this function. Refer to naibrd_SER_GetEventMappedInterruptEnable() to retrieve the interrupt enable/disable setting of event-mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetChanMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_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 and Summary (Rx Data Available) interrupts are supported in this function. Refer to naibrd_SER_SetEventMappedInterruptTriggerType() to set the interrupt trigger mode of event mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetChanMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ser_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 and Summary (Rx Data Available) interrupts are supported in this function. Refer to naibrd_SER_GetEventMappedInterruptTriggerType() to retrieve the interrupt trigger mode of event mapped statuses.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetChanMappedInterruptVector (int32_t cardIndex, int32_t module, naibrd_ser_chan_mapped_status_type_t statusType, uint32_t vector) |
| Sets the Interrupt Vector of the status type specified. The Interrupt Service callback routine passes in this vector value to identify the status that generated the interrupt. This function is only for BIT and Summary (Rx Data Available) interrupts.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetChanMappedInterruptVector (int32_t cardIndex, int32_t module, naibrd_ser_chan_mapped_status_type_t statusType, uint32_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 that generated the interrupt. This function is only for BIT and Summary (Rx Data Available) interrupts.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetChanMappedInterruptSteering (int32_t cardIndex, int32_t module, naibrd_ser_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 BIT or Summary (Rx Data Available) status type.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetChanMappedInterruptSteering (int32_t cardIndex, int32_t module, naibrd_ser_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 BIT or Summary (Rx Data Available) status.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetDataBits (int32_t cardIndex, int32_t module, int32_t channel, uint8_t dataBits) |
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetDataBits (int32_t cardIndex, int32_t module, int32_t channel, uint8_t *p_outdataBits) |
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetStopBits (int32_t cardIndex, int32_t module, int32_t channel, uint8_t stopBits) |
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetStopBits (int32_t cardIndex, int32_t module, int32_t channel, uint8_t *p_outstopBits) |
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_SetClockMode (int32_t cardIndex, int32_t module, int32_t channel, uint32_t clockMode) |
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_SER_GetClockMode (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outclockMode) |
|