1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/import/chips/p9/procedures/hwp/pm/p9_pm_recovery_ffdc_cme.H $ */
/* */
/* OpenPOWER HostBoot 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 */
#ifndef __PM_RECOVERY_FFDC_CME_
#define __PM_RECOVERY_FFDC_CME_
///
/// @file p9_pm_recovery_ffdc_cme.H
/// @brief Models CME platform for the FFDC collection of PM complex
///
/// *HWP HWP Owner: Greg Still <stillgs@us.ibm.com>
/// *HWP FW Owner: Prem S Jha <premjha2@in.ibm.com>
/// *HWP Team: PM
/// *HWP Level: 2
/// *HWP Consumed by: Hostboot
//
// *INDENT-OFF*
//--------------------------------------------------------------------------
// Includes
//--------------------------------------------------------------------------
#include <fapi2.H>
#include <stdint.h>
#include <p9_pm_recovery_ffdc_base.H>
namespace p9_stop_recov_ffdc
{
class PlatCme : public PlatPmComplex
{
public:
/// @brief constructor
PlatCme( const fapi2::Target< fapi2::TARGET_TYPE_PROC_CHIP > i_procChipTgt );
/// @brief destructor
virtual ~PlatCme() { };
/// @brief Initializes the CME FFDC Sub-Sections in HOMER with default headers
/// @param[in] i_pHomerBuf points to base of P9 HOMER.
/// @return fapi2 return code
fapi2::ReturnCode init ( void* i_pHomerBuf );
/// @brief collects FFDC pertaining to all functional CMEs in the chip.
/// @param[in] i_pHomerBuf points to base of P9 HOMER.
/// @param[in] i_ffdcType indicates the content type to collect
// @return fapi2 return code.
fapi2::ReturnCode collectFfdc( void* i_pHomerBuf,
uint8_t i_ffdcType = ALL );
/// @brief collects FFDC pertaining to a given CME target.
/// @param[in] i_pBuf points to base of FFDC buffer.
/// @param[in] i_dataType indicates the content type to collect
/// @param[in] i_exTgt ex target
/// @param[in] o_ffdcLength length of FFDC in bytes
/// @return fapi2 return code.
/// @note function intends to copy FFDC pertaining to CME and SGPE to
/// an error log.
fapi2::ReturnCode collectPartialFfdc( void * i_pBuf, FfdcDataType i_dataType,
fapi2::Target<fapi2::TARGET_TYPE_EX >& i_exTgt,
uint32_t & o_ffdcLength );
/// @brief generates summary of FFDC pertaining to a given platform.
/// @param[in] i_pHomer points to Homer base.
/// @return fapi2 return code
fapi2::ReturnCode generateSummary( void * i_pHomer );
private:
/// @brief collects trace info from a given CME SRAM buffer.
/// @param[in] i_pHomerBuf points to location of HOMER meant for CME Trace info.
/// @param[in] i_exTgt fapi2 target for ex
fapi2::ReturnCode collectTrace( uint8_t * i_pHomerBuf,
const fapi2::Target< fapi2::TARGET_TYPE_EX > & i_exTgt );
/// @brief collects global variables from a given CME's SRAM.
/// @param[in] i_pHomerBuf points to location of HOMER meant for CME's global variable
/// @param[in] i_exTgt fapi2 target for ex
fapi2::ReturnCode collectGlobals( uint8_t * i_pHomerBuf,
const fapi2::Target< fapi2::TARGET_TYPE_EX > & i_exTgt );
/// @brief collects internal register info for a given CME
/// @param[in] i_pHomerBuf points to location of HOMER meant for CME's internal register.
/// @param[in] i_exTgt fapi2 target for ex
/// @param[in] i_exPos EX target position
fapi2::ReturnCode collectInternalReg( uint8_t * i_pHomerBuf,
const fapi2::Target< fapi2::TARGET_TYPE_EX > & i_exTgt ,
const uint8_t i_exPos);
/// @brief collects CME Image Header info from CME SRAM buffer.
/// @param[in] i_pHomerBuf points to location of HOMER meant for CME's header.
/// @param[in] i_exTgt fapi2 target for ex
fapi2::ReturnCode collectImageHeader( uint8_t * i_pHomerBuf,
const fapi2::Target< fapi2::TARGET_TYPE_EX > & i_exTgt );
/// @brief updates the CME FFDC Header
///@param[in] i_pHomerBuf points to a location in HOMER meant for CME FFDC Header
///@param[in] i_cmePos position of CME instance
///param[in] i_sectionsValid bit vector summarizing FFDC validity
///@return fapi2 return code.
fapi2::ReturnCode updateCmeFfdcHeader( uint8_t* i_pHomerBuf, uint8_t i_cmePos,
uint16_t i_sectionsValid );
};
//---------------------------------------------------------------------------------------------
// function pointer typedef definition for HWP call support
typedef fapi2::ReturnCode( *p9_pm_recovery_ffdc_cme_FP_t )
( const fapi2::Target< fapi2::TARGET_TYPE_PROC_CHIP > & i_procChipTgt,
void * i_cmeFfdcBuf );
extern "C"
{
// -----------------------------------------------------------------------------
// Function prototypes
// -----------------------------------------------------------------------------
///
/// @brief Populates the PM FFDC section with FFDC collected from CME.
///
/// @param[in] i_procChipTarget Proc Chip target
/// @param[in] i_pHomerImage Pointer to the base of the chip HOMER region
///
/// @return FAPI2_RC_SUCCESS on success or error return code
///
fapi2::ReturnCode p9_pm_recovery_ffdc_cme
( const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_procChipTarget,
void* i_pHomerImage );
}
} //namespace p9_stop_recov_ffdc ends
#endif //__PM_RECOVERY_FFDC_CME_
|
