ArchAVR_ADC Class Reference

yasimavr: ArchAVR_ADC Class Reference

yasimavr

Loading...

Searching...

No Matches

Implementation of an ADC for AVR series. More...

#include <arch_avr_adc.h>

Inheritance diagram for ArchAVR_ADC:

Public Member Functions
	ArchAVR_ADC (int num, const ArchAVR_ADCConfig &config)

virtual bool	init (Device &device) override

virtual void	reset (int flags) override

virtual bool	ctlreq (ctlreq_id_t req, ctlreq_data_t *data) override

virtual uint8_t	ioreg_read_handler (reg_addr_t addr, uint8_t value) override

virtual void	ioreg_write_handler (reg_addr_t addr, const ioreg_write_t &data) override

virtual void	sleep (bool on, SleepMode mode) 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_peek_handler (reg_addr_t addr, uint8_t value) override

	Peripheral (const Peripheral &)=delete

Peripheral &	operator= (const Peripheral &)=delete

Public Member Functions inherited from IORegHandler
virtual	~IORegHandler ()=default

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 an ADC for AVR series.

Limitations:

No automatic start on ADR Noise Reduction sleep mode
No digital input disabling

CTLREQs supported:

AVR_CTLREQ_GET_SIGNAL : returns a pointer to the instance signal
AVR_CTLREQ_ADC_SET_TEMP : Sets the temperature reported by the internal sensor. The reqdata should carry the temperature in Celsius as a double.
AVR_CTLREQ_ADC_TRIGGER : Allows other peripherals to trigger a conversion. The trigger only works when the ADC is enabled and idle, auto-trigger is enabled and an external trigger source is selected.

Constructor & Destructor Documentation

◆ ArchAVR_ADC()

ArchAVR_ADC::ArchAVR_ADC	(	int	num,
		const ArchAVR_ADCConfig &	config
	)

Member Function Documentation

◆ ctlreq()

bool ArchAVR_ADC::ctlreq	(	ctlreq_id_t	req,
		ctlreq_data_t *	data
	)

overridevirtual

Virtual method called for a CTL request. The method must return true if the request has been processed.

Reimplemented from Peripheral.

◆ init()

bool ArchAVR_ADC::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_read_handler()

uint8_t ArchAVR_ADC::ioreg_read_handler	(	reg_addr_t	addr,
		uint8_t	value
	)

overridevirtual

Virtual method called when the CPU is reading a I/O register allocated by this peripheral. The value has not been read yet so the module can modify it before the CPU gets it.

Parameters

addr	the register address in I/O space
value	current cached value of the register

Returns: actual value of the register

Reimplemented from Peripheral.

◆ ioreg_write_handler()

void ArchAVR_ADC::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.

◆ reset()

void ArchAVR_ADC::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 Peripheral.

◆ sleep()

void ArchAVR_ADC::sleep	(	bool	on,
		SleepMode	mode
	)

overridevirtual

Virtual method called when the device enters or exits a sleep mode.

Parameters

on	true when entering a sleep mode, false when exiting it.
mode	one of the enum SleepMode values

Reimplemented from Peripheral.

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

ArchAVR_ADC Class Reference

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ArchAVR_ADC()

Member Function Documentation

◆ ctlreq()

◆ init()

◆ ioreg_read_handler()

◆ ioreg_write_handler()

◆ reset()

◆ sleep()