diff options
Diffstat (limited to 'MdeModulePkg/Include')
-rw-r--r-- | MdeModulePkg/Include/Guid/CapsuleVendor.h | 21 | ||||
-rw-r--r-- | MdeModulePkg/Include/Library/CapsuleLib.h | 13 | ||||
-rw-r--r-- | MdeModulePkg/Include/Library/RecoveryLib.h | 4 | ||||
-rw-r--r-- | MdeModulePkg/Include/Library/S3Lib.h | 2 |
4 files changed, 21 insertions, 19 deletions
diff --git a/MdeModulePkg/Include/Guid/CapsuleVendor.h b/MdeModulePkg/Include/Guid/CapsuleVendor.h index 5bbccd3652..b326018c49 100644 --- a/MdeModulePkg/Include/Guid/CapsuleVendor.h +++ b/MdeModulePkg/Include/Guid/CapsuleVendor.h @@ -1,7 +1,8 @@ /** @file
- This file defines capsule update guid, capsule variable name and
- capsule guid hob data structure, which are required by capsule update feature.
+ This file defines capsule vendor guid, capsule variable name
+ and capsule guid hob data structure.
+ They are used by EDKII implementation of capsule update across a system reset.
Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials
@@ -18,9 +19,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define __EFI_CAPSULE_VENDOR_GUID_H__
///
-/// This guid is used as a variable GUID (depending on implementation)
-/// for the capsule variable if the capsule pointer is passes through reset
-/// via a variable.
+/// This guid is used as a variable GUID for the capsule variable
+/// if the capsule pointer is passed through reset via a variable.
+///
+/// This guid is also used as a hob GUID for the capsule data
+/// when the capsule pointer is passed from PEI phase to DXE phase.
///
#define EFI_CAPSULE_VENDOR_GUID \
{ 0x711C703F, 0xC285, 0x4B10, { 0xA3, 0xB0, 0x36, 0xEC, 0xBD, 0x3C, 0x8B, 0xE2 } }
@@ -30,14 +33,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. ///
#define EFI_CAPSULE_VARIABLE_NAME L"CapsuleUpdateData"
-extern EFI_GUID gEfiCapsuleVendorGuid;
-
///
/// Data structure of capsule guid hob entry
///
typedef struct {
- EFI_PHYSICAL_ADDRESS BaseAddress; /// Capsule data start address
- UINT32 Length; /// Length of capsule data.
+ EFI_PHYSICAL_ADDRESS BaseAddress; ///> Capsule data start address
+ UINT32 Length; ///> Length of capsule data.
} CAPSULE_HOB_INFO;
+extern EFI_GUID gEfiCapsuleVendorGuid;
+
#endif // #ifndef _EFI_CAPSULE_VENDOR_GUID_H_
diff --git a/MdeModulePkg/Include/Library/CapsuleLib.h b/MdeModulePkg/Include/Library/CapsuleLib.h index 3bbc8c03c4..662e4def95 100644 --- a/MdeModulePkg/Include/Library/CapsuleLib.h +++ b/MdeModulePkg/Include/Library/CapsuleLib.h @@ -1,9 +1,8 @@ /** @file
- Capsule Library. This library class defines a set of interfaces on
- how to process capusle image update.
+ This library class defines a set of interfaces on how to process capusle image update.
- Copyright (c) 2007, Intel Corporation
+ Copyright (c) 2007 - 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
@@ -18,7 +17,8 @@ #define __CAPSULE_LIB_H__
/**
- Those capsules supported by the firmwares.
+ The firmware checks whether the capsule image is supported
+ by the CapsuleGuid in CapsuleHeader or other specific information in capsule image.
@param CapsuleHeader Point to the UEFI capsule image to be checked.
@@ -32,7 +32,8 @@ SupportCapsuleImage ( );
/**
- The firmware implements to process the capsule image.
+ The firmware specific implementation processes the capsule image
+ if it recognized the format of this capsule image.
@param CapsuleHeader Point to the UEFI capsule image to be processed.
@@ -46,5 +47,3 @@ ProcessCapsuleImage ( );
#endif
-
-
diff --git a/MdeModulePkg/Include/Library/RecoveryLib.h b/MdeModulePkg/Include/Library/RecoveryLib.h index fc0413656d..a724c9ed28 100644 --- a/MdeModulePkg/Include/Library/RecoveryLib.h +++ b/MdeModulePkg/Include/Library/RecoveryLib.h @@ -1,5 +1,5 @@ /** @file
- Recovery Library. This library class defines a set of methods related recovery mode.
+ Recovery library class defines a set of methods related recovery boot mode.
Copyright (c) 2005 - 2008, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
@@ -16,7 +16,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define __RECOVERY_LIB_H__
/**
- Calling this function causes the system do recovery.
+ Calling this function causes the system do recovery boot path.
@retval EFI_SUCESS Sucess to do recovery.
@retval Others Fail to do recovery.
diff --git a/MdeModulePkg/Include/Library/S3Lib.h b/MdeModulePkg/Include/Library/S3Lib.h index 8e2a25d14f..c8fa22aaba 100644 --- a/MdeModulePkg/Include/Library/S3Lib.h +++ b/MdeModulePkg/Include/Library/S3Lib.h @@ -1,5 +1,5 @@ /** @file
- S3 Library. This library class defines a set of methods related do S3 mode.
+ S3 library class defines a set of methods related do S3 boot mode.
Copyright (c) 2005 - 2008, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
|