On this page
article
peary/interfaces/SerialMemory/serialmemory.hpp
peary/interfaces/SerialMemory/serialmemory.hpp
Peary Serial Memory Interface. More…
Namespaces
| Name |
|---|
| peary |
| peary::interface |
Classes
| Name | |
|---|---|
| class | peary::interface::iface_sermem_config Configuration class for Serial Memory interface. |
| class | peary::interface::iface_sermem Peary Serial Memory Interface. |
Detailed Description
Peary Serial Memory Interface.
Copyright: Copyright (c) 2016-2025 CERN and the Peary Caribou authors. This software is distributed under the terms of the LGPL-3.0-only License, copied verbatim in the file “LICENSE.md”. SPDX-License-Identifier: LGPL-3.0-only
Source code
#pragma once
#include <cstdint>
#include <cstdio>
#include <string>
#include <vector>
#include <fcntl.h>
#include <sys/mman.h>
#include "peary/interfaces/Memory/memory.hpp"
#include "peary/utils/datatypes.hpp"
#include "peary/utils/exceptions.hpp"
namespace peary::interface {
class iface_sermem_config : public iface_mem_config {
public:
iface_sermem_config(std::string const& devicepath,
const utils::memory_map& mem,
const size_t reg_addr_write,
const size_t reg_value_write,
const size_t reg_addr_read,
const size_t reg_value_read,
const size_t status);
size_t _addr_write;
size_t _val_write;
size_t _addr_read;
size_t _val_read;
size_t _status;
using iface_mem_config::operator<;
virtual bool operator<(const iface_sermem_config& rhs) const;
};
class iface_sermem : public iface_mem {
public:
using reg_type = size_t;
using data_type = uintptr_t;
using configuration_type = iface_sermem_config;
using dataVector_type = std::vector<data_type>;
explicit iface_sermem(const configuration_type& config);
~iface_sermem() = default;
iface_sermem() = delete;
GENERATE_FRIENDS()
private:
// Transactions are triggered by writing into the address registers!
// Register for storing the target address and target values for write operations:
size_t _register_address_write;
size_t _register_value_write;
// Register for storing the target address and retrieved values for read operations:
size_t _register_address_read;
size_t _register_value_read;
// One status register that contains
// - transaction status [0] (high when transaction done),
// - error flag [1] (high when there was an error) and
// - optionally the device error code [31:2]
size_t _status;
std::pair<size_t, uintptr_t> write(const std::pair<size_t, uintptr_t>&) override;
dataVector_type read(const size_t&, const unsigned int) override;
friend iface_sermem& InterfaceManager::getInterface<iface_sermem>(const configuration_type&);
friend void InterfaceManager::deleteInterface<iface_sermem>(iface_sermem*);
};
} // namespace peary::interface
Updated on 2025-11-14 at 11:31:23 +0100