[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / StatusCode / Pei / StatusCodePei.h

/** @file\r
  Internal include file for Status Code PEIM.\r
\r
  Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __PEI_STATUS_CODE_H__\r
#define __PEI_STATUS_CODE_H__\r
\r
#include <FrameworkPei.h>\r
\r
#include <Guid/MemoryStatusCodeRecord.h>\r
#include <Guid/StatusCodeDataTypeId.h>\r
#include <Guid/StatusCodeDataTypeDebug.h>\r
#include <Ppi/StatusCode.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
#include <Library/SerialPortLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/PeiServicesLib.h>\r
#include <Library/OemHookStatusCodeLib.h>\r
#include <Library/PeimEntryPoint.h>\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.\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      Status code reported to serial I/O successfully.\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 CONST EFI_GUID                 *CallerId,\r
  IN CONST EFI_STATUS_CODE_DATA     *Data OPTIONAL\r
  );\r
\r
\r
/**\r
  Create the first memory status code GUID'ed HOB as initialization for memory status code worker.\r
\r
  @retval EFI_SUCCESS  The GUID'ed HOB is created successfully.\r
\r
**/\r
EFI_STATUS\r
MemoryStatusCodeInitializeWorker (\r
  VOID\r
  );\r
\r
/**\r
  Report status code into GUID'ed HOB.\r
\r
  This function reports status code into GUID'ed HOB. If not all packets are full, then\r
  write status code into available entry. Otherwise, create a new packet for it.\r
\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
\r
  @retval EFI_SUCCESS      The function always return EFI_SUCCESS.\r
\r
**/\r
EFI_STATUS\r
MemoryStatusCodeReportWorker (\r
  IN EFI_STATUS_CODE_TYPE     CodeType,\r
  IN EFI_STATUS_CODE_VALUE    Value,\r
  IN UINT32                   Instance\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
#endif\r
\r
\r
Commit	Line	Data
ad1a1798	1	/** @file\r
d5aea10c	2	Internal include file for Status Code PEIM.\r
ad1a1798	3	\r
180a5a35	4	Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r
c0a00b14	5	SPDX-License-Identifier: BSD-2-Clause-Patent\r
ad1a1798	6	\r
ad1a1798	7	**/\r
	8	\r
	9	#ifndef __PEI_STATUS_CODE_H__\r
	10	#define __PEI_STATUS_CODE_H__\r
	11	\r
ececc2eb	12	#include <FrameworkPei.h>\r
79bc7a89	13	\r
ececc2eb	14	#include <Guid/MemoryStatusCodeRecord.h>\r
ececc2eb	15	#include <Guid/StatusCodeDataTypeId.h>\r
785e0c07	16	#include <Guid/StatusCodeDataTypeDebug.h>\r
ececc2eb	17	#include <Ppi/StatusCode.h>\r
ed7748fe	18	\r
ececc2eb	19	#include <Library/BaseLib.h>\r
	20	#include <Library/BaseMemoryLib.h>\r
	21	#include <Library/DebugLib.h>\r
	22	#include <Library/PrintLib.h>\r
	23	#include <Library/ReportStatusCodeLib.h>\r
	24	#include <Library/SerialPortLib.h>\r
	25	#include <Library/HobLib.h>\r
	26	#include <Library/PcdLib.h>\r
	27	#include <Library/PeiServicesLib.h>\r
	28	#include <Library/OemHookStatusCodeLib.h>\r
	29	#include <Library/PeimEntryPoint.h>\r
ad1a1798	30	\r
	31	/**\r
	32	Convert status code value and extended data to readable ASCII string, send string to serial I/O device.\r
ececc2eb	33	\r
d5aea10c	34	@param CodeType Indicates the type of status code being reported.\r
	35	@param Value Describes the current status of a hardware or\r
	36	software entity. This includes information about the class and\r
	37	subclass that is used to classify the entity as well as an operation.\r
	38	For progress codes, the operation is the current activity.\r
	39	For error codes, it is the exception.For debug codes,it is not defined at this time.\r
	40	@param Instance The enumeration of a hardware or software entity within\r
	41	the system. A system may contain multiple entities that match a class/subclass\r
	42	pairing. The instance differentiates between them. An instance of 0 indicates\r
	43	that instance information is unavailable, not meaningful, or not relevant.\r
	44	Valid instance numbers start with 1.\r
	45	@param CallerId This optional parameter may be used to identify the caller.\r
	46	This parameter allows the status code driver to apply different rules to\r
	47	different callers.\r
	48	@param Data This optional parameter may be used to pass additional data.\r
	49	\r
	50	@retval EFI_SUCCESS Status code reported to serial I/O successfully.\r
ad1a1798	51	\r
	52	**/\r
	53	EFI_STATUS\r
	54	SerialStatusCodeReportWorker (\r
d5aea10c	55	IN EFI_STATUS_CODE_TYPE CodeType,\r
	56	IN EFI_STATUS_CODE_VALUE Value,\r
	57	IN UINT32 Instance,\r
507b36ca	58	IN CONST EFI_GUID *CallerId,\r
507b36ca	59	IN CONST EFI_STATUS_CODE_DATA *Data OPTIONAL\r
ad1a1798	60	);\r
	61	\r
	62	\r
	63	/**\r
d5aea10c	64	Create the first memory status code GUID'ed HOB as initialization for memory status code worker.\r
ececc2eb	65	\r
d5aea10c	66	@retval EFI_SUCCESS The GUID'ed HOB is created successfully.\r
ad1a1798	67	\r
	68	**/\r
	69	EFI_STATUS\r
	70	MemoryStatusCodeInitializeWorker (\r
	71	VOID\r
	72	);\r
	73	\r
	74	/**\r
	75	Report status code into GUID'ed HOB.\r
ececc2eb	76	\r
d5aea10c	77	This function reports status code into GUID'ed HOB. If not all packets are full, then\r
d5aea10c	78	write status code into available entry. Otherwise, create a new packet for it.\r
ececc2eb	79	\r
d5aea10c	80	@param CodeType Indicates the type of status code being reported.\r
	81	@param Value Describes the current status of a hardware or\r
	82	software entity. This includes information about the class and\r
	83	subclass that is used to classify the entity as well as an operation.\r
	84	For progress codes, the operation is the current activity.\r
	85	For error codes, it is the exception.For debug codes,it is not defined at this time.\r
	86	@param Instance The enumeration of a hardware or software entity within\r
	87	the system. A system may contain multiple entities that match a class/subclass\r
	88	pairing. The instance differentiates between them. An instance of 0 indicates\r
	89	that instance information is unavailable, not meaningful, or not relevant.\r
	90	Valid instance numbers start with 1.\r
ececc2eb	91	\r
d5aea10c	92	@retval EFI_SUCCESS The function always return EFI_SUCCESS.\r
ad1a1798	93	\r
	94	**/\r
	95	EFI_STATUS\r
	96	MemoryStatusCodeReportWorker (\r
	97	IN EFI_STATUS_CODE_TYPE CodeType,\r
	98	IN EFI_STATUS_CODE_VALUE Value,\r
	99	IN UINT32 Instance\r
	100	);\r
	101	\r
	102	/**\r
d5aea10c	103	Publishes an interface that allows PEIMs to report status codes.\r
	104	\r
	105	This function implements EFI_PEI_PROGRESS_CODE_PPI.ReportStatusCode().\r
	106	It publishes an interface that allows PEIMs to report status codes.\r
	107	\r
	108	@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
	109	@param CodeType Indicates the type of status code being reported.\r
	110	@param Value Describes the current status of a hardware or\r
	111	software entity. This includes information about the class and\r
	112	subclass that is used to classify the entity as well as an operation.\r
	113	For progress codes, the operation is the current activity.\r
	114	For error codes, it is the exception.For debug codes,it is not defined at this time.\r
	115	@param Instance The enumeration of a hardware or software entity within\r
	116	the system. A system may contain multiple entities that match a class/subclass\r
	117	pairing. The instance differentiates between them. An instance of 0 indicates\r
	118	that instance information is unavailable, not meaningful, or not relevant.\r
	119	Valid instance numbers start with 1.\r
	120	@param CallerId This optional parameter may be used to identify the caller.\r
	121	This parameter allows the status code driver to apply different rules to\r
	122	different callers.\r
	123	@param Data This optional parameter may be used to pass additional data.\r
	124	\r
	125	@retval EFI_SUCCESS The function completed successfully.\r
ad1a1798	126	\r
	127	**/\r
	128	EFI_STATUS\r
	129	EFIAPI\r
	130	ReportDispatcher (\r
507b36ca	131	IN CONST EFI_PEI_SERVICES **PeiServices,\r
d5aea10c	132	IN EFI_STATUS_CODE_TYPE CodeType,\r
	133	IN EFI_STATUS_CODE_VALUE Value,\r
	134	IN UINT32 Instance,\r
507b36ca	135	IN CONST EFI_GUID *CallerId OPTIONAL,\r
507b36ca	136	IN CONST EFI_STATUS_CODE_DATA *Data OPTIONAL\r
ad1a1798	137	);\r
ad1a1798	138	\r
d5aea10c	139	#endif\r
bcd70414	140	\r
bcd70414	141	\r