[mirror_edk2.git] / EdkModulePkg / Universal / StatusCode / Pei / PeiStatusCode.h

\r
/** @file\r
  Heade file of status code PEIM\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:  PeiStatusCode.h\r
\r
**/\r
\r
#ifndef __PEI_STATUS_CODE_H__\r
#define __PEI_STATUS_CODE_H__\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
  @return               The function always return EFI_SUCCESS.\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
/**\r
  Initialize memory status code.\r
  Create one GUID'ed HOB with PCD defined size. If create required size \r
  GUID'ed HOB failed, then ASSERT().\r
 \r
  @return           The function always return EFI_SUCCESS\r
\r
**/\r
EFI_STATUS\r
MemoryStatusCodeInitializeWorker (\r
  VOID\r
  );\r
\r
/**\r
  Report status code into GUID'ed HOB.\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
MemoryStatusCodeReportWorker (\r
  IN EFI_STATUS_CODE_TYPE     CodeType,\r
  IN EFI_STATUS_CODE_VALUE    Value,\r
  IN UINT32                   Instance\r
  );\r
\r
/**\r
  Report status code to all supported device.\r
  \r
  \r
  @param  PeiServices\r
\r
  @param  Type          Indicates the type of status code being reported.  \r
                        The type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
  @param  Value         Describes the current status of a hardware or software entity.  \r
                        This includes 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
  @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 \r
                        information is unavailable, not meaningful, or not relevant.  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 different callers.\r
  @param  Data          This optional parameter may be used to pass additional data.  \r
                        Type EFI_STATUS_CODE_DATA is defined in "Related Definitions" below.  \r
                        The contents of this data type may have additional GUID-specific data.  The standard GUIDs and \r
                        their associated data structures are defined in the Intel? Platform Innovation Framework for EFI Status Codes Specification.\r
\r
  @return               Always return EFI_SUCCESS.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
ReportDispatcher (\r
  IN EFI_PEI_SERVICES         **PeiServices,\r
  IN EFI_STATUS_CODE_TYPE     Type,\r
  IN EFI_STATUS_CODE_VALUE    Value,\r
  IN UINT32                   Instance,\r
  IN EFI_GUID                 *CallerId OPTIONAL,\r
  IN EFI_STATUS_CODE_DATA     *Data OPTIONAL\r
  );\r
\r
#endif\r
Commit	Line	Data
56836fe9	1	\r
	2	/** @file\r
	3	Heade file of status code PEIM\r
	4	\r
161c26a7	5	Copyright (c) 2006, Intel Corporation \r
	6	All rights reserved. This program and the accompanying materials \r
	7	are licensed and made available under the terms and conditions of the BSD License \r
	8	which accompanies this distribution. The full text of the license may be found at \r
	9	http://opensource.org/licenses/bsd-license.php \r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
56836fe9	13	\r
	14	Module Name: PeiStatusCode.h\r
	15	\r
	16	**/\r
	17	\r
	18	#ifndef __PEI_STATUS_CODE_H__\r
	19	#define __PEI_STATUS_CODE_H__\r
	20	\r
	21	\r
	22	/**\r
	23	Convert status code value and extended data to readable ASCII string, send string to serial I/O device.\r
	24	\r
511710d6	25	@param CodeType Indicates the type of status code being reported. Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
56836fe9	26	\r
	27	@param Value Describes the current status of a hardware or software entity. \r
	28	This included information about the class and subclass that is used to classify the entity \r
	29	as well as an operation. For progress codes, the operation is the current activity. \r
	30	For error codes, it is the exception. For debug codes, it is not defined at this time. \r
511710d6	31	Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. \r
56836fe9	32	Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r
	33	\r
	34	@param Instance The enumeration of a hardware or software entity within the system. \r
	35	A system may contain multiple entities that match a class/subclass pairing. \r
	36	The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, \r
	37	not meaningful, or not relevant. Valid instance numbers start with 1.\r
	38	\r
	39	\r
	40	@param CallerId This optional parameter may be used to identify the caller. \r
	41	This parameter allows the status code driver to apply different rules to different callers. \r
	42	Type EFI_GUID is defined in InstallProtocolInterface() in the EFI 1.10 Specification.\r
	43	\r
	44	\r
	45	@param Data This optional parameter may be used to pass additional data\r
	46	\r
	47	@return The function always return EFI_SUCCESS.\r
	48	\r
	49	**/\r
	50	EFI_STATUS\r
	51	SerialStatusCodeReportWorker (\r
	52	IN EFI_STATUS_CODE_TYPE CodeType,\r
	53	IN EFI_STATUS_CODE_VALUE Value,\r
	54	IN UINT32 Instance,\r
	55	IN EFI_GUID *CallerId,\r
	56	IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r
	57	);\r
	58	\r
	59	\r
	60	/**\r
	61	Initialize memory status code.\r
	62	Create one GUID'ed HOB with PCD defined size. If create required size \r
	63	GUID'ed HOB failed, then ASSERT().\r
	64	\r
	65	@return The function always return EFI_SUCCESS\r
	66	\r
	67	**/\r
	68	EFI_STATUS\r
	69	MemoryStatusCodeInitializeWorker (\r
	70	VOID\r
	71	);\r
	72	\r
	73	/**\r
	74	Report status code into GUID'ed HOB.\r
	75	\r
511710d6	76	@param CodeType Indicates the type of status code being reported. Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
56836fe9	77	\r
	78	@param Value Describes the current status of a hardware or software entity. \r
	79	This included information about the class and subclass that is used to classify the entity \r
	80	as well as an operation. For progress codes, the operation is the current activity. \r
	81	For error codes, it is the exception. For debug codes, it is not defined at this time. \r
511710d6	82	Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. \r
56836fe9	83	Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r
	84	\r
	85	@param Instance The enumeration of a hardware or software entity within the system. \r
	86	A system may contain multiple entities that match a class/subclass pairing. \r
	87	The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, \r
	88	not meaningful, or not relevant. Valid instance numbers start with 1.\r
	89	\r
	90	@return The function always return EFI_SUCCESS.\r
	91	\r
	92	**/\r
	93	EFI_STATUS\r
	94	MemoryStatusCodeReportWorker (\r
	95	IN EFI_STATUS_CODE_TYPE CodeType,\r
	96	IN EFI_STATUS_CODE_VALUE Value,\r
	97	IN UINT32 Instance\r
	98	);\r
	99	\r
92dda53e	100	/**\r
	101	Report status code to all supported device.\r
	102	\r
	103	\r
	104	@param PeiServices\r
	105	\r
	106	@param Type Indicates the type of status code being reported. \r
	107	The type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
	108	@param Value Describes the current status of a hardware or software entity. \r
	109	This includes information about the class and subclass that is used to classify the entity \r
	110	as well as an operation. For progress codes, the operation is the current activity. \r
	111	For error codes, it is the exception. For debug codes, it is not defined at this time. \r
	112	Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. \r
	113	Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r
	114	@param Instance The enumeration of a hardware or software entity within the system. \r
	115	A system may contain multiple entities that match a class/subclass pairing. \r
	116	The instance differentiates between them. An instance of 0 indicates that instance \r
	117	information is unavailable, not meaningful, or not relevant. Valid instance numbers start with 1.\r
	118	@param CallerId This optional parameter may be used to identify the caller. \r
	119	This parameter allows the status code driver to apply different rules to different callers.\r
	120	@param Data This optional parameter may be used to pass additional data. \r
	121	Type EFI_STATUS_CODE_DATA is defined in "Related Definitions" below. \r
	122	The contents of this data type may have additional GUID-specific data. The standard GUIDs and \r
	123	their associated data structures are defined in the Intel? Platform Innovation Framework for EFI Status Codes Specification.\r
	124	\r
	125	@return Always return EFI_SUCCESS.\r
	126	\r
	127	**/\r
	128	EFI_STATUS\r
	129	EFIAPI\r
	130	ReportDispatcher (\r
	131	IN EFI_PEI_SERVICES **PeiServices,\r
	132	IN EFI_STATUS_CODE_TYPE Type,\r
	133	IN EFI_STATUS_CODE_VALUE Value,\r
	134	IN UINT32 Instance,\r
	135	IN EFI_GUID *CallerId OPTIONAL,\r
	136	IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r
	137	);\r
	138	\r
56836fe9	139	#endif\r