/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/diag/prdf/common/plat/axone/prdfMccPlugins.C $        */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 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                                                     */

// Framework includes
#include <iipServiceDataCollector.h>
#include <prdfExtensibleChip.H>
#include <prdfPluginMap.H>

// Platform includes
#include <prdfMemUtils.H>
#include <prdfPlatServices.H>
#include <prdfMemExtraSig.H>

using namespace TARGETING;

namespace PRDF
{

using namespace PlatServices;

namespace axone_mcc
{

//##############################################################################
//
//                             Special plugins
//
//##############################################################################

/**
 * @brief  Analysis code that is called before the main analyze() function.
 * @param  i_chip     A MCC chip.
 * @param  io_sc      The step code data struct.
 * @param  o_analyzed True if analysis is done on this chip, false otherwise.
 * @return Non-SUCCESS if an internal function fails, SUCCESS otherwise.
 */
int32_t PreAnalysis( ExtensibleChip * i_chip, STEP_CODE_DATA_STRUCT & io_sc,
                     bool & o_analyzed )
{
    // Check for a channel failure before analyzing this chip.
    o_analyzed = MemUtils::analyzeChnlFail<TYPE_MCC>( i_chip, io_sc );

    return SUCCESS;
}
PRDF_PLUGIN_DEFINE( axone_mcc, PreAnalysis );

/**
 * @brief  Plugin function called after analysis is complete but before PRD
 *         exits.
 * @param  i_chip A MCC chip.
 * @param  io_sc  The step code data struct.
 * @note   This is especially useful for any analysis that still needs to be
 *         done after the framework clears the FIR bits that were at attention.
 * @return SUCCESS.
 */
int32_t PostAnalysis( ExtensibleChip * i_chip, STEP_CODE_DATA_STRUCT & io_sc )
{
    // If there was a channel failure some cleanup is required to ensure
    // there are no more attentions from this channel.
    MemUtils::cleanupChnlFail<TYPE_MCC>( i_chip, io_sc );

    return SUCCESS;
}
PRDF_PLUGIN_DEFINE( axone_mcc, PostAnalysis );

//##############################################################################
//
//                                  DSTLFIR
//
//##############################################################################

/**
 * @brief  Plugin function called to avoid analyzing to a checkstop on an OCMB.
 * @param  i_chip A MCC chip.
 * @param  io_sc  The step code data struct.
 * @param  i_pos  Position of the OMI/OCMB relative to the MCC.
 * @return SUCCESS if the primary attn is CS, else PRD_SCAN_COMM_REGISTER_ZERO.
 */
int32_t checkOcmb( ExtensibleChip * i_chip, STEP_CODE_DATA_STRUCT & io_sc,
                   uint8_t i_pos )
{
    int32_t rc = PRD_SCAN_COMM_REGISTER_ZERO;

    #ifdef CONFIG_ENABLE_CHECKSTOP_ANALYSIS
    // We do not have support for the OCMB in the checkstop analysis path.
    // As such, we will simply indicate there is an attention from the OCMB and
    // add second level support and both sides of the bus as callouts.
    if ( CHECK_STOP == io_sc.service_data->getPrimaryAttnType() )
    {
        TargetHandle_t omi = getConnectedChild( i_chip->getTrgt(), TYPE_OMI,
                                                i_pos );
        ExtensibleChip * ocmb = getConnectedChild( i_chip, TYPE_OCMB_CHIP,
                                                   i_pos );

        io_sc.service_data->SetCallout( LEVEL2_SUPPORT, MRU_MED, NO_GARD );
        io_sc.service_data->SetCallout( omi, MRU_LOW, NO_GARD );
        io_sc.service_data->SetCallout( ocmb->getTrgt(), MRU_LOW, NO_GARD );

        rc = SUCCESS;
    }
    #endif

    return rc;
}

#define CHECK_OCMB_PLUGIN( POS ) \
int32_t checkOcmb_##POS( ExtensibleChip * i_chip, \
                         STEP_CODE_DATA_STRUCT & io_sc ) \
{ \
    return checkOcmb( i_chip, io_sc, POS ); \
} \
PRDF_PLUGIN_DEFINE( axone_mcc, checkOcmb_##POS );

CHECK_OCMB_PLUGIN( 0 );
CHECK_OCMB_PLUGIN( 1 );

} // end namespace axone_mcc

} // end namespace PRDF