AR0820NonFuSaCustomInterface.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2021-2025 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 _AR0820_NONFUSA_CUSTOMINTERFACE_HPP_
#define _AR0820_NONFUSA_CUSTOMINTERFACE_HPP_
 
#include "INvSIPLDeviceInterfaceProvider.hpp"
#include "NvSIPLCommon.hpp"
 
namespace nvsipl
{
// This is version 1 UUID obtained using https://www.uuidgenerator.net/
// This will be used to uniquely identify this interface
// The client can use this ID to validate the correct interface before use
//024ea870-a3f3-4b4c-bbb9-dfba64955a1b
const UUID AR0820_NONFUSA_CUSTOM_INTERFACE_ID(0x024ea870U, 0xa3f3U, 0x4b4cU, 0xbbb9U,
                                              0xdfU, 0xbaU, 0x64U, 0x95U, 0x5AU, 0x1BU);
 
 
class AR0820NonFuSaCustomInterface : public Interface
{
public:
    static const UUID& getClassInterfaceID() {
        return AR0820_NONFUSA_CUSTOM_INTERFACE_ID;
    }
 
    // Used for a confirmatory test by the app to ensure typecasted pointer
    // indeed points to the right object
    const UUID& getInstanceInterfaceID() const noexcept override {
        return AR0820_NONFUSA_CUSTOM_INTERFACE_ID;
    }
 
    virtual SIPLStatus CheckModuleStatus() = 0;
 
protected:
    ~AR0820NonFuSaCustomInterface() = default;
};
 
} // end of namespace nvsipl
#endif // _AR0820_NONFUSA_CUSTOMINTERFACE_HPP_