IInterruptStatus.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2022-2024 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 IINTERRUPTSTATUS_HPP
#define IINTERRUPTSTATUS_HPP
 
#include <array>
 
#include "NvSIPLInterrupts.hpp"
 
namespace nvsipl
{
 
static constexpr uint32_t MAX_DEVGRP_NTFNS_PER_INTR { 8U };
 
class IInterruptStatus
{
public:
    struct InterruptNotification {
        InterruptCode code;
        uint64_t data;
        uint32_t gpioIdx;
        uint32_t linkMask;
        bool valid;
    };
 
    virtual SIPLStatus GetInterruptStatus(
        uint32_t const gpioIdx,
        std::array<InterruptNotification, MAX_DEVGRP_NTFNS_PER_INTR> &intrNtfns) const noexcept
    {
        static_cast<void>(gpioIdx);
        static_cast<void>(intrNtfns);
        return NVSIPL_STATUS_NOT_SUPPORTED;
    }
 
protected:
    IInterruptStatus() =  default;
 
    IInterruptStatus(IInterruptStatus const &) = delete;
 
    IInterruptStatus(IInterruptStatus &&) = delete;
 
    IInterruptStatus& operator=(IInterruptStatus const &) & = delete;
 
    IInterruptStatus& operator=(IInterruptStatus&&) & = delete;
 
    virtual ~IInterruptStatus() = default;
};
 
static constexpr struct IInterruptStatus::InterruptNotification EMPTY_INTR_NTFN
    { InterruptCode::INTR_STATUS_FAILURE, 0ULL, 0U, 0U, false };
 
} // end of namespace nvsipl
 
#endif // IINTERRUPTSTATUS_HPP