Channel.hpp

Go to the documentation of this file.

 
//
// Notice
// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
//
// NVIDIA CORPORATION & AFFILIATES assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA CORPORATION & AFFILIATES. No third party distribution is allowed unless
// expressly authorized by NVIDIA. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA CORPORATION & AFFILIATES products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA CORPORATION & AFFILIATES.
//
// SPDX-FileCopyrightText: Copyright (c) 2018-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
//
// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
// property and proprietary rights in and to this material, related
// documentation and any modifications thereto. Any use, reproduction,
// disclosure or distribution of this material and related documentation
// without an express license agreement from NVIDIA CORPORATION or
// its affiliates is strictly prohibited.
//
 
#ifndef DW_FRAMEWORK_CHANNEL_HPP_
#define DW_FRAMEWORK_CHANNEL_HPP_
 
#include "ChannelParameters.hpp"
#include "IChannelPacket.hpp"
 
#include <dw/core/context/Context.h>
#include <dwshared/dwfoundation/dw/core/language/Function.hpp>
#include <dwshared/dwfoundation/dw/core/container/BaseString.hpp>
#include <dw/core/health/HealthSignals.h>
 
#include <memory>
#include <mutex>
#include <string>
 
namespace dw
{
namespace framework
{
 
// coverity[autosar_cpp14_a0_1_1_violation]
// coverity[autosar_cpp14_m0_1_4_violation]
static constexpr dwTime_t CHN_WAIT_TIMEOUT_US{50'000'000};
 
class ChannelObject
{
public:
    virtual ~ChannelObject() = default;
 
    class SyncClient
    {
    public:
        virtual void getSyncObjs(dw::core::span<NvSciSyncObj>& syncObjs) = 0;
    };
 
    class SyncWaiter : public SyncClient
    {
    public:
        virtual void getWaitFences(void* data, dw::core::span<NvSciSyncFence>& waitFences) = 0;
    };
 
    class SyncSignaler : public SyncClient
    {
    public:
        virtual void setSignalFences(void* data, dw::core::span<const NvSciSyncFence> postFences) = 0;
    };
 
    // coverity[autosar_cpp14_m3_4_1_violation]
    class PacketPool
    {
    public:
        SyncWaiter& getSyncWaiter();
 
        SyncSignaler& getSyncSignaler();
 
        virtual dwStatus wait(dwTime_t timeout) = 0;
 
        virtual dw::core::VectorFixed<GenericData> getAllBuffers() = 0;
 
        using OnDataReady = dw::core::Function<void()>;
 
        virtual void setOnDataReady(void* opaque, OnDataReady onDataReady) = 0;
    };
 
    class Producer : public PacketPool
    {
    public:
        // coverity[autosar_cpp14_a2_10_5_violation] RFD Pending: TID-2053
        virtual dwStatus get(GenericData* data) = 0;
        virtual dwStatus send(void* data) = 0;
 
        virtual dwStatus release(void* data) = 0;
    };
 
    class Consumer : public PacketPool
    {
    public:
        virtual dwStatus recv(GenericData* data) = 0;
        virtual dwStatus release(void* data) = 0;
    };
 
    virtual Producer* getProducer(const GenericDataReference& ref) = 0;
 
    virtual Consumer* getConsumer(const GenericDataReference& ref) = 0;
 
    virtual bool hasClients() const = 0;
 
    virtual bool isConnected() const = 0;
 
    virtual dwStatus connect(dwTime_t timeout) = 0;
 
    virtual const ChannelParams& getParams() const = 0;
 
    virtual void disconnectEndpoint(const char* nvsciipcEndpoint) = 0;
 
    virtual void connectEndpoint(const char* nvsciipcEndpoint) = 0;
};
 
enum class ChannelEventType
{
    CONNECTED,      
    DISCONNECTED,   
    ERROR,          
    READY,          
    GROUP_CONNECTED 
};
 
// coverity[autosar_cpp14_a0_1_6_violation]
struct ChannelEvent
{
    ChannelEventType type;                              
    uint32_t uid;                                       
    uint32_t connectGroupID;                            
    void* opaque;                                       
    ChannelObject::PacketPool::OnDataReady onDataReady; 
};
 
// coverity[autosar_cpp14_a0_1_6_violation]
struct ChannelError
{
    dwErrorSignal errorSignal;                   
    dw::core::FixedString<64U> nvsciipcEndpoint; 
};
 
} // namespace framework
} // namespace dw
 
#endif // DW_FRAMEWORK_CHANNEL_HPP_