diff options
| author | lgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-04-09 07:07:50 +0000 |
|---|---|---|
| committer | lgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-04-09 07:07:50 +0000 |
| commit | 504214c4870e9183418014634268ce630eb5332a (patch) | |
| tree | ca283f3d1317f33f0f83e87b92b9e82a4a6f2f10 /MdeModulePkg/Include | |
| parent | 6cc9ca322cdfe8417274e3659437750ee833fb54 (diff) | |
| download | edk2-platforms-504214c4870e9183418014634268ce630eb5332a.tar.xz | |
Add comments and DoxyGen format for these files.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5028 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Include')
| -rw-r--r-- | MdeModulePkg/Include/Guid/AlternateFvBlock.h | 16 | ||||
| -rw-r--r-- | MdeModulePkg/Include/Guid/CapsuleVendor.h | 16 | ||||
| -rw-r--r-- | MdeModulePkg/Include/Guid/PeiPeCoffLoader.h | 101 | ||||
| -rw-r--r-- | MdeModulePkg/Include/Guid/SystemNvDataGuid.h | 18 | ||||
| -rw-r--r-- | MdeModulePkg/Include/Guid/VariableInfo.h | 9 | ||||
| -rw-r--r-- | MdeModulePkg/Include/Library/CapsuleLib.h | 1 | ||||
| -rw-r--r-- | MdeModulePkg/Include/Ppi/FlashMap.h | 32 | ||||
| -rw-r--r-- | MdeModulePkg/Include/Protocol/Capsule.h | 16 | ||||
| -rw-r--r-- | MdeModulePkg/Include/Protocol/CustomizedDecompress.h | 132 | ||||
| -rw-r--r-- | MdeModulePkg/Include/Protocol/EdkDecompress.h | 132 | ||||
| -rw-r--r-- | MdeModulePkg/Include/Protocol/FirmwareVolumeDispatch.h | 6 | ||||
| -rw-r--r-- | MdeModulePkg/Include/Protocol/FvbExtension.h | 33 | ||||
| -rw-r--r-- | MdeModulePkg/Include/Protocol/LoadPe32Image.h | 62 | ||||
| -rw-r--r-- | MdeModulePkg/Include/Protocol/Print.h | 230 | ||||
| -rw-r--r-- | MdeModulePkg/Include/Protocol/TcgPlatform.h | 15 | ||||
| -rw-r--r-- | MdeModulePkg/Include/VariableFormat.h | 6 | ||||
| -rw-r--r-- | MdeModulePkg/Include/WorkingBlockHeader.h | 21 |
17 files changed, 553 insertions, 293 deletions
diff --git a/MdeModulePkg/Include/Guid/AlternateFvBlock.h b/MdeModulePkg/Include/Guid/AlternateFvBlock.h index 5eac2fe620..4ea8a2143d 100644 --- a/MdeModulePkg/Include/Guid/AlternateFvBlock.h +++ b/MdeModulePkg/Include/Guid/AlternateFvBlock.h @@ -1,6 +1,8 @@ -/*++
+/** @file
-Copyright (c) 2006 - 2007, Intel Corporation
+ Tiano Guid used to define the Alternate Firmware Volume Block Guid.
+
+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,15 +11,7 @@ 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:
-
- AlternateFvBlock.h
-
-Abstract:
-
- Tiano Guid used to define the Alternate Firmware Volume Block Guid.
-
---*/
+**/
#ifndef __ALT_FVB_GUID_H__
#define __ALT_FVB_GUID_H__
diff --git a/MdeModulePkg/Include/Guid/CapsuleVendor.h b/MdeModulePkg/Include/Guid/CapsuleVendor.h index 8ac5d0cf46..118e08b5b1 100644 --- a/MdeModulePkg/Include/Guid/CapsuleVendor.h +++ b/MdeModulePkg/Include/Guid/CapsuleVendor.h @@ -1,6 +1,8 @@ -/*++
+/** @file
-Copyright (c) 2006 - 2007, Intel Corporation
+ Capsule update Guid definitions for capsule varialbe and capsule hob.
+
+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,15 +11,7 @@ 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:
-
- CapsuleVendor.h
-
-Abstract:
-
- Capsule update Guid definitions
-
---*/
+**/
#ifndef __EFI_CAPSULE_VENDOR_GUID_H__
#define __EFI_CAPSULE_VENDOR_GUID_H__
diff --git a/MdeModulePkg/Include/Guid/PeiPeCoffLoader.h b/MdeModulePkg/Include/Guid/PeiPeCoffLoader.h index 95ee354277..eaca8e6f23 100644 --- a/MdeModulePkg/Include/Guid/PeiPeCoffLoader.h +++ b/MdeModulePkg/Include/Guid/PeiPeCoffLoader.h @@ -1,21 +1,17 @@ -/*++
+/** @file
+
+ GUID for the PE/COFF Loader APIs shared between SEC, PEI and DXE
-Copyright (c) 2006 - 2007, Intel Corporation
+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
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.
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-Module Name:
- PeiPeCoffLoader.h
-
-Abstract:
- GUID for the PE/COFF Loader APIs shared between PEI and DXE
-
---*/
+**/
#ifndef __PEI_PE_COFF_LOADER_H__
#define __PEI_PE_COFF_LOADER_H__
@@ -30,30 +26,107 @@ Abstract: typedef struct _EFI_PEI_PE_COFF_LOADER_PROTOCOL EFI_PEI_PE_COFF_LOADER_PROTOCOL;
+/**
+ Retrieves information about a PE/COFF image.
+
+ Computes the PeCoffHeaderOffset, ImageAddress, ImageSize, DestinationAddress, CodeView,
+ PdbPointer, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva
+ fields of the ImageContext structure. If ImageContext is NULL, then return RETURN_INVALID_PARAMETER.
+ If the PE/COFF image accessed through the ImageRead service in the ImageContext structure is not
+ a supported PE/COFF image type, then return RETURN_UNSUPPORTED. If any errors occur while
+ computing the fields of ImageContext, then the error status is returned in the ImageError field of
+ ImageContext.
+
+ @param This Pointer to the EFI_PEI_PE_COFF_LOADER_PROTOCOL instance.
+ @param ImageContext Pointer to the image context structure that describes the PE/COFF
+ image that needs to be examined by this function.
+
+ @retval RETURN_SUCCESS The information on the PE/COFF image was collected.
+ @retval RETURN_INVALID_PARAMETER ImageContext is NULL.
+ @retval RETURN_UNSUPPORTED The PE/COFF image is not supported.
+**/
typedef
-EFI_STATUS
+RETURN_STATUS
(EFIAPI *EFI_PEI_PE_COFF_LOADER_GET_IMAGE_INFO) (
IN EFI_PEI_PE_COFF_LOADER_PROTOCOL *This,
IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
);
+/**
+ Loads a PE/COFF image into memory.
+
+ Loads the PE/COFF image accessed through the ImageRead service of ImageContext into the buffer
+ specified by the ImageAddress and ImageSize fields of ImageContext. The caller must allocate
+ the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function.
+ The EntryPoint, FixupDataSize, CodeView, and PdbPointer fields of ImageContext are computed.
+ If ImageContext is NULL, then ASSERT().
+
+ @param This Pointer to the EFI_PEI_PE_COFF_LOADER_PROTOCOL instance.
+ @param ImageContext Pointer to the image context structure that describes the PE/COFF
+ image that is being loaded.
+
+ @retval RETURN_SUCCESS The PE/COFF image was loaded into the buffer specified by
+ the ImageAddress and ImageSize fields of ImageContext.
+ Extended status information is in the ImageError field of ImageContext.
+ @retval RETURN_BUFFER_TOO_SMALL The caller did not provide a large enough buffer.
+ Extended status information is in the ImageError field of ImageContext.
+ @retval RETURN_LOAD_ERROR The PE/COFF image is an EFI Runtime image with no relocations.
+ Extended status information is in the ImageError field of ImageContext.
+ @retval RETURN_INVALID_PARAMETER The image address is invalid.
+ Extended status information is in the ImageError field of ImageContext.
+
+**/
typedef
-EFI_STATUS
+RETURN_STATUS
(EFIAPI *EFI_PEI_PE_COFF_LOADER_LOAD_IMAGE) (
IN EFI_PEI_PE_COFF_LOADER_PROTOCOL *This,
IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
);
+/**
+ Applies relocation fixups to a PE/COFF image that was loaded with PeCoffLoaderLoadImage().
+
+ If the DestinationAddress field of ImageContext is 0, then use the ImageAddress field of
+ ImageContext as the relocation base address. Otherwise, use the DestinationAddress field
+ of ImageContext as the relocation base address. The caller must allocate the relocation
+ fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.
+ If ImageContext is NULL, then ASSERT().
+
+ @param This Pointer to the EFI_PEI_PE_COFF_LOADER_PROTOCOL instance.
+ @param ImageContext Pointer to the image context structure that describes the PE/COFF
+ image that is being relocated.
+
+ @retval RETURN_SUCCESS The PE/COFF image was relocated.
+ Extended status information is in the ImageError field of ImageContext.
+ @retval RETURN_LOAD_ERROR The image in not a valid PE/COFF image.
+ Extended status information is in the ImageError field of ImageContext.
+ @retval RETURN_UNSUPPORTED A relocation record type is not supported.
+ Extended status information is in the ImageError field of ImageContext.
+
+**/
typedef
-EFI_STATUS
+RETURN_STATUS
(EFIAPI *EFI_PEI_PE_COFF_LOADER_RELOCATE_IMAGE) (
IN EFI_PEI_PE_COFF_LOADER_PROTOCOL *This,
IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
);
+/**
+ Unloads a loaded PE/COFF image from memory and releases its taken resource.
+
+ For NT32 emulator, the PE/COFF image loaded by system needs to release.
+ For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded,
+ this function can simply return RETURN_SUCCESS.
+
+ @param This Pointer to the EFI_PEI_PE_COFF_LOADER_PROTOCOL instance.
+ @param ImageContext Pointer to the image context structure that describes the PE/COFF
+ image to be unloaded.
+
+ @retval RETURN_SUCCESS The PE/COFF image was unloaded successfully.
+**/
typedef
-EFI_STATUS
+RETURN_STATUS
(EFIAPI *EFI_PEI_PE_COFF_LOADER_UNLOAD_IMAGE) (
IN EFI_PEI_PE_COFF_LOADER_PROTOCOL *This,
IN PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
diff --git a/MdeModulePkg/Include/Guid/SystemNvDataGuid.h b/MdeModulePkg/Include/Guid/SystemNvDataGuid.h index 946d4d8d03..fd807f93a2 100644 --- a/MdeModulePkg/Include/Guid/SystemNvDataGuid.h +++ b/MdeModulePkg/Include/Guid/SystemNvDataGuid.h @@ -1,6 +1,9 @@ -/*++
+/** @file
-Copyright (c) 2006, Intel Corporation
+ GUIDs used for System Non Volatile HOB entries in the in the HOB list and FV Guids carrying
+ the System specific information.
+
+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,16 +12,7 @@ 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:
-
- SystemNvDataGuid.h
-
-Abstract:
-
- GUIDs used for System Non Volatile HOB entries in the in the HOB list and FV Guids carrying
- the System specific information.
-
---*/
+**/
#ifndef __SYSTEM_NV_DATA_GUID_H__
#define __SYSTEM_NV_DATA_GUID_H__
diff --git a/MdeModulePkg/Include/Guid/VariableInfo.h b/MdeModulePkg/Include/Guid/VariableInfo.h index d6eb734d94..a7e624d90f 100644 --- a/MdeModulePkg/Include/Guid/VariableInfo.h +++ b/MdeModulePkg/Include/Guid/VariableInfo.h @@ -1,6 +1,8 @@ -/*++
+/** @file
-Copyright (c) 2006 - 2007, Intel Corporation
+ GUIDs used for variable list entries put in the EFI system table.
+
+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,8 +11,7 @@ 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.
-
---*/
+**/
#ifndef __VARIABLE_INFO_GUID_H__
#define __VARIABLE_INFO_GUID_H__
diff --git a/MdeModulePkg/Include/Library/CapsuleLib.h b/MdeModulePkg/Include/Library/CapsuleLib.h index 8f411458d1..80df80e628 100644 --- a/MdeModulePkg/Include/Library/CapsuleLib.h +++ b/MdeModulePkg/Include/Library/CapsuleLib.h @@ -1,4 +1,5 @@ /** @file
+
Capsule Library. This library class defines a set of interfaces on
how to process capusle image update.
diff --git a/MdeModulePkg/Include/Ppi/FlashMap.h b/MdeModulePkg/Include/Ppi/FlashMap.h index a2ab3388be..f562f888ad 100644 --- a/MdeModulePkg/Include/Ppi/FlashMap.h +++ b/MdeModulePkg/Include/Ppi/FlashMap.h @@ -1,6 +1,8 @@ -/*++
+/** @file
-Copyright (c) 2006, Intel Corporation
+ FlashMap PPI abstracts access to FlashMap information.
+
+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,17 +11,7 @@ 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:
-
- FlashMap.h
-
-Abstract:
-
- FlashMap PPI defined in Tiano
-
- This code abstracts FlashMap access
-
---*/
+**/
#ifndef _PEI_FLASH_MAP_PPI_H_
#define _PEI_FLASH_MAP_PPI_H_
@@ -30,9 +22,23 @@ Abstract: { 0xf34c2fa0, 0xde88, 0x4270, {0x84, 0x14, 0x96, 0x12, 0x22, 0xf4, 0x52, 0x1c } }
typedef struct _PEI_FLASH_MAP_PPI PEI_FLASH_MAP_PPI;
+
//
// Functions
//
+/**
+ Get flash region information.
+
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to the FlashMap PPI instance
+ @param AreaType Flash Area Type
+ @param AreaTypeGuid Pointer to Guid for Flash Area Type
+ @param NumEntries Pointer to the number of entries for the total flash area.
+ @param Entries Pointer to the entry list.
+
+ @retval EFI_SUCESS Get flash area information successfully.
+ @retval EFI_NOT_FOUND No flash area information is found.
+**/
typedef
EFI_STATUS
(EFIAPI *PEI_GET_FLASH_AREA_INFO) (
diff --git a/MdeModulePkg/Include/Protocol/Capsule.h b/MdeModulePkg/Include/Protocol/Capsule.h index aeeb903473..32b09ea039 100644 --- a/MdeModulePkg/Include/Protocol/Capsule.h +++ b/MdeModulePkg/Include/Protocol/Capsule.h @@ -1,6 +1,8 @@ -/*++
+/** @file
-Copyright (c) 2006 - 2007, Intel Corporation
+ Capsule Architectural Protocol is added to produce UEFI2.0 capsule runtime services.
+
+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,15 +11,7 @@ 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:
-
- Capsule.h
-
-Abstract:
-
- Capsule Architectural Protocol is newly added to produce UEFI2.0 capsule runtime services.
-
---*/
+**/
#ifndef __ARCH_PROTOCOL_CAPSULE_ARCH_H__
#define __ARCH_PROTOCOL_CAPSULE_ARCH_H__
diff --git a/MdeModulePkg/Include/Protocol/CustomizedDecompress.h b/MdeModulePkg/Include/Protocol/CustomizedDecompress.h index bff8d46e88..ca54c67ae3 100644 --- a/MdeModulePkg/Include/Protocol/CustomizedDecompress.h +++ b/MdeModulePkg/Include/Protocol/CustomizedDecompress.h @@ -1,6 +1,8 @@ -/*++
+/** @file
+
+ The user Customized Decompress Protocol Interface
-Copyright (c) 2006, Intel Corporation
+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,13 +11,7 @@ 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:
- CustomizedDecompress.h
-
-Abstract:
- The user Customized Decompress Protocol Interface
-
---*/
+**/
#ifndef __CUSTOMIZED_DECOMPRESS_H__
#define __CUSTOMIZED_DECOMPRESS_H__
@@ -25,18 +21,7 @@ Abstract: typedef struct _EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL;
-typedef
-EFI_STATUS
-(EFIAPI *EFI_CUSTOMIZED_DECOMPRESS_GET_INFO) (
- IN EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL *This,
- IN VOID *Source,
- IN UINT32 SourceSize,
- OUT UINT32 *DestinationSize,
- OUT UINT32 *ScratchSize
- );
-/*++
-
-Routine Description:
+/**
The GetInfo() function retrieves the size of the uncompressed buffer
and the temporary scratch buffer required to decompress the buffer
@@ -53,42 +38,35 @@ Routine Description: output it as DestinationSize. And ScratchSize is specific to the decompression
implementation.
-Arguments:
-
- This - The protocol instance pointer
- Source - The source buffer containing the compressed data.
- SourceSize - The size, in bytes, of source buffer.
- DestinationSize - A pointer to the size, in bytes, of the uncompressed buffer
- that will be generated when the compressed buffer specified
- by Source and SourceSize is decompressed.
- ScratchSize - A pointer to the size, in bytes, of the scratch buffer that
- is required to decompress the compressed buffer specified by
- Source and SourceSize.
-
-Returns:
- EFI_SUCCESS - The size of the uncompressed data was returned in DestinationSize
- and the size of the scratch buffer was returned in ScratchSize.
- EFI_INVALID_PARAMETER - The size of the uncompressed data or the size of the scratch
- buffer cannot be determined from the compressed data specified by
- Source and SourceData.
+ @param This The protocol instance pointer
+ @param Source The source buffer containing the compressed data.
+ @param SourceSize The size, in bytes, of source buffer.
+ @param DestinationSize A pointer to the size, in bytes, of the uncompressed buffer
+ that will be generated when the compressed buffer specified
+ by Source and SourceSize is decompressed.
+ @param ScratchSize A pointer to the size, in bytes, of the scratch buffer that
+ is required to decompress the compressed buffer specified by
+ Source and SourceSize.
+
+ @retval EFI_SUCCESS The size of the uncompressed data was returned in DestinationSize
+ and the size of the scratch buffer was returned in ScratchSize.
+ @retval EFI_INVALID_PARAMETER
+ The size of the uncompressed data or the size of the scratch
+ buffer cannot be determined from the compressed data specified by
+ Source and SourceData.
--*/
-
-
typedef
EFI_STATUS
-(EFIAPI *EFI_CUSTOMIZED_DECOMPRESS_DECOMPRESS) (
- IN EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL *This,
- IN VOID* Source,
- IN UINT32 SourceSize,
- IN OUT VOID* Destination,
- IN UINT32 DestinationSize,
- IN OUT VOID* Scratch,
- IN UINT32 ScratchSize
+(EFIAPI *EFI_CUSTOMIZED_DECOMPRESS_GET_INFO) (
+ IN EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL *This,
+ IN VOID *Source,
+ IN UINT32 SourceSize,
+ OUT UINT32 *DestinationSize,
+ OUT UINT32 *ScratchSize
);
-/*++
-Routine Description:
+/**
The Decompress() function extracts decompressed data to its original form.
@@ -103,29 +81,35 @@ Routine Description: If the compressed source data specified by Source and SourceSize is not in
a valid compressed data format, then EFI_INVALID_PARAMETER is returned.
-Arguments:
-
- This - The protocol instance pointer
- Source - The source buffer containing the compressed data.
- SourceSize - The size of source data.
- Destination - On output, the destination buffer that contains
- the uncompressed data.
- DestinationSize - The size of destination buffer. The size of destination
- buffer needed is obtained from GetInfo().
- Scratch - A temporary scratch buffer that is used to perform the
- decompression.
- ScratchSize - The size of scratch buffer. The size of scratch buffer needed
- is obtained from GetInfo().
-
-Returns:
-
- EFI_SUCCESS - Decompression completed successfully, and the uncompressed
- buffer is returned in Destination.
- EFI_INVALID_PARAMETER
- - The source buffer specified by Source and SourceSize is
- corrupted (not in a valid compressed format).
-
---*/
+ @param This The protocol instance pointer
+ @param Source The source buffer containing the compressed data.
+ @param SourceSize The size of source data.
+ @param Destination On output, the destination buffer that contains
+ the uncompressed data.
+ @param DestinationSize The size of destination buffer. The size of destination
+ buffer needed is obtained from GetInfo().
+ @param Scratch A temporary scratch buffer that is used to perform the
+ decompression.
+ @param ScratchSize The size of scratch buffer. The size of scratch buffer needed
+ is obtained from GetInfo().
+
+ @retval EFI_SUCCESS Decompression completed successfully, and the uncompressed
+ buffer is returned in Destination.
+ @retval EFI_INVALID_PARAMETER
+ The source buffer specified by Source and SourceSize is
+ corrupted (not in a valid compressed format).
+**/
+typedef
+EFI_STATUS
+(EFIAPI *EFI_CUSTOMIZED_DECOMPRESS_DECOMPRESS) (
+ IN EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL *This,
+ IN VOID* Source,
+ IN UINT32 SourceSize,
+ IN OUT VOID* Destination,
+ IN UINT32 DestinationSize,
+ IN OUT VOID* Scratch,
+ IN UINT32 ScratchSize
+ );
struct _EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL {
EFI_CUSTOMIZED_DECOMPRESS_GET_INFO GetInfo;
diff --git a/MdeModulePkg/Include/Protocol/EdkDecompress.h b/MdeModulePkg/Include/Protocol/EdkDecompress.h index ab9b840cf2..fff1e31874 100644 --- a/MdeModulePkg/Include/Protocol/EdkDecompress.h +++ b/MdeModulePkg/Include/Protocol/EdkDecompress.h @@ -1,6 +1,8 @@ -/*++
+/** @file
-Copyright (c) 2006, Intel Corporation
+ The Tiano Decompress Protocol Interface
+
+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,13 +11,7 @@ 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:
- EdkDecompress.h
-
-Abstract:
- The Tiano Decompress Protocol Interface
-
---*/
+**/
#ifndef __EDK_DECOMPRESS_H__
#define __EDK_DECOMPRESS_H__
@@ -25,18 +21,7 @@ Abstract: typedef struct _EFI_TIANO_DECOMPRESS_PROTOCOL EFI_TIANO_DECOMPRESS_PROTOCOL;
-typedef
-EFI_STATUS
-(EFIAPI *EFI_TIANO_DECOMPRESS_GET_INFO) (
- IN EFI_TIANO_DECOMPRESS_PROTOCOL *This,
- IN VOID *Source,
- IN UINT32 SourceSize,
- OUT UINT32 *DestinationSize,
- OUT UINT32 *ScratchSize
- );
-/*++
-
-Routine Description:
+/**
The GetInfo() function retrieves the size of the uncompressed buffer
and the temporary scratch buffer required to decompress the buffer
@@ -53,42 +38,35 @@ Routine Description: output it as DestinationSize. And ScratchSize is specific to the decompression
implementation.
-Arguments:
-
- This - The protocol instance pointer
- Source - The source buffer containing the compressed data.
- SourceSize - The size, in bytes, of source buffer.
- DestinationSize - A pointer to the size, in bytes, of the uncompressed buffer
- that will be generated when the compressed buffer specified
- by Source and SourceSize is decompressed.
- ScratchSize - A pointer to the size, in bytes, of the scratch buffer that
- is required to decompress the compressed buffer specified by
- Source and SourceSize.
-
-Returns:
- EFI_SUCCESS - The size of the uncompressed data was returned in DestinationSize
- and the size of the scratch buffer was returned in ScratchSize.
- EFI_INVALID_PARAMETER - The size of the uncompressed data or the size of the scratch
- buffer cannot be determined from the compressed data specified by
- Source and SourceData.
+ @param This The protocol instance pointer
+ @param Source The source buffer containing the compressed data.
+ @param SourceSize The size, in bytes, of source buffer.
+ @param DestinationSize A pointer to the size, in bytes, of the uncompressed buffer
+ that will be generated when the compressed buffer specified
+ by Source and SourceSize is decompressed.
+ @param ScratchSize A pointer to the size, in bytes, of the scratch buffer that
+ is required to decompress the compressed buffer specified by
+ Source and SourceSize.
+
+ @retval EFI_SUCCESS The size of the uncompressed data was returned in DestinationSize
+ and the size of the scratch buffer was returned in ScratchSize.
+ @retval EFI_INVALID_PARAMETER
+ The size of the uncompressed data or the size of the scratch
+ buffer cannot be determined from the compressed data specified by
+ Source and SourceData.
--*/
-
-
typedef
EFI_STATUS
-(EFIAPI *EFI_TIANO_DECOMPRESS_DECOMPRESS) (
- IN EFI_TIANO_DECOMPRESS_PROTOCOL *This,
- IN VOID* Source,
- IN UINT32 SourceSize,
- IN OUT VOID* Destination,
- IN UINT32 DestinationSize,
- IN OUT VOID* Scratch,
- IN UINT32 ScratchSize
+(EFIAPI *EFI_TIANO_DECOMPRESS_GET_INFO) (
+ IN EFI_TIANO_DECOMPRESS_PROTOCOL *This,
+ IN VOID *Source,
+ IN UINT32 SourceSize,
+ OUT UINT32 *DestinationSize,
+ OUT UINT32 *ScratchSize
);
-/*++
-Routine Description:
+/**
The Decompress() function extracts decompressed data to its original form.
@@ -103,29 +81,35 @@ Routine Description: If the compressed source data specified by Source and SourceSize is not in
a valid compressed data format, then EFI_INVALID_PARAMETER is returned.
-Arguments:
-
- This - The protocol instance pointer
- Source - The source buffer containing the compressed data.
- SourceSize - The size of source data.
- Destination - On output, the destination buffer that contains
- the uncompressed data.
- DestinationSize - The size of destination buffer. The size of destination
- buffer needed is obtained from GetInfo().
- Scratch - A temporary scratch buffer that is used to perform the
- decompression.
- ScratchSize - The size of scratch buffer. The size of scratch buffer needed
- is obtained from GetInfo().
-
-Returns:
-
- EFI_SUCCESS - Decompression completed successfully, and the uncompressed
- buffer is returned in Destination.
- EFI_INVALID_PARAMETER
- - The source buffer specified by Source and SourceSize is
- corrupted (not in a valid compressed format).
-
---*/
+ @param This The protocol instance pointer
+ @param Source The source buffer containing the compressed data.
+ @param SourceSize The size of source data.
+ @param Destination On output, the destination buffer that contains
+ the uncompressed data.
+ @param DestinationSize The size of destination buffer. The size of destination
+ buffer needed is obtained from GetInfo().
+ @param Scratch A temporary scratch buffer that is used to perform the
+ decompression.
+ @param ScratchSize The size of scratch buffer. The size of scratch buffer needed
+ is obtained from GetInfo().
+
+ @retval EFI_SUCCESS Decompression completed successfully, and the uncompressed
+ buffer is returned in Destination.
+ @retval EFI_INVALID_PARAMETER
+ The source buffer specified by Source and SourceSize is
+ corrupted (not in a valid compressed format).
+**/
+typedef
+EFI_STATUS
+(EFIAPI *EFI_TIANO_DECOMPRESS_DECOMPRESS) (
+ IN EFI_TIANO_DECOMPRESS_PROTOCOL *This,
+ IN VOID* Source,
+ IN UINT32 SourceSize,
+ IN OUT VOID* Destination,
+ IN UINT32 DestinationSize,
+ IN OUT VOID* Scratch,
+ IN UINT32 ScratchSize
+ );
struct _EFI_TIANO_DECOMPRESS_PROTOCOL {
EFI_TIANO_DECOMPRESS_GET_INFO GetInfo;
diff --git a/MdeModulePkg/Include/Protocol/FirmwareVolumeDispatch.h b/MdeModulePkg/Include/Protocol/FirmwareVolumeDispatch.h index e976f37693..d8c1e76303 100644 --- a/MdeModulePkg/Include/Protocol/FirmwareVolumeDispatch.h +++ b/MdeModulePkg/Include/Protocol/FirmwareVolumeDispatch.h @@ -13,12 +13,6 @@ 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: FirmwareVolumeDispatch.h
-
- @par Revision Reference:
- This protol will be defined in DXE CIS Spec.
- Version 0.91C.
-
**/
#ifndef __FIRMWARE_VOLUME_DISPATCH_H__
diff --git a/MdeModulePkg/Include/Protocol/FvbExtension.h b/MdeModulePkg/Include/Protocol/FvbExtension.h index 8a85d3d905..e961057f91 100644 --- a/MdeModulePkg/Include/Protocol/FvbExtension.h +++ b/MdeModulePkg/Include/Protocol/FvbExtension.h @@ -1,6 +1,8 @@ -/*++
+/** @file
-Copyright (c) 2006 - 2007, Intel Corporation
+ FVB Extension protocol that extends the FVB Class in a component fashion.
+
+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,15 +11,7 @@ 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:
-
- FvbExtension.h
-
-Abstract:
-
- FVB Extension protocol that extends the FVB Class in a component fashion.
-
---*/
+**/
#ifndef __FVB_EXTENSION_H__
#define __FVB_EXTENSION_H__
@@ -30,6 +24,21 @@ typedef struct _EFI_FVB_EXTENSION_PROTOCOL EFI_FVB_EXTENSION_PROTOCOL; //
// FVB Extension Function Prototypes
//
+/** + Erases and initializes a specified range of a firmware volume
+ + @param[in] This Pointer to the FVB Extension protocol instance + @param[in] StartLba The starting logical block index to be erased + @param[in] OffsetStartLba Offset into the starting block at which to
+ begin erasing + @param[in] LastLba The last logical block index to be erased + @param[in] OffsetLastLba Offset into the last block at which to end erasing + + @retval EFI_EFI_SUCCESS Range was erased + @retval EFI_INVALID_PARAMETER invalid parameter + @retval EFI_UNSUPPORTED Range can not be erased
+ +**/
typedef
EFI_STATUS
(EFIAPI * EFI_FV_ERASE_CUSTOM_BLOCK) (
@@ -41,7 +50,7 @@ EFI_STATUS );
//
-// IPMI TRANSPORT PROTOCOL
+// FVB Extension PROTOCOL
//
struct _EFI_FVB_EXTENSION_PROTOCOL {
EFI_FV_ERASE_CUSTOM_BLOCK EraseFvbCustomBlock;
diff --git a/MdeModulePkg/Include/Protocol/LoadPe32Image.h b/MdeModulePkg/Include/Protocol/LoadPe32Image.h index 155604d5df..8cf58ecdf4 100644 --- a/MdeModulePkg/Include/Protocol/LoadPe32Image.h +++ b/MdeModulePkg/Include/Protocol/LoadPe32Image.h @@ -1,18 +1,5 @@ -/*++
+/** @file
-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.
-
-Module Name:
- LoadPe32Image.h
-
-Abstract:
Load File protocol.
Load file protocol exists to supports the addition of new boot devices,
@@ -21,7 +8,16 @@ Abstract: UEFI 2.0 can boot from any device that produces a LoadFile protocol.
---*/
+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
+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.
+
+**/
#ifndef __LOAD_PE32_IMAGE_H__
#define __LOAD_PE32_IMAGE_H__
@@ -35,6 +31,30 @@ Abstract: typedef struct _EFI_PE32_IMAGE_PROTOCOL EFI_PE32_IMAGE_PROTOCOL;
+/**
+
+ Loads an EFI image into memory and returns a handle to the image with extended parameters.
+
+ @param This Calling context
+ @param ParentImageHandle The caller's image handle.
+ @param FilePath The specific file path from which the image is loaded.
+ @param SourceBuffer If not NULL, a pointer to the memory location containing a copy of
+ the image to be loaded.
+ @param SourceSize The size in bytes of SourceBuffer.
+ @param DstBuffer The buffer to store the image.
+ @param NumberOfPages For input, specifies the space size of the image by caller if not NULL.
+ For output, specifies the actual space size needed.
+ @param ImageHandle Image handle for output.
+ @param EntryPoint Image entry point for output.
+ @param Attribute The bit mask of attributes to set for the load PE image.
+
+ @retval EFI_SUCCESS The image was loaded into memory.
+ @retval EFI_NOT_FOUND The FilePath was not found.
+ @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
+ @retval EFI_UNSUPPORTED The image type is not supported, or the device path cannot be
+ parsed to locate the proper protocol for loading the file.
+ @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient resources.
+**/
typedef
EFI_STATUS
(EFIAPI *LOAD_PE_IMAGE) (
@@ -50,6 +70,18 @@ EFI_STATUS IN UINT32 Attribute
);
+/**
+
+ Unload the specified image.
+
+ @param This Indicates the calling context.
+ @param ImageHandle The specified image handle.
+
+ @retval EFI_INVALID_PARAMETER Image handle is NULL.
+ @retval EFI_UNSUPPORTED Attempt to unload an unsupported image.
+ @retval EFI_SUCCESS Image successfully unloaded.
+
+--*/
typedef
EFI_STATUS
(EFIAPI *UNLOAD_PE_IMAGE) (
diff --git a/MdeModulePkg/Include/Protocol/Print.h b/MdeModulePkg/Include/Protocol/Print.h index b640cb0b2f..4a356f3f7e 100644 --- a/MdeModulePkg/Include/Protocol/Print.h +++ b/MdeModulePkg/Include/Protocol/Print.h @@ -1,6 +1,8 @@ -/*++
+/** @file
-Copyright (c) 2006 - 2007, Intel Corporation
+ This file defines the Print protocol.
+
+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,15 +11,7 @@ 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:
-
- Print.h
-
-Abstract:
-
- This file defines the Print protocol
-
---*/
+**/
#ifndef __PPRINT_H__
#define __PPRINT_H__
@@ -30,7 +24,40 @@ Abstract: //
typedef struct _EFI_PRINT_PROTOCOL EFI_PRINT_PROTOCOL;
-
+/** + Produces a Null-terminated Unicode string in an output buffer based on + a Null-terminated Unicode format string and a VA_LIST argument list + + Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer + and BufferSize. + The Unicode string is produced by parsing the format string specified by FormatString. + Arguments are pulled from the variable argument list specified by Marker based on the + contents of the format string. + The number of Unicode characters in the produced output buffer is returned not including + the Null-terminator. + If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned. + + If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). + If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT(). + If BufferSize > 1 and FormatString is NULL, then ASSERT(). + If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT(). + If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than + PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then + ASSERT(). + If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string + contains more than PcdMaximumUnicodeStringLength Unicode characters not including the + Null-terminator, then ASSERT(). + + @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated + Unicode string. + @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. + @param FormatString Null-terminated Unicode format string. + @param Marker VA_LIST marker for the variable argument list. + + @return The number of Unicode characters in the produced output buffer not including the + Null-terminator. + +**/
typedef
UINTN
(EFIAPI *UNI_VSPRINT) (
@@ -40,6 +67,39 @@ UINTN IN VA_LIST Marker
);
+/** + Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated + ASCII format string and a VA_LIST argument list + + Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer + and BufferSize. + The Unicode string is produced by parsing the format string specified by FormatString. + Arguments are pulled from the variable argument list specified by Marker based on the + contents of the format string. + The number of Unicode characters in the produced output buffer is returned not including + the Null-terminator. + If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned. + + If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT(). + If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT(). + If BufferSize > 1 and FormatString is NULL, then ASSERT(). + If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than + PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then + ASSERT(). + If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string + contains more than PcdMaximumUnicodeStringLength Unicode characters not including the + Null-terminator, then ASSERT(). + + @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated + Unicode string. + @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. + @param FormatString Null-terminated Unicode format string. + @param Marker VA_LIST marker for the variable argument list. + + @return The number of Unicode characters in the produced output buffer not including the + Null-terminator. + +**/
typedef
UINTN (EFIAPI *UNI_VSPRINT_ASCII) ( @@ -49,6 +109,47 @@ UINTN IN VA_LIST Marker );
+/** + Converts a decimal value to a Null-terminated Unicode string. + + Converts the decimal number specified by Value to a Null-terminated Unicode + string specified by Buffer containing at most Width characters. No padding of spaces + is ever performed. If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed. + The number of Unicode characters in Buffer is returned not including the Null-terminator. + If the conversion contains more than Width characters, then only the first + Width characters are returned, and the total number of characters + required to perform the conversion is returned. + Additional conversion parameters are specified in Flags. + + The Flags bit LEFT_JUSTIFY is always ignored. + All conversions are left justified in Buffer. + If Width is 0, PREFIX_ZERO is ignored in Flags. + If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas + are inserted every 3rd digit starting from the right. + If HEX_RADIX is set in Flags, then the output buffer will be + formatted in hexadecimal format. + If Value is < 0 and HEX_RADIX is not set in Flags, then the fist character in Buffer is a '-'. + If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, + then Buffer is padded with '0' characters so the combination of the optional '-' + sign character, '0' characters, digit characters for Value, and the Null-terminator + add up to Width characters. + If both COMMA_TYPE and HEX_RADIX are set in Flags, then ASSERT(). + If Buffer is NULL, then ASSERT(). + If Buffer is not aligned on a 16-bit boundary, then ASSERT(). + If unsupported bits are set in Flags, then ASSERT(). + If both COMMA_TYPE and HEX_RADIX are set in Flags, then ASSERT(). + If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT() + + @param Buffer Pointer to the output buffer for the produced Null-terminated + Unicode string. + @param Flags The bitmask of flags that specify left justification, zero pad, and commas. + @param Value The 64-bit signed value to convert to a string. + @param Width The maximum number of Unicode characters to place in Buffer, not including + the Null-terminator. + + @return The number of Unicode characters in Buffer not including the Null-terminator. + +**/
typedef
UINTN (EFIAPI *VALUE_TO_UNISTRING) ( @@ -58,6 +159,38 @@ UINTN IN UINTN Width );
+/** + Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated + ASCII format string and a VA_LIST argument list. + + Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer + and BufferSize. + The ASCII string is produced by parsing the format string specified by FormatString. + Arguments are pulled from the variable argument list specified by Marker based on + the contents of the format string. + The number of ASCII characters in the produced output buffer is returned not including + the Null-terminator. + If BufferSize is 0, then no output buffer is produced and 0 is returned. + + If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). + If BufferSize > 0 and FormatString is NULL, then ASSERT(). + If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than + PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then + ASSERT(). + If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string + contains more than PcdMaximumAsciiStringLength ASCII characters not including the + Null-terminator, then ASSERT(). + + @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated + ASCII string. + @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. + @param FormatString Null-terminated Unicode format string. + @param Marker VA_LIST marker for the variable argument list. + + @return The number of ASCII characters in the produced output buffer not including the + Null-terminator. + +**/
typedef
UINTN (EFIAPI *ASCII_VSPRINT) ( @@ -67,6 +200,39 @@ UINTN IN VA_LIST Marker );
+/** + Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated + ASCII format string and a VA_LIST argument list. + + Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer + and BufferSize. + The ASCII string is produced by parsing the format string specified by FormatString. + Arguments are pulled from the variable argument list specified by Marker based on + the contents of the format string. + The number of ASCII characters in the produced output buffer is returned not including + the Null-terminator. + If BufferSize is 0, then no output buffer is produced and 0 is returned. + + If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT(). + If BufferSize > 0 and FormatString is NULL, then ASSERT(). + If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT(). + If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than + PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then + ASSERT(). + If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string + contains more than PcdMaximumAsciiStringLength ASCII characters not including the + Null-terminator, then ASSERT(). + + @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated + ASCII string. + @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. + @param FormatString Null-terminated Unicode format string. + @param Marker VA_LIST marker for the variable argument list. + + @return The number of ASCII characters in the produced output buffer not including the + Null-terminator. + +**/
typedef
UINTN (EFIAPI *ASCII_VSPRINT_UNI) ( @@ -76,6 +242,46 @@ UINTN IN VA_LIST Marker );
+/** + Converts a decimal value to a Null-terminated ASCII string. + + Converts the decimal number specified by Value to a Null-terminated ASCII string + specified by Buffer containing at most Width characters. No padding of spaces + is ever performed. + If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed. + The number of ASCII characters in Buffer is returned not including the Null-terminator. + If the conversion contains more than Width characters, then only the first Width + characters are returned, and the total number of characters required to perform + the conversion is returned. + Additional conversion parameters are specified in Flags. + The Flags bit LEFT_JUSTIFY is always ignored. + All conversions are left justified in Buffer. + If Width is 0, PREFIX_ZERO is ignored in Flags. + If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas + are inserted every 3rd digit starting from the right. + If HEX_RADIX is set in Flags, then the output buffer will be + formatted in hexadecimal format. + If Value is < 0 and HEX_RADIX is not set in Flags, then the fist character in Buffer is a '-'. + If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, + then Buffer is padded with '0' characters so the combination of the optional '-' + sign character, '0' characters, digit characters for Value, and the Null-terminator + add up to Width characters. + + If Buffer is NULL, then ASSERT(). + If unsupported bits are set in Flags, then ASSERT(). + If both COMMA_TYPE and HEX_RADIX are set in Flags, then ASSERT(). + If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT() + + @param Buffer Pointer to the output buffer for the produced Null-terminated + ASCII string. + @param Flags The bitmask of flags that specify left justification, zero pad, and commas. + @param Value The 64-bit signed value to convert to a string. + @param Width The maximum number of ASCII characters to place in Buffer, not including + the Null-terminator. + + @return The number of ASCII characters in Buffer not including the Null-terminator. + +**/
typedef
UINTN (EFIAPI *VALUE_TO_ASCIISTRING) ( diff --git a/MdeModulePkg/Include/Protocol/TcgPlatform.h b/MdeModulePkg/Include/Protocol/TcgPlatform.h index 20f8075e65..a1f8c43725 100644 --- a/MdeModulePkg/Include/Protocol/TcgPlatform.h +++ b/MdeModulePkg/Include/Protocol/TcgPlatform.h @@ -1,6 +1,8 @@ -/*++
+/** @file
-Copyright (c) 2006, Intel Corporation
+ Tcg addtional services to measure PeImage and ActionString
+
+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,14 +11,7 @@ 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:
-
- TcgPlatform.h
-
-Abstract:
- Tcg addtional services to measure PeImage and ActionString
-
---*/
+**/
#ifndef _TCG_PLATFORM_PROTOCOL_H_
#define _TCG_PLATFORM_PROTOCOL_H_
diff --git a/MdeModulePkg/Include/VariableFormat.h b/MdeModulePkg/Include/VariableFormat.h index bdc33ecb54..15b48eb8e5 100644 --- a/MdeModulePkg/Include/VariableFormat.h +++ b/MdeModulePkg/Include/VariableFormat.h @@ -67,6 +67,9 @@ typedef enum { #pragma pack(1)
+//
+// Variable Store region header
+//
typedef struct {
UINT32 Signature;
UINT32 Size;
@@ -76,6 +79,9 @@ typedef struct { UINT32 Reserved1;
} VARIABLE_STORE_HEADER;
+//
+// Variable header structure
+//
typedef struct {
UINT16 StartId;
UINT8 State;
diff --git a/MdeModulePkg/Include/WorkingBlockHeader.h b/MdeModulePkg/Include/WorkingBlockHeader.h index fc023ffe69..3946b45a96 100644 --- a/MdeModulePkg/Include/WorkingBlockHeader.h +++ b/MdeModulePkg/Include/WorkingBlockHeader.h @@ -1,6 +1,10 @@ -/*++
+/** @file
-Copyright (c) 2006, Intel Corporation
+ Defines data structure that is the headers found at the runtime
+ updatable firmware volumes.
+ The header structure of FTW working block region.
+
+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,18 +13,7 @@ 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:
-
- EfiWorkingBlockHeader.h
-
-Abstract:
-
- Defines data structure that is the headers found at the runtime
- updatable firmware volumes, such as the FileSystemGuid of the
- working block, the header structure of the variable block, FTW
- working block, or event log block.
-
---*/
+**/
#ifndef __EFI_WORKING_BLOCK_HEADER_H__
#define __EFI_WORKING_BLOCK_HEADER_H__
|