163 lines
6.6 KiB
C++
163 lines
6.6 KiB
C++
/* IBM_PROLOG_BEGIN_TAG */
|
|
/* This is an automatically generated prolog. */
|
|
/* */
|
|
/* $Source: src/import/chips/p9/procedures/utils/stopreg/p9_stop_api.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 */
|
|
#ifndef __P9_STOP_IMAGE_API_
|
|
#define __P9_STOP_IMAGE_API_
|
|
|
|
#include <stdint.h>
|
|
|
|
#ifdef __SKIBOOT__
|
|
#include <skiboot.h>
|
|
#endif
|
|
|
|
///
|
|
/// @file p9_stop_api.H
|
|
/// @brief describes STOP API which create/manipulate STOP image.
|
|
///
|
|
// *HWP HW Owner : Greg Still <stillgs@us.ibm.com>
|
|
// *HWP FW Owner : Prem Shanker Jha <premjha2@in.ibm.com>
|
|
// *HWP Team : PM
|
|
// *HWP Level : 2
|
|
// *HWP Consumed by : HB:HYP
|
|
|
|
#ifdef __cplusplus
|
|
namespace stopImageSection
|
|
{
|
|
#endif
|
|
|
|
/**
|
|
* @brief all SPRs and MSR for which register restore is to be supported.
|
|
* @note STOP API design has built in support to accomodate 8 register of
|
|
* scope core and thread each.
|
|
*/
|
|
typedef enum
|
|
{
|
|
P9_STOP_SPR_DAWR = 180, // thread register
|
|
P9_STOP_SPR_HSPRG0 = 304, // thread register
|
|
P9_STOP_SPR_HRMOR = 313, // core register
|
|
P9_STOP_SPR_LPCR = 318, // thread register
|
|
P9_STOP_SPR_HMEER = 337, // core register
|
|
P9_STOP_SPR_LDBAR = 850, // thread register
|
|
P9_STOP_SPR_PSSCR = 855, // thread register
|
|
P9_STOP_SPR_PMCR = 884, // core register
|
|
P9_STOP_SPR_HID = 1008, // core register
|
|
P9_STOP_SPR_MSR = 2000, // thread register
|
|
} CpuReg_t;
|
|
|
|
/**
|
|
* @brief lists all the bad error codes.
|
|
*/
|
|
typedef enum
|
|
{
|
|
STOP_SAVE_SUCCESS = 0,
|
|
STOP_SAVE_ARG_INVALID_IMG = 1,
|
|
STOP_SAVE_ARG_INVALID_REG = 2,
|
|
STOP_SAVE_ARG_INVALID_THREAD = 3,
|
|
STOP_SAVE_ARG_INVALID_MODE = 4,
|
|
STOP_SAVE_ARG_INVALID_CORE = 5,
|
|
STOP_SAVE_SPR_ENTRY_NOT_FOUND = 6,
|
|
STOP_SAVE_SPR_ENTRY_UPDATE_FAILED = 7,
|
|
STOP_SAVE_SCOM_INVALID_OPERATION = 8,
|
|
STOP_SAVE_SCOM_INVALID_SECTION = 9,
|
|
STOP_SAVE_SCOM_INVALID_ADDRESS = 10,
|
|
STOP_SAVE_SCOM_INVALID_CHIPLET = 11,
|
|
STOP_SAVE_SCOM_ENTRY_UPDATE_FAILED = 12,
|
|
STOP_SAVE_INVALID_FUSED_CORE_STATUS = 13,
|
|
STOP_SAVE_FAIL = 14, // for internal failure within firmware.
|
|
} StopReturnCode_t;
|
|
|
|
/**
|
|
* @brief summarizes all operations supported on scom entries of STOP image.
|
|
*/
|
|
typedef enum
|
|
{
|
|
P9_STOP_SCOM_OP_MIN = 0,
|
|
P9_STOP_SCOM_APPEND = 1,
|
|
P9_STOP_SCOM_REPLACE = 2,
|
|
P9_STOP_SCOM_OR = 3,
|
|
P9_STOP_SCOM_AND = 4,
|
|
P9_STOP_SCOM_NOOP = 5,
|
|
P9_STOP_SCOM_RESET = 6,
|
|
P9_STOP_SCOM_OR_APPEND = 7,
|
|
P9_STOP_SCOM_AND_APPEND = 8,
|
|
P9_STOP_SCOM_OP_MAX = 9
|
|
} ScomOperation_t;
|
|
|
|
/**
|
|
* @brief All subsections that contain scom entries in a STOP image.
|
|
*/
|
|
typedef enum
|
|
{
|
|
P9_STOP_SECTION_MIN = 0,
|
|
P9_STOP_SECTION_CORE_SCOM = 1,
|
|
P9_STOP_SECTION_EQ_SCOM = 2,
|
|
P9_STOP_SECTION_L2 = 3,
|
|
P9_STOP_SECTION_L3 = 4,
|
|
P9_STOP_SECTION_MAX = 5
|
|
} ScomSection_t;
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
/**
|
|
* @brief Updates STOP image entry associated with CPU register.
|
|
* @param[in] i_pImage start address of homer image associated with processor.
|
|
* @param[in] i_regId id of SPR for which STOP image needs to be updated.
|
|
* @param[in] i_regData data to be restored in SPR register.
|
|
* @param[in] i_pir value of processor identification register (PIR)
|
|
* @return STOP_SAVE_SUCCESS SUCCESS if image is updated successfully, error
|
|
* code otherwise.
|
|
*/
|
|
|
|
StopReturnCode_t p9_stop_save_cpureg( void* const i_pImage,
|
|
const CpuReg_t i_regId,
|
|
const uint64_t i_regData,
|
|
const uint64_t i_pir );
|
|
|
|
/**
|
|
* @brief Updates scom image entry associated with given core or cache in
|
|
* STOP section of homer image.
|
|
* @param[in] i_pImage start address of homer image of P9 chip.
|
|
* @param[in] i_scomAddress fully qualified address of SCOM register.
|
|
* @param[in] i_scomData data associated with SCOM register.
|
|
* @param[in] i_operation operation to be done on SCOM image entry.
|
|
* @param[in] i_section area to which given SCOM entry belongs.
|
|
* @return STOP_SAVE_SUCCESS if image is updated successfully, error code
|
|
* otherwise.
|
|
* @note API is intended to update SCOM image entry associated with given
|
|
* core or given part of a cache section. API doesn't validate if
|
|
* a given SCOM address really belongs to given section.
|
|
*/
|
|
StopReturnCode_t p9_stop_save_scom( void* const i_pImage,
|
|
const uint32_t i_scomAddress,
|
|
const uint64_t i_scomData,
|
|
const ScomOperation_t i_operation,
|
|
const ScomSection_t i_section );
|
|
|
|
#ifdef __cplusplus
|
|
} // extern "C"
|
|
}; // namespace stopImageSection ends
|
|
#endif //__cplusplus
|
|
|
|
#endif //__P9_STOP_IMAGE_API_
|