mirror of
https://github.com/acidanthera/audk.git
synced 2025-10-25 17:23:53 +02:00
b4e2cf092a
Move the documentation blocks from between the parameter list and function body to above the function. Convert all the documentation blocks to Doxygen format. Signed-off-by: Rebecca Cran <rebecca@bsdio.com> Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
68 lines
1.6 KiB
C
68 lines
1.6 KiB
C
/** @file
|
|
Header file for compression routine.
|
|
Providing both EFI and Tiano Compress algorithms.
|
|
|
|
Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#ifndef _COMPRESS_H_
|
|
#define _COMPRESS_H_
|
|
|
|
#include <string.h>
|
|
#include <stdlib.h>
|
|
|
|
#include "CommonLib.h"
|
|
#include <Common/UefiBaseTypes.h>
|
|
|
|
/**
|
|
Tiano compression routine.
|
|
**/
|
|
EFI_STATUS
|
|
TianoCompress (
|
|
IN UINT8 *SrcBuffer,
|
|
IN UINT32 SrcSize,
|
|
IN UINT8 *DstBuffer,
|
|
IN OUT UINT32 *DstSize
|
|
)
|
|
;
|
|
|
|
/**
|
|
Efi compression routine.
|
|
**/
|
|
EFI_STATUS
|
|
EfiCompress (
|
|
IN UINT8 *SrcBuffer,
|
|
IN UINT32 SrcSize,
|
|
IN UINT8 *DstBuffer,
|
|
IN OUT UINT32 *DstSize
|
|
)
|
|
;
|
|
|
|
/**
|
|
The compression routine.
|
|
|
|
@param SrcBuffer The buffer storing the source data
|
|
@param SrcSize The size of source data
|
|
@param DstBuffer The buffer to store the compressed data
|
|
@param DstSize On input, the size of DstBuffer; On output,
|
|
the size of the actual compressed data.
|
|
|
|
@retval EFI_BUFFER_TOO_SMALL The DstBuffer is too small. In this case,
|
|
DstSize contains the size needed.
|
|
@retval EFI_SUCCESS Compression is successful.
|
|
@retval EFI_OUT_OF_RESOURCES No resource to complete function.
|
|
@retval 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
|