projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 664d4c0a SZ |
1 | /** @file\r |
| 2 | This file declares Sec Hob Data PPI.\r | |
| 3 | \r | |
| 9095d37b | 4 | This PPI provides a way for the SEC code to pass zero or more HOBs in a HOB list.\r |
| 664d4c0a | 5 | \r |
| 9095d37b | 6 | Copyright (c) 2017 - 2018, Intel Corporation. All rights reserved.<BR>\r |
| 664d4c0a SZ |
7 | This program and the accompanying materials are licensed and made available under\r |
| 8 | the terms and conditions of the BSD License that accompanies this distribution.\r | |
| 9 | The full text of the license may be found at\r | |
| 10 | http://opensource.org/licenses/bsd-license.php.\r | |
| 11 | \r | |
| 12 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
| 13 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
| 14 | \r | |
| 15 | @par Revision Reference:\r | |
| 16 | This PPI is introduced in PI Version 1.5.\r | |
| 17 | \r | |
| 18 | **/\r | |
| 19 | \r | |
| 20 | #ifndef __SEC_HOB_DATA_PPI_H__\r | |
| 21 | #define __SEC_HOB_DATA_PPI_H__\r | |
| 22 | \r | |
| 23 | #include <Pi/PiHob.h>\r | |
| 24 | \r | |
| 25 | #define EFI_SEC_HOB_DATA_PPI_GUID \\r | |
| 26 | { \\r | |
| 27 | 0x3ebdaf20, 0x6667, 0x40d8, {0xb4, 0xee, 0xf5, 0x99, 0x9a, 0xc1, 0xb7, 0x1f } \\r | |
| 28 | }\r | |
| 29 | \r | |
| 30 | typedef struct _EFI_SEC_HOB_DATA_PPI EFI_SEC_HOB_DATA_PPI;\r | |
| 31 | \r | |
| 32 | /**\r | |
| 33 | Return a pointer to a buffer containing zero or more HOBs that\r | |
| 34 | will be installed into the PEI HOB List.\r | |
| 35 | \r | |
| 36 | This function returns a pointer to a pointer to zero or more HOBs,\r | |
| 37 | terminated with a HOB of type EFI_HOB_TYPE_END_OF_HOB_LIST.\r | |
| 38 | Note: The HobList must not contain a EFI_HOB_HANDOFF_INFO_TABLE HOB (PHIT) HOB.\r | |
| 39 | \r | |
| 40 | @param[in] This Pointer to this PPI structure.\r | |
| 41 | @param[out] HobList A pointer to a returned pointer to zero or more HOBs.\r | |
| 42 | If no HOBs are to be returned, then the returned pointer\r | |
| 43 | is a pointer to a HOB of type EFI_HOB_TYPE_END_OF_HOB_LIST.\r | |
| 44 | \r | |
| 45 | @retval EFI_SUCCESS This function completed successfully.\r | |
| 46 | @retval EFI_NOT_FOUND No HOBS are available.\r | |
| 47 | \r | |
| 48 | **/\r | |
| 49 | typedef\r | |
| 50 | EFI_STATUS\r | |
| 51 | (EFIAPI *EFI_SEC_HOB_DATA_GET) (\r | |
| 52 | IN CONST EFI_SEC_HOB_DATA_PPI *This,\r | |
| 53 | OUT EFI_HOB_GENERIC_HEADER **HobList\r | |
| 54 | );\r | |
| 55 | \r | |
| 56 | ///\r | |
| 57 | /// This PPI provides a way for the SEC code to pass zero or more HOBs in a HOB list.\r | |
| 58 | ///\r | |
| 59 | struct _EFI_SEC_HOB_DATA_PPI {\r | |
| 60 | EFI_SEC_HOB_DATA_GET GetHobs;\r | |
| 61 | };\r | |
| 62 | \r | |
| 63 | extern EFI_GUID gEfiSecHobDataPpiGuid;\r | |
| 64 | \r | |
| 65 | #endif\r |