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 |
9344f092 | 7 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
664d4c0a SZ |
8 | \r |
9 | @par Revision Reference:\r | |
10 | This PPI is introduced in PI Version 1.5.\r | |
11 | \r | |
12 | **/\r | |
13 | \r | |
14 | #ifndef __SEC_HOB_DATA_PPI_H__\r | |
15 | #define __SEC_HOB_DATA_PPI_H__\r | |
16 | \r | |
17 | #include <Pi/PiHob.h>\r | |
18 | \r | |
19 | #define EFI_SEC_HOB_DATA_PPI_GUID \\r | |
20 | { \\r | |
21 | 0x3ebdaf20, 0x6667, 0x40d8, {0xb4, 0xee, 0xf5, 0x99, 0x9a, 0xc1, 0xb7, 0x1f } \\r | |
22 | }\r | |
23 | \r | |
24 | typedef struct _EFI_SEC_HOB_DATA_PPI EFI_SEC_HOB_DATA_PPI;\r | |
25 | \r | |
26 | /**\r | |
27 | Return a pointer to a buffer containing zero or more HOBs that\r | |
28 | will be installed into the PEI HOB List.\r | |
29 | \r | |
30 | This function returns a pointer to a pointer to zero or more HOBs,\r | |
31 | terminated with a HOB of type EFI_HOB_TYPE_END_OF_HOB_LIST.\r | |
32 | Note: The HobList must not contain a EFI_HOB_HANDOFF_INFO_TABLE HOB (PHIT) HOB.\r | |
33 | \r | |
34 | @param[in] This Pointer to this PPI structure.\r | |
35 | @param[out] HobList A pointer to a returned pointer to zero or more HOBs.\r | |
36 | If no HOBs are to be returned, then the returned pointer\r | |
37 | is a pointer to a HOB of type EFI_HOB_TYPE_END_OF_HOB_LIST.\r | |
38 | \r | |
39 | @retval EFI_SUCCESS This function completed successfully.\r | |
40 | @retval EFI_NOT_FOUND No HOBS are available.\r | |
41 | \r | |
42 | **/\r | |
43 | typedef\r | |
44 | EFI_STATUS\r | |
45 | (EFIAPI *EFI_SEC_HOB_DATA_GET) (\r | |
46 | IN CONST EFI_SEC_HOB_DATA_PPI *This,\r | |
47 | OUT EFI_HOB_GENERIC_HEADER **HobList\r | |
48 | );\r | |
49 | \r | |
50 | ///\r | |
51 | /// This PPI provides a way for the SEC code to pass zero or more HOBs in a HOB list.\r | |
52 | ///\r | |
53 | struct _EFI_SEC_HOB_DATA_PPI {\r | |
54 | EFI_SEC_HOB_DATA_GET GetHobs;\r | |
55 | };\r | |
56 | \r | |
57 | extern EFI_GUID gEfiSecHobDataPpiGuid;\r | |
58 | \r | |
59 | #endif\r |