Detailed Description

Mockup for a memory-mapped ConfigBus.

This mocks out the memory-map interface only; the child class or end-user must add behaviors to simulate device operation.

Definition at line 238 of file sim_utils.h.

#include <sim_utils.h>

Inheritance diagram for satcat5::test::MockConfigBusMmap:

[legend]

Collaboration diagram for satcat5::test::MockConfigBusMmap:

[legend]

Public Member Functions
	MockConfigBusMmap ()
	Create this mock interface.

void	clear_all (u32 val=0)
	Clear all registers for all devices.

void	clear_dev (unsigned devaddr, u32 val=0)
	Clear all registers for the specified device-ID.

void	irq_event ()
	Make event-handler accessible (normally private)

satcat5::cfg::IoStatus	read (unsigned regaddr, u32 &val) override
	Basic single-register read operation.

satcat5::cfg::IoStatus	write (unsigned regaddr, u32 val) override
	Basic single-register write operation.

void *	get_device_mmap (unsigned dev) const
	Get a raw pointer to the designated device-address.

volatile u32 *	get_register_mmap (unsigned addr) const
	Get a raw pointer to the designated combined-address.

virtual satcat5::cfg::IoStatus	read_array (unsigned regaddr, unsigned count, u32 *result)
	Bulk-read with auto-increment (regaddr, regaddr+1, ...) Bulk read/write operations are more efficient when controlling ConfigBus peripherals over a network interface.

virtual satcat5::cfg::IoStatus	read_repeat (unsigned regaddr, unsigned count, u32 *result)
	Bulk-read the same register N times.

virtual satcat5::cfg::IoStatus	write_array (unsigned regaddr, unsigned count, const u32 *data)
	Bulk-write with auto-increment (regaddr, regaddr+1, ...)

virtual satcat5::cfg::IoStatus	write_repeat (unsigned regaddr, unsigned count, const u32 *data)
	Bulk-write the same register N times.

unsigned	get_regaddr (unsigned dev, unsigned reg) const
	Convert device + register to combined address.

void	register_irq (satcat5::cfg::Interrupt *obj)
	Add an interrupt handler. More...

void	unregister_irq (satcat5::cfg::Interrupt *obj)
	Remove an interrupt handler.

unsigned	count_irq () const
	Count attached interrupt handlers.

satcat5::cfg::Register	get_register (unsigned dev, unsigned reg=0)
	Create register-map object for the given device address. More...

void	irq_poll ()
	Poll all registered ConfigBus interrupt handlers. More...

Public Attributes
const char *const	m_label
	Human-readable label, for debugging.

const int	m_irq_idx
	IRQ index for this interrupt handler.

Protected Attributes
u32	m_regs [satcat5::cfg::MAX_TOTAL_REGS]
	Simulated register-map for up to 256 devices.

volatile u32 *	m_base_ptr

satcat5::util::List< satcat5::cfg::Interrupt >	m_irq_list

u32	m_max_irqtime
	Statistics tracking for time consumed by this interrupt.

Private Attributes
satcat5::irq::Handler *	m_next

Member Function Documentation

◆ get_register()

Register ConfigBus::get_register	(	unsigned	dev,
		unsigned	reg = `0`
	)

inherited

Create register-map object for the given device address.

(Or for a specific register, if the register address is specified.)

Definition at line 101 of file cfgbus_core.cc.

◆ irq_poll()

void ConfigBus::irq_poll ( )

inherited

Poll all registered ConfigBus interrupt handlers.

Issue callbacks to any that may have triggered. (This method should not usually be called directly.)

Definition at line 111 of file cfgbus_core.cc.

◆ register_irq()

void ConfigBus::register_irq ( satcat5::cfg::Interrupt * obj )

inherited

Add an interrupt handler.

Each ConfigBus interface has a single interrupt signal, which is the logical OR of interrupts from all attached peripherals. When any peripheral raises its interrupt signal, call irq_poll().

Definition at line 80 of file cfgbus_core.cc.

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

Detailed Description

Public Member Functions

Public Attributes

Protected Attributes

Private Attributes

Member Function Documentation

◆ get_register()

◆ irq_poll()

◆ register_irq()