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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/diag/prdf/common/plat/mem/prdfMemMark.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2016,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 __prdfMemMark_H
#define __prdfMemMark_H
// Framework includes
#include <iipServiceDataCollector.h>
#include <prdfExtensibleChip.H>
// Platform includes
#include <prdfMemAddress.H>
#include <prdfMemSymbol.H>
#include <prdfP9McaExtraSig.H>
#include <prdfPlatServices.H>
#ifdef __HOSTBOOT_MODULE
#include <prdfMemTdQueue.H>
#endif
//##############################################################################
// class MemMark
//##############################################################################
namespace PRDF
{
/** @brief Container for a memory mark (chip or symbol). */
class MemMark
{
public: // constructor
/** Default constructor. */
MemMark() = default;
/**
* @brief Constructor from components.
* @param i_trgt MBA or MCA target.
* @param i_rank The rank this mark is on.
* @param i_galois The Galois field.
*/
MemMark( TARGETING::TargetHandle_t i_trgt, const MemRank & i_rank,
uint8_t i_galois ) :
iv_galois( i_galois ),
iv_symbol( MemSymbol::fromGalois(i_trgt, i_rank, i_galois) )
{}
/**
* @brief Cosntructor from components.
* @param i_trgt MBA or MCA target.
* @param i_rank The rank this mark is on.
* @param i_symbol The symbol representing this mark.
*/
MemMark( TARGETING::TargetHandle_t i_trgt, const MemRank & i_rank,
const MemSymbol & i_symbol ) :
iv_galois( i_symbol.getGalois() ),
iv_symbol( i_symbol )
{}
public: // functions
/** @return The Galois field representing this mark. */
uint8_t getGalois() const { return iv_galois; }
/** @return The Galois field associated with the chip this mark is in.
* Will correspond to the rightmost/least index symbol in the chip. You
* must check for a valid symbol before calling this function. */
uint8_t getChipGalois() const
{
PRDF_ASSERT( iv_symbol.isValid() );
return symbol2Galois[(iv_symbol.getSymbol()/4)*4];
}
/** @return The symbol representing this mark. */
MemSymbol getSymbol() const { return iv_symbol; }
/** @return The symbol representing this mark. */
bool isValid() const { return iv_symbol.isValid(); }
private: // instance variables
/** Galois field representing any symbol on this mark. */
uint8_t iv_galois = 0;
/** Any symbol on this mark (must match iv_galois). */
MemSymbol iv_symbol = MemSymbol();
};
//##############################################################################
// Utilities to read/write markstore
//##############################################################################
namespace MarkStore
{
/**
* @brief Reads markstore and returns the chip mark for the given rank.
* @param i_chip MBA or MCA chip.
* @param i_rank Target rank.
* @param o_mark The returned chip mark.
* @return Non-SUCCESS if an internal function fails. SUCCESS otherwise.
*/
template<TARGETING::TYPE T>
uint32_t readChipMark( ExtensibleChip * i_chip, const MemRank & i_rank,
MemMark & o_mark );
/**
* @brief Writes a chip mark into markstore for the given rank.
* @param i_chip MBA or MCA chip.
* @param i_rank Target rank.
* @param i_mark Target chip mark.
* @return Non-SUCCESS if an internal function fails. SUCCESS otherwise.
*/
template<TARGETING::TYPE T>
uint32_t writeChipMark( ExtensibleChip * i_chip, const MemRank & i_rank,
const MemMark & i_mark );
/**
* @brief Clear chip mark in markstore for the given rank.
* @param i_chip MBA or MCA chip.
* @param i_rank Target rank.
* @return Non-SUCCESS if an internal function fails. SUCCESS otherwise.
*/
template<TARGETING::TYPE T>
uint32_t clearChipMark( ExtensibleChip * i_chip, const MemRank & i_rank );
/**
* @brief Reads markstore and returns the symbol mark for the given rank.
* @param i_chip MBA or MCA chip.
* @param i_rank Target rank.
* @param o_mark The returned symbol mark.
* @return Non-SUCCESS if an internal function fails. SUCCESS otherwise.
*/
template<TARGETING::TYPE T>
uint32_t readSymbolMark( ExtensibleChip * i_chip, const MemRank & i_rank,
MemMark & o_mark );
/**
* @brief Writes a symbol mark into markstore for the given rank.
* @param i_chip MBA or MCA chip.
* @param i_rank Target rank.
* @param i_mark Target symbol mark.
* @return Non-SUCCESS if an internal function fails. SUCCESS otherwise.
*/
template<TARGETING::TYPE T>
uint32_t writeSymbolMark( ExtensibleChip * i_chip, const MemRank & i_rank,
const MemMark & i_mark );
/**
* @brief Clear symbol mark in markstore for the given rank.
* @param i_chip MBA or MCA chip.
* @param i_rank Target rank.
* @return Non-SUCCESS if an internal function fails. SUCCESS otherwise.
*/
template<TARGETING::TYPE T>
uint32_t clearSymbolMark( ExtensibleChip * i_chip, const MemRank & i_rank );
#ifdef __HOSTBOOT_MODULE // Not supported on FSP.
/**
* @brief Applies RAS policies on a rank of memory based on based on the number
* of repairs available on that rank.
*
* Function details:
* - Removes the symbol mark if it is on the same DRAM as the chip mark.
* - Adds the following to the callout list if they exist: chip mark, symbol
* mark, DRAM spares, and ECC spare.
* - Makes the error log predictive and exits if DRAM repairs are disabled.
* - Makes the error log predictive and bans TPS on this rank if all available
* repairs have been used.
* - Returns a new DsdEvent if DRAM sparing is available.
*
* @param i_chip MBA or MCA chip.
* @param i_rank Target rank.
* @param io_sc The step code data struct.
* @param o_dsdEvent A new DsdEvent if DRAM sparing is available. Otherwise,
* nullptr. Note that this is not used in all cases so the
* event will need to be manually deleted if not added to the
* TD queue.
* @return Non-SUCCESS if an internal function fails. SUCCESS otherwise.
*/
template<TARGETING::TYPE T>
uint32_t applyRasPolicies( ExtensibleChip * i_chip, const MemRank & i_rank,
STEP_CODE_DATA_STRUCT & io_sc,
TdEntry * & o_dsdEvent );
/**
* @brief If a chip mark has been verified or explicitly set due other RAS
* policies, this function does all the necessary cleanup.
*
* Function details:
* - Calls applyRasPolicies() to make any necessary callouts.
* - If DRAM repairs are not disabled:
* - Sets the DRAM in the DRAM Repair VPD if DRAM repairs.
* - Adds a DSD procedure to the TD queue if a DRAM spare is available
*
* @param i_chip MBA or MCA chip.
* @param i_rank Target rank.
* @param io_sc The step code data struct.
* @return Non-SUCCESS if an internal function fails. SUCCESS otherwise.
*/
template<TARGETING::TYPE T>
uint32_t chipMarkCleanup( ExtensibleChip * i_chip, const MemRank & i_rank,
STEP_CODE_DATA_STRUCT & io_sc );
#endif // Not supported on FSP.
} // end namespace MarkStore
} // end namespace PRDF
#endif // __prdfMemMark_H
|
