Reviewed the code comments in the Include/Protocol directory for typos, grammar issue...

[mirror_edk2.git] / UnixPkg / UnixFlashMapPei / FlashMap.c

/*++\r
\r
Copyright (c) 2006 - 2008, 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
Module Name:\r
\r
  FlashMap.c\r
   \r
Abstract:\r
\r
  PEIM to build GUIDed HOBs for platform specific flash map\r
\r
--*/\r
\r
\r
#include "PiPei.h"\r
\r
#include <Guid/SystemNvDataGuid.h>\r
#include <Guid/FirmwareFileSystem.h>\r
#include <Ppi/UnixFwh.h>\r
#include <Protocol/FirmwareVolumeBlock.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/PeimEntryPoint.h>\r
#include <Library/HobLib.h>\r
#include <Library/PeiServicesLib.h>\r
#include <Library/PeiServicesTablePointerLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/PcdLib.h>\r
\r
EFI_STATUS\r
EFIAPI\r
PeimInitializeFlashMap (\r
  IN       EFI_PEI_FILE_HANDLE       FileHandle,\r
  IN CONST EFI_PEI_SERVICES          **PeiServices\r
  )\r
/*++\r
\r
Routine Description:\r
  Build GUIDed HOBs for platform specific flash map\r
  \r
Arguments:\r
  FfsHeader   - A pointer to the EFI_FFS_FILE_HEADER structure.\r
  PeiServices - General purpose services available to every PEIM.\r
    \r
Returns:\r
  EFI_STATUS\r
\r
--*/\r
// TODO:    EFI_SUCCESS - add return value to function comment\r
{\r
  EFI_STATUS              Status;\r
  UNIX_FWH_PPI           *UnixFwhPpi;\r
  EFI_PEI_PPI_DESCRIPTOR  *PpiDescriptor;\r
  EFI_PHYSICAL_ADDRESS    FdBase;\r
  UINT64                  FdSize;\r
\r
  DEBUG ((EFI_D_ERROR, "NT 32 Flash Map PEIM Loaded\n"));\r
\r
  //\r
  // Get the Fwh Information PPI\r
  //\r
  Status = PeiServicesLocatePpi (\r
            &gUnixFwhPpiGuid, // GUID\r
            0,              // INSTANCE\r
            &PpiDescriptor, // EFI_PEI_PPI_DESCRIPTOR\r
            (VOID **)&UnixFwhPpi       // PPI\r
            );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Assume that FD0 contains the Flash map.\r
  //\r
  Status = UnixFwhPpi->UnixFwh (0, &FdBase, &FdSize);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  \r
  PcdSet32 (PcdFlashNvStorageVariableBase, PcdGet32 (PcdUnixFlashNvStorageVariableBase) + (UINT32) FdBase);\r
  PcdSet32 (PcdFlashNvStorageFtwWorkingBase, PcdGet32 (PcdUnixFlashNvStorageFtwWorkingBase) + (UINT32) FdBase);\r
  PcdSet32 (PcdFlashNvStorageFtwSpareBase, PcdGet32 (PcdUnixFlashNvStorageFtwSpareBase) + (UINT32) FdBase);\r
\r
  return EFI_SUCCESS;\r
}\r