ArchAVR_USI Class Reference

yasimavr: ArchAVR_USI Class Reference
yasimavr
Loading...
Searching...
No Matches
Classes | Public Member Functions | Friends | List of all members
ArchAVR_USI Class Reference

Implementation of a Universal Serial Interface for AVR series. More...

#include <arch_avr_usi.h>

Inheritance diagram for ArchAVR_USI:
Peripheral IORegHandler

Classes

class  _PinDriver
 

Public Member Functions

 ArchAVR_USI (const ArchAVR_USIConfig &config)
 
virtual ~ArchAVR_USI ()
 
virtual bool init (Device &device) override
 
virtual void reset (int flags) override
 
virtual void ioreg_write_handler (reg_addr_t addr, const ioreg_write_t &data) override
 
- Public Member Functions inherited from Peripheral
 Peripheral (ctl_id_t id)
 
virtual ~Peripheral ()
 
ctl_id_t id () const
 Unique identifier of the peripheral.
 
std::string name () const
 The name of the peripheral.
 
virtual bool ctlreq (ctlreq_id_t req, ctlreq_data_t *data)
 
virtual uint8_t ioreg_read_handler (reg_addr_t addr, uint8_t value) override
 
virtual uint8_t ioreg_peek_handler (reg_addr_t addr, uint8_t value) override
 
virtual void sleep (bool on, SleepMode mode)
 
 Peripheral (const Peripheral &)=delete
 
Peripheral & operator= (const Peripheral &)=delete
 
- Public Member Functions inherited from IORegHandler
virtual ~IORegHandler ()=default
 

Friends

class _PinDriver
 

Additional Inherited Members

- Protected Member Functions inherited from Peripheral
Device * device () const
 Access to the device. It is null before init() is called.
 
Logger & logger ()
 Logging object associated with this peripheral.
 
bool register_interrupt (int_vect_t vector, InterruptHandler &handler) const
 
Signal * get_signal (ctl_id_t ctl_id) const
 
void add_ioreg (const regmask_t &rm, IORegister::BitMode bitmode=IORegister::RW)
 
void add_ioreg (const regbit_compound_t &rbc, IORegister::BitMode bitmode=IORegister::RW)
 
void add_ioreg (reg_addr_t addr, IORegister::BitMode bitmode=IORegister::RW)
 
void add_ioreg (reg_addr_t addr, bitmask_t mask, IORegister::BitMode bitmode=IORegister::RW)
 
uint8_t read_ioreg (const regbit_t &rb) const
 
uint64_t read_ioreg (const regbit_compound_t &rbc) const
 
uint8_t read_ioreg (reg_addr_t addr) const
 
uint8_t read_ioreg (reg_addr_t addr, const bitspec_t &bs) const
 
bool test_ioreg (const regbit_t &rb) const
 
bool test_ioreg (const regbit_compound_t &rbc) const
 
bool test_ioreg (reg_addr_t addr, const bitspec_t &bs) const
 
bool test_ioreg (reg_addr_t addr, bitmask_t bm=0xFF) const
 
void write_ioreg (reg_addr_t addr, bitmask_t bm, uint8_t value)
 
void write_ioreg (const regbit_t &rb, uint8_t value)
 
void write_ioreg (const regbit_compound_t &rbc, uint64_t value)
 
void write_ioreg (reg_addr_t addr, uint8_t value)
 
void write_ioreg (reg_addr_t addr, const bitspec_t &bs, uint8_t value)
 
void set_ioreg (reg_addr_t addr, bitmask_t bm=0xFF)
 
void set_ioreg (const regbit_t &rb)
 
void set_ioreg (const regbit_compound_t &rbc)
 
void set_ioreg (reg_addr_t addr, const bitspec_t &bs)
 
void clear_ioreg (reg_addr_t addr, bitmask_t bm=0xFF)
 
void clear_ioreg (const regbit_t &rb)
 
void clear_ioreg (const regbit_compound_t &rbc)
 
void clear_ioreg (reg_addr_t addr, const bitspec_t &bs)
 

Detailed Description

Implementation of a Universal Serial Interface for AVR series.

Unsupported features:

Constructor & Destructor Documentation

◆ ArchAVR_USI()

ArchAVR_USI::ArchAVR_USI ( const ArchAVR_USIConfig &  config)
explicit

◆ ~ArchAVR_USI()

ArchAVR_USI::~ArchAVR_USI ( )
virtual

Member Function Documentation

◆ init()

bool ArchAVR_USI::init ( Device &  device)
overridevirtual

Virtual method called when the device is initialised. This is where the peripheral can allocate its I/O registers, interrupts or connect signals.

Returns
boolean indicates the success of all allocations.

Reimplemented from Peripheral.

◆ ioreg_write_handler()

void ArchAVR_USI::ioreg_write_handler ( reg_addr_t  addr,
const ioreg_write_t &  value 
)
overridevirtual

Virtual method called when the CPU is writing a I/O register allocated by this peripheral. The value has already been written.

Parameters
addrthe register address in I/O space
valuethe new register content

Reimplemented from Peripheral.

◆ reset()

void ArchAVR_USI::reset ( int  flags)
overridevirtual

Virtual method called when the device is reset. Note that resetting I/O registers is only necessary here if their reset value is not zero.

Parameters
flagsReset flags (OR'ed combination of Device::ResetFlag enumeration values)

Reimplemented from Peripheral.

Friends And Related Symbol Documentation

◆ _PinDriver

friend class _PinDriver
friend
The documentation for this class was generated from the following files:
Generated by doxygen 1.9.8