]>
Commit | Line | Data |
---|---|---|
3af9b388 | 1 | /** @file\r |
2 | Status Code Handler Driver which produces general handlers and hook them\r | |
3 | onto the DXE status code router.\r | |
4 | \r | |
45bc2817 | 5 | Copyright (c) 2006 - 2020, Intel Corporation. All rights reserved.<BR>\r |
9d510e61 | 6 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
3af9b388 | 7 | \r |
8 | **/\r | |
9 | \r | |
10 | #include "StatusCodeHandlerRuntimeDxe.h"\r | |
11 | \r | |
12 | EFI_EVENT mVirtualAddressChangeEvent = NULL;\r | |
af51cb48 | 13 | static EFI_EVENT mExitBootServicesEvent = NULL;\r |
3af9b388 | 14 | EFI_RSC_HANDLER_PROTOCOL *mRscHandlerProtocol = NULL;\r |
15 | \r | |
16 | /**\r | |
17 | Unregister status code callback functions only available at boot time from\r | |
18 | report status code router when exiting boot services.\r | |
19 | \r | |
20 | @param Event Event whose notification function is being invoked.\r | |
21 | @param Context Pointer to the notification function's context, which is\r | |
22 | always zero in current implementation.\r | |
23 | \r | |
24 | **/\r | |
25 | VOID\r | |
26 | EFIAPI\r | |
27 | UnregisterBootTimeHandlers (\r | |
28 | IN EFI_EVENT Event,\r | |
29 | IN VOID *Context\r | |
30 | )\r | |
31 | {\r | |
45bc2817 | 32 | if (PcdGetBool (PcdStatusCodeUseSerial)) {\r |
3af9b388 | 33 | mRscHandlerProtocol->Unregister (SerialStatusCodeReportWorker);\r |
34 | }\r | |
35 | }\r | |
36 | \r | |
37 | /**\r | |
38 | Virtual address change notification call back. It converts global pointer\r | |
39 | to virtual address.\r | |
40 | \r | |
41 | @param Event Event whose notification function is being invoked.\r | |
42 | @param Context Pointer to the notification function's context, which is\r | |
43 | always zero in current implementation.\r | |
44 | \r | |
45 | **/\r | |
46 | VOID\r | |
47 | EFIAPI\r | |
48 | VirtualAddressChangeCallBack (\r | |
49 | IN EFI_EVENT Event,\r | |
50 | IN VOID *Context\r | |
51 | )\r | |
52 | {\r | |
53 | //\r | |
54 | // Convert memory status code table to virtual address;\r | |
55 | //\r | |
56 | EfiConvertPointer (\r | |
57 | 0,\r | |
58 | (VOID **) &mRtMemoryStatusCodeTable\r | |
59 | );\r | |
60 | }\r | |
61 | \r | |
62 | /**\r | |
d1102dba | 63 | Dispatch initialization request to sub status code devices based on\r |
3af9b388 | 64 | customized feature flags.\r |
d1102dba | 65 | \r |
3af9b388 | 66 | **/\r |
67 | VOID\r | |
68 | InitializationDispatcherWorker (\r | |
69 | VOID\r | |
70 | )\r | |
71 | {\r | |
72 | EFI_PEI_HOB_POINTERS Hob;\r | |
73 | EFI_STATUS Status;\r | |
74 | MEMORY_STATUSCODE_PACKET_HEADER *PacketHeader;\r | |
75 | MEMORY_STATUSCODE_RECORD *Record;\r | |
3af9b388 | 76 | UINTN Index;\r |
be63a20a | 77 | UINTN MaxRecordNumber;\r |
3af9b388 | 78 | \r |
79 | //\r | |
80 | // If enable UseSerial, then initialize serial port.\r | |
81 | // if enable UseRuntimeMemory, then initialize runtime memory status code worker.\r | |
82 | //\r | |
45bc2817 | 83 | if (PcdGetBool (PcdStatusCodeUseSerial)) {\r |
3af9b388 | 84 | //\r |
85 | // Call Serial Port Lib API to initialize serial port.\r | |
86 | //\r | |
87 | Status = SerialPortInitialize ();\r | |
88 | ASSERT_EFI_ERROR (Status);\r | |
89 | }\r | |
45bc2817 | 90 | if (PcdGetBool (PcdStatusCodeUseMemory)) {\r |
3af9b388 | 91 | Status = RtMemoryStatusCodeInitializeWorker ();\r |
92 | ASSERT_EFI_ERROR (Status);\r | |
93 | }\r | |
94 | \r | |
95 | //\r | |
d1102dba | 96 | // Replay Status code which saved in GUID'ed HOB to all supported devices.\r |
3af9b388 | 97 | //\r |
98 | if (FeaturePcdGet (PcdStatusCodeReplayIn)) {\r | |
d1102dba LG |
99 | //\r |
100 | // Journal GUID'ed HOBs to find all record entry, if found,\r | |
3af9b388 | 101 | // then output record to support replay device.\r |
102 | //\r | |
3af9b388 | 103 | Hob.Raw = GetFirstGuidHob (&gMemoryStatusCodeRecordGuid);\r |
be63a20a | 104 | if (Hob.Raw != NULL) {\r |
3af9b388 | 105 | PacketHeader = (MEMORY_STATUSCODE_PACKET_HEADER *) GET_GUID_HOB_DATA (Hob.Guid);\r |
be63a20a LG |
106 | Record = (MEMORY_STATUSCODE_RECORD *) (PacketHeader + 1);\r |
107 | MaxRecordNumber = (UINTN) PacketHeader->RecordIndex;\r | |
108 | if (PacketHeader->PacketIndex > 0) {\r | |
3af9b388 | 109 | //\r |
be63a20a | 110 | // Record has been wrapped around. So, record number has arrived at max number.\r |
3af9b388 | 111 | //\r |
be63a20a LG |
112 | MaxRecordNumber = (UINTN) PacketHeader->MaxRecordsNumber;\r |
113 | }\r | |
114 | for (Index = 0; Index < MaxRecordNumber; Index++) {\r | |
3af9b388 | 115 | //\r |
be63a20a | 116 | // Dispatch records to devices based on feature flag.\r |
3af9b388 | 117 | //\r |
45bc2817 | 118 | if (PcdGetBool (PcdStatusCodeUseSerial)) {\r |
be63a20a LG |
119 | SerialStatusCodeReportWorker (\r |
120 | Record[Index].CodeType,\r | |
121 | Record[Index].Value,\r | |
122 | Record[Index].Instance,\r | |
123 | NULL,\r | |
124 | NULL\r | |
125 | );\r | |
126 | }\r | |
45bc2817 | 127 | if (PcdGetBool (PcdStatusCodeUseMemory)) {\r |
be63a20a LG |
128 | RtMemoryStatusCodeReportWorker (\r |
129 | Record[Index].CodeType,\r | |
130 | Record[Index].Value,\r | |
131 | Record[Index].Instance,\r | |
132 | NULL,\r | |
133 | NULL\r | |
134 | );\r | |
135 | }\r | |
3af9b388 | 136 | }\r |
3af9b388 | 137 | }\r |
138 | }\r | |
139 | }\r | |
140 | \r | |
141 | /**\r | |
142 | Entry point of DXE Status Code Driver.\r | |
143 | \r | |
144 | This function is the entry point of this DXE Status Code Driver.\r | |
145 | It initializes registers status code handlers, and registers event for EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.\r | |
146 | \r | |
147 | @param ImageHandle The firmware allocated handle for the EFI image.\r | |
148 | @param SystemTable A pointer to the EFI System Table.\r | |
d1102dba | 149 | \r |
3af9b388 | 150 | @retval EFI_SUCCESS The entry point is executed successfully.\r |
151 | \r | |
152 | **/\r | |
153 | EFI_STATUS\r | |
154 | EFIAPI\r | |
155 | StatusCodeHandlerRuntimeDxeEntry (\r | |
156 | IN EFI_HANDLE ImageHandle,\r | |
157 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
158 | )\r | |
159 | {\r | |
160 | EFI_STATUS Status;\r | |
161 | \r | |
162 | Status = gBS->LocateProtocol (\r | |
163 | &gEfiRscHandlerProtocolGuid,\r | |
164 | NULL,\r | |
165 | (VOID **) &mRscHandlerProtocol\r | |
166 | );\r | |
167 | ASSERT_EFI_ERROR (Status);\r | |
168 | \r | |
169 | //\r | |
170 | // Dispatch initialization request to supported devices\r | |
171 | //\r | |
172 | InitializationDispatcherWorker ();\r | |
173 | \r | |
45bc2817 | 174 | if (PcdGetBool (PcdStatusCodeUseSerial)) {\r |
3af9b388 | 175 | mRscHandlerProtocol->Register (SerialStatusCodeReportWorker, TPL_HIGH_LEVEL);\r |
176 | }\r | |
45bc2817 | 177 | if (PcdGetBool (PcdStatusCodeUseMemory)) {\r |
3af9b388 | 178 | mRscHandlerProtocol->Register (RtMemoryStatusCodeReportWorker, TPL_HIGH_LEVEL);\r |
179 | }\r | |
180 | \r | |
181 | Status = gBS->CreateEventEx (\r | |
182 | EVT_NOTIFY_SIGNAL,\r | |
183 | TPL_NOTIFY,\r | |
184 | UnregisterBootTimeHandlers,\r | |
185 | NULL,\r | |
186 | &gEfiEventExitBootServicesGuid,\r | |
187 | &mExitBootServicesEvent\r | |
188 | );\r | |
189 | \r | |
190 | Status = gBS->CreateEventEx (\r | |
191 | EVT_NOTIFY_SIGNAL,\r | |
192 | TPL_NOTIFY,\r | |
193 | VirtualAddressChangeCallBack,\r | |
194 | NULL,\r | |
195 | &gEfiEventVirtualAddressChangeGuid,\r | |
196 | &mVirtualAddressChangeEvent\r | |
197 | );\r | |
198 | ASSERT_EFI_ERROR (Status);\r | |
199 | \r | |
200 | return EFI_SUCCESS;\r | |
201 | }\r |