-
Notifications
You must be signed in to change notification settings - Fork 97
/
plat_wof_access.C
440 lines (392 loc) · 17.2 KB
/
plat_wof_access.C
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/fapi2/plat_wof_access.C $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2012,2017 */
/* [+] 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 plat_wof_access.C
*
* @brief Implements the GetWofTables function
*/
#include <stdint.h>
#include <fapi2.H>
#include <attribute_service.H>
#include <attributeenums.H>
#include <errl/errludattribute.H>
#include <errl/errlreasoncodes.H>
#include <util/utillidmgr.H>
#include <p9_pstates_common.h>
#include <initservice/initserviceif.H>
namespace fapi2
{
namespace platAttrSvc
{
const uint32_t WOF_IMAGE_MAGIC_VALUE = 0x57544948; // WTIH
const uint32_t WOF_TABLES_MAGIC_VALUE = 0x57465448; // WFTH
const uint32_t RES_VERSION_MASK = 0xFF;
const uint32_t WOF_IMAGE_VERSION = 1;
const uint32_t WOF_TABLES_VERSION = 1;
/*
WOF Tables In PNOR
---------------------------
| Image Header | Points to Section Table
|-------------------------|
| Section Table Entry 1 | Section Table
| Section Table Entry 2 | Each entry points to
| ... | a WOF Table
|-------------------------|
| WOF Tables Header 1 | WOF Table
| VRFT 1 | Returned if match
| VRFT 2 |
| ... |
|-------------------------|
| WOF Tables Header 2 | WOF Table
| VRFT 1 | Returned if match
| VRFT 2 |
| ... |
|-------------------------|
| ... |
---------------------------
The structs for the Image Header and
Section Table Entry are defined below.
The struct for the WOF Tables Header
is defined in p9_pstates_common.h.
*/
typedef struct __attribute__((__packed__)) wofImageHeader
{
uint32_t magicNumber;
uint8_t version;
uint8_t entryCount;
uint32_t offset;
} wofImageHeader_t;
typedef struct __attribute__((__packed__)) wofSectionTableEntry
{
uint32_t offset;
uint32_t size;
} wofSectionTableEntry_t;
fapi2::ReturnCode platParseWOFTables(uint8_t* o_wofData)
{
FAPI_DBG("Entering platParseWOFTables ....");
errlHndl_t l_errl = nullptr;
fapi2::ReturnCode l_rc = fapi2::FAPI2_RC_SUCCESS;;
TARGETING::Target * l_sys = nullptr;
TARGETING::Target * l_mProc = nullptr;
TARGETING::targetService().getTopLevelTarget(l_sys);
TARGETING::targetService().masterProcChipTargetHandle( l_mProc );
// Get the number of present cores
TARGETING::TargetHandleList l_coreTargetList;
TARGETING::getChildAffinityTargetsByState( l_coreTargetList,
l_mProc,
TARGETING::CLASS_UNIT,
TARGETING::TYPE_CORE,
TARGETING::UTIL_FILTER_PRESENT);
uint32_t l_numCores = l_coreTargetList.size();
// Choose a sort freq
uint32_t l_sortFreq = 0;
// Get the socket power
uint32_t l_socketPower = 0;
uint8_t l_wofPowerLimit =
l_sys->getAttr<TARGETING::ATTR_WOF_POWER_LIMIT>();
if(l_wofPowerLimit == TARGETING::WOF_POWER_LIMIT_TURBO)
{
l_socketPower =
l_sys->getAttr<TARGETING::ATTR_SOCKET_POWER_TURBO>();
l_sortFreq = l_sys->getAttr<TARGETING::ATTR_FREQ_CORE_MAX>();
}
else
{
l_socketPower =
l_sys->getAttr<TARGETING::ATTR_SOCKET_POWER_NOMINAL>();
l_sortFreq = l_sys->getAttr<TARGETING::ATTR_NOMINAL_FREQ_MHZ>();
}
// Get the frequencies
uint32_t l_nestFreq =
l_sys->getAttr<TARGETING::ATTR_FREQ_PB_MHZ>();
// Trace the input params
FAPI_INF("WOF table search: "
"Cores %d SocketPower 0x%X NestFreq 0x%X SortFreq 0x%X",
l_numCores, l_socketPower, l_nestFreq, l_sortFreq);
void* l_pWofImage = nullptr;
size_t l_lidImageSize = 0;
do {
// @todo RTC 172776 Make WOF table parser PNOR accesses more efficient
uint32_t l_lidNumber = Util::WOF_LIDID;
if( INITSERVICE::spBaseServicesEnabled() )
{
// Lid number is system dependent on FSP systems
l_lidNumber =
l_sys->getAttr<TARGETING::ATTR_WOF_TABLE_LID_NUMBER>();
}
UtilLidMgr l_wofLidMgr(l_lidNumber);
// Get the size of the full wof tables image
l_errl = l_wofLidMgr.getLidSize(l_lidImageSize);
if(l_errl)
{
FAPI_ERR("platParseWOFTables getLidSize failed");
l_rc.setPlatDataPtr(reinterpret_cast<void *>(l_errl));
break;
}
// Allocate space, remember to free it later
l_pWofImage = static_cast<void*>(malloc(l_lidImageSize));
// Get the tables from pnor or lid
l_errl = l_wofLidMgr.getLid(l_pWofImage, l_lidImageSize);
if(l_errl)
{
FAPI_ERR("platParseWOFTables getLid failed "
"pLidImage %p imageSize %d",
l_pWofImage, l_lidImageSize);
l_rc.setPlatDataPtr(reinterpret_cast<void *>(l_errl));
break;
}
// Get the Image Header
wofImageHeader_t* l_img =
reinterpret_cast<wofImageHeader_t*>(l_pWofImage);
// Check for the eyecatcher
if(l_img->magicNumber != WOF_IMAGE_MAGIC_VALUE)
{
FAPI_ERR("Image Header Magic Value != WTIH(0x%X)",
WOF_IMAGE_MAGIC_VALUE);
/*@
* @errortype
* @moduleid fapi2::MOD_FAPI2_PLAT_PARSE_WOF_TABLES
* @reasoncode fapi2::RC_WOF_IMAGE_MAGIC_MISMATCH
* @userdata1[00:31] Image header magic value
* @userdata1[32:63] Expected magic value
* @userdata2[00:31] LID ID
* @userdata2[32:63] Image header version
* @devdesc Image header magic value mismatch
* @custdesc Firmware Error
*/
l_errl = new ERRORLOG::ErrlEntry(
ERRORLOG::ERRL_SEV_UNRECOVERABLE,
fapi2::MOD_FAPI2_PLAT_PARSE_WOF_TABLES,
fapi2::RC_WOF_IMAGE_MAGIC_MISMATCH,
TWO_UINT32_TO_UINT64(
l_img->magicNumber,
WOF_IMAGE_MAGIC_VALUE),
TWO_UINT32_TO_UINT64(
l_lidNumber,
l_img->version),
true); //software callout
l_rc.setPlatDataPtr(reinterpret_cast<void *>(l_errl));
break;
}
// Check for a valid image header version
if(l_img->version > WOF_IMAGE_VERSION)
{
FAPI_ERR("Image header version not supported: "
" Header Version %d Supported Version %d",
l_img->version, WOF_IMAGE_VERSION);
/*@
* @errortype
* @moduleid fapi2::MOD_FAPI2_PLAT_PARSE_WOF_TABLES
* @reasoncode fapi2::RC_WOF_IMAGE_VERSION_MISMATCH
* @userdata1[00:31] Image header version
* @userdata1[32:63] Supported header version
* @userdata2 LID ID
* @devdesc Image header version not supported
* @custdesc Firmware Error
*/
l_errl = new ERRORLOG::ErrlEntry(
ERRORLOG::ERRL_SEV_UNRECOVERABLE,
fapi2::MOD_FAPI2_PLAT_PARSE_WOF_TABLES,
fapi2::RC_WOF_IMAGE_VERSION_MISMATCH,
TWO_UINT32_TO_UINT64(
l_img->version,
WOF_IMAGE_VERSION),
l_lidNumber,
true); //software callout
l_rc.setPlatDataPtr(reinterpret_cast<void *>(l_errl));
break;
}
// Image info
FAPI_INF("WOF Image: Magic 0x%X Version %d Entries %d Offset %p",
l_img->magicNumber, l_img->version,
l_img->entryCount, l_img->offset);
// Get a pointer to the first section table entry
wofSectionTableEntry_t* l_ste =
reinterpret_cast<wofSectionTableEntry_t*>
(reinterpret_cast<uint8_t*>(l_pWofImage) + l_img->offset);
WofTablesHeader_t* l_wth = nullptr;
std::vector<WofTablesHeader_t*> l_headers;
l_headers.clear();
uint32_t l_ent = 0;
uint32_t l_ver = 0;
// Loop through all section table entries
for( l_ent = 0; l_ent < l_img->entryCount; l_ent++ )
{
// Get a pointer to the WOF table
l_wth = reinterpret_cast<WofTablesHeader_t*>
(reinterpret_cast<uint8_t*>(l_pWofImage)
+ l_ste[l_ent].offset);
l_ver = l_wth->reserved_version & RES_VERSION_MASK;
// Check for the eyecatcher
if(l_wth->magic_number != WOF_TABLES_MAGIC_VALUE)
{
FAPI_ERR("WOF Tables Header Magic Number != WFTH(0x%X)",
WOF_TABLES_MAGIC_VALUE);
/*@
* @errortype
* @moduleid fapi2::MOD_FAPI2_PLAT_PARSE_WOF_TABLES
* @reasoncode fapi2::RC_WOF_TABLES_MAGIC_MISMATCH
* @userdata1[00:31] WOF tables header magic value
* @userdata1[32:63] Expected magic value
* @userdata2[00:31] WOF tables entry number
* @userdata2[32:63] WOF tables header version
* @devdesc WOF tables header magic value mismatch
* @custdesc Firmware Error
*/
l_errl = new ERRORLOG::ErrlEntry(
ERRORLOG::ERRL_SEV_UNRECOVERABLE,
fapi2::MOD_FAPI2_PLAT_PARSE_WOF_TABLES,
fapi2::RC_WOF_TABLES_MAGIC_MISMATCH,
TWO_UINT32_TO_UINT64(
l_wth->magic_number,
WOF_TABLES_MAGIC_VALUE),
TWO_UINT32_TO_UINT64(
l_ent,
l_ver),
true); //software callout
l_rc.setPlatDataPtr(reinterpret_cast<void *>(l_errl));
break;
}
// Check for a valid tables header version
if(l_ver > WOF_TABLES_VERSION)
{
FAPI_ERR("WOF tables header version not supported: "
" Header Version %d Supported Version %d",
l_ver, WOF_TABLES_VERSION);
/*@
* @errortype
* @moduleid fapi2::MOD_FAPI2_PLAT_PARSE_WOF_TABLES
* @reasoncode fapi2::RC_WOF_TABLES_VERSION_MISMATCH
* @userdata1[00:31] WOF tables header version
* @userdata1[32:63] Supported header version
* @userdata2 WOF tables entry number
* @devdesc WOF tables header version not supported
* @custdesc Firmware Error
*/
l_errl = new ERRORLOG::ErrlEntry(
ERRORLOG::ERRL_SEV_UNRECOVERABLE,
fapi2::MOD_FAPI2_PLAT_PARSE_WOF_TABLES,
fapi2::RC_WOF_TABLES_VERSION_MISMATCH,
TWO_UINT32_TO_UINT64(
l_ver,
WOF_TABLES_VERSION),
l_ent,
true); //software callout
l_rc.setPlatDataPtr(reinterpret_cast<void *>(l_errl));
break;
}
// Trace the WOF table fields
FAPI_INF("WOF table fields "
"SectionTableEntry %d "
"SectionTableOffset 0x%X "
"SectionTableSize %d "
"Version %d Cores %d SocketPower 0x%X "
"NestFreq 0x%X NomFreq 0x%X",
l_ent, l_ste[l_ent].offset, l_ste[l_ent].size,
l_ver, l_wth->core_count, l_wth->socket_power_w,
l_wth->nest_frequency_mhz, l_wth->sort_power_freq_mhz);
// Compare the fields
if( (l_wth->core_count == l_numCores) &&
(l_wth->socket_power_w == l_socketPower) &&
(l_wth->nest_frequency_mhz == l_nestFreq) &&
(l_wth->sort_power_freq_mhz == l_sortFreq) )
{
// Found a match
FAPI_INF("Found a WOF table match");
// Copy the WOF table to the ouput pointer
memcpy(o_wofData,
reinterpret_cast<uint8_t*>(l_wth),
l_ste[l_ent].size);
break;
}
else
{
// Save the header for later
l_headers.push_back(l_wth);
}
}
if(l_errl)
{
break;
}
//Check for no match
if(l_ent == l_img->entryCount)
{
FAPI_ERR("No WOF table match found");
/*@
* @errortype
* @moduleid fapi2::MOD_FAPI2_PLAT_PARSE_WOF_TABLES
* @reasoncode fapi2::RC_WOF_TABLE_NOT_FOUND
* @userdata1[00:15] Number of cores
* @userdata1[16:31] WOF Power Mode (0=Nominal,1=Turbo)
* @userdata1[32:63] Socket power
* @userdata2[00:31] Nest frequency
* @userdata2[32:63] Sort frequency
* @devdesc No WOF table match found
* @custdesc Firmware Error
*/
l_errl = new ERRORLOG::ErrlEntry(
ERRORLOG::ERRL_SEV_UNRECOVERABLE,
fapi2::MOD_FAPI2_PLAT_PARSE_WOF_TABLES,
fapi2::RC_WOF_TABLE_NOT_FOUND,
TWO_UINT16_ONE_UINT32_TO_UINT64(
l_numCores,
l_wofPowerLimit,
l_socketPower),
TWO_UINT32_TO_UINT64(
l_nestFreq,
l_sortFreq),
true); //software callout
l_errl->collectTrace(FAPI_TRACE_NAME);
// Add data
ERRORLOG::ErrlUserDetailsAttribute(
l_sys,
TARGETING::ATTR_WOF_TABLE_LID_NUMBER)
.addToLog(l_errl);
while(l_headers.size())
{
l_errl->addFFDC(
HWPF_COMP_ID,
l_headers.back(),
sizeof(WofTablesHeader_t),
0, // version
ERRORLOG::ERRL_UDT_NOFORMAT, // parser ignores data
false ); // merge
l_headers.pop_back();
}
l_rc.setPlatDataPtr(reinterpret_cast<void *>(l_errl));
break;
}
} while(0);
// Free the wof tables memory
if(l_pWofImage != nullptr)
{
free(l_pWofImage);
}
FAPI_DBG("Exiting platParseWOFTables ....");
return l_rc;
}
} // End platAttrSvc namespace
} // End fapi2 namespace