]>
Commit | Line | Data |
---|---|---|
d1f95000 | 1 | /** @file\r |
2 | Status code Runtime Protocol as defined in the DXE CIS\r | |
3 | \r | |
4 | The StatusCode () Tiano service is added to the EFI system table and the \r | |
5 | EFI_STATUS_CODE_ARCH_PROTOCOL_GUID protocol is registered with a NULL \r | |
6 | pointer.\r | |
7 | \r | |
8 | No CRC of the EFI system table is required, as it is done in the DXE core.\r | |
9 | \r | |
10 | This code abstracts Status Code reporting.\r | |
11 | \r | |
12 | Copyright (c) 2006, Intel Corporation \r | |
13 | All rights reserved. This program and the accompanying materials \r | |
14 | are licensed and made available under the terms and conditions of the BSD License \r | |
15 | which accompanies this distribution. The full text of the license may be found at \r | |
16 | http://opensource.org/licenses/bsd-license.php \r | |
17 | \r | |
18 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
19 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
20 | \r | |
d1f95000 | 21 | @par Revision Reference:\r |
22 | Version 0.91B.\r | |
23 | \r | |
24 | **/\r | |
25 | \r | |
26 | #ifndef __STATUS_CODE_RUNTIME_PROTOCOL_H__\r | |
27 | #define __STATUS_CODE_RUNTIME_PROTOCOL_H__\r | |
28 | \r | |
29 | #define EFI_STATUS_CODE_RUNTIME_PROTOCOL_GUID \\r | |
30 | { 0xd2b2b828, 0x826, 0x48a7, { 0xb3, 0xdf, 0x98, 0x3c, 0x0, 0x60, 0x24, 0xf0 } }\r | |
31 | \r | |
32 | /**\r | |
33 | Provides an interface that a software module can call to report a status code.\r | |
34 | \r | |
35 | @param Type Indicates the type of status code being reported.\r | |
36 | @param Value Describes the current status of a hardware or software entity.\r | |
37 | This included information about the class and subclass that is used to\r | |
38 | classify the entity as well as an operation.\r | |
39 | @param Instance The enumeration of a hardware or software entity within\r | |
40 | the system. Valid instance numbers start with 1.\r | |
41 | @param CallerId This optional parameter may be used to identify the caller.\r | |
42 | This parameter allows the status code driver to apply different rules to\r | |
43 | different callers.\r | |
44 | @param Data This optional parameter may be used to pass additional data.\r | |
45 | \r | |
46 | @retval EFI_SUCCESS The function completed successfully\r | |
47 | @retval EFI_DEVICE_ERROR The function should not be completed due to a device error.\r | |
48 | \r | |
49 | **/\r | |
50 | typedef\r | |
51 | EFI_STATUS \r | |
52 | (EFIAPI *EFI_REPORT_STATUS_CODE) (\r | |
53 | IN EFI_STATUS_CODE_TYPE Type,\r | |
54 | IN EFI_STATUS_CODE_VALUE Value,\r | |
55 | IN UINT32 Instance,\r | |
56 | IN EFI_GUID *CallerId OPTIONAL,\r | |
57 | IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r | |
58 | );\r | |
59 | \r | |
60 | /**\r | |
61 | @par Protocol Description:\r | |
62 | Provides the service required to report a status code to the platform firmware.\r | |
63 | This protocol must be produced by a runtime DXE driver and may be consumed \r | |
64 | only by the DXE Foundation.\r | |
65 | \r | |
66 | @param ReportStatusCode Emit a status code.\r | |
67 | \r | |
68 | **/\r | |
69 | typedef struct _EFI_STATUS_CODE_PROTOCOL {\r | |
70 | EFI_REPORT_STATUS_CODE ReportStatusCode;\r | |
71 | } EFI_STATUS_CODE_PROTOCOL;\r | |
72 | \r | |
73 | extern EFI_GUID gEfiStatusCodeRuntimeProtocolGuid;\r | |
74 | \r | |
75 | #endif\r |