NvSIPLQuery.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2019, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, related documentation
 * and any modifications thereto.  Any use, reproduction, disclosure or
 * distribution of this software and related documentation without an express
 * license agreement from NVIDIA CORPORATION is strictly prohibited.
 */
#ifndef NVSIPLQUERY_HPP
#define NVSIPLQUERY_HPP

#include "NvSIPLCommon.hpp"
#include "NvSIPLPlatformCfg.hpp"

#include <string>
#include <cstdint>
#include <memory>
#include <vector>

namespace nvsipl
{

class INvSIPLQuery
{
public:

    static constexpr std::uint32_t MAJOR_VER  = 1u; 
    static constexpr std::uint32_t MINOR_VER  = 0u; 
    static constexpr std::uint32_t PATCH_VER  = 0u; 
    struct Version
    {
        std::uint32_t uMajor = MAJOR_VER; 
        std::uint32_t uMinor = MINOR_VER; 
        std::uint32_t uPatch = PATCH_VER; 
    };

    static void GetVersion(Version& version);

    static std::unique_ptr <INvSIPLQuery> GetInstance(void);

    virtual SIPLStatus ParseDatabase(void) = 0;

    virtual SIPLStatus ParseJsonFile(std::string fileName) = 0;

    const virtual DeviceInfoList* GetDeviceInfoList() const = 0;

    virtual std::vector <const PlatformCfg*> GetPlatformCfgList() const = 0;

    virtual SIPLStatus GetPlatformCfg(std::string name,
                                      PlatformCfg& oConfig) const = 0;

    enum EnableMask
    {
        LINK_0 = 0x0001, 
        LINK_1 = 0x0010, 
        LINK_2 = 0x0100, 
        LINK_3 = 0x1000  
    };

    virtual SIPLStatus ApplyMask(PlatformCfg& platCfg,
                                 const std::vector <std::uint32_t>& vMasks) const = 0;

    virtual ~INvSIPLQuery() = default;

}; //INvSIPLQuery

}// namespace nvsipl



#endif //NVSIPLQUERY_HPP