X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FLibrary%2FBaseUefiDecompressLib%2FBaseUefiDecompressLibInternals.h;h=4e143133714ce19cbae13751c869c574de84e311;hp=856c1f7b017b27a16e32acb1a61ec7bbba63edb2;hb=a750b4ae24ce072f7c5ced1b89c18f9cc23debc8;hpb=61f0f4375b35dd9b3ab6f1e1803385b57a22c7fb diff --git a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h index 856c1f7b01..4e14313371 100644 --- a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h +++ b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h @@ -1,11 +1,11 @@ /** @file - Internal data structure defintions for Base UEFI Decompress Libary. + Internal data structure defintions for Base UEFI Decompress Library. Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php + http://opensource.org/licenses/bsd-license.php. THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @@ -40,8 +40,8 @@ #endif typedef struct { - UINT8 *mSrcBase; // Starting address of compressed data - UINT8 *mDstBase; // Starting address of decompressed data + UINT8 *mSrcBase; // The starting address of compressed data + UINT8 *mDstBase; // The starting address of decompressed data UINT32 mOutBuf; UINT32 mInBuf; @@ -63,7 +63,7 @@ typedef struct { /// /// The length of the field 'Position Set Code Length Array Size' in Block Header. - /// For UEFI 2.0 de/compression algorithm, mPBit = 4 + /// For UEFI 2.0 de/compression algorithm, mPBit = 4. /// UINT8 mPBit; } SCRATCH_DATA; @@ -73,7 +73,7 @@ typedef struct { Shift mBitBuf NumOfBits left. Read in NumOfBits of bits from source. - @param Sd The global scratch data + @param Sd The global scratch data. @param NumOfBits The number of bits to shift and read. **/ @@ -109,10 +109,10 @@ GetBits ( and Position Set according to code length array. If TableBits > 16, then ASSERT (). - @param Sd The global scratch data - @param NumOfChar Number of symbols in the symbol set - @param BitLen Code length array - @param TableBits The width of the mapping table + @param Sd The global scratch data. + @param NumOfChar The number of symbols in the symbol set. + @param BitLen Code length array. + @param TableBits The width of the mapping table. @param Table The table to be created. @retval 0 OK. @@ -133,7 +133,7 @@ MakeTable ( Get a position value according to Position Huffman Table. - @param Sd the global scratch data + @param Sd The global scratch data. @return The position value decoded. @@ -146,12 +146,12 @@ DecodeP ( /** Reads code lengths for the Extra Set or the Position Set. - Read in the Extra Set or Pointion Set Length Arrary, then + Read in the Extra Set or Position Set Length Array, then generate the Huffman code mapping for them. @param Sd The global scratch data. - @param nn Number of symbols. - @param nbit Number of bits needed to represent nn. + @param nn The number of symbols. + @param nbit The number of bits needed to represent nn. @param Special The special symbol that needs to be taken care of. @retval 0 OK. @@ -172,7 +172,7 @@ ReadPTLen ( Read in and decode the Char&Len Set Code Length Array, then generate the Huffman Code mapping table for the Char&Len Set. - @param Sd the global scratch data + @param Sd The global scratch data. **/ VOID @@ -200,7 +200,7 @@ DecodeC ( /** Decode the source data and put the resulting data into the destination buffer. - @param Sd The global scratch data + @param Sd The global scratch data. **/ VOID