DebugLib:

	Fix a bug in PeiDxeDebugLibReportStatusCode: it should use gReportStatusCodeDebugType so that report status code infrastructure can correctly extract debug info.
	Fix functional and coding style issues in the three instances in EdkModulePkg, namely: EdkDxeDebugLibReportStatusCode, EdkUefiDebugLibStderr, EdkUefiDebugLibConout.
	DevicePathLib:
	Sync with MWG 0.57 and add new interface of CreateDevicePathNode(). All the function headers have been updated.
	PeiServicesLib:
	Adjust coding style and fix a minor comment error.
	PciLib:
	Adjust assert() condition to sync with MWG 0.57
	BaseMemoryLib:
	Adjust assert() for ScanMemXX (), ScanGuid()
	Rename UefiMemoryLib to DxeMemoryLib
	PrintLib:
	Change the return value of all print services to exclude the NULL-terminator.
	Misc:
	Slightly adjust the coding style in hob.c in PeiCore module.


git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@757 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 131 insertions, 139 deletions

diff --git a/MdePkg/Include/Library/PeiServicesLib.h b/MdePkg/Include/Library/PeiServicesLib.h
index 10eebb5bf0..53d1cdba42 100644
--- a/MdePkg/Include/Library/PeiServicesLib.h
+++ b/MdePkg/Include/Library/PeiServicesLib.h
@@ -1,5 +1,5 @@
 /** @file

-  PEI Core Library implementation

+  Header file for PEI Services Library.

 

   Copyright (c) 2006, Intel Corporation                                                         

   All rights reserved. This program and the accompanying materials                          

@@ -20,287 +20,279 @@
 /**

   This service enables a given PEIM to register an interface into the PEI Foundation. 

 

-  @param  PpiList A pointer to the list of interfaces that the caller shall install.

+  @param  PpiList               A pointer to the list of interfaces that the caller shall install.

 

-  @retval  EFI_SUCCESS The interface was successfully installed.

-  @retval  EFI_INVALID_PARAMETER The PpiList pointer is NULL.

-  @retval  EFI_INVALID_PARAMETER Any of the PEI PPI descriptors in the list do not have

-  the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.

-  @retval  EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.

+  @retval EFI_SUCCESS           The interface was successfully installed.

+  @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL.

+  @retval EFI_INVALID_PARAMETER Any of the PEI PPI descriptors in the list do not have the

+                                EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.

+  @retval EFI_OUT_OF_RESOURCES  There is no additional space in the PPI database.

 

 **/

 EFI_STATUS

 EFIAPI

 PeiServicesInstallPpi (

-  IN EFI_PEI_PPI_DESCRIPTOR           *PpiList

-  )

-;

+  IN EFI_PEI_PPI_DESCRIPTOR     *PpiList

+  );

 

 /**

   This service enables PEIMs to replace an entry in the PPI database with an alternate entry.

 

-  @param  OldPpi Pointer to the old PEI PPI Descriptors.

-  @param  NewPpi Pointer to the new PEI PPI Descriptors.

+  @param  OldPpi                Pointer to the old PEI PPI Descriptors.

+  @param  NewPpi                Pointer to the new PEI PPI Descriptors.

 

-  @retval  EFI_SUCCESS The interface was successfully installed.

-  @retval  EFI_INVALID_PARAMETER The OldPpi or NewPpi is NULL.

-  @retval  EFI_INVALID_PARAMETER Any of the PEI PPI descriptors in the list do not have

-  the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.

-  @retval  EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.

-  @retval  EFI_NOT_FOUND The PPI for which the reinstallation was requested has not been installed.

+  @retval EFI_SUCCESS           The interface was successfully installed.

+  @retval EFI_INVALID_PARAMETER The OldPpi or NewPpi is NULL.

+  @retval EFI_INVALID_PARAMETER Any of the PEI PPI descriptors in the list do not have the

+                                EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.

+  @retval EFI_OUT_OF_RESOURCES  There is no additional space in the PPI database.

+  @retval EFI_NOT_FOUND         The PPI for which the reinstallation was requested has not been

+                                installed.

 

 **/

 EFI_STATUS

 EFIAPI

 PeiServicesReInstallPpi (

-  IN EFI_PEI_PPI_DESCRIPTOR           *OldPpi,

-  IN EFI_PEI_PPI_DESCRIPTOR           *NewPpi

-  )

-;

+  IN EFI_PEI_PPI_DESCRIPTOR     *OldPpi,

+  IN EFI_PEI_PPI_DESCRIPTOR     *NewPpi

+  );

 

 /**

   This service enables PEIMs to discover a given instance of an interface.

 

-  @param  Guid A pointer to the GUID whose corresponding interface needs to be found.

-  @param  Instance The N-th instance of the interface that is required.

-  @param  PpiDescriptor A pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.

-  @param  Ppi A pointer to the instance of the interface.

+  @param  Guid                  A pointer to the GUID whose corresponding interface needs to be

+                                found.

+  @param  Instance              The N-th instance of the interface that is required.

+  @param  PpiDescriptor         A pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.

+  @param  Ppi                   A pointer to the instance of the interface.

 

-  @retval  EFI_SUCCESS The interface was successfully returned.

-  @retval  EFI_NOT_FOUND The PPI descriptor is not found in the database.

+  @retval EFI_SUCCESS           The interface was successfully returned.

+  @retval EFI_NOT_FOUND         The PPI descriptor is not found in the database.

 

 **/

 EFI_STATUS

 EFIAPI

 PeiServicesLocatePpi (

-  IN EFI_GUID                         *Guid,

-  IN UINTN                            Instance,

-  IN OUT EFI_PEI_PPI_DESCRIPTOR       **PpiDescriptor,

-  IN OUT VOID                         **Ppi

-  )

-;

+  IN EFI_GUID                   *Guid,

+  IN UINTN                      Instance,

+  IN OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor,

+  IN OUT VOID                   **Ppi

+  );

 

 /**

-  This service enables PEIMs to register a given service to be invoked

-  when another service is installed or reinstalled.

+  This service enables PEIMs to register a given service to be invoked when another service is

+  installed or reinstalled.

 

-  @param  NotifyList A pointer to the list of notification interfaces that the caller shall install.

+  @param  NotifyList            A pointer to the list of notification interfaces that the caller

+                                shall install.

 

-  @retval  EFI_SUCCESS The interface was successfully installed.

-  @retval  EFI_INVALID_PARAMETER The NotifyList pointer is NULL.

-  @retval  EFI_INVALID_PARAMETER Any of the PEI notify descriptors in the list do not have

-  the EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES bit set in the Flags field.

-  @retval  EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.

+  @retval EFI_SUCCESS           The interface was successfully installed.

+  @retval EFI_INVALID_PARAMETER The NotifyList pointer is NULL.

+  @retval EFI_INVALID_PARAMETER Any of the PEI notify descriptors in the list do not have the

+                                EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES bit set in the Flags field.

+  @retval EFI_OUT_OF_RESOURCES  There is no additional space in the PPI database.

 

 **/

 EFI_STATUS

 EFIAPI

 PeiServicesNotifyPpi (

-  IN EFI_PEI_NOTIFY_DESCRIPTOR        *NotifyList

-  )

-;

+  IN EFI_PEI_NOTIFY_DESCRIPTOR  *NotifyList

+  );

 

 /**

   This service enables PEIMs to ascertain the present value of the boot mode.  

 

-  @param  BootMode A pointer to contain the value of the boot mode.

+  @param  BootMode              A pointer to contain the value of the boot mode.

 

-  @retval  EFI_SUCCESS The boot mode was returned successfully.

-  @retval  EFI_INVALID_PARAMETER BootMode is NULL.

+  @retval EFI_SUCCESS           The boot mode was returned successfully.

+  @retval EFI_INVALID_PARAMETER BootMode is NULL.

 

 **/

 EFI_STATUS

 EFIAPI

 PeiServicesGetBootMode (

-  IN OUT EFI_BOOT_MODE                *BootMode

-  )

-;

+  IN OUT EFI_BOOT_MODE          *BootMode

+  );

 

 /**

   This service enables PEIMs to update the boot mode variable.    

 

-  @param  BootMode The value of the boot mode to set.

+  @param  BootMode              The value of the boot mode to set.

 

-  @retval  EFI_SUCCESS The value was successfully updated

+  @retval EFI_SUCCESS           The value was successfully updated

 

 **/

 EFI_STATUS

 EFIAPI

 PeiServicesSetBootMode (

-  IN EFI_BOOT_MODE                    BootMode

-  )

-;

+  IN EFI_BOOT_MODE              BootMode

+  );

 

 /**

   This service enables a PEIM to ascertain the address of the list of HOBs in memory.

 

-  @param  HobList A pointer to the list of HOBs that the PEI Foundation will initialize.

+  @param  HobList               A pointer to the list of HOBs that the PEI Foundation will initialize.

 

-  @retval  EFI_SUCCESS The list was successfully returned.

-  @retval  EFI_NOT_AVAILABLE_YET The HOB list is not yet published.

+  @retval EFI_SUCCESS           The list was successfully returned.

+  @retval EFI_NOT_AVAILABLE_YET The HOB list is not yet published.

 

 **/

 EFI_STATUS

 EFIAPI

 PeiServicesGetHobList (

-  IN OUT VOID                         **HobList

-  )

-;

+  IN OUT VOID                   **HobList

+  );

 

 /**

   This service enables PEIMs to create various types of HOBs.

 

-  @param  Type The type of HOB to be installed.

-  @param  Length The length of the HOB to be added.

-  @param  Hob The address of a pointer that will contain the HOB header.

+  @param  Type                  The type of HOB to be installed.

+  @param  Length                The length of the HOB to be added.

+  @param  Hob                   The address of a pointer that will contain the HOB header.

 

-  @retval  EFI_SUCCESS The HOB was successfully created.

-  @retval  EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.

+  @retval EFI_SUCCESS           The HOB was successfully created.

+  @retval EFI_OUT_OF_RESOURCES  There is no additional space for HOB creation.

 

 **/

 EFI_STATUS

 EFIAPI

 PeiServicesCreateHob (

-  IN UINT16                           Type,

-  IN UINT16                           Length,

-  IN OUT VOID                         **Hob

-  )

-;

+  IN UINT16                     Type,

+  IN UINT16                     Length,

+  IN OUT VOID                   **Hob

+  );

 

 /**

   This service enables PEIMs to discover additional firmware volumes.

 

-  @param  Instance This instance of the firmware volume to find.

-  The value 0 is the Boot Firmware Volume (BFV).

-  @param  FwVolHeader Pointer to the firmware volume header of the volume to return.

+  @param  Instance              This instance of the firmware volume to find.  The value 0 is the

+                                Boot Firmware Volume (BFV).

+  @param  FwVolHeader           Pointer to the firmware volume header of the volume to return.

 

-  @retval  EFI_SUCCESS The volume was found.

-  @retval  EFI_NOT_FOUND The volume was not found.

-  @retval  EFI_INVALID_PARAMETER FwVolHeader is NULL.

+  @retval EFI_SUCCESS           The volume was found.

+  @retval EFI_NOT_FOUND         The volume was not found.

+  @retval EFI_INVALID_PARAMETER FwVolHeader is NULL.

 

 **/

 EFI_STATUS

 EFIAPI

 PeiServicesFfsFindNextVolume (

-  IN UINTN                            Instance,

-  IN OUT EFI_FIRMWARE_VOLUME_HEADER   **FwVolHeader

-  )

-;

+  IN UINTN                          Instance,

+  IN OUT EFI_FIRMWARE_VOLUME_HEADER **FwVolHeader

+  );

 

 /**

   This service enables PEIMs to discover additional firmware files.

 

-  @param  SearchType A filter to find files only of this type.

-  @param  FwVolHeader Pointer to the firmware volume header of the volume to search.

-  This parameter must point to a valid FFS volume.

-  @param  FileHeader Pointer to the current file from which to begin searching.

+  @param  SearchType            A filter to find files only of this type.

+  @param  FwVolHeader           Pointer to the firmware volume header of the volume to search.

+                                This parameter must point to a valid FFS volume.

+  @param  FileHeader            Pointer to the current file from which to begin searching.

 

-  @retval  EFI_SUCCESS The file was found.

-  @retval  EFI_NOT_FOUND The file was not found.

-  @retval  EFI_NOT_FOUND The header checksum was not zero.

+  @retval EFI_SUCCESS           The file was found.

+  @retval EFI_NOT_FOUND         The file was not found.

+  @retval EFI_NOT_FOUND         The header checksum was not zero.

 

 **/

 EFI_STATUS

 EFIAPI

 PeiServicesFfsFindNextFile (

-  IN EFI_FV_FILETYPE                  SearchType,

-  IN EFI_FIRMWARE_VOLUME_HEADER       *FwVolHeader,

-  IN OUT EFI_FFS_FILE_HEADER          **FileHeader

-  )

-;

+  IN EFI_FV_FILETYPE            SearchType,

+  IN EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader,

+  IN OUT EFI_FFS_FILE_HEADER    **FileHeader

+  );

 

 /**

   This service enables PEIMs to discover sections of a given type within a valid FFS file.

 

-  @param  SearchType The value of the section type to find.

-  @param  FfsFileHeader A pointer to the file header that contains the set of sections to be searched.

-  @param  SectionData A pointer to the discovered section, if successful.

+  @param  SearchType            The value of the section type to find.

+  @param  FfsFileHeader         A pointer to the file header that contains the set of sections to

+                                be searched.

+  @param  SectionData           A pointer to the discovered section, if successful.

 

-  @retval  EFI_SUCCESS The section was found.

-  @retval  EFI_NOT_FOUND The section was not found.

+  @retval EFI_SUCCESS           The section was found.

+  @retval EFI_NOT_FOUND         The section was not found.

 

 **/

 EFI_STATUS

 EFIAPI

 PeiServicesFfsFindSectionData (

-  IN EFI_SECTION_TYPE                 SectionType,

-  IN EFI_FFS_FILE_HEADER              *FfsFileHeader,

-  IN OUT VOID                         **SectionData

-  )

-;

+  IN EFI_SECTION_TYPE           SectionType,

+  IN EFI_FFS_FILE_HEADER        *FfsFileHeader,

+  IN OUT VOID                   **SectionData

+  );

 

 /**

   This service enables PEIMs to register the permanent memory configuration

   that has been initialized with the PEI Foundation.

 

-  @param  MemoryBegin The value of a region of installed memory.

-  @param  MemoryLength The corresponding length of a region of installed memory.

+  @param  MemoryBegin           The value of a region of installed memory.

+  @param  MemoryLength          The corresponding length of a region of installed memory.

 

-  @retval  EFI_SUCCESS The region was successfully installed in a HOB.

-  @retval  EFI_INVALID_PARAMETER MemoryBegin and MemoryLength are illegal for this system.

-  @retval  EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.

+  @retval EFI_SUCCESS           The region was successfully installed in a HOB.

+  @retval EFI_INVALID_PARAMETER MemoryBegin and MemoryLength are illegal for this system.

+  @retval EFI_OUT_OF_RESOURCES  There is no additional space for HOB creation.

 

 **/

 EFI_STATUS

 EFIAPI

 PeiServicesInstallPeiMemory (

-  IN EFI_PHYSICAL_ADDRESS             MemoryBegin,

-  IN UINT64                           MemoryLength

-  )

-;

+  IN EFI_PHYSICAL_ADDRESS       MemoryBegin,

+  IN UINT64                     MemoryLength

+  );

 

 /**

-  This service enables PEIMs to allocate memory after the permanent memory has been installed by a PEIM.

+  This service enables PEIMs to allocate memory after the permanent memory has been installed by a

+  PEIM.

 

-  @param  MemoryType Type of memory to allocate.

-  @param  Pages Number of pages to allocate.

-  @param  Memory Pointer of memory allocated.

+  @param  MemoryType            Type of memory to allocate.

+  @param  Pages                 Number of pages to allocate.

+  @param  Memory                Pointer of memory allocated.

 

-  @retval  EFI_SUCCESS The memory range was successfully allocated.

-  @retval  EFI_INVALID_PARAMETER Type is not equal to AllocateAnyPages.

-  @retval  EFI_NOT_AVAILABLE_YET Called with permanent memory not available.

-  @retval  EFI_OUT_OF_RESOURCES The pages could not be allocated.

+  @retval EFI_SUCCESS           The memory range was successfully allocated.

+  @retval EFI_INVALID_PARAMETER Type is not equal to AllocateAnyPages.

+  @retval EFI_NOT_AVAILABLE_YET Called with permanent memory not available.

+  @retval EFI_OUT_OF_RESOURCES  The pages could not be allocated.

 

 **/

 EFI_STATUS

 EFIAPI

 PeiServicesAllocatePages (

-  IN EFI_MEMORY_TYPE                  MemoryType,

-  IN UINTN                            Pages,

-  IN OUT EFI_PHYSICAL_ADDRESS         *Memory

-  )

-;

+  IN EFI_MEMORY_TYPE            MemoryType,

+  IN UINTN                      Pages,

+  IN OUT EFI_PHYSICAL_ADDRESS   *Memory

+  );

 

 /**

   This service allocates memory from the Hand-Off Block (HOB) heap.

 

-  @param  Size The number of bytes to allocate from the pool.

-  @param  Buffer If the call succeeds, a pointer to a pointer to the allocated buffer;

-  undefined otherwise.

+  @param  Size                  The number of bytes to allocate from the pool.

+  @param  Buffer                If the call succeeds, a pointer to a pointer to the allocate

+                                buffer; undefined otherwise.

 

-  @retval  EFI_SUCCESS The allocation was successful

-  @retval  EFI_OUT_OF_RESOURCES There is not enough heap to allocate the requested size.

+  @retval EFI_SUCCESS           The allocation was successful

+  @retval EFI_OUT_OF_RESOURCES  There is not enough heap to allocate the requested size.

 

 **/

 EFI_STATUS

 EFIAPI

 PeiServicesAllocatePool (

-  IN UINTN                            Size,

-  OUT VOID                            **Buffer

-  )

-;

+  IN UINTN                      Size,

+  OUT VOID                      **Buffer

+  );

 

 /**

-  This service resets the entire platform, including all processors and devices, and reboots the system. 

+  This service resets the entire platform, including all processors and devices, and reboots the

+  system. 

 

-  @retval  EFI_NOT_AVAILABLE_YET The service has not been installed yet.

+  @retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.

 

 **/

 EFI_STATUS

 EFIAPI

 PeiServicesResetSystem (

   VOID

-  )

-;

+  );

+

 

 #endif