/**
 * @file        iopmp.h
 * @brief       Interfaces for the Peregrine IO-PMP controls.
 *
 * Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * * Neither the name of NVIDIA CORPORATION nor the names of its
 * contributors may be used to endorse or promote products derived
 * from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef CPU__IOPMP_H
#define CPU__IOPMP_H
#define FSP__CPU__IOPMP_H 1

/* Compiler headers */
#include <stdbool.h>                    // for bool

/* Early FSP headers */
#include <misc/ct-assert.h>             // for HEADER_CHECK

/* Hardware headers */

/* Late FSP headers */
// Clients must provide their own DRF headers

/* Module-specific FSP headers */
#include <cpu/io.h>                     // for local_read

/*
 * Compile-time check for FSP header files
 *   Each FSP header file contains a signature unique to that file, and the
 *   FSP project.  The HEADER_CHECK macro (contained in misc/ct-assert.h) can
 *   check for this signature.  If it does not exist, then the build will
 *   abort.
 *
 *   This is a trap for projects which have their own include files of the
 *   same names, but different contents.  This trap ensures that only the
 *   files from the FSP project, are built into the FSP source code.
 */
HEADER_CHECK(FSP__CPU__IO_H)


/**
 * @brief Temporary work-around for typo in PRGNLCL manual (bug #3394780).
 */
#ifndef NV_PRGNLCL_RISCV_IOPMP_ERR_STAT_VALID_TRUE
#define NV_PRGNLCL_RISCV_IOPMP_ERR_STAT_VALID_TRUE \
    NV_PRGNLCL_RISCV_IOPMP_ERR_STAT_VALID_TURE
#endif


/**
 * @brief Checks whether error-capture is enabled for a given IO-PMP master.
 *
 * @param[in] master  The IO-PMP master to check (e.g. CPDMA).
 *
 * @retval true  if error-capture is enabled.
 * @retval false if error-capture is disabled.
 *
 * @note Does not support vectored masters (use the _IDX variant instead).
 */
#define IOPMP_IS_CAPTURE_ENABLED(master) (                                    \
    FLD_TEST_DRF(_PRGNLCL_RISCV, _IOPMP_ERR_CAPEN, _MASTER_##master, _ENABLE, \
        local_read(NV_PRGNLCL_RISCV_IOPMP_ERR_CAPEN))                         \
)

/**
 * @brief Checks whether error-capture is enabled for a vectored IO-PMP master.
 *
 * @param[in] master  The vectored IO-PMP master to check (e.g. PMB).
 * @param[in] index   The index of the desired vector entry.
 *
 * @retval true  if error-capture is enabled.
 * @retval false if error-capture is disabled.
 */
#define IOPMP_IS_CAPTURE_ENABLED_IDX(master, index) (                       \
    FLD_IDX_TEST_DRF(_PRGNLCL_RISCV, _IOPMP_ERR_CAPEN, _MASTER_##master,    \
        (index), _ENABLE, local_read(NV_PRGNLCL_RISCV_IOPMP_ERR_CAPEN))     \
)


/**
 * @brief Checks whether an IO-PMP error is pending.
 *
 * @retval true  if an error is pending.
 * @retval false otherwise.
 */
static inline bool
iopmp_has_error(void)
{
    return FLD_TEST_DRF(_PRGNLCL_RISCV, _IOPMP_ERR_STAT, _VALID, _TRUE,
        local_read(NV_PRGNLCL_RISCV_IOPMP_ERR_STAT));
}

#endif // CPU__IOPMP_H
