]>
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 | |
100 | #endif\r |