Correct comments.

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

diff --git a/MdeModulePkg/Core/Pei/PeiMain.h b/MdeModulePkg/Core/Pei/PeiMain.h
index 3cd642ea4f9635c30506caad28f41a39404d79e4..647edae4167431bf1462dfe0604968091f0ab475 100644 (file)
--- a/MdeModulePkg/Core/Pei/PeiMain.h
+++ b/MdeModulePkg/Core/Pei/PeiMain.h
@@ -59,14 +59,33 @@ typedef union {
 } PEI_PPI_LIST_POINTERS;\r
 \r
 ///\r
-/// PPI database structure\r
+/// PPI database structure which contains two link: PpiList and NotifyList. PpiList\r
+/// is in head of PpiListPtrs array and notify is in end of PpiListPtrs.\r
 ///\r
 typedef struct {\r
+  ///\r
+  /// index of end of PpiList link list.\r
+  ///\r
   INTN                    PpiListEnd;\r
+  ///\r
+  /// index of end of notify link list.\r
+  ///\r
   INTN                    NotifyListEnd;\r
+  ///\r
+  /// index of the dispatched notify list.\r
+  ///\r
   INTN                    DispatchListEnd;\r
+  ///\r
+  /// index of last installed Ppi description in PpiList link list.\r
+  ///\r
   INTN                    LastDispatchedInstall;\r
+  ///\r
+  /// index of last dispatched notify in Notify link list.\r
+  /// \r
   INTN                    LastDispatchedNotify;\r
+  ///\r
+  /// Ppi database.\r
+  ///\r
   PEI_PPI_LIST_POINTERS   PpiListPtrs[FixedPcdGet32 (PcdPeiCoreMaxPpiSupported)];\r
 } PEI_PPI_DATABASE;\r
 \r
@@ -220,7 +239,7 @@ PeiCore (
   operation types (AND, OR).\r
 \r
 \r
-  @param PeiServices            Calling context.\r
+  @param PeiServices            An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
   @param DependencyExpression   Pointer to a dependency expression.  The Grammar adheres to\r
                                 the BNF described above and is stored in postfix notation.\r
 \r
@@ -243,9 +262,7 @@ PeimDispatchReadiness (
   @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
-                         PrivateData          - Pointer to the private data passed in from caller\r
-                         DispatchData         - Pointer to PEI_CORE_DISPATCH_DATA data.\r
-  @param Private         EDES_TODO: Add parameter description\r
+  @param PrivateData     Pointer to the private data passed in from caller\r
 \r
   @retval EFI_SUCCESS    Successfully dispatched PEIM.\r
   @retval EFI_NOT_FOUND  The dispatch failed.\r
@@ -362,14 +379,14 @@ PeiInstallPpi (
 \r
   Re-Install PPI services.\r
 \r
-  @param PeiServices     - Pointer to the PEI Service Table\r
-  @param OldPpi          - Pointer to the old PEI PPI Descriptors.\r
-  @param NewPpi          - Pointer to the new PEI PPI Descriptors.\r
+  @param PeiServices            An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param OldPpi                 Pointer to the old PEI PPI Descriptors.\r
+  @param NewPpi                 Pointer to the new PEI PPI Descriptors.\r
 \r
-  @retval EFI_SUCCESS           - if the operation was successful\r
-  @retval EFI_INVALID_PARAMETER - if OldPpi or NewPpi is NULL\r
-  @retval EFI_INVALID_PARAMETER - if NewPpi is not valid\r
-  @retval EFI_NOT_FOUND         - if the PPI was not in the database\r
+  @retval EFI_SUCCESS           if the operation was successful\r
+  @retval EFI_INVALID_PARAMETER if OldPpi or NewPpi is NULL\r
+  @retval EFI_INVALID_PARAMETER if NewPpi is not valid\r
+  @retval EFI_NOT_FOUND         if the PPI was not in the database\r
 \r
 **/\r
 EFI_STATUS\r
@@ -386,12 +403,12 @@ PeiReInstallPpi (
   Locate a given named PPI.\r
 \r
 \r
-  @param PeiServices     - Pointer to the PEI Service Table\r
-  @param Guid            - Pointer to GUID of the PPI.\r
-  @param Instance        - Instance Number to discover.\r
-  @param PpiDescriptor   - Pointer to reference the found descriptor. If not NULL,\r
+  @param PeiServices     An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param Guid            Pointer to GUID of the PPI.\r
+  @param Instance        Instance Number to discover.\r
+  @param PpiDescriptor   Pointer to reference the found descriptor. If not NULL,\r
                          returns a pointer to the descriptor (includes flags, etc)\r
-  @param Ppi             - Pointer to reference the found PPI\r
+  @param Ppi             Pointer to reference the found PPI\r
 \r
   @retval EFI_SUCCESS   if the PPI is in the database\r
   @retval EFI_NOT_FOUND if the PPI is not in the database\r
@@ -400,8 +417,8 @@ PeiReInstallPpi (
 EFI_STATUS\r
 EFIAPI\r
 PeiLocatePpi (\r
-  IN CONST EFI_PEI_SERVICES            **PeiServices,\r
-  IN CONST EFI_GUID                    *Guid,\r
+  IN CONST EFI_PEI_SERVICES      **PeiServices,\r
+  IN CONST EFI_GUID              *Guid,\r
   IN UINTN                       Instance,\r
   IN OUT EFI_PEI_PPI_DESCRIPTOR  **PpiDescriptor,\r
   IN OUT VOID                    **Ppi\r
@@ -413,8 +430,8 @@ PeiLocatePpi (
   Install a notification for a given PPI.\r
 \r
 \r
-  @param PeiServices     - Pointer to the PEI Service Table\r
-  @param NotifyList      - Pointer to list of Descriptors to notify upon.\r
+  @param PeiServices            An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param NotifyList             Pointer to list of Descriptors to notify upon.\r
 \r
   @retval EFI_SUCCESS           if successful\r
   @retval EFI_OUT_OF_RESOURCES  if no space in the database\r
@@ -471,7 +488,7 @@ DispatchNotify (
 /**\r
   This service enables PEIMs to ascertain the present value of the boot mode.\r
 \r
-  @param PeiServices            The PEI core services table.\r
+  @param PeiServices            An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
   @param BootMode               A pointer to contain the value of the boot mode.\r
 \r
   @retval EFI_SUCCESS           The boot mode was returned successfully.\r
@@ -490,10 +507,10 @@ PeiGetBootMode (
   This service enables PEIMs to update the boot mode variable.\r
 \r
 \r
-  @param PeiServices     - The PEI core services table.\r
-  @param BootMode        - The value of the boot mode to set.\r
+  @param PeiServices     An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param BootMode        The value of the boot mode to set.\r
 \r
-  @return EFI_SUCCESS    - The value was successfully updated\r
+  @return EFI_SUCCESS    The value was successfully updated\r
 \r
 **/\r
 EFI_STATUS\r
@@ -511,7 +528,7 @@ PeiSetBootMode (
 \r
   Initialize the security services.\r
 \r
-  @param PeiServices     The PEI core services table.\r
+  @param PeiServices     An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
   @param OldCoreData     Pointer to the old core data.\r
                          NULL if being run in non-permament memory mode.\r
 \r
@@ -564,7 +581,7 @@ VerifyPeim (
   Gets the pointer to the HOB List.\r
 \r
 \r
-  @param PeiServices                   The PEI core services table.\r
+  @param PeiServices                   An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
   @param HobList                       Pointer to the HOB List.\r
 \r
   @retval EFI_SUCCESS                  Get the pointer of HOB List\r
@@ -583,10 +600,10 @@ PeiGetHobList (
 /**\r
   Add a new HOB to the HOB List.\r
 \r
-  @param PeiServices     - The PEI core services table.\r
-  @param Type            - Type of the new HOB.\r
-  @param Length          - Length of the new HOB to allocate.\r
-  @param Hob             - Pointer to the new HOB.\r
+  @param PeiServices        An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param Type               Type of the new HOB.\r
+  @param Length             Length of the new HOB to allocate.\r
+  @param Hob                Pointer to the new HOB.\r
 \r
   @return  EFI_SUCCESS           Success to create hob.\r
   @retval  EFI_INVALID_PARAMETER if Hob is NULL\r
@@ -633,7 +650,7 @@ PeiCoreBuildHobHandoffInfoTable (
   the Firmware Volume defined by FwVolHeader.\r
 \r
 \r
-  @param PeiServices     Pointer to the PEI Core Services Table.\r
+  @param PeiServices     An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
   @param SearchType      Filter to find only files of this type.\r
                          Type EFI_FV_FILETYPE_ALL causes no filtering to be done.\r
   @param VolumeHandle    Pointer to the FV header of the volume to search.\r
@@ -658,7 +675,7 @@ PeiFfsFindNextFile (
   FFS volume.\r
 \r
 \r
-  @param PeiServices     Pointer to the PEI Core Services Table.\r
+  @param PeiServices     An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
   @param SectionType     Filter to find only sections of this type.\r
   @param FileHandle      Pointer to the current file to search.\r
   @param SectionData     Pointer to the Section matching SectionType in FfsFileHeader.\r
@@ -681,7 +698,7 @@ PeiFfsFindSectionData (
 /**\r
   search the firmware volumes by index\r
 \r
-  @param PeiServices     The PEI core services table.\r
+  @param PeiServices     An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
   @param Instance        Instance of FV to find\r
   @param VolumeHandle    Pointer to found Volume.\r
 \r
@@ -706,7 +723,7 @@ PeiFvFindNextVolume (
   Initialize the memory services.\r
 \r
 \r
-  @param PrivateData     Add parameter description\r
+  @param PrivateData     PeiCore's private data structure\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
@@ -727,9 +744,9 @@ InitializeMemoryServices (
   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
+  @param PeiServices     An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param MemoryBegin     Start of memory address.\r
+  @param MemoryLength    Length of memory.\r
 \r
   @return EFI_SUCCESS Always success.\r
 \r
@@ -749,10 +766,10 @@ PeiInstallPeiMemory (
   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
+  @param PeiServices               An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\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
@@ -776,9 +793,9 @@ PeiAllocatePages (
   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
+  @param PeiServices        An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\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
@@ -799,14 +816,14 @@ PeiAllocatePool (
   Routine for load image file.\r
 \r
 \r
-  @param PeiServices     - The PEI core services table.\r
-  @param FileHandle      - Pointer to the FFS file header of the image.\r
-  @param EntryPoint      - Pointer to entry point of specified image file for output.\r
-  @param AuthenticationState - Pointer to attestation authentication state of image.\r
+  @param PeiServices            An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param FileHandle             Pointer to the FFS file header of the image.\r
+  @param EntryPoint             Pointer to entry point of specified image file for output.\r
+  @param AuthenticationState    Pointer to attestation authentication state of image.\r
 \r
-  @retval EFI_SUCCESS    - Image is successfully loaded.\r
-  @retval EFI_NOT_FOUND  - Fail to locate necessary PPI\r
-  @retval Others         - Fail to load file.\r
+  @retval EFI_SUCCESS     Image is successfully loaded.\r
+  @retval EFI_NOT_FOUND   Fail to locate necessary PPI\r
+  @retval Others          Fail to load file.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -823,12 +840,12 @@ PeiLoadImage (
   Core version of the Status Code reporter\r
 \r
 \r
-  @param PeiServices     The PEI core services table.\r
-  @param CodeType        Type of Status Code.\r
-  @param Value           Value to output for Status Code.\r
-  @param Instance        Instance Number of this status code.\r
-  @param CallerId        ID of the caller of this status code.\r
-  @param Data            Optional data associated with this status code.\r
+  @param PeiServices            An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param CodeType               Type of Status Code.\r
+  @param Value                  Value to output for Status Code.\r
+  @param Instance               Instance Number of this status code.\r
+  @param CallerId               ID of the caller of this status code.\r
+  @param Data                   Optional data associated with this status code.\r
 \r
   @retval EFI_SUCCESS             if status code is successfully reported\r
   @retval EFI_NOT_AVAILABLE_YET   if StatusCodePpi has not been installed\r
@@ -851,7 +868,7 @@ PeiReportStatusCode (
   Core version of the Reset System\r
 \r
 \r
-  @param PeiServices     - The PEI core services table.\r
+  @param PeiServices                An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
 \r
   @retval EFI_NOT_AVAILABLE_YET     PPI not available yet.\r
   @retval EFI_DEVICE_ERROR          Did not reset system.\r
@@ -873,8 +890,6 @@ PeiResetSystem (
   @param PrivateData     - Pointer to PEI_CORE_INSTANCE.\r
   @param SecCoreData     - Pointer to EFI_SEC_PEI_HAND_OFF.\r
 \r
-  @return NONE\r
-\r
 **/\r
 VOID\r
 PeiInitializeFv (\r
@@ -886,10 +901,9 @@ PeiInitializeFv (
 /**\r
   Process Firmware Volum Information once FvInfoPPI install.\r
 \r
-\r
-  @param PeiServices     - General purpose services available to every PEIM.\r
-  @param NotifyDescriptor EDES_TODO: Add parameter description\r
-  @param Ppi             EDES_TODO: Add parameter description\r
+  @param PeiServices       An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param NotifyDescriptor  Address of the notification descriptor data structure.\r
+  @param Ppi               Address of the PPI that was installed.\r
 \r
   @retval EFI_SUCCESS if the interface could be successfully installed\r
 \r
@@ -908,10 +922,10 @@ FirmwareVolmeInfoPpiNotifyCallback (
   Given the input VolumeHandle, search for the next matching name file.\r
 \r
 \r
-  @param FileName        - File name to search.\r
-  @param VolumeHandle    - The current FV to search.\r
-  @param FileHandle      - Pointer to the file matching name in VolumeHandle.\r
-                         - NULL if file not found\r
+  @param FileName        File name to search.\r
+  @param VolumeHandle    The current FV to search.\r
+  @param FileHandle      Pointer to the file matching name in VolumeHandle.\r
+                         NULL if file not found\r
 \r
   @return EFI_STATUS\r
 \r
@@ -930,8 +944,8 @@ PeiFfsFindFileByName (
   Returns information about a specific file.\r
 \r
 \r
-  @param FileHandle      - The handle to file.\r
-  @param FileInfo        - Pointer to the file information.\r
+  @param FileHandle         The handle to file.\r
+  @param FileInfo           Pointer to the file information.\r
 \r
   @retval EFI_INVALID_PARAMETER Invalid FileHandle or FileInfo.\r
   @retval EFI_SUCCESS           Success to collect file info.\r
@@ -949,8 +963,8 @@ PeiFfsGetFileInfo (
 \r
   Collect information of given Fv Volume.\r
 \r
-  @param VolumeHandle    - The handle to Fv Volume.\r
-  @param VolumeInfo      - The pointer to volume information.\r
+  @param VolumeHandle           The handle to Fv Volume.\r
+  @param VolumeInfo             The pointer to volume information.\r
 \r
   @retval EFI_INVALID_PARAMETER VolumeInfo is NULL\r
   @retval EFI_SUCCESS           Success to collect fv info.\r
@@ -1013,8 +1027,8 @@ PeiFindFileEx (
   Install Pei Load File PPI.\r
 \r
 \r
-  @param PrivateData     - Pointer to PEI_CORE_INSTANCE.\r
-  @param OldCoreData     - Pointer to PEI_CORE_INSTANCE.\r
+  @param PrivateData        Pointer to PEI_CORE_INSTANCE.\r
+  @param OldCoreData        Pointer to PEI_CORE_INSTANCE.\r
 \r
 **/\r
 VOID\r
@@ -1027,7 +1041,7 @@ InitializeImageServices (
 /**\r
   Get Fv image from the FV type file, then install FV INFO ppi, Build FV hob.\r
 \r
-  @param PeiServices          Pointer to the PEI Core Services Table.\r
+  @param PeiServices          An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
   @param FileHandle           File handle of a Fv type file.\r
   @param AuthenticationState  Pointer to attestation authentication state of image.\r
 \r