/*
 * 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_H
#define UTC__UTC_H
#define FSP__UTC__UTC_H                      1

/**
 * @file utc/utc.h
 * @brief functions for performing utc operations.
 */

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

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

/* Hardware headers */

/* Late FSP headers */
#include <error/common-errors.h>        // for error_t, FSP__ERROR__COMMON...
#include <misc/macros.h>                // for START_RFD_BLOCK, END_RFD_BLOCK, INLINE_RFD

/*
 * 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, Rule_1_2, "Approval: Bug 200531996, DR: SWE-FSP-009-SWSADR.docx",
                MISRA, DEVIATE, Rule_2_3, "Approval:  On-file, DR: SWE-FSP-010-SWSADR.docx",
                MISRA, DEVIATE, Rule_2_5, "Approval: Bug 3175244, DR: SWE-FSP-013-SWSADR.docx",
                MISRA, DEVIATE, Directive_4_9, "Approval: Bug 200531995, DR: SWE-FSP-012-SWSADR.docx")
CT_ASSERT(FSP__ERROR__COMMON_ERRORS_H, "Header file missing or invalid.")
CT_ASSERT(FSP__MISC__MACROS_H, "Header file missing or invalid.")
END_RFD_BLOCK(MISRA, DEVIATE, Rule_1_2, "Approval: Bug 200531996, DR: SWE-FSP-009-SWSADR.docx",
              MISRA, DEVIATE, Rule_2_3, "Approval:  On-file, DR: SWE-FSP-010-SWSADR.docx")

/*
 * Declaration for utc_id that allows the APIs to take a pointer to it
 * without actually defining its contents here.
 */
struct utc_client;

/**
 * @brief tx flush operation via the UTC.
 *
 * @pre utc_client_init() has been called
 *
 * @param[in] cl   utc client context
 *
 * @retval E_SUCCESS           indicates success
 * @retval E_UTC_NULL_PTR      null cl paramter passed
 * @retval E_UTC_NOT_INITED    utc not initialized.
 */
error_t utc_tx_flush(const struct utc_client *cl);

/**
 * @brief output a string via the UTC.
 *
 * @pre utc_client_init() has been called
 *
 * @param[in] cl   utc client context
 * @param[in] s    string to output
 *
 * @retval E_SUCCESS           indicates success
 * @retval E_UTC_NULL_PTR      null cl paramter passed
 * @retval E_UTC_NOT_INITED    utc not initialized.
 */
error_t utc_puts(const struct utc_client *cl, const char *s);

/**
 * @brief output a char via the UTC.
 *
 * @pre utc_client_init() has been called
 *
 * @param[in] cl   utc context
 * @param[in] ch   character to output
 *
 * @retval E_SUCCESS           indicates success
 * @retval E_UTC_NULL_PTR      null cl paramter passed
 * @retval E_UTC_NOT_INITED    utc not initialized.
 */
error_t utc_putc(const struct utc_client *cl, const char ch);

/**
 * @brief check if UTC TX can accept data.
 *
 * @pre utc_client_init() has been called
 *
 * @param[in] cl      utc context
 * @param[in] ready   pointer to store the utc tx status
 *
 * @retval E_SUCCESS           indicates success
 * @retval E_UTC_NULL_PTR      null cl paramter passed
 * @retval E_UTC_NOT_INITED    utc not initialized.
 */
error_t utc_is_tx_ready(const struct utc_client *cl, bool *ready);

/**
 * @brief get TX fifo empty count.
 *
 * @pre utc_client_init() has been called
 *
 * @param[in] cl      utc context
 * @param[in] ready   pointer to store the utc tx fifo empty count
 *
 * @retval E_SUCCESS           indicates success
 * @retval E_UTC_NULL_PTR      null cl paramter passed
 * @retval E_UTC_NOT_INITED    utc not initialized.
 */
error_t utc_get_tx_empty_space(const struct utc_client *cl, uint8_t *count);

/**
 * @brief output data via the UTC.
 *
 * This function outputs data to the UTC client TX FIFO.
 *
 * @pre the function utc_client_init() has been called
 *
 * @param[in] cl          UTC context for the client.
 * @param[in] buf         buffer that has the data to be written.
 * @param[in] count       byte count of the data to write.
 *
 * @retval E_SUCCESS           indicates success
 * @retval E_UTC_NULL_PTR      null cl/buf/written paramter passed
 * @retval E_UTC_NOT_INITED    utc not initialized.
 */
error_t utc_write_now(const struct utc_client *cl, const char *buf, uint32_t count);

/**
 * @brief output data via the UTC.
 *
 * This function outputs data to the UTC client TX FIFO.
 *
 * @pre the function utc_client_init() has been called
 *
 * @param[in] cl          UTC context for the client.
 * @param[in] buf         buffer that has the data to be written.
 * @param[in] count       byte count of the data to write.
 * @param[in] written     byte count written.
 * @param[in] timeout_us  timeout in us to return on expiry.
 *
 * @retval E_SUCCESS           indicates success
 * @retval E_UTC_NULL_PTR      null cl/buf/written paramter passed
 * @retval E_UTC_NOT_INITED    utc not initialized.
 * @retval E_UTC_TIMED_OUT     utc timed out
 */
error_t utc_write(const struct utc_client *cl, const char *buf,
                  uint32_t count, uint32_t *written, uint64_t timeout_us);

/**
 * @brief receive a char via the UTC.
 *
 * @pre utc_client_init() has been called
 *
 * @param[in] cl   utc context
 * @param[in] ch   pointer to where the char is stored
 *
 * @retval E_SUCCESS           indicates success
 * @retval E_UTC_NULL_PTR      null cl/ch paramter passed
 * @retval E_UTC_NOT_INITED    utc not initialized.
 * @retval E_UTC_RX_DISABLED   utc rx disabled
 */
error_t utc_getc(const struct utc_client *cl, char *ch);

/**
 * @brief Read from the UTC RX buffer.
 *
 * This function reads data from the UTC client RX FIFO.
 *
 * @pre the function utc_client_init() has been called
 *
 * @param[in] cl          UTC context for the client.
 * @param[in] buf         pointer to store the data being read.
 * @param[in] count       byte count of the data to be read.
 * @param[in] read        byte count read.
 * @param[in] timeout_us  timeout in us to return on expiry.
 *
 * @retval E_SUCCESS           indicates success
 * @retval E_UTC_NULL_PTR      null cl/buf/read paramter passed
 * @retval E_UTC_INVALID_PARAM invalid parameter passed
 * @retval E_UTC_NOT_INITED    utc not initialized.
 * @retval E_UTC_TIMED_OUT     utc timed out
 * @retval E_UTC_RX_DISABLED   utc rx disabled
 */
error_t utc_read(const struct utc_client *cl, char *buf, uint32_t count,
                 uint32_t *read, uint64_t timeout_us);

/**
 * @brief Initialization of the UTC context for the client.
 *
 * This API resets the client FIFOs, performs a sanity check of the global
 * initialization performed by some micro-boot stage and enables TX/RX.
 *
 * @pre Some micro-boot stage has performed the UTC common configuration.
 *
 * @param[in] cl                utc context for this client
 *
 * @retval E_SUCCESS            indicates success
 * @retval E_UTC_NULL_PTR       null cl paramter passed
 * @retval E_UTC_NOT_INITED     utc not enabled by BL.
 * @retval E_UTC_INVALID_PARAM  utc client invalid id.
 */
error_t utc_client_init(const struct utc_client *cl);

#endif
