Skip to content

Commit

Permalink
p9_pm_pstate_gpe_init Level 2
Browse files Browse the repository at this point in the history 
- Include fapi2::delay for polling and overall timeout calculation
- Unit tested with Suet
- Awan tested with real Hcode to set "PGPEActive" bit

Change-Id: I8d03988b82813542d8e4a40ed6b577838850baf5
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/21583
Tested-by: Hostboot CI <hostboot-ci+hostboot@us.ibm.com>
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Reviewed-by: Gregory S. Still <stillgs@us.ibm.com>
Tested-by: PPE CI <ppe-ci+hostboot@us.ibm.com>
Reviewed-by: Prem Shanker Jha <premjha2@in.ibm.com>
Reviewed-by: Jennifer A. Stofer <stofer@us.ibm.com>
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/21585
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Tested-by: Jenkins OP Build CI <op-jenkins+hostboot@us.ibm.com>
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>
  • Loading branch information
@stillgs @dcrowell77
stillgs authored and dcrowell77 committed Feb 27, 2017
1 parent b3d511e commit 708c686
Show file tree
Hide file tree
Showing 4 changed files with 446 additions and 0 deletions.
253 changes: 253 additions & 0 deletions src/import/chips/p9/procedures/hwp/pm/p9_pm_pstate_gpe_init.C
View file
@@ -0,0 +1,253 @@
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/import/chips/p9/procedures/hwp/pm/p9_pm_pstate_gpe_init.C $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2015,2017 */
/* [+] 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_pm_pstate_gpe_init.C
/// @brief Stop, reset and initalize/start the Pstate GPE
///
// *HWP HWP Owner: Greg Still <stillgs@us.ibm.com>
// *HWP BackupHWP Owner: Amit Kumar <akumar3@us.ibm.com>
// *HWP FW Owner: Sangeetha T S <sangeet2@in.ibm.com>
// *HWP Team: PM
// *HWP Level: 2
// *HWP Consumed by: FSP:HS

// -----------------------------------------------------------------------------
// Includes
// -----------------------------------------------------------------------------
#include <p9_pm_pstate_gpe_init.H>

// -----------------------------------------------------------------------------
// Constants
// -----------------------------------------------------------------------------
// @todo RTC 148540 Refine this values for the lab
// Following constants hold an approximate value.
static const uint32_t PGPE_TIMEOUT_MS = 500;
static const uint32_t PGPE_TIMEOUT_MCYCLES = 20;
static const uint32_t PGPE_POLLTIME_MS = 20;
static const uint32_t PGPE_POLLTIME_MCYCLES = 2;
static const uint32_t TIMEOUT_COUNT = PGPE_TIMEOUT_MS / PGPE_POLLTIME_MS;

// -----------------------------------------------------------------------------
// Function definitions
// -----------------------------------------------------------------------------

// -----------------------------------------------------------------------------
// Pstate GPE Initialization Function
// -----------------------------------------------------------------------------

/// @brief Initializes the Pstate GPE and related Pstate functions on a chip
///
/// @param [in] i_target Chip target
///
/// @retval FAPI_RC_SUCCESS else ERROR defined in xml

fapi2::ReturnCode pstate_gpe_init(
const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target)
{
fapi2::buffer<uint64_t> l_data64;
fapi2::buffer<uint64_t> l_occ_scratch2;
fapi2::buffer<uint64_t> l_xcr;
fapi2::buffer<uint64_t> l_xsr;
fapi2::buffer<uint64_t> l_ivpr;
uint32_t l_ivpr_offset;
uint32_t l_timeout_counter = TIMEOUT_COUNT;

FAPI_IMP(">> pstate_gpe_init......");

FAPI_TRY( FAPI_ATTR_GET(fapi2::ATTR_PSTATEGPE_BOOT_COPIER_IVPR_OFFSET,
i_target,
l_ivpr_offset),
"Error getting ATTR_PSTATEGPE_BOOT_COPIER_IVPR_OFFSET");


// Program PGPE IVPR
l_ivpr.flush<0>().insertFromRight<0, 32>(l_ivpr_offset);
FAPI_INF(" Writing IVPR with 0x%16llX", l_ivpr);
FAPI_TRY(putScom(i_target, PU_GPE2_GPEIVPR_SCOM, l_ivpr));

// Clear the PGPE active bit before attempting the boot
FAPI_TRY(getScom(i_target, PU_OCB_OCI_OCCS2_SCOM, l_occ_scratch2));
FAPI_INF(" Clear PGPE_ACTIVE in OCC Scratch 2 Register...");
l_occ_scratch2.clearBit<p9hcd::PGPE_ACTIVE>();
FAPI_TRY(putScom(i_target, PU_OCB_OCI_OCCS2_SCOM, l_occ_scratch2));

// Program XCR to ACTIVATE PGPE
// @todo RTC 146665 Operations to PPEs should use a p9ppe namespace
FAPI_INF(" Starting the PGPE...");
l_xcr.flush<0>().insertFromRight(p9hcd::HARD_RESET, 1, 3);
FAPI_TRY(putScom(i_target, PU_GPE2_PPE_XIXCR, l_xcr));
l_xcr.flush<0>().insertFromRight(p9hcd::TOGGLE_XSR_TRH, 1 , 3);
FAPI_TRY(putScom(i_target, PU_GPE2_PPE_XIXCR, l_xcr));
l_xcr.flush<0>().insertFromRight(p9hcd::RESUME, 1, 3);
FAPI_TRY(putScom(i_target, PU_GPE2_PPE_XIXCR, l_xcr));

// Now wait for PGPE to boot
FAPI_DBG(" Poll for PGPE Active for %d ms", PGPE_TIMEOUT_MS);
l_occ_scratch2.flush<0>();
l_xsr.flush<0>();

do
{
FAPI_TRY(getScom(i_target, PU_OCB_OCI_OCCS2_SCOM, l_occ_scratch2));
FAPI_TRY(getScom(i_target, PU_GPE2_GPEXIXSR_SCOM, l_xsr));
FAPI_DBG("OCC Scratch2: 0x%016lx; XSR: 0x%016lx Timeout: %d",
l_occ_scratch2, l_xsr, l_timeout_counter);
fapi2::delay(PGPE_POLLTIME_MS * 1000, PGPE_POLLTIME_MCYCLES * 1000 * 1000);
}
while((l_occ_scratch2.getBit<p9hcd::PGPE_ACTIVE>() != 1) &&
(l_xsr.getBit<p9hcd::HALTED_STATE>() != 1) &&
(--l_timeout_counter != 0));

if(( 1 == l_occ_scratch2.getBit<p9hcd::PGPE_ACTIVE>() ))
{
FAPI_INF("PGPE was activated successfully!!!!");
}

// @todo 146665 Need to collect PGPE state. Operations to PPEs should
// use a p9ppe namespace clase when created

// When PGPE fails to boot, assert out
FAPI_ASSERT((l_timeout_counter != 0 &&
l_occ_scratch2.getBit<p9hcd::PGPE_ACTIVE>() == 1 &&
l_xsr.getBit<p9hcd::HALTED_STATE>() != 1),
fapi2::PSTATE_GPE_INIT_TIMEOUT(),
"Pstate GPE Init timeout");

fapi_try_exit:
FAPI_IMP("<< pstate_gpe_init......");
return fapi2::current_err;
}

// -----------------------------------------------------------------------------
// Pstate GPE Reset Function
// -----------------------------------------------------------------------------

/// @brief Stops the Pstate GPE
///
/// @param [in] i_target Chip target
///
/// @retval FAPI_RC_SUCCESS else ERROR defined in xml

fapi2::ReturnCode pstate_gpe_reset(
const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target)
{

fapi2::buffer<uint64_t> l_data64;
uint32_t l_timeout_in_MS = 100;


FAPI_IMP(">> pstate_gpe_reset...");

// Program XCR to HALT PGPE
// @todo This should be replaced by a call to a common PPE service class
// ppe<PPE_TYPE_GPE>GPE2(3);
// GPE2.hard_reset();
FAPI_INF(" Send HALT command via XCR...");
l_data64.flush<0>().insertFromRight(p9hcd::HALT, 1, 3);
FAPI_TRY(putScom(i_target, PU_GPE2_PPE_XIXCR, l_data64));

// Now wait for PGPE to be halted.
// @todo This loop should be replace by a call to a common PPE service class
// FAPI_TRY(GPE2.is_halted(&b_halted_state,
// timeout_value_ns,
// timeout_value_simcycles));
FAPI_INF(" Poll for HALT State via XSR...");

do
{
FAPI_TRY(getScom(i_target, PU_GPE2_GPEXIXSR_SCOM, l_data64));
fapi2::delay(PGPE_POLLTIME_MS * 1000, PGPE_POLLTIME_MCYCLES * 1000 * 1000);
}
while((l_data64.getBit<p9hcd::HALTED_STATE>() == 0) &&
(--l_timeout_in_MS != 0));

// When PGPE fails to halt, then assert ot
FAPI_ASSERT((l_timeout_in_MS != 0),
fapi2::PSTATE_GPE_RESET_TIMEOUT(),
"PSTATE GPE Init timeout");

FAPI_TRY(getScom(i_target, PU_OCB_OCI_OCCS2_SCOM, l_data64));
FAPI_INF(" Clear PGPE_ACTIVE in OCC Flag Register...");
l_data64.flush<0>().clearBit<p9hcd::PGPE_ACTIVE>();
FAPI_TRY(putScom(i_target, PU_OCB_OCI_OCCS2_SCOM, l_data64));

fapi_try_exit:
FAPI_IMP("<< pstate_gpe_reset...");
return fapi2::current_err;

}

// -----------------------------------------------------------------------------
// p9_pm_pstate_gpe_init Function
// -----------------------------------------------------------------------------
fapi2::ReturnCode p9_pm_pstate_gpe_init(
const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target,
const p9pm::PM_FLOW_MODE i_mode)
{
FAPI_IMP("> p9_pm_pstate_gpe_init");

const char* PM_MODE_NAME_VAR; //Defines storage for PM_MODE_NAME
FAPI_INF("Executing p9_pstate_gpe_init in mode %s", PM_MODE_NAME(i_mode));

// Boot the PSTATE GPE
if (i_mode == p9pm::PM_INIT)
{
FAPI_TRY(pstate_gpe_init(i_target),
"ERROR: failed to initialize Pstate GPE");

// Setup the PBA channels for run-time operation (eg when the PPC405 and its GPEs are active).
FAPI_EXEC_HWP(fapi2::current_err,
p9_pm_pba_init,
i_target,
p9pm::PM_INIT);

FAPI_ASSERT(fapi2::current_err == fapi2::FAPI2_RC_SUCCESS,
fapi2::PSTATE_GPE_PBA_INIT_FAILED()
.set_TARGET(i_target)
.set_MODE(p9pm::PM_INIT),
"PBA setup failed");
}

// Reset the PSTATE GPE
else if (i_mode == p9pm::PM_RESET)
{
FAPI_TRY(pstate_gpe_reset(i_target), "ERROR:failed to reset Pstate GPE");
}

// Unsupported Mode
else
{
FAPI_ERR("Unknown mode %x passed to p9_pstate_gpe_init.", i_mode);
FAPI_ASSERT(false,
fapi2::PSTATE_GPE_BAD_MODE()
.set_BADMODE(i_mode),
"ERROR; Unknown mode passed to pstate_gpe_init. Mode %x",
i_mode);
}

fapi_try_exit:
FAPI_INF("< p9_pm_pstate_gpe_init");
return fapi2::current_err;
}
92 changes: 92 additions & 0 deletions src/import/chips/p9/procedures/hwp/pm/p9_pm_pstate_gpe_init.H
View file
@@ -0,0 +1,92 @@
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/import/chips/p9/procedures/hwp/pm/p9_pm_pstate_gpe_init.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2015,2017 */
/* [+] 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_pm_pstate_gpe_init.H
/// @brief Initialize the STOP GPE Engine in the OCC
///
// *HWP HWP Owner: Greg Still <stillgs@us.ibm.com>
// *HWP BackupHWP Owner: Amit Kumar <akumar3@us.ibm.com>
// *HWP FW Owner: Sangeetha T S <sangeet2@in.ibm.com>
// *HWP Team: PM
// *HWP Level: 2
// *HWP Consumed by: FSP:HS
///
/// High-level procedure flow:
/// @verbatim
/// if PM_RESET
/// - Halt the PGPE
/// if PM_INIT
/// - Read the PGPE IVPR value, the address of boot copier in HOMER region.
/// - clear OCC Scratch2 flag indicating HCode init completion.
/// - Write to XCR to activate the PGPE
/// - Poll OCC Scratch 2 flag for HCode init completion
/// - Call p9_pm_pba_init in PM_INIT mode to activate the PBA channels for
/// runtime configuration.
/// @endverbatim

#ifndef _P9_PSTATE_GPEINIT_H_
#define _P9_PSTATE_GPEINIT_H_

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

#include <p9_pm.H>
#include <fapi2.H>
#include <p9_misc_scom_addresses.H>
#include <p9_hcd_common.H>
#include <p9_pm_hcd_flags.h>
#include <p9_pm_pba_init.H>


// function pointer typedef definition for HWP call support
typedef fapi2::ReturnCode (*p9_pm_pstate_gpe_init_FP_t) (
const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>&,
const p9pm::PM_FLOW_MODE);

// -----------------------------------------------------------------------------
// Function prototype
// -----------------------------------------------------------------------------
extern "C" {

/// @addtogroup pm_fapi
/// @{

/// @brief Initialize the Pstate GPE Engine in the OCC
///
/// @param [in] i_target Chip target
/// @param [in] i_mode Control mode PM_INIT, PM_RESET
///
/// @retval FAPI2_RC_SUCCESS on success, else error RC
///
fapi2::ReturnCode p9_pm_pstate_gpe_init(
const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target,
const p9pm::PM_FLOW_MODE i_mode);

/// @} end addtogroup

} // extern "C"

#endif // _P9_PSTATE_GPEINIT_H_
27 changes: 27 additions & 0 deletions src/import/chips/p9/procedures/hwp/pm/p9_pm_pstate_gpe_init.mk
View file
@@ -0,0 +1,27 @@
# IBM_PROLOG_BEGIN_TAG
# This is an automatically generated prolog.
#
# $Source: src/import/chips/p9/procedures/hwp/pm/p9_pm_pstate_gpe_init.mk $
#
# OpenPOWER HostBoot Project
#
# Contributors Listed Below - COPYRIGHT 2015,2017
# [+] 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
PROCEDURE=p9_pm_pstate_gpe_init
$(call ADD_MODULE_SRCDIR,$(PROCEDURE),$(ROOTPATH)/chips/p9/procedures/hwp/lib)
$(call BUILD_PROCEDURE)

0 comments on commit 708c686

Please sign in to comment.