]>
Commit | Line | Data |
---|---|---|
d1f95000 | 1 | /** @file\r |
28c1711d | 2 | Status code Runtime Protocol as defined in PI Specification 1.4a VOLUME 2 DXE\r |
d1f95000 | 3 | \r |
9095d37b | 4 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r |
9344f092 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
d1f95000 | 6 | \r |
d1f95000 | 7 | **/\r |
8 | \r | |
9 | #ifndef __STATUS_CODE_RUNTIME_PROTOCOL_H__\r | |
10 | #define __STATUS_CODE_RUNTIME_PROTOCOL_H__\r | |
11 | \r | |
12 | #define EFI_STATUS_CODE_RUNTIME_PROTOCOL_GUID \\r | |
13 | { 0xd2b2b828, 0x826, 0x48a7, { 0xb3, 0xdf, 0x98, 0x3c, 0x0, 0x60, 0x24, 0xf0 } }\r | |
14 | \r | |
15 | /**\r | |
16 | Provides an interface that a software module can call to report a status code.\r | |
17 | \r | |
18 | @param Type Indicates the type of status code being reported.\r | |
19 | @param Value Describes the current status of a hardware or software entity.\r | |
20 | This included information about the class and subclass that is used to\r | |
21 | classify the entity as well as an operation.\r | |
22 | @param Instance The enumeration of a hardware or software entity within\r | |
23 | the system. Valid instance numbers start with 1.\r | |
24 | @param CallerId This optional parameter may be used to identify the caller.\r | |
25 | This parameter allows the status code driver to apply different rules to\r | |
26 | different callers.\r | |
27 | @param Data This optional parameter may be used to pass additional data.\r | |
28 | \r | |
29 | @retval EFI_SUCCESS The function completed successfully\r | |
30 | @retval EFI_DEVICE_ERROR The function should not be completed due to a device error.\r | |
31 | \r | |
32 | **/\r | |
33 | typedef\r | |
ec0ccdda | 34 | EFI_STATUS\r |
8b13229b | 35 | (EFIAPI *EFI_REPORT_STATUS_CODE)(\r |
d1f95000 | 36 | IN EFI_STATUS_CODE_TYPE Type,\r |
37 | IN EFI_STATUS_CODE_VALUE Value,\r | |
38 | IN UINT32 Instance,\r | |
39 | IN EFI_GUID *CallerId OPTIONAL,\r | |
40 | IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r | |
41 | );\r | |
42 | \r | |
44717a39 | 43 | ///\r |
44 | /// Provides the service required to report a status code to the platform firmware.\r | |
28c1711d | 45 | /// This protocol must be produced by a runtime DXE driver.\r |
44717a39 | 46 | ///\r |
d1f95000 | 47 | typedef struct _EFI_STATUS_CODE_PROTOCOL {\r |
48 | EFI_REPORT_STATUS_CODE ReportStatusCode;\r | |
49 | } EFI_STATUS_CODE_PROTOCOL;\r | |
50 | \r | |
51 | extern EFI_GUID gEfiStatusCodeRuntimeProtocolGuid;\r | |
52 | \r | |
53 | #endif\r |