]>
Commit | Line | Data |
---|---|---|
ad1a1798 | 1 | \r |
2 | /** @file\r | |
3 | Heade file of status code PEIM\r | |
4 | \r | |
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 | |
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 | // Include common header file for this module.\r | |
24 | //\r | |
25 | #include "CommonHeader.h"\r | |
26 | \r | |
27 | /**\r | |
28 | Convert status code value and extended data to readable ASCII string, send string to serial I/O device.\r | |
29 | \r | |
30 | @param CodeType Indicates the type of status code being reported. Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r | |
31 | \r | |
32 | @param Value Describes the current status of a hardware or software entity. \r | |
33 | This included information about the class and subclass that is used to classify the entity \r | |
34 | as well as an operation. For progress codes, the operation is the current activity. \r | |
35 | For error codes, it is the exception. For debug codes, it is not defined at this time. \r | |
36 | Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. \r | |
37 | Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r | |
38 | \r | |
39 | @param Instance The enumeration of a hardware or software entity within the system. \r | |
40 | A system may contain multiple entities that match a class/subclass pairing. \r | |
41 | The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, \r | |
42 | not meaningful, or not relevant. Valid instance numbers start with 1.\r | |
43 | \r | |
44 | \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 different callers. \r | |
47 | Type EFI_GUID is defined in InstallProtocolInterface() in the EFI 1.10 Specification.\r | |
48 | \r | |
49 | \r | |
50 | @param Data This optional parameter may be used to pass additional data\r | |
51 | \r | |
52 | @return The function always return EFI_SUCCESS.\r | |
53 | \r | |
54 | **/\r | |
55 | EFI_STATUS\r | |
56 | SerialStatusCodeReportWorker (\r | |
57 | IN EFI_STATUS_CODE_TYPE CodeType,\r | |
58 | IN EFI_STATUS_CODE_VALUE Value,\r | |
59 | IN UINT32 Instance,\r | |
60 | IN EFI_GUID *CallerId,\r | |
61 | IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r | |
62 | );\r | |
63 | \r | |
64 | \r | |
65 | /**\r | |
66 | Initialize memory status code.\r | |
67 | Create one GUID'ed HOB with PCD defined size. If create required size \r | |
68 | GUID'ed HOB failed, then ASSERT().\r | |
69 | \r | |
70 | @return The function always return EFI_SUCCESS\r | |
71 | \r | |
72 | **/\r | |
73 | EFI_STATUS\r | |
74 | MemoryStatusCodeInitializeWorker (\r | |
75 | VOID\r | |
76 | );\r | |
77 | \r | |
78 | /**\r | |
79 | Report status code into GUID'ed HOB.\r | |
80 | \r | |
81 | @param CodeType Indicates the type of status code being reported. Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r | |
82 | \r | |
83 | @param Value Describes the current status of a hardware or software entity. \r | |
84 | This included information about the class and subclass that is used to classify the entity \r | |
85 | as well as an operation. For progress codes, the operation is the current activity. \r | |
86 | For error codes, it is the exception. For debug codes, it is not defined at this time. \r | |
87 | Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. \r | |
88 | Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r | |
89 | \r | |
90 | @param Instance The enumeration of a hardware or software entity within the system. \r | |
91 | A system may contain multiple entities that match a class/subclass pairing. \r | |
92 | The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, \r | |
93 | not meaningful, or not relevant. Valid instance numbers start with 1.\r | |
94 | \r | |
95 | @return The function always return EFI_SUCCESS.\r | |
96 | \r | |
97 | **/\r | |
98 | EFI_STATUS\r | |
99 | MemoryStatusCodeReportWorker (\r | |
100 | IN EFI_STATUS_CODE_TYPE CodeType,\r | |
101 | IN EFI_STATUS_CODE_VALUE Value,\r | |
102 | IN UINT32 Instance\r | |
103 | );\r | |
104 | \r | |
105 | /**\r | |
106 | Report status code to all supported device.\r | |
107 | \r | |
108 | \r | |
109 | @param PeiServices\r | |
110 | \r | |
111 | @param Type Indicates the type of status code being reported. \r | |
112 | The type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r | |
113 | @param Value Describes the current status of a hardware or software entity. \r | |
114 | This includes information about the class and subclass that is used to classify the entity \r | |
115 | as well as an operation. For progress codes, the operation is the current activity. \r | |
116 | For error codes, it is the exception. For debug codes, it is not defined at this time. \r | |
117 | Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. \r | |
118 | Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r | |
119 | @param Instance The enumeration of a hardware or software entity within the system. \r | |
120 | A system may contain multiple entities that match a class/subclass pairing. \r | |
121 | The instance differentiates between them. An instance of 0 indicates that instance \r | |
122 | information is unavailable, not meaningful, or not relevant. Valid instance numbers start with 1.\r | |
123 | @param CallerId This optional parameter may be used to identify the caller. \r | |
124 | This parameter allows the status code driver to apply different rules to different callers.\r | |
125 | @param Data This optional parameter may be used to pass additional data. \r | |
126 | Type EFI_STATUS_CODE_DATA is defined in "Related Definitions" below. \r | |
127 | The contents of this data type may have additional GUID-specific data. The standard GUIDs and \r | |
128 | their associated data structures are defined in the Intel? Platform Innovation Framework for EFI Status Codes Specification.\r | |
129 | \r | |
130 | @return Always return EFI_SUCCESS.\r | |
131 | \r | |
132 | **/\r | |
133 | EFI_STATUS\r | |
134 | EFIAPI\r | |
135 | ReportDispatcher (\r | |
136 | IN EFI_PEI_SERVICES **PeiServices,\r | |
137 | IN EFI_STATUS_CODE_TYPE Type,\r | |
138 | IN EFI_STATUS_CODE_VALUE Value,\r | |
139 | IN UINT32 Instance,\r | |
140 | IN EFI_GUID *CallerId OPTIONAL,\r | |
141 | IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r | |
142 | );\r | |
143 | \r | |
144 | #endif\r |