Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
naibrd_ser.h File Reference

Go to the source code of this file.

Typedefs

typedef enum naibrd_ser_protocol naibrd_ser_protocol_t
 
typedef enum naibrd_ser_data_bits naibrd_ser_data_bits_t
 
typedef enum naibrd_ser_stop_bits naibrd_ser_stop_bits_t
 
typedef enum naibrd_ser_parity naibrd_ser_parity_t
 
typedef enum naibrd_ser_encoding naibrd_ser_encoding_t
 
typedef enum naibrd_ser_event_mapped_category_type naibrd_ser_event_mapped_category_type_t
 
typedef enum naibrd_ser_event_mapped_status_type naibrd_ser_event_mapped_status_type_t
 
typedef enum naibrd_ser_chan_mapped_status_type naibrd_ser_chan_mapped_status_type_t
 

Enumerations

enum  naibrd_ser_protocol {
  NAIBRD_SER_PROTOCOL_ASYNC = 0x0000u , NAIBRD_SER_PROTOCOL_MONOSYNC = 0x0001u , NAIBRD_SER_PROTOCOL_BISYNC = 0x0002u , NAIBRD_SER_PROTOCOL_HDLC = 0x0003u ,
  NAIBRD_SER_PROTOCOL_ASYNC_GPO = 0x0010u , NAIBRD_SER_PROTOCOL_ASYNC_GPI = 0x0020u
}
 
enum  naibrd_ser_data_bits {
  NAIBRD_SER_DATA_BITS_5 = 0x0005u , NAIBRD_SER_DATA_BITS_6 = 0x0006u , NAIBRD_SER_DATA_BITS_7 = 0x0007u , NAIBRD_SER_DATA_BITS_8 = 0x0008u ,
  NAIBRD_SER_DATA_BITS_9 = 0x0009u
}
 
enum  naibrd_ser_stop_bits { NAIBRD_SER_STOP_BITS_1 = 0x0100u , NAIBRD_SER_STOP_BITS_2 = 0x0200u }
 
enum  naibrd_ser_parity {
  NAIBRD_SER_PARITY_NONE = 0x0000u , NAIBRD_SER_PARITY_SPACE = 0x0010u , NAIBRD_SER_PARITY_ODD = 0x0030u , NAIBRD_SER_PARITY_EVEN = 0x0050u ,
  NAIBRD_SER_PARITY_MARK = 0x0070u
}
 
enum  naibrd_ser_encoding {
  NAIBRD_SER_ENCODING_NONE = 0x0000u , NAIBRD_SER_ENCODING_NRZI = 0x2000u , NAIBRD_SER_ENCODING_FM0 = 0x4000u , NAIBRD_SER_ENCODING_FM1 = 0x5000u ,
  NAIBRD_SER_ENCODING_MANCH = 0x6000u , NAIBRD_SER_ENCODING_MANCH_IEEE = 0x7000u
}
 
enum  naibrd_ser_event_mapped_category_type { NAIBRD_SER_EVENT_MAP_COMM , NAIBRD_SER_EVENT_MAP_FIFO }
 
enum  naibrd_ser_event_mapped_status_type {
  NAIBRD_SER_EVENT_MAP_STATUS_COMM_PARITY_ERROR_LATCHED = 0 , NAIBRD_SER_EVENT_MAP_STATUS_COMM_PARITY_ERROR_REALTIME , NAIBRD_SER_EVENT_MAP_STATUS_COMM_RXBUF_ALMOST_FULL_LATCHED , NAIBRD_SER_EVENT_MAP_STATUS_COMM_RXBUF_ALMOST_FULL_REALTIME ,
  NAIBRD_SER_EVENT_MAP_STATUS_COMM_CRC_ERROR_LATCHED , NAIBRD_SER_EVENT_MAP_STATUS_COMM_CRC_ERROR_REALTIME , NAIBRD_SER_EVENT_MAP_STATUS_COMM_RXCOMPLETE_LATCHED , NAIBRD_SER_EVENT_MAP_STATUS_COMM_RXCOMPLETE_REALTIME ,
  NAIBRD_SER_EVENT_MAP_STATUS_COMM_RXAVAILABLE_LATCHED , NAIBRD_SER_EVENT_MAP_STATUS_COMM_RXAVAILABLE_REALTIME , NAIBRD_SER_EVENT_MAP_STATUS_COMM_RXOVERRUN_LATCHED , NAIBRD_SER_EVENT_MAP_STATUS_COMM_RXOVERRUN_REALTIME ,
  NAIBRD_SER_EVENT_MAP_STATUS_COMM_HIGH_WATERMARK_LATCHED , NAIBRD_SER_EVENT_MAP_STATUS_COMM_HIGH_WATERMARK_REALTIME , NAIBRD_SER_EVENT_MAP_STATUS_COMM_LOW_WATERMARK_LATCHED , NAIBRD_SER_EVENT_MAP_STATUS_COMM_LOW_WATERMARK_REALTIME ,
  NAIBRD_SER_EVENT_MAP_STATUS_COMM_TXBUF_ALMOST_EMPTY_LATCHED , NAIBRD_SER_EVENT_MAP_STATUS_COMM_TXBUF_ALMOST_EMPTY_REALTIME , NAIBRD_SER_EVENT_MAP_STATUS_COMM_TXCOMPLETE_LATCHED , NAIBRD_SER_EVENT_MAP_STATUS_COMM_TXCOMPLETE_REALTIME ,
  NAIBRD_SER_EVENT_MAP_STATUS_COMM_TIMEOUT_LATCHED , NAIBRD_SER_EVENT_MAP_STATUS_COMM_TIMEOUT_REALTIME , NAIBRD_SER_EVENT_MAP_STATUS_COMM_BREAK_ABORT_LATCHED , NAIBRD_SER_EVENT_MAP_STATUS_COMM_BREAK_ABORT_REALTIME ,
  NAIBRD_SER_EVENT_MAP_STATUS_COMM_SYNCDETECT_LATCHED , NAIBRD_SER_EVENT_MAP_STATUS_COMM_SYNCDETECT_REALTIME , NAIBRD_SER_EVENT_MAP_STATUS_COMM_CTS_RISE_LATCHED , NAIBRD_SER_EVENT_MAP_STATUS_COMM_CTS_RISE_REALTIME ,
  NAIBRD_SER_EVENT_MAP_STATUS_COMM_CTS_FALL_LATCHED , NAIBRD_SER_EVENT_MAP_STATUS_COMM_CTS_FALL_REALTIME , NAIBRD_SER_EVENT_MAP_STATUS_COMM_GPI1_LATCHED , NAIBRD_SER_EVENT_MAP_STATUS_COMM_GPI1_REALTIME ,
  NAIBRD_SER_EVENT_MAP_STATUS_COMM_CTS_LATCHED , NAIBRD_SER_EVENT_MAP_STATUS_COMM_CTS_REALTIME , NAIBRD_SER_EVENT_MAP_STATUS_COMM_GPI2_LATCHED , NAIBRD_SER_EVENT_MAP_STATUS_COMM_GPI2_REALTIME ,
  NAIBRD_SER_EVENT_MAP_STATUS_COMM_GAP_TIME_OUT_LATCHED , NAIBRD_SER_EVENT_MAP_STATUS_COMM_GAP_TIME_OUT_REALTIME , NAIBRD_SER_EVENT_MAP_STATUS_COMM_BIT_PASSED_LATCHED , NAIBRD_SER_EVENT_MAP_STATUS_COMM_BIT_PASSED_REALTIME ,
  NAIBRD_SER_EVENT_MAP_STATUS_COMM_CHANNEL_CONFIGURED_LATCHED , NAIBRD_SER_EVENT_MAP_STATUS_COMM_CHANNEL_CONFIGURED_REALTIME , NAIBRD_SER_EVENT_MAP_STATUS_FIFO_RXBUF_ALMOST_FULL_REALTIME , NAIBRD_SER_EVENT_MAP_STATUS_FIFO_TXBUF_ALMOST_EMPTY_REALTIME ,
  NAIBRD_SER_EVENT_MAP_STATUS_FIFO_HIGH_WATERMARK_REALTIME , NAIBRD_SER_EVENT_MAP_STATUS_FIFO_LOW_WATERMARK_REALTIME , NAIBRD_SER_EVENT_MAP_STATUS_FIFO_RX_EMPTY_REALTIME , NAIBRD_SER_EVENT_MAP_STATUS_FIFO_TX_FULL_REALTIME
}
 
enum  naibrd_ser_chan_mapped_status_type { NAIBRD_SER_STATUS_BIT_LATCHED , NAIBRD_SER_STATUS_BIT_REALTIME , NAIBRD_SER_STATUS_SUMMARY_RX_AVAIL_LATCHED , NAIBRD_SER_STATUS_SUMMARY_RX_AVAIL_REALTIME }
 

Typedef Documentation

◆ naibrd_ser_chan_mapped_status_type_t

◆ naibrd_ser_data_bits_t

◆ naibrd_ser_encoding_t

◆ naibrd_ser_event_mapped_category_type_t

◆ naibrd_ser_event_mapped_status_type_t

◆ naibrd_ser_parity_t

◆ naibrd_ser_protocol_t

◆ naibrd_ser_stop_bits_t

Enumeration Type Documentation

◆ naibrd_ser_chan_mapped_status_type

naibrd_ser_chan_mapped_status_type

Enumerator
NAIBRD_SER_STATUS_BIT_LATCHED 
NAIBRD_SER_STATUS_BIT_REALTIME 
NAIBRD_SER_STATUS_SUMMARY_RX_AVAIL_LATCHED 
NAIBRD_SER_STATUS_SUMMARY_RX_AVAIL_REALTIME 

◆ naibrd_ser_data_bits

naibrd_ser_data_bits

Enumerator
NAIBRD_SER_DATA_BITS_5 
NAIBRD_SER_DATA_BITS_6 
NAIBRD_SER_DATA_BITS_7 
NAIBRD_SER_DATA_BITS_8 
NAIBRD_SER_DATA_BITS_9 

◆ naibrd_ser_encoding

naibrd_ser_encoding

Enumerator
NAIBRD_SER_ENCODING_NONE 
NAIBRD_SER_ENCODING_NRZI 
NAIBRD_SER_ENCODING_FM0 
NAIBRD_SER_ENCODING_FM1 
NAIBRD_SER_ENCODING_MANCH 
NAIBRD_SER_ENCODING_MANCH_IEEE 

◆ naibrd_ser_event_mapped_category_type

naibrd_ser_event_mapped_category_type

Enumerator
NAIBRD_SER_EVENT_MAP_COMM 
NAIBRD_SER_EVENT_MAP_FIFO 

◆ naibrd_ser_event_mapped_status_type

naibrd_ser_event_mapped_status_type

Enumerator
NAIBRD_SER_EVENT_MAP_STATUS_COMM_PARITY_ERROR_LATCHED 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_PARITY_ERROR_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_RXBUF_ALMOST_FULL_LATCHED 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_RXBUF_ALMOST_FULL_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_CRC_ERROR_LATCHED 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_CRC_ERROR_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_RXCOMPLETE_LATCHED 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_RXCOMPLETE_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_RXAVAILABLE_LATCHED 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_RXAVAILABLE_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_RXOVERRUN_LATCHED 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_RXOVERRUN_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_HIGH_WATERMARK_LATCHED 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_HIGH_WATERMARK_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_LOW_WATERMARK_LATCHED 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_LOW_WATERMARK_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_TXBUF_ALMOST_EMPTY_LATCHED 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_TXBUF_ALMOST_EMPTY_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_TXCOMPLETE_LATCHED 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_TXCOMPLETE_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_TIMEOUT_LATCHED 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_TIMEOUT_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_BREAK_ABORT_LATCHED 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_BREAK_ABORT_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_SYNCDETECT_LATCHED 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_SYNCDETECT_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_CTS_RISE_LATCHED 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_CTS_RISE_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_CTS_FALL_LATCHED 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_CTS_FALL_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_GPI1_LATCHED 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_GPI1_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_CTS_LATCHED 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_CTS_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_GPI2_LATCHED 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_GPI2_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_GAP_TIME_OUT_LATCHED 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_GAP_TIME_OUT_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_BIT_PASSED_LATCHED 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_BIT_PASSED_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_CHANNEL_CONFIGURED_LATCHED 
NAIBRD_SER_EVENT_MAP_STATUS_COMM_CHANNEL_CONFIGURED_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_FIFO_RXBUF_ALMOST_FULL_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_FIFO_TXBUF_ALMOST_EMPTY_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_FIFO_HIGH_WATERMARK_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_FIFO_LOW_WATERMARK_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_FIFO_RX_EMPTY_REALTIME 
NAIBRD_SER_EVENT_MAP_STATUS_FIFO_TX_FULL_REALTIME 

◆ naibrd_ser_parity

naibrd_ser_parity

Enumerator
NAIBRD_SER_PARITY_NONE 
NAIBRD_SER_PARITY_SPACE 
NAIBRD_SER_PARITY_ODD 
NAIBRD_SER_PARITY_EVEN 
NAIBRD_SER_PARITY_MARK 

◆ naibrd_ser_protocol

naibrd_ser_protocol

Enumerator
NAIBRD_SER_PROTOCOL_ASYNC 
NAIBRD_SER_PROTOCOL_MONOSYNC 
NAIBRD_SER_PROTOCOL_BISYNC 
NAIBRD_SER_PROTOCOL_HDLC 
NAIBRD_SER_PROTOCOL_ASYNC_GPO 
NAIBRD_SER_PROTOCOL_ASYNC_GPI 

◆ naibrd_ser_stop_bits

naibrd_ser_stop_bits

Enumerator
NAIBRD_SER_STOP_BITS_1 
NAIBRD_SER_STOP_BITS_2