Update the copyright notice format

[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Library / Pei / PeiLib / PeiLib.c

/*++\r
\r
Copyright (c) 2004 - 2008, Intel Corporation. All rights reserved.<BR>\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
Module Name:\r
\r
  PeiLib.c\r
\r
Abstract:\r
\r
  PEI Library Functions\r
 \r
--*/\r
\r
#include "TianoCommon.h"\r
#include "PeiHob.h"\r
#include "Pei.h"\r
#include "PeiLib.h"\r
#include "EfiCommonLib.h"\r
\r
VOID\r
PeiCopyMem (\r
  IN VOID   *Destination,\r
  IN VOID   *Source,\r
  IN UINTN  Length\r
  );\r
\r
VOID\r
ZeroMem (\r
  IN VOID   *Buffer,\r
  IN UINTN  Size\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Set Buffer to zero for Size bytes.\r
\r
Arguments:\r
\r
  Buffer  - Memory to set.\r
\r
  Size    - Number of bytes to set\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
{\r
  EfiCommonLibZeroMem (Buffer, Size);\r
}\r
\r
VOID\r
PeiCopyMem (\r
  IN VOID   *Destination,\r
  IN VOID   *Source,\r
  IN UINTN  Length\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Copy Length bytes from Source to Destination.\r
\r
Arguments:\r
\r
  Destination - Target of copy\r
\r
  Source      - Place to copy from\r
\r
  Length      - Number of bytes to copy\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
{\r
  EfiCommonLibCopyMem (Destination, Source, Length);\r
}\r
\r
VOID\r
CopyMem (\r
  IN VOID   *Destination,\r
  IN VOID   *Source,\r
  IN UINTN  Length\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Copy Length bytes from Source to Destination.\r
\r
Arguments:\r
\r
  Destination - Target of copy\r
\r
  Source      - Place to copy from\r
\r
  Length      - Number of bytes to copy\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
{\r
  EfiCommonLibCopyMem (Destination, Source, Length);\r
}\r
\r
\r
BOOLEAN\r
CompareGuid (\r
  IN EFI_GUID     *Guid1,\r
  IN EFI_GUID     *Guid2\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Compares two GUIDs\r
\r
Arguments:\r
\r
  Guid1 - guid to compare\r
  Guid2 - guid to compare\r
\r
Returns:\r
  = TRUE  if Guid1 == Guid2\r
  = FALSE if Guid1 != Guid2 \r
\r
--*/\r
{\r
  if ((((INT32 *) Guid1)[0] - ((INT32 *) Guid2)[0]) == 0) {\r
    if ((((INT32 *) Guid1)[1] - ((INT32 *) Guid2)[1]) == 0) {\r
      if ((((INT32 *) Guid1)[2] - ((INT32 *) Guid2)[2]) == 0) {\r
        if ((((INT32 *) Guid1)[3] - ((INT32 *) Guid2)[3]) == 0) {\r
          return TRUE;\r
        }\r
      }\r
    }\r
  }\r
\r
  return FALSE;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI \r
PeiLibPciCfgModify (\r
  IN EFI_PEI_SERVICES         **PeiServices,\r
  IN PEI_PCI_CFG_PPI          *PciCfg,\r
  IN PEI_PCI_CFG_PPI_WIDTH    Width,\r
  IN UINT64                   Address,\r
  IN UINTN                    SetBits,\r
  IN UINTN                    ClearBits\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  PCI read-modify-write operations.\r
\r
  PIWG's PI specification replaces Inte's EFI Specification 1.10.\r
  EFI_PEI_PCI_CFG_PPI defined in Inte's EFI Specification 1.10 is replaced by\r
  EFI_PEI_PCI_CFG2_PPI in PI 1.0. "Modify" function  in these two PPI are not \r
  compatibile with each other.\r
  \r
\r
  For Framework code that make the following call:\r
\r
      PciCfg->Modify (\r
                       PeiServices,\r
                       PciCfg,\r
                       Width,\r
                       Address,\r
                       SetBits,\r
                       ClearBits\r
                       );\r
   it will be updated to the following code which call this library API:\r
      PeiLibPciCfgModify (\r
          PeiServices,\r
          PciCfg,\r
          Width,\r
          Address,\r
          SetBits,\r
          ClearBits\r
          );\r
\r
   The \r
\r
Arguments:\r
  \r
  PeiServices     An indirect pointer to the PEI Services Table\r
                          published by the PEI Foundation.\r
  PciCfg          A pointer to the this pointer of EFI_PEI_PCI_CFG_PPI. \r
                          This parameter is unused as a place holder to make\r
                          the parameter list identical to PEI_PCI_CFG_PPI_RW.\r
  Width           The width of the access. Enumerated in bytes. Type\r
                          EFI_PEI_PCI_CFG_PPI_WIDTH is defined in Read().\r
\r
  Address         The physical address of the access.\r
\r
  SetBits         Points to value to bitwise-OR with the read configuration value.\r
\r
                          The size of the value is determined by Width.\r
\r
  ClearBits       Points to the value to negate and bitwise-AND with the read configuration value.\r
                          The size of the value is determined by Width.\r
\r
\r
Returns:\r
\r
  EFI_SUCCESS           The function completed successfully.\r
\r
  EFI_DEVICE_ERROR      There was a problem with the transaction.\r
\r
--*/\r
{\r
  EFI_STATUS            Status;\r
  EFI_PEI_PCI_CFG2_PPI  *PciCfg2;\r
\r
  Status = (*PeiServices)->LocatePpi (\r
                             PeiServices,\r
                             &gPeiPciCfg2PpiGuid,\r
                             0,\r
                             NULL,\r
                             (VOID **) &PciCfg2\r
                             );\r
  ASSERT_PEI_ERROR ((CONST EFI_PEI_SERVICES **) PeiServices, Status);\r
\r
  Status = PciCfg2->Modify (\r
                      (CONST EFI_PEI_SERVICES **) PeiServices,\r
                      PciCfg2,\r
                      (EFI_PEI_PCI_CFG_PPI_WIDTH) Width,\r
                      Address,\r
                      &SetBits,\r
                      &ClearBits\r
                      );\r
\r
  return Status;\r
}\r
\r
\r
#if (PI_SPECIFICATION_VERSION >= 0x00010000)\r
\r
VOID *\r
EFIAPI\r
ScanGuid (\r
  IN VOID        *Buffer,\r
  IN UINTN       Length,\r
  IN EFI_GUID    *Guid\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Scans a target buffer for a GUID, and returns a pointer to the matching GUID\r
  in the target buffer.\r
\r
  This function searches target the buffer specified by Buffer and Length from\r
  the lowest address to the highest address at 128-bit increments for the 128-bit\r
  GUID value that matches Guid.  If a match is found, then a pointer to the matching\r
  GUID in the target buffer is returned.  If no match is found, then NULL is returned.\r
  If Length is 0, then NULL is returned.\r
  If Length > 0 and Buffer is NULL, then ASSERT().\r
  If Buffer is not aligned on a 32-bit boundary, then ASSERT().\r
  If Length is not aligned on a 128-bit boundary, then ASSERT().\r
  If Length is greater than (EFI_MAX_ADDRESS ?Buffer + 1), then ASSERT(). \r
\r
Arguments:\r
\r
  Buffer - Pointer to the target buffer to scan.\r
  Length - Number of bytes in Buffer to scan.\r
  Guid   - Value to search for in the target buffer.\r
  \r
Returns:\r
  A pointer to the matching Guid in the target buffer or NULL otherwise.\r
\r
--*/\r
{\r
  EFI_GUID                 *GuidPtr;\r
  EFI_PEI_SERVICES         **PeiServices;\r
  \r
  PeiServices = GetPeiServicesTablePointer();\r
  PEI_ASSERT(PeiServices, (((UINTN)Buffer & (sizeof (Guid->Data1) - 1)) == 0));\r
  PEI_ASSERT(PeiServices, (Length <= (EFI_MAX_ADDRESS - (UINTN)Buffer + 1)));\r
  PEI_ASSERT(PeiServices, ((Length & (sizeof (*GuidPtr) - 1)) == 0));\r
\r
  GuidPtr = (EFI_GUID*)Buffer;\r
  Buffer  = GuidPtr + Length / sizeof (*GuidPtr);\r
  while (GuidPtr < (EFI_GUID*)Buffer) {\r
    if (CompareGuid (GuidPtr, Guid)) {\r
      return (VOID*)GuidPtr;\r
    }\r
    GuidPtr++;\r
  }\r
  return NULL;\r
}\r
\r
\r
VOID *\r
EFIAPI\r
InvalidateInstructionCacheRange (\r
  IN      VOID                      *Address,\r
  IN      UINTN                     Length\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Invalidates a range of instruction cache lines in the cache coherency domain\r
  of the calling CPU.\r
\r
  Invalidates the instruction cache lines specified by Address and Length. If\r
  Address is not aligned on a cache line boundary, then entire instruction\r
  cache line containing Address is invalidated. If Address + Length is not\r
  aligned on a cache line boundary, then the entire instruction cache line\r
  containing Address + Length -1 is invalidated. This function may choose to\r
  invalidate the entire instruction cache if that is more efficient than\r
  invalidating the specified range. If Length is 0, the no instruction cache\r
  lines are invalidated. Address is returned.\r
\r
  If Length is greater than (EFI_MAX_ADDRESS - Address + 1), then ASSERT().\r
\r
Arguments:\r
\r
  Address   -     The base address of the instruction cache lines to\r
                  invalidate. If the CPU is in a physical addressing mode, then\r
                  Address is a physical address. If the CPU is in a virtual\r
                  addressing mode, then Address is a virtual address.\r
\r
  Length    -      The number of bytes to invalidate from the instruction cache.\r
\r
 Returns:\r
  Address\r
\r
**/\r
{\r
  PEI_ASSERT(GetPeiServicesTablePointer() , (Length <= EFI_MAX_ADDRESS - (UINTN)Address + 1));\r
  return Address;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiLibFfsFindNextVolume (\r
  IN UINTN                          Instance,\r
  IN OUT EFI_PEI_FV_HANDLE          *VolumeHandle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The wrapper of Pei Core Service function FfsFindNextVolume.\r
\r
Arguments:\r
\r
  Instance     - The Fv Volume Instance.\r
  VolumeHandle - Pointer to the current Fv Volume to search.\r
\r
Returns:\r
  EFI_STATUS\r
  \r
--*/\r
  \r
{\r
  EFI_PEI_SERVICES  **PeiServices;\r
  \r
  PeiServices = GetPeiServicesTablePointer();\r
  return (*PeiServices)->FfsFindNextVolume (PeiServices, Instance, VolumeHandle);\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
PeiLibFfsFindNextFile (\r
  IN EFI_FV_FILETYPE            SearchType,\r
  IN EFI_PEI_FV_HANDLE          FwVolHeader,\r
  IN OUT EFI_PEI_FILE_HANDLE    *FileHeader\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The wrapper of Pei Core Service function FfsFindNextFile.\r
\r
Arguments:\r
\r
  SearchType   - Filter to find only file of this type.\r
  FwVolHeader  - Pointer to the current FV to search.\r
  FileHandle   - Pointer to the file matching SearchType in FwVolHeader.\r
                - NULL if file not found\r
\r
Returns:\r
  EFI_STATUS\r
  \r
--*/  \r
{\r
  EFI_PEI_SERVICES  **PeiServices;\r
  \r
  PeiServices = GetPeiServicesTablePointer();\r
  return (*PeiServices)->FfsFindNextFile (PeiServices, SearchType, &FwVolHeader, &FileHeader);\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiLibFfsFindFileByName (\r
  IN  EFI_GUID              *FileName,\r
  IN  EFI_PEI_FV_HANDLE     VolumeHandle,\r
  OUT EFI_PEI_FILE_HANDLE   *FileHandle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The wrapper of Pei Core Service function FfsFindFileByName.\r
\r
Arguments:\r
\r
  FileName      - File name to search.\r
  VolumeHandle  - The current FV to search.\r
  FileHandle    - Pointer to the file matching name in VolumeHandle.\r
                - NULL if file not found\r
\r
Returns:\r
   EFI_STATUS\r
   \r
--*/  \r
{\r
  EFI_PEI_SERVICES  **PeiServices;\r
  \r
  PeiServices = GetPeiServicesTablePointer();\r
  return (*PeiServices)->FfsFindFileByName (FileName, VolumeHandle, FileHandle);\r
}\r
\r
\r
\r
EFI_STATUS\r
EFIAPI\r
PeiLibFfsFindSectionData (\r
  IN EFI_SECTION_TYPE           SectionType,\r
  IN EFI_FFS_FILE_HEADER        *FfsFileHeader,\r
  IN OUT VOID                   **SectionData\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The wrapper of Pei Core Service function FfsFindSectionData.\r
\r
Arguments:\r
\r
  SearchType      - Filter to find only sections of this type.\r
  FileHandle      - Pointer to the current file to search.\r
  SectionData     - Pointer to the Section matching SectionType in FfsFileHeader.\r
                  - NULL if section not found\r
\r
Returns:\r
  EFI_STATUS\r
--*/\r
{\r
  EFI_PEI_SERVICES  **PeiServices;\r
  \r
  PeiServices = GetPeiServicesTablePointer();\r
  return (*PeiServices)->FfsFindSectionData (PeiServices, SectionType, &FfsFileHeader, SectionData);\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
PeiLibFfsGetVolumeInfo (\r
  IN EFI_PEI_FV_HANDLE  *VolumeHandle,\r
  OUT EFI_FV_INFO       *VolumeInfo\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The wrapper of Pei Core Service function FfsGetVolumeInfo.\r
\r
Arguments:\r
\r
  VolumeHandle    - The handle to Fv Volume.\r
  VolumeInfo      - The pointer to volume information.\r
  \r
Returns:\r
  EFI_STATUS\r
--*/  \r
{\r
  EFI_PEI_SERVICES  **PeiServices;\r
  \r
  PeiServices = GetPeiServicesTablePointer();\r
  return (*PeiServices)->FfsGetVolumeInfo (VolumeHandle, VolumeInfo);\r
}\r
\r
\r
\r
VOID\r
EFIAPI\r
BuildFvHob (\r
  IN EFI_PHYSICAL_ADDRESS        BaseAddress,\r
  IN UINT64                      Length\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Build FvHob.\r
\r
Arguments:\r
\r
  BaseAddress    - Fv base address.\r
  Length         - Fv Length.\r
\r
Returns:\r
  NONE.\r
--*/  \r
{\r
\r
  EFI_STATUS               Status;  \r
  EFI_HOB_FIRMWARE_VOLUME  *Hob;\r
  EFI_PEI_SERVICES  **PeiServices;\r
\r
  PeiServices = GetPeiServicesTablePointer();\r
\r
  //\r
  // Check FV Signature\r
  //\r
  PEI_ASSERT (PeiServices, ((EFI_FIRMWARE_VOLUME_HEADER*)((UINTN)BaseAddress))->Signature == EFI_FVH_SIGNATURE);\r
\r
\r
  Status = (*PeiServices)->CreateHob (\r
                             PeiServices,\r
                             EFI_HOB_TYPE_FV,\r
                             sizeof (EFI_HOB_FIRMWARE_VOLUME),\r
                             &Hob\r
                             );\r
  Hob->BaseAddress = BaseAddress;\r
  Hob->Length      = Length;\r
}\r
\r
VOID\r
EFIAPI\r
BuildFvHob2 (\r
  IN EFI_PHYSICAL_ADDRESS        BaseAddress,\r
  IN UINT64                      Length,\r
  IN EFI_GUID                    *FvNameGuid,\r
  IN EFI_GUID                    *FileNameGuid\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Build FvHob2.\r
\r
Arguments:\r
\r
  BaseAddress  - Fv base address.\r
  Length       - Fv length.\r
  FvNameGuid   - Fv name.\r
  FileNameGuid - File name which contians encapsulated Fv.\r
\r
Returns:\r
   NONE.\r
--*/  \r
{\r
\r
  EFI_STATUS               Status;  \r
  EFI_HOB_FIRMWARE_VOLUME2  *Hob;\r
  EFI_PEI_SERVICES  **PeiServices;\r
\r
  PeiServices = GetPeiServicesTablePointer();\r
\r
  //\r
  // Check FV Signature\r
  //\r
  PEI_ASSERT (PeiServices, ((EFI_FIRMWARE_VOLUME_HEADER*)((UINTN)BaseAddress))->Signature == EFI_FVH_SIGNATURE);\r
\r
  Status = (*PeiServices)->CreateHob (\r
                             PeiServices,\r
                             EFI_HOB_TYPE_FV2,\r
                             sizeof (EFI_HOB_FIRMWARE_VOLUME2),\r
                             &Hob\r
                             );\r
  Hob->BaseAddress = BaseAddress;\r
  Hob->Length      = Length;\r
  CopyMem ((VOID*)&Hob->FvName, FvNameGuid, sizeof(EFI_GUID));\r
  CopyMem ((VOID*)&Hob->FileName, FileNameGuid, sizeof(EFI_GUID));\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
PeiServicesLocatePpi (\r
  IN EFI_GUID                   *Guid,\r
  IN UINTN                      Instance,\r
  IN OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor,\r
  IN OUT VOID                   **Ppi\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The wrapper of Pei Core Service function LocatePpi.\r
\r
Arguments:\r
\r
  Guid          - Pointer to GUID of the PPI.\r
  Instance      - Instance Number to discover.\r
  PpiDescriptor - Pointer to reference the found descriptor. If not NULL,\r
                returns a pointer to the descriptor (includes flags, etc)\r
  Ppi           - Pointer to reference the found PPI\r
\r
Returns:\r
\r
  Status -  EFI_SUCCESS   if the PPI is in the database           \r
            EFI_NOT_FOUND if the PPI is not in the database\r
--*/  \r
{\r
  EFI_PEI_SERVICES  **PeiServices;\r
  \r
  PeiServices = GetPeiServicesTablePointer();\r
  return (*PeiServices)->LocatePpi (PeiServices, Guid, Instance, PpiDescriptor, Ppi);\r
}\r
\r
\r
VOID \r
EFIAPI\r
BuildGuidDataHob (\r
  IN EFI_GUID                   *Guid,\r
  IN VOID                        *Data,\r
  IN UINTN                       DataLength\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Build Guid data Hob.\r
\r
Arguments:\r
\r
  Guid        - guid to build data hob.\r
  Data        - data to build data hob.\r
  DataLength  - the length of data.\r
\r
Returns:\r
  NONE\r
--*/  \r
{\r
  VOID              *HobData;\r
  EFI_HOB_GUID_TYPE *Hob;\r
  EFI_PEI_SERVICES  **PeiServices;\r
\r
  PeiServices = GetPeiServicesTablePointer();\r
  (*PeiServices)->CreateHob (\r
                     PeiServices,\r
                     EFI_HOB_TYPE_GUID_EXTENSION,\r
                     (UINT16) (sizeof (EFI_HOB_GUID_TYPE) + DataLength),\r
                     &Hob\r
                     );\r
  CopyMem ((VOID*)&Hob->Name, (VOID*)Guid, sizeof(EFI_GUID));\r
\r
  HobData =  Hob + 1;\r
\r
  CopyMem (HobData, Data, DataLength);\r
}\r
\r
\r
VOID *\r
EFIAPI\r
AllocatePages (\r
  IN UINTN  Pages\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Allocate Memory.\r
\r
Arguments:\r
\r
  Pages - Pages to allocate.\r
\r
Returns:\r
  = Address if successful to allocate memory. \r
  = NULL    if fail to allocate memory.\r
\r
--*/  \r
{\r
  EFI_STATUS            Status;\r
  EFI_PHYSICAL_ADDRESS  Memory; \r
  EFI_PEI_SERVICES      **PeiServices;\r
\r
  if (Pages == 0) {\r
    return NULL;\r
  }\r
\r
  PeiServices = GetPeiServicesTablePointer();\r
  Status = (*PeiServices)->AllocatePages (PeiServices, EfiBootServicesData, Pages, &Memory);\r
  if (EFI_ERROR (Status)) {\r
    Memory = 0;\r
  }\r
  return (VOID *) (UINTN) Memory;\r
\r
}\r
\r
#endif\r