3 Copyright (c) 2006, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 This file deals with Architecture Protocol (AP) registration in
19 the Dxe Core. The mArchProtocols[] array represents a list of
20 events that represent the Architectural Protocols.
28 // DXE Core Global Variables for all of the Architectural Protocols.
29 // If a protocol is installed mArchProtocols[].Present will be TRUE.
31 // CoreNotifyOnArchProtocolInstallation () fills in mArchProtocols[].Event
32 // and mArchProtocols[].Registration as it creates events for every array
36 ARCHITECTURAL_PROTOCOL_ENTRY mArchProtocols
[] = {
37 { &gEfiSecurityArchProtocolGuid
, (VOID
**)&gSecurity
, NULL
, NULL
, FALSE
},
38 { &gEfiCpuArchProtocolGuid
, (VOID
**)&gCpu
, NULL
, NULL
, FALSE
},
39 { &gEfiMetronomeArchProtocolGuid
, (VOID
**)&gMetronome
, NULL
, NULL
, FALSE
},
40 { &gEfiTimerArchProtocolGuid
, (VOID
**)&gTimer
, NULL
, NULL
, FALSE
},
41 { &gEfiBdsArchProtocolGuid
, (VOID
**)&gBds
, NULL
, NULL
, FALSE
},
42 { &gEfiWatchdogTimerArchProtocolGuid
, (VOID
**)&gWatchdogTimer
, NULL
, NULL
, FALSE
},
43 { &gEfiRuntimeArchProtocolGuid
, (VOID
**)&gRuntime
, NULL
, NULL
, FALSE
},
44 { &gEfiVariableArchProtocolGuid
, (VOID
**)NULL
, NULL
, NULL
, FALSE
},
45 { &gEfiVariableWriteArchProtocolGuid
, (VOID
**)NULL
, NULL
, NULL
, FALSE
},
46 { &gEfiMonotonicCounterArchProtocolGuid
, (VOID
**)NULL
, NULL
, NULL
, FALSE
},
47 { &gEfiResetArchProtocolGuid
, (VOID
**)NULL
, NULL
, NULL
, FALSE
},
48 // { &gEfiStatusCodeRuntimeProtocolGuid, (VOID **)&gStatusCode, NULL, NULL, FALSE },
49 { &gEfiRealTimeClockArchProtocolGuid
, (VOID
**)NULL
, NULL
, NULL
, FALSE
},
50 { NULL
, (VOID
**)NULL
, NULL
, NULL
, FALSE
}
55 CoreAllEfiServicesAvailable (
61 Return TRUE if all AP services are availible.
67 EFI_SUCCESS - All AP services are available
68 EFI_NOT_FOUND - At least one AP service is not available
72 ARCHITECTURAL_PROTOCOL_ENTRY
*Entry
;
74 for (Entry
= mArchProtocols
; Entry
->ProtocolGuid
!= NULL
; Entry
++) {
75 if (!Entry
->Present
) {
86 GenericArchProtocolNotify (
93 Notification event handler registered by CoreNotifyOnArchProtocolInstallation ().
94 This notify function is registered for every architectural protocol. This handler
95 updates mArchProtocol[] array entry with protocol instance data and sets it's
96 present flag to TRUE. If any constructor is required it is executed. The EFI
97 System Table headers are updated.
101 Event - The Event that is being processed, not used.
103 Context - Event Context, not used.
112 ARCHITECTURAL_PROTOCOL_ENTRY
*Entry
;
117 for (Entry
= mArchProtocols
; Entry
->ProtocolGuid
!= NULL
; Entry
++) {
119 Status
= CoreLocateProtocol (Entry
->ProtocolGuid
, Entry
->Registration
, &Protocol
);
120 if (EFI_ERROR (Status
)) {
125 Entry
->Present
= TRUE
;
128 // Update protocol global variable if one exists. Entry->Protocol points to a global variable
129 // if one exists in the DXE core for this Architectural Protocol
131 if (Entry
->Protocol
!= NULL
) {
132 *(Entry
->Protocol
) = Protocol
;
135 if (CompareGuid (Entry
->ProtocolGuid
, &gEfiTimerArchProtocolGuid
)) {
137 // Register the Core timer tick handler with the Timer AP
139 gTimer
->RegisterHandler (gTimer
, CoreTimerTick
);
142 if (CompareGuid (Entry
->ProtocolGuid
, &gEfiRuntimeArchProtocolGuid
)) {
144 // When runtime architectural protocol is available, updates CRC32 in the Debug Table
146 CoreUpdateDebugTableCrc32 ();
151 // It's over kill to do them all every time, but it saves a lot of code.
154 CalculateEfiHdrCrc (&gRT
->Hdr
);
155 CalculateEfiHdrCrc (&gBS
->Hdr
);
156 CalculateEfiHdrCrc (&gST
->Hdr
);
157 CalculateEfiHdrCrc (&gDS
->Hdr
);
164 CoreNotifyOnArchProtocolInstallation (
170 Creates an event that is fired everytime a Protocol of a specific type is installed
181 ARCHITECTURAL_PROTOCOL_ENTRY
*Entry
;
183 for (Entry
= mArchProtocols
; Entry
->ProtocolGuid
!= NULL
; Entry
++) {
188 Status
= CoreCreateEvent (
189 EFI_EVENT_NOTIFY_SIGNAL
,
191 GenericArchProtocolNotify
,
195 ASSERT_EFI_ERROR(Status
);
198 // Register for protocol notifactions on this event
200 Status
= CoreRegisterProtocolNotify (
205 ASSERT_EFI_ERROR(Status
);
211 // Following is needed to display missing architectural protocols in debug builds
214 EFI_GUID
*ProtocolGuid
;
216 } GUID_TO_STRING_PROTOCOL_ENTRY
;
218 static const GUID_TO_STRING_PROTOCOL_ENTRY MissingProtocols
[] = {
219 { &gEfiSecurityArchProtocolGuid
, (CHAR16
*)L
"Security" },
220 { &gEfiCpuArchProtocolGuid
, (CHAR16
*)L
"CPU" },
221 { &gEfiMetronomeArchProtocolGuid
, (CHAR16
*)L
"Metronome" },
222 { &gEfiTimerArchProtocolGuid
, (CHAR16
*)L
"Timer" },
223 { &gEfiBdsArchProtocolGuid
, (CHAR16
*)L
"Bds" },
224 { &gEfiWatchdogTimerArchProtocolGuid
, (CHAR16
*)L
"Watchdog Timer" },
225 { &gEfiRuntimeArchProtocolGuid
, (CHAR16
*)L
"Runtime" },
226 { &gEfiVariableArchProtocolGuid
, (CHAR16
*)L
"Variable" },
227 { &gEfiVariableWriteArchProtocolGuid
, (CHAR16
*)L
"Variable Write" },
228 { &gEfiMonotonicCounterArchProtocolGuid
, (CHAR16
*)L
"Monotonic Counter" },
229 { &gEfiResetArchProtocolGuid
, (CHAR16
*)L
"Reset" },
230 // { &gEfiStatusCodeRuntimeProtocolGuid, (CHAR16 *)L"Status Code" },
231 { &gEfiRealTimeClockArchProtocolGuid
, (CHAR16
*)L
"Real Time Clock" }
235 CoreDisplayMissingArchProtocols (
241 Displays Architectural protocols that were not loaded and are required for DXE core to function
242 Only used in Debug Builds
252 const GUID_TO_STRING_PROTOCOL_ENTRY
*MissingEntry
;
253 ARCHITECTURAL_PROTOCOL_ENTRY
*Entry
;
255 for (Entry
= mArchProtocols
; Entry
->ProtocolGuid
!= NULL
; Entry
++) {
256 if (!Entry
->Present
) {
257 MissingEntry
= MissingProtocols
;
258 for (MissingEntry
= MissingProtocols
; TRUE
; MissingEntry
++) {
259 if (CompareGuid (Entry
->ProtocolGuid
, MissingEntry
->ProtocolGuid
)) {
260 DEBUG ((EFI_D_ERROR
, "\n%s Arch Protocol not present!!\n", MissingEntry
->GuidString
));