peary::interface::AXI4LiteEndpoint

Peary AXI4Lite Interface Endpoint.

#include <peary/interfaces/AXI4Lite/axi4lite.hpp>

Inherits from peary::interface::Endpoint< AXI4LiteInterface, size_t, uintptr_t >

Inherited by peary::interface::SerialMemoryEndpoint

Public Functions

Name
AXI4LiteEndpoint(std::string const & devpath, const utils::memory_map & mem)
~AXI4LiteEndpoint()

Protected Functions

Name
virtual pair_t write_impl(const pair_t & ) overrideWrite data to a memory location.
virtual vector_t read_impl(const reg_t & , const unsigned int ) overrideRead multiple words from a memory location.
uintptr_t read_word(const reg_t & offset) constRead a word from a memory location.

Additional inherited members

Public Types inherited from peary::interface::Endpoint< AXI4LiteInterface, size_t, uintptr_t >

Name
using RegisterType reg_t
using DataType data_t
using std::pair< RegisterType, DataType > pair_t
using std::vector< DataType > vector_t

Public Functions inherited from peary::interface::Endpoint< AXI4LiteInterface, size_t, uintptr_t >

Name
Endpoint(const Endpoint & ) =delete
Endpoint & operator=(const Endpoint & ) =delete
Endpoint(Endpoint && ) =delete
Endpoint & operator=(Endpoint && ) =delete
std::string info() constReturn human-readable endpoint information.
data_t write(const data_t & value)Write a single data word to a device which does not contain internal registers.
vector_t write(const vector_t & values)Write multiple data words to a device which does not contain internal registers.
pair_t write(const pair_t & regData)Write a single data word to a device containing internal registers.
vector_t write(const reg_t & reg, const vector_t & values)Write multiple data words to a specific register of a device containing internal registers.
std::vector< pair_t > write(const std::vector< pair_t > & regDataVec)Write multiple data words to multiple registers of a device containing internal registers.
data_t read()Read a single data word from a device which does not contain internal registers.
vector_t read(unsigned int count)Read multiple data words from a device which does not contain internal registers.
vector_t read(const reg_t & reg, unsigned int count)Read a single data word from a specific register of a device containing internal registers.

Protected Functions inherited from peary::interface::Endpoint< AXI4LiteInterface, size_t, uintptr_t >

Name
Endpoint(const std::string & info)
virtual ~Endpoint() =default

Public Functions Documentation

function AXI4LiteEndpoint 

  AXI4LiteEndpoint(
    std::string const & devpath,
    const utils::memory_map & mem
)
  
         @brief Type definition for the configuration object used by the AXI4Lite interface

  • *devpathThe device path for the memory interface

  • *memThe memory map configuration

function ~AXI4LiteEndpoint 

  ~AXI4LiteEndpoint()

Protected Functions Documentation

function write_impl 

  virtual pair_t write_impl(
    const pair_t & 
) override

Write data to a memory location.

Reimplements: peary::interface::Endpoint::write_impl

Reimplemented by: peary::interface::SerialMemoryEndpoint::write_impl

function read_impl 

  virtual vector_t read_impl(
    const reg_t & ,
    const unsigned int 
) override

Read multiple words from a memory location.

Return: A vector containing the words read from the specified memory location

Reimplements: peary::interface::Endpoint::read_impl

Reimplemented by: peary::interface::SerialMemoryEndpoint::read_impl

function read_word 

  uintptr_t read_word(
    const reg_t & offset
) const

Read a word from a memory location.

Return: The word read from the specified memory location

Updated on 2026-01-30 at 22:01:05 +0100