ArchXT_SPI Class Reference

Implementation of a Serial Peripheral Interface controller for the XT core series. More...

#include <arch_xt_spi.h>

Inheritance diagram for ArchXT_SPI:

Classes
class	_Controller
class	_InterruptHandler
class	_PinDriver

Public Member Functions
	ArchXT_SPI (int num, const ArchXT_SPIConfig &config)
virtual	~ArchXT_SPI ()
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
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 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	SPIController

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 Serial Peripheral Interface controller for the XT core series.

for supported CTLREQs, see sim_spi.h

Constructor & Destructor Documentation

ArchXT_SPI()

ArchXT_SPI::ArchXT_SPI	(	int	num,
		const ArchXT_SPIConfig &	config
	)

~ArchXT_SPI()

ArchXT_SPI::~ArchXT_SPI ( )

virtual

Member Function Documentation

ctlreq()

bool ArchXT_SPI::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_SPI::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_SPI::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_SPI::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_SPI::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_SPI::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.

Friends And Related Symbol Documentation

SPIController

friend class SPIController

friend

---

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

• arch_xt_spi.h
• arch_xt_spi.cpp