peary::interface::iface_sermem

Peary Serial Memory Interface.

#include <peary/interfaces/SerialMemory/serialmemory.hpp>

Inherits from peary::interface::iface_mem, peary::interface::Interface< size_t, uintptr_t, iface_mem_config >

Public Types

Name
using size_t reg_type Type definitions for register and data types.
using uintptr_t data_type
using iface_sermem_config configuration_type
using std::vector< data_type > dataVector_type

Public Functions

Name
iface_sermem(const configuration_type & config)Constructor for iface_sermem.
~iface_sermem() =defaultDestructor for iface_sermem.
iface_sermem() =deleteDelete copy constructor to prevent copying.

Friends

Name
iface_sermem & InterfaceManager::getInterface(const configuration_type & ) Friend function to get an instance of iface_sermem from the InterfaceManager.
void InterfaceManager::deleteInterface(iface_sermem * ) Friend function to delete an instance of iface_sermem from the InterfaceManager.

Additional inherited members

Public Functions inherited from peary::interface::iface_mem

Name
iface_mem(const configuration_type & config)Type definition for the configuration object used by the Memory interface.
~iface_mem() overrideDestructor for iface_mem.
utils::memory_map mem() constGet the memory map.
iface_mem() =deleteDeleted default constructor to prevent instantiation without configuration.

Protected Functions inherited from peary::interface::iface_mem

Name
uintptr_t readWord(const size_t) constRead a word from a memory location.

Public Attributes inherited from peary::interface::iface_mem

Name
int _memfd
void * _mappedMemory

Public Functions inherited from peary::interface::Interface< size_t, uintptr_t, iface_mem_config >

Name
std::string devicePath() constGet the device path associated with the interface.

Protected Functions inherited from peary::interface::Interface< size_t, uintptr_t, iface_mem_config >

Name
Interface(const InterfaceConfiguration & config)Constructor for Interface class.
virtual ~Interface() =defaultVirtual destructor for Interface class.

Public Types Documentation

using reg_type 

  using peary::interface::iface_sermem::reg_type =  size_t;

Type definitions for register and data types.

using data_type 

  using peary::interface::iface_sermem::data_type =  uintptr_t;

using configuration_type 

  using peary::interface::iface_sermem::configuration_type =  iface_sermem_config;

using dataVector_type 

  using peary::interface::iface_sermem::dataVector_type =  std::vector<data_type>;

Public Functions Documentation

function iface_sermem 

  explicit iface_sermem(
    const configuration_type & config
)

Constructor for iface_sermem.

Parameters:

  • config The configuration object for the Serial Memory interface

function ~iface_sermem 

  ~iface_sermem() =default

Destructor for iface_sermem.

function iface_sermem 

  iface_sermem() =delete

Delete copy constructor to prevent copying.

Friends

friend InterfaceManager::getInterface 

  friend iface_sermem & InterfaceManager::getInterface(
    const configuration_type & 
);

Friend function to get an instance of iface_sermem from the InterfaceManager.

Return: A reference to the iface_sermem instance

friend InterfaceManager::deleteInterface 

  friend void InterfaceManager::deleteInterface(
    iface_sermem * 
);

Friend function to delete an instance of iface_sermem from the InterfaceManager.

Updated on 2025-11-14 at 11:31:23 +0100