os::driver::serial::Status Class Reference

Serial port status More...

#include <serial.h>

Public Member Functions
bool	is_rx_break (void)
bool	is_rx_busy (void)
bool	is_rx_framing_error (void)
bool	is_rx_overflow (void)
bool	is_rx_parity_error (void)
bool	is_tx_busy (void)
bool	is_tx_underflow (void)

Public Attributes
bool	rx_break:1
	Framing error detected on receive (cleared on start of next receive operation) More...
bool	rx_busy:1
	Transmit data underflow detected (cleared on start of next send operation) More...
bool	rx_framing_error:1
	Parity error detected on receive (cleared on start of next receive operation) More...
bool	rx_overflow:1
	Break detected on receive (cleared on start of next receive operation) More...
bool	rx_parity_error:1
bool	tx_busy:1
	< Transmitter busy flag More...
bool	tx_underflow:1
	Receive data overflow detected (cleared on start of next receive operation) More...

Detailed Description

Serial port status

Definition at line 256 of file serial.h.

Member Function Documentation

is_rx_break()

bool os::driver::serial::Status::is_rx_break ( void  )

inline

Definition at line 746 of file serial.h.

is_rx_busy()

bool os::driver::serial::Status::is_rx_busy ( void  )

inline

Definition at line 728 of file serial.h.

is_rx_framing_error()

bool os::driver::serial::Status::is_rx_framing_error ( void  )

inline

Definition at line 752 of file serial.h.

is_rx_overflow()

bool os::driver::serial::Status::is_rx_overflow ( void  )

inline

Definition at line 740 of file serial.h.

is_rx_parity_error()

bool os::driver::serial::Status::is_rx_parity_error ( void  )

inline

Definition at line 758 of file serial.h.

is_tx_busy()

bool os::driver::serial::Status::is_tx_busy ( void  )

inline

Definition at line 722 of file serial.h.

is_tx_underflow()

bool os::driver::serial::Status::is_tx_underflow ( void  )

inline

Definition at line 734 of file serial.h.

Member Data Documentation

rx_break

bool os::driver::serial::Status::rx_break

Framing error detected on receive (cleared on start of next receive operation)

Definition at line 301 of file serial.h.

rx_busy

bool os::driver::serial::Status::rx_busy

Transmit data underflow detected (cleared on start of next send operation)

Definition at line 292 of file serial.h.

rx_framing_error

bool os::driver::serial::Status::rx_framing_error

Parity error detected on receive (cleared on start of next receive operation)

Definition at line 304 of file serial.h.

rx_overflow

bool os::driver::serial::Status::rx_overflow

Break detected on receive (cleared on start of next receive operation)

Definition at line 298 of file serial.h.

rx_parity_error

bool os::driver::serial::Status::rx_parity_error

Definition at line 307 of file serial.h.

tx_busy

bool os::driver::serial::Status::tx_busy

< Transmitter busy flag

Receiver busy flag

Definition at line 289 of file serial.h.

tx_underflow

bool os::driver::serial::Status::tx_underflow

Receive data overflow detected (cleared on start of next receive operation)

Definition at line 295 of file serial.h.

---

The documentation for this class was generated from the following file:

• include/cmsis-plus/driver/serial.h