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
|
/* IBM_PROLOG_BEGIN_TAG
* This is an automatically generated prolog.
*
* $Source: src/usr/hwpf/hwp/build_winkle_images/proc_slw_build/proc_slw_build.C $
*
* IBM CONFIDENTIAL
*
* COPYRIGHT International Business Machines Corp. 2012
*
* p1
*
* Object Code Only (OCO) source materials
* Licensed Internal Code Source Materials
* IBM HostBoot Licensed Internal Code
*
* The source code for this program is not published or other-
* wise divested of its trade secrets, irrespective of what has
* been deposited with the U.S. Copyright Office.
*
* Origin: 30
*
* IBM_PROLOG_END_TAG
*/
/*------------------------------------------------------------------------------*/
/* *! TITLE : proc_slw_build */
/* *! DESCRIPTION : Extracts and decompresses delta ring states from EPROM */
// image. Utilizes the linked list approach (LLA) to extract
// and position wiggle-flip programs in .rings according to
// back pointer, DD level, phase and override settings.
/* *! OWNER NAME : Michael Olsen cmolsen@us.ibm.com */
//
/* *! EXTENDED DESCRIPTION : */
//
/* *! USAGE : To build (for Hostboot) - */
// buildfapiprcd -r ver-12-5 -C "p8_image_help.C,p8_scan_compression.C" -c "sbe_xip_image.c,pore_inline_assembler.c,pore_inline_disassembler.c,p8_pore_static_data.c" -e "../../xml/error_info/proc_slw_build_errors.xml" proc_slw_build.C
// Parameter list -
// See function definition below.
// Alternative usages -
// To build for scanning by EPM team:
// buildfapiprcd_cmo -u "SLW_BUILD_WF_P0_FIX,SLW_BUILD_SYSPHASE_ZERO_MODE,SLW_COMMAND_LINE" -r ...
//
/* *! ASSUMPTIONS : */
// - For proc_slw_build, sysPhase=1 is assumed during real hostboot.
//
/* *! COMMENTS : */
// - All image content, incl .initf content and ring layout, is handled
// in BE format. No matter which platform.
// - A ring may only be requested with the sysPhase=0 or 1. Any other
// sysPhase value, incl sysPhase=2, will cause no rings to be found.
//
/*------------------------------------------------------------------------------*/
#include "proc_slw_build.H"
extern "C" {
using namespace fapi;
// Parameter list:
// fapi::Target &i_target: Hardware target
// void *i_imageIn: Pointer to memory mapped input SBE-XIP EPROM image
// uint32_t i_sizeImageIn: Size of input image.
// void *i_imageOut: Pointer to where to put SLW mainstore image
// uint32_t *io_sizeImageOut: Size of output image. Initial upper limit supplied by HB. Final size returned.
//
ReturnCode proc_slw_build( const fapi::Target &i_target,
const void *i_imageIn,
uint32_t i_sizeImageIn,
void *i_imageOut,
uint32_t *io_sizeImageOut)
{
ReturnCode rc;
uint8_t l_uint8 = 0;
uint32_t ddLevel=0;
#ifdef SLW_BUILD_SYSPHASE_ZERO_MODE
uint8_t sysPhase=0;
#else
uint8_t sysPhase=1;
#endif
uint32_t rcLoc=0, rcSearch=0, i, countWF=0;
uint32_t sizeImage=0, sizeImageOutMax, sizeImageTmp, sizeImageOld;
uint8_t *deltaRingDxed=NULL;
CompressedScanData *deltaRingRS4=NULL;
DeltaRingLayout rs4RingLayout;
void *nextRing=NULL;
uint32_t ringBitLen=0, ringByteLen=0, ringTrailBits=0;
uint32_t *wfInline=NULL;
uint32_t wfInlineLenInWords;
sizeImageOutMax = *io_sizeImageOut;
if (sizeImageOutMax<i_sizeImageIn) {
FAPI_ERR("Inp image size (from caller): %i",i_sizeImageIn);
FAPI_ERR("Max image size (from caller): %i",*io_sizeImageOut);
uint32_t & DATA_IMG_SIZE_INP = i_sizeImageIn;
uint32_t & DATA_IMG_SIZE_MAX = *io_sizeImageOut;
FAPI_SET_HWP_ERROR(rc, RC_PROC_SLWB_INPUT_IMAGE_SIZE_MESS);
return rc;
}
// ==========================================================================
// Check and copy image to mainstore and clean it up.
// ==========================================================================
// ToDo:
// - Eventually, automate emptying sections in proper order (last section goes first).
// - For 5/15, assume following order of removal: rings, pibmem0, and halt.
//
// First, check supplied size and validation of input EPROM image.
//
sbe_xip_image_size((void*)i_imageIn, &sizeImage);
rcLoc = sbe_xip_validate((void*)i_imageIn, sizeImage);
if (rcLoc) {
FAPI_ERR("xip_validate() failed w/rcLoc=%i",rcLoc);
uint32_t & RC_LOCAL = rcLoc;
FAPI_SET_HWP_ERROR(rc, RC_PROC_SLWB_INTERNAL_IMAGE_ERR);
return rc;
}
if (sizeImage!=i_sizeImageIn) {
FAPI_ERR("Size obtained from image's header (=%i) differs from supplied size (=%i).",
sizeImage,i_sizeImageIn);
uint32_t & DATA_IMG_SIZE_INP = i_sizeImageIn;
uint32_t & DATA_IMG_SIZE = sizeImage;
FAPI_SET_HWP_ERROR(rc, RC_PROC_SLWB_IMAGE_SIZE_MISMATCH);
return rc;
}
FAPI_DBG("Image size (in EPROM): %i",i_sizeImageIn);
// Second, copy input image to supplied mainstore location.
//
memcpy( i_imageOut, i_imageIn, i_sizeImageIn);
sbe_xip_image_size(i_imageOut, &sizeImage);
rcLoc = sbe_xip_validate(i_imageOut, sizeImage);
if (rcLoc) {
FAPI_ERR("xip_validate() failed w/rcLoc=%i",rcLoc);
uint32_t & RC_LOCAL=rcLoc;
FAPI_SET_HWP_ERROR(rc, RC_PROC_SLWB_MS_INTERNAL_IMAGE_ERR);
return rc;
}
if (sizeImage!=i_sizeImageIn) {
FAPI_ERR("Size obtained from image's header (=%i) differs from supplied size (=%i).",
sizeImage,i_sizeImageIn);
uint32_t & DATA_IMG_SIZE_INP = i_sizeImageIn;
uint32_t & DATA_IMG_SIZE = sizeImage;
FAPI_SET_HWP_ERROR(rc, RC_PROC_SLWB_MS_IMAGE_SIZE_MISMATCH);
return rc;
}
// Third, delete .rings and .pibmem0 sections (but keep .halt)
//
rcLoc = sbe_xip_delete_section( i_imageOut, SBE_XIP_SECTION_RINGS);
if (rcLoc) {
FAPI_ERR("xip_delete_section(.rings) failed w/rcLoc=%i",rcLoc);
uint32_t & RC_LOCAL=rcLoc;
FAPI_SET_HWP_ERROR(rc, RC_PROC_SLWB_DELETE_IMAGE_SECTION_ERROR);
return rc;
}
sbe_xip_image_size(i_imageOut, &sizeImage);
rcLoc = sbe_xip_validate(i_imageOut, sizeImage);
if (rcLoc) {
FAPI_ERR("xip_validate() failed w/rcLoc=%i",rcLoc);
uint32_t & RC_LOCAL=rcLoc;
FAPI_SET_HWP_ERROR(rc, RC_PROC_SLWB_MS_INTERNAL_IMAGE_ERR);
return rc;
}
FAPI_DBG("Image size (after .rings delete): %i",sizeImage);
rcLoc = sbe_xip_delete_section( i_imageOut, SBE_XIP_SECTION_PIBMEM0);
if (rcLoc) {
FAPI_ERR("xip_delete_section(.pibmem0) failed w/rcLoc=%i",rcLoc);
uint32_t & RC_LOCAL=rcLoc;
FAPI_SET_HWP_ERROR(rc, RC_PROC_SLWB_DELETE_IMAGE_SECTION_ERROR);
return rc;
}
sbe_xip_image_size(i_imageOut, &sizeImage);
rcLoc = sbe_xip_validate(i_imageOut, sizeImage);
if (rcLoc) {
FAPI_ERR("xip_validate() failed w/rcLoc=%i",rcLoc);
uint32_t & RC_LOCAL=rcLoc;
FAPI_SET_HWP_ERROR(rc, RC_PROC_SLWB_MS_INTERNAL_IMAGE_ERR);
return rc;
}
FAPI_DBG("Image size (after .pibmem0 delete): %i",sizeImage);
// ==========================================================================
// Get DD level from FAPI attributes.
// ==========================================================================
// $$rc = FAPI_ATTR_GET(ATTR_EC, &i_target, l_uint8);
rc = FAPI_ATTR_GET_PRIVILEGED(ATTR_EC, &i_target, l_uint8);
ddLevel = (uint32_t)l_uint8;
if (rc) {
FAPI_ERR("FAPI_ATTR_GET() failed w/rc=%i and ddLevel=0x%02x",(uint32_t)rc,l_uint8);
return rc;
}
/***************************************************************************
* SEARCH LOOP - Begin *
***************************************************************************/
do {
FAPI_DBG("nextRing (at top)=0x%016llx",(uint64_t)nextRing);
// ==========================================================================
// Get ring layout from image
// ==========================================================================
FAPI_DBG("--> Reading RS4 delta ring info from SBE-XIP Image.");
rcLoc = get_ring_layout_from_image( i_imageIn,
ddLevel,
sysPhase,
&rs4RingLayout,
&nextRing);
rcSearch = rcLoc;
if (rcSearch!=DSLWB_RING_SEARCH_MATCH &&
rcSearch!=DSLWB_RING_SEARCH_EXHAUST_MATCH &&
rcSearch!=DSLWB_RING_SEARCH_NO_MATCH) {
FAPI_ERR("\tERROR : Getting delta ring from image was unsuccessful (rcSearch=%i).",rcSearch);
FAPI_ERR("\tNo wiggle-flip programs will be stored in .rings section.");
FAPI_ERR("\tThe following ELF sections have been emptied: .rings, .pibmem0, .ipl_text.");
uint32_t & RC_LOCAL=rcLoc;
FAPI_SET_HWP_ERROR(rc, RC_PROC_SLWB_RING_RETRIEVAL_ERROR);
return rc;
}
if (rcSearch==DSLWB_RING_SEARCH_MATCH ||
rcSearch==DSLWB_RING_SEARCH_EXHAUST_MATCH)
FAPI_DBG("\tRetrieving RS4 delta ring was successful.");
// Check if we're done at this point.
//
if (rcSearch==DSLWB_RING_SEARCH_NO_MATCH) {
FAPI_INF("Wiggle-flip programming done.");
FAPI_INF("Number of wf programs appended: %i", countWF);
if (countWF==0)
FAPI_INF("ZERO WF programs appended to .rings section.");
sizeImageTmp = sizeImageOutMax;
rcLoc = append_empty_section( i_imageOut,
&sizeImageTmp,
SBE_XIP_SECTION_SLW,
SLW_SLW_SECTION_SIZE);
if (rcLoc) {
if (rcLoc==IMGBUILD_ERR_IMAGE_TOO_LARGE) {
uint32_t & DATA_IMG_SIZE_OLD=sizeImageOld;
uint32_t & DATA_IMG_SIZE_EST=sizeImageTmp;
uint32_t & DATA_IMG_SIZE_MAX=sizeImageOutMax;
FAPI_SET_HWP_ERROR(rc, RC_PROC_SLWB_MAX_IMAGE_SIZE_EXCEEDED);
}
else {
uint32_t & RC_LOCAL=rcLoc;
FAPI_SET_HWP_ERROR(rc, RC_PROC_SLWB_APPEND_SLW_SECTION_ERROR);
}
return rc;
}
FAPI_INF("SLW section allocated for Ramming table.");
sbe_xip_image_size( i_imageOut, io_sizeImageOut);
FAPI_INF("Final SLW image size: %i", *io_sizeImageOut);
return FAPI_RC_SUCCESS;
}
deltaRingRS4 = (CompressedScanData*)rs4RingLayout.rs4Delta;
FAPI_DBG("Dumping ring layout:");
FAPI_DBG("\tentryOffset = %i",(uint32_t)myRev64(rs4RingLayout.entryOffset));
FAPI_DBG("\tbackItemPtr = 0x%016llx",myRev64(rs4RingLayout.backItemPtr));
FAPI_DBG("\tsizeOfThis = %i",myRev32(rs4RingLayout.sizeOfThis));
FAPI_DBG("\tsizeOfMeta = %i",myRev32(rs4RingLayout.sizeOfMeta));
FAPI_DBG("\tddLevel = %i",myRev32(rs4RingLayout.ddLevel));
FAPI_DBG("\tsysPhase = %i",rs4RingLayout.sysPhase);
FAPI_DBG("\toverride = %i",rs4RingLayout.override);
FAPI_DBG("\treserved1+2 = %i",rs4RingLayout.reserved1|rs4RingLayout.reserved2);
FAPI_DBG("\tRS4 magic # = 0x%08x",myRev32(deltaRingRS4->iv_magic));
FAPI_DBG("\tRS4 total size = %i",myRev32(deltaRingRS4->iv_size));
FAPI_DBG("\tUnXed data size = %i",myRev32(deltaRingRS4->iv_length));
FAPI_DBG("\tScan select = 0x%08x",myRev32(deltaRingRS4->iv_scanSelect));
FAPI_DBG("\tHeader version = 0x%02x",deltaRingRS4->iv_headerVersion);
FAPI_DBG("\tFlush optimize = 0x%02x (reverse of override)",deltaRingRS4->iv_flushOptimization);
FAPI_DBG("\tReserved = 0x%02x",deltaRingRS4->iv_reserved);
FAPI_DBG("\tChiplet ID = 0x%02x",deltaRingRS4->iv_chipletId);
FAPI_DBG("Dumping meta data:");
FAPI_DBG("\tsizeOfData = %i",myRev32(rs4RingLayout.sizeOfMeta));
FAPI_DBG("\tMeta data = ");
for (i=0; i<myRev32(rs4RingLayout.sizeOfMeta); i++) { // String may not be null terminated.
FAPI_DBG("%c",rs4RingLayout.metaData[i]);
}
// ==========================================================================
// Decompress RS4 delta state.
// ==========================================================================
FAPI_DBG("--> Decompressing RS4 delta ring.");
// Note: deltaRingDxed is left-aligned. If converting to uint32_t, do BE->LE flip.
deltaRingDxed = NULL;
rcLoc = rs4_decompress( &deltaRingDxed,
&ringBitLen,
deltaRingRS4);
if (rcLoc) {
FAPI_ERR("\tERROR : rs4_decompress() failed: rc=%i",rcLoc);
if (deltaRingDxed) free(deltaRingDxed);
uint32_t & RC_LOCAL=rcLoc;
FAPI_SET_HWP_ERROR(rc, RC_PROC_SLWB_RS4_DECOMPRESSION_ERROR);
return rc;
}
FAPI_DBG("\tDecompression successful.\n");
ringByteLen = (ringBitLen-1)/8+1;
ringTrailBits = ringBitLen - 8*(ringByteLen-1);
// ==========================================================================
// Create Wiggle-Flip Programs
// ==========================================================================
FAPI_DBG("--> Creating Wiggle-Flip Program.");
rcLoc = create_wiggle_flip_prg( (uint32_t*)deltaRingDxed,
ringBitLen,
myRev32(deltaRingRS4->iv_scanSelect),
(uint32_t)deltaRingRS4->iv_chipletId,
&wfInline,
&wfInlineLenInWords);
if (rcLoc) {
FAPI_ERR("ERROR : create_wiggle_flip_prg() failed w/rcLoc=%i",rcLoc);
if (deltaRingDxed) free(deltaRingDxed);
if (wfInline) free(wfInline);
uint32_t & RC_LOCAL=rcLoc;
FAPI_SET_HWP_ERROR(rc, RC_PROC_SLWB_WF_CREATION_ERROR);
return rc;
}
FAPI_DBG("\tWiggle-flip programming successful.");
// ==========================================================================
// Append Wiggle-Flip programs to .rings section.
// ==========================================================================
FAPI_DBG("--> Appending wiggle-flip and layout header to .rings section.");
sizeImageTmp = sizeImageOutMax;
rcLoc = write_wiggle_flip_to_image( i_imageOut,
&sizeImageTmp,
&rs4RingLayout,
wfInline,
wfInlineLenInWords);
if (rcLoc) {
FAPI_ERR("ERROR : write_wiggle_flip_to_image() failed w/rcLoc=%i",rcLoc);
if (deltaRingDxed) free(deltaRingDxed);
if (wfInline) free(wfInline);
if (rcLoc==IMGBUILD_ERR_IMAGE_TOO_LARGE) {
uint32_t & DATA_IMG_SIZE_OLD=sizeImageOld;
uint32_t & DATA_IMG_SIZE_EST=sizeImageTmp;
uint32_t & DATA_IMG_SIZE_MAX=sizeImageOutMax;
FAPI_SET_HWP_ERROR(rc, RC_PROC_SLWB_MAX_IMAGE_SIZE_EXCEEDED);
}
else {
uint32_t & RC_LOCAL=rcLoc;
FAPI_SET_HWP_ERROR(rc, RC_PROC_SLWB_IMAGE_UPDATE_ERROR);
}
return rc;
}
FAPI_DBG("\tUpdating image w/wiggle-flip program + header was successful.");
// Update some variables for debugging and error reporting.
sizeImageOld = sizeImageTmp;
countWF++;
// ==========================================================================
// Clean up
// ==========================================================================
if (deltaRingDxed) free(deltaRingDxed);
if (wfInline) free(wfInline);
// ==========================================================================
// Are we done?
// ==========================================================================
if (rcSearch==DSLWB_RING_SEARCH_EXHAUST_MATCH) {
FAPI_INF("Wiggle-flip programming done.");
FAPI_INF("Number of wf programs appended: %i", countWF);
if (countWF==0)
FAPI_INF("ZERO WF programs appended to .rings section.");
sizeImageTmp = sizeImageOutMax;
rcLoc = append_empty_section( i_imageOut,
&sizeImageTmp,
SBE_XIP_SECTION_SLW,
SLW_SLW_SECTION_SIZE);
if (rcLoc) {
if (rcLoc==IMGBUILD_ERR_IMAGE_TOO_LARGE) {
uint32_t & DATA_IMG_SIZE_OLD=sizeImageOld;
uint32_t & DATA_IMG_SIZE_EST=sizeImageTmp;
uint32_t & DATA_IMG_SIZE_MAX=sizeImageOutMax;
FAPI_SET_HWP_ERROR(rc, RC_PROC_SLWB_MAX_IMAGE_SIZE_EXCEEDED);
}
else {
uint32_t & RC_LOCAL=rcLoc;
FAPI_SET_HWP_ERROR(rc, RC_PROC_SLWB_APPEND_SLW_SECTION_ERROR);
}
return rc;
}
FAPI_INF("SLW section allocated for Ramming table.");
sbe_xip_image_size( i_imageOut, io_sizeImageOut);
FAPI_INF("Final SLW image size: %i", *io_sizeImageOut);
return FAPI_RC_SUCCESS;
}
FAPI_DBG("nextRing (at bottom)=0x%016llx",(uint64_t)nextRing);
} while (nextRing!=NULL);
/***************************************************************************
* SEARCH LOOP - End *
***************************************************************************/
FAPI_ERR("ERROR : Shouldn't be in this code section. Check code.");
rcLoc = IMGBUILD_ERR_CHECK_CODE;
uint32_t & RC_LOCAL=rcLoc;
FAPI_SET_HWP_ERROR(rc, RC_PROC_SLWB_UNKOWN_ERROR);
return rc;
}
} // End of extern C
|
