HALDLS
haldls::vx::PLLSelfTest Class Reference

Container for configuration and triggering of the PLL internal self test. More...

#include <pll.h>

Classes

struct  CheckRange
 Acceptance range for the internal counter compared to the expected counter. More...
 
struct  CheckValue
 Expected counter value within the 2^(p + 2) reference cycles. More...
 
struct  PreScalerP
 Selects counting window of the self test. More...
 

Public Types

typedef halco::hicann_dls::vx::PLLSelfTestOnDLS coordinate_type
 
typedef std::true_type is_leaf_node
 

Public Member Functions

 PLLSelfTest () SYMBOL_VISIBLE
 Default construct PLL self test. More...
 
template<typename WordT >
void decode (std::array< WordT, config_size_in_words > const &data) SYMBOL_VISIBLE
 
template<typename WordT >
std::array< WordT, config_size_in_wordsencode () const SYMBOL_VISIBLE
 
CheckRange get_check_range () const SYMBOL_VISIBLE
 
CheckValue get_check_value () const SYMBOL_VISIBLE
 
bool get_clock_enable () const SYMBOL_VISIBLE
 Get wheter the clock is enabled for the self-test. More...
 
PreScalerP get_pre_scaler_p () const SYMBOL_VISIBLE
 
halco::hicann_dls::vx::PLLClockOutputOnDLS get_select_source () const SYMBOL_VISIBLE
 Get selected source output to test. More...
 
bool operator!= (PLLSelfTest const &other) const SYMBOL_VISIBLE
 
bool operator== (PLLSelfTest const &other) const SYMBOL_VISIBLE
 
void set_check_range (CheckRange value) SYMBOL_VISIBLE
 
void set_check_value (CheckValue value) SYMBOL_VISIBLE
 
void set_clock_enable (bool value) SYMBOL_VISIBLE
 Set to enable the clock for the self-test. More...
 
void set_pre_scaler_p (PreScalerP value) SYMBOL_VISIBLE
 
void set_select_source (halco::hicann_dls::vx::PLLClockOutputOnDLS value) SYMBOL_VISIBLE
 Set selected source output to test. More...
 

Static Public Member Functions

template<typename AddressT >
static std::array< AddressT, config_size_in_wordsaddresses (coordinate_type const &coord) SYMBOL_VISIBLE
 

Static Public Attributes

static constexpr size_t config_size_in_words = 1
 

Friends

class cereal::access
 
std::ostream & operator<< (std::ostream &os, PLLSelfTest const &config) SYMBOL_VISIBLE
 

Detailed Description

Container for configuration and triggering of the PLL internal self test.

Definition at line 370 of file pll.h.

Member Typedef Documentation

◆ coordinate_type

typedef halco::hicann_dls::vx::PLLSelfTestOnDLS haldls::vx::PLLSelfTest::coordinate_type

Definition at line 373 of file pll.h.

◆ is_leaf_node

typedef std::true_type haldls::vx::PLLSelfTest::is_leaf_node

Definition at line 374 of file pll.h.

Constructor & Destructor Documentation

◆ PLLSelfTest()

haldls::vx::PLLSelfTest::PLLSelfTest ( )

Default construct PLL self test.

Member Function Documentation

◆ addresses()

template<typename AddressT >
static std::array<AddressT, config_size_in_words> haldls::vx::PLLSelfTest::addresses ( coordinate_type const &  coord)
static

◆ decode()

template<typename WordT >
void haldls::vx::PLLSelfTest::decode ( std::array< WordT, config_size_in_words > const &  data)

◆ encode()

template<typename WordT >
std::array<WordT, config_size_in_words> haldls::vx::PLLSelfTest::encode ( ) const

◆ get_check_range()

CheckRange haldls::vx::PLLSelfTest::get_check_range ( ) const

◆ get_check_value()

CheckValue haldls::vx::PLLSelfTest::get_check_value ( ) const

◆ get_clock_enable()

bool haldls::vx::PLLSelfTest::get_clock_enable ( ) const

Get wheter the clock is enabled for the self-test.

Before executing a valid test, this has to be written to be false.

Returns
Boolean value

◆ get_pre_scaler_p()

PreScalerP haldls::vx::PLLSelfTest::get_pre_scaler_p ( ) const

◆ get_select_source()

halco::hicann_dls::vx::PLLClockOutputOnDLS haldls::vx::PLLSelfTest::get_select_source ( ) const

Get selected source output to test.

Returns
Selected PLLClockOutputOnDLS

◆ operator!=()

bool haldls::vx::PLLSelfTest::operator!= ( PLLSelfTest const &  other) const

◆ operator==()

bool haldls::vx::PLLSelfTest::operator== ( PLLSelfTest const &  other) const

◆ set_check_range()

void haldls::vx::PLLSelfTest::set_check_range ( CheckRange  value)

◆ set_check_value()

void haldls::vx::PLLSelfTest::set_check_value ( CheckValue  value)

◆ set_clock_enable()

void haldls::vx::PLLSelfTest::set_clock_enable ( bool  value)

Set to enable the clock for the self-test.

Before executing a valid test, this has to be written to be false.

Parameters
valueBoolean value to set

◆ set_pre_scaler_p()

void haldls::vx::PLLSelfTest::set_pre_scaler_p ( PreScalerP  value)

◆ set_select_source()

void haldls::vx::PLLSelfTest::set_select_source ( halco::hicann_dls::vx::PLLClockOutputOnDLS  value)

Set selected source output to test.

Parameters
Tobe selected PLLClockOutputOnDLS

Friends And Related Function Documentation

◆ cereal::access

friend class cereal::access
friend

Definition at line 472 of file pll.h.

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
PLLSelfTest const &  config 
)
friend

Member Data Documentation

◆ config_size_in_words

constexpr size_t haldls::vx::PLLSelfTest::config_size_in_words = 1
staticconstexpr

Definition at line 461 of file pll.h.


The documentation for this class was generated from the following file: