Add more comments for PeiCore.

[mirror_edk2.git] / MdeModulePkg / Core / Pei / Memory / MemoryServices.c

/** @file\r
  EFI PEI Core memory services\r
  \r
Copyright (c) 2006, Intel Corporation                                                         \r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The 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 <PeiMain.h>\r
\r
/**\r
\r
  Initialize the memory services.\r
\r
\r
  @param PrivateData     Add parameter description\r
  @param SecCoreData     Points to a data structure containing information about the PEI core's operating\r
                         environment, such as the size and location of temporary RAM, the stack location and\r
                         the BFV location.\r
  @param OldCoreData     Pointer to the PEI Core data.\r
                         NULL if being run in non-permament memory mode.\r
\r
**/\r
VOID\r
InitializeMemoryServices (\r
  IN PEI_CORE_INSTANCE           *PrivateData,\r
  IN CONST EFI_SEC_PEI_HAND_OFF  *SecCoreData,\r
  IN PEI_CORE_INSTANCE           *OldCoreData\r
  )\r
{\r
  \r
  PrivateData->SwitchStackSignal      = FALSE;\r
\r
  //\r
  // First entering PeiCore, following code will initialized some field\r
  // in PeiCore's private data according to hand off data from sec core.\r
  //\r
  if (OldCoreData == NULL) {\r
\r
    PrivateData->PeiMemoryInstalled = FALSE;\r
\r
    PrivateData->BottomOfCarHeap        = SecCoreData->PeiTemporaryRamBase; \r
    PrivateData->TopOfCarHeap           = (VOID *)((UINTN)(PrivateData->BottomOfCarHeap) + SecCoreData->PeiTemporaryRamSize);\r
    PrivateData->SizeOfTemporaryMemory  = SecCoreData->TemporaryRamSize;\r
    PrivateData->StackSize              = (UINT64) SecCoreData->StackSize;\r
    \r
    DEBUG_CODE_BEGIN ();\r
      PrivateData->SizeOfCacheAsRam = SecCoreData->PeiTemporaryRamSize + SecCoreData->StackSize;\r
      PrivateData->MaxTopOfCarHeap  = (VOID *) ((UINTN) PrivateData->BottomOfCarHeap + (UINTN) PrivateData->SizeOfCacheAsRam);\r
      PrivateData->StackBase        = (EFI_PHYSICAL_ADDRESS) (UINTN) SecCoreData->StackBase;\r
      PrivateData->StackSize        = (UINT64) SecCoreData->StackSize;\r
    DEBUG_CODE_END ();\r
\r
    PrivateData->HobList.Raw = PrivateData->BottomOfCarHeap;\r
    \r
    PeiCoreBuildHobHandoffInfoTable (\r
      BOOT_WITH_FULL_CONFIGURATION,\r
      (EFI_PHYSICAL_ADDRESS) (UINTN) PrivateData->BottomOfCarHeap,\r
      (UINTN) SecCoreData->PeiTemporaryRamSize\r
      );\r
\r
    //\r
    // Set PS to point to ServiceTableShadow in Cache\r
    //\r
    PrivateData->PS = &(PrivateData->ServiceTableShadow);\r
  }\r
  \r
  return;\r
}\r
\r
/**\r
\r
  Install the permanent memory is now available.\r
  Creates HOB (PHIT and Stack).\r
\r
  @param PeiServices     - The PEI core services table.\r
  @param MemoryBegin     - Start of memory address.\r
  @param MemoryLength    - Length of memory.\r
\r
  @return EFI_SUCCESS Always success.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiInstallPeiMemory (\r
  IN CONST EFI_PEI_SERVICES  **PeiServices,\r
  IN EFI_PHYSICAL_ADDRESS    MemoryBegin,\r
  IN UINT64                  MemoryLength\r
  )\r
{\r
  PEI_CORE_INSTANCE                     *PrivateData;\r
\r
  DEBUG ((EFI_D_INFO, "PeiInstallPeiMemory MemoryBegin 0x%LX, MemoryLength 0x%LX\n", MemoryBegin, MemoryLength));\r
  PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r
\r
  PrivateData->PhysicalMemoryBegin   = MemoryBegin;\r
  PrivateData->PhysicalMemoryLength  = MemoryLength;\r
  PrivateData->FreePhysicalMemoryTop = MemoryBegin + MemoryLength;\r
   \r
  PrivateData->SwitchStackSignal      = TRUE;\r
\r
  return EFI_SUCCESS;   \r
}\r
\r
/**\r
\r
  Memory allocation service on permanent memory,\r
  not usable prior to the memory installation.\r
\r
\r
  @param PeiServices     - The PEI core services table.\r
  @param MemoryType      - Type of memory to allocate.\r
  @param Pages           - Number of pages to allocate.\r
  @param Memory          - Pointer of memory allocated.\r
\r
  @retval EFI_SUCCESS              The allocation was successful\r
  @retval EFI_INVALID_PARAMETER    Only AllocateAnyAddress is supported.\r
  @retval EFI_NOT_AVAILABLE_YET    Called with permanent memory not available\r
  @retval EFI_OUT_OF_RESOURCES     There is not enough HOB heap to satisfy the requirement\r
                                   to allocate the number of pages.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiAllocatePages (\r
  IN CONST EFI_PEI_SERVICES           **PeiServices,\r
  IN EFI_MEMORY_TYPE            MemoryType,\r
  IN UINTN                      Pages,\r
  OUT EFI_PHYSICAL_ADDRESS      *Memory\r
  )\r
{\r
  PEI_CORE_INSTANCE                       *PrivateData;\r
  EFI_PEI_HOB_POINTERS                    Hob;\r
  EFI_PHYSICAL_ADDRESS                    Offset;\r
  EFI_PHYSICAL_ADDRESS                    *FreeMemoryTop;\r
  EFI_PHYSICAL_ADDRESS                    *FreeMemoryBottom;\r
\r
  PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r
  Hob.Raw     = PrivateData->HobList.Raw;\r
  \r
  //\r
  // Check if Hob already available\r
  //\r
  if (!PrivateData->PeiMemoryInstalled) {\r
    //\r
    // When PeiInstallMemory is called but CAR has *not* been moved to temporary memory,\r
    // the AllocatePage will dependent the field of PEI_CORE_INSTANCE structure.\r
    //\r
    if (!PrivateData->SwitchStackSignal) {\r
      return EFI_NOT_AVAILABLE_YET;\r
    } else {\r
      FreeMemoryTop     = &(PrivateData->FreePhysicalMemoryTop);\r
      FreeMemoryBottom  = &(PrivateData->PhysicalMemoryBegin);\r
    }\r
  } else {\r
    FreeMemoryTop     = &(Hob.HandoffInformationTable->EfiFreeMemoryTop);\r
    FreeMemoryBottom  = &(Hob.HandoffInformationTable->EfiFreeMemoryBottom);\r
  }\r
\r
  //\r
  // Check to see if on 4k boundary\r
  //\r
  Offset = *(FreeMemoryTop) & 0xFFF;\r
  \r
  //\r
  // If not aligned, make the allocation aligned.\r
  //\r
  if (Offset != 0) {\r
    *(FreeMemoryTop) -= Offset;\r
  }\r
  \r
  //\r
  // Verify that there is sufficient memory to satisfy the allocation\r
  //\r
  if (*(FreeMemoryTop) - ((Pages * EFI_PAGE_SIZE) + sizeof (EFI_HOB_MEMORY_ALLOCATION)) < \r
      *(FreeMemoryBottom)) {\r
    DEBUG ((EFI_D_ERROR, "AllocatePages failed: No 0x%x Pages is available.\n", Pages));\r
    DEBUG ((EFI_D_ERROR, "There is only left 0x%x pages memory resource to be allocated.\n", \\r
    EFI_SIZE_TO_PAGES ((UINTN) (*(FreeMemoryTop) - *(FreeMemoryBottom)))));\r
    return  EFI_OUT_OF_RESOURCES;\r
  } else {\r
    //\r
    // Update the PHIT to reflect the memory usage\r
    //\r
    *(FreeMemoryTop) -= Pages * EFI_PAGE_SIZE;\r
\r
    //\r
    // Update the value for the caller\r
    //\r
    *Memory = *(FreeMemoryTop);\r
\r
    //\r
    // Create a memory allocation HOB.\r
    //\r
    BuildMemoryAllocationHob (\r
      *(FreeMemoryTop),\r
      Pages * EFI_PAGE_SIZE,\r
      MemoryType\r
      );\r
\r
    return EFI_SUCCESS;\r
  }\r
}\r
\r
/**\r
\r
  Memory allocation service on the CAR.\r
\r
\r
  @param PeiServices     - The PEI core services table.\r
  @param Size            - Amount of memory required\r
  @param Buffer          - Address of pointer to the buffer\r
\r
  @retval EFI_SUCCESS              The allocation was successful\r
  @retval EFI_OUT_OF_RESOURCES     There is not enough heap to satisfy the requirement\r
                                   to allocate the requested size.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiAllocatePool (\r
  IN CONST EFI_PEI_SERVICES           **PeiServices,\r
  IN UINTN                      Size,\r
  OUT VOID                      **Buffer\r
  )\r
{\r
  EFI_STATUS               Status;\r
  EFI_HOB_MEMORY_POOL      *Hob;\r
\r
 //\r
 // If some "post-memory" PEIM wishes to allocate larger pool,\r
 // it should use AllocatePages service instead.\r
 //\r
 ASSERT (Size < 0x10000 - sizeof (EFI_HOB_MEMORY_POOL));\r
 Status = PeiServicesCreateHob (\r
             EFI_HOB_TYPE_MEMORY_POOL,\r
             (UINT16)(sizeof (EFI_HOB_MEMORY_POOL) + Size),\r
             (VOID **)&Hob\r
             );\r
  *Buffer = Hob+1;  \r
\r
\r
  return Status;\r
}\r