Add some function/header comments.
authorklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 10 Apr 2008 07:13:54 +0000 (07:13 +0000)
committerklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 10 Apr 2008 07:13:54 +0000 (07:13 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5037 6f19259b-4bc3-4df7-8a09-765794883524

17 files changed:
IntelFrameworkModulePkg/Include/Guid/CustomDecompress.h
IntelFrameworkModulePkg/Include/Guid/DataHubProducer.h
IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
IntelFrameworkModulePkg/Include/Guid/PciHotplugDevice.h
IntelFrameworkModulePkg/Include/Guid/PciOptionRomTable.h
IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h
IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h
IntelFrameworkModulePkg/Library/BaseReportStatusCodeLib/BaseReportStatusCodeLib.c
IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.c
IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeSupport.c
IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/ReportStatusCodeLib.c
IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/ReportStatusCodeLibInternal.h
IntelFrameworkModulePkg/Library/GraphicsLib/Graphics.c
IntelFrameworkModulePkg/Library/OemHookStatusCodeLibNull/OemHookStatusCodeLibNull.c
IntelFrameworkModulePkg/Library/PeiReportStatusCodeLib/ReportStatusCodeLib.c
IntelFrameworkModulePkg/Library/SmmRuntimeDxeReportStatusCodeLibFramework/ReportStatusCodeLib.c
IntelFrameworkModulePkg/Library/SmmRuntimeDxeReportStatusCodeLibFramework/SmmRuntimeDxeSupport.c

index c03524e02b98fa4f72d7dad12ecc8d16c711b2af..3e98785c2ba309c2a48b6549ac190b31e61a2f76 100644 (file)
@@ -1,5 +1,6 @@
 /** @file\r
-\r
+  Custom decompress Guid definitions\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
@@ -9,20 +10,12 @@ 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
-  CustomDecompress.h\r
-\r
-Abstract:\r
-\r
-  Custom decompress Guid definitions\r
-\r
 **/\r
 \r
 #ifndef __EFI_CUSTOM_DECOMPRESS_GUID_H__\r
 #define __EFI_CUSTOM_DECOMPRESS_GUID_H__\r
 \r
-#define TINAO_CUSTOM_DECOMPRESS_GUID  \\r
+#define TIANO_CUSTOM_DECOMPRESS_GUID  \\r
   { 0xA31280AD, 0x481E, 0x41B6, { 0x95, 0xE8, 0x12, 0x7F, 0x4C, 0x98, 0x47, 0x79 } }\r
 \r
 extern GUID gTianoCustomDecompressGuid;\r
index ec7c1fdb89e376c4e24fe28d0159cceb6674e0e8..0385be1de1147d0406dde1df36c597d654b62972 100644 (file)
@@ -36,5 +36,4 @@ extern  EFI_GUID gEfiMemoryProducerGuid;
 \r
 extern  EFI_GUID gEfiMiscProducerGuid;\r
 \r
-\r
-#endif\r
+#endif // _DATAHUB_PRODUCER_H_\r
index 54382f4ef33da0fb7a4afa148947865ff9ec3c2a..34c1fefe373d9be0ba3353fbc166941d28126362 100644 (file)
@@ -32,4 +32,5 @@ typedef struct {
 \r
 extern EFI_GUID gEfiDataHubStatusCodeRecordGuid;\r
 \r
-#endif\r
+#endif // __STATUS_CODE_H__\r
+\r
index 197a0465b741dac001ef2ed1a4bf8823b41b30f8..e2c6e7ae84a10ed54bdffcda8bf777e5140d2d45 100644 (file)
@@ -20,4 +20,5 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 extern EFI_GUID gEfiPciHotplugDeviceGuid;\r
 \r
-#endif\r
+#endif // __PCI_HOTPLUG_DEVICE_GUID_H_\r
+\r
index ef9e345de53332022bf11117ee6e7ec814be8810..32ab10ac3d2221073ad37f2d492b3b70354ac90c 100644 (file)
@@ -37,4 +37,5 @@ typedef struct {
   EFI_PCI_OPTION_ROM_DESCRIPTOR   *PciOptionRomDescriptors;\r
 } EFI_PCI_OPTION_ROM_TABLE;\r
 \r
-#endif\r
+#endif // __PCI_OPTION_ROM_TABLE_GUID_H_\r
+\r
index b26189c941de4b445f848589b6ce388c97a347fe..5f5726ea8a36608907adce8b477b8357b29fd442 100644 (file)
@@ -1,4 +1,3 @@
-\r
 /** @file\r
   OEM hook status code library functions with no library constructor/destructor\r
 \r
@@ -11,8 +10,6 @@
   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:  OemHookStatusCodeLib.h\r
-\r
 **/\r
 \r
 #ifndef __OEM_HOOK_STATUSCODE_LIB__\r
@@ -70,4 +67,5 @@ OemHookStatusCodeReport (
   IN EFI_STATUS_CODE_DATA     *Data      OPTIONAL\r
   );\r
 \r
-#endif\r
+#endif // __OEM_HOOK_STATUSCODE_LIB__\r
+\r
index bb9802420cb8d40be847c0e7bb1a280cc034a54b..714028993cbe13664ef854b730df505d16cb51d1 100644 (file)
@@ -22,6 +22,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 typedef struct _EFI_VGA_MINI_PORT_PROTOCOL  EFI_VGA_MINI_PORT_PROTOCOL;\r
 \r
+/**\r
+  Sets the text display mode of a VGA controller\r
+  \r
+  @param This             Protocol instance pointer.\r
+  @param Mode             Mode number.  0 - 80x25   1-80x50\r
+\r
+  @retval EFI_SUCCESS            The mode was set\r
+  @retval EFI_DEVICE_ERROR       The device is not functioning properly.\r
+  \r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_VGA_MINI_PORT_SET_MODE) (\r
@@ -29,20 +39,6 @@ EFI_STATUS
   IN UINTN                               ModeNumber\r
   );\r
 \r
-/*++\r
-\r
-  Routine Description:\r
-    Sets the text display mode of a VGA controller\r
-\r
-  Arguments:\r
-    This                 - Protocol instance pointer.\r
-    Mode                 - Mode number.  0 - 80x25   1-80x50\r
-\r
-  Returns:\r
-    EFI_SUCCESS           - The mode was set\r
-    EFI_DEVICE_ERROR      - The device is not functioning properly.\r
-\r
---*/\r
 struct _EFI_VGA_MINI_PORT_PROTOCOL {\r
   EFI_VGA_MINI_PORT_SET_MODE  SetMode;\r
 \r
index a335ae74c3224039b3e673a199e2b58b9585e897..973e14b07a0cb42b0dfe9217b64d75ec7c30b004 100644 (file)
@@ -1,5 +1,6 @@
 /** @file\r
-  Report Status Code Library for DXE Phase.\r
+  Implementation for ReportStatusCodeLib library class. This \r
+  library instance can be used to any phase: SEC/PEI/DXE.\r
 \r
   Copyright (c) 2006 - 2007, Intel Corporation<BR>\r
   All rights reserved. This program and the accompanying materials\r
@@ -12,7 +13,6 @@
 \r
 **/\r
 \r
-\r
 #include <Base.h>\r
 #include <Framework/StatusCode.h>\r
 #include <Guid/StatusCodeDataTypeId.h>\r
@@ -528,3 +528,4 @@ ReportDebugCodeEnabled (
 {\r
   return (BOOLEAN) ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED) != 0);\r
 }\r
+\r
index d3d99eac2c0f2549ee393e9517c738111e973be8..93b7c110bc3b23fe671a3b3b4ec9f88bd2920baa 100644 (file)
@@ -1,5 +1,8 @@
 /**@file\r
   UEFI and Custom Decompress Library \r
+  The function of UefiTianoDecompress() is interface for this module,\r
+  it will do tiano or uefi decompress with different verison parameter.\r
+  See EFI specification 1.1 Chapter 17 to get LZ77 compress/decompress.\r
   \r
 Copyright (c) 2006, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -15,25 +18,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Guid/CustomDecompress.h>\r
 #include "BaseUefiTianoCustomDecompressLibInternals.h"\r
 \r
+/**\r
+  Shift mBitBuf NumOfBits left. Read in NumOfBits of bits from source.\r
+  \r
+  @param Sd         The global scratch data\r
+  @param NumOfBits  The number of bits to shift and read.  \r
+**/\r
 VOID\r
 FillBuf (\r
   IN  SCRATCH_DATA  *Sd,\r
   IN  UINT16        NumOfBits\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Shift mBitBuf NumOfBits left. Read in NumOfBits of bits from source.\r
-\r
-Arguments:\r
-\r
-  Sd        - The global scratch data\r
-  NumOfBits  - The number of bits to shift and read.\r
-\r
-Returns: (VOID)\r
-\r
---*/\r
 {\r
   Sd->mBitBuf = (UINT32) (Sd->mBitBuf << NumOfBits);\r
 \r
@@ -64,29 +59,24 @@ Returns: (VOID)
   Sd->mBitBuf |= Sd->mSubBitBuf >> Sd->mBitCount;\r
 }\r
 \r
-UINT32\r
-GetBits (\r
-  IN  SCRATCH_DATA  *Sd,\r
-  IN  UINT16        NumOfBits\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
+  Get NumOfBits of bits out from mBitBuf\r
 \r
   Get NumOfBits of bits out from mBitBuf. Fill mBitBuf with subsequent \r
   NumOfBits of bits from source. Returns NumOfBits of bits that are \r
   popped out.\r
 \r
-Arguments:\r
+  @param  Sd        The global scratch data.\r
+  @param  NumOfBits The number of bits to pop and read.\r
 \r
-  Sd            - The global scratch data.\r
-  NumOfBits     - The number of bits to pop and read.\r
+  @return The bits that are popped out.\r
 \r
-Returns:\r
-\r
-  The bits that are popped out.\r
-\r
---*/\r
+**/\r
+UINT32\r
+GetBits (\r
+  IN  SCRATCH_DATA  *Sd,\r
+  IN  UINT16        NumOfBits\r
+  )\r
 {\r
   UINT32  OutBits;\r
 \r
@@ -97,6 +87,22 @@ Returns:
   return OutBits;\r
 }\r
 \r
+/**\r
+  Creates Huffman Code mapping table according to code length array.\r
+\r
+  Creates Huffman Code mapping table for Extra Set, Char&Len Set \r
+  and Position Set according to code length array.\r
+\r
+  @param  Sd        The global scratch data\r
+  @param  NumOfChar Number of symbols in the symbol set\r
+  @param  BitLen    Code length array\r
+  @param  TableBits The width of the mapping table\r
+  @param  Table     The table\r
+\r
+  @retval  0 OK.\r
+  @retval  BAD_TABLE The table is corrupted.\r
+\r
+**/\r
 UINT16\r
 MakeTable (\r
   IN  SCRATCH_DATA  *Sd,\r
@@ -105,26 +111,6 @@ MakeTable (
   IN  UINT16        TableBits,\r
   OUT UINT16        *Table\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Creates Huffman Code mapping table according to code length array.\r
-\r
-Arguments:\r
-\r
-  Sd        - The global scratch data\r
-  NumOfChar - Number of symbols in the symbol set\r
-  BitLen    - Code length array\r
-  TableBits - The width of the mapping table\r
-  Table     - The table\r
-  \r
-Returns:\r
-  \r
-  0         - OK.\r
-  BAD_TABLE - The table is corrupted.\r
-\r
---*/\r
 {\r
   UINT16  Count[17];\r
   UINT16  Weight[17];\r
@@ -235,25 +221,17 @@ Returns:
   return 0;\r
 }\r
 \r
+/**\r
+  Decodes a position value.\r
+  \r
+  @param Sd      the global scratch data\r
+  \r
+  @return The position value decoded.\r
+**/\r
 UINT32\r
 DecodeP (\r
   IN  SCRATCH_DATA  *Sd\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Decodes a position value.\r
-\r
-Arguments:\r
-\r
-  Sd      - the global scratch data\r
-\r
-Returns:\r
-\r
-  The position value decoded.\r
-\r
---*/\r
 {\r
   UINT16  Val;\r
   UINT32  Mask;\r
@@ -288,6 +266,21 @@ Returns:
   return Pos;\r
 }\r
 \r
+/**\r
+  Reads code lengths for the Extra Set or the Position Set.\r
+\r
+  Read in the Extra Set or Pointion Set Length Arrary, then\r
+  generate the Huffman code mapping for them.\r
+\r
+  @param  Sd      The global scratch data.\r
+  @param  nn      Number of symbols.\r
+  @param  nbit    Number of bits needed to represent nn.\r
+  @param  Special The special symbol that needs to be taken care of.\r
+\r
+  @retval  0 OK.\r
+  @retval  BAD_TABLE Table is corrupted.\r
+\r
+**/\r
 UINT16\r
 ReadPTLen (\r
   IN  SCRATCH_DATA  *Sd,\r
@@ -295,25 +288,6 @@ ReadPTLen (
   IN  UINT16        nbit,\r
   IN  UINT16        Special\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Reads code lengths for the Extra Set or the Position Set\r
-\r
-Arguments:\r
-\r
-  Sd        - The global scratch data\r
-  nn        - Number of symbols\r
-  nbit      - Number of bits needed to represent nn\r
-  Special   - The special symbol that needs to be taken care of \r
-\r
-Returns:\r
-\r
-  0         - OK.\r
-  BAD_TABLE - Table is corrupted.\r
-\r
---*/\r
 {\r
   UINT16  Number;\r
   UINT16  CharC;\r
@@ -369,23 +343,19 @@ Returns:
   return MakeTable (Sd, nn, Sd->mPTLen, 8, Sd->mPTTable);\r
 }\r
 \r
+/**\r
+  Reads code lengths for Char&Len Set.\r
+  \r
+  Read in and decode the Char&Len Set Code Length Array, then\r
+  generate the Huffman Code mapping table for the Char&Len Set.\r
+\r
+  @param  Sd the global scratch data\r
+\r
+**/\r
 VOID\r
 ReadCLen (\r
   SCRATCH_DATA  *Sd\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Reads code lengths for Char&Len Set.\r
-\r
-Arguments:\r
-\r
-  Sd    - the global scratch data\r
-\r
-Returns: (VOID)\r
-\r
---*/\r
 {\r
   UINT16  Number;\r
   UINT16  CharC;\r
@@ -462,25 +432,22 @@ Returns: (VOID)
   return ;\r
 }\r
 \r
-UINT16\r
-DecodeC (\r
-  SCRATCH_DATA  *Sd\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
   Decode a character/length value.\r
+  \r
+  Read one value from mBitBuf, Get one code from mBitBuf. If it is at block boundary, generates\r
+  Huffman code mapping table for Extra Set, Code&Len Set and\r
+  Position Set.\r
 \r
-Arguments:\r
-\r
-  Sd    - The global scratch data.\r
-\r
-Returns:\r
+  @param  Sd The global scratch data.\r
 \r
-  The value decoded.\r
+  @return The value decoded.\r
 \r
---*/\r
+**/\r
+UINT16\r
+DecodeC (\r
+  SCRATCH_DATA  *Sd\r
+  )\r
 {\r
   UINT16  Index2;\r
   UINT32  Mask;\r
@@ -527,23 +494,15 @@ Returns:
   return Index2;\r
 }\r
 \r
+/**\r
+  Decode the source data ad put the resulting data into the destination buffer.\r
+  \r
+  @param Sd            - The global scratch data\r
+**/\r
 VOID\r
 Decode (\r
   SCRATCH_DATA  *Sd\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Decode the source data and put the resulting data into the destination buffer.\r
-\r
-Arguments:\r
-\r
-  Sd            - The global scratch data\r
-\r
-Returns: (VOID)\r
-\r
- --*/\r
 {\r
   UINT16  BytesRemain;\r
   UINT32  DataIdx;\r
@@ -595,6 +554,17 @@ Done:
   return ;\r
 }\r
 \r
+/**\r
+  The internal implementation of *_DECOMPRESS_PROTOCOL.GetInfo().\r
+  \r
+  @param Source           The source buffer containing the compressed data.\r
+  @param SourceSize       The size of source buffer\r
+  @param DestinationSize  The size of destination buffer.\r
+  @param ScratchSize      The size of scratch buffer.\r
+\r
+  @retval RETURN_SUCCESS           - The size of destination buffer and the size of scratch buffer are successull retrieved.\r
+  @retval RETURN_INVALID_PARAMETER - The source data is corrupted\r
+**/\r
 RETURN_STATUS\r
 EFIAPI\r
 UefiDecompressGetInfo (\r
@@ -603,25 +573,6 @@ UefiDecompressGetInfo (
   OUT UINT32      *DestinationSize,\r
   OUT UINT32      *ScratchSize\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  The internal implementation of *_DECOMPRESS_PROTOCOL.GetInfo().\r
-\r
-Arguments:\r
-\r
-  Source          - The source buffer containing the compressed data.\r
-  SourceSize      - The size of source buffer\r
-  DestinationSize - The size of destination buffer.\r
-  ScratchSize     - The size of scratch buffer.\r
-\r
-Returns:\r
-\r
-  RETURN_SUCCESS           - The size of destination buffer and the size of scratch buffer are successull retrieved.\r
-  RETURN_INVALID_PARAMETER - The source data is corrupted\r
-\r
---*/\r
 {\r
   UINT32  CompressedSize;\r
 \r
@@ -644,6 +595,17 @@ Returns:
   return RETURN_SUCCESS;\r
 }\r
 \r
+/**\r
+  The internal implementation of *_DECOMPRESS_PROTOCOL.Decompress().\r
+\r
+  @param Source           The source buffer containing the compressed data.\r
+  @param Destination      The destination buffer to store the decompressed data\r
+  @param Scratch          The buffer used internally by the decompress routine. This  buffer is needed to store intermediate data.\r
+  @param Version          1 for UEFI Decompress algoruthm, 2 for Tiano Decompess algorithm\r
+\r
+  @retval RETURN_SUCCESS            Decompression is successfull\r
+  @retval RETURN_INVALID_PARAMETER  The source data is corrupted\r
+**/\r
 RETURN_STATUS\r
 EFIAPI\r
 UefiTianoDecompress (\r
@@ -652,25 +614,6 @@ UefiTianoDecompress (
   IN OUT VOID    *Scratch,\r
   IN UINT32      Version\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  The internal implementation of *_DECOMPRESS_PROTOCOL.Decompress().\r
-\r
-Arguments:\r
-\r
-  Source          - The source buffer containing the compressed data.\r
-  Destination     - The destination buffer to store the decompressed data\r
-  Scratch         - The buffer used internally by the decompress routine. This  buffer is needed to store intermediate data.\r
-  Version         - 1 for UEFI Decompress algoruthm, 2 for Tiano Decompess algorithm\r
-\r
-Returns:\r
-\r
-  RETURN_SUCCESS           - Decompression is successfull\r
-  RETURN_INVALID_PARAMETER - The source data is corrupted\r
-\r
---*/\r
 {\r
   volatile UINT32  Index;\r
   UINT32           CompSize;\r
@@ -743,6 +686,16 @@ Returns:
   return RETURN_SUCCESS;\r
 }\r
 \r
+/**\r
+  The internal implementation of *_DECOMPRESS_PROTOCOL.Decompress().\r
+  \r
+  @param Source          - The source buffer containing the compressed data.\r
+  @param Destination     - The destination buffer to store the decompressed data\r
+  @param Scratch         - The buffer used internally by the decompress routine. This  buffer is needed to store intermediate data.\r
+\r
+  @retval RETURN_SUCCESS           - Decompression is successfull\r
+  @retval RETURN_INVALID_PARAMETER - The source data is corrupted  \r
+**/\r
 RETURN_STATUS\r
 EFIAPI\r
 UefiDecompress (\r
@@ -750,28 +703,22 @@ UefiDecompress (
   IN OUT VOID    *Destination,\r
   IN OUT VOID    *Scratch\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  The internal implementation of *_DECOMPRESS_PROTOCOL.Decompress().\r
-\r
-Arguments:\r
-\r
-  Source          - The source buffer containing the compressed data.\r
-  Destination     - The destination buffer to store the decompressed data\r
-  Scratch         - The buffer used internally by the decompress routine. This  buffer is needed to store intermediate data.\r
-\r
-Returns:\r
-\r
-  RETURN_SUCCESS           - Decompression is successfull\r
-  RETURN_INVALID_PARAMETER - The source data is corrupted\r
-\r
---*/\r
 {\r
   return UefiTianoDecompress (Source, Destination, Scratch, 1);\r
 }\r
 \r
+/**\r
+  The internal implementation of Tiano decompress GetInfo.\r
+\r
+  @param InputSection          Buffer containing the input GUIDed section to be processed. \r
+  @param OutputBufferSize      The size of OutputBuffer.\r
+  @param ScratchBufferSize     The size of ScratchBuffer.\r
+  @param SectionAttribute      The attribute of the input guided section.\r
+\r
+  @retval RETURN_SUCCESS           - The size of destination buffer and the size of scratch buffer are successull retrieved.\r
+  @retval RETURN_INVALID_PARAMETER - The source data is corrupted\r
+                             The GUID in InputSection does not match this instance guid.\r
+**/\r
 RETURN_STATUS\r
 EFIAPI\r
 TianoDecompressGetInfo (\r
@@ -780,25 +727,7 @@ TianoDecompressGetInfo (
   OUT UINT32      *ScratchBufferSize,\r
   OUT UINT16      *SectionAttribute\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  The internal implementation of Tiano decompress GetInfo.\r
-\r
-Arguments:\r
-  InputSection          Buffer containing the input GUIDed section to be processed. \r
-  OutputBufferSize      The size of OutputBuffer.\r
-  ScratchBufferSize     The size of ScratchBuffer.\r
-  SectionAttribute      The attribute of the input guided section.\r
-\r
-Returns:\r
 \r
-  RETURN_SUCCESS           - The size of destination buffer and the size of scratch buffer are successull retrieved.\r
-  RETURN_INVALID_PARAMETER - The source data is corrupted\r
-                             The GUID in InputSection does not match this instance guid.\r
-\r
---*/\r
 {\r
   ASSERT (SectionAttribute != NULL);\r
 \r
@@ -827,6 +756,22 @@ Returns:
          );\r
 }\r
 \r
+/**\r
+  The implementation of Tiano Decompress().\r
+\r
+  @param InputSection           Buffer containing the input GUIDed section to be processed. \r
+  @param OutputBuffer           OutputBuffer to point to the start of the section's contents.\r
+                                if guided data is not prcessed. Otherwise,\r
+                                OutputBuffer to contain the output data, which is allocated by the caller.\r
+  @param ScratchBuffer          A pointer to a caller-allocated buffer for function internal use. \r
+  @param AuthenticationStatus   A pointer to a caller-allocated UINT32 that indicates the\r
+                                authentication status of the output buffer. \r
+\r
+  @retval RETURN_SUCCESS            Decompression is successfull\r
+  @retval RETURN_INVALID_PARAMETER  The source data is corrupted, or\r
+                                    The GUID in InputSection does not match this instance guid.\r
+\r
+--*/\r
 RETURN_STATUS\r
 EFIAPI\r
 TianoDecompress (\r
@@ -835,28 +780,6 @@ TianoDecompress (
   IN        VOID    *ScratchBuffer,        OPTIONAL\r
   OUT       UINT32  *AuthenticationStatus\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  The implementation of Tiano Decompress().\r
-\r
-Arguments:\r
-  InputSection           Buffer containing the input GUIDed section to be processed. \r
-  OutputBuffer           OutputBuffer to point to the start of the section's contents.\r
-                         if guided data is not prcessed. Otherwise,\r
-                         OutputBuffer to contain the output data, which is allocated by the caller.\r
-  ScratchBuffer          A pointer to a caller-allocated buffer for function internal use. \r
-  AuthenticationStatus   A pointer to a caller-allocated UINT32 that indicates the\r
-                         authentication status of the output buffer. 
-\r
-Returns:\r
-\r
-  RETURN_SUCCESS           - Decompression is successfull\r
-  RETURN_INVALID_PARAMETER - The source data is corrupted, or\r
-                             The GUID in InputSection does not match this instance guid.\r
-\r
---*/\r
 {\r
   ASSERT (OutputBuffer != NULL);\r
 \r
@@ -886,11 +809,11 @@ Returns:
          );\r
 }\r
 \r
-/**
+/**\r
   Register TianoDecompress handler.\r
-
+\r
   @retval  RETURN_SUCCESS            Register successfully.\r
-  @retval  RETURN_OUT_OF_RESOURCES   No enough memory to store this handler.
+  @retval  RETURN_OUT_OF_RESOURCES   No enough memory to store this handler.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
index 7c9a62f49ee08beaa2d0ad453b36ef49949f518c..42f7699e225b4b9d2e71b2fb2a4c7e6c4e6c8642 100644 (file)
@@ -15,7 +15,7 @@
 #include "ReportStatusCodeLibInternal.h"\r
 \r
 /**\r
-  Locatet he report status code service.\r
+  Locate he report status code service.\r
 \r
   @return     EFI_REPORT_STATUS_CODE    function point to\r
               ReportStatusCode.\r
@@ -40,7 +40,47 @@ InternalGetReportStatusCode (
   return NULL;\r
 }\r
 \r
+/**\r
+  Reports a status code with full parameters.\r
+\r
+  The function reports a status code.  If ExtendedData is NULL and ExtendedDataSize\r
+  is 0, then an extended data buffer is not reported.  If ExtendedData is not\r
+  NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated.\r
+  ExtendedData is assumed not have the standard status code header, so this function\r
+  is responsible for allocating a buffer large enough for the standard header and\r
+  the extended data passed into this function.  The standard header is filled in\r
+  with a GUID specified by ExtendedDataGuid.  If ExtendedDataGuid is NULL, then a\r
+  GUID of gEfiStatusCodeSpecificDatauid is used.  The status code is reported with\r
+  an instance specified by Instance and a caller ID specified by CallerId.  If\r
+  CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.\r
+\r
+  ReportStatusCodeEx()must actively prevent recursion.  If ReportStatusCodeEx()\r
+  is called while processing another any other Report Status Code Library function,\r
+  then ReportStatusCodeEx() must return EFI_DEVICE_ERROR immediately.\r
+\r
+  If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().\r
+  If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().\r
+\r
+  @param  Type              Status code type.\r
+  @param  Value             Status code value.\r
+  @param  Instance          Status code instance number.\r
+  @param  CallerId          Pointer to a GUID that identifies the caller of this\r
+                            function.  If this parameter is NULL, then a caller\r
+                            ID of gEfiCallerIdGuid is used.\r
+  @param  ExtendedDataGuid  Pointer to the GUID for the extended data buffer.\r
+                            If this parameter is NULL, then a the status code\r
+                            standard header is filled in with\r
+                            gEfiStatusCodeSpecificDataGuid.\r
+  @param  ExtendedData      Pointer to the extended data buffer.  This is an\r
+                            optional parameter that may be NULL.\r
+  @param  ExtendedDataSize  The size, in bytes, of the extended data buffer.\r
+\r
+  @retval  EFI_SUCCESS           The status code was reported.\r
+  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate\r
+                                 the extended data section if it was specified.\r
+  @retval  EFI_UNSUPPORTED       Report status code is not supported\r
 \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 InternalReportStatusCodeEx (\r
index d4f0daddc4891706d17dd50a40c00f1e18d38a23..7e2cc8b27a82b2679274d4db84936db9c8184dec 100644 (file)
@@ -13,8 +13,6 @@
 **/\r
 \r
 #include "ReportStatusCodeLibInternal.h"\r
-\r
-\r
  \r
 EFI_REPORT_STATUS_CODE  mReportStatusCode = NULL;\r
 \r
index d2dc4c615e52b8b78ac1b57555b9aadd72173a3e..5f4c7abf9be40f1865508b8e5c39f64d5bbce608 100644 (file)
@@ -33,7 +33,7 @@
 \r
 \r
 /**\r
-  Locatet he report status code service.\r
+  Locate he report status code service.\r
 \r
   @return     EFI_REPORT_STATUS_CODE    function point to\r
               ReportStatusCode.\r
index ea8c7d5157fb883f13ae43929850495c41ea2d88..f75963e712351b17db623c3ada1ca99f747ba80f 100644 (file)
@@ -37,37 +37,30 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/DebugLib.h>\r
 #include <Library/PcdLib.h>\r
 \r
-EFI_STATUS\r
-GetGraphicsBitMapFromFV (\r
-  IN  EFI_GUID      *FileNameGuid,\r
-  OUT VOID          **Image,\r
-  OUT UINTN         *ImageSize\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
   Return the graphics image file named FileNameGuid into Image and return it's\r
   size in ImageSize. All Firmware Volumes (FV) in the system are searched for the\r
   file name.\r
 \r
-Arguments:\r
-\r
-  FileNameGuid  - File Name of graphics file in the FV(s).\r
+  @param FileNameGuid  - File Name of graphics file in the FV(s).\r
 \r
-  Image         - Pointer to pointer to return graphics image.  If NULL, a\r
-                  buffer will be allocated.\r
+  @param Image         - Pointer to pointer to return graphics image.  If NULL, a\r
+                         buffer will be allocated.\r
 \r
-  ImageSize     - Size of the graphics Image in bytes. Zero if no image found.\r
+  @param ImageSize     - Size of the graphics Image in bytes. Zero if no image found.\r
 \r
+  @retval EFI_SUCCESS          - Image and ImageSize are valid.\r
+  @retval EFI_BUFFER_TOO_SMALL - Image not big enough. ImageSize has required size\r
+  @retval EFI_NOT_FOUND        - FileNameGuid not found\r
 \r
-Returns:\r
-\r
-  EFI_SUCCESS          - Image and ImageSize are valid.\r
-  EFI_BUFFER_TOO_SMALL - Image not big enough. ImageSize has required size\r
-  EFI_NOT_FOUND        - FileNameGuid not found\r
+**/\r
 \r
---*/\r
+EFI_STATUS\r
+GetGraphicsBitMapFromFV (\r
+  IN  EFI_GUID      *FileNameGuid,\r
+  OUT VOID          **Image,\r
+  OUT UINTN         *ImageSize\r
+  )\r
 {\r
   EFI_STATUS                    Status;\r
   UINTN                         FvProtocolCount;\r
@@ -120,48 +113,42 @@ Returns:
   return EFI_NOT_FOUND;\r
 }\r
 \r
-STATIC\r
-EFI_STATUS\r
-ConvertBmpToGopBlt (\r
-  IN  VOID      *BmpImage,\r
-  IN  UINTN     BmpImageSize,\r
-  IN OUT VOID   **GopBlt,\r
-  IN OUT UINTN  *GopBltSize,\r
-  OUT UINTN     *PixelHeight,\r
-  OUT UINTN     *PixelWidth\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
   Convert a *.BMP graphics image to a GOP/UGA blt buffer. If a NULL Blt buffer\r
   is passed in a GopBlt buffer will be allocated by this routine. If a GopBlt\r
   buffer is passed in it will be used if it is big enough.\r
 \r
-Arguments:\r
+  @param BmpImage      - Pointer to BMP file\r
 \r
-  BmpImage      - Pointer to BMP file\r
+  @param BmpImageSize  - Number of bytes in BmpImage\r
 \r
-  BmpImageSize  - Number of bytes in BmpImage\r
+  @param GopBlt        - Buffer containing GOP version of BmpImage.\r
 \r
-  GopBlt        - Buffer containing GOP version of BmpImage.\r
+  @param GopBltSize    - Size of GopBlt in bytes.\r
 \r
-  GopBltSize    - Size of GopBlt in bytes.\r
+  @param PixelHeight   - Height of GopBlt/BmpImage in pixels\r
 \r
-  PixelHeight   - Height of GopBlt/BmpImage in pixels\r
+  @param PixelWidth    - Width of GopBlt/BmpImage in pixels\r
 \r
-  PixelWidth    - Width of GopBlt/BmpImage in pixels\r
 \r
+  @retval EFI_SUCCESS           - GopBlt and GopBltSize are returned.\r
+  @retval EFI_UNSUPPORTED       - BmpImage is not a valid *.BMP image\r
+  @retval EFI_BUFFER_TOO_SMALL  - The passed in GopBlt buffer is not big enough.\r
+                                  GopBltSize will contain the required size.\r
+  @retval EFI_OUT_OF_RESOURCES  - No enough buffer to allocate\r
 \r
-Returns:\r
-\r
-  EFI_SUCCESS           - GopBlt and GopBltSize are returned.\r
-  EFI_UNSUPPORTED       - BmpImage is not a valid *.BMP image\r
-  EFI_BUFFER_TOO_SMALL  - The passed in GopBlt buffer is not big enough.\r
-                          GopBltSize will contain the required size.\r
-  EFI_OUT_OF_RESOURCES  - No enough buffer to allocate\r
+**/\r
+STATIC\r
+EFI_STATUS\r
+ConvertBmpToGopBlt (\r
+  IN  VOID      *BmpImage,\r
+  IN  UINTN     BmpImageSize,\r
+  IN OUT VOID   **GopBlt,\r
+  IN OUT UINTN  *GopBltSize,\r
+  OUT UINTN     *PixelHeight,\r
+  OUT UINTN     *PixelWidth\r
+  )\r
 \r
---*/\r
 {\r
   UINT8             *Image;\r
   UINT8             *ImageHeader;\r
@@ -296,30 +283,23 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
-\r
-EFI_STATUS\r
-LockKeyboards (\r
-  IN  CHAR16    *Password\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
   Use Console Control Protocol to lock the Console In Spliter virtual handle.\r
   This is the ConInHandle and ConIn handle in the EFI system table. All key\r
   presses will be ignored until the Password is typed in. The only way to\r
   disable the password is to type it in to a ConIn device.\r
 \r
-Arguments:\r
-  Password - Password used to lock ConIn device\r
-\r
+  @param  Password - Password used to lock ConIn device\r
 \r
-Returns:\r
-\r
-  EFI_SUCCESS     - ConsoleControl has been flipped to graphics and logo\r
+  @retval EFI_SUCCESS     - ConsoleControl has been flipped to graphics and logo\r
                           displayed.\r
-  EFI_UNSUPPORTED - Logo not found\r
+  @retval EFI_UNSUPPORTED - Logo not found\r
 \r
---*/\r
+**/\r
+EFI_STATUS\r
+LockKeyboards (\r
+  IN  CHAR16    *Password\r
+  )\r
 {\r
   EFI_STATUS                    Status;\r
   EFI_CONSOLE_CONTROL_PROTOCOL  *ConsoleControl;\r
@@ -333,30 +313,22 @@ Returns:
   return Status;\r
 }\r
 \r
-\r
-EFI_STATUS\r
-EnableQuietBoot (\r
-  IN  EFI_GUID  *LogoFile\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
   Use Console Control to turn off UGA based Simple Text Out consoles from going\r
   to the UGA device. Put up LogoFile on every UGA device that is a console\r
 \r
-Arguments:\r
-\r
-  LogoFile - File name of logo to display on the center of the screen.\r
+  @param LogoFile - File name of logo to display on the center of the screen.\r
 \r
+  @retval EFI_SUCCESS           - ConsoleControl has been flipped to graphics and logo\r
+                                  displayed.\r
+  @retval EFI_UNSUPPORTED       - Logo not found\r
 \r
-Returns:\r
-\r
-  EFI_SUCCESS           - ConsoleControl has been flipped to graphics and logo\r
-                          displayed.\r
-  EFI_UNSUPPORTED       - Logo not found\r
+**/\r
+EFI_STATUS\r
+EnableQuietBoot (\r
+  IN  EFI_GUID  *LogoFile\r
+  )\r
 \r
---*/\r
 {\r
   EFI_STATUS                    Status;\r
   EFI_CONSOLE_CONTROL_PROTOCOL  *ConsoleControl;\r
@@ -571,28 +543,18 @@ Returns:
   return Status;\r
 }\r
 \r
+/**\r
+  Use Console Control to turn on GOP/UGA based Simple Text Out consoles. The GOP/UGA\r
+  Simple Text Out screens will now be synced up with all non GOP/UGA output devices\r
 \r
+  @retval EFI_SUCCESS           - GOP/UGA devices are back in text mode and synced up.\r
+  @retval EFI_UNSUPPORTED       - Logo not found\r
+**/\r
 EFI_STATUS\r
 DisableQuietBoot (\r
   VOID\r
   )\r
-/*++\r
-\r
-Routine Description:\r
 \r
-  Use Console Control to turn on GOP/UGA based Simple Text Out consoles. The GOP/UGA\r
-  Simple Text Out screens will now be synced up with all non GOP/UGA output devices\r
-\r
-Arguments:\r
-\r
-  NONE\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS           - GOP/UGA devices are back in text mode and synced up.\r
-  EFI_UNSUPPORTED       - Logo not found\r
-\r
---*/\r
 {\r
   EFI_STATUS                    Status;\r
   EFI_CONSOLE_CONTROL_PROTOCOL  *ConsoleControl;\r
@@ -624,51 +586,46 @@ static EFI_GRAPHICS_OUTPUT_BLT_PIXEL mEfiColors[16] = {
   { 0xff, 0xff, 0xff, 0x00 }\r
 };\r
 \r
-STATIC\r
-UINTN\r
-_IPrint (\r
-  IN EFI_GRAPHICS_OUTPUT_PROTOCOL     *GraphicsOutput,\r
-  IN EFI_UGA_DRAW_PROTOCOL            *UgaDraw,\r
-  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *Sto,\r
-  IN UINTN                            X,\r
-  IN UINTN                            Y,\r
-  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *Foreground,\r
-  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *Background,\r
-  IN CHAR16                           *fmt,\r
-  IN VA_LIST                          args\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
   Display string worker for: Print, PrintAt, IPrint, IPrintAt\r
 \r
-Arguments:\r
+  @param GraphicsOutput  - Graphics output protocol interface\r
 \r
-  GraphicsOutput  - Graphics output protocol interface\r
+  @param UgaDraw         - UGA draw protocol interface\r
 \r
-  UgaDraw         - UGA draw protocol interface\r
+  @param Sto             - Simple text out protocol interface\r
 \r
-  Sto             - Simple text out protocol interface\r
+  @param X               - X coordinate to start printing\r
 \r
-  X               - X coordinate to start printing\r
+  @param Y               - Y coordinate to start printing\r
 \r
-  Y               - Y coordinate to start printing\r
+  @param Foreground      - Foreground color\r
 \r
-  Foreground      - Foreground color\r
+  @param Background      - Background color\r
 \r
-  Background      - Background color\r
+  @param fmt             - Format string\r
 \r
-  fmt             - Format string\r
+  @param args            - Print arguments\r
 \r
-  args            - Print arguments\r
 \r
-Returns:\r
+  @retval EFI_SUCCESS             -  success\r
+  @retval EFI_OUT_OF_RESOURCES    -  out of resources\r
 \r
-  EFI_SUCCESS             -  success\r
-  EFI_OUT_OF_RESOURCES    -  out of resources\r
+**/\r
+STATIC\r
+UINTN\r
+_IPrint (\r
+  IN EFI_GRAPHICS_OUTPUT_PROTOCOL     *GraphicsOutput,\r
+  IN EFI_UGA_DRAW_PROTOCOL            *UgaDraw,\r
+  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *Sto,\r
+  IN UINTN                            X,\r
+  IN UINTN                            Y,\r
+  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *Foreground,\r
+  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *Background,\r
+  IN CHAR16                           *fmt,\r
+  IN VA_LIST                          args\r
+  )\r
 \r
---*/\r
 {\r
   VOID                           *Buffer;\r
   EFI_STATUS                     Status;\r
@@ -812,7 +769,25 @@ Error:
   return Status;\r
 }\r
 \r
+/**\r
+  Prints a formatted unicode string to the default console\r
+\r
+  @param X           - X coordinate to start printing\r
+\r
+  @param Y           - Y coordinate to start printing\r
+\r
+  @param ForeGround  - Foreground color\r
+\r
+  @param BackGround  - Background color\r
+\r
+  @param Fmt         - Format string\r
+\r
+  @param ...         - Print arguments\r
 \r
+\r
+  @retval Length of string printed to the console\r
+\r
+**/\r
 UINTN\r
 PrintXY (\r
   IN UINTN                            X,\r
@@ -822,31 +797,6 @@ PrintXY (
   IN CHAR16                           *Fmt,\r
   ...\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-    Prints a formatted unicode string to the default console\r
-\r
-Arguments:\r
-\r
-    X           - X coordinate to start printing\r
-\r
-    Y           - Y coordinate to start printing\r
-\r
-    ForeGround  - Foreground color\r
-\r
-    BackGround  - Background color\r
-\r
-    Fmt         - Format string\r
-\r
-    ...         - Print arguments\r
-\r
-Returns:\r
-\r
-    Length of string printed to the console\r
-\r
---*/\r
 {\r
   EFI_HANDLE                    Handle;\r
 \r
@@ -894,3 +844,4 @@ Returns:
 \r
   return _IPrint (GraphicsOutput, UgaDraw, Sto, X, Y, ForeGround, BackGround, Fmt, Args);\r
 }\r
+\r
index b9df977052deb9e96198d04b207c84052d4be9d6..4da04ad69b5368a951bc301ba3dc07fe2141f06c 100644 (file)
@@ -10,8 +10,6 @@
   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:  OemHookStatusCodeLibNull.c\r
-\r
 **/\r
 \r
 #include <PiPei.h>\r
index 64808f5a13237db0e4337bc6f412212dfbfc8023..44f733e7b393874f6eee10281d9477365ae845aa 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  Report Status Code Library for DXE Phase.\r
+  Report Status Code Library for PEI Phase.\r
 \r
   Copyright (c) 2006, Intel Corporation<BR>\r
   All rights reserved. This program and the accompanying materials\r
index d4f0daddc4891706d17dd50a40c00f1e18d38a23..eca0fdcf0ff3ede95c0ac1afb511eecd3f1df69f 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  Report Status Code Library for DXE Phase.\r
+  Report Status Code Library for SMM Runtime driver.\r
 \r
   Copyright (c) 2006 - 2007, Intel Corporation<BR>\r
   All rights reserved. This program and the accompanying materials\r
index 882cad677f6a99a0589e7082640f1dbcf985ecbd..dcd0b38c72f3ac8c2b60bd07bac404422299cac4 100644 (file)
@@ -42,7 +42,7 @@ STATIC
 BOOLEAN               mHaveExitedBootServices = FALSE;\r
 \r
 /**\r
-  Locatet he report status code service.\r
+  Locate he report status code service.\r
 \r
   @return     EFI_REPORT_STATUS_CODE    function point to\r
               ReportStatusCode.\r
@@ -92,7 +92,7 @@ ReportStatusCodeLibVirtualAddressChange (
 }\r
 \r
 /**\r
-  Updatet the In Runtime Indicator.\r
+  Update the In Runtime Indicator.\r
 \r
   @param[in]    Event   The Event that is being processed\r
   @param[in]    Context Event Context\r
@@ -191,7 +191,13 @@ ReportStatusCodeLibConstruct (
   return Status;\r
 }\r
 \r
-\r
+/**\r
+  Desctructor of library will close events.\r
+  \r
+  @param ImageHandle callder module's image handle\r
+  @param SystemTable pointer to EFI system table.\r
+  @return the status of close event.\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 ReportStatusCodeLibDestruct (\r
@@ -215,7 +221,6 @@ ReportStatusCodeLibDestruct (
   return Status;\r
 }\r
 \r
-\r
 /**\r
   Reports a status code with full parameters.\r
 \r
@@ -299,3 +304,4 @@ InternalReportStatusCodeEx (
   }\r
   return  InternalReportStatusCode (Type, Value, Instance, CallerId, mStatusCodeData);\r
 }\r
+\r