mirror of
https://github.com/nasa/fprime.git
synced 2025-12-10 00:44:37 -06:00
c69ff72110
* Format Svc and add to CI * Fix comlogger include * fix assert UTs * Fix static analysis warning * formatting
238 lines
9.6 KiB
C++
238 lines
9.6 KiB
C++
// ======================================================================
|
|
// \title Version.cpp
|
|
// \author sreddy
|
|
// \brief cpp file for Version component implementation class
|
|
// ======================================================================
|
|
|
|
#include "Svc/Version/Version.hpp"
|
|
#include "Fw/FPrimeBasicTypes.hpp"
|
|
|
|
#include "versions/version.hpp" //autogenerated file containing hardcoded project and framework versions
|
|
|
|
namespace Svc {
|
|
|
|
// ----------------------------------------------------------------------
|
|
// Component construction and destruction
|
|
// ----------------------------------------------------------------------
|
|
|
|
Version ::Version(const char* const compName)
|
|
: VersionComponentBase(compName), m_enable(false), m_num_custom_elements(0) {
|
|
Fw::String version_string = "no_ver";
|
|
// initialize all custom entries
|
|
for (FwIndexType id = 0; id < Svc::VersionCfg::VersionEnum::NUM_CONSTANTS; id++) {
|
|
// setVersion_enum is by default set to the first enum value, so not setting it here
|
|
this->verId_db[id].set_version_value(version_string);
|
|
this->verId_db[id].set_version_status(VersionStatus::FAILURE);
|
|
}
|
|
}
|
|
|
|
Version ::~Version() {}
|
|
|
|
void Version::config(bool enable) {
|
|
// Set Verbosity for custom versions
|
|
this->m_enable = enable;
|
|
|
|
// Setup and send startup TLM
|
|
this->fwVersion_tlm();
|
|
this->projectVersion_tlm();
|
|
this->libraryVersion_tlm();
|
|
}
|
|
// ----------------------------------------------------------------------
|
|
// Handler implementations for user-defined typed input ports
|
|
// ----------------------------------------------------------------------
|
|
|
|
void Version ::getVersion_handler(FwIndexType portNum,
|
|
const Svc::VersionCfg::VersionEnum& version_id,
|
|
Fw::StringBase& version_string,
|
|
Svc::VersionStatus& status) {
|
|
FW_ASSERT(version_id.isValid(), version_id.e);
|
|
U8 version_slot = VersionSlot(version_id.e);
|
|
version_string = this->verId_db[version_slot].get_version_value();
|
|
status = this->verId_db[version_slot].get_version_status();
|
|
}
|
|
|
|
void Version ::setVersion_handler(FwIndexType portNum,
|
|
const Svc::VersionCfg::VersionEnum& version_id,
|
|
Fw::StringBase& version_string,
|
|
Svc::VersionStatus& status) {
|
|
FW_ASSERT(version_id.isValid(), version_id.e);
|
|
VersionSlot ver_slot = VersionSlot(version_id.e);
|
|
this->verId_db[ver_slot].set_version_enum(version_id);
|
|
this->verId_db[ver_slot].set_version_value(version_string);
|
|
this->verId_db[ver_slot].set_version_status(status);
|
|
this->m_num_custom_elements++;
|
|
this->customVersion_tlm(ver_slot);
|
|
}
|
|
|
|
// ----------------------------------------------------------------------
|
|
// Handler implementations for commands
|
|
// ----------------------------------------------------------------------
|
|
|
|
void Version ::ENABLE_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, Svc::VersionEnabled enable) {
|
|
this->m_enable = (enable == VersionEnabled::ENABLED);
|
|
|
|
this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
|
|
}
|
|
|
|
// Command handler to event versions
|
|
void Version ::VERSION_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, Svc::VersionType version_type) {
|
|
FW_ASSERT(version_type.isValid(), version_type.e);
|
|
|
|
switch (version_type) {
|
|
case (Svc::VersionType::PROJECT):
|
|
this->projectVersion_tlm();
|
|
break;
|
|
|
|
case (Svc::VersionType::FRAMEWORK):
|
|
this->fwVersion_tlm();
|
|
break;
|
|
|
|
case (Svc::VersionType::LIBRARY):
|
|
this->libraryVersion_tlm();
|
|
break;
|
|
|
|
case (Svc::VersionType::CUSTOM):
|
|
this->customVersion_tlm_all();
|
|
break;
|
|
|
|
case (Svc::VersionType::ALL):
|
|
this->projectVersion_tlm();
|
|
this->fwVersion_tlm();
|
|
this->libraryVersion_tlm();
|
|
this->customVersion_tlm_all();
|
|
break;
|
|
default:
|
|
FW_ASSERT(0, version_type);
|
|
break;
|
|
}
|
|
|
|
this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
|
|
}
|
|
// ----------------------------------------------------------------------
|
|
// implementations for internal functions
|
|
// ----------------------------------------------------------------------
|
|
// Send both events and tlm for framework version
|
|
void Version ::fwVersion_tlm() {
|
|
Fw::LogStringArg fw_event = (Project::Version::FRAMEWORK_VERSION);
|
|
this->log_ACTIVITY_LO_FrameworkVersion(fw_event);
|
|
Fw::TlmString fw_tlm = (Project::Version::FRAMEWORK_VERSION);
|
|
this->tlmWrite_FrameworkVersion(fw_tlm);
|
|
}
|
|
|
|
// Send both events and tlm for project version
|
|
void Version ::projectVersion_tlm() {
|
|
Fw::LogStringArg proj_event = Project::Version::PROJECT_VERSION;
|
|
this->log_ACTIVITY_LO_ProjectVersion(proj_event);
|
|
Fw::TlmString proj_tlm = Project::Version::PROJECT_VERSION;
|
|
this->tlmWrite_ProjectVersion(proj_tlm);
|
|
}
|
|
|
|
// Send both events and tlm for library versions
|
|
void Version ::libraryVersion_tlm() {
|
|
// Process libraries array
|
|
for (U8 i = 0; i < Project::Version::LIBRARY_VERSIONS_COUNT; i++) {
|
|
// Emit Event/TLM on library versions
|
|
this->log_ACTIVITY_LO_LibraryVersions(Fw::LogStringArg(Project::Version::LIBRARY_VERSIONS[i]));
|
|
// Write to Events
|
|
switch (i) {
|
|
case VER_SLOT_00:
|
|
this->tlmWrite_LibraryVersion01(Fw::TlmString(Project::Version::LIBRARY_VERSIONS[i]));
|
|
break;
|
|
case VER_SLOT_01:
|
|
this->tlmWrite_LibraryVersion02(Fw::TlmString(Project::Version::LIBRARY_VERSIONS[i]));
|
|
break;
|
|
case VER_SLOT_02:
|
|
this->tlmWrite_LibraryVersion03(Fw::TlmString(Project::Version::LIBRARY_VERSIONS[i]));
|
|
break;
|
|
case VER_SLOT_03:
|
|
this->tlmWrite_LibraryVersion04(Fw::TlmString(Project::Version::LIBRARY_VERSIONS[i]));
|
|
break;
|
|
case VER_SLOT_04:
|
|
this->tlmWrite_LibraryVersion05(Fw::TlmString(Project::Version::LIBRARY_VERSIONS[i]));
|
|
break;
|
|
case VER_SLOT_05:
|
|
this->tlmWrite_LibraryVersion06(Fw::TlmString(Project::Version::LIBRARY_VERSIONS[i]));
|
|
break;
|
|
case VER_SLOT_06:
|
|
this->tlmWrite_LibraryVersion07(Fw::TlmString(Project::Version::LIBRARY_VERSIONS[i]));
|
|
break;
|
|
case VER_SLOT_07:
|
|
this->tlmWrite_LibraryVersion08(Fw::TlmString(Project::Version::LIBRARY_VERSIONS[i]));
|
|
break;
|
|
case VER_SLOT_08:
|
|
this->tlmWrite_LibraryVersion09(Fw::TlmString(Project::Version::LIBRARY_VERSIONS[i]));
|
|
break;
|
|
case VER_SLOT_09:
|
|
this->tlmWrite_LibraryVersion10(Fw::TlmString(Project::Version::LIBRARY_VERSIONS[i]));
|
|
break;
|
|
default:
|
|
// It is possible to have more than 10 library versions; however design agreed to only
|
|
// provide 10 TLM channels for it
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Send all events and tlm (if verbosity is enabled) for custom versions
|
|
void Version ::customVersion_tlm_all() {
|
|
for (U8 i = 0;
|
|
(m_enable == true) && (m_num_custom_elements != 0) && (i < Svc::VersionCfg::VersionEnum::NUM_CONSTANTS); i++) {
|
|
Version::customVersion_tlm(VersionSlot(i));
|
|
}
|
|
}
|
|
|
|
// Send events and tlm (if verbosity is enabled) for custom versions
|
|
void Version ::customVersion_tlm(VersionSlot custom_slot) {
|
|
// Process custom version TLM only if verbosity is enabled and there are any valid writes to it;
|
|
// it doesn't necessarily have to be consecutive
|
|
if ((this->verId_db[custom_slot].get_version_value() != "no_ver") &&
|
|
(this->m_num_custom_elements > 0)) { // Write TLM for valid writes
|
|
|
|
// Emit Events/TLM on custom versions
|
|
this->log_ACTIVITY_LO_CustomVersions(this->verId_db[custom_slot].get_version_enum(),
|
|
this->verId_db[custom_slot].get_version_value());
|
|
|
|
if (m_enable == true) { // Send TLM only if verbosity is enabled
|
|
// Write to TLM
|
|
switch (custom_slot) {
|
|
case VER_SLOT_00:
|
|
this->tlmWrite_CustomVersion01(verId_db[custom_slot]);
|
|
break;
|
|
case VER_SLOT_01:
|
|
this->tlmWrite_CustomVersion02(verId_db[custom_slot]);
|
|
break;
|
|
case VER_SLOT_02:
|
|
this->tlmWrite_CustomVersion03(verId_db[custom_slot]);
|
|
break;
|
|
case VER_SLOT_03:
|
|
this->tlmWrite_CustomVersion04(verId_db[custom_slot]);
|
|
break;
|
|
case VER_SLOT_04:
|
|
this->tlmWrite_CustomVersion05(verId_db[custom_slot]);
|
|
break;
|
|
case VER_SLOT_05:
|
|
this->tlmWrite_CustomVersion06(verId_db[custom_slot]);
|
|
break;
|
|
case VER_SLOT_06:
|
|
this->tlmWrite_CustomVersion07(verId_db[custom_slot]);
|
|
break;
|
|
case VER_SLOT_07:
|
|
this->tlmWrite_CustomVersion08(verId_db[custom_slot]);
|
|
break;
|
|
case VER_SLOT_08:
|
|
this->tlmWrite_CustomVersion09(verId_db[custom_slot]);
|
|
break;
|
|
case VER_SLOT_09:
|
|
this->tlmWrite_CustomVersion10(verId_db[custom_slot]);
|
|
break;
|
|
default:
|
|
// There are only 10 custom slots available
|
|
FW_ASSERT(0, custom_slot);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
} // namespace Svc
|