ham_impl

Warning

doxygenfile: Cannot find file “eos/ham_impl.h

Type definitions in ham_impl

namespace eos

class device_impl_t

#include <ham_impl.h>

The device_t type is passed to the ctor of the eossdk_ham_t type.

Public Functions

device_impl_t()

Default constructor.

std::string driver() const

Getter for ‘driver’: Driver name.

void driver_is(std::string driver)

Setter for ‘driver’.

uint32_t uid() const

Getter for ‘uid’: The unique ID for the component.

void uid_is(uint32_t uid)

Setter for ‘uid’.

uint32_t did() const

Getter for ‘did’: The unique topology ID for the device.

void did_is(uint32_t did)

Setter for ‘did’.

uint32_t bus() const

Getter for ‘bus’: The Bus ID attribute.

void bus_is(uint32_t bus)

Setter for ‘bus’.

uint32_t accelerator() const

Getter for ‘accelerator’: The accelerator attribute.

void accelerator_is(uint32_t accelerator)

Setter for ‘accelerator’.

bool operator==(device_impl_t const &other) const

bool operator!=(device_impl_t const &other) const

bool operator<(device_impl_t const &other) const

uint32_t hash() const

The hash function for type device_t.

void mix_me(hash_mix &h) const

The hash mix function for type device_t.

std::string to_string() const

Returns a string representation of the current object’s values.

Private Members

std::string driver_

uint32_t uid_

uint32_t did_

uint32_t bus_

uint32_t accelerator_

Friends

std::ostream &operator<<(std::ostream &os, const device_impl_t &obj)

A utility stream operator that adds a string representation of device_t to the ostream.

class pci_address_impl_t

#include <ham_impl.h>

The pci_address_t type is passed to the ctor of the eossdk_ham_t type. The HAM should use the PCI address of the SCD. If zero, the CPUs SMBuses are used.

Public Functions

pci_address_impl_t()

Default constructor.

uint32_t domain() const

Getter for ‘domain’: Domain of the pci address.

void domain_is(uint32_t domain)

Setter for ‘domain’.

uint32_t bus() const

Getter for ‘bus’: Bus identifier for pci address.

void bus_is(uint32_t bus)

Setter for ‘bus’.

uint32_t device() const

Getter for ‘device’: Device identifier for pci address.

void device_is(uint32_t device)

Setter for ‘device’.

uint32_t function() const

Getter for ‘function’: Function identifier for pci address.

void function_is(uint32_t function)

Setter for ‘function’.

bool operator==(pci_address_impl_t const &other) const

bool operator!=(pci_address_impl_t const &other) const

bool operator<(pci_address_impl_t const &other) const

uint32_t hash() const

The hash function for type pci_address_t.

void mix_me(hash_mix &h) const

The hash mix function for type pci_address_t.

std::string to_string() const

Returns a string representation of the current object’s values.

Private Members

uint32_t domain_

uint32_t bus_

uint32_t device_

uint32_t function_

Friends

std::ostream &operator<<(std::ostream &os, const pci_address_impl_t &obj)

A utility stream operator that adds a string representation of pci_address_t to the ostream.

class aham_address_impl_t

#include <ham_impl.h>

The aham_address_t type is passed to the ctor of the eossdk_ham_t type. It holds the bus Id, the accelerator,and the endpoint address.

Public Functions

aham_address_impl_t()

Default constructor.

uint32_t bus() const

Getter for ‘bus’: Bus attribute for aham address.

void bus_is(uint32_t bus)

Setter for ‘bus’.

uint32_t accelerator() const

Getter for ‘accelerator’: Accelerator for ahamaddress.

void accelerator_is(uint32_t accelerator)

Setter for ‘accelerator’.

uint32_t address() const

Getter for ‘address’: Address field of the aham addressobject.

void address_is(uint32_t address)

Setter for ‘address’.

bool operator==(aham_address_impl_t const &other) const

bool operator!=(aham_address_impl_t const &other) const

bool operator<(aham_address_impl_t const &other) const

uint32_t hash() const

The hash function for type aham_address_t.

void mix_me(hash_mix &h) const

The hash mix function for type aham_address_t.

std::string to_string() const

Returns a string representation of the current object’s values.

Private Members

uint32_t bus_

uint32_t accelerator_

uint32_t address_

Friends

std::ostream &operator<<(std::ostream &os, const aham_address_impl_t &obj)

A utility stream operator that adds a string representation of aham_address_t to the ostream.

class eossdk_ham_impl_t

#include <ham_impl.h>

Hardware access method.

Public Functions

eossdk_ham_impl_t(device_t device_Args, uint32_t endpoint_Addr)

Default constructor, where deviceArgs and endpointAddr are passed in from the EosSdk FPGA module.

eossdk_ham_impl_t(aham_address_t aham_address, pci_address_t pci_address)

Constructor specifying the AhamAddress for the ham device, where the AhamAddress contains the endpoint address, the bus Id, and the accelerator for the ham. Also specifies PCI Address.

device_t device_Args() const

uint32_t endpoint_Addr() const

aham_address_t aham_address() const

pci_address_t pci_address() const

uint32_t hash() const

The hash function for type eossdk_ham_t.

void mix_me(hash_mix &h) const

The hash mix function for type eossdk_ham_t.

std::string to_string() const

Returns a string representation of the current object’s values.

Private Members

device_t device_Args_

uint32_t endpoint_Addr_

aham_address_t aham_address_

pci_address_t pci_address_

Friends

std::ostream &operator<<(std::ostream &os, const eossdk_ham_impl_t &obj)

A utility stream operator that adds a string representation of eossdk_ham_t to the ostream.

class read8_result_impl_t

#include <ham_impl.h>

Stores the status and result of read8 calls.

Public Functions

read8_result_impl_t(response_enum_t status, uint8_t result)

Default constructor.

response_enum_t status() const

void status_is(response_enum_t status)

uint8_t result() const

void result_is(uint8_t result)

bool operator==(read8_result_impl_t const &other) const

bool operator!=(read8_result_impl_t const &other) const

uint32_t hash() const

The hash function for type read8_result_t.

void mix_me(hash_mix &h) const

The hash mix function for type read8_result_t.

std::string to_string() const

Returns a string representation of the current object’s values.

Private Members

response_enum_t status_

uint8_t result_

Friends

std::ostream &operator<<(std::ostream &os, const read8_result_impl_t &obj)

A utility stream operator that adds a string representation of read8_result_t to the ostream.

class read16_result_impl_t

#include <ham_impl.h>

Stores the status and result of read16 calls.

Public Functions

read16_result_impl_t(response_enum_t status, uint16_t result)

Default constructor.

response_enum_t status() const

void status_is(response_enum_t status)

uint16_t result() const

void result_is(uint16_t result)

bool operator==(read16_result_impl_t const &other) const

bool operator!=(read16_result_impl_t const &other) const

uint32_t hash() const

The hash function for type read16_result_t.

void mix_me(hash_mix &h) const

The hash mix function for type read16_result_t.

std::string to_string() const

Returns a string representation of the current object’s values.

Private Members

response_enum_t status_

uint16_t result_

Friends

std::ostream &operator<<(std::ostream &os, const read16_result_impl_t &obj)

A utility stream operator that adds a string representation of read16_result_t to the ostream.

class read_result_impl_t

#include <ham_impl.h>

Stores the status and result of read calls that readup to 32 bytes.

Public Functions

read_result_impl_t(response_enum_t status, std::string result)

Default constructor.

response_enum_t status() const

void status_is(response_enum_t status)

std::string result() const

void result_is(std::string result)

bool operator==(read_result_impl_t const &other) const

bool operator!=(read_result_impl_t const &other) const

uint32_t hash() const

The hash function for type read_result_t.

void mix_me(hash_mix &h) const

The hash mix function for type read_result_t.

std::string to_string() const

Returns a string representation of the current object’s values.

Private Members

response_enum_t status_

std::string result_

Friends

std::ostream &operator<<(std::ostream &os, const read_result_impl_t &obj)

A utility stream operator that adds a string representation of read_result_t to the ostream.

class register_impl_t

#include <ham_impl.h>

Register type, from which the HAM will read from/write to.

Public Functions

register_impl_t()

uint32_t reg() const

void reg_is(uint32_t reg)

bool operator==(register_impl_t const &other) const

bool operator!=(register_impl_t const &other) const

bool operator<(register_impl_t const &other) const

uint32_t hash() const

The hash function for type register_t.

void mix_me(hash_mix &h) const

The hash mix function for type register_t.

std::string to_string() const

Returns a string representation of the current object’s values.

Private Members

uint32_t reg_

Friends

std::ostream &operator<<(std::ostream &os, const register_impl_t &obj)

A utility stream operator that adds a string representation of register_t to the ostream.