]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFspWrapperPkg/Include/Library/FspApiLib.h
IntelFspWrapperPkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / IntelFspWrapperPkg / Include / Library / FspApiLib.h
CommitLineData
a33a2f62
JY
1/** @file\r
2 Provide FSP API related function.\r
3\r
d8043ce9 4 Copyright (c) 2014 - 2015, Intel Corporation. All rights reserved.<BR>\r
19486360 5 SPDX-License-Identifier: BSD-2-Clause-Patent\r
a33a2f62
JY
6\r
7**/\r
8\r
9#ifndef __FSP_API_LIB_H__\r
10#define __FSP_API_LIB_H__\r
11\r
12#include <FspApi.h>\r
13#include <FspInfoHeader.h>\r
14\r
15/**\r
16 Find FSP header pointer.\r
17\r
18 @param[in] FlashFvFspBase Flash address of FSP FV.\r
19\r
20 @return FSP header pointer.\r
21**/\r
22FSP_INFO_HEADER *\r
23EFIAPI\r
24FspFindFspHeader (\r
25 IN EFI_PHYSICAL_ADDRESS FlashFvFspBase\r
26 );\r
27\r
28/**\r
29 Call FSP API - FspInit.\r
30\r
31 @param[in] FspHeader FSP header pointer.\r
32 @param[in] FspInitParams Address pointer to the FSP_INIT_PARAMS structure.\r
33\r
d8043ce9 34 @return EFI status returned by FspInit API.\r
a33a2f62 35**/\r
d8043ce9 36EFI_STATUS\r
a33a2f62
JY
37EFIAPI\r
38CallFspInit (\r
39 IN FSP_INFO_HEADER *FspHeader,\r
40 IN FSP_INIT_PARAMS *FspInitParams\r
41 );\r
42\r
43/**\r
44 Call FSP API - FspNotifyPhase.\r
45\r
46 @param[in] FspHeader FSP header pointer.\r
47 @param[in] NotifyPhaseParams Address pointer to the NOTIFY_PHASE_PARAMS structure.\r
48\r
d8043ce9 49 @return EFI status returned by FspNotifyPhase API.\r
a33a2f62 50**/\r
d8043ce9 51EFI_STATUS\r
a33a2f62
JY
52EFIAPI\r
53CallFspNotifyPhase (\r
54 IN FSP_INFO_HEADER *FspHeader,\r
55 IN NOTIFY_PHASE_PARAMS *NotifyPhaseParams\r
56 );\r
57\r
d8043ce9
JY
58/**\r
59 Call FSP API - FspMemoryInit.\r
60\r
61 @param[in] FspHeader FSP header pointer.\r
62 @param[in,out] FspMemoryInitParams Address pointer to the FSP_MEMORY_INIT_PARAMS structure.\r
63\r
64 @return EFI status returned by FspMemoryInit API.\r
65**/\r
66EFI_STATUS\r
67EFIAPI\r
68CallFspMemoryInit (\r
69 IN FSP_INFO_HEADER *FspHeader,\r
70 IN OUT FSP_MEMORY_INIT_PARAMS *FspMemoryInitParams\r
71 );\r
72\r
73/**\r
74 Call FSP API - TempRamExit.\r
75\r
76 @param[in] FspHeader FSP header pointer.\r
77 @param[in,out] TempRamExitParam Address pointer to the TempRamExit parameters structure.\r
78\r
79 @return EFI status returned by TempRamExit API.\r
80**/\r
81EFI_STATUS\r
82EFIAPI\r
83CallTempRamExit (\r
84 IN FSP_INFO_HEADER *FspHeader,\r
85 IN OUT VOID *TempRamExitParam\r
86 );\r
87\r
88/**\r
89 Call FSP API - FspSiliconInit.\r
90\r
91 @param[in] FspHeader FSP header pointer.\r
92 @param[in,out] FspSiliconInitParam Address pointer to the Silicon Init parameters structure.\r
93\r
94 @return EFI status returned by FspSiliconInit API.\r
95**/\r
96EFI_STATUS\r
97EFIAPI\r
98CallFspSiliconInit (\r
99 IN FSP_INFO_HEADER *FspHeader,\r
100 IN OUT VOID *FspSiliconInitParam\r
101 );\r
102\r
a33a2f62 103#endif\r