/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/isteps/istep14/call_mss_thermal_init.C $              */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2015,2019                        */
/* [+] International Business Machines Corp.                              */
/*                                                                        */
/*                                                                        */
/* Licensed under the Apache License, Version 2.0 (the "License");        */
/* you may not use this file except in compliance with the License.       */
/* You may obtain a copy of the License at                                */
/*                                                                        */
/*     http://www.apache.org/licenses/LICENSE-2.0                         */
/*                                                                        */
/* Unless required by applicable law or agreed to in writing, software    */
/* distributed under the License is distributed on an "AS IS" BASIS,      */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or        */
/* implied. See the License for the specific language governing           */
/* permissions and limitations under the License.                         */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */
#include <errl/errlentry.H>
#include <errl/errlmanager.H>
#include <errl/errludtarget.H>

#include <isteps/hwpisteperror.H>
#include <initservice/isteps_trace.H>

//  targeting support
#include <targeting/common/commontargeting.H>
#include <targeting/common/util.H>
#include <targeting/common/utilFilter.H>

#include    <config.h>
#include    <fapi2.H>
#include    <fapi2/plat_hwp_invoker.H>

#ifdef CONFIG_AXONE
   #include    <exp_mss_thermal_init.H>
    #include    <chipids.H> // for EXPLORER ID
    #include    <p9a_throttle_sync.H>
#else
    #include    <p9c_mss_thermal_init.H>
    #include    <p9_mss_thermal_init.H>
    #include    <p9_throttle_sync.H>
#endif

using   namespace   ISTEP;
using   namespace   ISTEP_ERROR;
using   namespace   ERRORLOG;
using   namespace   TARGETING;

namespace ISTEP_14
{
void nimbus_call_mss_thermal_init(IStepError & io_istepError);
void cumulus_call_mss_thermal_init(IStepError & io_istepError);
void axone_call_mss_thermal_init(IStepError & io_istepError);
void run_proc_throttle_sync(IStepError & io_istepError);

void* call_mss_thermal_init (void *io_pArgs)
{
    IStepError  l_StepError;
    TRACFCOMP(ISTEPS_TRACE::g_trac_isteps_trace, "call_mss_thermal_init entry");

    auto l_procModel = TARGETING::targetService().getProcessorModel();
    switch (l_procModel)
    {
        case TARGETING::MODEL_CUMULUS:
            cumulus_call_mss_thermal_init(l_StepError);
            break;
        case TARGETING::MODEL_AXONE:
            axone_call_mss_thermal_init(l_StepError);
            break;
        case TARGETING::MODEL_NIMBUS:
            nimbus_call_mss_thermal_init(l_StepError);
            break;
        default:
            assert(0, "call_mss_thermal_init: Unsupported model type 0x%04X",
                l_procModel);
            break;
    }

    // This should run whether or not mss_thermal_init worked
    run_proc_throttle_sync(l_StepError);

    TRACFCOMP(ISTEPS_TRACE::g_trac_isteps_trace, "call_mss_thermal_init exit");

    // end task, returning any errorlogs to IStepDisp
    return l_StepError.getErrorHandle();
}

#ifndef CONFIG_AXONE
void nimbus_call_mss_thermal_init(IStepError & io_istepError)
{
    errlHndl_t  l_errl  =   nullptr;

    // -- Nimbus only ---
    // Get all MCS targets
    TARGETING::TargetHandleList l_mcsTargetList;
    getAllChiplets(l_mcsTargetList, TYPE_MCS);

    //  --------------------------------------------------------------------
    //  run mss_thermal_init on all functional MCS chiplets
    //  --------------------------------------------------------------------
    for (const auto & l_pMcs : l_mcsTargetList)
    {
        fapi2::Target<fapi2::TARGET_TYPE_MCS> l_fapi_pMcs(l_pMcs);

        // Current run on target
        TRACFCOMP( ISTEPS_TRACE::g_trac_isteps_trace,
                   "Running p9_mss_thermal_init HWP on target HUID %.8X",
                   TARGETING::get_huid(l_pMcs) );

        FAPI_INVOKE_HWP( l_errl, p9_mss_thermal_init, l_fapi_pMcs );

        if ( l_errl )
        {
            TRACFCOMP(ISTEPS_TRACE::g_trac_isteps_trace,
                      "ERROR 0x%.8X: p9_mss_thermal_init HWP returns error",
                      l_errl->reasonCode());

            // capture the target data in the elog
            ErrlUserDetailsTarget(l_pMcs).addToLog( l_errl );

            // Create IStep error log and cross reference
            // to error that occurred
            io_istepError.addErrorDetails( l_errl );

            // Commit Error
            errlCommit( l_errl, HWPF_COMP_ID );

            break;
        }
        else
        {
            TRACFCOMP( ISTEPS_TRACE::g_trac_isteps_trace,
                       "SUCCESS : p9_mss_thermal_init HWP() on 0x%.8X MCS",
                       TARGETING::get_huid(l_pMcs) );
        }
    } // end MCS loop

}

void cumulus_call_mss_thermal_init(IStepError & io_istepError)
{
    errlHndl_t  l_errl  =   nullptr;

    // -- Cumulus only ---
    // Get all Centaur targets
    TARGETING::TargetHandleList l_memBufTargetList;
    getAllChips(l_memBufTargetList, TYPE_MEMBUF);

    //  --------------------------------------------------------------------
    //  run mss_thermal_init on all functional Centaur chips
    //  --------------------------------------------------------------------
    for (const auto & l_pCentaur : l_memBufTargetList)
    {
        fapi2::Target<fapi2::TARGET_TYPE_MEMBUF_CHIP> l_fapi_pCentaur
          (l_pCentaur);

        // Current run on target
        TRACFCOMP( ISTEPS_TRACE::g_trac_isteps_trace,
                   "Running p9c_mss_thermal_init HWP on target HUID %.8X",
                   TARGETING::get_huid(l_pCentaur) );

        FAPI_INVOKE_HWP( l_errl, p9c_mss_thermal_init, l_fapi_pCentaur );

        if ( l_errl )
        {
            TRACFCOMP(ISTEPS_TRACE::g_trac_isteps_trace,
                      "ERROR 0x%.8X: p9c_mss_thermal_init HWP returns error",
                      l_errl->reasonCode());

            // capture the target data in the elog
            ErrlUserDetailsTarget(l_pCentaur).addToLog( l_errl );

            // Create IStep error log and cross reference
            // to error that occurred
            io_istepError.addErrorDetails( l_errl );

            // Commit Error
            errlCommit( l_errl, HWPF_COMP_ID );

            break;
        }
        else
        {
            TRACFCOMP( ISTEPS_TRACE::g_trac_isteps_trace,
                       "SUCCESS : p9c_mss_thermal_init HWP( ) on 0x%.8X target",
                       TARGETING::get_huid(l_pCentaur) );
        }
    } // end MEMBUF loop
}
#else
void nimbus_call_mss_thermal_init(IStepError & io_istepError)
{
    TRACFCOMP( ISTEPS_TRACE::g_trac_isteps_trace,
              "Error: Trying to call 'p9_mss_thermal_init' but Nimbus code is not compiled in");
    assert(0, "Calling wrong Model's HWPs");
}

void cumulus_call_mss_thermal_init(IStepError & io_istepError)
{
    TRACFCOMP( ISTEPS_TRACE::g_trac_isteps_trace,
              "Error: Trying to call 'p9c_mss_thermal_init' but Cumulus code is not compiled in");
    assert(0, "Calling wrong Model's HWPs");
}
#endif

#ifdef CONFIG_AXONE
void axone_call_mss_thermal_init(IStepError & io_istepError)
{
    errlHndl_t l_err = nullptr;

    // Get all OCMB targets
    TARGETING::TargetHandleList l_ocmbTargetList;
    getAllChips(l_ocmbTargetList, TYPE_OCMB_CHIP);

    for (const auto & l_ocmb_target : l_ocmbTargetList)
    {
        // check EXPLORER first as this is most likely the configuration
        uint32_t chipId = l_ocmb_target->getAttr< TARGETING::ATTR_CHIP_ID>();
        if (chipId == POWER_CHIPID::EXPLORER_16)
        {
            fapi2::Target <fapi2::TARGET_TYPE_OCMB_CHIP> l_fapi_ocmb_target
                (l_ocmb_target);

            // Dump current run on target
            TRACFCOMP( ISTEPS_TRACE::g_trac_isteps_trace,
                "Running exp_mss_thermal_init HWP on target HUID %.8X",
                TARGETING::get_huid(l_ocmb_target));

            // call the HWP with each fapi2::Target
            FAPI_INVOKE_HWP(l_err, exp_mss_thermal_init, l_fapi_ocmb_target);
        }
        else
        {
            // Gemini, NOOP
            TRACFCOMP( ISTEPS_TRACE::g_trac_isteps_trace,
                "Skipping thermal_init HWP on axone target HUID 0x%.8X, chipId 0x%.4X",
                TARGETING::get_huid(l_ocmb_target), chipId );
        }

        if (l_err)
        {
            TRACFCOMP(ISTEPS_TRACE::g_trac_isteps_trace,
                      "ERROR 0x%.8X: exp_mss_thermal_init HWP returns error",
                      l_err->reasonCode());

            // capture the target data in the elog
            ErrlUserDetailsTarget(l_ocmb_target).addToLog(l_err);

            // Create IStep error log and cross reference to error that
            // occurred
            io_istepError.addErrorDetails( l_err );

            // Commit Error
            errlCommit( l_err, HWPF_COMP_ID );

            break;
        }
        else if (chipId == POWER_CHIPID::EXPLORER_16)
        {
            TRACFCOMP( ISTEPS_TRACE::g_trac_isteps_trace,
                  "SUCCESS running exp_mss_thermal_init HWP on target HUID %.8X",
                  TARGETING::get_huid(l_ocmb_target));
        }
    } // end OCMB loop
}
#else
void axone_call_mss_thermal_init(IStepError & io_istepError)
{
    TRACFCOMP( ISTEPS_TRACE::g_trac_isteps_trace,
              "Error: Trying to call 'exp_mss_thermal_init' but Axone code is not compiled in");
    assert(0, "Calling wrong Model's HWPs");
}
#endif


void run_proc_throttle_sync(IStepError & io_istepError)
{
    errlHndl_t  l_errl  =   nullptr;

    // Run proc throttle sync
    // Get all functional proc chip targets
    // Use targeting code to get a list of all processors
    TARGETING::TargetHandleList l_procChips;
    getAllChips( l_procChips, TARGETING::TYPE_PROC );

    for (const auto & l_procChip: l_procChips)
    {
        //Convert the TARGETING::Target into a fapi2::Target by passing
        //l_procChip into the fapi2::Target constructor
        fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>
                                           l_fapi2CpuTarget((l_procChip));

        // Call p9_throttle_sync
#ifndef CONFIG_AXONE
        TRACFCOMP( ISTEPS_TRACE::g_trac_isteps_trace,
                   "Running p9_throttle_sync HWP on target HUID %.8X",
                   TARGETING::get_huid(l_procChip) );
        FAPI_INVOKE_HWP( l_errl, p9_throttle_sync, l_fapi2CpuTarget );
#else
        TRACFCOMP( ISTEPS_TRACE::g_trac_isteps_trace,
                   "Running p9a_throttle_sync HWP on target HUID %.8X",
                   TARGETING::get_huid(l_procChip) );
        FAPI_INVOKE_HWP( l_errl, p9a_throttle_sync, l_fapi2CpuTarget );
#endif

        if (l_errl)
        {
            TRACFCOMP(ISTEPS_TRACE::g_trac_isteps_trace,
                      "ERROR 0x%.8X: p9_throttle_sync HWP returns error",
                      l_errl->reasonCode());

            // Capture the target data in the elog
            ErrlUserDetailsTarget(l_procChip).addToLog(l_errl);

            // Create IStep error log and cross reference
            //  to error that occurred
            io_istepError.addErrorDetails( l_errl );

            // Commit Error
            errlCommit( l_errl, HWPF_COMP_ID );

            break;
        }
        else
        {
            TRACFCOMP( ISTEPS_TRACE::g_trac_isteps_trace,
                       "SUCCESS : p9_throttle_sync HWP on 0x%.8X processor",
                       TARGETING::get_huid(l_procChip) );
        }
    }
}

};