SubdeviceRegisterWindowAccessor.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Deutsches Elektronen-Synchrotron DESY, MSK, ChimeraTK Project <chimeratk-support@desy.de>
// SPDX-License-Identifier: LGPL-3.0-or-later
#pragma once
 
#include "NDRegisterAccessor.h"
#include "OneDRegisterAccessor.h"
#include "SubdeviceBackend.h"
#include "VoidRegisterAccessor.h"
 
namespace ChimeraTK {
 
  /********************************************************************************************************************/
 
  template<typename RegisterRawType, typename ReadWriteDataType>
  class SubdeviceRegisterWindowAccessor : public NDRegisterAccessor<RegisterRawType> {
   public:
    SubdeviceRegisterWindowAccessor(boost::shared_ptr<SubdeviceBackend> backend, const std::string& registerPathName,
        size_t numberOfWords, size_t wordOffsetInRegister);
 
    void doReadTransferSynchronously() override;
 
    bool doWriteTransfer(ChimeraTK::VersionNumber versionNumber) override;
 
    void doPreRead(TransferType type) override;
 
    void doPostRead(TransferType type, bool hasNewData) override;
 
    void doPreWrite(TransferType type, VersionNumber) override;
 
    void doPostWrite(TransferType type, VersionNumber) override;
 
    [[nodiscard]] bool mayReplaceOther(const boost::shared_ptr<TransferElement const>&) const override;
 
    [[nodiscard]] bool isReadOnly() const override;
 
    [[nodiscard]] bool isReadable() const override;
 
    [[nodiscard]] bool isWriteable() const override;
 
   protected:
    boost::shared_ptr<SubdeviceBackend> _backend;
 
    ScalarRegisterAccessor<uint64_t> _accChipSelect;       // chip select register, if present
    ScalarRegisterAccessor<uint64_t> _accAddress;          // address register
    OneDRegisterAccessor<ReadWriteDataType> _accWriteData; // write data register
    ScalarRegisterAccessor<ChimeraTK::Boolean> _accBusy;   // busy register, if present
    VoidRegisterAccessor _accReadRequest;                  // read request register, if present
    OneDRegisterAccessor<ReadWriteDataType> _accReadData;  // read data register
 
    // values needed in all transfers
    size_t _startAddress, _endAddress, _transferSize; // in bytes
    size_t _starTransferAddress, _endTransferAddress; // in increments of _transfersize, not in bytes
    size_t _numberOfWords;
 
    std::vector<RegisterRawType> _buffer;
 
    std::vector<boost::shared_ptr<TransferElement>> getHardwareAccessingElements() override;
 
    std::list<boost::shared_ptr<TransferElement>> getInternalElements() override;
 
    void replaceTransferElement(boost::shared_ptr<TransferElement> newElement) override;
 
    enum class TransferDirection { read, write };
    // Helper for the transfer to minimise code duplication
    void transferImpl(TransferDirection direction);
    std::vector<std::byte> _zeros; // _transferSize bytes with 0 to copy from for padding
  };
 
  /********************************************************************************************************************/
 
  DECLARE_MULTI_TEMPLATE_FOR_CHIMERATK_RAW_TYPES(SubdeviceRegisterWindowAccessor, uint8_t);
  DECLARE_MULTI_TEMPLATE_FOR_CHIMERATK_RAW_TYPES(SubdeviceRegisterWindowAccessor, uint16_t);
  DECLARE_MULTI_TEMPLATE_FOR_CHIMERATK_RAW_TYPES(SubdeviceRegisterWindowAccessor, uint32_t);
  DECLARE_MULTI_TEMPLATE_FOR_CHIMERATK_RAW_TYPES(SubdeviceRegisterWindowAccessor, uint64_t);
 
  // Compatibility stuff
  extern template class SubdeviceRegisterWindowAccessor<int8_t, uint8_t>;
  extern template class SubdeviceRegisterWindowAccessor<int8_t, uint16_t>;
  extern template class SubdeviceRegisterWindowAccessor<int8_t, uint32_t>;
  extern template class SubdeviceRegisterWindowAccessor<int8_t, uint64_t>;
 
  extern template class SubdeviceRegisterWindowAccessor<int16_t, uint8_t>;
  extern template class SubdeviceRegisterWindowAccessor<int16_t, uint16_t>;
  extern template class SubdeviceRegisterWindowAccessor<int16_t, uint32_t>;
  extern template class SubdeviceRegisterWindowAccessor<int16_t, uint64_t>;
 
  extern template class SubdeviceRegisterWindowAccessor<int32_t, uint8_t>;
  extern template class SubdeviceRegisterWindowAccessor<int32_t, uint16_t>;
  extern template class SubdeviceRegisterWindowAccessor<int32_t, uint32_t>;
  extern template class SubdeviceRegisterWindowAccessor<int32_t, uint64_t>;
 
  extern template class SubdeviceRegisterWindowAccessor<int64_t, uint8_t>;
  extern template class SubdeviceRegisterWindowAccessor<int64_t, uint16_t>;
  extern template class SubdeviceRegisterWindowAccessor<int64_t, uint32_t>;
  extern template class SubdeviceRegisterWindowAccessor<int64_t, uint64_t>;
 
} // namespace ChimeraTK