UART Namespace Reference

Common enums and signal definitions for UART classes. More...

Classes
class	USART
	Generic model defining an universal synchronous/asynchronous serial interface a.k.a. USART. More...

Enumerations
enum	SignalId {   Signal_TX_Start , Signal_TX_Complete , Signal_RX_Start , Signal_RX_Complete ,   Signal_TX_Frame , Signal_TX_Data , Signal_RX_Overflow , Signal_TX_Collision }
enum	ClockMode { Clock_Async , Clock_Emitter , Clock_Receiver }
enum	Line { Line_TXD , Line_RXD , Line_XCK , Line_DIR }
enum	Parity { Parity_No , Parity_Odd , Parity_Even }

Detailed Description

Common enums and signal definitions for UART classes.

Enumeration Type Documentation

ClockMode

enum UART::ClockMode

Enumerator
Clock_Async	Asynchronous mode, the clock line is not used.
Clock_Emitter	Synchronous mode where the interface is the clock master.
Clock_Receiver	Synchronous mode where the interface is not the clock master.

Line

enum UART::Line

Index definition for the lines used in a UART bus

Enumerator
Line_TXD
Line_RXD
Line_XCK
Line_DIR

Parity

enum UART::Parity

Parity mode definitions

Enumerator
Parity_No
Parity_Odd
Parity_Even

SignalId

enum UART::SignalId

Enumerator
Signal_TX_Start	Raised at the start of a frame transmission, with sigdata containing the frame.
Signal_TX_Complete	Raised at the end of a frame transmission. sigdata contains 1 if the transmission completed successfully or 0 if it was interrupted.
Signal_RX_Start	Raised at the start of a frame reception.
Signal_RX_Complete	Raised at the end of a frame reception. sigdata contains 1 if the frame is received successfully or 0 if it was discarded.
Signal_TX_Frame	Raised on transmission of a frame. sigdata contains the raw frame transmitted.
Signal_TX_Data	Raised on transmission of a frame. sigdata contains the data transmitted.
Signal_RX_Overflow	Raised when the RX buffer overruns.
Signal_TX_Collision	Raised when the TX buffer overruns.