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
	Break detected on receive (cleared on start of next receive operation).
bool	rx_busy: 1
	Receiver busy flag.
bool	rx_framing_error: 1
	Framing error detected on receive (cleared on start of next receive operation).
bool	rx_overflow: 1
	Receive data overflow detected (cleared on start of next receive operation).
bool	rx_parity_error: 1
	Parity error detected on receive (cleared on start of next receive operation).
bool	tx_busy: 1
	Transmitter busy flag.
bool	tx_underflow: 1
	Transmit data underflow detected (cleared on start of next send operation).

Detailed Description

Definition at line 258 of file serial.h.

Member Function Documentation

is_rx_break()

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

inline

Definition at line 772 of file serial.h.

      {
        return rx_break;
      }

References os::driver::serial::rx_break.

is_rx_busy()

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

inline

Definition at line 754 of file serial.h.

      {
        return rx_busy;
      }

is_rx_framing_error()

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

inline

Definition at line 778 of file serial.h.

      {
        return rx_framing_error;
      }

References os::driver::serial::rx_framing_error.

is_rx_overflow()

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

inline

Definition at line 766 of file serial.h.

      {
        return rx_overflow;
      }

References os::driver::serial::rx_overflow.

is_rx_parity_error()

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

inline

Definition at line 784 of file serial.h.

      {
        return rx_parity_error;
      }

References os::driver::serial::rx_parity_error.

is_tx_busy()

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

inline

Definition at line 748 of file serial.h.

      {
        return tx_busy;
      }

Referenced by os::posix::device_serial_buffered< CS >::do_write().

is_tx_underflow()

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

inline

Definition at line 760 of file serial.h.

      {
        return tx_underflow;
      }

References os::driver::serial::tx_underflow.

Member Data Documentation

rx_break

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

Definition at line 304 of file serial.h.

rx_busy

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

Definition at line 292 of file serial.h.

rx_framing_error

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

Definition at line 308 of file serial.h.

rx_overflow

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

Definition at line 300 of file serial.h.

rx_parity_error

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

Definition at line 312 of file serial.h.

tx_busy

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

Definition at line 289 of file serial.h.

Referenced by os::posix::device_serial_buffered< CS >::do_write().

tx_underflow

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

Definition at line 296 of file serial.h.

---

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

• serial.h