-/*++\r
+/** @file\r
+ This file defines header data structures for BMP file and default\r
+ BMP file GUID. \r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+Copyright (c) 2006 - 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
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
-Module Name:\r
-\r
- Bmp.h\r
-\r
-Abstract:\r
-\r
---*/\r
+**/\r
\r
#ifndef __BMP_GUID_H__\r
#define __BMP_GUID_H__\r
-/*++\r
+/** @file\r
+ This file defines variable name and GUID to record boot state.\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+Copyright (c) 2006 - 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
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
-Module Name:\r
-\r
- BootState.h\r
-\r
-Abstract:\r
-\r
- Constants and declarations that are common accross PEI and DXE.\r
---*/\r
+**/\r
\r
#ifndef __BOOT_STATE_H__\r
#define __BOOT_STATE_H__\r
-/*++\r
+/** @file\r
+ The variable space Guid to pair with a Unicode string name to tag an EFI variable.\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+Copyright (c) 2006 - 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
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
-Module Name:\r
-\r
- GenericPlatformVariable.h\r
-\r
-Abstract:\r
-\r
- The variable space Guid to pair with a Unicode string name to tag an EFI variable.\r
-\r
---*/\r
+**/\r
\r
#ifndef __GENERIC_PLATFORM_VARIABLE_H__\r
#define __GENERIC_PLATFORM_VARIABLE_H__\r
-/*++\r
-\r
-Copyright (c) 2006, Intel Corporation \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
-Module Name:\r
- MemoryTypeInformation.h\r
- \r
-Abstract:\r
+/** @file\r
GUID used for Memory Type Information entries in the HOB list.\r
\r
---*/\r
+Copyright (c) 2006 - 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 __MEMORY_TYPE_INFORMATION_GUID_H__\r
#define __MEMORY_TYPE_INFORMATION_GUID_H__\r
-/*++\r
-\r
-Copyright (c) 2006, Intel Corporation \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
-Module Name:\r
+/** @file\r
+ GUIDs used for PEI Performance HOB data structures\r
\r
- PeiPerformanceHob.h\r
- \r
-Abstract:\r
+Copyright (c) 2006 - 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
- GUIDs used for PEI Performance HOB data structures\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
\r
#ifndef __PEI_PERFORMANCE_HOB_H__\r
#define __PEI_PERFORMANCE_HOB_H__\r
-/*++\r
-\r
-Copyright (c) 2006, Intel Corporation \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
-Module Name:\r
- \r
- EfiShell.h\r
- \r
-Abstract:\r
-\r
- FFS Filename for EFI Shell\r
-\r
---*/\r
+/** @file\r
+ This file defnies FFS GUID Filename for EFI Shell.\r
+\r
+Copyright (c) 2006 - 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 _SHELLFILE_H_\r
#define _SHELLFILE_H_\r
This library includes the APIs that is specific to EDK II's implementation.\r
It extended the UEFI Specification to define GUIDed device path.\r
\r
- Copyright (c) 2008, Intel Corporation \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
+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
Library header file defines APIs that is related to IFR operations but \r
specific to EDK II implementation.\r
\r
- Copyright (c) 2006 - 2007, Intel Corporation\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
+Copyright (c) 2006 - 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
/** @file\r
Recovery Library. This library class defines a set of methods related recovery mode.\r
\r
- Copyright (c) 2005 - 2007, Intel Corporation\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
+Copyright (c) 2005 - 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
\r
@retval EFI_SUCESS Sucess to do recovery.\r
@retval Others Fail to do recovery.\r
+\r
**/\r
EFI_STATUS\r
EFIAPI\r
/** @file\r
S3 Library. This library class defines a set of methods related do S3 mode.\r
\r
- Copyright (c) 2005 - 2007, Intel Corporation\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
+Copyright (c) 2005 - 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
\r
@retval EFI_SUCESS Sucess to restore config from S3.\r
@retval Others Fail to restore config from S3.\r
+\r
**/\r
EFI_STATUS\r
EFIAPI\r
-/*++\r
+/** @file\r
+ Pei memory test PPI used to Perform memory test in PEI phase.\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+Copyright (c) 2006 - 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
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
-Module Name:\r
-\r
- BaseMemoryTest.h\r
-\r
-Abstract:\r
-\r
- Pei memory test PPI as defined in Tiano\r
-\r
- Used to Pei memory test in PEI\r
-\r
---*/\r
+**/\r
\r
#ifndef __BASE_MEMORY_TEST_H__\r
#define __BASE_MEMORY_TEST_H__\r
-/*++\r
+/** @file\r
+ PPI published by the PEIM that is responsible for detecting operator presence.\r
\r
-Copyright (c) 2006, Intel Corporation \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
+Copyright (c) 2006 - 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
-Module Name:\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
- OperatorPresence.h\r
-\r
-Abstract:\r
-\r
- PPI published by the PEIM who's responsible for detecting operator presence\r
-\r
---*/\r
+**/\r
\r
#ifndef _PEI_OPERATOR_PRESENCE_H_\r
#define _PEI_OPERATOR_PRESENCE_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
\r
-Copyright (c) 2006, Intel Corporation\r
+Copyright (c) 2006 - 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
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
-Module Name:\r
-\r
- DiskInfo.h\r
-\r
-Abstract:\r
-\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
-\r
---*/\r
+**/\r
\r
#ifndef __DISK_INFO_H__\r
#define __DISK_INFO_H__\r
//\r
typedef struct _EFI_DISK_INFO_PROTOCOL EFI_DISK_INFO_PROTOCOL;\r
\r
+/**\r
+ Return the results of the Inquiry command to a drive in InquiryData.\r
+ Data format of Inquiry data is defined by the Interface GUID.\r
+\r
+ @param This Protocol instance pointer. \r
+ @param InquiryData Results of Inquiry command to device \r
+ @param InquiryDataSize Size of InquiryData in bytes. \r
+\r
+ @retval EFI_SUCCESS InquiryData valid \r
+ @retval EFI_NOT_FOUND Device does not support this data class \r
+ @retval EFI_DEVICE_ERROR Error reading InquiryData from device \r
+ @retval EFI_BUFFER_TOO_SMALL IntquiryDataSize not big enough \r
+\r
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DISK_INFO_INQUIRY) (\r
IN OUT VOID *InquiryData,\r
IN OUT UINT32 *IntquiryDataSize\r
)\r
-/*++\r
+;\r
\r
- Routine Description:\r
- Return the results of the Inquiry command to a drive in InquiryData.\r
- Data format of Inquiry data is defined by the Interface GUID.\r
\r
- Arguments:\r
- This - Protocol instance pointer.\r
- InquiryData - Results of Inquiry command to device\r
- InquiryDataSize - Size of InquiryData in bytes.\r
+/**\r
+ Return the results of the Identify command to a drive in IdentifyData.\r
+ Data format of Identify data is defined by the Interface GUID.\r
\r
- Returns:\r
- EFI_SUCCESS - InquiryData valid\r
- EFI_NOT_FOUND - Device does not support this data class\r
- EFI_DEVICE_ERROR - Error reading InquiryData from device\r
- EFI_BUFFER_TOO_SMALL - IntquiryDataSize not big enough\r
+ @param This Protocol instance pointer. \r
+ @param IdentifyData Results of Identify command to device \r
+ @param IdentifyDataSize Size of IdentifyData in bytes. \r
\r
---*/\r
-;\r
+ @retval EFI_SUCCESS IdentifyData valid \r
+ @retval EFI_NOT_FOUND Device does not support this data class \r
+ @retval EFI_DEVICE_ERROR Error reading IdentifyData from device \r
+ @retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough \r
\r
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DISK_INFO_IDENTIFY) (\r
IN OUT VOID *IdentifyData,\r
IN OUT UINT32 *IdentifyDataSize\r
)\r
-/*++\r
+;\r
\r
- Routine Description:\r
- Return the results of the Identify command to a drive in IdentifyData.\r
- Data format of Identify data is defined by the Interface GUID.\r
\r
- Arguments:\r
- This - Protocol instance pointer.\r
- IdentifyData - Results of Identify command to device\r
- IdentifyDataSize - Size of IdentifyData in bytes.\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
\r
- Returns:\r
- EFI_SUCCESS - IdentifyData valid\r
- EFI_NOT_FOUND - Device does not support this data class\r
- EFI_DEVICE_ERROR - Error reading IdentifyData from device\r
- EFI_BUFFER_TOO_SMALL - IdentifyDataSize not big enough\r
+ @param This Protocol instance pointer. \r
+ @param SenseData Results of Request Sense command to device \r
+ @param SenseDataSize Size of SenseData in bytes. \r
+ @param SenseDataNumber Type of SenseData \r
\r
---*/\r
-;\r
+ @retval EFI_SUCCESS InquiryData valid \r
+ @retval EFI_NOT_FOUND Device does not support this data class \r
+ @retval EFI_DEVICE_ERROR Error reading InquiryData from device \r
+ @retval EFI_BUFFER_TOO_SMALL SenseDataSize not big enough \r
\r
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DISK_INFO_SENSE_DATA) (\r
IN OUT UINT32 *SenseDataSize,\r
OUT UINT8 *SenseDataNumber\r
)\r
-/*++\r
-\r
- Routine Description:\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
+;\r
\r
- Arguments:\r
- This - Protocol instance pointer.\r
- SenseData - Results of Request Sense command to device\r
- SenseDataSize - Size of SenseData in bytes.\r
- SenseDataNumber - Type of SenseData\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
\r
- Returns:\r
- EFI_SUCCESS - InquiryData valid\r
- EFI_NOT_FOUND - Device does not support this data class\r
- EFI_DEVICE_ERROR - Error reading InquiryData from device\r
- EFI_BUFFER_TOO_SMALL - SenseDataSize not big enough\r
+ @param This Protocol instance pointer. \r
+ @param IdeChannel Primary or Secondary \r
+ @param IdeDevice Master or Slave \r
\r
---*/\r
-;\r
+ @retval EFI_SUCCESS IdeChannel and IdeDevice are valid \r
+ @retval EFI_UNSUPPORTED This is not an IDE device \r
\r
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DISK_INFO_WHICH_IDE) (\r
OUT UINT32 *IdeChannel,\r
OUT UINT32 *IdeDevice\r
)\r
-/*++\r
-\r
- Routine Description:\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
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- IdeChannel - Primary or Secondary\r
- IdeDevice - Master or Slave\r
-\r
- Returns:\r
- EFI_SUCCESS - IdeChannel and IdeDevice are valid\r
- EFI_UNSUPPORTED - This is not an IDE device\r
-\r
---*/\r
;\r
\r
//\r
-/*++\r
+/** @file\r
+ This is a simple fault tolerant write driver, based on PlatformFd library.\r
+ And it only supports write BufferSize <= SpareAreaLength.\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+Copyright (c) 2006 - 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
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
-Module Name:\r
-\r
- FaultTolerantWriteLite.h\r
-\r
-Abstract:\r
-\r
- This is a simple fault tolerant write driver, based on PlatformFd library.\r
- And it only supports write BufferSize <= SpareAreaLength.\r
-\r
---*/\r
+**/\r
\r
#ifndef __FW_FAULT_TOLERANT_WRITE_LITE_PROTOCOL_H__\r
#define __FW_FAULT_TOLERANT_WRITE_LITE_PROTOCOL_H__\r
//\r
// Protocol API definitions\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
+ manner, ensuring at all times that either the original contents or\r
+ the modified contents are available.\r
\r
+ @param This Calling context \r
+ @param FvBlockHandle The handle of FVB protocol that provides services \r
+ for reading, writing, and erasing the target \r
+ 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 Buffer The data to write. \r
+\r
+ @retval EFI_SUCCESS The function completed successfully \r
+ @retval EFI_ABORTED The function could not complete successfully. \r
+ @retval EFI_BAD_BUFFER_SIZE The write would span a block boundary, which is \r
+ not a valid action. \r
+ @retval EFI_ACCESS_DENIED No writes have been allocated. \r
+ @retval EFI_NOT_READY The last write has not been completed. Restart () \r
+ must be called to complete it. \r
+\r
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI * EFI_FTW_LITE_WRITE) (\r
IN UINTN Offset,\r
IN UINTN *NumBytes,\r
IN VOID *Buffer\r
- );\r
-/*++\r
-\r
-Routine Description:\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
- manner, ensuring at all times that either the original contents or\r
- the modified contents are available.\r
-\r
-Arguments:\r
-\r
- This - Calling context\r
- FvBlockHandle - The handle of FVB protocol that provides services for\r
- reading, writing, and erasing the target block.\r
- Lba - The logical block address of the target block.\r
- Offset - The offset within the target block to place the data.\r
- Length - The number of bytes to write to the target block.\r
- Buffer - The data to write.\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - The function completed successfully\r
- EFI_ABORTED - The function could not complete successfully.\r
- EFI_BAD_BUFFER_SIZE - The write would span a block boundary,\r
- which is not a valid action.\r
- EFI_ACCESS_DENIED - No writes have been allocated.\r
- EFI_NOT_READY - The last write has not been completed.\r
- Restart () must be called to complete it.\r
-\r
---*/\r
+ )\r
+;\r
\r
//\r
// Protocol declaration\r
-/*++\r
+/** @file\r
+ The EFI generic memory test protocol interface.\r
+ For more information please look at EfiMemoryTest.doc\r
\r
-Copyright (c) 2006, Intel Corporation \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
+Copyright (c) 2006 - 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
-Module Name:\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
- GenericMemoryTest.h\r
-\r
-Abstract:\r
-\r
- The EFI generic memory test protocol\r
- For more information please look at EfiMemoryTest.doc\r
-\r
---*/\r
+**/\r
\r
#ifndef __GENERIC_MEMORY_TEST_H__\r
#define __GENERIC_MEMORY_TEST_H__\r
MAXLEVEL\r
} EXTENDMEM_COVERAGE_LEVEL;\r
\r
+\r
+/**\r
+ Initialize the generic memory test.\r
+\r
+ @param This Protocol instance pointer. \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
+ that the memory test driver have not detect any \r
+ non-tested extended memory of current system. \r
+\r
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_MEMORY_TEST_INIT) (\r
IN EXTENDMEM_COVERAGE_LEVEL Level,\r
OUT BOOLEAN *RequireSoftECCInit\r
)\r
-/*++\r
+;\r
\r
- Routine Description:\r
- Initialize the generic memory test.\r
\r
- Arguments:\r
- This - Protocol instance pointer.\r
- Level - The coverage level of the memory test.\r
- RequireSoftECCInit - Indicate if the memory need software ECC init.\r
+/**\r
+ Perform the memory test.\r
\r
- Returns:\r
- EFI_SUCCESS - The generic memory test initialized correctly.\r
- EFI_NO_MEDIA - There is not any non-tested memory found, in this\r
- function if not any non-tesed memory found means \r
- that the memory test driver have not detect any\r
- non-tested extended memory of current system.\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
---*/\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
\r
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PERFORM_MEMORY_TEST) (\r
OUT BOOLEAN *ErrorOut,\r
IN BOOLEAN IfTestAbort\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Perform the memory test.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- TestedMemorySize - Return the tested extended memory size.\r
- 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
- ErrorOut - Any time the memory error occurs, this will be TRUE.\r
- IfTestAbort - Indicate if the user press "ESC" to skip the memory\r
- test.\r
-\r
- Returns:\r
- EFI_SUCCESS - One block of memory test ok, the block size is hide\r
- internally.\r
- EFI_NOT_FOUND - Indicate all the non-tested memory blocks have \r
- already go through.\r
-\r
---*/\r
;\r
\r
+\r
+/**\r
+ The memory test finished.\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
+\r
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_MEMORY_TEST_FINISHED) (\r
IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This\r
)\r
-/*++\r
-\r
- Routine Description:\r
- The memory test finished.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
+;\r
\r
- Returns:\r
- 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
+/**\r
+ Provide capability to test compatible range which used by some sepcial\r
+ driver required using memory range before BDS perform memory test.\r
\r
---*/\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
\r
+ @retval EFI_SUCCESS The compatible memory range pass the memory test. \r
+ @retval EFI_DEVICE_ERROR The compatible memory range test find memory error \r
+ and also return return the error address. \r
+\r
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_MEMORY_TEST_COMPATIBLE_RANGE) (\r
IN EFI_PHYSICAL_ADDRESS StartAddress,\r
IN UINT64 Length\r
)\r
-/*++\r
- \r
- Routine Description:\r
- Provide capability to test compatible range which used by some sepcial\r
- driver required using memory range before BDS perform memory test.\r
- \r
- Arguments:\r
- This - Protocol instance pointer.\r
- StartAddress - The start address of the memory range.\r
- Length - The memory range's length.\r
- \r
- Return:\r
- EFI_SUCCESS - The compatible memory range pass the memory test.\r
- EFI_DEVICE_ERROR - The compatible memory range test find memory error\r
- and also return return the error address.\r
- \r
---*/\r
;\r
\r
struct _EFI_GENERIC_MEMORY_TEST_PROTOCOL {\r
-/*++\r
+/** @file\r
+ EFI OEM Badging Protocol definition header file\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+Copyright (c) 2006 - 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
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
-Module Name:\r
-\r
- EfiOEMBadging.h\r
-\r
-Abstract:\r
-\r
- EFI OEM Badging Protocol definition header file\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
#ifndef __EFI_OEM_BADGING_H__\r
#define __EFI_OEM_BADGING_H__\r
-/*++\r
+/** @file\r
+ Performance protocol interfaces to support cross module performance logging. \r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+Copyright (c) 2006 - 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
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
-Module Name:\r
-\r
- Performance.h\r
-\r
-Abstract:\r
-\r
-\r
---*/\r
+**/\r
\r
#ifndef __PERFORMANCE_H__\r
#define __PERFORMANCE_H__\r
projects / mirror_edk2.git / commitdiff