ArchAVR_Port Class Reference

yasimavr: ArchAVR_Port Class Reference

yasimavr

Loading...

Searching...

No Matches

Implementation of a GPIO port controller for AVR series. More...

#include <arch_avr_port.h>

Inheritance diagram for ArchAVR_Port:

Public Member Functions
	ArchAVR_Port (const ArchAVR_PortConfig &config)

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 Port
	Port (char name)

virtual bool	ctlreq (ctlreq_id_t req, ctlreq_data_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 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

Protected Member Functions
virtual void	pin_state_changed (uint8_t num, Wire::StateEnum state) override

Protected Member Functions inherited from Port
bitmask_t	pin_mask () const
	Returns the pin mask, containing a '1' for each existing pin.

Pin *	pin (uint8_t num) const

void	set_pin_internal_state (uint8_t num, const Pin::controls_t &controls)

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 GPIO port controller for AVR series.

Constructor & Destructor Documentation

◆ ArchAVR_Port()

YASIMAVR_USING_NAMESPACE ArchAVR_Port::ArchAVR_Port ( const ArchAVR_PortConfig & config )

explicit

Member Function Documentation

◆ init()

bool ArchAVR_Port::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 Port.

◆ ioreg_write_handler()

void ArchAVR_Port::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

addr	the register address in I/O space
value	the new register content

Reimplemented from Peripheral.

◆ pin_state_changed()

void ArchAVR_Port::pin_state_changed	(	uint8_t	num,
		Wire::StateEnum	state
	)

overrideprotectedvirtual

Callback method called when the resolved state of a pin has changed.

See also: set_pin_internal_state

Reimplemented from Port.

◆ reset()

void ArchAVR_Port::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

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

Reimplemented from Port.

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

ArchAVR_Port Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ArchAVR_Port()

Member Function Documentation

◆ init()

◆ ioreg_write_handler()

◆ pin_state_changed()

◆ reset()