[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / StatusCode / Dxe / DxeStatusCode.h

/*++\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
--*/\r
\r
#ifndef __DXE_STATUS_CODE_H__\r
#define __DXE_STATUS_CODE_H__\r
\r
//\r
// The package level header files this module uses\r
//\r
#include <FrameworkDxe.h>\r
//\r
// The protocols, PPI and GUID defintions for this module\r
//\r
#include <Guid/StatusCode.h>\r
#include <Protocol/DataHub.h>\r
#include <Protocol/SerialIo.h>\r
#include <Guid/MemoryStatusCodeRecord.h>\r
#include <Protocol/StatusCode.h>\r
#include <Guid/StatusCodeDataTypeId.h>\r
//\r
// The Library classes this module consumes\r
//\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiRuntimeLib.h>\r
#include <Library/SerialPortLib.h>\r
#include <Library/OemHookStatusCodeLib.h>\r
\r
//\r
// Data hub worker definition \r
//\r
#define MAX_NUMBER_DATAHUB_RECORDS                1000\r
#define DATAHUB_BYTES_PER_RECORD                  EFI_STATUS_CODE_DATA_MAX_SIZE\r
#define EMPTY_RECORD_TAG                          0xFF\r
#define DATAHUB_STATUS_CODE_SIGNATURE             EFI_SIGNATURE_32 ('B', 'D', 'H', 'S')\r
\r
//\r
// Address type of pointer.\r
// The point type always equal to PHYSICAL_MODE on IA32/X64/EBC architecture\r
// Otherwise, VIRTUAL_MODE/PHYSICAL_MODE would be used on Ipf architecture, \r
// \r
typedef enum {\r
  PHYSICAL_MODE,\r
  VIRTUAL_MODE\r
} PROCESSOR_MODE;\r
\r
typedef struct {\r
  UINTN       Signature;\r
  LIST_ENTRY  Node;\r
\r
  UINT8       Data[sizeof (DATA_HUB_STATUS_CODE_DATA_RECORD) + EFI_STATUS_CODE_DATA_MAX_SIZE];\r
} DATAHUB_STATUSCODE_RECORD;\r
\r
\r
//\r
// Runtime memory status code worker definition \r
// \r
typedef struct {\r
  UINT32   RecordIndex;\r
  UINT32   NumberOfRecords;\r
  UINT32   MaxRecordsNumber;\r
} RUNTIME_MEMORY_STATUSCODE_HEADER;\r
\r
\r
typedef struct {\r
  //\r
  // Report operation nest status. \r
  // If it is set, then the report operation has nested.\r
  // \r
  UINT32                            StatusCodeNestStatus;\r
  //\r
  // Runtime status code management header, the records buffer is following it.\r
  // \r
  RUNTIME_MEMORY_STATUSCODE_HEADER  *RtMemoryStatusCodeTable[2];\r
} DXE_STATUS_CODE_CONTROLLER;\r
\r
\r
/**\r
  \r
  Dispatch initialization request to sub status code devices based on \r
  customized feature flags.\r
 \r
**/\r
VOID\r
InitializationDispatcherWorker (\r
  VOID\r
  );\r
\r
\r
/**\r
  Initialize serial status code worker.\r
 \r
  @return  The function always return EFI_SUCCESS\r
\r
**/\r
EFI_STATUS\r
EfiSerialStatusCodeInitializeWorker (\r
  VOID\r
  );\r
\r
\r
/**\r
  Convert status code value and extended data to readable ASCII string, send string to serial I/O device.\r
 \r
  @param  CodeType      Indicates the type of status code being reported.  Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
 \r
  @param  Value         Describes the current status of a hardware or software entity.  \r
                        This included information about the class and subclass that is used to classify the entity \r
                        as well as an operation.  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
                        Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.  \r
                        Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r
 \r
  @param  Instance      The enumeration of a hardware or software entity within the system.  \r
                        A system may contain multiple entities that match a class/subclass pairing. \r
                        The instance differentiates between them.  An instance of 0 indicates that instance information is unavailable, \r
                        not meaningful, or not relevant.  Valid instance numbers start with 1.\r
\r
\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 different callers. \r
                        Type EFI_GUID is defined in InstallProtocolInterface() in the EFI 1.10 Specification.\r
\r
\r
  @param  Data          This optional parameter may be used to pass additional data\r
 \r
  @retval EFI_SUCCESS         Success to report status code to serial I/O.\r
  @retval EFI_DEVICE_ERROR    EFI serial device can not work after ExitBootService() is called .\r
\r
**/\r
EFI_STATUS\r
SerialStatusCodeReportWorker (\r
  IN EFI_STATUS_CODE_TYPE     CodeType,\r
  IN EFI_STATUS_CODE_VALUE    Value,\r
  IN UINT32                   Instance,\r
  IN EFI_GUID                 *CallerId,\r
  IN EFI_STATUS_CODE_DATA     *Data OPTIONAL\r
  );\r
\r
/**\r
  Initialize runtime memory status code.\r
 \r
  @return  The function always return EFI_SUCCESS\r
\r
**/\r
EFI_STATUS\r
RtMemoryStatusCodeInitializeWorker (\r
  VOID\r
  );\r
\r
/**\r
  Report status code into runtime memory. If the runtime pool is full, roll back to the \r
  first record and overwrite it.\r
 \r
  @param  RtMemoryStatusCodeTable      \r
                        Point to Runtime memory table header.\r
\r
  @param  CodeType      Indicates the type of status code being reported.  Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
 \r
  @param  Value         Describes the current status of a hardware or software entity.  \r
                        This included information about the class and subclass that is used to classify the entity \r
                        as well as an operation.  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
                        Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.  \r
                        Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r
 \r
  @param  Instance      The enumeration of a hardware or software entity within the system.  \r
                        A system may contain multiple entities that match a class/subclass pairing. \r
                        The instance differentiates between them.  An instance of 0 indicates that instance information is unavailable, \r
                        not meaningful, or not relevant.  Valid instance numbers start with 1.\r
 \r
  @return               The function always return EFI_SUCCESS.\r
\r
**/\r
EFI_STATUS\r
RtMemoryStatusCodeReportWorker (\r
  RUNTIME_MEMORY_STATUSCODE_HEADER      *RtMemoryStatusCodeTable,\r
  IN EFI_STATUS_CODE_TYPE               CodeType,\r
  IN EFI_STATUS_CODE_VALUE              Value,\r
  IN UINT32                             Instance\r
  );\r
\r
/**\r
  Initialize data hubstatus code.\r
  Create a data hub listener.\r
 \r
  @return  The function always return EFI_SUCCESS\r
\r
**/\r
EFI_STATUS\r
DataHubStatusCodeInitializeWorker (\r
  VOID\r
  );\r
\r
\r
/**\r
  Report status code into DataHub.\r
 \r
  @param  CodeType      Indicates the type of status code being reported.  Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
 \r
  @param  Value         Describes the current status of a hardware or software entity.  \r
                        This included information about the class and subclass that is used to classify the entity \r
                        as well as an operation.  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
                        Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.  \r
                        Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r
 \r
  @param  Instance      The enumeration of a hardware or software entity within the system.  \r
                        A system may contain multiple entities that match a class/subclass pairing. \r
                        The instance differentiates between them.  An instance of 0 indicates that instance information is unavailable, \r
                        not meaningful, or not relevant.  Valid instance numbers start with 1.\r
\r
\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 different callers. \r
                        Type EFI_GUID is defined in InstallProtocolInterface() in the EFI 1.10 Specification.\r
\r
\r
  @param  Data          This optional parameter may be used to pass additional data\r
 \r
  @retval EFI_OUT_OF_RESOURCES   Can not acquire record buffer.\r
  @retval EFI_DEVICE_ERROR       EFI serial device can not work after ExitBootService() is called .\r
  @retval EFI_SUCCESS            Success to cache status code and signal log data event.\r
\r
**/\r
EFI_STATUS\r
DataHubStatusCodeReportWorker (\r
  IN EFI_STATUS_CODE_TYPE     CodeType,\r
  IN EFI_STATUS_CODE_VALUE    Value,\r
  IN UINT32                   Instance,\r
  IN EFI_GUID                 *CallerId,\r
  IN EFI_STATUS_CODE_DATA     *Data OPTIONAL\r
  );\r
\r
\r
//\r
// Declaration for callback Event.\r
//\r
VOID\r
EFIAPI\r
VirtualAddressChangeCallBack (\r
  IN EFI_EVENT  Event,\r
  IN VOID       *Context\r
  );\r
\r
//\r
// Declaration for original Entry Point.\r
//\r
EFI_STATUS\r
EFIAPI\r
DxeStatusCodeDriverEntry (\r
  IN EFI_HANDLE           ImageHandle,\r
  IN EFI_SYSTEM_TABLE     *SystemTable\r
  );\r
\r
//\r
// declaration of DXE status code controller.\r
// \r
extern DXE_STATUS_CODE_CONTROLLER gDxeStatusCode;\r
\r
#endif\r
Commit	Line	Data
ad1a1798	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
ad1a1798	12	--*/\r
	13	\r
	14	#ifndef __DXE_STATUS_CODE_H__\r
	15	#define __DXE_STATUS_CODE_H__\r
	16	\r
	17	//\r
6f2b45bb	18	// The package level header files this module uses\r
ad1a1798	19	//\r
6f2b45bb	20	#include <FrameworkDxe.h>\r
	21	//\r
	22	// The protocols, PPI and GUID defintions for this module\r
	23	//\r
	24	#include <Guid/StatusCode.h>\r
	25	#include <Protocol/DataHub.h>\r
	26	#include <Protocol/SerialIo.h>\r
	27	#include <Guid/MemoryStatusCodeRecord.h>\r
	28	#include <Protocol/StatusCode.h>\r
	29	#include <Guid/StatusCodeDataTypeId.h>\r
	30	//\r
	31	// The Library classes this module consumes\r
	32	//\r
	33	#include <Library/BaseLib.h>\r
	34	#include <Library/BaseMemoryLib.h>\r
	35	#include <Library/DebugLib.h>\r
	36	#include <Library/ReportStatusCodeLib.h>\r
	37	#include <Library/PrintLib.h>\r
	38	#include <Library/PcdLib.h>\r
	39	#include <Library/HobLib.h>\r
	40	#include <Library/UefiDriverEntryPoint.h>\r
	41	#include <Library/UefiBootServicesTableLib.h>\r
	42	#include <Library/UefiLib.h>\r
	43	#include <Library/MemoryAllocationLib.h>\r
	44	#include <Library/UefiRuntimeLib.h>\r
	45	#include <Library/SerialPortLib.h>\r
	46	#include <Library/OemHookStatusCodeLib.h>\r
ad1a1798	47	\r
	48	//\r
	49	// Data hub worker definition \r
	50	//\r
	51	#define MAX_NUMBER_DATAHUB_RECORDS 1000\r
	52	#define DATAHUB_BYTES_PER_RECORD EFI_STATUS_CODE_DATA_MAX_SIZE\r
	53	#define EMPTY_RECORD_TAG 0xFF\r
	54	#define DATAHUB_STATUS_CODE_SIGNATURE EFI_SIGNATURE_32 ('B', 'D', 'H', 'S')\r
	55	\r
	56	//\r
	57	// Address type of pointer.\r
	58	// The point type always equal to PHYSICAL_MODE on IA32/X64/EBC architecture\r
	59	// Otherwise, VIRTUAL_MODE/PHYSICAL_MODE would be used on Ipf architecture, \r
	60	// \r
	61	typedef enum {\r
	62	PHYSICAL_MODE,\r
	63	VIRTUAL_MODE\r
	64	} PROCESSOR_MODE;\r
	65	\r
	66	typedef struct {\r
6f2b45bb	67	UINTN Signature;\r
	68	LIST_ENTRY Node;\r
	69	\r
	70	UINT8 Data[sizeof (DATA_HUB_STATUS_CODE_DATA_RECORD) + EFI_STATUS_CODE_DATA_MAX_SIZE];\r
ad1a1798	71	} DATAHUB_STATUSCODE_RECORD;\r
	72	\r
	73	\r
	74	//\r
	75	// Runtime memory status code worker definition \r
	76	// \r
	77	typedef struct {\r
	78	UINT32 RecordIndex;\r
	79	UINT32 NumberOfRecords;\r
	80	UINT32 MaxRecordsNumber;\r
	81	} RUNTIME_MEMORY_STATUSCODE_HEADER;\r
	82	\r
	83	\r
	84	typedef struct {\r
	85	//\r
	86	// Report operation nest status. \r
	87	// If it is set, then the report operation has nested.\r
	88	// \r
	89	UINT32 StatusCodeNestStatus;\r
	90	//\r
	91	// Runtime status code management header, the records buffer is following it.\r
	92	// \r
	93	RUNTIME_MEMORY_STATUSCODE_HEADER *RtMemoryStatusCodeTable[2];\r
	94	} DXE_STATUS_CODE_CONTROLLER;\r
	95	\r
	96	\r
	97	/**\r
	98	\r
	99	Dispatch initialization request to sub status code devices based on \r
	100	customized feature flags.\r
	101	\r
	102	**/\r
	103	VOID\r
	104	InitializationDispatcherWorker (\r
	105	VOID\r
	106	);\r
	107	\r
	108	\r
	109	/**\r
	110	Initialize serial status code worker.\r
	111	\r
	112	@return The function always return EFI_SUCCESS\r
	113	\r
	114	**/\r
	115	EFI_STATUS\r
	116	EfiSerialStatusCodeInitializeWorker (\r
	117	VOID\r
	118	);\r
	119	\r
	120	\r
	121	/**\r
	122	Convert status code value and extended data to readable ASCII string, send string to serial I/O device.\r
	123	\r
	124	@param CodeType Indicates the type of status code being reported. Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
	125	\r
	126	@param Value Describes the current status of a hardware or software entity. \r
	127	This included information about the class and subclass that is used to classify the entity \r
	128	as well as an operation. For progress codes, the operation is the current activity. \r
	129	For error codes, it is the exception. For debug codes, it is not defined at this time. \r
	130	Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. \r
	131	Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r
	132	\r
	133	@param Instance The enumeration of a hardware or software entity within the system. \r
	134	A system may contain multiple entities that match a class/subclass pairing. \r
135	The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, \r
136	not meaningful, or not relevant. Valid instance numbers start with 1.\r
137	\r
138	\r
139	@param CallerId This optional parameter may be used to identify the caller. \r
140	This parameter allows the status code driver to apply different rules to different callers. \r
141	Type EFI_GUID is defined in InstallProtocolInterface() in the EFI 1.10 Specification.\r
142	\r
143	\r
144	@param Data This optional parameter may be used to pass additional data\r
145	\r
146	@retval EFI_SUCCESS Success to report status code to serial I/O.\r
147	@retval EFI_DEVICE_ERROR EFI serial device can not work after ExitBootService() is called .\r
148	\r
149	**/\r
150	EFI_STATUS\r
151	SerialStatusCodeReportWorker (\r
152	IN EFI_STATUS_CODE_TYPE CodeType,\r
153	IN EFI_STATUS_CODE_VALUE Value,\r
154	IN UINT32 Instance,\r
155	IN EFI_GUID *CallerId,\r
156	IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r
157	);\r
158	\r
159	/**\r
160	Initialize runtime memory status code.\r
161	\r
162	@return The function always return EFI_SUCCESS\r
163	\r
164	**/\r
165	EFI_STATUS\r
166	RtMemoryStatusCodeInitializeWorker (\r
167	VOID\r
168	);\r
169	\r
170	/**\r
171	Report status code into runtime memory. If the runtime pool is full, roll back to the \r
172	first record and overwrite it.\r
173	\r
174	@param RtMemoryStatusCodeTable \r
175	Point to Runtime memory table header.\r
176	\r
177	@param CodeType Indicates the type of status code being reported. Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
178	\r
179	@param Value Describes the current status of a hardware or software entity. \r
180	This included information about the class and subclass that is used to classify the entity \r
181	as well as an operation. For progress codes, the operation is the current activity. \r
182	For error codes, it is the exception. For debug codes, it is not defined at this time. \r
183	Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. \r
184	Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r
185	\r
186	@param Instance The enumeration of a hardware or software entity within the system. \r
187	A system may contain multiple entities that match a class/subclass pairing. \r
188	The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, \r
189	not meaningful, or not relevant. Valid instance numbers start with 1.\r
190	\r
191	@return The function always return EFI_SUCCESS.\r
192	\r
193	**/\r
194	EFI_STATUS\r
195	RtMemoryStatusCodeReportWorker (\r
196	RUNTIME_MEMORY_STATUSCODE_HEADER *RtMemoryStatusCodeTable,\r
197	IN EFI_STATUS_CODE_TYPE CodeType,\r
198	IN EFI_STATUS_CODE_VALUE Value,\r
199	IN UINT32 Instance\r
200	);\r
201	\r
202	/**\r
203	Initialize data hubstatus code.\r
204	Create a data hub listener.\r
205	\r
206	@return The function always return EFI_SUCCESS\r
207	\r
208	**/\r
209	EFI_STATUS\r
210	DataHubStatusCodeInitializeWorker (\r
211	VOID\r
212	);\r
213	\r
214	\r
215	/**\r
216	Report status code into DataHub.\r
217	\r
218	@param CodeType Indicates the type of status code being reported. Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
219	\r
220	@param Value Describes the current status of a hardware or software entity. \r
221	This included information about the class and subclass that is used to classify the entity \r
222	as well as an operation. For progress codes, the operation is the current activity. \r
223	For error codes, it is the exception. For debug codes, it is not defined at this time. \r
224	Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. \r
225	Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r
226	\r
227	@param Instance The enumeration of a hardware or software entity within the system. \r
228	A system may contain multiple entities that match a class/subclass pairing. \r
229	The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, \r
230	not meaningful, or not relevant. Valid instance numbers start with 1.\r
231	\r
232	\r
233	@param CallerId This optional parameter may be used to identify the caller. \r
234	This parameter allows the status code driver to apply different rules to different callers. \r
235	Type EFI_GUID is defined in InstallProtocolInterface() in the EFI 1.10 Specification.\r
236	\r
237	\r
238	@param Data This optional parameter may be used to pass additional data\r
239	\r
240	@retval EFI_OUT_OF_RESOURCES Can not acquire record buffer.\r
241	@retval EFI_DEVICE_ERROR EFI serial device can not work after ExitBootService() is called .\r
242	@retval EFI_SUCCESS Success to cache status code and signal log data event.\r
243	\r
244	**/\r
245	EFI_STATUS\r
246	DataHubStatusCodeReportWorker (\r
247	IN EFI_STATUS_CODE_TYPE CodeType,\r
248	IN EFI_STATUS_CODE_VALUE Value,\r
249	IN UINT32 Instance,\r
250	IN EFI_GUID *CallerId,\r
251	IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r
252	);\r
253	\r
6f2b45bb	254	\r
	255	//\r
	256	// Declaration for callback Event.\r
	257	//\r
	258	VOID\r
	259	EFIAPI\r
	260	VirtualAddressChangeCallBack (\r
	261	IN EFI_EVENT Event,\r
	262	IN VOID *Context\r
	263	);\r
	264	\r
	265	//\r
	266	// Declaration for original Entry Point.\r
	267	//\r
	268	EFI_STATUS\r
	269	EFIAPI\r
	270	DxeStatusCodeDriverEntry (\r
	271	IN EFI_HANDLE ImageHandle,\r
	272	IN EFI_SYSTEM_TABLE *SystemTable\r
	273	);\r
	274	\r
ad1a1798	275	//\r
	276	// declaration of DXE status code controller.\r
	277	// \r
	278	extern DXE_STATUS_CODE_CONTROLLER gDxeStatusCode;\r
	279	\r
	280	#endif\r