correlation.h

Go to the documentation of this file.

#pragma once
#include "halco/common/geometry.h"
#include "halco/common/typed_array.h"
#include "halco/hicann-dls/vx/capmem.h"
#include "halco/hicann-dls/vx/correlation.h"
#include "haldls/vx/genpybind.h"
#include "haldls/vx/traits.h"
#include "hate/math.h"
#include "hate/visibility.h"
 
#ifndef __ppu__
#include "haldls/cerealization.h"
#include <cereal/cereal.hpp>
#endif
 
namespace fisch::vx::word_access_type {
class Omnibus;
class OmnibusChipOverJTAG;
} // namespace fisch::vx::word_access_type
 
namespace haldls::vx GENPYBIND_TAG_HALDLS_VX {
 
class GENPYBIND(visible) CommonCorrelationConfig
{
public:
    typedef std::true_type is_leaf_node;
    typedef halco::hicann_dls::vx::CommonCorrelationConfigOnDLS coordinate_type;
 
    struct GENPYBIND(inline_base("*")) SenseDelay
        : public halco::common::detail::
              RantWrapper<SenseDelay, uint_fast16_t, hate::math::pow(2, 12) - 1, 0>
    {
        constexpr explicit SenseDelay(uintmax_t const val = 1) GENPYBIND(implicit_conversion) :
            rant_t(val)
        {}
    };
 
    struct GENPYBIND(inline_base("*")) ResetDuration
        : public halco::common::detail::
              RantWrapper<ResetDuration, uint_fast16_t, hate::math::pow(2, 12) - 1, 0>
    {
        constexpr explicit ResetDuration(uintmax_t const val = 200) GENPYBIND(implicit_conversion) :
            rant_t(val)
        {}
    };
 
    struct GENPYBIND(inline_base("*")) ResetFallTime
        : public halco::common::detail::
              RantWrapper<ResetFallTime, uint_fast16_t, hate::math::pow(2, 12) - 1, 0>
    {
        constexpr explicit ResetFallTime(uintmax_t const val = 5) GENPYBIND(implicit_conversion) :
            rant_t(val)
        {}
    };
 
    enum class ResetMode : uint_fast8_t
    {
        normal = 0b0,
        auto_calibrating = 0b1
    };
 
    typedef halco::common::typed_array<
        halco::hicann_dls::vx::CapMemBlockOnHemisphere,
        halco::hicann_dls::vx::CapMemBlockOnHemisphere>
        RampOffsets GENPYBIND(opaque(false));
 
    CommonCorrelationConfig() SYMBOL_VISIBLE;
 
    GENPYBIND(getter_for(sense_delay))
    SenseDelay get_sense_delay() const SYMBOL_VISIBLE;
    GENPYBIND(setter_for(sense_delay))
    void set_sense_delay(SenseDelay value) SYMBOL_VISIBLE;
 
    GENPYBIND(getter_for(reset_duration))
    ResetDuration get_reset_duration() const SYMBOL_VISIBLE;
    GENPYBIND(setter_for(reset_duration))
    void set_reset_duration(ResetDuration value) SYMBOL_VISIBLE;
 
    GENPYBIND(getter_for(reset_fall_time))
    ResetFallTime get_reset_fall_time() const SYMBOL_VISIBLE;
    GENPYBIND(setter_for(reset_fall_time))
    void set_reset_fall_time(ResetFallTime value) SYMBOL_VISIBLE;
 
    GENPYBIND(getter_for(reset_mode))
    ResetMode get_reset_mode() const SYMBOL_VISIBLE;
    GENPYBIND(setter_for(reset_mode))
    void set_reset_mode(ResetMode value) SYMBOL_VISIBLE;
 
    GENPYBIND(getter_for(cadc_v_offset_assignment), return_value_policy(reference))
    RampOffsets const& get_cadc_v_offset_assignment() const SYMBOL_VISIBLE;
    GENPYBIND(setter_for(cadc_v_offset_assignment))
    void set_cadc_v_offset_assignment(RampOffsets const& value) SYMBOL_VISIBLE;
 
    bool operator==(CommonCorrelationConfig const& other) const SYMBOL_VISIBLE;
    bool operator!=(CommonCorrelationConfig const& other) const SYMBOL_VISIBLE;
 
    GENPYBIND(stringstream)
    friend std::ostream& operator<<(std::ostream& os, CommonCorrelationConfig const& config)
        SYMBOL_VISIBLE;
 
    static size_t constexpr config_size_in_words GENPYBIND(hidden) = 4;
    template <typename AddressT>
    static std::array<AddressT, config_size_in_words> addresses(coordinate_type const& word)
        SYMBOL_VISIBLE GENPYBIND(hidden);
    template <typename WordT>
    std::array<WordT, config_size_in_words> encode() const SYMBOL_VISIBLE GENPYBIND(hidden);
    template <typename WordT>
    void decode(std::array<WordT, config_size_in_words> const& data) SYMBOL_VISIBLE
        GENPYBIND(hidden);
 
private:
    friend class cereal::access;
    template <typename Archive>
    void serialize(Archive& ar, std::uint32_t const version) SYMBOL_VISIBLE;
 
    SenseDelay m_sense_delay;
    ResetDuration m_reset_duration;
    ResetFallTime m_reset_fall_time;
    ResetMode m_reset_mode;
    RampOffsets m_cadc_v_offset_assignment;
};
 
std::ostream& operator<<(std::ostream& os, CommonCorrelationConfig::ResetMode const& config)
    SYMBOL_VISIBLE;
 
} // namespace haldls::vx
 
namespace haldls::vx::detail {
 
template <>
struct BackendContainerTrait<CommonCorrelationConfig>
    : public BackendContainerBase<
          haldls::vx::CommonCorrelationConfig,
          fisch::vx::word_access_type::Omnibus,
          fisch::vx::word_access_type::OmnibusChipOverJTAG>
{};
 
} // namespace haldls::vx::detail
 
#ifndef __ppu__
CEREAL_CLASS_VERSION(haldls::vx::CommonCorrelationConfig, 1)
EXTERN_INSTANTIATE_CEREAL_SERIALIZE(haldls::vx::CommonCorrelationConfig)
#endif