avr-classes
Public Member Functions | List of all members
Usart0 Class Reference

#include <usart0.h>

Inheritance diagram for Usart0:
Usart

Public Member Functions

virtual void enable (bool state) override
 
virtual void configure (const Config &config) override
 
virtual void setData (uint8_t data) override
 
virtual uint8_t getData (void) override
 
virtual bool isReadable (void) override
 
virtual bool isWritable (void) override
 
virtual void setInterruptHandler (InterruptHandler *handler) override
 
virtual void enableDataRegisterEmptyInterrupt (bool state) override
 
virtual void enableRxCompleteInterrupt (bool state) override
 

Additional Inherited Members

- Static Public Member Functions inherited from Usart
template<uint32_t CPUFREQUENCY>
static bool autoFill (Config &config, uint32_t desiredBaudRate, const char *mode, uint32_t *actualBaudRate=nullptr)
 

Detailed Description

Implements the Usart interface using the Usart0 hardware unit.

Member Function Documentation

◆ configure()

void Usart0::configure ( const Config config)
overridevirtual

Configures the USART device.

Parameters
configConfiguration for USART device.

Implements Usart.

◆ enable()

void Usart0::enable ( bool  state)
overridevirtual

Enables or disables the USART on hardware level.

Parameters
stateDesired state of USART, true means enabled, false means disabled.

Implements Usart.

◆ enableDataRegisterEmptyInterrupt()

void Usart0::enableDataRegisterEmptyInterrupt ( bool  state)
overridevirtual

Enables or disabled the Data Register Empty interrupt.

Parameters
stateTrue to enable interrupt, false to disable.

Implements Usart.

◆ enableRxCompleteInterrupt()

void Usart0::enableRxCompleteInterrupt ( bool  state)
overridevirtual

Enables or disabled the RX Complete interrupt.

Parameters
stateTrue to enable interrupt, false to disable.

Implements Usart.

◆ getData()

uint8_t Usart0::getData ( void  )
overridevirtual

Gets the content of the data register.

Note
This might be old or undefined data! Check with isReadable() first.
Returns
Content of data register.

Implements Usart.

◆ isReadable()

bool Usart0::isReadable ( void  )
overridevirtual

Checks if data is available for reading.

Returns
True if data can be read, false otherwise.

Implements Usart.

◆ isWritable()

bool Usart0::isWritable ( void  )
overridevirtual

Checks if data register is ready for writing the next data byte.

Returns
True if data can be written, false otherwise.

Implements Usart.

◆ setData()

void Usart0::setData ( uint8_t  data)
overridevirtual

Writes a data byte into the data register.

Parameters
dataData byte to write.

Implements Usart.

◆ setInterruptHandler()

void Usart0::setInterruptHandler ( InterruptHandler handler)
overridevirtual

Sets callback for interrupts.

Parameters
handlerPointer to class implementing the interrupt handler interface.

Implements Usart.