/**
 * @file io_local.h
 *
 * @brief RISC-V LOCAL access
 *
 * Copyright (c) 2020-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__IO_LOCAL_H
#define CPU__IO_LOCAL_H
#define FSP__CPU__IO_LOCAL_H                       1

/**
 * @file io_local.h
 * @brief Provides functions for accessing Local aperture memory.
 */

/* Compiler headers */
#include <stdint.h>

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

/* Late FSP headers */
#include <cpu/mmio-access.h>            // for ioread32, iowrite32, ...

#if (__riscv_xlen == 32)
#include NVRISCV32_MANUAL_ADDRESS_MAP
#include NVRISCV32_MANUAL_LOCAL_IO
#else
#include NVRISCV64_MANUAL_ADDRESS_MAP
#include NVRISCV64_MANUAL_LOCAL_IO
#endif // (__riscv_xlen == 32)

/*
 * Compile-time check for FSP header files
 *   Each FSP header file contains a signature unique to that file, and the
 *   FSP project.  The CT_ASSERT 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.
 */
START_RFD_BLOCK(MISRA, DEVIATE, Directive_4_9, "Approval: Bug 200531995, DR: SWE-FSP-012-SWSADR.docx")
CT_ASSERT(FSP__MISC__GCC_ATTRS_H, "Header file missing or invalid.")
CT_ASSERT(FSP__CPU__MMIO_ACCESS_H, "Header file missing or invalid.")

/**
 * @brief Read from a local register using local IO offset
 *
 * @param[in] addr      address to read from within the aperture
 *
 * @return              contents of the register
 */
GCC_ATTR_ALWAYSINLINE
static inline uint32_t local_read(uint32_t addr)
{
    return ioread32(addr);
}

/**
 * @brief Write to a local register using local IO offset
 *
 * @param[in] addr      address to read from within the aperture
 * @param[in] val       value to write at the address
 */
GCC_ATTR_ALWAYSINLINE
static inline void local_write(uint32_t addr, uint32_t val)
{
    iowrite32(addr, val);
}

END_RFD_BLOCK(MISRA, DEVIATE, Directive_4_9, "Approval: Bug 200531995, DR: SWE-FSP-012-SWSADR.docx")

#endif // CPU__IO_LOCAL_H
