summaryrefslogtreecommitdiff
path: root/MdePkg/Include/Ppi/Decompress.h
diff options
context:
space:
mode:
Diffstat (limited to 'MdePkg/Include/Ppi/Decompress.h')
-rw-r--r--MdePkg/Include/Ppi/Decompress.h46
1 files changed, 21 insertions, 25 deletions
diff --git a/MdePkg/Include/Ppi/Decompress.h b/MdePkg/Include/Ppi/Decompress.h
index 5cbfd8be4e..074b057928 100644
--- a/MdePkg/Include/Ppi/Decompress.h
+++ b/MdePkg/Include/Ppi/Decompress.h
@@ -30,48 +30,44 @@ typedef struct _EFI_PEI_DECOMPRESS_PPI EFI_PEI_DECOMPRESS_PPI;
as a series of standard PI Firmware File Sections. The
required memory is allocated from permanent memory.
- @param This Points to this instance of the
- EFI_PEI_DECOMPRESS_PEI PPI. InputSection Points to
- the compressed section.
-
- @param OutputBuffer Holds the returned pointer to the
- decompressed sections.
-
- @param OutputSize Holds the returned size of the decompress
- section streams.
+ @param This Points to this instance of the
+ EFI_PEI_DECOMPRESS_PEI PPI.
+ @param InputSection Points to the compressed section.
+ @param OutputBuffer Holds the returned pointer to the
+ decompressed sections.
+ @param OutputSize Holds the returned size of the decompress
+ section streams.
@retval EFI_SUCCESS The section was decompressed
successfully. OutputBuffer contains the
resulting data and OutputSize contains
the resulting size.
-
@retval EFI_OUT_OF_RESOURCES Unable to allocate sufficient
memory to hold the decompressed data.
-
@retval EFI_UNSUPPORTED The compression type specified
in the compression header is unsupported.
+
**/
typedef
EFI_STATUS
(EFIAPI *EFI_PEI_DECOMPRESS_DECOMPRESS)(
- IN CONST EFI_PEI_DECOMPRESS_PPI *This,
- IN CONST EFI_COMPRESSION_SECTION *InputSection,
- OUT VOID **OutputBuffer,
- OUT UINTN *OutputSize
+ IN CONST EFI_PEI_DECOMPRESS_PPI *This,
+ IN CONST EFI_COMPRESSION_SECTION *InputSection,
+ OUT VOID **OutputBuffer,
+ OUT UINTN *OutputSize
);
-/**
- @par Ppi Description:
- This PPI's single member function decompresses a compression
- encapsulated section. It is used by the PEI Foundation to
- process sectioned files. Prior to the installation of this PPI,
- compression sections will be ignored.
-
- @param Decompress Decompress a single compression section in
- a firmware file.
-**/
+///
+/// This PPI's single member function decompresses a compression
+/// encapsulated section. It is used by the PEI Foundation to
+/// process sectioned files. Prior to the installation of this PPI,
+/// compression sections will be ignored.
+///
struct _EFI_PEI_DECOMPRESS_PPI {
+ ///
+ /// Decompress a single compression section in a firmware file.
+ ///
EFI_PEI_DECOMPRESS_DECOMPRESS Decompress;
};