diff options
| author | lgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-07-08 13:29:42 +0000 |
|---|---|---|
| committer | lgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-07-08 13:29:42 +0000 |
| commit | 5f597758e20f046a7a76e728370b99308cf2c8a0 (patch) | |
| tree | 749e4d98131de9bc655860cf2a715d8b9cc75703 /MdeModulePkg/Include/Protocol | |
| parent | 78c2ffb5a7172b9c5fbef15b5edc7aae3de5d4f2 (diff) | |
| download | edk2-5f597758e20f046a7a76e728370b99308cf2c8a0.zip edk2-5f597758e20f046a7a76e728370b99308cf2c8a0.tar.gz edk2-5f597758e20f046a7a76e728370b99308cf2c8a0.tar.bz2 | |
Code scrube for MdeModule Definitions.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5428 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Include/Protocol')
18 files changed, 153 insertions, 521 deletions
diff --git a/MdeModulePkg/Include/Protocol/Capsule.h b/MdeModulePkg/Include/Protocol/Capsule.h index 32b09ea..7c8e258 100644 --- a/MdeModulePkg/Include/Protocol/Capsule.h +++ b/MdeModulePkg/Include/Protocol/Capsule.h @@ -1,6 +1,7 @@ /** @file
- Capsule Architectural Protocol is added to produce UEFI2.0 capsule runtime services.
+ Capsule Architectural Protocol is responsible to tag UEFI2.0 capsule runtime services
+ are ready in EFI_RUNTIME_SERVICES.
Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials
diff --git a/MdeModulePkg/Include/Protocol/ConsoleControl.h b/MdeModulePkg/Include/Protocol/ConsoleControl.h index 75de391..5b3eb0d 100644 --- a/MdeModulePkg/Include/Protocol/ConsoleControl.h +++ b/MdeModulePkg/Include/Protocol/ConsoleControl.h @@ -1,6 +1,8 @@ -/*++
+/** @file
-Copyright (c) 2006 - 2007, Intel Corporation
+ This protocol provides the interfaces to Get/Set the current video mode for GOP/UGA screen
+
+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:
-
- ConsoleControl.h
-
-Abstract:
-
- Abstraction of a Text mode or GOP/UGA screen
-
---*/
+**/
#ifndef __CONSOLE_CONTROL_H__
#define __CONSOLE_CONTROL_H__
@@ -34,7 +28,20 @@ typedef enum { EfiConsoleControlScreenMaxValue
} EFI_CONSOLE_CONTROL_SCREEN_MODE;
+/**
+ Return the current video mode information. Also returns info about existence
+ of Graphics Output devices or UGA Draw devices in system, and if the Std In device is locked. All the
+ arguments are optional and only returned if a non NULL pointer is passed in.
+
+ @param This Protocol instance pointer.
+ @param Mode Are we in text of grahics mode.
+ @param GopExists TRUE if GOP Spliter has found a GOP/UGA device
+ @param StdInLocked TRUE if StdIn device is keyboard locked
+ @retval EFI_SUCCESS Video mode information is returned.
+ @retval EFI_INVALID_PARAMETER Invalid parameters if Mode == NULL.
+
+**/
typedef
EFI_STATUS
(EFIAPI *EFI_CONSOLE_CONTROL_PROTOCOL_GET_MODE) (
@@ -43,74 +50,43 @@ EFI_STATUS OUT BOOLEAN *GopUgaExists, OPTIONAL
OUT BOOLEAN *StdInLocked OPTIONAL
)
-/*++
-
- Routine Description:
- Return the current video mode information. Also returns info about existence
- of Graphics Output devices or UGA Draw devices in system, and if the Std In
- device is locked. All the arguments are optional and only returned if a non
- NULL pointer is passed in.
-
- Arguments:
- This - Protocol instance pointer.
- Mode - Are we in text of grahics mode.
- GopUgaExists - TRUE if Console Spliter has found a GOP or UGA device
- StdInLocked - TRUE if StdIn device is keyboard locked
+;
- Returns:
- EFI_SUCCESS - Mode information returned.
+/**
+ Set the current video mode to either text or graphics.
---*/
-;
+ @param This Protocol instance pointer.
+ @param Mode Mode is to be set.
+ @retval EFI_SUCCESS Mode is set.
+ @retval EFI_INVALID_PARAMETER Mode is not the valid mode value.
+ @retval EFI_UNSUPPORTED Mode is unsupported by console device.
+**/
typedef
EFI_STATUS
(EFIAPI *EFI_CONSOLE_CONTROL_PROTOCOL_SET_MODE) (
IN EFI_CONSOLE_CONTROL_PROTOCOL *This,
OUT EFI_CONSOLE_CONTROL_SCREEN_MODE Mode
)
-/*++
-
- Routine Description:
- Set the current mode to either text or graphics. Graphics is
- for Quiet Boot.
-
- Arguments:
- This - Protocol instance pointer.
- Mode - Mode to set the
-
- Returns:
- EFI_SUCCESS - Mode information returned.
-
---*/
;
+/**
+ Copy the Password and enable state variable and then arm the periodic timer
+
+ @retval EFI_SUCCESS Lock the StdIn device
+ @retval EFI_INVALID_PARAMETER Password is NULL
+ @retval EFI_OUT_OF_RESOURCES Buffer allocation to store the big password fails
+**/
typedef
EFI_STATUS
(EFIAPI *EFI_CONSOLE_CONTROL_PROTOCOL_LOCK_STD_IN) (
IN EFI_CONSOLE_CONTROL_PROTOCOL *This,
IN CHAR16 *Password
)
-/*++
-
- Routine Description:
- Lock Std In devices until Password is typed.
-
- Arguments:
- This - Protocol instance pointer.
- Password - Password needed to unlock screen. NULL means unlock keyboard
-
- Returns:
- EFI_SUCCESS - Mode information returned.
- EFI_DEVICE_ERROR - Std In not locked
-
---*/
;
-
-
struct _EFI_CONSOLE_CONTROL_PROTOCOL {
EFI_CONSOLE_CONTROL_PROTOCOL_GET_MODE GetMode;
EFI_CONSOLE_CONTROL_PROTOCOL_SET_MODE SetMode;
diff --git a/MdeModulePkg/Include/Protocol/Crc32GuidedSectionExtraction.h b/MdeModulePkg/Include/Protocol/Crc32GuidedSectionExtraction.h index 6ef3b22..389d53c 100644 --- a/MdeModulePkg/Include/Protocol/Crc32GuidedSectionExtraction.h +++ b/MdeModulePkg/Include/Protocol/Crc32GuidedSectionExtraction.h @@ -1,10 +1,11 @@ /** @file
- This protocol implements a FV section extraction using a CRC32 encapsulation.
- The GUID defins the encapsulation scheme and the data structures come from
- the SectionExtraction protocol definition.
+ This file can define the different guids to specify the different
+ encapsulation scheme for the guided section.
+ Now, only one guid is defined for CRC32 encapsulation scheme.
+ The related data structures come from the SectionExtraction protocol definition.
- 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
@@ -28,11 +29,6 @@ { 0xFC1BCDB0, 0x7D31, 0x49aa, {0x93, 0x6A, 0xA4, 0x60, 0x0D, 0x9D, 0xD0, 0x83 } }
//
-// Forward reference for pure ANSI compatability
-//
-typedef struct _EFI_CRC32_GUIDED_SECTION_EXTRACTION_PROTOCOL EFI_CRC32_GUID_SECTION_EXTRACTION_PROTOCOL;
-
-//
// The data structures are the same as GuidedSectionExtraction protocol only the GUID's are different
//
#include <Protocol/GuidedSectionExtraction.h>
diff --git a/MdeModulePkg/Include/Protocol/CustomizedDecompress.h b/MdeModulePkg/Include/Protocol/CustomizedDecompress.h deleted file mode 100644 index ca54c67..0000000 --- a/MdeModulePkg/Include/Protocol/CustomizedDecompress.h +++ /dev/null @@ -1,121 +0,0 @@ -/** @file
-
- The user Customized 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
-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 __CUSTOMIZED_DECOMPRESS_H__
-#define __CUSTOMIZED_DECOMPRESS_H__
-
-#define EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL_GUID \
- { 0x9a44198e, 0xa4a2, 0x44e6, {0x8a, 0x1f, 0x39, 0xbe, 0xfd, 0xac, 0x89, 0x6f } }
-
-typedef struct _EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL;
-
-/**
-
- The GetInfo() function retrieves the size of the uncompressed buffer
- and the temporary scratch buffer required to decompress the buffer
- specified by Source and SourceSize. If the size of the uncompressed
- buffer or the size of the scratch buffer cannot be determined from
- the compressed data specified by Source and SourceData, then
- EFI_INVALID_PARAMETER is returned. Otherwise, the size of the uncompressed
- buffer is returned in DestinationSize, the size of the scratch buffer is
- returned in ScratchSize, and EFI_SUCCESS is returned.
-
- The GetInfo() function does not have scratch buffer available to perform
- a thorough checking of the validity of the source data. It just retrieves
- the 'Original Size' field from the beginning bytes of the source data and
- output it as DestinationSize. And ScratchSize is specific to the decompression
- implementation.
-
- @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_GET_INFO) (
- IN EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL *This,
- IN VOID *Source,
- IN UINT32 SourceSize,
- OUT UINT32 *DestinationSize,
- OUT UINT32 *ScratchSize
- );
-
-/**
-
- The Decompress() function extracts decompressed data to its original form.
-
- This protocol is designed so that the decompression algorithm can be
- implemented without using any memory services. As a result, the
- Decompress() function is not allowed to call AllocatePool() or
- AllocatePages() in its implementation. It is the caller's responsibility
- to allocate and free the Destination and Scratch buffers.
-
- If the compressed source data specified by Source and SourceSize is
- sucessfully decompressed into Destination, then EFI_SUCCESS is returned.
- If the compressed source data specified by Source and SourceSize is not in
- a valid compressed data format, then EFI_INVALID_PARAMETER is returned.
-
- @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;
- EFI_CUSTOMIZED_DECOMPRESS_DECOMPRESS Decompress;
-};
-
-extern EFI_GUID gEfiCustomizedDecompressProtocolGuid;
-
-#endif
diff --git a/MdeModulePkg/Include/Protocol/Dpc.h b/MdeModulePkg/Include/Protocol/Dpc.h index e095f84..a93ac24 100644 --- a/MdeModulePkg/Include/Protocol/Dpc.h +++ b/MdeModulePkg/Include/Protocol/Dpc.h @@ -1,6 +1,8 @@ -/*++
+/** @file
-Copyright (c) 2007, Intel Corporation
+ EFI Deferred Procedure Call Protocol
+
+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
@@ -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:
-
- Dpc.h
-
-Abstract:
-
- EFI Deferred Procedure Call Protocol
-
-Revision History
-
---*/
+**/
#ifndef __DPC_H__
diff --git a/MdeModulePkg/Include/Protocol/EdkDecompress.h b/MdeModulePkg/Include/Protocol/EdkDecompress.h deleted file mode 100644 index fff1e31..0000000 --- a/MdeModulePkg/Include/Protocol/EdkDecompress.h +++ /dev/null @@ -1,121 +0,0 @@ -/** @file
-
- 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
-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 __EDK_DECOMPRESS_H__
-#define __EDK_DECOMPRESS_H__
-
-#define EFI_TIANO_DECOMPRESS_PROTOCOL_GUID \
- { 0xe84cf29c, 0x191f, 0x4eae, {0x96, 0xe1, 0xf4, 0x6a, 0xec, 0xea, 0xea, 0x0b } }
-
-typedef struct _EFI_TIANO_DECOMPRESS_PROTOCOL EFI_TIANO_DECOMPRESS_PROTOCOL;
-
-/**
-
- The GetInfo() function retrieves the size of the uncompressed buffer
- and the temporary scratch buffer required to decompress the buffer
- specified by Source and SourceSize. If the size of the uncompressed
- buffer or the size of the scratch buffer cannot be determined from
- the compressed data specified by Source and SourceData, then
- EFI_INVALID_PARAMETER is returned. Otherwise, the size of the uncompressed
- buffer is returned in DestinationSize, the size of the scratch buffer is
- returned in ScratchSize, and EFI_SUCCESS is returned.
-
- The GetInfo() function does not have scratch buffer available to perform
- a thorough checking of the validity of the source data. It just retrieves
- the 'Original Size' field from the beginning bytes of the source data and
- output it as DestinationSize. And ScratchSize is specific to the decompression
- implementation.
-
- @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_GET_INFO) (
- IN EFI_TIANO_DECOMPRESS_PROTOCOL *This,
- IN VOID *Source,
- IN UINT32 SourceSize,
- OUT UINT32 *DestinationSize,
- OUT UINT32 *ScratchSize
- );
-
-/**
-
- The Decompress() function extracts decompressed data to its original form.
-
- This protocol is designed so that the decompression algorithm can be
- implemented without using any memory services. As a result, the
- Decompress() function is not allowed to call AllocatePool() or
- AllocatePages() in its implementation. It is the caller's responsibility
- to allocate and free the Destination and Scratch buffers.
-
- If the compressed source data specified by Source and SourceSize is
- sucessfully decompressed into Destination, then EFI_SUCCESS is returned.
- If the compressed source data specified by Source and SourceSize is not in
- a valid compressed data format, then EFI_INVALID_PARAMETER is returned.
-
- @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;
- EFI_TIANO_DECOMPRESS_DECOMPRESS Decompress;
-};
-
-extern EFI_GUID gEfiTianoDecompressProtocolGuid;
-
-#endif
diff --git a/MdeModulePkg/Include/Protocol/FaultTolerantWriteLite.h b/MdeModulePkg/Include/Protocol/FaultTolerantWriteLite.h index 7eb83e8..97b9b81 100644 --- a/MdeModulePkg/Include/Protocol/FaultTolerantWriteLite.h +++ b/MdeModulePkg/Include/Protocol/FaultTolerantWriteLite.h @@ -1,6 +1,6 @@ /** @file
- This is a simple fault tolerant write driver, based on PlatformFd library.
- And it only supports write BufferSize <= SpareAreaLength.
+ Fault tolerant write lite protocol defines only one interface to write
+ the buffer to the fault tolerant storage.
Copyright (c) 2006 - 2008, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
@@ -33,7 +33,7 @@ typedef struct _EFI_FTW_LITE_PROTOCOL EFI_FTW_LITE_PROTOCOL; manner, ensuring at all times that either the original contents or
the modified contents are available.
- @param This Calling context
+ @param This The pointer to this protocol instance.
@param FvBlockHandle The handle of FVB protocol that provides services
for reading, writing, and erasing the target
block.
@@ -45,12 +45,11 @@ typedef struct _EFI_FTW_LITE_PROTOCOL EFI_FTW_LITE_PROTOCOL; @retval EFI_SUCCESS The function completed successfully
@retval EFI_ABORTED The function could not complete successfully.
- @retval EFI_BAD_BUFFER_SIZE The write would span a block boundary, which is
- not a valid action.
+ @retval EFI_BAD_BUFFER_SIZE The input data can't fit within the target block.
@retval EFI_ACCESS_DENIED No writes have been allocated.
- @retval EFI_NOT_READY The last write has not been completed. Restart ()
- must be called to complete it.
-
+ @retval EFI_OUT_OF_RESOURCES Cannot allocate enough memory resource.
+ @retval EFI_NOT_FOUND Cannot find FVB protocol by handle.
+
**/
typedef
EFI_STATUS
diff --git a/MdeModulePkg/Include/Protocol/FirmwareVolumeDispatch.h b/MdeModulePkg/Include/Protocol/FirmwareVolumeDispatch.h index d8c1e76..4f0952b 100644 --- a/MdeModulePkg/Include/Protocol/FirmwareVolumeDispatch.h +++ b/MdeModulePkg/Include/Protocol/FirmwareVolumeDispatch.h @@ -1,10 +1,9 @@ /** @file
This file declares Firmware Volume Dispatch protocol.
- Presence of this protocol tells the dispatch to dispatch from this Firmware
- Volume
+ Presence of this protocol tells the core dispatcher to dispatch this Firmware Volume.
- 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
diff --git a/MdeModulePkg/Include/Protocol/FvbExtension.h b/MdeModulePkg/Include/Protocol/FvbExtension.h index e961057..21b5d0c 100644 --- a/MdeModulePkg/Include/Protocol/FvbExtension.h +++ b/MdeModulePkg/Include/Protocol/FvbExtension.h @@ -24,29 +24,30 @@ 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 +/**
+ Erases and initializes a specified range of a firmware volume block
+
+ @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
- + 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_SUCCESS The specified range was erased successfully
+ @retval EFI_ACCESS_DENIED The firmware volume block is in the WriteDisabled state
+ @retval EFI_DEVICE_ERROR The block device is not functioning correctly and
+ could not be written. Firmware device may have been
+ partially erased
**/
typedef
EFI_STATUS
(EFIAPI * EFI_FV_ERASE_CUSTOM_BLOCK) (
IN EFI_FVB_EXTENSION_PROTOCOL *This,
- IN EFI_LBA StartLba,
- IN UINTN OffsetStartLba,
- IN EFI_LBA LastLba,
- IN UINTN OffsetLastLba
+ IN EFI_LBA StartLba,
+ IN UINTN OffsetStartLba,
+ IN EFI_LBA LastLba,
+ IN UINTN OffsetLastLba
);
//
diff --git a/MdeModulePkg/Include/Protocol/GenericMemoryTest.h b/MdeModulePkg/Include/Protocol/GenericMemoryTest.h index 9fcdffa..c5c4f24 100644 --- a/MdeModulePkg/Include/Protocol/GenericMemoryTest.h +++ b/MdeModulePkg/Include/Protocol/GenericMemoryTest.h @@ -1,6 +1,5 @@ /** @file
- The EFI generic memory test protocol interface.
- For more information please look at EfiMemoryTest.doc
+ This protocol defines the EFI generic memory test interfaces in Dxe phase.
Copyright (c) 2006 - 2008, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
@@ -47,7 +46,7 @@ typedef enum { typedef
EFI_STATUS
(EFIAPI *EFI_MEMORY_TEST_INIT) (
- IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This,
+ IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This,
IN EXTENDMEM_COVERAGE_LEVEL Level,
OUT BOOLEAN *RequireSoftECCInit
)
@@ -71,6 +70,7 @@ EFI_STATUS internally.
@retval EFI_NOT_FOUND Indicate all the non-tested memory blocks have
already go through.
+ @retval EFI_DEVICE_ERROR Mis-compare error, and no agent can handle it
**/
typedef
@@ -110,15 +110,14 @@ EFI_STATUS @param StartAddress The start address of the memory range.
@param Length The memory range's length.
- @retval EFI_SUCCESS The compatible memory range pass the memory test.
- @retval EFI_DEVICE_ERROR The compatible memory range test find memory error
- and also return return the error address.
+ @retval EFI_SUCCESS The compatible memory range pass the memory test.
+ @retval EFI_INVALID_PARAMETER The compatible memory range must be below 16M.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_MEMORY_TEST_COMPATIBLE_RANGE) (
- IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This,
+ IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This,
IN EFI_PHYSICAL_ADDRESS StartAddress,
IN UINT64 Length
)
diff --git a/MdeModulePkg/Include/Protocol/LoadPe32Image.h b/MdeModulePkg/Include/Protocol/LoadPe32Image.h index 8cf58ec..8415872 100644 --- a/MdeModulePkg/Include/Protocol/LoadPe32Image.h +++ b/MdeModulePkg/Include/Protocol/LoadPe32Image.h @@ -1,6 +1,7 @@ /** @file
- Load File protocol.
+ Load File protocol provides capability to load and unload EFI image into
+ memory and execute it.
Load file protocol exists to supports the addition of new boot devices,
and to support booting from devices that do not map well to file system.
diff --git a/MdeModulePkg/Include/Protocol/NicIp4Config.h b/MdeModulePkg/Include/Protocol/NicIp4Config.h index 2272d98..2bf20c0 100644 --- a/MdeModulePkg/Include/Protocol/NicIp4Config.h +++ b/MdeModulePkg/Include/Protocol/NicIp4Config.h @@ -1,6 +1,7 @@ -/*++
+/** @file
+ This file defines NicIp4Config Protocol.
-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 +10,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:
-
- NicIp4Config.h
-
-Abstract:
-
---*/
+**/
#ifndef __NIC_IP4_CONFIG_H__
#define __NIC_IP4_CONFIG_H__
@@ -38,7 +33,7 @@ Abstract: typedef struct _EFI_NIC_IP4_CONFIG_PROTOCOL EFI_NIC_IP4_CONFIG_PROTOCOL;
-enum {
+typedef enum {
//
// Config source: dhcp or static
//
@@ -48,7 +43,7 @@ enum { IP4_NIC_NAME_LENGTH = 64,
MAX_IP4_CONFIG_IN_VARIABLE = 16
-};
+} IP4_CONFIG_TYPE;
//
// The following structures are used by drivers/applications other
diff --git a/MdeModulePkg/Include/Protocol/OEMBadging.h b/MdeModulePkg/Include/Protocol/OEMBadging.h index 3154c14..0d701a8 100644 --- a/MdeModulePkg/Include/Protocol/OEMBadging.h +++ b/MdeModulePkg/Include/Protocol/OEMBadging.h @@ -1,5 +1,6 @@ /** @file
- EFI OEM Badging Protocol definition header file
+ EFI OEM Badging Protocol defines the interface to get the OEM badging
+ image with the dispaly attribute. This protocol can be produced based on OEM images.
Copyright (c) 2006 - 2008, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
@@ -45,7 +46,23 @@ typedef enum { EfiBadgingDisplayAttributeCustomized
} EFI_BADGING_DISPLAY_ATTRIBUTE;
+/**
+ Load an OEM image and return its data as well as attributes.
+
+ @param This Pointer to this protocol instance.
+ @param Instance The visiable image instance is founded and returned from the input instance.
+ @param Format Format of the image such as BMP,JPEG,etc.
+ @param ImageData Image data returned.
+ @param ImageSize Size of the image returned.
+ @param Attribute Display attributes of the image returned.
+ @param CoordinateX X coordinate of the image.
+ @param CoordinateY Y coordinate of the image.
+
+ @retval EFI_SUCCESS Image has been fetched successfully.
+ @retval EFI_NOT_FOUND The specified image could not be found.
+
+**/
typedef
EFI_STATUS
(EFIAPI *EFI_BADGING_GET_IMAGE) (
diff --git a/MdeModulePkg/Include/Protocol/Print.h b/MdeModulePkg/Include/Protocol/Print.h index 4a356f3..22d6a60 100644 --- a/MdeModulePkg/Include/Protocol/Print.h +++ b/MdeModulePkg/Include/Protocol/Print.h @@ -1,6 +1,7 @@ /** @file
- This file defines the Print protocol.
+ This print protocol defines six basic print functions to + print the format unicode and ascii string.
Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials
diff --git a/MdeModulePkg/Include/Protocol/PxeDhcp4.h b/MdeModulePkg/Include/Protocol/PxeDhcp4.h index 53fe743..c52aa1e 100644 --- a/MdeModulePkg/Include/Protocol/PxeDhcp4.h +++ b/MdeModulePkg/Include/Protocol/PxeDhcp4.h @@ -1,6 +1,7 @@ -/*++
+/** @file
+ EFI PXE DHCPv4 protocol definition
-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 +10,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:
- PxeDhcp4.h
-
-Abstract:
- EFI PXE DHCPv4 protocol definition
-
---*/
+**/
#ifndef _PXEDHCP4_H_
#define _PXEDHCP4_H_
@@ -168,23 +163,23 @@ typedef union _DHCP4_PACKET { #define DHCP4_NIS_SERVERS 41
#define DHCP4_NTP_SERVERS 42
#define DHCP4_VENDOR_SPECIFIC 43
-# define PXE_MTFTP_IP 1
-# define PXE_MTFTP_CPORT 2
-# define PXE_MTFTP_SPORT 3
-# define PXE_MTFTP_TMOUT 4
-# define PXE_MTFTP_DELAY 5
-# define PXE_DISCOVERY_CONTROL 6
-# define PXE_DISABLE_BROADCAST_DISCOVERY 0x01
-# define PXE_DISABLE_MULTICAST_DISCOVERY 0x02
-# define PXE_ACCEPT_ONLY_PXE_BOOT_SERVERS 0x04
-# define PXE_DO_NOT_PROMPT 0x08
-# define PXE_DISCOVERY_MCAST_ADDR 7
-# define PXE_BOOT_SERVERS 8
-# define PXE_BOOT_MENU 9
-# define PXE_BOOT_PROMPT 10
-# define PXE_MCAST_ADDRS_ALLOC 11
-# define PXE_CREDENTIAL_TYPES 12
-# define PXE_BOOT_ITEM 71
+#define PXE_MTFTP_IP 1
+#define PXE_MTFTP_CPORT 2
+#define PXE_MTFTP_SPORT 3
+#define PXE_MTFTP_TMOUT 4
+#define PXE_MTFTP_DELAY 5
+#define PXE_DISCOVERY_CONTROL 6
+#define PXE_DISABLE_BROADCAST_DISCOVERY 0x01
+#define PXE_DISABLE_MULTICAST_DISCOVERY 0x02
+#define PXE_ACCEPT_ONLY_PXE_BOOT_SERVERS 0x04
+#define PXE_DO_NOT_PROMPT 0x08
+#define PXE_DISCOVERY_MCAST_ADDR 7
+#define PXE_BOOT_SERVERS 8
+#define PXE_BOOT_MENU 9
+#define PXE_BOOT_PROMPT 10
+#define PXE_MCAST_ADDRS_ALLOC 11
+#define PXE_CREDENTIAL_TYPES 12
+#define PXE_BOOT_ITEM 71
#define DHCP4_NBNS_SERVERS 44
#define DHCP4_NBDD_SERVERS 45
#define DHCP4_NETBIOS_NODE_TYPE 46
@@ -194,23 +189,23 @@ typedef union _DHCP4_PACKET { #define DHCP4_REQUESTED_IP_ADDRESS 50
#define DHCP4_LEASE_TIME 51
#define DHCP4_OPTION_OVERLOAD 52
-# define DHCP4_OVERLOAD_FNAME 1
-# define DHCP4_OVERLOAD_SNAME 2
-# define DHCP4_OVERLOAD_FNAME_AND_SNAME 3
+#define DHCP4_OVERLOAD_FNAME 1
+#define DHCP4_OVERLOAD_SNAME 2
+#define DHCP4_OVERLOAD_FNAME_AND_SNAME 3
#define DHCP4_MESSAGE_TYPE 53
-# define DHCP4_MESSAGE_TYPE_DISCOVER 1
-# define DHCP4_MESSAGE_TYPE_OFFER 2
-# define DHCP4_MESSAGE_TYPE_REQUEST 3
-# define DHCP4_MESSAGE_TYPE_DECLINE 4
-# define DHCP4_MESSAGE_TYPE_ACK 5
-# define DHCP4_MESSAGE_TYPE_NAK 6
-# define DHCP4_MESSAGE_TYPE_RELEASE 7
-# define DHCP4_MESSAGE_TYPE_INFORM 8
+#define DHCP4_MESSAGE_TYPE_DISCOVER 1
+#define DHCP4_MESSAGE_TYPE_OFFER 2
+#define DHCP4_MESSAGE_TYPE_REQUEST 3
+#define DHCP4_MESSAGE_TYPE_DECLINE 4
+#define DHCP4_MESSAGE_TYPE_ACK 5
+#define DHCP4_MESSAGE_TYPE_NAK 6
+#define DHCP4_MESSAGE_TYPE_RELEASE 7
+#define DHCP4_MESSAGE_TYPE_INFORM 8
#define DHCP4_SERVER_IDENTIFIER 54
#define DHCP4_PARAMETER_REQUEST_LIST 55
#define DHCP4_ERROR_MESSAGE 56
#define DHCP4_MAX_MESSAGE_SIZE 57
-# define DHCP4_DEFAULT_MAX_MESSAGE_SIZE 576
+#define DHCP4_DEFAULT_MAX_MESSAGE_SIZE 576
#define DHCP4_RENEWAL_TIME 58
#define DHCP4_REBINDING_TIME 59
#define DHCP4_CLASS_IDENTIFIER 60
diff --git a/MdeModulePkg/Include/Protocol/PxeDhcp4CallBack.h b/MdeModulePkg/Include/Protocol/PxeDhcp4CallBack.h index cfba380..7f39723 100644 --- a/MdeModulePkg/Include/Protocol/PxeDhcp4CallBack.h +++ b/MdeModulePkg/Include/Protocol/PxeDhcp4CallBack.h @@ -1,6 +1,7 @@ -/*++
+/** @file
+ EFI PXE DHCP4 Callback protocol definition.
-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,16 +10,10 @@ 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:
- PxeDhcp4Callback.h
-
-Abstract:
- EFI PXE DHCP4 Callback protocol definition.
-
---*/
+**/
-#ifndef _PXE_DHCP4CALLBACK_H
-#define _PXE_DHCP4CALLBACK_H
+#ifndef __PXE_DHCP4CALLBACK_H__
+#define __PXE_DHCP4CALLBACK_H__
#include <Protocol/PxeDhcp4.h>
//
diff --git a/MdeModulePkg/Include/Protocol/Tcp.h b/MdeModulePkg/Include/Protocol/Tcp.h index f49915c..ca6416e 100644 --- a/MdeModulePkg/Include/Protocol/Tcp.h +++ b/MdeModulePkg/Include/Protocol/Tcp.h @@ -1,6 +1,8 @@ -/*++
+/** @file
-Copyright (c) 2004, Intel Corporation
+ This file defines EFI Transmission Control Protocol.
+
+Copyright (c) 2004 - 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,23 +11,11 @@ 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:
-
- tcp.h
-
-Abstract:
-
- EFI Transmission Control Protocol
-
-
-
-Revision History
-
---*/
+**/
-#ifndef _EFITCP_H
-#define _EFITCP_H
+#ifndef __EFI_TCP_H__
+#define __EFI_TCP_H__
#include <Protocol/PxeBaseCode.h>
diff --git a/MdeModulePkg/Include/Protocol/UsbAtapi.h b/MdeModulePkg/Include/Protocol/UsbAtapi.h deleted file mode 100644 index daa0529..0000000 --- a/MdeModulePkg/Include/Protocol/UsbAtapi.h +++ /dev/null @@ -1,83 +0,0 @@ -/*++
-
-Copyright (c) 2006 - 2007, 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:
-
- UsbAtapi.h
-
-Abstract:
-
- EFI Atapi Protocol definition.
-
-Revision History
-
---*/
-
-#ifndef __EFI_USB_ATAPI_H__
-#define __EFI_USB_ATAPI_H__
-
-//
-// Transfer protocol types
-//
-#define BOT 0x50
-#define CBI0 0x00
-#define CBI1 0x01
-
-//
-// SubClass Code (defines command set)
-//
-#define EFI_USB_SUBCLASS_RBC 0x01
-#define EFI_USB_SUBCLASS_ATAPI 0x02
-#define EFI_USB_SUBCLASS_QIC_157 0x03
-#define EFI_USB_SUBCLASS_UFI 0x04
-#define EFI_USB_SUBCLASS_SFF_8070i 0x05
-#define EFI_USB_SUBCLASS_SCSI 0x06
-#define EFI_USB_SUBCLASS_RESERVED_LOW 0x07
-#define EFI_USB_SUBCLASS_RESERVED_HIGH 0xff
-//
-// Global GUID for transfer protocol interface
-//
-#define EFI_USB_ATAPI_PROTOCOL_GUID \
- { 0x2B2F68DA, 0x0CD2, 0x44cf, {0x8E, 0x8B, 0xBB, 0xA2, 0x0B, 0x1B, 0x5B, 0x75 } }
-
-typedef struct _EFI_USB_ATAPI_PROTOCOL EFI_USB_ATAPI_PROTOCOL;
-
-typedef
-EFI_STATUS
-(EFIAPI *EFI_USB_ATAPI_PACKET_CMD) (
- IN EFI_USB_ATAPI_PROTOCOL *This,
- IN VOID *Command,
- IN UINT8 CommandSize,
- IN VOID *DataBuffer,
- IN UINT32 BufferLength,
- IN EFI_USB_DATA_DIRECTION Direction,
- IN UINT16 TimeOutInMilliSeconds
-);
-
-typedef
-EFI_STATUS
-(EFIAPI *EFI_USB_MASS_STORAGE_RESET) (
- IN EFI_USB_ATAPI_PROTOCOL *This,
- IN BOOLEAN ExtendedVerification
-);
-
-//
-// Protocol Interface Structure
-//
-struct _EFI_USB_ATAPI_PROTOCOL {
- EFI_USB_ATAPI_PACKET_CMD UsbAtapiPacketCmd;
- EFI_USB_MASS_STORAGE_RESET UsbAtapiReset;
- UINT32 CommandProtocol;
-};
-
-extern EFI_GUID gEfiUsbAtapiProtocolGuid;
-
-#endif
|