]>
Commit | Line | Data |
---|---|---|
3eb9473e | 1 | /*++\r |
2 | \r | |
3 | Copyright (c) 2004 - 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 | |
12 | Module Name:\r | |
13 | \r | |
14 | StatusCode.h\r | |
15 | \r | |
16 | Abstract:\r | |
17 | \r | |
18 | Status code Architectural Protocol as defined in the DXE CIS\r | |
19 | \r | |
20 | This code abstracts Status Code reporting.\r | |
21 | \r | |
22 | The StatusCode () Tiano service is added to the EFI system table and the \r | |
23 | EFI_STATUS_CODE_ARCH_PROTOCOL_GUID protocol is registered with a NULL \r | |
24 | pointer.\r | |
25 | \r | |
26 | No CRC of the EFI system table is required, as it is done in the DXE core.\r | |
27 | \r | |
28 | --*/\r | |
29 | \r | |
30 | #ifndef __STATUS_CODE_RUNTIME_PROTOCOL_H__\r | |
31 | #define __STATUS_CODE_RUNTIME_PROTOCOL_H__\r | |
32 | \r | |
33 | #define EFI_STATUS_CODE_RUNTIME_PROTOCOL_GUID \\r | |
34 | { 0xd2b2b828, 0x826, 0x48a7, 0xb3, 0xdf, 0x98, 0x3c, 0x0, 0x60, 0x24, 0xf0}\r | |
35 | \r | |
36 | #if (EFI_SPECIFICATION_VERSION >= 0x00020000)\r | |
37 | typedef\r | |
38 | EFI_STATUS \r | |
39 | (EFIAPI *EFI_REPORT_STATUS_CODE) (\r | |
40 | IN EFI_STATUS_CODE_TYPE Type,\r | |
41 | IN EFI_STATUS_CODE_VALUE Value,\r | |
42 | IN UINT32 Instance,\r | |
43 | IN EFI_GUID *CallerId OPTIONAL,\r | |
44 | IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r | |
45 | )\r | |
46 | /*++\r | |
47 | Routine Description: \r | |
48 | \r | |
49 | Provides an interface that a software module can call to report a status code.\r | |
50 | \r | |
51 | Arguments:\r | |
52 | \r | |
53 | Type - Indicates the type of status code being reported.\r | |
54 | \r | |
55 | Value - Describes the current status of a hardware or software entity.\r | |
56 | This included information about the class and subclass that is \r | |
57 | used to classify the entity as well as an operation.\r | |
58 | \r | |
59 | Instance - The enumeration of a hardware or software entity within \r | |
60 | the system. Valid instance numbers start with 1.\r | |
61 | \r | |
62 | CallerId - This optional parameter may be used to identify the caller.\r | |
63 | This parameter allows the status code driver to apply different \r | |
64 | rules to different callers.\r | |
65 | \r | |
66 | Data - This optional parameter may be used to pass additional data.\r | |
67 | \r | |
68 | Returns: \r | |
69 | \r | |
70 | EFI_SUCCESS - The function completed successfully\r | |
71 | \r | |
72 | EFI_DEVICE_ERROR - The function should not be completed due to a device error.\r | |
73 | \r | |
74 | --*/\r | |
75 | ;\r | |
76 | #endif\r | |
77 | \r | |
78 | //\r | |
79 | // Interface stucture for the STATUS CODE Architectural Protocol\r | |
80 | //\r | |
81 | typedef struct _EFI_STATUS_CODE_PROTOCOL {\r | |
82 | EFI_REPORT_STATUS_CODE ReportStatusCode;\r | |
83 | } EFI_STATUS_CODE_PROTOCOL;\r | |
84 | \r | |
85 | /*++\r | |
86 | // Protocol Description:\r | |
87 | //\r | |
88 | // Provides the service required to report a status code to the platform firmware.\r | |
89 | // This protocol must be produced by a runtime DXE driver and may be consumed \r | |
90 | // only by the DXE Foundation.\r | |
91 | //\r | |
92 | // Parameter:\r | |
93 | //\r | |
94 | // ReportStatusCode - Emit a status code.\r | |
95 | --*/\r | |
96 | \r | |
97 | \r | |
98 | extern EFI_GUID gEfiStatusCodeRuntimeProtocolGuid;\r | |
99 | \r | |
100 | #endif\r |