API referenceEmulation APIClasses

hololink::emulation::AddressMemory

View as Markdown

Representation of the internal memory space of the HSBEmulator and its registers.

#include <hololink/emulation/address_memory.hpp>

This currently implemented as a simple map, but the underlying implementation should be expected to change, though the public methods should remain available.

Constructors

Destructor

~AddressMemory

virtual hololink::emulation::AddressMemory::~AddressMemory() = default

Methods

write

virtual int hololink::emulation::AddressMemory::write(
    AddressValuePair &address_value
)

Write a value to a register.

Returns: 0 on success, 1 on failure

Parameters

address_value
AddressValuePair &

Pair of address and value to write

read

virtual int hololink::emulation::AddressMemory::read(
    AddressValuePair &address_value
)

Read a value from a register.

Returns: 0 on success, 1 on failure

Parameters

address_value
AddressValuePair &

Pair of address and value to read

write_many

virtual int hololink::emulation::AddressMemory::write_many(
    AddressValuePair *address_values,
    int num_addresses
)

Convenience function to write multiple values to registers under a single lock.

Returns: 0 on success, 1 on failure

Parameters

address_values
AddressValuePair *

Pointer to array of pairs of register addresses and values to write

num_addresses
int

Number of address-value pairs

read_many

virtual int hololink::emulation::AddressMemory::read_many(
    AddressValuePair *address_values,
    int num_addresses
)

Convenience function to read multiple values from registers under a single lock.

Returns: 0 on success, 1 on failure

Parameters

address_values
AddressValuePair *

Pointer to array of pairs of register addresses and values to read (caller must allocate at least num_addresses elements)

num_addresses
int

Number of addresses to read

write_range

virtual int hololink::emulation::AddressMemory::write_range(
    uint32_t start_address,
    uint32_t *values,
    int num_addresses,
    int stride = 2
)

Write a range of values to registers.

Allow optimizations if it is known that the addresses are contiguous.

Returns: 0 on success, 1 on failure

Parameters

num_addresses
int

The number of addresses to write

read_range

virtual int hololink::emulation::AddressMemory::read_range(
    uint32_t start_address,
    uint32_t *values,
    int num_addresses,
    int stride = 2
)

Read a range of values from registers.

Allow optimizations if it is known that the addresses are contiguous.

Returns: 0 on success, 1 on failure

Parameters

num_addresses
int

The number of addresses to read