--- /dev/null
+/** @file\r
+ This file defines Simple TextInEx Notify Guid that specify the notify handle.\r
+\r
+Copyright (c) 2008, Intel Corporation. <BR>\r
+All rights reserved. This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution. The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#ifndef _SIMPLE_TEXTIN_EX_NOTIFY__H_\r
+#define _SIMPLE_TEXTIN_EX_NOTIFY__H_\r
+\r
+#define SIMPLE_TEXTIN_EX_NOTIFY_GUID \\r
+ { \\r
+ 0x856f2def, 0x4e93, 0x4d6b, {0x94, 0xce, 0x1c, 0xfe, 0x47, 0x1, 0x3e, 0xa5} \\r
+ }\r
+\r
+extern EFI_GUID gSimpleTextInExNotifyGuid;\r
+\r
+#endif\r
/** @file\r
- This file defines Pei memory test PPI used to Perform memory test in PEI phase.\r
+ This file defines Pei memory test PPI used to perform memory test in PEI phase.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
\r
typedef struct _PEI_BASE_MEMORY_TEST_PPI PEI_BASE_MEMORY_TEST_PPI;\r
\r
-//\r
-// 4 different test operations\r
-// Ignore op not test memory, Quick and Sparse op test memory quickly, Extensive op test memory detailedly.\r
-//\r
+///\r
+/// Pei Memory test operations\r
+/// Ignore op not test memory, Quick and Sparse op test memory quickly, Extensive op test memory detailedly.\r
+///\r
typedef enum {\r
Ignore,\r
Quick,\r
} PEI_MEMORY_TEST_OP;\r
\r
/**\r
- Test a range memory space is ready to read and write.\r
+ Test a range memory space that is ready to read and write.\r
+ If the memory is not ready, the error memory address will be returned.\r
\r
@param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
@param This Pointer to Pei memory test PPI instance.\r
@param BeginAddress Beginning of the memory address to be checked.\r
@param MemoryLength Bytes of memory range to be checked.\r
@param Operation Type of memory check operation to be performed.\r
- @param ErrorAddress Address which has error when checked.\r
+ @param ErrorAddress Address of memory where the error is checked.\r
\r
@retval EFI_SUCCESS Memory range pass basic read and write test.\r
@retval EFI_DEVICE_ERROR Memory is not ready to access.\r
/** @file\r
- This file defines OperatorPresent PPI responsible for detecting TPM operator presence.\r
+ This file defines OperatorPresent PPI. It is responsible for detecting TPM operator presence.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
typedef struct _PEI_OPERATOR_PRESENCE_PPI PEI_OPERATOR_PRESENCE_PPI;\r
\r
struct _PEI_OPERATOR_PRESENCE_PPI {\r
- BOOLEAN OperatorPresent;\r
+ BOOLEAN OperatorPresent; /// TRUE if TPM Operator is detected.\r
};\r
\r
extern EFI_GUID gPeiOperatorPresencePpiGuid;\r
/** @file\r
\r
Capsule Architectural Protocol is responsible to tag UEFI2.0 capsule runtime services\r
- are ready in EFI_RUNTIME_SERVICES.\r
+ are ready in EFI_RUNTIME_SERVICES table.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
\r
\r
typedef enum {\r
- EfiConsoleControlScreenText,\r
- EfiConsoleControlScreenGraphics,\r
+ EfiConsoleControlScreenText, /// Text Mode\r
+ EfiConsoleControlScreenGraphics, /// Graphics Mode\r
EfiConsoleControlScreenMaxValue\r
} EFI_CONSOLE_CONTROL_SCREEN_MODE;\r
\r
/**\r
Return the current video mode information. Also returns info about existence\r
- of Graphics Output devices or UGA Draw devices in system, and if the Std In device is locked. All the\r
- arguments are optional and only returned if a non NULL pointer is passed in.\r
+ of Graphics Output devices or UGA Draw devices in system, and whether the Std In device is locked. \r
+ GopUgaExists and StdInLocked parameters are optional.\r
\r
@param This Protocol instance pointer.\r
- @param Mode Are we in text of grahics mode.\r
+ @param Mode Current video mode.\r
@param GopExists TRUE if GOP Spliter has found a GOP/UGA device\r
@param StdInLocked TRUE if StdIn device is keyboard locked\r
\r
Set the current video mode to either text or graphics. \r
\r
@param This Protocol instance pointer.\r
- @param Mode Mode is to be set.\r
+ @param Mode Video mode is to be set.\r
\r
- @retval EFI_SUCCESS Mode is set.\r
+ @retval EFI_SUCCESS Mode is set successfully.\r
@retval EFI_INVALID_PARAMETER Mode is not the valid mode value.\r
@retval EFI_UNSUPPORTED Mode is unsupported by console device.\r
\r
);\r
\r
/**\r
- Copy the Password and enable state variable and then arm the periodic timer\r
+ Store the password, enable state variable and arm the periodic timer.\r
\r
- @retval EFI_SUCCESS Lock the StdIn device\r
+ @retval EFI_SUCCESS Lock the StdIn device successfully.\r
@retval EFI_INVALID_PARAMETER Password is NULL\r
@retval EFI_OUT_OF_RESOURCES Buffer allocation to store the big password fails\r
\r
/** @file\r
\r
- This file can define the different guids to specify the different \r
+ This file defines a group of guids to specify the different \r
encapsulation scheme for the guided section.\r
+ The related defintions is in UEFI GuidedSectionExtraction protocol.\r
+\r
Now, only one guid is defined for CRC32 encapsulation scheme.\r
- The related data structures come from the SectionExtraction protocol definition.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
//\r
// Protocol GUID definition. Each GUIDed section extraction protocol has the\r
// same interface but with different GUID. All the GUIDs is defined here.\r
-// May add multiple GUIDs here.\r
+// May add more GUIDs here in future.\r
//\r
#define EFI_CRC32_GUIDED_SECTION_EXTRACTION_PROTOCOL_GUID \\r
{ 0xFC1BCDB0, 0x7D31, 0x49aa, {0x93, 0x6A, 0xA4, 0x60, 0x0D, 0x9D, 0xD0, 0x83 } }\r
\r
//\r
-// The data structures are the same as GuidedSectionExtraction protocol only the GUID's are different\r
+// The data structures are the same to UEFI GuidedSectionExtraction protocol.\r
//\r
#include <Protocol/GuidedSectionExtraction.h>\r
\r
/** @file\r
Disk Info protocol is used to export Inquiry Data for a drive.\r
- Its needed to support low level formating of drives in a mannor\r
- thats DOS compatible.\r
+ It supports low level formating of drives in a DOS compatible manner.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
);\r
\r
/**\r
- Return the results of the Request Sense command to a drive in SenseData.\r
- Data format of Sense data is defined by the Interface GUID.\r
+ Return the IDE device information.\r
\r
@param This Protocol instance pointer. \r
@param IdeChannel Primary or Secondary \r
extern EFI_GUID gEfiDiskInfoAhciInterfaceGuid;\r
\r
struct _EFI_DISK_INFO_PROTOCOL {\r
- EFI_GUID Interface;\r
+ EFI_GUID Interface; /// The format of the buffers returned by member functions.\r
EFI_DISK_INFO_INQUIRY Inquiry;\r
EFI_DISK_INFO_IDENTIFY Identify;\r
EFI_DISK_INFO_SENSE_DATA SenseData;\r
//\r
/**\r
Starts a target block update. This records information about the write\r
- in fault tolerant storage and will complete the write in a recoverable\r
+ in fault tolerant storage will complete the write in a recoverable\r
manner, ensuring at all times that either the original contents or\r
the modified contents are available.\r
\r
@param This The pointer to this protocol instance. \r
- @param FvBlockHandle The handle of FVB protocol that provides services \r
- for reading, writing, and erasing the target \r
- block. \r
+ @param FvbHandle The handle of FVB protocol that provides services \r
+ for reading, writing, and erasing the target block. \r
@param Lba The logical block address of the target block. \r
- @param Offset The offset within the target block to place the \r
- data. \r
- @param Length The number of bytes to write to the target block. \r
+ @param Offset The offset within the target block to place the data. \r
+ @param NumBytes The number of bytes to write to the target block. \r
@param Buffer The data to write. \r
\r
@retval EFI_SUCCESS The function completed successfully \r
/** @file\r
This file declares Firmware Volume Dispatch protocol.\r
\r
- Presence of this protocol tells the core dispatcher to dispatch this Firmware Volume.\r
+ This protocol will be installed into FV Handle if the drivers in this Firmware Volume \r
+ are required to be dispatched by the core dispatcher.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
/** @file\r
\r
- FVB Extension protocol that extends the FVB Class in a component fashion.\r
+ FVB Extension protocol provides one extended service to FVB protocol defined in PI specification.\r
+ This service can erase the specified range of a firmware volume block.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
// FVB Extension Function Prototypes\r
//\r
/**\r
- Erases and initializes a specified range of a firmware volume block\r
+ Erases and initializes a specified range of a firmware volume block.\r
\r
@param[in] This Pointer to the FVB Extension protocol instance\r
@param[in] StartLba The starting logical block index to be erased\r
- @param[in] OffsetStartLba Offset into the starting block at which to \r
- begin erasing \r
+ @param[in] OffsetStartLba Offset into the starting block at which to begin erasing \r
@param[in] LastLba The last logical block index to be erased\r
@param[in] OffsetLastLba Offset into the last block at which to end erasing \r
\r
@retval EFI_ACCESS_DENIED The firmware volume block is in the WriteDisabled state\r
@retval EFI_DEVICE_ERROR The block device is not functioning correctly and \r
could not be written. Firmware device may have been\r
- partially erased\r
+ partially erased.\r
**/\r
typedef\r
EFI_STATUS\r
/** @file\r
- This protocol defines the EFI generic memory test interfaces in Dxe phase.\r
+ This protocol defines the generic memory test interfaces in Dxe phase.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
\r
typedef struct _EFI_GENERIC_MEMORY_TEST_PROTOCOL EFI_GENERIC_MEMORY_TEST_PROTOCOL;\r
\r
+///\r
+/// Memory test coverage level\r
+/// Ignore op not test memory, Quick and Sparse op test memory quickly, Extensive op test memory detailedly.\r
+///\r
typedef enum {\r
IGNORE,\r
QUICK,\r
@param Level The coverage level of the memory test. \r
@param RequireSoftECCInit Indicate if the memory need software ECC init. \r
\r
- @retval EFI_SUCCESS The generic memory test initialized correctly. \r
- @retval EFI_NO_MEDIA There is not any non-tested memory found, in this \r
- function if not any non-tesed memory found means \r
+ @retval EFI_SUCCESS The generic memory test is initialized correctly. \r
+ @retval EFI_NO_MEDIA There is not any non-tested memory found, which means \r
that the memory test driver have not detect any \r
- non-tested extended memory of current system. \r
+ non-tested extended memory in current system. \r
\r
**/\r
typedef\r
@param This Protocol instance pointer. \r
@param TestedMemorySize Return the tested extended memory size. \r
@param TotalMemorySize Return the whole system physical memory size, this \r
- value may be changed if in some case some error \r
- DIMMs be disabled. \r
- @param ErrorOut Any time the memory error occurs, this will be \r
- TRUE. \r
- @param IfTestAbort Indicate if the user press "ESC" to skip the memory \r
- test. \r
-\r
- @retval EFI_SUCCESS One block of memory test ok, the block size is hide \r
- internally. \r
- @retval EFI_NOT_FOUND Indicate all the non-tested memory blocks have \r
- already go through. \r
- @retval EFI_DEVICE_ERROR Mis-compare error, and no agent can handle it\r
+ value may be changed if some error DIMMs is disabled in some case. \r
+ @param ErrorOut TRUE if the memory error occurs.\r
+ @param IfTestAbort Indicate if the user press "ESC" to skip the memory test. \r
+\r
+ @retval EFI_SUCCESS One block of memory pass test.\r
+ @retval EFI_NOT_FOUND Indicate all the non-tested memory blocks have been\r
+ already gone through.\r
+ @retval EFI_DEVICE_ERROR Memory device error occurs and no agent can handle it.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PERFORM_MEMORY_TEST)(\r
- IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This,\r
+ IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This,\r
OUT UINT64 *TestedMemorySize,\r
OUT UINT64 *TotalMemorySize,\r
OUT BOOLEAN *ErrorOut,\r
\r
\r
/**\r
- The memory test finished.\r
+ Finish the memory test.\r
\r
@param This Protocol instance pointer. \r
\r
- @retval EFI_SUCCESS Successful free all the generic memory test driver \r
- allocated resource and notify to platform memory \r
- test driver that memory test finished. \r
+ @retval EFI_SUCCESS Successful. \r
\r
**/\r
typedef\r
);\r
\r
/**\r
- Provide capability to test compatible range which used by some sepcial\r
- driver required using memory range before BDS perform memory test.\r
+ Provide capability to test compatible range used by some sepcial\r
+ driver before BDS perform memory test.\r
\r
@param This Protocol instance pointer. \r
- @param StartAddress The start address of the memory range. \r
- @param Length The memory range's length. \r
+ @param StartAddress The start address of the compatible memory range that\r
+ must be below 16M.\r
+ @param Length The compatible memory range's length. \r
\r
@retval EFI_SUCCESS The compatible memory range pass the memory test. \r
@retval EFI_INVALID_PARAMETER The compatible memory range must be below 16M.\r
/** @file\r
\r
- Load File protocol provides capability to load and unload EFI image into \r
- memory and execute it.\r
+ Load Pe32 Image protocol provides capability to load and unload EFI image into memory and execute it.\r
\r
- Load file protocol exists to supports the addition of new boot devices,\r
- and to support booting from devices that do not map well to file system.\r
- Network boot is done via a LoadFile protocol.\r
-\r
- UEFI 2.0 can boot from any device that produces a LoadFile protocol.\r
+ This protocol supports the additional new boot devices that do not map well to file system.\r
+ UEFI can boot from any device (including Network boot) that produces a LoadFile protocol.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
\r
Loads an EFI image into memory and returns a handle to the image with extended parameters.\r
\r
- @param This Calling context\r
+ @param This Pointer to the LoadPe32Image protocol instance\r
@param ParentImageHandle The caller's image handle.\r
@param FilePath The specific file path from which the image is loaded.\r
@param SourceBuffer If not NULL, a pointer to the memory location containing a copy of\r
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
@retval EFI_UNSUPPORTED The image type is not supported, or the device path cannot be\r
parsed to locate the proper protocol for loading the file.\r
- @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient resources.\r
+ @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient memory resources.\r
**/\r
typedef\r
EFI_STATUS\r
\r
Unload the specified image.\r
\r
- @param This Indicates the calling context.\r
- @param ImageHandle The specified image handle.\r
+ @param This Pointer to the LoadPe32Image protocol instance\r
+ @param ImageHandle The specified image handle to be unloaded.\r
\r
@retval EFI_INVALID_PARAMETER Image handle is NULL.\r
@retval EFI_UNSUPPORTED Attempt to unload an unsupported image.\r
- @retval EFI_SUCCESS Image successfully unloaded.\r
+ @retval EFI_SUCCESS Image is successfully unloaded.\r
\r
--*/\r
typedef\r
\r
struct _EFI_PE32_IMAGE_PROTOCOL {\r
LOAD_PE_IMAGE LoadPeImage;\r
- UNLOAD_PE_IMAGE UnLoadPeImage;\r
+ UNLOAD_PE_IMAGE UnLoadPeImage;\r
};\r
\r
extern EFI_GUID gEfiLoadPeImageProtocolGuid;\r
/** @file\r
- EFI OEM Badging Protocol defines the interface to get the OEM badging \r
- image with the dispaly attribute. This protocol can be produced based on OEM images.\r
+ The OEM Badging Protocol defines the interface to get the OEM badging \r
+ image with the dispaly attribute. This protocol can be produced based on OEM badging images.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
\r
/**\r
\r
- Load an OEM image and return its data as well as attributes.\r
+ Load an OEM badge image and return its data as well as attributes.\r
\r
@param This Pointer to this protocol instance.\r
- @param Instance The visiable image instance is founded and returned from the input instance.\r
+ @param Instance The visiable image instance is found.\r
@param Format Format of the image such as BMP,JPEG,etc.\r
@param ImageData Image data returned.\r
@param ImageSize Size of the image returned.\r
\r
typedef struct {\r
EFI_PHYSICAL_ADDRESS Handle;\r
- CHAR8 Token[DXE_PERFORMANCE_STRING_SIZE];\r
- CHAR8 Module[DXE_PERFORMANCE_STRING_SIZE];\r
- UINT64 StartTimeStamp;\r
- UINT64 EndTimeStamp;\r
+ CHAR8 Token[DXE_PERFORMANCE_STRING_SIZE]; /// Measured token string name \r
+ CHAR8 Module[DXE_PERFORMANCE_STRING_SIZE]; /// Module string name\r
+ UINT64 StartTimeStamp; /// Start time point\r
+ UINT64 EndTimeStamp; /// End time point\r
} GAUGE_DATA_ENTRY;\r
\r
//\r
// The header must be aligned at 8 bytes\r
//\r
typedef struct {\r
- UINT32 NumberOfEntries;\r
+ UINT32 NumberOfEntries; /// The number of all performance guage entries\r
UINT32 Reserved;\r
} GAUGE_DATA_HEADER;\r
\r
/** @file\r
\r
- This print protocol defines six basic print functions to \r
- print the format unicode and ascii string.\r
+ The lite print protocol defines only one print function to \r
+ print the format unicode string.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
Unicode string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
+ @param FormatString Null-terminated ASCII format string.\r
@param Marker VA_LIST marker for the variable argument list.\r
\r
@return The number of Unicode characters in the produced output buffer not including the\r
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
ASCII string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
+ @param FormatString Null-terminated ASCII format string.\r
@param Marker VA_LIST marker for the variable argument list.\r
\r
@return The number of ASCII characters in the produced output buffer not including the\r
\r
/**\r
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
- ASCII format string and a VA_LIST argument list.\r
+ Unicode format string and a VA_LIST argument list.\r
\r
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
and BufferSize.\r
#endif\r
\r
///\r
-/// Hardware error record maximum variable size\r
+/// Maximum buffer for Hardware error record variable\r
///\r
#ifndef MAX_HARDWARE_ERROR_VARIABLE_SIZE\r
#define MAX_HARDWARE_ERROR_VARIABLE_SIZE FixedPcdGet32(PcdMaxHardwareErrorVariableSize)\r
## Print protocol defines six basic print functions to print the format unicode and ascii string.\r
gEfiPrint2ProtocolGuid = { 0x5bcc3dbc, 0x8c57, 0x450a, { 0xbb, 0x0c, 0xa1, 0xc0, 0xbd, 0xde, 0x48, 0x0c }}\r
\r
- ## This protocol defines the EFI generic memory test interfaces in Dxe phase.\r
+ ## This protocol defines the generic memory test interfaces in Dxe phase.\r
gEfiGenericMemTestProtocolGuid = { 0x309DE7F1, 0x7F5E, 0x4ACE, { 0xB4, 0x9C, 0x53, 0x1B, 0xE5, 0xAA, 0x95, 0xEF }}\r
\r
## Disk Info protocol is used to export Inquiry Data for a drive.\r
gEfiDiskInfoProtocolGuid = { 0xD432A67F, 0x14DC, 0x484B, { 0xB3, 0xBB, 0x3F, 0x02, 0x91, 0x84, 0x93, 0x27 }}\r
\r
- ## FVB Extension protocol that extends the FVB Class in a component fashion.\r
+ ## This protocol provides an extended service to erase the specified range of a firmware volume block.\r
gEfiFvbExtensionProtocolGuid = { 0x53A4C71B, 0xB581, 0x4170, { 0x91, 0xB3, 0x8D, 0xB8, 0x7A, 0x4B, 0x5C, 0x46 }}\r
\r
## Fault tolerant write lite protocol defines only one interface to write \r
## This protocol provides the interfaces to Get/Set the current video mode for GOP/UGA screen\r
gEfiConsoleControlProtocolGuid = { 0xF42F7782, 0x012E, 0x4C12, { 0x99, 0x56, 0x49, 0xF9, 0x43, 0x04, 0xF7, 0x21 }}\r
\r
- ## EFI OEM Badging Protocol defines the interface to get the OEM badging image with the dispaly attribute.\r
+ ## OEM Badging Protocol defines the interface to get the OEM badging image with the dispaly attribute.\r
gEfiOEMBadgingProtocolGuid = { 0x170E13C0, 0xBF1B, 0x4218, { 0x87, 0x1D, 0x2A, 0xBD, 0xC6, 0xF8, 0x87, 0xBC }}\r
\r
## Performance protocol interfaces to support cross module performance logging.\r
## Maximum buffer for the single variable.\r
gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize|0x400|UINT32|0x30000003\r
\r
- ## The hardware error record maximum variable size.\r
+ ## Maximum buffer for Hardware error record variable.\r
gEfiMdeModulePkgTokenSpaceGuid.PcdMaxHardwareErrorVariableSize|0x8000|UINT32|0x30000004\r
\r
## Maximum buffer for the total variable store.\r
projects / mirror_edk2.git / commitdiff