]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFsp2Pkg/Include/Library/FspPlatformLib.h
IntelFsp2Pkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / IntelFsp2Pkg / Include / Library / FspPlatformLib.h
CommitLineData
cf1d4549
JY
1/** @file\r
2\r
3 Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR>\r
9672cd30 4 SPDX-License-Identifier: BSD-2-Clause-Patent\r
cf1d4549
JY
5\r
6**/\r
7\r
8#ifndef _FSP_PLATFORM_LIB_H_\r
9#define _FSP_PLATFORM_LIB_H_\r
10\r
11/**\r
12 Get system memory resource descriptor by owner.\r
13\r
14 @param[in] OwnerGuid resource owner guid\r
15**/\r
16EFI_HOB_RESOURCE_DESCRIPTOR *\r
17EFIAPI\r
18FspGetResourceDescriptorByOwner (\r
19 IN EFI_GUID *OwnerGuid\r
20 );\r
21\r
22/**\r
23 Get system memory from HOB.\r
24\r
25 @param[in,out] LowMemoryLength less than 4G memory length\r
26 @param[in,out] HighMemoryLength greater than 4G memory length\r
27**/\r
28VOID\r
29EFIAPI\r
30FspGetSystemMemorySize (\r
31 IN OUT UINT64 *LowMemoryLength,\r
32 IN OUT UINT64 *HighMemoryLength\r
33 );\r
34\r
cf1d4549
JY
35\r
36/**\r
37 Set a new stack frame for the continuation function.\r
38\r
39**/\r
40VOID\r
41EFIAPI\r
42FspSetNewStackFrame (\r
43 VOID\r
44 );\r
45\r
46/**\r
47 This function transfer control back to BootLoader after FspSiliconInit.\r
48\r
49**/\r
50VOID\r
51EFIAPI\r
52FspSiliconInitDone (\r
53 VOID\r
54 );\r
55\r
56/**\r
57 This function returns control to BootLoader after MemoryInitApi.\r
58\r
59 @param[in,out] HobListPtr The address of HobList pointer.\r
60**/\r
61VOID\r
62EFIAPI\r
63FspMemoryInitDone (\r
64 IN OUT VOID **HobListPtr\r
65 );\r
66\r
67/**\r
68 This function returns control to BootLoader after TempRamExitApi.\r
69\r
70**/\r
71VOID\r
72EFIAPI\r
73FspTempRamExitDone (\r
74 VOID\r
75 );\r
76\r
77/**\r
78 This function handle NotifyPhase API call from the BootLoader.\r
79 It gives control back to the BootLoader after it is handled. If the\r
80 Notification code is a ReadyToBoot event, this function will return\r
81 and FSP continues the remaining execution until it reaches the DxeIpl.\r
82\r
83**/\r
84VOID\r
85EFIAPI\r
86FspWaitForNotify (\r
87 VOID\r
88 );\r
89\r
f56ae7bf
TRM
90/**\r
91 This function transfer control back to BootLoader after FspSiliconInit.\r
92\r
93 @param[in] Status return status for the FspSiliconInit.\r
94**/\r
95VOID\r
96EFIAPI\r
97FspSiliconInitDone2 (\r
98 IN EFI_STATUS Status\r
99 );\r
100\r
101/**\r
102 This function returns control to BootLoader after MemoryInitApi.\r
103\r
104 @param[in] Status return status for the MemoryInitApi.\r
105 @param[in,out] HobListPtr The address of HobList pointer.\r
106**/\r
107VOID\r
108EFIAPI\r
109FspMemoryInitDone2 (\r
110 IN EFI_STATUS Status,\r
111 IN OUT VOID **HobListPtr\r
112 );\r
113\r
114/**\r
115 This function returns control to BootLoader after TempRamExitApi.\r
116\r
117 @param[in] Status return status for the TempRamExitApi.\r
118**/\r
119VOID\r
120EFIAPI\r
121FspTempRamExitDone2 (\r
122 IN EFI_STATUS Status\r
123 );\r
124\r
cf1d4549 125#endif\r