SecurityPkg: Fix typos in comments

[mirror_edk2.git] / OvmfPkg / Library / LockBoxLib / LockBoxDxe.c

/** @file\r
\r
  Copyright (c) 2006 - 2016, 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 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 <Uefi.h>\r
\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/QemuFwCfgLib.h>\r
#include <Protocol/LockBox.h>\r
#include <LockBoxLib.h>\r
\r
/**\r
  Allocate memory below 4G memory address.\r
\r
  This function allocates memory below 4G memory address.\r
\r
  @param  MemoryType   Memory type of memory to allocate.\r
  @param  Size         Size of memory to allocate.\r
  \r
  @return Allocated address for output.\r
\r
**/\r
STATIC\r
VOID *\r
AllocateMemoryBelow4G (\r
  IN EFI_MEMORY_TYPE    MemoryType,\r
  IN UINTN              Size\r
  )\r
{\r
  UINTN                 Pages;\r
  EFI_PHYSICAL_ADDRESS  Address;\r
  EFI_STATUS            Status;\r
  VOID*                 Buffer;\r
  UINTN                 AllocRemaining;\r
\r
  Pages = EFI_SIZE_TO_PAGES (Size);\r
  Address = 0xffffffff;\r
\r
  //\r
  // Since we need to use gBS->AllocatePages to get a buffer below\r
  // 4GB, there is a good chance that space will be wasted for very\r
  // small allocation. We keep track of unused portions of the page\r
  // allocations, and use these to allocate memory for small buffers.\r
  //\r
  ASSERT (mLockBoxGlobal->Signature == LOCK_BOX_GLOBAL_SIGNATURE);\r
  if ((UINTN) mLockBoxGlobal->SubPageRemaining >= Size) {\r
    Buffer = (VOID*)(UINTN) mLockBoxGlobal->SubPageBuffer;\r
    mLockBoxGlobal->SubPageBuffer += (UINT32) Size;\r
    mLockBoxGlobal->SubPageRemaining -= (UINT32) Size;\r
    return Buffer;\r
  }\r
\r
  Status  = gBS->AllocatePages (\r
                   AllocateMaxAddress,\r
                   MemoryType,\r
                   Pages,\r
                   &Address\r
                   );\r
  if (EFI_ERROR (Status)) {\r
    return NULL;\r
  }\r
\r
  Buffer = (VOID *) (UINTN) Address;\r
  ZeroMem (Buffer, EFI_PAGES_TO_SIZE (Pages));\r
\r
  AllocRemaining = EFI_PAGES_TO_SIZE (Pages) - Size;\r
  if (AllocRemaining > (UINTN) mLockBoxGlobal->SubPageRemaining) {\r
    mLockBoxGlobal->SubPageBuffer = (UINT32) (Address + Size);\r
    mLockBoxGlobal->SubPageRemaining = (UINT32) AllocRemaining;\r
  }\r
\r
  return Buffer;\r
}\r
\r
\r
/**\r
  Allocates a buffer of type EfiACPIMemoryNVS.\r
\r
  Allocates the number bytes specified by AllocationSize of type\r
  EfiACPIMemoryNVS and returns a pointer to the allocated buffer.\r
  If AllocationSize is 0, then a valid buffer of 0 size is\r
  returned.  If there is not enough memory remaining to satisfy\r
  the request, then NULL is returned.\r
\r
  @param  AllocationSize        The number of bytes to allocate.\r
\r
  @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
EFIAPI\r
AllocateAcpiNvsPool (\r
  IN UINTN  AllocationSize\r
  )\r
{\r
  return AllocateMemoryBelow4G (EfiACPIMemoryNVS, AllocationSize);\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
LockBoxDxeLibInitialize (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS    Status;\r
  VOID          *Interface;\r
\r
  Status = LockBoxLibInitialize ();\r
  if (!EFI_ERROR (Status)) {\r
    if (QemuFwCfgS3Enabled ()) {\r
      //\r
      // When S3 enabled, the first driver run with this library linked will\r
      // have this library constructor to install LockBox protocol on the\r
      // ImageHandle. As other drivers may have gEfiLockBoxProtocolGuid\r
      // dependency, the first driver should run before them.\r
      //\r
      Status = gBS->LocateProtocol (&gEfiLockBoxProtocolGuid, NULL, &Interface);\r
      if (EFI_ERROR (Status)) {\r
        Status = gBS->InstallProtocolInterface (\r
                        &ImageHandle,\r
                        &gEfiLockBoxProtocolGuid,\r
                        EFI_NATIVE_INTERFACE,\r
                        NULL\r
                        );\r
        ASSERT_EFI_ERROR (Status);\r
      }\r
    }\r
  }\r
\r
  return Status;\r
}\r