X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdeModulePkg%2FCore%2FPei%2FBootMode%2FBootMode.c;h=af7d8b1058726645c322d2e80ff78f22a069f899;hb=d1102dba7210b95e41d06c2338a22ba6af248645;hp=fbfd02f84c40091a2806c4d942b0fc13fea4cf9c;hpb=0c2b5da80e9551286cd02a92d91090290ae2d816;p=mirror_edk2.git

diff --git a/MdeModulePkg/Core/Pei/BootMode/BootMode.c b/MdeModulePkg/Core/Pei/BootMode/BootMode.c
index fbfd02f84c..af7d8b1058 100644
--- a/MdeModulePkg/Core/Pei/BootMode/BootMode.c
+++ b/MdeModulePkg/Core/Pei/BootMode/BootMode.c
@@ -1,55 +1,41 @@
-/*++
+/** @file
+  This module provide function for ascertaining and updating the boot mode:
+  GetBootMode()
+  SetBootMode()
+  See PI Specification volume I, chapter 9 Boot Paths for additional information
+  on the boot mode.
 
-Copyright (c) 2006, Intel Corporation                                                         
-All rights reserved. This program and the accompanying materials                          
-are licensed and made available under the terms and conditions of the BSD License         
-which accompanies this distribution.  The full text of the license may be found at        
-http://opensource.org/licenses/bsd-license.php                                            
-                                                                                          
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
+This program and the accompanying materials
+are licensed and made available under the terms and conditions of the BSD License
+which accompanies this distribution.  The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php
 
-Module Name:
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
-  BootMode.c
+**/
 
-Abstract:
+#include "PeiMain.h"
 
-  EFI PEI Core Boot Mode services
+/**
+  This service enables PEIMs to ascertain the present value of the boot mode.
 
+  @param PeiServices            An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
+  @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.
 
-Revision History
-
---*/
-
-#include <PeiMain.h>
-
+**/
 EFI_STATUS
 EFIAPI
 PeiGetBootMode (
-  IN CONST EFI_PEI_SERVICES  **PeiServices,
-  OUT EFI_BOOT_MODE          *BootMode
+  IN  CONST EFI_PEI_SERVICES  **PeiServices,
+  IN  OUT   EFI_BOOT_MODE     *BootMode
   )
-/*++
-
-Routine Description:
-
-  This service enables PEIMs to ascertain the present value of the boot mode.  
-
-Arguments:
-
-  PeiServices    - The PEI core services table.
-  BootMode       - A pointer to contain the value of the boot mode. 
-
-Returns:
-
-  EFI_SUCCESS           - The boot mode was returned successfully.
-  EFI_INVALID_PARAMETER - BootMode is NULL.
-
---*/
 {
-  PEI_CORE_INSTANCE                    *PrivateData;    
+  PEI_CORE_INSTANCE             *PrivateData;
   EFI_HOB_HANDOFF_INFO_TABLE    *HandOffHob;
 
 
@@ -58,49 +44,43 @@ Returns:
   }
 
   PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS(PeiServices);
-  
+
   HandOffHob  = (PrivateData->HobList.HandoffInformationTable);
-  
+
   *BootMode   = HandOffHob->BootMode;
-  
 
-  return EFI_SUCCESS;   
+
+  return EFI_SUCCESS;
 }
 
 
+/**
+  This service enables PEIMs to update the boot mode variable.
+
+
+  @param PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
+  @param BootMode         The value of the boot mode to set.
+
+  @return EFI_SUCCESS     The value was successfully updated
+
+**/
 EFI_STATUS
 EFIAPI
 PeiSetBootMode (
   IN CONST EFI_PEI_SERVICES  **PeiServices,
   IN EFI_BOOT_MODE           BootMode
   )
-/*++
-
-Routine Description:
-
-  This service enables PEIMs to update the boot mode variable.    
-
-Arguments:
-
-  PeiServices    - The PEI core services table.
-  BootMode       - The value of the boot mode to set.
-
-Returns:
-
-  EFI_SUCCESS    - The value was successfully updated
-
---*/
 {
-  PEI_CORE_INSTANCE                    *PrivateData;    
+  PEI_CORE_INSTANCE                    *PrivateData;
   EFI_HOB_HANDOFF_INFO_TABLE    *HandOffHob;
 
 
   PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS(PeiServices);
-  
+
   HandOffHob  = (PrivateData->HobList.HandoffInformationTable);
-  
+
   HandOffHob->BootMode = BootMode;
 
 
-  return EFI_SUCCESS;   
+  return EFI_SUCCESS;
 }