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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/diag/prdf/plat/pegasus/prdfCenMbaTdCtlr_ipl.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2014 */
/* [+] 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 prdfCenMbaTdCtlr_ipl.H
* @brief The Hostboot implementation of the MBA TD Controller.
*/
#ifndef __prdfCenMbaTdCtlr_ipl_H
#define __prdfCenMbaTdCtlr_ipl_H
#include <prdfCenMbaTdCtlr_common.H>
namespace PRDF
{
/**
* @brief A state machine for memory targeted diagnostics during Hostboot MDIA.
*/
class CenMbaTdCtlr : public CenMbaTdCtlrCommon
{
private: // constants, enums
// Function pointers for maintenance command complete events.
typedef int32_t (CenMbaTdCtlr::*FUNCS)( STEP_CODE_DATA_STRUCT & io_sc,
const CenAddr & i_stopAddr,
const CenAddr & i_endAddr );
public: // functions
/**
* @brief Constructor
*
* This contructor will be called in the MBA data bundle code. Therefore,
* no register reads/writes can be done in this constructor. Anything needed
* to initialize the instance variables that requires register reads/writes
* or is non-trivial should be done in initialize().
*
* @param i_mbaChip An MBA chip.
*/
explicit CenMbaTdCtlr( ExtensibleChip * i_mbaChip ) :
CenMbaTdCtlrCommon(i_mbaChip)
{}
public: // Overloaded functions
int32_t handleCmdCompleteEvent( STEP_CODE_DATA_STRUCT & io_sc );
int32_t handleTdEvent( STEP_CODE_DATA_STRUCT & io_sc,
const CenRank & i_rank, const TdType i_event,
bool i_banTps = false );
private: // Overloaded functions
int32_t initialize();
int32_t analyzeCmdComplete( STEP_CODE_DATA_STRUCT & io_sc,
const CenAddr & i_stopAddr,
const CenAddr & i_endAddr );
int32_t analyzeVcmPhase1( STEP_CODE_DATA_STRUCT & io_sc,
const CenAddr & i_stopAddr,
const CenAddr & i_endAddr );
int32_t analyzeVcmPhase2( STEP_CODE_DATA_STRUCT & io_sc,
const CenAddr & i_stopAddr,
const CenAddr & i_endAddr );
int32_t analyzeDsdPhase1( STEP_CODE_DATA_STRUCT & io_sc,
const CenAddr & i_stopAddr,
const CenAddr & i_endAddr );
int32_t analyzeDsdPhase2( STEP_CODE_DATA_STRUCT & io_sc,
const CenAddr & i_stopAddr,
const CenAddr & i_endAddr );
int32_t analyzeTpsPhase1( STEP_CODE_DATA_STRUCT & io_sc,
const CenAddr & i_stopAddr,
const CenAddr & i_endAddr );
int32_t analyzeTpsPhase2( STEP_CODE_DATA_STRUCT & io_sc,
const CenAddr & i_stopAddr,
const CenAddr & i_endAddr );
int32_t startVcmPhase1( STEP_CODE_DATA_STRUCT & io_sc );
int32_t startVcmPhase2( STEP_CODE_DATA_STRUCT & io_sc );
int32_t startDsdPhase1( STEP_CODE_DATA_STRUCT & io_sc );
int32_t startDsdPhase2( STEP_CODE_DATA_STRUCT & io_sc );
int32_t startTpsPhase1( STEP_CODE_DATA_STRUCT & io_sc );
int32_t startTpsPhase2( STEP_CODE_DATA_STRUCT & io_sc );
public: // functions
/**
* @brief Start the initial background scrub. This is done at the very end
* of Hostboot after the last call to checkForIplAttns().
* @return Non-SUCCESS if an internal function fails, SUCCESS otherwise.
*/
int32_t startInitialBgScrub();
private: // functions
/**
* @brief Handle UEs during TD analysis.
* @param io_sc Service data collector.
* @return Non-SUCCESS if an internal function fails, SUCCESS otherwise.
*/
int32_t handleUE( STEP_CODE_DATA_STRUCT & io_sc );
/**
* @brief Handle MPE event
* @param io_sc Service data collector.
* @note This will start VCM phase 1.
* @return Non-SUCCESS if an internal function fails, SUCCESS otherwise.
*/
int32_t handleMPE( STEP_CODE_DATA_STRUCT & io_sc );
/**
* @brief Handle CE ETE during MNFG CE analysis.
* @param io_sc Service data collector.
* @return Non-SUCCESS if an internal function fails, SUCCESS otherwise.
*/
int32_t handleMnfgCeEte( STEP_CODE_DATA_STRUCT & io_sc );
/**
* @brief Sends a message to MDIA that a maintenance command has completed.
* @note If for some reason PRD needed to do some targeted diagnotics and
* on a rank that was not the last rank behind the MBA, this
* function will need to send a message to MDIA indicating that the
* command stopped and MDIA will need to restart the pattern testing
* from the next address to the end of memory.
* @return Non-SUCCESS if an internal function fails, SUCCESS otherwise.
*/
int32_t signalMdiaCmdComplete();
/**
* @brief Does mnfg setup for CE threshold.
* @note Before calling this function, set current state to new
* value (TPS_PHASE_1/ TPS_PHASE_2).
* @return Non-SUCCESS if an internal function fails, SUCCESS otherwise.
*/
int32_t mnfgCeSetup();
private: // instance variables
/** Array of functions pointers for TD controller states. This is used to
* determine the next course of action after a maintenance command complete
* attention.
*/
static FUNCS cv_cmdCompleteFuncs[MAX_TD_STATE];
}; // CenMbaTdCtlr
} // end namespace PRDF
#endif // __prdfCenMbaTdCtlr_ipl_H
|
