as a series of standard PI Firmware File Sections. The\r
required memory is allocated from permanent memory.\r
\r
- @param This Points to this instance of the\r
- EFI_PEI_DECOMPRESS_PEI PPI. InputSection Points to\r
- the compressed section.\r
-\r
- @param OutputBuffer Holds the returned pointer to the\r
- decompressed sections.\r
-\r
- @param OutputSize Holds the returned size of the decompress\r
- section streams.\r
+ @param This Points to this instance of the\r
+ EFI_PEI_DECOMPRESS_PEI PPI.\r
+ @param InputSection Points to the compressed section.\r
+ @param OutputBuffer Holds the returned pointer to the\r
+ decompressed sections.\r
+ @param OutputSize Holds the returned size of the decompress\r
+ section streams.\r
\r
@retval EFI_SUCCESS The section was decompressed\r
successfully. OutputBuffer contains the\r
resulting data and OutputSize contains\r
the resulting size.\r
-\r
@retval EFI_OUT_OF_RESOURCES Unable to allocate sufficient\r
memory to hold the decompressed data.\r
-\r
@retval EFI_UNSUPPORTED The compression type specified\r
in the compression header is unsupported.\r
+\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_DECOMPRESS_DECOMPRESS)(\r
- IN CONST EFI_PEI_DECOMPRESS_PPI *This,\r
- IN CONST EFI_COMPRESSION_SECTION *InputSection,\r
- OUT VOID **OutputBuffer,\r
- OUT UINTN *OutputSize\r
+ IN CONST EFI_PEI_DECOMPRESS_PPI *This,\r
+ IN CONST EFI_COMPRESSION_SECTION *InputSection,\r
+ OUT VOID **OutputBuffer,\r
+ OUT UINTN *OutputSize\r
);\r
\r
\r
-/**\r
- @par Ppi Description: \r
- This PPI's single member function decompresses a compression\r
- encapsulated section. It is used by the PEI Foundation to\r
- process sectioned files. Prior to the installation of this PPI,\r
- compression sections will be ignored.\r
-\r
- @param Decompress Decompress a single compression section in\r
- a firmware file.\r
-**/\r
+///\r
+/// This PPI's single member function decompresses a compression\r
+/// encapsulated section. It is used by the PEI Foundation to\r
+/// process sectioned files. Prior to the installation of this PPI,\r
+/// compression sections will be ignored.\r
+///\r
struct _EFI_PEI_DECOMPRESS_PPI {\r
+ ///\r
+ /// Decompress a single compression section in a firmware file.\r
+ ///\r
EFI_PEI_DECOMPRESS_DECOMPRESS Decompress;\r
};\r
\r