CdtDreamAPI Class Reference

Inheritance diagram for CdtDreamAPI:

Collaboration diagram for CdtDreamAPI:

Public Member Functions
	CdtDreamAPI (RMMAPI *rmmApi, int ring, int node, std::string name)
	Constructor for the CdtDreamAPI class.
void	configFE ()
void	resetCore ()
uint64_t	readUid (rmmStatus *status=NULL, uint32_t timeout=100)
	Tries to read UID for some time. If it fails, return rmmError in status.
rmmStatus	writeSim (bool enable, uint32_t pause_cycles=0)
	Starts or stops simulated data.
rmmStatus	readSimParams (SimInfo &simInfo)
	Reads registers telling the simulation params.
double	readXADCTemperature ()
	Converts XADC raw value to temperature (in Celsius) using transfer function.
Public Member Functions inherited from CdtCDRE
	CdtCDRE (std::string name)
uint8_t	getMaxCipix () const
std::string	getFwAlias () const
void	fetchFwInfo ()
RMMResult	cipixRegRead (int cipixIdx, std::string reg)
	Reads a value from a cipix register.
RMMResult	cipixRegWrite (int cipixIdx, std::string, uint8_t wdata)
	Writes a value to a cipix register and returns the read value.
Public Member Functions inherited from CdtBaseAPI
	CdtBaseAPI (RMMAPI *rmmApi, int ring, int node, std::string name, FENRegMap additional_reg_map)
	Constructor for the Cdt class.
void	configAcquireTime (uint64_t cycles)
	Sets the acquisition time. Executed inside configFE right before starting the acquisition.
void	measurementEnable (bool enable)
	Enables or disables the measurement process.
bool	isMeasRunning ()
	Checks if the measurement is currently running.

Public Attributes
RMMLog	cdtDreamLog

Additional Inherited Members
Public Types inherited from CdtCDRE
using	CipixPair = std::pair<std::string, uint8_t>
using	CipixVector = std::vector<CipixPair>
using	FwMap = std::map<std::string, FwInfo>
Static Public Member Functions inherited from CdtCDRE
static const CipixVector &	getCipixMap ()
Protected Attributes inherited from CdtCDRE
uint8_t	maxCipix
std::string	fwAlias = "Undefined"

Constructor & Destructor Documentation

CdtDreamAPI()

CdtDreamAPI::CdtDreamAPI	(	RMMAPI *	rmmApi,
		int	ring,
		int	node,
		std::string	name )

Constructor for the CdtDreamAPI class.

Initializes a new instance of the CdtDreamAPI class by calling the base classes FrontEndBase and CdtCDRE constructors.

Parameters

[in]	rmmApi	Pointer to the RMMAPI instance used for communication and management of the RMM.
[in]	ring	The ring number.
[in]	node	The node number.
[in]	name	The name to identify the front-end instance.

Member Function Documentation

readSimParams()

rmmStatus CdtDreamAPI::readSimParams

(

SimInfo &

simInfo

)

Reads registers telling the simulation params.

Parameters

simInfo

Struct to be filled with current simulation parameters.

Returns

rmmStatus. If non-zero, then reading failed.

readUid()

uint64_t CdtDreamAPI::readUid	(	rmmStatus *	status = NULL,
		uint32_t	timeout = 100 )

Tries to read UID for some time. If it fails, return rmmError in status.

Parameters

[in]

timeout

timeout in milliseconds to keep trying if status_uid_error returns something different than 0.

Returns

RMMResult.

See also

RMMResult

readXADCTemperature()

double CdtDreamAPI::readXADCTemperature

(

)

Converts XADC raw value to temperature (in Celsius) using transfer function.

See also

https://docs.amd.com/r/qOeib0vlzXa1isUAfuFzOQ/k~CVcrTI5YXEUXVL5p8leQ?section=XREF_93944_Equation1_1

writeSim()

rmmStatus CdtDreamAPI::writeSim	(	bool	enable,
		uint32_t	pause_cycles = 0 )

Starts or stops simulated data.

Parameters

[in]	enable	true to activate simulated data. False to stop.
[in]	pause_cycles	Number of pauses cycles.

Returns

rmmStatus An enum indicating the status of the operation.

See also

rmmStatus

---

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

• include/CdtDreamAPI.h
• src/CdtDreamAPI.cpp