]> git.proxmox.com Git - mirror_edk2.git/blame - UefiCpuPkg/Include/Library/PlatformSecLib.h
UefiCpuPkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / UefiCpuPkg / Include / Library / PlatformSecLib.h
CommitLineData
a39d5097
MK
1/** @file\r
2This library class defines interface for platform to perform platform\r
3specific initialization in SEC phase.\r
4\r
5Copyright (c) 2013 - 2015, Intel Corporation. All rights reserved.<BR>\r
0acd8697 6SPDX-License-Identifier: BSD-2-Clause-Patent\r
a39d5097
MK
7\r
8**/\r
9\r
10#ifndef __PLATFORM_SEC_LIB_H__\r
11#define __PLATFORM_SEC_LIB_H__\r
12\r
13/**\r
14 A developer supplied function to perform platform specific operations.\r
15\r
16 It's a developer supplied function to perform any operations appropriate to a\r
17 given platform. It's invoked just before passing control to PEI core by SEC\r
18 core. Platform developer may modify the SecCoreData passed to PEI Core.\r
19 It returns a platform specific PPI list that platform wishes to pass to PEI core.\r
20 The Generic SEC core module will merge this list to join the final list passed to\r
21 PEI core.\r
22\r
23 @param SecCoreData The same parameter as passing to PEI core. It\r
24 could be overridden by this function.\r
25\r
26 @return The platform specific PPI list to be passed to PEI core or\r
27 NULL if there is no need of such platform specific PPI list.\r
28\r
29**/\r
30EFI_PEI_PPI_DESCRIPTOR *\r
31EFIAPI\r
32SecPlatformMain (\r
33 IN OUT EFI_SEC_PEI_HAND_OFF *SecCoreData\r
34 );\r
35\r
36/**\r
37 This interface conveys state information out of the Security (SEC) phase into PEI.\r
38\r
39 @param PeiServices Pointer to the PEI Services Table.\r
40 @param StructureSize Pointer to the variable describing size of the input buffer.\r
41 @param PlatformInformationRecord Pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.\r
42\r
43 @retval EFI_SUCCESS The data was successfully returned.\r
44 @retval EFI_BUFFER_TOO_SMALL The buffer was too small.\r
45\r
46**/\r
47EFI_STATUS\r
48EFIAPI\r
49SecPlatformInformation (\r
50 IN CONST EFI_PEI_SERVICES **PeiServices,\r
51 IN OUT UINT64 *StructureSize,\r
52 OUT EFI_SEC_PLATFORM_INFORMATION_RECORD *PlatformInformationRecord\r
53 );\r
54\r
55/**\r
56 This interface disables temporary memory in SEC Phase.\r
57**/\r
58VOID\r
59EFIAPI\r
60SecPlatformDisableTemporaryMemory (\r
61 VOID\r
62 );\r
63\r
64#endif\r