[mirror_edk2.git] / EdkModulePkg / Core / Dxe / DxeMain / DxeProtocolNotify.c

/*++\r
\r
Copyright (c) 2006, Intel Corporation                                                         \r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
Module Name:\r
\r
  DxeProtocolNotify.c\r
\r
Abstract:\r
\r
  This file deals with Architecture Protocol (AP) registration in \r
  the Dxe Core. The mArchProtocols[] array represents a list of \r
  events that represent the Architectural Protocols.\r
\r
--*/\r
\r
#include <DxeMain.h>\r
\r
\r
//\r
// DXE Core Global Variables for all of the Architectural Protocols.\r
// If a protocol is installed mArchProtocols[].Present will be TRUE.\r
//\r
// CoreNotifyOnArchProtocolInstallation () fills in mArchProtocols[].Event\r
// and mArchProtocols[].Registration as it creates events for every array\r
// entry.\r
//\r
\r
ARCHITECTURAL_PROTOCOL_ENTRY  mArchProtocols[] = {\r
  { &gEfiSecurityArchProtocolGuid,         (VOID **)&gSecurity,      NULL, NULL, FALSE },\r
  { &gEfiCpuArchProtocolGuid,              (VOID **)&gCpu,           NULL, NULL, FALSE },\r
  { &gEfiMetronomeArchProtocolGuid,        (VOID **)&gMetronome,     NULL, NULL, FALSE },\r
  { &gEfiTimerArchProtocolGuid,            (VOID **)&gTimer,         NULL, NULL, FALSE },\r
  { &gEfiBdsArchProtocolGuid,              (VOID **)&gBds,           NULL, NULL, FALSE },\r
  { &gEfiWatchdogTimerArchProtocolGuid,    (VOID **)&gWatchdogTimer, NULL, NULL, FALSE },\r
  { &gEfiRuntimeArchProtocolGuid,          (VOID **)&gRuntime,       NULL, NULL, FALSE },\r
  { &gEfiVariableArchProtocolGuid,         (VOID **)NULL,            NULL, NULL, FALSE },\r
  { &gEfiVariableWriteArchProtocolGuid,    (VOID **)NULL,            NULL, NULL, FALSE },\r
  { &gEfiMonotonicCounterArchProtocolGuid, (VOID **)NULL,            NULL, NULL, FALSE },\r
  { &gEfiResetArchProtocolGuid,            (VOID **)NULL,            NULL, NULL, FALSE },\r
//  { &gEfiStatusCodeRuntimeProtocolGuid,    (VOID **)&gStatusCode,    NULL, NULL, FALSE },\r
  { &gEfiRealTimeClockArchProtocolGuid,    (VOID **)NULL,            NULL, NULL, FALSE },\r
  { NULL,                                  (VOID **)NULL,            NULL, NULL, FALSE }\r
};\r
\r
\r
EFI_STATUS\r
CoreAllEfiServicesAvailable (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
  Return TRUE if all AP services are availible.\r
\r
Arguments:\r
  NONE\r
\r
Returns:\r
  EFI_SUCCESS   - All AP services are available\r
  EFI_NOT_FOUND - At least one AP service is not available \r
\r
--*/\r
{\r
  ARCHITECTURAL_PROTOCOL_ENTRY  *Entry;\r
\r
  for (Entry = mArchProtocols; Entry->ProtocolGuid != NULL; Entry++) {\r
    if (!Entry->Present) {\r
      return EFI_NOT_FOUND;\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
VOID\r
EFIAPI\r
GenericArchProtocolNotify (\r
  IN	EFI_EVENT       Event,\r
  IN	VOID            *Context\r
  )\r
/*++\r
\r
Routine Description:\r
  Notification event handler registered by CoreNotifyOnArchProtocolInstallation ().\r
  This notify function is registered for every architectural protocol. This handler\r
  updates mArchProtocol[] array entry with protocol instance data and sets it's \r
  present flag to TRUE. If any constructor is required it is executed. The EFI \r
  System Table headers are updated.\r
\r
Arguments:\r
\r
  Event   - The Event that is being processed, not used.\r
  \r
  Context - Event Context, not used.\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
{\r
  EFI_STATUS                      Status;\r
  ARCHITECTURAL_PROTOCOL_ENTRY    *Entry;\r
  VOID                            *Protocol;\r
  BOOLEAN                         Found;\r
  \r
  Found = FALSE;\r
  for (Entry = mArchProtocols; Entry->ProtocolGuid != NULL; Entry++) {\r
 \r
    Status = CoreLocateProtocol (Entry->ProtocolGuid, Entry->Registration, &Protocol);\r
    if (EFI_ERROR (Status)) {\r
      continue;\r
    } \r
    \r
    Found = TRUE;\r
    Entry->Present = TRUE;\r
    \r
    //\r
    // Update protocol global variable if one exists. Entry->Protocol points to a global variable\r
    // if one exists in the DXE core for this Architectural Protocol \r
    //\r
    if (Entry->Protocol != NULL) {\r
      *(Entry->Protocol) = Protocol;\r
    }\r
\r
    if (CompareGuid (Entry->ProtocolGuid, &gEfiTimerArchProtocolGuid)) {\r
      //\r
      // Register the Core timer tick handler with the Timer AP\r
      //\r
      gTimer->RegisterHandler (gTimer, CoreTimerTick);\r
    }\r
\r
    if (CompareGuid (Entry->ProtocolGuid, &gEfiRuntimeArchProtocolGuid)) {\r
      //\r
      // When runtime architectural protocol is available, updates CRC32 in the Debug Table\r
      //\r
      CoreUpdateDebugTableCrc32 ();\r
    }\r
  }\r
\r
  //\r
  // It's over kill to do them all every time, but it saves a lot of code.\r
  //\r
  if (Found) {\r
    CalculateEfiHdrCrc (&gRT->Hdr);\r
    CalculateEfiHdrCrc (&gBS->Hdr);\r
    CalculateEfiHdrCrc (&gST->Hdr);\r
    CalculateEfiHdrCrc (&gDS->Hdr);\r
  }\r
}\r
\r
\r
\r
VOID\r
CoreNotifyOnArchProtocolInstallation (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
  Creates an event that is fired everytime a Protocol of a specific type is installed\r
\r
Arguments:\r
  NONE\r
\r
Returns:\r
  NONE\r
\r
--*/\r
{\r
  EFI_STATUS                      Status;\r
  ARCHITECTURAL_PROTOCOL_ENTRY    *Entry;\r
\r
  for (Entry = mArchProtocols; Entry->ProtocolGuid != NULL; Entry++) {\r
    \r
    //\r
    // Create the event\r
    //\r
    Status = CoreCreateEvent (\r
              EFI_EVENT_NOTIFY_SIGNAL,\r
              EFI_TPL_CALLBACK,\r
              GenericArchProtocolNotify,\r
              NULL,\r
              &Entry->Event\r
              );\r
    ASSERT_EFI_ERROR(Status);\r
\r
    //\r
    // Register for protocol notifactions on this event\r
    //\r
    Status = CoreRegisterProtocolNotify (\r
              Entry->ProtocolGuid, \r
              Entry->Event, \r
              &Entry->Registration\r
              );\r
    ASSERT_EFI_ERROR(Status);\r
\r
  }\r
}\r
\r
//\r
// Following is needed to display missing architectural protocols in debug builds\r
//\r
typedef struct {\r
  EFI_GUID                    *ProtocolGuid;\r
  CHAR16                       *GuidString;\r
} GUID_TO_STRING_PROTOCOL_ENTRY;\r
\r
static const GUID_TO_STRING_PROTOCOL_ENTRY MissingProtocols[] = {\r
  { &gEfiSecurityArchProtocolGuid,         (CHAR16 *)L"Security"           },\r
  { &gEfiCpuArchProtocolGuid,              (CHAR16 *)L"CPU"                },\r
  { &gEfiMetronomeArchProtocolGuid,        (CHAR16 *)L"Metronome"          },\r
  { &gEfiTimerArchProtocolGuid,            (CHAR16 *)L"Timer"              },\r
  { &gEfiBdsArchProtocolGuid,              (CHAR16 *)L"Bds"                },\r
  { &gEfiWatchdogTimerArchProtocolGuid,    (CHAR16 *)L"Watchdog Timer"     },\r
  { &gEfiRuntimeArchProtocolGuid,          (CHAR16 *)L"Runtime"            },\r
  { &gEfiVariableArchProtocolGuid,         (CHAR16 *)L"Variable"           },\r
  { &gEfiVariableWriteArchProtocolGuid,    (CHAR16 *)L"Variable Write"     },\r
  { &gEfiMonotonicCounterArchProtocolGuid, (CHAR16 *)L"Monotonic Counter"  },\r
  { &gEfiResetArchProtocolGuid,            (CHAR16 *)L"Reset"              },\r
//  { &gEfiStatusCodeRuntimeProtocolGuid,       (CHAR16 *)L"Status Code"        },\r
  { &gEfiRealTimeClockArchProtocolGuid,    (CHAR16 *)L"Real Time Clock"    }\r
};\r
\r
VOID\r
CoreDisplayMissingArchProtocols (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
  Displays Architectural protocols that were not loaded and are required for DXE core to function\r
  Only used in Debug Builds\r
\r
Arguments:\r
  NONE\r
\r
Returns:\r
  NONE\r
\r
--*/\r
{\r
  const GUID_TO_STRING_PROTOCOL_ENTRY  *MissingEntry;\r
  ARCHITECTURAL_PROTOCOL_ENTRY         *Entry;\r
\r
  for (Entry = mArchProtocols; Entry->ProtocolGuid != NULL; Entry++) {\r
    if (!Entry->Present) {\r
      MissingEntry = MissingProtocols;\r
      for (MissingEntry = MissingProtocols; TRUE ; MissingEntry++) {\r
        if (CompareGuid (Entry->ProtocolGuid, MissingEntry->ProtocolGuid)) {\r
          DEBUG ((EFI_D_ERROR, "\n%s Arch Protocol not present!!\n", MissingEntry->GuidString));\r
          break;\r
        }\r
      }\r
    }\r
  } \r
}\r
Commit	Line	Data
878ddf1f	1	/*++\r
	2	\r
	3	Copyright (c) 2006, Intel Corporation \r
	4	All rights reserved. This program and the accompanying materials \r
	5	are licensed and made available under the terms and conditions of the BSD License \r
	6	which accompanies this distribution. The full text of the license may be found at \r
	7	http://opensource.org/licenses/bsd-license.php \r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	11	\r
	12	Module Name:\r
	13	\r
	14	DxeProtocolNotify.c\r
	15	\r
	16	Abstract:\r
	17	\r
	18	This file deals with Architecture Protocol (AP) registration in \r
	19	the Dxe Core. The mArchProtocols[] array represents a list of \r
	20	events that represent the Architectural Protocols.\r
	21	\r
	22	--*/\r
	23	\r
	24	#include <DxeMain.h>\r
	25	\r
	26	\r
	27	//\r
	28	// DXE Core Global Variables for all of the Architectural Protocols.\r
	29	// If a protocol is installed mArchProtocols[].Present will be TRUE.\r
	30	//\r
	31	// CoreNotifyOnArchProtocolInstallation () fills in mArchProtocols[].Event\r
	32	// and mArchProtocols[].Registration as it creates events for every array\r
	33	// entry.\r
	34	//\r
	35	\r
	36	ARCHITECTURAL_PROTOCOL_ENTRY mArchProtocols[] = {\r
	37	{ &gEfiSecurityArchProtocolGuid, (VOID **)&gSecurity, NULL, NULL, FALSE },\r
	38	{ &gEfiCpuArchProtocolGuid, (VOID **)&gCpu, NULL, NULL, FALSE },\r
	39	{ &gEfiMetronomeArchProtocolGuid, (VOID **)&gMetronome, NULL, NULL, FALSE },\r
	40	{ &gEfiTimerArchProtocolGuid, (VOID **)&gTimer, NULL, NULL, FALSE },\r
	41	{ &gEfiBdsArchProtocolGuid, (VOID **)&gBds, NULL, NULL, FALSE },\r
	42	{ &gEfiWatchdogTimerArchProtocolGuid, (VOID **)&gWatchdogTimer, NULL, NULL, FALSE },\r
	43	{ &gEfiRuntimeArchProtocolGuid, (VOID **)&gRuntime, NULL, NULL, FALSE },\r
	44	{ &gEfiVariableArchProtocolGuid, (VOID **)NULL, NULL, NULL, FALSE },\r
	45	{ &gEfiVariableWriteArchProtocolGuid, (VOID **)NULL, NULL, NULL, FALSE },\r
	46	{ &gEfiMonotonicCounterArchProtocolGuid, (VOID **)NULL, NULL, NULL, FALSE },\r
	47	{ &gEfiResetArchProtocolGuid, (VOID **)NULL, NULL, NULL, FALSE },\r
	48	// { &gEfiStatusCodeRuntimeProtocolGuid, (VOID **)&gStatusCode, NULL, NULL, FALSE },\r
	49	{ &gEfiRealTimeClockArchProtocolGuid, (VOID **)NULL, NULL, NULL, FALSE },\r
	50	{ NULL, (VOID **)NULL, NULL, NULL, FALSE }\r
	51	};\r
	52	\r
	53	\r
	54	EFI_STATUS\r
	55	CoreAllEfiServicesAvailable (\r
	56	VOID\r
	57	)\r
	58	/*++\r
	59	\r
	60	Routine Description:\r
	61	Return TRUE if all AP services are availible.\r
	62	\r
	63	Arguments:\r
	64	NONE\r
65	\r
66	Returns:\r
67	EFI_SUCCESS - All AP services are available\r
68	EFI_NOT_FOUND - At least one AP service is not available \r
69	\r
70	--*/\r
71	{\r
72	ARCHITECTURAL_PROTOCOL_ENTRY *Entry;\r
73	\r
74	for (Entry = mArchProtocols; Entry->ProtocolGuid != NULL; Entry++) {\r
75	if (!Entry->Present) {\r
76	return EFI_NOT_FOUND;\r
77	}\r
78	}\r
79	\r
80	return EFI_SUCCESS;\r
81	}\r
82	\r
83	\r
84	VOID\r
85	EFIAPI\r
86	GenericArchProtocolNotify (\r
87	IN EFI_EVENT Event,\r
88	IN VOID *Context\r
89	)\r
90	/*++\r
91	\r
92	Routine Description:\r
93	Notification event handler registered by CoreNotifyOnArchProtocolInstallation ().\r
94	This notify function is registered for every architectural protocol. This handler\r
95	updates mArchProtocol[] array entry with protocol instance data and sets it's \r
96	present flag to TRUE. If any constructor is required it is executed. The EFI \r
97	System Table headers are updated.\r
98	\r
99	Arguments:\r
100	\r
101	Event - The Event that is being processed, not used.\r
102	\r
103	Context - Event Context, not used.\r
104	\r
105	Returns:\r
106	\r
107	None\r
108	\r
109	--*/\r
110	{\r
111	EFI_STATUS Status;\r
112	ARCHITECTURAL_PROTOCOL_ENTRY *Entry;\r
113	VOID *Protocol;\r
114	BOOLEAN Found;\r
115	\r
116	Found = FALSE;\r
117	for (Entry = mArchProtocols; Entry->ProtocolGuid != NULL; Entry++) {\r
118	\r
119	Status = CoreLocateProtocol (Entry->ProtocolGuid, Entry->Registration, &Protocol);\r
120	if (EFI_ERROR (Status)) {\r
121	continue;\r
122	} \r
123	\r
124	Found = TRUE;\r
125	Entry->Present = TRUE;\r
126	\r
127	//\r
128	// Update protocol global variable if one exists. Entry->Protocol points to a global variable\r
129	// if one exists in the DXE core for this Architectural Protocol \r
130	//\r
131	if (Entry->Protocol != NULL) {\r
132	*(Entry->Protocol) = Protocol;\r
133	}\r
134	\r
135	if (CompareGuid (Entry->ProtocolGuid, &gEfiTimerArchProtocolGuid)) {\r
136	//\r
137	// Register the Core timer tick handler with the Timer AP\r
138	//\r
139	gTimer->RegisterHandler (gTimer, CoreTimerTick);\r
140	}\r
141	\r
142	if (CompareGuid (Entry->ProtocolGuid, &gEfiRuntimeArchProtocolGuid)) {\r
143	//\r
144	// When runtime architectural protocol is available, updates CRC32 in the Debug Table\r
145	//\r
146	CoreUpdateDebugTableCrc32 ();\r
147	}\r
148	}\r
149	\r
150	//\r
151	// It's over kill to do them all every time, but it saves a lot of code.\r
152	//\r
153	if (Found) {\r
154	CalculateEfiHdrCrc (&gRT->Hdr);\r
155	CalculateEfiHdrCrc (&gBS->Hdr);\r
156	CalculateEfiHdrCrc (&gST->Hdr);\r
157	CalculateEfiHdrCrc (&gDS->Hdr);\r
158	}\r
159	}\r
160	\r
161	\r
162	\r
163	VOID\r
164	CoreNotifyOnArchProtocolInstallation (\r
165	VOID\r
166	)\r
167	/*++\r
168	\r
169	Routine Description:\r
170	Creates an event that is fired everytime a Protocol of a specific type is installed\r
171	\r
172	Arguments:\r
173	NONE\r
174	\r
175	Returns:\r
176	NONE\r
177	\r
178	--*/\r
179	{\r
180	EFI_STATUS Status;\r
181	ARCHITECTURAL_PROTOCOL_ENTRY *Entry;\r
182	\r
183	for (Entry = mArchProtocols; Entry->ProtocolGuid != NULL; Entry++) {\r
184	\r
185	//\r
186	// Create the event\r
187	//\r
188	Status = CoreCreateEvent (\r
189	EFI_EVENT_NOTIFY_SIGNAL,\r
190	EFI_TPL_CALLBACK,\r
191	GenericArchProtocolNotify,\r
192	NULL,\r
193	&Entry->Event\r
194	);\r
195	ASSERT_EFI_ERROR(Status);\r
196	\r
197	//\r
198	// Register for protocol notifactions on this event\r
199	//\r
200	Status = CoreRegisterProtocolNotify (\r
201	Entry->ProtocolGuid, \r
202	Entry->Event, \r
203	&Entry->Registration\r
204	);\r
205	ASSERT_EFI_ERROR(Status);\r
206	\r
207	}\r
208	}\r
209	\r
210	//\r
211	// Following is needed to display missing architectural protocols in debug builds\r
212	//\r
213	typedef struct {\r
214	EFI_GUID *ProtocolGuid;\r
215	CHAR16 *GuidString;\r
216	} GUID_TO_STRING_PROTOCOL_ENTRY;\r
217	\r
218	static const GUID_TO_STRING_PROTOCOL_ENTRY MissingProtocols[] = {\r
219	{ &gEfiSecurityArchProtocolGuid, (CHAR16 *)L"Security" },\r
220	{ &gEfiCpuArchProtocolGuid, (CHAR16 *)L"CPU" },\r
221	{ &gEfiMetronomeArchProtocolGuid, (CHAR16 *)L"Metronome" },\r
222	{ &gEfiTimerArchProtocolGuid, (CHAR16 *)L"Timer" },\r
223	{ &gEfiBdsArchProtocolGuid, (CHAR16 *)L"Bds" },\r
224	{ &gEfiWatchdogTimerArchProtocolGuid, (CHAR16 *)L"Watchdog Timer" },\r
225	{ &gEfiRuntimeArchProtocolGuid, (CHAR16 *)L"Runtime" },\r
226	{ &gEfiVariableArchProtocolGuid, (CHAR16 *)L"Variable" },\r
227	{ &gEfiVariableWriteArchProtocolGuid, (CHAR16 *)L"Variable Write" },\r
228	{ &gEfiMonotonicCounterArchProtocolGuid, (CHAR16 *)L"Monotonic Counter" },\r
229	{ &gEfiResetArchProtocolGuid, (CHAR16 *)L"Reset" },\r
230	// { &gEfiStatusCodeRuntimeProtocolGuid, (CHAR16 *)L"Status Code" },\r
231	{ &gEfiRealTimeClockArchProtocolGuid, (CHAR16 *)L"Real Time Clock" }\r
232	};\r
233	\r
234	VOID\r
235	CoreDisplayMissingArchProtocols (\r
236	VOID\r
237	)\r
238	/*++\r
239	\r
240	Routine Description:\r
241	Displays Architectural protocols that were not loaded and are required for DXE core to function\r
242	Only used in Debug Builds\r
243	\r
244	Arguments:\r
245	NONE\r
246	\r
247	Returns:\r
248	NONE\r
249	\r
250	--*/\r
251	{\r
252	const GUID_TO_STRING_PROTOCOL_ENTRY *MissingEntry;\r
253	ARCHITECTURAL_PROTOCOL_ENTRY *Entry;\r
254	\r
255	for (Entry = mArchProtocols; Entry->ProtocolGuid != NULL; Entry++) {\r
256	if (!Entry->Present) {\r
257	MissingEntry = MissingProtocols;\r
258	for (MissingEntry = MissingProtocols; TRUE ; MissingEntry++) {\r
259	if (CompareGuid (Entry->ProtocolGuid, MissingEntry->ProtocolGuid)) {\r
260	DEBUG ((EFI_D_ERROR, "\n%s Arch Protocol not present!!\n", MissingEntry->GuidString));\r
261	break;\r
262	}\r
263	}\r
264	}\r
265	} \r
266	}\r