Precommit (#1)

* first commit

* cleanup
This commit is contained in:
tompzf
2025-11-04 13:28:06 +01:00
committed by GitHub
parent dba45dc636
commit 6ed4b1534e
898 changed files with 256340 additions and 0 deletions

View File

@@ -0,0 +1,65 @@
# Only build on MSVC/Windows or 64-bit Linux (not ARM)
if((WIN32 AND NOT MSVC) OR (UNIX AND CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64"))
# Define project
project(can_com_silkit VERSION 1.0 LANGUAGES CXX)
# Platform-specific SilKit flavor and library settings
if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
set(SILKIT_FLAVOR "ubuntu-18.04-x86_64-gcc" CACHE STRING "SIL Kit package flavor for Linux")
elseif(CMAKE_SYSTEM_NAME STREQUAL "Windows")
set(SILKIT_FLAVOR "Win-x86_64-VS2017" CACHE STRING "SIL Kit package flavor for Windows")
else()
message(FATAL_ERROR "Unsupported platform for SilKit build.")
endif()
set(SILKIT_VERSION "4.0.37" CACHE STRING "SIL Kit package is specified, this version will be downloaded")
message ("Build SilKit component on system: ${CMAKE_SYSTEM_PROCESSOR}")
# Fetch SIL Kit from github.com
message(STATUS "Attempting to fetch [SilKit-${SILKIT_VERSION}-${SILKIT_FLAVOR}] from github.com")
include(FetchContent)
FetchContent_Declare(
silkit
URL https://github.com/vectorgrp/sil-kit/releases/download/sil-kit%2Fv${SILKIT_VERSION}/SilKit-${SILKIT_VERSION}-${SILKIT_FLAVOR}.zip
DOWNLOAD_DIR ${CMAKE_CURRENT_LIST_DIR}/sil-kit
)
message(STATUS "SIL Kit: fetching [SilKit-${SILKIT_VERSION}-${SILKIT_FLAVOR}]")
FetchContent_MakeAvailable(silkit)
message(STATUS "SIL Kit: using source code from: \"${silkit_SOURCE_DIR}\"")
if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
set(SILKIT_LIB "${silkit_SOURCE_DIR}/SilKit/lib/libSilKit.so")
message(STATUS "Expecting libSilKit.so at: ${SILKIT_LIB}")
elseif(CMAKE_SYSTEM_NAME STREQUAL "Windows")
set(SILKIT_LIB "${silkit_SOURCE_DIR}/SilKit/lib/SilKit.lib")
message(STATUS "Expecting SilKit.lib at: ${SILKIT_LIB}")
else()
message(FATAL_ERROR "SilKit libraries not found at: ${SILKIT_LIB}. Check the SilKit flavor, version, and extraction path.")
endif()
set(SilKit_DIR "${silkit_SOURCE_DIR}/SilKit/lib/cmake/SilKit")
message(STATUS "SilKit_DIR: ${SilKit_DIR}")
find_package(SilKit REQUIRED CONFIG)
add_library(can_com_silkit SHARED "can_com_silkit.h" "can_com_silkit.cpp")
# Only add -Wno-shadow for GCC or Clang
if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU" OR CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
target_compile_options(can_com_silkit PRIVATE -Wno-shadow)
endif()
target_link_libraries(can_com_silkit PRIVATE "${SILKIT_LIB}" ${CMAKE_THREAD_LIBS_INIT})
target_include_directories(can_com_silkit PRIVATE "${silkit_SOURCE_DIR}/SilKit/include")
set_target_properties(can_com_silkit PROPERTIES PREFIX "")
set_target_properties(can_com_silkit PROPERTIES SUFFIX ".sdv")
add_dependencies(can_com_silkit CompileCoreIDL)
# Appending the service in the service list
set(SDV_Service_List ${SDV_Service_List} can_com_silkit PARENT_SCOPE)
endif() # SilKit library is not compatible for ARM and MINGW

View File

@@ -0,0 +1,549 @@
#include "can_com_silkit.h"
#include <support/toml.h>
#include <bitset>
void CCANSilKit::Initialize(const sdv::u8string& rssObjectConfig)
{
std::string silKitNetwork = "";
std::string silKitJSONConfigContent = "";
std::string silKitRegistryUri = "";
try
{
sdv::toml::CTOMLParser config(rssObjectConfig.c_str());
sdv::toml::CNode nodeSilKitConfig = config.GetDirect("SilKitConfig");
if (nodeSilKitConfig.GetType() == sdv::toml::ENodeType::node_string)
{
silKitJSONConfigContent = static_cast<std::string>(nodeSilKitConfig.GetValue());
}
sdv::toml::CNode nodeSilKitParticipant = config.GetDirect("SilKitParticipantName");
if (nodeSilKitParticipant.GetType() == sdv::toml::ENodeType::node_string)
{
m_SilKitParticipantName = static_cast<std::string>(nodeSilKitParticipant.GetValue());
}
sdv::toml::CNode nodeSilKitNetwork = config.GetDirect("CanSilKitNetwork");
if (nodeSilKitNetwork.GetType() == sdv::toml::ENodeType::node_string)
{
silKitNetwork = static_cast<std::string>(nodeSilKitNetwork.GetValue());
}
sdv::toml::CNode nodeSilKitRegistryURI = config.GetDirect("RegistryURI");
if (nodeSilKitRegistryURI.GetType() == sdv::toml::ENodeType::node_string)
{
silKitRegistryUri = static_cast<std::string>(nodeSilKitRegistryURI.GetValue());
}
sdv::toml::CNode nodeSilKitSyncMode = config.GetDirect("SyncMode");
if (nodeSilKitSyncMode.GetType() == sdv::toml::ENodeType::node_boolean)
{
m_SilKitIsSynchronousMode = static_cast<bool>(nodeSilKitSyncMode.GetValue());
}
}
catch (const sdv::toml::XTOMLParseException& e)
{
SDV_LOG_ERROR("Configuration could not be read: ", e.what());
m_eStatus = sdv::EObjectStatus::initialization_failure;
return;
}
m_TimerSimulationStep = sdv::core::GetObject<sdv::core::ITimerSimulationStep>("SimulationTaskTimerService");
if (!ValidateConfiguration(silKitJSONConfigContent, silKitNetwork, silKitRegistryUri))
{
m_eStatus = sdv::EObjectStatus::initialization_failure;
return;
}
if (!CreateSilKitConnection(silKitJSONConfigContent, silKitNetwork, silKitRegistryUri))
{
SDV_LOG_ERROR("Error createing SilKit connection, probably invalid JSON content");
m_eStatus = sdv::EObjectStatus::initialization_failure;
return;
}
// Update status only if initialization was successful
m_eStatus = sdv::EObjectStatus::initialized;
}
bool CCANSilKit::ValidateConfiguration(const std::string& ssSilKitJSONConfigContent, const std::string& ssSilKitNetwork, const std::string& ssSilKitRegistryUri)
{
bool success = true;
SDV_LOG_INFO("SilKit connecting to network: ", ssSilKitNetwork.c_str());
SDV_LOG_INFO("SilKit registry URI: ", ssSilKitRegistryUri.c_str());
m_SilKitIsSynchronousMode ? SDV_LOG_INFO("SilKit is running in synchronous mode.") : SDV_LOG_INFO("SilKit is running in asynchronous mode.");
m_TimerSimulationStep ? SDV_LOG_WARNING("Run simulation with simulation timer service.") : SDV_LOG_WARNING("Run simulation with real time service.");
if (ssSilKitJSONConfigContent.empty())
{
SDV_LOG_ERROR("Error reading config file content for SilKit, missing 'SilKitConfig'.");
success = false;
}
if (m_SilKitParticipantName.empty())
{
SDV_LOG_ERROR("SilKit CAN participant is not found in configuration, missing 'SilKitParticipantName'.");
success = false;
}
if (ssSilKitNetwork.empty())
{
SDV_LOG_ERROR("Error reading SilKit network name, missing 'CanSilKitNetwork'.");
success = false;
}
else
{
SDV_LOG_INFO("SilKit connecting to network: ", ssSilKitNetwork.c_str());
}
if (ssSilKitRegistryUri.empty())
{
SDV_LOG_ERROR("Error reading SilKit registry URI, missing 'RegistryURI'.");
success = false;
}
else
{
SDV_LOG_INFO("SilKit registry URI: ", ssSilKitRegistryUri.c_str());
}
if (!m_TimerSimulationStep)
{
SDV_LOG_WARNING("Run simulation with real timer.");
}
if (m_SilKitIsSynchronousMode)
{
SDV_LOG_INFO("SilKit is running in synchronous mode.");
}
else
{
SDV_LOG_INFO("SilKit is running in asynchronous mode.");
}
return success;
}
sdv::EObjectStatus CCANSilKit::GetStatus() const
{
return m_eStatus;
}
void CCANSilKit::SetOperationMode(sdv::EOperationMode eMode)
{
switch (eMode)
{
case sdv::EOperationMode::configuring:
if (m_eStatus == sdv::EObjectStatus::running || m_eStatus == sdv::EObjectStatus::initialized)
m_eStatus = sdv::EObjectStatus::configuring;
break;
case sdv::EOperationMode::running:
if (m_eStatus == sdv::EObjectStatus::configuring || m_eStatus == sdv::EObjectStatus::initialized)
m_eStatus = sdv::EObjectStatus::running;
break;
default:
break;
}
}
void CCANSilKit::Shutdown()
{
SDV_LOG_INFO("Initiating shutdown process...");
m_eStatus = sdv::EObjectStatus::shutdown_in_progress;
try
{
if (m_SilKitLifeCycleService)
{
SDV_LOG_INFO("Stopping SilKit Lifecycle Service...");
m_SilKitLifeCycleService->Stop("Shutdown requested.");
m_SilKitLifeCycleService = nullptr;
}
if (m_SilKitCanController)
{
SDV_LOG_INFO("Stopping SilKit CAN Controller...");
m_SilKitCanController->Stop();
m_SilKitCanController = nullptr;
}
if (m_SilKitParticipant)
{
SDV_LOG_INFO("Resetting SilKit Participant...");
m_SilKitParticipant.reset();
m_SilKitParticipant = nullptr;
}
}
catch (const SilKit::SilKitError& e)
{
SDV_LOG_ERROR("SilKit exception occurred during shutdown: ", e.what());
m_eStatus = sdv::EObjectStatus::runtime_error;
}
catch (const std::exception& e)
{
SDV_LOG_ERROR("Unknown exception occurred during shutdown: ", e.what());
m_eStatus = sdv::EObjectStatus::runtime_error;
}
std::lock_guard<std::mutex> lock(m_QueueMutex);
while (!m_MessageQueue.empty())
{
m_MessageQueue.pop();
}
}
void CCANSilKit::RegisterReceiver(/*in*/ sdv::can::IReceive* pReceiver)
{
if (m_eStatus != sdv::EObjectStatus::configuring)
return;
if (!pReceiver)
{
SDV_LOG_ERROR("No CAN receiver available.");
return;
}
SDV_LOG_INFO("Registering VAPI CAN communication receiver...");
std::unique_lock<std::mutex> lock(m_ReceiversMtx);
if (m_SetReceivers.find(pReceiver) == m_SetReceivers.end())
{
m_SetReceivers.insert(pReceiver);
SDV_LOG_INFO("Receiver registered successfully.");
}
else
{
SDV_LOG_INFO("Receiver is already registered.");
}
}
void CCANSilKit::UnregisterReceiver(/*in*/ sdv::can::IReceive* pReceiver)
{
// NOTE: Normally the remove function should be called in the configuration mode. Since it doesn't give
// feedback and the associated caller might delete any receiving function, allow the removal to take place even
// when running.
if (!pReceiver)
{
return;
}
SDV_LOG_INFO("Unregistering VAPI CAN communication receiver...");
std::unique_lock<std::mutex> lock(m_ReceiversMtx);
m_SetReceivers.erase(pReceiver);
}
sdv::sequence<sdv::u8string> CCANSilKit::GetInterfaces() const
{
sdv::sequence<sdv::u8string> seqIfcNames;
if (m_eStatus != sdv::EObjectStatus::running) return seqIfcNames;
seqIfcNames.push_back(m_SilKitParticipantName);
return seqIfcNames;
}
std::shared_ptr<SilKit::Config::IParticipantConfiguration> CCANSilKit::GetSilKitConfig(const std::string& ssSilKitJSONConfigContent)
{
// Get the SilKit configuration from the config file.
//auto silKitParticipantCconfig = std::move(SilKit::Config::ParticipantConfigurationFromString(ssSilKitJSONConfigContent));
auto silKitParticipantCconfig = SilKit::Config::ParticipantConfigurationFromString(ssSilKitJSONConfigContent);
if (silKitParticipantCconfig == nullptr)
{
SDV_LOG_ERROR("Error parsing the SilKit config content: ", ssSilKitJSONConfigContent.c_str());
return nullptr;
}
return silKitParticipantCconfig;
}
std::unique_ptr<SilKit::IParticipant> CCANSilKit::CreateParticipantFromJSONConfig(const std::string& ssSilKitJSONConfigContent, const std::string& ssSilKitRegistryUri)
{
auto silKitParticipantConfig = GetSilKitConfig(ssSilKitJSONConfigContent);
if (silKitParticipantConfig == nullptr)
{
SDV_LOG_ERROR("The SilKit configuaration file could not be opened.");
return nullptr;
}
// TODO: get participant name from the configuration
// participant name must be unique in the SilKit network setup and must exit before running thee test
// 1 single participant: use complete name from the config
// more than one channel: do we need more that on participants or can one participant include multiple channels?
// in case every single channel requires another participant name: add channel to the name ['config_name' + 'channel']
SDV_LOG_INFO("Creating SilKit participant: ", m_SilKitParticipantName.c_str());
return SilKit::CreateParticipant(silKitParticipantConfig, m_SilKitParticipantName, ssSilKitRegistryUri);
}
SilKit::Services::Can::ICanController* CCANSilKit::CreateController(const std::string& ssSilKitNetwork)
{
/* Create the SilKit CAN controller. */
SilKit::Services::Can::ICanController* silKitCanController = m_SilKitParticipant->CreateCanController(m_SilKitParticipantName, ssSilKitNetwork);
if (silKitCanController == nullptr)
{
SDV_LOG_ERROR("SilKit CAN controller is not available.");
return nullptr;
}
/* Register the SilKit transmit status handler (use lambda function to map to member variable). */
silKitCanController->AddFrameTransmitHandler(
[this](SilKit::Services::Can::ICanController* /*ctrl*/, const SilKit::Services::Can::CanFrameTransmitEvent& rs_transmit_acknowledge)
{
SilKitTransmitAcknowledgeHandler(rs_transmit_acknowledge);
},
static_cast<SilKit::Services::Can::CanTransmitStatusMask>(SilKit::Services::Can::CanTransmitStatus::Transmitted) |
static_cast<SilKit::Services::Can::CanTransmitStatusMask>(SilKit::Services::Can::CanTransmitStatus::Canceled) |
static_cast<SilKit::Services::Can::CanTransmitStatusMask>(SilKit::Services::Can::CanTransmitStatus::TransmitQueueFull));
/* Register the SilKit receive handler (use lambda function to map to member variable). */
silKitCanController->AddFrameHandler(
[this](SilKit::Services::Can::ICanController* /*ctrl*/, const SilKit::Services::Can::CanFrameEvent& rs_frame_event)
{
SilKitReceiveMessageHandler(rs_frame_event.frame);
},
static_cast<SilKit::Services::DirectionMask>(SilKit::Services::TransmitDirection::RX)
/*| static_cast<SilKit::Services::DirectionMask>(SilKit::Services::TransmitDirection::TX)*/);
return silKitCanController;
}
SilKit::Services::Orchestration::ILifecycleService* CCANSilKit::CreateSilKitLifecycleService()
{
SilKit::Services::Orchestration::OperationMode silkit_operationMode = (
m_SilKitIsSynchronousMode ? SilKit::Services::Orchestration::OperationMode::Coordinated
: SilKit::Services::Orchestration::OperationMode::Autonomous
);
return m_SilKitParticipant->CreateLifecycleService({ silkit_operationMode });
}
bool CCANSilKit::SetHandlerFunctions(SilKit::Services::Orchestration::ILifecycleService* silKitLifeCycleService)
{
try
{
// Set a SilKit Stop Handler
silKitLifeCycleService->SetStopHandler([this]()
{
m_eStatus = sdv::EObjectStatus::runtime_error;
SDV_LOG_INFO("SilKit StopHandlerhandler called");
});
// Set a Shutdown Handler
silKitLifeCycleService->SetShutdownHandler([this]()
{
m_eStatus = sdv::EObjectStatus::runtime_error;
SDV_LOG_INFO("SilKit Shutdown handler called");
});
// Set a Shutdown Handler
silKitLifeCycleService->SetAbortHandler([this](auto /*participantState*/)
{
m_eStatus = sdv::EObjectStatus::runtime_error;
SDV_LOG_INFO("SilKit Abort handler called");
});
silKitLifeCycleService->SetCommunicationReadyHandler([this]()
{
m_SilKitCanController->SetBaudRate(10'000, 1'000'000, 2'000'000);
m_SilKitCanController->Start();
});
}
catch (const SilKit::SilKitError& e)
{
SDV_LOG_ERROR("SilKit exception occurred when setting the silkit handlers.", e.what());
return false;
}
catch (const std::exception& e)
{
SDV_LOG_ERROR("Unknown std exception occurred when setting the silkit handlers.", e.what());
return false;
}
return true;
}
bool CCANSilKit::CreateSilKitConnection(const std::string& ssSilKitJSONConfigContent, const std::string& ssSilKitNetwork, const std::string& ssSilKitRegistryUri)
{
try
{
m_SilKitParticipant = CreateParticipantFromJSONConfig(ssSilKitJSONConfigContent, ssSilKitRegistryUri);
if (m_SilKitParticipant == nullptr)
{
SDV_LOG_ERROR("SilKit COM adapter is not available.");
return false;
}
m_SilKitCanController = CreateController(ssSilKitNetwork);
if (m_SilKitCanController == nullptr)
{
SDV_LOG_ERROR("SilKit CAN controller is not available.");
return false;
}
m_SilKitLifeCycleService = CreateSilKitLifecycleService();
if (!SetHandlerFunctions(m_SilKitLifeCycleService))
{
SDV_LOG_ERROR("SilKit handler functions could not be set.");
return false;
}
if (m_SilKitIsSynchronousMode)
{
SetupTimeSyncService();
}
auto finalStateFuture = m_SilKitLifeCycleService->StartLifecycle();
if (!finalStateFuture.valid())
{
SDV_LOG_ERROR("Participant State = SilKit::Services::Orchestration::ParticipantState::Invalid");
return false;
}
}
catch (const SilKit::SilKitError& e)
{
SDV_LOG_ERROR("SilKit exception occurred in CreateSilKitConnection().", e.what());
return false;
}
catch (const std::exception& e)
{
SDV_LOG_ERROR("Unknown std exception in CreateSilKitConnection():", e.what());
return false;
}
/* Adapter is configured now, return true */
return true;
}
void CCANSilKit::SilKitReceiveMessageHandler(const SilKit::Services::Can::CanFrame& rsSilKitCanFrame)
{
if (m_eStatus != sdv::EObjectStatus::running)
return;
if (rsSilKitCanFrame.dlc > m_maxCanDataLength)
{
SDV_LOG_WARNING("Invalid data length.");
return;
}
sdv::can::SMessage sSDVCanMessage{};
sSDVCanMessage.uiID = rsSilKitCanFrame.canId;
for (size_t nDataIndex = 0; nDataIndex < static_cast<size_t>(rsSilKitCanFrame.dlc); nDataIndex++)
{
sSDVCanMessage.seqData.push_back(rsSilKitCanFrame.dataField[nDataIndex]);
}
// Broadcast the message to the receivers
std::unique_lock<std::mutex> lockReceivers(m_ReceiversMtx);
for (sdv::can::IReceive* pReceiver : m_SetReceivers)
{
pReceiver->Receive(sSDVCanMessage, 0);
}
}
void CCANSilKit::SilKitTransmitAcknowledgeHandler(const SilKit::Services::Can::CanFrameTransmitEvent& rsSilKitTransmitAcknowledge)
{
/* Get the Acknowledge Sync structure. */
SAcknowledgeSync* acknowledgeSync = reinterpret_cast<SAcknowledgeSync*>(rsSilKitTransmitAcknowledge.userContext);
if (acknowledgeSync == nullptr)
return;
/* Synchronize threads. */
std::unique_lock<std::mutex> lock(acknowledgeSync->mtx);
/* Copy the content of the transmit status to the sync structure. */
*static_cast<SilKit::Services::Can::CanFrameTransmitEvent *>(acknowledgeSync) = rsSilKitTransmitAcknowledge;
/* Trigger the condition variable. */
acknowledgeSync->bProcessed = true;
lock.unlock();
acknowledgeSync->cv.notify_all();
}
void CCANSilKit::Send(/*in*/ const sdv::can::SMessage& sSDVCanMessage, /*in*/ uint32_t)
{
if (m_eStatus != sdv::EObjectStatus::running)
return;
if(sSDVCanMessage.bCanFd)
{
SDV_LOG_ERROR("CAN-FD not supported.");
return; // CAN-FD not supported
// s_SilKit_message.flags |= static_cast< SilKit::Services::Can::CanFrameFlagMask>( SilKit::Services::Can::CanFrameFlag::Fdf) // FD Format Indicator
// | static_cast< SilKit::Services::Can::CanFrameFlagMask>( SilKit::Services::Can::CanFrameFlag::Brs); // Bit Rate Switch (for FD Format only)
}
if (sSDVCanMessage.seqData.size() > m_maxCanDataLength) // Invalid message length.
{
SDV_LOG_ERROR("Invalid message length:", sSDVCanMessage.seqData.size());
return;
}
// Send the message in async mode
if (!m_SilKitIsSynchronousMode)
{
SilKit::Services::Can::CanFrame silKitMessage{};
silKitMessage.canId = sSDVCanMessage.uiID;
std::vector<uint8_t> vecData;
for (uint8_t index = 0; index < sSDVCanMessage.seqData.size(); index++)
{
vecData.emplace_back(sSDVCanMessage.seqData[index]);
}
silKitMessage.dataField = vecData;
m_SilKitCanController->SendFrame(silKitMessage);
}
else
{
std::lock_guard<std::mutex> lock(m_QueueMutex);
m_MessageQueue.push(sSDVCanMessage);
}
}
void CCANSilKit::SetupTimeSyncService()
{
auto silKitTimeSyncService = m_SilKitLifeCycleService->CreateTimeSyncService();
silKitTimeSyncService->SetSimulationStepHandler([this](std::chrono::nanoseconds /*now*/, std::chrono::nanoseconds duration)
{
if (m_TimerSimulationStep)
{
m_TimerSimulationStep->SimulationStep(duration.count() / 1000);
}
try
{
std::lock_guard<std::mutex> lock(m_QueueMutex);
while (!m_MessageQueue.empty())
{
const sdv::can::SMessage& frontMsg = m_MessageQueue.front();
SilKit::Services::Can::CanFrame silKitMessage{};
silKitMessage.canId = frontMsg.uiID;
// Clamp or check to avoid narrowing conversion warning
if (frontMsg.seqData.size() > std::numeric_limits<uint16_t>::max()) {
SDV_LOG_WARNING("CAN data length exceeds uint16_t max, truncating.");
silKitMessage.dlc = static_cast<uint16_t>(std::numeric_limits<uint16_t>::max());
} else {
silKitMessage.dlc = static_cast<uint16_t>(frontMsg.seqData.size());
}
std::vector<uint8_t> vecData;
for (uint8_t index = 0; index < frontMsg.seqData.size(); index++)
{
vecData.emplace_back(frontMsg.seqData[index]);
}
silKitMessage.dataField = vecData;
m_SilKitCanController->SendFrame(silKitMessage);
m_MessageQueue.pop();
}
}
catch (const SilKit::SilKitError& e)
{
SDV_LOG_ERROR("SilKit exception occurred when setting up TimeSyncService.", e.what());
}
catch (const std::exception& e)
{
SDV_LOG_ERROR("Unknown std exception when setting up TimeSyncService.", e.what());
}
}, std::chrono::milliseconds(1));
}

View File

@@ -0,0 +1,207 @@
#ifndef CAN_COM_SILKIT_H
#define CAN_COM_SILKIT_H
#include <iostream>
#include <thread>
#include <mutex>
#include <queue>
#include <set>
//VAPI includes
#include <interfaces/can.h>
#include <support/component_impl.h>
#include <support/timer.h>
//SilKit includes
#include "silkit/SilKit.hpp"
/**
* @brief Component to establish Socket CAN communication between VAPI and external application
*/
class CCANSilKit : public sdv::CSdvObject, public sdv::IObjectControl, public sdv::can::IRegisterReceiver,
public sdv::can::ISend, sdv::can::IInformation
{
public:
// Interface map
BEGIN_SDV_INTERFACE_MAP()
SDV_INTERFACE_ENTRY(sdv::IObjectControl)
SDV_INTERFACE_ENTRY(sdv::can::IRegisterReceiver)
SDV_INTERFACE_ENTRY(sdv::can::ISend)
SDV_INTERFACE_ENTRY(sdv::can::IInformation)
END_SDV_INTERFACE_MAP()
DECLARE_OBJECT_CLASS_TYPE(sdv::EObjectType::Device)
DECLARE_OBJECT_CLASS_NAME("CAN_Com_SilKit")
DECLARE_DEFAULT_OBJECT_NAME("CAN_Communication_Object")
DECLARE_OBJECT_SINGLETON()
/**
* @brief Initialize the object. Overload of sdv::IObjectControl::Initialize.
* @param[in] ssObjectConfig Optional configuration string.
*/
virtual void Initialize(const sdv::u8string& ssObjectConfig) override;
/**
* @brief Get the current status of the object. Overload of sdv::IObjectControl::GetStatus.
* @return Return the current status of the object.
*/
virtual sdv::EObjectStatus GetStatus() const override;
/**
* @brief Set the component operation mode. Overload of sdv::IObjectControl::SetOperationMode.
* @param[in] eMode The operation mode, the component should run in.
*/
void SetOperationMode(sdv::EOperationMode eMode) override;
/**
* @brief Shutdown called before the object is destroyed. Overload of sdv::IObjectControl::Shutdown.
*/
virtual void Shutdown() override;
/**
* @brief Register a CAN message receiver. Overload of sdv::can::IRegisterReceiver::RegisterReceiver.
* @param[in] pReceiver Pointer to the receiver interface.
*/
virtual void RegisterReceiver(/*in*/ sdv::can::IReceive* pReceiver) override;
/**
* @brief Unregister a previously registered CAN message receiver. Overload of
* sdv::can::IRegisterReceiver::UnregisterReceiver.
* @param[in] pReceiver Pointer to the receiver interface.
*/
virtual void UnregisterReceiver(/*in*/ sdv::can::IReceive* pReceiver) override;
/**
* @brief Send a CAN message. Overload of sdv::can::ISend::Send.
* @param[in] sSDVCanMessage Message that is to be sent. The source node information is ignored. The target node determines over
* what interface the message will be sent.
* @param[in] uiIfcIndex Interface index to use for sending.
*/
virtual void Send(/*in*/ const sdv::can::SMessage& sSDVCanMessage, /*in*/ uint32_t uiIfcIndex) override;
/**
* @brief Get a list of interface names. Overload of sdv::can::IInformation::GetInterfaces.
* @return Sequence containing the names of the interfaces.
*/
virtual sdv::sequence<sdv::u8string> GetInterfaces() const override;
private:
/**
* @brief Acknowledge struct used to synchronize between Transmit and Acknowledge callback.
*/
struct SAcknowledgeSync : public SilKit::Services::Can::CanFrameTransmitEvent
{
// False positive warning of CppCheck concerning the initialization of member variables. Suppress warning.
// cppcheck-suppress uninitDerivedMemberVar
/**
* @brief Constructor
*/
SAcknowledgeSync() : SilKit::Services::Can::CanFrameTransmitEvent{} {}
/**
* @brief Mutex used for synchronization.
*/
std::mutex mtx;
/**
* @brief Condition variable to trigger transmission callback has been received.
*/
std::condition_variable cv;
/**
* @brief FLag to indicate whether transmit acknowledge has been sent.
*/
bool bProcessed = false;
};
/**
* @brief Reading configuration for SilKIt from JSON.
* @param[in] ssSilKitJSONConfigContent SilKit JSON config file.
* @return Return true if SilKIt JSON could be parsed successfully
*/
std::shared_ptr<SilKit::Config::IParticipantConfiguration> GetSilKitConfig(const std::string& ssSilKitJSONConfigContent);
/**
* @brief Create Participant with unique name
* @param[in] ssSilKitJSONConfigContent SilKit JSON config file.
* @param[in] ssSilKitRegistryUri SilKit Registry URI.
* @return SilKit::IParticipant, nullptr on failure
*/
std::unique_ptr<SilKit::IParticipant> CreateParticipantFromJSONConfig(const std::string& ssSilKitJSONConfigContent, const std::string& ssSilKitRegistryUri);
/**
* @brief Create SilKit can controller.
* @param[in] ssSilKitNetwork SilKit network.
* @return SilKit::Services::Can::ICanController, nullptr on failure.
*/
SilKit::Services::Can::ICanController* CreateController(const std::string& ssSilKitNetwork);
/**
* @brief Validate if the configuration includes all required settings
* @param[in] ssSilKitJSONConfigContent SilKit JSON config file.
* @param[in] ssSilKitNetwork Declaration of SilKit CAN network.
* @param[in] ssSilKitRegistryUri SilKit Registry URI.
* @return Return true if required settings are available
*/
bool ValidateConfiguration(const std::string& ssSilKitJSONConfigContent, const std::string& ssSilKitNetwork, const std::string& ssSilKitRegistryUri);
/**
* @brief Function for SilKit Timesyncservice creation and to set simulation step handler.
*/
void SetupTimeSyncService();
/**
* @brief Function to setup CAN interfaces.
* @param[in] ssSilKitJSONConfigContent SilKit JSON config file.
* @param[in] ssSilKitNetwork Declaration of SilKit CAN network.
* @param[in] ssSilKitRegistryUri SilKit Registry URI.
* @return Return true if CAN interfaces are setup successfully
*/
bool CreateSilKitConnection(const std::string& ssSilKitJSONConfigContent, const std::string& ssSilKitNetwork, const std::string& ssSilKitRegistryUri);
/**
* @brief Create lifecycle service.
* @return Return SilKit lifecycle service.
*/
SilKit::Services::Orchestration::ILifecycleService* CreateSilKitLifecycleService();
/**
* @brief Set all SillKit handler functiones
* @return Return SilKit lifecycle service.
*/
bool SetHandlerFunctions(SilKit::Services::Orchestration::ILifecycleService* silKitlifeCyleService);
/**
* @brief Method to receive CAN frame via SilKit
* @param[in] rsSilKitCanFrame CAN frame in SilKit format.
*/
void SilKitReceiveMessageHandler(const SilKit::Services::Can::CanFrame& rsSilKitCanFrame);
/**
* @brief Method to transmit acknowledgement callback.
* @param[in] rsSilKitTransmitAcknowledge SilKit CAN message transmit acknowledgement.
*/
void SilKitTransmitAcknowledgeHandler(const SilKit::Services::Can::CanFrameTransmitEvent& rsSilKitTransmitAcknowledge);
std::mutex m_ReceiversMtx; ///< Protect the receiver set.
std::set<sdv::can::IReceive*> m_SetReceivers; ///< Set with receiver interfaces.
std::queue<sdv::can::SMessage> m_MessageQueue; ///< Map of the messages to be sent on SilKit.
std::mutex m_QueueMutex; ///< Protection for message map.
SilKit::Services::Orchestration::ILifecycleService* m_SilKitLifeCycleService = nullptr; ///< SilKit lifecycle service.
SilKit::Services::Can::ICanController* m_SilKitCanController = nullptr; ///< SilKit CAN1 Controller interface.
sdv::core::ITimerSimulationStep* m_TimerSimulationStep = nullptr; ///< Timer simulation step.
std::unique_ptr<SilKit::IParticipant> m_SilKitParticipant = nullptr; ///< SilKit participant.
std::string m_SilKitParticipantName; ///< Configured SilKit participants.
bool m_SilKitIsSynchronousMode = false; ///< SilKit sync mode when true.
uint32_t m_maxCanDataLength = 8; ///< maximum size of the CAN message.
std::atomic<sdv::EObjectStatus> m_eStatus = sdv::EObjectStatus::initialization_pending; ///< Object status.
};
DEFINE_SDV_OBJECT(CCANSilKit)
#endif // ! defined CAN_COM_SILKIT_H