ArchXT_TimerB Class Reference

Implementation of a Timer/Counter type B for the XT core series. More...

#include <arch_xt_timer_b.h>

Inheritance diagram for ArchXT_TimerB:

Classes
class	_PinDriver

Public Types
enum	SignalId { Signal_Capture , Signal_Output }
enum	CaptureHookTag { Tag_Event , Tag_Count }

Public Member Functions
	ArchXT_TimerB (int num, const ArchXT_TimerBConfig &config)
virtual	~ArchXT_TimerB ()
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 uint8_t	ioreg_peek_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.
	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 Timer/Counter type B for the XT core series.

Unsupported features:

• Debug run override
• Synchronize Update (SYNCUPD)

Member Enumeration Documentation

CaptureHookTag

enum ArchXT_TimerB::CaptureHookTag

Enumerator
Tag_Event
Tag_Count

SignalId

enum ArchXT_TimerB::SignalId

Enumerator
Signal_Capture
Signal_Output

Constructor & Destructor Documentation

ArchXT_TimerB()

ArchXT_TimerB::ArchXT_TimerB	(	int	num,
		const ArchXT_TimerBConfig &	config
	)

~ArchXT_TimerB()

ArchXT_TimerB::~ArchXT_TimerB ( )

virtual

Member Function Documentation

ctlreq()

bool ArchXT_TimerB::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 ArchXT_TimerB::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_peek_handler()

uint8_t ArchXT_TimerB::ioreg_peek_handler ( reg_addr_t  addr, uint8_t  value  )

overridevirtual

Virtual method called when a debug probe is peeking the value of a register. The value has not been read yet so the module can modify it before the CPU gets it. The difference between a peek and a read is that a peek should not modify the state of the peripheral. By default, ioreg_read_handler is called to obtain the value.

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_read_handler()

uint8_t ArchXT_TimerB::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 ArchXT_TimerB::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 ArchXT_TimerB::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 ArchXT_TimerB::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.

Friends And Related Symbol Documentation

_PinDriver

friend class _PinDriver

friend

---

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

• arch_xt_timer_b.h
• arch_xt_timer_b.cpp