IntelSiliconPkg MicrocodeUpdate: Fix typo EFI_SECURITY_VIOLATIO
[mirror_edk2.git] / IntelSiliconPkg / Feature / Capsule / MicrocodeUpdateDxe / MicrocodeFmp.c
1 /** @file
2 Produce FMP instance for Microcode.
3
4 Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 **/
14
15 #include "MicrocodeUpdate.h"
16
17 //
18 // MicrocodeFmp driver private data
19 //
20 MICROCODE_FMP_PRIVATE_DATA *mMicrocodeFmpPrivate = NULL;
21
22 EFI_FIRMWARE_MANAGEMENT_PROTOCOL mFirmwareManagementProtocol = {
23 FmpGetImageInfo,
24 FmpGetImage,
25 FmpSetImage,
26 FmpCheckImage,
27 FmpGetPackageInfo,
28 FmpSetPackageInfo
29 };
30
31 /**
32 Initialize Microcode Descriptor.
33
34 @param[in] MicrocodeFmpPrivate private data structure to be initialized.
35
36 @return EFI_SUCCESS Microcode Descriptor is initialized.
37 **/
38 EFI_STATUS
39 InitializeMicrocodeDescriptor (
40 IN MICROCODE_FMP_PRIVATE_DATA *MicrocodeFmpPrivate
41 );
42
43 /**
44 Returns information about the current firmware image(s) of the device.
45
46 This function allows a copy of the current firmware image to be created and saved.
47 The saved copy could later been used, for example, in firmware image recovery or rollback.
48
49 @param[in] This A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance.
50 @param[in, out] ImageInfoSize A pointer to the size, in bytes, of the ImageInfo buffer.
51 On input, this is the size of the buffer allocated by the caller.
52 On output, it is the size of the buffer returned by the firmware
53 if the buffer was large enough, or the size of the buffer needed
54 to contain the image(s) information if the buffer was too small.
55 @param[in, out] ImageInfo A pointer to the buffer in which firmware places the current image(s)
56 information. The information is an array of EFI_FIRMWARE_IMAGE_DESCRIPTORs.
57 @param[out] DescriptorVersion A pointer to the location in which firmware returns the version number
58 associated with the EFI_FIRMWARE_IMAGE_DESCRIPTOR.
59 @param[out] DescriptorCount A pointer to the location in which firmware returns the number of
60 descriptors or firmware images within this device.
61 @param[out] DescriptorSize A pointer to the location in which firmware returns the size, in bytes,
62 of an individual EFI_FIRMWARE_IMAGE_DESCRIPTOR.
63 @param[out] PackageVersion A version number that represents all the firmware images in the device.
64 The format is vendor specific and new version must have a greater value
65 than the old version. If PackageVersion is not supported, the value is
66 0xFFFFFFFF. A value of 0xFFFFFFFE indicates that package version comparison
67 is to be performed using PackageVersionName. A value of 0xFFFFFFFD indicates
68 that package version update is in progress.
69 @param[out] PackageVersionName A pointer to a pointer to a null-terminated string representing the
70 package version name. The buffer is allocated by this function with
71 AllocatePool(), and it is the caller's responsibility to free it with a call
72 to FreePool().
73
74 @retval EFI_SUCCESS The device was successfully updated with the new image.
75 @retval EFI_BUFFER_TOO_SMALL The ImageInfo buffer was too small. The current buffer size
76 needed to hold the image(s) information is returned in ImageInfoSize.
77 @retval EFI_INVALID_PARAMETER ImageInfoSize is NULL.
78 @retval EFI_DEVICE_ERROR Valid information could not be returned. Possible corrupted image.
79
80 **/
81 EFI_STATUS
82 EFIAPI
83 FmpGetImageInfo (
84 IN EFI_FIRMWARE_MANAGEMENT_PROTOCOL *This,
85 IN OUT UINTN *ImageInfoSize,
86 IN OUT EFI_FIRMWARE_IMAGE_DESCRIPTOR *ImageInfo,
87 OUT UINT32 *DescriptorVersion,
88 OUT UINT8 *DescriptorCount,
89 OUT UINTN *DescriptorSize,
90 OUT UINT32 *PackageVersion,
91 OUT CHAR16 **PackageVersionName
92 )
93 {
94 MICROCODE_FMP_PRIVATE_DATA *MicrocodeFmpPrivate;
95 UINTN Index;
96
97 MicrocodeFmpPrivate = MICROCODE_FMP_PRIVATE_DATA_FROM_FMP(This);
98
99 if(ImageInfoSize == NULL) {
100 return EFI_INVALID_PARAMETER;
101 }
102
103 if (*ImageInfoSize < sizeof(EFI_FIRMWARE_IMAGE_DESCRIPTOR) * MicrocodeFmpPrivate->DescriptorCount) {
104 *ImageInfoSize = sizeof(EFI_FIRMWARE_IMAGE_DESCRIPTOR) * MicrocodeFmpPrivate->DescriptorCount;
105 return EFI_BUFFER_TOO_SMALL;
106 }
107
108 if (ImageInfo == NULL ||
109 DescriptorVersion == NULL ||
110 DescriptorCount == NULL ||
111 DescriptorSize == NULL ||
112 PackageVersion == NULL ||
113 PackageVersionName == NULL) {
114 return EFI_INVALID_PARAMETER;
115 }
116
117 *ImageInfoSize = sizeof(EFI_FIRMWARE_IMAGE_DESCRIPTOR) * MicrocodeFmpPrivate->DescriptorCount;
118 *DescriptorSize = sizeof(EFI_FIRMWARE_IMAGE_DESCRIPTOR);
119 *DescriptorCount = MicrocodeFmpPrivate->DescriptorCount;
120 *DescriptorVersion = EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION;
121
122 //
123 // supports 1 ImageInfo descriptor
124 //
125 CopyMem(&ImageInfo[0], MicrocodeFmpPrivate->ImageDescriptor, sizeof(EFI_FIRMWARE_IMAGE_DESCRIPTOR) * MicrocodeFmpPrivate->DescriptorCount);
126 for (Index = 0; Index < MicrocodeFmpPrivate->DescriptorCount; Index++) {
127 if ((ImageInfo[Index].AttributesSetting & IMAGE_ATTRIBUTE_IN_USE) != 0) {
128 ImageInfo[Index].LastAttemptVersion = MicrocodeFmpPrivate->LastAttempt.LastAttemptVersion;
129 ImageInfo[Index].LastAttemptStatus = MicrocodeFmpPrivate->LastAttempt.LastAttemptStatus;
130 }
131 }
132
133 //
134 // package version
135 //
136 *PackageVersion = MicrocodeFmpPrivate->PackageVersion;
137 if (MicrocodeFmpPrivate->PackageVersionName != NULL) {
138 *PackageVersionName = AllocateCopyPool(StrSize(MicrocodeFmpPrivate->PackageVersionName), MicrocodeFmpPrivate->PackageVersionName);
139 }
140
141 return EFI_SUCCESS;
142 }
143
144 /**
145 Retrieves a copy of the current firmware image of the device.
146
147 This function allows a copy of the current firmware image to be created and saved.
148 The saved copy could later been used, for example, in firmware image recovery or rollback.
149
150 @param[in] This A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance.
151 @param[in] ImageIndex A unique number identifying the firmware image(s) within the device.
152 The number is between 1 and DescriptorCount.
153 @param[in,out] Image Points to the buffer where the current image is copied to.
154 @param[in,out] ImageSize On entry, points to the size of the buffer pointed to by Image, in bytes.
155 On return, points to the length of the image, in bytes.
156
157 @retval EFI_SUCCESS The device was successfully updated with the new image.
158 @retval EFI_BUFFER_TOO_SMALL The buffer specified by ImageSize is too small to hold the
159 image. The current buffer size needed to hold the image is returned
160 in ImageSize.
161 @retval EFI_INVALID_PARAMETER The Image was NULL.
162 @retval EFI_NOT_FOUND The current image is not copied to the buffer.
163 @retval EFI_UNSUPPORTED The operation is not supported.
164 @retval EFI_SECURITY_VIOLATION The operation could not be performed due to an authentication failure.
165
166 **/
167 EFI_STATUS
168 EFIAPI
169 FmpGetImage (
170 IN EFI_FIRMWARE_MANAGEMENT_PROTOCOL *This,
171 IN UINT8 ImageIndex,
172 IN OUT VOID *Image,
173 IN OUT UINTN *ImageSize
174 )
175 {
176 MICROCODE_FMP_PRIVATE_DATA *MicrocodeFmpPrivate;
177 MICROCODE_INFO *MicrocodeInfo;
178
179 if (Image == NULL || ImageSize == NULL) {
180 return EFI_INVALID_PARAMETER;
181 }
182
183 MicrocodeFmpPrivate = MICROCODE_FMP_PRIVATE_DATA_FROM_FMP(This);
184
185 if (ImageIndex == 0 || ImageIndex > MicrocodeFmpPrivate->DescriptorCount || ImageSize == NULL || Image == NULL) {
186 return EFI_INVALID_PARAMETER;
187 }
188
189 MicrocodeInfo = &MicrocodeFmpPrivate->MicrocodeInfo[ImageIndex - 1];
190
191 if (*ImageSize < MicrocodeInfo->TotalSize) {
192 *ImageSize = MicrocodeInfo->TotalSize;
193 return EFI_BUFFER_TOO_SMALL;
194 }
195
196 *ImageSize = MicrocodeInfo->TotalSize;
197 CopyMem (Image, MicrocodeInfo->MicrocodeEntryPoint, MicrocodeInfo->TotalSize);
198 return EFI_SUCCESS;
199 }
200
201 /**
202 Updates the firmware image of the device.
203
204 This function updates the hardware with the new firmware image.
205 This function returns EFI_UNSUPPORTED if the firmware image is not updatable.
206 If the firmware image is updatable, the function should perform the following minimal validations
207 before proceeding to do the firmware image update.
208 - Validate the image authentication if image has attribute
209 IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED. The function returns
210 EFI_SECURITY_VIOLATION if the validation fails.
211 - Validate the image is a supported image for this device. The function returns EFI_ABORTED if
212 the image is unsupported. The function can optionally provide more detailed information on
213 why the image is not a supported image.
214 - Validate the data from VendorCode if not null. Image validation must be performed before
215 VendorCode data validation. VendorCode data is ignored or considered invalid if image
216 validation failed. The function returns EFI_ABORTED if the data is invalid.
217
218 VendorCode enables vendor to implement vendor-specific firmware image update policy. Null if
219 the caller did not specify the policy or use the default policy. As an example, vendor can implement
220 a policy to allow an option to force a firmware image update when the abort reason is due to the new
221 firmware image version is older than the current firmware image version or bad image checksum.
222 Sensitive operations such as those wiping the entire firmware image and render the device to be
223 non-functional should be encoded in the image itself rather than passed with the VendorCode.
224 AbortReason enables vendor to have the option to provide a more detailed description of the abort
225 reason to the caller.
226
227 @param[in] This A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance.
228 @param[in] ImageIndex A unique number identifying the firmware image(s) within the device.
229 The number is between 1 and DescriptorCount.
230 @param[in] Image Points to the new image.
231 @param[in] ImageSize Size of the new image in bytes.
232 @param[in] VendorCode This enables vendor to implement vendor-specific firmware image update policy.
233 Null indicates the caller did not specify the policy or use the default policy.
234 @param[in] Progress A function used by the driver to report the progress of the firmware update.
235 @param[out] AbortReason A pointer to a pointer to a null-terminated string providing more
236 details for the aborted operation. The buffer is allocated by this function
237 with AllocatePool(), and it is the caller's responsibility to free it with a
238 call to FreePool().
239
240 @retval EFI_SUCCESS The device was successfully updated with the new image.
241 @retval EFI_ABORTED The operation is aborted.
242 @retval EFI_INVALID_PARAMETER The Image was NULL.
243 @retval EFI_UNSUPPORTED The operation is not supported.
244 @retval EFI_SECURITY_VIOLATION The operation could not be performed due to an authentication failure.
245
246 **/
247 EFI_STATUS
248 EFIAPI
249 FmpSetImage (
250 IN EFI_FIRMWARE_MANAGEMENT_PROTOCOL *This,
251 IN UINT8 ImageIndex,
252 IN CONST VOID *Image,
253 IN UINTN ImageSize,
254 IN CONST VOID *VendorCode,
255 IN EFI_FIRMWARE_MANAGEMENT_UPDATE_IMAGE_PROGRESS Progress,
256 OUT CHAR16 **AbortReason
257 )
258 {
259 EFI_STATUS Status;
260 EFI_STATUS VarStatus;
261 MICROCODE_FMP_PRIVATE_DATA *MicrocodeFmpPrivate;
262
263 if (Image == NULL || AbortReason == NULL) {
264 return EFI_INVALID_PARAMETER;
265 }
266
267 MicrocodeFmpPrivate = MICROCODE_FMP_PRIVATE_DATA_FROM_FMP(This);
268 *AbortReason = NULL;
269
270 if (ImageIndex == 0 || ImageIndex > MicrocodeFmpPrivate->DescriptorCount || Image == NULL) {
271 return EFI_INVALID_PARAMETER;
272 }
273
274 Status = MicrocodeWrite(MicrocodeFmpPrivate, (VOID *)Image, ImageSize, &MicrocodeFmpPrivate->LastAttempt.LastAttemptVersion, &MicrocodeFmpPrivate->LastAttempt.LastAttemptStatus, AbortReason);
275 DEBUG((DEBUG_INFO, "SetImage - LastAttemp Version - 0x%x, State - 0x%x\n", MicrocodeFmpPrivate->LastAttempt.LastAttemptVersion, MicrocodeFmpPrivate->LastAttempt.LastAttemptStatus));
276 VarStatus = gRT->SetVariable(
277 MICROCODE_FMP_LAST_ATTEMPT_VARIABLE_NAME,
278 &gEfiCallerIdGuid,
279 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,
280 sizeof(MicrocodeFmpPrivate->LastAttempt),
281 &MicrocodeFmpPrivate->LastAttempt
282 );
283 DEBUG((DEBUG_INFO, "SetLastAttemp - %r\n", VarStatus));
284
285 if (!EFI_ERROR(Status)) {
286 InitializeMicrocodeDescriptor(MicrocodeFmpPrivate);
287 DumpPrivateInfo (MicrocodeFmpPrivate);
288 }
289
290 return Status;
291 }
292
293 /**
294 Checks if the firmware image is valid for the device.
295
296 This function allows firmware update application to validate the firmware image without
297 invoking the SetImage() first.
298
299 @param[in] This A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance.
300 @param[in] ImageIndex A unique number identifying the firmware image(s) within the device.
301 The number is between 1 and DescriptorCount.
302 @param[in] Image Points to the new image.
303 @param[in] ImageSize Size of the new image in bytes.
304 @param[out] ImageUpdatable Indicates if the new image is valid for update. It also provides,
305 if available, additional information if the image is invalid.
306
307 @retval EFI_SUCCESS The image was successfully checked.
308 @retval EFI_INVALID_PARAMETER The Image was NULL.
309 @retval EFI_UNSUPPORTED The operation is not supported.
310 @retval EFI_SECURITY_VIOLATION The operation could not be performed due to an authentication failure.
311
312 **/
313 EFI_STATUS
314 EFIAPI
315 FmpCheckImage (
316 IN EFI_FIRMWARE_MANAGEMENT_PROTOCOL *This,
317 IN UINT8 ImageIndex,
318 IN CONST VOID *Image,
319 IN UINTN ImageSize,
320 OUT UINT32 *ImageUpdatable
321 )
322 {
323 return EFI_UNSUPPORTED;
324 }
325
326 /**
327 Returns information about the firmware package.
328
329 This function returns package information.
330
331 @param[in] This A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance.
332 @param[out] PackageVersion A version number that represents all the firmware images in the device.
333 The format is vendor specific and new version must have a greater value
334 than the old version. If PackageVersion is not supported, the value is
335 0xFFFFFFFF. A value of 0xFFFFFFFE indicates that package version
336 comparison is to be performed using PackageVersionName. A value of
337 0xFFFFFFFD indicates that package version update is in progress.
338 @param[out] PackageVersionName A pointer to a pointer to a null-terminated string representing
339 the package version name. The buffer is allocated by this function with
340 AllocatePool(), and it is the caller's responsibility to free it with a
341 call to FreePool().
342 @param[out] PackageVersionNameMaxLen The maximum length of package version name if device supports update of
343 package version name. A value of 0 indicates the device does not support
344 update of package version name. Length is the number of Unicode characters,
345 including the terminating null character.
346 @param[out] AttributesSupported Package attributes that are supported by this device. See 'Package Attribute
347 Definitions' for possible returned values of this parameter. A value of 1
348 indicates the attribute is supported and the current setting value is
349 indicated in AttributesSetting. A value of 0 indicates the attribute is not
350 supported and the current setting value in AttributesSetting is meaningless.
351 @param[out] AttributesSetting Package attributes. See 'Package Attribute Definitions' for possible returned
352 values of this parameter
353
354 @retval EFI_SUCCESS The package information was successfully returned.
355 @retval EFI_UNSUPPORTED The operation is not supported.
356
357 **/
358 EFI_STATUS
359 EFIAPI
360 FmpGetPackageInfo (
361 IN EFI_FIRMWARE_MANAGEMENT_PROTOCOL *This,
362 OUT UINT32 *PackageVersion,
363 OUT CHAR16 **PackageVersionName,
364 OUT UINT32 *PackageVersionNameMaxLen,
365 OUT UINT64 *AttributesSupported,
366 OUT UINT64 *AttributesSetting
367 )
368 {
369 return EFI_UNSUPPORTED;
370 }
371
372 /**
373 Updates information about the firmware package.
374
375 This function updates package information.
376 This function returns EFI_UNSUPPORTED if the package information is not updatable.
377 VendorCode enables vendor to implement vendor-specific package information update policy.
378 Null if the caller did not specify this policy or use the default policy.
379
380 @param[in] This A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance.
381 @param[in] Image Points to the authentication image.
382 Null if authentication is not required.
383 @param[in] ImageSize Size of the authentication image in bytes.
384 0 if authentication is not required.
385 @param[in] VendorCode This enables vendor to implement vendor-specific firmware
386 image update policy.
387 Null indicates the caller did not specify this policy or use
388 the default policy.
389 @param[in] PackageVersion The new package version.
390 @param[in] PackageVersionName A pointer to the new null-terminated Unicode string representing
391 the package version name.
392 The string length is equal to or less than the value returned in
393 PackageVersionNameMaxLen.
394
395 @retval EFI_SUCCESS The device was successfully updated with the new package
396 information.
397 @retval EFI_INVALID_PARAMETER The PackageVersionName length is longer than the value
398 returned in PackageVersionNameMaxLen.
399 @retval EFI_UNSUPPORTED The operation is not supported.
400 @retval EFI_SECURITY_VIOLATION The operation could not be performed due to an authentication failure.
401
402 **/
403 EFI_STATUS
404 EFIAPI
405 FmpSetPackageInfo (
406 IN EFI_FIRMWARE_MANAGEMENT_PROTOCOL *This,
407 IN CONST VOID *Image,
408 IN UINTN ImageSize,
409 IN CONST VOID *VendorCode,
410 IN UINT32 PackageVersion,
411 IN CONST CHAR16 *PackageVersionName
412 )
413 {
414 return EFI_UNSUPPORTED;
415 }
416
417 /**
418 Initialize Processor Microcode Index.
419
420 @param[in] MicrocodeFmpPrivate private data structure to be initialized.
421 **/
422 VOID
423 InitializedProcessorMicrocodeIndex (
424 IN MICROCODE_FMP_PRIVATE_DATA *MicrocodeFmpPrivate
425 )
426 {
427 UINTN CpuIndex;
428 UINTN MicrocodeIndex;
429 UINTN TargetCpuIndex;
430 UINT32 AttemptStatus;
431 EFI_STATUS Status;
432
433 for (CpuIndex = 0; CpuIndex < MicrocodeFmpPrivate->ProcessorCount; CpuIndex++) {
434 if (MicrocodeFmpPrivate->ProcessorInfo[CpuIndex].MicrocodeIndex != (UINTN)-1) {
435 continue;
436 }
437 for (MicrocodeIndex = 0; MicrocodeIndex < MicrocodeFmpPrivate->DescriptorCount; MicrocodeIndex++) {
438 if (!MicrocodeFmpPrivate->MicrocodeInfo[MicrocodeIndex].InUse) {
439 continue;
440 }
441 TargetCpuIndex = CpuIndex;
442 Status = VerifyMicrocode(
443 MicrocodeFmpPrivate,
444 MicrocodeFmpPrivate->MicrocodeInfo[MicrocodeIndex].MicrocodeEntryPoint,
445 MicrocodeFmpPrivate->MicrocodeInfo[MicrocodeIndex].TotalSize,
446 FALSE,
447 &AttemptStatus,
448 NULL,
449 &TargetCpuIndex
450 );
451 if (!EFI_ERROR(Status)) {
452 MicrocodeFmpPrivate->ProcessorInfo[CpuIndex].MicrocodeIndex = MicrocodeIndex;
453 }
454 }
455 }
456 }
457
458 /**
459 Initialize Microcode Descriptor.
460
461 @param[in] MicrocodeFmpPrivate private data structure to be initialized.
462
463 @return EFI_SUCCESS Microcode Descriptor is initialized.
464 **/
465 EFI_STATUS
466 InitializeMicrocodeDescriptor (
467 IN MICROCODE_FMP_PRIVATE_DATA *MicrocodeFmpPrivate
468 )
469 {
470 UINT8 CurrentMicrocodeCount;
471
472 CurrentMicrocodeCount = (UINT8)GetMicrocodeInfo (MicrocodeFmpPrivate, 0, NULL, NULL);
473
474 if (CurrentMicrocodeCount > MicrocodeFmpPrivate->DescriptorCount) {
475 if (MicrocodeFmpPrivate->ImageDescriptor != NULL) {
476 FreePool(MicrocodeFmpPrivate->ImageDescriptor);
477 MicrocodeFmpPrivate->ImageDescriptor = NULL;
478 }
479 if (MicrocodeFmpPrivate->MicrocodeInfo != NULL) {
480 FreePool(MicrocodeFmpPrivate->MicrocodeInfo);
481 MicrocodeFmpPrivate->MicrocodeInfo = NULL;
482 }
483 } else {
484 ZeroMem(MicrocodeFmpPrivate->ImageDescriptor, MicrocodeFmpPrivate->DescriptorCount * sizeof(EFI_FIRMWARE_IMAGE_DESCRIPTOR));
485 ZeroMem(MicrocodeFmpPrivate->MicrocodeInfo, MicrocodeFmpPrivate->DescriptorCount * sizeof(MICROCODE_INFO));
486 }
487
488 MicrocodeFmpPrivate->DescriptorCount = CurrentMicrocodeCount;
489
490 if (MicrocodeFmpPrivate->ImageDescriptor == NULL) {
491 MicrocodeFmpPrivate->ImageDescriptor = AllocateZeroPool(MicrocodeFmpPrivate->DescriptorCount * sizeof(EFI_FIRMWARE_IMAGE_DESCRIPTOR));
492 if (MicrocodeFmpPrivate->ImageDescriptor == NULL) {
493 return EFI_OUT_OF_RESOURCES;
494 }
495 }
496 if (MicrocodeFmpPrivate->MicrocodeInfo == NULL) {
497 MicrocodeFmpPrivate->MicrocodeInfo = AllocateZeroPool(MicrocodeFmpPrivate->DescriptorCount * sizeof(MICROCODE_INFO));
498 if (MicrocodeFmpPrivate->MicrocodeInfo == NULL) {
499 return EFI_OUT_OF_RESOURCES;
500 }
501 }
502
503 CurrentMicrocodeCount = (UINT8)GetMicrocodeInfo (MicrocodeFmpPrivate, MicrocodeFmpPrivate->DescriptorCount, MicrocodeFmpPrivate->ImageDescriptor, MicrocodeFmpPrivate->MicrocodeInfo);
504 ASSERT(CurrentMicrocodeCount == MicrocodeFmpPrivate->DescriptorCount);
505
506 InitializedProcessorMicrocodeIndex (MicrocodeFmpPrivate);
507
508 return EFI_SUCCESS;
509 }
510
511 /**
512 Initialize MicrocodeFmpDriver multiprocessor information.
513
514 @param[in] MicrocodeFmpPrivate private data structure to be initialized.
515
516 @return EFI_SUCCESS private data is initialized.
517 **/
518 EFI_STATUS
519 InitializeProcessorInfo (
520 IN MICROCODE_FMP_PRIVATE_DATA *MicrocodeFmpPrivate
521 )
522 {
523 EFI_STATUS Status;
524 EFI_MP_SERVICES_PROTOCOL *MpService;
525 UINTN NumberOfProcessors;
526 UINTN NumberOfEnabledProcessors;
527 UINTN Index;
528 UINTN BspIndex;
529
530 Status = gBS->LocateProtocol (&gEfiMpServiceProtocolGuid, NULL, (VOID **)&MpService);
531 ASSERT_EFI_ERROR(Status);
532
533 MicrocodeFmpPrivate->MpService = MpService;
534 MicrocodeFmpPrivate->ProcessorCount = 0;
535 MicrocodeFmpPrivate->ProcessorInfo = NULL;
536
537 Status = MpService->GetNumberOfProcessors (MpService, &NumberOfProcessors, &NumberOfEnabledProcessors);
538 ASSERT_EFI_ERROR(Status);
539 MicrocodeFmpPrivate->ProcessorCount = NumberOfProcessors;
540
541 Status = MpService->WhoAmI (MpService, &BspIndex);
542 ASSERT_EFI_ERROR(Status);
543 MicrocodeFmpPrivate->BspIndex = BspIndex;
544
545 MicrocodeFmpPrivate->ProcessorInfo = AllocateZeroPool (sizeof(PROCESSOR_INFO) * MicrocodeFmpPrivate->ProcessorCount);
546 if (MicrocodeFmpPrivate->ProcessorInfo == NULL) {
547 return EFI_OUT_OF_RESOURCES;
548 }
549
550 for (Index = 0; Index < NumberOfProcessors; Index++) {
551 MicrocodeFmpPrivate->ProcessorInfo[Index].CpuIndex = Index;
552 MicrocodeFmpPrivate->ProcessorInfo[Index].MicrocodeIndex = (UINTN)-1;
553 if (Index == BspIndex) {
554 CollectProcessorInfo (&MicrocodeFmpPrivate->ProcessorInfo[Index]);
555 } else {
556 Status = MpService->StartupThisAP (
557 MpService,
558 CollectProcessorInfo,
559 Index,
560 NULL,
561 0,
562 &MicrocodeFmpPrivate->ProcessorInfo[Index],
563 NULL
564 );
565 ASSERT_EFI_ERROR(Status);
566 }
567 }
568
569 return EFI_SUCCESS;
570 }
571
572 /**
573 Dump private information.
574
575 @param[in] MicrocodeFmpPrivate private data structure.
576 **/
577 VOID
578 DumpPrivateInfo (
579 IN MICROCODE_FMP_PRIVATE_DATA *MicrocodeFmpPrivate
580 )
581 {
582 UINTN Index;
583 PROCESSOR_INFO *ProcessorInfo;
584 MICROCODE_INFO *MicrocodeInfo;
585 EFI_FIRMWARE_IMAGE_DESCRIPTOR *ImageDescriptor;
586
587 DEBUG ((DEBUG_INFO, "ProcessorInfo:\n"));
588 DEBUG ((DEBUG_INFO, " ProcessorCount - 0x%x\n", MicrocodeFmpPrivate->ProcessorCount));
589 DEBUG ((DEBUG_INFO, " BspIndex - 0x%x\n", MicrocodeFmpPrivate->BspIndex));
590
591 ProcessorInfo = MicrocodeFmpPrivate->ProcessorInfo;
592 for (Index = 0; Index < MicrocodeFmpPrivate->ProcessorCount; Index++) {
593 DEBUG ((
594 DEBUG_INFO,
595 " ProcessorInfo[0x%x] - 0x%08x, 0x%02x, 0x%08x, (0x%x)\n",
596 ProcessorInfo[Index].CpuIndex,
597 ProcessorInfo[Index].ProcessorSignature,
598 ProcessorInfo[Index].PlatformId,
599 ProcessorInfo[Index].MicrocodeRevision,
600 ProcessorInfo[Index].MicrocodeIndex
601 ));
602 }
603
604 DEBUG ((DEBUG_INFO, "MicrocodeInfo:\n"));
605 MicrocodeInfo = MicrocodeFmpPrivate->MicrocodeInfo;
606 DEBUG ((DEBUG_INFO, " MicrocodeRegion - 0x%x - 0x%x\n", MicrocodeFmpPrivate->MicrocodePatchAddress, MicrocodeFmpPrivate->MicrocodePatchRegionSize));
607 DEBUG ((DEBUG_INFO, " MicrocodeCount - 0x%x\n", MicrocodeFmpPrivate->DescriptorCount));
608 for (Index = 0; Index < MicrocodeFmpPrivate->DescriptorCount; Index++) {
609 DEBUG ((
610 DEBUG_INFO,
611 " MicrocodeInfo[0x%x] - 0x%08x, 0x%08x, (0x%x)\n",
612 Index,
613 MicrocodeInfo[Index].MicrocodeEntryPoint,
614 MicrocodeInfo[Index].TotalSize,
615 MicrocodeInfo[Index].InUse
616 ));
617 }
618
619 ImageDescriptor = MicrocodeFmpPrivate->ImageDescriptor;
620 DEBUG ((DEBUG_VERBOSE, "ImageDescriptor:\n"));
621 for (Index = 0; Index < MicrocodeFmpPrivate->DescriptorCount; Index++) {
622 DEBUG((DEBUG_VERBOSE, " ImageDescriptor (%d)\n", Index));
623 DEBUG((DEBUG_VERBOSE, " ImageIndex - 0x%x\n", ImageDescriptor[Index].ImageIndex));
624 DEBUG((DEBUG_VERBOSE, " ImageTypeId - %g\n", &ImageDescriptor[Index].ImageTypeId));
625 DEBUG((DEBUG_VERBOSE, " ImageId - 0x%lx\n", ImageDescriptor[Index].ImageId));
626 DEBUG((DEBUG_VERBOSE, " ImageIdName - %s\n", ImageDescriptor[Index].ImageIdName));
627 DEBUG((DEBUG_VERBOSE, " Version - 0x%x\n", ImageDescriptor[Index].Version));
628 DEBUG((DEBUG_VERBOSE, " VersionName - %s\n", ImageDescriptor[Index].VersionName));
629 DEBUG((DEBUG_VERBOSE, " Size - 0x%x\n", ImageDescriptor[Index].Size));
630 DEBUG((DEBUG_VERBOSE, " AttributesSupported - 0x%lx\n", ImageDescriptor[Index].AttributesSupported));
631 DEBUG((DEBUG_VERBOSE, " AttributesSetting - 0x%lx\n", ImageDescriptor[Index].AttributesSetting));
632 DEBUG((DEBUG_VERBOSE, " Compatibilities - 0x%lx\n", ImageDescriptor[Index].Compatibilities));
633 DEBUG((DEBUG_VERBOSE, " LowestSupportedImageVersion - 0x%x\n", ImageDescriptor[Index].LowestSupportedImageVersion));
634 DEBUG((DEBUG_VERBOSE, " LastAttemptVersion - 0x%x\n", ImageDescriptor[Index].LastAttemptVersion));
635 DEBUG((DEBUG_VERBOSE, " LastAttemptStatus - 0x%x\n", ImageDescriptor[Index].LastAttemptStatus));
636 DEBUG((DEBUG_VERBOSE, " HardwareInstance - 0x%lx\n", ImageDescriptor[Index].HardwareInstance));
637 }
638 }
639
640 /**
641 Initialize MicrocodeFmpDriver private data structure.
642
643 @param[in] MicrocodeFmpPrivate private data structure to be initialized.
644
645 @return EFI_SUCCESS private data is initialized.
646 **/
647 EFI_STATUS
648 InitializePrivateData (
649 IN MICROCODE_FMP_PRIVATE_DATA *MicrocodeFmpPrivate
650 )
651 {
652 EFI_STATUS Status;
653 EFI_STATUS VarStatus;
654 UINTN VarSize;
655 BOOLEAN Result;
656
657 MicrocodeFmpPrivate->Signature = MICROCODE_FMP_PRIVATE_DATA_SIGNATURE;
658 MicrocodeFmpPrivate->Handle = NULL;
659 CopyMem(&MicrocodeFmpPrivate->Fmp, &mFirmwareManagementProtocol, sizeof(EFI_FIRMWARE_MANAGEMENT_PROTOCOL));
660
661 MicrocodeFmpPrivate->PackageVersion = 0x1;
662 MicrocodeFmpPrivate->PackageVersionName = L"Microcode";
663
664 MicrocodeFmpPrivate->LastAttempt.LastAttemptVersion = 0x0;
665 MicrocodeFmpPrivate->LastAttempt.LastAttemptStatus = 0x0;
666 VarSize = sizeof(MicrocodeFmpPrivate->LastAttempt);
667 VarStatus = gRT->GetVariable(
668 MICROCODE_FMP_LAST_ATTEMPT_VARIABLE_NAME,
669 &gEfiCallerIdGuid,
670 NULL,
671 &VarSize,
672 &MicrocodeFmpPrivate->LastAttempt
673 );
674 DEBUG((DEBUG_INFO, "GetLastAttemp - %r\n", VarStatus));
675 DEBUG((DEBUG_INFO, "GetLastAttemp Version - 0x%x, State - 0x%x\n", MicrocodeFmpPrivate->LastAttempt.LastAttemptVersion, MicrocodeFmpPrivate->LastAttempt.LastAttemptStatus));
676
677 Result = GetMicrocodeRegion(&MicrocodeFmpPrivate->MicrocodePatchAddress, &MicrocodeFmpPrivate->MicrocodePatchRegionSize);
678 if (!Result) {
679 DEBUG((DEBUG_ERROR, "Fail to get Microcode Region\n"));
680 return EFI_NOT_FOUND;
681 }
682
683 Status = InitializeProcessorInfo (MicrocodeFmpPrivate);
684 if (EFI_ERROR(Status)) {
685 DEBUG((DEBUG_ERROR, "InitializeProcessorInfo - %r\n", Status));
686 return Status;
687 }
688
689 Status = InitializeMicrocodeDescriptor(MicrocodeFmpPrivate);
690 if (EFI_ERROR(Status)) {
691 DEBUG((DEBUG_ERROR, "InitializeMicrocodeDescriptor - %r\n", Status));
692 return Status;
693 }
694
695 DumpPrivateInfo (MicrocodeFmpPrivate);
696
697 return Status;
698 }
699
700 /**
701 Microcode FMP module entrypoint
702
703 @param[in] ImageHandle The firmware allocated handle for the EFI image.
704 @param[in] SystemTable A pointer to the EFI System Table.
705
706 @return EFI_SUCCESS Microcode FMP module is initialized.
707 **/
708 EFI_STATUS
709 EFIAPI
710 MicrocodeFmpMain (
711 IN EFI_HANDLE ImageHandle,
712 IN EFI_SYSTEM_TABLE *SystemTable
713 )
714 {
715 EFI_STATUS Status;
716
717 //
718 // Initialize MicrocodeFmpPrivateData
719 //
720 mMicrocodeFmpPrivate = AllocateZeroPool (sizeof(MICROCODE_FMP_PRIVATE_DATA));
721 if (mMicrocodeFmpPrivate == NULL) {
722 return EFI_OUT_OF_RESOURCES;
723 }
724
725 Status = InitializePrivateData(mMicrocodeFmpPrivate);
726 if (EFI_ERROR(Status)) {
727 FreePool(mMicrocodeFmpPrivate);
728 mMicrocodeFmpPrivate = NULL;
729 return Status;
730 }
731
732 //
733 // Install FMP protocol.
734 //
735 Status = gBS->InstallProtocolInterface (
736 &mMicrocodeFmpPrivate->Handle,
737 &gEfiFirmwareManagementProtocolGuid,
738 EFI_NATIVE_INTERFACE,
739 &mMicrocodeFmpPrivate->Fmp
740 );
741 if (EFI_ERROR (Status)) {
742 FreePool(mMicrocodeFmpPrivate);
743 mMicrocodeFmpPrivate = NULL;
744 return Status;
745 }
746
747 return Status;
748 }