[mirror_edk2.git] / MdeModulePkg / Universal / CapsulePei / UefiCapsule.c

/** @file\r
  Capsule update PEIM for UEFI2.0\r
\r
Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions\r
of the BSD License which accompanies this distribution.  The\r
full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "Capsule.h"\r
\r
#ifdef MDE_CPU_IA32\r
//\r
// Global Descriptor Table (GDT)\r
//\r
GLOBAL_REMOVE_IF_UNREFERENCED IA32_SEGMENT_DESCRIPTOR mGdtEntries[] = {\r
/* selector { Global Segment Descriptor                              } */\r
/* 0x00 */  {{0,      0,  0,  0,    0,  0,  0,  0,    0,  0, 0,  0,  0}}, //null descriptor\r
/* 0x08 */  {{0xffff, 0,  0,  0x3,  1,  0,  1,  0xf,  0,  0, 1,  1,  0}}, //linear data segment descriptor\r
/* 0x10 */  {{0xffff, 0,  0,  0xf,  1,  0,  1,  0xf,  0,  0, 1,  1,  0}}, //linear code segment descriptor\r
/* 0x18 */  {{0xffff, 0,  0,  0x3,  1,  0,  1,  0xf,  0,  0, 1,  1,  0}}, //system data segment descriptor\r
/* 0x20 */  {{0xffff, 0,  0,  0xb,  1,  0,  1,  0xf,  0,  0, 1,  1,  0}}, //system code segment descriptor\r
/* 0x28 */  {{0,      0,  0,  0,    0,  0,  0,  0,    0,  0, 0,  0,  0}}, //spare segment descriptor\r
/* 0x30 */  {{0xffff, 0,  0,  0x3,  1,  0,  1,  0xf,  0,  0, 1,  1,  0}}, //system data segment descriptor\r
/* 0x38 */  {{0xffff, 0,  0,  0xb,  1,  0,  1,  0xf,  0,  1, 0,  1,  0}}, //system code segment descriptor\r
/* 0x40 */  {{0,      0,  0,  0,    0,  0,  0,  0,    0,  0, 0,  0,  0}}, //spare segment descriptor\r
};\r
\r
//\r
// IA32 Gdt register\r
//\r
GLOBAL_REMOVE_IF_UNREFERENCED CONST IA32_DESCRIPTOR mGdt = {\r
  sizeof (mGdtEntries) - 1,\r
  (UINTN) mGdtEntries\r
  };\r
\r
/**\r
  Calculate the total size of page table.\r
  \r
  @return The size of page table.\r
  \r
  \r
**/\r
UINTN\r
CalculatePageTableSize (\r
  VOID\r
  )\r
{\r
  UINT32                                        RegEax;\r
  UINT32                                        RegEdx;\r
  UINTN                                         TotalPagesNum;\r
  UINT8                                         PhysicalAddressBits;\r
  VOID                                          *Hob;\r
  UINT32                                        NumberOfPml4EntriesNeeded;\r
  UINT32                                        NumberOfPdpEntriesNeeded;\r
  BOOLEAN                                       Page1GSupport;\r
\r
  Page1GSupport = FALSE;\r
  if (PcdGetBool(PcdUse1GPageTable)) {\r
    AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL);\r
    if (RegEax >= 0x80000001) {\r
      AsmCpuid (0x80000001, NULL, NULL, NULL, &RegEdx);\r
      if ((RegEdx & BIT26) != 0) {\r
        Page1GSupport = TRUE;\r
      }\r
    }\r
  }\r
\r
  //\r
  // Get physical address bits supported.\r
  //\r
  Hob = GetFirstHob (EFI_HOB_TYPE_CPU);\r
  if (Hob != NULL) {\r
    PhysicalAddressBits = ((EFI_HOB_CPU *) Hob)->SizeOfMemorySpace;\r
  } else {\r
    AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL);\r
    if (RegEax >= 0x80000008) {\r
      AsmCpuid (0x80000008, &RegEax, NULL, NULL, NULL);\r
      PhysicalAddressBits = (UINT8) RegEax;\r
    } else {\r
      PhysicalAddressBits = 36;\r
    }\r
  }\r
\r
  //\r
  // IA-32e paging translates 48-bit linear addresses to 52-bit physical addresses.\r
  //\r
  ASSERT (PhysicalAddressBits <= 52);\r
  if (PhysicalAddressBits > 48) {\r
    PhysicalAddressBits = 48;\r
  }\r
\r
  //\r
  // Calculate the table entries needed.\r
  //\r
  if (PhysicalAddressBits <= 39 ) {\r
    NumberOfPml4EntriesNeeded = 1;\r
    NumberOfPdpEntriesNeeded = (UINT32)LShiftU64 (1, (PhysicalAddressBits - 30));\r
  } else {\r
    NumberOfPml4EntriesNeeded = (UINT32)LShiftU64 (1, (PhysicalAddressBits - 39));\r
    NumberOfPdpEntriesNeeded = 512;\r
  }\r
\r
  if (!Page1GSupport) {\r
    TotalPagesNum = (NumberOfPdpEntriesNeeded + 1) * NumberOfPml4EntriesNeeded + 1;\r
  } else {\r
    TotalPagesNum = NumberOfPml4EntriesNeeded + 1;\r
  }\r
\r
  return EFI_PAGES_TO_SIZE (TotalPagesNum);\r
}\r
\r
/**\r
  Allocates and fills in the Page Directory and Page Table Entries to\r
  establish a 1:1 Virtual to Physical mapping.\r
\r
  @param[in]  PageTablesAddress  The base address of page table.\r
\r
**/\r
VOID\r
CreateIdentityMappingPageTables (\r
  IN  EFI_PHYSICAL_ADDRESS  PageTablesAddress\r
  )\r
{  \r
  UINT32                                        RegEax;\r
  UINT32                                        RegEdx;\r
  UINT8                                         PhysicalAddressBits;\r
  EFI_PHYSICAL_ADDRESS                          PageAddress;\r
  UINTN                                         IndexOfPml4Entries;\r
  UINTN                                         IndexOfPdpEntries;\r
  UINTN                                         IndexOfPageDirectoryEntries;\r
  UINT32                                        NumberOfPml4EntriesNeeded;\r
  UINT32                                        NumberOfPdpEntriesNeeded;\r
  PAGE_MAP_AND_DIRECTORY_POINTER                *PageMapLevel4Entry;\r
  PAGE_MAP_AND_DIRECTORY_POINTER                *PageMap;\r
  PAGE_MAP_AND_DIRECTORY_POINTER                *PageDirectoryPointerEntry;\r
  PAGE_TABLE_ENTRY                              *PageDirectoryEntry;\r
  UINTN                                         BigPageAddress;\r
  VOID                                          *Hob;\r
  BOOLEAN                                       Page1GSupport;\r
  PAGE_TABLE_1G_ENTRY                           *PageDirectory1GEntry;\r
\r
  Page1GSupport = FALSE;\r
  AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL);\r
  if (RegEax >= 0x80000001) {\r
    AsmCpuid (0x80000001, NULL, NULL, NULL, &RegEdx);\r
    if ((RegEdx & BIT26) != 0) {\r
      Page1GSupport = TRUE;\r
    }\r
  }\r
\r
  //\r
  // Get physical address bits supported.\r
  //\r
  Hob = GetFirstHob (EFI_HOB_TYPE_CPU);\r
  if (Hob != NULL) {\r
    PhysicalAddressBits = ((EFI_HOB_CPU *) Hob)->SizeOfMemorySpace;\r
  } else {\r
    AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL);\r
    if (RegEax >= 0x80000008) {\r
      AsmCpuid (0x80000008, &RegEax, NULL, NULL, NULL);\r
      PhysicalAddressBits = (UINT8) RegEax;\r
    } else {\r
      PhysicalAddressBits = 36;\r
    }\r
  }\r
\r
  //\r
  // IA-32e paging translates 48-bit linear addresses to 52-bit physical addresses.\r
  //\r
  ASSERT (PhysicalAddressBits <= 52);\r
  if (PhysicalAddressBits > 48) {\r
    PhysicalAddressBits = 48;\r
  }\r
\r
  //\r
  // Calculate the table entries needed.\r
  //\r
  if (PhysicalAddressBits <= 39 ) {\r
    NumberOfPml4EntriesNeeded = 1;\r
    NumberOfPdpEntriesNeeded = (UINT32)LShiftU64 (1, (PhysicalAddressBits - 30));\r
  } else {\r
    NumberOfPml4EntriesNeeded = (UINT32)LShiftU64 (1, (PhysicalAddressBits - 39));\r
    NumberOfPdpEntriesNeeded = 512;\r
  }\r
\r
  //\r
  // Pre-allocate big pages to avoid later allocations. \r
  //\r
  BigPageAddress = (UINTN) PageTablesAddress;\r
\r
  //\r
  // By architecture only one PageMapLevel4 exists - so lets allocate storage for it.\r
  //\r
  PageMap         = (VOID *) BigPageAddress;\r
  BigPageAddress += SIZE_4KB;\r
\r
  PageMapLevel4Entry = PageMap;\r
  PageAddress        = 0;\r
  for (IndexOfPml4Entries = 0; IndexOfPml4Entries < NumberOfPml4EntriesNeeded; IndexOfPml4Entries++, PageMapLevel4Entry++) {\r
    //\r
    // Each PML4 entry points to a page of Page Directory Pointer entires.\r
    // So lets allocate space for them and fill them in in the IndexOfPdpEntries loop.\r
    //\r
    PageDirectoryPointerEntry = (VOID *) BigPageAddress;\r
    BigPageAddress += SIZE_4KB;\r
\r
    //\r
    // Make a PML4 Entry\r
    //\r
    PageMapLevel4Entry->Uint64 = (UINT64)(UINTN)PageDirectoryPointerEntry;\r
    PageMapLevel4Entry->Bits.ReadWrite = 1;\r
    PageMapLevel4Entry->Bits.Present = 1;\r
\r
    if (Page1GSupport) {\r
      PageDirectory1GEntry = (VOID *) PageDirectoryPointerEntry;\r
    \r
      for (IndexOfPageDirectoryEntries = 0; IndexOfPageDirectoryEntries < 512; IndexOfPageDirectoryEntries++, PageDirectory1GEntry++, PageAddress += SIZE_1GB) {\r
        //\r
        // Fill in the Page Directory entries\r
        //\r
        PageDirectory1GEntry->Uint64 = (UINT64)PageAddress;\r
        PageDirectory1GEntry->Bits.ReadWrite = 1;\r
        PageDirectory1GEntry->Bits.Present = 1;\r
        PageDirectory1GEntry->Bits.MustBe1 = 1;\r
      }\r
    } else {\r
      for (IndexOfPdpEntries = 0; IndexOfPdpEntries < NumberOfPdpEntriesNeeded; IndexOfPdpEntries++, PageDirectoryPointerEntry++) {\r
        //\r
        // Each Directory Pointer entries points to a page of Page Directory entires.\r
        // So allocate space for them and fill them in in the IndexOfPageDirectoryEntries loop.\r
        //       \r
        PageDirectoryEntry = (VOID *) BigPageAddress;\r
        BigPageAddress += SIZE_4KB;\r
\r
        //\r
        // Fill in a Page Directory Pointer Entries\r
        //\r
        PageDirectoryPointerEntry->Uint64 = (UINT64)(UINTN)PageDirectoryEntry;\r
        PageDirectoryPointerEntry->Bits.ReadWrite = 1;\r
        PageDirectoryPointerEntry->Bits.Present = 1;\r
\r
        for (IndexOfPageDirectoryEntries = 0; IndexOfPageDirectoryEntries < 512; IndexOfPageDirectoryEntries++, PageDirectoryEntry++, PageAddress += SIZE_2MB) {\r
          //\r
          // Fill in the Page Directory entries\r
          //\r
          PageDirectoryEntry->Uint64 = (UINT64)PageAddress;\r
          PageDirectoryEntry->Bits.ReadWrite = 1;\r
          PageDirectoryEntry->Bits.Present = 1;\r
          PageDirectoryEntry->Bits.MustBe1 = 1;\r
        }\r
      }\r
\r
      for (; IndexOfPdpEntries < 512; IndexOfPdpEntries++, PageDirectoryPointerEntry++) {\r
        ZeroMem (\r
          PageDirectoryPointerEntry,\r
          sizeof(PAGE_MAP_AND_DIRECTORY_POINTER)\r
          );\r
      }\r
    }\r
  }\r
\r
  //\r
  // For the PML4 entries we are not using fill in a null entry.\r
  //\r
  for (; IndexOfPml4Entries < 512; IndexOfPml4Entries++, PageMapLevel4Entry++) {\r
    ZeroMem (\r
      PageMapLevel4Entry,\r
      sizeof (PAGE_MAP_AND_DIRECTORY_POINTER)\r
      );\r
  }\r
}\r
\r
/**\r
  Return function from long mode to 32-bit mode.\r
\r
  @param  EntrypointContext  Context for mode switching\r
  @param  ReturnContext      Context for mode switching\r
\r
**/\r
VOID\r
ReturnFunction (\r
  SWITCH_32_TO_64_CONTEXT  *EntrypointContext,\r
  SWITCH_64_TO_32_CONTEXT  *ReturnContext\r
  )\r
{ \r
  //\r
  // Restore original GDT\r
  //\r
  AsmWriteGdtr (&ReturnContext->Gdtr);\r
  \r
  //\r
  // return to original caller\r
  //\r
  LongJump ((BASE_LIBRARY_JUMP_BUFFER  *)(UINTN)EntrypointContext->JumpBuffer, 1);\r
 \r
  //\r
  // never be here\r
  // \r
  ASSERT (FALSE);\r
}\r
\r
/**\r
  Thunk function from 32-bit protection mode to long mode.\r
\r
  @param  PageTableAddress  Page table base address\r
  @param  Context           Context for mode switching\r
  @param  ReturnContext     Context for mode switching\r
\r
  @retval EFI_SUCCESS  Function successfully executed.\r
\r
**/\r
EFI_STATUS\r
Thunk32To64 (\r
  EFI_PHYSICAL_ADDRESS          PageTableAddress,\r
  SWITCH_32_TO_64_CONTEXT       *Context,\r
  SWITCH_64_TO_32_CONTEXT       *ReturnContext\r
  )\r
{\r
  UINTN                       SetJumpFlag;\r
  EFI_STATUS                  Status;\r
\r
  //\r
  // Save return address, LongJump will return here then\r
  //\r
  SetJumpFlag = SetJump ((BASE_LIBRARY_JUMP_BUFFER  *) (UINTN) Context->JumpBuffer);\r
\r
  if (SetJumpFlag == 0) {\r
\r
    //\r
    // Build Page Tables for all physical memory processor supports\r
    //\r
    CreateIdentityMappingPageTables (PageTableAddress);\r
    \r
    //\r
    // Create 64-bit GDT\r
    //\r
    AsmWriteGdtr (&mGdt);\r
\r
    //\r
    // Write CR3\r
    //\r
    AsmWriteCr3 ((UINTN) PageTableAddress);\r
\r
    //\r
    // Disable interrupt of Debug timer, since the IDT table cannot work in long mode\r
    //\r
    SaveAndSetDebugTimerInterrupt (FALSE);\r
    //\r
    // Transfer to long mode\r
    //\r
    AsmEnablePaging64 (\r
       0x38,\r
      (UINT64) Context->EntryPoint,\r
      (UINT64)(UINTN) Context,\r
      (UINT64)(UINTN) ReturnContext,\r
      Context->StackBufferBase + Context->StackBufferLength\r
      );\r
  }\r
  \r
  //\r
  // Convert to 32-bit Status and return\r
  //\r
  Status = EFI_SUCCESS;\r
  if ((UINTN) ReturnContext->ReturnStatus != 0) {\r
    Status = ENCODE_ERROR ((UINTN) ReturnContext->ReturnStatus);\r
  }\r
  \r
  return Status;\r
}\r
\r
/**\r
  If in 32 bit protection mode, and coalesce image is of X64, switch to long mode.\r
\r
  @param  LongModeBuffer            The context of long mode.\r
  @param  CoalesceEntry             Entry of coalesce image.\r
  @param  BlockListAddr             Address of block list.\r
  @param  MemoryBase                Base of memory range.\r
  @param  MemorySize                Size of memory range.\r
\r
  @retval EFI_SUCCESS               Successfully switched to long mode and execute coalesce.\r
  @retval Others                    Failed to execute coalesce in long mode.\r
\r
**/\r
EFI_STATUS\r
ModeSwitch (\r
  IN EFI_CAPSULE_LONG_MODE_BUFFER   *LongModeBuffer,\r
  IN COALESCE_ENTRY                 CoalesceEntry,\r
  IN EFI_PHYSICAL_ADDRESS           BlockListAddr,\r
  IN OUT VOID                       **MemoryBase,\r
  IN OUT UINTN                      *MemorySize\r
  )\r
{\r
  EFI_STATUS                           Status;\r
  EFI_PHYSICAL_ADDRESS                 MemoryBase64;\r
  UINT64                               MemorySize64;\r
  EFI_PHYSICAL_ADDRESS                 MemoryEnd64;\r
  SWITCH_32_TO_64_CONTEXT              Context;\r
  SWITCH_64_TO_32_CONTEXT              ReturnContext;\r
  BASE_LIBRARY_JUMP_BUFFER             JumpBuffer;\r
  EFI_PHYSICAL_ADDRESS                 ReservedRangeBase;\r
  EFI_PHYSICAL_ADDRESS                 ReservedRangeEnd;\r
\r
  ZeroMem (&Context, sizeof (SWITCH_32_TO_64_CONTEXT));\r
  ZeroMem (&ReturnContext, sizeof (SWITCH_64_TO_32_CONTEXT));\r
  \r
  MemoryBase64  = (UINT64) (UINTN) *MemoryBase;\r
  MemorySize64  = (UINT64) (UINTN) *MemorySize;\r
  MemoryEnd64   = MemoryBase64 + MemorySize64;\r
\r
  //\r
  // Merge memory range reserved for stack and page table  \r
  //\r
  if (LongModeBuffer->StackBaseAddress < LongModeBuffer->PageTableAddress) {\r
    ReservedRangeBase = LongModeBuffer->StackBaseAddress;\r
    ReservedRangeEnd  = LongModeBuffer->PageTableAddress + CalculatePageTableSize ();\r
  } else {\r
    ReservedRangeBase = LongModeBuffer->PageTableAddress;\r
    ReservedRangeEnd  = LongModeBuffer->StackBaseAddress + LongModeBuffer->StackSize;\r
  }\r
  \r
  //\r
  // Check if memory range reserved is overlap with MemoryBase ~ MemoryBase + MemorySize.\r
  // If they are overlapped, get a larger range to process capsule data.\r
  //\r
  if (ReservedRangeBase <= MemoryBase64) {\r
    if (ReservedRangeEnd < MemoryEnd64) {\r
      MemoryBase64 = ReservedRangeEnd;\r
    } else {\r
      DEBUG ((EFI_D_ERROR, "Memory is not enough to process capsule!\n"));\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
  } else if (ReservedRangeBase < MemoryEnd64) {\r
    if (ReservedRangeEnd < MemoryEnd64   &&\r
        ReservedRangeBase - MemoryBase64 < MemoryEnd64 - ReservedRangeEnd) {\r
      MemoryBase64 = ReservedRangeEnd;\r
    } else {\r
      MemorySize64 = (UINT64)(UINTN)(ReservedRangeBase - MemoryBase64);\r
    }\r
  }  \r
  \r
  //\r
  // Initialize context jumping to 64-bit enviroment\r
  //\r
  Context.JumpBuffer            = (EFI_PHYSICAL_ADDRESS)(UINTN)&JumpBuffer;\r
  Context.StackBufferBase       = LongModeBuffer->StackBaseAddress;\r
  Context.StackBufferLength     = LongModeBuffer->StackSize;\r
  Context.EntryPoint            = (EFI_PHYSICAL_ADDRESS)(UINTN)CoalesceEntry;\r
  Context.BlockListAddr         = BlockListAddr;\r
  Context.MemoryBase64Ptr       = (EFI_PHYSICAL_ADDRESS)(UINTN)&MemoryBase64;\r
  Context.MemorySize64Ptr       = (EFI_PHYSICAL_ADDRESS)(UINTN)&MemorySize64;\r
\r
  //\r
  // Prepare data for return back\r
  //\r
  ReturnContext.ReturnCs           = 0x10;\r
  ReturnContext.ReturnEntryPoint   = (EFI_PHYSICAL_ADDRESS)(UINTN)ReturnFunction;\r
  //\r
  // Will save the return status of processing capsule\r
  //\r
  ReturnContext.ReturnStatus       = 0;\r
  \r
  //\r
  // Save original GDT\r
  //\r
  AsmReadGdtr ((IA32_DESCRIPTOR *)&ReturnContext.Gdtr);\r
  \r
  Status = Thunk32To64 (LongModeBuffer->PageTableAddress, &Context, &ReturnContext);\r
  \r
  if (!EFI_ERROR (Status)) {\r
    *MemoryBase = (VOID *) (UINTN) MemoryBase64;\r
    *MemorySize = (UINTN) MemorySize64;\r
  }\r
\r
  return Status;\r
\r
}\r
\r
/**\r
  Locates the coalesce image entry point, and detects its machine type.\r
\r
  @param CoalesceImageEntryPoint   Pointer to coalesce image entry point for output.\r
  @param CoalesceImageMachineType  Pointer to machine type of coalesce image.\r
\r
  @retval EFI_SUCCESS     Coalesce image successfully located.\r
  @retval Others          Failed to locate the coalesce image.\r
\r
**/\r
EFI_STATUS\r
FindCapsuleCoalesceImage (\r
  OUT EFI_PHYSICAL_ADDRESS    *CoalesceImageEntryPoint,\r
  OUT UINT16                  *CoalesceImageMachineType\r
  )\r
{\r
  EFI_STATUS                           Status;\r
  UINTN                                Instance;\r
  EFI_PEI_LOAD_FILE_PPI                *LoadFile;\r
  EFI_PEI_FV_HANDLE                    VolumeHandle;\r
  EFI_PEI_FILE_HANDLE                  FileHandle;\r
  EFI_PHYSICAL_ADDRESS                 CoalesceImageAddress;\r
  UINT64                               CoalesceImageSize;\r
  UINT32                               AuthenticationState;\r
\r
  Instance = 0;\r
\r
  while (TRUE) {\r
    Status = PeiServicesFfsFindNextVolume (Instance++, &VolumeHandle);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
    Status = PeiServicesFfsFindFileByName (PcdGetPtr(PcdCapsuleCoalesceFile), VolumeHandle, &FileHandle);\r
    if (!EFI_ERROR (Status)) {\r
      Status = PeiServicesLocatePpi (&gEfiPeiLoadFilePpiGuid, 0, NULL, (VOID **) &LoadFile);\r
      ASSERT_EFI_ERROR (Status);\r
\r
      Status = LoadFile->LoadFile (\r
                           LoadFile,\r
                           FileHandle,\r
                           &CoalesceImageAddress,\r
                           &CoalesceImageSize,\r
                           CoalesceImageEntryPoint,\r
                           &AuthenticationState\r
                           );\r
      if (EFI_ERROR (Status)) {\r
        DEBUG ((EFI_D_ERROR, "Unable to find PE32 section in CapsuleRelocate image ffs %r!\n", Status));\r
        return Status;\r
      }\r
      *CoalesceImageMachineType = PeCoffLoaderGetMachineType ((VOID *) (UINTN) CoalesceImageAddress);\r
      break;\r
    } else {\r
      continue;\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
#endif\r
\r
/**\r
  Checks for the presence of capsule descriptors.\r
  Get capsule descriptors from variable CapsuleUpdateData, CapsuleUpdateData1, CapsuleUpdateData2...\r
  and save to DescriptorBuffer.\r
\r
  @param DescriptorBuffer        Pointer to the capsule descriptors\r
\r
  @retval EFI_SUCCESS     a valid capsule is present\r
  @retval EFI_NOT_FOUND   if a valid capsule is not present\r
**/\r
EFI_STATUS\r
GetCapsuleDescriptors (\r
  IN EFI_PHYSICAL_ADDRESS     *DescriptorBuffer\r
  )\r
{\r
  EFI_STATUS                       Status;\r
  UINTN                            Size;\r
  UINTN                            Index;\r
  UINTN                            TempIndex;\r
  UINTN                            ValidIndex;\r
  BOOLEAN                          Flag;\r
  CHAR16                           CapsuleVarName[30];\r
  CHAR16                           *TempVarName;\r
  EFI_PHYSICAL_ADDRESS             CapsuleDataPtr64;\r
  EFI_PEI_READ_ONLY_VARIABLE2_PPI  *PPIVariableServices;\r
\r
  Index             = 0;\r
  TempVarName       = NULL;\r
  CapsuleVarName[0] = 0;\r
  ValidIndex        = 0;\r
  CapsuleDataPtr64  = 0;\r
  \r
  Status = PeiServicesLocatePpi (\r
              &gEfiPeiReadOnlyVariable2PpiGuid,\r
              0,\r
              NULL,\r
              (VOID **) &PPIVariableServices\r
              );\r
  if (Status == EFI_SUCCESS) {\r
    StrCpy (CapsuleVarName, EFI_CAPSULE_VARIABLE_NAME);\r
    TempVarName = CapsuleVarName + StrLen (CapsuleVarName);\r
    Size = sizeof (CapsuleDataPtr64);\r
    while (1) {\r
      if (Index == 0) {\r
        //\r
        // For the first Capsule Image\r
        //\r
        Status = PPIVariableServices->GetVariable (\r
                                        PPIVariableServices,\r
                                        CapsuleVarName,\r
                                        &gEfiCapsuleVendorGuid,\r
                                        NULL,\r
                                        &Size,\r
                                        (VOID *) &CapsuleDataPtr64\r
                                        );\r
        if (EFI_ERROR (Status)) {\r
          DEBUG ((EFI_D_ERROR, "Capsule -- capsule variable not set\n"));\r
          return EFI_NOT_FOUND;\r
        }\r
        //\r
        // We have a chicken/egg situation where the memory init code needs to\r
        // know the boot mode prior to initializing memory. For this case, our\r
        // validate function will fail. We can detect if this is the case if blocklist\r
        // pointer is null. In that case, return success since we know that the\r
        // variable is set.\r
        //\r
        if (DescriptorBuffer == NULL) {\r
          return EFI_SUCCESS;\r
        }\r
      } else {\r
        UnicodeValueToString (TempVarName, 0, Index, 0);\r
        Status = PPIVariableServices->GetVariable (\r
                                        PPIVariableServices,\r
                                        CapsuleVarName,\r
                                        &gEfiCapsuleVendorGuid,\r
                                        NULL,\r
                                        &Size,\r
                                        (VOID *) &CapsuleDataPtr64\r
                                        );\r
        if (EFI_ERROR (Status)) {\r
          break;\r
        }\r
        \r
        //\r
        // If this BlockList has been linked before, skip this variable\r
        //\r
        Flag = FALSE;\r
        for (TempIndex = 0; TempIndex < ValidIndex; TempIndex++) {\r
          if (DescriptorBuffer[TempIndex] == CapsuleDataPtr64)  {\r
            Flag = TRUE;\r
            break;\r
          }\r
        }\r
        if (Flag) {\r
          Index ++;\r
          continue;\r
        }\r
      }\r
      \r
      //\r
      // Cache BlockList which has been processed\r
      //\r
      DescriptorBuffer[ValidIndex++] = CapsuleDataPtr64;\r
      Index ++;\r
    }\r
  }\r
  \r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Gets the reserved long mode buffer.\r
\r
  @param  LongModeBuffer  Pointer to the long mode buffer for output.\r
\r
  @retval EFI_SUCCESS     Long mode buffer successfully retrieved.\r
  @retval Others          Variable storing long mode buffer not found.\r
\r
**/\r
EFI_STATUS\r
GetLongModeContext (\r
  OUT EFI_CAPSULE_LONG_MODE_BUFFER *LongModeBuffer\r
  )\r
{\r
  EFI_STATUS   Status;\r
  UINTN        Size;\r
  EFI_PEI_READ_ONLY_VARIABLE2_PPI *PPIVariableServices;\r
\r
  Status = PeiServicesLocatePpi (\r
             &gEfiPeiReadOnlyVariable2PpiGuid,\r
             0,\r
             NULL,\r
             (VOID **) &PPIVariableServices\r
             );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Size = sizeof (EFI_CAPSULE_LONG_MODE_BUFFER);\r
  Status = PPIVariableServices->GetVariable (\r
                                  PPIVariableServices,\r
                                  EFI_CAPSULE_LONG_MODE_BUFFER_NAME,\r
                                  &gEfiCapsuleVendorGuid,\r
                                  NULL,\r
                                  &Size,\r
                                  LongModeBuffer\r
                                  );\r
  if (EFI_ERROR (Status)) {\r
    DEBUG (( EFI_D_ERROR, "Error Get LongModeBuffer variable %r!\n", Status));\r
  }\r
  return Status;\r
}\r
\r
/**\r
  Capsule PPI service to coalesce a fragmented capsule in memory.\r
\r
  @param PeiServices  General purpose services available to every PEIM.\r
  @param MemoryBase   Pointer to the base of a block of memory that we can walk\r
                      all over while trying to coalesce our buffers.\r
                      On output, this variable will hold the base address of\r
                      a coalesced capsule.\r
  @param MemorySize   Size of the memory region pointed to by MemoryBase.\r
                      On output, this variable will contain the size of the\r
                      coalesced capsule.\r
\r
  @retval EFI_NOT_FOUND   if we can't determine the boot mode\r
                          if the boot mode is not flash-update\r
                          if we could not find the capsule descriptors\r
\r
  @retval EFI_BUFFER_TOO_SMALL\r
                          if we could not coalesce the capsule in the memory\r
                          region provided to us\r
\r
  @retval EFI_SUCCESS     if there's no capsule, or if we processed the\r
                          capsule successfully.\r
**/\r
EFI_STATUS\r
EFIAPI\r
CapsuleCoalesce (\r
  IN     EFI_PEI_SERVICES            **PeiServices,\r
  IN OUT VOID                        **MemoryBase,\r
  IN OUT UINTN                       *MemorySize\r
  )\r
{\r
  UINTN                                Index;\r
  UINTN                                Size;\r
  UINTN                                VariableCount;\r
  CHAR16                               CapsuleVarName[30];\r
  CHAR16                               *TempVarName;\r
  EFI_PHYSICAL_ADDRESS                 CapsuleDataPtr64;  \r
  EFI_STATUS                           Status;\r
  EFI_BOOT_MODE                        BootMode;\r
  EFI_PEI_READ_ONLY_VARIABLE2_PPI      *PPIVariableServices;\r
  EFI_PHYSICAL_ADDRESS                 *VariableArrayAddress;\r
#ifdef MDE_CPU_IA32\r
  UINT16                               CoalesceImageMachineType;\r
  EFI_PHYSICAL_ADDRESS                 CoalesceImageEntryPoint;\r
  COALESCE_ENTRY                       CoalesceEntry;\r
  EFI_CAPSULE_LONG_MODE_BUFFER         LongModeBuffer;\r
#endif\r
\r
  Index                   = 0;\r
  VariableCount           = 0;\r
  CapsuleVarName[0]       = 0;\r
  CapsuleDataPtr64        = 0;\r
\r
  //\r
  // Someone should have already ascertained the boot mode. If it's not\r
  // capsule update, then return normally.\r
  //\r
  Status = PeiServicesGetBootMode (&BootMode);\r
  if (EFI_ERROR (Status) || (BootMode != BOOT_ON_FLASH_UPDATE)) {\r
    DEBUG ((EFI_D_ERROR, "Boot mode is not correct for capsule update path.\n"));    \r
    Status = EFI_NOT_FOUND;\r
    goto Done;\r
  }\r
  \r
  //\r
  // User may set the same ScatterGatherList with several different variables,\r
  // so cache all ScatterGatherList for check later.\r
  //\r
  Status = PeiServicesLocatePpi (\r
              &gEfiPeiReadOnlyVariable2PpiGuid,\r
              0,\r
              NULL,\r
              (VOID **) &PPIVariableServices\r
              );\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
  Size = sizeof (CapsuleDataPtr64);\r
  StrCpy (CapsuleVarName, EFI_CAPSULE_VARIABLE_NAME);\r
  TempVarName = CapsuleVarName + StrLen (CapsuleVarName);\r
  while (TRUE) {\r
    if (Index > 0) {\r
      UnicodeValueToString (TempVarName, 0, Index, 0);\r
    }\r
    Status = PPIVariableServices->GetVariable (\r
                                    PPIVariableServices,\r
                                    CapsuleVarName,\r
                                    &gEfiCapsuleVendorGuid,\r
                                    NULL,\r
                                    &Size,\r
                                    (VOID *) &CapsuleDataPtr64\r
                                    );\r
    if (EFI_ERROR (Status)) {\r
      //\r
      // There is no capsule variables, quit\r
      //\r
      DEBUG ((EFI_D_INFO,"Capsule variable Index = %d\n", Index));\r
      break;\r
    }\r
    VariableCount++;\r
    Index++;\r
  }\r
  \r
  DEBUG ((EFI_D_INFO,"Capsule variable count = %d\n", VariableCount));\r
  \r
  //\r
  // The last entry is the end flag.\r
  //\r
  Status = PeiServicesAllocatePool (\r
             (VariableCount + 1) * sizeof (EFI_PHYSICAL_ADDRESS),\r
             (VOID **)&VariableArrayAddress\r
             );\r
\r
  if (Status != EFI_SUCCESS) {\r
    DEBUG ((EFI_D_ERROR, "AllocatePages Failed!, Status = %x\n", Status));\r
    goto Done;\r
  }\r
  \r
  ZeroMem (VariableArrayAddress, (VariableCount + 1) * sizeof (EFI_PHYSICAL_ADDRESS));\r
  \r
  //\r
  // Find out if we actually have a capsule.\r
  // GetCapsuleDescriptors depends on variable PPI, so it should run in 32-bit environment.\r
  //\r
  Status = GetCapsuleDescriptors (VariableArrayAddress);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_ERROR, "Fail to find capsule variables.\n"));\r
    goto Done;\r
  }\r
\r
#ifdef MDE_CPU_IA32\r
  if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
    //\r
    // Switch to 64-bit mode to process capsule data when:\r
    // 1. When DXE phase is 64-bit\r
    // 2. When the buffer for 64-bit transition exists\r
    // 3. When Capsule X64 image is built in BIOS image\r
    // In 64-bit mode, we can process capsule data above 4GB.\r
    //\r
    CoalesceImageEntryPoint = 0;\r
    Status = GetLongModeContext (&LongModeBuffer);\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((EFI_D_ERROR, "Fail to find the variables for long mode context!\n"));\r
      Status = EFI_NOT_FOUND;\r
      goto Done;\r
    }\r
    \r
    Status = FindCapsuleCoalesceImage (&CoalesceImageEntryPoint, &CoalesceImageMachineType);\r
    if ((EFI_ERROR (Status)) || (CoalesceImageMachineType != EFI_IMAGE_MACHINE_X64)) {\r
      DEBUG ((EFI_D_ERROR, "Fail to find CapsuleX64 module in FV!\n"));\r
      Status = EFI_NOT_FOUND;\r
      goto Done;\r
    }\r
    ASSERT (CoalesceImageEntryPoint != 0);\r
    CoalesceEntry = (COALESCE_ENTRY) (UINTN) CoalesceImageEntryPoint;\r
    Status = ModeSwitch (&LongModeBuffer, CoalesceEntry, (EFI_PHYSICAL_ADDRESS)(UINTN)VariableArrayAddress, MemoryBase, MemorySize);\r
  } else {\r
    //\r
    // Capsule is processed in IA32 mode.\r
    //\r
    Status = CapsuleDataCoalesce (PeiServices, (EFI_PHYSICAL_ADDRESS *)(UINTN)VariableArrayAddress, MemoryBase, MemorySize);\r
  }\r
#else\r
  //\r
  // Process capsule directly.\r
  //\r
  Status = CapsuleDataCoalesce (PeiServices, (EFI_PHYSICAL_ADDRESS *)(UINTN)VariableArrayAddress, MemoryBase, MemorySize);\r
#endif\r
  \r
  DEBUG ((EFI_D_INFO, "Capsule Coalesce Status = %r!\n", Status));\r
\r
  if (Status == EFI_BUFFER_TOO_SMALL) {\r
    DEBUG ((EFI_D_ERROR, "There is not enough memory to process capsule!\n"));\r
  }\r
  \r
  if (Status == EFI_NOT_FOUND) {\r
    DEBUG ((EFI_D_ERROR, "Fail to parse capsule descriptor in memory!\n"));\r
    REPORT_STATUS_CODE (\r
      EFI_ERROR_CODE | EFI_ERROR_MAJOR,\r
      (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_EC_INVALID_CAPSULE_DESCRIPTOR)\r
      );\r
  }\r
\r
Done:\r
  return Status;\r
}\r
\r
/**\r
  Determine if we're in capsule update boot mode.\r
\r
  @param PeiServices  PEI services table\r
\r
  @retval EFI_SUCCESS   if we have a capsule available\r
  @retval EFI_NOT_FOUND no capsule detected\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CheckCapsuleUpdate (\r
  IN EFI_PEI_SERVICES           **PeiServices\r
  )\r
{\r
  EFI_STATUS  Status;\r
  Status = GetCapsuleDescriptors (NULL);\r
  return Status;\r
}\r
/**\r
  This function will look at a capsule and determine if it's a test pattern. \r
  If it is, then it will verify it and emit an error message if corruption is detected.\r
  \r
  @param PeiServices   Standard pei services pointer\r
  @param CapsuleBase   Base address of coalesced capsule, which is preceeded\r
                       by private data. Very implementation specific.\r
\r
  @retval TRUE    Capsule image is the test image\r
  @retval FALSE   Capsule image is not the test image.\r
\r
**/\r
BOOLEAN\r
CapsuleTestPattern (\r
  IN EFI_PEI_SERVICES                 **PeiServices,\r
  IN VOID                             *CapsuleBase\r
  )\r
{\r
  UINT32  *TestPtr;\r
  UINT32  TestCounter;\r
  UINT32  TestSize;\r
  BOOLEAN RetValue;\r
\r
  RetValue = FALSE;\r
\r
  //\r
  // Look at the capsule data and determine if it's a test pattern. If it\r
  // is, then test it now.\r
  //\r
  TestPtr = (UINT32 *) CapsuleBase;\r
  //\r
  // 0x54534554 "TEST"\r
  //\r
  if (*TestPtr == 0x54534554) {\r
    RetValue = TRUE;\r
    DEBUG ((EFI_D_INFO, "Capsule test pattern mode activated...\n"));\r
    TestSize = TestPtr[1] / sizeof (UINT32);\r
    //\r
    // Skip over the signature and the size fields in the pattern data header\r
    //\r
    TestPtr += 2;\r
    TestCounter = 0;\r
    while (TestSize > 0) {\r
      if (*TestPtr != TestCounter) {\r
        DEBUG ((EFI_D_INFO, "Capsule test pattern mode FAILED: BaseAddr/FailAddr 0x%X 0x%X\n", (UINT32)(UINTN)(EFI_CAPSULE_PEIM_PRIVATE_DATA *)CapsuleBase, (UINT32)(UINTN)TestPtr));\r
        return TRUE;\r
      }\r
\r
      TestPtr++;\r
      TestCounter++;\r
      TestSize--;\r
    }\r
\r
    DEBUG ((EFI_D_INFO, "Capsule test pattern mode SUCCESS\n"));\r
  }\r
\r
  return RetValue;\r
}\r
\r
/**\r
  Capsule PPI service that gets called after memory is available. The\r
  capsule coalesce function, which must be called first, returns a base\r
  address and size, which can be anything actually. Once the memory init\r
  PEIM has discovered memory, then it should call this function and pass in\r
  the base address and size returned by the coalesce function. Then this\r
  function can create a capsule HOB and return.\r
\r
  @param PeiServices   standard pei services pointer\r
  @param CapsuleBase   address returned by the capsule coalesce function. Most\r
                       likely this will actually be a pointer to private data.\r
  @param CapsuleSize   value returned by the capsule coalesce function.\r
\r
  @retval EFI_VOLUME_CORRUPTED  CapsuleBase does not appear to point to a\r
                                coalesced capsule\r
  @retval EFI_SUCCESS           if all goes well.\r
**/\r
EFI_STATUS\r
EFIAPI\r
CreateState (\r
  IN EFI_PEI_SERVICES                 **PeiServices,\r
  IN VOID                             *CapsuleBase,\r
  IN UINTN                            CapsuleSize\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  EFI_CAPSULE_PEIM_PRIVATE_DATA *PrivateData;\r
  UINTN                         Size;\r
  EFI_PHYSICAL_ADDRESS          NewBuffer;\r
  UINTN                         CapsuleNumber;\r
  UINT32                        Index;\r
  EFI_PHYSICAL_ADDRESS          BaseAddress;\r
  UINT64                        Length;\r
 \r
  PrivateData    = (EFI_CAPSULE_PEIM_PRIVATE_DATA *) CapsuleBase;\r
  if (PrivateData->Signature != EFI_CAPSULE_PEIM_PRIVATE_DATA_SIGNATURE) {\r
    return EFI_VOLUME_CORRUPTED;\r
  }\r
  if (PrivateData->CapsuleAllImageSize >= MAX_ADDRESS) {\r
    DEBUG ((EFI_D_ERROR, "CapsuleAllImageSize too big - 0x%lx\n", PrivateData->CapsuleAllImageSize));\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  if (PrivateData->CapsuleNumber >= MAX_ADDRESS) {\r
    DEBUG ((EFI_D_ERROR, "CapsuleNumber too big - 0x%lx\n", PrivateData->CapsuleNumber));\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  //\r
  // Capsule Number and Capsule Offset is in the tail of Capsule data.\r
  //\r
  Size          = (UINTN)PrivateData->CapsuleAllImageSize;\r
  CapsuleNumber = (UINTN)PrivateData->CapsuleNumber;\r
  //\r
  // Allocate the memory so that it gets preserved into DXE\r
  //\r
  Status = PeiServicesAllocatePages (\r
             EfiRuntimeServicesData,\r
             EFI_SIZE_TO_PAGES (Size),\r
             &NewBuffer\r
             );\r
\r
  if (Status != EFI_SUCCESS) {\r
    DEBUG ((EFI_D_ERROR, "AllocatePages Failed!\n"));\r
    return Status;\r
  }\r
  //\r
  // Copy to our new buffer for DXE\r
  //\r
  DEBUG ((EFI_D_INFO, "Capsule copy from 0x%8X to 0x%8X with size 0x%8X\n", (UINTN)((UINT8 *)PrivateData + sizeof(EFI_CAPSULE_PEIM_PRIVATE_DATA) + (CapsuleNumber - 1) * sizeof(UINT64)), (UINTN) NewBuffer, Size));\r
  CopyMem ((VOID *) (UINTN) NewBuffer, (VOID *) (UINTN) ((UINT8 *)PrivateData + sizeof(EFI_CAPSULE_PEIM_PRIVATE_DATA) + (CapsuleNumber - 1) * sizeof(UINT64)), Size);\r
  //\r
  // Check for test data pattern. If it is the test pattern, then we'll\r
  // test it ans still create the HOB so that it can be used to verify\r
  // that capsules don't get corrupted all the way into BDS. BDS will\r
  // still try to turn it into a firmware volume, but will think it's\r
  // corrupted so nothing will happen.\r
  //\r
  DEBUG_CODE (\r
    CapsuleTestPattern (PeiServices, (VOID *) (UINTN) NewBuffer);\r
  );\r
\r
  //\r
  // Build the UEFI Capsule Hob for each capsule image.\r
  //\r
  for (Index = 0; Index < CapsuleNumber; Index ++) {\r
    BaseAddress = NewBuffer + PrivateData->CapsuleOffset[Index];\r
    Length      = ((EFI_CAPSULE_HEADER *)((UINTN) BaseAddress))->CapsuleImageSize;\r
\r
    BuildCvHob (BaseAddress, Length);\r
  }\r
  \r
  return EFI_SUCCESS;\r
}\r
\r
CONST PEI_CAPSULE_PPI        mCapsulePpi = {\r
  CapsuleCoalesce,\r
  CheckCapsuleUpdate,\r
  CreateState\r
};\r
\r
CONST EFI_PEI_PPI_DESCRIPTOR mUefiPpiListCapsule = {\r
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gPeiCapsulePpiGuid,\r
  (PEI_CAPSULE_PPI *) &mCapsulePpi\r
};\r
\r
/**\r
  Entry point function for the PEIM\r
\r
  @param FileHandle      Handle of the file being invoked.\r
  @param PeiServices     Describes the list of possible PEI Services.\r
\r
  @return EFI_SUCCESS    If we installed our PPI\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CapsuleMain (\r
  IN       EFI_PEI_FILE_HANDLE  FileHandle,\r
  IN CONST EFI_PEI_SERVICES     **PeiServices\r
  )\r
{\r
  //\r
  // Just produce our PPI\r
  //\r
  return PeiServicesInstallPpi (&mUefiPpiListCapsule);\r
}\r