summaryrefslogtreecommitdiffstats
path: root/src/usr/diag/prdf/common/plat/mem/prdfMemDbUtils.H
blob: 9028dec8e6e43e8d30548d14da9a18ee49a8bd03 (plain)
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
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/diag/prdf/common/plat/mem/prdfMemDbUtils.H $          */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 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 prdfMemDbUtils_H
#define prdfMemDbUtils_H

#include <prdfCenMbaDataBundle.H>
#include <prdfP9McaDataBundle.H>

namespace PRDF
{

namespace MemDbUtils
{

//##############################################################################
//                                 Generic wrappers
//##############################################################################

/**
 * @brief  Generic wrapper to add an entry to the CE table.
 * @param  i_chip   MCA or MBA.
 * @param  i_addr   CE address.
 * @param  i_symbol CE symbol.
 * @param  i_isHard True if this was a hard CE. False otherwise.
 * @return Non-SUCCESS if an internal function fails, SUCCESS otherwise.
 */
template<TARGETING::TYPE T>
uint32_t addCeTableEntry( ExtensibleChip * i_chip, const MemAddr & i_addr,
                          const MemSymbol & i_symbol, bool i_isHard );

template<> inline
uint32_t addCeTableEntry<TARGETING::TYPE_MCA>( ExtensibleChip * i_chip,
                                               const MemAddr & i_addr,
                                               const MemSymbol & i_symbol,
                                               bool i_isHard )
{
    return getMcaDataBundle(i_chip)->iv_ceTable.addEntry( i_addr, i_symbol,
                                                          i_isHard );
}

template<> inline
uint32_t addCeTableEntry<TARGETING::TYPE_MBA>( ExtensibleChip * i_chip,
                                               const MemAddr & i_addr,
                                               const MemSymbol & i_symbol,
                                               bool i_isHard )
{
    return getMbaDataBundle(i_chip)->iv_ceTable.addEntry( i_addr, i_symbol,
                                                          i_isHard );
}

/**
 * @brief  Generic wrapper to add an entry to the UE table.
 * @param  i_chip MCA or MBA.
 * @param  i_type UE table entry type.
 * @param  i_addr UE address.
 * @return Non-SUCCESS if an internal function fails, SUCCESS otherwise.
 */
template<TARGETING::TYPE T>
void addUeTableEntry( ExtensibleChip * i_chip, UE_TABLE::Type i_type,
                      const MemAddr & i_addr );

template<> inline
void addUeTableEntry<TARGETING::TYPE_MCA>( ExtensibleChip * i_chip,
                                           UE_TABLE::Type i_type,
                                           const MemAddr & i_addr )
{
    getMcaDataBundle(i_chip)->iv_ueTable.addEntry( i_type, i_addr );
}

template<> inline
void addUeTableEntry<TARGETING::TYPE_MBA>( ExtensibleChip * i_chip,
                                           UE_TABLE::Type i_type,
                                           const MemAddr & i_addr )
{
    getMbaDataBundle(i_chip)->iv_ueTable.addEntry( i_type, i_addr );
}

//##############################################################################
//                         Hostboot IPL/Runtime wrappers
//##############################################################################

#ifdef __HOSTBOOT_MODULE

/**
 * @brief  Generic wrapper to push a TdEntry to the Targeted Diagnostics queue.
 * @param  i_chip  MCA or MBA.
 * @param  i_entry The new TdEntry.
 * @return Non-SUCCESS if an internal function fails, SUCCESS otherwise.
 */
template<TARGETING::TYPE T>
void pushToQueue( ExtensibleChip * i_chip, TdEntry * i_entry );

template<> inline
void pushToQueue<TARGETING::TYPE_MCA>( ExtensibleChip * i_chip,
                                       TdEntry * i_entry )
{
    getMcaDataBundle(i_chip)->getTdCtlr()->pushToQueue( i_entry );
}

template<> inline
void pushToQueue<TARGETING::TYPE_MBA>( ExtensibleChip * i_chip,
                                       TdEntry * i_entry )
{
    getMbaDataBundle(i_chip)->getTdCtlr()->pushToQueue( i_entry );
}

#endif // Hostboot IPL/Runtime

//##############################################################################
//                          Hostboot IPL only wrappers
//##############################################################################

#if defined(__HOSTBOOT_MODULE) && !defined(__HOSTBOOT_RUNTIME)

/**
 * @brief  Generic wrapper to get a pointer to the MemIplCeStats object from the
 *         data bundle of the given chip.
 * @param  i_chip MCA or MBA.
 * @return Non-SUCCESS if an internal function fails, SUCCESS otherwise.
 */
template<TARGETING::TYPE T>
MemIplCeStats<T> * getIplCeStats( ExtensibleChip * i_chip );

template<> inline
MemIplCeStats<TARGETING::TYPE_MCA> * getIplCeStats( ExtensibleChip * i_chip )
{
    return getMcaDataBundle(i_chip)->getIplCeStats();
}

template<> inline
MemIplCeStats<TARGETING::TYPE_MBA> * getIplCeStats( ExtensibleChip * i_chip )
{
    return getMbaDataBundle(i_chip)->getIplCeStats();
}

#endif // Hostboot IPL only

//##############################################################################
//                          Hostboot Runtime only wrappers
//##############################################################################

#if defined(__HOSTBOOT_MODULE) && defined(__HOSTBOOT_RUNTIME)

/**
 * @brief  Generic wrapper to tell the TD controller to process the next event
 *         in the TD queue.
 * @param  i_chip  MCA or MBA.
 * @param  io_sc   The step code data struct.
 * @return Non-SUCCESS if an internal function fails, SUCCESS otherwise.
 */
template<TARGETING::TYPE T>
uint32_t handleTdEvent( ExtensibleChip * i_chip,
                        STEP_CODE_DATA_STRUCT & io_sc );

template<> inline
uint32_t handleTdEvent<TARGETING::TYPE_MCA>( ExtensibleChip * i_chip,
                                             STEP_CODE_DATA_STRUCT & io_sc )
{
    return getMcaDataBundle(i_chip)->getTdCtlr()->handleTdEvent( io_sc );
}

template<> inline
uint32_t handleTdEvent<TARGETING::TYPE_MBA>( ExtensibleChip * i_chip,
                                             STEP_CODE_DATA_STRUCT & io_sc )
{
    return getMbaDataBundle(i_chip)->getTdCtlr()->handleTdEvent( io_sc );
}

/**
 * @brief Generic wrapper to tell the TD controller to ban TPS on a rank.
 * @param i_chip  MCA or MBA.
 * @param i_rank  The target slave rank.
 */
template<TARGETING::TYPE T>
void banTps( ExtensibleChip * i_chip, const MemRank & i_rank );

template<> inline
void banTps<TARGETING::TYPE_MCA>( ExtensibleChip * i_chip,
                                  const MemRank & i_rank )
{
    getMcaDataBundle(i_chip)->getTdCtlr()->banTps( i_chip, i_rank );
}

template<> inline
void banTps<TARGETING::TYPE_MBA>( ExtensibleChip * i_chip,
                                  const MemRank & i_rank )
{
    getMbaDataBundle(i_chip)->getTdCtlr()->banTps( i_chip, i_rank );
}

#endif // Hostboot Runtime only

} // end namespace MemDbUtils

} // end namespace PRDF

#endif // prdfMemDbUtils_H
OpenPOWER on IntegriCloud