]>
Commit | Line | Data |
---|---|---|
878ddf1f | 1 | /** @file\r |
2 | This file declares SMM Status code Protocol.\r | |
3 | \r | |
4 | This code abstracts SMM Status Code reporting.\r | |
5 | \r | |
6 | Copyright (c) 2006, Intel Corporation \r | |
7 | All rights reserved. This program and the accompanying materials \r | |
8 | are licensed and made available under the terms and conditions of the BSD License \r | |
9 | which accompanies this distribution. The full text of the license may be found at \r | |
10 | http://opensource.org/licenses/bsd-license.php \r | |
11 | \r | |
12 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
13 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
14 | \r | |
15 | Module Name: SmmStatusCode.h\r | |
16 | \r | |
17 | @par Revision Reference:\r | |
18 | This Protocol is defined in Framework of EFI SMM Core Interface Spec\r | |
19 | Version 0.9.\r | |
20 | \r | |
21 | **/\r | |
22 | \r | |
23 | #ifndef _PROTOCOL_SMM_STATUS_CODE_H__\r | |
24 | #define _PROTOCOL_SMM_STATUS_CODE_H__\r | |
25 | \r | |
26 | //\r | |
27 | // Global ID for the Smm Status Code Protocol\r | |
28 | //\r | |
29 | #define EFI_SMM_STATUS_CODE_PROTOCOL_GUID \\r | |
30 | { \\r | |
31 | 0x6afd2b77, 0x98c1, 0x4acd, {0xa6, 0xf9, 0x8a, 0x94, 0x39, 0xde, 0xf, 0xb1 } \\r | |
32 | }\r | |
33 | \r | |
34 | typedef struct _EFI_SMM_STATUS_CODE_PROTOCOL EFI_SMM_STATUS_CODE_PROTOCOL;\r | |
35 | \r | |
36 | /**\r | |
37 | Service to emit the status code in SMM.\r | |
38 | \r | |
0647c9ad LG |
39 | @param This Pointer to EFI_SMM_STATUS_CODE_PROTOCOL instance.\r |
40 | @param CodeType Indicates the type of status code being reported.\r | |
41 | @param Value Describes the current status of a hardware or software entity.\r | |
42 | This included information about the class and subclass that is used to\r | |
43 | classify the entity as well as an operation.\r | |
44 | @param Instance The enumeration of a hardware or software entity within\r | |
45 | the system. Valid instance numbers start with 1.\r | |
46 | @param CallerId This optional parameter may be used to identify the caller.\r | |
47 | This parameter allows the status code driver to apply different rules to\r | |
48 | different callers.\r | |
49 | @param Data This optional parameter may be used to pass additional data.\r | |
50 | \r | |
51 | @retval EFI_SUCCESS The function completed successfully\r | |
52 | @retval EFI_DEVICE_ERROR The function should not be completed due to a device error.\r | |
878ddf1f | 53 | \r |
54 | **/\r | |
55 | typedef\r | |
56 | EFI_STATUS\r | |
57 | (EFIAPI *EFI_SMM_REPORT_STATUS_CODE) (\r | |
58 | IN EFI_SMM_STATUS_CODE_PROTOCOL *This,\r | |
59 | IN EFI_STATUS_CODE_TYPE CodeType,\r | |
60 | IN EFI_STATUS_CODE_VALUE Value,\r | |
61 | IN UINT32 Instance,\r | |
62 | IN EFI_GUID *CallerId,\r | |
63 | IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r | |
64 | );\r | |
65 | \r | |
66 | /**\r | |
67 | @par Protocol Description:\r | |
68 | Provides status code services from SMM.\r | |
69 | \r | |
70 | @param ReportStatusCode\r | |
71 | Allows for the SMM agent to produce a status code output.\r | |
72 | \r | |
73 | **/\r | |
74 | struct _EFI_SMM_STATUS_CODE_PROTOCOL {\r | |
75 | EFI_SMM_REPORT_STATUS_CODE ReportStatusCode;\r | |
76 | };\r | |
77 | \r | |
78 | extern EFI_GUID gEfiSmmStatusCodeProtocolGuid;\r | |
79 | \r | |
80 | #endif\r |