]> git.proxmox.com Git - mirror_edk2.git/commitdiff
Add comments and DoxyGen format for these files.
authorlgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 9 Apr 2008 07:00:57 +0000 (07:00 +0000)
committerlgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 9 Apr 2008 07:00:57 +0000 (07:00 +0000)
Remove the unused module Crc32SectionExtractDxe, which is replaced by Crc32SectionExtract library instance.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5027 6f19259b-4bc3-4df7-8a09-765794883524

MdeModulePkg/Universal/FirmwareVolume/Crc32SectionExtractDxe/Crc32SectionExtract.c [deleted file]
MdeModulePkg/Universal/FirmwareVolume/Crc32SectionExtractDxe/Crc32SectionExtract.h [deleted file]
MdeModulePkg/Universal/FirmwareVolume/Crc32SectionExtractDxe/Crc32SectionExtract.msa [deleted file]
MdeModulePkg/Universal/FirmwareVolume/Crc32SectionExtractDxe/Crc32SectionExtractDxe.inf [deleted file]
MdeModulePkg/Universal/FirmwareVolume/FaultTolerantWriteDxe/FtwLite.c
MdeModulePkg/Universal/FirmwareVolume/FaultTolerantWriteDxe/FtwLite.h
MdeModulePkg/Universal/FirmwareVolume/FaultTolerantWriteDxe/FtwMisc.c
MdeModulePkg/Universal/FirmwareVolume/FaultTolerantWriteDxe/FtwWorkSpace.c
MdeModulePkg/Universal/FirmwareVolume/FaultTolerantWriteDxe/Ia32/Ia32FtwMisc.c
MdeModulePkg/Universal/FirmwareVolume/FaultTolerantWriteDxe/Ipf/IpfFtwMisc.c
MdeModulePkg/Universal/FirmwareVolume/FaultTolerantWriteDxe/x64/x64FtwMisc.c

diff --git a/MdeModulePkg/Universal/FirmwareVolume/Crc32SectionExtractDxe/Crc32SectionExtract.c b/MdeModulePkg/Universal/FirmwareVolume/Crc32SectionExtractDxe/Crc32SectionExtract.c
deleted file mode 100644 (file)
index ca5ee21..0000000
+++ /dev/null
@@ -1,265 +0,0 @@
-/*++\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
-\r
-Module Name:\r
-\r
-  Crc32SectionExtract.c\r
-\r
-Abstract:\r
-\r
-  Implements GUIDed section extraction protocol interface with \r
-  a specific GUID: CRC32.\r
-\r
-  Please refer to the Framewokr Firmware Volume Specification 0.9.\r
-\r
---*/\r
-\r
-\r
-#include <Crc32SectionExtract.h>\r
-\r
-EFI_STATUS\r
-GuidedSectionExtractionProtocolConstructor (\r
-  OUT EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL      **GuidedSep,\r
-  IN  EFI_EXTRACT_GUIDED_SECTION                  ExtractSection\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Constructor for the GUIDed section extraction protocol.  Initializes\r
-  instance data.\r
-\r
-Arguments:\r
-\r
-  This      Instance to construct\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS:  Instance initialized.\r
-\r
---*/\r
-// TODO:    GuidedSep - add argument and description to function comment\r
-// TODO:    ExtractSection - add argument and description to function comment\r
-// TODO:    EFI_OUT_OF_RESOURCES - add return value to function comment\r
-{\r
-  *GuidedSep = AllocatePool (sizeof (EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL));\r
-  if (*GuidedSep == NULL) {\r
-    return EFI_OUT_OF_RESOURCES;\r
-  }\r
-\r
-  (*GuidedSep)->ExtractSection = ExtractSection;\r
-\r
-  return EFI_SUCCESS;\r
-}\r
-\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-InitializeCrc32GuidedSectionExtractionProtocol (\r
-  IN EFI_HANDLE                   ImageHandle,\r
-  IN EFI_SYSTEM_TABLE             *SystemTable\r
-  )\r
-/*++\r
-\r
-Routine Description: \r
-\r
-  Entry point of the CRC32 GUIDed section extraction protocol. \r
-  Creates and initializes an instance of the GUIDed section \r
-  extraction protocol with CRC32 GUID.\r
-\r
-Arguments:  \r
-\r
-  ImageHandle   EFI_HANDLE: A handle for the image that is initializing \r
-                this driver\r
-  SystemTable   EFI_SYSTEM_TABLE: A pointer to the EFI system table        \r
-\r
-Returns:  \r
-\r
-  EFI_SUCCESS:          Driver initialized successfully\r
-  EFI_LOAD_ERROR:       Failed to Initialize or has been loaded \r
-  EFI_OUT_OF_RESOURCES: Could not allocate needed resources\r
-\r
---*/\r
-{\r
-  EFI_STATUS                              Status;\r
-  EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL  *Crc32GuidedSep;\r
-  EFI_HANDLE                              Handle;\r
-\r
-  //\r
-  // Call all constructors per produced protocols\r
-  //\r
-  Status = GuidedSectionExtractionProtocolConstructor (\r
-            &Crc32GuidedSep,\r
-            (EFI_EXTRACT_GUIDED_SECTION) Crc32ExtractSection\r
-            );\r
-  if (EFI_ERROR (Status)) {\r
-    if (Crc32GuidedSep != NULL) {\r
-      FreePool (Crc32GuidedSep);\r
-    }\r
-\r
-    return Status;\r
-  }\r
-  //\r
-  // Pass in a NULL to install to a new handle\r
-  //\r
-  Handle = NULL;\r
-  Status = gBS->InstallProtocolInterface (\r
-                  &Handle,\r
-                  &gEfiCrc32GuidedSectionExtractionProtocolGuid,\r
-                  EFI_NATIVE_INTERFACE,\r
-                  Crc32GuidedSep\r
-                  );\r
-  if (EFI_ERROR (Status)) {\r
-    FreePool (Crc32GuidedSep);\r
-    return EFI_LOAD_ERROR;\r
-  }\r
-\r
-  return EFI_SUCCESS;\r
-}\r
-\r
-STATIC\r
-UINT32\r
-EFIAPI\r
-GetSectionLength (\r
-  IN EFI_COMMON_SECTION_HEADER  *CommonHeader\r
-  )\r
-/*++\r
-\r
-  Routine Description:\r
-    Get a length of section.\r
-\r
-  Parameters:\r
-    CommonHeader      -   Pointer to the common section header.\r
-\r
-  Return Value:\r
-    The length of the section, including the section header.\r
-\r
---*/\r
-// TODO: function comment is missing 'Arguments:'\r
-// TODO: function comment is missing 'Returns:'\r
-// TODO:    CommonHeader - add argument and description to function comment\r
-{\r
-  UINT32  Size;\r
-\r
-  Size = *(UINT32 *) CommonHeader->Size & 0x00FFFFFF;\r
-\r
-  return Size;\r
-}\r
-\r
-STATIC\r
-EFI_STATUS\r
-EFIAPI\r
-Crc32ExtractSection (\r
-  IN  EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL  *This,\r
-  IN  VOID                                    *InputSection,\r
-  OUT VOID                                    **OutputBuffer,\r
-  OUT UINTN                                   *OutputSize,\r
-  OUT UINT32                                  *AuthenticationStatus\r
-  )\r
-/*++\r
-\r
-  Routine Description:\r
-    This function reads and extracts contents of a section from an\r
-    encapsulating section.\r
-\r
-  Parameters:\r
-    This                    - Indicates the calling context.\r
-    InputSection            - Buffer containing the input GUIDed section \r
-                              to be processed.\r
-    OutputBuffer            - *OutputBuffer is allocated from boot services\r
-                              pool memory and containing the new section\r
-                              stream. The caller is responsible for freeing\r
-                              this buffer.\r
-    AuthenticationStatus    - Pointer to a caller allocated UINT32 that\r
-                              indicates the authentication status of the\r
-                              output buffer\r
-\r
-  Return Value:\r
-    EFI_SUCCESS\r
-    EFI_OUT_OF_RESOURCES\r
-    EFI_INVALID_PARAMETER\r
-    EFI_NOT_AVAILABLE_YET\r
-\r
---*/\r
-// TODO: function comment is missing 'Arguments:'\r
-// TODO: function comment is missing 'Returns:'\r
-// TODO:    This - add argument and description to function comment\r
-// TODO:    InputSection - add argument and description to function comment\r
-// TODO:    OutputBuffer - add argument and description to function comment\r
-// TODO:    OutputSize - add argument and description to function comment\r
-// TODO:    AuthenticationStatus - add argument and description to function comment\r
-// TODO:    EFI_INVALID_PARAMETER - add return value to function comment\r
-// TODO:    EFI_INVALID_PARAMETER - add return value to function comment\r
-// TODO:    EFI_OUT_OF_RESOURCES - add return value to function comment\r
-// TODO:    EFI_SUCCESS - add return value to function comment\r
-{\r
-  EFI_STATUS                Status;\r
-  CRC32_SECTION_HEADER      *Crc32SectionHeader;\r
-  EFI_GUID_DEFINED_SECTION  *GuidedSectionHeader;\r
-  UINT8                     *Image;\r
-  UINT32                    Crc32Checksum;\r
-  VOID                      *DummyInterface;\r
-\r
-  if (OutputBuffer == NULL) {\r
-    return EFI_INVALID_PARAMETER;\r
-  }\r
-\r
-  *OutputBuffer = NULL;\r
-\r
-  //\r
-  // Points to the section header\r
-  //\r
-  Crc32SectionHeader  = (CRC32_SECTION_HEADER *) InputSection;\r
-  GuidedSectionHeader = (EFI_GUID_DEFINED_SECTION *) InputSection;\r
-\r
-  //\r
-  // Check if the GUID is a CRC32 section GUID\r
-  //\r
-  if (!CompareGuid (\r
-        &(GuidedSectionHeader->SectionDefinitionGuid),\r
-        &gEfiCrc32GuidedSectionExtractionProtocolGuid\r
-        )) {\r
-    return EFI_INVALID_PARAMETER;\r
-  }\r
-\r
-  Image = (UINT8 *) InputSection + (UINT32) (GuidedSectionHeader->DataOffset);\r
-  *OutputSize = GetSectionLength ((EFI_COMMON_SECTION_HEADER *) InputSection) - (UINT32) GuidedSectionHeader->DataOffset;\r
-\r
-  *OutputBuffer = AllocatePool (*OutputSize);\r
-  if (*OutputBuffer == NULL) {\r
-    return EFI_OUT_OF_RESOURCES;\r
-  }\r
-  //\r
-  // Implictly CRC32 GUIDed section should have STATUS_VALID bit set\r
-  //\r
-  ASSERT (GuidedSectionHeader->Attributes & EFI_GUIDED_SECTION_AUTH_STATUS_VALID);\r
-  *AuthenticationStatus = EFI_AUTH_STATUS_IMAGE_SIGNED;\r
-\r
-  //\r
-  // Check whether there exists EFI_SECURITY_POLICY_PROTOCOL_GUID.\r
-  //\r
-  Status = gBS->LocateProtocol (&gEfiSecurityPolicyProtocolGuid, NULL, &DummyInterface);\r
-  if (!EFI_ERROR (Status)) {\r
-    *AuthenticationStatus |= EFI_AUTH_STATUS_PLATFORM_OVERRIDE;\r
-  } else {\r
-    //\r
-    // Calculate CRC32 Checksum of Image\r
-    //\r
-    gBS->CalculateCrc32 (Image, *OutputSize, &Crc32Checksum);\r
-    if (Crc32Checksum != Crc32SectionHeader->CRC32Checksum) {\r
-      *AuthenticationStatus |= EFI_AUTH_STATUS_TEST_FAILED;\r
-    }\r
-  }\r
-\r
-  CopyMem (*OutputBuffer, Image, *OutputSize);\r
-\r
-  return EFI_SUCCESS;\r
-}\r
diff --git a/MdeModulePkg/Universal/FirmwareVolume/Crc32SectionExtractDxe/Crc32SectionExtract.h b/MdeModulePkg/Universal/FirmwareVolume/Crc32SectionExtractDxe/Crc32SectionExtract.h
deleted file mode 100644 (file)
index e7bf276..0000000
+++ /dev/null
@@ -1,105 +0,0 @@
-/*++\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
-\r
-Module Name:\r
-\r
-  Crc32SectionExtract.h\r
-  \r
-Abstract:\r
-\r
-  Header file for Crc32SectionExtract.c\r
-  Please refer to the Framewokr Firmware Volume Specification 0.9.\r
-\r
---*/\r
-\r
-#ifndef _CRC32_GUIDED_SECTION_EXTRACTION_H\r
-#define _CRC32_GUIDED_SECTION_EXTRACTION_H\r
-\r
-#include <PiDxe.h>\r
-#include <Protocol/SecurityPolicy.h>\r
-#include <Protocol/Crc32GuidedSectionExtraction.h>\r
-#include <Library/MemoryAllocationLib.h>\r
-#include <Library/DebugLib.h>\r
-#include <Library/UefiDriverEntryPoint.h>\r
-#include <Library/BaseMemoryLib.h>\r
-#include <Library/UefiBootServicesTableLib.h>\r
-\r
-\r
-\r
-typedef struct {\r
-  EFI_GUID_DEFINED_SECTION  GuidedSectionHeader;\r
-  UINT32                    CRC32Checksum;\r
-} CRC32_SECTION_HEADER;\r
-\r
-//\r
-// Function prototype declarations\r
-//\r
-STATIC\r
-EFI_STATUS\r
-EFIAPI\r
-Crc32ExtractSection (\r
-  IN  EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL  *This,\r
-  IN  VOID                                    *InputSection,\r
-  OUT VOID                                    **OutputBuffer,\r
-  OUT UINTN                                   *OutputSize,\r
-  OUT UINT32                                  *AuthenticationStatus\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  This                  - TODO: add argument description\r
-  InputSection          - TODO: add argument description\r
-  OutputBuffer          - TODO: add argument description\r
-  OutputSize            - TODO: add argument description\r
-  AuthenticationStatus  - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
---*/\r
-;\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-InitializeCrc32GuidedSectionExtractionProtocol (\r
-  IN EFI_HANDLE                   ImageHandle,\r
-  IN EFI_SYSTEM_TABLE             *SystemTable\r
-  )\r
-/*++\r
-\r
-Routine Description: \r
-\r
-  Entry point of the CRC32 GUIDed section extraction protocol. \r
-  Creates and initializes an instance of the GUIDed section \r
-  extraction protocol with CRC32 GUID.\r
-\r
-Arguments:  \r
-\r
-  ImageHandle   EFI_HANDLE: A handle for the image that is initializing \r
-                this driver\r
-  SystemTable   EFI_SYSTEM_TABLE: A pointer to the EFI system table        \r
-\r
-Returns:  \r
-\r
-  EFI_SUCCESS:          Driver initialized successfully\r
-  EFI_LOAD_ERROR:       Failed to Initialize or has been loaded \r
-  EFI_OUT_OF_RESOURCES: Could not allocate needed resources\r
-\r
---*/\r
-;\r
-\r
-#endif\r
diff --git a/MdeModulePkg/Universal/FirmwareVolume/Crc32SectionExtractDxe/Crc32SectionExtract.msa b/MdeModulePkg/Universal/FirmwareVolume/Crc32SectionExtractDxe/Crc32SectionExtract.msa
deleted file mode 100644 (file)
index a4ab182..0000000
+++ /dev/null
@@ -1,66 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>\r
-<ModuleSurfaceArea xmlns="http://www.TianoCore.org/2006/Edk2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">\r
-  <MsaHeader>\r
-    <ModuleName>Crc32SectionExtract</ModuleName>\r
-    <ModuleType>DXE_DRIVER</ModuleType>\r
-    <GuidValue>51C9F40C-5243-4473-B265-B3C8FFAFF9FA</GuidValue>\r
-    <Version>1.0</Version>\r
-    <Abstract>Component description file for Crc32SectionExtract module.</Abstract>\r
-    <Description>This driver implements CRC32 GUIDed section extraction protocol interface.</Description>\r
-    <Copyright>Copyright (c) 2006 - 2007, Intel Corporation</Copyright>\r
-    <License>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
-      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.</License>\r
-    <Specification>FRAMEWORK_BUILD_PACKAGING_SPECIFICATION   0x00000052</Specification>\r
-  </MsaHeader>\r
-  <ModuleDefinitions>\r
-    <SupportedArchitectures>IA32 X64 IPF EBC</SupportedArchitectures>\r
-    <BinaryModule>false</BinaryModule>\r
-    <OutputFileBasename>Crc32SectionExtract</OutputFileBasename>\r
-  </ModuleDefinitions>\r
-  <LibraryClassDefinitions>\r
-    <LibraryClass Usage="ALWAYS_CONSUMED">\r
-      <Keyword>DebugLib</Keyword>\r
-    </LibraryClass>\r
-    <LibraryClass Usage="ALWAYS_CONSUMED">\r
-      <Keyword>UefiDriverEntryPoint</Keyword>\r
-    </LibraryClass>\r
-    <LibraryClass Usage="ALWAYS_CONSUMED">\r
-      <Keyword>BaseMemoryLib</Keyword>\r
-    </LibraryClass>\r
-    <LibraryClass Usage="ALWAYS_CONSUMED">\r
-      <Keyword>UefiBootServicesTableLib</Keyword>\r
-    </LibraryClass>\r
-    <LibraryClass Usage="ALWAYS_CONSUMED">\r
-      <Keyword>MemoryAllocationLib</Keyword>\r
-    </LibraryClass>\r
-  </LibraryClassDefinitions>\r
-  <SourceFiles>\r
-    <Filename>Crc32SectionExtract.c</Filename>\r
-    <Filename>Crc32SectionExtract.h</Filename>\r
-    <Filename>GuidedSection.c</Filename>\r
-    <Filename>GuidedSection.h</Filename>\r
-    <Filename>Crc32SectionExtract.dxs</Filename>\r
-  </SourceFiles>\r
-  <PackageDependencies>\r
-    <Package PackageGuid="1E73767F-8F52-4603-AEB4-F29B510B6766"/>\r
-  </PackageDependencies>\r
-  <Protocols>\r
-    <Protocol Usage="SOMETIMES_CONSUMED">\r
-      <ProtocolCName>gEfiSecurityPolicyProtocolGuid</ProtocolCName>\r
-    </Protocol>\r
-    <Protocol Usage="ALWAYS_PRODUCED">\r
-      <ProtocolCName>gEfiCrc32GuidedSectionExtractionProtocolGuid</ProtocolCName>\r
-    </Protocol>\r
-  </Protocols>\r
-  <Externs>\r
-    <Specification>EFI_SPECIFICATION_VERSION 0x00020000</Specification>\r
-    <Specification>EDK_RELEASE_VERSION 0x00020000</Specification>\r
-    <Extern>\r
-      <ModuleEntryPoint>InitializeCrc32GuidedSectionExtractionProtocol</ModuleEntryPoint>\r
-    </Extern>\r
-  </Externs>\r
-</ModuleSurfaceArea>\r
diff --git a/MdeModulePkg/Universal/FirmwareVolume/Crc32SectionExtractDxe/Crc32SectionExtractDxe.inf b/MdeModulePkg/Universal/FirmwareVolume/Crc32SectionExtractDxe/Crc32SectionExtractDxe.inf
deleted file mode 100644 (file)
index 6b60d97..0000000
+++ /dev/null
@@ -1,54 +0,0 @@
-#/** @file\r
-# Component description file for Crc32SectionExtract module.\r
-#\r
-# This driver implements CRC32 GUIDed section extraction protocol interface.\r
-# Copyright (c) 2006 - 2007, Intel Corporation\r
-#\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
-#  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
-[Defines]\r
-  INF_VERSION                    = 0x00010005\r
-  BASE_NAME                      = Crc32SectionExtractDxe\r
-  FILE_GUID                      = 51C9F40C-5243-4473-B265-B3C8FFAFF9FA\r
-  MODULE_TYPE                    = DXE_DRIVER\r
-  VERSION_STRING                 = 1.0\r
-  EDK_RELEASE_VERSION            = 0x00020000\r
-  EFI_SPECIFICATION_VERSION      = 0x00020000\r
-\r
-  ENTRY_POINT                    = InitializeCrc32GuidedSectionExtractionProtocol\r
-\r
-#\r
-# The following information is for reference only and not required by the build tools.\r
-#\r
-#  VALID_ARCHITECTURES           = IA32 X64 IPF EBC\r
-#\r
-\r
-[Sources.common]\r
-  Crc32SectionExtract.h\r
-  Crc32SectionExtract.c\r
-\r
-[Packages]\r
-  MdePkg/MdePkg.dec\r
-  MdeModulePkg/MdeModulePkg.dec\r
-\r
-[LibraryClasses]\r
-  MemoryAllocationLib\r
-  UefiBootServicesTableLib\r
-  BaseMemoryLib\r
-  UefiDriverEntryPoint\r
-  DebugLib\r
-\r
-[Protocols]\r
-  gEfiSecurityPolicyProtocolGuid                # PROTOCOL SOMETIMES_CONSUMED\r
-  gEfiCrc32GuidedSectionExtractionProtocolGuid  # PROTOCOL ALWAYS_PRODUCED\r
-\r
-[Depex]\r
-  gEfiRuntimeArchProtocolGuid\r
index 81d6f6bd70b1e2983e81698700eb0ba1167f3953..25836c470a2a1877c97f235581b000e21c2e20d8 100644 (file)
@@ -1,22 +1,6 @@
-/*++\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
-\r
-\r
-Module Name:\r
-\r
-  FtwLite.c\r
+/** @file\r
 \r
-Abstract:\r
-\r
-  This is a simple fault tolerant write driver, based on PlatformFd library.\r
+  This is a simple fault tolerant write driver.\r
   And it only supports write BufferSize <= SpareAreaLength.\r
 \r
   This boot service only protocol provides fault tolerant write capability for \r
@@ -24,13 +8,20 @@ Abstract:
   of the data and private information. It should be able to recover \r
   automatically from a critical fault, such as power failure. \r
 \r
-Notes:\r
-\r
   The implementation uses an FTW Lite (Fault Tolerant Write) Work Space. \r
   This work space is a memory copy of the work space on the Woring Block,\r
   the size of the work space is the FTW_WORK_SPACE_SIZE bytes.\r
 \r
---*/\r
+Copyright (c) 2006 - 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
+\r
+**/\r
 \r
 #include <FtwLite.h>\r
 \r
index 4ce98eb3572c45dc09348fbebb517126954207ef..ab775c19679de5db3b489b2b985456e88ad063a7 100644 (file)
@@ -1,6 +1,9 @@
-/*++\r
+/** @file\r
+\r
+  The internal header file includes the common header files, defines\r
+  internal structure and functions used by FtwLite module.\r
 \r
-Copyright (c) 2006, Intel Corporation                                                         \r
+Copyright (c) 2006 - 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
@@ -9,22 +12,7 @@ http://opensource.org/licenses/bsd-license.php
 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
-Module Name:\r
-\r
-  FtwLite.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
-  This boot service only protocol provides fault tolerant write capability for \r
-  block devices.  The protocol has internal non-volatile intermediate storage \r
-  of the data and private information. It should be able to recover \r
-  automatically from a critical fault, such as power failure. \r
-\r
---*/\r
+**/\r
 \r
 #ifndef _EFI_FAULT_TOLERANT_WRITE_LITE_H_\r
 #define _EFI_FAULT_TOLERANT_WRITE_LITE_H_\r
index eb334eaedd917ffcc7a831a532dc3b5b637c73c7..fccf889a3d057207535ee1c5e0e5e9d50875436f 100644 (file)
@@ -1,6 +1,8 @@
-/*++\r
+/** @file\r
+\r
+  Internal generic functions to support fault tolerant write.\r
 \r
-Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+Copyright (c) 2006 - 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
@@ -9,17 +11,7 @@ http://opensource.org/licenses/bsd-license.php
 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
-  FtwMisc.c\r
-  \r
-Abstract:\r
-  \r
-  Internal functions to support fault tolerant write.\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
 \r
 #include <FtwLite.h>\r
 \r
index 00d7d8e912cf5c62691578fb8c2974fb467b25e5..d4dbf1ce8e5a3f7a27da5a9fa26b467aef2b7786 100644 (file)
@@ -1,6 +1,8 @@
-/*++\r
+/** @file\r
+\r
+   Internal functions to operate Working Block Space.\r
 \r
-Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+Copyright (c) 2006 - 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
@@ -9,15 +11,7 @@ http://opensource.org/licenses/bsd-license.php
 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
-  FtwWorkSpace.c\r
-  \r
-Abstract:\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
 \r
 \r
 #include <FtwLite.h>\r
index 6425f29b2c475fe5882eb03af9f259995b55a9de..2ca858c4dd4b52dbf5f581fedb83bf1bed084d3c 100644 (file)
@@ -1,6 +1,8 @@
-/*++\r
-\r
-Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+/** @file\r
+  \r
+  Ia32 platform related code to support FtwLite.\r
+  \r
+Copyright (c) 2006 - 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
@@ -9,17 +11,7 @@ http://opensource.org/licenses/bsd-license.php
 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
-  Ia32FtwMisc.c\r
-  \r
-Abstract:\r
-  \r
-   Ia32 platform related code to support FtwLite..\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
 \r
 \r
 #include <FtwLite.h>\r
index d31883b2ee7d05b3f2b5b0730130514e3575d675..20b7f566b92cc202dc6ef2b13c57b9156a92c1f9 100644 (file)
@@ -1,6 +1,8 @@
-/*++\r
+/** @file\r
+\r
+  Ipf platform related code to support FtwLite..\r
 \r
-Copyright (c) 2006, Intel Corporation                                                         \r
+Copyright (c) 2006 - 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
@@ -9,17 +11,7 @@ http://opensource.org/licenses/bsd-license.php
 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
-  IpfFtwMisc.c\r
-  \r
-Abstract:\r
-  \r
-  Ipf platform related code to support FtwLite..\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
 \r
 \r
 #include <FtwLite.h>\r
index d8e3a03fdefc776c3151862dab9813ff8f1ea70a..b782b2042d8e0b0d0d0892390c964224f5a19d5c 100644 (file)
@@ -1,7 +1,8 @@
-\r
-/*++\r
-\r
-Copyright (c) 2006, Intel Corporation                                                         \r
+/** \r
+  \r
+  X64 platform related code to support FtwLite.\r
+  \r
+Copyright (c) 2006 - 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
@@ -10,17 +11,7 @@ http://opensource.org/licenses/bsd-license.php
 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
-  x64FtwMisc.c\r
-  \r
-Abstract:\r
-  \r
-  X64 platform related code to support FtwLite..\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
 \r
 \r
 #include <FtwLite.h>\r