StandaloneMmPkg: Apply uncrustify changes

[mirror_edk2.git] / UefiCpuPkg / Library / MpInitLib / Microcode.c

/** @file\r
  Implementation of loading microcode on processors.\r
\r
  Copyright (c) 2015 - 2021, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "MpLib.h"\r
\r
/**\r
  Detect whether specified processor can find matching microcode patch and load it.\r
\r
  @param[in]  CpuMpData        The pointer to CPU MP Data structure.\r
  @param[in]  ProcessorNumber  The handle number of the processor. The range is\r
                               from 0 to the total number of logical processors\r
                               minus 1.\r
**/\r
VOID\r
MicrocodeDetect (\r
  IN CPU_MP_DATA             *CpuMpData,\r
  IN UINTN                   ProcessorNumber\r
  )\r
{\r
  CPU_MICROCODE_HEADER                    *Microcode;\r
  UINTN                                   MicrocodeEnd;\r
  CPU_AP_DATA                             *BspData;\r
  UINT32                                  LatestRevision;\r
  CPU_MICROCODE_HEADER                    *LatestMicrocode;\r
  UINT32                                  ThreadId;\r
  EDKII_PEI_MICROCODE_CPU_ID              MicrocodeCpuId;\r
\r
  if (CpuMpData->MicrocodePatchRegionSize == 0) {\r
    //\r
    // There is no microcode patches\r
    //\r
    return;\r
  }\r
\r
  GetProcessorLocationByApicId (GetInitialApicId (), NULL, NULL, &ThreadId);\r
  if (ThreadId != 0) {\r
    //\r
    // Skip loading microcode if it is not the first thread in one core.\r
    //\r
    return;\r
  }\r
\r
  GetProcessorMicrocodeCpuId (&MicrocodeCpuId);\r
\r
  if (ProcessorNumber != (UINTN) CpuMpData->BspNumber) {\r
    //\r
    // Direct use microcode of BSP if AP is the same as BSP.\r
    // Assume BSP calls this routine() before AP.\r
    //\r
    BspData = &(CpuMpData->CpuData[CpuMpData->BspNumber]);\r
    if ((BspData->ProcessorSignature == MicrocodeCpuId.ProcessorSignature) &&\r
        (BspData->PlatformId == MicrocodeCpuId.PlatformId) &&\r
        (BspData->MicrocodeEntryAddr != 0)) {\r
      LatestMicrocode = (CPU_MICROCODE_HEADER *)(UINTN) BspData->MicrocodeEntryAddr;\r
      LatestRevision  = LatestMicrocode->UpdateRevision;\r
      goto LoadMicrocode;\r
    }\r
  }\r
\r
  //\r
  // BSP or AP which is different from BSP runs here\r
  // Use 0 as the starting revision to search for microcode because MicrocodePatchInfo HOB needs\r
  // the latest microcode location even it's loaded to the processor.\r
  //\r
  LatestRevision  = 0;\r
  LatestMicrocode = NULL;\r
  Microcode       = (CPU_MICROCODE_HEADER *) (UINTN) CpuMpData->MicrocodePatchAddress;\r
  MicrocodeEnd    = (UINTN) Microcode + (UINTN) CpuMpData->MicrocodePatchRegionSize;\r
\r
  do {\r
    if (!IsValidMicrocode (Microcode, MicrocodeEnd - (UINTN) Microcode, LatestRevision, &MicrocodeCpuId, 1, TRUE)) {\r
      //\r
      // It is the padding data between the microcode patches for microcode patches alignment.\r
      // Because the microcode patch is the multiple of 1-KByte, the padding data should not\r
      // exist if the microcode patch alignment value is not larger than 1-KByte. So, the microcode\r
      // alignment value should be larger than 1-KByte. We could skip SIZE_1KB padding data to\r
      // find the next possible microcode patch header.\r
      //\r
      Microcode = (CPU_MICROCODE_HEADER *) ((UINTN) Microcode + SIZE_1KB);\r
      continue;\r
    }\r
    LatestMicrocode = Microcode;\r
    LatestRevision  = LatestMicrocode->UpdateRevision;\r
\r
    Microcode = (CPU_MICROCODE_HEADER *) (((UINTN) Microcode) + GetMicrocodeLength (Microcode));\r
  } while ((UINTN) Microcode < MicrocodeEnd);\r
\r
LoadMicrocode:\r
  if (LatestRevision != 0) {\r
    //\r
    // Save the detected microcode patch entry address (including the microcode\r
    // patch header) for each processor even it's the same as the loaded one.\r
    // It will be used when building the microcode patch cache HOB.\r
    //\r
    CpuMpData->CpuData[ProcessorNumber].MicrocodeEntryAddr = (UINTN) LatestMicrocode;\r
  }\r
\r
  if (LatestRevision > GetProcessorMicrocodeSignature ()) {\r
    //\r
    // BIOS only authenticate updates that contain a numerically larger revision\r
    // than the currently loaded revision, where Current Signature < New Update\r
    // Revision. A processor with no loaded update is considered to have a\r
    // revision equal to zero.\r
    //\r
    LoadMicrocode (LatestMicrocode);\r
  }\r
  //\r
  // It's possible that the microcode fails to load. Just capture the CPU microcode revision after loading.\r
  //\r
  CpuMpData->CpuData[ProcessorNumber].MicrocodeRevision = GetProcessorMicrocodeSignature ();\r
}\r
\r
/**\r
  Actual worker function that shadows the required microcode patches into memory.\r
\r
  @param[in, out]  CpuMpData        The pointer to CPU MP Data structure.\r
  @param[in]       Patches          The pointer to an array of information on\r
                                    the microcode patches that will be loaded\r
                                    into memory.\r
  @param[in]       PatchCount       The number of microcode patches that will\r
                                    be loaded into memory.\r
  @param[in]       TotalLoadSize    The total size of all the microcode patches\r
                                    to be loaded.\r
**/\r
VOID\r
ShadowMicrocodePatchWorker (\r
  IN OUT CPU_MP_DATA             *CpuMpData,\r
  IN     MICROCODE_PATCH_INFO    *Patches,\r
  IN     UINTN                   PatchCount,\r
  IN     UINTN                   TotalLoadSize\r
  )\r
{\r
  UINTN    Index;\r
  VOID     *MicrocodePatchInRam;\r
  UINT8    *Walker;\r
\r
  ASSERT ((Patches != NULL) && (PatchCount != 0));\r
\r
  MicrocodePatchInRam = AllocatePages (EFI_SIZE_TO_PAGES (TotalLoadSize));\r
  if (MicrocodePatchInRam == NULL) {\r
    return;\r
  }\r
\r
  //\r
  // Load all the required microcode patches into memory\r
  //\r
  for (Walker = MicrocodePatchInRam, Index = 0; Index < PatchCount; Index++) {\r
    CopyMem (\r
      Walker,\r
      (VOID *) Patches[Index].Address,\r
      Patches[Index].Size\r
      );\r
    Walker += Patches[Index].Size;\r
  }\r
\r
  //\r
  // Update the microcode patch related fields in CpuMpData\r
  //\r
  CpuMpData->MicrocodePatchAddress    = (UINTN) MicrocodePatchInRam;\r
  CpuMpData->MicrocodePatchRegionSize = TotalLoadSize;\r
\r
  DEBUG ((\r
    DEBUG_INFO,\r
    "%a: Required microcode patches have been loaded at 0x%lx, with size 0x%lx.\n",\r
    __FUNCTION__, CpuMpData->MicrocodePatchAddress, CpuMpData->MicrocodePatchRegionSize\r
    ));\r
\r
  return;\r
}\r
\r
/**\r
  Shadow the required microcode patches data into memory according to PCD\r
  PcdCpuMicrocodePatchAddress and PcdCpuMicrocodePatchRegionSize.\r
\r
  @param[in, out]  CpuMpData    The pointer to CPU MP Data structure.\r
**/\r
VOID\r
ShadowMicrocodePatchByPcd (\r
  IN OUT CPU_MP_DATA             *CpuMpData\r
  )\r
{\r
  UINTN                                  Index;\r
  CPU_MICROCODE_HEADER                   *MicrocodeEntryPoint;\r
  UINTN                                  MicrocodeEnd;\r
  UINTN                                  TotalSize;\r
  MICROCODE_PATCH_INFO                   *PatchInfoBuffer;\r
  UINTN                                  MaxPatchNumber;\r
  UINTN                                  PatchCount;\r
  UINTN                                  TotalLoadSize;\r
  EDKII_PEI_MICROCODE_CPU_ID             *MicrocodeCpuIds;\r
  BOOLEAN                                Valid;\r
\r
  //\r
  // Initialize the microcode patch related fields in CpuMpData as the values\r
  // specified by the PCD pair. If the microcode patches are loaded into memory,\r
  // these fields will be updated.\r
  //\r
  CpuMpData->MicrocodePatchAddress    = PcdGet64 (PcdCpuMicrocodePatchAddress);\r
  CpuMpData->MicrocodePatchRegionSize = PcdGet64 (PcdCpuMicrocodePatchRegionSize);\r
\r
  MicrocodeEntryPoint    = (CPU_MICROCODE_HEADER *) (UINTN) CpuMpData->MicrocodePatchAddress;\r
  MicrocodeEnd           = (UINTN) MicrocodeEntryPoint +\r
                           (UINTN) CpuMpData->MicrocodePatchRegionSize;\r
  if ((MicrocodeEntryPoint == NULL) || ((UINTN) MicrocodeEntryPoint == MicrocodeEnd)) {\r
    //\r
    // There is no microcode patches\r
    //\r
    return;\r
  }\r
\r
  PatchCount      = 0;\r
  MaxPatchNumber  = DEFAULT_MAX_MICROCODE_PATCH_NUM;\r
  TotalLoadSize   = 0;\r
  PatchInfoBuffer = AllocatePool (MaxPatchNumber * sizeof (MICROCODE_PATCH_INFO));\r
  if (PatchInfoBuffer == NULL) {\r
    return;\r
  }\r
\r
  MicrocodeCpuIds = AllocatePages (\r
                      EFI_SIZE_TO_PAGES (CpuMpData->CpuCount * sizeof (EDKII_PEI_MICROCODE_CPU_ID))\r
                      );\r
  if (MicrocodeCpuIds == NULL) {\r
    FreePool (PatchInfoBuffer);\r
    return;\r
  }\r
\r
  for (Index = 0; Index < CpuMpData->CpuCount; Index++) {\r
    MicrocodeCpuIds[Index].PlatformId         = CpuMpData->CpuData[Index].PlatformId;\r
    MicrocodeCpuIds[Index].ProcessorSignature = CpuMpData->CpuData[Index].ProcessorSignature;\r
  }\r
\r
  //\r
  // Process the header of each microcode patch within the region.\r
  // The purpose is to decide which microcode patch(es) will be loaded into memory.\r
  // Microcode checksum is not verified because it's slow when performing on flash.\r
  //\r
  do {\r
    Valid = IsValidMicrocode (\r
              MicrocodeEntryPoint,\r
              MicrocodeEnd - (UINTN) MicrocodeEntryPoint,\r
              0,\r
              MicrocodeCpuIds,\r
              CpuMpData->CpuCount,\r
              FALSE\r
              );\r
    if (!Valid) {\r
      //\r
      // Padding data between the microcode patches, skip 1KB to check next entry.\r
      //\r
      MicrocodeEntryPoint = (CPU_MICROCODE_HEADER *) (((UINTN) MicrocodeEntryPoint) + SIZE_1KB);\r
      continue;\r
    }\r
\r
    PatchCount++;\r
    if (PatchCount > MaxPatchNumber) {\r
      //\r
      // Current 'PatchInfoBuffer' cannot hold the information, double the size\r
      // and allocate a new buffer.\r
      //\r
      if (MaxPatchNumber > MAX_UINTN / 2 / sizeof (MICROCODE_PATCH_INFO)) {\r
        //\r
        // Overflow check for MaxPatchNumber\r
        //\r
        goto OnExit;\r
      }\r
\r
      PatchInfoBuffer = ReallocatePool (\r
                          MaxPatchNumber * sizeof (MICROCODE_PATCH_INFO),\r
                          2 * MaxPatchNumber * sizeof (MICROCODE_PATCH_INFO),\r
                          PatchInfoBuffer\r
                          );\r
      if (PatchInfoBuffer == NULL) {\r
        goto OnExit;\r
      }\r
      MaxPatchNumber = MaxPatchNumber * 2;\r
    }\r
\r
    TotalSize = GetMicrocodeLength (MicrocodeEntryPoint);\r
\r
    //\r
    // Store the information of this microcode patch\r
    //\r
    PatchInfoBuffer[PatchCount - 1].Address = (UINTN) MicrocodeEntryPoint;\r
    PatchInfoBuffer[PatchCount - 1].Size    = TotalSize;\r
    TotalLoadSize += TotalSize;\r
\r
    //\r
    // Process the next microcode patch\r
    //\r
    MicrocodeEntryPoint = (CPU_MICROCODE_HEADER *) ((UINTN) MicrocodeEntryPoint + TotalSize);\r
  } while ((UINTN) MicrocodeEntryPoint < MicrocodeEnd);\r
\r
  if (PatchCount != 0) {\r
    DEBUG ((\r
      DEBUG_INFO,\r
      "%a: 0x%x microcode patches will be loaded into memory, with size 0x%x.\n",\r
      __FUNCTION__, PatchCount, TotalLoadSize\r
      ));\r
\r
    ShadowMicrocodePatchWorker (CpuMpData, PatchInfoBuffer, PatchCount, TotalLoadSize);\r
  }\r
\r
OnExit:\r
  if (PatchInfoBuffer != NULL) {\r
    FreePool (PatchInfoBuffer);\r
  }\r
  FreePages (MicrocodeCpuIds, EFI_SIZE_TO_PAGES (CpuMpData->CpuCount * sizeof (EDKII_PEI_MICROCODE_CPU_ID)));\r
}\r
\r
/**\r
  Shadow the required microcode patches data into memory.\r
\r
  @param[in, out]  CpuMpData    The pointer to CPU MP Data structure.\r
**/\r
VOID\r
ShadowMicrocodeUpdatePatch (\r
  IN OUT CPU_MP_DATA             *CpuMpData\r
  )\r
{\r
  EFI_STATUS     Status;\r
\r
  Status = PlatformShadowMicrocode (CpuMpData);\r
  if (EFI_ERROR (Status)) {\r
    ShadowMicrocodePatchByPcd (CpuMpData);\r
  }\r
}\r
\r
/**\r
  Get the cached microcode patch base address and size from the microcode patch\r
  information cache HOB.\r
\r
  @param[out] Address       Base address of the microcode patches data.\r
                            It will be updated if the microcode patch\r
                            information cache HOB is found.\r
  @param[out] RegionSize    Size of the microcode patches data.\r
                            It will be updated if the microcode patch\r
                            information cache HOB is found.\r
\r
  @retval  TRUE     The microcode patch information cache HOB is found.\r
  @retval  FALSE    The microcode patch information cache HOB is not found.\r
\r
**/\r
BOOLEAN\r
GetMicrocodePatchInfoFromHob (\r
  UINT64                         *Address,\r
  UINT64                         *RegionSize\r
  )\r
{\r
  EFI_HOB_GUID_TYPE            *GuidHob;\r
  EDKII_MICROCODE_PATCH_HOB    *MicrocodePathHob;\r
\r
  GuidHob = GetFirstGuidHob (&gEdkiiMicrocodePatchHobGuid);\r
  if (GuidHob == NULL) {\r
    DEBUG((DEBUG_INFO, "%a: Microcode patch cache HOB is not found.\n", __FUNCTION__));\r
    return FALSE;\r
  }\r
\r
  MicrocodePathHob = GET_GUID_HOB_DATA (GuidHob);\r
\r
  *Address    = MicrocodePathHob->MicrocodePatchAddress;\r
  *RegionSize = MicrocodePathHob->MicrocodePatchRegionSize;\r
\r
  DEBUG((\r
    DEBUG_INFO, "%a: MicrocodeBase = 0x%lx, MicrocodeSize = 0x%lx\n",\r
    __FUNCTION__, *Address, *RegionSize\r
    ));\r
\r
  return TRUE;\r
}\r