diff options
| author | klu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-07-16 09:40:06 +0000 |
|---|---|---|
| committer | klu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-07-16 09:40:06 +0000 |
| commit | b1f6a7c636fca9eda65a3045302de577c00e438d (patch) | |
| tree | 5481174a3895d15055e130b5d03502912e669989 /MdeModulePkg/Core/Pei/BootMode | |
| parent | e94358a3fe824986cfaa777690170f26aa5a8200 (diff) | |
| download | edk2-platforms-b1f6a7c636fca9eda65a3045302de577c00e438d.tar.xz | |
Fix function comment to follows doxygen format.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5499 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Core/Pei/BootMode')
| -rw-r--r-- | MdeModulePkg/Core/Pei/BootMode/BootMode.c | 76 |
1 files changed, 28 insertions, 48 deletions
diff --git a/MdeModulePkg/Core/Pei/BootMode/BootMode.c b/MdeModulePkg/Core/Pei/BootMode/BootMode.c index afa3c89ebc..eac541d574 100644 --- a/MdeModulePkg/Core/Pei/BootMode/BootMode.c +++ b/MdeModulePkg/Core/Pei/BootMode/BootMode.c @@ -1,6 +1,11 @@ /** @file
-
-Copyright (c) 2006, Intel Corporation
+ This module provide function for ascertaining and updating the boot mode:
+ GetBootMode()
+ SetBootMode()
+ See PI Speicifcation volume I, chapter 9 Boot Paths for addtional information
+ on the boot mode.
+
+Copyright (c) 2006 - 2008, 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
@@ -9,47 +14,28 @@ 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.
-Module Name:
-
- BootMode.c
-
-Abstract:
+**/
- EFI PEI Core Boot Mode services
+#include <PeiMain.h>
+/**
+ This service enables PEIMs to ascertain the present value of the boot mode.
+ @param PeiServices The PEI core services table.
+ @param BootMode A pointer to contain the value of the boot mode.
-Revision History
+ @retval EFI_SUCCESS The boot mode was returned successfully.
+ @retval EFI_INVALID_PARAMETER BootMode is NULL.
**/
-
-#include <PeiMain.h>
-
EFI_STATUS
EFIAPI
PeiGetBootMode (
- IN CONST EFI_PEI_SERVICES **PeiServices,
- OUT EFI_BOOT_MODE *BootMode
+ IN CONST EFI_PEI_SERVICES **PeiServices,
+ 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;
@@ -68,28 +54,22 @@ Returns: }
+/**
+ This service enables PEIMs to update the boot mode variable.
+
+
+ @param PeiServices - The PEI core services table.
+ @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;
EFI_HOB_HANDOFF_INFO_TABLE *HandOffHob;
|