#include <UioBackend.h>

Inheritance diagram for ChimeraTK::UioBackend:

Collaboration diagram for ChimeraTK::UioBackend:

Public Member Functions
	UioBackend (std::string deviceName, std::string mapFileName)

	~UioBackend () override

void	open () override
	Open the device. More...

void	closeImpl () override
	All backends derrived from NumericAddressedBackend must implement closeImpl() instead of close. More...

size_t	minimumTransferAlignment ([[maybe_unused]] uint64_t bar) const override
	Determines the supported minimum alignment for any read/write requests. More...

bool	barIndexValid (uint64_t bar) override
	Function to be implemented by the backends. More...

void	read (uint64_t bar, uint64_t address, int32_t *data, size_t sizeInBytes) override
	Read function to be implemented by backends. More...

void	write (uint64_t bar, uint64_t address, int32_t const *data, size_t sizeInBytes) override
	Write function to be implemented by backends. More...

std::future< void >	activateSubscription (uint32_t interruptNumber, boost::shared_ptr< async::DomainImpl< std::nullptr_t >> asyncDomain) override
	Activate/create the subscription for a given interrupt (for instance by starting the according interrupt handling thread). More...

std::string	readDeviceInfo () override
	Return a device information string containing hardware details like the firmware version number or the slot number used by the board. More...

Public Member Functions inherited from ChimeraTK::NumericAddressedBackend
	NumericAddressedBackend (const std::string &mapFileName="", std::unique_ptr< NumericAddressedRegisterCatalogue > registerMapPointer=std::make_unique< NumericAddressedRegisterCatalogue >())

	~NumericAddressedBackend () override=default

virtual void	read ([[maybe_unused]] uint8_t bar, [[maybe_unused]] uint32_t address, [[maybe_unused]] int32_t *data, [[maybe_unused]] size_t sizeInBytes)
	Deprecated read function using 32bit address for backwards compatibility. More...

virtual void	write ([[maybe_unused]] uint8_t bar, [[maybe_unused]] uint32_t address, [[maybe_unused]] int32_t const *data, [[maybe_unused]] size_t sizeInBytes)
	Deprecated write function using 32bit address for backwards compatibility. More...

virtual bool	canMergeRequests () const
	Determines whether the backend supports merging of requests (read or write) More...

RegisterCatalogue	getRegisterCatalogue () const override
	Return the register catalogue with detailed information on all registers. More...

MetadataCatalogue	getMetadataCatalogue () const override
	Return the device metadata catalogue. More...

NumericAddressedRegisterInfo	getRegisterInfo (const RegisterPath &registerPathName)
	getRegisterInfo returns a NumericAddressedRegisterInfo object for the given register. More...

void	activateAsyncRead () noexcept override
	Activate asyncronous read for all transfer elements where AccessMode::wait_for_new_data is set. More...

void	close () final
	Deactivates all asynchronous accessors and calls closeImpl(). More...

void	setExceptionImpl () noexcept override
	Turn off the internal variable which remembers that async is active. More...

template<typename BackendSpecificUserType >
std::pair< BackendSpecificUserType, VersionNumber >	getAsyncDomainInitialValue (size_t asyncDomainId)
	Get the initial value for a certain async::Domain. More...

template<typename BackendSpecificUserType >
std::pair< BackendSpecificUserType, VersionNumber >	getAsyncDomainInitialValue ([[maybe_unused]] size_t asyncDomainId)

Public Member Functions inherited from ChimeraTK::DeviceBackendImpl
bool	isOpen () override
	Return whether a device has been opened or not. More...

bool	isConnected () final
	Deprecated since 2022-03-03. More...

void	checkActiveException () final
	Function to be called by backends when needing to check for an active exception. More...

void	setException (const std::string &message) noexcept final
	Set the backend into an exception state. More...

bool	isFunctional () const noexcept final
	Return whether a device is working as intended, usually this means it is opened and does not have any errors. More...

std::string	getActiveExceptionMessage () noexcept

Public Member Functions inherited from ChimeraTK::DeviceBackend
virtual	~DeviceBackend ()=default
	Every virtual class needs a virtual desctructor. More...

template<typename UserType >
boost::shared_ptr< NDRegisterAccessor< UserType > >	getRegisterAccessor (const RegisterPath &registerPathName, size_t numberOfWords, size_t wordOffsetInRegister, AccessModeFlags flags)
	Get a NDRegisterAccessor object from the register name. More...

	DEFINE_VIRTUAL_FUNCTION_TEMPLATE_VTABLE (getRegisterAccessor_impl, boost::shared_ptr< NDRegisterAccessor< T >>(const RegisterPath &, size_t, size_t, AccessModeFlags))

Static Public Member Functions
static boost::shared_ptr< DeviceBackend >	createInstance (std::string address, std::map< std::string, std::string > parameters)

Public Attributes
boost::shared_ptr< async::DomainImpl< std::nullptr_t > >	_asyncDomain

Additional Inherited Members
Protected Member Functions inherited from ChimeraTK::DeviceBackendImpl
void	setOpenedAndClearException () noexcept
	Backends should call this function at the end of a (successful) open() call. More...

Protected Attributes inherited from ChimeraTK::NumericAddressedBackend
std::unique_ptr< NumericAddressedRegisterCatalogue >	_registerMapPointer

NumericAddressedRegisterCatalogue &	_registerMap

MetadataCatalogue	_metadataCatalogue
	metadata catalogue More...

std::mutex	_unalignedAccess
	mutex for protecting unaligned access More...

friend	NumericAddressedLowLevelTransferElement

friend	TriggeredPollDistributor

Protected Attributes inherited from ChimeraTK::DeviceBackendImpl
std::atomic< bool >	_opened {false}
	flag if backend is opened More...

async::DomainsContainer	_asyncDomainsContainer
	Container for async::Domains to support wait_for_new_data. More...

Detailed Description

Definition at line 12 of file UioBackend.h.

Constructor & Destructor Documentation

◆ UioBackend()

ChimeraTK::UioBackend::UioBackend	(	std::string	deviceName,
		std::string	mapFileName
	)

Definition at line 8 of file UioBackend.cc.

Here is the caller graph for this function:

◆ ~UioBackend()

ChimeraTK::UioBackend::~UioBackend ( )

override

Definition at line 12 of file UioBackend.cc.

Here is the call graph for this function:

Member Function Documentation

◆ activateSubscription()

std::future< void > ChimeraTK::UioBackend::activateSubscription	(	uint32_t	interruptNumber,
		boost::shared_ptr< async::DomainImpl< std::nullptr_t >>	asyncDomain
	)

overridevirtual

Activate/create the subscription for a given interrupt (for instance by starting the according interrupt handling thread).

A shared pointer to the async::Domain is handed as a parameter. The backend has to store it together with the subscription (usually as a weak pointer) and use it to distribute the interrupt.

A future is returned. It becomes ready when the subscription is actually active (e.g. from inside the an interrupt handling thread after the initialisation sequence with the hardware is done).

If the subscription already exists and is active, a ready future is returned.

The function has an empty default implementation which returns a ready future.

Reimplemented from ChimeraTK::NumericAddressedBackend.

Definition at line 67 of file UioBackend.cc.

Here is the call graph for this function:

◆ barIndexValid()

bool ChimeraTK::UioBackend::barIndexValid ( uint64_t bar )

overridevirtual

Function to be implemented by the backends.

Returns whether the given bar number is valid.

Reimplemented from ChimeraTK::NumericAddressedBackend.

Definition at line 49 of file UioBackend.cc.

◆ closeImpl()

void ChimeraTK::UioBackend::closeImpl ( )

overridevirtual

All backends derrived from NumericAddressedBackend must implement closeImpl() instead of close.

Like this it is assured that the deactivation of the asynchronous accessors is always executed.

Reimplemented from ChimeraTK::NumericAddressedBackend.

Definition at line 36 of file UioBackend.cc.

Here is the caller graph for this function:

◆ createInstance()

boost::shared_ptr< DeviceBackend > ChimeraTK::UioBackend::createInstance	(	std::string	address,
		std::map< std::string, std::string >	parameters
	)

static

Definition at line 16 of file UioBackend.cc.

Here is the call graph for this function:

◆ minimumTransferAlignment()

size_t ChimeraTK::UioBackend::minimumTransferAlignment ( [[maybe_unused] ] uint64_t bar ) const

inlineoverridevirtual

Determines the supported minimum alignment for any read/write requests.

If the backend expects a particular alignment for read()/write() calls it should return a value bigger than 1. The address and sizeInBytes arguments of the read()/write() calls will be always an integer multiple of this number. Any unaligned transfers will be changed to meet these criteria (additional padding data will be thrown away).

The default implementation returns 1, which means no special alignment is required.

Returns: Minimum alignment in bytes

Reimplemented from ChimeraTK::NumericAddressedBackend.

Definition at line 32 of file UioBackend.h.

◆ open()

void ChimeraTK::UioBackend::open ( )

overridevirtual

Open the device.

Implements ChimeraTK::DeviceBackend.

Definition at line 24 of file UioBackend.cc.

Here is the call graph for this function:

◆ read()

void ChimeraTK::UioBackend::read	(	uint64_t	bar,
		uint64_t	address,
		int32_t *	data,
		size_t	sizeInBytes
	)

overridevirtual

Read function to be implemented by backends.

TODO: Add documentation!

Reimplemented from ChimeraTK::NumericAddressedBackend.

Definition at line 53 of file UioBackend.cc.

Here is the call graph for this function:

◆ readDeviceInfo()

std::string ChimeraTK::UioBackend::readDeviceInfo ( )

overridevirtual

Return a device information string containing hardware details like the firmware version number or the slot number used by the board.

The format and contained information of this string is completely backend implementation dependent, so the string may only be printed to the user as an informational output. Do not try to parse this string or extract information from it programmatically.

Implements ChimeraTK::DeviceBackend.

Definition at line 88 of file UioBackend.cc.

Here is the call graph for this function:

◆ write()

void ChimeraTK::UioBackend::write	(	uint64_t	bar,
		uint64_t	address,
		int32_t const *	data,
		size_t	sizeInBytes
	)

overridevirtual

Write function to be implemented by backends.

TODO: Add documentation!

Reimplemented from ChimeraTK::NumericAddressedBackend.

Definition at line 60 of file UioBackend.cc.

Here is the call graph for this function:

Member Data Documentation

◆ _asyncDomain

boost::shared_ptr<async::DomainImpl<std::nullptr_t> > ChimeraTK::UioBackend::_asyncDomain

Definition at line 43 of file UioBackend.h.

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

/scratch/dragon/sources/ChimeraTK-DeviceAccess/backends/uio/include/UioBackend.h
/scratch/dragon/sources/ChimeraTK-DeviceAccess/backends/uio/src/UioBackend.cc

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UioBackend()

◆ ~UioBackend()

Member Function Documentation

◆ activateSubscription()

◆ barIndexValid()

◆ closeImpl()

◆ createInstance()

◆ minimumTransferAlignment()

◆ open()

◆ read()

◆ readDeviceInfo()

◆ write()

Member Data Documentation

◆ _asyncDomain