/*
 * Copyright (c) 2023, 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 UTC__UTC_PRIV_H
#define UTC__UTC_PRIV_H
#define FSP__UTC__UTC_PRIV_H                      1

/**
 * @file utc/utc-priv.h
 * @brief Structures that are internal to the UTC driver
 */

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

/* Early FSP headers */

/* Hardware headers */
#include <address_map_new.h>
#include <arutc.h>

/* Late FSP headers */

#define UTC_BASE               (NV_ADDRESS_MAP_UTC_32BITBASE)
#define CLIENT_STRIDE          (UTC_TX_CLIENT_2_ENABLE_0 - UTC_TX_CLIENT_1_ENABLE_0)
#define CL_BASE(cl_id)         (UTC_BASE + (cl_id - 1U) * CLIENT_STRIDE)

#define DEFINE_UTC_CL(_name, _id, _irq, _en_rx)    \
        const struct utc_client utc_id_##_name = { \
            .base = CL_BASE(_id),                  \
            .id = _id,                             \
            .irq = _irq,                           \
            .enable_rx = _en_rx,                   \
        };

/**
 * @brief utc client context structure
 *
 * Structure that is used by the utc client driver to manage context
 * during run time.
 *
 * @base            base address for the client
 * @irq             irq number
 * @id              client id
 * @enable_rx       flag to indicate whether to enable rx.
 */
struct utc_client {
    const uint32_t  base;
    const uint32_t  irq;
    const uint32_t  id;
    const bool      enable_rx;
};

#endif
