ClearCore Library
Loading...
Searching...
No Matches
List of all members | Public Member Functions | Public Attributes
ClearCore::SerialBase::SerialErrorStatusRegister Union Reference

Detailed Description

A register to report errors detected on the serial port.

#include <SerialBase.h>

Public Member Functions

 SerialErrorStatusRegister ()
 
 SerialErrorStatusRegister (uint32_t val)
 
 operator bool () const
 

Public Attributes

uint32_t reg
 
struct { 
 
   uint32_t   SerialFrameError: 1 
 
   uint32_t   SerialParityError: 1 
 
   uint32_t   SerialOverflowError: 1 
 
bit 
 

Constructor & Destructor Documentation

◆ SerialErrorStatusRegister() [1/2]

ClearCore::SerialBase::SerialErrorStatusRegister::SerialErrorStatusRegister ( )
inline

Serial error register default constructor

◆ SerialErrorStatusRegister() [2/2]

ClearCore::SerialBase::SerialErrorStatusRegister::SerialErrorStatusRegister ( uint32_t  val)
inline

Serial error register constructor with initial value

Member Function Documentation

◆ operator bool()

ClearCore::SerialBase::SerialErrorStatusRegister::operator bool ( ) const
inline

Interpret the serial error register as a boolean by reporting whether any bits are set.

Member Data Documentation

◆ [struct]

struct { ... } ClearCore::SerialBase::SerialErrorStatusRegister::bit

Field access to the register

◆ reg

uint32_t ClearCore::SerialBase::SerialErrorStatusRegister::reg

Broad access to the whole register

◆ SerialFrameError

uint32_t ClearCore::SerialBase::SerialErrorStatusRegister::SerialFrameError

A frame error has been detected on the serial port.

◆ SerialOverflowError

uint32_t ClearCore::SerialBase::SerialErrorStatusRegister::SerialOverflowError

An overflow error has been detected on the serial port.

◆ SerialParityError

uint32_t ClearCore::SerialBase::SerialErrorStatusRegister::SerialParityError

A parity error has been detected on the serial port.


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