/**
 *  @file fapiPlatHwAccess.C
 *
 *  @brief Implements the fapiHwAccess.H functions.
 *
 *  Note that platform code must provide the implementation.
 */

#include <fapiHwAccess.H>
#include <fapiPlatTrace.H>
#include <errl/errlentry.H>
#include <targeting/targetservice.H>
#include <devicefw/userif.H>

extern "C"
{

//******************************************************************************
// GetScom function
//******************************************************************************
fapi::ReturnCode GetScom(const fapi::Target& i_target,
                         const uint64_t i_address,
                         ecmdDataBufferBase & o_data)
{
	FAPI_DBG(ENTER_MRK "GetScom");

	fapi::ReturnCode l_rc;
    errlHndl_t l_err = NULL;

    // Extract the component pointer
    TARGETING::Target* l_target = reinterpret_cast<TARGETING::Target*>(i_target.get());

    // Perform SCOM read
    uint64_t l_data = 0;
    size_t l_size = sizeof(uint64_t);
    l_err = deviceRead(l_target,
                       &l_data,
                       l_size,
                       DEVICE_SCOM_ADDRESS(i_address));
    if (l_err)
    {
        // Add the error log pointer as data to the ReturnCode
        FAPI_ERR("GetScom: HostBoot GetScom returns error");
        l_rc = fapi::FAPI_RC_PLAT_ERR_SEE_DATA;
        l_rc.setData(reinterpret_cast<void *> (l_err));
    }
    else
    {
        o_data.setDoubleWord(0, l_data);
    }

    FAPI_DBG(EXIT_MRK "GetScom");
    return l_rc;
}

//******************************************************************************
// PutScom function
//******************************************************************************
fapi::ReturnCode PutScom(const fapi::Target& i_target,
                         const uint64_t i_address,
                         ecmdDataBufferBase & i_data)
{
    FAPI_DBG(ENTER_MRK "PutScom");
    fapi::ReturnCode l_rc;
    errlHndl_t l_err = NULL;

    // Extract the component pointer
    TARGETING::Target* l_target = reinterpret_cast<TARGETING::Target*>(i_target.get());

    // Perform SCOM read
    uint64_t l_data = i_data.getDoubleWord(0);
    size_t l_size = sizeof(uint64_t);
    l_err = deviceWrite(l_target,
                        &l_data,
                        l_size,
                        DEVICE_SCOM_ADDRESS(i_address));
    if (l_err)
    {
        // Add the error log pointer as data to the ReturnCode
        FAPI_ERR("Putscom: HostBoot Putscom returns error");
        l_rc = fapi::FAPI_RC_PLAT_ERR_SEE_DATA;
        l_rc.setData(reinterpret_cast<void *> (l_err));
    }

    FAPI_DBG(EXIT_MRK "PutScom");
    return l_rc;
}

//@todo - Implement these functions later
#if 0
//******************************************************************************
// PutScomUnderMask function
//******************************************************************************
fapi::ReturnCode PutScomUnderMask(const fapi::Target& i_target,
                                  const uint64_t i_address,
                                  ecmdDataBufferBase & i_data,
                                  ecmdDataBufferBase & i_mask)
{
	FAPI_DBG(ENTER_MRK "PutScomUnderMask");

	FAPI_DBG(EXIT_MRK "PutScomUnderMask");
}

//******************************************************************************
// GetCfamRegister function
//******************************************************************************
fapi::ReturnCode GetCfamRegister(const fapi::Target& i_target,
                                 const uint32_t i_address,
                                 ecmdDataBufferBase & o_data)
{
	FAPI_DBG(ENTER_MRK "GetCfamRegister");

	FAPI_DBG(EXIT_MRK "GetCfamRegister");
}

//******************************************************************************
// PutCfamRegister function
//******************************************************************************
fapi::ReturnCode PutCfamRegister(const fapi::Target& i_target,
                                 const uint32_t i_address,
                                 ecmdDataBufferBase & i_data)
{
	FAPI_DBG(ENTER_MRK "PutCfamRegister");

	FAPI_DBG(EXIT_MRK "PutCfamRegister");
}

//******************************************************************************
// ModifyCfamRegister function
//******************************************************************************
fapi::ReturnCode ModifyCfamRegister(const fapi::Target& i_target,
                                    const uint32_t i_address,
                                    ecmdDataBufferBase & i_data,
                                    const fapi::ChipOpModifyMode i_modifyMode)
{
	FAPI_DBG(ENTER_MRK "ModifyCfamRegister");

	FAPI_DBG(EXIT_MRK "ModifyCfamRegister");
}
#endif

} // extern "C"