peary::device::CaribouDevice link

Caribou Device class definition. More…

#include <peary/device/CaribouDevice.hpp>

Inherits from peary::device::Device

Protected Types link

Public Functions link

Protected Functions link

Protected Attributes link

Additional inherited members link

Public Functions inherited from peary::device::Device

Protected Attributes inherited from peary::device::Device

Friends inherited from peary::device::Device

Detailed Description link

  template <typename B ,
typename SCI ,
typename DRI  =SCI>
class peary::device::CaribouDevice;
  

Caribou Device class definition.

Template Parameters:

• B Type of the hardware board class
• SCI Type of the slow control interface
• DRI Type of the data readout interface

this is the central device class from which all device implementations inherit. Some basic functionality is defined via purely virtual member functions which have to be implemented by every device instance. This enables the possibility of interfacing the devices independently via the common set of function calls, e.g., from a GUI or a commandline interface.

Protected Types Documentation link

typedef _registers link

  utils::dictionary<utils::register_t<typename SCI::reg_type, typename SCI::data_type> > peary::device::CaribouDevice< B, SCI, DRI >::_registers;
  

Register dictionary for the devices:

typedef _periphery link

  utils::dictionary<hal::Resource> peary::device::CaribouDevice< B, SCI, DRI >::_periphery;
  

Periphery dictionary to access board components:

typedef _memory link

  utils::dictionary<std::pair<utils::memory_map, utils::register_t<std::uintptr_t, std::uintptr_t> > > peary::device::CaribouDevice< B, SCI, DRI >::_memory;
  

Memory page dictionary to access FPGA registers:

Public Functions Documentation link

function CaribouDevice link

  CaribouDevice(
    const config::Configuration & config,
    const typename SCI::configuration_type & sciConfig
)
  

Default constructor for Caribou devices.

Parameters:

• config Configuration object
• sciConfig Configuration for the slow control interface

function CaribouDevice link

  CaribouDevice(
    const config::Configuration config,
    const typename SCI::configuration_type sciConfig,
    const typename DRI::configuration_type driConfig
)
  

Default constructor for Caribou devices with the Data readout interface.

Parameters:

• config Configuration object
• sciConfig Configuration for the slow control interface
• driConfig Configuration for the data readout interface

function getFirmwareVersion link

  virtual std::string getFirmwareVersion() override
  

Return the firmware version string for reference.

Return: Peary software version string

Reimplements: peary::device::Device::getFirmwareVersion

function getName link

  inline virtual std::string getName() override
  

Return the human-readable device name.

Return: Device name

Reimplements: peary::device::Device::getName

function getType link

  virtual std::string getType() override
  

Return the human-readable device type.

Return: Device type

Reimplements: peary::device::Device::getType

function getBoardID link

  uint8_t getBoardID()
  

Return the identifier of the installed board.

Return: Board ID

function getChipID link

  inline uint16_t getChipID()
  

Read the ID from the chip board if available.

Return: Chip ID, 0 if not available

Some chip boards feature an EPROM which stores a board ID and thus allows identification of the attached chip board.

function getDeviceName link

  std::string getDeviceName()
  

Return the human-readable device name of the firmware currently loaded.

Return: Device name

function powerOn link

  virtual void powerOn() override
  

Call the device’s powerUp() function and toggle the powered state.

Reimplements: peary::device::Device::powerOn

function powerUp link

  virtual void powerUp() =0
  

Turn on the power supply for the attached device.

function powerOff link

  virtual void powerOff() override
  

Call the device’s powerDown() function and toggle the powered state.

Reimplements: peary::device::Device::powerOff

function powerDown link

  virtual void powerDown() =0
  

Turn off power for the attached device.

function daqStart link

  virtual void daqStart() override =0
  

Start the data acquisition.

Reimplements: peary::device::Device::daqStart

function daqStop link

  virtual void daqStop() override =0
  

Stop the data acquisition.

Reimplements: peary::device::Device::daqStop

function configure link

  virtual void configure() override
  

Configure the device after power-up.

Reimplements: peary::device::Device::configure

function setRegister link

  virtual void setRegister(
    std::string name,
    uintptr_t value
) override
  

Set a register on this device.

Parameters:

• name Name of the register
• value Value to be set

Reimplements: peary::device::Device::setRegister

function setSpecialRegister link

  inline virtual void setSpecialRegister(
    const std::string & ,
    uintptr_t 
)
  

Set a special register on this device.

function getSpecialRegister link

  inline virtual uintptr_t getSpecialRegister(
    const std::string & 
)
  

Get a special register on this device.

function getRegister link

  virtual uintptr_t getRegister(
    std::string name
) override
  

Get a register from this device.

Parameters:

• name Name of the register

Return: Value of the register

Reimplements: peary::device::Device::getRegister

function getRegisters link

  virtual std::vector< std::pair< std::string, uintptr_t > > getRegisters() override
  

Get all registers from this device.

Return: Vector with pairs of register name and value

Reimplements: peary::device::Device::getRegisters

function reset link

  virtual void reset() override
  

Sending reset signal to the device.

Reimplements: peary::device::Device::reset

function setVoltage link

  virtual void setVoltage(
    const std::string & name,
    double voltage
) override
  

Set voltage and current limit on the board resource.

Parameters:

• name Name of the resource
• voltage Voltage to be set in V

Reimplements: peary::device::Device::setVoltage

function setCurrentLimit link

  virtual void setCurrentLimit(
    const std::string & name,
    double current_limit
) override
  

Set current limit on the board resource.

Parameters:

• name Name of the resource
• current_limit current limit to be set in A

Reimplements: peary::device::Device::setCurrentLimit

function setCurrent link

  virtual void setCurrent(
    const std::string & name,
    double current,
    utils::Polarity polarity
) override
  

Configure board current source.

Parameters:

• name Name of the current source
• current Current to be set in A
• polarity Polarity of the source, HIGH or LOW

Reimplements: peary::device::Device::setCurrent

function switchOn link

  inline virtual void switchOn(
    const std::string & name
) override
  

Switch on the given board resource.

Parameters:

• name Name of the resource

Reimplements: peary::device::Device::switchOn

function switchOff link

  inline virtual void switchOff(
    const std::string & name
) override
  

Switch off the given board resource.

Parameters:

• name Name of the resource

Reimplements: peary::device::Device::switchOff

function getVoltage link

  virtual double getVoltage(
    const std::string & name
) override
  

Get voltage of the given board resource.

Parameters:

• name Name of the resource

Return: Voltage in V

Reimplements: peary::device::Device::getVoltage

function getCurrent link

  virtual double getCurrent(
    const std::string & name
) override
  

Get current from the given board resource.

Parameters:

• name Name of the resource

Return: Current in A

Reimplements: peary::device::Device::getCurrent

function getPower link

  virtual double getPower(
    const std::string & name
) override
  

Get power consumption of the given board resource.

Parameters:

• name Name of the resource

Return: Power in W

Reimplements: peary::device::Device::getPower

function getAlertStatus link

  bool getAlertStatus(
    const std::string & name
)
  

Get alert status from the given board resource.

Parameters:

• name Name of the resource

Return: Alert status, true if alert is active

function getTemperature link

  double getTemperature(
    const std::string & name
)
  

Get temperature from the given board resource.

Parameters:

• name Name of the resource

Return: Temperature in degree Celsius

function configureClock link

  virtual void configureClock(
    const std::string & name,
    const std::any & config
) override
  

Configure a clock output on the board.

Parameters:

• name Name of the resource
• config Configuration object for the clock

Reimplements: peary::device::Device::configureClock

function disableClock link

  virtual void disableClock(
    const std::string & name
) override
  

Disable a clock output on the board.

Parameters:

• name Name of the resource

Reimplements: peary::device::Device::disableClock

function isClockLocked link

  virtual bool isClockLocked(
    const std::string & name
) override
  

Check if a clock output is locked.

Parameters:

• name Name of the resource

Return: True if the clock is locked, false otherwise

Reimplements: peary::device::Device::isClockLocked

function setClockFrequency link

  virtual void setClockFrequency(
    const std::string & name,
    uint64_t frequency
) override
  

Set frequency of a clock output on the board.

Parameters:

• name Name of the resource
• frequency Frequency in Hz

Reimplements: peary::device::Device::setClockFrequency

function listMemories link

  virtual std::vector< std::string > listMemories() override
  

List all memory registers.

Return: Vector with names of all available memory pages

Reimplements: peary::device::Device::listMemories

List all memory registers (accessed through memory pages mapping) known to this device

function listRegisters link

  virtual std::vector< std::string > listRegisters() override
  

List all registers known to this device.

Return: Vector with names of all available registers

Reimplements: peary::device::Device::listRegisters

function listResources link

  virtual std::vector< std::pair< std::string, std::string > > listResources() override
  

List all periphery components and their types registered by this device.

Return: Vector with pairs of component name and component type

Reimplements: peary::device::Device::listResources

function getRawData link

  virtual utils::pearyRawData getRawData() override
  

Raw and decoded data readback.

Return: Raw data structure

Reimplements: peary::device::Device::getRawData

function getRawData link

  virtual utils::pearyRawDataVector getRawData(
    const unsigned int noFrames
) override
  

Raw and decoded data readback.

Parameters:

• noFrames Number of frames to be read

Return: Vector of raw data frames

Reimplements: peary::device::Device::getRawData

function getData link

  virtual utils::pearydata getData() override
  

Raw and decoded data readback.

Return: Decoded data structure

Reimplements: peary::device::Device::getData

function getData link

  virtual utils::pearydataVector getData(
    const unsigned int noFrames
) override
  

Raw and decoded data readback.

Parameters:

• noFrames Number of frames to be read

Return: Vector of decoded data frames

Reimplements: peary::device::Device::getData

function setMemory link

  virtual void setMemory(
    const std::string & name,
    size_t offset,
    uintptr_t value
) override
  

Set memory register on this device.

Parameters:

• name Name of the memory register
• offset Offset to be applied to the base address of the memory register
• value Value to be set

Reimplements: peary::device::Device::setMemory

function setMemory link

  virtual void setMemory(
    const std::string & name,
    uintptr_t value
) override
  

Set memory register on this device.

Parameters:

• name Name of the memory register
• value Value to be set

Reimplements: peary::device::Device::setMemory

function getMemory link

  template <typename D  =uintptr_t>
virtual D getMemory(
    const std::string & name,
    size_t offset
)
  

Get memory register from this device.

Parameters:

• name Name of the memory register
• offset Offset to be applied to the base address of the memory register

Return: Value of the register

Reimplements: peary::device::Device::getMemory

function getMemory link

  inline virtual uintptr_t getMemory(
    const std::string & name,
    size_t offset
) override
  

Get memory register from this device.

Parameters:

• name Name of the memory register
• offset Offset to be applied to the base address of the memory register

Return: Value of the register

Reimplements: peary::device::Device::getMemory

function getMemory link

  template <typename D  =uintptr_t>
virtual D getMemory(
    const std::string & name
)
  

Get memory register from this device.

Parameters:

• name Name of the memory register

Return: Value of the register

Reimplements: peary::device::Device::getMemory

function getMemory link

  inline virtual uintptr_t getMemory(
    const std::string & name
) override
  

Get memory register from this device.

Parameters:

• name Name of the memory register

Return: Value of the register

Reimplements: peary::device::Device::getMemory

function getMemories link

  virtual std::vector< std::pair< std::string, uintptr_t > > getMemories() override
  

Get all memory registers from this device.

Return: Vector with pairs of memory name and value

Reimplements: peary::device::Device::getMemories

Protected Functions Documentation link

function register_resource link

  void register_resource(
    const std::string & name,
    const std::string & resource
)
  

Register a resource with the device.

Parameters:

• name Name of the resource
• resource Name of the resource to be associated

This function registers a resource with the device, which can be used to control the device’s periphery components, such as voltage regulators, ADCs, etc.

function process_register_write link

  void process_register_write(
    utils::register_t< typename SCI::reg_type, typename SCI::data_type > reg,
    uintptr_t value
)
  

Process writing to registers, ignoring special flags.

Parameters:

• reg Register to be written
• value Value of the register to be set

function process_register_read link

  uintptr_t process_register_read(
    utils::register_t< typename SCI::reg_type, typename SCI::data_type > reg
)
  

Process reading from registers, ignoring special flags.

Parameters:

• reg Register to be read

Return: Value of the register

function send link

  SCI::data_type send(
    const typename SCI::data_type & data
)
  

Write data to a device which does not contain internal register.

Parameters:

• data Data to be sent

Return: Data read back if readout is integral part of write operations

function send link

  SCI::dataVector_type send(
    const std::vector< typename SCI::data_type > & data
)
  

Write data to a device which does not contain internal register.

Parameters:

• data Data to be sent

Return: Data read back if readout is integral part of write operations

function send link

  std::pair< typename SCI::reg_type, typename SCI::data_type > send(
    const std::pair< typename SCI::reg_type, typename SCI::data_type > & data
)
  

Send data to a device containing internal registers.

Parameters:

• data Pair of register address and data to be sent

Return: Pair of register address and data read back if readout is integral part of write operations

function send link

  SCI::dataVector_type send(
    const typename SCI::reg_type & reg,
    const std::vector< typename SCI::data_type > & data
)
  

Send data to a device containing internal registers.

Parameters:

• reg Register address to which data is to be sent
• data Data to be sent

Return: Data read back if readout is integral part of write operations

function send link

  std::vector< std::pair< typename SCI::reg_type, typename SCI::data_type > > send(
    const std::vector< std::pair< typename SCI::reg_type, typename SCI::data_type >> & data
)
  

Send data to a device containing internal registers.

Parameters:

• data Vector of pairs of register address and data to be sent

Return: Vector of pairs of register address and data read back if readout is integral part of write operations

function receive link

  SCI::dataVector_type receive(
    const typename SCI::reg_type reg,
    const unsigned int length =1
)
  

Receive data from a device which does not contain internal register.

Parameters:

• reg Register address from which data is to be read
• length Number of data words to be read

Return: Data read back

function receiveData link

  DRI::dataVector_type receiveData(
    const unsigned int length =1
)
  

Receive data from a device which does not contain internal register.

Parameters:

• length Number of data words to be read

Return: Data read back

function receiveData link

  DRI::dataVector_type receiveData(
    const typename DRI::reg_type reg,
    const unsigned int length =1
)
  

Receive data from a device containing internal registers.

Parameters:

• reg Register address from which data is to be read
• length Number of data words to be read

Return: Data read back

function obey_mask_write link

  template <typename reg_type ,
typename data_type >
data_type obey_mask_write(
    utils::register_t< reg_type, data_type > reg,
    data_type regval,
    data_type regcurrval
) const
  

Apply mask on the write regval.

Parameters:

• reg Register to be written
• regval Value to be written
• regcurrval Current value of the register

Return: New value to be written

function obey_mask_read link

  template <typename reg_type ,
typename data_type >
data_type obey_mask_read(
    utils::register_t< reg_type, data_type > reg,
    data_type regval
) const
  

Apply mask on the read regval.

Parameters:

• reg Register to be read
• regval Value read from the register

Return: New value to be returned

Protected Attributes Documentation link

variable _board link

  std::shared_ptr< B > _board;
  

Instance of the Caribou Board abstraction layer library All register and hardware access should go through this interface.

variable _config link

  config::Configuration _config;
  

Device configuration object

variable _register_cache link

  std::map< std::string, typename SCI::data_type > _register_cache;
  

Register cache

variable _sciConfig link

  const SCI::configuration_type _sciConfig;
  

Slow control interface configuration

variable _driConfig link

  const DRI::configuration_type _driConfig;
  

Data Readout interface configuration

Updated on 2025-11-14 at 11:31:23 +0100