projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 5879b875 | 1 | /* @file\r |
| 2 | Provides decompression services to the PEI Foundatoin.\r | |
| 3 | \r | |
| 4 | Copyright (c) 2006, Intel Corporation \r | |
| 5 | All rights reserved. This program and the accompanying materials \r | |
| 6 | are licensed and made available under the terms and conditions of the BSD License \r | |
| 7 | which accompanies this distribution. The full text of the license may be found at \r | |
| 8 | http://opensource.org/licenses/bsd-license.php \r | |
| 9 | \r | |
| 10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
| 11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
| 12 | \r | |
| 5879b875 | 13 | @par Revision Reference:\r |
| 14 | This PPI is defined in PI Version 1.00.\r | |
| 15 | \r | |
| 16 | **/\r | |
| 17 | \r | |
| 18 | #ifndef __DECOMPRESS_PPI_H__\r | |
| 19 | #define __DECOMPRESS_PPI_H__\r | |
| 20 | \r | |
| 21 | #define EFI_PEI_DECOMPRESS_PPI_GUID \\r | |
| 00edb218 | 22 | { 0x1a36e4e7, 0xfab6, 0x476a, { 0x8e, 0x75, 0x69, 0x5a, 0x5, 0x76, 0xfd, 0xd7 } }\r |
| 5879b875 | 23 | \r |
| 00edb218 | 24 | typedef struct _EFI_PEI_DECOMPRESS_PPI EFI_PEI_DECOMPRESS_PPI;;\r |
| 5879b875 | 25 | \r |
| 26 | /** \r | |
| 27 | Decompresses the data in a compressed section and returns it\r | |
| 28 | as a series of standard PI Firmware File Sections. The\r | |
| 29 | required memory is allocated from permanent memory.\r | |
| 30 | \r | |
| 00edb218 A |
31 | @param This Points to this instance of the\r |
| 32 | EFI_PEI_DECOMPRESS_PEI PPI. InputSection Points to\r | |
| 33 | the compressed section.\r | |
| 5879b875 | 34 | \r |
| 35 | @param OutputBuffer Holds the returned pointer to the\r | |
| 36 | decompressed sections.\r | |
| 37 | \r | |
| 00edb218 | 38 | @param OutputSize Holds the returned size of the decompress\r |
| 5879b875 | 39 | section streams.\r |
| 40 | \r | |
| 00edb218 A |
41 | @retval EFI_SUCCESS The section was decompressed\r |
| 42 | successfully. OutputBuffer contains the\r | |
| 43 | resulting data and OutputSize contains\r | |
| 44 | the resulting size.\r | |
| 5879b875 | 45 | \r |
| 00edb218 | 46 | @retval EFI_OUT_OF_RESOURCES Unable to allocate sufficient\r |
| 5879b875 | 47 | memory to hold the decompressed data.\r |
| 48 | \r | |
| 00edb218 A |
49 | @retval EFI_UNSUPPORTED The compression type specified\r |
| 50 | in the compression header is unsupported.\r | |
| 5879b875 | 51 | **/\r |
| 52 | typedef\r | |
| 53 | EFI_STATUS\r | |
| 54 | (EFIAPI *EFI_PEI_DECOMPRESS_DECOMPRESS)(\r | |
| 00edb218 A |
55 | IN CONST EFI_PEI_DECOMPRESS_PPI *This,\r |
| 56 | IN CONST EFI_COMPRESSION_SECTION *InputSection,\r | |
| 57 | OUT VOID **OutputBuffer,\r | |
| 58 | OUT UINTN *OutputSize\r | |
| 5879b875 | 59 | );\r |
| 60 | \r | |
| 61 | \r | |
| 62 | /** \r | |
| 63 |