[mirror_edk2.git] / MdeModulePkg / Universal / ReportStatusCodeRouter / Pei / ReportStatusCodeRouterPei.c

/** @file\r
  Report Status Code Router PEIM which produces Report Stataus Code Handler PPI and Status Code PPI.\r
\r
  Copyright (c) 2009, 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
**/\r
\r
#include "ReportStatusCodeRouterPei.h"\r
\r
EFI_PEI_RSC_HANDLER_PPI     mRscHandlerPpi = {\r
  Register,\r
  Unregister\r
  };\r
\r
EFI_PEI_PROGRESS_CODE_PPI     mStatusCodePpi = {\r
  ReportDispatcher\r
  };\r
\r
EFI_PEI_PPI_DESCRIPTOR   mStatusCodePpiList[] = {\r
  {\r
    EFI_PEI_PPI_DESCRIPTOR_PPI,\r
    &gEfiPeiRscHandlerPpiGuid,\r
    &mRscHandlerPpi\r
  },\r
  {\r
    EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,\r
    &gEfiPeiStatusCodePpiGuid,\r
    &mStatusCodePpi\r
  }\r
};\r
\r
/**\r
  Worker function to create one memory status code GUID'ed HOB,\r
  using PacketIndex to identify the packet.\r
\r
  @param   PacketIndex    Index of records packet.\r
\r
  @return  Pointer to the memory status code packet.\r
\r
**/\r
UINTN *\r
CreateRscHandlerCallbackPacket (\r
  VOID\r
  )\r
{\r
  UINTN  *NumberOfEntries;\r
\r
  //\r
  // Build GUID'ed HOB with PCD defined size.\r
  //\r
  NumberOfEntries = BuildGuidHob (\r
                      &gStatusCodeCallbackGuid,\r
                      sizeof (EFI_PEI_RSC_HANDLER_CALLBACK) * 64 + sizeof (UINTN)\r
                      );\r
  ASSERT (NumberOfEntries != NULL);\r
\r
  *NumberOfEntries = 0;\r
\r
  return NumberOfEntries;\r
}\r
\r
/**\r
  Register the callback function for ReportStatusCode() notification.\r
  \r
  When this function is called the function pointer is added to an internal list and any future calls to\r
  ReportStatusCode() will be forwarded to the Callback function.\r
\r
  @param[in] Callback           A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is called\r
                                when a call to ReportStatusCode() occurs.\r
                        \r
  @retval EFI_SUCCESS           Function was successfully registered.\r
  @retval EFI_INVALID_PARAMETER The callback function was NULL.\r
  @retval EFI_OUT_OF_RESOURCES  The internal buffer ran out of space. No more functions can be\r
                                registered.\r
  @retval EFI_ALREADY_STARTED   The function was already registered. It can't be registered again.\r
  \r
**/\r
EFI_STATUS\r
EFIAPI\r
Register (\r
  IN EFI_PEI_RSC_HANDLER_CALLBACK Callback\r
  )\r
{\r
  EFI_PEI_HOB_POINTERS          Hob;\r
  EFI_PEI_RSC_HANDLER_CALLBACK  *CallbackEntry;\r
  UINTN                         *NumberOfEntries;\r
  UINTN                         Index;\r
  UINTN                         *FreePacket;\r
\r
  if (Callback == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Hob.Raw  = GetFirstGuidHob (&gStatusCodeCallbackGuid);\r
  FreePacket = NULL;\r
  while (Hob.Raw != NULL) {\r
    NumberOfEntries = GET_GUID_HOB_DATA (Hob);\r
    CallbackEntry   = (EFI_PEI_RSC_HANDLER_CALLBACK *) (NumberOfEntries + 1);\r
    if (*NumberOfEntries < 64) {\r
      FreePacket = NumberOfEntries;\r
    }\r
    for (Index = 0; Index < *NumberOfEntries; Index++) {\r
      if (CallbackEntry[Index] == Callback) {\r
        //\r
        // If the function was already registered. It can't be registered again.\r
        //\r
        return EFI_ALREADY_STARTED;\r
      }\r
    }\r
    Hob.Raw = GET_NEXT_HOB (Hob);\r
    Hob.Raw = GetNextGuidHob (&gStatusCodeCallbackGuid, Hob.Raw);\r
  }\r
\r
  if (FreePacket == NULL) {\r
    FreePacket = CreateRscHandlerCallbackPacket();\r
  }\r
\r
  CallbackEntry = (EFI_PEI_RSC_HANDLER_CALLBACK *) (FreePacket + 1);\r
  CallbackEntry[*FreePacket] = Callback;\r
  *FreePacket += 1;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Remove a previously registered callback function from the notification list.\r
  \r
  ReportStatusCode() messages will no longer be forwarded to the Callback function.\r
  \r
  @param[in] Callback           A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is to be\r
                                unregistered.\r
\r
  @retval EFI_SUCCESS           The function was successfully unregistered.\r
  @retval EFI_INVALID_PARAMETER The callback function was NULL.\r
  @retval EFI_NOT_FOUND         The callback function was not found to be unregistered.\r
                        \r
**/\r
EFI_STATUS\r
EFIAPI\r
Unregister (\r
  IN EFI_PEI_RSC_HANDLER_CALLBACK Callback\r
  )\r
{\r
  EFI_PEI_HOB_POINTERS            Hob;\r
  EFI_PEI_RSC_HANDLER_CALLBACK    *CallbackEntry;\r
  UINTN                           *NumberOfEntries;\r
  UINTN                           Index;\r
\r
  if (Callback == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Hob.Raw  = GetFirstGuidHob (&gStatusCodeCallbackGuid);\r
  while (Hob.Raw != NULL) {\r
    NumberOfEntries = GET_GUID_HOB_DATA (Hob);\r
    CallbackEntry   = (EFI_PEI_RSC_HANDLER_CALLBACK *) (NumberOfEntries + 1);\r
    for (Index = 0; Index < *NumberOfEntries; Index++) {\r
      if (CallbackEntry[Index] == Callback) {\r
        CallbackEntry[Index] = CallbackEntry[*NumberOfEntries - 1];\r
        *NumberOfEntries -= 1;\r
        return EFI_SUCCESS;\r
      }\r
    }\r
    Hob.Raw = GET_NEXT_HOB (Hob);\r
    Hob.Raw = GetNextGuidHob (&gStatusCodeCallbackGuid, Hob.Raw);\r
  }\r
\r
  return EFI_NOT_FOUND;\r
}\r
\r
/**\r
  Publishes an interface that allows PEIMs to report status codes.\r
\r
  This function implements EFI_PEI_PROGRESS_CODE_PPI.ReportStatusCode().\r
  It publishes an interface that allows PEIMs to report status codes.\r
\r
  @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param  CodeType         Indicates the type of status code being reported.\r
  @param  Value            Describes the current status of a hardware or\r
                           software entity. This includes information about the class and\r
                           subclass that is used to classify the entity as well as an operation.\r
                           For progress codes, the operation is the current activity.\r
                           For error codes, it is the exception.For debug codes,it is not defined at this time.\r
  @param  Instance         The enumeration of a hardware or software entity within\r
                           the system. A system may contain multiple entities that match a class/subclass\r
                           pairing. The instance differentiates between them. An instance of 0 indicates\r
                           that instance information is unavailable, not meaningful, or not relevant.\r
                           Valid instance numbers start with 1.\r
  @param  CallerId         This optional parameter may be used to identify the caller.\r
                           This parameter allows the status code driver to apply different rules to\r
                           different callers.\r
  @param  Data             This optional parameter may be used to pass additional data.\r
\r
  @retval EFI_SUCCESS      The function completed successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
ReportDispatcher (\r
  IN CONST EFI_PEI_SERVICES         **PeiServices,\r
  IN EFI_STATUS_CODE_TYPE           CodeType,\r
  IN EFI_STATUS_CODE_VALUE          Value,\r
  IN UINT32                         Instance,\r
  IN CONST EFI_GUID                 *CallerId OPTIONAL,\r
  IN CONST EFI_STATUS_CODE_DATA     *Data OPTIONAL\r
  )\r
{\r
  EFI_PEI_HOB_POINTERS            Hob;\r
  EFI_PEI_RSC_HANDLER_CALLBACK    *CallbackEntry;\r
  UINTN                           *NumberOfEntries;\r
  UINTN                           Index;\r
\r
  Hob.Raw  = GetFirstGuidHob (&gStatusCodeCallbackGuid);\r
  while (Hob.Raw != NULL) {\r
    NumberOfEntries = GET_GUID_HOB_DATA (Hob);\r
    CallbackEntry   = (EFI_PEI_RSC_HANDLER_CALLBACK *) (NumberOfEntries + 1);\r
    for (Index = 0; Index < *NumberOfEntries; Index++) {\r
      CallbackEntry[Index](\r
        PeiServices,\r
        CodeType,\r
        Value,\r
        Instance,\r
        CallerId,\r
        Data\r
        );\r
    }\r
    Hob.Raw = GET_NEXT_HOB (Hob);\r
    Hob.Raw = GetNextGuidHob (&gStatusCodeCallbackGuid, Hob.Raw);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Entry point of Status Code PEIM.\r
  \r
  This function is the entry point of this Status Code Router PEIM.\r
  It produces Report Stataus Code Handler PPI and Status Code PPI.\r
\r
  @param  FileHandle  Handle of the file being invoked.\r
  @param  PeiServices Describes the list of possible PEI Services.\r
\r
  @retval EFI_SUCESS  The entry point of DXE IPL PEIM executes successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GenericStatusCodePeiEntry (\r
  IN       EFI_PEI_FILE_HANDLE  FileHandle,\r
  IN CONST EFI_PEI_SERVICES     **PeiServices\r
  )\r
{\r
  EFI_STATUS     Status;\r
\r
  CreateRscHandlerCallbackPacket ();\r
\r
  Status = PeiServicesInstallPpi (mStatusCodePpiList);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return EFI_SUCCESS;\r
}\r
Commit	Line	Data
25126a05	1	/** @file\r
	2	Report Status Code Router PEIM which produces Report Stataus Code Handler PPI and Status Code PPI.\r
	3	\r
	4	Copyright (c) 2009, Intel Corporation\r
	5	All rights reserved. This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
	13	**/\r
	14	\r
	15	#include "ReportStatusCodeRouterPei.h"\r
	16	\r
	17	EFI_PEI_RSC_HANDLER_PPI mRscHandlerPpi = {\r
	18	Register,\r
	19	Unregister\r
	20	};\r
	21	\r
	22	EFI_PEI_PROGRESS_CODE_PPI mStatusCodePpi = {\r
	23	ReportDispatcher\r
	24	};\r
	25	\r
	26	EFI_PEI_PPI_DESCRIPTOR mStatusCodePpiList[] = {\r
	27	{\r
	28	EFI_PEI_PPI_DESCRIPTOR_PPI,\r
	29	&gEfiPeiRscHandlerPpiGuid,\r
	30	&mRscHandlerPpi\r
	31	},\r
	32	{\r
	33	EFI_PEI_PPI_DESCRIPTOR_PPI \| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,\r
	34	&gEfiPeiStatusCodePpiGuid,\r
	35	&mStatusCodePpi\r
	36	}\r
	37	};\r
	38	\r
	39	/**\r
	40	Worker function to create one memory status code GUID'ed HOB,\r
	41	using PacketIndex to identify the packet.\r
	42	\r
	43	@param PacketIndex Index of records packet.\r
	44	\r
	45	@return Pointer to the memory status code packet.\r
	46	\r
	47	**/\r
	48	UINTN *\r
	49	CreateRscHandlerCallbackPacket (\r
	50	VOID\r
	51	)\r
	52	{\r
	53	UINTN *NumberOfEntries;\r
	54	\r
	55	//\r
	56	// Build GUID'ed HOB with PCD defined size.\r
	57	//\r
	58	NumberOfEntries = BuildGuidHob (\r
	59	&gStatusCodeCallbackGuid,\r
	60	sizeof (EFI_PEI_RSC_HANDLER_CALLBACK) * 64 + sizeof (UINTN)\r
	61	);\r
	62	ASSERT (NumberOfEntries != NULL);\r
	63	\r
	64	*NumberOfEntries = 0;\r
65	\r
66	return NumberOfEntries;\r
67	}\r
68	\r
69	/**\r
70	Register the callback function for ReportStatusCode() notification.\r
71	\r
72	When this function is called the function pointer is added to an internal list and any future calls to\r
73	ReportStatusCode() will be forwarded to the Callback function.\r
74	\r
75	@param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is called\r
76	when a call to ReportStatusCode() occurs.\r
77	\r
78	@retval EFI_SUCCESS Function was successfully registered.\r
79	@retval EFI_INVALID_PARAMETER The callback function was NULL.\r
80	@retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be\r
81	registered.\r
82	@retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again.\r
83	\r
84	**/\r
85	EFI_STATUS\r
86	EFIAPI\r
87	Register (\r
88	IN EFI_PEI_RSC_HANDLER_CALLBACK Callback\r
89	)\r
90	{\r
91	EFI_PEI_HOB_POINTERS Hob;\r
92	EFI_PEI_RSC_HANDLER_CALLBACK *CallbackEntry;\r
93	UINTN *NumberOfEntries;\r
94	UINTN Index;\r
95	UINTN *FreePacket;\r
96	\r
97	if (Callback == NULL) {\r
98	return EFI_INVALID_PARAMETER;\r
99	}\r
100	\r
101	Hob.Raw = GetFirstGuidHob (&gStatusCodeCallbackGuid);\r
102	FreePacket = NULL;\r
103	while (Hob.Raw != NULL) {\r
104	NumberOfEntries = GET_GUID_HOB_DATA (Hob);\r
105	CallbackEntry = (EFI_PEI_RSC_HANDLER_CALLBACK *) (NumberOfEntries + 1);\r
106	if (*NumberOfEntries < 64) {\r
107	FreePacket = NumberOfEntries;\r
108	}\r
109	for (Index = 0; Index < *NumberOfEntries; Index++) {\r
110	if (CallbackEntry[Index] == Callback) {\r
111	//\r
112	// If the function was already registered. It can't be registered again.\r
113	//\r
114	return EFI_ALREADY_STARTED;\r
115	}\r
116	}\r
117	Hob.Raw = GET_NEXT_HOB (Hob);\r
118	Hob.Raw = GetNextGuidHob (&gStatusCodeCallbackGuid, Hob.Raw);\r
119	}\r
120	\r
121	if (FreePacket == NULL) {\r
122	FreePacket = CreateRscHandlerCallbackPacket();\r
123	}\r
124	\r
125	CallbackEntry = (EFI_PEI_RSC_HANDLER_CALLBACK *) (FreePacket + 1);\r
126	CallbackEntry[*FreePacket] = Callback;\r
127	*FreePacket += 1;\r
128	\r
129	return EFI_SUCCESS;\r
130	}\r
131	\r
132	/**\r
133	Remove a previously registered callback function from the notification list.\r
134	\r
135	ReportStatusCode() messages will no longer be forwarded to the Callback function.\r
136	\r
137	@param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is to be\r
138	unregistered.\r
139	\r
140	@retval EFI_SUCCESS The function was successfully unregistered.\r
141	@retval EFI_INVALID_PARAMETER The callback function was NULL.\r
142	@retval EFI_NOT_FOUND The callback function was not found to be unregistered.\r
143	\r
144	**/\r
145	EFI_STATUS\r
146	EFIAPI\r
147	Unregister (\r
148	IN EFI_PEI_RSC_HANDLER_CALLBACK Callback\r
149	)\r
150	{\r
151	EFI_PEI_HOB_POINTERS Hob;\r
152	EFI_PEI_RSC_HANDLER_CALLBACK *CallbackEntry;\r
153	UINTN *NumberOfEntries;\r
154	UINTN Index;\r
155	\r
156	if (Callback == NULL) {\r
157	return EFI_INVALID_PARAMETER;\r
158	}\r
159	\r
160	Hob.Raw = GetFirstGuidHob (&gStatusCodeCallbackGuid);\r
161	while (Hob.Raw != NULL) {\r
162	NumberOfEntries = GET_GUID_HOB_DATA (Hob);\r
163	CallbackEntry = (EFI_PEI_RSC_HANDLER_CALLBACK *) (NumberOfEntries + 1);\r
164	for (Index = 0; Index < *NumberOfEntries; Index++) {\r
165	if (CallbackEntry[Index] == Callback) {\r
166	CallbackEntry[Index] = CallbackEntry[*NumberOfEntries - 1];\r
167	*NumberOfEntries -= 1;\r
168	return EFI_SUCCESS;\r
169	}\r
170	}\r
171	Hob.Raw = GET_NEXT_HOB (Hob);\r
172	Hob.Raw = GetNextGuidHob (&gStatusCodeCallbackGuid, Hob.Raw);\r
173	}\r
174	\r
175	return EFI_NOT_FOUND;\r
176	}\r
177	\r
178	/**\r
179	Publishes an interface that allows PEIMs to report status codes.\r
180	\r
181	This function implements EFI_PEI_PROGRESS_CODE_PPI.ReportStatusCode().\r
182	It publishes an interface that allows PEIMs to report status codes.\r
183	\r
184	@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
185	@param CodeType Indicates the type of status code being reported.\r
186	@param Value Describes the current status of a hardware or\r
187	software entity. This includes information about the class and\r
188	subclass that is used to classify the entity as well as an operation.\r
189	For progress codes, the operation is the current activity.\r
190	For error codes, it is the exception.For debug codes,it is not defined at this time.\r
191	@param Instance The enumeration of a hardware or software entity within\r
192	the system. A system may contain multiple entities that match a class/subclass\r
193	pairing. The instance differentiates between them. An instance of 0 indicates\r
194	that instance information is unavailable, not meaningful, or not relevant.\r
195	Valid instance numbers start with 1.\r
196	@param CallerId This optional parameter may be used to identify the caller.\r
197	This parameter allows the status code driver to apply different rules to\r
198	different callers.\r
199	@param Data This optional parameter may be used to pass additional data.\r
200	\r
201	@retval EFI_SUCCESS The function completed successfully.\r
202	\r
203	**/\r
204	EFI_STATUS\r
205	EFIAPI\r
206	ReportDispatcher (\r
207	IN CONST EFI_PEI_SERVICES **PeiServices,\r
208	IN EFI_STATUS_CODE_TYPE CodeType,\r
209	IN EFI_STATUS_CODE_VALUE Value,\r
210	IN UINT32 Instance,\r
211	IN CONST EFI_GUID *CallerId OPTIONAL,\r
212	IN CONST EFI_STATUS_CODE_DATA *Data OPTIONAL\r
213	)\r
214	{\r
215	EFI_PEI_HOB_POINTERS Hob;\r
216	EFI_PEI_RSC_HANDLER_CALLBACK *CallbackEntry;\r
217	UINTN *NumberOfEntries;\r
218	UINTN Index;\r
219	\r
220	Hob.Raw = GetFirstGuidHob (&gStatusCodeCallbackGuid);\r
221	while (Hob.Raw != NULL) {\r
222	NumberOfEntries = GET_GUID_HOB_DATA (Hob);\r
223	CallbackEntry = (EFI_PEI_RSC_HANDLER_CALLBACK *) (NumberOfEntries + 1);\r
224	for (Index = 0; Index < *NumberOfEntries; Index++) {\r
225	CallbackEntry[Index](\r
226	PeiServices,\r
227	CodeType,\r
228	Value,\r
229	Instance,\r
230	CallerId,\r
231	Data\r
232	);\r
233	}\r
234	Hob.Raw = GET_NEXT_HOB (Hob);\r
235	Hob.Raw = GetNextGuidHob (&gStatusCodeCallbackGuid, Hob.Raw);\r
236	}\r
237	\r
238	return EFI_SUCCESS;\r
239	}\r
240	\r
241	/**\r
242	Entry point of Status Code PEIM.\r
243	\r
244	This function is the entry point of this Status Code Router PEIM.\r
245	It produces Report Stataus Code Handler PPI and Status Code PPI.\r
246	\r
247	@param FileHandle Handle of the file being invoked.\r
248	@param PeiServices Describes the list of possible PEI Services.\r
249	\r
250	@retval EFI_SUCESS The entry point of DXE IPL PEIM executes successfully.\r
251	\r
252	**/\r
253	EFI_STATUS\r
254	EFIAPI\r
255	GenericStatusCodePeiEntry (\r
256	IN EFI_PEI_FILE_HANDLE FileHandle,\r
257	IN CONST EFI_PEI_SERVICES **PeiServices\r
258	)\r
259	{\r
260	EFI_STATUS Status;\r
261	\r
262	CreateRscHandlerCallbackPacket ();\r
263	\r
264	Status = PeiServicesInstallPpi (mStatusCodePpiList);\r
265	ASSERT_EFI_ERROR (Status);\r
266	\r
267	return EFI_SUCCESS;\r
268	}\r