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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/diag/prdf/common/plat/prdfPllDomain.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2016 */
/* [+] 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 prdfPllDomain_H
#define prdfPllDomain_H
#include <iipDomain.h>
#include <iipResolutionFactory.h>
#include <prdfExtensibleDomain.H>
#include <prdfParentDomain.H>
#include <prdfRuleChipDomain.H>
#include <prdfThresholdResolutions.H>
#ifndef __HOSTBOOT_MODULE
#include <hdctContent.H> // for hwTableContent
#endif
namespace PRDF
{
//------------------------------------------------------------------------------
class PllDomain : public RuleChipDomain, public ExtensibleDomain,
public ParentDomain<ExtensibleDomain>
{
public:
#ifdef __HOSTBOOT_MODULE
/**
* @brief Constructor
* @param DOMAIN_ID the domain ID
* @param Resolution to callout the correct clock source
* @param ThresholdResolution::ThresholdPolicy
*/
PllDomain( DOMAIN_ID domain_id, Resolution & clockSource,
const ThresholdResolution::ThresholdPolicy & i_mfgThresh );
/**
* @brief Constructor
* @param DOMAIN_ID the domain ID
* @param Resolution to callout the correct second clock source
* @param Resolution to callout the correct clock source
* @param ThresholdResolution::ThresholdPolicy
*/
PllDomain( DOMAIN_ID domain_id, Resolution & secondClockSource,
Resolution & clockSource,
const ThresholdResolution::ThresholdPolicy & i_mfgThresh );
#else // not __HOSTBOOT_MODULE
/**
* @brief Constructor
* @param DOMAIN_ID the domain ID
* @param Resolution to callout the correct clock source
* @param Dump content
* @param ThresholdResolution::ThresholdPolicy
*/
PllDomain( DOMAIN_ID domain_id, Resolution & clockSource,
hwTableContent i_hwdc,
const ThresholdResolution::ThresholdPolicy & i_mfgThresh );
/**
* @brief Constructor
* @param DOMAIN_ID the domain ID
* @param Resolution to callout the correct second clock source
* @param Resolution to callout the correct clock source
* @param Dump content
* @param ThresholdResolution::ThresholdPolicy
*/
PllDomain( DOMAIN_ID domain_id, Resolution & secondClockSource,
Resolution & clockSource,
hwTableContent i_hwdc,
const ThresholdResolution::ThresholdPolicy & i_mfgThresh );
#endif // not __HOSTBOOT_MODULE
/**
* @brief Perform any initialization required by the hardware
* @returns error code
* @post PLL errors cleared in hardware.
*/
virtual int32_t Initialize(void);
/**
* @brief Query if anything in this domain is at the attention type specified
* @param Attention type to query for. (@see iipsdbug.h)
* @returns [true|false]
* @pre Initialize()
*/
virtual bool Query(ATTENTION_TYPE attentionType);
/**
* @brief Analyze errors within the domain
* @param service data collector
* @param attentiont type (@see iipsdbug.h)
* @returns service data collector - completed
* @return return code
* @pre Initialize(); Query() == true
* @post domain element order may be modified.
*/
virtual int32_t Analyze( STEP_CODE_DATA_STRUCT & serviceData,
ATTENTION_TYPE attentionType );
/**
* @brief Domain level plugin function used to clear PLL attentions in a
* domain and its subdomains.
* @param i_domain The target PLL domain.
* @param i_sc The step code data struct.
* @return SUCCESS
*/
static int32_t ClearPll( ExtensibleDomain * i_domain,
STEP_CODE_DATA_STRUCT & i_sc );
/**
* @brief Domain level plugin function used to mask PLL attentions in a
* domain and its subdomains.
* @param i_domain The target PLL domain.
* @param i_sc The step code data struct.
* @return SUCCESS
*/
static int32_t MaskPll( ExtensibleDomain * i_domain,
STEP_CODE_DATA_STRUCT & i_sc );
/**
* @brief Domain level plugin function used to mask PLL attentions in a
* domain and its subdomains.
* @param i_domain The target PLL domain.
* @param i_sc The step code data struct.
* @param i_oscPos osc position (only used by IO pcie domain)
* @return SUCCESS
*/
static int32_t MaskPllIo( ExtensibleDomain * i_domain,
STEP_CODE_DATA_STRUCT & i_sc,
uint32_t i_oscPos );
protected:
/**
* @brief Order the domain - with detecting element at the top
* @param Attention type (@see iipsdbug.h)
* @post domain elemenet order may be altered
* @note this is called by Analyze()
*/
virtual void Order(ATTENTION_TYPE attentionType);
private: // Data
enum { CONTAINER_SIZE = 8 };
Resolution & closeClockSource;
Resolution & farClockSource;
Resolution & iv_threshold;
#ifndef __HOSTBOOT_MODULE
hwTableContent iv_dumpContent;
#endif
};
//------------------------------------------------------------------------------
#ifdef __HOSTBOOT_MODULE
inline
PllDomain::PllDomain( DOMAIN_ID domain_id, Resolution & clockSource,
const ThresholdResolution::ThresholdPolicy& i_mfgThresh) :
RuleChipDomain( domain_id, PllDomain::CONTAINER_SIZE ),
ExtensibleDomain("PllDomain"),
closeClockSource(clockSource),
farClockSource(clockSource),
iv_threshold( ResolutionFactory::Access().GetThresholdResolution( 1,
ThresholdResolution::cv_pllDefault,
i_mfgThresh ) )
{
}
inline
PllDomain::PllDomain( DOMAIN_ID domain_id, Resolution & secondClockSource,
Resolution & clockSource,
const ThresholdResolution::ThresholdPolicy& i_mfgThresh) :
RuleChipDomain( domain_id, PllDomain::CONTAINER_SIZE ),
ExtensibleDomain("PllDomain"),
closeClockSource(secondClockSource),
farClockSource(clockSource),
iv_threshold( ResolutionFactory::Access().GetThresholdResolution( 1,
ThresholdResolution::cv_pllDefault,
i_mfgThresh ) )
{
}
#else // not __HOSTBOOT_MODULE
inline
PllDomain::PllDomain( DOMAIN_ID domain_id, Resolution & clockSource,
hwTableContent i_hwdc,
const ThresholdResolution::ThresholdPolicy& i_mfgThresh) :
RuleChipDomain( domain_id, PllDomain::CONTAINER_SIZE ),
ExtensibleDomain("PllDomain"),
closeClockSource(clockSource),
farClockSource(clockSource),
iv_threshold( ResolutionFactory::Access().GetThresholdResolution( 1,
ThresholdResolution::cv_pllDefault,
i_mfgThresh ) ),
iv_dumpContent(i_hwdc)
{
}
inline
PllDomain::PllDomain( DOMAIN_ID domain_id, Resolution & secondClockSource,
Resolution & clockSource,
hwTableContent i_hwdc,
const ThresholdResolution::ThresholdPolicy& i_mfgThresh) :
RuleChipDomain( domain_id, PllDomain::CONTAINER_SIZE ),
ExtensibleDomain("PllDomain"),
closeClockSource(secondClockSource),
farClockSource(clockSource),
iv_threshold( ResolutionFactory::Access().GetThresholdResolution( 1,
ThresholdResolution::cv_pllDefault,
i_mfgThresh ) ),
iv_dumpContent(i_hwdc)
{
}
#endif // not __HOSTBOOT_MODULE
//------------------------------------------------------------------------------
} // end namespace PRDF
#endif /* prdfPllDomain_H */
|
