2 Implementation of loading microcode on processors.
4 Copyright (c) 2015 - 2019, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
12 Get microcode update signature of currently loaded microcode update.
14 @return Microcode signature.
17 GetCurrentMicrocodeSignature (
21 MSR_IA32_BIOS_SIGN_ID_REGISTER BiosSignIdMsr
;
23 AsmWriteMsr64 (MSR_IA32_BIOS_SIGN_ID
, 0);
24 AsmCpuid (CPUID_VERSION_INFO
, NULL
, NULL
, NULL
, NULL
);
25 BiosSignIdMsr
.Uint64
= AsmReadMsr64 (MSR_IA32_BIOS_SIGN_ID
);
26 return BiosSignIdMsr
.Bits
.MicrocodeUpdateSignature
;
30 Detect whether specified processor can find matching microcode patch and load it.
32 Microcode Payload as the following format:
33 +----------------------------------------+------------------+
34 | CPU_MICROCODE_HEADER | |
35 +----------------------------------------+ CheckSum Part1 |
36 | Microcode Binary | |
37 +----------------------------------------+------------------+
38 | CPU_MICROCODE_EXTENDED_TABLE_HEADER | |
39 +----------------------------------------+ CheckSum Part2 |
40 | CPU_MICROCODE_EXTENDED_TABLE | |
42 +----------------------------------------+------------------+
44 There may by multiple CPU_MICROCODE_EXTENDED_TABLE in this format.
45 The count of CPU_MICROCODE_EXTENDED_TABLE is indicated by ExtendedSignatureCount
46 of CPU_MICROCODE_EXTENDED_TABLE_HEADER structure.
48 When we are trying to verify the CheckSum32 with extended table.
49 We should use the fields of exnteded table to replace the corresponding
50 fields in CPU_MICROCODE_HEADER structure, and recalculate the
51 CheckSum32 with CPU_MICROCODE_HEADER + Microcode Binary. We named
54 The CheckSum Part2 is used to verify the CPU_MICROCODE_EXTENDED_TABLE_HEADER
55 and CPU_MICROCODE_EXTENDED_TABLE parts. We should make sure CheckSum Part2
56 is correct before we are going to verify each CPU_MICROCODE_EXTENDED_TABLE.
58 Only ProcessorSignature, ProcessorFlag and CheckSum are different between
59 CheckSum Part1 and CheckSum Part3. To avoid multiple computing CheckSum Part3.
60 Save an in-complete CheckSum32 from CheckSum Part1 for common parts.
61 When we are going to calculate CheckSum32, just should use the corresponding part
62 of the ProcessorSignature, ProcessorFlag and CheckSum with in-complete CheckSum32.
64 Notes: CheckSum32 is not a strong verification.
65 It does not guarantee that the data has not been modified.
66 CPU has its own mechanism to verify Microcode Binary part.
68 @param[in] CpuMpData The pointer to CPU MP Data structure.
69 @param[in] ProcessorNumber The handle number of the processor. The range is
70 from 0 to the total number of logical processors
75 IN CPU_MP_DATA
*CpuMpData
,
76 IN UINTN ProcessorNumber
79 UINT32 ExtendedTableLength
;
80 UINT32 ExtendedTableCount
;
81 CPU_MICROCODE_EXTENDED_TABLE
*ExtendedTable
;
82 CPU_MICROCODE_EXTENDED_TABLE_HEADER
*ExtendedTableHeader
;
83 CPU_MICROCODE_HEADER
*MicrocodeEntryPoint
;
87 CPUID_VERSION_INFO_EAX Eax
;
89 UINT32 CurrentRevision
;
90 UINT32 LatestRevision
;
93 UINT32 InCompleteCheckSum32
;
94 BOOLEAN CorrectMicrocode
;
99 if (CpuMpData
->MicrocodePatchRegionSize
== 0) {
101 // There is no microcode patches
106 CurrentRevision
= GetCurrentMicrocodeSignature ();
107 IsBspCallIn
= (ProcessorNumber
== (UINTN
)CpuMpData
->BspNumber
) ? TRUE
: FALSE
;
108 if (CurrentRevision
!= 0 && !IsBspCallIn
) {
110 // Skip loading microcode if it has been loaded successfully
115 GetProcessorLocationByApicId (GetInitialApicId (), NULL
, NULL
, &ThreadId
);
118 // Skip loading microcode if it is not the first thread in one core.
123 ExtendedTableLength
= 0;
124 Eax
.Uint32
= CpuMpData
->CpuData
[ProcessorNumber
].ProcessorSignature
;
125 PlatformId
= CpuMpData
->CpuData
[ProcessorNumber
].PlatformId
;
128 // Check whether AP has same processor with BSP.
129 // If yes, direct use microcode info saved by BSP.
133 // Get the CPU data for BSP
135 CpuData
= &(CpuMpData
->CpuData
[CpuMpData
->BspNumber
]);
136 if ((CpuData
->ProcessorSignature
== Eax
.Uint32
) &&
137 (CpuData
->PlatformId
== PlatformId
) &&
138 (CpuData
->MicrocodeEntryAddr
!= 0)) {
139 MicrocodeEntryPoint
= (CPU_MICROCODE_HEADER
*)(UINTN
) CpuData
->MicrocodeEntryAddr
;
140 MicrocodeData
= (VOID
*) (MicrocodeEntryPoint
+ 1);
141 LatestRevision
= MicrocodeEntryPoint
->UpdateRevision
;
147 MicrocodeData
= NULL
;
148 MicrocodeEnd
= (UINTN
) (CpuMpData
->MicrocodePatchAddress
+ CpuMpData
->MicrocodePatchRegionSize
);
149 MicrocodeEntryPoint
= (CPU_MICROCODE_HEADER
*) (UINTN
) CpuMpData
->MicrocodePatchAddress
;
153 // Check if the microcode is for the Cpu and the version is newer
154 // and the update can be processed on the platform
156 CorrectMicrocode
= FALSE
;
158 if (MicrocodeEntryPoint
->DataSize
== 0) {
159 TotalSize
= sizeof (CPU_MICROCODE_HEADER
) + 2000;
161 TotalSize
= sizeof (CPU_MICROCODE_HEADER
) + MicrocodeEntryPoint
->DataSize
;
165 /// 0x0 MicrocodeBegin MicrocodeEntry MicrocodeEnd 0xffffffff
166 /// |--------------|---------------|---------------|---------------|
168 /// TotalSize is only valid between 0 and (MicrocodeEnd - MicrocodeEntry).
169 /// And it should be aligned with 4 bytes.
170 /// If the TotalSize is invalid, skip 1KB to check next entry.
172 if ( (UINTN
)MicrocodeEntryPoint
> (MAX_ADDRESS
- TotalSize
) ||
173 ((UINTN
)MicrocodeEntryPoint
+ TotalSize
) > MicrocodeEnd
||
174 (TotalSize
& 0x3) != 0
176 MicrocodeEntryPoint
= (CPU_MICROCODE_HEADER
*) (((UINTN
) MicrocodeEntryPoint
) + SIZE_1KB
);
181 // Save an in-complete CheckSum32 from CheckSum Part1 for common parts.
183 InCompleteCheckSum32
= CalculateSum32 (
184 (UINT32
*) MicrocodeEntryPoint
,
187 InCompleteCheckSum32
-= MicrocodeEntryPoint
->ProcessorSignature
.Uint32
;
188 InCompleteCheckSum32
-= MicrocodeEntryPoint
->ProcessorFlags
;
189 InCompleteCheckSum32
-= MicrocodeEntryPoint
->Checksum
;
191 if (MicrocodeEntryPoint
->HeaderVersion
== 0x1) {
193 // It is the microcode header. It is not the padding data between microcode patches
194 // because the padding data should not include 0x00000001 and it should be the repeated
195 // byte format (like 0xXYXYXYXY....).
197 if (MicrocodeEntryPoint
->ProcessorSignature
.Uint32
== Eax
.Uint32
&&
198 MicrocodeEntryPoint
->UpdateRevision
> LatestRevision
&&
199 (MicrocodeEntryPoint
->ProcessorFlags
& (1 << PlatformId
))
202 // Calculate CheckSum Part1.
204 CheckSum32
= InCompleteCheckSum32
;
205 CheckSum32
+= MicrocodeEntryPoint
->ProcessorSignature
.Uint32
;
206 CheckSum32
+= MicrocodeEntryPoint
->ProcessorFlags
;
207 CheckSum32
+= MicrocodeEntryPoint
->Checksum
;
208 if (CheckSum32
== 0) {
209 CorrectMicrocode
= TRUE
;
211 } else if ((MicrocodeEntryPoint
->DataSize
!= 0) &&
212 (MicrocodeEntryPoint
->UpdateRevision
> LatestRevision
)) {
213 ExtendedTableLength
= MicrocodeEntryPoint
->TotalSize
- (MicrocodeEntryPoint
->DataSize
+
214 sizeof (CPU_MICROCODE_HEADER
));
215 if (ExtendedTableLength
!= 0) {
217 // Extended Table exist, check if the CPU in support list
219 ExtendedTableHeader
= (CPU_MICROCODE_EXTENDED_TABLE_HEADER
*) ((UINT8
*) (MicrocodeEntryPoint
)
220 + MicrocodeEntryPoint
->DataSize
+ sizeof (CPU_MICROCODE_HEADER
));
222 // Calculate Extended Checksum
224 if ((ExtendedTableLength
% 4) == 0) {
226 // Calculate CheckSum Part2.
228 CheckSum32
= CalculateSum32 ((UINT32
*) ExtendedTableHeader
, ExtendedTableLength
);
229 if (CheckSum32
== 0) {
233 ExtendedTableCount
= ExtendedTableHeader
->ExtendedSignatureCount
;
234 ExtendedTable
= (CPU_MICROCODE_EXTENDED_TABLE
*) (ExtendedTableHeader
+ 1);
235 for (Index
= 0; Index
< ExtendedTableCount
; Index
++) {
237 // Calculate CheckSum Part3.
239 CheckSum32
= InCompleteCheckSum32
;
240 CheckSum32
+= ExtendedTable
->ProcessorSignature
.Uint32
;
241 CheckSum32
+= ExtendedTable
->ProcessorFlag
;
242 CheckSum32
+= ExtendedTable
->Checksum
;
243 if (CheckSum32
== 0) {
247 if ((ExtendedTable
->ProcessorSignature
.Uint32
== Eax
.Uint32
) &&
248 (ExtendedTable
->ProcessorFlag
& (1 << PlatformId
)) ) {
252 CorrectMicrocode
= TRUE
;
264 // It is the padding data between the microcode patches for microcode patches alignment.
265 // Because the microcode patch is the multiple of 1-KByte, the padding data should not
266 // exist if the microcode patch alignment value is not larger than 1-KByte. So, the microcode
267 // alignment value should be larger than 1-KByte. We could skip SIZE_1KB padding data to
268 // find the next possible microcode patch header.
270 MicrocodeEntryPoint
= (CPU_MICROCODE_HEADER
*) (((UINTN
) MicrocodeEntryPoint
) + SIZE_1KB
);
274 // Get the next patch.
276 if (MicrocodeEntryPoint
->DataSize
== 0) {
279 TotalSize
= MicrocodeEntryPoint
->TotalSize
;
282 if (CorrectMicrocode
) {
283 LatestRevision
= MicrocodeEntryPoint
->UpdateRevision
;
284 MicrocodeData
= (VOID
*) ((UINTN
) MicrocodeEntryPoint
+ sizeof (CPU_MICROCODE_HEADER
));
287 MicrocodeEntryPoint
= (CPU_MICROCODE_HEADER
*) (((UINTN
) MicrocodeEntryPoint
) + TotalSize
);
288 } while (((UINTN
) MicrocodeEntryPoint
< MicrocodeEnd
));
291 if (LatestRevision
!= 0) {
293 // Save the detected microcode patch entry address (including the
294 // microcode patch header) for each processor.
295 // It will be used when building the microcode patch cache HOB.
297 CpuMpData
->CpuData
[ProcessorNumber
].MicrocodeEntryAddr
=
298 (UINTN
) MicrocodeData
- sizeof (CPU_MICROCODE_HEADER
);
301 if (LatestRevision
> CurrentRevision
) {
303 // BIOS only authenticate updates that contain a numerically larger revision
304 // than the currently loaded revision, where Current Signature < New Update
305 // Revision. A processor with no loaded update is considered to have a
306 // revision equal to zero.
308 ASSERT (MicrocodeData
!= NULL
);
310 MSR_IA32_BIOS_UPDT_TRIG
,
311 (UINT64
) (UINTN
) MicrocodeData
314 // Get and check new microcode signature
316 CurrentRevision
= GetCurrentMicrocodeSignature ();
317 if (CurrentRevision
!= LatestRevision
) {
318 AcquireSpinLock(&CpuMpData
->MpLock
);
319 DEBUG ((EFI_D_ERROR
, "Updated microcode signature [0x%08x] does not match \
320 loaded microcode signature [0x%08x]\n", CurrentRevision
, LatestRevision
));
321 ReleaseSpinLock(&CpuMpData
->MpLock
);
327 Determine if a microcode patch will be loaded into memory.
329 @param[in] CpuMpData The pointer to CPU MP Data structure.
330 @param[in] ProcessorSignature The processor signature field value
331 supported by a microcode patch.
332 @param[in] ProcessorFlags The prcessor flags field value supported by
335 @retval TRUE The specified microcode patch will be loaded.
336 @retval FALSE The specified microcode patch will not be loaded.
339 IsMicrocodePatchNeedLoad (
340 IN CPU_MP_DATA
*CpuMpData
,
341 IN UINT32 ProcessorSignature
,
342 IN UINT32 ProcessorFlags
346 CPU_AP_DATA
*CpuData
;
348 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
349 CpuData
= &CpuMpData
->CpuData
[Index
];
350 if ((ProcessorSignature
== CpuData
->ProcessorSignature
) &&
351 (ProcessorFlags
& (1 << CpuData
->PlatformId
)) != 0) {
360 Actual worker function that loads the required microcode patches into memory.
362 @param[in, out] CpuMpData The pointer to CPU MP Data structure.
363 @param[in] Patches The pointer to an array of information on
364 the microcode patches that will be loaded
366 @param[in] PatchCount The number of microcode patches that will
367 be loaded into memory.
368 @param[in] TotalLoadSize The total size of all the microcode patches
372 LoadMicrocodePatchWorker (
373 IN OUT CPU_MP_DATA
*CpuMpData
,
374 IN MICROCODE_PATCH_INFO
*Patches
,
376 IN UINTN TotalLoadSize
380 VOID
*MicrocodePatchInRam
;
383 ASSERT ((Patches
!= NULL
) && (PatchCount
!= 0));
385 MicrocodePatchInRam
= AllocatePages (EFI_SIZE_TO_PAGES (TotalLoadSize
));
386 if (MicrocodePatchInRam
== NULL
) {
391 // Load all the required microcode patches into memory
393 for (Walker
= MicrocodePatchInRam
, Index
= 0; Index
< PatchCount
; Index
++) {
396 (VOID
*) Patches
[Index
].Address
,
401 // Zero-fill the padding area
402 // Please note that AlignedSize will be no less than Size
405 Walker
+ Patches
[Index
].Size
,
406 Patches
[Index
].AlignedSize
- Patches
[Index
].Size
409 Walker
+= Patches
[Index
].AlignedSize
;
413 // Update the microcode patch related fields in CpuMpData
415 CpuMpData
->MicrocodePatchAddress
= (UINTN
) MicrocodePatchInRam
;
416 CpuMpData
->MicrocodePatchRegionSize
= TotalLoadSize
;
420 "%a: Required microcode patches have been loaded at 0x%lx, with size 0x%lx.\n",
421 __FUNCTION__
, CpuMpData
->MicrocodePatchAddress
, CpuMpData
->MicrocodePatchRegionSize
428 Load the required microcode patches data into memory.
430 @param[in, out] CpuMpData The pointer to CPU MP Data structure.
434 IN OUT CPU_MP_DATA
*CpuMpData
437 CPU_MICROCODE_HEADER
*MicrocodeEntryPoint
;
441 CPU_MICROCODE_EXTENDED_TABLE_HEADER
*ExtendedTableHeader
;
442 UINT32 ExtendedTableCount
;
443 CPU_MICROCODE_EXTENDED_TABLE
*ExtendedTable
;
444 MICROCODE_PATCH_INFO
*PatchInfoBuffer
;
445 UINTN MaxPatchNumber
;
452 // Initialize the microcode patch related fields in CpuMpData as the values
453 // specified by the PCD pair. If the microcode patches are loaded into memory,
454 // these fields will be updated.
456 CpuMpData
->MicrocodePatchAddress
= PcdGet64 (PcdCpuMicrocodePatchAddress
);
457 CpuMpData
->MicrocodePatchRegionSize
= PcdGet64 (PcdCpuMicrocodePatchRegionSize
);
459 MicrocodeEntryPoint
= (CPU_MICROCODE_HEADER
*) (UINTN
) CpuMpData
->MicrocodePatchAddress
;
460 MicrocodeEnd
= (UINTN
) MicrocodeEntryPoint
+
461 (UINTN
) CpuMpData
->MicrocodePatchRegionSize
;
462 if ((MicrocodeEntryPoint
== NULL
) || ((UINTN
) MicrocodeEntryPoint
== MicrocodeEnd
)) {
464 // There is no microcode patches
470 MaxPatchNumber
= DEFAULT_MAX_MICROCODE_PATCH_NUM
;
472 PatchInfoBuffer
= AllocatePool (MaxPatchNumber
* sizeof (MICROCODE_PATCH_INFO
));
473 if (PatchInfoBuffer
== NULL
) {
478 // Process the header of each microcode patch within the region.
479 // The purpose is to decide which microcode patch(es) will be loaded into memory.
482 if (MicrocodeEntryPoint
->HeaderVersion
!= 0x1) {
484 // Padding data between the microcode patches, skip 1KB to check next entry.
486 MicrocodeEntryPoint
= (CPU_MICROCODE_HEADER
*) (((UINTN
) MicrocodeEntryPoint
) + SIZE_1KB
);
490 DataSize
= MicrocodeEntryPoint
->DataSize
;
491 TotalSize
= (DataSize
== 0) ? 2048 : MicrocodeEntryPoint
->TotalSize
;
492 if ( (UINTN
)MicrocodeEntryPoint
> (MAX_ADDRESS
- TotalSize
) ||
493 ((UINTN
)MicrocodeEntryPoint
+ TotalSize
) > MicrocodeEnd
||
494 (DataSize
& 0x3) != 0 ||
495 (TotalSize
& (SIZE_1KB
- 1)) != 0 ||
499 // Not a valid microcode header, skip 1KB to check next entry.
501 MicrocodeEntryPoint
= (CPU_MICROCODE_HEADER
*) (((UINTN
) MicrocodeEntryPoint
) + SIZE_1KB
);
506 // Check the 'ProcessorSignature' and 'ProcessorFlags' of the microcode
507 // patch header with the CPUID and PlatformID of the processors within
508 // system to decide if it will be copied into memory
510 NeedLoad
= IsMicrocodePatchNeedLoad (
512 MicrocodeEntryPoint
->ProcessorSignature
.Uint32
,
513 MicrocodeEntryPoint
->ProcessorFlags
517 // If the Extended Signature Table exists, check if the processor is in the
520 if ((!NeedLoad
) && (DataSize
!= 0) &&
521 (TotalSize
- DataSize
> sizeof (CPU_MICROCODE_HEADER
) +
522 sizeof (CPU_MICROCODE_EXTENDED_TABLE_HEADER
))) {
523 ExtendedTableHeader
= (CPU_MICROCODE_EXTENDED_TABLE_HEADER
*) ((UINT8
*) (MicrocodeEntryPoint
)
524 + DataSize
+ sizeof (CPU_MICROCODE_HEADER
));
525 ExtendedTableCount
= ExtendedTableHeader
->ExtendedSignatureCount
;
526 ExtendedTable
= (CPU_MICROCODE_EXTENDED_TABLE
*) (ExtendedTableHeader
+ 1);
528 for (Index
= 0; Index
< ExtendedTableCount
; Index
++) {
530 // Avoid access content beyond MicrocodeEnd
532 if ((UINTN
) ExtendedTable
> MicrocodeEnd
- sizeof (CPU_MICROCODE_EXTENDED_TABLE
)) {
537 // Check the 'ProcessorSignature' and 'ProcessorFlag' of the Extended
538 // Signature Table entry with the CPUID and PlatformID of the processors
539 // within system to decide if it will be copied into memory
541 NeedLoad
= IsMicrocodePatchNeedLoad (
543 ExtendedTable
->ProcessorSignature
.Uint32
,
544 ExtendedTable
->ProcessorFlag
555 if (PatchCount
> MaxPatchNumber
) {
557 // Current 'PatchInfoBuffer' cannot hold the information, double the size
558 // and allocate a new buffer.
560 if (MaxPatchNumber
> MAX_UINTN
/ 2 / sizeof (MICROCODE_PATCH_INFO
)) {
562 // Overflow check for MaxPatchNumber
567 PatchInfoBuffer
= ReallocatePool (
568 MaxPatchNumber
* sizeof (MICROCODE_PATCH_INFO
),
569 2 * MaxPatchNumber
* sizeof (MICROCODE_PATCH_INFO
),
572 if (PatchInfoBuffer
== NULL
) {
575 MaxPatchNumber
= MaxPatchNumber
* 2;
579 // Store the information of this microcode patch
581 if (TotalSize
> ALIGN_VALUE (TotalSize
, SIZE_1KB
) ||
582 ALIGN_VALUE (TotalSize
, SIZE_1KB
) > MAX_UINTN
- TotalLoadSize
) {
585 PatchInfoBuffer
[PatchCount
- 1].Address
= (UINTN
) MicrocodeEntryPoint
;
586 PatchInfoBuffer
[PatchCount
- 1].Size
= TotalSize
;
587 PatchInfoBuffer
[PatchCount
- 1].AlignedSize
= ALIGN_VALUE (TotalSize
, SIZE_1KB
);
588 TotalLoadSize
+= PatchInfoBuffer
[PatchCount
- 1].AlignedSize
;
592 // Process the next microcode patch
594 MicrocodeEntryPoint
= (CPU_MICROCODE_HEADER
*) (((UINTN
) MicrocodeEntryPoint
) + TotalSize
);
595 } while (((UINTN
) MicrocodeEntryPoint
< MicrocodeEnd
));
597 if (PatchCount
!= 0) {
600 "%a: 0x%x microcode patches will be loaded into memory, with size 0x%x.\n",
601 __FUNCTION__
, PatchCount
, TotalLoadSize
604 LoadMicrocodePatchWorker (CpuMpData
, PatchInfoBuffer
, PatchCount
, TotalLoadSize
);
608 if (PatchInfoBuffer
!= NULL
) {
609 FreePool (PatchInfoBuffer
);