f1d1cd642181dbefee8a1f1f4593c7191eeaf6ba
[mirror_edk2.git] / IntelFsp2WrapperPkg / FspmWrapperPeim / FspmWrapperPeim.c
1 /** @file\r
2   This will be invoked only once. It will call FspMemoryInit API,\r
3   register TemporaryRamDonePpi to call TempRamExit API, and register MemoryDiscoveredPpi\r
4   notify to call FspSiliconInit API.\r
5 \r
6   Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR>\r
7   This program and the accompanying materials\r
8   are licensed and made available under the terms and conditions of the BSD License\r
9   which accompanies this distribution.  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 **/\r
16 \r
17 \r
18 #include <PiPei.h>\r
19 \r
20 #include <Library/PeimEntryPoint.h>\r
21 #include <Library/PeiServicesLib.h>\r
22 #include <Library/PeiServicesTablePointerLib.h>\r
23 #include <Library/BaseLib.h>\r
24 #include <Library/DebugLib.h>\r
25 #include <Library/BaseMemoryLib.h>\r
26 #include <Library/MemoryAllocationLib.h>\r
27 #include <Library/HobLib.h>\r
28 #include <Library/PcdLib.h>\r
29 #include <Library/TimerLib.h>\r
30 #include <Library/PerformanceLib.h>\r
31 #include <Library/FspWrapperPlatformLib.h>\r
32 #include <Library/FspWrapperHobProcessLib.h>\r
33 #include <Library/FspWrapperApiLib.h>\r
34 \r
35 #include <Ppi/FspSiliconInitDone.h>\r
36 #include <Ppi/EndOfPeiPhase.h>\r
37 #include <Ppi/MemoryDiscovered.h>\r
38 #include <Ppi/SecPlatformInformation.h>\r
39 #include <Library/FspWrapperApiTestLib.h>\r
40 #include <FspEas.h>\r
41 #include <FspStatusCode.h>\r
42 \r
43 extern EFI_GUID gFspHobGuid;\r
44 \r
45 /**\r
46   Call FspMemoryInit API.\r
47 \r
48   @return Status returned by FspMemoryInit API.\r
49 **/\r
50 EFI_STATUS\r
51 PeiFspMemoryInit (\r
52   VOID\r
53   )\r
54 {\r
55   FSP_INFO_HEADER           *FspmHeaderPtr;\r
56   EFI_STATUS                Status;\r
57   UINT64                    TimeStampCounterStart;\r
58   VOID                      *FspHobListPtr;\r
59   VOID                      *HobData;\r
60   FSPM_UPD_COMMON           *FspmUpdDataPtr;\r
61   UINTN                     *SourceData;\r
62 \r
63   DEBUG ((DEBUG_INFO, "PeiFspMemoryInit enter\n"));\r
64 \r
65   FspHobListPtr = NULL;\r
66 \r
67   //\r
68   // Copy default FSP-M UPD data from Flash\r
69   //\r
70   FspmHeaderPtr = (FSP_INFO_HEADER *)FspFindFspHeader (PcdGet32 (PcdFspmBaseAddress));\r
71   DEBUG ((DEBUG_INFO, "FspmHeaderPtr - 0x%x\n", FspmHeaderPtr));\r
72   if (FspmHeaderPtr == NULL) {\r
73     return EFI_DEVICE_ERROR;\r
74   }\r
75 \r
76   FspmUpdDataPtr = (FSPM_UPD_COMMON *)AllocateZeroPool ((UINTN)FspmHeaderPtr->CfgRegionSize);\r
77   ASSERT (FspmUpdDataPtr != NULL);\r
78   SourceData = (UINTN *)((UINTN)FspmHeaderPtr->ImageBase + (UINTN)FspmHeaderPtr->CfgRegionOffset);\r
79   CopyMem (FspmUpdDataPtr, SourceData, (UINTN)FspmHeaderPtr->CfgRegionSize);\r
80 \r
81   DEBUG ((DEBUG_INFO, "UpdateFspmUpdData enter\n"));\r
82   UpdateFspmUpdData ((VOID *)FspmUpdDataPtr);\r
83   DEBUG ((DEBUG_INFO, "  NvsBufferPtr        - 0x%x\n", FspmUpdDataPtr->FspmArchUpd.NvsBufferPtr));\r
84   DEBUG ((DEBUG_INFO, "  StackBase           - 0x%x\n", FspmUpdDataPtr->FspmArchUpd.StackBase));\r
85   DEBUG ((DEBUG_INFO, "  StackSize           - 0x%x\n", FspmUpdDataPtr->FspmArchUpd.StackSize));\r
86   DEBUG ((DEBUG_INFO, "  BootLoaderTolumSize - 0x%x\n", FspmUpdDataPtr->FspmArchUpd.BootLoaderTolumSize));\r
87   DEBUG ((DEBUG_INFO, "  BootMode            - 0x%x\n", FspmUpdDataPtr->FspmArchUpd.BootMode));\r
88   DEBUG ((DEBUG_INFO, "  HobListPtr          - 0x%x\n", &FspHobListPtr));\r
89 \r
90   TimeStampCounterStart = AsmReadTsc ();\r
91   Status = CallFspMemoryInit (FspmUpdDataPtr, &FspHobListPtr);\r
92   // Create hobs after memory initialization and not in temp RAM. Hence passing the recorded timestamp here\r
93   PERF_START_EX(&gFspApiPerformanceGuid, "EventRec", NULL, TimeStampCounterStart, FSP_STATUS_CODE_MEMORY_INIT | FSP_STATUS_CODE_COMMON_CODE | FSP_STATUS_CODE_API_ENTRY);\r
94   PERF_END_EX(&gFspApiPerformanceGuid, "EventRec", NULL, 0, FSP_STATUS_CODE_MEMORY_INIT | FSP_STATUS_CODE_COMMON_CODE | FSP_STATUS_CODE_API_EXIT);\r
95   DEBUG ((DEBUG_INFO, "Total time spent executing FspMemoryInitApi: %d millisecond\n", DivU64x32 (GetTimeInNanoSecond (AsmReadTsc () - TimeStampCounterStart), 1000000)));\r
96 \r
97   //\r
98   // Reset the system if FSP API returned FSP_STATUS_RESET_REQUIRED status\r
99   //\r
100   if ((Status >= FSP_STATUS_RESET_REQUIRED_COLD) && (Status <= FSP_STATUS_RESET_REQUIRED_8)) {\r
101     DEBUG((DEBUG_INFO, "FspMemoryInitApi requested reset 0x%x\n", Status));\r
102     CallFspWrapperResetSystem ((UINT32)Status);\r
103   }\r
104 \r
105   if (EFI_ERROR(Status)) {\r
106     DEBUG ((DEBUG_ERROR, "ERROR - Failed to execute FspMemoryInitApi(), Status = %r\n", Status));\r
107   }\r
108   DEBUG((DEBUG_INFO, "FspMemoryInit status: 0x%x\n", Status));\r
109   ASSERT_EFI_ERROR (Status);\r
110 \r
111 \r
112   Status = TestFspMemoryInitApiOutput (FspmUpdDataPtr, &FspHobListPtr);\r
113   if (EFI_ERROR (Status)) {\r
114     DEBUG ((DEBUG_ERROR, "ERROR - TestFspMemoryInitApiOutput () fail, Status = %r\n", Status));\r
115   }\r
116 \r
117   DEBUG ((DEBUG_INFO, "  FspHobListPtr (returned) - 0x%x\n", FspHobListPtr));\r
118   ASSERT (FspHobListPtr != NULL);\r
119 \r
120   PostFspmHobProcess (FspHobListPtr);\r
121 \r
122   //\r
123   // FspHobList is not complete at this moment.\r
124   // Save FspHobList pointer to hob, so that it can be got later\r
125   //\r
126   HobData = BuildGuidHob (\r
127              &gFspHobGuid,\r
128              sizeof (VOID *)\r
129              );\r
130   ASSERT (HobData != NULL);\r
131   CopyMem (HobData, &FspHobListPtr, sizeof (FspHobListPtr));\r
132 \r
133   return Status;\r
134 }\r
135 \r
136 /**\r
137   Do FSP initialization.\r
138 \r
139   @return FSP initialization status.\r
140 **/\r
141 EFI_STATUS\r
142 EFIAPI\r
143 FspmWrapperInit (\r
144   VOID\r
145   )\r
146 {\r
147   EFI_STATUS           Status;\r
148 \r
149   Status = PeiFspMemoryInit ();\r
150   ASSERT_EFI_ERROR (Status);\r
151 \r
152   return Status;\r
153 }\r
154 \r
155 /**\r
156   This is the entrypoint of PEIM\r
157 \r
158   @param[in] FileHandle  Handle of the file being invoked.\r
159   @param[in] PeiServices Describes the list of possible PEI Services.\r
160 \r
161   @retval EFI_SUCCESS if it completed successfully.\r
162 **/\r
163 EFI_STATUS\r
164 EFIAPI\r
165 FspmWrapperPeimEntryPoint (\r
166   IN       EFI_PEI_FILE_HANDLE  FileHandle,\r
167   IN CONST EFI_PEI_SERVICES     **PeiServices\r
168   )\r
169 {\r
170   DEBUG((DEBUG_INFO, "FspmWrapperPeimEntryPoint\n"));\r
171 \r
172   FspmWrapperInit ();\r
173 \r
174   return EFI_SUCCESS;\r
175 }\r