summaryrefslogtreecommitdiff
path: root/Tools/CCode/Source/Common/Compress.h
diff options
context:
space:
mode:
authorklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2006-12-07 05:29:07 +0000
committerklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2006-12-07 05:29:07 +0000
commit30f80dd8dedf2c333be4616442daf5d1b412e23e (patch)
tree81c72954148b30a1a9ac81ff160b2279e5e8faba /Tools/CCode/Source/Common/Compress.h
parent61e61e3d30f3965953dcfe646d15a17bd9173da1 (diff)
downloadedk2-platforms-30f80dd8dedf2c333be4616442daf5d1b412e23e.tar.xz
The main issue want to be resolve is that some tools need EfiCompress and other tools need TianoCompress, but only common Compress(indeed is TianoCompress) is provided in tool/CCode/Common.
EfiCompress and TianoCompress are all originated from LZ77 algorithms and they have very little different, that different position set for Huffman code. EfiCompress is defined in EFI 1.1 spec and EfiRom tool need it to create a recognized compressed EFI driver. TianoCompress is for pursuer more size saving and it used be GenFfs and GenSection tools. So this patch: 1) Split EfiComress and TianoCompress in edkII’s tools 2) Change EfiRom tool use EfiCompress and GenFfs/GenSection use TianoCompress git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@2064 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'Tools/CCode/Source/Common/Compress.h')
-rw-r--r--Tools/CCode/Source/Common/Compress.h94
1 files changed, 94 insertions, 0 deletions
diff --git a/Tools/CCode/Source/Common/Compress.h b/Tools/CCode/Source/Common/Compress.h
new file mode 100644
index 0000000000..7366e720e2
--- /dev/null
+++ b/Tools/CCode/Source/Common/Compress.h
@@ -0,0 +1,94 @@
+/*++
+
+Copyright (c) 2004 - 2006, 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
+
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+Module Name:
+
+ Compress.h
+
+Abstract:
+
+ Header file for compression routine.
+ Providing both EFI and Tiano Compress algorithms.
+
+--*/
+
+#ifndef _COMPRESS_H_
+#define _COMPRESS_H_
+
+#include <string.h>
+#include <stdlib.h>
+
+#include <Common/UefiBaseTypes.h>
+/*++
+
+Routine Description:
+
+ Tiano compression routine.
+
+--*/
+EFI_STATUS
+TianoCompress (
+ IN UINT8 *SrcBuffer,
+ IN UINT32 SrcSize,
+ IN UINT8 *DstBuffer,
+ IN OUT UINT32 *DstSize
+ )
+;
+
+/*++
+
+Routine Description:
+
+ Efi compression routine.
+
+--*/
+EFI_STATUS
+EfiCompress (
+ IN UINT8 *SrcBuffer,
+ IN UINT32 SrcSize,
+ IN UINT8 *DstBuffer,
+ IN OUT UINT32 *DstSize
+ )
+;
+
+/*++
+
+Routine Description:
+
+ The compression routine.
+
+Arguments:
+
+ SrcBuffer - The buffer storing the source data
+ SrcSize - The size of source data
+ DstBuffer - The buffer to store the compressed data
+ DstSize - On input, the size of DstBuffer; On output,
+ the size of the actual compressed data.
+
+Returns:
+
+ EFI_BUFFER_TOO_SMALL - The DstBuffer is too small. In this case,
+ DstSize contains the size needed.
+ EFI_SUCCESS - Compression is successful.
+ EFI_OUT_OF_RESOURCES - No resource to complete function.
+ EFI_INVALID_PARAMETER - Parameter supplied is wrong.
+
+--*/
+typedef
+EFI_STATUS
+(*COMPRESS_FUNCTION) (
+ IN UINT8 *SrcBuffer,
+ IN UINT32 SrcSize,
+ IN UINT8 *DstBuffer,
+ IN OUT UINT32 *DstSize
+ );
+
+#endif