RMM API 2.0.0
Loading...
Searching...
No Matches
RMMInfos Class Reference

Class responsible for retrieving RMM firmware and register bank version info. More...

#include <RMMInformations.h>

Collaboration diagram for RMMInfos:

Public Member Functions

 RMMInfos (RMMRegisterAccess &RMMRegs)
 Constructor to RMMInfos.
 
rmmStatus getFirmwareInfo (std::unordered_map< std::string, std::string > *info)
 Gets the firmware information, including FPGA DNA, git hash, and build time.
 
rmmStatus getRegBankVersion (RegBankVersion *banks)
 Gets the register bank version details for the different register banks.
 

Public Attributes

RMMLog rmmLog
 Log handler for RMMInfos messages.
 

Detailed Description

Class responsible for retrieving RMM firmware and register bank version info.

This class interacts with the RMM registers and logs information regarding firmware and register bank versions.

Constructor & Destructor Documentation

◆ RMMInfos()

RMMInfos::RMMInfos ( RMMRegisterAccess & RMMRegs)

Constructor to RMMInfos.

Parameters
RMMRegsReference to the RMMRegisterAccess object used for register access.

Member Function Documentation

◆ getFirmwareInfo()

rmmStatus RMMInfos::getFirmwareInfo ( std::unordered_map< std::string, std::string > * info)

Gets the firmware information, including FPGA DNA, git hash, and build time.

Parameters
[out]infoPointer to a std::unordered_map<std::string, std::string> to store the firmware information. The map will contain:
  • "vcu118_dna": Hex string of RMM FPGA DNA (96-bit internal serial number).
  • "git_hash": Hex string of the first 96 bits of the 'dgro_master' git hash.
  • "build_time": Build time of RMM firmware in human-readable format.
Returns
rmmStatus indicating success or failure.

◆ getRegBankVersion()

rmmStatus RMMInfos::getRegBankVersion ( RegBankVersion * banks)

Gets the register bank version details for the different register banks.

Parameters
[out]banksPointer to a RegBankVersion structure where the register bank versions will be populated.
Returns
rmmStatus indicating success or failure.

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