/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/import/chips/p9/procedures/hwp/core/p9_hcd_core_scomcust.C $ */
/*                                                                        */
/* OpenPOWER sbe Project                                                  */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2015,2018                        */
/* [+] 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                                                     */
///
/// @file  p9_hcd_core_scomcust.C
/// @brief Core Customization SCOMs
///
/// Procedure Summary:
///   Dynamically built (and installed) routine that is inserted by the .XIP
///   Customization. process. (New for P9) (TODO: this part of the process is
///   a placeholder at this point)
///   Dynamically built pointer where a NULL is checked before execution
///   If NULL (a potential early value); return
///   Else call the function at the pointer;
///   pointer is filled in by XIP Customization

// *HWP HWP Owner          : David Du         <daviddu@us.ibm.com>
// *HWP Backup HWP Owner   : Greg Still       <stillgs@us.ibm.com>
// *HWP FW Owner           : Prem Shanker Jha <premjha2@in.ibm.com>
// *HWP Team               : PM
// *HWP Consumed by        : SBE:CME
// *HWP Level              : 3

//-----------------------------------------------------------------------------
// Includes
//-----------------------------------------------------------------------------

#include <p9_quad_scom_addresses.H>
#include <p9_hcd_common.H>
#include "p9_hcd_core_scomcust.H"
#include <p9_quad_scom_addresses_fld.H>

//-----------------------------------------------------------------------------
// Constant Definitions: Core Customization SCOMs
//-----------------------------------------------------------------------------

fapi2::ReturnCode
p9_hcd_core_scomcust(
    const fapi2::Target<fapi2::TARGET_TYPE_CORE>& i_target)
{
    FAPI_INF(">>p9_hcd_core_scomcust");
    fapi2::buffer<uint64_t> l_data64;

    FAPI_DBG("Drop chiplet fence via NET_CTRL0[18]");
    FAPI_TRY(putScom(i_target, C_NET_CTRL0_WAND, MASK_UNSET(18)));

    //Given auto special wakeup is enabled. Special wake-up signal must be
    //routed toward CME HW asserts DONE bit without CME Firmware's intervention.
    fapi2::ATTR_CHIP_UNIT_POS_Type l_corePos;
    FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_CHIP_UNIT_POS, i_target, l_corePos));
    FAPI_DBG("Enabling Auto Special Wakeup For Core %d", l_corePos );

    l_data64.flush<0>().setBit(EX_CPPM_CPMMR_WKUP_NOTIFY_SELECT);
    FAPI_TRY(putScom(i_target, C_CPPM_CPMMR_CLEAR, l_data64));

    FAPI_TRY(putScom(i_target, C_SPATTN_MASK, 0x2222222200000000ULL));

fapi_try_exit:

    FAPI_INF("<<p9_hcd_core_scomcust");
    return fapi2::current_err;
}